libZSservicesZSamazonka-stepfunctionsZSamazonka-stepfunctions
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.StepFunctions.Lens

Description

 
Synopsis

Operations

DeleteActivity

deleteActivity_activityArn :: Lens' DeleteActivity Text Source #

The Amazon Resource Name (ARN) of the activity to delete.

DescribeStateMachine

describeStateMachine_stateMachineArn :: Lens' DescribeStateMachine Text Source #

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

describeStateMachineResponse_stateMachineArn :: Lens' DescribeStateMachineResponse Text Source #

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

describeStateMachineResponse_name :: Lens' DescribeStateMachineResponse Text Source #

The name of the state machine.

A name must not contain:

  • white space
  • brackets < > { } [ ]
  • wildcard characters ? *
  • special characters " # % \ ^ | ~ ` $ & , ; : /
  • control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

describeStateMachineResponse_definition :: Lens' DescribeStateMachineResponse Text Source #

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

describeStateMachineResponse_roleArn :: Lens' DescribeStateMachineResponse Text Source #

The Amazon Resource Name (ARN) of the IAM role used when creating this state machine. (The IAM role maintains security by granting Step Functions access to AWS resources.)

describeStateMachineResponse_type :: Lens' DescribeStateMachineResponse StateMachineType Source #

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

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) for the Step Functions state machine or activity.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag]) Source #

An array of tags associated with the resource.

StopExecution

stopExecution_error :: Lens' StopExecution (Maybe Text) Source #

The error code of the failure.

stopExecution_cause :: Lens' StopExecution (Maybe Text) Source #

A more detailed explanation of the cause of the failure.

stopExecution_executionArn :: Lens' StopExecution Text Source #

The Amazon Resource Name (ARN) of the execution to stop.

DescribeActivity

describeActivity_activityArn :: Lens' DescribeActivity Text Source #

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

describeActivityResponse_activityArn :: Lens' DescribeActivityResponse Text Source #

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

describeActivityResponse_name :: Lens' DescribeActivityResponse Text Source #

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

ListStateMachines

listStateMachines_nextToken :: Lens' ListStateMachines (Maybe Text) Source #

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.

listStateMachines_maxResults :: Lens' ListStateMachines (Maybe Natural) Source #

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.

listStateMachinesResponse_nextToken :: Lens' ListStateMachinesResponse (Maybe Text) Source #

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_statusFilter :: Lens' ListExecutions (Maybe ExecutionStatus) Source #

If specified, only list the executions whose current execution status matches the given filter.

listExecutions_nextToken :: Lens' ListExecutions (Maybe Text) Source #

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_maxResults :: Lens' ListExecutions (Maybe Natural) Source #

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_stateMachineArn :: Lens' ListExecutions Text Source #

The Amazon Resource Name (ARN) of the state machine whose executions is listed.

listExecutionsResponse_nextToken :: Lens' ListExecutionsResponse (Maybe Text) Source #

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.

DeleteStateMachine

deleteStateMachine_stateMachineArn :: Lens' DeleteStateMachine Text Source #

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

UpdateStateMachine

updateStateMachine_definition :: Lens' UpdateStateMachine (Maybe Text) Source #

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

updateStateMachine_loggingConfiguration :: Lens' UpdateStateMachine (Maybe LoggingConfiguration) Source #

The LoggingConfiguration data type is used to set CloudWatch Logs options.

updateStateMachine_roleArn :: Lens' UpdateStateMachine (Maybe Text) Source #

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

updateStateMachine_stateMachineArn :: Lens' UpdateStateMachine Text Source #

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

updateStateMachineResponse_updateDate :: Lens' UpdateStateMachineResponse UTCTime Source #

The date and time the state machine was updated.

DescribeStateMachineForExecution

describeStateMachineForExecution_executionArn :: Lens' DescribeStateMachineForExecution Text Source #

The Amazon Resource Name (ARN) of the execution you want state machine information for.

describeStateMachineForExecutionResponse_stateMachineArn :: Lens' DescribeStateMachineForExecutionResponse Text Source #

The Amazon Resource Name (ARN) of the state machine associated with the execution.

describeStateMachineForExecutionResponse_name :: Lens' DescribeStateMachineForExecutionResponse Text Source #

The name of the state machine associated with the execution.

describeStateMachineForExecutionResponse_roleArn :: Lens' DescribeStateMachineForExecutionResponse Text Source #

The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution.

describeStateMachineForExecutionResponse_updateDate :: Lens' DescribeStateMachineForExecutionResponse UTCTime Source #

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

getActivityTask_workerName :: Lens' GetActivityTask (Maybe Text) Source #

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_activityArn :: Lens' GetActivityTask Text Source #

The Amazon Resource Name (ARN) of the activity to retrieve tasks from (assigned when you create the task using CreateActivity.)

getActivityTaskResponse_input :: Lens' GetActivityTaskResponse (Maybe Text) Source #

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.

getActivityTaskResponse_taskToken :: Lens' GetActivityTaskResponse (Maybe Text) Source #

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.

CreateActivity

createActivity_tags :: Lens' CreateActivity (Maybe [Tag]) Source #

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 AWS 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_name :: Lens' CreateActivity Text Source #

The name of the activity to create. This name must be unique for your AWS account and region for 90 days. For more information, see Limits Related to State Machine Executions in the AWS 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 _.

createActivityResponse_activityArn :: Lens' CreateActivityResponse Text Source #

The Amazon Resource Name (ARN) that identifies the created activity.

ListActivities

listActivities_nextToken :: Lens' ListActivities (Maybe Text) Source #

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.

listActivities_maxResults :: Lens' ListActivities (Maybe Natural) Source #

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.

listActivitiesResponse_nextToken :: Lens' ListActivitiesResponse (Maybe Text) Source #

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.

SendTaskHeartbeat

sendTaskHeartbeat_taskToken :: Lens' SendTaskHeartbeat Text Source #

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.

SendTaskFailure

sendTaskFailure_error :: Lens' SendTaskFailure (Maybe Text) Source #

The error code of the failure.

sendTaskFailure_cause :: Lens' SendTaskFailure (Maybe Text) Source #

A more detailed explanation of the cause of the failure.

sendTaskFailure_taskToken :: Lens' SendTaskFailure Text Source #

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.

DescribeExecution

describeExecution_executionArn :: Lens' DescribeExecution Text Source #

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

describeExecutionResponse_stopDate :: Lens' DescribeExecutionResponse (Maybe UTCTime) Source #

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

describeExecutionResponse_input :: Lens' DescribeExecutionResponse (Maybe Text) Source #

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_name :: Lens' DescribeExecutionResponse (Maybe Text) Source #

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_output :: Lens' DescribeExecutionResponse (Maybe Text) Source #

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_traceHeader :: Lens' DescribeExecutionResponse (Maybe Text) Source #

The AWS X-Ray trace header that was passed to the execution.

describeExecutionResponse_executionArn :: Lens' DescribeExecutionResponse Text Source #

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

describeExecutionResponse_stateMachineArn :: Lens' DescribeExecutionResponse Text Source #

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

SendTaskSuccess

sendTaskSuccess_taskToken :: Lens' SendTaskSuccess Text Source #

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_output :: Lens' SendTaskSuccess Text Source #

The JSON output of the task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

StartExecution

startExecution_input :: Lens' StartExecution (Maybe Text) Source #

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_name :: Lens' StartExecution (Maybe Text) Source #

The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the AWS 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 _.

startExecution_traceHeader :: Lens' StartExecution (Maybe Text) Source #

Passes the AWS X-Ray trace header. The trace header can also be passed in the request payload.

startExecution_stateMachineArn :: Lens' StartExecution Text Source #

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

startExecutionResponse_executionArn :: Lens' StartExecutionResponse Text Source #

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

StartSyncExecution

startSyncExecution_input :: Lens' StartSyncExecution (Maybe Text) Source #

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_traceHeader :: Lens' StartSyncExecution (Maybe Text) Source #

Passes the AWS X-Ray trace header. The trace header can also be passed in the request payload.

startSyncExecution_stateMachineArn :: Lens' StartSyncExecution Text Source #

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

