DescribeCases
Returns a list of cases that you specify by passing one or more case IDs. In
addition, you can filter the cases by date by setting values for the
afterTime
and beforeTime
request parameters. You can set
values for the includeResolvedCases
and includeCommunications
request parameters to control how much information is returned.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.
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 theCaseDetails
objects.
Request Syntax
{ "afterTime": "
string
", "beforeTime": "string
", "caseIdList": [ "string
" ], "displayId": "string
", "includeCommunications":boolean
, "includeResolvedCases":boolean
, "language": "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.
- afterTime
-
The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
Type: String
- beforeTime
-
The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
Type: String
- caseIdList
-
A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 100 items.
- displayId
-
The ID displayed for a case in the AWS Support Center user interface.
Type: String
- includeCommunications
-
Specifies whether communications should be included in the DescribeCases results. The default is true.
Type: Boolean
- includeResolvedCases
-
Specifies whether resolved support cases should be included in the DescribeCases results. The default is false.
Type: Boolean
- language
-
The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
Type: String
- maxResults
-
The maximum number of results to return before paginating.
Type: Integer
Valid Range: Minimum value of 10. Maximum value of 100.
- nextToken
-
A resumption point for pagination.
Type: String
Response Syntax
{ "cases": [ { "caseId": "string", "categoryCode": "string", "ccEmailAddresses": [ "string" ], "displayId": "string", "language": "string", "recentCommunications": { "communications": [ { "attachmentSet": [ { "attachmentId": "string", "fileName": "string" } ], "body": "string", "caseId": "string", "submittedBy": "string", "timeCreated": "string" } ], "nextToken": "string" }, "serviceCode": "string", "severityCode": "string", "status": "string", "subject": "string", "submittedBy": "string", "timeCreated": "string" } ], "nextToken": "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.
- cases
-
The details for the cases that match the request.
Type: Array of CaseDetails objects
- nextToken
-
A resumption point for pagination.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- CaseIdNotFound
-
The requested
caseId
could not be located.HTTP Status Code: 400
- InternalServerError
-
An internal server error occurred.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: