Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListBusinessSupportAccountCharges

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

Request Syntax


{
   "accountId": "string",
   "billingMonth": "string",
   "maxResults": number,
   "nextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

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.

Type: String

Pattern: [0-9]{12}

Required: No

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

Type: String

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

Required: Yes

maxResults

The maximum number of results to return per page. Default is 100.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

nextToken

The pagination token for the next page of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4095.

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

Required: No

Response Syntax


{
   "accountCharges": [ 
      { 
         "accountId": "string",
         "supportDiscount": { 
            "discountAmount": "string",
            "discountPercentage": "string",
            "discountSource": "string",
            "discountType": "string"
         },
         "supportEligibleSpendByService": [ 
            { 
               "chargeAmount": "string",
               "contributingService": "string",
               "currency": "string",
               "description": "string",
               "itemType": "string"
            }
         ],
         "supportPlanName": "string",
         "tierCharges": [ 
            { 
               "chargePeriodEndDate": number,
               "chargePeriodStartDate": number,
               "tierCharge": "string",
               "tierDescription": "string",
               "tierRate": "string",
               "usageSlice": "string"
            }
         ],
         "totalCharge": "string",
         "totalUsageBasis": "string"
      }
   ],
   "accountCount": number,
   "billingMonth": "string",
   "isEstimated": boolean,
   "nextToken": "string",
   "totalSupportCharge": "string",
   "totalSupportEligibleSpend": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

accountCharges

The list of Business Support charges per linked account.

Type: Array of BusinessSupportAccountCharge objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

accountCount

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

Type: Integer

billingMonth

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

Type: String

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

isEstimated

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

Type: Boolean

nextToken

The pagination token for the next page of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4095.

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

totalSupportCharge

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

Type: String

totalSupportEligibleSpend

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

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You don't have sufficient access to perform this action.

HTTP Status Code: 400

InternalServerException

The request processing failed because of an unknown error, exception, or failure.

HTTP Status Code: 500

ResourceNotFoundException

The specified ARN in the request doesn't exist.

resourceId: Value is a list of resource IDs that were not found.
resourceType: Value is the type of resource that was not found.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

fieldList: The input fails to satisfy the constraints specified by an AWS service.
reason: The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400