libZSservicesZSamazonka-swfZSamazonka-swf
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.SWF.Lens

Contents

Description

 
Synopsis

Operations

ListOpenWorkflowExecutions

listOpenWorkflowExecutions_nextPageToken :: Lens' ListOpenWorkflowExecutions (Maybe Text) Source #

If NextPageToken is returned there are more results available. The value of NextPageToken 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 60 seconds. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

The configured maximumPageSize determines how many results can be returned in a single call.

listOpenWorkflowExecutions_executionFilter :: Lens' ListOpenWorkflowExecutions (Maybe WorkflowExecutionFilter) Source #

If specified, only workflow executions matching the workflow ID specified in the filter are returned.

executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

listOpenWorkflowExecutions_typeFilter :: Lens' ListOpenWorkflowExecutions (Maybe WorkflowTypeFilter) Source #

If specified, only executions of the type specified in the filter are returned.

executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

listOpenWorkflowExecutions_reverseOrder :: Lens' ListOpenWorkflowExecutions (Maybe Bool) Source #

When set to true, returns the results in reverse order. By default the results are returned in descending order of the start time of the executions.

listOpenWorkflowExecutions_tagFilter :: Lens' ListOpenWorkflowExecutions (Maybe TagFilter) Source #

If specified, only executions that have the matching tag are listed.

executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

listOpenWorkflowExecutions_maximumPageSize :: Lens' ListOpenWorkflowExecutions (Maybe Natural) Source #

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

listOpenWorkflowExecutions_domain :: Lens' ListOpenWorkflowExecutions Text Source #

The name of the domain that contains the workflow executions to list.

listOpenWorkflowExecutions_startTimeFilter :: Lens' ListOpenWorkflowExecutions ExecutionTimeFilter Source #

Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.

workflowExecutionInfos_nextPageToken :: Lens' WorkflowExecutionInfos (Maybe Text) Source #

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

RegisterActivityType

registerActivityType_defaultTaskScheduleToStartTimeout :: Lens' RegisterActivityType (Maybe Text) Source #

If set, specifies the default maximum duration that a task of this activity type can wait before being assigned to a worker. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

registerActivityType_defaultTaskList :: Lens' RegisterActivityType (Maybe TaskList) Source #

If set, specifies the default task list to use for scheduling tasks of this activity type. This default task list is used if a task list isn't provided when a task is scheduled through the ScheduleActivityTask Decision.

registerActivityType_defaultTaskPriority :: Lens' RegisterActivityType (Maybe Text) Source #

The default task priority to assign to the activity type. If not assigned, then 0 is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the in the Amazon SWF Developer Guide..

registerActivityType_defaultTaskHeartbeatTimeout :: Lens' RegisterActivityType (Maybe Text) Source #

If set, specifies the default maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

registerActivityType_defaultTaskScheduleToCloseTimeout :: Lens' RegisterActivityType (Maybe Text) Source #

If set, specifies the default maximum duration for a task of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

registerActivityType_defaultTaskStartToCloseTimeout :: Lens' RegisterActivityType (Maybe Text) Source #

If set, specifies the default maximum duration that a worker can take to process tasks of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

registerActivityType_description :: Lens' RegisterActivityType (Maybe Text) Source #

A textual description of the activity type.

registerActivityType_domain :: Lens' RegisterActivityType Text Source #

The name of the domain in which this activity is to be registered.

registerActivityType_name :: Lens' RegisterActivityType Text Source #

The name of the activity type within the domain.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

registerActivityType_version :: Lens' RegisterActivityType Text Source #

The version of the activity type.

The activity type consists of the name and version, the combination of which must be unique within the domain.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

ListActivityTypes

listActivityTypes_nextPageToken :: Lens' ListActivityTypes (Maybe Text) Source #

If NextPageToken is returned there are more results available. The value of NextPageToken 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 60 seconds. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

The configured maximumPageSize determines how many results can be returned in a single call.

listActivityTypes_reverseOrder :: Lens' ListActivityTypes (Maybe Bool) Source #

When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the activity types.

listActivityTypes_name :: Lens' ListActivityTypes (Maybe Text) Source #

If specified, only lists the activity types that have this name.

listActivityTypes_maximumPageSize :: Lens' ListActivityTypes (Maybe Natural) Source #

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

listActivityTypes_domain :: Lens' ListActivityTypes Text Source #

The name of the domain in which the activity types have been registered.

listActivityTypes_registrationStatus :: Lens' ListActivityTypes RegistrationStatus Source #

Specifies the registration status of the activity types to list.

listActivityTypesResponse_nextPageToken :: Lens' ListActivityTypesResponse (Maybe Text) Source #

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

CountPendingActivityTasks

countPendingActivityTasks_domain :: Lens' CountPendingActivityTasks Text Source #

The name of the domain that contains the task list.

pendingTaskCount_truncated :: Lens' PendingTaskCount (Maybe Bool) Source #

If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.

pendingTaskCount_count :: Lens' PendingTaskCount Natural Source #

The number of tasks in the task list.

RegisterWorkflowType

registerWorkflowType_defaultLambdaRole :: Lens' RegisterWorkflowType (Maybe Text) Source #

The default IAM role attached to this workflow type.

Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't specify an IAM role when you start this workflow type, the default Lambda role is attached to the execution. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.

registerWorkflowType_defaultChildPolicy :: Lens' RegisterWorkflowType (Maybe ChildPolicy) Source #

If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

The supported child policies are:

  • TERMINATE – The child executions are terminated.
  • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
  • ABANDON – No action is taken. The child executions continue to run.

registerWorkflowType_defaultTaskList :: Lens' RegisterWorkflowType (Maybe TaskList) Source #

If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type. This default is used only if a task list isn't provided when starting the execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.

registerWorkflowType_defaultTaskPriority :: Lens' RegisterWorkflowType (Maybe Text) Source #

The default task priority to assign to the workflow type. If not assigned, then 0 is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

registerWorkflowType_defaultExecutionStartToCloseTimeout :: Lens' RegisterWorkflowType (Maybe Text) Source #

If set, specifies the default maximum duration for executions of this workflow type. You can override this default when starting an execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.

The duration is specified in seconds; an integer greater than or equal to 0. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for defaultExecutionStartToCloseTimeout; there is a one-year max limit on the time that a workflow execution can run. Exceeding this limit always causes the workflow execution to time out.

registerWorkflowType_defaultTaskStartToCloseTimeout :: Lens' RegisterWorkflowType (Maybe Text) Source #

If set, specifies the default maximum duration of decision tasks for this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

registerWorkflowType_description :: Lens' RegisterWorkflowType (Maybe Text) Source #

Textual description of the workflow type.

registerWorkflowType_domain :: Lens' RegisterWorkflowType Text Source #

The name of the domain in which to register the workflow type.

registerWorkflowType_name :: Lens' RegisterWorkflowType Text Source #

The name of the workflow type.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

registerWorkflowType_version :: Lens' RegisterWorkflowType Text Source #

The version of the workflow type.

The workflow type consists of the name and version, the combination of which must be unique within the domain. To get a list of all currently registered workflow types, use the ListWorkflowTypes action.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

ListWorkflowTypes

listWorkflowTypes_nextPageToken :: Lens' ListWorkflowTypes (Maybe Text) Source #

If NextPageToken is returned there are more results available. The value of NextPageToken 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 60 seconds. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

The configured maximumPageSize determines how many results can be returned in a single call.

listWorkflowTypes_reverseOrder :: Lens' ListWorkflowTypes (Maybe Bool) Source #

When set to true, returns the results in reverse order. By default the results are returned in ascending alphabetical order of the name of the workflow types.

listWorkflowTypes_name :: Lens' ListWorkflowTypes (Maybe Text) Source #

If specified, lists the workflow type with this name.

listWorkflowTypes_maximumPageSize :: Lens' ListWorkflowTypes (Maybe Natural) Source #

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

listWorkflowTypes_domain :: Lens' ListWorkflowTypes Text Source #

The name of the domain in which the workflow types have been registered.

listWorkflowTypes_registrationStatus :: Lens' ListWorkflowTypes RegistrationStatus Source #

Specifies the registration status of the workflow types to list.

listWorkflowTypesResponse_nextPageToken :: Lens' ListWorkflowTypesResponse (Maybe Text) Source #

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) for the Amazon SWF domain.

RespondActivityTaskFailed

respondActivityTaskFailed_reason :: Lens' RespondActivityTaskFailed (Maybe Text) Source #

Description of the error that may assist in diagnostics.

respondActivityTaskFailed_taskToken :: Lens' RespondActivityTaskFailed Text Source #

The taskToken of the ActivityTask.

taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

CountOpenWorkflowExecutions

countOpenWorkflowExecutions_executionFilter :: Lens' CountOpenWorkflowExecutions (Maybe WorkflowExecutionFilter) Source #

If specified, only workflow executions matching the WorkflowId in the filter are counted.

executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

countOpenWorkflowExecutions_typeFilter :: Lens' CountOpenWorkflowExecutions (Maybe WorkflowTypeFilter) Source #

Specifies the type of the workflow executions to be counted.

executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

countOpenWorkflowExecutions_tagFilter :: Lens' CountOpenWorkflowExecutions (Maybe TagFilter) Source #

If specified, only executions that have a tag that matches the filter are counted.

executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

countOpenWorkflowExecutions_domain :: Lens' CountOpenWorkflowExecutions Text Source #

The name of the domain containing the workflow executions to count.

countOpenWorkflowExecutions_startTimeFilter :: Lens' CountOpenWorkflowExecutions ExecutionTimeFilter Source #

Specifies the start time criteria that workflow executions must meet in order to be counted.

workflowExecutionCount_truncated :: Lens' WorkflowExecutionCount (Maybe Bool) Source #

If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.

UndeprecateDomain

undeprecateDomain_name :: Lens' UndeprecateDomain Text Source #

The name of the domain of the deprecated workflow type.

DescribeWorkflowType

describeWorkflowType_domain :: Lens' DescribeWorkflowType Text Source #

The name of the domain in which this workflow type is registered.

describeWorkflowTypeResponse_typeInfo :: Lens' DescribeWorkflowTypeResponse WorkflowTypeInfo Source #

General information about the workflow type.

The status of the workflow type (returned in the WorkflowTypeInfo structure) can be one of the following.

  • REGISTERED – The type is registered and available. Workers supporting this type should be running.
  • DEPRECATED – The type was deprecated using DeprecateWorkflowType, but is still in use. You should keep workers supporting this type running. You cannot create new workflow executions of this type.

describeWorkflowTypeResponse_configuration :: Lens' DescribeWorkflowTypeResponse WorkflowTypeConfiguration Source #

Configuration settings of the workflow type registered through RegisterWorkflowType

DeprecateWorkflowType

deprecateWorkflowType_domain :: Lens' DeprecateWorkflowType Text Source #

The name of the domain in which the workflow type is registered.

RequestCancelWorkflowExecution

requestCancelWorkflowExecution_domain :: Lens' RequestCancelWorkflowExecution Text Source #

The name of the domain containing the workflow execution to cancel.

requestCancelWorkflowExecution_workflowId :: Lens' RequestCancelWorkflowExecution Text Source #

The workflowId of the workflow execution to cancel.

RegisterDomain

registerDomain_description :: Lens' RegisterDomain (Maybe Text) Source #

A text description of the domain.

registerDomain_tags :: Lens' RegisterDomain (Maybe [ResourceTag]) Source #

Tags to be added when registering a domain.

Tags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.

registerDomain_name :: Lens' RegisterDomain Text Source #

Name of the domain to register. The name must be unique in the region that the domain is registered in.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

registerDomain_workflowExecutionRetentionPeriodInDays :: Lens' RegisterDomain Text Source #

The duration (in days) that records and histories of workflow executions on the domain should be kept by the service. After the retention period, the workflow execution isn't available in the results of visibility calls.

If you pass the value NONE or 0 (zero), then the workflow execution history isn't retained. As soon as the workflow execution completes, the execution record and its history are deleted.

