Struct aws_sdk_sfn::operation::start_execution::builders::StartExecutionInputBuilder

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

A builder for StartExecutionInput.

Implementations

impl StartExecutionInputBuilder

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

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

The stateMachineArn parameter accepts one of the following inputs:

• An unqualified state machine ARN – Refers to a state machine ARN that isn't qualified with a version or alias ARN. The following is an example of an unqualified state machine ARN.

  arn: :states: : :stateMachine:

  Step Functions doesn't associate state machine executions that you start with an unqualified ARN with a version. This is true even if that version uses the same revision that the execution used.

• A state machine version ARN – Refers to a version ARN, which is a combination of state machine ARN and the version number separated by a colon (:). The following is an example of the ARN for version 10.

  arn: :states: : :stateMachine: :10

  Step Functions doesn't associate executions that you start with a version ARN with any aliases that point to that version.

• A state machine alias ARN – Refers to an alias ARN, which is a combination of state machine ARN and the alias name separated by a colon (:). The following is an example of the ARN for an alias named PROD.

  arn: :states: : :stateMachine:

  Step Functions associates executions that you start with an alias ARN with that alias and the state machine version used for that execution.

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.

The stateMachineArn parameter accepts one of the following inputs:

• An unqualified state machine ARN – Refers to a state machine ARN that isn't qualified with a version or alias ARN. The following is an example of an unqualified state machine ARN.

  arn: :states: : :stateMachine:

  Step Functions doesn't associate state machine executions that you start with an unqualified ARN with a version. This is true even if that version uses the same revision that the execution used.

• A state machine version ARN – Refers to a version ARN, which is a combination of state machine ARN and the version number separated by a colon (:). The following is an example of the ARN for version 10.

  arn: :states: : :stateMachine: :10

  Step Functions doesn't associate executions that you start with a version ARN with any aliases that point to that version.

• A state machine alias ARN – Refers to an alias ARN, which is a combination of state machine ARN and the alias name separated by a colon (:). The following is an example of the ARN for an alias named PROD.

  arn: :states: : :stateMachine:

  Step Functions associates executions that you start with an alias ARN with that alias and the state machine version used for that execution.

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

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

The stateMachineArn parameter accepts one of the following inputs:

• An unqualified state machine ARN – Refers to a state machine ARN that isn't qualified with a version or alias ARN. The following is an example of an unqualified state machine ARN.

  arn: :states: : :stateMachine:

  Step Functions doesn't associate state machine executions that you start with an unqualified ARN with a version. This is true even if that version uses the same revision that the execution used.

• A state machine version ARN – Refers to a version ARN, which is a combination of state machine ARN and the version number separated by a colon (:). The following is an example of the ARN for version 10.

  arn: :states: : :stateMachine: :10

  Step Functions doesn't associate executions that you start with a version ARN with any aliases that point to that version.

• A state machine alias ARN – Refers to an alias ARN, which is a combination of state machine ARN and the alias name separated by a colon (:). The following is an example of the ARN for an alias named PROD.

  arn: :states: : :stateMachine:

  Step Functions associates executions that you start with an alias ARN with that alias and the state machine version used for that execution.

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

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

If you don't provide a name for the execution, Step Functions automatically generates a universally unique identifier (UUID) as the execution name.

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

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

If you don't provide a name for the execution, Step Functions automatically generates a universally unique identifier (UUID) as the execution name.

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 get_name(&self) -> &Option<String>

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

If you don't provide a name for the execution, Step Functions automatically generates a universally unique identifier (UUID) as the execution name.

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 get_input(&self) -> &Option<String>

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

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.

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

Consumes the builder and constructs a StartExecutionInput.

impl StartExecutionInputBuilder

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

Sends a request with this input using the given client.

Trait Implementations

impl Clone for StartExecutionInputBuilder

fn clone(&self) -> StartExecutionInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartExecutionInputBuilder

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

Formats the value using the given formatter.

impl Default for StartExecutionInputBuilder

fn default() -> StartExecutionInputBuilder

Returns the “default value” for a type.

impl PartialEq for StartExecutionInputBuilder

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for StartExecutionInputBuilder