Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Service Configuration
- Errors
- ActivityDoesNotExist
- ActivityLimitExceeded
- ActivityWorkerLimitExceeded
- ExecutionAlreadyExists
- ExecutionDoesNotExist
- ExecutionLimitExceeded
- InvalidArn
- InvalidDefinition
- InvalidExecutionInput
- InvalidLoggingConfiguration
- InvalidName
- InvalidOutput
- InvalidToken
- InvalidTracingConfiguration
- MissingRequiredParameter
- ResourceNotFound
- StateMachineAlreadyExists
- StateMachineDeleting
- StateMachineDoesNotExist
- StateMachineLimitExceeded
- StateMachineTypeNotSupported
- TaskDoesNotExist
- TaskTimedOut
- TooManyTags
- ValidationException
- Waiters
- Operations
- CreateActivity
- CreateStateMachine
- DeleteActivity
- DeleteStateMachine
- DescribeActivity
- DescribeExecution
- DescribeMapRun
- DescribeStateMachine
- DescribeStateMachineForExecution
- GetActivityTask
- GetExecutionHistory (Paginated)
- ListActivities (Paginated)
- ListExecutions (Paginated)
- ListMapRuns (Paginated)
- ListStateMachines (Paginated)
- ListTagsForResource
- SendTaskFailure
- SendTaskHeartbeat
- SendTaskSuccess
- StartExecution
- StartSyncExecution
- StopExecution
- TagResource
- UntagResource
- UpdateMapRun
- UpdateStateMachine
- Types
- ExecutionStatus
- HistoryEventType
- LogLevel
- MapRunStatus
- StateMachineStatus
- StateMachineType
- SyncExecutionStatus
- ActivityFailedEventDetails
- ActivityListItem
- ActivityScheduleFailedEventDetails
- ActivityScheduledEventDetails
- ActivityStartedEventDetails
- ActivitySucceededEventDetails
- ActivityTimedOutEventDetails
- BillingDetails
- CloudWatchEventsExecutionDataDetails
- CloudWatchLogsLogGroup
- ExecutionAbortedEventDetails
- ExecutionFailedEventDetails
- ExecutionListItem
- ExecutionStartedEventDetails
- ExecutionSucceededEventDetails
- ExecutionTimedOutEventDetails
- HistoryEvent
- HistoryEventExecutionDataDetails
- LambdaFunctionFailedEventDetails
- LambdaFunctionScheduleFailedEventDetails
- LambdaFunctionScheduledEventDetails
- LambdaFunctionStartFailedEventDetails
- LambdaFunctionSucceededEventDetails
- LambdaFunctionTimedOutEventDetails
- LogDestination
- LoggingConfiguration
- MapIterationEventDetails
- MapRunExecutionCounts
- MapRunFailedEventDetails
- MapRunItemCounts
- MapRunListItem
- MapRunStartedEventDetails
- MapStateStartedEventDetails
- StateEnteredEventDetails
- StateExitedEventDetails
- StateMachineListItem
- Tag
- TaskCredentials
- TaskFailedEventDetails
- TaskScheduledEventDetails
- TaskStartFailedEventDetails
- TaskStartedEventDetails
- TaskSubmitFailedEventDetails
- TaskSubmittedEventDetails
- TaskSucceededEventDetails
- TaskTimedOutEventDetails
- TracingConfiguration
Derived from API version 2016-11-23
of the AWS service descriptions, licensed under Apache 2.0.
Step Functions
Step Functions is a service that lets you coordinate the components of distributed applications and microservices using visual workflows.
You can use Step Functions to build applications from individual components, each of which performs a discrete function, or task, allowing you to scale and change applications quickly. Step Functions provides a console that helps visualize the components of your application as a series of steps. Step Functions automatically triggers and tracks each step, and retries steps when there are errors, so your application executes predictably and in the right order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any issues.
Step Functions manages operations and underlying infrastructure to ensure your application is available at any scale. You can run tasks on Amazon Web Services, your own servers, or any system that has access to Amazon Web Services. You can access and use Step Functions using the console, the Amazon Web Services SDKs, or an HTTP API. For more information about Step Functions, see the <https:docs.aws.amazon.comstep-functionslatestdgwelcome.html Step Functions Developer Guide> .
Synopsis
- defaultService :: Service
- _ActivityDoesNotExist :: AsError a => Fold a ServiceError
- _ActivityLimitExceeded :: AsError a => Fold a ServiceError
- _ActivityWorkerLimitExceeded :: AsError a => Fold a ServiceError
- _ExecutionAlreadyExists :: AsError a => Fold a ServiceError
- _ExecutionDoesNotExist :: AsError a => Fold a ServiceError
- _ExecutionLimitExceeded :: AsError a => Fold a ServiceError
- _InvalidArn :: AsError a => Fold a ServiceError
- _InvalidDefinition :: AsError a => Fold a ServiceError
- _InvalidExecutionInput :: AsError a => Fold a ServiceError
- _InvalidLoggingConfiguration :: AsError a => Fold a ServiceError
- _InvalidName :: AsError a => Fold a ServiceError
- _InvalidOutput :: AsError a => Fold a ServiceError
- _InvalidToken :: AsError a => Fold a ServiceError
- _InvalidTracingConfiguration :: AsError a => Fold a ServiceError
- _MissingRequiredParameter :: AsError a => Fold a ServiceError
- _ResourceNotFound :: AsError a => Fold a ServiceError
- _StateMachineAlreadyExists :: AsError a => Fold a ServiceError
- _StateMachineDeleting :: AsError a => Fold a ServiceError
- _StateMachineDoesNotExist :: AsError a => Fold a ServiceError
- _StateMachineLimitExceeded :: AsError a => Fold a ServiceError
- _StateMachineTypeNotSupported :: AsError a => Fold a ServiceError
- _TaskDoesNotExist :: AsError a => Fold a ServiceError
- _TaskTimedOut :: AsError a => Fold a ServiceError
- _TooManyTags :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data CreateActivity = CreateActivity' (Maybe [Tag]) Text
- newCreateActivity :: Text -> CreateActivity
- data CreateActivityResponse = CreateActivityResponse' Int Text POSIX
- newCreateActivityResponse :: Int -> Text -> UTCTime -> CreateActivityResponse
- data CreateStateMachine = CreateStateMachine' (Maybe LoggingConfiguration) (Maybe [Tag]) (Maybe TracingConfiguration) (Maybe StateMachineType) Text (Sensitive Text) Text
- newCreateStateMachine :: Text -> Text -> Text -> CreateStateMachine
- data CreateStateMachineResponse = CreateStateMachineResponse' Int Text POSIX
- newCreateStateMachineResponse :: Int -> Text -> UTCTime -> CreateStateMachineResponse
- data DeleteActivity = DeleteActivity' Text
- newDeleteActivity :: Text -> DeleteActivity
- data DeleteActivityResponse = DeleteActivityResponse' Int
- newDeleteActivityResponse :: Int -> DeleteActivityResponse
- data DeleteStateMachine = DeleteStateMachine' Text
- newDeleteStateMachine :: Text -> DeleteStateMachine
- data DeleteStateMachineResponse = DeleteStateMachineResponse' Int
- newDeleteStateMachineResponse :: Int -> DeleteStateMachineResponse
- data DescribeActivity = DescribeActivity' Text
- newDescribeActivity :: Text -> DescribeActivity
- data DescribeActivityResponse = DescribeActivityResponse' Int Text Text POSIX
- newDescribeActivityResponse :: Int -> Text -> Text -> UTCTime -> DescribeActivityResponse
- data DescribeExecution = DescribeExecution' Text
- newDescribeExecution :: Text -> DescribeExecution
- data DescribeExecutionResponse = DescribeExecutionResponse' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe CloudWatchEventsExecutionDataDetails) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe CloudWatchEventsExecutionDataDetails) (Maybe POSIX) (Maybe Text) Int Text Text ExecutionStatus POSIX
- newDescribeExecutionResponse :: Int -> Text -> Text -> ExecutionStatus -> UTCTime -> DescribeExecutionResponse
- data DescribeMapRun = DescribeMapRun' Text
- newDescribeMapRun :: Text -> DescribeMapRun
- data DescribeMapRunResponse = DescribeMapRunResponse' (Maybe POSIX) Int Text Text MapRunStatus POSIX Natural Double Natural MapRunItemCounts MapRunExecutionCounts
- newDescribeMapRunResponse :: Int -> Text -> Text -> MapRunStatus -> UTCTime -> Natural -> Double -> Natural -> MapRunItemCounts -> MapRunExecutionCounts -> DescribeMapRunResponse
- data DescribeStateMachine = DescribeStateMachine' Text
- newDescribeStateMachine :: Text -> DescribeStateMachine
- data DescribeStateMachineResponse = DescribeStateMachineResponse' (Maybe Text) (Maybe LoggingConfiguration) (Maybe StateMachineStatus) (Maybe TracingConfiguration) Int Text Text (Sensitive Text) Text StateMachineType POSIX
- newDescribeStateMachineResponse :: Int -> Text -> Text -> Text -> Text -> StateMachineType -> UTCTime -> DescribeStateMachineResponse
- data DescribeStateMachineForExecution = DescribeStateMachineForExecution' Text
- newDescribeStateMachineForExecution :: Text -> DescribeStateMachineForExecution
- data DescribeStateMachineForExecutionResponse = DescribeStateMachineForExecutionResponse' (Maybe Text) (Maybe LoggingConfiguration) (Maybe Text) (Maybe TracingConfiguration) Int Text Text (Sensitive Text) Text POSIX
- newDescribeStateMachineForExecutionResponse :: Int -> Text -> Text -> Text -> Text -> UTCTime -> DescribeStateMachineForExecutionResponse
- data GetActivityTask = GetActivityTask' (Maybe Text) Text
- newGetActivityTask :: Text -> GetActivityTask
- data GetActivityTaskResponse = GetActivityTaskResponse' (Maybe (Sensitive Text)) (Maybe Text) Int
- newGetActivityTaskResponse :: Int -> GetActivityTaskResponse
- data GetExecutionHistory = GetExecutionHistory' (Maybe Bool) (Maybe Natural) (Maybe Text) (Maybe Bool) Text
- newGetExecutionHistory :: Text -> GetExecutionHistory
- data GetExecutionHistoryResponse = GetExecutionHistoryResponse' (Maybe Text) Int [HistoryEvent]
- newGetExecutionHistoryResponse :: Int -> GetExecutionHistoryResponse
- data ListActivities = ListActivities' (Maybe Natural) (Maybe Text)
- newListActivities :: ListActivities
- data ListActivitiesResponse = ListActivitiesResponse' (Maybe Text) Int [ActivityListItem]
- newListActivitiesResponse :: Int -> ListActivitiesResponse
- data ListExecutions = ListExecutions' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe ExecutionStatus)
- newListExecutions :: ListExecutions
- data ListExecutionsResponse = ListExecutionsResponse' (Maybe Text) Int [ExecutionListItem]
- newListExecutionsResponse :: Int -> ListExecutionsResponse
- data ListMapRuns = ListMapRuns' (Maybe Natural) (Maybe Text) Text
- newListMapRuns :: Text -> ListMapRuns
- data ListMapRunsResponse = ListMapRunsResponse' (Maybe Text) Int [MapRunListItem]
- newListMapRunsResponse :: Int -> ListMapRunsResponse
- data ListStateMachines = ListStateMachines' (Maybe Natural) (Maybe Text)
- newListStateMachines :: ListStateMachines
- data ListStateMachinesResponse = ListStateMachinesResponse' (Maybe Text) Int [StateMachineListItem]
- newListStateMachinesResponse :: Int -> ListStateMachinesResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data SendTaskFailure = SendTaskFailure' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) Text
- newSendTaskFailure :: Text -> SendTaskFailure
- data SendTaskFailureResponse = SendTaskFailureResponse' Int
- newSendTaskFailureResponse :: Int -> SendTaskFailureResponse
- data SendTaskHeartbeat = SendTaskHeartbeat' Text
- newSendTaskHeartbeat :: Text -> SendTaskHeartbeat
- data SendTaskHeartbeatResponse = SendTaskHeartbeatResponse' Int
- newSendTaskHeartbeatResponse :: Int -> SendTaskHeartbeatResponse
- data SendTaskSuccess = SendTaskSuccess' Text (Sensitive Text)
- newSendTaskSuccess :: Text -> Text -> SendTaskSuccess
- data SendTaskSuccessResponse = SendTaskSuccessResponse' Int
- newSendTaskSuccessResponse :: Int -> SendTaskSuccessResponse
- data StartExecution = StartExecution' (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) Text
- newStartExecution :: Text -> StartExecution
- data StartExecutionResponse = StartExecutionResponse' Int Text POSIX
- newStartExecutionResponse :: Int -> Text -> UTCTime -> StartExecutionResponse
- data StartSyncExecution = StartSyncExecution' (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) Text
- newStartSyncExecution :: Text -> StartSyncExecution
- data StartSyncExecutionResponse = StartSyncExecutionResponse' (Maybe BillingDetails) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe CloudWatchEventsExecutionDataDetails) (Maybe Text) (Maybe (Sensitive Text)) (Maybe CloudWatchEventsExecutionDataDetails) (Maybe Text) (Maybe Text) Int Text POSIX POSIX SyncExecutionStatus
- newStartSyncExecutionResponse :: Int -> Text -> UTCTime -> UTCTime -> SyncExecutionStatus -> StartSyncExecutionResponse
- data StopExecution = StopExecution' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) Text
- newStopExecution :: Text -> StopExecution
- data StopExecutionResponse = StopExecutionResponse' Int POSIX
- newStopExecutionResponse :: Int -> UTCTime -> StopExecutionResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateMapRun = UpdateMapRun' (Maybe Natural) (Maybe Natural) (Maybe Double) Text
- newUpdateMapRun :: Text -> UpdateMapRun
- data UpdateMapRunResponse = UpdateMapRunResponse' Int
- newUpdateMapRunResponse :: Int -> UpdateMapRunResponse
- data UpdateStateMachine = UpdateStateMachine' (Maybe (Sensitive Text)) (Maybe LoggingConfiguration) (Maybe Text) (Maybe TracingConfiguration) Text
- newUpdateStateMachine :: Text -> UpdateStateMachine
- data UpdateStateMachineResponse = UpdateStateMachineResponse' Int POSIX
- newUpdateStateMachineResponse :: Int -> UTCTime -> UpdateStateMachineResponse
- newtype ExecutionStatus where
- ExecutionStatus' { }
- pattern ExecutionStatus_ABORTED :: ExecutionStatus
- pattern ExecutionStatus_FAILED :: ExecutionStatus
- pattern ExecutionStatus_RUNNING :: ExecutionStatus
- pattern ExecutionStatus_SUCCEEDED :: ExecutionStatus
- pattern ExecutionStatus_TIMED_OUT :: ExecutionStatus
- newtype HistoryEventType where
- HistoryEventType' { }
- pattern HistoryEventType_ActivityFailed :: HistoryEventType
- pattern HistoryEventType_ActivityScheduleFailed :: HistoryEventType
- pattern HistoryEventType_ActivityScheduled :: HistoryEventType
- pattern HistoryEventType_ActivityStarted :: HistoryEventType
- pattern HistoryEventType_ActivitySucceeded :: HistoryEventType
- pattern HistoryEventType_ActivityTimedOut :: HistoryEventType
- pattern HistoryEventType_ChoiceStateEntered :: HistoryEventType
- pattern HistoryEventType_ChoiceStateExited :: HistoryEventType
- pattern HistoryEventType_ExecutionAborted :: HistoryEventType
- pattern HistoryEventType_ExecutionFailed :: HistoryEventType
- pattern HistoryEventType_ExecutionStarted :: HistoryEventType
- pattern HistoryEventType_ExecutionSucceeded :: HistoryEventType
- pattern HistoryEventType_ExecutionTimedOut :: HistoryEventType
- pattern HistoryEventType_FailStateEntered :: HistoryEventType
- pattern HistoryEventType_LambdaFunctionFailed :: HistoryEventType
- pattern HistoryEventType_LambdaFunctionScheduleFailed :: HistoryEventType
- pattern HistoryEventType_LambdaFunctionScheduled :: HistoryEventType
- pattern HistoryEventType_LambdaFunctionStartFailed :: HistoryEventType
- pattern HistoryEventType_LambdaFunctionStarted :: HistoryEventType
- pattern HistoryEventType_LambdaFunctionSucceeded :: HistoryEventType
- pattern HistoryEventType_LambdaFunctionTimedOut :: HistoryEventType
- pattern HistoryEventType_MapIterationAborted :: HistoryEventType
- pattern HistoryEventType_MapIterationFailed :: HistoryEventType
- pattern HistoryEventType_MapIterationStarted :: HistoryEventType
- pattern HistoryEventType_MapIterationSucceeded :: HistoryEventType
- pattern HistoryEventType_MapRunAborted :: HistoryEventType
- pattern HistoryEventType_MapRunFailed :: HistoryEventType
- pattern HistoryEventType_MapRunStarted :: HistoryEventType
- pattern HistoryEventType_MapRunSucceeded :: HistoryEventType
- pattern HistoryEventType_MapStateAborted :: HistoryEventType
- pattern HistoryEventType_MapStateEntered :: HistoryEventType
- pattern HistoryEventType_MapStateExited :: HistoryEventType
- pattern HistoryEventType_MapStateFailed :: HistoryEventType
- pattern HistoryEventType_MapStateStarted :: HistoryEventType
- pattern HistoryEventType_MapStateSucceeded :: HistoryEventType
- pattern HistoryEventType_ParallelStateAborted :: HistoryEventType
- pattern HistoryEventType_ParallelStateEntered :: HistoryEventType
- pattern HistoryEventType_ParallelStateExited :: HistoryEventType
- pattern HistoryEventType_ParallelStateFailed :: HistoryEventType
- pattern HistoryEventType_ParallelStateStarted :: HistoryEventType
- pattern HistoryEventType_ParallelStateSucceeded :: HistoryEventType
- pattern HistoryEventType_PassStateEntered :: HistoryEventType
- pattern HistoryEventType_PassStateExited :: HistoryEventType
- pattern HistoryEventType_SucceedStateEntered :: HistoryEventType
- pattern HistoryEventType_SucceedStateExited :: HistoryEventType
- pattern HistoryEventType_TaskFailed :: HistoryEventType
- pattern HistoryEventType_TaskScheduled :: HistoryEventType
- pattern HistoryEventType_TaskStartFailed :: HistoryEventType
- pattern HistoryEventType_TaskStarted :: HistoryEventType
- pattern HistoryEventType_TaskStateAborted :: HistoryEventType
- pattern HistoryEventType_TaskStateEntered :: HistoryEventType
- pattern HistoryEventType_TaskStateExited :: HistoryEventType
- pattern HistoryEventType_TaskSubmitFailed :: HistoryEventType
- pattern HistoryEventType_TaskSubmitted :: HistoryEventType
- pattern HistoryEventType_TaskSucceeded :: HistoryEventType
- pattern HistoryEventType_TaskTimedOut :: HistoryEventType
- pattern HistoryEventType_WaitStateAborted :: HistoryEventType
- pattern HistoryEventType_WaitStateEntered :: HistoryEventType
- pattern HistoryEventType_WaitStateExited :: HistoryEventType
- newtype LogLevel where
- LogLevel' {
- fromLogLevel :: Text
- pattern LogLevel_ALL :: LogLevel
- pattern LogLevel_ERROR :: LogLevel
- pattern LogLevel_FATAL :: LogLevel
- pattern LogLevel_OFF :: LogLevel
- LogLevel' {
- newtype MapRunStatus where
- MapRunStatus' { }
- pattern MapRunStatus_ABORTED :: MapRunStatus
- pattern MapRunStatus_FAILED :: MapRunStatus
- pattern MapRunStatus_RUNNING :: MapRunStatus
- pattern MapRunStatus_SUCCEEDED :: MapRunStatus
- newtype StateMachineStatus where
- newtype StateMachineType where
- StateMachineType' { }
- pattern StateMachineType_EXPRESS :: StateMachineType
- pattern StateMachineType_STANDARD :: StateMachineType
- newtype SyncExecutionStatus where
- data ActivityFailedEventDetails = ActivityFailedEventDetails' (Maybe (Sensitive Text)) (Maybe (Sensitive Text))
- newActivityFailedEventDetails :: ActivityFailedEventDetails
- data ActivityListItem = ActivityListItem' Text Text POSIX
- newActivityListItem :: Text -> Text -> UTCTime -> ActivityListItem
- data ActivityScheduleFailedEventDetails = ActivityScheduleFailedEventDetails' (Maybe (Sensitive Text)) (Maybe (Sensitive Text))
- newActivityScheduleFailedEventDetails :: ActivityScheduleFailedEventDetails
- data ActivityScheduledEventDetails = ActivityScheduledEventDetails' (Maybe Integer) (Maybe (Sensitive Text)) (Maybe HistoryEventExecutionDataDetails) (Maybe Integer) Text
- newActivityScheduledEventDetails :: Text -> ActivityScheduledEventDetails
- data ActivityStartedEventDetails = ActivityStartedEventDetails' (Maybe Text)
- newActivityStartedEventDetails :: ActivityStartedEventDetails
- data ActivitySucceededEventDetails = ActivitySucceededEventDetails' (Maybe (Sensitive Text)) (Maybe HistoryEventExecutionDataDetails)
- newActivitySucceededEventDetails :: ActivitySucceededEventDetails
- data ActivityTimedOutEventDetails = ActivityTimedOutEventDetails' (Maybe (Sensitive Text)) (Maybe (Sensitive Text))
- newActivityTimedOutEventDetails :: ActivityTimedOutEventDetails
- data BillingDetails = BillingDetails' (Maybe Natural) (Maybe Natural)
- newBillingDetails :: BillingDetails
- data CloudWatchEventsExecutionDataDetails = CloudWatchEventsExecutionDataDetails' (Maybe Bool)
- newCloudWatchEventsExecutionDataDetails :: CloudWatchEventsExecutionDataDetails
- data CloudWatchLogsLogGroup = CloudWatchLogsLogGroup' (Maybe Text)
- newCloudWatchLogsLogGroup :: CloudWatchLogsLogGroup
- data ExecutionAbortedEventDetails = ExecutionAbortedEventDetails' (Maybe (Sensitive Text)) (Maybe (Sensitive Text))
- newExecutionAbortedEventDetails :: ExecutionAbortedEventDetails
- data ExecutionFailedEventDetails = ExecutionFailedEventDetails' (Maybe (Sensitive Text)) (Maybe (Sensitive Text))
- newExecutionFailedEventDetails :: ExecutionFailedEventDetails
- data ExecutionListItem = ExecutionListItem' (Maybe Natural) (Maybe Text) (Maybe POSIX) Text Text Text ExecutionStatus POSIX
- newExecutionListItem :: Text -> Text -> Text -> ExecutionStatus -> UTCTime -> ExecutionListItem
- data ExecutionStartedEventDetails = ExecutionStartedEventDetails' (Maybe (Sensitive Text)) (Maybe HistoryEventExecutionDataDetails) (Maybe Text)
- newExecutionStartedEventDetails :: ExecutionStartedEventDetails
- data ExecutionSucceededEventDetails = ExecutionSucceededEventDetails' (Maybe (Sensitive Text)) (Maybe HistoryEventExecutionDataDetails)
- newExecutionSucceededEventDetails :: ExecutionSucceededEventDetails
- data ExecutionTimedOutEventDetails = ExecutionTimedOutEventDetails' (Maybe (Sensitive Text)) (Maybe (Sensitive Text))
- newExecutionTimedOutEventDetails :: ExecutionTimedOutEventDetails
- data HistoryEvent = HistoryEvent' (Maybe ActivityFailedEventDetails) (Maybe ActivityScheduleFailedEventDetails) (Maybe ActivityScheduledEventDetails) (Maybe ActivityStartedEventDetails) (Maybe ActivitySucceededEventDetails) (Maybe ActivityTimedOutEventDetails) (Maybe ExecutionAbortedEventDetails) (Maybe ExecutionFailedEventDetails) (Maybe ExecutionStartedEventDetails) (Maybe ExecutionSucceededEventDetails) (Maybe ExecutionTimedOutEventDetails) (Maybe LambdaFunctionFailedEventDetails) (Maybe LambdaFunctionScheduleFailedEventDetails) (Maybe LambdaFunctionScheduledEventDetails) (Maybe LambdaFunctionStartFailedEventDetails) (Maybe LambdaFunctionSucceededEventDetails) (Maybe LambdaFunctionTimedOutEventDetails) (Maybe MapIterationEventDetails) (Maybe MapIterationEventDetails) (Maybe MapIterationEventDetails) (Maybe MapIterationEventDetails) (Maybe MapRunFailedEventDetails) (Maybe MapRunStartedEventDetails) (Maybe MapStateStartedEventDetails) (Maybe Integer) (Maybe StateEnteredEventDetails) (Maybe StateExitedEventDetails) (Maybe TaskFailedEventDetails) (Maybe TaskScheduledEventDetails) (Maybe TaskStartFailedEventDetails) (Maybe TaskStartedEventDetails) (Maybe TaskSubmitFailedEventDetails) (Maybe TaskSubmittedEventDetails) (Maybe TaskSucceededEventDetails) (Maybe TaskTimedOutEventDetails) POSIX HistoryEventType Integer
- newHistoryEvent :: UTCTime -> HistoryEventType -> Integer -> HistoryEvent
- data HistoryEventExecutionDataDetails = HistoryEventExecutionDataDetails' (Maybe Bool)
- newHistoryEventExecutionDataDetails :: HistoryEventExecutionDataDetails
- data LambdaFunctionFailedEventDetails = LambdaFunctionFailedEventDetails' (Maybe (Sensitive Text)) (Maybe (Sensitive Text))
- newLambdaFunctionFailedEventDetails :: LambdaFunctionFailedEventDetails
- data LambdaFunctionScheduleFailedEventDetails = LambdaFunctionScheduleFailedEventDetails' (Maybe (Sensitive Text)) (Maybe (Sensitive Text))
- newLambdaFunctionScheduleFailedEventDetails :: LambdaFunctionScheduleFailedEventDetails
- data LambdaFunctionScheduledEventDetails = LambdaFunctionScheduledEventDetails' (Maybe (Sensitive Text)) (Maybe HistoryEventExecutionDataDetails) (Maybe TaskCredentials) (Maybe Integer) Text
- newLambdaFunctionScheduledEventDetails :: Text -> LambdaFunctionScheduledEventDetails
- data LambdaFunctionStartFailedEventDetails = LambdaFunctionStartFailedEventDetails' (Maybe (Sensitive Text)) (Maybe (Sensitive Text))
- newLambdaFunctionStartFailedEventDetails :: LambdaFunctionStartFailedEventDetails
- data LambdaFunctionSucceededEventDetails = LambdaFunctionSucceededEventDetails' (Maybe (Sensitive Text)) (Maybe HistoryEventExecutionDataDetails)
- newLambdaFunctionSucceededEventDetails :: LambdaFunctionSucceededEventDetails
- data LambdaFunctionTimedOutEventDetails = LambdaFunctionTimedOutEventDetails' (Maybe (Sensitive Text)) (Maybe (Sensitive Text))
- newLambdaFunctionTimedOutEventDetails :: LambdaFunctionTimedOutEventDetails
- data LogDestination = LogDestination' (Maybe CloudWatchLogsLogGroup)
- newLogDestination :: LogDestination
- data LoggingConfiguration = LoggingConfiguration' (Maybe [LogDestination]) (Maybe Bool) (Maybe LogLevel)
- newLoggingConfiguration :: LoggingConfiguration
- data MapIterationEventDetails = MapIterationEventDetails' (Maybe Natural) (Maybe Text)
- newMapIterationEventDetails :: MapIterationEventDetails
- data MapRunExecutionCounts = MapRunExecutionCounts' Natural Natural Natural Natural Natural Natural Natural Natural
- newMapRunExecutionCounts :: Natural -> Natural -> Natural -> Natural -> Natural -> Natural -> Natural -> Natural -> MapRunExecutionCounts
- data MapRunFailedEventDetails = MapRunFailedEventDetails' (Maybe (Sensitive Text)) (Maybe (Sensitive Text))
- newMapRunFailedEventDetails :: MapRunFailedEventDetails
- data MapRunItemCounts = MapRunItemCounts' Natural Natural Natural Natural Natural Natural Natural Natural
- newMapRunItemCounts :: Natural -> Natural -> Natural -> Natural -> Natural -> Natural -> Natural -> Natural -> MapRunItemCounts
- data MapRunListItem = MapRunListItem' (Maybe POSIX) Text Text Text POSIX
- newMapRunListItem :: Text -> Text -> Text -> UTCTime -> MapRunListItem
- data MapRunStartedEventDetails = MapRunStartedEventDetails' (Maybe Text)
- newMapRunStartedEventDetails :: MapRunStartedEventDetails
- data MapStateStartedEventDetails = MapStateStartedEventDetails' (Maybe Natural)
- newMapStateStartedEventDetails :: MapStateStartedEventDetails
- data StateEnteredEventDetails = StateEnteredEventDetails' (Maybe (Sensitive Text)) (Maybe HistoryEventExecutionDataDetails) Text
- newStateEnteredEventDetails :: Text -> StateEnteredEventDetails
- data StateExitedEventDetails = StateExitedEventDetails' (Maybe (Sensitive Text)) (Maybe HistoryEventExecutionDataDetails) Text
- newStateExitedEventDetails :: Text -> StateExitedEventDetails
- data StateMachineListItem = StateMachineListItem' Text Text StateMachineType POSIX
- newStateMachineListItem :: Text -> Text -> StateMachineType -> UTCTime -> StateMachineListItem
- data Tag = Tag' (Maybe Text) (Maybe Text)
- newTag :: Tag
- data TaskCredentials = TaskCredentials' (Maybe Text)
- newTaskCredentials :: TaskCredentials
- data TaskFailedEventDetails = TaskFailedEventDetails' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) Text Text
- newTaskFailedEventDetails :: Text -> Text -> TaskFailedEventDetails
- data TaskScheduledEventDetails = TaskScheduledEventDetails' (Maybe Integer) (Maybe TaskCredentials) (Maybe Integer) Text Text Text (Sensitive Text)
- newTaskScheduledEventDetails :: Text -> Text -> Text -> Text -> TaskScheduledEventDetails
- data TaskStartFailedEventDetails = TaskStartFailedEventDetails' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) Text Text
- newTaskStartFailedEventDetails :: Text -> Text -> TaskStartFailedEventDetails
- data TaskStartedEventDetails = TaskStartedEventDetails' Text Text
- newTaskStartedEventDetails :: Text -> Text -> TaskStartedEventDetails
- data TaskSubmitFailedEventDetails = TaskSubmitFailedEventDetails' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) Text Text
- newTaskSubmitFailedEventDetails :: Text -> Text -> TaskSubmitFailedEventDetails
- data TaskSubmittedEventDetails = TaskSubmittedEventDetails' (Maybe (Sensitive Text)) (Maybe HistoryEventExecutionDataDetails) Text Text
- newTaskSubmittedEventDetails :: Text -> Text -> TaskSubmittedEventDetails
- data TaskSucceededEventDetails = TaskSucceededEventDetails' (Maybe (Sensitive Text)) (Maybe HistoryEventExecutionDataDetails) Text Text
- newTaskSucceededEventDetails :: Text -> Text -> TaskSucceededEventDetails
- data TaskTimedOutEventDetails = TaskTimedOutEventDetails' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) Text Text
- newTaskTimedOutEventDetails :: Text -> Text -> TaskTimedOutEventDetails
- data TracingConfiguration = TracingConfiguration' (Maybe Bool)
- newTracingConfiguration :: TracingConfiguration
Service Configuration
defaultService :: Service Source #
API version 2016-11-23
of the Amazon Step Functions SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by StepFunctions
.
ActivityDoesNotExist
_ActivityDoesNotExist :: AsError a => Fold a ServiceError Source #
The specified activity does not exist.
ActivityLimitExceeded
_ActivityLimitExceeded :: AsError a => Fold a ServiceError Source #
The maximum number of activities has been reached. Existing activities must be deleted before a new activity can be created.
ActivityWorkerLimitExceeded
_ActivityWorkerLimitExceeded :: AsError a => Fold a ServiceError Source #
The maximum number of workers concurrently polling for activity tasks has been reached.
ExecutionAlreadyExists
_ExecutionAlreadyExists :: AsError a => Fold a ServiceError Source #
The execution has the same name
as another execution (but a different
input
).
Executions with the same name
and input
are considered idempotent.
ExecutionDoesNotExist
_ExecutionDoesNotExist :: AsError a => Fold a ServiceError Source #
The specified execution does not exist.
ExecutionLimitExceeded
_ExecutionLimitExceeded :: AsError a => Fold a ServiceError Source #
The maximum number of running executions has been reached. Running executions must end or be stopped before a new execution can be started.
InvalidArn
_InvalidArn :: AsError a => Fold a ServiceError Source #
The provided Amazon Resource Name (ARN) is not valid.
InvalidDefinition
_InvalidDefinition :: AsError a => Fold a ServiceError Source #
The provided Amazon States Language definition is not valid.
InvalidExecutionInput
_InvalidExecutionInput :: AsError a => Fold a ServiceError Source #
The provided JSON input data is not valid.
InvalidLoggingConfiguration
_InvalidLoggingConfiguration :: AsError a => Fold a ServiceError Source #
InvalidName
_InvalidName :: AsError a => Fold a ServiceError Source #
The provided name is not valid.
InvalidOutput
_InvalidOutput :: AsError a => Fold a ServiceError Source #
The provided JSON output data is not valid.
InvalidToken
_InvalidToken :: AsError a => Fold a ServiceError Source #
The provided token is not valid.
InvalidTracingConfiguration
_InvalidTracingConfiguration :: AsError a => Fold a ServiceError Source #
Your tracingConfiguration
key does not match, or enabled
has not
been set to true
or false
.
MissingRequiredParameter
_MissingRequiredParameter :: AsError a => Fold a ServiceError Source #
Request is missing a required parameter. This error occurs if both
definition
and roleArn
are not specified.
ResourceNotFound
_ResourceNotFound :: AsError a => Fold a ServiceError Source #
Could not find the referenced resource. Only state machine and activity ARNs are supported.
StateMachineAlreadyExists
_StateMachineAlreadyExists :: AsError a => Fold a ServiceError Source #
A state machine with the same name but a different definition or role ARN already exists.
StateMachineDeleting
_StateMachineDeleting :: AsError a => Fold a ServiceError Source #
The specified state machine is being deleted.
StateMachineDoesNotExist
_StateMachineDoesNotExist :: AsError a => Fold a ServiceError Source #
The specified state machine does not exist.
StateMachineLimitExceeded
_StateMachineLimitExceeded :: AsError a => Fold a ServiceError Source #
The maximum number of state machines has been reached. Existing state machines must be deleted before a new state machine can be created.
StateMachineTypeNotSupported
_StateMachineTypeNotSupported :: AsError a => Fold a ServiceError Source #
TaskDoesNotExist
_TaskDoesNotExist :: AsError a => Fold a ServiceError Source #
Prism for TaskDoesNotExist' errors.
TaskTimedOut
_TaskTimedOut :: AsError a => Fold a ServiceError Source #
Prism for TaskTimedOut' errors.
TooManyTags
_TooManyTags :: AsError a => Fold a ServiceError Source #
You've exceeded the number of tags allowed for a resource. See the Limits Topic in the Step Functions Developer Guide.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
The input does not satisfy the constraints specified by an Amazon Web Services service.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateActivity
data CreateActivity Source #
See: newCreateActivity
smart constructor.
CreateActivity' (Maybe [Tag]) Text |
Instances
Create a value of CreateActivity
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:tags:CreateActivity'
, createActivity_tags
- The list of tags to add to a resource.
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
Tags may only contain Unicode letters, digits, white space, or these
symbols: _ . : / = + - @
.
CreateActivity
, createActivity_name
- The name of the activity to create. This name must be unique for your
Amazon Web Services account and region for 90 days. For more
information, see
Limits Related to State Machine Executions
in the Step Functions Developer Guide.
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 _.
data CreateActivityResponse Source #
See: newCreateActivityResponse
smart constructor.
Instances
newCreateActivityResponse Source #
:: Int | |
-> Text | |
-> UTCTime | |
-> CreateActivityResponse |
Create a value of CreateActivityResponse
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:httpStatus:CreateActivityResponse'
, createActivityResponse_httpStatus
- The response's http status code.
CreateActivityResponse
, createActivityResponse_activityArn
- The Amazon Resource Name (ARN) that identifies the created activity.
CreateActivityResponse
, createActivityResponse_creationDate
- The date the activity is created.
CreateStateMachine
data CreateStateMachine Source #
See: newCreateStateMachine
smart constructor.
CreateStateMachine' (Maybe LoggingConfiguration) (Maybe [Tag]) (Maybe TracingConfiguration) (Maybe StateMachineType) Text (Sensitive Text) Text |
Instances
newCreateStateMachine Source #
:: Text | |
-> Text | |
-> Text | |
-> CreateStateMachine |
Create a value of CreateStateMachine
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:loggingConfiguration:CreateStateMachine'
, createStateMachine_loggingConfiguration
- Defines what execution history events are logged and where they are
logged.
By default, the level
is set to OFF
. For more information see
Log Levels
in the Step Functions User Guide.
$sel:tags:CreateStateMachine'
, createStateMachine_tags
- Tags to be added when creating a state machine.
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
Tags may only contain Unicode letters, digits, white space, or these
symbols: _ . : / = + - @
.
$sel:tracingConfiguration:CreateStateMachine'
, createStateMachine_tracingConfiguration
- Selects whether X-Ray tracing is enabled.
CreateStateMachine
, createStateMachine_type
- Determines whether a Standard or Express state machine is created. The
default is STANDARD
. You cannot update the type
of a state machine
once it has been created.
CreateStateMachine
, createStateMachine_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:CreateStateMachine'
, createStateMachine_definition
- The Amazon States Language definition of the state machine. See
Amazon States Language.
CreateStateMachine
, createStateMachine_roleArn
- The Amazon Resource Name (ARN) of the IAM role to use for this state
machine.
data CreateStateMachineResponse Source #
See: newCreateStateMachineResponse
smart constructor.
Instances
newCreateStateMachineResponse Source #
:: Int | |
-> Text | |
-> UTCTime | |
-> CreateStateMachineResponse |
Create a value of CreateStateMachineResponse
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:httpStatus:CreateStateMachineResponse'
, createStateMachineResponse_httpStatus
- The response's http status code.
CreateStateMachineResponse
, createStateMachineResponse_stateMachineArn
- The Amazon Resource Name (ARN) that identifies the created state
machine.
CreateStateMachineResponse
, createStateMachineResponse_creationDate
- The date the state machine is created.
DeleteActivity
data DeleteActivity Source #
See: newDeleteActivity
smart constructor.
Instances
Create a value of DeleteActivity
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:
DeleteActivity
, deleteActivity_activityArn
- The Amazon Resource Name (ARN) of the activity to delete.
data DeleteActivityResponse Source #
See: newDeleteActivityResponse
smart constructor.
Instances
newDeleteActivityResponse Source #
Create a value of DeleteActivityResponse
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:httpStatus:DeleteActivityResponse'
, deleteActivityResponse_httpStatus
- The response's http status code.
DeleteStateMachine
data DeleteStateMachine Source #
See: newDeleteStateMachine
smart constructor.
Instances
newDeleteStateMachine Source #
Create a value of DeleteStateMachine
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:
DeleteStateMachine
, deleteStateMachine_stateMachineArn
- The Amazon Resource Name (ARN) of the state machine to delete.
data DeleteStateMachineResponse Source #
See: newDeleteStateMachineResponse
smart constructor.
Instances
newDeleteStateMachineResponse Source #
Create a value of DeleteStateMachineResponse
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:httpStatus:DeleteStateMachineResponse'
, deleteStateMachineResponse_httpStatus
- The response's http status code.
DescribeActivity
data DescribeActivity Source #
See: newDescribeActivity
smart constructor.
Instances
Create a value of DescribeActivity
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:
DescribeActivity
, describeActivity_activityArn
- The Amazon Resource Name (ARN) of the activity to describe.
data DescribeActivityResponse Source #
See: newDescribeActivityResponse
smart constructor.
Instances
newDescribeActivityResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> UTCTime | |
-> DescribeActivityResponse |
Create a value of DescribeActivityResponse
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:httpStatus:DescribeActivityResponse'
, describeActivityResponse_httpStatus
- The response's http status code.
DescribeActivity
, describeActivityResponse_activityArn
- The Amazon Resource Name (ARN) that identifies the activity.
DescribeActivityResponse
, describeActivityResponse_name
- The name of the activity.
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 _.
DescribeActivityResponse
, describeActivityResponse_creationDate
- The date the activity is created.
DescribeExecution
data DescribeExecution Source #
See: newDescribeExecution
smart constructor.
Instances
Create a value of DescribeExecution
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:
DescribeExecution
, describeExecution_executionArn
- The Amazon Resource Name (ARN) of the execution to describe.
data DescribeExecutionResponse Source #
See: newDescribeExecutionResponse
smart constructor.
Instances
newDescribeExecutionResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> ExecutionStatus | |
-> UTCTime | |
-> DescribeExecutionResponse |
Create a value of DescribeExecutionResponse
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:
DescribeExecutionResponse
, describeExecutionResponse_cause
- The cause string if the state machine execution failed.
DescribeExecutionResponse
, describeExecutionResponse_error
- The error string if the state machine execution failed.
DescribeExecutionResponse
, describeExecutionResponse_input
- The string that contains the JSON input data of the execution. Length
constraints apply to the payload size, and are expressed as bytes in
UTF-8 encoding.
DescribeExecutionResponse
, describeExecutionResponse_inputDetails
- Undocumented member.
DescribeExecutionResponse
, describeExecutionResponse_mapRunArn
- The Amazon Resource Name (ARN) that identifies a Map Run, which
dispatched this execution.
DescribeExecutionResponse
, describeExecutionResponse_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 _.
DescribeExecutionResponse
, describeExecutionResponse_output
- The JSON output data of the execution. Length constraints apply to the
payload size, and are expressed as bytes in UTF-8 encoding.
This field is set only if the execution succeeds. If the execution fails, this field is null.
DescribeExecutionResponse
, describeExecutionResponse_outputDetails
- Undocumented member.
DescribeExecutionResponse
, describeExecutionResponse_stopDate
- If the execution has already ended, the date the execution stopped.
$sel:traceHeader:DescribeExecutionResponse'
, describeExecutionResponse_traceHeader
- The X-Ray trace header that was passed to the execution.
$sel:httpStatus:DescribeExecutionResponse'
, describeExecutionResponse_httpStatus
- The response's http status code.
DescribeExecution
, describeExecutionResponse_executionArn
- The Amazon Resource Name (ARN) that identifies the execution.
DescribeExecutionResponse
, describeExecutionResponse_stateMachineArn
- The Amazon Resource Name (ARN) of the executed stated machine.
DescribeExecutionResponse
, describeExecutionResponse_status
- The current status of the execution.
DescribeExecutionResponse
, describeExecutionResponse_startDate
- The date the execution is started.
DescribeMapRun
data DescribeMapRun Source #
See: newDescribeMapRun
smart constructor.
Instances
Create a value of DescribeMapRun
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:
DescribeMapRun
, describeMapRun_mapRunArn
- The Amazon Resource Name (ARN) that identifies a Map Run.
data DescribeMapRunResponse Source #
See: newDescribeMapRunResponse
smart constructor.
DescribeMapRunResponse' (Maybe POSIX) Int Text Text MapRunStatus POSIX Natural Double Natural MapRunItemCounts MapRunExecutionCounts |
Instances
newDescribeMapRunResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> MapRunStatus | |
-> UTCTime | |
-> Natural | |
-> Double | |
-> Natural | |
-> MapRunItemCounts | |
-> MapRunExecutionCounts | |
-> DescribeMapRunResponse |
Create a value of DescribeMapRunResponse
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:
DescribeMapRunResponse
, describeMapRunResponse_stopDate
- The date when the Map Run was stopped.
$sel:httpStatus:DescribeMapRunResponse'
, describeMapRunResponse_httpStatus
- The response's http status code.
DescribeMapRun
, describeMapRunResponse_mapRunArn
- The Amazon Resource Name (ARN) that identifies a Map Run.
DescribeMapRunResponse
, describeMapRunResponse_executionArn
- The Amazon Resource Name (ARN) that identifies the execution in which
the Map Run was started.
DescribeMapRunResponse
, describeMapRunResponse_status
- The current status of the Map Run.
DescribeMapRunResponse
, describeMapRunResponse_startDate
- The date when the Map Run was started.
$sel:maxConcurrency:DescribeMapRunResponse'
, describeMapRunResponse_maxConcurrency
- The maximum number of child workflow executions configured to run in
parallel for the Map Run at the same time.
$sel:toleratedFailurePercentage:DescribeMapRunResponse'
, describeMapRunResponse_toleratedFailurePercentage
- The maximum percentage of failed child workflow executions before the
Map Run fails.
$sel:toleratedFailureCount:DescribeMapRunResponse'
, describeMapRunResponse_toleratedFailureCount
- The maximum number of failed child workflow executions before the Map
Run fails.
$sel:itemCounts:DescribeMapRunResponse'
, describeMapRunResponse_itemCounts
- A JSON object that contains information about the total number of items,
and the item count for each processing status, such as pending
and
failed
.
$sel:executionCounts:DescribeMapRunResponse'
, describeMapRunResponse_executionCounts
- A JSON object that contains information about the total number of child
workflow executions for the Map Run, and the count of child workflow
executions for each status, such as failed
and succeeded
.
DescribeStateMachine
data DescribeStateMachine Source #
See: newDescribeStateMachine
smart constructor.
Instances
newDescribeStateMachine Source #
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.
data DescribeStateMachineResponse Source #
See: newDescribeStateMachineResponse
smart constructor.
DescribeStateMachineResponse' (Maybe Text) (Maybe LoggingConfiguration) (Maybe StateMachineStatus) (Maybe TracingConfiguration) Int Text Text (Sensitive Text) Text StateMachineType POSIX |
Instances
newDescribeStateMachineResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> Text | |
-> Text | |
-> StateMachineType | |
-> UTCTime | |
-> 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.
DescribeStateMachineForExecution
data DescribeStateMachineForExecution Source #
See: newDescribeStateMachineForExecution
smart constructor.
Instances
newDescribeStateMachineForExecution Source #
Create a value of DescribeStateMachineForExecution
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:
DescribeStateMachineForExecution
, describeStateMachineForExecution_executionArn
- The Amazon Resource Name (ARN) of the execution you want state machine
information for.
data DescribeStateMachineForExecutionResponse Source #
See: newDescribeStateMachineForExecutionResponse
smart constructor.
DescribeStateMachineForExecutionResponse' (Maybe Text) (Maybe LoggingConfiguration) (Maybe Text) (Maybe TracingConfiguration) Int Text Text (Sensitive Text) Text POSIX |
Instances
newDescribeStateMachineForExecutionResponse Source #
Create a value of DescribeStateMachineForExecutionResponse
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:DescribeStateMachineForExecutionResponse'
, describeStateMachineForExecutionResponse_label
- A user-defined or an auto-generated string that identifies a Map
state. This field is returned only if the executionArn
is a child
workflow execution that was started by a Distributed Map state.
$sel:loggingConfiguration:DescribeStateMachineForExecutionResponse'
, describeStateMachineForExecutionResponse_loggingConfiguration
- Undocumented member.
DescribeStateMachineForExecutionResponse
, describeStateMachineForExecutionResponse_mapRunArn
- The Amazon Resource Name (ARN) of the Map Run that started the child
workflow execution. This field is returned only if the executionArn
is
a child workflow execution that was started by a Distributed Map state.
$sel:tracingConfiguration:DescribeStateMachineForExecutionResponse'
, describeStateMachineForExecutionResponse_tracingConfiguration
- Selects whether X-Ray tracing is enabled.
$sel:httpStatus:DescribeStateMachineForExecutionResponse'
, describeStateMachineForExecutionResponse_httpStatus
- The response's http status code.
DescribeStateMachineForExecutionResponse
, describeStateMachineForExecutionResponse_stateMachineArn
- The Amazon Resource Name (ARN) of the state machine associated with the
execution.
DescribeStateMachineForExecutionResponse
, describeStateMachineForExecutionResponse_name
- The name of the state machine associated with the execution.
$sel:definition:DescribeStateMachineForExecutionResponse'
, describeStateMachineForExecutionResponse_definition
- The Amazon States Language definition of the state machine. See
Amazon States Language.
DescribeStateMachineForExecutionResponse
, describeStateMachineForExecutionResponse_roleArn
- The Amazon Resource Name (ARN) of the IAM role of the State Machine for
the execution.
$sel:updateDate:DescribeStateMachineForExecutionResponse'
, describeStateMachineForExecutionResponse_updateDate
- The date and time the state machine associated with an execution was
updated. For a newly created state machine, this is the creation date.
GetActivityTask
data GetActivityTask Source #
See: newGetActivityTask
smart constructor.
Instances
Create a value of GetActivityTask
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:
GetActivityTask
, getActivityTask_workerName
- You can provide an arbitrary name in order to identify the worker that
the task is assigned to. This name is used when it is logged in the
execution history.
GetActivityTask
, getActivityTask_activityArn
- The Amazon Resource Name (ARN) of the activity to retrieve tasks from
(assigned when you create the task using CreateActivity.)
data GetActivityTaskResponse Source #
See: newGetActivityTaskResponse
smart constructor.
Instances
newGetActivityTaskResponse Source #
Create a value of GetActivityTaskResponse
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:
GetActivityTaskResponse
, getActivityTaskResponse_input
- The string that contains the JSON input data for the task. Length
constraints apply to the payload size, and are expressed as bytes in
UTF-8 encoding.
$sel:taskToken:GetActivityTaskResponse'
, getActivityTaskResponse_taskToken
- A token that identifies the scheduled task. This token must be copied
and included in subsequent calls to SendTaskHeartbeat, SendTaskSuccess
or SendTaskFailure in order to report the progress or completion of the
task.
$sel:httpStatus:GetActivityTaskResponse'
, getActivityTaskResponse_httpStatus
- The response's http status code.
GetExecutionHistory (Paginated)
data GetExecutionHistory Source #
See: newGetExecutionHistory
smart constructor.
Instances
newGetExecutionHistory Source #
Create a value of GetExecutionHistory
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:
GetExecutionHistory
, getExecutionHistory_includeExecutionData
- You can select whether execution data (input or output of a history
event) is returned. The default is true
.
$sel:maxResults:GetExecutionHistory'
, getExecutionHistory_maxResults
- The maximum number of results that are returned per call. You can use
nextToken
to obtain further pages of results. The default is 100 and
the maximum allowed page size is 1000. A value of 0 uses the default.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
GetExecutionHistory
, getExecutionHistory_nextToken
- If nextToken
is returned, there are more results available. The value
of nextToken
is a unique pagination token for each page. Make the call
again using the returned token to retrieve the next page. Keep all other
arguments unchanged. Each pagination token expires after 24 hours. Using
an expired pagination token will return an HTTP 400 InvalidToken
error.
$sel:reverseOrder:GetExecutionHistory'
, getExecutionHistory_reverseOrder
- Lists events in descending order of their timeStamp
.
GetExecutionHistory
, getExecutionHistory_executionArn
- The Amazon Resource Name (ARN) of the execution.
data GetExecutionHistoryResponse Source #
See: newGetExecutionHistoryResponse
smart constructor.
Instances
newGetExecutionHistoryResponse Source #
Create a value of GetExecutionHistoryResponse
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:
GetExecutionHistory
, getExecutionHistoryResponse_nextToken
- If nextToken
is returned, there are more results available. The value
of nextToken
is a unique pagination token for each page. Make the call
again using the returned token to retrieve the next page. Keep all other
arguments unchanged. Each pagination token expires after 24 hours. Using
an expired pagination token will return an HTTP 400 InvalidToken
error.
$sel:httpStatus:GetExecutionHistoryResponse'
, getExecutionHistoryResponse_httpStatus
- The response's http status code.
$sel:events:GetExecutionHistoryResponse'
, getExecutionHistoryResponse_events
- The list of events that occurred in the execution.
ListActivities (Paginated)
data ListActivities Source #
See: newListActivities
smart constructor.
Instances
newListActivities :: ListActivities Source #
Create a value of ListActivities
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:maxResults:ListActivities'
, listActivities_maxResults
- The maximum number of results that are returned per call. You can use
nextToken
to obtain further pages of results. The default is 100 and
the maximum allowed page size is 1000. A value of 0 uses the default.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
ListActivities
, listActivities_nextToken
- If nextToken
is returned, there are more results available. The value
of nextToken
is a unique pagination token for each page. Make the call
again using the returned token to retrieve the next page. Keep all other
arguments unchanged. Each pagination token expires after 24 hours. Using
an expired pagination token will return an HTTP 400 InvalidToken
error.
data ListActivitiesResponse Source #
See: newListActivitiesResponse
smart constructor.
Instances
newListActivitiesResponse Source #
Create a value of ListActivitiesResponse
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:
ListActivities
, listActivitiesResponse_nextToken
- If nextToken
is returned, there are more results available. The value
of nextToken
is a unique pagination token for each page. Make the call
again using the returned token to retrieve the next page. Keep all other
arguments unchanged. Each pagination token expires after 24 hours. Using
an expired pagination token will return an HTTP 400 InvalidToken
error.
$sel:httpStatus:ListActivitiesResponse'
, listActivitiesResponse_httpStatus
- The response's http status code.
$sel:activities:ListActivitiesResponse'
, listActivitiesResponse_activities
- The list of activities.
ListExecutions (Paginated)
data ListExecutions Source #
See: newListExecutions
smart constructor.
Instances
newListExecutions :: ListExecutions Source #
Create a value of ListExecutions
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:
ListExecutions
, listExecutions_mapRunArn
- The Amazon Resource Name (ARN) of the Map Run that started the child
workflow executions. If the mapRunArn
field is specified, a list of
all of the child workflow executions started by a Map Run is returned.
For more information, see
Examining Map Run
in the Step Functions Developer Guide.
You can specify either a mapRunArn
or a stateMachineArn
, but not
both.
$sel:maxResults:ListExecutions'
, listExecutions_maxResults
- The maximum number of results that are returned per call. You can use
nextToken
to obtain further pages of results. The default is 100 and
the maximum allowed page size is 1000. A value of 0 uses the default.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
ListExecutions
, listExecutions_nextToken
- If nextToken
is returned, there are more results available. The value
of nextToken
is a unique pagination token for each page. Make the call
again using the returned token to retrieve the next page. Keep all other
arguments unchanged. Each pagination token expires after 24 hours. Using
an expired pagination token will return an HTTP 400 InvalidToken
error.
ListExecutions
, listExecutions_stateMachineArn
- The Amazon Resource Name (ARN) of the state machine whose executions is
listed.
You can specify either a mapRunArn
or a stateMachineArn
, but not
both.
$sel:statusFilter:ListExecutions'
, listExecutions_statusFilter
- If specified, only list the executions whose current execution status
matches the given filter.
data ListExecutionsResponse Source #
See: newListExecutionsResponse
smart constructor.
Instances
newListExecutionsResponse Source #
Create a value of ListExecutionsResponse
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:
ListExecutions
, listExecutionsResponse_nextToken
- If nextToken
is returned, there are more results available. The value
of nextToken
is a unique pagination token for each page. Make the call
again using the returned token to retrieve the next page. Keep all other
arguments unchanged. Each pagination token expires after 24 hours. Using
an expired pagination token will return an HTTP 400 InvalidToken
error.
$sel:httpStatus:ListExecutionsResponse'
, listExecutionsResponse_httpStatus
- The response's http status code.
$sel:executions:ListExecutionsResponse'
, listExecutionsResponse_executions
- The list of matching executions.
ListMapRuns (Paginated)
data ListMapRuns Source #
See: newListMapRuns
smart constructor.
Instances
Create a value of ListMapRuns
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:maxResults:ListMapRuns'
, listMapRuns_maxResults
- The maximum number of results that are returned per call. You can use
nextToken
to obtain further pages of results. The default is 100 and
the maximum allowed page size is 1000. A value of 0 uses the default.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
ListMapRuns
, listMapRuns_nextToken
- If nextToken
is returned, there are more results available. The value
of nextToken
is a unique pagination token for each page. Make the call
again using the returned token to retrieve the next page. Keep all other
arguments unchanged. Each pagination token expires after 24 hours. Using
an expired pagination token will return an HTTP 400 InvalidToken
error.
ListMapRuns
, listMapRuns_executionArn
- The Amazon Resource Name (ARN) of the execution for which the Map Runs
must be listed.
data ListMapRunsResponse Source #
See: newListMapRunsResponse
smart constructor.
Instances
newListMapRunsResponse Source #
Create a value of ListMapRunsResponse
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:
ListMapRuns
, listMapRunsResponse_nextToken
- If nextToken
is returned, there are more results available. The value
of nextToken
is a unique pagination token for each page. Make the call
again using the returned token to retrieve the next page. Keep all other
arguments unchanged. Each pagination token expires after 24 hours. Using
an expired pagination token will return an HTTP 400 InvalidToken
error.
$sel:httpStatus:ListMapRunsResponse'
, listMapRunsResponse_httpStatus
- The response's http status code.
$sel:mapRuns:ListMapRunsResponse'
, listMapRunsResponse_mapRuns
- An array that lists information related to a Map Run, such as the Amazon
Resource Name (ARN) of the Map Run and the ARN of the state machine that
started the Map Run.
ListStateMachines (Paginated)
data ListStateMachines Source #
See: newListStateMachines
smart constructor.
Instances
newListStateMachines :: ListStateMachines Source #
Create a value of ListStateMachines
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:maxResults:ListStateMachines'
, listStateMachines_maxResults
- The maximum number of results that are returned per call. You can use
nextToken
to obtain further pages of results. The default is 100 and
the maximum allowed page size is 1000. A value of 0 uses the default.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
ListStateMachines
, listStateMachines_nextToken
- If nextToken
is returned, there are more results available. The value
of nextToken
is a unique pagination token for each page. Make the call
again using the returned token to retrieve the next page. Keep all other
arguments unchanged. Each pagination token expires after 24 hours. Using
an expired pagination token will return an HTTP 400 InvalidToken
error.
data ListStateMachinesResponse Source #
See: newListStateMachinesResponse
smart constructor.
Instances
newListStateMachinesResponse Source #
Create a value of ListStateMachinesResponse
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:
ListStateMachines
, listStateMachinesResponse_nextToken
- If nextToken
is returned, there are more results available. The value
of nextToken
is a unique pagination token for each page. Make the call
again using the returned token to retrieve the next page. Keep all other
arguments unchanged. Each pagination token expires after 24 hours. Using
an expired pagination token will return an HTTP 400 InvalidToken
error.
$sel:httpStatus:ListStateMachinesResponse'
, listStateMachinesResponse_httpStatus
- The response's http status code.
$sel:stateMachines:ListStateMachinesResponse'
, listStateMachinesResponse_stateMachines
- Undocumented member.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
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:resourceArn:ListTagsForResource'
, listTagsForResource_resourceArn
- The Amazon Resource Name (ARN) for the Step Functions state machine or
activity.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
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:tags:ListTagsForResourceResponse'
, listTagsForResourceResponse_tags
- An array of tags associated with the resource.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
SendTaskFailure
data SendTaskFailure Source #
See: newSendTaskFailure
smart constructor.
Instances
Create a value of SendTaskFailure
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:
SendTaskFailure
, sendTaskFailure_cause
- A more detailed explanation of the cause of the failure.
SendTaskFailure
, sendTaskFailure_error
- The error code of the failure.
$sel:taskToken:SendTaskFailure'
, sendTaskFailure_taskToken
- The token that represents this task. Task tokens are generated by Step
Functions when tasks are assigned to a worker, or in the
context object
when a workflow enters a task state. See
GetActivityTaskOutput$taskToken.
data SendTaskFailureResponse Source #
See: newSendTaskFailureResponse
smart constructor.
Instances
newSendTaskFailureResponse Source #
Create a value of SendTaskFailureResponse
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:httpStatus:SendTaskFailureResponse'
, sendTaskFailureResponse_httpStatus
- The response's http status code.
SendTaskHeartbeat
data SendTaskHeartbeat Source #
See: newSendTaskHeartbeat
smart constructor.
Instances
Create a value of SendTaskHeartbeat
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:taskToken:SendTaskHeartbeat'
, sendTaskHeartbeat_taskToken
- The token that represents this task. Task tokens are generated by Step
Functions when tasks are assigned to a worker, or in the
context object
when a workflow enters a task state. See
GetActivityTaskOutput$taskToken.
data SendTaskHeartbeatResponse Source #
See: newSendTaskHeartbeatResponse
smart constructor.
Instances
newSendTaskHeartbeatResponse Source #
Create a value of SendTaskHeartbeatResponse
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:httpStatus:SendTaskHeartbeatResponse'
, sendTaskHeartbeatResponse_httpStatus
- The response's http status code.
SendTaskSuccess
data SendTaskSuccess Source #
See: newSendTaskSuccess
smart constructor.
Instances
Create a value of SendTaskSuccess
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:taskToken:SendTaskSuccess'
, sendTaskSuccess_taskToken
- The token that represents this task. Task tokens are generated by Step
Functions when tasks are assigned to a worker, or in the
context object
when a workflow enters a task state. See
GetActivityTaskOutput$taskToken.
SendTaskSuccess
, sendTaskSuccess_output
- The JSON output of the task. Length constraints apply to the payload
size, and are expressed as bytes in UTF-8 encoding.
data SendTaskSuccessResponse Source #
See: newSendTaskSuccessResponse
smart constructor.
Instances
newSendTaskSuccessResponse Source #
Create a value of SendTaskSuccessResponse
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:httpStatus:SendTaskSuccessResponse'
, sendTaskSuccessResponse_httpStatus
- The response's http status code.
StartExecution
data StartExecution Source #
See: newStartExecution
smart constructor.
Instances
Create a value of StartExecution
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:
StartExecution
, startExecution_input
- The string that contains the JSON input data for the execution, for
example:
"input": "{\"first_name\" : \"test\"}"
If you don't include any JSON input data, you still must include the
two braces, for example: "input": "{}"
Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
StartExecution
, startExecution_name
- The name of the execution. This name must be unique for your Amazon Web
Services account, region, and state machine for 90 days. For more
information, see
Limits Related to State Machine Executions
in the Step Functions Developer Guide.
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:traceHeader:StartExecution'
, startExecution_traceHeader
- Passes the X-Ray trace header. The trace header can also be passed in
the request payload.
StartExecution
, startExecution_stateMachineArn
- The Amazon Resource Name (ARN) of the state machine to execute.
data StartExecutionResponse Source #
See: newStartExecutionResponse
smart constructor.
Instances
newStartExecutionResponse Source #
:: Int | |
-> Text | |
-> UTCTime | |
-> StartExecutionResponse |
Create a value of StartExecutionResponse
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:httpStatus:StartExecutionResponse'
, startExecutionResponse_httpStatus
- The response's http status code.
StartExecutionResponse
, startExecutionResponse_executionArn
- The Amazon Resource Name (ARN) that identifies the execution.
StartExecutionResponse
, startExecutionResponse_startDate
- The date the execution is started.
StartSyncExecution
data StartSyncExecution Source #
See: newStartSyncExecution
smart constructor.
Instances
newStartSyncExecution Source #
Create a value of StartSyncExecution
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:
StartSyncExecution
, startSyncExecution_input
- The string that contains the JSON input data for the execution, for
example:
"input": "{\"first_name\" : \"test\"}"
If you don't include any JSON input data, you still must include the
two braces, for example: "input": "{}"
Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
StartSyncExecution
, startSyncExecution_name
- The name of the execution.
StartSyncExecution
, startSyncExecution_traceHeader
- Passes the X-Ray trace header. The trace header can also be passed in
the request payload.
StartSyncExecution
, startSyncExecution_stateMachineArn
- The Amazon Resource Name (ARN) of the state machine to execute.
data StartSyncExecutionResponse Source #
See: newStartSyncExecutionResponse
smart constructor.
Instances
newStartSyncExecutionResponse Source #
:: Int | |
-> Text | |
-> UTCTime | |
-> UTCTime | |
-> SyncExecutionStatus | |
-> StartSyncExecutionResponse |
Create a value of StartSyncExecutionResponse
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:billingDetails:StartSyncExecutionResponse'
, startSyncExecutionResponse_billingDetails
- An object that describes workflow billing details, including billed
duration and memory use.
StartSyncExecutionResponse
, startSyncExecutionResponse_cause
- A more detailed explanation of the cause of the failure.
StartSyncExecutionResponse
, startSyncExecutionResponse_error
- The error code of the failure.
StartSyncExecution
, startSyncExecutionResponse_input
- The string that contains the JSON input data of the execution. Length
constraints apply to the payload size, and are expressed as bytes in
UTF-8 encoding.
StartSyncExecutionResponse
, startSyncExecutionResponse_inputDetails
- Undocumented member.
StartSyncExecution
, startSyncExecutionResponse_name
- The name of the execution.
StartSyncExecutionResponse
, startSyncExecutionResponse_output
- The JSON output data of the execution. Length constraints apply to the
payload size, and are expressed as bytes in UTF-8 encoding.
This field is set only if the execution succeeds. If the execution fails, this field is null.
StartSyncExecutionResponse
, startSyncExecutionResponse_outputDetails
- Undocumented member.
StartSyncExecution
, startSyncExecutionResponse_stateMachineArn
- The Amazon Resource Name (ARN) that identifies the state machine.
StartSyncExecution
, startSyncExecutionResponse_traceHeader
- The X-Ray trace header that was passed to the execution.
$sel:httpStatus:StartSyncExecutionResponse'
, startSyncExecutionResponse_httpStatus
- The response's http status code.
StartSyncExecutionResponse
, startSyncExecutionResponse_executionArn
- The Amazon Resource Name (ARN) that identifies the execution.
StartSyncExecutionResponse
, startSyncExecutionResponse_startDate
- The date the execution is started.
StartSyncExecutionResponse
, startSyncExecutionResponse_stopDate
- If the execution has already ended, the date the execution stopped.
StartSyncExecutionResponse
, startSyncExecutionResponse_status
- The current status of the execution.
StopExecution
data StopExecution Source #
See: newStopExecution
smart constructor.
Instances
Create a value of StopExecution
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:
StopExecution
, stopExecution_cause
- A more detailed explanation of the cause of the failure.
StopExecution
, stopExecution_error
- The error code of the failure.
StopExecution
, stopExecution_executionArn
- The Amazon Resource Name (ARN) of the execution to stop.
data StopExecutionResponse Source #
See: newStopExecutionResponse
smart constructor.
Instances
newStopExecutionResponse Source #
Create a value of StopExecutionResponse
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:httpStatus:StopExecutionResponse'
, stopExecutionResponse_httpStatus
- The response's http status code.
StopExecutionResponse
, stopExecutionResponse_stopDate
- The date the execution is stopped.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
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:resourceArn:TagResource'
, tagResource_resourceArn
- The Amazon Resource Name (ARN) for the Step Functions state machine or
activity.
$sel:tags:TagResource'
, tagResource_tags
- The list of tags to add to a resource.
Tags may only contain Unicode letters, digits, white space, or these
symbols: _ . : / = + - @
.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
Create a value of TagResourceResponse
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:httpStatus:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
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:resourceArn:UntagResource'
, untagResource_resourceArn
- The Amazon Resource Name (ARN) for the Step Functions state machine or
activity.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- The list of tags to remove from the resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
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:httpStatus:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
UpdateMapRun
data UpdateMapRun Source #
See: newUpdateMapRun
smart constructor.
Instances
Create a value of UpdateMapRun
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:maxConcurrency:UpdateMapRun'
, updateMapRun_maxConcurrency
- The maximum number of child workflow executions that can be specified to
run in parallel for the Map Run at the same time.
$sel:toleratedFailureCount:UpdateMapRun'
, updateMapRun_toleratedFailureCount
- The maximum number of failed items before the Map Run fails.
$sel:toleratedFailurePercentage:UpdateMapRun'
, updateMapRun_toleratedFailurePercentage
- The maximum percentage of failed items before the Map Run fails.
UpdateMapRun
, updateMapRun_mapRunArn
- The Amazon Resource Name (ARN) of a Map Run.
data UpdateMapRunResponse Source #
See: newUpdateMapRunResponse
smart constructor.
Instances
newUpdateMapRunResponse Source #
Create a value of UpdateMapRunResponse
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:httpStatus:UpdateMapRunResponse'
, updateMapRunResponse_httpStatus
- The response's http status code.
UpdateStateMachine
data UpdateStateMachine Source #
See: newUpdateStateMachine
smart constructor.
UpdateStateMachine' (Maybe (Sensitive Text)) (Maybe LoggingConfiguration) (Maybe Text) (Maybe TracingConfiguration) Text |
Instances
newUpdateStateMachine Source #
Create a value of UpdateStateMachine
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:definition:UpdateStateMachine'
, updateStateMachine_definition
- The Amazon States Language definition of the state machine. See
Amazon States Language.
$sel:loggingConfiguration:UpdateStateMachine'
, updateStateMachine_loggingConfiguration
- The LoggingConfiguration
data type is used to set CloudWatch Logs
options.
UpdateStateMachine
, updateStateMachine_roleArn
- The Amazon Resource Name (ARN) of the IAM role of the state machine.
$sel:tracingConfiguration:UpdateStateMachine'
, updateStateMachine_tracingConfiguration
- Selects whether X-Ray tracing is enabled.
UpdateStateMachine
, updateStateMachine_stateMachineArn
- The Amazon Resource Name (ARN) of the state machine.
data UpdateStateMachineResponse Source #
See: newUpdateStateMachineResponse
smart constructor.
Instances
newUpdateStateMachineResponse Source #
:: Int | |
-> UTCTime | |
-> UpdateStateMachineResponse |
Create a value of UpdateStateMachineResponse
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:httpStatus:UpdateStateMachineResponse'
, updateStateMachineResponse_httpStatus
- The response's http status code.
$sel:updateDate:UpdateStateMachineResponse'
, updateStateMachineResponse_updateDate
- The date and time the state machine was updated.
Types
ExecutionStatus
newtype ExecutionStatus Source #
pattern ExecutionStatus_ABORTED :: ExecutionStatus | |
pattern ExecutionStatus_FAILED :: ExecutionStatus | |
pattern ExecutionStatus_RUNNING :: ExecutionStatus | |
pattern ExecutionStatus_SUCCEEDED :: ExecutionStatus | |
pattern ExecutionStatus_TIMED_OUT :: ExecutionStatus |
Instances
HistoryEventType
newtype HistoryEventType Source #
Instances
LogLevel
pattern LogLevel_ALL :: LogLevel | |
pattern LogLevel_ERROR :: LogLevel | |
pattern LogLevel_FATAL :: LogLevel | |
pattern LogLevel_OFF :: LogLevel |
Instances
MapRunStatus
newtype MapRunStatus Source #
pattern MapRunStatus_ABORTED :: MapRunStatus | |
pattern MapRunStatus_FAILED :: MapRunStatus | |
pattern MapRunStatus_RUNNING :: MapRunStatus | |
pattern MapRunStatus_SUCCEEDED :: MapRunStatus |
Instances
StateMachineStatus
newtype StateMachineStatus Source #
pattern StateMachineStatus_ACTIVE :: StateMachineStatus | |
pattern StateMachineStatus_DELETING :: StateMachineStatus |
Instances
StateMachineType
newtype StateMachineType Source #
pattern StateMachineType_EXPRESS :: StateMachineType | |
pattern StateMachineType_STANDARD :: StateMachineType |
Instances
SyncExecutionStatus
newtype SyncExecutionStatus Source #
pattern SyncExecutionStatus_FAILED :: SyncExecutionStatus | |
pattern SyncExecutionStatus_SUCCEEDED :: SyncExecutionStatus | |
pattern SyncExecutionStatus_TIMED_OUT :: SyncExecutionStatus |
Instances
ActivityFailedEventDetails
data ActivityFailedEventDetails Source #
Contains details about an activity that failed during an execution.
See: newActivityFailedEventDetails
smart constructor.
Instances
newActivityFailedEventDetails :: ActivityFailedEventDetails Source #
Create a value of ActivityFailedEventDetails
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:cause:ActivityFailedEventDetails'
, activityFailedEventDetails_cause
- A more detailed explanation of the cause of the failure.
$sel:error:ActivityFailedEventDetails'
, activityFailedEventDetails_error
- The error code of the failure.
ActivityListItem
data ActivityListItem Source #
Contains details about an activity.
See: newActivityListItem
smart constructor.
Instances
:: Text | |
-> Text | |
-> UTCTime | |
-> ActivityListItem |
Create a value of ActivityListItem
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:activityArn:ActivityListItem'
, activityListItem_activityArn
- The Amazon Resource Name (ARN) that identifies the activity.
$sel:name:ActivityListItem'
, activityListItem_name
- The name of the activity.
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:creationDate:ActivityListItem'
, activityListItem_creationDate
- The date the activity is created.
ActivityScheduleFailedEventDetails
data ActivityScheduleFailedEventDetails Source #
Contains details about an activity schedule failure that occurred during an execution.
See: newActivityScheduleFailedEventDetails
smart constructor.
Instances
FromJSON ActivityScheduleFailedEventDetails Source # | |
Generic ActivityScheduleFailedEventDetails Source # | |
Show ActivityScheduleFailedEventDetails Source # | |
NFData ActivityScheduleFailedEventDetails Source # | |
Eq ActivityScheduleFailedEventDetails Source # | |
Hashable ActivityScheduleFailedEventDetails Source # | |
type Rep ActivityScheduleFailedEventDetails Source # | |
Defined in Amazonka.StepFunctions.Types.ActivityScheduleFailedEventDetails type Rep ActivityScheduleFailedEventDetails = D1 ('MetaData "ActivityScheduleFailedEventDetails" "Amazonka.StepFunctions.Types.ActivityScheduleFailedEventDetails" "amazonka-stepfunctions-2.0-K6z2kqboJVbL1MZX8DUt0f" 'False) (C1 ('MetaCons "ActivityScheduleFailedEventDetails'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cause") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "error") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) |
newActivityScheduleFailedEventDetails :: ActivityScheduleFailedEventDetails Source #
Create a value of ActivityScheduleFailedEventDetails
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:cause:ActivityScheduleFailedEventDetails'
, activityScheduleFailedEventDetails_cause
- A more detailed explanation of the cause of the failure.
$sel:error:ActivityScheduleFailedEventDetails'
, activityScheduleFailedEventDetails_error
- The error code of the failure.
ActivityScheduledEventDetails
data ActivityScheduledEventDetails Source #
Contains details about an activity scheduled during an execution.
See: newActivityScheduledEventDetails
smart constructor.
ActivityScheduledEventDetails' (Maybe Integer) (Maybe (Sensitive Text)) (Maybe HistoryEventExecutionDataDetails) (Maybe Integer) Text |
Instances
newActivityScheduledEventDetails Source #
Create a value of ActivityScheduledEventDetails
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:heartbeatInSeconds:ActivityScheduledEventDetails'
, activityScheduledEventDetails_heartbeatInSeconds
- The maximum allowed duration between two heartbeats for the activity
task.
$sel:input:ActivityScheduledEventDetails'
, activityScheduledEventDetails_input
- The JSON data input to the activity task. Length constraints apply to
the payload size, and are expressed as bytes in UTF-8 encoding.
$sel:inputDetails:ActivityScheduledEventDetails'
, activityScheduledEventDetails_inputDetails
- Contains details about the input for an execution history event.
$sel:timeoutInSeconds:ActivityScheduledEventDetails'
, activityScheduledEventDetails_timeoutInSeconds
- The maximum allowed duration of the activity task.
$sel:resource:ActivityScheduledEventDetails'
, activityScheduledEventDetails_resource
- The Amazon Resource Name (ARN) of the scheduled activity.
ActivityStartedEventDetails
data ActivityStartedEventDetails Source #
Contains details about the start of an activity during an execution.
See: newActivityStartedEventDetails
smart constructor.
Instances
newActivityStartedEventDetails :: ActivityStartedEventDetails Source #
Create a value of ActivityStartedEventDetails
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:workerName:ActivityStartedEventDetails'
, activityStartedEventDetails_workerName
- The name of the worker that the task is assigned to. These names are
provided by the workers when calling GetActivityTask.
ActivitySucceededEventDetails
data ActivitySucceededEventDetails Source #
Contains details about an activity that successfully terminated during an execution.
See: newActivitySucceededEventDetails
smart constructor.
Instances
newActivitySucceededEventDetails :: ActivitySucceededEventDetails Source #
Create a value of ActivitySucceededEventDetails
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:output:ActivitySucceededEventDetails'
, activitySucceededEventDetails_output
- The JSON data output by the activity task. Length constraints apply to
the payload size, and are expressed as bytes in UTF-8 encoding.
$sel:outputDetails:ActivitySucceededEventDetails'
, activitySucceededEventDetails_outputDetails
- Contains details about the output of an execution history event.
ActivityTimedOutEventDetails
data ActivityTimedOutEventDetails Source #
Contains details about an activity timeout that occurred during an execution.
See: newActivityTimedOutEventDetails
smart constructor.
Instances
newActivityTimedOutEventDetails :: ActivityTimedOutEventDetails Source #
Create a value of ActivityTimedOutEventDetails
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:cause:ActivityTimedOutEventDetails'
, activityTimedOutEventDetails_cause
- A more detailed explanation of the cause of the timeout.
$sel:error:ActivityTimedOutEventDetails'
, activityTimedOutEventDetails_error
- The error code of the failure.
BillingDetails
data BillingDetails Source #
An object that describes workflow billing details.
See: newBillingDetails
smart constructor.
Instances
newBillingDetails :: BillingDetails Source #
Create a value of BillingDetails
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:billedDurationInMilliseconds:BillingDetails'
, billingDetails_billedDurationInMilliseconds
- Billed duration of your workflow, in milliseconds.
$sel:billedMemoryUsedInMB:BillingDetails'
, billingDetails_billedMemoryUsedInMB
- Billed memory consumption of your workflow, in MB.
CloudWatchEventsExecutionDataDetails
data CloudWatchEventsExecutionDataDetails Source #
Provides details about execution input or output.
See: newCloudWatchEventsExecutionDataDetails
smart constructor.
Instances
FromJSON CloudWatchEventsExecutionDataDetails Source # | |
Generic CloudWatchEventsExecutionDataDetails Source # | |
Read CloudWatchEventsExecutionDataDetails Source # | |
Show CloudWatchEventsExecutionDataDetails Source # | |
NFData CloudWatchEventsExecutionDataDetails Source # | |
Eq CloudWatchEventsExecutionDataDetails Source # | |
Hashable CloudWatchEventsExecutionDataDetails Source # | |
type Rep CloudWatchEventsExecutionDataDetails Source # | |
Defined in Amazonka.StepFunctions.Types.CloudWatchEventsExecutionDataDetails type Rep CloudWatchEventsExecutionDataDetails = D1 ('MetaData "CloudWatchEventsExecutionDataDetails" "Amazonka.StepFunctions.Types.CloudWatchEventsExecutionDataDetails" "amazonka-stepfunctions-2.0-K6z2kqboJVbL1MZX8DUt0f" 'False) (C1 ('MetaCons "CloudWatchEventsExecutionDataDetails'" 'PrefixI 'True) (S1 ('MetaSel ('Just "included") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) |
newCloudWatchEventsExecutionDataDetails :: CloudWatchEventsExecutionDataDetails Source #
Create a value of CloudWatchEventsExecutionDataDetails
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:included:CloudWatchEventsExecutionDataDetails'
, cloudWatchEventsExecutionDataDetails_included
- Indicates whether input or output was included in the response. Always
true
for API calls.
CloudWatchLogsLogGroup
data CloudWatchLogsLogGroup Source #
See: newCloudWatchLogsLogGroup
smart constructor.
Instances
newCloudWatchLogsLogGroup :: CloudWatchLogsLogGroup Source #
Create a value of CloudWatchLogsLogGroup
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:logGroupArn:CloudWatchLogsLogGroup'
, cloudWatchLogsLogGroup_logGroupArn
- The ARN of the the CloudWatch log group to which you want your logs
emitted to. The ARN must end with :*
ExecutionAbortedEventDetails
data ExecutionAbortedEventDetails Source #
Contains details about an abort of an execution.
See: newExecutionAbortedEventDetails
smart constructor.
Instances
newExecutionAbortedEventDetails :: ExecutionAbortedEventDetails Source #
Create a value of ExecutionAbortedEventDetails
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:cause:ExecutionAbortedEventDetails'
, executionAbortedEventDetails_cause
- A more detailed explanation of the cause of the failure.
$sel:error:ExecutionAbortedEventDetails'
, executionAbortedEventDetails_error
- The error code of the failure.
ExecutionFailedEventDetails
data ExecutionFailedEventDetails Source #
Contains details about an execution failure event.
See: newExecutionFailedEventDetails
smart constructor.
Instances
newExecutionFailedEventDetails :: ExecutionFailedEventDetails Source #
Create a value of ExecutionFailedEventDetails
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:cause:ExecutionFailedEventDetails'
, executionFailedEventDetails_cause
- A more detailed explanation of the cause of the failure.
$sel:error:ExecutionFailedEventDetails'
, executionFailedEventDetails_error
- The error code of the failure.
ExecutionListItem
data ExecutionListItem Source #
Contains details about an execution.
See: newExecutionListItem
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> ExecutionStatus | |
-> UTCTime | |
-> 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.
ExecutionStartedEventDetails
data ExecutionStartedEventDetails Source #
Contains details about the start of the execution.
See: newExecutionStartedEventDetails
smart constructor.
ExecutionStartedEventDetails' (Maybe (Sensitive Text)) (Maybe HistoryEventExecutionDataDetails) (Maybe Text) |
Instances
newExecutionStartedEventDetails :: ExecutionStartedEventDetails Source #
Create a value of ExecutionStartedEventDetails
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:input:ExecutionStartedEventDetails'
, executionStartedEventDetails_input
- The JSON data input to the execution. Length constraints apply to the
payload size, and are expressed as bytes in UTF-8 encoding.
$sel:inputDetails:ExecutionStartedEventDetails'
, executionStartedEventDetails_inputDetails
- Contains details about the input for an execution history event.
$sel:roleArn:ExecutionStartedEventDetails'
, executionStartedEventDetails_roleArn
- The Amazon Resource Name (ARN) of the IAM role used for executing Lambda
tasks.
ExecutionSucceededEventDetails
data ExecutionSucceededEventDetails Source #
Contains details about the successful termination of the execution.
See: newExecutionSucceededEventDetails
smart constructor.
Instances
FromJSON ExecutionSucceededEventDetails Source # | |
Generic ExecutionSucceededEventDetails Source # | |
Show ExecutionSucceededEventDetails Source # | |
NFData ExecutionSucceededEventDetails Source # | |
Eq ExecutionSucceededEventDetails Source # | |
Hashable ExecutionSucceededEventDetails Source # | |
type Rep ExecutionSucceededEventDetails Source # | |
Defined in Amazonka.StepFunctions.Types.ExecutionSucceededEventDetails type Rep ExecutionSucceededEventDetails = D1 ('MetaData "ExecutionSucceededEventDetails" "Amazonka.StepFunctions.Types.ExecutionSucceededEventDetails" "amazonka-stepfunctions-2.0-K6z2kqboJVbL1MZX8DUt0f" 'False) (C1 ('MetaCons "ExecutionSucceededEventDetails'" 'PrefixI 'True) (S1 ('MetaSel ('Just "output") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "outputDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HistoryEventExecutionDataDetails)))) |
newExecutionSucceededEventDetails :: ExecutionSucceededEventDetails Source #
Create a value of ExecutionSucceededEventDetails
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:output:ExecutionSucceededEventDetails'
, executionSucceededEventDetails_output
- The JSON data output by the execution. Length constraints apply to the
payload size, and are expressed as bytes in UTF-8 encoding.
$sel:outputDetails:ExecutionSucceededEventDetails'
, executionSucceededEventDetails_outputDetails
- Contains details about the output of an execution history event.
ExecutionTimedOutEventDetails
data ExecutionTimedOutEventDetails Source #
Contains details about the execution timeout that occurred during the execution.
See: newExecutionTimedOutEventDetails
smart constructor.
Instances
newExecutionTimedOutEventDetails :: ExecutionTimedOutEventDetails Source #
Create a value of ExecutionTimedOutEventDetails
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:cause:ExecutionTimedOutEventDetails'
, executionTimedOutEventDetails_cause
- A more detailed explanation of the cause of the timeout.
$sel:error:ExecutionTimedOutEventDetails'
, executionTimedOutEventDetails_error
- The error code of the failure.
HistoryEvent
data HistoryEvent Source #
Contains details about the events of an execution.
See: newHistoryEvent
smart constructor.
Instances
:: UTCTime | |
-> HistoryEventType | |
-> Integer | |
-> HistoryEvent |
Create a value of HistoryEvent
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:activityFailedEventDetails:HistoryEvent'
, historyEvent_activityFailedEventDetails
- Undocumented member.
$sel:activityScheduleFailedEventDetails:HistoryEvent'
, historyEvent_activityScheduleFailedEventDetails
- Contains details about an activity schedule event that failed during an
execution.
$sel:activityScheduledEventDetails:HistoryEvent'
, historyEvent_activityScheduledEventDetails
- Undocumented member.
$sel:activityStartedEventDetails:HistoryEvent'
, historyEvent_activityStartedEventDetails
- Undocumented member.
$sel:activitySucceededEventDetails:HistoryEvent'
, historyEvent_activitySucceededEventDetails
- Undocumented member.
$sel:activityTimedOutEventDetails:HistoryEvent'
, historyEvent_activityTimedOutEventDetails
- Undocumented member.
$sel:executionAbortedEventDetails:HistoryEvent'
, historyEvent_executionAbortedEventDetails
- Undocumented member.
$sel:executionFailedEventDetails:HistoryEvent'
, historyEvent_executionFailedEventDetails
- Undocumented member.
$sel:executionStartedEventDetails:HistoryEvent'
, historyEvent_executionStartedEventDetails
- Undocumented member.
$sel:executionSucceededEventDetails:HistoryEvent'
, historyEvent_executionSucceededEventDetails
- Undocumented member.
$sel:executionTimedOutEventDetails:HistoryEvent'
, historyEvent_executionTimedOutEventDetails
- Undocumented member.
$sel:lambdaFunctionFailedEventDetails:HistoryEvent'
, historyEvent_lambdaFunctionFailedEventDetails
- Undocumented member.
$sel:lambdaFunctionScheduleFailedEventDetails:HistoryEvent'
, historyEvent_lambdaFunctionScheduleFailedEventDetails
- Undocumented member.
$sel:lambdaFunctionScheduledEventDetails:HistoryEvent'
, historyEvent_lambdaFunctionScheduledEventDetails
- Undocumented member.
$sel:lambdaFunctionStartFailedEventDetails:HistoryEvent'
, historyEvent_lambdaFunctionStartFailedEventDetails
- Contains details about a lambda function that failed to start during an
execution.
$sel:lambdaFunctionSucceededEventDetails:HistoryEvent'
, historyEvent_lambdaFunctionSucceededEventDetails
- Contains details about a Lambda function that terminated successfully
during an execution.
$sel:lambdaFunctionTimedOutEventDetails:HistoryEvent'
, historyEvent_lambdaFunctionTimedOutEventDetails
- Undocumented member.
$sel:mapIterationAbortedEventDetails:HistoryEvent'
, historyEvent_mapIterationAbortedEventDetails
- Contains details about an iteration of a Map state that was aborted.
$sel:mapIterationFailedEventDetails:HistoryEvent'
, historyEvent_mapIterationFailedEventDetails
- Contains details about an iteration of a Map state that failed.
$sel:mapIterationStartedEventDetails:HistoryEvent'
, historyEvent_mapIterationStartedEventDetails
- Contains details about an iteration of a Map state that was started.
$sel:mapIterationSucceededEventDetails:HistoryEvent'
, historyEvent_mapIterationSucceededEventDetails
- Contains details about an iteration of a Map state that succeeded.
$sel:mapRunFailedEventDetails:HistoryEvent'
, historyEvent_mapRunFailedEventDetails
- Contains error and cause details about a Map Run that failed.
$sel:mapRunStartedEventDetails:HistoryEvent'
, historyEvent_mapRunStartedEventDetails
- Contains details, such as mapRunArn
, and the start date and time of a
Map Run. mapRunArn
is the Amazon Resource Name (ARN) of the Map Run
that was started.
$sel:mapStateStartedEventDetails:HistoryEvent'
, historyEvent_mapStateStartedEventDetails
- Contains details about Map state that was started.
$sel:previousEventId:HistoryEvent'
, historyEvent_previousEventId
- The id of the previous event.
$sel:stateEnteredEventDetails:HistoryEvent'
, historyEvent_stateEnteredEventDetails
- Undocumented member.
$sel:stateExitedEventDetails:HistoryEvent'
, historyEvent_stateExitedEventDetails
- Undocumented member.
$sel:taskFailedEventDetails:HistoryEvent'
, historyEvent_taskFailedEventDetails
- Contains details about the failure of a task.
$sel:taskScheduledEventDetails:HistoryEvent'
, historyEvent_taskScheduledEventDetails
- Contains details about a task that was scheduled.
$sel:taskStartFailedEventDetails:HistoryEvent'
, historyEvent_taskStartFailedEventDetails
- Contains details about a task that failed to start.
$sel:taskStartedEventDetails:HistoryEvent'
, historyEvent_taskStartedEventDetails
- Contains details about a task that was started.
$sel:taskSubmitFailedEventDetails:HistoryEvent'
, historyEvent_taskSubmitFailedEventDetails
- Contains details about a task that where the submit failed.
$sel:taskSubmittedEventDetails:HistoryEvent'
, historyEvent_taskSubmittedEventDetails
- Contains details about a submitted task.
$sel:taskSucceededEventDetails:HistoryEvent'
, historyEvent_taskSucceededEventDetails
- Contains details about a task that succeeded.
$sel:taskTimedOutEventDetails:HistoryEvent'
, historyEvent_taskTimedOutEventDetails
- Contains details about a task that timed out.
$sel:timestamp:HistoryEvent'
, historyEvent_timestamp
- The date and time the event occurred.
$sel:type':HistoryEvent'
, historyEvent_type
- The type of the event.
$sel:id:HistoryEvent'
, historyEvent_id
- The id of the event. Events are numbered sequentially, starting at one.
HistoryEventExecutionDataDetails
data HistoryEventExecutionDataDetails Source #
Provides details about input or output in an execution history event.
See: newHistoryEventExecutionDataDetails
smart constructor.
Instances
FromJSON HistoryEventExecutionDataDetails Source # | |
Generic HistoryEventExecutionDataDetails Source # | |
Read HistoryEventExecutionDataDetails Source # | |
Show HistoryEventExecutionDataDetails Source # | |
NFData HistoryEventExecutionDataDetails Source # | |
Eq HistoryEventExecutionDataDetails Source # | |
Hashable HistoryEventExecutionDataDetails Source # | |
type Rep HistoryEventExecutionDataDetails Source # | |
Defined in Amazonka.StepFunctions.Types.HistoryEventExecutionDataDetails type Rep HistoryEventExecutionDataDetails = D1 ('MetaData "HistoryEventExecutionDataDetails" "Amazonka.StepFunctions.Types.HistoryEventExecutionDataDetails" "amazonka-stepfunctions-2.0-K6z2kqboJVbL1MZX8DUt0f" 'False) (C1 ('MetaCons "HistoryEventExecutionDataDetails'" 'PrefixI 'True) (S1 ('MetaSel ('Just "truncated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) |
newHistoryEventExecutionDataDetails :: HistoryEventExecutionDataDetails Source #
Create a value of HistoryEventExecutionDataDetails
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:truncated:HistoryEventExecutionDataDetails'
, historyEventExecutionDataDetails_truncated
- Indicates whether input or output was truncated in the response. Always
false
for API calls.
LambdaFunctionFailedEventDetails
data LambdaFunctionFailedEventDetails Source #
Contains details about a Lambda function that failed during an execution.
See: newLambdaFunctionFailedEventDetails
smart constructor.
Instances
FromJSON LambdaFunctionFailedEventDetails Source # | |
Generic LambdaFunctionFailedEventDetails Source # | |
Show LambdaFunctionFailedEventDetails Source # | |
NFData LambdaFunctionFailedEventDetails Source # | |
Eq LambdaFunctionFailedEventDetails Source # | |
Hashable LambdaFunctionFailedEventDetails Source # | |
type Rep LambdaFunctionFailedEventDetails Source # | |
Defined in Amazonka.StepFunctions.Types.LambdaFunctionFailedEventDetails type Rep LambdaFunctionFailedEventDetails = D1 ('MetaData "LambdaFunctionFailedEventDetails" "Amazonka.StepFunctions.Types.LambdaFunctionFailedEventDetails" "amazonka-stepfunctions-2.0-K6z2kqboJVbL1MZX8DUt0f" 'False) (C1 ('MetaCons "LambdaFunctionFailedEventDetails'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cause") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "error") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) |
newLambdaFunctionFailedEventDetails :: LambdaFunctionFailedEventDetails Source #
Create a value of LambdaFunctionFailedEventDetails
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:cause:LambdaFunctionFailedEventDetails'
, lambdaFunctionFailedEventDetails_cause
- A more detailed explanation of the cause of the failure.
$sel:error:LambdaFunctionFailedEventDetails'
, lambdaFunctionFailedEventDetails_error
- The error code of the failure.
LambdaFunctionScheduleFailedEventDetails
data LambdaFunctionScheduleFailedEventDetails Source #
Contains details about a failed Lambda function schedule event that occurred during an execution.
See: newLambdaFunctionScheduleFailedEventDetails
smart constructor.
Instances
newLambdaFunctionScheduleFailedEventDetails :: LambdaFunctionScheduleFailedEventDetails Source #
Create a value of LambdaFunctionScheduleFailedEventDetails
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:cause:LambdaFunctionScheduleFailedEventDetails'
, lambdaFunctionScheduleFailedEventDetails_cause
- A more detailed explanation of the cause of the failure.
$sel:error:LambdaFunctionScheduleFailedEventDetails'
, lambdaFunctionScheduleFailedEventDetails_error
- The error code of the failure.
LambdaFunctionScheduledEventDetails
data LambdaFunctionScheduledEventDetails Source #
Contains details about a Lambda function scheduled during an execution.
See: newLambdaFunctionScheduledEventDetails
smart constructor.
LambdaFunctionScheduledEventDetails' (Maybe (Sensitive Text)) (Maybe HistoryEventExecutionDataDetails) (Maybe TaskCredentials) (Maybe Integer) Text |
Instances
newLambdaFunctionScheduledEventDetails Source #
Create a value of LambdaFunctionScheduledEventDetails
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:input:LambdaFunctionScheduledEventDetails'
, lambdaFunctionScheduledEventDetails_input
- The JSON data input to the Lambda function. Length constraints apply to
the payload size, and are expressed as bytes in UTF-8 encoding.
$sel:inputDetails:LambdaFunctionScheduledEventDetails'
, lambdaFunctionScheduledEventDetails_inputDetails
- Contains details about input for an execution history event.
$sel:taskCredentials:LambdaFunctionScheduledEventDetails'
, lambdaFunctionScheduledEventDetails_taskCredentials
- The credentials that Step Functions uses for the task.
$sel:timeoutInSeconds:LambdaFunctionScheduledEventDetails'
, lambdaFunctionScheduledEventDetails_timeoutInSeconds
- The maximum allowed duration of the Lambda function.
$sel:resource:LambdaFunctionScheduledEventDetails'
, lambdaFunctionScheduledEventDetails_resource
- The Amazon Resource Name (ARN) of the scheduled Lambda function.
LambdaFunctionStartFailedEventDetails
data LambdaFunctionStartFailedEventDetails Source #
Contains details about a lambda function that failed to start during an execution.
See: newLambdaFunctionStartFailedEventDetails
smart constructor.
Instances
newLambdaFunctionStartFailedEventDetails :: LambdaFunctionStartFailedEventDetails Source #
Create a value of LambdaFunctionStartFailedEventDetails
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:cause:LambdaFunctionStartFailedEventDetails'
, lambdaFunctionStartFailedEventDetails_cause
- A more detailed explanation of the cause of the failure.
$sel:error:LambdaFunctionStartFailedEventDetails'
, lambdaFunctionStartFailedEventDetails_error
- The error code of the failure.
LambdaFunctionSucceededEventDetails
data LambdaFunctionSucceededEventDetails Source #
Contains details about a Lambda function that successfully terminated during an execution.
See: newLambdaFunctionSucceededEventDetails
smart constructor.
LambdaFunctionSucceededEventDetails' (Maybe (Sensitive Text)) (Maybe HistoryEventExecutionDataDetails) |
Instances
newLambdaFunctionSucceededEventDetails :: LambdaFunctionSucceededEventDetails Source #
Create a value of LambdaFunctionSucceededEventDetails
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:output:LambdaFunctionSucceededEventDetails'
, lambdaFunctionSucceededEventDetails_output
- The JSON data output by the Lambda function. Length constraints apply to
the payload size, and are expressed as bytes in UTF-8 encoding.
$sel:outputDetails:LambdaFunctionSucceededEventDetails'
, lambdaFunctionSucceededEventDetails_outputDetails
- Contains details about the output of an execution history event.
LambdaFunctionTimedOutEventDetails
data LambdaFunctionTimedOutEventDetails Source #
Contains details about a Lambda function timeout that occurred during an execution.
See: newLambdaFunctionTimedOutEventDetails
smart constructor.
Instances
FromJSON LambdaFunctionTimedOutEventDetails Source # | |
Generic LambdaFunctionTimedOutEventDetails Source # | |
Show LambdaFunctionTimedOutEventDetails Source # | |
NFData LambdaFunctionTimedOutEventDetails Source # | |
Eq LambdaFunctionTimedOutEventDetails Source # | |
Hashable LambdaFunctionTimedOutEventDetails Source # | |
type Rep LambdaFunctionTimedOutEventDetails Source # | |
Defined in Amazonka.StepFunctions.Types.LambdaFunctionTimedOutEventDetails type Rep LambdaFunctionTimedOutEventDetails = D1 ('MetaData "LambdaFunctionTimedOutEventDetails" "Amazonka.StepFunctions.Types.LambdaFunctionTimedOutEventDetails" "amazonka-stepfunctions-2.0-K6z2kqboJVbL1MZX8DUt0f" 'False) (C1 ('MetaCons "LambdaFunctionTimedOutEventDetails'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cause") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "error") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) |
newLambdaFunctionTimedOutEventDetails :: LambdaFunctionTimedOutEventDetails Source #
Create a value of LambdaFunctionTimedOutEventDetails
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:cause:LambdaFunctionTimedOutEventDetails'
, lambdaFunctionTimedOutEventDetails_cause
- A more detailed explanation of the cause of the timeout.
$sel:error:LambdaFunctionTimedOutEventDetails'
, lambdaFunctionTimedOutEventDetails_error
- The error code of the failure.
LogDestination
data LogDestination Source #
See: newLogDestination
smart constructor.
Instances
newLogDestination :: LogDestination Source #
Create a value of LogDestination
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:cloudWatchLogsLogGroup:LogDestination'
, logDestination_cloudWatchLogsLogGroup
- An object describing a CloudWatch log group. For more information, see
AWS::Logs::LogGroup
in the CloudFormation User Guide.
LoggingConfiguration
data LoggingConfiguration Source #
The LoggingConfiguration
data type is used to set CloudWatch Logs
options.
See: newLoggingConfiguration
smart constructor.
Instances
newLoggingConfiguration :: LoggingConfiguration Source #
Create a value of LoggingConfiguration
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:destinations:LoggingConfiguration'
, loggingConfiguration_destinations
- An array of objects that describes where your execution history events
will be logged. Limited to size 1. Required, if your log level is not
set to OFF
.
$sel:includeExecutionData:LoggingConfiguration'
, loggingConfiguration_includeExecutionData
- Determines whether execution data is included in your log. When set to
false
, data is excluded.
$sel:level:LoggingConfiguration'
, loggingConfiguration_level
- Defines which category of execution history events are logged.
MapIterationEventDetails
data MapIterationEventDetails Source #
Contains details about an iteration of a Map state.
See: newMapIterationEventDetails
smart constructor.
Instances
newMapIterationEventDetails :: MapIterationEventDetails Source #
Create a value of MapIterationEventDetails
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:index:MapIterationEventDetails'
, mapIterationEventDetails_index
- The index of the array belonging to the Map state iteration.
$sel:name:MapIterationEventDetails'
, mapIterationEventDetails_name
- The name of the iteration’s parent Map state.
MapRunExecutionCounts
data MapRunExecutionCounts Source #
Contains details about all of the child workflow executions started by a Map Run.
See: newMapRunExecutionCounts
smart constructor.
Instances
newMapRunExecutionCounts Source #
:: Natural | |
-> Natural | |
-> Natural | |
-> Natural | |
-> Natural | |
-> Natural | |
-> Natural | |
-> Natural | |
-> MapRunExecutionCounts |
Create a value of MapRunExecutionCounts
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:pending:MapRunExecutionCounts'
, mapRunExecutionCounts_pending
- The total number of child workflow executions that were started by a Map
Run, but haven't started executing yet.
$sel:running:MapRunExecutionCounts'
, mapRunExecutionCounts_running
- The total number of child workflow executions that were started by a Map
Run and are currently in-progress.
$sel:succeeded:MapRunExecutionCounts'
, mapRunExecutionCounts_succeeded
- The total number of child workflow executions that were started by a Map
Run and have completed successfully.
$sel:failed:MapRunExecutionCounts'
, mapRunExecutionCounts_failed
- The total number of child workflow executions that were started by a Map
Run, but have failed.
$sel:timedOut:MapRunExecutionCounts'
, mapRunExecutionCounts_timedOut
- The total number of child workflow executions that were started by a Map
Run and have timed out.
$sel:aborted:MapRunExecutionCounts'
, mapRunExecutionCounts_aborted
- The total number of child workflow executions that were started by a Map
Run and were running, but were either stopped by the user or by Step
Functions because the Map Run failed.
$sel:total:MapRunExecutionCounts'
, mapRunExecutionCounts_total
- The total number of child workflow executions that were started by a Map
Run.
$sel:resultsWritten:MapRunExecutionCounts'
, mapRunExecutionCounts_resultsWritten
- Returns the count of child workflow executions whose results were
written by ResultWriter
. For more information, see
ResultWriter
in the Step Functions Developer Guide.
MapRunFailedEventDetails
data MapRunFailedEventDetails Source #
Contains details about a Map Run failure event that occurred during a state machine execution.
See: newMapRunFailedEventDetails
smart constructor.
Instances
newMapRunFailedEventDetails :: MapRunFailedEventDetails Source #
Create a value of MapRunFailedEventDetails
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:cause:MapRunFailedEventDetails'
, mapRunFailedEventDetails_cause
- A more detailed explanation of the cause of the failure.
$sel:error:MapRunFailedEventDetails'
, mapRunFailedEventDetails_error
- The error code of the Map Run failure.
MapRunItemCounts
data MapRunItemCounts Source #
Contains details about items that were processed in all of the child workflow executions that were started by a Map Run.
See: newMapRunItemCounts
smart constructor.
Instances
Create a value of MapRunItemCounts
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:pending:MapRunItemCounts'
, mapRunItemCounts_pending
- The total number of items to process in child workflow executions that
haven't started running yet.
$sel:running:MapRunItemCounts'
, mapRunItemCounts_running
- The total number of items being processed in child workflow executions
that are currently in-progress.
$sel:succeeded:MapRunItemCounts'
, mapRunItemCounts_succeeded
- The total number of items processed in child workflow executions that
have completed successfully.
$sel:failed:MapRunItemCounts'
, mapRunItemCounts_failed
- The total number of items processed in child workflow executions that
have failed.
$sel:timedOut:MapRunItemCounts'
, mapRunItemCounts_timedOut
- The total number of items processed in child workflow executions that
have timed out.
$sel:aborted:MapRunItemCounts'
, mapRunItemCounts_aborted
- The total number of items processed in child workflow executions that
were either stopped by the user or by Step Functions, because the Map
Run failed.
$sel:total:MapRunItemCounts'
, mapRunItemCounts_total
- The total number of items processed in all the child workflow executions
started by a Map Run.
$sel:resultsWritten:MapRunItemCounts'
, mapRunItemCounts_resultsWritten
- Returns the count of items whose results were written by ResultWriter
.
For more information, see
ResultWriter
in the Step Functions Developer Guide.
MapRunListItem
data MapRunListItem Source #
Contains details about a specific Map Run.
See: newMapRunListItem
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> UTCTime | |
-> MapRunListItem |
Create a value of MapRunListItem
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:stopDate:MapRunListItem'
, mapRunListItem_stopDate
- The date on which the Map Run stopped.
$sel:executionArn:MapRunListItem'
, mapRunListItem_executionArn
- The executionArn
of the execution from which the Map Run was started.
$sel:mapRunArn:MapRunListItem'
, mapRunListItem_mapRunArn
- The Amazon Resource Name (ARN) of the Map Run.
$sel:stateMachineArn:MapRunListItem'
, mapRunListItem_stateMachineArn
- The Amazon Resource Name (ARN) of the executed state machine.
$sel:startDate:MapRunListItem'
, mapRunListItem_startDate
- The date on which the Map Run started.
MapRunStartedEventDetails
data MapRunStartedEventDetails Source #
Contains details about a Map Run that was started during a state machine execution.
See: newMapRunStartedEventDetails
smart constructor.
Instances
newMapRunStartedEventDetails :: MapRunStartedEventDetails Source #
Create a value of MapRunStartedEventDetails
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:mapRunArn:MapRunStartedEventDetails'
, mapRunStartedEventDetails_mapRunArn
- The Amazon Resource Name (ARN) of a Map Run that was started.
MapStateStartedEventDetails
data MapStateStartedEventDetails Source #
Details about a Map state that was started.
See: newMapStateStartedEventDetails
smart constructor.
Instances
newMapStateStartedEventDetails :: MapStateStartedEventDetails Source #
Create a value of MapStateStartedEventDetails
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:length:MapStateStartedEventDetails'
, mapStateStartedEventDetails_length
- The size of the array for Map state iterations.
StateEnteredEventDetails
data StateEnteredEventDetails Source #
Contains details about a state entered during an execution.
See: newStateEnteredEventDetails
smart constructor.
Instances
newStateEnteredEventDetails Source #
Create a value of StateEnteredEventDetails
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:input:StateEnteredEventDetails'
, stateEnteredEventDetails_input
- The string that contains the JSON input data for the state. Length
constraints apply to the payload size, and are expressed as bytes in
UTF-8 encoding.
$sel:inputDetails:StateEnteredEventDetails'
, stateEnteredEventDetails_inputDetails
- Contains details about the input for an execution history event.
$sel:name:StateEnteredEventDetails'
, stateEnteredEventDetails_name
- The name of the state.
StateExitedEventDetails
data StateExitedEventDetails Source #
Contains details about an exit from a state during an execution.
See: newStateExitedEventDetails
smart constructor.
Instances
newStateExitedEventDetails Source #
Create a value of StateExitedEventDetails
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:output:StateExitedEventDetails'
, stateExitedEventDetails_output
- The JSON output data of the state. Length constraints apply to the
payload size, and are expressed as bytes in UTF-8 encoding.
$sel:outputDetails:StateExitedEventDetails'
, stateExitedEventDetails_outputDetails
- Contains details about the output of an execution history event.
$sel:name:StateExitedEventDetails'
, stateExitedEventDetails_name
- The name of the state.
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 _.
StateMachineListItem
data StateMachineListItem Source #
Contains details about the state machine.
See: newStateMachineListItem
smart constructor.
Instances
newStateMachineListItem Source #
:: Text | |
-> Text | |
-> StateMachineType | |
-> UTCTime | |
-> StateMachineListItem |
Create a value of StateMachineListItem
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:StateMachineListItem'
, stateMachineListItem_stateMachineArn
- The Amazon Resource Name (ARN) that identifies the state machine.
$sel:name:StateMachineListItem'
, stateMachineListItem_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:type':StateMachineListItem'
, stateMachineListItem_type
-
$sel:creationDate:StateMachineListItem'
, stateMachineListItem_creationDate
- The date the state machine is created.
Tag
Tags are key-value pairs that can be associated with Step Functions state machines and activities.
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
Tags may only contain Unicode letters, digits, white space, or these
symbols: _ . : / = + - @
.
See: newTag
smart constructor.
Instances
FromJSON Tag Source # | |
ToJSON Tag Source # | |
Defined in Amazonka.StepFunctions.Types.Tag | |
Generic Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.StepFunctions.Types.Tag | |
Eq Tag Source # | |
Hashable Tag Source # | |
Defined in Amazonka.StepFunctions.Types.Tag | |
type Rep Tag Source # | |
Defined in Amazonka.StepFunctions.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.StepFunctions.Types.Tag" "amazonka-stepfunctions-2.0-K6z2kqboJVbL1MZX8DUt0f" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
Create a value of Tag
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:key:Tag'
, tag_key
- The key of a tag.
$sel:value:Tag'
, tag_value
- The value of a tag.
TaskCredentials
data TaskCredentials Source #
Contains details about the credentials that Step Functions uses for a task.
See: newTaskCredentials
smart constructor.
Instances
newTaskCredentials :: TaskCredentials Source #
Create a value of TaskCredentials
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:roleArn:TaskCredentials'
, taskCredentials_roleArn
- The ARN of an IAM role that Step Functions assumes for the task. The
role can allow cross-account access to resources.
TaskFailedEventDetails
data TaskFailedEventDetails Source #
Contains details about a task failure event.
See: newTaskFailedEventDetails
smart constructor.
Instances
newTaskFailedEventDetails Source #
:: Text | |
-> Text | |
-> TaskFailedEventDetails |
Create a value of TaskFailedEventDetails
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:cause:TaskFailedEventDetails'
, taskFailedEventDetails_cause
- A more detailed explanation of the cause of the failure.
$sel:error:TaskFailedEventDetails'
, taskFailedEventDetails_error
- The error code of the failure.
$sel:resourceType:TaskFailedEventDetails'
, taskFailedEventDetails_resourceType
- The service name of the resource in a task state.
$sel:resource:TaskFailedEventDetails'
, taskFailedEventDetails_resource
- The action of the resource called by a task state.
TaskScheduledEventDetails
data TaskScheduledEventDetails Source #
Contains details about a task scheduled during an execution.
See: newTaskScheduledEventDetails
smart constructor.
TaskScheduledEventDetails' (Maybe Integer) (Maybe TaskCredentials) (Maybe Integer) Text Text Text (Sensitive Text) |
Instances
newTaskScheduledEventDetails Source #
:: Text | |
-> Text | |
-> Text | |
-> Text | |
-> TaskScheduledEventDetails |
Create a value of TaskScheduledEventDetails
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:heartbeatInSeconds:TaskScheduledEventDetails'
, taskScheduledEventDetails_heartbeatInSeconds
- The maximum allowed duration between two heartbeats for the task.
$sel:taskCredentials:TaskScheduledEventDetails'
, taskScheduledEventDetails_taskCredentials
- The credentials that Step Functions uses for the task.
$sel:timeoutInSeconds:TaskScheduledEventDetails'
, taskScheduledEventDetails_timeoutInSeconds
- The maximum allowed duration of the task.
$sel:resourceType:TaskScheduledEventDetails'
, taskScheduledEventDetails_resourceType
- The service name of the resource in a task state.
$sel:resource:TaskScheduledEventDetails'
, taskScheduledEventDetails_resource
- The action of the resource called by a task state.
$sel:region:TaskScheduledEventDetails'
, taskScheduledEventDetails_region
- The region of the scheduled task
$sel:parameters:TaskScheduledEventDetails'
, taskScheduledEventDetails_parameters
- The JSON data passed to the resource referenced in a task state. Length
constraints apply to the payload size, and are expressed as bytes in
UTF-8 encoding.
TaskStartFailedEventDetails
data TaskStartFailedEventDetails Source #
Contains details about a task that failed to start during an execution.
See: newTaskStartFailedEventDetails
smart constructor.
Instances
newTaskStartFailedEventDetails Source #
:: Text | |
-> Text | |
-> TaskStartFailedEventDetails |
Create a value of TaskStartFailedEventDetails
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:cause:TaskStartFailedEventDetails'
, taskStartFailedEventDetails_cause
- A more detailed explanation of the cause of the failure.
$sel:error:TaskStartFailedEventDetails'
, taskStartFailedEventDetails_error
- The error code of the failure.
$sel:resourceType:TaskStartFailedEventDetails'
, taskStartFailedEventDetails_resourceType
- The service name of the resource in a task state.
$sel:resource:TaskStartFailedEventDetails'
, taskStartFailedEventDetails_resource
- The action of the resource called by a task state.
TaskStartedEventDetails
data TaskStartedEventDetails Source #
Contains details about the start of a task during an execution.
See: newTaskStartedEventDetails
smart constructor.
Instances
newTaskStartedEventDetails Source #
:: Text | |
-> Text | |
-> TaskStartedEventDetails |
Create a value of TaskStartedEventDetails
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:resourceType:TaskStartedEventDetails'
, taskStartedEventDetails_resourceType
- The service name of the resource in a task state.
$sel:resource:TaskStartedEventDetails'
, taskStartedEventDetails_resource
- The action of the resource called by a task state.
TaskSubmitFailedEventDetails
data TaskSubmitFailedEventDetails Source #
Contains details about a task that failed to submit during an execution.
See: newTaskSubmitFailedEventDetails
smart constructor.
Instances
newTaskSubmitFailedEventDetails Source #
:: Text | |
-> Text | |
-> TaskSubmitFailedEventDetails |
Create a value of TaskSubmitFailedEventDetails
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:cause:TaskSubmitFailedEventDetails'
, taskSubmitFailedEventDetails_cause
- A more detailed explanation of the cause of the failure.
$sel:error:TaskSubmitFailedEventDetails'
, taskSubmitFailedEventDetails_error
- The error code of the failure.
$sel:resourceType:TaskSubmitFailedEventDetails'
, taskSubmitFailedEventDetails_resourceType
- The service name of the resource in a task state.
$sel:resource:TaskSubmitFailedEventDetails'
, taskSubmitFailedEventDetails_resource
- The action of the resource called by a task state.
TaskSubmittedEventDetails
data TaskSubmittedEventDetails Source #
Contains details about a task submitted to a resource .
See: newTaskSubmittedEventDetails
smart constructor.
TaskSubmittedEventDetails' (Maybe (Sensitive Text)) (Maybe HistoryEventExecutionDataDetails) Text Text |
Instances
newTaskSubmittedEventDetails Source #
:: Text | |
-> Text | |
-> TaskSubmittedEventDetails |
Create a value of TaskSubmittedEventDetails
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:output:TaskSubmittedEventDetails'
, taskSubmittedEventDetails_output
- The response from a resource when a task has started. Length constraints
apply to the payload size, and are expressed as bytes in UTF-8 encoding.
$sel:outputDetails:TaskSubmittedEventDetails'
, taskSubmittedEventDetails_outputDetails
- Contains details about the output of an execution history event.
$sel:resourceType:TaskSubmittedEventDetails'
, taskSubmittedEventDetails_resourceType
- The service name of the resource in a task state.
$sel:resource:TaskSubmittedEventDetails'
, taskSubmittedEventDetails_resource
- The action of the resource called by a task state.
TaskSucceededEventDetails
data TaskSucceededEventDetails Source #
Contains details about the successful completion of a task state.
See: newTaskSucceededEventDetails
smart constructor.
TaskSucceededEventDetails' (Maybe (Sensitive Text)) (Maybe HistoryEventExecutionDataDetails) Text Text |
Instances
newTaskSucceededEventDetails Source #
:: Text | |
-> Text | |
-> TaskSucceededEventDetails |
Create a value of TaskSucceededEventDetails
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:output:TaskSucceededEventDetails'
, taskSucceededEventDetails_output
- The full JSON response from a resource when a task has succeeded. This
response becomes the output of the related task. Length constraints
apply to the payload size, and are expressed as bytes in UTF-8 encoding.
$sel:outputDetails:TaskSucceededEventDetails'
, taskSucceededEventDetails_outputDetails
- Contains details about the output of an execution history event.
$sel:resourceType:TaskSucceededEventDetails'
, taskSucceededEventDetails_resourceType
- The service name of the resource in a task state.
$sel:resource:TaskSucceededEventDetails'
, taskSucceededEventDetails_resource
- The action of the resource called by a task state.
TaskTimedOutEventDetails
data TaskTimedOutEventDetails Source #
Contains details about a resource timeout that occurred during an execution.
See: newTaskTimedOutEventDetails
smart constructor.
Instances
newTaskTimedOutEventDetails Source #
:: Text | |
-> Text | |
-> TaskTimedOutEventDetails |
Create a value of TaskTimedOutEventDetails
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:cause:TaskTimedOutEventDetails'
, taskTimedOutEventDetails_cause
- A more detailed explanation of the cause of the failure.
$sel:error:TaskTimedOutEventDetails'
, taskTimedOutEventDetails_error
- The error code of the failure.
$sel:resourceType:TaskTimedOutEventDetails'
, taskTimedOutEventDetails_resourceType
- The service name of the resource in a task state.
$sel:resource:TaskTimedOutEventDetails'
, taskTimedOutEventDetails_resource
- The action of the resource called by a task state.
TracingConfiguration
data TracingConfiguration Source #
Selects whether or not the state machine's X-Ray tracing is enabled.
Default is false
See: newTracingConfiguration
smart constructor.
Instances
newTracingConfiguration :: TracingConfiguration Source #
Create a value of TracingConfiguration
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:enabled:TracingConfiguration'
, tracingConfiguration_enabled
- When set to true
, X-Ray tracing is enabled.