The maximum workflow execution retention period is 90 days. For more information about Amazon SWF service limits, see: Amazon SWF Service Limits in the Amazon SWF Developer Guide.

RespondDecisionTaskCompleted

respondDecisionTaskCompleted_decisions :: Lens' RespondDecisionTaskCompleted (Maybe [Decision]) Source #

The list of decisions (possibly empty) made by the decider while processing this decision task. See the docs for the Decision structure for details.

respondDecisionTaskCompleted_taskToken :: Lens' RespondDecisionTaskCompleted Text Source #

The taskToken from the DecisionTask.

taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

PollForActivityTask

pollForActivityTask_identity :: Lens' PollForActivityTask (Maybe Text) Source #

Identity of the worker making the request, recorded in the ActivityTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

pollForActivityTask_domain :: Lens' PollForActivityTask Text Source #

The name of the domain that contains the task lists being polled.

pollForActivityTask_taskList :: Lens' PollForActivityTask TaskList Source #

Specifies the task list to poll for activity tasks.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

pollForActivityTaskResponse_input :: Lens' PollForActivityTaskResponse (Maybe Text) Source #

The inputs provided when the activity task was scheduled. The form of the input is user defined and should be meaningful to the activity implementation.

pollForActivityTaskResponse_taskToken :: Lens' PollForActivityTaskResponse (Maybe Text) Source #

The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task.

pollForActivityTaskResponse_startedEventId :: Lens' PollForActivityTaskResponse Integer Source #

The ID of the ActivityTaskStarted event recorded in the history.

RespondActivityTaskCompleted

respondActivityTaskCompleted_result :: Lens' RespondActivityTaskCompleted (Maybe Text) Source #

The result of the activity task. It is a free form string that is implementation specific.

respondActivityTaskCompleted_taskToken :: Lens' RespondActivityTaskCompleted Text Source #

The taskToken of the ActivityTask.

taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

DescribeWorkflowExecution

describeWorkflowExecution_domain :: Lens' DescribeWorkflowExecution Text Source #

The name of the domain containing the workflow execution.

describeWorkflowExecutionResponse_latestActivityTaskTimestamp :: Lens' DescribeWorkflowExecutionResponse (Maybe UTCTime) Source #

The time when the last activity task was scheduled for this workflow execution. You can use this information to determine if the workflow has not made progress for an unusually long period of time and might require a corrective action.

describeWorkflowExecutionResponse_latestExecutionContext :: Lens' DescribeWorkflowExecutionResponse (Maybe Text) Source #

The latest executionContext provided by the decider for this workflow execution. A decider can provide an executionContext (a free-form string) when closing a decision task using RespondDecisionTaskCompleted.

describeWorkflowExecutionResponse_executionConfiguration :: Lens' DescribeWorkflowExecutionResponse WorkflowExecutionConfiguration Source #

The configuration settings for this workflow execution including timeout values, tasklist etc.

describeWorkflowExecutionResponse_openCounts :: Lens' DescribeWorkflowExecutionResponse WorkflowExecutionOpenCounts Source #

The number of tasks for this workflow execution. This includes open and closed tasks of all types.

SignalWorkflowExecution

signalWorkflowExecution_input :: Lens' SignalWorkflowExecution (Maybe Text) Source #

Data to attach to the WorkflowExecutionSignaled event in the target workflow execution's history.

signalWorkflowExecution_runId :: Lens' SignalWorkflowExecution (Maybe Text) Source #

The runId of the workflow execution to signal.

signalWorkflowExecution_domain :: Lens' SignalWorkflowExecution Text Source #

The name of the domain containing the workflow execution to signal.

signalWorkflowExecution_workflowId :: Lens' SignalWorkflowExecution Text Source #

The workflowId of the workflow execution to signal.

signalWorkflowExecution_signalName :: Lens' SignalWorkflowExecution Text Source #

The name of the signal. This name must be meaningful to the target workflow.

CountPendingDecisionTasks

countPendingDecisionTasks_domain :: Lens' CountPendingDecisionTasks Text Source #

The name of the domain that contains the task list.

pendingTaskCount_truncated :: Lens' PendingTaskCount (Maybe Bool) Source #

If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.

pendingTaskCount_count :: Lens' PendingTaskCount Natural Source #

The number of tasks in the task list.

ListClosedWorkflowExecutions

listClosedWorkflowExecutions_nextPageToken :: Lens' ListClosedWorkflowExecutions (Maybe Text) Source #

If NextPageToken is returned there are more results available. The value of NextPageToken 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 60 seconds. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

The configured maximumPageSize determines how many results can be returned in a single call.

listClosedWorkflowExecutions_executionFilter :: Lens' ListClosedWorkflowExecutions (Maybe WorkflowExecutionFilter) Source #

If specified, only workflow executions matching the workflow ID specified in the filter are returned.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

listClosedWorkflowExecutions_closeStatusFilter :: Lens' ListClosedWorkflowExecutions (Maybe CloseStatusFilter) Source #

If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

listClosedWorkflowExecutions_typeFilter :: Lens' ListClosedWorkflowExecutions (Maybe WorkflowTypeFilter) Source #

If specified, only executions of the type specified in the filter are returned.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

listClosedWorkflowExecutions_closeTimeFilter :: Lens' ListClosedWorkflowExecutions (Maybe ExecutionTimeFilter) Source #

If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times.

startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

listClosedWorkflowExecutions_reverseOrder :: Lens' ListClosedWorkflowExecutions (Maybe Bool) Source #

When set to true, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.

listClosedWorkflowExecutions_tagFilter :: Lens' ListClosedWorkflowExecutions (Maybe TagFilter) Source #

If specified, only executions that have the matching tag are listed.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

listClosedWorkflowExecutions_startTimeFilter :: Lens' ListClosedWorkflowExecutions (Maybe ExecutionTimeFilter) Source #

If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times.

startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

listClosedWorkflowExecutions_maximumPageSize :: Lens' ListClosedWorkflowExecutions (Maybe Natural) Source #

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

listClosedWorkflowExecutions_domain :: Lens' ListClosedWorkflowExecutions Text Source #

The name of the domain that contains the workflow executions to list.

workflowExecutionInfos_nextPageToken :: Lens' WorkflowExecutionInfos (Maybe Text) Source #

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

RecordActivityTaskHeartbeat

recordActivityTaskHeartbeat_details :: Lens' RecordActivityTaskHeartbeat (Maybe Text) Source #

If specified, contains details about the progress of the task.

recordActivityTaskHeartbeat_taskToken :: Lens' RecordActivityTaskHeartbeat Text Source #

The taskToken of the ActivityTask.

taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

DescribeDomain

describeDomain_name :: Lens' DescribeDomain Text Source #

The name of the domain to describe.

describeDomainResponse_domainInfo :: Lens' DescribeDomainResponse DomainInfo Source #

The basic information about a domain, such as its name, status, and description.

describeDomainResponse_configuration :: Lens' DescribeDomainResponse DomainConfiguration Source #

The domain configuration. Currently, this includes only the domain's retention period.

GetWorkflowExecutionHistory

getWorkflowExecutionHistory_nextPageToken :: Lens' GetWorkflowExecutionHistory (Maybe Text) Source #

If NextPageToken is returned there are more results available. The value of NextPageToken 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 60 seconds. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

The configured maximumPageSize determines how many results can be returned in a single call.

getWorkflowExecutionHistory_reverseOrder :: Lens' GetWorkflowExecutionHistory (Maybe Bool) Source #

When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.

getWorkflowExecutionHistory_maximumPageSize :: Lens' GetWorkflowExecutionHistory (Maybe Natural) Source #

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

getWorkflowExecutionHistory_domain :: Lens' GetWorkflowExecutionHistory Text Source #

The name of the domain containing the workflow execution.

getWorkflowExecutionHistory_execution :: Lens' GetWorkflowExecutionHistory WorkflowExecution Source #

Specifies the workflow execution for which to return the history.

getWorkflowExecutionHistoryResponse_nextPageToken :: Lens' GetWorkflowExecutionHistoryResponse (Maybe Text) Source #

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

DeprecateDomain

deprecateDomain_name :: Lens' DeprecateDomain Text Source #

The name of the domain to deprecate.

UndeprecateWorkflowType

undeprecateWorkflowType_domain :: Lens' UndeprecateWorkflowType Text Source #

The name of the domain of the deprecated workflow type.

undeprecateWorkflowType_workflowType :: Lens' UndeprecateWorkflowType WorkflowType Source #

The name of the domain of the deprecated workflow type.

TerminateWorkflowExecution

terminateWorkflowExecution_reason :: Lens' TerminateWorkflowExecution (Maybe Text) Source #

A descriptive reason for terminating the workflow execution.

terminateWorkflowExecution_runId :: Lens' TerminateWorkflowExecution (Maybe Text) Source #

The runId of the workflow execution to terminate.

terminateWorkflowExecution_childPolicy :: Lens' TerminateWorkflowExecution (Maybe ChildPolicy) Source #

If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution.

The supported child policies are:

  • TERMINATE – The child executions are terminated.
  • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
  • ABANDON – No action is taken. The child executions continue to run.

A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

terminateWorkflowExecution_details :: Lens' TerminateWorkflowExecution (Maybe Text) Source #

Details for terminating the workflow execution.

terminateWorkflowExecution_domain :: Lens' TerminateWorkflowExecution Text Source #

The domain of the workflow execution to terminate.

terminateWorkflowExecution_workflowId :: Lens' TerminateWorkflowExecution Text Source #

The workflowId of the workflow execution to terminate.

DescribeActivityType

describeActivityType_domain :: Lens' DescribeActivityType Text Source #

The name of the domain in which the activity type is registered.

describeActivityType_activityType :: Lens' DescribeActivityType ActivityType Source #

The activity type to get information about. Activity types are identified by the name and version that were supplied when the activity was registered.

describeActivityTypeResponse_typeInfo :: Lens' DescribeActivityTypeResponse ActivityTypeInfo Source #

General information about the activity type.

The status of activity type (returned in the ActivityTypeInfo structure) can be one of the following.

  • REGISTERED – The type is registered and available. Workers supporting this type should be running.
  • DEPRECATED – The type was deprecated using DeprecateActivityType, but is still in use. You should keep workers supporting this type running. You cannot create new tasks of this type.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) for the Amazon SWF domain.

tagResource_tags :: Lens' TagResource [ResourceTag] Source #

The list of tags to add to a domain.

Tags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.

DeprecateActivityType

deprecateActivityType_domain :: Lens' DeprecateActivityType Text Source #

The name of the domain in which the activity type is registered.

UndeprecateActivityType

undeprecateActivityType_domain :: Lens' UndeprecateActivityType Text Source #

The name of the domain of the deprecated activity type.

CountClosedWorkflowExecutions

countClosedWorkflowExecutions_executionFilter :: Lens' CountClosedWorkflowExecutions (Maybe WorkflowExecutionFilter) Source #

If specified, only workflow executions matching the WorkflowId in the filter are counted.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

countClosedWorkflowExecutions_closeStatusFilter :: Lens' CountClosedWorkflowExecutions (Maybe CloseStatusFilter) Source #

If specified, only workflow executions that match this close status are counted. This filter has an affect only if executionStatus is specified as CLOSED.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

countClosedWorkflowExecutions_typeFilter :: Lens' CountClosedWorkflowExecutions (Maybe WorkflowTypeFilter) Source #

If specified, indicates the type of the workflow executions to be counted.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

countClosedWorkflowExecutions_closeTimeFilter :: Lens' CountClosedWorkflowExecutions (Maybe ExecutionTimeFilter) Source #

If specified, only workflow executions that meet the close time criteria of the filter are counted.

startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

countClosedWorkflowExecutions_tagFilter :: Lens' CountClosedWorkflowExecutions (Maybe TagFilter) Source #

If specified, only executions that have a tag that matches the filter are counted.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

countClosedWorkflowExecutions_startTimeFilter :: Lens' CountClosedWorkflowExecutions (Maybe ExecutionTimeFilter) Source #

If specified, only workflow executions that meet the start time criteria of the filter are counted.

startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

countClosedWorkflowExecutions_domain :: Lens' CountClosedWorkflowExecutions Text Source #

