GetEnterpriseSupportChargeSummary
Returns a summary of Enterprise Support data aggregated across all accounts in the Enterprise Support profile.
Request Syntax
{
"billingMonth": "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.
- billingMonth
-
The billing month in YYYY-MM format. This must be a month in the past.
Type: String
Pattern:
\d{4}-(0[1-9]|1[0-2])Required: Yes
Response Syntax
{
"billDate": number,
"billingMonth": "string",
"billingPeriodEndDate": number,
"billingPeriodStartDate": number,
"isEstimated": boolean,
"payerAccountId": "string",
"supportCharge": "string",
"supportChargePercentage": "string",
"supportDiscount": "string",
"supportEffectivePricingPlan": {
"description": "string",
"discountAppliesToMinimumCharge": boolean,
"endDate": number,
"minimumCharge": "string",
"name": "string",
"planDiscountPercent": "string",
"pricingPlanId": "string",
"startDate": number,
"tiered": "string",
"tiers": [
{
"additionalPercentageOfAggregateCharges": "string",
"aggregateChargesAdjustment": "string",
"baseCharge": "string",
"increment": "string",
"incremental": boolean,
"incrementCharge": "string",
"tierMaximum": "string",
"tierMinimum": "string"
}
]
},
"totalSupportCharge": "string",
"totalSupportEligibleReservedInstanceSpend": "string",
"totalSupportEligibleSavingsPlanSpend": "string",
"totalSupportEligibleSpend": "string",
"totalSupportEligibleUsageSpend": "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.
- billDate
-
The date the bill was generated.
Type: Timestamp
- billingMonth
-
The billing month in YYYY-MM format. This must be a month in the past.
Type: String
Pattern:
\d{4}-(0[1-9]|1[0-2]) - billingPeriodEndDate
-
The end date of the billing period.
Type: Timestamp
- billingPeriodStartDate
-
The start date of the billing period.
Type: Timestamp
- isEstimated
-
When true, the Support charge amount is estimated. When false, the Support charge amount is finalized.
Type: Boolean
- payerAccountId
-
The payer account ID that is authorized to view Enterprise Support data for all accounts in its Support profile.
Type: String
Pattern:
[0-9]{12} - supportCharge
-
The Support charge amount for the account.
Type: String
- supportChargePercentage
-
The percentage applied to the total Support-eligible spend to calculate the total Support charge across all accounts in the Support profile.
Type: String
- supportDiscount
-
The support discount amount.
Type: String
- supportEffectivePricingPlan
-
The effective pricing plan used for the support charge calculation.
Type: PricingPlan object
- totalSupportCharge
-
The total Support charge amount for all accounts in the Support profile.
Type: String
- totalSupportEligibleReservedInstanceSpend
-
The total Support-eligible Reserved Instance spend from all accounts in the Support profile.
Type: String
- totalSupportEligibleSavingsPlanSpend
-
The total Support-eligible Savings Plan spend from all accounts in the Support profile.
Type: String
- 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.
Type: String
- totalSupportEligibleUsageSpend
-
The total Support-eligible spend from usage of Amazon Web Services from all accounts in the Support profile.
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
