file_transfer_results

Creates, updates, deletes, gets or lists a file_transfer_results resource.

Overview

Name	file_transfer_results
Type	Resource
Id	aws.transfer.file_transfer_results

Fields

The following fields are returned by SELECT queries:

list_file_transfer_results

Name	Datatype	Description
failure_code	string	For transfers that fail, this parameter contains a code indicating the reason. For example, RETRIEVE_FILE_NOT_FOUND
failure_message	string	For transfers that fail, this parameter describes the reason for the failure.
file_path	string	The filename and path to where the file was sent to or retrieved from. (pattern: <code>(.)+</code>)
status_code	string	The current status for the transfer. (QUEUED, IN_PROGRESS, COMPLETED, FAILED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_file_transfer_results	select	region		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. File transfer results are available up to 7 days after an operation has been requested.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_file_transfer_results

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. File transfer results are available up to 7 days after an operation has been requested.

SELECT
failure_code,
failure_message,
file_path,
status_code
FROM aws.transfer.file_transfer_results
WHERE region = '{{ region }}' -- required
;