AWS Support

2026/08/31 - AWS Support - 4 new 11 updated api methods

Changes  AWS Support now allows up to 10 attachments (150 MB each) per case correspondence, up from 3 at 5 MB. Customers can share large diagnostic logs, heap dumps, and packet captures directly in cases to reduce back-and-forth and speed up resolution. Available in US East, US West, and Europe (Ireland).

CompleteAttachmentUpload (new) Link ¶

Completes an attachment upload that was started with GetAttachmentUploadLinks. After you upload a part of the file to its presigned Amazon S3 URL, call CompleteAttachmentUpload with the partIndex and eTag of that part. You can include one part per call, or multiple parts in a single call. After CompleteAttachmentUpload has been called for every part of the file, the service processes the upload asynchronously. The attachment-ready status might not be reflected immediately. Use DescribeAttachmentUploadStatus to poll for the uploadStatus to become attachment-ready before passing the uploadId to CreateCase or AddCommunicationToCase.

See also: AWS API Documentation

Request Syntax

client.complete_attachment_upload(
    uploadId='string',
    completedUploads=[
        {
            'partIndex': 123,
            'eTag': 'string'
        },
    ],
    dryRun=True|False
)
type uploadId:

string

param uploadId:

[REQUIRED]

The identifier associated with the upload to complete.

type completedUploads:

list

param completedUploads:

[REQUIRED]

The list of parts being reported as completed in this call. Each entry must contain the partIndex of an uploaded part and the ETag returned by Amazon S3 when that part was uploaded.

  • (dict) --

    Identifies a single uploaded part of a multipart attachment upload. Pass a list of CompletedUpload objects to CompleteAttachmentUpload to finalize the upload.

    • partIndex (integer) -- [REQUIRED]

      The index of the uploaded part. This is the same partIndex value returned for the corresponding entry in the uploadUrls field of the GetAttachmentUploadLinks response.

    • eTag (string) -- [REQUIRED]

      The ETag returned in the response headers when the part was uploaded to Amazon S3. The ETag value identifies the part contents.

type dryRun:

boolean

param dryRun:

Specifies whether to validate the request without actually completing the upload. When set to true, the request is validated but the upload isn't finalized, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

rtype:

dict

returns:

Response Syntax

{
    'uploadStatus': 'attachment-ready'|'attachment-not-ready'|'failed'
}

Response Structure

  • (dict) --

    • uploadStatus (string) --

      The status of the multipart upload after the operation finalizes the attachment. Valid values: attachment-ready, attachment-not-ready, and failed.

DescribeAttachmentUploadStatus (new) Link ¶

Returns the current status, file name, and progress of a multipart attachment upload that was started with GetAttachmentUploadLinks. Use this operation to track where an upload is in the workflow. While parts are still being uploaded and reported through CompleteAttachmentUpload, the uploadStatus is attachment-not-ready and uploadProgress reports the total number of parts and how many have been completed so far. After every part has been reported and the service finishes processing the upload asynchronously, the uploadStatus becomes attachment-ready and the uploadId can be attached to a case through CreateCase or AddCommunicationToCase.

See also: AWS API Documentation

Request Syntax

client.describe_attachment_upload_status(
    uploadId='string',
    dryRun=True|False
)
type uploadId:

string

param uploadId:

[REQUIRED]

The unique identifier for the upload. The uploadId is returned by GetAttachmentUploadLinks when you initiate the upload.

type dryRun:

boolean

param dryRun:

Specifies whether to validate the request without actually returning upload status. When set to true, the request is validated but no status is returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

rtype:

dict

returns:

Response Syntax

{
    'uploadStatus': 'attachment-ready'|'attachment-not-ready'|'failed',
    'fileName': 'string',
    'uploadProgress': {
        'totalParts': 123,
        'completedPartsCount': 123
    }
}

Response Structure

  • (dict) --

    • uploadStatus (string) --

      The current status of the multipart upload. Valid values: attachment-ready, attachment-not-ready, and failed.

    • fileName (string) --

      The name of the file being uploaded, including the file extension.

    • uploadProgress (dict) --

      The progress of the multipart upload, including the total number of parts and the number of parts that have been successfully uploaded.

      • totalParts (integer) --

        The total number of parts that the file is split into.

      • completedPartsCount (integer) --

        The number of parts that have been successfully uploaded.

