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
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.
", "AssociateSourceViews": "Associates one or more source billing views with an existing billing view. This allows creating aggregate billing views that combine data from multiple sources.
", "CancelContractualInvestmentAttestation": "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).
Creates a billing view with the specified billing view attributes.
", "CreateContractualInvestmentAttestation": "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.
Deletes the specified billing view.
", "DisassociateContract": "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.
", "DisassociateSourceViews": "Removes the association between one or more source billing views and an existing billing view. This allows modifying the composition of aggregate billing views.
", "GetBillingPreferences": "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, and per-credit options.
", "GetBillingView": "Returns the metadata associated to the specified billing view ARN.
", "GetContractInformation": "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.
", "GetCreditAllocationHistory": "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.
", "GetCredits": "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.
Returns a summary of Enterprise Support data aggregated across all accounts in the Enterprise Support profile.
", "GetEnterpriseSupportContractDetails": "Returns Enterprise Support contract details.
", "GetResourcePolicy": "Returns the resource-based policy document attached to the resource in JSON format.
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.
", "ListBillingViews": "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.
Returns Business Support charges broken down at the linked account level for a given billing month.
", "ListBusinessSupportSubscriptionHistory": "Returns the history of Business Support subscription contracts across accounts.
", "ListContracts": "Lists the private pricing contracts that your Amazon Web Services account is an eligible payer account of. This operation is read-only and paginated.
", "ListContractualInvestmentAttestations": "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.
Lists the investment summaries within a specific private pricing contract. This operation is read-only and paginated.
", "ListContractualInvestments": "Lists the investments within a specific investment summary. This operation is read-only and paginated.
", "ListEnterpriseSupportLinkedAccountCharges": "Returns Support-eligible spend broken down at linked account level.
", "ListSourceViewsForBillingView": "Lists the source views (managed Amazon Web Services billing views) associated with the billing view.
", "ListTagsForResource": "Lists tags associated with the billing view resource.
", "RedeemCredits": "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.
", "TagResource": "An API operation for adding one or more tags (key-value pairs) to a resource.
", "UntagResource": "Removes one or more tags from a resource. Specify only tag keys in your request. Don't specify the value.
", "UpdateBillingPreferences": "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.
Sharing keys (RI_SHARING, CREDIT_SHARING, CREDIT_LEVEL_SHARING, and sharing keys under CREDIT_PREFERENCE_OPTIONS) may only be set by the management account of a consolidated billing family. The credit/{creditId}/status key may be set by member accounts for credits they own, or by the management account for any credit in the family.
An API to update the attributes of the billing view.
" }, "shapes": { "AccessDeniedException": { "base": "You don't have sufficient access to perform this action.
", "refs": {} }, "AccountId": { "base": null, "refs": { "AccountList$member": null, "BillingPreferenceSummary$accountId": "The associated Amazon Web Services account ID. Populated for account-list keys; null otherwise.
The account owner of the billing view.
", "BillingViewElement$sourceAccountId": "The Amazon Web Services account ID that owns the source billing view, if this is a derived billing view.
", "BillingViewListElement$ownerAccountId": "The list of owners of the Billing view.
", "BillingViewListElement$sourceAccountId": "The Amazon Web Services account ID that owns the source billing view, if this is a derived billing view.
", "BillingViewSegmentsListElement$billingTransferAccountId": "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.
", "BillingViewSegmentsListElement$managementAccountId": "The management account ID of the organization. The response includes this field for organization member accounts.
", "BillingViewSegmentsListElement$billingGroupPrimaryAccountId": "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.
", "BusinessSupportAccountCharge$accountId": "The linked account ID.
", "BusinessSupportSubscriptionContract$accountId": "The account ID associated with this subscription contract.
", "ChargeAccount$accountId": "The account ID.
", "ContractAccount$accountId": "The account ID.
", "CreditAllocationHistoryEntry$accountId": "The Amazon Web Services account the credit was applied to.
", "CreditData$accountId": "The Amazon Web Services account ID that owns the credit.
", "GetCreditAllocationHistoryRequest$accountId": "The Amazon Web Services account ID whose allocation history to retrieve. Must be a 12-digit numeric string.
", "GetEnterpriseSupportChargeSummaryResponse$payerAccountId": "The payer account ID that is authorized to view Enterprise Support data for all accounts in its Support profile.
", "InvestmentDistribution$accountId": "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.
", "LinkedAccountCharge$accountId": "The linked account ID.
", "LinkedAccountCharge$payerAccountId": "The payer account ID that is authorized to view Enterprise Support data for all accounts in its Support profile.
", "ListBillingViewsRequest$ownerAccountId": "The list of owners of the billing view.
", "ListBillingViewsRequest$sourceAccountId": "Filters the results to include only billing views that use the specified account as a source.
", "ListBusinessSupportAccountChargesRequest$accountId": "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.
", "ListBusinessSupportSubscriptionHistoryRequest$accountId": "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.
", "ListEnterpriseSupportLinkedAccountChargesRequest$accountId": "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.
", "ShareableAccountIds$member": null } }, "AccountList": { "base": "A list of 12-digit Amazon Web Services account IDs. The list contains at most 100 account IDs.
", "refs": { "PrivatePricingAddendum$eligiblePayerAccounts": "The payer accounts that are eligible under the private pricing addendum. The list contains at most 100 account IDs.
", "PrivatePricingAddendum$investmentAccounts": "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 display name of the account. Populated together with accountId; null otherwise.
A time range with a start and end time.
", "refs": { "ListBillingViewsRequest$activeTimeRange": " 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.
An additional charge applied to an Enterprise Support contract.
", "refs": { "AdditionalChargeList$member": null } }, "AdditionalChargeList": { "base": "A list of additional charges.
", "refs": { "GetEnterpriseSupportContractDetailsResponse$additionalSupportCharge": "Any Additional support charges applied to the contract.
", "GetEnterpriseSupportContractDetailsResponse$additionalSupportEligibleUsageSpend": "Any Additional support-eligible usage spend charges.
" } }, "AdditionalRecipient": { "base": "A recipient copied as a viewer on the executive approval request, in addition to the approver.
", "refs": { "AdditionalRecipients$member": null } }, "AdditionalRecipients": { "base": "A list of recipients copied as viewers on the executive approval request. The list contains at most 10 recipients.
", "refs": { "CreateContractualInvestmentAttestationRequest$additionalRecipients": "The email addresses to copy as viewers on the executive approval request.
" } }, "Amount": { "base": "A monetary amount with a currency code. Used throughout the Billing API to represent credit balances, allocations, and adjustments.
", "refs": { "AttestationValue$attestationAmount": "The value attested as a monetary amount. This form is valid only when the investment has no multiplier.
", "CreditAllocationHistoryEntry$creditAmount": "The amount of credit applied. Negative values represent credits that reduced the bill.
", "CreditData$initialAmount": "The initial amount of the credit when it was issued.
", "CreditData$remainingAmount": "The unused balance of the credit.
", "CreditData$estimatedAmount": "The estimated remaining balance, including in-flight (open) bills that have not yet been finalized.
", "InvestmentAttestation$attestedValue": "The monetary value attested.
", "InvestmentDistribution$investmentAmount": "The monetary value allocated to the recipient account.
", "InvestmentRestriction$amount": "The maximum monetary amount allowed under the restriction.
", "InvestmentSummary$maxAllowedInvestmentDisbursementValue": "The maximum monetary value that can be disbursed against the investment summary, inclusive of all outcomes combined under the summary.
", "MilestoneBasedInvestment$investmentValue": "The total value of the investment, including its currency and amount.
", "OutcomeBasedInvestment$disbursedValue": "The total value already disbursed against the investment. This value can be distributed among the investment accounts distribution.
" } }, "ApplicationType": { "base": null, "refs": { "CreditData$applicationType": "When the credit is applied during bill computation. Valid values: BEFORE_CROSS_SERVICE_DISCOUNTS, AFTER_DISCOUNTS.
Information about the executive approver who signs off on an investment attestation.
", "refs": { "CreateContractualInvestmentAttestationRequest$approverDetails": "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.
" } }, "ArnString": { "base": null, "refs": { "AssociateContractRequest$contractArn": "The Amazon Resource Name (ARN) of the contract to associate with your account.
", "CancelContractualInvestmentAttestationRequest$contractArn": "The Amazon Resource Name (ARN) of the contract that contains the attested investment.
", "ContractSummary$contractArn": "The Amazon Resource Name (ARN) of the contract. Pass this value to operations such as GetContractInformation, ListContractualInvestmentSummaries, and AssociateContract.
The Amazon Resource Name (ARN) of the contract that contains the investment being attested.
", "DisassociateContractRequest$contractArn": "The Amazon Resource Name (ARN) of the contract to disassociate from your account.
", "GetContractInformationRequest$contractArn": "The Amazon Resource Name (ARN) of the contract to retrieve information about.
", "ListContractualInvestmentAttestationsRequest$contractArn": "The Amazon Resource Name (ARN) of the contract whose attestations you want to list.
", "ListContractualInvestmentSummariesRequest$contractArn": "The Amazon Resource Name (ARN) of the contract whose investment summaries you want to list.
", "ListContractualInvestmentsRequest$contractArn": "The Amazon Resource Name (ARN) of the contract that contains the investment summary.
", "PrivatePricingAddendum$contractArn": "The Amazon Resource Name (ARN) of the private pricing addendum.
" } }, "AssociateContractRequest": { "base": null, "refs": {} }, "AssociateContractResponse": { "base": null, "refs": {} }, "AssociateSourceViewsRequest": { "base": null, "refs": {} }, "AssociateSourceViewsResponse": { "base": null, "refs": {} }, "AssociationStatus": { "base": "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.
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.
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.
" } }, "AttestationDetails": { "base": "The details of an investment attestation submission, including the value being attested and how the resulting investment is distributed.
", "refs": { "CreateContractualInvestmentAttestationRequest$attestationDetails": "The details of the attestation, including the value being claimed and how the resulting investment is distributed across investment accounts.
" } }, "AttestationQuantities": { "base": "A list of quantity-based attestation values. The list contains at most 50 quantities.
", "refs": { "AttestationValue$attestationQuantities": "The value attested as one or more quantities, each with its own unit. The list contains at most 50 quantities.
" } }, "AttestationQuantity": { "base": "A quantity-based attestation value, such as a count of workloads migrated.
", "refs": { "AttestationQuantities$member": null } }, "AttestationQuantityAttestationUnitString": { "base": null, "refs": { "AttestationQuantity$attestationUnit": "The unit of the attestation, such as workloads migrated. This value is 1–1000 characters.
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–1000 characters.
" } }, "AttestationValue": { "base": "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 value being attested, expressed as either a monetary amount or one or more quantities. Exactly one form is set.
" } }, "BillingDomain": { "base": "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 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 feature this preference belongs to.
", "GetBillingPreferencesRequestFeaturesList$member": null, "UpdateBillingPreferencesRequest$feature": "The feature to update. Valid values: BILLING_ALERTS, RI_SHARING, CREDIT_SHARING, CREDIT_LEVEL_SHARING, CREDIT_PREFERENCE_OPTIONS. The history features (RI_SHARING_HISTORY and CREDIT_SHARING_HISTORY) are read-only and cannot be updated.
A filter that narrows the set of preferences returned by GetBillingPreferences.
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.
The billing month of the application in YYYY-MM format.
A specific billing period identified by year and month.
", "refs": { "BillingPreferenceSummary$billingPeriod": "The billing period associated with the preference change. Populated only for the history features RI_SHARING_HISTORY and CREDIT_SHARING_HISTORY.
A single key/value entry used to update a billing preference.
", "refs": { "BillingPreferencesPerKey$member": null } }, "BillingPreferenceSummary": { "base": "A single billing preference entry returned by GetBillingPreferences.
The list of preference entries matching the request.
" } }, "BillingPreferencesPerKey": { "base": null, "refs": { "UpdateBillingPreferencesRequest$billingPreferencesPerKey": "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.
The Amazon Resource Name (ARN) of the billing view to associate source views with.
", "AssociateSourceViewsResponse$arn": "The ARN of the billing view that the source views were associated with.
", "BillingViewArnList$member": null, "BillingViewElement$arn": "The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
", "BillingViewListElement$arn": "The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
", "BillingViewSourceViewsList$member": null, "CreateBillingViewResponse$arn": "The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
", "DeleteBillingViewRequest$arn": "The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
", "DeleteBillingViewResponse$arn": "The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
", "DisassociateSourceViewsRequest$arn": "The Amazon Resource Name (ARN) of the billing view to disassociate source views from.
", "DisassociateSourceViewsResponse$arn": "The ARN of the billing view that the source views were disassociated from.
", "GetBillingViewRequest$arn": "The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
", "ListBillingViewSegmentsRequest$arn": " 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 Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
", "UpdateBillingViewRequest$arn": "The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
", "UpdateBillingViewResponse$arn": "The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
" } }, "BillingViewArnList": { "base": null, "refs": { "ListBillingViewsRequest$arns": "The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.
" } }, "BillingViewDescription": { "base": null, "refs": { "BillingViewElement$description": "The description of the billing view.
", "BillingViewListElement$description": "The description of the billing view.
", "CreateBillingViewRequest$description": "The description of the billing view.
", "UpdateBillingViewRequest$description": "The description of the billing view.
" } }, "BillingViewElement": { "base": "The metadata associated to the billing view.
", "refs": { "GetBillingViewResponse$billingView": "The billing view element associated with the specified ARN.
" } }, "BillingViewHealthStatus": { "base": "Represents the health status of a billing view, including a status code and optional reasons for the status.
", "refs": { "BillingViewElement$healthStatus": "The current health status of the billing view.
", "BillingViewListElement$healthStatus": "The current health status of the billing view.
" } }, "BillingViewHealthStatusException": { "base": " 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.
A list of BillingViewListElement retrieved.
A representation of a billing view.
", "refs": { "BillingViewList$member": null } }, "BillingViewName": { "base": null, "refs": { "BillingViewElement$name": "The account name of the billing view.
", "BillingViewListElement$name": "A list of names of the Billing view.
", "CreateBillingViewRequest$name": "The name of the billing view.
", "UpdateBillingViewRequest$name": "The name of the billing view.
" } }, "BillingViewSegmentTimeRange": { "base": "Specifies a time range with an inclusive begin date and an exclusive end date.
", "refs": { "BillingViewSegmentsListElement$timeRange": "The time range during which this segment is effective.
", "ListBillingViewSegmentsRequest$timeRange": "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.
" } }, "BillingViewSegmentsList": { "base": "A list of billing view segments.
", "refs": { "ListBillingViewSegmentsResponse$items": "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.
" } }, "BillingViewSegmentsListElement": { "base": "A billing view segment. A segment represents a time range during which the billing domain and account relationships for a billing view remained unchanged.
", "refs": { "BillingViewSegmentsList$member": null } }, "BillingViewSourceViewsList": { "base": null, "refs": { "AssociateSourceViewsRequest$sourceViews": "A list of ARNs of the source billing views to associate.
", "CreateBillingViewRequest$sourceViews": "A list of billing views used as the data source for the custom billing view.
", "DisassociateSourceViewsRequest$sourceViews": "A list of ARNs of the source billing views to disassociate.
", "ListSourceViewsForBillingViewResponse$sourceViews": "A list of billing views used as the data source for the custom billing view.
" } }, "BillingViewStatus": { "base": null, "refs": { "BillingViewHealthStatus$statusCode": "The current health status code of the billing view.
" } }, "BillingViewStatusReason": { "base": null, "refs": { "BillingViewStatusReasons$member": null } }, "BillingViewStatusReasons": { "base": null, "refs": { "BillingViewHealthStatus$statusReasons": "A list of reasons explaining the current health status, if applicable.
" } }, "BillingViewType": { "base": null, "refs": { "BillingViewElement$billingViewType": "The type of billing group.
", "BillingViewListElement$billingViewType": "The type of billing view.
", "BillingViewTypeList$member": null } }, "BillingViewTypeList": { "base": null, "refs": { "ListBillingViewsRequest$billingViewTypes": "The type of billing view.
" } }, "BillingViewsMaxResults": { "base": null, "refs": { "ListBillingViewSegmentsRequest$maxResults": "The number of entries a paginated response contains. Valid values range from 1 to 100. The default is 100.
", "ListBillingViewsRequest$maxResults": "The maximum number of billing views to retrieve. Default is 100.
", "ListSourceViewsForBillingViewRequest$maxResults": "The number of entries a paginated response contains.
" } }, "BillingYear": { "base": null, "refs": { "BillingPeriod$year": "The four-digit year of the billing period.
" } }, "Boolean": { "base": null, "refs": { "ContractAccount$isGdn": "When true, Support charges are calculated on charges before private discounts. When false, they are calculated after private discounts.
", "CreditAllocationHistoryEntry$isEstimatedBill": " true when the entry was applied to an in-flight bill that has not yet been finalized.
Whether the owning account has account-level credit sharing turned on.
", "DeleteBillingViewRequest$force": "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.
", "GetCreditAllocationHistoryResponse$partialResults": " true when data could not be retrieved for one or more billing months. The failedMonths field lists which months are missing.
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.
Specifies whether the Support charge amount is estimated. When false, the charge amount is finalized.
", "GetEnterpriseSupportContractDetailsResponse$isContractActive": "When true, the Enterprise Support contract is active. When false, the Enterprise Support Contract is inactive.
", "InvestmentAttestation$isCancellable": "Indicates whether the attestation can be canceled with CancelContractualInvestmentAttestation.
Specifies whether the Support charge amount is estimated. When false, the charge amount is finalized.
", "PricingPlan$discountAppliesToMinimumCharge": "Whether the discount applies to the minimum Support charge.
", "PricingPlanTier$incremental": "Whether the tier charges are calculated incrementally.
" } }, "BusinessSupportAccountCharge": { "base": "Business Support charges for a linked account.
", "refs": { "BusinessSupportAccountChargeList$member": null } }, "BusinessSupportAccountChargeList": { "base": "A list of Business Support account charges.
", "refs": { "ListBusinessSupportAccountChargesResponse$accountCharges": "The list of Business Support charges per linked account.
" } }, "BusinessSupportBillingMonth": { "base": "A billing month in YYYY-MM format. Supports the current month (estimated charges) and past months (finalized charges).
", "refs": { "ListBusinessSupportAccountChargesRequest$billingMonth": "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).
", "ListBusinessSupportAccountChargesResponse$billingMonth": "The billing month for the returned charges, in YYYY-MM format.
", "ListBusinessSupportSubscriptionHistoryRequest$billingMonth": "The billing month to retrieve subscription contracts for, in YYYY-MM format. If you don't specify a value, defaults to the current month.
" } }, "BusinessSupportDiscount": { "base": "A discount applied to a Business Support account charge, including the discount amount, percentage, type, and source.
", "refs": { "BusinessSupportAccountCharge$supportDiscount": "The discount applied to the Business Support charge for this account, if any. This field is absent when no discount applies.
" } }, "BusinessSupportServiceSpend": { "base": "A service-level spend entry contributing to Business Support eligible spend.
", "refs": { "BusinessSupportServiceSpendList$member": null } }, "BusinessSupportServiceSpendList": { "base": "A list of Business Support service spend entries.
", "refs": { "BusinessSupportAccountCharge$supportEligibleSpendByService": "The Support-eligible spend broken down by contributing service for this account.
" } }, "BusinessSupportSubscriptionContract": { "base": "A Business Support subscription contract for an account.
", "refs": { "BusinessSupportSubscriptionContractList$member": null } }, "BusinessSupportSubscriptionContractList": { "base": "A list of Business Support subscription contracts.
", "refs": { "ListBusinessSupportSubscriptionHistoryResponse$subscriptionContracts": "The list of Business Support subscription contracts.
" } }, "BusinessSupportTierCharge": { "base": "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.
", "refs": { "BusinessSupportTierChargeList$member": null } }, "BusinessSupportTierChargeList": { "base": "A list of Business Support tier charges.
", "refs": { "BusinessSupportAccountCharge$tierCharges": "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.
" } }, "CancelContractualInvestmentAttestationRequest": { "base": null, "refs": {} }, "CancelContractualInvestmentAttestationResponse": { "base": null, "refs": {} }, "CancellationReason": { "base": null, "refs": { "CancelContractualInvestmentAttestationRequest$reason": "The reason for the cancellation. This value can be 1 to 80 characters.
" } }, "ChargeAccount": { "base": "An account that is charged all or a portion of the total Support charge and the percentage of the charge allocated to it.
", "refs": { "ChargeAccountList$member": null } }, "ChargeAccountList": { "base": "A list of charge accounts.
", "refs": { "GetEnterpriseSupportContractDetailsResponse$chargedPayerAccountIds": "The list of payer accounts and their charge allocation percentages.
" } }, "ClientToken": { "base": null, "refs": { "CreateBillingViewRequest$clientToken": "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.
" } }, "ConflictException": { "base": "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.
", "refs": {} }, "ContractAccount": { "base": "An account that is covered by the Enterprise Support contract.
", "refs": { "ContractAccountList$member": null } }, "ContractAccountList": { "base": "A list of accounts that appear in the Enterprise Support Contract.
", "refs": { "GetEnterpriseSupportContractDetailsResponse$contractPayerAccountIds": "The list of accounts covered by the Enterprise Support contract.
" } }, "ContractDetails": { "base": "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.
The contract details such as term (duration), eligible payer accounts, investment accounts, and legal entities.
" } }, "ContractDocumentId": { "base": null, "refs": { "AssociateContractRequest$contractDocumentId": "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.
", "CreateContractualInvestmentAttestationRequest$contractDocumentId": "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.
" } }, "ContractRestriction": { "base": "A restriction that limits the self-service actions you can take on a contract. A contract with no restrictions supports all self-service actions.
", "refs": { "ContractRestrictions$member": null } }, "ContractRestrictions": { "base": "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.
", "refs": { "PrivatePricingAddendum$contractRestrictions": "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.
" } }, "ContractSummaries": { "base": "A list of private pricing contract summaries, as returned by ListContracts.
The list of contracts that your Amazon Web Services account is an eligible payer account of.
" } }, "ContractSummary": { "base": "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 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.
The unique name of the Cost Category.
" } }, "CostCategoryValues": { "base": "The Cost Categories values used for filtering the costs.
", "refs": { "Expression$costCategories": " The filter that's based on CostCategory values.
A single entry in the credit allocation history, representing how a credit was applied to a specific service during a billing month.
", "refs": { "CreditAllocationHistoryList$member": null } }, "CreditAllocationHistoryList": { "base": null, "refs": { "GetCreditAllocationHistoryResponse$creditAllocationHistoryList": "Allocation entries sorted by billingMonth in descending order.
Detailed information about an Amazon Web Services credit, including its identifier, type, monetary amounts, applicable products, sharing configuration, and current enabled status.
", "refs": { "CreditDataList$member": null } }, "CreditDataList": { "base": null, "refs": { "GetCreditsResponse$credits": "The list of credits matching the request. Returns an empty list when no credits exist.
" } }, "CreditId": { "base": null, "refs": { "CreditAllocationHistoryEntry$creditId": "The identifier of the credit that was applied.
", "CreditData$creditId": "The unique identifier for the credit.
" } }, "CreditSharingType": { "base": null, "refs": { "CreditData$creditSharingType": "The sharing configuration for the credit. Valid values: DEFAULT, DISABLED, CUSTOM, COST_CATEGORY_RULE.
Whether the credit participates in billing runs. Valid values: ENABLED, DISABLED.
The amount as a decimal string (for example, \"743.21\"). Negative values represent credits that reduce a bill.
The ISO 4217 currency code for the amount (for example, USD).
The names of the metadata types that you can use to filter and group your results.
" } }, "DimensionValues": { "base": "The metadata that you can use to filter and group your results.
", "refs": { "Expression$dimensions": " The specific Dimension to use for Expression.
The billing month in YYYY-MM format. This must be a month in the past.
", "refs": { "GetEnterpriseSupportChargeSummaryRequest$billingMonth": "The billing month in YYYY-MM format. This must be a month in the past.
", "GetEnterpriseSupportChargeSummaryResponse$billingMonth": "The billing month in YYYY-MM format. This must be a month in the past.
", "GetEnterpriseSupportContractDetailsRequest$billingMonth": "The billing month in YYYY-MM format. This must be a month in the past.
", "ListEnterpriseSupportLinkedAccountChargesRequest$billingMonth": "The billing month in YYYY-MM format. This must be a month in the past.
" } }, "EnterpriseSupportTimePeriod": { "base": "A time period for Enterprise Support billing.
", "refs": { "TimePeriodList$member": null } }, "ErrorMessage": { "base": null, "refs": { "AccessDeniedException$message": null, "BillingViewHealthStatusException$message": null, "ConflictException$message": null, "InternalServerException$message": null, "ResourceNotFoundException$message": null, "ServiceQuotaExceededException$message": null, "ThrottlingException$message": null, "ValidationException$message": null, "ValidationExceptionField$message": "The message describing why the field failed validation.
" } }, "Expression": { "base": " See Expression. Billing view only supports LINKED_ACCOUNT, Tags, and CostCategories.
See Expression. Billing view only supports LINKED_ACCOUNT, Tags, and CostCategories.
See Expression. Billing view only supports LINKED_ACCOUNT, Tags, and CostCategories.
See Expression. Billing view only supports LINKED_ACCOUNT, Tags, and CostCategories.
Billing months in YYYY-MM format that failed to return data. Non-empty only when partialResults is true.
The name of the field.
" } }, "GetBillingPreferencesRequest": { "base": null, "refs": {} }, "GetBillingPreferencesRequestFeaturesList": { "base": null, "refs": { "GetBillingPreferencesRequest$features": "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.
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.
The maximum number of records to return per page. Range: 1 to 50. Default: 50.
" } }, "GetBillingPreferencesResponse": { "base": null, "refs": {} }, "GetBillingViewRequest": { "base": null, "refs": {} }, "GetBillingViewResponse": { "base": null, "refs": {} }, "GetContractInformationRequest": { "base": null, "refs": {} }, "GetContractInformationResponse": { "base": null, "refs": {} }, "GetCreditAllocationHistoryRequest": { "base": null, "refs": {} }, "GetCreditAllocationHistoryRequestMaxResultsInteger": { "base": null, "refs": { "GetCreditAllocationHistoryRequest$maxResults": "The maximum number of records to return per page. Range: 1 to 1000. Default: 100.
" } }, "GetCreditAllocationHistoryResponse": { "base": null, "refs": {} }, "GetCreditsRequest": { "base": null, "refs": {} }, "GetCreditsResponse": { "base": null, "refs": {} }, "GetEnterpriseSupportChargeSummaryRequest": { "base": "The request structure for GetEnterpriseSupportChargeSummary.
", "refs": {} }, "GetEnterpriseSupportChargeSummaryResponse": { "base": "The response structure for GetEnterpriseSupportChargeSummary.
", "refs": {} }, "GetEnterpriseSupportContractDetailsRequest": { "base": "The request structure for GetEnterpriseSupportContractDetails.
", "refs": {} }, "GetEnterpriseSupportContractDetailsResponse": { "base": "The response structure for GetEnterpriseSupportContractDetails.
", "refs": {} }, "GetResourcePolicyRequest": { "base": null, "refs": {} }, "GetResourcePolicyResponse": { "base": null, "refs": {} }, "IdentifierString": { "base": null, "refs": { "CancelContractualInvestmentAttestationRequest$attestationId": "The identifier of the investment attestation to cancel.
", "CreateContractualInvestmentAttestationRequest$investmentSummaryId": "The identifier of the investment summary being attested. This is the parent to the investmentId.
", "CreateContractualInvestmentAttestationRequest$investmentId": "The identifier of the investment (outcome) being attested.
", "CreateContractualInvestmentAttestationResponse$attestationId": "The identifier of the submitted attestation.
", "InvestmentAttestation$attestationId": "The identifier of the attestation. This value is returned by CreateContractualInvestmentAttestation and is used to cancel the attestation with CancelContractualInvestmentAttestation. This value is 1–36 characters.
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 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–36 characters.
The identifier of a specific investment summary to filter the attestations by. If omitted, attestations for all investment summaries in the contract are returned.
", "ListContractualInvestmentsRequest$investmentSummaryId": "The identifier of the investment summary whose investments you want to list.
", "MilestoneBasedInvestment$investmentId": "The identifier of the investment, as returned by ListContractualInvestments. This value is 1–36 characters.
The identifier of the investment, as returned by ListContractualInvestments. This value is 1–36 characters.
The number of billing views that use this billing view as a source.
", "BillingViewElement$sourceViewCount": "The number of source views associated with this billing view.
", "ListBusinessSupportAccountChargesResponse$accountCount": "The total number of linked accounts with Business Support charges in the billing month.
" } }, "InternalServerException": { "base": "The request processing failed because of an unknown error, exception, or failure.
", "refs": {} }, "Interval": { "base": "A time period bounded by an inclusive start date and an inclusive end date.
", "refs": { "ContractSummary$contractTerm": "The contract term period of the contract, expressed as an interval with an inclusive start date and an inclusive end date.
", "OutcomeBasedInvestment$attestationWindow": "The time window, expressed as an interval with inclusive start and end dates, during which outcomes can be attested to.
", "PrivatePricingAddendum$contractTerm": "The contract term period of the private pricing addendum, expressed as an interval with an inclusive start date and an inclusive end date.
" } }, "Investment": { "base": "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.
A summary of a submitted investment attestation, as returned by ListContractualInvestmentAttestations.
The name of the investment summary that contains the attested outcome. This value is 1–400 characters.
" } }, "InvestmentAttestationOutcomeDescriptionString": { "base": null, "refs": { "InvestmentAttestation$outcomeDescription": "The description of the attested outcome. This value is 1–2048 characters.
" } }, "InvestmentAttestationStatus": { "base": "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.
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.
A list of investment attestations submitted under a private pricing contract, as returned by ListContractualInvestmentAttestations.
The list of investment attestations submitted under the contract.
" } }, "InvestmentDistribution": { "base": "An allocation of an investment disbursement to a specific recipient account. The account is the target account that receives the investment, not your account.
", "refs": { "InvestmentDistributions$member": null } }, "InvestmentDistributions": { "base": "A list of investment distributions that allocate an attested investment across recipient accounts. The list contains at most 200 distributions.
", "refs": { "AttestationDetails$investmentDistributions": "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.
", "InvestmentAttestation$investmentDistributions": "The distribution of the attested investment across the eligible investment accounts. The list contains at most 200 distributions.
" } }, "InvestmentMultiplier": { "base": "A multiplier used to convert attestation input into an investment value.
", "refs": { "InvestmentMultipliers$member": null } }, "InvestmentMultiplierInvestmentAttestationInputUnitString": { "base": null, "refs": { "InvestmentMultiplier$investmentAttestationInputUnit": "The unit of the attestation input that the multiplier applies to, such as workloads migrated. This value is 1–1000 characters. The terms of the contract define this value.
The multiplier value, expressed as a decimal string to preserve precision. The value is digits with an optional decimal point and is 1–1000 characters. The terms of the contract define this value.
" } }, "InvestmentMultipliers": { "base": "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.
", "refs": { "OutcomeBasedInvestment$investmentMultipliers": "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.
" } }, "InvestmentRestriction": { "base": "A restriction that caps the value that can be disbursed for an investment. The cap applies for each attestation window.
", "refs": { "InvestmentRestrictions$member": null } }, "InvestmentRestrictions": { "base": "A list of restrictions that cap the value that can be disbursed for an investment. The list contains at most 10 restrictions.
", "refs": { "OutcomeBasedInvestment$investmentRestrictions": "The restrictions that cap the value that can be disbursed for the investment. The list contains at most 10 restrictions.
" } }, "InvestmentSummaries": { "base": "A list of investment summaries within a contract or a private pricing addendum, as returned by ListContractualInvestmentSummaries.
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.
" } }, "InvestmentSummary": { "base": "Detailed information about an investment summary within a contract or a private pricing addendum.
", "refs": { "InvestmentSummaries$member": null } }, "InvestmentSummaryInvestmentNameString": { "base": null, "refs": { "InvestmentSummary$investmentName": "The name of the investment summary, used to reference the investment against a term in the physical contract. This value is 1–400 characters.
" } }, "InvestmentType": { "base": "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.
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.
A list of investments within an investment summary, as returned by ListContractualInvestments. For OUTCOME_BASED investments, they are referred to as outcomes.
The list of investments for the investment summary.
" } }, "LegalEntities": { "base": "A list of legal entities on a private pricing contract. The list contains at most 10 legal entities.
", "refs": { "PrivatePricingAddendum$legalEntities": "The legal entities on the private pricing addendum. The list contains at most 10 legal entities.
" } }, "LegalEntity": { "base": "A legal entity on a private pricing contract. It can be found on your contract's signature page.
", "refs": { "LegalEntities$member": null } }, "LinkedAccountCharge": { "base": "Enterprise Support charges for a linked account.
", "refs": { "LinkedAccountChargeList$member": null } }, "LinkedAccountChargeList": { "base": "A list of linked account charges.
", "refs": { "ListEnterpriseSupportLinkedAccountChargesResponse$linkedAccount": "The list of Enterprise Support charges per linked account.
" } }, "ListBillingViewSegmentsRequest": { "base": null, "refs": {} }, "ListBillingViewSegmentsResponse": { "base": null, "refs": {} }, "ListBillingViewsRequest": { "base": null, "refs": {} }, "ListBillingViewsResponse": { "base": null, "refs": {} }, "ListBusinessSupportAccountChargesRequest": { "base": "Contains the billing month and optional filters used to retrieve Business Support charges broken down by linked account.
", "refs": {} }, "ListBusinessSupportAccountChargesRequestMaxResultsInteger": { "base": null, "refs": { "ListBusinessSupportAccountChargesRequest$maxResults": "The maximum number of results to return per page. Default is 100.
" } }, "ListBusinessSupportAccountChargesResponse": { "base": "Contains the Business Support charges broken down by linked account for the specified billing month, along with account and spend totals.
", "refs": {} }, "ListBusinessSupportSubscriptionHistoryRequest": { "base": "Contains the optional filters used to retrieve the history of Business Support subscription contracts across accounts.
", "refs": {} }, "ListBusinessSupportSubscriptionHistoryRequestMaxResultsInteger": { "base": null, "refs": { "ListBusinessSupportSubscriptionHistoryRequest$maxResults": "The maximum number of results to return per page. Default is 100.
" } }, "ListBusinessSupportSubscriptionHistoryResponse": { "base": "Contains the list of Business Support subscription contracts that match the request filters.
", "refs": {} }, "ListContractsRequest": { "base": null, "refs": {} }, "ListContractsRequestMaxResultsInteger": { "base": null, "refs": { "ListContractsRequest$maxResults": "The maximum number of contracts to return in a single call. Minimum value of 1, maximum value of 100.
" } }, "ListContractsResponse": { "base": null, "refs": {} }, "ListContractualInvestmentAttestationsRequest": { "base": null, "refs": {} }, "ListContractualInvestmentAttestationsRequestMaxResultsInteger": { "base": null, "refs": { "ListContractualInvestmentAttestationsRequest$maxResults": "The maximum number of attestations to return in a single call. Minimum value of 1, maximum value of 100.
" } }, "ListContractualInvestmentAttestationsResponse": { "base": null, "refs": {} }, "ListContractualInvestmentSummariesRequest": { "base": null, "refs": {} }, "ListContractualInvestmentSummariesRequestMaxResultsInteger": { "base": null, "refs": { "ListContractualInvestmentSummariesRequest$maxResults": "The maximum number of investment summaries to return in a single call. Minimum value of 1, maximum value of 100.
" } }, "ListContractualInvestmentSummariesResponse": { "base": null, "refs": {} }, "ListContractualInvestmentsRequest": { "base": null, "refs": {} }, "ListContractualInvestmentsRequestMaxResultsInteger": { "base": null, "refs": { "ListContractualInvestmentsRequest$maxResults": "The maximum number of investments to return in a single call. Minimum value of 1, maximum value of 100.
" } }, "ListContractualInvestmentsResponse": { "base": null, "refs": {} }, "ListEnterpriseSupportLinkedAccountChargesRequest": { "base": "The request structure for ListEnterpriseSupportLinkedAccountCharges.
", "refs": {} }, "ListEnterpriseSupportLinkedAccountChargesRequestMaxResultsInteger": { "base": null, "refs": { "ListEnterpriseSupportLinkedAccountChargesRequest$maxResults": "The maximum number of results to return per page. Default is 100.
" } }, "ListEnterpriseSupportLinkedAccountChargesResponse": { "base": "The response structure for ListEnterpriseSupportLinkedAccountCharges.
", "refs": {} }, "ListSourceViewsForBillingViewRequest": { "base": null, "refs": {} }, "ListSourceViewsForBillingViewResponse": { "base": null, "refs": {} }, "ListTagsForResourceRequest": { "base": null, "refs": {} }, "ListTagsForResourceResponse": { "base": null, "refs": {} }, "Long": { "base": null, "refs": { "GetCreditAllocationHistoryRequest$creditId": "Filters the result to a single credit. When omitted, returns allocation entries for all credits.
", "LinkedAccountCharge$billableSeconds": "The number of billable seconds in the billing period based on when the account was subscribed to Enterprise Support.
", "LinkedAccountCharge$totalSeconds": "The total number of seconds in the billing period.
" } }, "MilestoneBasedInvestment": { "base": "An investment with a fixed value that is disbursed on a schedule. This corresponds to the MILESTONE_BASED investment type.
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.
The month of the billing period as an integer between 1 and 12.
" } }, "MultiplierType": { "base": "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 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.
An investment that is awarded upon completion of a defined outcome. This corresponds to the OUTCOME_BASED investment type and is claimed through CreateContractualInvestmentAttestation.
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.
The description of what must be completed to attest the outcome. This value is 1–2048 characters.
" } }, "PageToken": { "base": null, "refs": { "GetBillingPreferencesRequest$nextToken": "Pagination token from a previous response. Pass the value returned in nextToken to retrieve the next page of results.
Pagination token. Present when more pages are available; null when there are no more results.
Pagination token from a previous response. Pass the value returned in nextToken to retrieve the next page of results.
Pagination token. Present when more pages are available; null when there are no more results.
The pagination token that is used on subsequent calls to list billing view segments.
", "ListBillingViewSegmentsResponse$nextToken": "The pagination token that is used on subsequent calls to list billing view segments.
", "ListBillingViewsRequest$nextToken": "The pagination token that is used on subsequent calls to list billing views.
", "ListBillingViewsResponse$nextToken": "The pagination token to use on subsequent calls to list billing views.
", "ListBusinessSupportAccountChargesRequest$nextToken": "The pagination token for the next page of results.
", "ListBusinessSupportAccountChargesResponse$nextToken": "The pagination token for the next page of results.
", "ListBusinessSupportSubscriptionHistoryRequest$nextToken": "The pagination token for the next page of results.
", "ListBusinessSupportSubscriptionHistoryResponse$nextToken": "The pagination token for the next page of results.
", "ListContractsRequest$nextToken": "The pagination token that indicates the next set of results to retrieve.
", "ListContractsResponse$nextToken": "The pagination token to use on subsequent calls to retrieve the next set of results.
", "ListContractualInvestmentAttestationsRequest$nextToken": "The pagination token that indicates the next set of results to retrieve.
", "ListContractualInvestmentAttestationsResponse$nextToken": "The pagination token to use on subsequent calls to retrieve the next set of results.
", "ListContractualInvestmentSummariesRequest$nextToken": "The pagination token that indicates the next set of results to retrieve.
", "ListContractualInvestmentSummariesResponse$nextToken": "The pagination token to use on subsequent calls to retrieve the next set of results.
", "ListContractualInvestmentsRequest$nextToken": "The pagination token that indicates the next set of results to retrieve.
", "ListContractualInvestmentsResponse$nextToken": "The pagination token to use on subsequent calls to retrieve the next set of results.
", "ListEnterpriseSupportLinkedAccountChargesRequest$nextToken": "The pagination token for the next page of results.
", "ListEnterpriseSupportLinkedAccountChargesResponse$nextToken": "The pagination token for the next page of results.
", "ListSourceViewsForBillingViewRequest$nextToken": "The pagination token that is used on subsequent calls to list billing views.
", "ListSourceViewsForBillingViewResponse$nextToken": "The pagination token that is used on subsequent calls to list billing views.
" } }, "PolicyDocument": { "base": null, "refs": { "GetResourcePolicyResponse$policy": "The resource-based policy document attached to the resource in JSON format.
The preference key. Format depends on the feature being updated.
", "BillingPreferenceSummary$key": "The preference key. Format depends on the feature.
" } }, "PreferenceValue": { "base": null, "refs": { "BillingPreferenceForKey$value": "The preference value. Valid values: ENABLED or DISABLED.
The preference value. Valid values: ENABLED or DISABLED.
A pricing plan for Enterprise Support billing.
", "refs": { "GetEnterpriseSupportChargeSummaryResponse$supportEffectivePricingPlan": "The effective pricing plan used for the support charge calculation.
", "PricingPlanList$member": null } }, "PricingPlanList": { "base": "A list of pricing plans.
", "refs": { "GetEnterpriseSupportContractDetailsResponse$pricingPlans": "The pricing plans associated with this Enterprise Support contract.
" } }, "PricingPlanTier": { "base": "A tier within an Enterprise Support pricing plan.
", "refs": { "PricingPlanTierList$member": null } }, "PricingPlanTierList": { "base": "A list of pricing plan tiers.
", "refs": { "PricingPlan$tiers": "The pricing tiers within this plan.
" } }, "PrivatePricingAddendum": { "base": "The details of a private pricing addendum contract.
", "refs": { "ContractDetails$privatePricingAddendum": "The details of a private pricing addendum contract. This member is set when the contract is a private pricing addendum.
" } }, "ProductName": { "base": null, "refs": { "ProductNames$member": null } }, "ProductNames": { "base": null, "refs": { "CreditData$applicableProductNames": "The names of Amazon Web Services services this credit applies to.
" } }, "PromoCode": { "base": null, "refs": { "RedeemCreditsRequest$promoCode": "The promotional credit code to redeem.
" } }, "PurchaseType": { "base": null, "refs": { "PurchaseTypeApplications$member": null } }, "PurchaseTypeApplications": { "base": null, "refs": { "CreditData$purchaseTypeApplications": "Restricts which purchase types this credit applies to. When null or omitted, the credit applies to all purchase types.
The container for the quotaCode.
A single reason an attestation was rejected. This value is 1–300 characters.
", "refs": { "RejectionReasons$member": null } }, "RejectionReasons": { "base": "A list of reasons an attestation was rejected. The list contains at most 30 reasons.
", "refs": { "InvestmentAttestation$rejectionReasons": "The reasons the attestation was rejected. This value is present only when attestationStatus is REJECTED. The list contains at most 30 reasons.
The Amazon Resource Name (ARN) of the billing view resource to which the policy is attached to.
", "GetResourcePolicyResponse$resourceArn": "The Amazon Resource Name (ARN) of the billing view resource to which the policy is attached to.
", "ListTagsForResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource.
", "TagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource.
", "UntagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource.
" } }, "ResourceId": { "base": null, "refs": { "ConflictException$resourceId": "The identifier for the service resource associated with the request.
", "ResourceNotFoundException$resourceId": "Value is a list of resource IDs that were not found.
", "ServiceQuotaExceededException$resourceId": "The ID of the resource.
" } }, "ResourceNotFoundException": { "base": "The specified ARN in the request doesn't exist.
", "refs": {} }, "ResourceTag": { "base": "The tag structure that contains a tag key and value.
", "refs": { "ResourceTagList$member": null } }, "ResourceTagKey": { "base": null, "refs": { "ResourceTag$key": "The key that's associated with the tag.
", "ResourceTagKeyList$member": null } }, "ResourceTagKeyList": { "base": null, "refs": { "UntagResourceRequest$resourceTagKeys": "A list of tag key value pairs that are associated with the resource.
" } }, "ResourceTagList": { "base": null, "refs": { "CreateBillingViewRequest$resourceTags": "A list of key value map specifying tags associated to the billing view being created.
", "ListTagsForResourceResponse$resourceTags": "A list of tag key value pairs that are associated with the resource.
", "TagResourceRequest$resourceTags": "A list of tag key value pairs that are associated with the resource.
" } }, "ResourceTagValue": { "base": null, "refs": { "ResourceTag$value": "The value that's associated with the tag.
" } }, "ResourceType": { "base": null, "refs": { "ConflictException$resourceType": "The type of resource associated with the request.
", "ResourceNotFoundException$resourceType": "Value is the type of resource that was not found.
", "ServiceQuotaExceededException$resourceType": "The type of Amazon Web Services resource.
" } }, "SearchOption": { "base": null, "refs": { "StringSearch$searchOption": "The type of search operation to perform on the string value. Determines how the search value is matched against the target field.
" } }, "SearchValue": { "base": null, "refs": { "StringSearch$searchValue": "The string value to use in the search operation. This value is compared against the target field using the specified search option.
" } }, "SensitiveEmail": { "base": null, "refs": { "AdditionalRecipient$email": "The email address of the recipient. This value is 3–256 characters and must be a valid email address.
", "ApproverDetails$email": "The email address of the approver. This value is 3–256 characters and must be a valid email address.
" } }, "SensitiveString": { "base": null, "refs": { "ApproverDetails$name": "The name of the approver as it appears on the contract. This value can be up to 256 characters.
", "ApproverDetails$title": "The title of the approver, such as Chief Financial Officer. This value can be up to 256 characters.
The name of the legal entity as it appears on the contract document. This value can be up to 256 characters.
" } }, "ServiceCode": { "base": null, "refs": { "ServiceQuotaExceededException$serviceCode": " The container for the serviceCode.
Service-level usage details by account.
", "refs": { "ServiceLevelAccountUsageList$member": null } }, "ServiceLevelAccountUsageList": { "base": "A list of service-level account usages.
", "refs": { "LinkedAccountCharge$supportEligibleSpendByService": "The support-eligible spend broken down by service.
" } }, "ServiceQuotaExceededException": { "base": "You've reached the limit of resources you can create, or exceeded the size of an individual resource.
", "refs": {} }, "ShareableAccountIds": { "base": null, "refs": { "CreditData$shareableAccounts": "The Amazon Web Services account IDs entitled to apply this credit.
" } }, "String": { "base": null, "refs": { "AdditionalCharge$description": "A description of the additional charge.
", "AdditionalCharge$amount": "The charge amount.
", "AdditionalCharge$chargeType": "The type of additional charge.
", "BusinessSupportAccountCharge$supportPlanName": "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.
", "BusinessSupportAccountCharge$totalUsageBasis": "The total Support-eligible spend used as the basis for calculating the Business Support charge for this account.
", "BusinessSupportDiscount$discountAmount": "The discount amount applied to the Business Support charge. This value is negative, representing a reduction in the charge.
", "BusinessSupportDiscount$discountPercentage": "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.
", "BusinessSupportServiceSpend$contributingService": "The name of the Amazon Web Services service contributing to the Support-eligible spend.
", "BusinessSupportServiceSpend$itemType": "The type of the line item. Valid values: Usage.
A human-readable description of the service spend entry.
", "BusinessSupportServiceSpend$chargeAmount": "The Support-eligible spend amount for this service.
", "BusinessSupportServiceSpend$currency": "The ISO 4217 currency code for the charge amount (for example, USD).
The name of the Support plan for this subscription contract. Valid values: AWSSupportBusiness (Business Support plan), AWSSupportDeveloper (Developer Support plan), AWSSupportEssential (Basic Support plan).
A human-readable description of the pricing tier, including the spend range and percentage rate applied.
", "BusinessSupportTierCharge$tierRate": "The percentage rate applied to Support-eligible spend within this pricing tier.
", "BusinessSupportTierCharge$usageSlice": "The amount of Support-eligible spend that falls within this pricing tier.
", "BusinessSupportTierCharge$tierCharge": "The Business Support charge amount calculated for this pricing tier.
", "ChargeAccount$chargePercentage": "The percentage of the total Support charge allocated to this account. This is 0.0 when supportAllocationMethod = Proportional.
", "CreditAllocationHistoryEntry$description": "A human-readable description of the credit allocation.
", "CreditAllocationHistoryEntry$appliedServiceName": "The Amazon Web Services service the credit was applied to.
", "CreditData$creditType": "The type of credit. Examples: Promotion, Refund, TrueUp.
A human-readable description of the credit.
", "CreditData$creditConsoleVisibility": "The display configuration for the credit in the Amazon Web Services Billing console.
", "CreditData$costCategoryArn": "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.
The Amazon Web Services account ID. Must be a 12-digit numeric string.
", "GetEnterpriseSupportChargeSummaryResponse$supportCharge": "The Support charge amount for the account.
", "GetEnterpriseSupportChargeSummaryResponse$totalSupportCharge": "The total Support charge amount for all accounts in the Support profile.
", "GetEnterpriseSupportChargeSummaryResponse$supportDiscount": "The support discount amount.
", "GetEnterpriseSupportChargeSummaryResponse$totalSupportEligibleSpend": "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.
", "GetEnterpriseSupportChargeSummaryResponse$totalSupportEligibleUsageSpend": "The total Support-eligible spend from usage of Amazon Web Services from all accounts in the Support profile.
", "GetEnterpriseSupportChargeSummaryResponse$totalSupportEligibleReservedInstanceSpend": "The total Support-eligible Reserved Instance spend from all accounts in the Support profile.
", "GetEnterpriseSupportChargeSummaryResponse$totalSupportEligibleSavingsPlanSpend": "The total Support-eligible Savings Plan spend from all accounts in the Support profile.
", "GetEnterpriseSupportChargeSummaryResponse$supportChargePercentage": "The percentage applied to the total Support-eligible spend to calculate the total Support charge across all accounts in the Support profile.
", "GetEnterpriseSupportContractDetailsResponse$supportAllocationMethod": "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.
", "GetEnterpriseSupportContractDetailsResponse$supportReservedInstanceTreatmentMethod": "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).
", "GetEnterpriseSupportContractDetailsResponse$supportSavingsPlansTreatmentMethod": "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).
", "LinkedAccountCharge$accountType": "The type of account.
", "LinkedAccountCharge$totalSupportEligibleSpend": "The total support-eligible spend for this account.
", "LinkedAccountCharge$proratedTotalSupportEligibleSpend": "The prorated total support-eligible spend based on when the account was subscribed to Enterprise Support.
", "LinkedAccountCharge$totalSupportEligibleReservedInstanceSpend": "The total support-eligible Reserved Instance spend for this account.
", "LinkedAccountCharge$totalSupportEligibleSavingsPlanSpend": "The total support-eligible Savings Plan spend for this account.
", "ListBusinessSupportAccountChargesResponse$totalSupportCharge": "The total Business Support charge amount for all accounts in the billing month.
", "ListBusinessSupportAccountChargesResponse$totalSupportEligibleSpend": "The total Support-eligible spend from all accounts in the billing month. This includes eligible spend from usage of Amazon Web Services.
", "PricingPlan$pricingPlanId": "The unique identifier for the pricing plan.
", "PricingPlan$name": "The name of the pricing plan.
", "PricingPlan$description": "A description of the pricing plan.
", "PricingPlan$planDiscountPercent": "The discount percentage applied by this pricing plan.
", "PricingPlan$minimumCharge": "The minimum Support charge amount for this pricing plan.
", "PricingPlan$tiered": "Whether the pricing plan uses tiered pricing.
", "PricingPlanTier$tierMinimum": "The minimum spend threshold for this tier.
", "PricingPlanTier$tierMaximum": "The maximum spend threshold for this tier.
", "PricingPlanTier$baseCharge": "The base charge for this tier.
", "PricingPlanTier$additionalPercentageOfAggregateCharges": "The additional percentage applied to aggregate charges in this tier.
", "PricingPlanTier$aggregateChargesAdjustment": "The adjustment applied to aggregate charges.
", "PricingPlanTier$increment": "The increment amount for incremental tier calculations.
", "PricingPlanTier$incrementCharge": "The charge per increment.
", "ServiceLevelAccountUsage$serviceCode": "The service code for which to return Support-eligible spend data.
", "ServiceLevelAccountUsage$totalSupportEligibleSpend": "The total support-eligible spend for the service.
" } }, "StringSearch": { "base": "A structure that defines how to search for string values. You can specify a search option and the value to search for.
", "refs": { "StringSearches$member": null } }, "StringSearches": { "base": null, "refs": { "ListBillingViewsRequest$names": "Filters the list of billing views by name. You can specify search criteria to match billing view names based on the search option provided.
" } }, "TagKey": { "base": null, "refs": { "TagValues$key": "The key for the tag.
" } }, "TagResourceRequest": { "base": null, "refs": {} }, "TagResourceResponse": { "base": null, "refs": {} }, "TagValues": { "base": "The values that are available for a tag.
", "refs": { "Expression$tags": " The specific Tag to use for Expression.
The request was denied due to request throttling.
", "refs": {} }, "TimePeriodList": { "base": "A list of time periods.
", "refs": { "LinkedAccountCharge$linkedTimePeriods": "The time periods during which this account was linked.
", "LinkedAccountCharge$subscriptionTimePeriods": "The subscription time periods for this account.
" } }, "TimeRange": { "base": "Specifies a time range with inclusive begin and end dates.
", "refs": { "Expression$timeRange": "Specifies a time range filter for the billing view data.
" } }, "Timestamp": { "base": null, "refs": { "ActiveTimeRange$activeAfterInclusive": "The inclusive time range start date.
", "ActiveTimeRange$activeBeforeInclusive": "The inclusive time range end date.
", "BillingViewElement$createdAt": "The time when the billing view was created.
", "BillingViewElement$updatedAt": "The time when the billing view was last updated.
", "BillingViewElement$viewDefinitionLastUpdatedAt": "The timestamp of when the billing view definition was last updated.
", "BillingViewSegmentTimeRange$beginDateInclusive": "The inclusive start of the time range. This value can't be in the future.
", "BillingViewSegmentTimeRange$endDateExclusive": " The exclusive end of the time range. This value must be after beginDateInclusive.
The start date of the subscription contract.
", "BusinessSupportSubscriptionContract$contractEndDate": "The end date of the subscription contract.
", "BusinessSupportTierCharge$chargePeriodStartDate": "The start date of the charge period for this tier charge.
", "BusinessSupportTierCharge$chargePeriodEndDate": "The end date of the charge period for this tier charge.
", "ContractSummary$lastUpdatedAt": "The time when the contract was last associated with your account.
", "CreateBillingViewResponse$createdAt": "The time when the billing view was created.
", "CreateContractualInvestmentAttestationRequest$investmentDisbursedAt": "The date on which the investment is disbursed to the investment accounts. The disbursement date is subject to review timelines.
", "CreditData$startDate": "The date the credit becomes valid, as Unix epoch seconds.
", "CreditData$endDate": "The date the credit expires, as Unix epoch seconds.
", "CreditData$exhaustDate": "The date the credit balance reached zero, as Unix epoch seconds.
", "EnterpriseSupportTimePeriod$beginDate": "The begin date of the time period.
", "EnterpriseSupportTimePeriod$endDate": "The end date of the time period.
", "GetCreditAllocationHistoryRequest$startDate": "Inclusive start date as Unix epoch seconds. Must be on or before endDate. The range from startDate to endDate cannot exceed 24 billing months.
Inclusive end date as Unix epoch seconds.
", "GetCreditsRequest$startDate": "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.
", "GetCreditsRequest$endDate": "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.
The start date of the billing period.
", "GetEnterpriseSupportChargeSummaryResponse$billingPeriodEndDate": "The end date of the billing period.
", "GetEnterpriseSupportChargeSummaryResponse$billDate": "The date the bill was generated.
", "GetEnterpriseSupportContractDetailsResponse$supportReservedInstanceAmortizationStartDate": "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.
", "GetEnterpriseSupportContractDetailsResponse$supportSavingsPlansAmortizationStartDate": "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.
", "GetEnterpriseSupportContractDetailsResponse$supportProrateStartDate": "The start date for accounts subscribed or unsubscribed to Support billing during the billing month.
", "Interval$startDateInclusive": "The start date of the interval. This date is included in the interval.
", "Interval$endDateInclusive": "The end date of the interval. This date is included in the interval.
", "InvestmentAttestation$attestedAt": "The date on which the attestation was submitted.
", "InvestmentAttestation$updatedAt": "The date on which the attestation was last updated.
", "InvestmentAttestation$investmentDisbursedAt": "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.
", "ListBusinessSupportSubscriptionHistoryRequest$startDate": "The start date to filter subscription contracts from.
", "ListBusinessSupportSubscriptionHistoryRequest$endDate": "The end date to filter subscription contracts to.
", "MilestoneBasedInvestment$investmentDisbursedAt": "The date on which the investment is disbursed to the investment accounts.
", "PricingPlan$startDate": "The start date of the pricing plan.
", "PricingPlan$endDate": "The end date of the pricing plan.
", "TimeRange$beginDateInclusive": "The inclusive start date of the time range.
", "TimeRange$endDateInclusive": "The inclusive end date of the time range.
", "UpdateBillingViewResponse$updatedAt": "The time when the billing view was last updated.
" } }, "UntagResourceRequest": { "base": null, "refs": {} }, "UntagResourceResponse": { "base": null, "refs": {} }, "UpdateBillingPreferencesRequest": { "base": null, "refs": {} }, "UpdateBillingPreferencesResponse": { "base": null, "refs": {} }, "UpdateBillingViewRequest": { "base": null, "refs": {} }, "UpdateBillingViewResponse": { "base": null, "refs": {} }, "ValidationException": { "base": "The input fails to satisfy the constraints specified by an Amazon Web Services service.
", "refs": {} }, "ValidationExceptionField": { "base": "The field's information of a request that resulted in an exception.
", "refs": { "ValidationExceptionFieldList$member": null } }, "ValidationExceptionFieldList": { "base": null, "refs": { "ValidationException$fieldList": "The input fails to satisfy the constraints specified by an Amazon Web Services service.
" } }, "ValidationExceptionReason": { "base": null, "refs": { "ValidationException$reason": "The input fails to satisfy the constraints specified by an Amazon Web Services service.
" } }, "Value": { "base": null, "refs": { "Values$member": null } }, "Values": { "base": null, "refs": { "CostCategoryValues$values": "The specific value of the Cost Category.
", "DimensionValues$values": "The metadata values that you can use to filter and group your results.
", "TagValues$values": "The specific value of the tag.
" } } } }