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

Instance Attribute Summary collapse

Instance Attribute Details

#creation_dateTime

The date the state machine is created.

Returns:

  • (Time)

    The date the state machine is created.

#definitionString

The Amazon States Language definition of the state machine.

Returns:

  • (String)

    The Amazon States Language definition of the state machine.

#nameString

The name of the state machine.

A name must not contain:

  • whitespace

  • brackets < > { } [ ]

  • wildcard characters ? *

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

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

Returns:

  • (String)

    The name of the state machine.

#role_arnString

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_arnString

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

Returns:

  • (String)

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

#statusString

The current status of the state machine.

Possible values:

  • ACTIVE
  • DELETING

Returns:

  • (String)

    The current status of the state machine.