You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::States::Types::DescribeStateMachineOutput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#creation_date ⇒ Time

The date the state machine is created.

Returns:

  • (Time) —

    The date the state machine is created.

#definition ⇒ String

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

Returns:

  • (String) —

    The Amazon States Language definition of the state machine.

#logging_configuration ⇒ Types::LoggingConfiguration

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

Returns:

#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)

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

Returns:

  • (String) —

    The name of the state machine.

#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 AWS resources.)

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the IAM role used when creating this state machine.

#state_machine_arn ⇒ String

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

Returns:

  • (String) —

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

#status ⇒ String

The current status of the state machine.

Possible values:

  • ACTIVE
  • DELETING

Returns:

  • (String) —

    The current status of the state machine.

#tracing_configuration ⇒ Types::TracingConfiguration

Selects whether AWS X-Ray tracing is enabled.

Returns:

#type ⇒ String

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

Possible values:

  • STANDARD
  • EXPRESS

Returns:

  • (String) —

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