startSyncExecutionResponse_input :: Lens' StartSyncExecutionResponse (Maybe Text) Source #

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_cause :: Lens' StartSyncExecutionResponse (Maybe Text) Source #

A more detailed explanation of the cause of the failure.

startSyncExecutionResponse_stateMachineArn :: Lens' StartSyncExecutionResponse (Maybe Text) Source #

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

startSyncExecutionResponse_output :: Lens' StartSyncExecutionResponse (Maybe Text) Source #

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_traceHeader :: Lens' StartSyncExecutionResponse (Maybe Text) Source #

The AWS X-Ray trace header that was passed to the execution.

startSyncExecutionResponse_billingDetails :: Lens' StartSyncExecutionResponse (Maybe BillingDetails) Source #

An object that describes workflow billing details, including billed duration and memory use.

startSyncExecutionResponse_executionArn :: Lens' StartSyncExecutionResponse Text Source #

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

startSyncExecutionResponse_stopDate :: Lens' StartSyncExecutionResponse UTCTime Source #

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

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) for the Step Functions state machine or activity.

tagResource_tags :: Lens' TagResource [Tag] Source #

The list of tags to add to a resource.

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) for the Step Functions state machine or activity.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

The list of tags to remove from the resource.

GetExecutionHistory

getExecutionHistory_reverseOrder :: Lens' GetExecutionHistory (Maybe Bool) Source #

Lists events in descending order of their timeStamp.

getExecutionHistory_includeExecutionData :: Lens' GetExecutionHistory (Maybe Bool) Source #

You can select whether execution data (input or output of a history event) is returned. The default is true.

getExecutionHistory_nextToken :: Lens' GetExecutionHistory (Maybe Text) Source #

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.

getExecutionHistory_maxResults :: Lens' GetExecutionHistory (Maybe Natural) Source #

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_executionArn :: Lens' GetExecutionHistory Text Source #

The Amazon Resource Name (ARN) of the execution.

getExecutionHistoryResponse_nextToken :: Lens' GetExecutionHistoryResponse (Maybe Text) Source #

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.

getExecutionHistoryResponse_events :: Lens' GetExecutionHistoryResponse [HistoryEvent] Source #

The list of events that occurred in the execution.

CreateStateMachine

createStateMachine_type :: Lens' CreateStateMachine (Maybe StateMachineType) Source #

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_loggingConfiguration :: Lens' CreateStateMachine (Maybe LoggingConfiguration) Source #

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 AWS Step Functions User Guide.

createStateMachine_tags :: Lens' CreateStateMachine (Maybe [Tag]) Source #

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 AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

createStateMachine_name :: Lens' CreateStateMachine Text Source #

The name of the state machine.

A name must not contain:

  • white space
  • brackets < > { } [ ]
  • wildcard characters ? *
  • special characters " # % \ ^ | ~ ` $ & , ; : /
  • control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

createStateMachine_definition :: Lens' CreateStateMachine Text Source #

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

createStateMachine_roleArn :: Lens' CreateStateMachine Text Source #

The Amazon Resource Name (ARN) of the IAM role to use for this state machine.

createStateMachineResponse_stateMachineArn :: Lens' CreateStateMachineResponse Text Source #

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

Types

ActivityFailedEventDetails

activityFailedEventDetails_cause :: Lens' ActivityFailedEventDetails (Maybe Text) Source #

A more detailed explanation of the cause of the failure.

ActivityListItem

activityListItem_activityArn :: Lens' ActivityListItem Text Source #

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

activityListItem_name :: Lens' ActivityListItem Text Source #

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

ActivityScheduleFailedEventDetails

activityScheduleFailedEventDetails_cause :: Lens' ActivityScheduleFailedEventDetails (Maybe Text) Source #

A more detailed explanation of the cause of the failure.

ActivityScheduledEventDetails

activityScheduledEventDetails_heartbeatInSeconds :: Lens' ActivityScheduledEventDetails (Maybe Integer) Source #

The maximum allowed duration between two heartbeats for the activity task.

activityScheduledEventDetails_input :: Lens' ActivityScheduledEventDetails (Maybe Text) Source #

The JSON data input to the activity task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

activityScheduledEventDetails_resource :: Lens' ActivityScheduledEventDetails Text Source #

