Struct DescribeStateMachineOutput 

#[non_exhaustive]
pub struct DescribeStateMachineOutput {

    pub state_machine_arn: String,
    pub name: String,
    pub status: Option<StateMachineStatus>,
    pub definition: String,
    pub role_arn: String,
    pub type: StateMachineType,
    pub creation_date: DateTime,
    pub logging_configuration: Option<LoggingConfiguration>,
    pub tracing_configuration: Option<TracingConfiguration>,
    pub label: Option<String>,
    pub revision_id: Option<String>,
    pub description: Option<String>,
    pub encryption_configuration: Option<EncryptionConfiguration>,
    pub variable_references: Option<HashMap<String, Vec<String>>>,
    /* private fields */
}

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: String

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

If you specified a state machine version ARN in your request, the API returns the version ARN. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.

name: 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, 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 _.

status: Option<StateMachineStatus>

The current status of the state machine.

definition: String

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

If called with includedData = METADATA_ONLY, the returned definition will be {}.

role_arn: 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 Amazon Web Services resources.)

type: StateMachineType

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

creation_date: DateTime

The date the state machine is created.

For a state machine version, creationDate is the date the version was created.

logging_configuration: Option<LoggingConfiguration>

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

tracing_configuration: Option<TracingConfiguration>

Selects whether X-Ray tracing is enabled.

label: Option<String>

A user-defined or an auto-generated string that identifies a Map state. This parameter is present only if the stateMachineArn specified in input is a qualified state machine ARN.

revision_id: Option<String>

The revision identifier for the state machine.

Use the revisionId parameter to compare between versions of a state machine configuration used for executions without performing a diff of the properties, such as definition and roleArn.

description: Option<String>

The description of the state machine version.

encryption_configuration: Option<EncryptionConfiguration>

Settings to configure server-side encryption.

variable_references: Option<HashMap<String, Vec<String>>>

A map of state name to a list of variables referenced by that state. States that do not use variable references will not be shown in the response.

Implementations

impl DescribeStateMachineOutput

pub fn state_machine_arn(&self) -> &str

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

If you specified a state machine version ARN in your request, the API returns the version ARN. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.

pub fn name(&self) -> &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, 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 status(&self) -> Option<&StateMachineStatus>

The current status of the state machine.

pub fn definition(&self) -> &str

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

If called with includedData = METADATA_ONLY, the returned definition will be {}.

pub fn role_arn(&self) -> &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 Amazon Web Services resources.)

pub fn type(&self) -> &StateMachineType

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

pub fn creation_date(&self) -> &DateTime

The date the state machine is created.

For a state machine version, creationDate is the date the version was 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 X-Ray tracing is enabled.

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

A user-defined or an auto-generated string that identifies a Map state. This parameter is present only if the stateMachineArn specified in input is a qualified state machine ARN.

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

The revision identifier for the state machine.

Use the revisionId parameter to compare between versions of a state machine configuration used for executions without performing a diff of the properties, such as definition and roleArn.

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

The description of the state machine version.

pub fn encryption_configuration(&self) -> Option<&EncryptionConfiguration>

Settings to configure server-side encryption.

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

A map of state name to a list of variables referenced by that state. States that do not use variable references will not be shown in the response.

impl DescribeStateMachineOutput

pub fn builder() -> DescribeStateMachineOutputBuilder

Creates a new builder-style object to manufacture DescribeStateMachineOutput.

Trait Implementations

impl Clone for DescribeStateMachineOutput

fn clone(&self) -> DescribeStateMachineOutput

Returns a duplicate 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 for DescribeStateMachineOutput

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

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for DescribeStateMachineOutput