The name of the domain containing the workflow executions to count.

workflowExecutionCount_truncated :: Lens' WorkflowExecutionCount (Maybe Bool) Source #

If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) for the Amazon SWF domain.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

The list of tags to remove from the Amazon SWF domain.

RespondActivityTaskCanceled

respondActivityTaskCanceled_taskToken :: Lens' RespondActivityTaskCanceled Text Source #

The taskToken of the ActivityTask.

taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

StartWorkflowExecution

startWorkflowExecution_tagList :: Lens' StartWorkflowExecution (Maybe [Text]) Source #

The list of tags to associate with the workflow execution. You can specify a maximum of 5 tags. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

startWorkflowExecution_taskStartToCloseTimeout :: Lens' StartWorkflowExecution (Maybe Text) Source #

Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.

startWorkflowExecution_lambdaRole :: Lens' StartWorkflowExecution (Maybe Text) Source #

The IAM role to attach to this workflow execution.

Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't attach an IAM role, any attempt to schedule a Lambda task fails. This results in a ScheduleLambdaFunctionFailed history event. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.

startWorkflowExecution_input :: Lens' StartWorkflowExecution (Maybe Text) Source #

The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting. This input is made available to the new workflow execution in the WorkflowExecutionStarted history event.

startWorkflowExecution_executionStartToCloseTimeout :: Lens' StartWorkflowExecution (Maybe Text) Source #

The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

The duration is specified in seconds; an integer greater than or equal to 0. Exceeding this limit causes the workflow execution to time out. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for this timeout; there is a one-year max limit on the time that a workflow execution can run.

An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned.

startWorkflowExecution_taskList :: Lens' StartWorkflowExecution (Maybe TaskList) Source #

The task list to use for the decision tasks generated for this workflow execution. This overrides the defaultTaskList specified when registering the workflow type.

A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault is returned.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

startWorkflowExecution_taskPriority :: Lens' StartWorkflowExecution (Maybe Text) Source #

The task priority to use for this workflow execution. This overrides any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

startWorkflowExecution_childPolicy :: Lens' StartWorkflowExecution (Maybe ChildPolicy) Source #

If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.

The supported child policies are:

  • TERMINATE – The child executions are terminated.
  • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
  • ABANDON – No action is taken. The child executions continue to run.

A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

startWorkflowExecution_domain :: Lens' StartWorkflowExecution Text Source #

The name of the domain in which the workflow execution is created.

startWorkflowExecution_workflowId :: Lens' StartWorkflowExecution Text Source #

The user defined identifier associated with the workflow execution. You can use this to associate a custom identifier with the workflow execution. You may specify the same identifier if a workflow execution is logically a restart of a previous execution. You cannot have two open workflow executions with the same workflowId at the same time within the same domain.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

startWorkflowExecutionResponse_runId :: Lens' StartWorkflowExecutionResponse (Maybe Text) Source #

The runId of a workflow execution. This ID is generated by the service and can be used to uniquely identify the workflow execution within a domain.

PollForDecisionTask

pollForDecisionTask_nextPageToken :: Lens' PollForDecisionTask (Maybe Text) Source #

If NextPageToken is returned there are more results available. The value of NextPageToken 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 60 seconds. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

The configured maximumPageSize determines how many results can be returned in a single call.

The nextPageToken returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with the nextPageToken) to retrieve the next page of history records. Calling PollForDecisionTask with a nextPageToken doesn't return a new decision task.

pollForDecisionTask_reverseOrder :: Lens' PollForDecisionTask (Maybe Bool) Source #

When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimestamp of the events.

pollForDecisionTask_maximumPageSize :: Lens' PollForDecisionTask (Maybe Natural) Source #

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

pollForDecisionTask_identity :: Lens' PollForDecisionTask (Maybe Text) Source #

Identity of the decider making the request, which is recorded in the DecisionTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

pollForDecisionTask_domain :: Lens' PollForDecisionTask Text Source #

The name of the domain containing the task lists to poll.

pollForDecisionTask_taskList :: Lens' PollForDecisionTask TaskList Source #

Specifies the task list to poll for decision tasks.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

pollForDecisionTaskResponse_nextPageToken :: Lens' PollForDecisionTaskResponse (Maybe Text) Source #

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

pollForDecisionTaskResponse_workflowType :: Lens' PollForDecisionTaskResponse (Maybe WorkflowType) Source #

The type of the workflow execution for which this decision task was created.

pollForDecisionTaskResponse_previousStartedEventId :: Lens' PollForDecisionTaskResponse (Maybe Integer) Source #

The ID of the DecisionTaskStarted event of the previous decision task of this workflow execution that was processed by the decider. This can be used to determine the events in the history new since the last decision task received by the decider.

pollForDecisionTaskResponse_events :: Lens' PollForDecisionTaskResponse (Maybe [HistoryEvent]) Source #

A paginated list of history events of the workflow execution. The decider uses this during the processing of the decision task.

pollForDecisionTaskResponse_taskToken :: Lens' PollForDecisionTaskResponse (Maybe Text) Source #

The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task.

pollForDecisionTaskResponse_workflowExecution :: Lens' PollForDecisionTaskResponse (Maybe WorkflowExecution) Source #

The workflow execution for which this decision task was created.

pollForDecisionTaskResponse_startedEventId :: Lens' PollForDecisionTaskResponse Integer Source #

The ID of the DecisionTaskStarted event recorded in the history.

ListDomains

listDomains_nextPageToken :: Lens' ListDomains (Maybe Text) Source #

If NextPageToken is returned there are more results available. The value of NextPageToken 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 60 seconds. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

The configured maximumPageSize determines how many results can be returned in a single call.

listDomains_reverseOrder :: Lens' ListDomains (Maybe Bool) Source #

When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the domains.

listDomains_maximumPageSize :: Lens' ListDomains (Maybe Natural) Source #

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

listDomains_registrationStatus :: Lens' ListDomains RegistrationStatus Source #

Specifies the registration status of the domains to list.

listDomainsResponse_nextPageToken :: Lens' ListDomainsResponse (Maybe Text) Source #

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

Types

ActivityTaskCancelRequestedEventAttributes

activityTaskCancelRequestedEventAttributes_decisionTaskCompletedEventId :: Lens' ActivityTaskCancelRequestedEventAttributes Integer Source #

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelActivityTask decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

ActivityTaskCanceledEventAttributes

activityTaskCanceledEventAttributes_latestCancelRequestedEventId :: Lens' ActivityTaskCanceledEventAttributes (Maybe Integer) Source #

If set, contains the ID of the last ActivityTaskCancelRequested event recorded for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

activityTaskCanceledEventAttributes_scheduledEventId :: Lens' ActivityTaskCanceledEventAttributes Integer Source #

The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

activityTaskCanceledEventAttributes_startedEventId :: Lens' ActivityTaskCanceledEventAttributes Integer Source #

The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

ActivityTaskCompletedEventAttributes

activityTaskCompletedEventAttributes_scheduledEventId :: Lens' ActivityTaskCompletedEventAttributes Integer Source #

The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

activityTaskCompletedEventAttributes_startedEventId :: Lens' ActivityTaskCompletedEventAttributes Integer Source #

The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

ActivityTaskFailedEventAttributes

activityTaskFailedEventAttributes_scheduledEventId :: Lens' ActivityTaskFailedEventAttributes Integer Source #

The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

activityTaskFailedEventAttributes_startedEventId :: Lens' ActivityTaskFailedEventAttributes Integer Source #

The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

ActivityTaskScheduledEventAttributes

activityTaskScheduledEventAttributes_control :: Lens' ActivityTaskScheduledEventAttributes (Maybe Text) Source #

Data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the activity.

activityTaskScheduledEventAttributes_heartbeatTimeout :: Lens' ActivityTaskScheduledEventAttributes (Maybe Text) Source #

The maximum time before which the worker processing this task must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or return a result, it is ignored.

activityTaskScheduledEventAttributes_taskPriority :: Lens' ActivityTaskScheduledEventAttributes (Maybe Text) Source #

The priority to assign to the scheduled activity task. If set, this overrides any default priority value that was assigned when the activity type was registered.

Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

activityTaskScheduledEventAttributes_scheduleToStartTimeout :: Lens' ActivityTaskScheduledEventAttributes (Maybe Text) Source #

The maximum amount of time the activity task can wait to be assigned to a worker.

activityTaskScheduledEventAttributes_startToCloseTimeout :: Lens' ActivityTaskScheduledEventAttributes (Maybe Text) Source #

The maximum amount of time a worker may take to process the activity task.

activityTaskScheduledEventAttributes_taskList :: Lens' ActivityTaskScheduledEventAttributes TaskList Source #

The task list in which the activity task has been scheduled.

activityTaskScheduledEventAttributes_decisionTaskCompletedEventId :: Lens' ActivityTaskScheduledEventAttributes Integer Source #

The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

ActivityTaskStartedEventAttributes

activityTaskStartedEventAttributes_identity :: Lens' ActivityTaskStartedEventAttributes (Maybe Text) Source #

Identity of the worker that was assigned this task. This aids diagnostics when problems arise. The form of this identity is user defined.

activityTaskStartedEventAttributes_scheduledEventId :: Lens' ActivityTaskStartedEventAttributes Integer Source #

The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

ActivityTaskTimedOutEventAttributes

activityTaskTimedOutEventAttributes_details :: Lens' ActivityTaskTimedOutEventAttributes (Maybe Text) Source #

Contains the content of the details parameter for the last call made by the activity to RecordActivityTaskHeartbeat.

activityTaskTimedOutEventAttributes_scheduledEventId :: Lens' ActivityTaskTimedOutEventAttributes Integer Source #

The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

activityTaskTimedOutEventAttributes_startedEventId :: Lens' ActivityTaskTimedOutEventAttributes Integer Source #

The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

ActivityType

activityType_name :: Lens' ActivityType Text Source #

The name of this activity.

The combination of activity type name and version must be unique within a domain.

activityType_version :: Lens' ActivityType Text Source #

The version of this activity.

The combination of activity type name and version must be unique with in a domain.

ActivityTypeConfiguration

activityTypeConfiguration_defaultTaskScheduleToStartTimeout :: Lens' ActivityTypeConfiguration (Maybe Text) Source #

The default maximum duration, specified when registering the activity type, that a task of an activity type can wait before being assigned to a worker. You can override this default when scheduling a task through the ScheduleActivityTask Decision.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

activityTypeConfiguration_defaultTaskList :: Lens' ActivityTypeConfiguration (Maybe TaskList) Source #

The default task list specified for this activity type at registration. This default is used if a task list isn't provided when a task is scheduled through the ScheduleActivityTask Decision. You can override the default registered task list when scheduling a task through the ScheduleActivityTask Decision.

activityTypeConfiguration_defaultTaskPriority :: Lens' ActivityTypeConfiguration (Maybe Text) Source #

The default task priority for tasks of this activity type, specified at registration. If not set, then 0 is used as the default priority. This default can be overridden when scheduling an activity task.

Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

activityTypeConfiguration_defaultTaskHeartbeatTimeout :: Lens' ActivityTypeConfiguration (Maybe Text) Source #

The default maximum time, in seconds, before which a worker processing a task must report progress by calling RecordActivityTaskHeartbeat.

You can specify this value only when registering an activity type. The registered default value can be overridden when you schedule a task through the ScheduleActivityTask Decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

activityTypeConfiguration_defaultTaskScheduleToCloseTimeout :: Lens' ActivityTypeConfiguration (Maybe Text) Source #

The default maximum duration, specified when registering the activity type, for tasks of this activity type. You can override this default when scheduling a task through the ScheduleActivityTask Decision.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

activityTypeConfiguration_defaultTaskStartToCloseTimeout :: Lens' ActivityTypeConfiguration (Maybe Text) Source #

The default maximum duration for tasks of an activity type specified when registering the activity type. You can override this default when scheduling a task through the ScheduleActivityTask Decision.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

ActivityTypeInfo

activityTypeInfo_deprecationDate :: Lens' ActivityTypeInfo (Maybe UTCTime) Source #

