Skip to content

Describe Cases

support_describe_cases R Documentation

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.

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

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 Amazon Web Services 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 describe_cases 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 language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1 code for the language parameter if you want support in that language.
includeCommunications

Specifies whether to include communications in the describe_cases response. By default, communications are included.

Value

A list with the following syntax:

list(
  cases = list(
    list(
      caseId = "string",
      displayId = "string",
      subject = "string",
      status = "string",
      serviceCode = "string",
      categoryCode = "string",
      severityCode = "string",
      submittedBy = "string",
      timeCreated = "string",
      recentCommunications = list(
        communications = list(
          list(
            caseId = "string",
            body = "string",
            submittedBy = "string",
            timeCreated = "string",
            attachmentSet = list(
              list(
                attachmentId = "string",
                fileName = "string"
              )
            )
          )
        ),
        nextToken = "string"
      ),
      ccEmailAddresses = list(
        "string"
      ),
      language = "string"
    )
  ),
  nextToken = "string"
)

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
)