Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141410280.7 KB

Returns a list of cases that you specify by passing one or more case IDs. You can use the afterTime and beforeTime parameters to filter the cases by date. You can set values for the includeResolvedCases and includeCommunications parameters to specify how much information to return.

The response returns the following in JSON format:

  • One or more CaseDetails data types.

  • One or more nextToken values, which specify where to paginate the returned records represented by the CaseDetails objects.

Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request might return an error.

  • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

  • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

post/#X-Amz-Target=AWSSupport_20130415.DescribeCases

Query parameters

maxResultsstring

Pagination limit

nextTokenstring

Pagination token

Headers

X-Amz-Target'AWSSupport_20130415.DescribeCases' required

Request body

caseIdListCaseId[]

A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.

displayIdstring

The ID displayed for a case in the Amazon Web Services Support Center user interface.

afterTimestring

The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

beforeTimestring

The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

includeResolvedCasesboolean

Specifies whether to include resolved support cases in the <code>DescribeCases</code> response. By default, resolved cases aren't included.

nextTokenstring

A resumption point for pagination.

maxResultsinteger

The maximum number of results to return before paginating.

languagestring

The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports English ("en") and Japanese ("ja"). You must specify the ISO 639-1 code for the <code>language</code> parameter if you want support in that language.

includeCommunicationsboolean

Specifies whether to include communications in the <code>DescribeCases</code> response. By default, communications are included.

Response

Success

nextTokenstring

A resumption point for pagination.