AddAttachmentsToSet (updated) Link ¶
Changes (request)
{'dryRun': 'boolean'}

Adds one or more attachments to an attachment set.

An attachment set is a temporary container for attachments that you add to a case or case communication. The set is available for 1 hour after it's created. The expiryTime returned in the response is when the set expires.

See also: AWS API Documentation

Request Syntax

client.add_attachments_to_set(
    attachmentSetId='string',
    attachments=[
        {
            'fileName': 'string',
            'data': b'bytes'
        },
    ],
    dryRun=True|False
)
type attachmentSetId:

string

param attachmentSetId:

The ID of the attachment set. If an attachmentSetId is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an attachmentSetId is specified, the attachments are added to the specified set, if it exists.

type attachments:

list

param attachments:

[REQUIRED]

One or more attachments to add to the set. You can add up to three attachments per set. The size limit is 5 MB per attachment.

In the Attachment object, use the data parameter to specify the contents of the attachment file. In the previous request syntax, the value for data appear as blob, which is represented as a base64-encoded string. The value for fileName is the name of the attachment, such as troubleshoot-screenshot.png.

  • (dict) --

    An attachment to a case communication. The attachment consists of the file name and the content of the file. Each attachment file size should not exceed 5 MB. File types that are supported include the following: pdf, jpeg,.doc, .log, .text

    • fileName (string) --

      The name of the attachment file.

    • data (bytes) --

      The content of the attachment file.

type dryRun:

boolean

param dryRun:

Specifies whether to validate the request without actually adding the attachments. When set to true, the request is validated but no attachments are stored, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

rtype:

dict

returns:

Response Syntax

{
    'attachmentSetId': 'string',
    'expiryTime': 'string'
}

Response Structure

  • (dict) --

    The ID and expiry time of the attachment set returned by the AddAttachmentsToSet operation.

    • attachmentSetId (string) --

      The ID of the attachment set. If an attachmentSetId was not specified, a new attachment set is created, and the ID of the set is returned in the response. If an attachmentSetId was specified, the attachments are added to the specified set, if it exists.

    • expiryTime (string) --

      The time and date when the attachment set expires.

AddCommunicationToCase (updated) Link ¶
Changes (request)
{'dryRun': 'boolean', 'uploadIds': ['string']}

Adds additional customer communication to a Amazon Web Services Support case. Use the caseId parameter to identify the case to which to add communication. To list a set of email addresses to copy on the communication, use the ccEmailAddresses parameter. The communicationBody value contains the text of the communication.

To attach files larger than 5 MB to the communication, use the uploadIds parameter.

See also: AWS API Documentation

Request Syntax

client.add_communication_to_case(
    caseId='string',
    communicationBody='string',
    ccEmailAddresses=[
        'string',
    ],
    attachmentSetId='string',
    uploadIds=[
        'string',
    ],
    dryRun=True|False
)
type caseId:

string

param caseId:

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-exen-2025-c4c1d2bf33c5cf47

type communicationBody:

string

param communicationBody:

[REQUIRED]

The body of an email communication to add to the support case.

type ccEmailAddresses:

list

param ccEmailAddresses:

The email addresses in the CC line of an email to be added to the support case.

  • (string) --

type attachmentSetId:

string

param attachmentSetId:

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

type uploadIds:

list

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

  • (string) --

type dryRun:

boolean

param dryRun:

Specifies whether to validate the request without actually adding the communication to the case. When set to true, the request is validated but the communication isn't added, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

rtype:

dict

returns:

Response Syntax

{
    'result': True|False
}

Response Structure

  • (dict) --

    The result of the AddCommunicationToCase operation.

    • result (boolean) --

      True if AddCommunicationToCase succeeds. Otherwise, returns an error.

CreateCase (updated) Link ¶
Changes (request)
{'dryRun': 'boolean', 'uploadIds': ['string']}

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:

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.

See also: AWS API Documentation

Request Syntax

client.create_case(
    subject='string',
    serviceCode='string',
    severityCode='string',
    categoryCode='string',
    communicationBody='string',
    ccEmailAddresses=[
        'string',
    ],
    language='string',
    issueType='string',
    attachmentSetId='string',
    uploadIds=[
        'string',
    ],
    dryRun=True|False
)
type subject:

string

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

type serviceCode:

string

param serviceCode:

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

type severityCode:

string

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

type categoryCode:

string

param 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 Web Services service defines its own set of category codes.

type communicationBody:

string

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

type ccEmailAddresses:

list

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

  • (string) --

type language:

string

param 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 issueType:

string

param 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 attachmentSetId:

string

param 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 uploadIds:

list

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

  • (string) --

type dryRun:

boolean

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

rtype:

dict

returns:

Response Syntax

{
    'caseId': 'string'
}

Response Structure

  • (dict) --

    The support case ID returned by a successful completion of the CreateCase operation.

    • caseId (string) --

      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

DescribeAttachment (updated) Link ¶
Changes (request)
{'dryRun': 'boolean'}

Returns the attachment that has the specified ID. Attachments can include screenshots, error logs, or other files that describe your issue. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the AttachmentDetails objects that are returned by the DescribeCommunications operation.

See also: AWS API Documentation

Request Syntax

client.describe_attachment(
    attachmentId='string',
    dryRun=True|False
)
type attachmentId:

string

param attachmentId:

[REQUIRED]

The ID of the attachment to return. Attachment IDs are returned by the DescribeCommunications operation.

If the specified attachment is larger than 5 MB, this operation returns InvalidParameterValueException. To download attachments larger than 5 MB, use GetAttachmentDownloadLink.

type dryRun:

boolean

param dryRun:

Specifies whether to validate the request without actually retrieving the attachment. When set to true, the request is validated but no attachment content is returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

rtype:

dict

returns:

Response Syntax

{
    'attachment': {
        'fileName': 'string',
        'data': b'bytes'
    }
}

Response Structure

  • (dict) --

    The content and file name of the attachment returned by the DescribeAttachment operation.

    • attachment (dict) --

      This object includes the attachment content and file name.

      In the previous response syntax, the value for the data parameter appears as blob, which is represented as a base64-encoded string. The value for fileName is the name of the attachment, such as troubleshoot-screenshot.png.

      • fileName (string) --

        The name of the attachment file.

      • data (bytes) --

        The content of the attachment file.

DescribeCases (updated) Link ¶
Changes (request, response)
Request
{'dryRun': 'boolean'}
Response
{'cases': {'recentCommunications': {'communications': {'attachments': [{'attachmentId': 'string',
                                                                        'fileName': 'string'}]}}}}

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 24 months after creation. If a case was created more than 24 months ago, a request might return an error.

See also: AWS API Documentation

Request Syntax

client.describe_cases(
    caseIdList=[
        'string',
    ],
    displayId='string',
    afterTime='string',
    beforeTime='string',
    includeResolvedCases=True|False,
    nextToken='string',
    maxResults=123,
    language='string',
    includeCommunications=True|False,
    dryRun=True|False
)
type caseIdList:

list

param caseIdList:

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

  • (string) --

type displayId:

string

param displayId:

The ID displayed for a case in the Amazon Web Services Support Center user interface.

type afterTime:

string

param afterTime:

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

type beforeTime:

string

param beforeTime:

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

type includeResolvedCases:

boolean

param includeResolvedCases:

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

type nextToken:

string

param nextToken:

A resumption point for pagination.

type maxResults:

integer

param maxResults:

The maximum number of results to return before paginating.

type language:

string

param 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 includeCommunications:

boolean

param includeCommunications:

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

type dryRun:

boolean

param dryRun:

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

rtype:

dict

returns:

Response Syntax

