Support / Paginator / DescribeCommunications

DescribeCommunications

class Support.Paginator.DescribeCommunications

paginator = client.get_paginator('describe_communications')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Support.Client.describe_communications().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    caseId='string',
    beforeTime='string',
    afterTime='string',
    dryRun=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• caseId (string) –

  [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

• beforeTime (string) – The end date for a filtered date search on support case communications. Case communications are available for 24 months after creation.

• afterTime (string) – The start date for a filtered date search on support case communications. Case communications are available for 24 months after creation.

• dryRun (boolean) – 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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

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 token to resume pagination.