Struct StartSyncExecutionInputBuilder 

#[non_exhaustive]
pub struct StartSyncExecutionInputBuilder { /* private fields */ }

A builder for StartSyncExecutionInput.

Implementations

impl StartSyncExecutionInputBuilder

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

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

This field is required.

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.

pub fn build(self) -> Result<StartSyncExecutionInput, BuildError>

Consumes the builder and constructs a StartSyncExecutionInput.

impl StartSyncExecutionInputBuilder

pub async fn send_with( self, client: &Client, ) -> Result<StartSyncExecutionOutput, SdkError<StartSyncExecutionError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for StartSyncExecutionInputBuilder

fn clone(&self) -> StartSyncExecutionInputBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StartSyncExecutionInputBuilder

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

Formats the value using the given formatter.

impl Default for StartSyncExecutionInputBuilder

fn default() -> StartSyncExecutionInputBuilder

Returns the “default value” for a type.

impl PartialEq for StartSyncExecutionInputBuilder

fn eq(&self, other: &StartSyncExecutionInputBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StartSyncExecutionInputBuilder