{
    'cases': [
        {
            'caseId': 'string',
            'displayId': 'string',
            'subject': 'string',
            'status': 'string',
            'serviceCode': 'string',
            'categoryCode': 'string',
            'severityCode': 'string',
            'submittedBy': 'string',
            'timeCreated': 'string',
            'recentCommunications': {
                'communications': [
                    {
                        'caseId': 'string',
                        'body': 'string',
                        'submittedBy': 'string',
                        'timeCreated': 'string',
                        'attachments': [
                            {
                                'attachmentId': 'string',
                                'fileName': 'string'
                            },
                        ],
                        'attachmentSet': [
                            {
                                'attachmentId': 'string',
                                'fileName': 'string'
                            },
                        ]
                    },
                ],
                'nextToken': 'string'
            },
            'ccEmailAddresses': [
                'string',
            ],
            'language': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    Returns an array of CaseDetails objects and a nextToken that defines a point for pagination in the result set.

    • cases (list) --

      The details for the cases that match the request.

      • (dict) --

        A JSON-formatted object that contains the metadata for a support case. It is contained in the response from a DescribeCases request. CaseDetails contains the following fields:

        • caseId - 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-exen-2025-c4c1d2bf33c5cf47.

        • categoryCode - The category of problem for the support case. Corresponds to the CategoryCode values returned by a call to DescribeServices.

        • displayId - The identifier for the case on pages in the Amazon Web Services Support Center.

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

        • nextToken - A resumption point for pagination.

        • recentCommunications - One or more Communication objects. Fields of these objects are attachments, body, caseId, submittedBy, and timeCreated.

        • serviceCode - The identifier for the Amazon Web Services service that corresponds to the service code defined in the call to DescribeServices.

        • severityCode - The severity code assigned to the case. Contains one of the values returned by the call to DescribeSeverityLevels. The possible values are: low, normal, high, urgent, and critical.

        • status - The status of the case in the Amazon Web Services Support Center. Valid values:

          • all-open

          • customer-action-completed

          • opened

          • pending-customer-action

          • reopened

          • resolved

          • unassigned

          • work-in-progress

        • subject - The subject line of the case.

        • submittedBy - The email address of the account that submitted the case.

        • timeCreated - The time the case was created, in ISO-8601 format.

        • caseId (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-exen-2025-c4c1d2bf33c5cf47

        • displayId (string) --

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

        • subject (string) --

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

        • status (string) --

          The status of the case.

          Valid values:

          • all-open

          • customer-action-completed

          • opened

          • pending-customer-action

          • reopened

          • resolved

          • unassigned

          • work-in-progress

        • serviceCode (string) --

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

        • categoryCode (string) --

          The category of problem for the support case.

        • severityCode (string) --

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

        • submittedBy (string) --

          The email address of the account that submitted the case.

        • timeCreated (string) --

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

        • recentCommunications (dict) --

          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.

          • communications (list) --

            The five most recent communications associated with the case.

            • (dict) --

              A communication associated with a support case. The communication consists of the case ID, the message body, attachment information, the submitter of the communication, and the date and time of the communication.

              • caseId (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-exen-2025-c4c1d2bf33c5cf47

              • body (string) --

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

              • submittedBy (string) --

                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.

              • timeCreated (string) --

                The time the communication was created.

              • attachments (list) --

                Information about all attachments on the case communication. This includes attachments added through AddAttachmentsToSet and attachments uploaded through GetAttachmentUploadLinks.

                Use this field to enumerate every attachment on the communication. To download an attachment listed in this field, use GetAttachmentDownloadLink. GetAttachmentDownloadLink returns a presigned URL that works for attachments of any size.

                • (dict) --

                  The file name and ID of an attachment to a case communication. You can use the ID to retrieve the attachment with the DescribeAttachment operation.

                  • attachmentId (string) --

                    The ID of the attachment.

                  • fileName (string) --

                    The file name of the attachment.

              • attachmentSet (list) --

                Information about the attachments to the case communication that are 5 MB or smaller. This field doesn't include attachments larger than 5 MB. To enumerate every attachment on the communication, including attachments larger than 5 MB, use the attachments field instead.

                • (dict) --

                  The file name and ID of an attachment to a case communication. You can use the ID to retrieve the attachment with the DescribeAttachment operation.

                  • attachmentId (string) --

                    The ID of the attachment.

                  • fileName (string) --

                    The file name of the attachment.

          • nextToken (string) --

            A resumption point for pagination.

        • ccEmailAddresses (list) --

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

          • (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") , 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.

    • nextToken (string) --

      A resumption point for pagination.

DescribeCommunications (updated) Link ¶
Changes (request, response)
Request
{'dryRun': 'boolean'}
Response
{'communications': {'attachments': [{'attachmentId': 'string',
                                     'fileName': 'string'}]}}

Returns communications and attachments for one or more support cases. Use the afterTime and beforeTime parameters to filter by date. You can use the caseId parameter to restrict the results to a specific case.

Case data is available for 24 months after creation. If a case was created more than 24 months ago, a request for data might cause an error.

You can use the maxResults and nextToken parameters to control the pagination of the results. Set maxResults to the number of cases that you want to display on each page, and use nextToken to specify the resumption of pagination.

See also: AWS API Documentation

Request Syntax

client.describe_communications(
    caseId='string',
    beforeTime='string',
    afterTime='string',
    nextToken='string',
    maxResults=123,
    dryRun=True|False
)
type caseId:

string

param caseId:

[REQUIRED]

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-exen-2025-c4c1d2bf33c5cf47

type beforeTime:

string

param beforeTime:

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

type afterTime:

string

param afterTime:

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

type nextToken:

string

param nextToken:

A resumption point for pagination.

type maxResults:

integer

param maxResults:

The maximum number of results to return before paginating.

type dryRun:

boolean

param dryRun:

Specifies whether to validate the request without actually returning communications. When set to true, the request is validated but no communications are returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

rtype:

dict

returns:

Response Syntax

{
    'communications': [
        {
            'caseId': 'string',
            'body': 'string',
            'submittedBy': 'string',
            'timeCreated': 'string',
            'attachments': [
                {
                    'attachmentId': 'string',
                    'fileName': 'string'
                },
            ],
            'attachmentSet': [
                {
                    'attachmentId': 'string',
                    'fileName': 'string'
                },
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    The communications returned by the DescribeCommunications operation.

    • communications (list) --

      The communications for the case.

      • (dict) --

        A communication associated with a support case. The communication consists of the case ID, the message body, attachment information, the submitter of the communication, and the date and time of the communication.

        • caseId (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-exen-2025-c4c1d2bf33c5cf47

        • body (string) --

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

        • submittedBy (string) --

          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.

        • timeCreated (string) --

          The time the communication was created.

        • attachments (list) --

          Information about all attachments on the case communication. This includes attachments added through AddAttachmentsToSet and attachments uploaded through GetAttachmentUploadLinks.

          Use this field to enumerate every attachment on the communication. To download an attachment listed in this field, use GetAttachmentDownloadLink. GetAttachmentDownloadLink returns a presigned URL that works for attachments of any size.

          • (dict) --

            The file name and ID of an attachment to a case communication. You can use the ID to retrieve the attachment with the DescribeAttachment operation.

            • attachmentId (string) --

              The ID of the attachment.

            • fileName (string) --

              The file name of the attachment.

        • attachmentSet (list) --

          Information about the attachments to the case communication that are 5 MB or smaller. This field doesn't include attachments larger than 5 MB. To enumerate every attachment on the communication, including attachments larger than 5 MB, use the attachments field instead.

          • (dict) --

            The file name and ID of an attachment to a case communication. You can use the ID to retrieve the attachment with the DescribeAttachment operation.

            • attachmentId (string) --

              The ID of the attachment.

            • fileName (string) --

              The file name of the attachment.

    • nextToken (string) --

      A resumption point for pagination.

DescribeCreateCaseOptions (updated) Link ¶
Changes (request)
{'dryRun': 'boolean'}

Returns a list of CreateCaseOption types along with the corresponding supported hours and language availability. You can specify the language categoryCode, issueType and serviceCode used to retrieve the CreateCaseOptions.

See also: AWS API Documentation

Request Syntax

client.describe_create_case_options(
    issueType='string',
    serviceCode='string',
    language='string',
    categoryCode='string',
    dryRun=True|False
)
type issueType:

string

param issueType:

[REQUIRED]

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 serviceCode:

string

param serviceCode:

[REQUIRED]

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

type language:

string

param language:

[REQUIRED]

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 categoryCode:

string

param categoryCode:

[REQUIRED]

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.

type dryRun:

boolean

param dryRun:

Specifies whether to validate the request without actually returning case option data. When set to true, the request is validated but no options are returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

rtype:

dict

returns:

Response Syntax

{
    'languageAvailability': 'string',
    'communicationTypes': [
        {
            'type': 'string',
            'supportedHours': [
                {
                    'startTime': 'string',
                    'endTime': 'string'
                },
            ],
            'datesWithoutSupport': [
                {
                    'startDateTime': 'string',
                    'endDateTime': 'string'
                },
            ]
        },
    ]
}

Response Structure

  • (dict) --

    • languageAvailability (string) --

      Language availability can be any of the following:

      • available

      • best_effort

      • unavailable

    • communicationTypes (list) --

      A JSON-formatted array that contains the available communication type options, along with the available support timeframes for the given inputs.

      • (dict) --

        A JSON-formatted object that contains the CommunicationTypeOptions for creating a case for a certain communication channel. It is contained in the response from a DescribeCreateCaseOptions request. CommunicationTypeOptions contains the following fields:

        • datesWithoutSupport - A JSON-formatted list containing date and time ranges for periods without support in UTC time. Date and time format is RFC 3339 : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'.

        • supportedHours - A JSON-formatted list containing time ranges when support are available. Time format is RFC 3339 : 'HH:mm:ss.SSS'.

        • type - A string value indicating the communication type that the aforementioned rules apply to. At the moment the type value can assume one of 3 values at the moment chat, web and call.

        • type (string) --

          A string value indicating the communication type. At the moment the type value can assume one of 3 values at the moment chat, web and call.

        • supportedHours (list) --

          A JSON-formatted list containing time ranges when support is available.

          • (dict) --

            Time range object with startTime and endTime range in RFC 3339 format. 'HH:mm:ss.SSS'.

            • startTime (string) --

              Start Time. RFC 3339 format 'HH:mm:ss.SSS'.

            • endTime (string) --

              End Time. RFC 3339 format 'HH:mm:ss.SSS'.

        • datesWithoutSupport (list) --

          A JSON-formatted list containing date and time ranges for periods without support

          • (dict) --

            Date and time (UTC) format in RFC 3339 : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'.

            • startDateTime (string) --

              A JSON object containing start and date time (UTC). Date and time format is RFC 3339 : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'.

            • endDateTime (string) --

              End Date Time (UTC). RFC 3339 format : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'.

DescribeServices (updated) Link ¶
Changes (request)
{'dryRun': 'boolean'}

Returns the current list of Amazon Web Services services and a list of service categories for each service. You then use service names and categories in your CreateCase requests. Each Amazon Web Services service has its own set of categories.

The service codes and category codes correspond to the values that appear in the Service and Category lists on the Amazon Web Services Support Center Create Case page. The values in those fields don't necessarily match the service codes and categories returned by the DescribeServices operation. Always use the service codes and categories that the DescribeServices operation returns, so that you have the most recent set of service and category codes.

See also: AWS API Documentation

Request Syntax

client.describe_services(
    serviceCodeList=[
        'string',
    ],
    language='string',
    dryRun=True|False
)
type serviceCodeList:

list

param serviceCodeList:

A JSON-formatted list of service codes available for Amazon Web Services services.

  • (string) --

type language:

string

param 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 dryRun:

boolean

param dryRun:

Specifies whether to validate the request without actually returning the list of services. When set to true, the request is validated but no services are returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

rtype:

dict

returns:

Response Syntax

{
    'services': [
        {
            'code': 'string',
            'name': 'string',
            'categories': [
                {
                    'code': 'string',
                    'name': 'string'
                },
            ]
        },
    ]
}

Response Structure

  • (dict) --

    The list of Amazon Web Services services returned by the DescribeServices operation.

    • services (list) --

      A JSON-formatted list of Amazon Web Services services.

      • (dict) --

        Information about an Amazon Web Services service returned by the DescribeServices operation.

        • code (string) --

          The code for an Amazon Web Services service returned by the DescribeServices response. The name element contains the corresponding friendly name.

        • name (string) --

          The friendly name for an Amazon Web Services service. The code element contains the corresponding code.

        • categories (list) --

          A list of categories that describe the type of support issue a case describes. Categories consist of a category name and a category code. Category names and codes are passed to Amazon Web Services Support when you call CreateCase.

          • (dict) --

            A JSON-formatted name/value pair that represents the category name and category code of the problem, selected from the DescribeServices response for each Amazon Web Services service.

            • code (string) --

              The category code for the support case.

            • name (string) --

              The category name for the support case.

DescribeSeverityLevels (updated) Link ¶
Changes (request)
{'dryRun': 'boolean'}

Returns the list of severity levels that you can assign to a support case. The severity level for a case is also a field in the CaseDetails data type that you include for a CreateCase request.

See also: AWS API Documentation

Request Syntax

client.describe_severity_levels(
    language='string',
    dryRun=True|False
)
type language:

string

param 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 dryRun:

boolean

param dryRun:

Specifies whether to validate the request without actually returning severity levels. When set to true, the request is validated but no severity levels are returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

rtype:

dict

returns:

Response Syntax

{
    'severityLevels': [
        {
            'code': 'string',
            'name': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    The list of severity levels returned by the DescribeSeverityLevels operation.

    • severityLevels (list) --

      The available severity levels for the support case. Available severity levels are defined by your service level agreement with Amazon Web Services.

      • (dict) --

        A code and name pair that represents the severity level of a support case. The available values depend on the support plan for the account. For more information, see Choosing a severity in the Amazon Web Services Support User Guide.

        • code (string) --

          The code for case severity level.

          Valid values: low | normal | high | urgent | critical

        • name (string) --

          The name of the severity level that corresponds to the severity level code.

          For more information, see Choosing a severity in the Amazon Web Services Support User Guide.

DescribeSupportedLanguages (updated) Link ¶
Changes (request)
{'dryRun': 'boolean'}

Returns a list of supported languages for a specified categoryCode, issueType and serviceCode. The returned supported languages will include a ISO 639-1 code for the language, and the language display name.

See also: AWS API Documentation

Request Syntax

client.describe_supported_languages(
    issueType='string',
    serviceCode='string',
    categoryCode='string',
    dryRun=True|False
)
type issueType:

string

param issueType:

[REQUIRED]

The type of issue for the case. You can specify customer-service or technical.

type serviceCode:

string

param serviceCode:

[REQUIRED]

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

type categoryCode:

string

param categoryCode:

[REQUIRED]

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.

type dryRun:

boolean

param dryRun:

Specifies whether to validate the request without actually returning supported languages. When set to true, the request is validated but no languages are returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

rtype:

dict

returns:

Response Syntax

{
    'supportedLanguages': [
        {
            'code': 'string',
            'language': 'string',
            'display': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • supportedLanguages (list) --

      A JSON-formatted array that contains the available ISO 639-1 language codes.

      • (dict) --

        A JSON-formatted object that contains the available ISO 639-1 language code, language name and langauge display value. The language code is what should be used in the CreateCase call.

        • code (string) --

          2 digit ISO 639-1 code. e.g. en

        • language (string) --

          Full language description e.g. ENGLISH

        • display (string) --

          Language display value e.g. ENGLISH

ResolveCase (updated) Link ¶
Changes (request)
{'dryRun': 'boolean'}

Resolves a support case. This operation takes a caseId and returns the initial and final state of the case.

See also: AWS API Documentation

Request Syntax

client.resolve_case(
    caseId='string',
    dryRun=True|False
)
type caseId:

string

param caseId:

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-exen-2025-c4c1d2bf33c5cf47

type dryRun:

boolean

param dryRun:

Specifies whether to validate the request without actually resolving the case. When set to true, the request is validated but the case isn't resolved, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

rtype:

dict

returns:

Response Syntax

{
    'initialCaseStatus': 'string',
    'finalCaseStatus': 'string'
}

Response Structure

  • (dict) --

    The status of the case returned by the ResolveCase operation.

    • initialCaseStatus (string) --

      The status of the case when the ResolveCase request was sent.

    • finalCaseStatus (string) --

      The status of the case after the ResolveCase request was processed.