executions

Creates, updates, deletes, gets or lists an executions resource.

Overview

Name	executions
Type	Resource
Id	aws.transfer.executions

Fields

The following fields are returned by SELECT queries:

describe_execution

Name	Datatype	Description
execution	object	The structure that contains the details of the workflow' execution.
workflow_id	string	A unique identifier for the workflow. (pattern: <code>w-([a-z0-9]{17})</code>)

list_executions

Name	Datatype	Description
execution_id	string	A unique identifier for the execution of a workflow. (pattern: <code>[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}</code>)
initial_file_location	object	A structure that describes the Amazon S3 or EFS file location. This is the file location when the execution begins: if the file is being copied, this is the initial (as opposed to destination) file location.
service_metadata	object	A container object for the session details that are associated with a workflow.
status	string	The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception. (IN_PROGRESS, COMPLETED, EXCEPTION, HANDLING_EXCEPTION)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_execution	select	region		You can use DescribeExecution to check the details of the execution of the specified workflow. This API call only returns details for in-progress workflows. If you provide an ID for an execution that is not in progress, or if the execution doesn't match the specified workflow ID, you receive a ResourceNotFound exception.
list_executions	select	region		Lists all in-progress executions for the specified workflow. If the specified workflow ID cannot be found, ListExecutions returns a ResourceNotFound exception.

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

describe_execution

You can use DescribeExecution to check the details of the execution of the specified workflow. This API call only returns details for in-progress workflows. If you provide an ID for an execution that is not in progress, or if the execution doesn't match the specified workflow ID, you receive a ResourceNotFound exception.

SELECT
execution,
workflow_id
FROM aws.transfer.executions
WHERE region = '{{ region }}' -- required
;

list_executions

Lists all in-progress executions for the specified workflow. If the specified workflow ID cannot be found, ListExecutions returns a ResourceNotFound exception.

SELECT
execution_id,
initial_file_location,
service_metadata,
status
FROM aws.transfer.executions
WHERE region = '{{ region }}' -- required
;