Struct TestStateInput 

#[non_exhaustive]
pub struct TestStateInput {
    pub definition: Option<String>,
    pub role_arn: Option<String>,
    pub input: Option<String>,
    pub inspection_level: Option<InspectionLevel>,
    pub reveal_secrets: Option<bool>,
    pub variables: 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.

definition: Option<String>

The Amazon States Language (ASL) definition of the state.

role_arn: Option<String>

The Amazon Resource Name (ARN) of the execution role with the required IAM permissions for the state.

input: Option<String>

A string that contains the JSON input data for the state.

inspection_level: Option<InspectionLevel>

Determines the values to return when a state is tested. You can specify one of the following types:

• INFO: Shows the final state output. By default, Step Functions sets inspectionLevel to INFO if you don't specify a level.

• DEBUG: Shows the final state output along with the input and output data processing result.

• TRACE: Shows the HTTP request and response for an HTTP Task. This level also shows the final state output along with the input and output data processing result.

Each of these levels also provide information about the status of the state execution and the next state to transition to.

reveal_secrets: Option<bool>

Specifies whether or not to include secret information in the test result. For HTTP Tasks, a secret includes the data that an EventBridge connection adds to modify the HTTP request headers, query parameters, and body. Step Functions doesn't omit any information included in the state definition or the HTTP response.

If you set revealSecrets to true, you must make sure that the IAM user that calls the TestState API has permission for the states:RevealSecrets action. For an example of IAM policy that sets the states:RevealSecrets permission, see IAM permissions to test a state. Without this permission, Step Functions throws an access denied error.

By default, revealSecrets is set to false.

variables: Option<String>

JSON object literal that sets variables used in the state under test. Object keys are the variable names and values are the variable values.

Implementations

impl TestStateInput

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

The Amazon States Language (ASL) definition of the state.

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

The Amazon Resource Name (ARN) of the execution role with the required IAM permissions for the state.

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

A string that contains the JSON input data for the state.

pub fn inspection_level(&self) -> Option<&InspectionLevel>

Determines the values to return when a state is tested. You can specify one of the following types:

• INFO: Shows the final state output. By default, Step Functions sets inspectionLevel to INFO if you don't specify a level.

• DEBUG: Shows the final state output along with the input and output data processing result.

• TRACE: Shows the HTTP request and response for an HTTP Task. This level also shows the final state output along with the input and output data processing result.

Each of these levels also provide information about the status of the state execution and the next state to transition to.

pub fn reveal_secrets(&self) -> Option<bool>

Specifies whether or not to include secret information in the test result. For HTTP Tasks, a secret includes the data that an EventBridge connection adds to modify the HTTP request headers, query parameters, and body. Step Functions doesn't omit any information included in the state definition or the HTTP response.

If you set revealSecrets to true, you must make sure that the IAM user that calls the TestState API has permission for the states:RevealSecrets action. For an example of IAM policy that sets the states:RevealSecrets permission, see IAM permissions to test a state. Without this permission, Step Functions throws an access denied error.

By default, revealSecrets is set to false.

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

JSON object literal that sets variables used in the state under test. Object keys are the variable names and values are the variable values.

impl TestStateInput

pub fn builder() -> TestStateInputBuilder

Creates a new builder-style object to manufacture TestStateInput.

Trait Implementations

impl Clone for TestStateInput

fn clone(&self) -> TestStateInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TestStateInput

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

Formats the value using the given formatter.

impl PartialEq for TestStateInput

fn eq(&self, other: &TestStateInput) -> 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 TestStateInput