Transfer / Client / describe_execution

describe_execution#

Transfer.Client.describe_execution(**kwargs)#

You can use DescribeExecution to check the details of the execution of the specified workflow.

Note

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_execution(
    ExecutionId='string',
    WorkflowId='string'
)
Parameters:

  • ExecutionId (string) –

    [REQUIRED]

    A unique identifier for the execution of a workflow.

  • WorkflowId (string) –

    [REQUIRED]

    A unique identifier for the workflow.

Return type:

dict

Returns:

Response Syntax

{
    'WorkflowId': 'string',
    'Execution': {
        'ExecutionId': 'string',
        'InitialFileLocation': {
            'S3FileLocation': {
                'Bucket': 'string',
                'Key': 'string',
                'VersionId': 'string',
                'Etag': 'string'
            },
            'EfsFileLocation': {
                'FileSystemId': 'string',
                'Path': 'string'
            }
        },
        'ServiceMetadata': {
            'UserDetails': {
                'UserName': 'string',
                'ServerId': 'string',
                'SessionId': 'string'
            }
        },
        'ExecutionRole': 'string',
        'LoggingConfiguration': {
            'LoggingRole': 'string',
            'LogGroupName': 'string'
        },
        'PosixProfile': {
            'Uid': 123,
            'Gid': 123,
            'SecondaryGids': [
                123,
            ]
        },
        'Status': 'IN_PROGRESS'|'COMPLETED'|'EXCEPTION'|'HANDLING_EXCEPTION',
        'Results': {
            'Steps': [
                {
                    'StepType': 'COPY'|'CUSTOM'|'TAG'|'DELETE'|'DECRYPT',
                    'Outputs': 'string',
                    'Error': {
                        'Type': 'PERMISSION_DENIED'|'CUSTOM_STEP_FAILED'|'THROTTLED'|'ALREADY_EXISTS'|'NOT_FOUND'|'BAD_REQUEST'|'TIMEOUT'|'INTERNAL_SERVER_ERROR',
                        'Message': 'string'
                    }
                },
            ],
            'OnExceptionSteps': [
                {
                    'StepType': 'COPY'|'CUSTOM'|'TAG'|'DELETE'|'DECRYPT',
                    'Outputs': 'string',
                    'Error': {
                        'Type': 'PERMISSION_DENIED'|'CUSTOM_STEP_FAILED'|'THROTTLED'|'ALREADY_EXISTS'|'NOT_FOUND'|'BAD_REQUEST'|'TIMEOUT'|'INTERNAL_SERVER_ERROR',
                        'Message': 'string'
                    }
                },
            ]
        }
    }
}

Response Structure

  • (dict) –

    • WorkflowId (string) –

      A unique identifier for the workflow.

    • Execution (dict) –

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

      • ExecutionId (string) –

        A unique identifier for the execution of a workflow.

      • InitialFileLocation (dict) –

        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.

        • S3FileLocation (dict) –

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

          • Bucket (string) –

            Specifies the S3 bucket that contains the file being used.

          • Key (string) –

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

          • VersionId (string) –

            Specifies the file version.

          • Etag (string) –

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

        • EfsFileLocation (dict) –

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

          • FileSystemId (string) –

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

          • Path (string) –

            The pathname for the folder being used by a workflow.

      • ServiceMetadata (dict) –

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

        • UserDetails (dict) –

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

          • UserName (string) –

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

          • ServerId (string) –

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

          • SessionId (string) –

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

      • ExecutionRole (string) –

        The IAM role associated with the execution.

      • LoggingConfiguration (dict) –

        The IAM logging role associated with the execution.

        • LoggingRole (string) –

          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.

        • LogGroupName (string) –

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

      • PosixProfile (dict) –

        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.

        • Uid (integer) –

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

        • Gid (integer) –

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

        • SecondaryGids (list) –

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

          • (integer) –

      • Status (string) –

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

      • Results (dict) –

        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.

        • Steps (list) –

          Specifies the details for the steps that are in the specified workflow.

          • (dict) –

            Specifies the following details for the step: error (if any), outputs (if any), and the step type.

            • StepType (string) –

              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.

            • Outputs (string) –

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

            • Error (dict) –

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

              • Type (string) –

                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.

                Note

                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.

              • Message (string) –

                Specifies the descriptive message that corresponds to the ErrorType.

        • OnExceptionSteps (list) –

          Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

          • (dict) –

            Specifies the following details for the step: error (if any), outputs (if any), and the step type.

            • StepType (string) –

              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.

            • Outputs (string) –

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

            • Error (dict) –

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

              • Type (string) –

                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.

                Note

                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.

              • Message (string) –

                Specifies the descriptive message that corresponds to the ErrorType.

Exceptions