Struct StartSyncExecutionFluentBuilder 

pub struct StartSyncExecutionFluentBuilder { /* private fields */ }

Fluent builder constructing a request to StartSyncExecution.

Starts a Synchronous Express state machine execution. StartSyncExecution is not available for STANDARD workflows.

StartSyncExecution will return a 200 OK response, even if your execution fails, because the status code in the API response doesn't reflect function errors. Error codes are reserved for errors that prevent your execution from running, such as permissions errors, limit errors, or issues with your state machine code and configuration.

This API action isn't logged in CloudTrail.

Implementations

impl StartSyncExecutionFluentBuilder

pub fn as_input(&self) -> &StartSyncExecutionInputBuilder

Access the StartSyncExecution as a reference.

pub async fn send( self, ) -> Result<StartSyncExecutionOutput, SdkError<StartSyncExecutionError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self, ) -> CustomizableOperation<StartSyncExecutionOutput, StartSyncExecutionError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn state_machine_arn(self, input: impl Into<String>) -> Self

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

pub fn set_state_machine_arn(self, input: Option<String>) -> Self

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

pub fn get_state_machine_arn(&self) -> &Option<String>

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

pub fn name(self, input: impl Into<String>) -> Self

The name of the execution.

pub fn set_name(self, input: Option<String>) -> Self

The name of the execution.

pub fn get_name(&self) -> &Option<String>

The name of the execution.

pub fn input(self, input: impl Into<String>) -> Self

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.

pub fn set_input(self, input: Option<String>) -> Self

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.

pub fn get_input(&self) -> &Option<String>

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.

pub fn trace_header(self, input: impl Into<String>) -> Self

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.

pub fn set_trace_header(self, input: Option<String>) -> Self

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.

pub fn get_trace_header(&self) -> &Option<String>

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.

pub fn included_data(self, input: IncludedData) -> Self

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.

pub fn set_included_data(self, input: Option<IncludedData>) -> Self

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.

pub fn get_included_data(&self) -> &Option<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.

Trait Implementations

impl Clone for StartSyncExecutionFluentBuilder

fn clone(&self) -> StartSyncExecutionFluentBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StartSyncExecutionFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.