:doc:`Support <../../support>` / Paginator / DescribeCommunications

**********************
DescribeCommunications
**********************



.. py:class:: Support.Paginator.DescribeCommunications

  ::

    
    paginator = client.get_paginator('describe_communications')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`Support.Client.describe_communications`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeCommunications>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          caseId='string',
          beforeTime='string',
          afterTime='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :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-2013-c4c1d2bf33c5cf47*

      

    
    :type beforeTime: string
    :param beforeTime: 

      The end date for a filtered date search on support case communications. Case communications are available for 12 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 12 months after creation.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'communications': [
                {
                    'caseId': 'string',
                    'body': 'string',
                    'submittedBy': 'string',
                    'timeCreated': '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-2013-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.

              
            

            - **attachmentSet** *(list) --* 

              Information about the attachments to the case communication.

              
              

              - *(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.

          
    