If DEPRECATED, the date and time DeprecateActivityType was called.

activityTypeInfo_description :: Lens' ActivityTypeInfo (Maybe Text) Source #

The description of the activity type provided in RegisterActivityType.

activityTypeInfo_activityType :: Lens' ActivityTypeInfo ActivityType Source #

The ActivityType type structure representing the activity type.

activityTypeInfo_status :: Lens' ActivityTypeInfo RegistrationStatus Source #

The current status of the activity type.

activityTypeInfo_creationDate :: Lens' ActivityTypeInfo UTCTime Source #

The date and time this activity type was created through RegisterActivityType.

CancelTimerDecisionAttributes

CancelTimerFailedEventAttributes

cancelTimerFailedEventAttributes_timerId :: Lens' CancelTimerFailedEventAttributes Text Source #

The timerId provided in the CancelTimer decision that failed.

cancelTimerFailedEventAttributes_cause :: Lens' CancelTimerFailedEventAttributes CancelTimerFailedCause Source #

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

cancelTimerFailedEventAttributes_decisionTaskCompletedEventId :: Lens' CancelTimerFailedEventAttributes Integer Source #

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelTimer decision to cancel this timer. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

CancelWorkflowExecutionDecisionAttributes

CancelWorkflowExecutionFailedEventAttributes

cancelWorkflowExecutionFailedEventAttributes_cause :: Lens' CancelWorkflowExecutionFailedEventAttributes CancelWorkflowExecutionFailedCause Source #

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

cancelWorkflowExecutionFailedEventAttributes_decisionTaskCompletedEventId :: Lens' CancelWorkflowExecutionFailedEventAttributes Integer Source #

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

ChildWorkflowExecutionCanceledEventAttributes

childWorkflowExecutionCanceledEventAttributes_initiatedEventId :: Lens' ChildWorkflowExecutionCanceledEventAttributes Integer Source #

The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

childWorkflowExecutionCanceledEventAttributes_startedEventId :: Lens' ChildWorkflowExecutionCanceledEventAttributes Integer Source #

The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

ChildWorkflowExecutionCompletedEventAttributes

childWorkflowExecutionCompletedEventAttributes_initiatedEventId :: Lens' ChildWorkflowExecutionCompletedEventAttributes Integer Source #

The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

childWorkflowExecutionCompletedEventAttributes_startedEventId :: Lens' ChildWorkflowExecutionCompletedEventAttributes Integer Source #

The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

ChildWorkflowExecutionFailedEventAttributes

childWorkflowExecutionFailedEventAttributes_initiatedEventId :: Lens' ChildWorkflowExecutionFailedEventAttributes Integer Source #

The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

childWorkflowExecutionFailedEventAttributes_startedEventId :: Lens' ChildWorkflowExecutionFailedEventAttributes Integer Source #

The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

ChildWorkflowExecutionStartedEventAttributes

childWorkflowExecutionStartedEventAttributes_initiatedEventId :: Lens' ChildWorkflowExecutionStartedEventAttributes Integer Source #

The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

ChildWorkflowExecutionTerminatedEventAttributes

childWorkflowExecutionTerminatedEventAttributes_initiatedEventId :: Lens' ChildWorkflowExecutionTerminatedEventAttributes Integer Source #

The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

childWorkflowExecutionTerminatedEventAttributes_startedEventId :: Lens' ChildWorkflowExecutionTerminatedEventAttributes Integer Source #

The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

ChildWorkflowExecutionTimedOutEventAttributes

childWorkflowExecutionTimedOutEventAttributes_initiatedEventId :: Lens' ChildWorkflowExecutionTimedOutEventAttributes Integer Source #

The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

childWorkflowExecutionTimedOutEventAttributes_startedEventId :: Lens' ChildWorkflowExecutionTimedOutEventAttributes Integer Source #

The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

CloseStatusFilter

closeStatusFilter_status :: Lens' CloseStatusFilter CloseStatus Source #

The close status that must match the close status of an execution for it to meet the criteria of this filter.

CompleteWorkflowExecutionDecisionAttributes

completeWorkflowExecutionDecisionAttributes_result :: Lens' CompleteWorkflowExecutionDecisionAttributes (Maybe Text) Source #

The result of the workflow execution. The form of the result is implementation defined.

CompleteWorkflowExecutionFailedEventAttributes

completeWorkflowExecutionFailedEventAttributes_cause :: Lens' CompleteWorkflowExecutionFailedEventAttributes CompleteWorkflowExecutionFailedCause Source #

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

completeWorkflowExecutionFailedEventAttributes_decisionTaskCompletedEventId :: Lens' CompleteWorkflowExecutionFailedEventAttributes Integer Source #

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CompleteWorkflowExecution decision to complete this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

ContinueAsNewWorkflowExecutionDecisionAttributes

continueAsNewWorkflowExecutionDecisionAttributes_tagList :: Lens' ContinueAsNewWorkflowExecutionDecisionAttributes (Maybe [Text]) Source #

The list of tags to associate with the new workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

continueAsNewWorkflowExecutionDecisionAttributes_taskStartToCloseTimeout :: Lens' ContinueAsNewWorkflowExecutionDecisionAttributes (Maybe Text) Source #

Specifies the maximum duration of decision tasks for the new workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

A task start-to-close timeout for the new workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.

continueAsNewWorkflowExecutionDecisionAttributes_executionStartToCloseTimeout :: Lens' ContinueAsNewWorkflowExecutionDecisionAttributes (Maybe Text) Source #

If set, specifies the total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this field. If neither this field is set nor a default execution start-to-close timeout was specified at registration time then a fault is returned.

continueAsNewWorkflowExecutionDecisionAttributes_taskList :: Lens' ContinueAsNewWorkflowExecutionDecisionAttributes (Maybe TaskList) Source #

The task list to use for the decisions of the new (continued) workflow execution.

continueAsNewWorkflowExecutionDecisionAttributes_taskPriority :: Lens' ContinueAsNewWorkflowExecutionDecisionAttributes (Maybe Text) Source #

The task priority that, if set, specifies the priority for the decision tasks for this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

continueAsNewWorkflowExecutionDecisionAttributes_childPolicy :: Lens' ContinueAsNewWorkflowExecutionDecisionAttributes (Maybe ChildPolicy) Source #

If set, specifies the policy to use for the child workflow executions of the new execution if it is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.

The supported child policies are:

  • TERMINATE – The child executions are terminated.
  • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
  • ABANDON – No action is taken. The child executions continue to run.

A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

ContinueAsNewWorkflowExecutionFailedEventAttributes

continueAsNewWorkflowExecutionFailedEventAttributes_cause :: Lens' ContinueAsNewWorkflowExecutionFailedEventAttributes ContinueAsNewWorkflowExecutionFailedCause Source #

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

continueAsNewWorkflowExecutionFailedEventAttributes_decisionTaskCompletedEventId :: Lens' ContinueAsNewWorkflowExecutionFailedEventAttributes Integer Source #

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the ContinueAsNewWorkflowExecution decision that started this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

Decision

decision_requestCancelExternalWorkflowExecutionDecisionAttributes :: Lens' Decision (Maybe RequestCancelExternalWorkflowExecutionDecisionAttributes) Source #

Provides the details of the RequestCancelExternalWorkflowExecution decision. It isn't set for other decision types.

decision_scheduleActivityTaskDecisionAttributes :: Lens' Decision (Maybe ScheduleActivityTaskDecisionAttributes) Source #

Provides the details of the ScheduleActivityTask decision. It isn't set for other decision types.

decision_signalExternalWorkflowExecutionDecisionAttributes :: Lens' Decision (Maybe SignalExternalWorkflowExecutionDecisionAttributes) Source #

Provides the details of the SignalExternalWorkflowExecution decision. It isn't set for other decision types.

decision_startTimerDecisionAttributes :: Lens' Decision (Maybe StartTimerDecisionAttributes) Source #

Provides the details of the StartTimer decision. It isn't set for other decision types.

decision_recordMarkerDecisionAttributes :: Lens' Decision (Maybe RecordMarkerDecisionAttributes) Source #

Provides the details of the RecordMarker decision. It isn't set for other decision types.

decision_failWorkflowExecutionDecisionAttributes :: Lens' Decision (Maybe FailWorkflowExecutionDecisionAttributes) Source #

Provides the details of the FailWorkflowExecution decision. It isn't set for other decision types.

decision_startChildWorkflowExecutionDecisionAttributes :: Lens' Decision (Maybe StartChildWorkflowExecutionDecisionAttributes) Source #

Provides the details of the StartChildWorkflowExecution decision. It isn't set for other decision types.

decision_completeWorkflowExecutionDecisionAttributes :: Lens' Decision (Maybe CompleteWorkflowExecutionDecisionAttributes) Source #

Provides the details of the CompleteWorkflowExecution decision. It isn't set for other decision types.

decision_scheduleLambdaFunctionDecisionAttributes :: Lens' Decision (Maybe ScheduleLambdaFunctionDecisionAttributes) Source #

Provides the details of the ScheduleLambdaFunction decision. It isn't set for other decision types.

decision_requestCancelActivityTaskDecisionAttributes :: Lens' Decision (Maybe RequestCancelActivityTaskDecisionAttributes) Source #

Provides the details of the RequestCancelActivityTask decision. It isn't set for other decision types.

decision_cancelWorkflowExecutionDecisionAttributes :: Lens' Decision (Maybe CancelWorkflowExecutionDecisionAttributes) Source #

Provides the details of the CancelWorkflowExecution decision. It isn't set for other decision types.

decision_cancelTimerDecisionAttributes :: Lens' Decision (Maybe CancelTimerDecisionAttributes) Source #

Provides the details of the CancelTimer decision. It isn't set for other decision types.

decision_continueAsNewWorkflowExecutionDecisionAttributes :: Lens' Decision (Maybe ContinueAsNewWorkflowExecutionDecisionAttributes) Source #

Provides the details of the ContinueAsNewWorkflowExecution decision. It isn't set for other decision types.

decision_decisionType :: Lens' Decision DecisionType Source #

Specifies the type of the decision.

DecisionTaskCompletedEventAttributes

decisionTaskCompletedEventAttributes_scheduledEventId :: Lens' DecisionTaskCompletedEventAttributes Integer Source #

The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

decisionTaskCompletedEventAttributes_startedEventId :: Lens' DecisionTaskCompletedEventAttributes Integer Source #

The ID of the DecisionTaskStarted event recorded when this decision task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

DecisionTaskScheduledEventAttributes

decisionTaskScheduledEventAttributes_taskPriority :: Lens' DecisionTaskScheduledEventAttributes (Maybe Text) Source #

A task priority that, if set, specifies the priority for this decision task. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

decisionTaskScheduledEventAttributes_startToCloseTimeout :: Lens' DecisionTaskScheduledEventAttributes (Maybe Text) Source #

The maximum duration for this decision task. The task is considered timed out if it doesn't completed within this duration.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

decisionTaskScheduledEventAttributes_taskList :: Lens' DecisionTaskScheduledEventAttributes TaskList Source #

The name of the task list in which the decision task was scheduled.

DecisionTaskStartedEventAttributes

decisionTaskStartedEventAttributes_identity :: Lens' DecisionTaskStartedEventAttributes (Maybe Text) Source #

Identity of the decider making the request. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

decisionTaskStartedEventAttributes_scheduledEventId :: Lens' DecisionTaskStartedEventAttributes Integer Source #

The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

DecisionTaskTimedOutEventAttributes

decisionTaskTimedOutEventAttributes_timeoutType :: Lens' DecisionTaskTimedOutEventAttributes DecisionTaskTimeoutType Source #

The type of timeout that expired before the decision task could be completed.

decisionTaskTimedOutEventAttributes_scheduledEventId :: Lens' DecisionTaskTimedOutEventAttributes Integer Source #

The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

decisionTaskTimedOutEventAttributes_startedEventId :: Lens' DecisionTaskTimedOutEventAttributes Integer Source #

The ID of the DecisionTaskStarted event recorded when this decision task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

DomainConfiguration

