support_describe_cases: Returns a list of cases that you specify by passing one or...

Description Usage Arguments Value Request syntax

View source: R/support_operations.R

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:

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.

Usage

1
2
3
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 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 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 describe_cases response. By default, communications are incuded.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
svc$describe_cases(
  caseIdList = list(
    "string"
  ),
  displayId = "string",
  afterTime = "string",
  beforeTime = "string",
  includeResolvedCases = TRUE|FALSE,
  nextToken = "string",
  maxResults = 123,
  language = "string",
  includeCommunications = TRUE|FALSE
)

paws.management documentation built on March 8, 2021, 1:07 a.m.