cases

Creates, updates, deletes, gets or lists a cases resource.

Overview

Name	`cases`
Type	Resource
Id	`aws.support.cases`

Fields

The following fields are returned by SELECT queries:

describe_cases

Name	Datatype	Description
`case_id`	`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
`category_code`	`string`	The category of problem for the support case.
`cc_email_addresses`	`array`	The email addresses that receive copies of communication about the case.
`display_id`	`string`	The ID displayed for the case in the Amazon Web Services Support Center. This is a numeric string.
`language`	`string`	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.
`recent_communications`	`object`	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.
`service_code`	`string`	The code for the Amazon Web Services service. You can get a list of codes and the corresponding service names by calling DescribeServices.
`severity_code`	`string`	The code for the severity level returned by the call to DescribeSeverityLevels.
`status`	`string`	The status of the case. Valid values: all-open customer-action-completed opened pending-customer-action reopened resolved unassigned work-in-progress
`subject`	`string`	The subject line for the case in the Amazon Web Services Support Center.
`submitted_by`	`string`	The email address of the account that submitted the case.
`time_created`	`string`	The time that the case was created in the Amazon Web Services Support Center.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Description
`describe_cases`	`select`	`region`	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.
`create_case`	`insert`	`region`, `subject`, `communicationBody`	Creates a case in the Amazon Web Services Support Center. This operation is similar to how you create a case in the Amazon Web Services Support Center Create Case page. The Amazon Web Services Support API doesn't support requesting service limit increases. You can submit a service limit increase in the following ways: Submit a request from the Amazon Web Services Support Center Create Case page. Use the Service Quotas RequestServiceQuotaIncrease operation. A successful CreateCase request returns an Amazon Web Services Support case number. You can use the DescribeCases operation and specify the case number to get existing Amazon Web Services Support cases. After you create a case, use the AddCommunicationToCase operation to add additional communication or attachments to an existing case. The caseId is separate from the displayId that appears in the Amazon Web Services Support Center. Use the DescribeCases operation to get the displayId. 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.
`add_communication_to_case`	`update`	`region`, `communicationBody`	Adds additional customer communication to an Amazon Web Services Support case. Use the caseId parameter to identify the case to which to add communication. You can list a set of email addresses to copy on the communication by using the ccEmailAddresses parameter. The communicationBody value contains the text of the communication. 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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`region`	`string`	AWS region (default: us-east-1)

`SELECT` examples

describe_cases

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.

SELECT
case_id,
category_code,
cc_email_addresses,
display_id,
language,
recent_communications,
service_code,
severity_code,
status,
subject,
submitted_by,
time_created
FROM aws.support.cases
WHERE region = '{{ region }}' -- required
;

`INSERT` examples

create_case
Manifest

Creates a case in the Amazon Web Services Support Center. This operation is similar to how you create a case in the Amazon Web Services Support Center Create Case page. The Amazon Web Services Support API doesn't support requesting service limit increases. You can submit a service limit increase in the following ways: Submit a request from the Amazon Web Services Support Center Create Case page. Use the Service Quotas RequestServiceQuotaIncrease operation. A successful CreateCase request returns an Amazon Web Services Support case number. You can use the DescribeCases operation and specify the case number to get existing Amazon Web Services Support cases. After you create a case, use the AddCommunicationToCase operation to add additional communication or attachments to an existing case. The caseId is separate from the displayId that appears in the Amazon Web Services Support Center. Use the DescribeCases operation to get the displayId. 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.

INSERT INTO aws.support.cases (
subject,
serviceCode,
severityCode,
categoryCode,
communicationBody,
ccEmailAddresses,
language,
issueType,
attachmentSetId,
region
)
SELECT 
'{{ subject }}' /* required */,
'{{ serviceCode }}',
'{{ severityCode }}',
'{{ categoryCode }}',
'{{ communicationBody }}' /* required */,
'{{ ccEmailAddresses }}',
'{{ language }}',
'{{ issueType }}',
'{{ attachmentSetId }}',
'{{ region }}'
RETURNING
case_id
;

# Description fields are for documentation purposes
- name: cases
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the cases resource.
  - name: subject
    value: "{{ subject }}"
    description: |
      The title of the support case. The title appears in the Subject field on the Amazon Web Services Support Center Create Case page.
  - name: serviceCode
    value: "{{ serviceCode }}"
    description: |
      The code for the Amazon Web Services service. You can use the DescribeServices operation to get the possible serviceCode values.
  - name: severityCode
    value: "{{ severityCode }}"
    description: |
      A value that indicates the urgency of the case. This value determines the response time according to your service level agreement with Amazon Web Services Support. You can use the DescribeSeverityLevels operation to get the possible values for severityCode. For more information, see SeverityLevel and Choosing a Severity in the Amazon Web Services Support User Guide. The availability of severity levels depends on the support plan for the Amazon Web Services account.
  - name: categoryCode
    value: "{{ categoryCode }}"
    description: |
      The category of problem for the support case. You also use the DescribeServices operation to get the category code for a service. Each Amazon Web Services service defines its own set of category codes.
  - name: communicationBody
    value: "{{ communicationBody }}"
    description: |
      The communication body text that describes the issue. This text appears in the Description field on the Amazon Web Services Support Center Create Case page.
  - name: ccEmailAddresses
    value:
      - "{{ ccEmailAddresses }}"
    description: |
      A list of email addresses that Amazon Web Services Support copies on case correspondence. Amazon Web Services Support identifies the account that creates the case when you specify your Amazon Web Services credentials in an HTTP POST method or use the Amazon Web Services SDKs.
  - name: language
    value: "{{ language }}"
    description: |
      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.
  - name: issueType
    value: "{{ issueType }}"
    description: |
      The type of issue for the case. You can specify customer-service or technical. If you don't specify a value, the default is technical.
  - name: attachmentSetId
    value: "{{ attachmentSetId }}"
    description: |
      The ID of a set of one or more attachments for the case. Create the set by using the AddAttachmentsToSet operation.

`UPDATE` examples

add_communication_to_case

Adds additional customer communication to an Amazon Web Services Support case. Use the caseId parameter to identify the case to which to add communication. You can list a set of email addresses to copy on the communication by using the ccEmailAddresses parameter. The communicationBody value contains the text of the communication. 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.

UPDATE aws.support.cases
SET 
caseId = '{{ caseId }}',
communicationBody = '{{ communicationBody }}',
ccEmailAddresses = '{{ ccEmailAddresses }}',
attachmentSetId = '{{ attachmentSetId }}'
WHERE 
region = '{{ region }}' --required
AND communicationBody = '{{ communicationBody }}' --required
RETURNING
result;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​