Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeCommunications

Returns communications and attachments for one or more support cases. Use the afterTime and beforeTime parameters to filter by date. You can use the caseId parameter to restrict the results to a specific case.

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

You can use the maxResults and nextToken parameters to control the pagination of the results. Set maxResults to the number of cases that you want to display on each page, and use nextToken to specify the resumption of pagination.

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",
   "caseId": "string",
   "dryRun": boolean,
   "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

caseId

The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-exen-2025-c4c1d2bf33c5cf47

Type: String

dryRun

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

Type: Boolean

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


{
   "communications": [ 
      { 
         "attachments": [ 
            { 
               "attachmentId": "string",
               "fileName": "string"
            }
         ],
         "attachmentSet": [ 
            { 
               "attachmentId": "string",
               "fileName": "string"
            }
         ],
         "body": "string",
         "caseId": "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.

communications

The communications for the case.

Type: Array of Communication 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