Class DescribeCommunicationsCommandProtected

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.

• 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.

Example

Use a bare-bones client and the command you need to make an API call.

import { SupportClient, DescribeCommunicationsCommand } from "@aws-sdk/client-support"; // ES Modules import
// const { SupportClient, DescribeCommunicationsCommand } = require("@aws-sdk/client-support"); // CommonJS import
const client = new SupportClient(config);
const input = {
  caseId: "STRING_VALUE", // required
  beforeTime: "STRING_VALUE",
  afterTime: "STRING_VALUE",
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
};
const command = new DescribeCommunicationsCommand(input);
const response = await client.send(command);

Param

DescribeCommunicationsCommandInput

Returns

DescribeCommunicationsCommandOutput

See

• DescribeCommunicationsCommandInput for command's input shape.
• DescribeCommunicationsCommandOutput for command's response shape.
• config for SupportClient's config shape.

Throws

CaseIdNotFound (client fault)

The requested caseId couldn't be located.

Throws

InternalServerError (server fault)

An internal server error occurred.