Support / Client / describe_communications

describe_communications¶

Support.Client.describe_communications(**kwargs)¶

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.

Note

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 SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

Warning

Each Communication returned by this operation includes attachment information in two fields:

attachmentSet: returns only attachments that are 5 MB or smaller. Attachments larger than 5 MB are not included in this field.
attachments: returns all attachments regardless of size.

Amazon Web Services recommends that you use the attachments field and download each attachment with GetAttachmentDownloadLink, which supports attachments of any size. The attachmentSet field and DescribeAttachment return only attachments that are 5 MB or smaller.

Request Syntax

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

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.
nextToken (string) – A resumption point for pagination.
maxResults (integer) – The maximum number of results to return before paginating.
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.

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 resumption point for pagination.