Amazonka.StepFunctions.DescribeStateMachine

Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration. If the state machine ARN is a qualified state machine ARN, the response returned includes the Map state's label.

A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

Creating a Request

data DescribeStateMachine

See: newDescribeStateMachine smart constructor.

Constructors

DescribeStateMachine'

Fields

• stateMachineArn :: Text

  The Amazon Resource Name (ARN) of the state machine to describe.

Instances

ToJSON DescribeStateMachine

Defined in Amazonka.StepFunctions.DescribeStateMachine

Methods

toJSON :: DescribeStateMachine -> Value

toEncoding :: DescribeStateMachine -> Encoding

toJSONList :: [DescribeStateMachine] -> Value

toEncodingList :: [DescribeStateMachine] -> Encoding

ToHeaders DescribeStateMachine

Defined in Amazonka.StepFunctions.DescribeStateMachine

Methods

toHeaders :: DescribeStateMachine -> [Header]

ToPath DescribeStateMachine

Defined in Amazonka.StepFunctions.DescribeStateMachine

Methods

toPath :: DescribeStateMachine -> ByteString

ToQuery DescribeStateMachine

Defined in Amazonka.StepFunctions.DescribeStateMachine

Methods

toQuery :: DescribeStateMachine -> QueryString

AWSRequest DescribeStateMachine

Defined in Amazonka.StepFunctions.DescribeStateMachine

Associated Types

type AWSResponse DescribeStateMachine

Methods

request :: (Service -> Service) -> DescribeStateMachine -> Request DescribeStateMachine

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeStateMachine -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeStateMachine)))

Generic DescribeStateMachine

Defined in Amazonka.StepFunctions.DescribeStateMachine

Associated Types

type Rep DescribeStateMachine :: Type -> Type

Methods

from :: DescribeStateMachine -> Rep DescribeStateMachine x

to :: Rep DescribeStateMachine x -> DescribeStateMachine

Read DescribeStateMachine

Defined in Amazonka.StepFunctions.DescribeStateMachine

Methods

readsPrec :: Int -> ReadS DescribeStateMachine

readList :: ReadS [DescribeStateMachine]

readPrec :: ReadPrec DescribeStateMachine

readListPrec :: ReadPrec [DescribeStateMachine]

Show DescribeStateMachine

Defined in Amazonka.StepFunctions.DescribeStateMachine

Methods

showsPrec :: Int -> DescribeStateMachine -> ShowS

show :: DescribeStateMachine -> String

showList :: [DescribeStateMachine] -> ShowS

NFData DescribeStateMachine

Defined in Amazonka.StepFunctions.DescribeStateMachine

Methods

rnf :: DescribeStateMachine -> ()

Eq DescribeStateMachine

Defined in Amazonka.StepFunctions.DescribeStateMachine

Methods

(==) :: DescribeStateMachine -> DescribeStateMachine -> Bool

(/=) :: DescribeStateMachine -> DescribeStateMachine -> Bool

Hashable DescribeStateMachine

Defined in Amazonka.StepFunctions.DescribeStateMachine

Methods

hashWithSalt :: Int -> DescribeStateMachine -> Int

hash :: DescribeStateMachine -> Int

type AWSResponse DescribeStateMachine

Defined in Amazonka.StepFunctions.DescribeStateMachine

type AWSResponse DescribeStateMachine = DescribeStateMachineResponse

type Rep DescribeStateMachine

Defined in Amazonka.StepFunctions.DescribeStateMachine

