Skip to content

DescribedExecution

Source code in docs_src/capo_transfer/types/described_execution.py
class DescribedExecution(TypedDict, closed=True):
    execution_id: NotRequired["capo_transfer.types.execution_id.ExecutionId"]
    """<p>A unique identifier for the execution of a workflow.</p>"""
    initial_file_location: NotRequired["capo_transfer.types.file_location.FileLocation"]
    """<p>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.</p>"""
    service_metadata: NotRequired[
        "capo_transfer.types.service_metadata.ServiceMetadata"
    ]
    """<p>A container object for the session details that are associated with a workflow.</p>"""
    execution_role: NotRequired["capo_transfer.types.role.Role"]
    """<p>The IAM role associated with the execution.</p>"""
    logging_configuration: NotRequired[
        "capo_transfer.types.logging_configuration.LoggingConfiguration"
    ]
    """<p>The IAM logging role associated with the execution.</p>"""
    posix_profile: NotRequired["capo_transfer.types.posix_profile.PosixProfile"]
    status: NotRequired["capo_transfer.types.execution_status.ExecutionStatus"]
    """<p>The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception. </p>"""
    results: NotRequired["capo_transfer.types.execution_results.ExecutionResults"]
    """<p>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 <code>OnExceptionSteps</code> structure.</p>"""

execution_id instance-attribute

execution_id: NotRequired[ExecutionId]

A unique identifier for the execution of a workflow.

execution_role instance-attribute

execution_role: NotRequired[Role]

The IAM role associated with the execution.

initial_file_location instance-attribute

initial_file_location: NotRequired[FileLocation]

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.

logging_configuration instance-attribute

logging_configuration: NotRequired[LoggingConfiguration]

The IAM logging role associated with the execution.

posix_profile instance-attribute

posix_profile: NotRequired[PosixProfile]

results instance-attribute

results: NotRequired[ExecutionResults]

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.

service_metadata instance-attribute

service_metadata: NotRequired[ServiceMetadata]

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

status instance-attribute

status: NotRequired[ExecutionStatus]

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