Amazonka.StepFunctions.Types.ExecutionListItem

Documentation

data ExecutionListItem

Contains details about an execution.

See: newExecutionListItem smart constructor.

Constructors

ExecutionListItem'

Fields

• itemCount :: Maybe Natural

  The total number of items processed in a child workflow execution. This field is returned only if mapRunArn was specified in the ListExecutions API action. If stateMachineArn was specified in ListExecutions, the itemCount field isn't returned.

• mapRunArn :: Maybe Text

  The Amazon Resource Name (ARN) of a Map Run. This field is returned only if mapRunArn was specified in the ListExecutions API action. If stateMachineArn was specified in ListExecutions, the mapRunArn isn't returned.

• stopDate :: Maybe POSIX

  If the execution already ended, the date the execution stopped.

• executionArn :: Text

  The Amazon Resource Name (ARN) that identifies the execution.

• stateMachineArn :: Text

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

• name :: Text

  The name of the execution.

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

• status :: ExecutionStatus

  The current status of the execution.

• startDate :: POSIX

  The date the execution started.

Instances

FromJSON ExecutionListItem

Defined in Amazonka.StepFunctions.Types.ExecutionListItem

Methods

parseJSON :: Value -> Parser ExecutionListItem

parseJSONList :: Value -> Parser [ExecutionListItem]

Generic ExecutionListItem

Defined in Amazonka.StepFunctions.Types.ExecutionListItem

Associated Types

type Rep ExecutionListItem :: Type -> Type

Methods

from :: ExecutionListItem -> Rep ExecutionListItem x

to :: Rep ExecutionListItem x -> ExecutionListItem

Read ExecutionListItem

Defined in Amazonka.StepFunctions.Types.ExecutionListItem

Methods

readsPrec :: Int -> ReadS ExecutionListItem

readList :: ReadS [ExecutionListItem]

readPrec :: ReadPrec ExecutionListItem

readListPrec :: ReadPrec [ExecutionListItem]

Show ExecutionListItem

Defined in Amazonka.StepFunctions.Types.ExecutionListItem

Methods

showsPrec :: Int -> ExecutionListItem -> ShowS

show :: ExecutionListItem -> String

showList :: [ExecutionListItem] -> ShowS

NFData ExecutionListItem

Defined in Amazonka.StepFunctions.Types.ExecutionListItem

Methods

rnf :: ExecutionListItem -> ()

Eq ExecutionListItem

Defined in Amazonka.StepFunctions.Types.ExecutionListItem

Methods

(==) :: ExecutionListItem -> ExecutionListItem -> Bool

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

Hashable ExecutionListItem

Defined in Amazonka.StepFunctions.Types.ExecutionListItem

Methods

hashWithSalt :: Int -> ExecutionListItem -> Int

hash :: ExecutionListItem -> Int

type Rep ExecutionListItem

Defined in Amazonka.StepFunctions.Types.ExecutionListItem

type Rep ExecutionListItem = D1 ('MetaData "ExecutionListItem" "Amazonka.StepFunctions.Types.ExecutionListItem" "amazonka-stepfunctions-2.0-K6z2kqboJVbL1MZX8DUt0f" 'False) (C1 ('MetaCons "ExecutionListItem'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "itemCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "mapRunArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "stopDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "executionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "stateMachineArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ExecutionStatus) :*: S1 ('MetaSel ('Just "startDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)))))

newExecutionListItem

Arguments

:: Text

$sel:executionArn:ExecutionListItem'

-> Text

$sel:stateMachineArn:ExecutionListItem'

-> Text

$sel:name:ExecutionListItem'

-> ExecutionStatus

$sel:status:ExecutionListItem'

-> UTCTime

$sel:startDate:ExecutionListItem'

-> ExecutionListItem

Create a value of ExecutionListItem 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:itemCount:ExecutionListItem', executionListItem_itemCount - The total number of items processed in a child workflow execution. This field is returned only if mapRunArn was specified in the ListExecutions API action. If stateMachineArn was specified in ListExecutions, the itemCount field isn't returned.

$sel:mapRunArn:ExecutionListItem', executionListItem_mapRunArn - The Amazon Resource Name (ARN) of a Map Run. This field is returned only if mapRunArn was specified in the ListExecutions API action. If stateMachineArn was specified in ListExecutions, the mapRunArn isn't returned.

$sel:stopDate:ExecutionListItem', executionListItem_stopDate - If the execution already ended, the date the execution stopped.

$sel:executionArn:ExecutionListItem', executionListItem_executionArn - The Amazon Resource Name (ARN) that identifies the execution.

$sel:stateMachineArn:ExecutionListItem', executionListItem_stateMachineArn - The Amazon Resource Name (ARN) of the executed state machine.

$sel:name:ExecutionListItem', executionListItem_name - The name of the execution.

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:status:ExecutionListItem', executionListItem_status - The current status of the execution.

$sel:startDate:ExecutionListItem', executionListItem_startDate - The date the execution started.

executionListItem_itemCount :: Lens' ExecutionListItem (Maybe Natural)

The total number of items processed in a child workflow execution. This field is returned only if mapRunArn was specified in the ListExecutions API action. If stateMachineArn was specified in ListExecutions, the itemCount field isn't returned.

executionListItem_mapRunArn :: Lens' ExecutionListItem (Maybe Text)

The Amazon Resource Name (ARN) of a Map Run. This field is returned only if mapRunArn was specified in the ListExecutions API action. If stateMachineArn was specified in ListExecutions, the mapRunArn isn't returned.

executionListItem_stopDate :: Lens' ExecutionListItem (Maybe UTCTime)

If the execution already ended, the date the execution stopped.

executionListItem_executionArn :: Lens' ExecutionListItem Text

The Amazon Resource Name (ARN) that identifies the execution.

executionListItem_stateMachineArn :: Lens' ExecutionListItem Text

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

executionListItem_name :: Lens' ExecutionListItem Text

The name of the execution.

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

executionListItem_status :: Lens' ExecutionListItem ExecutionStatus

The current status of the execution.

executionListItem_startDate :: Lens' ExecutionListItem UTCTime

The date the execution started.