Creates a case in the Amazon Web Services Support Center¶
Description¶
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.
Amazon Web Services Support automatically redacts sensitive information from support cases to protect your data. The following information is replaced with [REDACTED_BY_Amazon Web Services] and is not stored:
- Amazon Web Services secret keys - The complete key is replaced. Example:
[REDACTED_BY_Amazon Web Services] - Private keys - The complete key is replaced. Example:
[REDACTED_BY_Amazon Web Services] - Credit card numbers - The number is redacted, but the last 4 digits remain. Example:
[REDACTED_BY_Amazon Web Services]-7016
This sensitive information is never required by Amazon Web Services Support.
A successful create_case request returns a Amazon Web Services Support case number. You can use the describe_cases operation and specify the case number to get existing Amazon Web Services Support cases. After you create a case, use the add_communication_to_case 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 describe_cases operation to get the displayId.
- You must have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan to use the Amazon Web Services Support API. If you're in an Amazon Web Services 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 Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
Usage¶
support_create_case(subject, serviceCode, severityCode, categoryCode,
communicationBody, ccEmailAddresses, language, issueType,
attachmentSetId, uploadIds, dryRun)
Arguments¶
-
subject[required] The title of the support case. The title appears in the Subject field on the Amazon Web Services Support Center Create Case page.
-
serviceCodeThe code for the Amazon Web Services service. You can use the
describe_servicesoperation to get the possibleserviceCodevalues. -
severityCodeA 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
describe_severity_levelsoperation to get the possible values forseverityCode.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.
-
categoryCodeThe category of problem for the support case. You also use the
describe_servicesoperation to get the category code for a service. Each Amazon Web Services service defines its own set of category codes. -
communicationBody[required] 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.
-
ccEmailAddressesA 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.
-
languageThe 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
languageparameter if you want support in that language. -
issueTypeThe type of issue for the case. You can specify
customer-serviceortechnical. If you don't specify a value, the default istechnical. -
attachmentSetIdThe ID of a set of one or more attachments for the case. Create the set by using the
add_attachments_to_setoperation. Each attachment in the set must be 5 MB or smaller. To attach files larger than 5 MB, useuploadIds. -
uploadIdsA list of upload IDs that identify attachments to add to the case. Each
uploadIdis returned by theget_attachment_upload_linksoperation. The upload must reach theattachment-readystate by callingcomplete_attachment_uploadbefore it can be passed here. UseuploadIdsto attach files of any supported size, including files larger than 5 MB. -
dryRunSpecifies 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 aDryRunOperationException. When omitted or set tofalse, the request runs normally.
Value¶
A list with the following syntax:
Request syntax¶
svc$create_case(
subject = "string",
serviceCode = "string",
severityCode = "string",
categoryCode = "string",
communicationBody = "string",
ccEmailAddresses = list(
"string"
),
language = "string",
issueType = "string",
attachmentSetId = "string",
uploadIds = list(
"string"
),
dryRun = TRUE|FALSE
)