Struct aws_sdk_sfn::input::StartExecutionInput

#[non_exhaustive]
pub struct StartExecutionInput {
    pub state_machine_arn: Option<String>,
    pub name: Option<String>,
    pub input: Option<String>,
    pub trace_header: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

state_machine_arn: Option<String>

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

name: Option<String>

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 _.

input: 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.

trace_header: Option<String>

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

Implementations

impl StartExecutionInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<StartExecution, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<StartExecution>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture StartExecutionInput

impl StartExecutionInput

pub fn state_machine_arn(&self) -> Option<&str>

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

pub fn name(&self) -> Option<&str>

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) -> Option<&str>

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) -> Option<&str>

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

Trait Implementations

impl Clone for StartExecutionInput

fn clone(&self) -> StartExecutionInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartExecutionInput

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

Formats the value using the given formatter.

impl PartialEq<StartExecutionInput> for StartExecutionInput

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

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

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

This method tests for !=.

impl StructuralPartialEq for StartExecutionInput