Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.StepFunctions.DescribeStateMachine

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes a state machine.

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

Synopsis

Creating a Request

data DescribeStateMachine Source #

See: newDescribeStateMachine smart constructor.

Constructors

DescribeStateMachine'
Fields stateMachineArn :: Text The Amazon Resource Name (ARN) of the state machine to describe.

Instances

Instances details

Eq DescribeStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.DescribeStateMachine Methods (==) :: DescribeStateMachine -> DescribeStateMachine -> Bool # (/=) :: DescribeStateMachine -> DescribeStateMachine -> Bool #
Read DescribeStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.DescribeStateMachine Methods readsPrec :: Int -> ReadS DescribeStateMachine # readList :: ReadS [DescribeStateMachine] # readPrec :: ReadPrec DescribeStateMachine # readListPrec :: ReadPrec [DescribeStateMachine] #
Show DescribeStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.DescribeStateMachine Methods showsPrec :: Int -> DescribeStateMachine -> ShowS # show :: DescribeStateMachine -> String # showList :: [DescribeStateMachine] -> ShowS #
Generic DescribeStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.DescribeStateMachine Associated Types type Rep DescribeStateMachine :: Type -> Type # Methods from :: DescribeStateMachine -> Rep DescribeStateMachine x # to :: Rep DescribeStateMachine x -> DescribeStateMachine #
NFData DescribeStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.DescribeStateMachine Methods rnf :: DescribeStateMachine -> () #
Hashable DescribeStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.DescribeStateMachine Methods hashWithSalt :: Int -> DescribeStateMachine -> Int # hash :: DescribeStateMachine -> Int #
ToJSON DescribeStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.DescribeStateMachine Methods toJSON :: DescribeStateMachine -> Value # toEncoding :: DescribeStateMachine -> Encoding # toJSONList :: [DescribeStateMachine] -> Value # toEncodingList :: [DescribeStateMachine] -> Encoding #
AWSRequest DescribeStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.DescribeStateMachine Associated Types type AWSResponse DescribeStateMachine # Methods request :: DescribeStateMachine -> Request DescribeStateMachine # response :: MonadResource m => Logger -> Service -> Proxy DescribeStateMachine -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeStateMachine))) #
ToHeaders DescribeStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.DescribeStateMachine Methods toHeaders :: DescribeStateMachine -> [Header] #
ToPath DescribeStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.DescribeStateMachine Methods toPath :: DescribeStateMachine -> ByteString #
ToQuery DescribeStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.DescribeStateMachine Methods toQuery :: DescribeStateMachine -> QueryString #
type Rep DescribeStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.DescribeStateMachine type Rep DescribeStateMachine = D1 ('MetaData "DescribeStateMachine" "Amazonka.StepFunctions.DescribeStateMachine" "libZSservicesZSamazonka-stepfunctionsZSamazonka-stepfunctions" 'False) (C1 ('MetaCons "DescribeStateMachine'" 'PrefixI 'True) (S1 ('MetaSel ('Just "stateMachineArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.DescribeStateMachine type AWSResponse DescribeStateMachine = DescribeStateMachineResponse

newDescribeStateMachine Source #

Arguments

:: Text	`$sel:stateMachineArn: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:

$sel:stateMachineArn:DescribeStateMachine', describeStateMachine_stateMachineArn - The Amazon Resource Name (ARN) of the state machine to describe.

Request Lenses

describeStateMachine_stateMachineArn :: Lens' DescribeStateMachine Text Source #

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

Destructuring the Response

data DescribeStateMachineResponse Source #

See: newDescribeStateMachineResponse smart constructor.

Constructors

DescribeStateMachineResponse'

Fields

status :: Maybe StateMachineStatus
The current status of the state machine.
tracingConfiguration :: Maybe TracingConfiguration
Selects whether AWS X-Ray tracing is enabled.
loggingConfiguration :: Maybe LoggingConfiguration
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 AWS resources.)
type' :: StateMachineType
The type of the state machine (STANDARD or EXPRESS).
creationDate :: POSIX
The date the state machine is created.

Instances

Instances details

Eq DescribeStateMachineResponse Source #
Instance details Defined in Amazonka.StepFunctions.DescribeStateMachine Methods (==) :: DescribeStateMachineResponse -> DescribeStateMachineResponse -> Bool # (/=) :: DescribeStateMachineResponse -> DescribeStateMachineResponse -> Bool #
Show DescribeStateMachineResponse Source #
Instance details Defined in Amazonka.StepFunctions.DescribeStateMachine Methods showsPrec :: Int -> DescribeStateMachineResponse -> ShowS # show :: DescribeStateMachineResponse -> String # showList :: [DescribeStateMachineResponse] -> ShowS #
Generic DescribeStateMachineResponse Source #
Instance details Defined in Amazonka.StepFunctions.DescribeStateMachine Associated Types type Rep DescribeStateMachineResponse :: Type -> Type # Methods from :: DescribeStateMachineResponse -> Rep DescribeStateMachineResponse x # to :: Rep DescribeStateMachineResponse x -> DescribeStateMachineResponse #
NFData DescribeStateMachineResponse Source #
Instance details Defined in Amazonka.StepFunctions.DescribeStateMachine Methods rnf :: DescribeStateMachineResponse -> () #
type Rep DescribeStateMachineResponse Source #
Instance details Defined in Amazonka.StepFunctions.DescribeStateMachine type Rep DescribeStateMachineResponse = D1 ('MetaData "DescribeStateMachineResponse" "Amazonka.StepFunctions.DescribeStateMachine" "libZSservicesZSamazonka-stepfunctionsZSamazonka-stepfunctions" 'False) (C1 ('MetaCons "DescribeStateMachineResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StateMachineStatus)) :: S1 ('MetaSel ('Just "tracingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TracingConfiguration))) :: (S1 ('MetaSel ('Just "loggingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LoggingConfiguration)) :: (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 Source #

Arguments

:: Int	`$sel:httpStatus:DescribeStateMachineResponse'`
-> Text	`$sel:stateMachineArn:DescribeStateMachine'`
-> Text	`$sel:name:DescribeStateMachineResponse'`
-> Text	`$sel:definition:DescribeStateMachineResponse'`
-> Text	`$sel:roleArn:DescribeStateMachineResponse'`
-> StateMachineType	`$sel:type':DescribeStateMachineResponse'`
-> UTCTime	`$sel:creationDate: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:status:DescribeStateMachineResponse', describeStateMachineResponse_status - The current status of the state machine.

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

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

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

$sel:stateMachineArn:DescribeStateMachine', describeStateMachineResponse_stateMachineArn - The Amazon Resource Name (ARN) that identifies the state machine.

$sel:name: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.

$sel:roleArn: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 AWS resources.)

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

$sel:creationDate:DescribeStateMachineResponse', describeStateMachineResponse_creationDate - The date the state machine is created.

Response Lenses

describeStateMachineResponse_status :: Lens' DescribeStateMachineResponse (Maybe StateMachineStatus) Source #

The current status of the state machine.

describeStateMachineResponse_tracingConfiguration :: Lens' DescribeStateMachineResponse (Maybe TracingConfiguration) Source #

Selects whether AWS X-Ray tracing is enabled.

describeStateMachineResponse_loggingConfiguration :: Lens' DescribeStateMachineResponse (Maybe LoggingConfiguration) Source #

Undocumented member.

describeStateMachineResponse_httpStatus :: Lens' DescribeStateMachineResponse Int Source #

The response's http status code.

describeStateMachineResponse_stateMachineArn :: Lens' DescribeStateMachineResponse Text Source #

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

describeStateMachineResponse_name :: Lens' DescribeStateMachineResponse Text Source #

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

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

describeStateMachineResponse_roleArn :: Lens' DescribeStateMachineResponse Text Source #

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

describeStateMachineResponse_type :: Lens' DescribeStateMachineResponse StateMachineType Source #

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

describeStateMachineResponse_creationDate :: Lens' DescribeStateMachineResponse UTCTime Source #

The date the state machine is created.