Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

ListFileTransferResults

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.

Request Syntax


{
   "ConnectorId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "TransferId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ConnectorId

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

Type: String

Length Constraints: Fixed length of 19.

Pattern: c-([0-9a-f]{17})

Required: Yes

MaxResults

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

NextToken

If there are more file details than returned in this call, use this value for a subsequent call to ListFileTransferResults to retrieve them.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 6144.

Required: No

TransferId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: [0-9a-zA-Z./-]+

Required: Yes

Response Syntax


{
   "FileTransferResults": [ 
      { 
         "FailureCode": "string",
         "FailureMessage": "string",
         "FilePath": "string",
         "StatusCode": "string"
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

FileTransferResults

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.

Type: Array of ConnectorFileTransferResult objects

Array Members: Minimum number of 0 items. Maximum number of 1000 items.

NextToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 6144.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceError

This exception is thrown when an error occurs in the AWS Transfer Family service.

HTTP Status Code: 500

InvalidRequestException

This exception is thrown when the client submits a malformed request.

HTTP Status Code: 400

ResourceNotFoundException

This exception is thrown when a resource is not found by the AWSTransfer Family service.

HTTP Status Code: 400

ServiceUnavailableException

The request has failed because the AWSTransfer Family service is not available.

HTTP Status Code: 500

Examples

Example

The following example returns a list of files for connector ID a-11112222333344444 and transfer ID aa1b2c3d4-5678-90ab-cdef-EXAMPLE11111.

Sample Request


aws transfer listFileTransferResults --connector-id a-11112222333344444 --transfer-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"

Example

An example response looks like the following.

Sample Response


{
  "FileTransferResults": [ 
    {
      "FilePath" : "my-stuff/hello.txt",
      "StatusCode": "COMPLETED"
    },
    {
      "FilePath" : "my-stuff/texting.txt",
      "StatusCode": "FAILED",
      "FailureCode": "RETRIEVE_FILE_NOT_FOUND",
      "FailureMessage": "SFTP error (SSH_FX_NO_SUCH_FILE)"
    }
  ],  
  "NextToken": "1111111"
}