domainConfiguration_workflowExecutionRetentionPeriodInDays :: Lens' DomainConfiguration Text Source #

The retention period for workflow executions in this domain.

DomainInfo

domainInfo_arn :: Lens' DomainInfo (Maybe Text) Source #

The ARN of the domain.

domainInfo_description :: Lens' DomainInfo (Maybe Text) Source #

The description of the domain provided through RegisterDomain.

domainInfo_name :: Lens' DomainInfo Text Source #

The name of the domain. This name is unique within the account.

domainInfo_status :: Lens' DomainInfo RegistrationStatus Source #

The status of the domain:

  • REGISTERED – The domain is properly registered and available. You can use this domain for registering types and creating new workflow executions.
  • DEPRECATED – The domain was deprecated using DeprecateDomain, but is still in use. You should not create new workflow executions in this domain.

ExecutionTimeFilter

executionTimeFilter_latestDate :: Lens' ExecutionTimeFilter (Maybe UTCTime) Source #

Specifies the latest start or close date and time to return.

executionTimeFilter_oldestDate :: Lens' ExecutionTimeFilter UTCTime Source #

Specifies the oldest start or close date and time to return.

ExternalWorkflowExecutionCancelRequestedEventAttributes

externalWorkflowExecutionCancelRequestedEventAttributes_initiatedEventId :: Lens' ExternalWorkflowExecutionCancelRequestedEventAttributes Integer Source #

The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this external workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

ExternalWorkflowExecutionSignaledEventAttributes

externalWorkflowExecutionSignaledEventAttributes_initiatedEventId :: Lens' ExternalWorkflowExecutionSignaledEventAttributes Integer Source #

The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflowExecution decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

FailWorkflowExecutionDecisionAttributes

failWorkflowExecutionDecisionAttributes_reason :: Lens' FailWorkflowExecutionDecisionAttributes (Maybe Text) Source #

A descriptive reason for the failure that may help in diagnostics.

FailWorkflowExecutionFailedEventAttributes

failWorkflowExecutionFailedEventAttributes_cause :: Lens' FailWorkflowExecutionFailedEventAttributes FailWorkflowExecutionFailedCause Source #

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

failWorkflowExecutionFailedEventAttributes_decisionTaskCompletedEventId :: Lens' FailWorkflowExecutionFailedEventAttributes Integer Source #

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the FailWorkflowExecution decision to fail this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

HistoryEvent

historyEvent_workflowExecutionCancelRequestedEventAttributes :: Lens' HistoryEvent (Maybe WorkflowExecutionCancelRequestedEventAttributes) Source #

If the event is of type WorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_recordMarkerFailedEventAttributes :: Lens' HistoryEvent (Maybe RecordMarkerFailedEventAttributes) Source #

If the event is of type DecisionTaskFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_requestCancelExternalWorkflowExecutionInitiatedEventAttributes :: Lens' HistoryEvent (Maybe RequestCancelExternalWorkflowExecutionInitiatedEventAttributes) Source #

If the event is of type RequestCancelExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_lambdaFunctionStartedEventAttributes :: Lens' HistoryEvent (Maybe LambdaFunctionStartedEventAttributes) Source #

Provides the details of the LambdaFunctionStarted event. It isn't set for other event types.

historyEvent_decisionTaskScheduledEventAttributes :: Lens' HistoryEvent (Maybe DecisionTaskScheduledEventAttributes) Source #

If the event is of type DecisionTaskScheduled then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_workflowExecutionCompletedEventAttributes :: Lens' HistoryEvent (Maybe WorkflowExecutionCompletedEventAttributes) Source #

If the event is of type WorkflowExecutionCompleted then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_startTimerFailedEventAttributes :: Lens' HistoryEvent (Maybe StartTimerFailedEventAttributes) Source #

If the event is of type StartTimerFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_activityTaskScheduledEventAttributes :: Lens' HistoryEvent (Maybe ActivityTaskScheduledEventAttributes) Source #

If the event is of type ActivityTaskScheduled then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_scheduleActivityTaskFailedEventAttributes :: Lens' HistoryEvent (Maybe ScheduleActivityTaskFailedEventAttributes) Source #

If the event is of type ScheduleActivityTaskFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_childWorkflowExecutionCompletedEventAttributes :: Lens' HistoryEvent (Maybe ChildWorkflowExecutionCompletedEventAttributes) Source #

If the event is of type ChildWorkflowExecutionCompleted then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_markerRecordedEventAttributes :: Lens' HistoryEvent (Maybe MarkerRecordedEventAttributes) Source #

If the event is of type MarkerRecorded then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_scheduleLambdaFunctionFailedEventAttributes :: Lens' HistoryEvent (Maybe ScheduleLambdaFunctionFailedEventAttributes) Source #

Provides the details of the ScheduleLambdaFunctionFailed event. It isn't set for other event types.

historyEvent_completeWorkflowExecutionFailedEventAttributes :: Lens' HistoryEvent (Maybe CompleteWorkflowExecutionFailedEventAttributes) Source #

If the event is of type CompleteWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_lambdaFunctionCompletedEventAttributes :: Lens' HistoryEvent (Maybe LambdaFunctionCompletedEventAttributes) Source #

Provides the details of the LambdaFunctionCompleted event. It isn't set for other event types.

historyEvent_requestCancelExternalWorkflowExecutionFailedEventAttributes :: Lens' HistoryEvent (Maybe RequestCancelExternalWorkflowExecutionFailedEventAttributes) Source #

If the event is of type RequestCancelExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_timerCanceledEventAttributes :: Lens' HistoryEvent (Maybe TimerCanceledEventAttributes) Source #

If the event is of type TimerCanceled then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_workflowExecutionStartedEventAttributes :: Lens' HistoryEvent (Maybe WorkflowExecutionStartedEventAttributes) Source #

If the event is of type WorkflowExecutionStarted then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_activityTaskCompletedEventAttributes :: Lens' HistoryEvent (Maybe ActivityTaskCompletedEventAttributes) Source #

If the event is of type ActivityTaskCompleted then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_decisionTaskTimedOutEventAttributes :: Lens' HistoryEvent (Maybe DecisionTaskTimedOutEventAttributes) Source #

If the event is of type DecisionTaskTimedOut then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_cancelTimerFailedEventAttributes :: Lens' HistoryEvent (Maybe CancelTimerFailedEventAttributes) Source #

If the event is of type CancelTimerFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_childWorkflowExecutionStartedEventAttributes :: Lens' HistoryEvent (Maybe ChildWorkflowExecutionStartedEventAttributes) Source #

If the event is of type ChildWorkflowExecutionStarted then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_activityTaskCanceledEventAttributes :: Lens' HistoryEvent (Maybe ActivityTaskCanceledEventAttributes) Source #

If the event is of type ActivityTaskCanceled then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_activityTaskTimedOutEventAttributes :: Lens' HistoryEvent (Maybe ActivityTaskTimedOutEventAttributes) Source #

If the event is of type ActivityTaskTimedOut then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_decisionTaskStartedEventAttributes :: Lens' HistoryEvent (Maybe DecisionTaskStartedEventAttributes) Source #

If the event is of type DecisionTaskStarted then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_workflowExecutionTerminatedEventAttributes :: Lens' HistoryEvent (Maybe WorkflowExecutionTerminatedEventAttributes) Source #

If the event is of type WorkflowExecutionTerminated then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_childWorkflowExecutionCanceledEventAttributes :: Lens' HistoryEvent (Maybe ChildWorkflowExecutionCanceledEventAttributes) Source #

If the event is of type ChildWorkflowExecutionCanceled then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_requestCancelActivityTaskFailedEventAttributes :: Lens' HistoryEvent (Maybe RequestCancelActivityTaskFailedEventAttributes) Source #

If the event is of type RequestCancelActivityTaskFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_lambdaFunctionScheduledEventAttributes :: Lens' HistoryEvent (Maybe LambdaFunctionScheduledEventAttributes) Source #

Provides the details of the LambdaFunctionScheduled event. It isn't set for other event types.

historyEvent_childWorkflowExecutionTimedOutEventAttributes :: Lens' HistoryEvent (Maybe ChildWorkflowExecutionTimedOutEventAttributes) Source #

If the event is of type ChildWorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_cancelWorkflowExecutionFailedEventAttributes :: Lens' HistoryEvent (Maybe CancelWorkflowExecutionFailedEventAttributes) Source #

If the event is of type CancelWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_startChildWorkflowExecutionInitiatedEventAttributes :: Lens' HistoryEvent (Maybe StartChildWorkflowExecutionInitiatedEventAttributes) Source #

If the event is of type StartChildWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_signalExternalWorkflowExecutionFailedEventAttributes :: Lens' HistoryEvent (Maybe SignalExternalWorkflowExecutionFailedEventAttributes) Source #

If the event is of type SignalExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_activityTaskStartedEventAttributes :: Lens' HistoryEvent (Maybe ActivityTaskStartedEventAttributes) Source #

If the event is of type ActivityTaskStarted then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_startLambdaFunctionFailedEventAttributes :: Lens' HistoryEvent (Maybe StartLambdaFunctionFailedEventAttributes) Source #

Provides the details of the StartLambdaFunctionFailed event. It isn't set for other event types.

historyEvent_childWorkflowExecutionTerminatedEventAttributes :: Lens' HistoryEvent (Maybe ChildWorkflowExecutionTerminatedEventAttributes) Source #

If the event is of type ChildWorkflowExecutionTerminated then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_lambdaFunctionFailedEventAttributes :: Lens' HistoryEvent (Maybe LambdaFunctionFailedEventAttributes) Source #

Provides the details of the LambdaFunctionFailed event. It isn't set for other event types.

historyEvent_workflowExecutionCanceledEventAttributes :: Lens' HistoryEvent (Maybe WorkflowExecutionCanceledEventAttributes) Source #

If the event is of type WorkflowExecutionCanceled then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_timerStartedEventAttributes :: Lens' HistoryEvent (Maybe TimerStartedEventAttributes) Source #

If the event is of type TimerStarted then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_activityTaskCancelRequestedEventAttributes :: Lens' HistoryEvent (Maybe ActivityTaskCancelRequestedEventAttributes) Source #

If the event is of type ActivityTaskcancelRequested then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_workflowExecutionTimedOutEventAttributes :: Lens' HistoryEvent (Maybe WorkflowExecutionTimedOutEventAttributes) Source #

If the event is of type WorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_workflowExecutionSignaledEventAttributes :: Lens' HistoryEvent (Maybe WorkflowExecutionSignaledEventAttributes) Source #

If the event is of type WorkflowExecutionSignaled then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_timerFiredEventAttributes :: Lens' HistoryEvent (Maybe TimerFiredEventAttributes) Source #

If the event is of type TimerFired then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_activityTaskFailedEventAttributes :: Lens' HistoryEvent (Maybe ActivityTaskFailedEventAttributes) Source #

If the event is of type ActivityTaskFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_externalWorkflowExecutionSignaledEventAttributes :: Lens' HistoryEvent (Maybe ExternalWorkflowExecutionSignaledEventAttributes) Source #

If the event is of type ExternalWorkflowExecutionSignaled then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_decisionTaskCompletedEventAttributes :: Lens' HistoryEvent (Maybe DecisionTaskCompletedEventAttributes) Source #

If the event is of type DecisionTaskCompleted then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_startChildWorkflowExecutionFailedEventAttributes :: Lens' HistoryEvent (Maybe StartChildWorkflowExecutionFailedEventAttributes) Source #

If the event is of type StartChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_childWorkflowExecutionFailedEventAttributes :: Lens' HistoryEvent (Maybe ChildWorkflowExecutionFailedEventAttributes) Source #

If the event is of type ChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_failWorkflowExecutionFailedEventAttributes :: Lens' HistoryEvent (Maybe FailWorkflowExecutionFailedEventAttributes) Source #

If the event is of type FailWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_continueAsNewWorkflowExecutionFailedEventAttributes :: Lens' HistoryEvent (Maybe ContinueAsNewWorkflowExecutionFailedEventAttributes) Source #

