Skip to content
AWS for Query.Farm

aws.support.describe_cases

Example SQL Queries

SELECT * FROM
aws.support.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.

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

Table Definition

Column NameColumn Data Type
after_time Input Column

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

VARCHAR
before_time Input Column

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

VARCHAR
case_id_list Input Column

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

VARCHAR[]
Show child fields
case_id_list[]
display_id Input Column

The ID displayed for the case in the Amazon Web Services Support Center. This is a numeric string.

VARCHAR
include_communications Input Column

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

BOOLEAN
include_resolved_cases Input Column

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

BOOLEAN
language Input Column

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.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

case_id

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 

VARCHAR
category_code

The category of problem for the support case.

VARCHAR
cc_email_addresses

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

VARCHAR[]
Show child fields
cc_email_addresses[]
recent_communications

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

STRUCT(
    "communications" STRUCT(
        "case_id" VARCHAR,
        "body" VARCHAR,
        "submitted_by" VARCHAR,
        "time_created" VARCHAR,
        "attachment_set" STRUCT(
            "attachment_id" VARCHAR,
            "file_name" VARCHAR
        )[]
    )[],
    "next_token" VARCHAR
)
Show child fields
recent_communications.communications[]
Show child fields
recent_communications.communications[].attachment_set[]
Show child fields
recent_communications.communications[].attachment_set[].attachment_id

The ID of the attachment.

recent_communications.communications[].attachment_set[].file_name

The file name of the attachment.

recent_communications.communications[].body

The text of the communication between the customer and Amazon Web Services Support.

recent_communications.communications[].case_id

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

recent_communications.communications[].submitted_by

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

recent_communications.communications[].time_created

The time the communication was created.

recent_communications.next_token

A resumption point for pagination.

service_code

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

VARCHAR
severity_code

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

VARCHAR
status

The status of the case.

Valid values:

  • all-open

  • customer-action-completed

  • opened

  • pending-customer-action

  • reopened

  • resolved

  • unassigned

  • work-in-progress 

VARCHAR
subject

The subject line for the case in the Amazon Web Services Support Center.

VARCHAR
submitted_by

The email address of the account that submitted the case.

VARCHAR
time_created

The time that the case was created in the Amazon Web Services Support Center.

VARCHAR