The Amazon Resource Name (ARN) of the scheduled activity.

ActivityStartedEventDetails

activityStartedEventDetails_workerName :: Lens' ActivityStartedEventDetails (Maybe Text) Source #

The name of the worker that the task is assigned to. These names are provided by the workers when calling GetActivityTask.

ActivitySucceededEventDetails

activitySucceededEventDetails_output :: Lens' ActivitySucceededEventDetails (Maybe Text) Source #

The JSON data output by the activity task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

ActivityTimedOutEventDetails

activityTimedOutEventDetails_cause :: Lens' ActivityTimedOutEventDetails (Maybe Text) Source #

A more detailed explanation of the cause of the timeout.

BillingDetails

billingDetails_billedMemoryUsedInMB :: Lens' BillingDetails (Maybe Natural) Source #

Billed memory consumption of your workflow, in MB.

billingDetails_billedDurationInMilliseconds :: Lens' BillingDetails (Maybe Natural) Source #

Billed duration of your workflow, in milliseconds.

CloudWatchEventsExecutionDataDetails

cloudWatchEventsExecutionDataDetails_included :: Lens' CloudWatchEventsExecutionDataDetails (Maybe Bool) Source #

Indicates whether input or output was included in the response. Always true for API calls.

CloudWatchLogsLogGroup

cloudWatchLogsLogGroup_logGroupArn :: Lens' CloudWatchLogsLogGroup (Maybe Text) Source #

The ARN of the the CloudWatch log group to which you want your logs emitted to. The ARN must end with :*

ExecutionAbortedEventDetails

executionAbortedEventDetails_cause :: Lens' ExecutionAbortedEventDetails (Maybe Text) Source #

A more detailed explanation of the cause of the failure.

ExecutionFailedEventDetails

executionFailedEventDetails_cause :: Lens' ExecutionFailedEventDetails (Maybe Text) Source #

A more detailed explanation of the cause of the failure.

ExecutionListItem

executionListItem_stopDate :: Lens' ExecutionListItem (Maybe UTCTime) Source #

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

executionListItem_executionArn :: Lens' ExecutionListItem Text Source #

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

executionListItem_stateMachineArn :: Lens' ExecutionListItem Text Source #

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

executionListItem_name :: Lens' ExecutionListItem Text Source #

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

ExecutionStartedEventDetails

executionStartedEventDetails_input :: Lens' ExecutionStartedEventDetails (Maybe Text) Source #

The JSON data input to the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

executionStartedEventDetails_roleArn :: Lens' ExecutionStartedEventDetails (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role used for executing AWS Lambda tasks.

ExecutionSucceededEventDetails

executionSucceededEventDetails_output :: Lens' ExecutionSucceededEventDetails (Maybe Text) Source #

The JSON data output by the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

ExecutionTimedOutEventDetails

executionTimedOutEventDetails_cause :: Lens' ExecutionTimedOutEventDetails (Maybe Text) Source #

A more detailed explanation of the cause of the timeout.

HistoryEvent

historyEvent_taskSubmitFailedEventDetails :: Lens' HistoryEvent (Maybe TaskSubmitFailedEventDetails) Source #

Contains details about a task that where the submit failed.

historyEvent_lambdaFunctionStartFailedEventDetails :: Lens' HistoryEvent (Maybe LambdaFunctionStartFailedEventDetails) Source #

Contains details about a lambda function that failed to start during an execution.

historyEvent_lambdaFunctionSucceededEventDetails :: Lens' HistoryEvent (Maybe LambdaFunctionSucceededEventDetails) Source #

Contains details about a lambda function that terminated successfully during an execution.

historyEvent_mapIterationAbortedEventDetails :: Lens' HistoryEvent (Maybe MapIterationEventDetails) Source #

Contains details about an iteration of a Map state that was aborted.

historyEvent_mapIterationSucceededEventDetails :: Lens' HistoryEvent (Maybe MapIterationEventDetails) Source #

Contains details about an iteration of a Map state that succeeded.

historyEvent_mapIterationStartedEventDetails :: Lens' HistoryEvent (Maybe MapIterationEventDetails) Source #

Contains details about an iteration of a Map state that was started.

