:doc:`QBusiness <../../qbusiness>` / Paginator / ListAttachments

***************
ListAttachments
***************



.. py:class:: QBusiness.Paginator.ListAttachments

  ::

    
    paginator = client.get_paginator('list_attachments')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`QBusiness.Client.list_attachments`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListAttachments>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          applicationId='string',
          conversationId='string',
          userId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type applicationId: string
    :param applicationId: **[REQUIRED]** 

      The unique identifier for the Amazon Q Business application.

      

    
    :type conversationId: string
    :param conversationId: 

      The unique identifier of the Amazon Q Business web experience conversation.

      

    
    :type userId: string
    :param userId: 

      The unique identifier of the user involved in the Amazon Q Business web experience conversation.

      

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

      
      ::

        {
            'attachments': [
                {
                    'attachmentId': 'string',
                    'conversationId': 'string',
                    'name': 'string',
                    'copyFrom': {
                        'conversation': {
                            'conversationId': 'string',
                            'attachmentId': 'string'
                        }
                    },
                    'fileType': 'string',
                    'fileSize': 123,
                    'md5chksum': 'string',
                    'createdAt': datetime(2015, 1, 1),
                    'status': 'FAILED'|'SUCCESS',
                    'error': {
                        'errorMessage': 'string',
                        'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound'
                    }
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **attachments** *(list) --* 

          An array of information on one or more attachments.

          
          

          - *(dict) --* 

            An attachment in an Amazon Q Business conversation.

            
            

            - **attachmentId** *(string) --* 

              The identifier of the Amazon Q Business attachment.

              
            

            - **conversationId** *(string) --* 

              The identifier of the Amazon Q Business conversation the attachment is associated with.

              
            

            - **name** *(string) --* 

              Filename of the Amazon Q Business attachment.

              
            

            - **copyFrom** *(dict) --* 

              A CopyFromSource containing a reference to the original source of the Amazon Q Business attachment.

              .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``conversation``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


            
              

              - **conversation** *(dict) --* 

                A reference to an attachment in an existing conversation.

                
                

                - **conversationId** *(string) --* 

                  The unique identifier of the Amazon Q Business conversation.

                  
                

                - **attachmentId** *(string) --* 

                  The unique identifier of the Amazon Q Business attachment.

                  
            
          
            

            - **fileType** *(string) --* 

              Filetype of the Amazon Q Business attachment.

              
            

            - **fileSize** *(integer) --* 

              Size in bytes of the Amazon Q Business attachment.

              
            

            - **md5chksum** *(string) --* 

              MD5 checksum of the Amazon Q Business attachment contents.

              
            

            - **createdAt** *(datetime) --* 

              The Unix timestamp when the Amazon Q Business attachment was created.

              
            

            - **status** *(string) --* 

              AttachmentStatus of the Amazon Q Business attachment.

              
            

            - **error** *(dict) --* 

              ErrorDetail providing information about a Amazon Q Business attachment error.

              
              

              - **errorMessage** *(string) --* 

                The message explaining the Amazon Q Business request error.

                
              

              - **errorCode** *(string) --* 

                The code associated with the Amazon Q Business request error.

                
          
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    