Struct aws_sdk_sfn::client::fluent_builders::StartExecution

pub struct StartExecution { /* private fields */ }

Fluent builder constructing a request to StartExecution.

Starts a state machine execution.

StartExecution is idempotent. If StartExecution is called with the same name and input as a running execution, the call will succeed and return the same response as the original request. If the execution is closed or if the input is different, it will return a 400 ExecutionAlreadyExists error. Names can be reused after 90 days.

Implementations

impl StartExecution

pub async fn send(
    self
) -> Result<StartExecutionOutput, SdkError<StartExecutionError>>

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 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 name(self, input: impl Into<String>) -> Self

The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.

A name must not contain:

• white space

• brackets < > { } [ ]

• wildcard characters ? *

• special characters " # % \ ^ | ~ ` $ & , ; : /

• control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

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

The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.

A name must not contain:

• white space

• brackets < > { } [ ]

• wildcard characters ? *

• special characters " # % \ ^ | ~ ` $ & , ; : /

• control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

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

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

"input": "{\"first_name\" : \"test\"}"

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

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:

"input": "{\"first_name\" : \"test\"}"

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

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 AWS X-Ray trace header. The trace header can also be passed in the request payload.

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

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

Trait Implementations

impl Clone for StartExecution

fn clone(&self) -> StartExecution

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartExecution

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

Formats the value using the given formatter.