Skip to content

StartSyncExecutionInput

Source code in docs_src/capo_sfn/types/start_sync_execution_input.py 
17
18
19
20
21
22
23
24
25
26
27
class StartSyncExecutionInput(TypedDict, closed=True):
    state_machine_arn: "capo_sfn.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) of the state machine to execute.</p>"""
    name: NotRequired["capo_sfn.types.name.Name"]
    """<p>The name of the execution.</p>"""
    input: NotRequired["capo_sfn.types.sensitive_data.SensitiveData"]
    r"""<p>The string that contains the JSON input data for the execution, for example:</p> <p> <code>"{\"first_name\" : \"Alejandro\"}"</code> </p> <note> <p>If you don't include any JSON input data, you still must include the two braces, for example: <code>"{}"</code> </p> </note> <p>Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>"""
    trace_header: NotRequired["capo_sfn.types.trace_header.TraceHeader"]
    """<p>Passes the X-Ray trace header. The trace header can also be passed in the request payload.</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>"""
    included_data: NotRequired["capo_sfn.types.included_data.IncludedData"]
    """<p>If your state machine definition is encrypted with a KMS key, callers must have <code>kms:Decrypt</code> permission to decrypt the definition. Alternatively, you can call the API with <code>includedData = METADATA_ONLY</code> to get a successful response without the encrypted definition.</p>"""

included_data instance-attribute 

included_data: NotRequired[IncludedData]

If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.

input instance-attribute 

input: NotRequired[SensitiveData]

The string that contains the JSON input data for the execution, for example:

"{\"first_name\" : \"Alejandro\"}"

If you don't include any JSON input data, you still must include the two braces, for example: "{}"

Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

name instance-attribute 

name: NotRequired[Name]

The name of the execution.

state_machine_arn instance-attribute 

state_machine_arn: Arn

The Amazon Resource Name (ARN) of the state machine to execute.

trace_header instance-attribute 

trace_header: NotRequired[TraceHeader]

Passes the X-Ray trace header. The trace header can also be passed in the request payload.

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.