DescribedExecution - Amazon Transfer Family
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

DescribedExecution

The details for an execution object.

Contents

ExecutionId

A unique identifier for the execution of a workflow.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[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}$

Required: No

ExecutionRole

The IAM role associated with the execution.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:.*role/.*

Required: No

InitialFileLocation

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.

Type: FileLocation object

Required: No

LoggingConfiguration

The IAM logging role associated with the execution.

Type: LoggingConfiguration object

Required: No

PosixProfile

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.

Type: PosixProfile object

Required: No

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.

Type: ExecutionResults object

Required: No

ServiceMetadata

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

Type: ServiceMetadata object

Required: No

Status

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

Type: String

Valid Values: IN_PROGRESS | COMPLETED | EXCEPTION | HANDLING_EXCEPTION

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: