GetEnterpriseSupportContractDetails
Returns Enterprise Support contract details.
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
{
"additionalSupportCharge": [
{
"amount": "string",
"chargeType": "string",
"description": "string"
}
],
"additionalSupportEligibleUsageSpend": [
{
"amount": "string",
"chargeType": "string",
"description": "string"
}
],
"chargedPayerAccountIds": [
{
"accountId": "string",
"chargePercentage": "string"
}
],
"contractPayerAccountIds": [
{
"accountId": "string",
"isGdn": boolean
}
],
"isContractActive": boolean,
"pricingPlans": [
{
"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"
}
]
}
],
"supportAllocationMethod": "string",
"supportProrateStartDate": number,
"supportReservedInstanceAmortizationStartDate": number,
"supportReservedInstanceTreatmentMethod": "string",
"supportSavingsPlansAmortizationStartDate": number,
"supportSavingsPlansTreatmentMethod": "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.
- additionalSupportCharge
-
Any Additional support charges applied to the contract.
Type: Array of AdditionalCharge objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
- additionalSupportEligibleUsageSpend
-
Any Additional support-eligible usage spend charges.
Type: Array of AdditionalCharge objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
- chargedPayerAccountIds
-
The list of payer accounts and their charge allocation percentages.
Type: Array of ChargeAccount objects
Array Members: Minimum number of 0 items. Maximum number of 1000 items.
- contractPayerAccountIds
-
The list of accounts covered by the Enterprise Support contract.
Type: Array of ContractAccount objects
Array Members: Minimum number of 0 items. Maximum number of 2000 items.
- isContractActive
-
When true, the Enterprise Support contract is active. When false, the Enterprise Support Contract is inactive.
Type: Boolean
- pricingPlans
-
The pricing plans associated with this Enterprise Support contract.
Type: Array of PricingPlan objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
- 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.
Type: String
- supportProrateStartDate
-
The start date for accounts subscribed or unsubscribed to Support billing during the billing month.
Type: Timestamp
- 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.
Type: Timestamp
- 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).
Type: String
- 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.
Type: Timestamp
- 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).
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:
