{ "smithy": "2.0", "shapes": { "com.amazonaws.billing#AWSBilling": { "type": "service", "version": "2023-09-07", "operations": [ { "target": "com.amazonaws.billing#AssociateContract" }, { "target": "com.amazonaws.billing#AssociateSourceViews" }, { "target": "com.amazonaws.billing#CancelContractualInvestmentAttestation" }, { "target": "com.amazonaws.billing#CreateBillingView" }, { "target": "com.amazonaws.billing#CreateContractualInvestmentAttestation" }, { "target": "com.amazonaws.billing#DeleteBillingView" }, { "target": "com.amazonaws.billing#DisassociateContract" }, { "target": "com.amazonaws.billing#DisassociateSourceViews" }, { "target": "com.amazonaws.billing#GetBillingPreferences" }, { "target": "com.amazonaws.billing#GetBillingView" }, { "target": "com.amazonaws.billing#GetContractInformation" }, { "target": "com.amazonaws.billing#GetCreditAllocationHistory" }, { "target": "com.amazonaws.billing#GetCredits" }, { "target": "com.amazonaws.billing#GetEnterpriseSupportChargeSummary" }, { "target": "com.amazonaws.billing#GetEnterpriseSupportContractDetails" }, { "target": "com.amazonaws.billing#GetResourcePolicy" }, { "target": "com.amazonaws.billing#ListBillingViews" }, { "target": "com.amazonaws.billing#ListBillingViewSegments" }, { "target": "com.amazonaws.billing#ListBusinessSupportAccountCharges" }, { "target": "com.amazonaws.billing#ListBusinessSupportSubscriptionHistory" }, { "target": "com.amazonaws.billing#ListContracts" }, { "target": "com.amazonaws.billing#ListContractualInvestmentAttestations" }, { "target": "com.amazonaws.billing#ListContractualInvestments" }, { "target": "com.amazonaws.billing#ListContractualInvestmentSummaries" }, { "target": "com.amazonaws.billing#ListEnterpriseSupportLinkedAccountCharges" }, { "target": "com.amazonaws.billing#ListSourceViewsForBillingView" }, { "target": "com.amazonaws.billing#ListTagsForResource" }, { "target": "com.amazonaws.billing#RedeemCredits" }, { "target": "com.amazonaws.billing#SplitCredit" }, { "target": "com.amazonaws.billing#TagResource" }, { "target": "com.amazonaws.billing#TransferCredit" }, { "target": "com.amazonaws.billing#UntagResource" }, { "target": "com.amazonaws.billing#UpdateBillingPreferences" }, { "target": "com.amazonaws.billing#UpdateBillingView" } ], "traits": { "aws.api#service": { "sdkId": "Billing", "endpointPrefix": "billing", "arnNamespace": "billing", "cloudTrailEventSource": "billing.amazonaws.com" }, "aws.auth#sigv4": { "name": "billing" }, "aws.endpoints#standardPartitionalEndpoints": { "endpointPatternType": "service_region_dnsSuffix", "partitionEndpointSpecialCases": { "aws": [ { "endpoint": "https://billing.us-east-1.api.aws", "region": "us-east-1", "dualStack": true }, { "endpoint": "https://billing.us-east-1.api.aws", "region": "us-east-1", "dualStack": false } ] } }, "aws.protocols#awsJson1_0": {}, "smithy.api#documentation": "
You can use the Billing API to programatically list the billing views available to you for a given time period. A billing view represents a set of billing data.
The Billing API provides the following endpoint:
https://billing.us-east-1.api.aws
You don't have sufficient access to perform this action.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.billing#AccountId": { "type": "string", "traits": { "smithy.api#pattern": "^[0-9]{12}$" } }, "com.amazonaws.billing#AccountList": { "type": "list", "member": { "target": "com.amazonaws.billing#AccountId" }, "traits": { "smithy.api#documentation": "A list of 12-digit Amazon Web Services account IDs. The list contains at most 100 account IDs.
", "smithy.api#length": { "max": 100 } } }, "com.amazonaws.billing#AccountName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.billing#ActiveTimeRange": { "type": "structure", "members": { "activeAfterInclusive": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The inclusive time range start date.
", "smithy.api#required": {} } }, "activeBeforeInclusive": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The inclusive time range end date.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A time range with a start and end time.
" } }, "com.amazonaws.billing#AdditionalCharge": { "type": "structure", "members": { "description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A description of the additional charge.
", "smithy.api#required": {} } }, "amount": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The charge amount.
" } }, "chargeType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The type of additional charge.
" } } }, "traits": { "smithy.api#documentation": "An additional charge applied to an Enterprise Support contract.
" } }, "com.amazonaws.billing#AdditionalChargeList": { "type": "list", "member": { "target": "com.amazonaws.billing#AdditionalCharge" }, "traits": { "smithy.api#documentation": "A list of additional charges.
", "smithy.api#length": { "max": 50 } } }, "com.amazonaws.billing#AdditionalRecipient": { "type": "structure", "members": { "email": { "target": "com.amazonaws.billing#SensitiveEmail", "traits": { "smithy.api#documentation": "The email address of the recipient. This value is 3\u2013256 characters and must be a valid email address.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A recipient copied as a viewer on the executive approval request, in addition to the approver.
" } }, "com.amazonaws.billing#AdditionalRecipients": { "type": "list", "member": { "target": "com.amazonaws.billing#AdditionalRecipient" }, "traits": { "smithy.api#documentation": "A list of recipients copied as viewers on the executive approval request. The list contains at most 10 recipients.
", "smithy.api#length": { "max": 10 } } }, "com.amazonaws.billing#Amount": { "type": "structure", "members": { "currencyCode": { "target": "com.amazonaws.billing#CurrencyCode", "traits": { "smithy.api#documentation": "The ISO 4217 currency code for the amount (for example, USD).
The amount as a decimal string (for example, \"743.21\"). Negative values represent credits that reduce a bill.
A monetary amount with a currency code. Used throughout the Billing API to represent credit balances, allocations, and adjustments.
" } }, "com.amazonaws.billing#ApplicationType": { "type": "enum", "members": { "BEFORE_CROSS_SERVICE_DISCOUNTS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BEFORE_CROSS_SERVICE_DISCOUNTS" } }, "AFTER_DISCOUNTS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AFTER_DISCOUNTS" } } } }, "com.amazonaws.billing#ApproverDetails": { "type": "structure", "members": { "name": { "target": "com.amazonaws.billing#SensitiveString", "traits": { "smithy.api#documentation": "The name of the approver as it appears on the contract. This value can be up to 256 characters.
", "smithy.api#required": {} } }, "title": { "target": "com.amazonaws.billing#SensitiveString", "traits": { "smithy.api#documentation": "The title of the approver, such as Chief Financial Officer. This value can be up to 256 characters.
The email address of the approver. This value is 3\u2013256 characters and must be a valid email address.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Information about the executive approver who signs off on an investment attestation.
" } }, "com.amazonaws.billing#ArnString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500 }, "smithy.api#pattern": "^arn:aws[a-z-]*:billing::[0-9]{12}:contract/[a-zA-Z0-9_\\+=\\.\\@-]{0,70}[a-zA-Z0-9]$" } }, "com.amazonaws.billing#AssociateContract": { "type": "operation", "input": { "target": "com.amazonaws.billing#AssociateContractRequest" }, "output": { "target": "com.amazonaws.billing#AssociateContractResponse" }, "errors": [ { "target": "com.amazonaws.billing#AccessDeniedException" }, { "target": "com.amazonaws.billing#ConflictException" }, { "target": "com.amazonaws.billing#InternalServerException" }, { "target": "com.amazonaws.billing#ResourceNotFoundException" }, { "target": "com.amazonaws.billing#ThrottlingException" }, { "target": "com.amazonaws.billing#ValidationException" } ], "traits": { "smithy.api#documentation": "Private Pricing contracts let eligible payer accounts manage private pricing agreements with Amazon Web Services. This operation associates a private pricing contract with the caller's Amazon Web Services account. The caller must be a payer (management) account listed on the contract. This operation is idempotent, so retrying a request that already succeeded is safe.
", "smithy.api#examples": [ { "title": "Invoke AssociateContract", "input": { "contractArn": "arn:aws:billing::123456789012:contract/1a2b3c4d-5e6f-7a8b-9c0d-111122223333", "contractDocumentId": "CC OTH XXXXXXXX XXXX TR" }, "output": {} } ], "smithy.api#idempotent": {} } }, "com.amazonaws.billing#AssociateContractRequest": { "type": "structure", "members": { "contractArn": { "target": "com.amazonaws.billing#ArnString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the contract to associate with your account.
", "smithy.api#required": {} } }, "contractDocumentId": { "target": "com.amazonaws.billing#ContractDocumentId", "traits": { "smithy.api#documentation": "The contract ID from the contract document. It can be found in the top right corner of your contract's pages. This value confirms that you have access to the contract you are associating.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.billing#AssociateContractResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.billing#AssociateSourceViews": { "type": "operation", "input": { "target": "com.amazonaws.billing#AssociateSourceViewsRequest" }, "output": { "target": "com.amazonaws.billing#AssociateSourceViewsResponse" }, "errors": [ { "target": "com.amazonaws.billing#AccessDeniedException" }, { "target": "com.amazonaws.billing#BillingViewHealthStatusException" }, { "target": "com.amazonaws.billing#ConflictException" }, { "target": "com.amazonaws.billing#InternalServerException" }, { "target": "com.amazonaws.billing#ResourceNotFoundException" }, { "target": "com.amazonaws.billing#ServiceQuotaExceededException" }, { "target": "com.amazonaws.billing#ThrottlingException" }, { "target": "com.amazonaws.billing#ValidationException" } ], "traits": { "smithy.api#documentation": "Associates one or more source billing views with an existing billing view. This allows creating aggregate billing views that combine data from multiple sources.
", "smithy.api#examples": [ { "title": "Invoke AssociateSourceViews", "input": { "arn": "arn:aws:billing::123456789012:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899", "sourceViews": [ "arn:aws:billing::123456789012:billingview/primary", "arn:aws:billing::123456789012:billingview/custom-d3f9c7e4-8b2f-4a6e-9d3b-2f7c8a1e5f6d" ] }, "output": { "arn": "arn:aws:billing::123456789012:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899" } } ], "smithy.api#idempotent": {} } }, "com.amazonaws.billing#AssociateSourceViewsRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.billing#BillingViewArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the billing view to associate source views with.
", "smithy.api#required": {} } }, "sourceViews": { "target": "com.amazonaws.billing#BillingViewSourceViewsList", "traits": { "smithy.api#documentation": "A list of ARNs of the source billing views to associate. Source views can be of the following types:
PRIMARY - The billing view that contains all cost management data associated with an account.
CUSTOM - A billing view that a customer creates from one or more source views.
BILLING_GROUP - The billing view for an Billing Conductor billing group.
BILLING_TRANSFER - The billing view for the billing data that a bill transfer account is financially responsible for.
BILLING_TRANSFER_SHOWBACK - The billing view for billing data configured for showback or chargeback purposes.
The ARN of the billing view that the source views were associated with.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.billing#AssociationStatus": { "type": "enum", "members": { "ASSOCIATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ASSOCIATED" } }, "NOT_ASSOCIATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_ASSOCIATED" } } }, "traits": { "smithy.api#documentation": "Indicates whether a contract is associated with your account. A value of ASSOCIATED indicates that the contract is associated with your account. A value of NOT_ASSOCIATED indicates that the contract is not associated with your account.
The value being attested, expressed as either a monetary amount or one or more quantities. Exactly one form is set.
", "smithy.api#required": {} } }, "investmentDistributions": { "target": "com.amazonaws.billing#InvestmentDistributions", "traits": { "smithy.api#documentation": "The distribution of the resulting investment across the eligible investment accounts on the contract. If you omit this value, the full investment is allocated to the single eligible investment account on the contract. This value is required when multiple investment accounts are eligible. When you provide this value, the sum of all distributions must equal the resulting monetary investment value (the attested amount, or the value computed from the attested quantities using the investment multipliers). The list contains at most 200 distributions.
" } } }, "traits": { "smithy.api#documentation": "The details of an investment attestation submission, including the value being attested and how the resulting investment is distributed.
" } }, "com.amazonaws.billing#AttestationQuantities": { "type": "list", "member": { "target": "com.amazonaws.billing#AttestationQuantity" }, "traits": { "smithy.api#documentation": "A list of quantity-based attestation values. The list contains at most 50 quantities.
", "smithy.api#length": { "max": 50 } } }, "com.amazonaws.billing#AttestationQuantity": { "type": "structure", "members": { "attestationVolume": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The number of units being attested, expressed as a decimal string to preserve precision. The value is digits with an optional decimal point and is 1\u20131000 characters.
", "smithy.api#length": { "min": 1, "max": 1000 }, "smithy.api#pattern": "^[0-9]+(\\.[0-9]+)?$", "smithy.api#required": {} } }, "attestationUnit": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The unit of the attestation, such as workloads migrated. This value is 1\u20131000 characters.
A quantity-based attestation value, such as a count of workloads migrated.
" } }, "com.amazonaws.billing#AttestationValue": { "type": "union", "members": { "attestationAmount": { "target": "com.amazonaws.billing#Amount", "traits": { "smithy.api#documentation": "The value attested as a monetary amount. This form is valid only when the investment has no multiplier.
" } }, "attestationQuantities": { "target": "com.amazonaws.billing#AttestationQuantities", "traits": { "smithy.api#documentation": "The value attested as one or more quantities, each with its own unit. The list contains at most 50 quantities.
" } } }, "traits": { "smithy.api#documentation": "The value being attested. This is a union in which exactly one member is set. Set attestationAmount to attest a monetary amount directly, or set attestationQuantities to attest one or more quantities that are converted to a value using the investment's multipliers.
The billing domain for a billing view segment. The following values are valid:
PRO_FORMA - Data shaped by Billing Conductor that doesn't reflect the final charges owed to Amazon Web Services.
BILLABLE - Data that represents the final charges owed to Amazon Web Services.
The filter name. Currently the only supported value is PREFERENCE_KEY.
The filter values to match. For PREFERENCE_KEY, supply 1 to 10 preference key values to match.
A filter that narrows the set of preferences returned by GetBillingPreferences.
The four-digit year of the billing period.
", "smithy.api#required": {} } }, "month": { "target": "com.amazonaws.billing#Month", "traits": { "smithy.api#documentation": "The month of the billing period as an integer between 1 and 12.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A specific billing period identified by year and month.
" } }, "com.amazonaws.billing#BillingPreferenceForKey": { "type": "structure", "members": { "key": { "target": "com.amazonaws.billing#PreferenceKey", "traits": { "smithy.api#documentation": "The preference key. Format depends on the feature being updated.
", "smithy.api#required": {} } }, "value": { "target": "com.amazonaws.billing#PreferenceValue", "traits": { "smithy.api#documentation": "The preference value. Valid values: ENABLED or DISABLED.
A single key/value entry used to update a billing preference.
" } }, "com.amazonaws.billing#BillingPreferenceSummary": { "type": "structure", "members": { "feature": { "target": "com.amazonaws.billing#BillingFeature", "traits": { "smithy.api#documentation": "The feature this preference belongs to.
", "smithy.api#required": {} } }, "key": { "target": "com.amazonaws.billing#PreferenceKey", "traits": { "smithy.api#documentation": "The preference key. Format depends on the feature.
", "smithy.api#required": {} } }, "value": { "target": "com.amazonaws.billing#PreferenceValue", "traits": { "smithy.api#documentation": "The preference value. Valid values: ENABLED or DISABLED.
The display name of the account. Populated together with accountId; null otherwise.
The associated Amazon Web Services account ID. Populated for account-list keys; null otherwise.
The billing period associated with the preference change. Populated only for the history features RI_SHARING_HISTORY and CREDIT_SHARING_HISTORY.
A single billing preference entry returned by GetBillingPreferences.
The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
" } }, "name": { "target": "com.amazonaws.billing#BillingViewName", "traits": { "smithy.api#documentation": "The account name of the billing view.
" } }, "description": { "target": "com.amazonaws.billing#BillingViewDescription", "traits": { "smithy.api#documentation": "The description of the billing view.
" } }, "billingViewType": { "target": "com.amazonaws.billing#BillingViewType", "traits": { "smithy.api#documentation": "The type of billing view. The following values are valid:
PRIMARY - The billing view that contains all cost management data associated with an account.
CUSTOM - A billing view that a customer creates from one or more source views.
BILLING_GROUP - The billing view for an Billing Conductor billing group.
BILLING_TRANSFER - The billing view for the billing data that a bill transfer account is financially responsible for.
BILLING_TRANSFER_SHOWBACK - The billing view for billing data configured for showback or chargeback purposes.
The account owner of the billing view.
" } }, "sourceAccountId": { "target": "com.amazonaws.billing#AccountId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID that owns the source billing view, if this is a derived billing view.
" } }, "dataFilterExpression": { "target": "com.amazonaws.billing#Expression", "traits": { "smithy.api#documentation": " See Expression. Billing view only supports LINKED_ACCOUNT, Tags, and CostCategories.
The time when the billing view was created.
" } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The time when the billing view was last updated.
" } }, "derivedViewCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of billing views that use this billing view as a source.
" } }, "sourceViewCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of source views associated with this billing view.
" } }, "viewDefinitionLastUpdatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when the billing view definition was last updated.
" } }, "healthStatus": { "target": "com.amazonaws.billing#BillingViewHealthStatus", "traits": { "smithy.api#documentation": "The current health status of the billing view.
" } } }, "traits": { "smithy.api#documentation": "The metadata associated to the billing view.
" } }, "com.amazonaws.billing#BillingViewHealthStatus": { "type": "structure", "members": { "statusCode": { "target": "com.amazonaws.billing#BillingViewStatus", "traits": { "smithy.api#documentation": "The current health status code of the billing view.
" } }, "statusReasons": { "target": "com.amazonaws.billing#BillingViewStatusReasons", "traits": { "smithy.api#documentation": "A list of reasons explaining the current health status, if applicable.
" } } }, "traits": { "smithy.api#documentation": "Represents the health status of a billing view, including a status code and optional reasons for the status.
" } }, "com.amazonaws.billing#BillingViewHealthStatusException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.billing#ErrorMessage", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": " Exception thrown when a billing view's health status prevents an operation from being performed. This may occur if the billing view is in a state other than HEALTHY.
The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
" } }, "name": { "target": "com.amazonaws.billing#BillingViewName", "traits": { "smithy.api#documentation": "A list of names of the Billing view.
" } }, "description": { "target": "com.amazonaws.billing#BillingViewDescription", "traits": { "smithy.api#documentation": "The description of the billing view.
" } }, "ownerAccountId": { "target": "com.amazonaws.billing#AccountId", "traits": { "smithy.api#documentation": "The list of owners of the Billing view.
" } }, "sourceAccountId": { "target": "com.amazonaws.billing#AccountId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID that owns the source billing view, if this is a derived billing view.
" } }, "billingViewType": { "target": "com.amazonaws.billing#BillingViewType", "traits": { "smithy.api#documentation": "The type of billing view. The following values are valid:
PRIMARY - The billing view that contains all cost management data associated with an account.
CUSTOM - A billing view that a customer creates from one or more source views.
BILLING_GROUP - The billing view for an Billing Conductor billing group.
BILLING_TRANSFER - The billing view for the billing data that a bill transfer account is financially responsible for.
BILLING_TRANSFER_SHOWBACK - The billing view for billing data configured for showback or chargeback purposes.
The current health status of the billing view.
" } } }, "traits": { "smithy.api#documentation": "A representation of a billing view.
" } }, "com.amazonaws.billing#BillingViewName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[ a-zA-Z0-9_\\+=\\.\\-@]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.billing#BillingViewSegmentTimeRange": { "type": "structure", "members": { "beginDateInclusive": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The inclusive start of the time range. This value can't be in the future.
" } }, "endDateExclusive": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": " The exclusive end of the time range. This value must be after beginDateInclusive.
Specifies a time range with an inclusive begin date and an exclusive end date.
" } }, "com.amazonaws.billing#BillingViewSegmentsList": { "type": "list", "member": { "target": "com.amazonaws.billing#BillingViewSegmentsListElement" }, "traits": { "smithy.api#documentation": "A list of billing view segments.
" } }, "com.amazonaws.billing#BillingViewSegmentsListElement": { "type": "structure", "members": { "domain": { "target": "com.amazonaws.billing#BillingDomain", "traits": { "smithy.api#documentation": "The billing domain for this segment. The following values are valid:
PRO_FORMA - Data shaped by Billing Conductor that doesn't reflect the final charges owed to Amazon Web Services.
BILLABLE - Data that represents the final charges owed to Amazon Web Services.
The time range during which this segment is effective.
" } }, "billingTransferAccountId": { "target": "com.amazonaws.billing#AccountId", "traits": { "smithy.api#documentation": "The billing transfer account ID. The response includes this field only when the caller is a billing transfer source account. The response omits this field for billing group billing views.
" } }, "managementAccountId": { "target": "com.amazonaws.billing#AccountId", "traits": { "smithy.api#documentation": "The management account ID of the organization. The response includes this field for organization member accounts.
" } }, "billingGroupPrimaryAccountId": { "target": "com.amazonaws.billing#AccountId", "traits": { "smithy.api#documentation": "The billing group primary account ID. The response includes this field for billing group members. Compare this value to your own account ID to determine whether you are the primary account.
" } } }, "traits": { "smithy.api#documentation": "A billing view segment. A segment represents a time range during which the billing domain and account relationships for a billing view remained unchanged.
" } }, "com.amazonaws.billing#BillingViewSourceViewsList": { "type": "list", "member": { "target": "com.amazonaws.billing#BillingViewArn" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.billing#BillingViewStatus": { "type": "enum", "members": { "HEALTHY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HEALTHY" } }, "UNHEALTHY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNHEALTHY" } }, "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } }, "UPDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATING" } } } }, "com.amazonaws.billing#BillingViewStatusReason": { "type": "enum", "members": { "SOURCE_VIEW_UNHEALTHY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SOURCE_VIEW_UNHEALTHY" } }, "SOURCE_VIEW_UPDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SOURCE_VIEW_UPDATING" } }, "SOURCE_VIEW_ACCESS_DENIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SOURCE_VIEW_ACCESS_DENIED" } }, "SOURCE_VIEW_NOT_FOUND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SOURCE_VIEW_NOT_FOUND" } }, "CYCLIC_DEPENDENCY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CYCLIC_DEPENDENCY" } }, "SOURCE_VIEW_DEPTH_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SOURCE_VIEW_DEPTH_EXCEEDED" } }, "AGGREGATE_SOURCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AGGREGATE_SOURCE" } }, "VIEW_OWNER_NOT_MANAGEMENT_ACCOUNT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VIEW_OWNER_NOT_MANAGEMENT_ACCOUNT" } } } }, "com.amazonaws.billing#BillingViewStatusReasons": { "type": "list", "member": { "target": "com.amazonaws.billing#BillingViewStatusReason" } }, "com.amazonaws.billing#BillingViewType": { "type": "enum", "members": { "PRIMARY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRIMARY" } }, "BILLING_GROUP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BILLING_GROUP" } }, "CUSTOM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CUSTOM" } }, "BILLING_TRANSFER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BILLING_TRANSFER" } }, "BILLING_TRANSFER_SHOWBACK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BILLING_TRANSFER_SHOWBACK" } } } }, "com.amazonaws.billing#BillingViewTypeList": { "type": "list", "member": { "target": "com.amazonaws.billing#BillingViewType" } }, "com.amazonaws.billing#BillingViewsMaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.billing#BillingYear": { "type": "integer", "traits": { "smithy.api#range": { "min": 2005, "max": 2120 } } }, "com.amazonaws.billing#BusinessSupportAccountCharge": { "type": "structure", "members": { "accountId": { "target": "com.amazonaws.billing#AccountId", "traits": { "smithy.api#documentation": "The linked account ID.
", "smithy.api#required": {} } }, "supportPlanName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Support plan name for this account. Valid values: AWSSupportBusiness (Business Support plan), AWSSupportDeveloper (Developer Support plan), AWSSupportEssential (Basic Support plan).
The total Business Support charge amount for this account in the billing month.
", "smithy.api#required": {} } }, "totalUsageBasis": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The total Support-eligible spend used as the basis for calculating the Business Support charge for this account.
", "smithy.api#required": {} } }, "tierCharges": { "target": "com.amazonaws.billing#BusinessSupportTierChargeList", "traits": { "smithy.api#documentation": "The tier-level charges that make up the total Business Support charge for this account. Each tier represents a spend range with its own rate.
" } }, "supportDiscount": { "target": "com.amazonaws.billing#BusinessSupportDiscount", "traits": { "smithy.api#documentation": "The discount applied to the Business Support charge for this account, if any. This field is absent when no discount applies.
" } }, "supportEligibleSpendByService": { "target": "com.amazonaws.billing#BusinessSupportServiceSpendList", "traits": { "smithy.api#documentation": "The Support-eligible spend broken down by contributing service for this account.
" } } }, "traits": { "smithy.api#documentation": "Business Support charges for a linked account.
" } }, "com.amazonaws.billing#BusinessSupportAccountChargeList": { "type": "list", "member": { "target": "com.amazonaws.billing#BusinessSupportAccountCharge" }, "traits": { "smithy.api#documentation": "A list of Business Support account charges.
", "smithy.api#length": { "max": 100 } } }, "com.amazonaws.billing#BusinessSupportBillingMonth": { "type": "string", "traits": { "smithy.api#documentation": "A billing month in YYYY-MM format. Supports the current month (estimated charges) and past months (finalized charges).
", "smithy.api#pattern": "^\\d{4}-(0[1-9]|1[0-2])$" } }, "com.amazonaws.billing#BusinessSupportDiscount": { "type": "structure", "members": { "discountAmount": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The discount amount applied to the Business Support charge. This value is negative, representing a reduction in the charge.
" } }, "discountPercentage": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The discount percentage applied to the Business Support charge, expressed as a decimal (for example, 0.12 for a 12% discount).
The type of discount applied. Valid values: Distributor_Discount (a discount applied through a distributor arrangement), SPP_Discount (a discount applied through the Solution Provider Program).
The source or program through which the discount was applied.
" } } }, "traits": { "smithy.api#documentation": "A discount applied to a Business Support account charge, including the discount amount, percentage, type, and source.
" } }, "com.amazonaws.billing#BusinessSupportServiceSpend": { "type": "structure", "members": { "contributingService": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the Amazon Web Services service contributing to the Support-eligible spend.
", "smithy.api#required": {} } }, "itemType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The type of the line item. Valid values: Usage.
A human-readable description of the service spend entry.
" } }, "chargeAmount": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Support-eligible spend amount for this service.
", "smithy.api#required": {} } }, "currency": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The ISO 4217 currency code for the charge amount (for example, USD).
A service-level spend entry contributing to Business Support eligible spend.
" } }, "com.amazonaws.billing#BusinessSupportServiceSpendList": { "type": "list", "member": { "target": "com.amazonaws.billing#BusinessSupportServiceSpend" }, "traits": { "smithy.api#documentation": "A list of Business Support service spend entries.
", "smithy.api#length": { "max": 50 } } }, "com.amazonaws.billing#BusinessSupportSubscriptionContract": { "type": "structure", "members": { "accountId": { "target": "com.amazonaws.billing#AccountId", "traits": { "smithy.api#documentation": "The account ID associated with this subscription contract.
", "smithy.api#required": {} } }, "planName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the Support plan for this subscription contract. Valid values: AWSSupportBusiness (Business Support plan), AWSSupportDeveloper (Developer Support plan), AWSSupportEssential (Basic Support plan).
The start date of the subscription contract.
", "smithy.api#required": {} } }, "contractEndDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The end date of the subscription contract.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A Business Support subscription contract for an account.
" } }, "com.amazonaws.billing#BusinessSupportSubscriptionContractList": { "type": "list", "member": { "target": "com.amazonaws.billing#BusinessSupportSubscriptionContract" }, "traits": { "smithy.api#documentation": "A list of Business Support subscription contracts.
", "smithy.api#length": { "max": 1000 } } }, "com.amazonaws.billing#BusinessSupportTierCharge": { "type": "structure", "members": { "tierDescription": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A human-readable description of the pricing tier, including the spend range and percentage rate applied.
", "smithy.api#required": {} } }, "tierRate": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The percentage rate applied to Support-eligible spend within this pricing tier.
", "smithy.api#required": {} } }, "usageSlice": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The amount of Support-eligible spend that falls within this pricing tier.
", "smithy.api#required": {} } }, "tierCharge": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Business Support charge amount calculated for this pricing tier.
", "smithy.api#required": {} } }, "chargePeriodStartDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The start date of the charge period for this tier charge.
" } }, "chargePeriodEndDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The end date of the charge period for this tier charge.
" } } }, "traits": { "smithy.api#documentation": "A tier-level charge within a Business Support pricing plan. Business Support uses tiered pricing where different percentage rates apply to different ranges of Support-eligible spend.
" } }, "com.amazonaws.billing#BusinessSupportTierChargeList": { "type": "list", "member": { "target": "com.amazonaws.billing#BusinessSupportTierCharge" }, "traits": { "smithy.api#documentation": "A list of Business Support tier charges.
", "smithy.api#length": { "max": 20 } } }, "com.amazonaws.billing#CancelContractualInvestmentAttestation": { "type": "operation", "input": { "target": "com.amazonaws.billing#CancelContractualInvestmentAttestationRequest" }, "output": { "target": "com.amazonaws.billing#CancelContractualInvestmentAttestationResponse" }, "errors": [ { "target": "com.amazonaws.billing#AccessDeniedException" }, { "target": "com.amazonaws.billing#ConflictException" }, { "target": "com.amazonaws.billing#InternalServerException" }, { "target": "com.amazonaws.billing#ResourceNotFoundException" }, { "target": "com.amazonaws.billing#ThrottlingException" }, { "target": "com.amazonaws.billing#ValidationException" } ], "traits": { "smithy.api#documentation": "Cancels a contractual investment attestation. This operation is idempotent, so retrying is safe. You can cancel an attestation only while it is still pending (its isCancellable value is true).
The identifier of the investment attestation to cancel.
", "smithy.api#required": {} } }, "contractArn": { "target": "com.amazonaws.billing#ArnString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the contract that contains the attested investment.
", "smithy.api#required": {} } }, "reason": { "target": "com.amazonaws.billing#CancellationReason", "traits": { "smithy.api#documentation": "The reason for the cancellation. This value can be 1 to 80 characters.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.billing#CancelContractualInvestmentAttestationResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.billing#CancellationReason": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 80 } } }, "com.amazonaws.billing#ChargeAccount": { "type": "structure", "members": { "accountId": { "target": "com.amazonaws.billing#AccountId", "traits": { "smithy.api#documentation": "The account ID.
", "smithy.api#required": {} } }, "chargePercentage": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The percentage of the total Support charge allocated to this account. This is 0.0 when supportAllocationMethod = Proportional.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An account that is charged all or a portion of the total Support charge and the percentage of the charge allocated to it.
" } }, "com.amazonaws.billing#ChargeAccountList": { "type": "list", "member": { "target": "com.amazonaws.billing#ChargeAccount" }, "traits": { "smithy.api#documentation": "A list of charge accounts.
", "smithy.api#length": { "max": 1000 } } }, "com.amazonaws.billing#ChildCredit": { "type": "structure", "members": { "creditId": { "target": "com.amazonaws.billing#CreditId", "traits": { "smithy.api#documentation": "The ID of the new credit. A dry run omits this field.
" } }, "amount": { "target": "com.amazonaws.billing#DecimalAmountString", "traits": { "smithy.api#documentation": "The amount of the new credit.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A new credit that a split created.
" } }, "com.amazonaws.billing#ChildCredits": { "type": "list", "member": { "target": "com.amazonaws.billing#ChildCredit" }, "traits": { "smithy.api#documentation": "The new credits that a split created, or would create in a dry run.
", "smithy.api#length": { "min": 2, "max": 99 } } }, "com.amazonaws.billing#ClientToken": { "type": "string", "traits": { "smithy.api#pattern": "^[a-zA-Z0-9-]+$" } }, "com.amazonaws.billing#ConflictException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.billing#ErrorMessage", "traits": { "smithy.api#required": {} } }, "resourceId": { "target": "com.amazonaws.billing#ResourceId", "traits": { "smithy.api#documentation": "The identifier for the service resource associated with the request.
", "smithy.api#required": {} } }, "resourceType": { "target": "com.amazonaws.billing#ResourceType", "traits": { "smithy.api#documentation": "The type of resource associated with the request.
", "smithy.api#required": {} } } }, "traits": { "aws.protocols#awsQueryError": { "code": "BillingConflict", "httpResponseCode": 409 }, "smithy.api#documentation": "The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.billing#ContractAccount": { "type": "structure", "members": { "accountId": { "target": "com.amazonaws.billing#AccountId", "traits": { "smithy.api#documentation": "The account ID.
", "smithy.api#required": {} } }, "isGdn": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "When true, Support charges are calculated on charges before private discounts. When false, they are calculated after private discounts.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An account that is covered by the Enterprise Support contract.
" } }, "com.amazonaws.billing#ContractAccountList": { "type": "list", "member": { "target": "com.amazonaws.billing#ContractAccount" }, "traits": { "smithy.api#documentation": "A list of accounts that appear in the Enterprise Support Contract.
", "smithy.api#length": { "max": 2000 } } }, "com.amazonaws.billing#ContractDetails": { "type": "union", "members": { "privatePricingAddendum": { "target": "com.amazonaws.billing#PrivatePricingAddendum", "traits": { "smithy.api#documentation": "The details of a private pricing addendum contract. This member is set when the contract is a private pricing addendum.
" } } }, "traits": { "smithy.api#documentation": "The details of a contract returned by GetContractInformation. This is a union in which exactly one member is set, corresponding to the contract type. For a private pricing addendum, the privatePricingAddendum member is set. Check which member is present to determine the contract type.
A restriction that limits the self-service actions you can take on a contract. A contract with no restrictions supports all self-service actions.
" } }, "com.amazonaws.billing#ContractRestrictions": { "type": "list", "member": { "target": "com.amazonaws.billing#ContractRestriction" }, "traits": { "smithy.api#documentation": "A list of restrictions that apply to a contract. An empty or absent value indicates that no restrictions apply. The list contains at most 10 restrictions.
", "smithy.api#length": { "max": 10 } } }, "com.amazonaws.billing#ContractSummaries": { "type": "list", "member": { "target": "com.amazonaws.billing#ContractSummary" }, "traits": { "smithy.api#documentation": "A list of private pricing contract summaries, as returned by ListContracts.
The Amazon Resource Name (ARN) of the contract. Pass this value to operations such as GetContractInformation, ListContractualInvestmentSummaries, and AssociateContract.
The contract term period of the contract, expressed as an interval with an inclusive start date and an inclusive end date.
", "smithy.api#required": {} } }, "contractType": { "target": "com.amazonaws.billing#ContractType", "traits": { "smithy.api#documentation": "The classification of the contract. Valid values are Cross-Service, Service-Specific, and Other. Cross-Service applies across multiple Amazon Web Services services. Service-Specific applies to a specific Amazon Web Services service. Other applies to other arrangements.
Indicates whether the contract is currently associated with your account. Valid values are ASSOCIATED and NOT_ASSOCIATED. ASSOCIATED means the contract is associated with your account. NOT_ASSOCIATED means the contract is not associated with your account.
The time when the contract was last associated with your account.
" } } }, "traits": { "smithy.api#documentation": "A summary of a private pricing contract visible to your account. ListContracts returns these summaries.
The classification of a private pricing contract. A value of Cross-Service indicates that the contract terms apply across multiple Amazon Web Services services. A value of Service-Specific indicates that the contract terms apply to a specific Amazon Web Services service. A value of Other indicates that the contract terms apply to other arrangements.
The specific value of the Cost Category.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The Cost Categories values used for filtering the costs.
" } }, "com.amazonaws.billing#CreateBillingView": { "type": "operation", "input": { "target": "com.amazonaws.billing#CreateBillingViewRequest" }, "output": { "target": "com.amazonaws.billing#CreateBillingViewResponse" }, "errors": [ { "target": "com.amazonaws.billing#AccessDeniedException" }, { "target": "com.amazonaws.billing#BillingViewHealthStatusException" }, { "target": "com.amazonaws.billing#ConflictException" }, { "target": "com.amazonaws.billing#InternalServerException" }, { "target": "com.amazonaws.billing#ResourceNotFoundException" }, { "target": "com.amazonaws.billing#ServiceQuotaExceededException" }, { "target": "com.amazonaws.billing#ThrottlingException" }, { "target": "com.amazonaws.billing#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates a billing view with the specified billing view attributes.
", "smithy.api#examples": [ { "title": "Invoke CreateBillingView", "input": { "name": "Example Custom Billing View", "sourceViews": [ "arn:aws:billing::123456789101:billingview/primary" ], "description": "Custom Billing View Example", "dataFilterExpression": { "dimensions": { "key": "LINKED_ACCOUNT", "values": [ "000000000000" ] } } }, "output": { "arn": "arn:aws:billing::123456789101:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899", "createdAt": 1719792001 } } ], "smithy.api#idempotent": {} } }, "com.amazonaws.billing#CreateBillingViewRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.billing#BillingViewName", "traits": { "smithy.api#documentation": "The name of the billing view.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.billing#BillingViewDescription", "traits": { "smithy.api#documentation": "The description of the billing view.
" } }, "sourceViews": { "target": "com.amazonaws.billing#BillingViewSourceViewsList", "traits": { "smithy.api#documentation": "A list of billing views used as the data source for the custom billing view. Source views can be of the following types:
PRIMARY - The billing view that contains all cost management data associated with an account.
CUSTOM - A billing view that a customer creates from one or more source views.
BILLING_GROUP - The billing view for an Billing Conductor billing group.
BILLING_TRANSFER - The billing view for the billing data that a bill transfer account is financially responsible for.
BILLING_TRANSFER_SHOWBACK - The billing view for billing data configured for showback or chargeback purposes.
See Expression. Billing view only supports LINKED_ACCOUNT, Tags, and CostCategories.
A unique, case-sensitive identifier you specify to ensure idempotency of the request. Idempotency ensures that an API request completes no more than one time. If the original request completes successfully, any subsequent retries complete successfully without performing any further actions with an idempotent request.
", "smithy.api#httpHeader": "X-Amzn-Client-Token", "smithy.api#idempotencyToken": {} } }, "resourceTags": { "target": "com.amazonaws.billing#ResourceTagList", "traits": { "smithy.api#documentation": "A list of key value map specifying tags associated to the billing view being created.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.billing#CreateBillingViewResponse": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.billing#BillingViewArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The time when the billing view was created.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.billing#CreateContractualInvestmentAttestation": { "type": "operation", "input": { "target": "com.amazonaws.billing#CreateContractualInvestmentAttestationRequest" }, "output": { "target": "com.amazonaws.billing#CreateContractualInvestmentAttestationResponse" }, "errors": [ { "target": "com.amazonaws.billing#AccessDeniedException" }, { "target": "com.amazonaws.billing#ConflictException" }, { "target": "com.amazonaws.billing#InternalServerException" }, { "target": "com.amazonaws.billing#ResourceNotFoundException" }, { "target": "com.amazonaws.billing#ThrottlingException" }, { "target": "com.amazonaws.billing#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates an attestation that claims an investment award for a completed milestone or outcome within a private pricing contract. Supply a clientToken to make the request idempotent so a safe retry does not create a duplicate attestation. This operation starts an asynchronous review and returns an attestationId while the attestation is pending.
The Amazon Resource Name (ARN) of the contract that contains the investment being attested.
", "smithy.api#required": {} } }, "investmentSummaryId": { "target": "com.amazonaws.billing#IdentifierString", "traits": { "smithy.api#documentation": "The identifier of the investment summary being attested. This is the parent to the investmentId.
", "smithy.api#required": {} } }, "investmentId": { "target": "com.amazonaws.billing#IdentifierString", "traits": { "smithy.api#documentation": "The identifier of the investment (outcome) being attested.
", "smithy.api#required": {} } }, "contractDocumentId": { "target": "com.amazonaws.billing#ContractDocumentId", "traits": { "smithy.api#documentation": "The contract ID from the contract document, located in the top-right corner of the private pricing contract pages. This value confirms that you have access to the contract.
", "smithy.api#required": {} } }, "approverDetails": { "target": "com.amazonaws.billing#ApproverDetails", "traits": { "smithy.api#documentation": "The details of the executive who authorized the attestation, under the terms of the private pricing contract. The executive receives a click-to-accept email to confirm the attestation.
", "smithy.api#required": {} } }, "investmentDisbursedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The date on which the investment is disbursed to the investment accounts. The disbursement date is subject to review timelines.
" } }, "attestationDetails": { "target": "com.amazonaws.billing#AttestationDetails", "traits": { "smithy.api#documentation": "The details of the attestation, including the value being claimed and how the resulting investment is distributed across investment accounts.
", "smithy.api#required": {} } }, "additionalRecipients": { "target": "com.amazonaws.billing#AdditionalRecipients", "traits": { "smithy.api#documentation": "The email addresses to copy as viewers on the executive approval request.
" } }, "clientToken": { "target": "com.amazonaws.billing#AttestationClientToken", "traits": { "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry completes without performing any further actions.
", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.billing#CreateContractualInvestmentAttestationResponse": { "type": "structure", "members": { "attestationId": { "target": "com.amazonaws.billing#IdentifierString", "traits": { "smithy.api#documentation": "The identifier of the submitted attestation.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.billing#CreditAllocationHistoryEntry": { "type": "structure", "members": { "creditId": { "target": "com.amazonaws.billing#CreditId", "traits": { "smithy.api#documentation": "The identifier of the credit that was applied.
", "smithy.api#required": {} } }, "creditAmount": { "target": "com.amazonaws.billing#Amount", "traits": { "smithy.api#documentation": "The amount of credit applied. Negative values represent credits that reduced the bill.
", "smithy.api#required": {} } }, "description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A human-readable description of the credit allocation.
" } }, "accountId": { "target": "com.amazonaws.billing#AccountId", "traits": { "smithy.api#documentation": "The Amazon Web Services account the credit was applied to.
", "smithy.api#required": {} } }, "appliedServiceName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Web Services service the credit was applied to.
", "smithy.api#required": {} } }, "billingMonth": { "target": "com.amazonaws.billing#BillingMonth", "traits": { "smithy.api#documentation": "The billing month of the application in YYYY-MM format.
true when the entry was applied to an in-flight bill that has not yet been finalized.
A single entry in the credit allocation history, representing how a credit was applied to a specific service during a billing month.
" } }, "com.amazonaws.billing#CreditAllocationHistoryList": { "type": "list", "member": { "target": "com.amazonaws.billing#CreditAllocationHistoryEntry" } }, "com.amazonaws.billing#CreditData": { "type": "structure", "members": { "creditId": { "target": "com.amazonaws.billing#CreditId", "traits": { "smithy.api#documentation": "The unique identifier for the credit.
", "smithy.api#required": {} } }, "accountId": { "target": "com.amazonaws.billing#AccountId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID that owns the credit.
", "smithy.api#required": {} } }, "creditType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The type of credit. Examples: Promotion, Refund, TrueUp.
The initial amount of the credit when it was issued.
", "smithy.api#required": {} } }, "remainingAmount": { "target": "com.amazonaws.billing#Amount", "traits": { "smithy.api#documentation": "The unused balance of the credit.
", "smithy.api#required": {} } }, "estimatedAmount": { "target": "com.amazonaws.billing#Amount", "traits": { "smithy.api#documentation": "The estimated remaining balance, including in-flight (open) bills that have not yet been finalized.
" } }, "applicableProductNames": { "target": "com.amazonaws.billing#ProductNames", "traits": { "smithy.api#documentation": "The names of Amazon Web Services services this credit applies to.
" } }, "description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A human-readable description of the credit.
", "smithy.api#required": {} } }, "startDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The date the credit becomes valid, as Unix epoch seconds.
", "smithy.api#required": {} } }, "endDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The date the credit expires, as Unix epoch seconds.
" } }, "exhaustDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The date the credit balance reached zero, as Unix epoch seconds.
" } }, "applicationType": { "target": "com.amazonaws.billing#ApplicationType", "traits": { "smithy.api#documentation": "When the credit is applied during bill computation. Valid values: BEFORE_CROSS_SERVICE_DISCOUNTS, AFTER_DISCOUNTS.
The Amazon Web Services account IDs entitled to apply this credit.
" } }, "accountHasCreditSharingEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Whether the owning account has account-level credit sharing turned on.
" } }, "creditConsoleVisibility": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The display configuration for the credit in the Amazon Web Services Billing console.
" } }, "creditSharingType": { "target": "com.amazonaws.billing#CreditSharingType", "traits": { "smithy.api#documentation": "The sharing configuration for the credit. Valid values: DEFAULT, DISABLED, CUSTOM, COST_CATEGORY_RULE.
The Amazon Resource Name (ARN) of the Cost Category controlling the credit's sharing scope. Present only when creditSharingType is COST_CATEGORY_RULE.
The rule name within the Cost Category. Present only when creditSharingType is COST_CATEGORY_RULE.
Whether the credit participates in billing runs. Valid values: ENABLED, DISABLED.
Restricts which purchase types this credit applies to. When null or omitted, the credit applies to all purchase types.
Detailed information about an Amazon Web Services credit, including its identifier, type, monetary amounts, applicable products, sharing configuration, and current enabled status.
" } }, "com.amazonaws.billing#CreditDataList": { "type": "list", "member": { "target": "com.amazonaws.billing#CreditData" } }, "com.amazonaws.billing#CreditId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 32 }, "smithy.api#pattern": "^[0-9]+$" } }, "com.amazonaws.billing#CreditSharingType": { "type": "enum", "members": { "DEFAULT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEFAULT" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } }, "CUSTOM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CUSTOM" } }, "COST_CATEGORY_RULE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COST_CATEGORY_RULE" } } } }, "com.amazonaws.billing#CreditStatus": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } } } }, "com.amazonaws.billing#CurrencyAmount": { "type": "string", "traits": { "smithy.api#pattern": "^[0-9]+(.[0-9]+)$" } }, "com.amazonaws.billing#CurrencyCode": { "type": "string", "traits": { "smithy.api#pattern": "^[A-Z]{3}$" } }, "com.amazonaws.billing#DecimalAmountString": { "type": "string", "traits": { "smithy.api#documentation": "The amount, as a decimal string with at most six decimal places, for example 2400.000000. The amount is always in the currency of the credit, so unlike Amount it carries no currency code. A decimal string, not a floating-point number, lets portions add up exactly to a balance.
Deletes the specified billing view.
", "smithy.api#examples": [ { "title": "Invoke DeleteBillingView", "input": { "arn": "arn:aws:billing::123456789101:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899" }, "output": { "arn": "arn:aws:billing::123456789101:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899" } } ], "smithy.api#idempotent": {} } }, "com.amazonaws.billing#DeleteBillingViewRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.billing#BillingViewArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
", "smithy.api#required": {} } }, "force": { "target": "smithy.api#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "If set to true, forces deletion of the billing view even if it has derived resources (e.g. other billing views or budgets). Use with caution as this may break dependent resources.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.billing#DeleteBillingViewResponse": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.billing#BillingViewArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.billing#Dimension": { "type": "enum", "members": { "LINKED_ACCOUNT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LINKED_ACCOUNT" } } } }, "com.amazonaws.billing#DimensionValues": { "type": "structure", "members": { "key": { "target": "com.amazonaws.billing#Dimension", "traits": { "smithy.api#documentation": "The names of the metadata types that you can use to filter and group your results.
", "smithy.api#required": {} } }, "values": { "target": "com.amazonaws.billing#Values", "traits": { "smithy.api#documentation": "The metadata values that you can use to filter and group your results.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The metadata that you can use to filter and group your results.
" } }, "com.amazonaws.billing#DisassociateContract": { "type": "operation", "input": { "target": "com.amazonaws.billing#DisassociateContractRequest" }, "output": { "target": "com.amazonaws.billing#DisassociateContractResponse" }, "errors": [ { "target": "com.amazonaws.billing#AccessDeniedException" }, { "target": "com.amazonaws.billing#InternalServerException" }, { "target": "com.amazonaws.billing#ResourceNotFoundException" }, { "target": "com.amazonaws.billing#ThrottlingException" }, { "target": "com.amazonaws.billing#ValidationException" } ], "traits": { "smithy.api#documentation": "Removes the association between a private pricing contract and your Amazon Web Services account. The account must have been associated with the contract previously. This operation is idempotent, so retrying is safe.
", "smithy.api#examples": [ { "title": "Invoke DisassociateContract", "input": { "contractArn": "arn:aws:billing::123456789012:contract/1a2b3c4d-5e6f-7a8b-9c0d-111122223333" }, "output": {} } ], "smithy.api#idempotent": {} } }, "com.amazonaws.billing#DisassociateContractRequest": { "type": "structure", "members": { "contractArn": { "target": "com.amazonaws.billing#ArnString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the contract to disassociate from your account.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.billing#DisassociateContractResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.billing#DisassociateSourceViews": { "type": "operation", "input": { "target": "com.amazonaws.billing#DisassociateSourceViewsRequest" }, "output": { "target": "com.amazonaws.billing#DisassociateSourceViewsResponse" }, "errors": [ { "target": "com.amazonaws.billing#AccessDeniedException" }, { "target": "com.amazonaws.billing#BillingViewHealthStatusException" }, { "target": "com.amazonaws.billing#ConflictException" }, { "target": "com.amazonaws.billing#InternalServerException" }, { "target": "com.amazonaws.billing#ResourceNotFoundException" }, { "target": "com.amazonaws.billing#ThrottlingException" }, { "target": "com.amazonaws.billing#ValidationException" } ], "traits": { "smithy.api#documentation": "Removes the association between one or more source billing views and an existing billing view. This allows modifying the composition of aggregate billing views.
", "smithy.api#examples": [ { "title": "Invoke DisassociateSourceViews", "input": { "arn": "arn:aws:billing::123456789012:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899", "sourceViews": [ "arn:aws:billing::123456789012:billingview/primary", "arn:aws:billing::123456789012:billingview/custom-d3f9c7e4-8b2f-4a6e-9d3b-2f7c8a1e5f6d" ] }, "output": { "arn": "arn:aws:billing::123456789012:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899" } } ], "smithy.api#idempotent": {} } }, "com.amazonaws.billing#DisassociateSourceViewsRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.billing#BillingViewArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the billing view to disassociate source views from.
", "smithy.api#required": {} } }, "sourceViews": { "target": "com.amazonaws.billing#BillingViewSourceViewsList", "traits": { "smithy.api#documentation": "A list of ARNs of the source billing views to disassociate.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.billing#DisassociateSourceViewsResponse": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.billing#BillingViewArn", "traits": { "smithy.api#documentation": "The ARN of the billing view that the source views were disassociated from.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.billing#EnterpriseSupportBillingMonth": { "type": "string", "traits": { "smithy.api#documentation": "The billing month in YYYY-MM format. This must be a month in the past.
", "smithy.api#pattern": "^\\d{4}-(0[1-9]|1[0-2])$" } }, "com.amazonaws.billing#EnterpriseSupportTimePeriod": { "type": "structure", "members": { "beginDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The begin date of the time period.
", "smithy.api#required": {} } }, "endDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The end date of the time period.
" } } }, "traits": { "smithy.api#documentation": "A time period for Enterprise Support billing.
" } }, "com.amazonaws.billing#ErrorMessage": { "type": "string", "traits": { "smithy.api#length": { "max": 1024 } } }, "com.amazonaws.billing#Expression": { "type": "structure", "members": { "dimensions": { "target": "com.amazonaws.billing#DimensionValues", "traits": { "smithy.api#documentation": " The specific Dimension to use for Expression.
The specific Tag to use for Expression.
The filter that's based on CostCategory values.
Specifies a time range filter for the billing view data.
" } } }, "traits": { "smithy.api#documentation": " See Expression. Billing view only supports LINKED_ACCOUNT, Tags, and CostCategories.
Retrieves billing preferences for the specified feature. Each feature controls a distinct billing capability: which accounts can share Reserved Instances or credits, whether billing alerts are enabled, the historical record of sharing changes, per-credit options, and which accounts an individual Reserved Instance or Savings Plan is shared with.
" } }, "com.amazonaws.billing#GetBillingPreferencesRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.billing#PageToken", "traits": { "smithy.api#documentation": "Pagination token from a previous response. Pass the value returned in nextToken to retrieve the next page of results.
The maximum number of records to return per page. Range: 1 to 50. Default: 50.
", "smithy.api#range": { "min": 1, "max": 50 } } }, "features": { "target": "com.amazonaws.billing#BillingFeatures", "traits": { "smithy.api#documentation": "The feature to retrieve. Specify exactly one value. Valid values: BILLING_ALERTS, RI_SHARING, RI_SHARING_HISTORY, CREDIT_SHARING, CREDIT_SHARING_HISTORY, CREDIT_LEVEL_SHARING, CREDIT_PREFERENCE_OPTIONS, BENEFIT_LEVEL_SHARING.
Filters to narrow results. Specify exactly one filter when supplied. The supported filter name is PREFERENCE_KEY, which accepts 1 to 10 values to match preference keys.
For BENEFIT_LEVEL_SHARING, this filter is required. Specify exactly one value that identifies the Reserved Instance (RI) or Savings Plan (SP), in the form benefit/{ri|sp}/{benefitId}.
The list of preference entries matching the request.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.billing#PageToken", "traits": { "smithy.api#documentation": "Pagination token. Present when more pages are available; null when there are no more results.
Returns the metadata associated to the specified billing view ARN.
", "smithy.api#examples": [ { "title": "Invoke GetBillingView", "input": { "arn": "arn:aws:billing::123456789101:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899" }, "output": { "billingView": { "arn": "arn:aws:billing::123456789101:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899", "name": "Example Custom Billing View", "description": "Custom Billing View Example -- updated description", "dataFilterExpression": { "dimensions": { "key": "LINKED_ACCOUNT", "values": [ "000000000000" ] } }, "ownerAccountId": "123456789101", "billingViewType": "CUSTOM" } } } ], "smithy.api#readonly": {} } }, "com.amazonaws.billing#GetBillingViewRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.billing#BillingViewArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.billing#GetBillingViewResponse": { "type": "structure", "members": { "billingView": { "target": "com.amazonaws.billing#BillingViewElement", "traits": { "smithy.api#documentation": "The billing view element associated with the specified ARN.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.billing#GetContractInformation": { "type": "operation", "input": { "target": "com.amazonaws.billing#GetContractInformationRequest" }, "output": { "target": "com.amazonaws.billing#GetContractInformationResponse" }, "errors": [ { "target": "com.amazonaws.billing#AccessDeniedException" }, { "target": "com.amazonaws.billing#InternalServerException" }, { "target": "com.amazonaws.billing#ResourceNotFoundException" }, { "target": "com.amazonaws.billing#ThrottlingException" }, { "target": "com.amazonaws.billing#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns information about a specific private pricing contract, including its term (duration), eligible payer accounts, investment accounts, and legal entities. This operation is read-only.
", "smithy.api#examples": [ { "title": "Invoke GetContractInformation", "input": { "contractArn": "arn:aws:billing::123456789012:contract/1a2b3c4d-5e6f-7a8b-9c0d-111122223333" }, "output": { "contract": { "privatePricingAddendum": { "contractArn": "arn:aws:billing::123456789012:contract/1a2b3c4d-5e6f-7a8b-9c0d-111122223333", "contractTerm": { "startDateInclusive": 1111111111, "endDateInclusive": 1222222222 }, "eligiblePayerAccounts": [ "123456789012", "210987654321" ], "investmentAccounts": [ "123456789012" ], "legalEntities": [ { "legalEntityName": "Example Legal Entity Name" } ] } } } } ], "smithy.api#readonly": {} } }, "com.amazonaws.billing#GetContractInformationRequest": { "type": "structure", "members": { "contractArn": { "target": "com.amazonaws.billing#ArnString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the contract to retrieve information about.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.billing#GetContractInformationResponse": { "type": "structure", "members": { "contract": { "target": "com.amazonaws.billing#ContractDetails", "traits": { "smithy.api#documentation": "The contract details such as term (duration), eligible payer accounts, investment accounts, and legal entities.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.billing#GetCreditAllocationHistory": { "type": "operation", "input": { "target": "com.amazonaws.billing#GetCreditAllocationHistoryRequest" }, "output": { "target": "com.amazonaws.billing#GetCreditAllocationHistoryResponse" }, "errors": [ { "target": "com.amazonaws.billing#AccessDeniedException" }, { "target": "com.amazonaws.billing#InternalServerException" }, { "target": "com.amazonaws.billing#ThrottlingException" }, { "target": "com.amazonaws.billing#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns the per-billing-month allocation history for credits applied to an Amazon Web Services account's bills. Traverses the consolidated billing family to capture cross-account credit applications. Supports pagination and optional filtering to a single credit.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "creditAllocationHistoryList" } } }, "com.amazonaws.billing#GetCreditAllocationHistoryRequest": { "type": "structure", "members": { "accountId": { "target": "com.amazonaws.billing#AccountId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID whose allocation history to retrieve. Must be a 12-digit numeric string.
", "smithy.api#required": {} } }, "creditId": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "Filters the result to a single credit. When omitted, returns allocation entries for all credits.
" } }, "startDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The inclusive start date of the range, in Unix epoch seconds. This value must be earlier than endDate. You get credit allocations for bills whose billing period starts on or after startDate and before endDate. If startDate is in the middle of a billing period, that period isn't included. The range can't exceed 24 calendar months.
The exclusive end date of the range, in Unix epoch seconds. To get one billing month, set startDate to the first day of that month. Then set endDate to the first day of the next month. Use 00:00 UTC for both.
Pagination token from a previous response. Pass the value returned in nextToken to retrieve the next page of results.
The maximum number of records to return per page. Range: 1 to 1000. Default: 100.
", "smithy.api#range": { "min": 1, "max": 1000 } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.billing#GetCreditAllocationHistoryResponse": { "type": "structure", "members": { "creditAllocationHistoryList": { "target": "com.amazonaws.billing#CreditAllocationHistoryList", "traits": { "smithy.api#documentation": "Allocation entries sorted by billingMonth in descending order.
true when data could not be retrieved for one or more billing months. The failedMonths field lists which months are missing.
Billing months in YYYY-MM format that failed to return data. Non-empty only when partialResults is true.
Pagination token. Present when more pages are available; null when there are no more results.
Returns the list of Amazon Web Services account credits for the specified account. Each credit includes its identifier, type, monetary amounts, applicable products, expiration, sharing configuration, and current enabled status.
When the caller is the management account of a consolidated billing family and payerAccountFlag is true, the response aggregates credits across the entire family. Otherwise, the response includes only credits owned by the account specified in accountId.
The Amazon Web Services account ID. Must be a 12-digit numeric string.
", "smithy.api#required": {} } }, "startDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The start date for the credit period as Unix epoch seconds. Must be a past date that is not more than one year before the current date.
", "smithy.api#required": {} } }, "endDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The end date for the credit period as Unix epoch seconds. Must not be a future date and must be on or after startDate. Defaults to the current date when omitted.
When true and the caller is the management account, the response aggregates credits across the entire consolidated billing family. When false or omitted, returns only credits for the specified accountId.
The list of credits matching the request. Returns an empty list when no credits exist.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.billing#GetEnterpriseSupportChargeSummary": { "type": "operation", "input": { "target": "com.amazonaws.billing#GetEnterpriseSupportChargeSummaryRequest" }, "output": { "target": "com.amazonaws.billing#GetEnterpriseSupportChargeSummaryResponse" }, "errors": [ { "target": "com.amazonaws.billing#AccessDeniedException" }, { "target": "com.amazonaws.billing#InternalServerException" }, { "target": "com.amazonaws.billing#ResourceNotFoundException" }, { "target": "com.amazonaws.billing#ThrottlingException" }, { "target": "com.amazonaws.billing#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns a summary of Enterprise Support data aggregated across all accounts in the Enterprise Support profile.
", "smithy.api#readonly": {} } }, "com.amazonaws.billing#GetEnterpriseSupportChargeSummaryRequest": { "type": "structure", "members": { "billingMonth": { "target": "com.amazonaws.billing#EnterpriseSupportBillingMonth", "traits": { "smithy.api#documentation": "The billing month in YYYY-MM format. This must be a month in the past.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request structure for GetEnterpriseSupportChargeSummary.
", "smithy.api#input": {} } }, "com.amazonaws.billing#GetEnterpriseSupportChargeSummaryResponse": { "type": "structure", "members": { "payerAccountId": { "target": "com.amazonaws.billing#AccountId", "traits": { "smithy.api#documentation": "The payer account ID that is authorized to view Enterprise Support data for all accounts in its Support profile.
", "smithy.api#required": {} } }, "billingMonth": { "target": "com.amazonaws.billing#EnterpriseSupportBillingMonth", "traits": { "smithy.api#documentation": "The billing month in YYYY-MM format. This must be a month in the past.
", "smithy.api#required": {} } }, "billingPeriodStartDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The start date of the billing period.
", "smithy.api#required": {} } }, "billingPeriodEndDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The end date of the billing period.
", "smithy.api#required": {} } }, "isEstimated": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Specifies whether the Support charge amount is estimated. When false, the charge amount is finalized.
", "smithy.api#required": {} } }, "billDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The date the bill was generated.
", "smithy.api#required": {} } }, "supportCharge": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Support charge amount for the account.
", "smithy.api#required": {} } }, "totalSupportCharge": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The total Support charge amount for all accounts in the Support profile.
", "smithy.api#required": {} } }, "supportDiscount": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The support discount amount.
", "smithy.api#required": {} } }, "totalSupportEligibleSpend": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The total Support-eligible Spend from all accounts in the Support profile. This includes eligible spend from usage of Amazon Web Services, Reserved Instances, and Savings Plans.
", "smithy.api#required": {} } }, "totalSupportEligibleUsageSpend": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The total Support-eligible spend from usage of Amazon Web Services from all accounts in the Support profile.
", "smithy.api#required": {} } }, "totalSupportEligibleReservedInstanceSpend": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The total Support-eligible Reserved Instance spend from all accounts in the Support profile.
", "smithy.api#required": {} } }, "totalSupportEligibleSavingsPlanSpend": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The total Support-eligible Savings Plan spend from all accounts in the Support profile.
", "smithy.api#required": {} } }, "supportChargePercentage": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The percentage applied to the total Support-eligible spend to calculate the total Support charge across all accounts in the Support profile.
", "smithy.api#required": {} } }, "supportEffectivePricingPlan": { "target": "com.amazonaws.billing#PricingPlan", "traits": { "smithy.api#documentation": "The effective pricing plan used for the support charge calculation.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The response structure for GetEnterpriseSupportChargeSummary.
", "smithy.api#output": {} } }, "com.amazonaws.billing#GetEnterpriseSupportContractDetails": { "type": "operation", "input": { "target": "com.amazonaws.billing#GetEnterpriseSupportContractDetailsRequest" }, "output": { "target": "com.amazonaws.billing#GetEnterpriseSupportContractDetailsResponse" }, "errors": [ { "target": "com.amazonaws.billing#AccessDeniedException" }, { "target": "com.amazonaws.billing#InternalServerException" }, { "target": "com.amazonaws.billing#ResourceNotFoundException" }, { "target": "com.amazonaws.billing#ThrottlingException" }, { "target": "com.amazonaws.billing#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns Enterprise Support contract details.
", "smithy.api#readonly": {} } }, "com.amazonaws.billing#GetEnterpriseSupportContractDetailsRequest": { "type": "structure", "members": { "billingMonth": { "target": "com.amazonaws.billing#EnterpriseSupportBillingMonth", "traits": { "smithy.api#documentation": "The billing month in YYYY-MM format. This must be a month in the past.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request structure for GetEnterpriseSupportContractDetails.
", "smithy.api#input": {} } }, "com.amazonaws.billing#GetEnterpriseSupportContractDetailsResponse": { "type": "structure", "members": { "isContractActive": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "When true, the Enterprise Support contract is active. When false, the Enterprise Support Contract is inactive.
" } }, "supportAllocationMethod": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The method used to distribute the total Support charge amount across each account in the Support profile. Valid values: Proportional, Fixed_Percentage. Proportional means support charges are distributed to each account in proportion to its eligible Spend. Fixed_Percentage means support charges are distributed across accounts according to pre-configured percentages from the contract.
", "smithy.api#required": {} } }, "supportReservedInstanceAmortizationStartDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "When supportReservedInstanceTreatmentMethod = AmortizedCustom, only amortized fees for Reserved Instances purchased on or after this date are included in the calculation. This field is Null for all other treatment methods.
" } }, "supportReservedInstanceTreatmentMethod": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The method used to include Reserved Instance (RI) fees in the Enterprise Support charge calculation. Valid values: None (RI fees excluded from Support-eligible spend), Upfront (full upfront RI fees included in month of purchase), Amortized (RI fees spread over commitment term for RIs purchased on or after Support subscription start date), AmortizedCustom (same as Amortized but only for RIs purchased on or after a specified custom start date), AmortizedAll (RI fees amortized for all active RIs including those purchased before Support subscription started).
" } }, "supportSavingsPlansAmortizationStartDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "This is applicable when supportSavingsPlansTreatmentMethod = Amortized and is Null for all other methods. It shows the start date from which Savings Plan fees are included in Support Eligible Spend.
" } }, "supportSavingsPlansTreatmentMethod": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The method used to include Savings Plans fees in Enterprise Support charge calculations. Valid values: None (Savings Plan fees excluded from Support-eligible spend), Upfront (full upfront Savings Plan fees included in month of purchase), Amortized (Savings Plan fees spread over commitment term for Savings Plans purchased on or after Support subscription start date), AmortizedCustom (same as Amortized but only for Savings Plans purchased on or after a specified custom start date), AmortizedAll (Savings Plan fees amortized for all active Savings Plans including those purchased before Support subscription started).
" } }, "supportProrateStartDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The start date for accounts subscribed or unsubscribed to Support billing during the billing month.
" } }, "contractPayerAccountIds": { "target": "com.amazonaws.billing#ContractAccountList", "traits": { "smithy.api#documentation": "The list of accounts covered by the Enterprise Support contract.
", "smithy.api#required": {} } }, "chargedPayerAccountIds": { "target": "com.amazonaws.billing#ChargeAccountList", "traits": { "smithy.api#documentation": "The list of payer accounts and their charge allocation percentages.
", "smithy.api#required": {} } }, "additionalSupportCharge": { "target": "com.amazonaws.billing#AdditionalChargeList", "traits": { "smithy.api#documentation": "Any Additional support charges applied to the contract.
" } }, "additionalSupportEligibleUsageSpend": { "target": "com.amazonaws.billing#AdditionalChargeList", "traits": { "smithy.api#documentation": "Any Additional support-eligible usage spend charges.
" } }, "pricingPlans": { "target": "com.amazonaws.billing#PricingPlanList", "traits": { "smithy.api#documentation": "The pricing plans associated with this Enterprise Support contract.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The response structure for GetEnterpriseSupportContractDetails.
", "smithy.api#output": {} } }, "com.amazonaws.billing#GetResourcePolicy": { "type": "operation", "input": { "target": "com.amazonaws.billing#GetResourcePolicyRequest" }, "output": { "target": "com.amazonaws.billing#GetResourcePolicyResponse" }, "errors": [ { "target": "com.amazonaws.billing#AccessDeniedException" }, { "target": "com.amazonaws.billing#InternalServerException" }, { "target": "com.amazonaws.billing#ResourceNotFoundException" }, { "target": "com.amazonaws.billing#ThrottlingException" }, { "target": "com.amazonaws.billing#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns the resource-based policy document attached to the resource in JSON format.
The Amazon Resource Name (ARN) of the billing view resource to which the policy is attached to.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.billing#GetResourcePolicyResponse": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.billing#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the billing view resource to which the policy is attached to.
", "smithy.api#required": {} } }, "policy": { "target": "com.amazonaws.billing#PolicyDocument", "traits": { "smithy.api#documentation": "The resource-based policy document attached to the resource in JSON format.
The request processing failed because of an unknown error, exception, or failure.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.billing#Interval": { "type": "structure", "members": { "startDateInclusive": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The start date of the interval. This date is included in the interval.
", "smithy.api#required": {} } }, "endDateInclusive": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The end date of the interval. This date is included in the interval.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A time period bounded by an inclusive start date and an inclusive end date.
" } }, "com.amazonaws.billing#Investment": { "type": "union", "members": { "milestoneBasedInvestment": { "target": "com.amazonaws.billing#MilestoneBasedInvestment", "traits": { "smithy.api#documentation": "An investment with a fixed value that is disbursed on a schedule. This member is set for a milestone-based investment and corresponds to the MILESTONE_BASED investment type.
An investment that is awarded upon completion of a defined outcome. This member is set for an outcome-based (attestable) investment and corresponds to the OUTCOME_BASED investment type.
An investment within an investment summary. This is a union in which exactly one member is set. The milestoneBasedInvestment member represents a fixed, scheduled investment. The outcomeBasedInvestment member represents an attestable investment awarded upon completion of a defined outcome. Check which member is present to determine the investment type.
The identifier of the attestation. This value is returned by CreateContractualInvestmentAttestation and is used to cancel the attestation with CancelContractualInvestmentAttestation. This value is 1\u201336 characters.
The name of the investment summary that contains the attested outcome. This value is 1\u2013400 characters.
", "smithy.api#length": { "min": 1, "max": 400 }, "smithy.api#required": {} } }, "outcomeDescription": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The description of the attested outcome. This value is 1\u20132048 characters.
", "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#required": {} } }, "investmentSummaryId": { "target": "com.amazonaws.billing#IdentifierString", "traits": { "smithy.api#documentation": "The identifier of the investment summary that was attested, as returned by ListContractualInvestmentSummaries.
The identifier of the investment that was attested, as returned by ListContractualInvestments.
The date on which the attestation was submitted.
", "smithy.api#required": {} } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The date on which the attestation was last updated.
", "smithy.api#required": {} } }, "attestationStatus": { "target": "com.amazonaws.billing#InvestmentAttestationStatus", "traits": { "smithy.api#documentation": "The current status of the attestation. Valid values are PENDING_REVIEW, PENDING_C_LEVEL_APPROVAL, PENDING_CANCELLATION, REJECTED, CANCELLED, and DISBURSED. The values DISBURSED, REJECTED, and CANCELLED are terminal. The other values indicate the attestation is still in progress.
The start date on which the investment is disbursed to the investment accounts. This is not the same as the time of disbursement, but reflects the date you submitted with the attestation.
" } }, "attestedValue": { "target": "com.amazonaws.billing#Amount", "traits": { "smithy.api#documentation": "The monetary value attested.
" } }, "investmentDistributions": { "target": "com.amazonaws.billing#InvestmentDistributions", "traits": { "smithy.api#documentation": "The distribution of the attested investment across the eligible investment accounts. The list contains at most 200 distributions.
" } }, "rejectionReasons": { "target": "com.amazonaws.billing#RejectionReasons", "traits": { "smithy.api#documentation": "The reasons the attestation was rejected. This value is present only when attestationStatus is REJECTED. The list contains at most 30 reasons.
Indicates whether the attestation can be canceled with CancelContractualInvestmentAttestation.
A summary of a submitted investment attestation, as returned by ListContractualInvestmentAttestations.
The current state of a submitted investment attestation in its lifecycle. Valid values are PENDING_REVIEW, PENDING_C_LEVEL_APPROVAL, PENDING_CANCELLATION, REJECTED, CANCELLED, and DISBURSED. The values DISBURSED, REJECTED, and CANCELLED are terminal. The values PENDING_REVIEW, PENDING_C_LEVEL_APPROVAL, and PENDING_CANCELLATION indicate the attestation is still in progress.
A list of investment attestations submitted under a private pricing contract, as returned by ListContractualInvestmentAttestations.
The recipient Amazon Web Services account ID that receives this portion of the investment. This must be one of the eligible investment accounts on the contract.
", "smithy.api#required": {} } }, "investmentAmount": { "target": "com.amazonaws.billing#Amount", "traits": { "smithy.api#documentation": "The monetary value allocated to the recipient account.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An allocation of an investment disbursement to a specific recipient account. The account is the target account that receives the investment, not your account.
" } }, "com.amazonaws.billing#InvestmentDistributions": { "type": "list", "member": { "target": "com.amazonaws.billing#InvestmentDistribution" }, "traits": { "smithy.api#documentation": "A list of investment distributions that allocate an attested investment across recipient accounts. The list contains at most 200 distributions.
", "smithy.api#length": { "max": 200 } } }, "com.amazonaws.billing#InvestmentMultiplier": { "type": "structure", "members": { "value": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The multiplier value, expressed as a decimal string to preserve precision. The value is digits with an optional decimal point and is 1\u20131000 characters. The terms of the contract define this value.
", "smithy.api#length": { "min": 1, "max": 1000 }, "smithy.api#pattern": "^[0-9]+(\\.[0-9]+)?$", "smithy.api#required": {} } }, "investmentAttestationInputUnit": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The unit of the attestation input that the multiplier applies to, such as workloads migrated. This value is 1\u20131000 characters. The terms of the contract define this value.
The type of the multiplier. A value of PERCENTAGE applies a percentage of a value. A value of CURRENCY_AMOUNT applies a currency amount per unit of attestation input. The terms of the contract define this value.
A multiplier used to convert attestation input into an investment value.
" } }, "com.amazonaws.billing#InvestmentMultipliers": { "type": "list", "member": { "target": "com.amazonaws.billing#InvestmentMultiplier" }, "traits": { "smithy.api#documentation": "A list of multipliers used to compute investment value from attestation input, derived from the terms of the contract. The list contains at most 200 multipliers.
", "smithy.api#length": { "max": 200 } } }, "com.amazonaws.billing#InvestmentRestriction": { "type": "structure", "members": { "amount": { "target": "com.amazonaws.billing#Amount", "traits": { "smithy.api#documentation": "The maximum monetary amount allowed under the restriction.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A restriction that caps the value that can be disbursed for an investment. The cap applies for each attestation window.
" } }, "com.amazonaws.billing#InvestmentRestrictions": { "type": "list", "member": { "target": "com.amazonaws.billing#InvestmentRestriction" }, "traits": { "smithy.api#documentation": "A list of restrictions that cap the value that can be disbursed for an investment. The list contains at most 10 restrictions.
", "smithy.api#length": { "max": 10 } } }, "com.amazonaws.billing#InvestmentSummaries": { "type": "list", "member": { "target": "com.amazonaws.billing#InvestmentSummary" }, "traits": { "smithy.api#documentation": "A list of investment summaries within a contract or a private pricing addendum, as returned by ListContractualInvestmentSummaries.
The identifier of the investment summary. Pass this value to ListContractualInvestments to list the investments within the summary, and to CreateContractualInvestmentAttestation to attest an investment. This value is 1\u201336 characters.
The name of the investment summary, used to reference the investment against a term in the physical contract. This value is 1\u2013400 characters.
", "smithy.api#length": { "min": 1, "max": 400 }, "smithy.api#required": {} } }, "investmentType": { "target": "com.amazonaws.billing#InvestmentType", "traits": { "smithy.api#documentation": "The type of the investment summary. Valid values are MILESTONE_BASED and OUTCOME_BASED. OUTCOME_BASED investments can be attested to, upon completion of outcomes. MILESTONE_BASED are automatically triggered by Amazon Web Services, based on the time schedule in the contract.
The maximum monetary value that can be disbursed against the investment summary, inclusive of all outcomes combined under the summary.
" } } }, "traits": { "smithy.api#documentation": "Detailed information about an investment summary within a contract or a private pricing addendum.
" } }, "com.amazonaws.billing#InvestmentType": { "type": "enum", "members": { "MILESTONE_BASED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MILESTONE_BASED" } }, "OUTCOME_BASED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OUTCOME_BASED" } } }, "traits": { "smithy.api#documentation": "The type of an investment summary. A value of MILESTONE_BASED indicates a fixed investment amount disbursed on a schedule. A value of OUTCOME_BASED indicates an investment awarded based on the completion of a defined outcome or milestone.
A list of investments within an investment summary, as returned by ListContractualInvestments. For OUTCOME_BASED investments, they are referred to as outcomes.
A list of legal entities on a private pricing contract. The list contains at most 10 legal entities.
", "smithy.api#length": { "max": 10 } } }, "com.amazonaws.billing#LegalEntity": { "type": "structure", "members": { "legalEntityName": { "target": "com.amazonaws.billing#SensitiveString", "traits": { "smithy.api#documentation": "The name of the legal entity as it appears on the contract document. This value can be up to 256 characters.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A legal entity on a private pricing contract. It can be found on your contract's signature page.
" } }, "com.amazonaws.billing#LinkedAccountCharge": { "type": "structure", "members": { "accountId": { "target": "com.amazonaws.billing#AccountId", "traits": { "smithy.api#documentation": "The linked account ID.
", "smithy.api#required": {} } }, "payerAccountId": { "target": "com.amazonaws.billing#AccountId", "traits": { "smithy.api#documentation": "The payer account ID that is authorized to view Enterprise Support data for all accounts in its Support profile.
", "smithy.api#required": {} } }, "accountType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The type of account.
" } }, "billableSeconds": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The number of billable seconds in the billing period based on when the account was subscribed to Enterprise Support.
", "smithy.api#required": {} } }, "totalSeconds": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The total number of seconds in the billing period.
", "smithy.api#required": {} } }, "totalSupportEligibleSpend": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The total support-eligible spend for this account.
", "smithy.api#required": {} } }, "proratedTotalSupportEligibleSpend": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The prorated total support-eligible spend based on when the account was subscribed to Enterprise Support.
", "smithy.api#required": {} } }, "linkedTimePeriods": { "target": "com.amazonaws.billing#TimePeriodList", "traits": { "smithy.api#documentation": "The time periods during which this account was linked.
" } }, "subscriptionTimePeriods": { "target": "com.amazonaws.billing#TimePeriodList", "traits": { "smithy.api#documentation": "The subscription time periods for this account.
" } }, "totalSupportEligibleReservedInstanceSpend": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The total support-eligible Reserved Instance spend for this account.
" } }, "totalSupportEligibleSavingsPlanSpend": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The total support-eligible Savings Plan spend for this account.
" } }, "supportEligibleSpendByService": { "target": "com.amazonaws.billing#ServiceLevelAccountUsageList", "traits": { "smithy.api#documentation": "The support-eligible spend broken down by service.
" } } }, "traits": { "smithy.api#documentation": "Enterprise Support charges for a linked account.
" } }, "com.amazonaws.billing#LinkedAccountChargeList": { "type": "list", "member": { "target": "com.amazonaws.billing#LinkedAccountCharge" }, "traits": { "smithy.api#documentation": "A list of linked account charges.
", "smithy.api#length": { "max": 100 } } }, "com.amazonaws.billing#ListBillingViewSegments": { "type": "operation", "input": { "target": "com.amazonaws.billing#ListBillingViewSegmentsRequest" }, "output": { "target": "com.amazonaws.billing#ListBillingViewSegmentsResponse" }, "errors": [ { "target": "com.amazonaws.billing#AccessDeniedException" }, { "target": "com.amazonaws.billing#BillingViewHealthStatusException" }, { "target": "com.amazonaws.billing#InternalServerException" }, { "target": "com.amazonaws.billing#ResourceNotFoundException" }, { "target": "com.amazonaws.billing#ThrottlingException" }, { "target": "com.amazonaws.billing#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists the segments of a billing view over a given time period. Each segment identifies the billing domain (PRO_FORMA or BILLABLE) and the account relationships that apply during its time range.
If you don't provide an arn, the response includes segments for the caller's PRIMARY billing view.
If a mid-period change occurs, the response includes multiple segments, each with its own time range. The response omits hidden segments, so the segments it returns might not cover the entire requested time period.
", "smithy.api#examples": [ { "title": "Invoke ListBillingViewSegments", "input": { "timeRange": { "beginDateInclusive": 1719792000, "endDateExclusive": 1722470400 } }, "output": { "items": [ { "domain": "BILLABLE", "timeRange": { "beginDateInclusive": 1719792000, "endDateExclusive": 1722470400 }, "billingTransferAccountId": "111111111111", "managementAccountId": "222222222222", "billingGroupPrimaryAccountId": "333333333333" } ] } }, { "title": "Error example for ListBillingViewSegments", "input": { "timeRange": { "beginDateInclusive": 1722470400, "endDateExclusive": 1719792000 } }, "error": { "shapeId": "com.amazonaws.billing#ValidationException", "content": { "message": "Failed to list billing view segments for an invalid time range.", "reason": "other" } }, "allowConstraintErrors": true } ], "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "items" }, "smithy.api#readonly": {} } }, "com.amazonaws.billing#ListBillingViewSegmentsRequest": { "type": "structure", "members": { "timeRange": { "target": "com.amazonaws.billing#BillingViewSegmentTimeRange", "traits": { "smithy.api#documentation": "The billing period to query. If you don't provide a time range, the current billing period, which is the calendar month in UTC, is used.
" } }, "arn": { "target": "com.amazonaws.billing#BillingViewArn", "traits": { "smithy.api#documentation": " The Amazon Resource Name (ARN) that uniquely identifies the billing view to query. If you don't provide an ARN, the caller's PRIMARY billing view is used. The ARN must reference a primary billing view. Custom billing views aren't supported.
The number of entries a paginated response contains. Valid values range from 1 to 100. The default is 100.
" } }, "nextToken": { "target": "com.amazonaws.billing#PageToken", "traits": { "smithy.api#documentation": "The pagination token that is used on subsequent calls to list billing view segments.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.billing#ListBillingViewSegmentsResponse": { "type": "structure", "members": { "items": { "target": "com.amazonaws.billing#BillingViewSegmentsList", "traits": { "smithy.api#documentation": "A list of billing view segments. Each segment covers a portion of the requested time period. The response omits hidden segments, so the segments it returns might not cover the entire requested time period.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.billing#PageToken", "traits": { "smithy.api#documentation": "The pagination token that is used on subsequent calls to list billing view segments.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.billing#ListBillingViews": { "type": "operation", "input": { "target": "com.amazonaws.billing#ListBillingViewsRequest" }, "output": { "target": "com.amazonaws.billing#ListBillingViewsResponse" }, "errors": [ { "target": "com.amazonaws.billing#AccessDeniedException" }, { "target": "com.amazonaws.billing#InternalServerException" }, { "target": "com.amazonaws.billing#ThrottlingException" }, { "target": "com.amazonaws.billing#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists the billing views available for a given time period.
Every Amazon Web Services account has a unique PRIMARY billing view that represents the billing data available by default. Accounts that use Billing Conductor also have BILLING_GROUP billing views representing pro forma costs associated with each created billing group.
The time range for the billing views listed. PRIMARY billing view is always listed. BILLING_GROUP billing views are listed for time ranges when the associated billing group resource in Billing Conductor is active. The time range must be within one calendar month.
The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
" } }, "billingViewTypes": { "target": "com.amazonaws.billing#BillingViewTypeList", "traits": { "smithy.api#documentation": "The type of billing view.
" } }, "names": { "target": "com.amazonaws.billing#StringSearches", "traits": { "smithy.api#documentation": "Filters the list of billing views by name. You can specify search criteria to match billing view names based on the search option provided.
" } }, "ownerAccountId": { "target": "com.amazonaws.billing#AccountId", "traits": { "smithy.api#documentation": "The list of owners of the billing view.
" } }, "sourceAccountId": { "target": "com.amazonaws.billing#AccountId", "traits": { "smithy.api#documentation": "Filters the results to include only billing views that use the specified account as a source.
" } }, "maxResults": { "target": "com.amazonaws.billing#BillingViewsMaxResults", "traits": { "smithy.api#documentation": "The maximum number of billing views to retrieve. Default is 100.
" } }, "nextToken": { "target": "com.amazonaws.billing#PageToken", "traits": { "smithy.api#documentation": "The pagination token that is used on subsequent calls to list billing views.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.billing#ListBillingViewsResponse": { "type": "structure", "members": { "billingViews": { "target": "com.amazonaws.billing#BillingViewList", "traits": { "smithy.api#documentation": "A list of BillingViewListElement retrieved.
The pagination token to use on subsequent calls to list billing views.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.billing#ListBusinessSupportAccountCharges": { "type": "operation", "input": { "target": "com.amazonaws.billing#ListBusinessSupportAccountChargesRequest" }, "output": { "target": "com.amazonaws.billing#ListBusinessSupportAccountChargesResponse" }, "errors": [ { "target": "com.amazonaws.billing#AccessDeniedException" }, { "target": "com.amazonaws.billing#InternalServerException" }, { "target": "com.amazonaws.billing#ResourceNotFoundException" }, { "target": "com.amazonaws.billing#ThrottlingException" }, { "target": "com.amazonaws.billing#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns Business Support charges broken down at the linked account level for a given billing month.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "accountCharges" }, "smithy.api#readonly": {} } }, "com.amazonaws.billing#ListBusinessSupportAccountChargesRequest": { "type": "structure", "members": { "billingMonth": { "target": "com.amazonaws.billing#BusinessSupportBillingMonth", "traits": { "smithy.api#documentation": "The billing month to retrieve Business Support charges for, in YYYY-MM format. You can request the current month (charges will be estimated) or a past month (charges will be finalized).
", "smithy.api#required": {} } }, "accountId": { "target": "com.amazonaws.billing#AccountId", "traits": { "smithy.api#documentation": "The linked account ID to filter results to a specific account. If you don't specify a value, the response includes charges for all linked accounts.
" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The maximum number of results to return per page. Default is 100.
", "smithy.api#range": { "min": 1, "max": 100 } } }, "nextToken": { "target": "com.amazonaws.billing#PageToken", "traits": { "smithy.api#documentation": "The pagination token for the next page of results.
" } } }, "traits": { "smithy.api#documentation": "Contains the billing month and optional filters used to retrieve Business Support charges broken down by linked account.
", "smithy.api#input": {} } }, "com.amazonaws.billing#ListBusinessSupportAccountChargesResponse": { "type": "structure", "members": { "billingMonth": { "target": "com.amazonaws.billing#BusinessSupportBillingMonth", "traits": { "smithy.api#documentation": "The billing month for the returned charges, in YYYY-MM format.
", "smithy.api#required": {} } }, "isEstimated": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Specifies whether the Support charge amount is estimated. When false, the charge amount is finalized.
", "smithy.api#required": {} } }, "totalSupportCharge": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The total Business Support charge amount for all accounts in the billing month.
", "smithy.api#required": {} } }, "totalSupportEligibleSpend": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The total Support-eligible spend from all accounts in the billing month. This includes eligible spend from usage of Amazon Web Services.
", "smithy.api#required": {} } }, "accountCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The total number of linked accounts with Business Support charges in the billing month.
", "smithy.api#required": {} } }, "accountCharges": { "target": "com.amazonaws.billing#BusinessSupportAccountChargeList", "traits": { "smithy.api#documentation": "The list of Business Support charges per linked account.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.billing#PageToken", "traits": { "smithy.api#documentation": "The pagination token for the next page of results.
" } } }, "traits": { "smithy.api#documentation": "Contains the Business Support charges broken down by linked account for the specified billing month, along with account and spend totals.
", "smithy.api#output": {} } }, "com.amazonaws.billing#ListBusinessSupportSubscriptionHistory": { "type": "operation", "input": { "target": "com.amazonaws.billing#ListBusinessSupportSubscriptionHistoryRequest" }, "output": { "target": "com.amazonaws.billing#ListBusinessSupportSubscriptionHistoryResponse" }, "errors": [ { "target": "com.amazonaws.billing#AccessDeniedException" }, { "target": "com.amazonaws.billing#InternalServerException" }, { "target": "com.amazonaws.billing#ResourceNotFoundException" }, { "target": "com.amazonaws.billing#ThrottlingException" }, { "target": "com.amazonaws.billing#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns the history of Business Support subscription contracts across accounts.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "subscriptionContracts" }, "smithy.api#readonly": {} } }, "com.amazonaws.billing#ListBusinessSupportSubscriptionHistoryRequest": { "type": "structure", "members": { "billingMonth": { "target": "com.amazonaws.billing#BusinessSupportBillingMonth", "traits": { "smithy.api#documentation": "The billing month to retrieve subscription contracts for, in YYYY-MM format. If you don't specify a value, defaults to the current month.
" } }, "accountId": { "target": "com.amazonaws.billing#AccountId", "traits": { "smithy.api#documentation": "The account ID to filter results to a specific account. If you don't specify a value, the response includes subscription history for all accounts.
" } }, "startDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The start date to filter subscription contracts from.
" } }, "endDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The end date to filter subscription contracts to.
" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The maximum number of results to return per page. Default is 100.
", "smithy.api#range": { "min": 1, "max": 100 } } }, "nextToken": { "target": "com.amazonaws.billing#PageToken", "traits": { "smithy.api#documentation": "The pagination token for the next page of results.
" } } }, "traits": { "smithy.api#documentation": "Contains the optional filters used to retrieve the history of Business Support subscription contracts across accounts.
", "smithy.api#input": {} } }, "com.amazonaws.billing#ListBusinessSupportSubscriptionHistoryResponse": { "type": "structure", "members": { "subscriptionContracts": { "target": "com.amazonaws.billing#BusinessSupportSubscriptionContractList", "traits": { "smithy.api#documentation": "The list of Business Support subscription contracts.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.billing#PageToken", "traits": { "smithy.api#documentation": "The pagination token for the next page of results.
" } } }, "traits": { "smithy.api#documentation": "Contains the list of Business Support subscription contracts that match the request filters.
", "smithy.api#output": {} } }, "com.amazonaws.billing#ListContracts": { "type": "operation", "input": { "target": "com.amazonaws.billing#ListContractsRequest" }, "output": { "target": "com.amazonaws.billing#ListContractsResponse" }, "errors": [ { "target": "com.amazonaws.billing#AccessDeniedException" }, { "target": "com.amazonaws.billing#InternalServerException" }, { "target": "com.amazonaws.billing#ThrottlingException" }, { "target": "com.amazonaws.billing#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists the private pricing contracts that your Amazon Web Services account is an eligible payer account of. This operation is read-only and paginated.
", "smithy.api#examples": [ { "title": "Invoke ListContracts", "input": { "maxResults": 100 }, "output": { "items": [ { "contractArn": "arn:aws:billing::123456789012:contract/1a2b3c4d-5e6f-7a8b-9c0d-111122223333", "contractTerm": { "startDateInclusive": 1111111111, "endDateInclusive": 1222222222 }, "contractType": "Cross-Service", "associationStatus": "ASSOCIATED" } ] } } ], "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "items" }, "smithy.api#readonly": {} } }, "com.amazonaws.billing#ListContractsRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.billing#PageToken", "traits": { "smithy.api#documentation": "The pagination token that indicates the next set of results to retrieve.
" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The maximum number of contracts to return in a single call. Minimum value of 1, maximum value of 100.
", "smithy.api#range": { "min": 1, "max": 100 } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.billing#ListContractsResponse": { "type": "structure", "members": { "items": { "target": "com.amazonaws.billing#ContractSummaries", "traits": { "smithy.api#documentation": "The list of contracts that your Amazon Web Services account is an eligible payer account of.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.billing#PageToken", "traits": { "smithy.api#documentation": "The pagination token to use on subsequent calls to retrieve the next set of results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.billing#ListContractualInvestmentAttestations": { "type": "operation", "input": { "target": "com.amazonaws.billing#ListContractualInvestmentAttestationsRequest" }, "output": { "target": "com.amazonaws.billing#ListContractualInvestmentAttestationsResponse" }, "errors": [ { "target": "com.amazonaws.billing#AccessDeniedException" }, { "target": "com.amazonaws.billing#InternalServerException" }, { "target": "com.amazonaws.billing#ResourceNotFoundException" }, { "target": "com.amazonaws.billing#ThrottlingException" }, { "target": "com.amazonaws.billing#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists the investment attestations submitted under a specific private pricing contract. Use this operation to track attestation status, including the terminal statuses DISBURSED, REJECTED, and CANCELLED. This operation is read-only and paginated.
The Amazon Resource Name (ARN) of the contract whose attestations you want to list.
", "smithy.api#required": {} } }, "investmentSummaryId": { "target": "com.amazonaws.billing#IdentifierString", "traits": { "smithy.api#documentation": "The identifier of a specific investment summary to filter the attestations by. If omitted, attestations for all investment summaries in the contract are returned.
" } }, "nextToken": { "target": "com.amazonaws.billing#PageToken", "traits": { "smithy.api#documentation": "The pagination token that indicates the next set of results to retrieve.
" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The maximum number of attestations to return in a single call. Minimum value of 1, maximum value of 100.
", "smithy.api#range": { "min": 1, "max": 100 } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.billing#ListContractualInvestmentAttestationsResponse": { "type": "structure", "members": { "items": { "target": "com.amazonaws.billing#InvestmentAttestations", "traits": { "smithy.api#documentation": "The list of investment attestations submitted under the contract.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.billing#PageToken", "traits": { "smithy.api#documentation": "The pagination token to use on subsequent calls to retrieve the next set of results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.billing#ListContractualInvestmentSummaries": { "type": "operation", "input": { "target": "com.amazonaws.billing#ListContractualInvestmentSummariesRequest" }, "output": { "target": "com.amazonaws.billing#ListContractualInvestmentSummariesResponse" }, "errors": [ { "target": "com.amazonaws.billing#AccessDeniedException" }, { "target": "com.amazonaws.billing#InternalServerException" }, { "target": "com.amazonaws.billing#ResourceNotFoundException" }, { "target": "com.amazonaws.billing#ThrottlingException" }, { "target": "com.amazonaws.billing#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists the investment summaries within a specific private pricing contract. This operation is read-only and paginated.
", "smithy.api#examples": [ { "title": "Invoke ListContractualInvestmentSummaries", "input": { "contractArn": "arn:aws:billing::123456789012:contract/1a2b3c4d-5e6f-7a8b-9c0d-111122223333", "maxResults": 100 }, "output": { "items": [ { "investmentSummaryId": "Example-Investment-Summary-Id", "investmentName": "Example Investment Name", "investmentType": "OUTCOME_BASED", "maxAllowedInvestmentDisbursementValue": { "currencyCode": "USD", "currencyAmount": "100000000.00" } } ] } } ], "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "items" }, "smithy.api#readonly": {} } }, "com.amazonaws.billing#ListContractualInvestmentSummariesRequest": { "type": "structure", "members": { "contractArn": { "target": "com.amazonaws.billing#ArnString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the contract whose investment summaries you want to list.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.billing#PageToken", "traits": { "smithy.api#documentation": "The pagination token that indicates the next set of results to retrieve.
" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The maximum number of investment summaries to return in a single call. Minimum value of 1, maximum value of 100.
", "smithy.api#range": { "min": 1, "max": 100 } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.billing#ListContractualInvestmentSummariesResponse": { "type": "structure", "members": { "items": { "target": "com.amazonaws.billing#InvestmentSummaries", "traits": { "smithy.api#documentation": "The list of investment summaries under the contract. It includes the investment name, maximum investment amount, and investment type. It does not provide investment details. Use this to know if the contract has investment terms and what type.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.billing#PageToken", "traits": { "smithy.api#documentation": "The pagination token to use on subsequent calls to retrieve the next set of results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.billing#ListContractualInvestments": { "type": "operation", "input": { "target": "com.amazonaws.billing#ListContractualInvestmentsRequest" }, "output": { "target": "com.amazonaws.billing#ListContractualInvestmentsResponse" }, "errors": [ { "target": "com.amazonaws.billing#AccessDeniedException" }, { "target": "com.amazonaws.billing#InternalServerException" }, { "target": "com.amazonaws.billing#ResourceNotFoundException" }, { "target": "com.amazonaws.billing#ThrottlingException" }, { "target": "com.amazonaws.billing#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists the investments within a specific investment summary. This operation is read-only and paginated.
", "smithy.api#examples": [ { "title": "Invoke ListContractualInvestments", "input": { "contractArn": "arn:aws:billing::123456789012:contract/1a2b3c4d-5e6f-7a8b-9c0d-111122223333", "investmentSummaryId": "Example-Investment-Summary-Id", "maxResults": 100 }, "output": { "items": [ { "outcomeBasedInvestment": { "investmentId": "Investment-Id", "outcomeDescription": "Example outcome description", "attestationWindow": { "startDateInclusive": 1111111111, "endDateInclusive": 1222222222 }, "investmentRestrictions": [ { "amount": { "currencyCode": "USD", "currencyAmount": "50000.00" } } ], "disbursedValue": { "currencyCode": "USD", "currencyAmount": "0.00" } } } ] } } ], "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "items" }, "smithy.api#readonly": {} } }, "com.amazonaws.billing#ListContractualInvestmentsRequest": { "type": "structure", "members": { "contractArn": { "target": "com.amazonaws.billing#ArnString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the contract that contains the investment summary.
", "smithy.api#required": {} } }, "investmentSummaryId": { "target": "com.amazonaws.billing#IdentifierString", "traits": { "smithy.api#documentation": "The identifier of the investment summary whose investments you want to list.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.billing#PageToken", "traits": { "smithy.api#documentation": "The pagination token that indicates the next set of results to retrieve.
" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The maximum number of investments to return in a single call. Minimum value of 1, maximum value of 100.
", "smithy.api#range": { "min": 1, "max": 100 } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.billing#ListContractualInvestmentsResponse": { "type": "structure", "members": { "items": { "target": "com.amazonaws.billing#Investments", "traits": { "smithy.api#documentation": "The list of investments for the investment summary.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.billing#PageToken", "traits": { "smithy.api#documentation": "The pagination token to use on subsequent calls to retrieve the next set of results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.billing#ListEnterpriseSupportLinkedAccountCharges": { "type": "operation", "input": { "target": "com.amazonaws.billing#ListEnterpriseSupportLinkedAccountChargesRequest" }, "output": { "target": "com.amazonaws.billing#ListEnterpriseSupportLinkedAccountChargesResponse" }, "errors": [ { "target": "com.amazonaws.billing#AccessDeniedException" }, { "target": "com.amazonaws.billing#InternalServerException" }, { "target": "com.amazonaws.billing#ResourceNotFoundException" }, { "target": "com.amazonaws.billing#ThrottlingException" }, { "target": "com.amazonaws.billing#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns Support-eligible spend broken down at linked account level.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "linkedAccount" }, "smithy.api#readonly": {} } }, "com.amazonaws.billing#ListEnterpriseSupportLinkedAccountChargesRequest": { "type": "structure", "members": { "billingMonth": { "target": "com.amazonaws.billing#EnterpriseSupportBillingMonth", "traits": { "smithy.api#documentation": "The billing month in YYYY-MM format. This must be a month in the past.
", "smithy.api#required": {} } }, "accountId": { "target": "com.amazonaws.billing#AccountId", "traits": { "smithy.api#documentation": "The linked account ID to filter results to a specific account. If you don't specify a value, the response includes charges for all linked accounts.
" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The maximum number of results to return per page. Default is 100.
", "smithy.api#range": { "min": 1, "max": 100 } } }, "nextToken": { "target": "com.amazonaws.billing#PageToken", "traits": { "smithy.api#documentation": "The pagination token for the next page of results.
" } } }, "traits": { "smithy.api#documentation": "The request structure for ListEnterpriseSupportLinkedAccountCharges.
", "smithy.api#input": {} } }, "com.amazonaws.billing#ListEnterpriseSupportLinkedAccountChargesResponse": { "type": "structure", "members": { "linkedAccount": { "target": "com.amazonaws.billing#LinkedAccountChargeList", "traits": { "smithy.api#documentation": "The list of Enterprise Support charges per linked account.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.billing#PageToken", "traits": { "smithy.api#documentation": "The pagination token for the next page of results.
" } } }, "traits": { "smithy.api#documentation": "The response structure for ListEnterpriseSupportLinkedAccountCharges.
", "smithy.api#output": {} } }, "com.amazonaws.billing#ListSourceViewsForBillingView": { "type": "operation", "input": { "target": "com.amazonaws.billing#ListSourceViewsForBillingViewRequest" }, "output": { "target": "com.amazonaws.billing#ListSourceViewsForBillingViewResponse" }, "errors": [ { "target": "com.amazonaws.billing#AccessDeniedException" }, { "target": "com.amazonaws.billing#InternalServerException" }, { "target": "com.amazonaws.billing#ResourceNotFoundException" }, { "target": "com.amazonaws.billing#ThrottlingException" }, { "target": "com.amazonaws.billing#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists the source views (managed Amazon Web Services billing views) associated with the billing view.
", "smithy.api#examples": [ { "title": "Invoke ListSourceViewsForBillingView", "input": { "arn": "arn:aws:billing::123456789101:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899" }, "output": { "sourceViews": [ "arn:aws:billing::123456789101:billingview/primary" ] } } ], "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "sourceViews" }, "smithy.api#readonly": {} } }, "com.amazonaws.billing#ListSourceViewsForBillingViewRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.billing#BillingViewArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
", "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.billing#BillingViewsMaxResults", "traits": { "smithy.api#documentation": "The number of entries a paginated response contains.
" } }, "nextToken": { "target": "com.amazonaws.billing#PageToken", "traits": { "smithy.api#documentation": "The pagination token that is used on subsequent calls to list billing views.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.billing#ListSourceViewsForBillingViewResponse": { "type": "structure", "members": { "sourceViews": { "target": "com.amazonaws.billing#BillingViewSourceViewsList", "traits": { "smithy.api#documentation": "A list of billing views used as the data source for the custom billing view.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.billing#PageToken", "traits": { "smithy.api#documentation": "The pagination token that is used on subsequent calls to list billing views.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.billing#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.billing#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.billing#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.billing#AccessDeniedException" }, { "target": "com.amazonaws.billing#InternalServerException" }, { "target": "com.amazonaws.billing#ResourceNotFoundException" }, { "target": "com.amazonaws.billing#ThrottlingException" }, { "target": "com.amazonaws.billing#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists tags associated with the billing view resource.
", "smithy.api#examples": [ { "title": "Invoke ListTagsForResource", "input": { "resourceArn": "arn:aws:billing::123456789101:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899" }, "output": { "resourceTags": [ { "key": "ExampleTagKey", "value": "ExampleTagValue" } ] } } ], "smithy.api#readonly": {} } }, "com.amazonaws.billing#ListTagsForResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.billing#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.billing#ListTagsForResourceResponse": { "type": "structure", "members": { "resourceTags": { "target": "com.amazonaws.billing#ResourceTagList", "traits": { "smithy.api#documentation": "A list of tag key value pairs that are associated with the resource.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.billing#MilestoneBasedInvestment": { "type": "structure", "members": { "investmentId": { "target": "com.amazonaws.billing#IdentifierString", "traits": { "smithy.api#documentation": "The identifier of the investment, as returned by ListContractualInvestments. This value is 1\u201336 characters.
The total value of the investment, including its currency and amount.
", "smithy.api#required": {} } }, "investmentDisbursedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The date on which the investment is disbursed to the investment accounts.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An investment with a fixed value that is disbursed on a schedule. This corresponds to the MILESTONE_BASED investment type.
The type of an investment multiplier. A value of PERCENTAGE applies a percentage of a value, expressed as a decimal string. A value of CURRENCY_AMOUNT applies a currency amount per unit of attestation input.
The identifier of the investment, as returned by ListContractualInvestments. This value is 1\u201336 characters.
The description of what must be completed to attest the outcome. This value is 1\u20132048 characters.
", "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#required": {} } }, "attestationWindow": { "target": "com.amazonaws.billing#Interval", "traits": { "smithy.api#documentation": "The time window, expressed as an interval with inclusive start and end dates, during which outcomes can be attested to.
", "smithy.api#required": {} } }, "investmentRestrictions": { "target": "com.amazonaws.billing#InvestmentRestrictions", "traits": { "smithy.api#documentation": "The restrictions that cap the value that can be disbursed for the investment. The list contains at most 10 restrictions.
" } }, "investmentMultipliers": { "target": "com.amazonaws.billing#InvestmentMultipliers", "traits": { "smithy.api#documentation": "The multipliers used to compute the investment value from the attestation input. The list contains at most 200 multipliers. Multipliers are derived from the terms of the private pricing contract.
" } }, "disbursedValue": { "target": "com.amazonaws.billing#Amount", "traits": { "smithy.api#documentation": "The total value already disbursed against the investment. This value can be distributed among the investment accounts distribution.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An investment that is awarded upon completion of a defined outcome. This corresponds to the OUTCOME_BASED investment type and is claimed through CreateContractualInvestmentAttestation.
The unique identifier for the pricing plan.
" } }, "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the pricing plan.
" } }, "description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A description of the pricing plan.
" } }, "startDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The start date of the pricing plan.
" } }, "endDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The end date of the pricing plan.
" } }, "planDiscountPercent": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The discount percentage applied by this pricing plan.
" } }, "discountAppliesToMinimumCharge": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Whether the discount applies to the minimum Support charge.
" } }, "minimumCharge": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The minimum Support charge amount for this pricing plan.
" } }, "tiered": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Whether the pricing plan uses tiered pricing.
" } }, "tiers": { "target": "com.amazonaws.billing#PricingPlanTierList", "traits": { "smithy.api#documentation": "The pricing tiers within this plan.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A pricing plan for Enterprise Support billing.
" } }, "com.amazonaws.billing#PricingPlanList": { "type": "list", "member": { "target": "com.amazonaws.billing#PricingPlan" }, "traits": { "smithy.api#documentation": "A list of pricing plans.
", "smithy.api#length": { "max": 10 } } }, "com.amazonaws.billing#PricingPlanTier": { "type": "structure", "members": { "tierMinimum": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The minimum spend threshold for this tier.
", "smithy.api#required": {} } }, "tierMaximum": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The maximum spend threshold for this tier.
" } }, "baseCharge": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The base charge for this tier.
", "smithy.api#required": {} } }, "additionalPercentageOfAggregateCharges": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The additional percentage applied to aggregate charges in this tier.
", "smithy.api#required": {} } }, "aggregateChargesAdjustment": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The adjustment applied to aggregate charges.
", "smithy.api#required": {} } }, "incremental": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Whether the tier charges are calculated incrementally.
", "smithy.api#required": {} } }, "increment": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The increment amount for incremental tier calculations.
" } }, "incrementCharge": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The charge per increment.
" } } }, "traits": { "smithy.api#documentation": "A tier within an Enterprise Support pricing plan.
" } }, "com.amazonaws.billing#PricingPlanTierList": { "type": "list", "member": { "target": "com.amazonaws.billing#PricingPlanTier" }, "traits": { "smithy.api#documentation": "A list of pricing plan tiers.
", "smithy.api#length": { "max": 20 } } }, "com.amazonaws.billing#PrivatePricingAddendum": { "type": "structure", "members": { "contractArn": { "target": "com.amazonaws.billing#ArnString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the private pricing addendum.
", "smithy.api#required": {} } }, "contractTerm": { "target": "com.amazonaws.billing#Interval", "traits": { "smithy.api#documentation": "The contract term period of the private pricing addendum, expressed as an interval with an inclusive start date and an inclusive end date.
", "smithy.api#required": {} } }, "eligiblePayerAccounts": { "target": "com.amazonaws.billing#AccountList", "traits": { "smithy.api#documentation": "The payer accounts that are eligible under the private pricing addendum. The list contains at most 100 account IDs.
", "smithy.api#required": {} } }, "investmentAccounts": { "target": "com.amazonaws.billing#AccountList", "traits": { "smithy.api#documentation": "The accounts that are eligible to receive investments under the private pricing addendum. An InvestmentDistribution must target one of these accounts. The list contains at most 100 account IDs.
The legal entities on the private pricing addendum. The list contains at most 10 legal entities.
", "smithy.api#required": {} } }, "contractRestrictions": { "target": "com.amazonaws.billing#ContractRestrictions", "traits": { "smithy.api#documentation": "The restrictions that limit the self-service actions you can take on the private pricing addendum. An empty or absent value indicates that no restrictions apply. The list contains at most 10 restrictions.
" } } }, "traits": { "smithy.api#documentation": "The details of a private pricing addendum contract.
" } }, "com.amazonaws.billing#ProductName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.billing#ProductNames": { "type": "list", "member": { "target": "com.amazonaws.billing#ProductName" }, "traits": { "smithy.api#length": { "max": 1000 } } }, "com.amazonaws.billing#PromoCode": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "[^<>\"&\\%|'\n\t]*" } }, "com.amazonaws.billing#PurchaseType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 } } }, "com.amazonaws.billing#PurchaseTypeApplications": { "type": "list", "member": { "target": "com.amazonaws.billing#PurchaseType" }, "traits": { "smithy.api#length": { "max": 50 } } }, "com.amazonaws.billing#QuotaCode": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.billing#RedeemCredits": { "type": "operation", "input": { "target": "com.amazonaws.billing#RedeemCreditsRequest" }, "output": { "target": "com.amazonaws.billing#RedeemCreditsResponse" }, "errors": [ { "target": "com.amazonaws.billing#AccessDeniedException" }, { "target": "com.amazonaws.billing#InternalServerException" }, { "target": "com.amazonaws.billing#ThrottlingException" }, { "target": "com.amazonaws.billing#ValidationException" } ], "traits": { "smithy.api#documentation": "Redeems an Amazon Web Services promotional credit code on behalf of the calling account. On success, a new credit is added to the account's credit ledger with the amount, validity period, and applicable products defined by the promotion. The credit is then automatically applied to subsequent bills according to the standard credit application order.
" } }, "com.amazonaws.billing#RedeemCreditsRequest": { "type": "structure", "members": { "promoCode": { "target": "com.amazonaws.billing#PromoCode", "traits": { "smithy.api#documentation": "The promotional credit code to redeem.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.billing#RedeemCreditsResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.billing#RejectionReason": { "type": "string", "traits": { "smithy.api#documentation": "A single reason an attestation was rejected. This value is 1\u2013300 characters.
", "smithy.api#length": { "min": 1, "max": 300 } } }, "com.amazonaws.billing#RejectionReasons": { "type": "list", "member": { "target": "com.amazonaws.billing#RejectionReason" }, "traits": { "smithy.api#documentation": "A list of reasons an attestation was rejected. The list contains at most 30 reasons.
", "smithy.api#length": { "max": 30 } } }, "com.amazonaws.billing#ResourceArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws[a-z-]*:(billing)::[0-9]{12}:[a-zA-Z0-9/:_\\+=\\.\\@-]{0,70}[a-zA-Z0-9]$" } }, "com.amazonaws.billing#ResourceId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.billing#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.billing#ErrorMessage", "traits": { "smithy.api#required": {} } }, "resourceId": { "target": "com.amazonaws.billing#ResourceId", "traits": { "smithy.api#documentation": "Value is a list of resource IDs that were not found.
", "smithy.api#required": {} } }, "resourceType": { "target": "com.amazonaws.billing#ResourceType", "traits": { "smithy.api#documentation": "Value is the type of resource that was not found.
", "smithy.api#required": {} } } }, "traits": { "aws.protocols#awsQueryError": { "code": "BillingResourceNotFound", "httpResponseCode": 404 }, "smithy.api#documentation": "The specified ARN in the request doesn't exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.billing#ResourceTag": { "type": "structure", "members": { "key": { "target": "com.amazonaws.billing#ResourceTagKey", "traits": { "smithy.api#documentation": "The key that's associated with the tag.
", "smithy.api#required": {} } }, "value": { "target": "com.amazonaws.billing#ResourceTagValue", "traits": { "smithy.api#documentation": "The value that's associated with the tag.
" } } }, "traits": { "smithy.api#documentation": "The tag structure that contains a tag key and value.
" } }, "com.amazonaws.billing#ResourceTagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.billing#ResourceTagKeyList": { "type": "list", "member": { "target": "com.amazonaws.billing#ResourceTagKey" }, "traits": { "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.billing#ResourceTagList": { "type": "list", "member": { "target": "com.amazonaws.billing#ResourceTag" }, "traits": { "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.billing#ResourceTagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.billing#ResourceType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.billing#SearchOption": { "type": "enum", "members": { "STARTS_WITH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STARTS_WITH" } } } }, "com.amazonaws.billing#SearchValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9_\\+=\\.\\-@ ]+$" } }, "com.amazonaws.billing#SensitiveEmail": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 256 }, "smithy.api#pattern": "^[A-Za-z0-9._%+\\-]+@[A-Za-z0-9.\\-]+\\.[A-Za-z]{2,}$", "smithy.api#sensitive": {} } }, "com.amazonaws.billing#SensitiveString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#sensitive": {} } }, "com.amazonaws.billing#ServiceCode": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.billing#ServiceLevelAccountUsage": { "type": "structure", "members": { "serviceCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The service code for which to return Support-eligible spend data.
" } }, "totalSupportEligibleSpend": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The total support-eligible spend for the service.
" } } }, "traits": { "smithy.api#documentation": "Service-level usage details by account.
" } }, "com.amazonaws.billing#ServiceLevelAccountUsageList": { "type": "list", "member": { "target": "com.amazonaws.billing#ServiceLevelAccountUsage" }, "traits": { "smithy.api#documentation": "A list of service-level account usages.
", "smithy.api#length": { "max": 200 } } }, "com.amazonaws.billing#ServiceQuotaExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.billing#ErrorMessage", "traits": { "smithy.api#required": {} } }, "resourceId": { "target": "com.amazonaws.billing#ResourceId", "traits": { "smithy.api#documentation": "The ID of the resource.
", "smithy.api#required": {} } }, "resourceType": { "target": "com.amazonaws.billing#ResourceType", "traits": { "smithy.api#documentation": "The type of Amazon Web Services resource.
", "smithy.api#required": {} } }, "serviceCode": { "target": "com.amazonaws.billing#ServiceCode", "traits": { "smithy.api#documentation": " The container for the serviceCode.
The container for the quotaCode.
You've reached the limit of resources you can create, or exceeded the size of an individual resource.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.billing#ShareableAccountIds": { "type": "list", "member": { "target": "com.amazonaws.billing#AccountId" } }, "com.amazonaws.billing#SplitCredit": { "type": "operation", "input": { "target": "com.amazonaws.billing#SplitCreditRequest" }, "output": { "target": "com.amazonaws.billing#SplitCreditResponse" }, "errors": [ { "target": "com.amazonaws.billing#AccessDeniedException" }, { "target": "com.amazonaws.billing#ConflictException" }, { "target": "com.amazonaws.billing#InternalServerException" }, { "target": "com.amazonaws.billing#ResourceNotFoundException" }, { "target": "com.amazonaws.billing#ServiceQuotaExceededException" }, { "target": "com.amazonaws.billing#ThrottlingException" }, { "target": "com.amazonaws.billing#ValidationException" } ], "traits": { "smithy.api#documentation": "Splits the available balance of a credit into 2 to 99 new credits in the same account, and cancels the original credit. The new credits keep the original credit's end date and applicable products.
The available balance is the remaining balance minus any amount reserved for a bill that isn't finalized. The portions must add up to exactly the available balance. Each portion must be at least 100.00 in the currency of the credit. For example, if the credit is in USD, each portion must be at least USD $100.00. A reserved amount stays on the original credit and still applies to that bill.
A credit and every credit split from it count toward a limit of 100 credits. After a split, you can't split or transfer the original credit. You can split or transfer its new credits, and you can split a credit after you transfer it.
You must own the credit or be the payer of the account that owns it. You can't undo a split. This operation is idempotent and supports a dry run.
", "smithy.api#idempotent": {} } }, "com.amazonaws.billing#SplitCreditRequest": { "type": "structure", "members": { "creditId": { "target": "com.amazonaws.billing#CreditId", "traits": { "smithy.api#documentation": "The ID of the credit to split.
", "smithy.api#required": {} } }, "portions": { "target": "com.amazonaws.billing#SplitPortions", "traits": { "smithy.api#documentation": "The new credits to create, one for each portion, in the order listed.
", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.billing#ClientToken", "traits": { "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure that the operation completes no more than one time. If you retry a successful request with the same client token and parameters, the retry completes without performing any further actions. If you reuse a client token with different parameters, the request fails with a ValidationException.
Specifies whether to validate the request and return the result without changing any credit.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.billing#SplitCreditResponse": { "type": "structure", "members": { "parentCreditId": { "target": "com.amazonaws.billing#CreditId", "traits": { "smithy.api#documentation": "The ID of the credit that was split.
", "smithy.api#required": {} } }, "childCredits": { "target": "com.amazonaws.billing#ChildCredits", "traits": { "smithy.api#documentation": "The new credits, in the order of the requested portions.
", "smithy.api#required": {} } }, "dryRun": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Specifies whether the request was a dry run. If true, the operation didn't change any credit.
The amount of the new credit, in the currency of the credit that you split. The amount must be at least 100.00 in that currency. For example, if the credit is in USD, the amount must be at least USD $100.00.
", "smithy.api#required": {} } }, "description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The description of the new credit. If you omit it, the new credit gets the original credit's description followed by its position in the request, for example MAP credit - 1/3. If you split that credit again, the name extends, for example MAP credit - 1/3 - 2/2. A generated name is at most 93 characters. If it would be longer, the name keeps only the beginning of the original description.
One new credit to create from a split.
" } }, "com.amazonaws.billing#SplitPortions": { "type": "list", "member": { "target": "com.amazonaws.billing#SplitPortion" }, "traits": { "smithy.api#documentation": "The portions of a split. Their amounts must add up to exactly the available balance of the credit. The limit of 100 credits includes the credit that you split, so a credit with no earlier splits can take at most 99 portions. The new credits follow the order of this list.
", "smithy.api#length": { "min": 2, "max": 99 } } }, "com.amazonaws.billing#StringSearch": { "type": "structure", "members": { "searchOption": { "target": "com.amazonaws.billing#SearchOption", "traits": { "smithy.api#documentation": "The type of search operation to perform on the string value. Determines how the search value is matched against the target field.
", "smithy.api#required": {} } }, "searchValue": { "target": "com.amazonaws.billing#SearchValue", "traits": { "smithy.api#documentation": "The string value to use in the search operation. This value is compared against the target field using the specified search option.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A structure that defines how to search for string values. You can specify a search option and the value to search for.
" } }, "com.amazonaws.billing#StringSearches": { "type": "list", "member": { "target": "com.amazonaws.billing#StringSearch" }, "traits": { "smithy.api#length": { "min": 1, "max": 1 } } }, "com.amazonaws.billing#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": "^[\\S\\s]*$" } }, "com.amazonaws.billing#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.billing#TagResourceRequest" }, "output": { "target": "com.amazonaws.billing#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.billing#AccessDeniedException" }, { "target": "com.amazonaws.billing#InternalServerException" }, { "target": "com.amazonaws.billing#ResourceNotFoundException" }, { "target": "com.amazonaws.billing#ThrottlingException" }, { "target": "com.amazonaws.billing#ValidationException" } ], "traits": { "smithy.api#documentation": "An API operation for adding one or more tags (key-value pairs) to a resource.
", "smithy.api#examples": [ { "title": "Invoke TagResource", "input": { "resourceArn": "arn:aws:billing::123456789101:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899", "resourceTags": [ { "key": "ExampleTagKey", "value": "ExampleTagValue" } ] }, "output": {} } ] } }, "com.amazonaws.billing#TagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.billing#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", "smithy.api#required": {} } }, "resourceTags": { "target": "com.amazonaws.billing#ResourceTagList", "traits": { "smithy.api#documentation": "A list of tag key value pairs that are associated with the resource.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.billing#TagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.billing#TagValues": { "type": "structure", "members": { "key": { "target": "com.amazonaws.billing#TagKey", "traits": { "smithy.api#documentation": "The key for the tag.
", "smithy.api#required": {} } }, "values": { "target": "com.amazonaws.billing#Values", "traits": { "smithy.api#documentation": "The specific value of the tag.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The values that are available for a tag.
" } }, "com.amazonaws.billing#ThrottlingException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.billing#ErrorMessage", "traits": { "smithy.api#required": {} } } }, "traits": { "aws.protocols#awsQueryError": { "code": "BillingThrottling", "httpResponseCode": 429 }, "smithy.api#documentation": "The request was denied due to request throttling.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.billing#TimePeriodList": { "type": "list", "member": { "target": "com.amazonaws.billing#EnterpriseSupportTimePeriod" }, "traits": { "smithy.api#documentation": "A list of time periods.
", "smithy.api#length": { "max": 500 } } }, "com.amazonaws.billing#TimeRange": { "type": "structure", "members": { "beginDateInclusive": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The inclusive start date of the time range.
" } }, "endDateInclusive": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The inclusive end date of the time range.
" } } }, "traits": { "smithy.api#documentation": "Specifies a time range with inclusive begin and end dates.
" } }, "com.amazonaws.billing#TransferCredit": { "type": "operation", "input": { "target": "com.amazonaws.billing#TransferCreditRequest" }, "output": { "target": "com.amazonaws.billing#TransferCreditResponse" }, "errors": [ { "target": "com.amazonaws.billing#AccessDeniedException" }, { "target": "com.amazonaws.billing#ConflictException" }, { "target": "com.amazonaws.billing#InternalServerException" }, { "target": "com.amazonaws.billing#ResourceNotFoundException" }, { "target": "com.amazonaws.billing#ServiceQuotaExceededException" }, { "target": "com.amazonaws.billing#ThrottlingException" }, { "target": "com.amazonaws.billing#ValidationException" } ], "traits": { "smithy.api#documentation": "Moves a credit to another account in the same consolidated billing family. The credit keeps its ID, balance, end date, and applicable products. Only the account that owns the credit changes.
The transfer removes the credit's sharing settings. The new owner or the payer can set them again. Any amount reserved for a bill that isn't finalized moves with the credit and still applies to that bill.
You must be the payer of both accounts. You can't transfer a credit that has ended, has no available balance, or is the original credit of a split. A transfer creates no credit, so it doesn't count toward the split limit, and the payer can transfer the credit back. This operation is idempotent and supports a dry run.
", "smithy.api#idempotent": {} } }, "com.amazonaws.billing#TransferCreditRequest": { "type": "structure", "members": { "creditId": { "target": "com.amazonaws.billing#CreditId", "traits": { "smithy.api#documentation": "The ID of the credit to transfer.
", "smithy.api#required": {} } }, "destinationAccountId": { "target": "com.amazonaws.billing#AccountId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID that becomes the owner of the credit. The account must be in your consolidated billing family and must not be the current owner.
", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.billing#ClientToken", "traits": { "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure that the operation completes no more than one time. If you retry a successful request with the same client token and parameters, the retry completes without performing any further actions. If you reuse a client token with different parameters, the request fails with a ValidationException.
Specifies whether to validate the request and return the result without changing the credit.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.billing#TransferCreditResponse": { "type": "structure", "members": { "sourceCreditId": { "target": "com.amazonaws.billing#CreditId", "traits": { "smithy.api#documentation": "The ID of the transferred credit. The credit keeps this ID.
", "smithy.api#required": {} } }, "newCreditId": { "target": "com.amazonaws.billing#CreditId", "traits": { "smithy.api#documentation": "Always the same as sourceCreditId, because a transfer moves the credit and creates no new one. A dry run omits this field.
The Amazon Web Services account ID that owns the credit after the transfer.
", "smithy.api#required": {} } }, "amount": { "target": "com.amazonaws.billing#DecimalAmountString", "traits": { "smithy.api#documentation": "The available balance of the credit, which is its remaining balance minus any amount reserved for a bill that isn't finalized.
", "smithy.api#required": {} } }, "dryRun": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Specifies whether the request was a dry run. If true, the operation didn't change the credit.
Removes one or more tags from a resource. Specify only tag keys in your request. Don't specify the value.
", "smithy.api#examples": [ { "title": "Invoke UntagResource", "input": { "resourceArn": "arn:aws:billing::123456789101:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899", "resourceTagKeys": [ "ExampleTagKey" ] }, "output": {} } ] } }, "com.amazonaws.billing#UntagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.billing#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", "smithy.api#required": {} } }, "resourceTagKeys": { "target": "com.amazonaws.billing#ResourceTagKeyList", "traits": { "smithy.api#documentation": "A list of tag key value pairs that are associated with the resource.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.billing#UntagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.billing#UpdateBillingPreferences": { "type": "operation", "input": { "target": "com.amazonaws.billing#UpdateBillingPreferencesRequest" }, "output": { "target": "com.amazonaws.billing#UpdateBillingPreferencesResponse" }, "errors": [ { "target": "com.amazonaws.billing#AccessDeniedException" }, { "target": "com.amazonaws.billing#InternalServerException" }, { "target": "com.amazonaws.billing#ThrottlingException" }, { "target": "com.amazonaws.billing#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates billing preferences for the specified feature. Each feature targets a distinct billing capability and has its own set of supported keys. The action sets the value for each provided key; keys not present in the request are unchanged.
To set sharing keys (RI_SHARING, CREDIT_SHARING, CREDIT_LEVEL_SHARING, BENEFIT_LEVEL_SHARING, and sharing keys under CREDIT_PREFERENCE_OPTIONS), you must use the management account of a consolidated billing family. To set the credit/{creditId}/status key, you must own the credit or use the management account of its family.
The feature to update. Valid values: BILLING_ALERTS, RI_SHARING, CREDIT_SHARING, CREDIT_LEVEL_SHARING, CREDIT_PREFERENCE_OPTIONS, BENEFIT_LEVEL_SHARING. The history features (RI_SHARING_HISTORY and CREDIT_SHARING_HISTORY) are read-only and cannot be updated.
Key/value pairs to apply. All keys in a single request must be valid for the specified feature and must not be duplicated. For CREDIT_PREFERENCE_OPTIONS, all keys must reference the same creditId.
For BENEFIT_LEVEL_SHARING, all keys must reference the same Reserved Instance or Savings Plan. To share it with the accounts in one Cost Category rule, send these three keys with the value ENABLED:
benefit/{ri|sp}/{benefitId}/sharing/costCategoryArn/{costCategoryArn}
benefit/{ri|sp}/{benefitId}/sharing/ruleName/{ruleName}
benefit/{ri|sp}/{benefitId}/sharing/mode/{prioritized|restricted}
With prioritized, any benefit that the rule's accounts don't use goes to the rest of your consolidated billing family, following your family sharing settings. With restricted, only the owner and the rule's accounts receive it. The Cost Category must belong to your account. To stop sharing, send the same three keys with the value DISABLED.
For RI_SHARING and CREDIT_SHARING, you can share benefits by account group. Each rule in a Cost Category is one group. Send exactly one of these group keys with the value ENABLED:
open-sharing - Share across the whole consolidated billing family, with no groups.
costcategory-prioritized/{costCategoryArn} - Share within each group first, then with the rest of the family.
costcategory-restricted/{costCategoryArn} - An account in a group shares only with accounts in the same group.
For RI_SHARING, the costcategory- keys use a Cost Category that supports the billing:rispgroupsharing resource type. To use a Cost Category that supports the billing:benefitgroupsharing resource type, use the benefitgroup-prioritized/ or benefitgroup-restricted/ prefix instead. For CREDIT_SHARING, the Cost Category must support the billing:benefitgroupsharing resource type. The Cost Category must belong to your account. GetBillingPreferences returns the group key that is in effect.
An API to update the attributes of the billing view.
", "smithy.api#examples": [ { "title": "Invoke UpdateBillingView", "input": { "name": "Example Custom Billing View", "arn": "arn:aws:billing::123456789101:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899", "description": "Custom Billing View Example -- updated description", "dataFilterExpression": { "dimensions": { "key": "LINKED_ACCOUNT", "values": [ "000000000000" ] } } }, "output": { "arn": "arn:aws:billing::123456789101:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899", "updatedAt": 1719792001 } } ], "smithy.api#idempotent": {} } }, "com.amazonaws.billing#UpdateBillingViewRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.billing#BillingViewArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.billing#BillingViewName", "traits": { "smithy.api#documentation": "The name of the billing view.
" } }, "description": { "target": "com.amazonaws.billing#BillingViewDescription", "traits": { "smithy.api#documentation": "The description of the billing view.
" } }, "dataFilterExpression": { "target": "com.amazonaws.billing#Expression", "traits": { "smithy.api#documentation": "See Expression. Billing view only supports LINKED_ACCOUNT, Tags, and CostCategories.
The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
", "smithy.api#required": {} } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The time when the billing view was last updated.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.billing#ValidationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.billing#ErrorMessage", "traits": { "smithy.api#required": {} } }, "reason": { "target": "com.amazonaws.billing#ValidationExceptionReason", "traits": { "smithy.api#documentation": "The input fails to satisfy the constraints specified by an Amazon Web Services service.
", "smithy.api#required": {} } }, "fieldList": { "target": "com.amazonaws.billing#ValidationExceptionFieldList", "traits": { "smithy.api#documentation": "The input fails to satisfy the constraints specified by an Amazon Web Services service.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "BillingValidation", "httpResponseCode": 400 }, "smithy.api#documentation": "The input fails to satisfy the constraints specified by an Amazon Web Services service.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.billing#ValidationExceptionField": { "type": "structure", "members": { "name": { "target": "com.amazonaws.billing#FieldName", "traits": { "smithy.api#documentation": "The name of the field.
", "smithy.api#required": {} } }, "message": { "target": "com.amazonaws.billing#ErrorMessage", "traits": { "smithy.api#documentation": "The message describing why the field failed validation.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The field's information of a request that resulted in an exception.
" } }, "com.amazonaws.billing#ValidationExceptionFieldList": { "type": "list", "member": { "target": "com.amazonaws.billing#ValidationExceptionField" } }, "com.amazonaws.billing#ValidationExceptionReason": { "type": "enum", "members": { "UNKNOWN_OPERATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "unknownOperation" } }, "CANNOT_PARSE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "cannotParse" } }, "FIELD_VALIDATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "fieldValidationFailed" } }, "OTHER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "other" } } } }, "com.amazonaws.billing#Value": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": "^[\\S\\s]*$" } }, "com.amazonaws.billing#Values": { "type": "list", "member": { "target": "com.amazonaws.billing#Value" }, "traits": { "smithy.api#length": { "min": 1, "max": 200 } } } } }