Transfer / Client / list_file_transfer_results

list_file_transfer_results#

Transfer.Client.list_file_transfer_results(**kwargs)#

Returns real-time updates and detailed information on the status of each individual file being transferred in a specific file transfer operation. You specify the file transfer by providing its ConnectorId and its TransferId.

Note

File transfer results are available up to 7 days after an operation has been requested.

See also: AWS API Documentation

Request Syntax

response = client.list_file_transfer_results(
    ConnectorId='string',
    TransferId='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • ConnectorId (string) –

    [REQUIRED]

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

  • TransferId (string) –

    [REQUIRED]

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

  • NextToken (string) – If there are more file details than returned in this call, use this value for a subsequent call to ListFileTransferResults to retrieve them.

  • MaxResults (integer) – The maximum number of files to return in a single page. Note that currently you can specify a maximum of 10 file paths in a single StartFileTransfer operation. Thus, the maximum number of file transfer results that can be returned in a single page is 10.

Return type:

dict

Returns:

Response Syntax

{
    'FileTransferResults': [
        {
            'FilePath': 'string',
            'StatusCode': 'QUEUED'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
            'FailureCode': 'string',
            'FailureMessage': 'string'
        },
    ],
    'NextToken': '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.

    • NextToken (string) –

      Returns a token that you can use to call ListFileTransferResults again and receive additional results, if there are any (against the same TransferId.

Exceptions