type Rep DescribeStateMachine = D1 ('MetaData "DescribeStateMachine" "Amazonka.StepFunctions.DescribeStateMachine" "amazonka-stepfunctions-2.0-K6z2kqboJVbL1MZX8DUt0f" 'False) (C1 ('MetaCons "DescribeStateMachine'" 'PrefixI 'True) (S1 ('MetaSel ('Just "stateMachineArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeStateMachine

Arguments

:: Text

DescribeStateMachine

-> DescribeStateMachine

Create a value of DescribeStateMachine with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeStateMachine, describeStateMachine_stateMachineArn - The Amazon Resource Name (ARN) of the state machine to describe.

Request Lenses

describeStateMachine_stateMachineArn :: Lens' DescribeStateMachine Text

The Amazon Resource Name (ARN) of the state machine to describe.

Destructuring the Response

data DescribeStateMachineResponse

See: newDescribeStateMachineResponse smart constructor.

Constructors

DescribeStateMachineResponse'

Fields

• label :: Maybe Text

  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.

• loggingConfiguration :: Maybe LoggingConfiguration
• status :: Maybe StateMachineStatus

  The current status of the state machine.

• tracingConfiguration :: Maybe TracingConfiguration

  Selects whether X-Ray tracing is enabled.

• httpStatus :: Int

  The response's http status code.

• stateMachineArn :: Text

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

• name :: Text

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

• definition :: Sensitive Text

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

• roleArn :: Text

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

• creationDate :: POSIX

  The date the state machine is created.

Instances

Generic DescribeStateMachineResponse

Defined in Amazonka.StepFunctions.DescribeStateMachine

Associated Types

type Rep DescribeStateMachineResponse :: Type -> Type

Methods

from :: DescribeStateMachineResponse -> Rep DescribeStateMachineResponse x

to :: Rep DescribeStateMachineResponse x -> DescribeStateMachineResponse

Show DescribeStateMachineResponse

Defined in Amazonka.StepFunctions.DescribeStateMachine

Methods

showsPrec :: Int -> DescribeStateMachineResponse -> ShowS

show :: DescribeStateMachineResponse -> String

showList :: [DescribeStateMachineResponse] -> ShowS

NFData DescribeStateMachineResponse

Defined in Amazonka.StepFunctions.DescribeStateMachine

Methods

rnf :: DescribeStateMachineResponse -> ()

Eq DescribeStateMachineResponse

Defined in Amazonka.StepFunctions.DescribeStateMachine

Methods

(==) :: DescribeStateMachineResponse -> DescribeStateMachineResponse -> Bool

(/=) :: DescribeStateMachineResponse -> DescribeStateMachineResponse -> Bool

type Rep DescribeStateMachineResponse

Defined in Amazonka.StepFunctions.DescribeStateMachine

type Rep DescribeStateMachineResponse = D1 ('MetaData "DescribeStateMachineResponse" "Amazonka.StepFunctions.DescribeStateMachine" "amazonka-stepfunctions-2.0-K6z2kqboJVbL1MZX8DUt0f" 'False) (C1 ('MetaCons "DescribeStateMachineResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "label") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "loggingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LoggingConfiguration))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StateMachineStatus)) :*: (S1 ('MetaSel ('Just "tracingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TracingConfiguration)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))) :*: ((S1 ('MetaSel ('Just "stateMachineArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "definition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)))) :*: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 StateMachineType) :*: S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))))))

newDescribeStateMachineResponse

Arguments

:: Int

$sel:httpStatus:DescribeStateMachineResponse'

-> Text

DescribeStateMachine

-> Text

DescribeStateMachineResponse

-> Text

$sel:definition:DescribeStateMachineResponse'

-> Text

DescribeStateMachineResponse

-> StateMachineType

DescribeStateMachineResponse

-> UTCTime

DescribeStateMachineResponse

-> DescribeStateMachineResponse

Create a value of DescribeStateMachineResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:label:DescribeStateMachineResponse', describeStateMachineResponse_label - 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.

$sel:loggingConfiguration:DescribeStateMachineResponse', describeStateMachineResponse_loggingConfiguration - Undocumented member.

DescribeStateMachineResponse, describeStateMachineResponse_status - The current status of the state machine.

$sel:tracingConfiguration:DescribeStateMachineResponse', describeStateMachineResponse_tracingConfiguration - Selects whether X-Ray tracing is enabled.

$sel:httpStatus:DescribeStateMachineResponse', describeStateMachineResponse_httpStatus - The response's http status code.

DescribeStateMachine, describeStateMachineResponse_stateMachineArn - The Amazon Resource Name (ARN) that identifies the state machine.

DescribeStateMachineResponse, describeStateMachineResponse_name - 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 _.

$sel:definition:DescribeStateMachineResponse', describeStateMachineResponse_definition - The Amazon States Language definition of the state machine. See Amazon States Language.

DescribeStateMachineResponse, describeStateMachineResponse_roleArn - 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.)

DescribeStateMachineResponse, describeStateMachineResponse_type - The type of the state machine (STANDARD or EXPRESS).

DescribeStateMachineResponse, describeStateMachineResponse_creationDate - The date the state machine is created.

Response Lenses

describeStateMachineResponse_label :: Lens' DescribeStateMachineResponse (Maybe Text)

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.

describeStateMachineResponse_loggingConfiguration :: Lens' DescribeStateMachineResponse (Maybe LoggingConfiguration)

Undocumented member.

describeStateMachineResponse_status :: Lens' DescribeStateMachineResponse (Maybe StateMachineStatus)

The current status of the state machine.

describeStateMachineResponse_tracingConfiguration :: Lens' DescribeStateMachineResponse (Maybe TracingConfiguration)

Selects whether X-Ray tracing is enabled.

describeStateMachineResponse_httpStatus :: Lens' DescribeStateMachineResponse Int

The response's http status code.

describeStateMachineResponse_stateMachineArn :: Lens' DescribeStateMachineResponse Text

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

describeStateMachineResponse_name :: Lens' DescribeStateMachineResponse Text

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

describeStateMachineResponse_definition :: Lens' DescribeStateMachineResponse Text

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

describeStateMachineResponse_roleArn :: Lens' DescribeStateMachineResponse Text

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

describeStateMachineResponse_type :: Lens' DescribeStateMachineResponse StateMachineType

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

describeStateMachineResponse_creationDate :: Lens' DescribeStateMachineResponse UTCTime

The date the state machine is created.