Struct aws_sdk_sfn::output::DescribeStateMachineOutput

#[non_exhaustive]
pub struct DescribeStateMachineOutput {
    pub state_machine_arn: Option<String>,
    pub name: Option<String>,
    pub status: Option<StateMachineStatus>,
    pub definition: Option<String>,
    pub role_arn: Option<String>,
    pub type: Option<StateMachineType>,
    pub creation_date: Option<DateTime>,
    pub logging_configuration: Option<LoggingConfiguration>,
    pub tracing_configuration: Option<TracingConfiguration>,
}

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) that identifies the state machine.

name: Option<String>

The name of the state machine.

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

status: Option<StateMachineStatus>

The current status of the state machine.

definition: Option<String>

The Amazon States Language definition of the state machine. See Amazon States Language.

role_arn: Option<String>

The Amazon Resource Name (ARN) of the IAM role used when creating this state machine. (The IAM role maintains security by granting Step Functions access to AWS resources.)

type: Option<StateMachineType>

The type of the state machine (STANDARD or EXPRESS).

creation_date: Option<DateTime>

The date the state machine is created.

logging_configuration: Option<LoggingConfiguration>

The LoggingConfiguration data type is used to set CloudWatch Logs options.

tracing_configuration: Option<TracingConfiguration>

Selects whether AWS X-Ray tracing is enabled.

Implementations

impl DescribeStateMachineOutput

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

The Amazon Resource Name (ARN) that identifies the state machine.

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

The name of the state machine.

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 status(&self) -> Option<&StateMachineStatus>

The current status of the state machine.

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

The Amazon States Language definition of the state machine. See Amazon States Language.

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

The Amazon Resource Name (ARN) of the IAM role used when creating this state machine. (The IAM role maintains security by granting Step Functions access to AWS resources.)

pub fn type(&self) -> Option<&StateMachineType>

The type of the state machine (STANDARD or EXPRESS).

pub fn creation_date(&self) -> Option<&DateTime>

The date the state machine is created.

pub fn logging_configuration(&self) -> Option<&LoggingConfiguration>

The LoggingConfiguration data type is used to set CloudWatch Logs options.

pub fn tracing_configuration(&self) -> Option<&TracingConfiguration>

Selects whether AWS X-Ray tracing is enabled.

impl DescribeStateMachineOutput

pub fn builder() -> Builder

Creates a new builder-style object to manufacture DescribeStateMachineOutput

Trait Implementations

impl Clone for DescribeStateMachineOutput

fn clone(&self) -> DescribeStateMachineOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeStateMachineOutput

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

Formats the value using the given formatter.

impl PartialEq<DescribeStateMachineOutput> for DescribeStateMachineOutput

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

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

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

This method tests for !=.

impl StructuralPartialEq for DescribeStateMachineOutput