describe-cases¶

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.

Note

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 .

Synopsis¶

  describe-cases
[--case-id-list <value>]
[--display-id <value>]
[--after-time <value>]
[--before-time <value>]
[--include-resolved-cases | --no-include-resolved-cases]
[--language <value>]
[--include-communications | --no-include-communications]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options¶

--case-id-list (list)

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

(string)

Syntax:

"string" "string" ...

--display-id (string)

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

--after-time (string)

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

--before-time (string)

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

--include-resolved-cases | --no-include-resolved-cases (boolean)

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

--language (string)

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.

--include-communications | --no-include-communications (boolean)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To describe a case

The following describe-cases example returns information about the specified support case in your AWS account.

aws support describe-cases \
    --display-id "1234567890" \
    --after-time "2020-03-23T21:31:47.774Z" \
    --include-resolved-cases \
    --language "en" \
    --no-include-communications \
    --max-item 1

Output:

{
    "cases": [
        {
            "status": "resolved",
            "ccEmailAddresses": [],
            "timeCreated": "2020-03-23T21:31:47.774Z",
            "caseId": "case-12345678910-2013-c4c1d2bf33c5cf47",
            "severityCode": "low",
            "language": "en",
            "categoryCode": "using-aws",
            "serviceCode": "general-info",
            "submittedBy": "myemail@example.com",
            "displayId": "1234567890",
            "subject": "Question about my account"
        }
    ]
}

For more information, see Case management in the AWS Support User Guide.

Output¶

cases -> (list)

The details for the cases that match the request.

(structure)

A JSON-formatted object that contains the metadata for a support case. It is contained in the response from a DescribeCases request. CaseDetails contains the following fields:

caseId - The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47 .

categoryCode - The category of problem for the support case. Corresponds to the CategoryCode values returned by a call to DescribeServices .

displayId - The identifier for the case on pages in the AWS Support Center.

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.

nextToken - A resumption point for pagination.

recentCommunications - One or more Communication objects. Fields of these objects are attachments , body , caseId , submittedBy , and timeCreated .

serviceCode - The identifier for the AWS service that corresponds to the service code defined in the call to DescribeServices .

severityCode - The severity code assigned to the case. Contains one of the values returned by the call to DescribeSeverityLevels . The possible values are: low , normal , high , urgent , and critical .

status - The status of the case in the AWS Support Center. Valid values:

opened

pending-customer-action

reopened

resolved

unassigned

work-in-progress

subject - The subject line of the case.

submittedBy - The email address of the account that submitted the case.

timeCreated - The time the case was created, in ISO-8601 format.

caseId -> (string)

The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

displayId -> (string)

The ID displayed for the case in the AWS Support Center. This is a numeric string.

subject -> (string)

The subject line for the case in the AWS Support Center.

status -> (string)

The status of the case.

Valid values:

opened

pending-customer-action

reopened

resolved

unassigned

work-in-progress

serviceCode -> (string)

The code for the AWS service. You can get a list of codes and the corresponding service names by calling DescribeServices .

categoryCode -> (string)

The category of problem for the support case.

severityCode -> (string)

The code for the severity level returned by the call to DescribeSeverityLevels .

submittedBy -> (string)

The email address of the account that submitted the case.

timeCreated -> (string)

The time that the case was created in the AWS Support Center.

recentCommunications -> (structure)

The five most recent communications between you and AWS Support Center, including the IDs of any attachments to the communications. Also includes a nextToken that you can use to retrieve earlier communications.

communications -> (list)

The five most recent communications associated with the case.

(structure)

A communication associated with a support case. The communication consists of the case ID, the message body, attachment information, the submitter of the communication, and the date and time of the communication.

caseId -> (string)

The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

body -> (string)

The text of the communication between the customer and AWS Support.

submittedBy -> (string)

The identity of the account that submitted, or responded to, the support case. Customer entries include the role or IAM user as well as the email address. For example, “AdminRole (Role) <janedoe@example.com>. Entries from the AWS Support team display “Amazon Web Services,” and don’t show an email address.

timeCreated -> (string)

The time the communication was created.

attachmentSet -> (list)

Information about the attachments to the case communication.

(structure)

The file name and ID of an attachment to a case communication. You can use the ID to retrieve the attachment with the DescribeAttachment operation.

attachmentId -> (string)

The ID of the attachment.

fileName -> (string)

The file name of the attachment.

nextToken -> (string)

A resumption point for pagination.

ccEmailAddresses -> (list)

The email addresses that receive copies of communication about the case.

(string)

language -> (string)

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.

nextToken -> (string)

A resumption point for pagination.

Table of Contents

Feedback

User Guide