billingconductor

package module
v1.16.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 8, 2024 License: Apache-2.0 Imports: 41 Imported by: 2

Documentation

Overview

Package billingconductor provides the API client, operations, and parameter types for AWSBillingConductor.

Amazon Web Services Billing Conductor is a fully managed service that you can use to customize a proformaversion of your billing data each month, to accurately show or chargeback your end customers. Amazon Web Services Billing Conductor doesn't change the way you're billed by Amazon Web Services each month by design. Instead, it provides you with a mechanism to configure, generate, and display rates to certain customers over a given billing period. You can also analyze the difference between the rates you apply to your accounting groupings relative to your actual rates from Amazon Web Services. As a result of your Amazon Web Services Billing Conductor configuration, the payer account can also see the custom rate applied on the billing details page of the Amazon Web Services Billing console, or configure a cost and usage report per billing group.

This documentation shows how you can configure Amazon Web Services Billing Conductor using its API. For more information about using the Amazon Web Services Billing Conductoruser interface, see the Amazon Web Services Billing Conductor User Guide.

Index

Constants

View Source
const ServiceAPIVersion = "2021-07-30"
View Source
const ServiceID = "billingconductor"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.8.0

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.11.2

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.11.2

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AssociateAccountsInput

type AssociateAccountsInput struct {

	//  The associating array of account IDs.
	//
	// This member is required.
	AccountIds []string

	//  The Amazon Resource Name (ARN) of the billing group that associates the array
	// of account IDs.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type AssociateAccountsOutput

type AssociateAccountsOutput struct {

	//  The Amazon Resource Name (ARN) of the billing group that associates the array
	// of account IDs.
	Arn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AssociatePricingRulesInput

type AssociatePricingRulesInput struct {

	//  The PricingPlanArn that the PricingRuleArns are associated with.
	//
	// This member is required.
	Arn *string

	//  The PricingRuleArns that are associated with the Pricing Plan.
	//
	// This member is required.
	PricingRuleArns []string
	// contains filtered or unexported fields
}

type AssociatePricingRulesOutput

type AssociatePricingRulesOutput struct {

	//  The PricingPlanArn that the PricingRuleArns are associated with.
	Arn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AuthResolverParameters added in v1.11.2

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.11.2

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type BatchAssociateResourcesToCustomLineItemInput

type BatchAssociateResourcesToCustomLineItemInput struct {

	//  A list containing the ARNs of the resources to be associated.
	//
	// This member is required.
	ResourceArns []string

	//  A percentage custom line item ARN to associate the resources to.
	//
	// This member is required.
	TargetArn *string

	// The billing period range in which the custom line item request will be applied.
	BillingPeriodRange *types.CustomLineItemBillingPeriodRange
	// contains filtered or unexported fields
}

type BatchAssociateResourcesToCustomLineItemOutput

type BatchAssociateResourcesToCustomLineItemOutput struct {

	//  A list of AssociateResourceResponseElement for each resource that failed
	// association to a percentage custom line item.
	FailedAssociatedResources []types.AssociateResourceResponseElement

	//  A list of AssociateResourceResponseElement for each resource that's been
	// associated to a percentage custom line item successfully.
	SuccessfullyAssociatedResources []types.AssociateResourceResponseElement

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type BatchDisassociateResourcesFromCustomLineItemInput

type BatchDisassociateResourcesFromCustomLineItemInput struct {

	//  A list containing the ARNs of resources to be disassociated.
	//
	// This member is required.
	ResourceArns []string

	//  A percentage custom line item ARN to disassociate the resources from.
	//
	// This member is required.
	TargetArn *string

	// The billing period range in which the custom line item request will be applied.
	BillingPeriodRange *types.CustomLineItemBillingPeriodRange
	// contains filtered or unexported fields
}

type BatchDisassociateResourcesFromCustomLineItemOutput

type BatchDisassociateResourcesFromCustomLineItemOutput struct {

	//  A list of DisassociateResourceResponseElement for each resource that failed
	// disassociation from a percentage custom line item.
	FailedDisassociatedResources []types.DisassociateResourceResponseElement

	//  A list of DisassociateResourceResponseElement for each resource that's been
	// disassociated from a percentage custom line item successfully.
	SuccessfullyDisassociatedResources []types.DisassociateResourceResponseElement

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for AWSBillingConductor.

func New

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) AssociateAccounts

func (c *Client) AssociateAccounts(ctx context.Context, params *AssociateAccountsInput, optFns ...func(*Options)) (*AssociateAccountsOutput, error)

Connects an array of account IDs in a consolidated billing family to a predefined billing group. The account IDs must be a part of the consolidated billing family during the current month, and not already associated with another billing group. The maximum number of accounts that can be associated in one call is 30.

func (*Client) AssociatePricingRules

func (c *Client) AssociatePricingRules(ctx context.Context, params *AssociatePricingRulesInput, optFns ...func(*Options)) (*AssociatePricingRulesOutput, error)

Connects an array of PricingRuleArns to a defined PricingPlan . The maximum number PricingRuleArn that can be associated in one call is 30.

func (*Client) BatchAssociateResourcesToCustomLineItem

func (c *Client) BatchAssociateResourcesToCustomLineItem(ctx context.Context, params *BatchAssociateResourcesToCustomLineItemInput, optFns ...func(*Options)) (*BatchAssociateResourcesToCustomLineItemOutput, error)

Associates a batch of resources to a percentage custom line item.

func (*Client) BatchDisassociateResourcesFromCustomLineItem

func (c *Client) BatchDisassociateResourcesFromCustomLineItem(ctx context.Context, params *BatchDisassociateResourcesFromCustomLineItemInput, optFns ...func(*Options)) (*BatchDisassociateResourcesFromCustomLineItemOutput, error)

Disassociates a batch of resources from a percentage custom line item.

func (*Client) CreateBillingGroup

func (c *Client) CreateBillingGroup(ctx context.Context, params *CreateBillingGroupInput, optFns ...func(*Options)) (*CreateBillingGroupOutput, error)
Creates a billing group that resembles a consolidated billing family that

Amazon Web Services charges, based off of the predefined pricing plan computation.

func (*Client) CreateCustomLineItem

func (c *Client) CreateCustomLineItem(ctx context.Context, params *CreateCustomLineItemInput, optFns ...func(*Options)) (*CreateCustomLineItemOutput, error)

Creates a custom line item that can be used to create a one-time fixed charge that can be applied to a single billing group for the current or previous billing period. The one-time fixed charge is either a fee or discount.

func (*Client) CreatePricingPlan

func (c *Client) CreatePricingPlan(ctx context.Context, params *CreatePricingPlanInput, optFns ...func(*Options)) (*CreatePricingPlanOutput, error)

Creates a pricing plan that is used for computing Amazon Web Services charges for billing groups.

func (*Client) CreatePricingRule

func (c *Client) CreatePricingRule(ctx context.Context, params *CreatePricingRuleInput, optFns ...func(*Options)) (*CreatePricingRuleOutput, error)
Creates a pricing rule can be associated to a pricing plan, or a set of

pricing plans.

func (*Client) DeleteBillingGroup

func (c *Client) DeleteBillingGroup(ctx context.Context, params *DeleteBillingGroupInput, optFns ...func(*Options)) (*DeleteBillingGroupOutput, error)

Deletes a billing group.

func (*Client) DeleteCustomLineItem

func (c *Client) DeleteCustomLineItem(ctx context.Context, params *DeleteCustomLineItemInput, optFns ...func(*Options)) (*DeleteCustomLineItemOutput, error)
Deletes the custom line item identified by the given ARN in the current, or

previous billing period.

func (*Client) DeletePricingPlan

func (c *Client) DeletePricingPlan(ctx context.Context, params *DeletePricingPlanInput, optFns ...func(*Options)) (*DeletePricingPlanOutput, error)

Deletes a pricing plan. The pricing plan must not be associated with any billing groups to delete successfully.

func (*Client) DeletePricingRule

func (c *Client) DeletePricingRule(ctx context.Context, params *DeletePricingRuleInput, optFns ...func(*Options)) (*DeletePricingRuleOutput, error)
Deletes the pricing rule that's identified by the input Amazon Resource Name

(ARN).

func (*Client) DisassociateAccounts

func (c *Client) DisassociateAccounts(ctx context.Context, params *DisassociateAccountsInput, optFns ...func(*Options)) (*DisassociateAccountsOutput, error)

Removes the specified list of account IDs from the given billing group.

func (*Client) DisassociatePricingRules

func (c *Client) DisassociatePricingRules(ctx context.Context, params *DisassociatePricingRulesInput, optFns ...func(*Options)) (*DisassociatePricingRulesOutput, error)

Disassociates a list of pricing rules from a pricing plan.

func (*Client) GetBillingGroupCostReport added in v1.14.0

func (c *Client) GetBillingGroupCostReport(ctx context.Context, params *GetBillingGroupCostReportInput, optFns ...func(*Options)) (*GetBillingGroupCostReportOutput, error)

Retrieves the margin summary report, which includes the Amazon Web Services cost and charged amount (pro forma cost) by Amazon Web Service for a specific billing group.

func (*Client) ListAccountAssociations

func (c *Client) ListAccountAssociations(ctx context.Context, params *ListAccountAssociationsInput, optFns ...func(*Options)) (*ListAccountAssociationsOutput, error)
This is a paginated call to list linked accounts that are linked to the payer

account for the specified time period. If no information is provided, the current billing period is used. The response will optionally include the billing group that's associated with the linked account.

func (*Client) ListBillingGroupCostReports

func (c *Client) ListBillingGroupCostReports(ctx context.Context, params *ListBillingGroupCostReportsInput, optFns ...func(*Options)) (*ListBillingGroupCostReportsOutput, error)

A paginated call to retrieve a summary report of actual Amazon Web Services charges and the calculated Amazon Web Services charges based on the associated pricing plan of a billing group.

func (*Client) ListBillingGroups

func (c *Client) ListBillingGroups(ctx context.Context, params *ListBillingGroupsInput, optFns ...func(*Options)) (*ListBillingGroupsOutput, error)

A paginated call to retrieve a list of billing groups for the given billing period. If you don't provide a billing group, the current billing period is used.

func (*Client) ListCustomLineItemVersions added in v1.1.0

func (c *Client) ListCustomLineItemVersions(ctx context.Context, params *ListCustomLineItemVersionsInput, optFns ...func(*Options)) (*ListCustomLineItemVersionsOutput, error)

A paginated call to get a list of all custom line item versions.

func (*Client) ListCustomLineItems

func (c *Client) ListCustomLineItems(ctx context.Context, params *ListCustomLineItemsInput, optFns ...func(*Options)) (*ListCustomLineItemsOutput, error)
A paginated call to get a list of all custom line items (FFLIs) for the given

billing period. If you don't provide a billing period, the current billing period is used.

func (*Client) ListPricingPlans

func (c *Client) ListPricingPlans(ctx context.Context, params *ListPricingPlansInput, optFns ...func(*Options)) (*ListPricingPlansOutput, error)

A paginated call to get pricing plans for the given billing period. If you don't provide a billing period, the current billing period is used.

func (*Client) ListPricingPlansAssociatedWithPricingRule

func (c *Client) ListPricingPlansAssociatedWithPricingRule(ctx context.Context, params *ListPricingPlansAssociatedWithPricingRuleInput, optFns ...func(*Options)) (*ListPricingPlansAssociatedWithPricingRuleOutput, error)

A list of the pricing plans that are associated with a pricing rule.

func (*Client) ListPricingRules

func (c *Client) ListPricingRules(ctx context.Context, params *ListPricingRulesInput, optFns ...func(*Options)) (*ListPricingRulesOutput, error)
Describes a pricing rule that can be associated to a pricing plan, or set of

pricing plans.

func (*Client) ListPricingRulesAssociatedToPricingPlan

func (c *Client) ListPricingRulesAssociatedToPricingPlan(ctx context.Context, params *ListPricingRulesAssociatedToPricingPlanInput, optFns ...func(*Options)) (*ListPricingRulesAssociatedToPricingPlanOutput, error)

Lists the pricing rules that are associated with a pricing plan.

func (*Client) ListResourcesAssociatedToCustomLineItem

func (c *Client) ListResourcesAssociatedToCustomLineItem(ctx context.Context, params *ListResourcesAssociatedToCustomLineItemInput, optFns ...func(*Options)) (*ListResourcesAssociatedToCustomLineItemOutput, error)

List the resources that are associated to a custom line item.

func (*Client) ListTagsForResource

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

A list the tags for a resource.

func (*Client) Options added in v1.12.0

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) TagResource

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Associates the specified tags to a resource with the specified resourceArn . If

existing tags on a resource are not specified in the request parameters, they are not changed.

func (*Client) UntagResource

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Deletes specified tags from a resource.

func (*Client) UpdateBillingGroup

func (c *Client) UpdateBillingGroup(ctx context.Context, params *UpdateBillingGroupInput, optFns ...func(*Options)) (*UpdateBillingGroupOutput, error)

This updates an existing billing group.

func (*Client) UpdateCustomLineItem

func (c *Client) UpdateCustomLineItem(ctx context.Context, params *UpdateCustomLineItemInput, optFns ...func(*Options)) (*UpdateCustomLineItemOutput, error)

Update an existing custom line item in the current or previous billing period.

func (*Client) UpdatePricingPlan

func (c *Client) UpdatePricingPlan(ctx context.Context, params *UpdatePricingPlanInput, optFns ...func(*Options)) (*UpdatePricingPlanOutput, error)

This updates an existing pricing plan.

func (*Client) UpdatePricingRule

func (c *Client) UpdatePricingRule(ctx context.Context, params *UpdatePricingRuleInput, optFns ...func(*Options)) (*UpdatePricingRuleOutput, error)

Updates an existing pricing rule.

type CreateBillingGroupInput

type CreateBillingGroupInput struct {

	//  The set of accounts that will be under the billing group. The set of accounts
	// resemble the linked accounts in a consolidated billing family.
	//
	// This member is required.
	AccountGrouping *types.AccountGrouping

	//  The preferences and settings that will be used to compute the Amazon Web
	// Services charges for a billing group.
	//
	// This member is required.
	ComputationPreference *types.ComputationPreference

	//  The billing group name. The names must be unique.
	//
	// This member is required.
	Name *string

	//  The token that is needed to support idempotency. Idempotency isn't currently
	// supported, but will be implemented in a future update.
	ClientToken *string

	// The description of the billing group.
	Description *string

	//  The account ID that serves as the main account in a billing group.
	PrimaryAccountId *string

	//  A map that contains tag keys and tag values that are attached to a billing
	// group. This feature isn't available during the beta.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateBillingGroupOutput

type CreateBillingGroupOutput struct {

	// The Amazon Resource Name (ARN) of the created billing group.
	Arn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateCustomLineItemInput

type CreateCustomLineItemInput struct {

	//  The Amazon Resource Name (ARN) that references the billing group where the
	// custom line item applies to.
	//
	// This member is required.
	BillingGroupArn *string

	//  A CustomLineItemChargeDetails that describes the charge details for a custom
	// line item.
	//
	// This member is required.
	ChargeDetails *types.CustomLineItemChargeDetails

	//  The description of the custom line item. This is shown on the Bills page in
	// association with the charge value.
	//
	// This member is required.
	Description *string

	//  The name of the custom line item.
	//
	// This member is required.
	Name *string

	// The Amazon Web Services account in which this custom line item will be applied
	// to.
	AccountId *string

	//  A time range for which the custom line item is effective.
	BillingPeriodRange *types.CustomLineItemBillingPeriodRange

	//  The token that is needed to support idempotency. Idempotency isn't currently
	// supported, but will be implemented in a future update.
	ClientToken *string

	//  A map that contains tag keys and tag values that are attached to a custom line
	// item.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateCustomLineItemOutput

type CreateCustomLineItemOutput struct {

	//  The Amazon Resource Name (ARN) of the created custom line item.
	Arn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreatePricingPlanInput

type CreatePricingPlanInput struct {

	// The name of the pricing plan. The names must be unique to each pricing plan.
	//
	// This member is required.
	Name *string

	//  The token that is needed to support idempotency. Idempotency isn't currently
	// supported, but will be implemented in a future update.
	ClientToken *string

	// The description of the pricing plan.
	Description *string

	//  A list of Amazon Resource Names (ARNs) that define the pricing plan
	// parameters.
	PricingRuleArns []string

	//  A map that contains tag keys and tag values that are attached to a pricing
	// plan.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreatePricingPlanOutput

type CreatePricingPlanOutput struct {

	// The Amazon Resource Name (ARN) of the created pricing plan.
	Arn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreatePricingRuleInput

type CreatePricingRuleInput struct {

	//  The pricing rule name. The names must be unique to each pricing rule.
	//
	// This member is required.
	Name *string

	//  The scope of pricing rule that indicates if it's globally applicable, or it's
	// service-specific.
	//
	// This member is required.
	Scope types.PricingRuleScope

	//  The type of pricing rule.
	//
	// This member is required.
	Type types.PricingRuleType

	//  The seller of services provided by Amazon Web Services, their affiliates, or
	// third-party providers selling services via Amazon Web Services Marketplace.
	BillingEntity *string

	//  The token that's needed to support idempotency. Idempotency isn't currently
	// supported, but will be implemented in a future update.
	ClientToken *string

	//  The pricing rule description.
	Description *string

	//  A percentage modifier that's applied on the public pricing rates.
	ModifierPercentage *float64

	//  Operation is the specific Amazon Web Services action covered by this line
	// item. This describes the specific usage of the line item.
	//
	// If the Scope attribute is set to SKU , this attribute indicates which operation
	// the PricingRule is modifying. For example, a value of RunInstances:0202
	// indicates the operation of running an Amazon EC2 instance.
	Operation *string

	//  If the Scope attribute is set to SERVICE or SKU , the attribute indicates which
	// service the PricingRule is applicable for.
	Service *string

	//  A map that contains tag keys and tag values that are attached to a pricing
	// rule.
	Tags map[string]string

	//  The set of tiering configurations for the pricing rule.
	Tiering *types.CreateTieringInput

	//  Usage type is the unit that each service uses to measure the usage of a
	// specific type of resource.
	//
	// If the Scope attribute is set to SKU , this attribute indicates which usage type
	// the PricingRule is modifying. For example, USW2-BoxUsage:m2.2xlarge describes an
	// M2 High Memory Double Extra Large instance in the US West (Oregon) Region.
	UsageType *string
	// contains filtered or unexported fields
}

type CreatePricingRuleOutput

type CreatePricingRuleOutput struct {

	//  The Amazon Resource Name (ARN) of the created pricing rule.
	Arn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteBillingGroupInput

type DeleteBillingGroupInput struct {

	// The Amazon Resource Name (ARN) of the billing group that you're deleting.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type DeleteBillingGroupOutput

type DeleteBillingGroupOutput struct {

	// The Amazon Resource Name (ARN) of the deleted billing group.
	Arn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteCustomLineItemInput

type DeleteCustomLineItemInput struct {

	//  The ARN of the custom line item to be deleted.
	//
	// This member is required.
	Arn *string

	// The billing period range in which the custom line item request will be applied.
	BillingPeriodRange *types.CustomLineItemBillingPeriodRange
	// contains filtered or unexported fields
}

type DeleteCustomLineItemOutput

type DeleteCustomLineItemOutput struct {

	// The ARN of the deleted custom line item.
	Arn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeletePricingPlanInput

type DeletePricingPlanInput struct {

	// The Amazon Resource Name (ARN) of the pricing plan that you're deleting.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type DeletePricingPlanOutput

type DeletePricingPlanOutput struct {

	//  The Amazon Resource Name (ARN) of the deleted pricing plan.
	Arn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeletePricingRuleInput

type DeletePricingRuleInput struct {

	//  The Amazon Resource Name (ARN) of the pricing rule that you are deleting.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type DeletePricingRuleOutput

type DeletePricingRuleOutput struct {

	//  The Amazon Resource Name (ARN) of the deleted pricing rule.
	Arn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisassociateAccountsInput

type DisassociateAccountsInput struct {

	// The array of account IDs to disassociate.
	//
	// This member is required.
	AccountIds []string

	// The Amazon Resource Name (ARN) of the billing group that the array of account
	// IDs will disassociate from.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type DisassociateAccountsOutput

type DisassociateAccountsOutput struct {

	// The Amazon Resource Name (ARN) of the billing group that the array of account
	// IDs is disassociated from.
	Arn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisassociatePricingRulesInput

type DisassociatePricingRulesInput struct {

	//  The pricing plan Amazon Resource Name (ARN) to disassociate pricing rules
	// from.
	//
	// This member is required.
	Arn *string

	//  A list containing the Amazon Resource Name (ARN) of the pricing rules that
	// will be disassociated.
	//
	// This member is required.
	PricingRuleArns []string
	// contains filtered or unexported fields
}

type DisassociatePricingRulesOutput

type DisassociatePricingRulesOutput struct {

	//  The Amazon Resource Name (ARN) of the pricing plan that the pricing rules
	// successfully disassociated from.
	Arn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters added in v1.8.0

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.8.0

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.8.0

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.8.0

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.8.0

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetBillingGroupCostReportAPIClient added in v1.14.0

type GetBillingGroupCostReportAPIClient interface {
	GetBillingGroupCostReport(context.Context, *GetBillingGroupCostReportInput, ...func(*Options)) (*GetBillingGroupCostReportOutput, error)
}

GetBillingGroupCostReportAPIClient is a client that implements the GetBillingGroupCostReport operation.

type GetBillingGroupCostReportInput added in v1.14.0

type GetBillingGroupCostReportInput struct {

	// The Amazon Resource Number (ARN) that uniquely identifies the billing group.
	//
	// This member is required.
	Arn *string

	// A time range for which the margin summary is effective. You can specify up to
	// 12 months.
	BillingPeriodRange *types.BillingPeriodRange

	// A list of strings that specify the attributes that are used to break down costs
	// in the margin summary reports for the billing group. For example, you can view
	// your costs by the Amazon Web Service name or the billing period.
	GroupBy []types.GroupByAttributeName

	// The maximum number of margin summary reports to retrieve.
	MaxResults *int32

	// The pagination token used on subsequent calls to get reports.
	NextToken *string
	// contains filtered or unexported fields
}

type GetBillingGroupCostReportOutput added in v1.14.0

type GetBillingGroupCostReportOutput struct {

	// The list of margin summary reports.
	BillingGroupCostReportResults []types.BillingGroupCostReportResultElement

	// The pagination token used on subsequent calls to get reports.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetBillingGroupCostReportPaginator added in v1.14.0

type GetBillingGroupCostReportPaginator struct {
	// contains filtered or unexported fields
}

GetBillingGroupCostReportPaginator is a paginator for GetBillingGroupCostReport

func NewGetBillingGroupCostReportPaginator added in v1.14.0

NewGetBillingGroupCostReportPaginator returns a new GetBillingGroupCostReportPaginator

func (*GetBillingGroupCostReportPaginator) HasMorePages added in v1.14.0

func (p *GetBillingGroupCostReportPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetBillingGroupCostReportPaginator) NextPage added in v1.14.0

NextPage retrieves the next GetBillingGroupCostReport page.

type GetBillingGroupCostReportPaginatorOptions added in v1.14.0

type GetBillingGroupCostReportPaginatorOptions struct {
	// The maximum number of margin summary reports to retrieve.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetBillingGroupCostReportPaginatorOptions is the paginator options for GetBillingGroupCostReport

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListAccountAssociationsAPIClient

type ListAccountAssociationsAPIClient interface {
	ListAccountAssociations(context.Context, *ListAccountAssociationsInput, ...func(*Options)) (*ListAccountAssociationsOutput, error)
}

ListAccountAssociationsAPIClient is a client that implements the ListAccountAssociations operation.

type ListAccountAssociationsInput

type ListAccountAssociationsInput struct {

	//  The preferred billing period to get account associations.
	BillingPeriod *string

	// The filter on the account ID of the linked account, or any of the following:
	//
	// MONITORED : linked accounts that are associated to billing groups.
	//
	// UNMONITORED : linked accounts that aren't associated to billing groups.
	//
	// Billing Group Arn : linked accounts that are associated to the provided billing
	// group Arn.
	Filters *types.ListAccountAssociationsFilter

	//  The pagination token that's used on subsequent calls to retrieve accounts.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAccountAssociationsOutput

type ListAccountAssociationsOutput struct {

	//  The list of linked accounts in the payer account.
	LinkedAccounts []types.AccountAssociationsListElement

	//  The pagination token that's used on subsequent calls to get accounts.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAccountAssociationsPaginator

type ListAccountAssociationsPaginator struct {
	// contains filtered or unexported fields
}

ListAccountAssociationsPaginator is a paginator for ListAccountAssociations

func NewListAccountAssociationsPaginator

NewListAccountAssociationsPaginator returns a new ListAccountAssociationsPaginator

func (*ListAccountAssociationsPaginator) HasMorePages

func (p *ListAccountAssociationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAccountAssociationsPaginator) NextPage

NextPage retrieves the next ListAccountAssociations page.

type ListAccountAssociationsPaginatorOptions

type ListAccountAssociationsPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAccountAssociationsPaginatorOptions is the paginator options for ListAccountAssociations

type ListBillingGroupCostReportsAPIClient

type ListBillingGroupCostReportsAPIClient interface {
	ListBillingGroupCostReports(context.Context, *ListBillingGroupCostReportsInput, ...func(*Options)) (*ListBillingGroupCostReportsOutput, error)
}

ListBillingGroupCostReportsAPIClient is a client that implements the ListBillingGroupCostReports operation.

type ListBillingGroupCostReportsInput

type ListBillingGroupCostReportsInput struct {

	// The preferred billing period for your report.
	BillingPeriod *string

	// A ListBillingGroupCostReportsFilter to specify billing groups to retrieve
	// reports from.
	Filters *types.ListBillingGroupCostReportsFilter

	// The maximum number of reports to retrieve.
	MaxResults *int32

	// The pagination token that's used on subsequent calls to get reports.
	NextToken *string
	// contains filtered or unexported fields
}

type ListBillingGroupCostReportsOutput

type ListBillingGroupCostReportsOutput struct {

	// A list of BillingGroupCostReportElement retrieved.
	BillingGroupCostReports []types.BillingGroupCostReportElement

	// The pagination token that's used on subsequent calls to get reports.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListBillingGroupCostReportsPaginator

type ListBillingGroupCostReportsPaginator struct {
	// contains filtered or unexported fields
}

ListBillingGroupCostReportsPaginator is a paginator for ListBillingGroupCostReports

func NewListBillingGroupCostReportsPaginator

NewListBillingGroupCostReportsPaginator returns a new ListBillingGroupCostReportsPaginator

func (*ListBillingGroupCostReportsPaginator) HasMorePages

func (p *ListBillingGroupCostReportsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListBillingGroupCostReportsPaginator) NextPage

NextPage retrieves the next ListBillingGroupCostReports page.

type ListBillingGroupCostReportsPaginatorOptions

type ListBillingGroupCostReportsPaginatorOptions struct {
	// The maximum number of reports to retrieve.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListBillingGroupCostReportsPaginatorOptions is the paginator options for ListBillingGroupCostReports

type ListBillingGroupsAPIClient

type ListBillingGroupsAPIClient interface {
	ListBillingGroups(context.Context, *ListBillingGroupsInput, ...func(*Options)) (*ListBillingGroupsOutput, error)
}

ListBillingGroupsAPIClient is a client that implements the ListBillingGroups operation.

type ListBillingGroupsInput

type ListBillingGroupsInput struct {

	// The preferred billing period to get billing groups.
	BillingPeriod *string

	// A ListBillingGroupsFilter that specifies the billing group and pricing plan to
	// retrieve billing group information.
	Filters *types.ListBillingGroupsFilter

	// The maximum number of billing groups to retrieve.
	MaxResults *int32

	// The pagination token that's used on subsequent calls to get billing groups.
	NextToken *string
	// contains filtered or unexported fields
}

type ListBillingGroupsOutput

type ListBillingGroupsOutput struct {

	// A list of BillingGroupListElement retrieved.
	BillingGroups []types.BillingGroupListElement

	// The pagination token that's used on subsequent calls to get billing groups.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListBillingGroupsPaginator

type ListBillingGroupsPaginator struct {
	// contains filtered or unexported fields
}

ListBillingGroupsPaginator is a paginator for ListBillingGroups

func NewListBillingGroupsPaginator

func NewListBillingGroupsPaginator(client ListBillingGroupsAPIClient, params *ListBillingGroupsInput, optFns ...func(*ListBillingGroupsPaginatorOptions)) *ListBillingGroupsPaginator

NewListBillingGroupsPaginator returns a new ListBillingGroupsPaginator

func (*ListBillingGroupsPaginator) HasMorePages

func (p *ListBillingGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListBillingGroupsPaginator) NextPage

func (p *ListBillingGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListBillingGroupsOutput, error)

NextPage retrieves the next ListBillingGroups page.

type ListBillingGroupsPaginatorOptions

type ListBillingGroupsPaginatorOptions struct {
	// The maximum number of billing groups to retrieve.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListBillingGroupsPaginatorOptions is the paginator options for ListBillingGroups

type ListCustomLineItemVersionsAPIClient added in v1.1.0

type ListCustomLineItemVersionsAPIClient interface {
	ListCustomLineItemVersions(context.Context, *ListCustomLineItemVersionsInput, ...func(*Options)) (*ListCustomLineItemVersionsOutput, error)
}

ListCustomLineItemVersionsAPIClient is a client that implements the ListCustomLineItemVersions operation.

type ListCustomLineItemVersionsInput added in v1.1.0

type ListCustomLineItemVersionsInput struct {

	// The Amazon Resource Name (ARN) for the custom line item.
	//
	// This member is required.
	Arn *string

	// A ListCustomLineItemVersionsFilter that specifies the billing period range in
	// which the custom line item versions are applied.
	Filters *types.ListCustomLineItemVersionsFilter

	// The maximum number of custom line item versions to retrieve.
	MaxResults *int32

	// The pagination token that's used on subsequent calls to retrieve custom line
	// item versions.
	NextToken *string
	// contains filtered or unexported fields
}

type ListCustomLineItemVersionsOutput added in v1.1.0

type ListCustomLineItemVersionsOutput struct {

	// A list of CustomLineItemVersionListElements that are received.
	CustomLineItemVersions []types.CustomLineItemVersionListElement

	// The pagination token that's used on subsequent calls to retrieve custom line
	// item versions.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCustomLineItemVersionsPaginator added in v1.1.0

type ListCustomLineItemVersionsPaginator struct {
	// contains filtered or unexported fields
}

ListCustomLineItemVersionsPaginator is a paginator for ListCustomLineItemVersions

func NewListCustomLineItemVersionsPaginator added in v1.1.0

NewListCustomLineItemVersionsPaginator returns a new ListCustomLineItemVersionsPaginator

func (*ListCustomLineItemVersionsPaginator) HasMorePages added in v1.1.0

func (p *ListCustomLineItemVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCustomLineItemVersionsPaginator) NextPage added in v1.1.0

NextPage retrieves the next ListCustomLineItemVersions page.

type ListCustomLineItemVersionsPaginatorOptions added in v1.1.0

type ListCustomLineItemVersionsPaginatorOptions struct {
	// The maximum number of custom line item versions to retrieve.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCustomLineItemVersionsPaginatorOptions is the paginator options for ListCustomLineItemVersions

type ListCustomLineItemsAPIClient

type ListCustomLineItemsAPIClient interface {
	ListCustomLineItems(context.Context, *ListCustomLineItemsInput, ...func(*Options)) (*ListCustomLineItemsOutput, error)
}

ListCustomLineItemsAPIClient is a client that implements the ListCustomLineItems operation.

type ListCustomLineItemsInput

type ListCustomLineItemsInput struct {

	//  The preferred billing period to get custom line items (FFLIs).
	BillingPeriod *string

	// A ListCustomLineItemsFilter that specifies the custom line item names and/or
	// billing group Amazon Resource Names (ARNs) to retrieve FFLI information.
	Filters *types.ListCustomLineItemsFilter

	//  The maximum number of billing groups to retrieve.
	MaxResults *int32

	//  The pagination token that's used on subsequent calls to get custom line items
	// (FFLIs).
	NextToken *string
	// contains filtered or unexported fields
}

type ListCustomLineItemsOutput

type ListCustomLineItemsOutput struct {

	//  A list of FreeFormLineItemListElements received.
	CustomLineItems []types.CustomLineItemListElement

	//  The pagination token that's used on subsequent calls to get custom line items
	// (FFLIs).
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCustomLineItemsPaginator

type ListCustomLineItemsPaginator struct {
	// contains filtered or unexported fields
}

ListCustomLineItemsPaginator is a paginator for ListCustomLineItems

func NewListCustomLineItemsPaginator

func NewListCustomLineItemsPaginator(client ListCustomLineItemsAPIClient, params *ListCustomLineItemsInput, optFns ...func(*ListCustomLineItemsPaginatorOptions)) *ListCustomLineItemsPaginator

NewListCustomLineItemsPaginator returns a new ListCustomLineItemsPaginator

func (*ListCustomLineItemsPaginator) HasMorePages

func (p *ListCustomLineItemsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCustomLineItemsPaginator) NextPage

func (p *ListCustomLineItemsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCustomLineItemsOutput, error)

NextPage retrieves the next ListCustomLineItems page.

type ListCustomLineItemsPaginatorOptions

type ListCustomLineItemsPaginatorOptions struct {
	//  The maximum number of billing groups to retrieve.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCustomLineItemsPaginatorOptions is the paginator options for ListCustomLineItems

type ListPricingPlansAPIClient

type ListPricingPlansAPIClient interface {
	ListPricingPlans(context.Context, *ListPricingPlansInput, ...func(*Options)) (*ListPricingPlansOutput, error)
}

ListPricingPlansAPIClient is a client that implements the ListPricingPlans operation.

type ListPricingPlansAssociatedWithPricingRuleAPIClient

type ListPricingPlansAssociatedWithPricingRuleAPIClient interface {
	ListPricingPlansAssociatedWithPricingRule(context.Context, *ListPricingPlansAssociatedWithPricingRuleInput, ...func(*Options)) (*ListPricingPlansAssociatedWithPricingRuleOutput, error)
}

ListPricingPlansAssociatedWithPricingRuleAPIClient is a client that implements the ListPricingPlansAssociatedWithPricingRule operation.

type ListPricingPlansAssociatedWithPricingRuleInput

type ListPricingPlansAssociatedWithPricingRuleInput struct {

	//  The pricing rule Amazon Resource Name (ARN) for which associations will be
	// listed.
	//
	// This member is required.
	PricingRuleArn *string

	//  The pricing plan billing period for which associations will be listed.
	BillingPeriod *string

	//  The optional maximum number of pricing rule associations to retrieve.
	MaxResults *int32

	//  The optional pagination token returned by a previous call.
	NextToken *string
	// contains filtered or unexported fields
}

type ListPricingPlansAssociatedWithPricingRuleOutput

type ListPricingPlansAssociatedWithPricingRuleOutput struct {

	//  The pricing plan billing period for which associations will be listed.
	BillingPeriod *string

	//  The pagination token to be used on subsequent calls.
	NextToken *string

	//  The list containing pricing plans that are associated with the requested
	// pricing rule.
	PricingPlanArns []string

	//  The pricing rule Amazon Resource Name (ARN) for which associations will be
	// listed.
	PricingRuleArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListPricingPlansAssociatedWithPricingRulePaginator

type ListPricingPlansAssociatedWithPricingRulePaginator struct {
	// contains filtered or unexported fields
}

ListPricingPlansAssociatedWithPricingRulePaginator is a paginator for ListPricingPlansAssociatedWithPricingRule

func NewListPricingPlansAssociatedWithPricingRulePaginator

NewListPricingPlansAssociatedWithPricingRulePaginator returns a new ListPricingPlansAssociatedWithPricingRulePaginator

func (*ListPricingPlansAssociatedWithPricingRulePaginator) HasMorePages

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPricingPlansAssociatedWithPricingRulePaginator) NextPage

NextPage retrieves the next ListPricingPlansAssociatedWithPricingRule page.

type ListPricingPlansAssociatedWithPricingRulePaginatorOptions

type ListPricingPlansAssociatedWithPricingRulePaginatorOptions struct {
	//  The optional maximum number of pricing rule associations to retrieve.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListPricingPlansAssociatedWithPricingRulePaginatorOptions is the paginator options for ListPricingPlansAssociatedWithPricingRule

type ListPricingPlansInput

type ListPricingPlansInput struct {

	// The preferred billing period to get pricing plan.
	BillingPeriod *string

	// A ListPricingPlansFilter that specifies the Amazon Resource Name (ARNs) of
	// pricing plans to retrieve pricing plans information.
	Filters *types.ListPricingPlansFilter

	// The maximum number of pricing plans to retrieve.
	MaxResults *int32

	// The pagination token that's used on subsequent call to get pricing plans.
	NextToken *string
	// contains filtered or unexported fields
}

type ListPricingPlansOutput

type ListPricingPlansOutput struct {

	//  The billing period for which the described pricing plans are applicable.
	BillingPeriod *string

	// The pagination token that's used on subsequent calls to get pricing plans.
	NextToken *string

	// A list of PricingPlanListElement retrieved.
	PricingPlans []types.PricingPlanListElement

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListPricingPlansPaginator

type ListPricingPlansPaginator struct {
	// contains filtered or unexported fields
}

ListPricingPlansPaginator is a paginator for ListPricingPlans

func NewListPricingPlansPaginator

func NewListPricingPlansPaginator(client ListPricingPlansAPIClient, params *ListPricingPlansInput, optFns ...func(*ListPricingPlansPaginatorOptions)) *ListPricingPlansPaginator

NewListPricingPlansPaginator returns a new ListPricingPlansPaginator

func (*ListPricingPlansPaginator) HasMorePages

func (p *ListPricingPlansPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPricingPlansPaginator) NextPage

func (p *ListPricingPlansPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPricingPlansOutput, error)

NextPage retrieves the next ListPricingPlans page.

type ListPricingPlansPaginatorOptions

type ListPricingPlansPaginatorOptions struct {
	// The maximum number of pricing plans to retrieve.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListPricingPlansPaginatorOptions is the paginator options for ListPricingPlans

type ListPricingRulesAPIClient

type ListPricingRulesAPIClient interface {
	ListPricingRules(context.Context, *ListPricingRulesInput, ...func(*Options)) (*ListPricingRulesOutput, error)
}

ListPricingRulesAPIClient is a client that implements the ListPricingRules operation.

type ListPricingRulesAssociatedToPricingPlanAPIClient

type ListPricingRulesAssociatedToPricingPlanAPIClient interface {
	ListPricingRulesAssociatedToPricingPlan(context.Context, *ListPricingRulesAssociatedToPricingPlanInput, ...func(*Options)) (*ListPricingRulesAssociatedToPricingPlanOutput, error)
}

ListPricingRulesAssociatedToPricingPlanAPIClient is a client that implements the ListPricingRulesAssociatedToPricingPlan operation.

type ListPricingRulesAssociatedToPricingPlanInput

type ListPricingRulesAssociatedToPricingPlanInput struct {

	//  The Amazon Resource Name (ARN) of the pricing plan for which associations are
	// to be listed.
	//
	// This member is required.
	PricingPlanArn *string

	//  The billing period for which the pricing rule associations are to be listed.
	BillingPeriod *string

	// The optional maximum number of pricing rule associations to retrieve.
	MaxResults *int32

	//  The optional pagination token returned by a previous call.
	NextToken *string
	// contains filtered or unexported fields
}

type ListPricingRulesAssociatedToPricingPlanOutput

type ListPricingRulesAssociatedToPricingPlanOutput struct {

	//  The billing period for which the pricing rule associations are listed.
	BillingPeriod *string

	//  The pagination token to be used on subsequent calls.
	NextToken *string

	//  The Amazon Resource Name (ARN) of the pricing plan for which associations are
	// listed.
	PricingPlanArn *string

	//  A list containing pricing rules that are associated with the requested pricing
	// plan.
	PricingRuleArns []string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListPricingRulesAssociatedToPricingPlanPaginator

type ListPricingRulesAssociatedToPricingPlanPaginator struct {
	// contains filtered or unexported fields
}

ListPricingRulesAssociatedToPricingPlanPaginator is a paginator for ListPricingRulesAssociatedToPricingPlan

func NewListPricingRulesAssociatedToPricingPlanPaginator

NewListPricingRulesAssociatedToPricingPlanPaginator returns a new ListPricingRulesAssociatedToPricingPlanPaginator

func (*ListPricingRulesAssociatedToPricingPlanPaginator) HasMorePages

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPricingRulesAssociatedToPricingPlanPaginator) NextPage

NextPage retrieves the next ListPricingRulesAssociatedToPricingPlan page.

type ListPricingRulesAssociatedToPricingPlanPaginatorOptions

type ListPricingRulesAssociatedToPricingPlanPaginatorOptions struct {
	// The optional maximum number of pricing rule associations to retrieve.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListPricingRulesAssociatedToPricingPlanPaginatorOptions is the paginator options for ListPricingRulesAssociatedToPricingPlan

type ListPricingRulesInput

type ListPricingRulesInput struct {

	//  The preferred billing period to get the pricing plan.
	BillingPeriod *string

	//  A DescribePricingRuleFilter that specifies the Amazon Resource Name (ARNs) of
	// pricing rules to retrieve pricing rules information.
	Filters *types.ListPricingRulesFilter

	//  The maximum number of pricing rules to retrieve.
	MaxResults *int32

	//  The pagination token that's used on subsequent call to get pricing rules.
	NextToken *string
	// contains filtered or unexported fields
}

type ListPricingRulesOutput

type ListPricingRulesOutput struct {

	//  The billing period for which the described pricing rules are applicable.
	BillingPeriod *string

	//  The pagination token that's used on subsequent calls to get pricing rules.
	NextToken *string

	//  A list containing the described pricing rules.
	PricingRules []types.PricingRuleListElement

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListPricingRulesPaginator

type ListPricingRulesPaginator struct {
	// contains filtered or unexported fields
}

ListPricingRulesPaginator is a paginator for ListPricingRules

func NewListPricingRulesPaginator

func NewListPricingRulesPaginator(client ListPricingRulesAPIClient, params *ListPricingRulesInput, optFns ...func(*ListPricingRulesPaginatorOptions)) *ListPricingRulesPaginator

NewListPricingRulesPaginator returns a new ListPricingRulesPaginator

func (*ListPricingRulesPaginator) HasMorePages

func (p *ListPricingRulesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPricingRulesPaginator) NextPage

func (p *ListPricingRulesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPricingRulesOutput, error)

NextPage retrieves the next ListPricingRules page.

type ListPricingRulesPaginatorOptions

type ListPricingRulesPaginatorOptions struct {
	//  The maximum number of pricing rules to retrieve.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListPricingRulesPaginatorOptions is the paginator options for ListPricingRules

type ListResourcesAssociatedToCustomLineItemAPIClient

type ListResourcesAssociatedToCustomLineItemAPIClient interface {
	ListResourcesAssociatedToCustomLineItem(context.Context, *ListResourcesAssociatedToCustomLineItemInput, ...func(*Options)) (*ListResourcesAssociatedToCustomLineItemOutput, error)
}

ListResourcesAssociatedToCustomLineItemAPIClient is a client that implements the ListResourcesAssociatedToCustomLineItem operation.

type ListResourcesAssociatedToCustomLineItemInput

type ListResourcesAssociatedToCustomLineItemInput struct {

	//  The ARN of the custom line item for which the resource associations will be
	// listed.
	//
	// This member is required.
	Arn *string

	//  The billing period for which the resource associations will be listed.
	BillingPeriod *string

	//  (Optional) A ListResourcesAssociatedToCustomLineItemFilter that can specify
	// the types of resources that should be retrieved.
	Filters *types.ListResourcesAssociatedToCustomLineItemFilter

	//  (Optional) The maximum number of resource associations to be retrieved.
	MaxResults *int32

	//  (Optional) The pagination token that's returned by a previous request.
	NextToken *string
	// contains filtered or unexported fields
}

type ListResourcesAssociatedToCustomLineItemOutput

type ListResourcesAssociatedToCustomLineItemOutput struct {

	//  The custom line item ARN for which the resource associations are listed.
	Arn *string

	//  A list of ListResourcesAssociatedToCustomLineItemResponseElement for each
	// resource association retrieved.
	AssociatedResources []types.ListResourcesAssociatedToCustomLineItemResponseElement

	//  The pagination token to be used in subsequent requests to retrieve additional
	// results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListResourcesAssociatedToCustomLineItemPaginator

type ListResourcesAssociatedToCustomLineItemPaginator struct {
	// contains filtered or unexported fields
}

ListResourcesAssociatedToCustomLineItemPaginator is a paginator for ListResourcesAssociatedToCustomLineItem

func NewListResourcesAssociatedToCustomLineItemPaginator

NewListResourcesAssociatedToCustomLineItemPaginator returns a new ListResourcesAssociatedToCustomLineItemPaginator

func (*ListResourcesAssociatedToCustomLineItemPaginator) HasMorePages

HasMorePages returns a boolean indicating whether more pages are available

func (*ListResourcesAssociatedToCustomLineItemPaginator) NextPage

NextPage retrieves the next ListResourcesAssociatedToCustomLineItem page.

type ListResourcesAssociatedToCustomLineItemPaginatorOptions

type ListResourcesAssociatedToCustomLineItemPaginatorOptions struct {
	//  (Optional) The maximum number of resource associations to be retrieved.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListResourcesAssociatedToCustomLineItemPaginatorOptions is the paginator options for ListResourcesAssociatedToCustomLineItem

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	//  The Amazon Resource Name (ARN) that identifies the resource to list the tags.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	//  The tags for the resource.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Options

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.11.2

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type TagResourceInput

type TagResourceInput struct {

	//  The Amazon Resource Name (ARN) of the resource to which to add tags.
	//
	// This member is required.
	ResourceArn *string

	//  The tags to add to the resource as a list of key-value pairs.
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput

type UntagResourceInput struct {

	//  The Amazon Resource Name (ARN) of the resource to which to delete tags.
	//
	// This member is required.
	ResourceArn *string

	//  The tags to delete from the resource as a list of key-value pairs.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateBillingGroupInput

type UpdateBillingGroupInput struct {

	// The Amazon Resource Name (ARN) of the billing group being updated.
	//
	// This member is required.
	Arn *string

	// Specifies if the billing group has automatic account association ( AutoAssociate
	// ) enabled.
	AccountGrouping *types.UpdateBillingGroupAccountGrouping

	//  The preferences and settings that will be used to compute the Amazon Web
	// Services charges for a billing group.
	ComputationPreference *types.ComputationPreference

	// A description of the billing group.
	Description *string

	// The name of the billing group. The names must be unique to each billing group.
	Name *string

	// The status of the billing group. Only one of the valid values can be used.
	Status types.BillingGroupStatus
	// contains filtered or unexported fields
}

type UpdateBillingGroupOutput

type UpdateBillingGroupOutput struct {

	// Specifies if the billing group has automatic account association ( AutoAssociate
	// ) enabled.
	AccountGrouping *types.UpdateBillingGroupAccountGrouping

	// The Amazon Resource Name (ARN) of the billing group that was updated.
	Arn *string

	//  A description of the billing group.
	Description *string

	//  The most recent time when the billing group was modified.
	LastModifiedTime int64

	//  The name of the billing group. The names must be unique to each billing group.
	Name *string

	//  The Amazon Resource Name (ARN) of the pricing plan to compute Amazon Web
	// Services charges for the billing group.
	PricingPlanArn *string

	//  The account ID that serves as the main account in a billing group.
	PrimaryAccountId *string

	//  The number of accounts in the particular billing group.
	Size int64

	//  The status of the billing group. Only one of the valid values can be used.
	Status types.BillingGroupStatus

	//  The reason why the billing group is in its current status.
	StatusReason *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateCustomLineItemInput

type UpdateCustomLineItemInput struct {

	//  The ARN of the custom line item to be updated.
	//
	// This member is required.
	Arn *string

	// The billing period range in which the custom line item request will be applied.
	BillingPeriodRange *types.CustomLineItemBillingPeriodRange

	//  A ListCustomLineItemChargeDetails containing the new charge details for the
	// custom line item.
	ChargeDetails *types.UpdateCustomLineItemChargeDetails

	//  The new line item description of the custom line item.
	Description *string

	//  The new name for the custom line item.
	Name *string
	// contains filtered or unexported fields
}

type UpdateCustomLineItemOutput

type UpdateCustomLineItemOutput struct {

	//  The ARN of the successfully updated custom line item.
	Arn *string

	//  The number of resources that are associated to the custom line item.
	AssociationSize int64

	//  The ARN of the billing group that the custom line item is applied to.
	BillingGroupArn *string

	//  A ListCustomLineItemChargeDetails containing the charge details of the
	// successfully updated custom line item.
	ChargeDetails *types.ListCustomLineItemChargeDetails

	//  The description of the successfully updated custom line item.
	Description *string

	//  The most recent time when the custom line item was modified.
	LastModifiedTime int64

	//  The name of the successfully updated custom line item.
	Name *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdatePricingPlanInput

type UpdatePricingPlanInput struct {

	// The Amazon Resource Name (ARN) of the pricing plan that you're updating.
	//
	// This member is required.
	Arn *string

	// The description of the pricing plan.
	Description *string

	// The name of the pricing plan. The name must be unique to each pricing plan.
	Name *string
	// contains filtered or unexported fields
}

type UpdatePricingPlanOutput

type UpdatePricingPlanOutput struct {

	// The Amazon Resource Name (ARN) of the updated pricing plan.
	Arn *string

	//  The new description for the pricing rule.
	Description *string

	//  The most recent time when the pricing plan was modified.
	LastModifiedTime int64

	//  The name of the pricing plan. The name must be unique to each pricing plan.
	Name *string

	//  The pricing rules count that's currently associated with this pricing plan
	// list.
	Size int64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdatePricingRuleInput

type UpdatePricingRuleInput struct {

	//  The Amazon Resource Name (ARN) of the pricing rule to update.
	//
	// This member is required.
	Arn *string

	//  The new description for the pricing rule.
	Description *string

	//  The new modifier to show pricing plan rates as a percentage.
	ModifierPercentage *float64

	//  The new name of the pricing rule. The name must be unique to each pricing
	// rule.
	Name *string

	//  The set of tiering configurations for the pricing rule.
	Tiering *types.UpdateTieringInput

	//  The new pricing rule type.
	Type types.PricingRuleType
	// contains filtered or unexported fields
}

type UpdatePricingRuleOutput

type UpdatePricingRuleOutput struct {

	//  The Amazon Resource Name (ARN) of the successfully updated pricing rule.
	Arn *string

	//  The pricing plans count that this pricing rule is associated with.
	AssociatedPricingPlanCount int64

	//  The seller of services provided by Amazon Web Services, their affiliates, or
	// third-party providers selling services via Amazon Web Services Marketplace.
	BillingEntity *string

	//  The new description for the pricing rule.
	Description *string

	//  The most recent time the pricing rule was modified.
	LastModifiedTime int64

	//  The new modifier to show pricing plan rates as a percentage.
	ModifierPercentage *float64

	//  The new name of the pricing rule. The name must be unique to each pricing
	// rule.
	Name *string

	// Operation refers to the specific Amazon Web Services covered by this line item.
	// This describes the specific usage of the line item.
	//
	// If the Scope attribute is set to SKU , this attribute indicates which operation
	// the PricingRule is modifying. For example, a value of RunInstances:0202
	// indicates the operation of running an Amazon EC2 instance.
	Operation *string

	//  The scope of pricing rule that indicates if it's globally applicable, or it's
	// service-specific.
	Scope types.PricingRuleScope

	//  If the Scope attribute is set to SERVICE , the attribute indicates which
	// service the PricingRule is applicable for.
	Service *string

	//  The set of tiering configurations for the pricing rule.
	Tiering *types.UpdateTieringInput

	//  The new pricing rule type.
	Type types.PricingRuleType

	// Usage type is the unit that each service uses to measure the usage of a
	// specific type of resource.
	//
	// If the Scope attribute is set to SKU , this attribute indicates which usage type
	// the PricingRule is modifying. For example, USW2-BoxUsage:m2.2xlarge describes
	// an M2 High Memory Double Extra Large instance in the US West (Oregon) Region.
	UsageType *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL