Skip to content

StartSyncExecutionOutput

Source code in docs_src/capo_sfn/types/start_sync_execution_output.py
class StartSyncExecutionOutput(TypedDict, closed=True):
    execution_arn: "capo_sfn.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) that identifies the execution.</p>"""
    state_machine_arn: NotRequired["capo_sfn.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) that identifies the state machine.</p>"""
    name: NotRequired["capo_sfn.types.name.Name"]
    """<p>The name of the execution.</p>"""
    start_date: "capo_sfn.types.timestamp.Timestamp"
    """<p>The date the execution is started.</p>"""
    stop_date: "capo_sfn.types.timestamp.Timestamp"
    """<p>If the execution has already ended, the date the execution stopped.</p>"""
    status: "capo_sfn.types.sync_execution_status.SyncExecutionStatus"
    """<p>The current status of the execution.</p>"""
    error: NotRequired["capo_sfn.types.sensitive_error.SensitiveError"]
    """<p>The error code of the failure.</p>"""
    cause: NotRequired["capo_sfn.types.sensitive_cause.SensitiveCause"]
    """<p>A more detailed explanation of the cause of the failure.</p>"""
    input: NotRequired["capo_sfn.types.sensitive_data.SensitiveData"]
    """<p>The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>"""
    input_details: NotRequired[
        "capo_sfn.types.cloud_watch_events_execution_data_details.CloudWatchEventsExecutionDataDetails"
    ]
    output: NotRequired["capo_sfn.types.sensitive_data.SensitiveData"]
    """<p>The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p> <note> <p>This field is set only if the execution succeeds. If the execution fails, this field is null.</p> </note>"""
    output_details: NotRequired[
        "capo_sfn.types.cloud_watch_events_execution_data_details.CloudWatchEventsExecutionDataDetails"
    ]
    trace_header: NotRequired["capo_sfn.types.trace_header.TraceHeader"]
    """<p>The X-Ray trace header that was passed to the execution.</p> <note> <p> For X-Ray traces, all Amazon Web Services services use the <code>X-Amzn-Trace-Id</code> header from the HTTP request. Using the header is the preferred mechanism to identify a trace. <code>StartExecution</code> and <code>StartSyncExecution</code> API operations can also use <code>traceHeader</code> from the body of the request payload. If <b>both</b> sources are provided, Step Functions will use the <b>header value</b> (preferred) over the value in the request body. </p> </note>"""
    billing_details: NotRequired["capo_sfn.types.billing_details.BillingDetails"]
    """<p>An object that describes workflow billing details, including billed duration and memory use.</p>"""

billing_details instance-attribute

billing_details: NotRequired[BillingDetails]

An object that describes workflow billing details, including billed duration and memory use.

cause instance-attribute

cause: NotRequired[SensitiveCause]

A more detailed explanation of the cause of the failure.

error instance-attribute

error: NotRequired[SensitiveError]

The error code of the failure.

execution_arn instance-attribute

execution_arn: Arn

The Amazon Resource Name (ARN) that identifies the execution.

input instance-attribute

input: NotRequired[SensitiveData]

The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

input_details instance-attribute

input_details: NotRequired[CloudWatchEventsExecutionDataDetails]

name instance-attribute

name: NotRequired[Name]

The name of the execution.

output instance-attribute

output: NotRequired[SensitiveData]

The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

This field is set only if the execution succeeds. If the execution fails, this field is null.

output_details instance-attribute

output_details: NotRequired[CloudWatchEventsExecutionDataDetails]

start_date instance-attribute

start_date: Timestamp

The date the execution is started.

state_machine_arn instance-attribute

state_machine_arn: NotRequired[Arn]

The Amazon Resource Name (ARN) that identifies the state machine.

status instance-attribute

The current status of the execution.

stop_date instance-attribute

stop_date: Timestamp

If the execution has already ended, the date the execution stopped.

trace_header instance-attribute

trace_header: NotRequired[TraceHeader]

The X-Ray trace header that was passed to the execution.

For X-Ray traces, all Amazon Web Services services use the X-Amzn-Trace-Id header from the HTTP request. Using the header is the preferred mechanism to identify a trace. StartExecution and StartSyncExecution API operations can also use traceHeader from the body of the request payload. If both sources are provided, Step Functions will use the header value (preferred) over the value in the request body.