If the event is of type ContinueAsNewWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_signalExternalWorkflowExecutionInitiatedEventAttributes :: Lens' HistoryEvent (Maybe SignalExternalWorkflowExecutionInitiatedEventAttributes) Source #

If the event is of type SignalExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_lambdaFunctionTimedOutEventAttributes :: Lens' HistoryEvent (Maybe LambdaFunctionTimedOutEventAttributes) Source #

Provides the details of the LambdaFunctionTimedOut event. It isn't set for other event types.

historyEvent_workflowExecutionFailedEventAttributes :: Lens' HistoryEvent (Maybe WorkflowExecutionFailedEventAttributes) Source #

If the event is of type WorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_workflowExecutionContinuedAsNewEventAttributes :: Lens' HistoryEvent (Maybe WorkflowExecutionContinuedAsNewEventAttributes) Source #

If the event is of type WorkflowExecutionContinuedAsNew then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_externalWorkflowExecutionCancelRequestedEventAttributes :: Lens' HistoryEvent (Maybe ExternalWorkflowExecutionCancelRequestedEventAttributes) Source #

If the event is of type ExternalWorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It isn't set for other event types.

historyEvent_eventTimestamp :: Lens' HistoryEvent UTCTime Source #

The date and time when the event occurred.

historyEvent_eventType :: Lens' HistoryEvent EventType Source #

The type of the history event.

historyEvent_eventId :: Lens' HistoryEvent Integer Source #

The system generated ID of the event. This ID uniquely identifies the event with in the workflow execution history.

LambdaFunctionCompletedEventAttributes

lambdaFunctionCompletedEventAttributes_scheduledEventId :: Lens' LambdaFunctionCompletedEventAttributes Integer Source #

The ID of the LambdaFunctionScheduled event that was recorded when this Lambda task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

lambdaFunctionCompletedEventAttributes_startedEventId :: Lens' LambdaFunctionCompletedEventAttributes Integer Source #

The ID of the LambdaFunctionStarted event recorded when this activity task started. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

LambdaFunctionFailedEventAttributes

lambdaFunctionFailedEventAttributes_scheduledEventId :: Lens' LambdaFunctionFailedEventAttributes Integer Source #

The ID of the LambdaFunctionScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

lambdaFunctionFailedEventAttributes_startedEventId :: Lens' LambdaFunctionFailedEventAttributes Integer Source #

The ID of the LambdaFunctionStarted event recorded when this activity task started. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

LambdaFunctionScheduledEventAttributes

lambdaFunctionScheduledEventAttributes_control :: Lens' LambdaFunctionScheduledEventAttributes (Maybe Text) Source #

Data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the Lambda task.

lambdaFunctionScheduledEventAttributes_startToCloseTimeout :: Lens' LambdaFunctionScheduledEventAttributes (Maybe Text) Source #

The maximum amount of time a worker can take to process the Lambda task.

lambdaFunctionScheduledEventAttributes_decisionTaskCompletedEventId :: Lens' LambdaFunctionScheduledEventAttributes Integer Source #

The ID of the LambdaFunctionCompleted event corresponding to the decision that resulted in scheduling this activity task. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

LambdaFunctionStartedEventAttributes

lambdaFunctionStartedEventAttributes_scheduledEventId :: Lens' LambdaFunctionStartedEventAttributes Integer Source #

The ID of the LambdaFunctionScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

LambdaFunctionTimedOutEventAttributes

lambdaFunctionTimedOutEventAttributes_scheduledEventId :: Lens' LambdaFunctionTimedOutEventAttributes Integer Source #

The ID of the LambdaFunctionScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

lambdaFunctionTimedOutEventAttributes_startedEventId :: Lens' LambdaFunctionTimedOutEventAttributes Integer Source #

The ID of the ActivityTaskStarted event that was recorded when this activity task started. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

MarkerRecordedEventAttributes

markerRecordedEventAttributes_decisionTaskCompletedEventId :: Lens' MarkerRecordedEventAttributes Integer Source #

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RecordMarker decision that requested this marker. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

PendingTaskCount

pendingTaskCount_truncated :: Lens' PendingTaskCount (Maybe Bool) Source #

If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.

pendingTaskCount_count :: Lens' PendingTaskCount Natural Source #

The number of tasks in the task list.

RecordMarkerDecisionAttributes

RecordMarkerFailedEventAttributes

recordMarkerFailedEventAttributes_cause :: Lens' RecordMarkerFailedEventAttributes RecordMarkerFailedCause Source #

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

recordMarkerFailedEventAttributes_decisionTaskCompletedEventId :: Lens' RecordMarkerFailedEventAttributes Integer Source #

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RecordMarkerFailed decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

RequestCancelActivityTaskDecisionAttributes

RequestCancelActivityTaskFailedEventAttributes

requestCancelActivityTaskFailedEventAttributes_activityId :: Lens' RequestCancelActivityTaskFailedEventAttributes Text Source #

The activityId provided in the RequestCancelActivityTask decision that failed.

requestCancelActivityTaskFailedEventAttributes_cause :: Lens' RequestCancelActivityTaskFailedEventAttributes RequestCancelActivityTaskFailedCause Source #

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

requestCancelActivityTaskFailedEventAttributes_decisionTaskCompletedEventId :: Lens' RequestCancelActivityTaskFailedEventAttributes Integer Source #

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelActivityTask decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

RequestCancelExternalWorkflowExecutionDecisionAttributes

requestCancelExternalWorkflowExecutionDecisionAttributes_control :: Lens' RequestCancelExternalWorkflowExecutionDecisionAttributes (Maybe Text) Source #

The data attached to the event that can be used by the decider in subsequent workflow tasks.

RequestCancelExternalWorkflowExecutionFailedEventAttributes

requestCancelExternalWorkflowExecutionFailedEventAttributes_control :: Lens' RequestCancelExternalWorkflowExecutionFailedEventAttributes (Maybe Text) Source #

The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the workflow execution.

requestCancelExternalWorkflowExecutionFailedEventAttributes_cause :: Lens' RequestCancelExternalWorkflowExecutionFailedEventAttributes RequestCancelExternalWorkflowExecutionFailedCause Source #

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

requestCancelExternalWorkflowExecutionFailedEventAttributes_initiatedEventId :: Lens' RequestCancelExternalWorkflowExecutionFailedEventAttributes Integer Source #

The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this external workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

requestCancelExternalWorkflowExecutionFailedEventAttributes_decisionTaskCompletedEventId :: Lens' RequestCancelExternalWorkflowExecutionFailedEventAttributes Integer Source #

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelExternalWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

RequestCancelExternalWorkflowExecutionInitiatedEventAttributes

requestCancelExternalWorkflowExecutionInitiatedEventAttributes_decisionTaskCompletedEventId :: Lens' RequestCancelExternalWorkflowExecutionInitiatedEventAttributes Integer Source #

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelExternalWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

ResourceTag

ScheduleActivityTaskDecisionAttributes

scheduleActivityTaskDecisionAttributes_control :: Lens' ScheduleActivityTaskDecisionAttributes (Maybe Text) Source #

Data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the activity.

scheduleActivityTaskDecisionAttributes_heartbeatTimeout :: Lens' ScheduleActivityTaskDecisionAttributes (Maybe Text) Source #

If set, specifies the maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or returns a result, it is ignored. This overrides the default heartbeat timeout specified when registering the activity type using RegisterActivityType.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

scheduleActivityTaskDecisionAttributes_scheduleToCloseTimeout :: Lens' ScheduleActivityTaskDecisionAttributes (Maybe Text) Source #

The maximum duration for this activity task.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

A schedule-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-close timeout was specified at registration time then a fault is returned.

scheduleActivityTaskDecisionAttributes_taskList :: Lens' ScheduleActivityTaskDecisionAttributes (Maybe TaskList) Source #

If set, specifies the name of the task list in which to schedule the activity task. If not specified, the defaultTaskList registered with the activity type is used.

A task list for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default task list was specified at registration time then a fault is returned.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn.

scheduleActivityTaskDecisionAttributes_taskPriority :: Lens' ScheduleActivityTaskDecisionAttributes (Maybe Text) Source #

If set, specifies the priority with which the activity task is to be assigned to a worker. This overrides the defaultTaskPriority specified when registering the activity type using RegisterActivityType. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

scheduleActivityTaskDecisionAttributes_scheduleToStartTimeout :: Lens' ScheduleActivityTaskDecisionAttributes (Maybe Text) Source #

If set, specifies the maximum duration the activity task can wait to be assigned to a worker. This overrides the default schedule-to-start timeout specified when registering the activity type using RegisterActivityType.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

A schedule-to-start timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-start timeout was specified at registration time then a fault is returned.

scheduleActivityTaskDecisionAttributes_startToCloseTimeout :: Lens' ScheduleActivityTaskDecisionAttributes (Maybe Text) Source #

If set, specifies the maximum duration a worker may take to process this activity task. This overrides the default start-to-close timeout specified when registering the activity type using RegisterActivityType.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

A start-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default start-to-close timeout was specified at registration time then a fault is returned.

scheduleActivityTaskDecisionAttributes_activityId :: Lens' ScheduleActivityTaskDecisionAttributes Text Source #

The activityId of the activity task.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn.

ScheduleActivityTaskFailedEventAttributes

scheduleActivityTaskFailedEventAttributes_activityType :: Lens' ScheduleActivityTaskFailedEventAttributes ActivityType Source #

The activity type provided in the ScheduleActivityTask decision that failed.

scheduleActivityTaskFailedEventAttributes_activityId :: Lens' ScheduleActivityTaskFailedEventAttributes Text Source #

The activityId provided in the ScheduleActivityTask decision that failed.

scheduleActivityTaskFailedEventAttributes_cause :: Lens' ScheduleActivityTaskFailedEventAttributes ScheduleActivityTaskFailedCause Source #

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

scheduleActivityTaskFailedEventAttributes_decisionTaskCompletedEventId :: Lens' ScheduleActivityTaskFailedEventAttributes Integer Source #

The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

ScheduleLambdaFunctionDecisionAttributes

scheduleLambdaFunctionDecisionAttributes_control :: Lens' ScheduleLambdaFunctionDecisionAttributes (Maybe Text) Source #

The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the Lambda task.

scheduleLambdaFunctionDecisionAttributes_input :: Lens' ScheduleLambdaFunctionDecisionAttributes (Maybe Text) Source #

The optional input data to be supplied to the Lambda function.

scheduleLambdaFunctionDecisionAttributes_startToCloseTimeout :: Lens' ScheduleLambdaFunctionDecisionAttributes (Maybe Text) Source #

The timeout value, in seconds, after which the Lambda function is considered to be failed once it has started. This can be any integer from 1-300 (1s-5m). If no value is supplied, than a default value of 300s is assumed.

scheduleLambdaFunctionDecisionAttributes_id :: Lens' ScheduleLambdaFunctionDecisionAttributes Text Source #

A string that identifies the Lambda function execution in the event history.

ScheduleLambdaFunctionFailedEventAttributes

scheduleLambdaFunctionFailedEventAttributes_id :: Lens' ScheduleLambdaFunctionFailedEventAttributes Text Source #

The ID provided in the ScheduleLambdaFunction decision that failed.

scheduleLambdaFunctionFailedEventAttributes_cause :: Lens' ScheduleLambdaFunctionFailedEventAttributes ScheduleLambdaFunctionFailedCause Source #

The cause of the failure. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

scheduleLambdaFunctionFailedEventAttributes_decisionTaskCompletedEventId :: Lens' ScheduleLambdaFunctionFailedEventAttributes Integer Source #

The ID of the LambdaFunctionCompleted event corresponding to the decision that resulted in scheduling this Lambda task. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

SignalExternalWorkflowExecutionDecisionAttributes

signalExternalWorkflowExecutionDecisionAttributes_control :: Lens' SignalExternalWorkflowExecutionDecisionAttributes (Maybe Text) Source #

The data attached to the event that can be used by the decider in subsequent decision tasks.

signalExternalWorkflowExecutionDecisionAttributes_input :: Lens' SignalExternalWorkflowExecutionDecisionAttributes (Maybe Text) Source #

