Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateCase

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.

Important

Amazon Web Services Support automatically redacts sensitive information from support cases to protect your data. The following information is replaced with [REDACTED_BY_Amazon] and is not stored:

Amazon secret keys - The complete key is replaced. Example: [REDACTED_BY_Amazon]
Private keys - The complete key is replaced. Example: [REDACTED_BY_Amazon]
Credit card numbers - The number is redacted, but the last 4 digits remain. Example: [REDACTED_BY_Amazon]-7016

This sensitive information is never required by Amazon Web Services Support.

A successful CreateCase request returns a 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 Support Center. Use the DescribeCases operation to get the displayId.

Note

You must have an Amazon Business Support+, Amazon Enterprise Support, or Amazon Unified Operations plan to use the Amazon Web Services Support API. If you're in an Amazon Region that doesn't offer one of these Amazon Web Services Support plans, or if you haven't transitioned to one of these plans, you can use the Amazon Web Services Support API with a Business, Enterprise On-Ramp, or Enterprise Support plan.
If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Business Support+, Amazon Enterprise Support, or Amazon Unified Operations plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

Request Syntax


{
   "attachmentSetId": "string",
   "categoryCode": "string",
   "ccEmailAddresses": [ "string" ],
   "communicationBody": "string",
   "dryRun": boolean,
   "issueType": "string",
   "language": "string",
   "serviceCode": "string",
   "severityCode": "string",
   "subject": "string",
   "uploadIds": [ "string" ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

attachmentSetId

The ID of a set of one or more attachments for the case. Create the set by using the AddAttachmentsToSet operation. Each attachment in the set must be 5 MB or smaller. To attach files larger than 5 MB, use uploadIds.

Type: String

categoryCode

The category of problem for the support case. You also use the DescribeServices operation to get the category code for a service. Each Amazon service defines its own set of category codes.

Type: String

ccEmailAddresses

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 credentials in an HTTP POST method or use the Amazon SDKs.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 10 items.

communicationBody

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 8000.

dryRun

Specifies whether to validate the request without actually creating the case. When set to true, the request is validated but no case is created, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

Type: Boolean

issueType

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.

Type: String

language

The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports Chinese (“zh”), English ("en"), Japanese ("ja") , Chinese ("zh"), Spanish ("es"), Portuguese ("pt"), French ("fr"), Korean (“ko”), and Turkish ("tr"). You must specify the ISO 639-1 code for the language parameter if you want support in that language.

Type: String

serviceCode

The code for the Amazon service. You can use the DescribeServices operation to get the possible serviceCode values.

Type: String

severityCode

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.

Note

The availability of severity levels depends on the support plan for the Amazon Web Services account.

Type: String

subject

The title of the support case. The title appears in the Subject field on the Amazon Web Services Support Center Create Case page.

Type: String

uploadIds

A list of upload IDs that identify attachments to add to the case. Each uploadId is returned by the GetAttachmentUploadLinks operation. The upload must reach the attachment-ready state by calling CompleteAttachmentUpload before it can be passed here. Use uploadIds to attach files of any supported size, including files larger than 5 MB.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Length Constraints: Minimum length of 1. Maximum length of 2048.

Response Syntax


{
   "caseId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

caseId

The support case ID requested or returned in the call. The case ID is an alphanumeric string in the following format: case-12345678910-exen-2025-c4c1d2bf33c5cf47

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

AttachmentSetExpired

The expiration time of the attachment set has passed. The set expires 1 hour after it is created.

message: The expiration time of the attachment set has passed. The set expires one hour after it is created.

HTTP Status Code: 400

AttachmentSetIdNotFound

An attachment set with the specified ID could not be found.

message: An attachment set with the specified ID could not be found.

HTTP Status Code: 400

CaseCreationLimitExceeded

The case creation limit for the account has been exceeded.

message: An error message that indicates that you have exceeded the number of cases you can have open.

HTTP Status Code: 400

DryRunOperationException

The request was valid, but the operation wasn't performed because dryRun was set to true.

HTTP Status Code: 400

InternalServerError

An internal server error occurred.

message: An internal server error occurred.

HTTP Status Code: 500