Network.AWS.StepFunctions.DescribeStateMachine

Describes a state machine.

Creating a Request

describeStateMachine

Arguments

:: Text

dsmStateMachineARN

-> DescribeStateMachine

Creates a value of DescribeStateMachine with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

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

data DescribeStateMachine

See: describeStateMachine smart constructor.

Instances

Eq DescribeStateMachine

Defined in Network.AWS.StepFunctions.DescribeStateMachine

Methods

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

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

Data DescribeStateMachine

Defined in Network.AWS.StepFunctions.DescribeStateMachine

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeStateMachine -> c DescribeStateMachine

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeStateMachine

toConstr :: DescribeStateMachine -> Constr

dataTypeOf :: DescribeStateMachine -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeStateMachine)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeStateMachine)

gmapT :: (forall b. Data b => b -> b) -> DescribeStateMachine -> DescribeStateMachine

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeStateMachine -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeStateMachine -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeStateMachine -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeStateMachine -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeStateMachine -> m DescribeStateMachine

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeStateMachine -> m DescribeStateMachine

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeStateMachine -> m DescribeStateMachine

Read DescribeStateMachine

Defined in Network.AWS.StepFunctions.DescribeStateMachine

Methods

readsPrec :: Int -> ReadS DescribeStateMachine

readList :: ReadS [DescribeStateMachine]

readPrec :: ReadPrec DescribeStateMachine

readListPrec :: ReadPrec [DescribeStateMachine]

Show DescribeStateMachine

Defined in Network.AWS.StepFunctions.DescribeStateMachine

Methods

showsPrec :: Int -> DescribeStateMachine -> ShowS

show :: DescribeStateMachine -> String

showList :: [DescribeStateMachine] -> ShowS

Generic DescribeStateMachine

Defined in Network.AWS.StepFunctions.DescribeStateMachine

Associated Types

type Rep DescribeStateMachine :: Type -> Type

Methods

from :: DescribeStateMachine -> Rep DescribeStateMachine x

to :: Rep DescribeStateMachine x -> DescribeStateMachine

Hashable DescribeStateMachine

Defined in Network.AWS.StepFunctions.DescribeStateMachine

Methods

hashWithSalt :: Int -> DescribeStateMachine -> Int

hash :: DescribeStateMachine -> Int

ToJSON DescribeStateMachine

Defined in Network.AWS.StepFunctions.DescribeStateMachine

Methods

toJSON :: DescribeStateMachine -> Value

toEncoding :: DescribeStateMachine -> Encoding

toJSONList :: [DescribeStateMachine] -> Value

toEncodingList :: [DescribeStateMachine] -> Encoding

AWSRequest DescribeStateMachine

Defined in Network.AWS.StepFunctions.DescribeStateMachine

Associated Types

type Rs DescribeStateMachine :: Type

Methods

request :: DescribeStateMachine -> Request DescribeStateMachine

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DescribeStateMachine -> ClientResponse -> m (Response DescribeStateMachine)

ToHeaders DescribeStateMachine

Defined in Network.AWS.StepFunctions.DescribeStateMachine

Methods

toHeaders :: DescribeStateMachine -> [Header]

ToPath DescribeStateMachine

Defined in Network.AWS.StepFunctions.DescribeStateMachine

Methods

toPath :: DescribeStateMachine -> ByteString

ToQuery DescribeStateMachine

Defined in Network.AWS.StepFunctions.DescribeStateMachine

Methods

toQuery :: DescribeStateMachine -> QueryString

NFData DescribeStateMachine

Defined in Network.AWS.StepFunctions.DescribeStateMachine

Methods

rnf :: DescribeStateMachine -> ()

type Rep DescribeStateMachine

Defined in Network.AWS.StepFunctions.DescribeStateMachine