The input data to be provided with the signal. The target workflow execution uses the signal name and input data to process the signal.

signalExternalWorkflowExecutionDecisionAttributes_signalName :: Lens' SignalExternalWorkflowExecutionDecisionAttributes Text Source #

The name of the signal.The target workflow execution uses the signal name and input to process the signal.

SignalExternalWorkflowExecutionFailedEventAttributes

signalExternalWorkflowExecutionFailedEventAttributes_control :: Lens' SignalExternalWorkflowExecutionFailedEventAttributes (Maybe Text) Source #

The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the workflow execution.

signalExternalWorkflowExecutionFailedEventAttributes_runId :: Lens' SignalExternalWorkflowExecutionFailedEventAttributes (Maybe Text) Source #

The runId of the external workflow execution that the signal was being delivered to.

signalExternalWorkflowExecutionFailedEventAttributes_workflowId :: Lens' SignalExternalWorkflowExecutionFailedEventAttributes Text Source #

The workflowId of the external workflow execution that the signal was being delivered to.

signalExternalWorkflowExecutionFailedEventAttributes_cause :: Lens' SignalExternalWorkflowExecutionFailedEventAttributes SignalExternalWorkflowExecutionFailedCause Source #

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

signalExternalWorkflowExecutionFailedEventAttributes_initiatedEventId :: Lens' SignalExternalWorkflowExecutionFailedEventAttributes Integer Source #

The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflowExecution decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

signalExternalWorkflowExecutionFailedEventAttributes_decisionTaskCompletedEventId :: Lens' SignalExternalWorkflowExecutionFailedEventAttributes Integer Source #

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the SignalExternalWorkflowExecution decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

SignalExternalWorkflowExecutionInitiatedEventAttributes

signalExternalWorkflowExecutionInitiatedEventAttributes_control :: Lens' SignalExternalWorkflowExecutionInitiatedEventAttributes (Maybe Text) Source #

Data attached to the event that can be used by the decider in subsequent decision tasks.

signalExternalWorkflowExecutionInitiatedEventAttributes_decisionTaskCompletedEventId :: Lens' SignalExternalWorkflowExecutionInitiatedEventAttributes Integer Source #

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the SignalExternalWorkflowExecution decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

StartChildWorkflowExecutionDecisionAttributes

startChildWorkflowExecutionDecisionAttributes_control :: Lens' StartChildWorkflowExecutionDecisionAttributes (Maybe Text) Source #

The data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the child workflow execution.

startChildWorkflowExecutionDecisionAttributes_tagList :: Lens' StartChildWorkflowExecutionDecisionAttributes (Maybe [Text]) Source #

The list of tags to associate with the child workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

startChildWorkflowExecutionDecisionAttributes_taskStartToCloseTimeout :: Lens' StartChildWorkflowExecutionDecisionAttributes (Maybe Text) Source #

Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.

startChildWorkflowExecutionDecisionAttributes_executionStartToCloseTimeout :: Lens' StartChildWorkflowExecutionDecisionAttributes (Maybe Text) Source #

The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default execution start-to-close timeout was specified at registration time then a fault is returned.

startChildWorkflowExecutionDecisionAttributes_taskList :: Lens' StartChildWorkflowExecutionDecisionAttributes (Maybe TaskList) Source #

The name of the task list to be used for decision tasks of the child workflow execution.

A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault is returned.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn.

startChildWorkflowExecutionDecisionAttributes_taskPriority :: Lens' StartChildWorkflowExecutionDecisionAttributes (Maybe Text) Source #

A task priority that, if set, specifies the priority for a decision task of this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

startChildWorkflowExecutionDecisionAttributes_childPolicy :: Lens' StartChildWorkflowExecutionDecisionAttributes (Maybe ChildPolicy) Source #

If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.

The supported child policies are:

  • TERMINATE – The child executions are terminated.
  • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
  • ABANDON – No action is taken. The child executions continue to run.

A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

startChildWorkflowExecutionDecisionAttributes_workflowId :: Lens' StartChildWorkflowExecutionDecisionAttributes Text Source #

The workflowId of the workflow execution.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn.

StartChildWorkflowExecutionFailedEventAttributes

startChildWorkflowExecutionFailedEventAttributes_control :: Lens' StartChildWorkflowExecutionFailedEventAttributes (Maybe Text) Source #

The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the child workflow execution.

startChildWorkflowExecutionFailedEventAttributes_workflowType :: Lens' StartChildWorkflowExecutionFailedEventAttributes WorkflowType Source #

The workflow type provided in the StartChildWorkflowExecution Decision that failed.

startChildWorkflowExecutionFailedEventAttributes_cause :: Lens' StartChildWorkflowExecutionFailedEventAttributes StartChildWorkflowExecutionFailedCause Source #

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

When cause is set to OPERATION_NOT_PERMITTED, the decision fails because it lacks sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

startChildWorkflowExecutionFailedEventAttributes_initiatedEventId :: Lens' StartChildWorkflowExecutionFailedEventAttributes Integer Source #

When the cause is WORKFLOW_ALREADY_RUNNING, initiatedEventId is the ID of the StartChildWorkflowExecutionInitiated event that corresponds to the StartChildWorkflowExecution Decision to start the workflow execution. You can use this information to diagnose problems by tracing back the chain of events leading up to this event.

When the cause isn't WORKFLOW_ALREADY_RUNNING, initiatedEventId is set to 0 because the StartChildWorkflowExecutionInitiated event doesn't exist.

startChildWorkflowExecutionFailedEventAttributes_decisionTaskCompletedEventId :: Lens' StartChildWorkflowExecutionFailedEventAttributes Integer Source #

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution Decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events.

StartChildWorkflowExecutionInitiatedEventAttributes

startChildWorkflowExecutionInitiatedEventAttributes_control :: Lens' StartChildWorkflowExecutionInitiatedEventAttributes (Maybe Text) Source #

Data attached to the event that can be used by the decider in subsequent decision tasks. This data isn't sent to the activity.

startChildWorkflowExecutionInitiatedEventAttributes_taskStartToCloseTimeout :: Lens' StartChildWorkflowExecutionInitiatedEventAttributes (Maybe Text) Source #

The maximum duration allowed for the decision tasks for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

startChildWorkflowExecutionInitiatedEventAttributes_executionStartToCloseTimeout :: Lens' StartChildWorkflowExecutionInitiatedEventAttributes (Maybe Text) Source #

The maximum duration for the child workflow execution. If the workflow execution isn't closed within this duration, it is timed out and force-terminated.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

startChildWorkflowExecutionInitiatedEventAttributes_taskPriority :: Lens' StartChildWorkflowExecutionInitiatedEventAttributes (Maybe Text) Source #

The priority assigned for the decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

startChildWorkflowExecutionInitiatedEventAttributes_taskList :: Lens' StartChildWorkflowExecutionInitiatedEventAttributes TaskList Source #

The name of the task list used for the decision tasks of the child workflow execution.

startChildWorkflowExecutionInitiatedEventAttributes_decisionTaskCompletedEventId :: Lens' StartChildWorkflowExecutionInitiatedEventAttributes Integer Source #

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution Decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.

startChildWorkflowExecutionInitiatedEventAttributes_childPolicy :: Lens' StartChildWorkflowExecutionInitiatedEventAttributes ChildPolicy Source #

The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout.

The supported child policies are:

  • TERMINATE – The child executions are terminated.
  • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
  • ABANDON – No action is taken. The child executions continue to run.

StartLambdaFunctionFailedEventAttributes

startLambdaFunctionFailedEventAttributes_scheduledEventId :: Lens' StartLambdaFunctionFailedEventAttributes (Maybe Integer) Source #

The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

startLambdaFunctionFailedEventAttributes_cause :: Lens' StartLambdaFunctionFailedEventAttributes (Maybe StartLambdaFunctionFailedCause) Source #

The cause of the failure. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

If cause is set to OPERATION_NOT_PERMITTED, the decision failed because the IAM role attached to the execution lacked sufficient permissions. For details and example IAM policies, see Lambda Tasks in the Amazon SWF Developer Guide.

StartTimerDecisionAttributes

startTimerDecisionAttributes_control :: Lens' StartTimerDecisionAttributes (Maybe Text) Source #

The data attached to the event that can be used by the decider in subsequent workflow tasks.

startTimerDecisionAttributes_timerId :: Lens' StartTimerDecisionAttributes Text Source #

The unique ID of the timer.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn.

startTimerDecisionAttributes_startToFireTimeout :: Lens' StartTimerDecisionAttributes Text Source #

The duration to wait before firing the timer.

The duration is specified in seconds, an integer greater than or equal to 0.

StartTimerFailedEventAttributes

startTimerFailedEventAttributes_timerId :: Lens' StartTimerFailedEventAttributes Text Source #

The timerId provided in the StartTimer decision that failed.

startTimerFailedEventAttributes_cause :: Lens' StartTimerFailedEventAttributes StartTimerFailedCause Source #

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

startTimerFailedEventAttributes_decisionTaskCompletedEventId :: Lens' StartTimerFailedEventAttributes Integer Source #

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartTimer decision for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

TagFilter

tagFilter_tag :: Lens' TagFilter Text Source #

Specifies the tag that must be associated with the execution for it to meet the filter criteria.

Tags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.

TaskList

taskList_name :: Lens' TaskList Text Source #

The name of the task list.

TimerCanceledEventAttributes

timerCanceledEventAttributes_startedEventId :: Lens' TimerCanceledEventAttributes Integer Source #

The ID of the TimerStarted event that was recorded when this timer was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

timerCanceledEventAttributes_decisionTaskCompletedEventId :: Lens' TimerCanceledEventAttributes Integer Source #

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelTimer decision to cancel this timer. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

TimerFiredEventAttributes

timerFiredEventAttributes_startedEventId :: Lens' TimerFiredEventAttributes Integer Source #

The ID of the TimerStarted event that was recorded when this timer was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

TimerStartedEventAttributes

timerStartedEventAttributes_control :: Lens' TimerStartedEventAttributes (Maybe Text) Source #

Data attached to the event that can be used by the decider in subsequent workflow tasks.

timerStartedEventAttributes_timerId :: Lens' TimerStartedEventAttributes Text Source #

The unique ID of the timer that was started.

timerStartedEventAttributes_startToFireTimeout :: Lens' TimerStartedEventAttributes Text Source #

The duration of time after which the timer fires.

The duration is specified in seconds, an integer greater than or equal to 0.

timerStartedEventAttributes_decisionTaskCompletedEventId :: Lens' TimerStartedEventAttributes Integer Source #

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartTimer decision for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

WorkflowExecution

workflowExecution_workflowId :: Lens' WorkflowExecution Text Source #

The user defined identifier associated with the workflow execution.

workflowExecution_runId :: Lens' WorkflowExecution Text Source #

A system-generated unique identifier for the workflow execution.

WorkflowExecutionCancelRequestedEventAttributes

workflowExecutionCancelRequestedEventAttributes_externalInitiatedEventId :: Lens' WorkflowExecutionCancelRequestedEventAttributes (Maybe Integer) Source #

The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this workflow execution.The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

workflowExecutionCancelRequestedEventAttributes_cause :: Lens' WorkflowExecutionCancelRequestedEventAttributes (Maybe WorkflowExecutionCancelRequestedCause) Source #

If set, indicates that the request to cancel the workflow execution was automatically generated, and specifies the cause. This happens if the parent workflow execution times out or is terminated, and the child policy is set to cancel child executions.

WorkflowExecutionCanceledEventAttributes

workflowExecutionCanceledEventAttributes_decisionTaskCompletedEventId :: Lens' WorkflowExecutionCanceledEventAttributes Integer Source #

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

WorkflowExecutionCompletedEventAttributes

workflowExecutionCompletedEventAttributes_result :: Lens' WorkflowExecutionCompletedEventAttributes (Maybe Text) Source #

The result produced by the workflow execution upon successful completion.

workflowExecutionCompletedEventAttributes_decisionTaskCompletedEventId :: Lens' WorkflowExecutionCompletedEventAttributes Integer Source #

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CompleteWorkflowExecution decision to complete this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