historyEvent_activityScheduleFailedEventDetails :: Lens' HistoryEvent (Maybe ActivityScheduleFailedEventDetails) Source #

Contains details about an activity schedule event that failed during an execution.

historyEvent_mapIterationFailedEventDetails :: Lens' HistoryEvent (Maybe MapIterationEventDetails) Source #

Contains details about an iteration of a Map state that failed.

historyEvent_timestamp :: Lens' HistoryEvent UTCTime Source #

The date and time the event occurred.

historyEvent_id :: Lens' HistoryEvent Integer Source #

The id of the event. Events are numbered sequentially, starting at one.

HistoryEventExecutionDataDetails

historyEventExecutionDataDetails_truncated :: Lens' HistoryEventExecutionDataDetails (Maybe Bool) Source #

Indicates whether input or output was truncated in the response. Always false for API calls.

LambdaFunctionFailedEventDetails

lambdaFunctionFailedEventDetails_cause :: Lens' LambdaFunctionFailedEventDetails (Maybe Text) Source #

A more detailed explanation of the cause of the failure.

LambdaFunctionScheduleFailedEventDetails

LambdaFunctionScheduledEventDetails

lambdaFunctionScheduledEventDetails_input :: Lens' LambdaFunctionScheduledEventDetails (Maybe Text) Source #

The JSON data input to the lambda function. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

lambdaFunctionScheduledEventDetails_resource :: Lens' LambdaFunctionScheduledEventDetails Text Source #

The Amazon Resource Name (ARN) of the scheduled lambda function.

LambdaFunctionStartFailedEventDetails

LambdaFunctionSucceededEventDetails

lambdaFunctionSucceededEventDetails_output :: Lens' LambdaFunctionSucceededEventDetails (Maybe Text) Source #

The JSON data output by the lambda function. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

LambdaFunctionTimedOutEventDetails

lambdaFunctionTimedOutEventDetails_cause :: Lens' LambdaFunctionTimedOutEventDetails (Maybe Text) Source #

A more detailed explanation of the cause of the timeout.

LogDestination

logDestination_cloudWatchLogsLogGroup :: Lens' LogDestination (Maybe CloudWatchLogsLogGroup) Source #

An object describing a CloudWatch log group. For more information, see AWS::Logs::LogGroup in the AWS CloudFormation User Guide.

LoggingConfiguration

loggingConfiguration_includeExecutionData :: Lens' LoggingConfiguration (Maybe Bool) Source #

Determines whether execution data is included in your log. When set to false, data is excluded.

loggingConfiguration_destinations :: Lens' LoggingConfiguration (Maybe [LogDestination]) Source #

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.

loggingConfiguration_level :: Lens' LoggingConfiguration (Maybe LogLevel) Source #

Defines which category of execution history events are logged.

MapIterationEventDetails

mapIterationEventDetails_name :: Lens' MapIterationEventDetails (Maybe Text) Source #

The name of the iteration’s parent Map state.

mapIterationEventDetails_index :: Lens' MapIterationEventDetails (Maybe Natural) Source #

The index of the array belonging to the Map state iteration.

MapStateStartedEventDetails

mapStateStartedEventDetails_length :: Lens' MapStateStartedEventDetails (Maybe Natural) Source #

The size of the array for Map state iterations.

StateEnteredEventDetails

stateEnteredEventDetails_inputDetails :: Lens' StateEnteredEventDetails (Maybe HistoryEventExecutionDataDetails) Source #

Contains details about the input for an execution history event.

stateEnteredEventDetails_input :: Lens' StateEnteredEventDetails (Maybe Text) Source #

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.

StateExitedEventDetails

stateExitedEventDetails_output :: Lens' StateExitedEventDetails (Maybe Text) Source #

The JSON output data of the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

stateExitedEventDetails_outputDetails :: Lens' StateExitedEventDetails (Maybe HistoryEventExecutionDataDetails) Source #

Contains details about the output of an execution history event.

stateExitedEventDetails_name :: Lens' StateExitedEventDetails Text Source #

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

stateMachineListItem_stateMachineArn :: Lens' StateMachineListItem Text Source #

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

