paws.management (version 0.1.0)

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. In addition, you can filter the cases by date by setting values for the afterTime and beforeTime request parameters. You can set values for the includeResolvedCases and includeCommunications request parameters to control how much information is returned.

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 resolved support cases should be included in the DescribeCases results. The default is false.

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 communications should be included in the DescribeCases results. The default is true.

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

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.

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.