Skip to content

aws.transfer.describe_execution

Example SQL Queries

SELECT * FROM
aws.transfer.describe_execution
WHERE
"execution_id" = 'VALUE'
AND "workflow_id" = 'VALUE';

Description

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.

Table Definition

Column NameColumn Data Type
execution_id Required Input Column

A unique identifier for the execution of a workflow.

VARCHAR
workflow_id Required Input Column

A unique identifier for the workflow.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
execution

The structure that contains the details of the workflow' execution.

STRUCT(
"execution_id" VARCHAR,
"initial_file_location" STRUCT(
"s3_file_location" STRUCT(
"bucket" VARCHAR,
"key" VARCHAR,
"version_id" VARCHAR,
"etag" VARCHAR
),
"efs_file_location" STRUCT(
"file_system_id" VARCHAR,
"path" VARCHAR
)
),
"service_metadata" STRUCT(
"user_details" STRUCT(
"user_name" VARCHAR,
"server_id" VARCHAR,
"session_id" VARCHAR
)
),
"execution_role" VARCHAR,
"logging_configuration" STRUCT(
"logging_role" VARCHAR,
"log_group_name" VARCHAR
),
"posix_profile" STRUCT(
"uid" BIGINT,
"gid" BIGINT,
"secondary_gids" BIGINT[]
),
"status" VARCHAR,
"results" STRUCT(
"steps" STRUCT(
"step_type" VARCHAR,
"outputs" VARCHAR,
"error" STRUCT(
"type" VARCHAR,
"message" VARCHAR
)
)[],
"on_exception_steps" STRUCT(
"step_type" VARCHAR,
"outputs" VARCHAR,
"error" STRUCT(
"type" VARCHAR,
"message" VARCHAR
)
)[]
)
)
Show child fields
execution.execution_id

A unique identifier for the execution of a workflow.

execution.execution_role

The IAM role associated with the execution.

execution.initial_file_location

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.

Show child fields
execution.initial_file_location.efs_file_location

Specifies the Amazon EFS identifier and the path for the file being used.

Show child fields
execution.initial_file_location.efs_file_location.file_system_id

The identifier of the file system, assigned by Amazon EFS.

execution.initial_file_location.efs_file_location.path

The pathname for the folder being used by a workflow.

execution.initial_file_location.s3_file_location

Specifies the S3 details for the file being used, such as bucket, ETag, and so forth.

Show child fields
execution.initial_file_location.s3_file_location.bucket

Specifies the S3 bucket that contains the file being used.

execution.initial_file_location.s3_file_location.etag

The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata.

execution.initial_file_location.s3_file_location.key

The name assigned to the file when it was created in Amazon S3. You use the object key to retrieve the object.

execution.initial_file_location.s3_file_location.version_id

Specifies the file version.

execution.logging_configuration

The IAM logging role associated with the execution.

Show child fields
execution.logging_configuration.log_group_name

The name of the CloudWatch logging group for the Transfer Family server to which this workflow belongs.

execution.logging_configuration.logging_role

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.

execution.posix_profile

The full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

Show child fields
execution.posix_profile.gid

The POSIX group ID used for all EFS operations by this user.

execution.posix_profile.secondary_gids[]
execution.posix_profile.uid

The POSIX user ID used for all EFS operations by this user.

execution.results

A structure that describes the execution results. This includes a list of the steps along with the details of each step, error type and message (if any), and the OnExceptionSteps structure.

Show child fields
execution.results.on_exception_steps[]
Show child fields
execution.results.on_exception_steps[].error

Specifies the details for an error, if it occurred during execution of the specified workflow step.

Show child fields
execution.results.on_exception_steps[].error.message

Specifies the descriptive message that corresponds to the ErrorType.

execution.results.on_exception_steps[].error.type

Specifies the error type.

  • ALREADY_EXISTS: occurs for a copy step, if the overwrite option is not selected and a file with the same name already exists in the target location.

  • BAD_REQUEST: a general bad request: for example, a step that attempts to tag an EFS file returns BAD_REQUEST, as only S3 files can be tagged.

  • CUSTOM_STEP_FAILED: occurs when the custom step provided a callback that indicates failure.

  • INTERNAL_SERVER_ERROR: a catch-all error that can occur for a variety of reasons.

  • NOT_FOUND: occurs when a requested entity, for example a source file for a copy step, does not exist.

  • PERMISSION_DENIED: occurs if your policy does not contain the correct permissions to complete one or more of the steps in the workflow.

  • TIMEOUT: occurs when the execution times out.

    You can set the TimeoutSeconds for a custom step, anywhere from 1 second to 1800 seconds (30 minutes).

  • THROTTLED: occurs if you exceed the new execution refill rate of one workflow per second.

execution.results.on_exception_steps[].outputs

The values for the key/value pair applied as a tag to the file. Only applicable if the step type is TAG.

execution.results.on_exception_steps[].step_type

One of the available step types.

  • COPY - Copy the file to another location.

  • CUSTOM - Perform a custom step with an Lambda function target.

  • DECRYPT - Decrypt a file that was encrypted before it was uploaded.

  • DELETE - Delete the file.

  • TAG - Add a tag to the file.

execution.results.steps[]
Show child fields
execution.results.steps[].error

Specifies the details for an error, if it occurred during execution of the specified workflow step.

Show child fields
execution.results.steps[].error.message

Specifies the descriptive message that corresponds to the ErrorType.

execution.results.steps[].error.type

Specifies the error type.

  • ALREADY_EXISTS: occurs for a copy step, if the overwrite option is not selected and a file with the same name already exists in the target location.

  • BAD_REQUEST: a general bad request: for example, a step that attempts to tag an EFS file returns BAD_REQUEST, as only S3 files can be tagged.

  • CUSTOM_STEP_FAILED: occurs when the custom step provided a callback that indicates failure.

  • INTERNAL_SERVER_ERROR: a catch-all error that can occur for a variety of reasons.

  • NOT_FOUND: occurs when a requested entity, for example a source file for a copy step, does not exist.

  • PERMISSION_DENIED: occurs if your policy does not contain the correct permissions to complete one or more of the steps in the workflow.

  • TIMEOUT: occurs when the execution times out.

    You can set the TimeoutSeconds for a custom step, anywhere from 1 second to 1800 seconds (30 minutes).

  • THROTTLED: occurs if you exceed the new execution refill rate of one workflow per second.

execution.results.steps[].outputs

The values for the key/value pair applied as a tag to the file. Only applicable if the step type is TAG.

execution.results.steps[].step_type

One of the available step types.

  • COPY - Copy the file to another location.

  • CUSTOM - Perform a custom step with an Lambda function target.

  • DECRYPT - Decrypt a file that was encrypted before it was uploaded.

  • DELETE - Delete the file.

  • TAG - Add a tag to the file.

execution.service_metadata

A container object for the session details that are associated with a workflow.

Show child fields
execution.service_metadata.user_details

The Server ID (ServerId), Session ID (SessionId) and user (UserName) make up the UserDetails.

Show child fields
execution.service_metadata.user_details.server_id

The system-assigned unique identifier for a Transfer server instance.

execution.service_metadata.user_details.session_id

The system-assigned unique identifier for a session that corresponds to the workflow.

execution.service_metadata.user_details.user_name

A unique string that identifies a Transfer Family user associated with a server.

execution.status

The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.