Struct StateExitedEventDetails

#[non_exhaustive]
pub struct StateExitedEventDetails {
    pub name: String,
    pub output: Option<String>,
    pub output_details: Option<HistoryEventExecutionDataDetails>,
    pub assigned_variables: Option<HashMap<String, String>>,
    pub assigned_variables_details: Option<AssignedVariablesDetails>,
}

Contains details about an exit from a state during an execution.

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.

name: String

The name of the state.

A name must not contain:

• white space

• brackets < > { } \[ \]

• wildcard characters ? *

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

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

• surrogates (U+D800-DFFF)

• invalid characters ( U+10FFFF)

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

output: Option<String>

The JSON output data of the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

output_details: Option<HistoryEventExecutionDataDetails>

Contains details about the output of an execution history event.

assigned_variables: Option<HashMap<String, String>>

Map of variable name and value as a serialized JSON representation.

assigned_variables_details: Option<AssignedVariablesDetails>

Provides details about input or output in an execution history event.

Implementations

impl StateExitedEventDetails

pub fn name(&self) -> &str

The name of the state.

A name must not contain:

• white space

• brackets < > { } \[ \]

• wildcard characters ? *

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

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

• surrogates (U+D800-DFFF)

• invalid characters ( U+10FFFF)

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

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

The JSON output data of the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

pub fn output_details(&self) -> Option<&HistoryEventExecutionDataDetails>

Contains details about the output of an execution history event.

pub fn assigned_variables(&self) -> Option<&HashMap<String, String>>

Map of variable name and value as a serialized JSON representation.

pub fn assigned_variables_details(&self) -> Option<&AssignedVariablesDetails>

Provides details about input or output in an execution history event.

impl StateExitedEventDetails

pub fn builder() -> StateExitedEventDetailsBuilder

Creates a new builder-style object to manufacture StateExitedEventDetails.

Trait Implementations

impl Clone for StateExitedEventDetails

fn clone(&self) -> StateExitedEventDetails

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StateExitedEventDetails

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

Formats the value using the given formatter.

impl PartialEq for StateExitedEventDetails

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