stateMachineListItem_name :: Lens' StateMachineListItem Text Source #

The name of the state machine.

A name must not contain:

  • white space
  • brackets < > { } [ ]
  • wildcard characters ? *
  • special characters " # % \ ^ | ~ ` $ & , ; : /
  • control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

Tag

tag_value :: Lens' Tag (Maybe Text) Source #

The value of a tag.

tag_key :: Lens' Tag (Maybe Text) Source #

The key of a tag.

TaskFailedEventDetails

taskFailedEventDetails_cause :: Lens' TaskFailedEventDetails (Maybe Text) Source #

A more detailed explanation of the cause of the failure.

taskFailedEventDetails_resourceType :: Lens' TaskFailedEventDetails Text Source #

The action of the resource called by a task state.

taskFailedEventDetails_resource :: Lens' TaskFailedEventDetails Text Source #

The service name of the resource in a task state.

TaskScheduledEventDetails

taskScheduledEventDetails_heartbeatInSeconds :: Lens' TaskScheduledEventDetails (Maybe Integer) Source #

The maximum allowed duration between two heartbeats for the task.

taskScheduledEventDetails_resourceType :: Lens' TaskScheduledEventDetails Text Source #

The action of the resource called by a task state.

taskScheduledEventDetails_resource :: Lens' TaskScheduledEventDetails Text Source #

The service name of the resource in a task state.

taskScheduledEventDetails_parameters :: Lens' TaskScheduledEventDetails Text Source #

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

taskStartFailedEventDetails_cause :: Lens' TaskStartFailedEventDetails (Maybe Text) Source #

A more detailed explanation of the cause of the failure.

taskStartFailedEventDetails_resourceType :: Lens' TaskStartFailedEventDetails Text Source #

The action of the resource called by a task state.

taskStartFailedEventDetails_resource :: Lens' TaskStartFailedEventDetails Text Source #

The service name of the resource in a task state.

TaskStartedEventDetails

taskStartedEventDetails_resourceType :: Lens' TaskStartedEventDetails Text Source #

The action of the resource called by a task state.

taskStartedEventDetails_resource :: Lens' TaskStartedEventDetails Text Source #

The service name of the resource in a task state.

TaskSubmitFailedEventDetails

taskSubmitFailedEventDetails_cause :: Lens' TaskSubmitFailedEventDetails (Maybe Text) Source #

A more detailed explanation of the cause of the failure.

taskSubmitFailedEventDetails_resourceType :: Lens' TaskSubmitFailedEventDetails Text Source #

The action of the resource called by a task state.

taskSubmitFailedEventDetails_resource :: Lens' TaskSubmitFailedEventDetails Text Source #

The service name of the resource in a task state.

TaskSubmittedEventDetails

taskSubmittedEventDetails_output :: Lens' TaskSubmittedEventDetails (Maybe Text) Source #

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.

taskSubmittedEventDetails_resourceType :: Lens' TaskSubmittedEventDetails Text Source #

The action of the resource called by a task state.

taskSubmittedEventDetails_resource :: Lens' TaskSubmittedEventDetails Text Source #

The service name of the resource in a task state.

TaskSucceededEventDetails

taskSucceededEventDetails_output :: Lens' TaskSucceededEventDetails (Maybe Text) Source #

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.

taskSucceededEventDetails_resourceType :: Lens' TaskSucceededEventDetails Text Source #

The action of the resource called by a task state.

taskSucceededEventDetails_resource :: Lens' TaskSucceededEventDetails Text Source #

The service name of the resource in a task state.

TaskTimedOutEventDetails

taskTimedOutEventDetails_cause :: Lens' TaskTimedOutEventDetails (Maybe Text) Source #

A more detailed explanation of the cause of the failure.

taskTimedOutEventDetails_resourceType :: Lens' TaskTimedOutEventDetails Text Source #

The action of the resource called by a task state.

taskTimedOutEventDetails_resource :: Lens' TaskTimedOutEventDetails Text Source #

The service name of the resource in a task state.

TracingConfiguration

tracingConfiguration_enabled :: Lens' TracingConfiguration (Maybe Bool) Source #

When set to true, AWS X-Ray tracing is enabled.