DescribeCommunications - AWS Support

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 12 months after creation. If a case was created more than 12 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 a Business or Enterprise support plan to use the AWS Support API.

  • If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support.

Request Syntax

{ "afterTime": "string", "beforeTime": "string", "caseId": "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

caseId

The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

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

{ "communications": [ { "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 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: