Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeCases

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 24 months after creation. If a case was created more than 24 months ago, a request might return an error.

Note

You must have an AWS Business Support+, AWS Enterprise Support, or AWS Unified Operations plan to use the AWS Support API. If you're in an AWS Region that doesn't offer one of these AWS Support plans, or if you haven't transitioned to one of these plans, you can use the AWS Support API with a Business, Enterprise On-Ramp, or Enterprise Support plan.
If you call the AWS Support API from an account that doesn't have an AWS Business Support+, AWS Enterprise Support, or AWS Unified Operations plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support.

Important

Each Communication returned by this operation includes attachment information in two fields:

attachmentSet: returns only attachments that are 5 MB or smaller. Attachments larger than 5 MB are not included in this field.
attachments: returns all attachments regardless of size.

AWS recommends that you use the attachments field and download each attachment with GetAttachmentDownloadLink, which supports attachments of any size. The attachmentSet field and DescribeAttachment return only attachments that are 5 MB or smaller.

Request Syntax


{
   "afterTime": "string",
   "beforeTime": "string",
   "caseIdList": [ "string" ],
   "displayId": "string",
   "dryRun": boolean,
   "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 24 months after creation.

Type: String

beforeTime

The end date for a filtered date search on support case communications. Case communications are available for 24 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

dryRun

Specifies whether to validate the request without actually returning case data. When set to true, the request is validated but no cases are returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

Type: Boolean

includeCommunications

Specifies whether to include communications in the DescribeCases response. By default, communications are included.

Type: Boolean

includeResolvedCases

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

Type: Boolean

language

The language in which AWS Support handles the case. AWS Support currently supports Chinese (“zh”), English ("en"), Japanese ("ja") , Chinese ("zh"), Spanish ("es"), Portuguese ("pt"), French ("fr"), Korean (“ko”), and Turkish ("tr"). You must specify the ISO 639-1 code for the language parameter if you want support in that language.

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": [ 
               { 
                  "attachments": [ 
                     { 
                        "attachmentId": "string",
                        "fileName": "string"
                     }
                  ],
                  "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 Error Types.

CaseIdNotFound

The requested caseId couldn't be located.

message: The requested CaseId could not be located.

HTTP Status Code: 400

DryRunOperationException

The request was valid, but the operation wasn't performed because dryRun was set to true.

HTTP Status Code: 400

InternalServerError

An internal server error occurred.

message: An internal server error occurred.

HTTP Status Code: 500