WorkflowExecutionConfiguration

workflowExecutionConfiguration_lambdaRole :: Lens' WorkflowExecutionConfiguration (Maybe Text) Source #

The IAM role attached to the child workflow execution.

workflowExecutionConfiguration_taskPriority :: Lens' WorkflowExecutionConfiguration (Maybe Text) Source #

The priority assigned to decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

workflowExecutionConfiguration_taskStartToCloseTimeout :: Lens' WorkflowExecutionConfiguration Text Source #

The maximum duration allowed for decision tasks for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

workflowExecutionConfiguration_executionStartToCloseTimeout :: Lens' WorkflowExecutionConfiguration Text Source #

The total duration for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

workflowExecutionConfiguration_taskList :: Lens' WorkflowExecutionConfiguration TaskList Source #

The task list used for the decision tasks generated for this workflow execution.

workflowExecutionConfiguration_childPolicy :: Lens' WorkflowExecutionConfiguration ChildPolicy Source #

The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

The supported child policies are:

  • TERMINATE – The child executions are terminated.
  • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
  • ABANDON – No action is taken. The child executions continue to run.

WorkflowExecutionContinuedAsNewEventAttributes

workflowExecutionContinuedAsNewEventAttributes_taskStartToCloseTimeout :: Lens' WorkflowExecutionContinuedAsNewEventAttributes (Maybe Text) Source #

The maximum duration of decision tasks for the new workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

workflowExecutionContinuedAsNewEventAttributes_executionStartToCloseTimeout :: Lens' WorkflowExecutionContinuedAsNewEventAttributes (Maybe Text) Source #

The total duration allowed for the new workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

workflowExecutionContinuedAsNewEventAttributes_taskPriority :: Lens' WorkflowExecutionContinuedAsNewEventAttributes (Maybe Text) Source #

The priority of the task to use for the decisions of the new (continued) workflow execution.

workflowExecutionContinuedAsNewEventAttributes_decisionTaskCompletedEventId :: Lens' WorkflowExecutionContinuedAsNewEventAttributes Integer Source #

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the ContinueAsNewWorkflowExecution decision that started this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

workflowExecutionContinuedAsNewEventAttributes_taskList :: Lens' WorkflowExecutionContinuedAsNewEventAttributes TaskList Source #

The task list to use for the decisions of the new (continued) workflow execution.

workflowExecutionContinuedAsNewEventAttributes_childPolicy :: Lens' WorkflowExecutionContinuedAsNewEventAttributes ChildPolicy Source #

The policy to use for the child workflow executions of the new execution if it is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

The supported child policies are:

  • TERMINATE – The child executions are terminated.
  • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
  • ABANDON – No action is taken. The child executions continue to run.

WorkflowExecutionCount

workflowExecutionCount_truncated :: Lens' WorkflowExecutionCount (Maybe Bool) Source #

If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.

WorkflowExecutionFailedEventAttributes

workflowExecutionFailedEventAttributes_decisionTaskCompletedEventId :: Lens' WorkflowExecutionFailedEventAttributes Integer Source #

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the FailWorkflowExecution decision to fail this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

WorkflowExecutionFilter

workflowExecutionFilter_workflowId :: Lens' WorkflowExecutionFilter Text Source #

The workflowId to pass of match the criteria of this filter.

WorkflowExecutionInfo

workflowExecutionInfo_parent :: Lens' WorkflowExecutionInfo (Maybe WorkflowExecution) Source #

If this workflow execution is a child of another execution then contains the workflow execution that started this execution.

workflowExecutionInfo_tagList :: Lens' WorkflowExecutionInfo (Maybe [Text]) Source #

The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.

workflowExecutionInfo_closeStatus :: Lens' WorkflowExecutionInfo (Maybe CloseStatus) Source #

If the execution status is closed then this specifies how the execution was closed:

  • COMPLETED – the execution was successfully completed.
  • CANCELED – the execution was canceled.Cancellation allows the implementation to gracefully clean up before the execution is closed.
  • TERMINATED – the execution was force terminated.
  • FAILED – the execution failed to complete.
  • TIMED_OUT – the execution did not complete in the alloted time and was automatically timed out.
  • CONTINUED_AS_NEW – the execution is logically continued. This means the current execution was completed and a new execution was started to carry on the workflow.

workflowExecutionInfo_closeTimestamp :: Lens' WorkflowExecutionInfo (Maybe UTCTime) Source #

The time when the workflow execution was closed. Set only if the execution status is CLOSED.

workflowExecutionInfo_cancelRequested :: Lens' WorkflowExecutionInfo (Maybe Bool) Source #

Set to true if a cancellation is requested for this workflow execution.

workflowExecutionInfo_execution :: Lens' WorkflowExecutionInfo WorkflowExecution Source #

The workflow execution this information is about.

WorkflowExecutionInfos

workflowExecutionInfos_nextPageToken :: Lens' WorkflowExecutionInfos (Maybe Text) Source #

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

WorkflowExecutionOpenCounts

workflowExecutionOpenCounts_openDecisionTasks :: Lens' WorkflowExecutionOpenCounts Natural Source #

The count of decision tasks whose status is OPEN. A workflow execution can have at most one open decision task.

workflowExecutionOpenCounts_openTimers :: Lens' WorkflowExecutionOpenCounts Natural Source #

The count of timers started by this workflow execution that have not fired yet.

workflowExecutionOpenCounts_openChildWorkflowExecutions :: Lens' WorkflowExecutionOpenCounts Natural Source #

The count of child workflow executions whose status is OPEN.

WorkflowExecutionSignaledEventAttributes

workflowExecutionSignaledEventAttributes_externalWorkflowExecution :: Lens' WorkflowExecutionSignaledEventAttributes (Maybe WorkflowExecution) Source #

The workflow execution that sent the signal. This is set only of the signal was sent by another workflow execution.

workflowExecutionSignaledEventAttributes_externalInitiatedEventId :: Lens' WorkflowExecutionSignaledEventAttributes (Maybe Integer) Source #

The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflow decision to signal this workflow execution.The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. This field is set only if the signal was initiated by another workflow execution.

workflowExecutionSignaledEventAttributes_input :: Lens' WorkflowExecutionSignaledEventAttributes (Maybe Text) Source #

The inputs provided with the signal. The decider can use the signal name and inputs to determine how to process the signal.

workflowExecutionSignaledEventAttributes_signalName :: Lens' WorkflowExecutionSignaledEventAttributes Text Source #

The name of the signal received. The decider can use the signal name and inputs to determine how to the process the signal.

WorkflowExecutionStartedEventAttributes

workflowExecutionStartedEventAttributes_parentInitiatedEventId :: Lens' WorkflowExecutionStartedEventAttributes (Maybe Integer) Source #

The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this workflow execution. The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

workflowExecutionStartedEventAttributes_tagList :: Lens' WorkflowExecutionStartedEventAttributes (Maybe [Text]) Source #

The list of tags associated with this workflow execution. An execution can have up to 5 tags.

workflowExecutionStartedEventAttributes_taskStartToCloseTimeout :: Lens' WorkflowExecutionStartedEventAttributes (Maybe Text) Source #

The maximum duration of decision tasks for this workflow type.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

workflowExecutionStartedEventAttributes_executionStartToCloseTimeout :: Lens' WorkflowExecutionStartedEventAttributes (Maybe Text) Source #

The maximum duration for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

workflowExecutionStartedEventAttributes_parentWorkflowExecution :: Lens' WorkflowExecutionStartedEventAttributes (Maybe WorkflowExecution) Source #

The source workflow execution that started this workflow execution. The member isn't set if the workflow execution was not started by a workflow.

workflowExecutionStartedEventAttributes_continuedExecutionRunId :: Lens' WorkflowExecutionStartedEventAttributes (Maybe Text) Source #

If this workflow execution was started due to a ContinueAsNewWorkflowExecution decision, then it contains the runId of the previous workflow execution that was closed and continued as this execution.

workflowExecutionStartedEventAttributes_childPolicy :: Lens' WorkflowExecutionStartedEventAttributes ChildPolicy Source #

The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

The supported child policies are:

  • TERMINATE – The child executions are terminated.
  • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
  • ABANDON – No action is taken. The child executions continue to run.

workflowExecutionStartedEventAttributes_taskList :: Lens' WorkflowExecutionStartedEventAttributes TaskList Source #

The name of the task list for scheduling the decision tasks for this workflow execution.

WorkflowExecutionTerminatedEventAttributes

workflowExecutionTerminatedEventAttributes_cause :: Lens' WorkflowExecutionTerminatedEventAttributes (Maybe WorkflowExecutionTerminatedCause) Source #

If set, indicates that the workflow execution was automatically terminated, and specifies the cause. This happens if the parent workflow execution times out or is terminated and the child policy is set to terminate child executions.

workflowExecutionTerminatedEventAttributes_childPolicy :: Lens' WorkflowExecutionTerminatedEventAttributes ChildPolicy Source #

The policy used for the child workflow executions of this workflow execution.

The supported child policies are:

  • TERMINATE – The child executions are terminated.
  • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
  • ABANDON – No action is taken. The child executions continue to run.

WorkflowExecutionTimedOutEventAttributes

workflowExecutionTimedOutEventAttributes_childPolicy :: Lens' WorkflowExecutionTimedOutEventAttributes ChildPolicy Source #

The policy used for the child workflow executions of this workflow execution.

The supported child policies are:

  • TERMINATE – The child executions are terminated.
  • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
  • ABANDON – No action is taken. The child executions continue to run.

WorkflowType

workflowType_name :: Lens' WorkflowType Text Source #

The name of the workflow type.

The combination of workflow type name and version must be unique with in a domain.

workflowType_version :: Lens' WorkflowType Text Source #

The version of the workflow type.

The combination of workflow type name and version must be unique with in a domain.

WorkflowTypeConfiguration

workflowTypeConfiguration_defaultLambdaRole :: Lens' WorkflowTypeConfiguration (Maybe Text) Source #

The default IAM role attached to this workflow type.

Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't specify an IAM role when starting this workflow type, the default Lambda role is attached to the execution. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.

workflowTypeConfiguration_defaultChildPolicy :: Lens' WorkflowTypeConfiguration (Maybe ChildPolicy) Source #

The default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

The supported child policies are:

  • TERMINATE – The child executions are terminated.
  • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
  • ABANDON – No action is taken. The child executions continue to run.

workflowTypeConfiguration_defaultTaskList :: Lens' WorkflowTypeConfiguration (Maybe TaskList) Source #

The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

workflowTypeConfiguration_defaultTaskPriority :: Lens' WorkflowTypeConfiguration (Maybe Text) Source #

The default task priority, specified when registering the workflow type, for all decision tasks of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.

Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

workflowTypeConfiguration_defaultExecutionStartToCloseTimeout :: Lens' WorkflowTypeConfiguration (Maybe Text) Source #

The default maximum duration, specified when registering the workflow type, for executions of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

workflowTypeConfiguration_defaultTaskStartToCloseTimeout :: Lens' WorkflowTypeConfiguration (Maybe Text) Source #

The default maximum duration, specified when registering the workflow type, that a decision task for executions of this workflow type might take before returning completion or failure. If the task doesn'tdo close in the specified time then the task is automatically timed out and rescheduled. If the decider eventually reports a completion or failure, it is ignored. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

WorkflowTypeFilter

WorkflowTypeInfo

workflowTypeInfo_deprecationDate :: Lens' WorkflowTypeInfo (Maybe UTCTime) Source #

If the type is in deprecated state, then it is set to the date when the type was deprecated.

workflowTypeInfo_description :: Lens' WorkflowTypeInfo (Maybe Text) Source #

The description of the type registered through RegisterWorkflowType.

workflowTypeInfo_workflowType :: Lens' WorkflowTypeInfo WorkflowType Source #

The workflow type this information is about.

workflowTypeInfo_status :: Lens' WorkflowTypeInfo RegistrationStatus Source #

The current status of the workflow type.

workflowTypeInfo_creationDate :: Lens' WorkflowTypeInfo UTCTime Source #

The date when this type was registered.