type Rep DescribeStateMachine = D1 (MetaData "DescribeStateMachine" "Network.AWS.StepFunctions.DescribeStateMachine" "amazonka-stepfunctions-1.6.1-2PTLha96w99Qwy2XlD0kq" True) (C1 (MetaCons "DescribeStateMachine'" PrefixI True) (S1 (MetaSel (Just "_dsmStateMachineARN") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

type Rs DescribeStateMachine

Defined in Network.AWS.StepFunctions.DescribeStateMachine

type Rs DescribeStateMachine = DescribeStateMachineResponse

Request Lenses

dsmStateMachineARN :: Lens' DescribeStateMachine Text

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

Destructuring the Response

describeStateMachineResponse

Arguments

:: Int

dsmrsResponseStatus

-> Text

dsmrsStateMachineARN

-> Text

dsmrsName

-> Text

dsmrsDefinition

-> Text

dsmrsRoleARN

-> UTCTime

dsmrsCreationDate

-> DescribeStateMachineResponse

Creates a value of DescribeStateMachineResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dsmrsStatus - The current status of the state machine.
• dsmrsResponseStatus - -- | The response status code.
• dsmrsStateMachineARN - The Amazon Resource Name (ARN) that identifies the state machine.
• dsmrsName - 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 )
• dsmrsDefinition - The Amazon States Language definition of the state machine.
• dsmrsRoleARN - 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.)
• dsmrsCreationDate - The date the state machine is created.

data DescribeStateMachineResponse

See: describeStateMachineResponse smart constructor.

Instances

Eq DescribeStateMachineResponse

Defined in Network.AWS.StepFunctions.DescribeStateMachine

Methods

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

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

Data DescribeStateMachineResponse

Defined in Network.AWS.StepFunctions.DescribeStateMachine

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeStateMachineResponse -> c DescribeStateMachineResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeStateMachineResponse

toConstr :: DescribeStateMachineResponse -> Constr

dataTypeOf :: DescribeStateMachineResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeStateMachineResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeStateMachineResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeStateMachineResponse -> DescribeStateMachineResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeStateMachineResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeStateMachineResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeStateMachineResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeStateMachineResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeStateMachineResponse -> m DescribeStateMachineResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeStateMachineResponse -> m DescribeStateMachineResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeStateMachineResponse -> m DescribeStateMachineResponse

Read DescribeStateMachineResponse

Defined in Network.AWS.StepFunctions.DescribeStateMachine

Methods

readsPrec :: Int -> ReadS DescribeStateMachineResponse

readList :: ReadS [DescribeStateMachineResponse]

readPrec :: ReadPrec DescribeStateMachineResponse

readListPrec :: ReadPrec [DescribeStateMachineResponse]

Show DescribeStateMachineResponse

Defined in Network.AWS.StepFunctions.DescribeStateMachine

Methods

showsPrec :: Int -> DescribeStateMachineResponse -> ShowS

show :: DescribeStateMachineResponse -> String

showList :: [DescribeStateMachineResponse] -> ShowS

Generic DescribeStateMachineResponse

Defined in Network.AWS.StepFunctions.DescribeStateMachine

Associated Types

type Rep DescribeStateMachineResponse :: Type -> Type

Methods

from :: DescribeStateMachineResponse -> Rep DescribeStateMachineResponse x

to :: Rep DescribeStateMachineResponse x -> DescribeStateMachineResponse

NFData DescribeStateMachineResponse

Defined in Network.AWS.StepFunctions.DescribeStateMachine

Methods

rnf :: DescribeStateMachineResponse -> ()

type Rep DescribeStateMachineResponse

Defined in Network.AWS.StepFunctions.DescribeStateMachine

type Rep DescribeStateMachineResponse = D1 (MetaData "DescribeStateMachineResponse" "Network.AWS.StepFunctions.DescribeStateMachine" "amazonka-stepfunctions-1.6.1-2PTLha96w99Qwy2XlD0kq" False) (C1 (MetaCons "DescribeStateMachineResponse'" PrefixI True) ((S1 (MetaSel (Just "_dsmrsStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe StateMachineStatus)) :*: (S1 (MetaSel (Just "_dsmrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Just "_dsmrsStateMachineARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :*: ((S1 (MetaSel (Just "_dsmrsName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_dsmrsDefinition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :*: (S1 (MetaSel (Just "_dsmrsRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_dsmrsCreationDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 POSIX)))))

Response Lenses

dsmrsStatus :: Lens' DescribeStateMachineResponse (Maybe StateMachineStatus)

The current status of the state machine.

dsmrsResponseStatus :: Lens' DescribeStateMachineResponse Int

• - | The response status code.

dsmrsStateMachineARN :: Lens' DescribeStateMachineResponse Text

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

dsmrsName :: Lens' DescribeStateMachineResponse Text

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 )

dsmrsDefinition :: Lens' DescribeStateMachineResponse Text

The Amazon States Language definition of the state machine.

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

dsmrsCreationDate :: Lens' DescribeStateMachineResponse UTCTime

The date the state machine is created.