Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListBusinessSupportSubscriptionHistory

Returns the history of Business Support subscription contracts across accounts.

Request Syntax


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

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 account ID to filter results to a specific account. If you don't specify a value, the response includes subscription history for all accounts.

Type: String

Pattern: [0-9]{12}

Required: No

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.

Type: String

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

Required: No

endDate

The end date to filter subscription contracts to.

Type: Timestamp

Required: No

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

startDate

The start date to filter subscription contracts from.

Type: Timestamp

Required: No

Response Syntax


{
   "nextToken": "string",
   "subscriptionContracts": [ 
      { 
         "accountId": "string",
         "contractEndDate": number,
         "contractStartDate": number,
         "planName": "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.

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+=/_]+

subscriptionContracts

The list of Business Support subscription contracts.

Type: Array of BusinessSupportSubscriptionContract objects

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

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