create_case
¶
create_case(
subject: Subject,
communication_body: CommunicationBody,
*,
config_overrides: Optional[SupportClientConfig] = None,
service_code: Optional[ServiceCode2] = None,
severity_code: Optional[SeverityCode] = None,
category_code: Optional[CategoryCode] = None,
cc_email_addresses: Optional[CcEmailAddressList] = None,
language: Optional[Language] = None,
issue_type: Optional[IssueType] = None,
attachment_set_id: Optional[AttachmentSetId] = None,
upload_ids: Optional[UploadIds] = None,
dry_run: Optional[NullableBooleanType] = None,
) -> CreateCaseResponse
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 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 Web Services Support Center. Use the DescribeCases 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.
Parameters:
-
subject(Subject) –The title of the support case. The title appears in the Subject field on the Amazon Web Services Support Center Create Case page.
-
service_code(Optional[ServiceCode2], default:None) –The code for the Amazon Web Services service. You can use the DescribeServices operation to get the possible
serviceCodevalues. -
severity_code(Optional[SeverityCode], default:None) –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.
-
category_code(Optional[CategoryCode], default:None) –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.
-
communication_body(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.
-
cc_email_addresses(Optional[CcEmailAddressList], default:None) –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.
-
language(Optional[Language], default:None) –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
languageparameter if you want support in that language. -
issue_type(Optional[IssueType], default:None) –The type of issue for the case. You can specify
customer-serviceortechnical. If you don't specify a value, the default istechnical. -
attachment_set_id(Optional[AttachmentSetId], default:None) –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. -
upload_ids(Optional[UploadIds], default:None) –A list of upload IDs that identify attachments to add to the case. Each
uploadIdis returned by the GetAttachmentUploadLinks operation. The upload must reach theattachment-readystate by calling CompleteAttachmentUpload before it can be passed here. UseuploadIdsto attach files of any supported size, including files larger than 5 MB. -
dry_run(Optional[NullableBooleanType], default:None) –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 aDryRunOperationException. When omitted or set tofalse, the request runs normally.
Raises:
-
AttachmentSetExpired–The expiration time of the attachment set has passed. The set expires 1 hour after it is created.
-
AttachmentSetIdNotFound–An attachment set with the specified ID could not be found.
-
CaseCreationLimitExceeded–The case creation limit for the account has been exceeded.
-
DryRunOperationException–The request was valid, but the operation wasn't performed because
dryRunwas set totrue. -
InternalServerError–An internal server error occurred.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_support/_services/support.py
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 | |