:doc:`Transfer <../../transfer>` / Paginator / ListFileTransferResults

***********************
ListFileTransferResults
***********************



.. py:class:: Transfer.Paginator.ListFileTransferResults

  ::

    
    paginator = client.get_paginator('list_file_transfer_results')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`Transfer.Client.list_file_transfer_results`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListFileTransferResults>`_    


    **Request Syntax**
    ::

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

      A unique identifier for a connector. This value should match the value supplied to the corresponding ``StartFileTransfer`` call.

      

    
    :type TransferId: string
    :param TransferId: **[REQUIRED]** 

      A unique identifier for a file transfer. This value should match the value supplied to the corresponding ``StartFileTransfer`` call.

      

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

      
      ::

        {
            'FileTransferResults': [
                {
                    'FilePath': 'string',
                    'StatusCode': 'QUEUED'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
                    'FailureCode': 'string',
                    'FailureMessage': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **FileTransferResults** *(list) --* 

          Returns the details for the files transferred in the transfer identified by the ``TransferId`` and ``ConnectorId`` specified.

           

          
          * ``FilePath``: the filename and path to where the file was sent to or retrieved from.
           
          * ``StatusCode``: current status for the transfer. The status returned is one of the following values: ``QUEUED``, ``IN_PROGRESS``, ``COMPLETED``, or ``FAILED``
           
          * ``FailureCode``: for transfers that fail, this parameter contains a code indicating the reason. For example, ``RETRIEVE_FILE_NOT_FOUND``
           
          * ``FailureMessage``: for transfers that fail, this parameter describes the reason for the failure.
          

          
          

          - *(dict) --* 

            A structure that contains the details for files transferred using an SFTP connector, during a single transfer.

            
            

            - **FilePath** *(string) --* 

              The filename and path to where the file was sent to or retrieved from.

              
            

            - **StatusCode** *(string) --* 

              The current status for the transfer.

              
            

            - **FailureCode** *(string) --* 

              For transfers that fail, this parameter contains a code indicating the reason. For example, ``RETRIEVE_FILE_NOT_FOUND``

              
            

            - **FailureMessage** *(string) --* 

              For transfers that fail, this parameter describes the reason for the failure.

              
        
      
    