list-business-support-account-charges¶

Description¶

Returns Business Support charges broken down at the linked account level for a given billing month.

Synopsis¶

  list-business-support-account-charges
--billing-month <value>
[--account-id <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--billing-month (string) [required]

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).

Constraints:

pattern: \d{4}-(0[1-9]|1[0-2])

--account-id (string)

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.

Constraints:

pattern: [0-9]{12}

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

Constraints:

min: 1

max: 100

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream
off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

billingMonth -> (string)

The billing month for the returned charges, in YYYY-MM format.

Constraints:

pattern: \d{4}-(0[1-9]|1[0-2])

isEstimated -> (boolean)

Specifies whether the Support charge amount is estimated. When false, the charge amount is finalized.

totalSupportCharge -> (string)

The total Business Support charge amount for all accounts in the billing month.

totalSupportEligibleSpend -> (string)

The total Support-eligible spend from all accounts in the billing month. This includes eligible spend from usage of Amazon Web Services.

accountCount -> (integer)

The total number of linked accounts with Business Support charges in the billing month.

accountCharges -> (list)

The list of Business Support charges per linked account.

Constraints:

min: 0

max: 100

(structure)

Business Support charges for a linked account.

accountId -> (string) [required]

The linked account ID.

Constraints:

pattern: [0-9]{12}

supportPlanName -> (string) [required]

The Support plan name for this account. Valid values: AWSSupportBusiness (Business Support plan), AWSSupportDeveloper (Developer Support plan), AWSSupportEssential (Basic Support plan).

totalCharge -> (string) [required]

The total Business Support charge amount for this account in the billing month.

totalUsageBasis -> (string) [required]

The total Support-eligible spend used as the basis for calculating the Business Support charge for this account.

tierCharges -> (list)

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.

Constraints:

min: 0

max: 20

(structure)

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.

tierDescription -> (string) [required]

A human-readable description of the pricing tier, including the spend range and percentage rate applied.

tierRate -> (string) [required]

The percentage rate applied to Support-eligible spend within this pricing tier.

usageSlice -> (string) [required]

The amount of Support-eligible spend that falls within this pricing tier.

tierCharge -> (string) [required]

The Business Support charge amount calculated for this pricing tier.

chargePeriodStartDate -> (timestamp)

The start date of the charge period for this tier charge.

chargePeriodEndDate -> (timestamp)

The end date of the charge period for this tier charge.

supportDiscount -> (structure)

The discount applied to the Business Support charge for this account, if any. This field is absent when no discount applies.

discountAmount -> (string)

The discount amount applied to the Business Support charge. This value is negative, representing a reduction in the charge.

discountPercentage -> (string)

The discount percentage applied to the Business Support charge, expressed as a decimal (for example, 0.12 for a 12% discount).

discountType -> (string)

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).

discountSource -> (string)

The source or program through which the discount was applied.

supportEligibleSpendByService -> (list)

The Support-eligible spend broken down by contributing service for this account.

Constraints:

min: 0

max: 50

(structure)

A service-level spend entry contributing to Business Support eligible spend.

contributingService -> (string) [required]

The name of the Amazon Web Services service contributing to the Support-eligible spend.

itemType -> (string) [required]

The type of the line item. Valid values: Usage .

description -> (string)

A human-readable description of the service spend entry.

chargeAmount -> (string) [required]

The Support-eligible spend amount for this service.

currency -> (string) [required]

The ISO 4217 currency code for the charge amount (for example, USD ).

nextToken -> (string)

The pagination token for the next page of results.

Constraints:

min: 1

max: 4095

pattern: [-a-zA-Z0-9+=/_]+

Table of Contents

Feedback

User Guide