support_describe_cases: Returns a list of cases that you specify by passing one or more case IDs

Description

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.

Usage

support_describe_cases(caseIdList, displayId, afterTime, beforeTime,
  includeResolvedCases, nextToken, maxResults, language,
  includeCommunications)

Arguments

caseIdList

A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.

displayId

The ID displayed for a case in the AWS Support Center user interface.

afterTime

The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

beforeTime

The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

includeResolvedCases

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

nextToken

A resumption point for pagination.

maxResults

The maximum number of results to return before paginating.

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.

includeCommunications

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

Request syntax

svc$describe_cases(
  caseIdList = list(
    "string"
  ),
  displayId = "string",
  afterTime = "string",
  beforeTime = "string",
  includeResolvedCases = TRUE|FALSE,
  nextToken = "string",
  maxResults = 123,
  language = "string",
  includeCommunications = TRUE|FALSE
)

Details

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

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.