Amazon SWF gives you full control over implementing tasks and coordinating them without worrying about underlying complexities such as tracking their progress and maintaining their state.
-This documentation serves as reference only. For a broader overview of the Amazon SWF
programming model, see the
Amazon SWF Developer Guide
diff --git a/clients/client-swf/src/SWF.ts b/clients/client-swf/src/SWF.ts
index d34b55c6b2c6c..6dfca7d190d51 100644
--- a/clients/client-swf/src/SWF.ts
+++ b/clients/client-swf/src/SWF.ts
@@ -828,17 +828,14 @@ export interface SWF {
/**
* @public
*
The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon's cloud to * coordinate work across distributed components. In Amazon SWF, a task * represents a logical unit of work that is performed by a component of your workflow. * Coordinating tasks in a workflow involves managing intertask dependencies, scheduling, and * concurrency in accordance with the logical flow of the application.
- * *Amazon SWF gives you full control over implementing tasks and coordinating them without * worrying about underlying complexities such as tracking their progress and maintaining their * state.
- * *This documentation serves as reference only. For a broader overview of the Amazon SWF
* programming model, see the
* Amazon SWF Developer Guide
diff --git a/clients/client-swf/src/SWFClient.ts b/clients/client-swf/src/SWFClient.ts
index 3fa6f61eb60e3..94a13af9a11b3 100644
--- a/clients/client-swf/src/SWFClient.ts
+++ b/clients/client-swf/src/SWFClient.ts
@@ -427,17 +427,14 @@ export interface SWFClientResolvedConfig extends SWFClientResolvedConfigType {}
/**
* @public
*
The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon's cloud to * coordinate work across distributed components. In Amazon SWF, a task * represents a logical unit of work that is performed by a component of your workflow. * Coordinating tasks in a workflow involves managing intertask dependencies, scheduling, and * concurrency in accordance with the logical flow of the application.
- * *Amazon SWF gives you full control over implementing tasks and coordinating them without * worrying about underlying complexities such as tracking their progress and maintaining their * state.
- * *This documentation serves as reference only. For a broader overview of the Amazon SWF * programming model, see the * Amazon SWF Developer Guide diff --git a/clients/client-swf/src/commands/PollForDecisionTaskCommand.ts b/clients/client-swf/src/commands/PollForDecisionTaskCommand.ts index e4992f72c7a5f..73cf1bbaed4f3 100644 --- a/clients/client-swf/src/commands/PollForDecisionTaskCommand.ts +++ b/clients/client-swf/src/commands/PollForDecisionTaskCommand.ts @@ -95,6 +95,7 @@ export interface PollForDecisionTaskCommandOutput extends DecisionTask, __Metada * nextPageToken: "STRING_VALUE", * maximumPageSize: Number("int"), * reverseOrder: true || false, + * startAtPreviousStartedEvent: true || false, * }; * const command = new PollForDecisionTaskCommand(input); * const response = await client.send(command); diff --git a/clients/client-swf/src/commands/RequestCancelWorkflowExecutionCommand.ts b/clients/client-swf/src/commands/RequestCancelWorkflowExecutionCommand.ts index 2ea26af1dc18f..57709098a45d3 100644 --- a/clients/client-swf/src/commands/RequestCancelWorkflowExecutionCommand.ts +++ b/clients/client-swf/src/commands/RequestCancelWorkflowExecutionCommand.ts @@ -39,13 +39,11 @@ export interface RequestCancelWorkflowExecutionCommandOutput extends __MetadataB * workflow execution identified by the given domain, workflowId, and runId. This logically * requests the cancellation of the workflow execution as a whole. It is up to the decider to * take appropriate actions when it receives an execution history with this event.
- * *If the runId isn't specified, the WorkflowExecutionCancelRequested event
* is recorded in the history of the current open workflow execution with the specified
* workflowId in the domain.
Because this action allows the workflow to properly clean up and gracefully close, it * should be used instead of TerminateWorkflowExecution when diff --git a/clients/client-swf/src/commands/RespondActivityTaskCanceledCommand.ts b/clients/client-swf/src/commands/RespondActivityTaskCanceledCommand.ts index 1a9ffac7fdb6d..3d22e3428f23b 100644 --- a/clients/client-swf/src/commands/RespondActivityTaskCanceledCommand.ts +++ b/clients/client-swf/src/commands/RespondActivityTaskCanceledCommand.ts @@ -35,22 +35,18 @@ export interface RespondActivityTaskCanceledCommandOutput extends __MetadataBear *
Used by workers to tell the service that the ActivityTask identified
* by the taskToken was successfully canceled. Additional details can
* be provided using the details argument.
These details (if provided) appear in the
* ActivityTaskCanceled event added to the workflow history.
Only use this operation if the canceled flag of a RecordActivityTaskHeartbeat request returns true and if the
* activity can be safely undone or abandoned.
A task is considered open from the time that it is scheduled until it is closed. * Therefore a task is reported as open while a worker is processing it. A task is closed after * it has been specified in a call to RespondActivityTaskCompleted, * RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has * timed * out.
- * ** Access Control *
diff --git a/clients/client-swf/src/commands/RespondActivityTaskCompletedCommand.ts b/clients/client-swf/src/commands/RespondActivityTaskCompletedCommand.ts index c60e11af35aa8..264ec22bb28f2 100644 --- a/clients/client-swf/src/commands/RespondActivityTaskCompletedCommand.ts +++ b/clients/client-swf/src/commands/RespondActivityTaskCompletedCommand.ts @@ -39,19 +39,16 @@ export interface RespondActivityTaskCompletedCommandOutput extends __MetadataBea * by thetaskToken completed successfully with a result (if provided).
* The result appears in the ActivityTaskCompleted event in the
* workflow history.
- *
* If the requested task doesn't complete successfully, use RespondActivityTaskFailed instead. If the worker finds that the task is
* canceled through the canceled flag returned by RecordActivityTaskHeartbeat, it should cancel the task, clean up and then call
* RespondActivityTaskCanceled.
A task is considered open from the time that it is scheduled until it is closed. * Therefore a task is reported as open while a worker is processing it. A task is closed after * it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the * task has timed * out.
- * ** Access Control *
diff --git a/clients/client-swf/src/commands/RespondActivityTaskFailedCommand.ts b/clients/client-swf/src/commands/RespondActivityTaskFailedCommand.ts index 78a61fa53ef2b..c7876f1e77a30 100644 --- a/clients/client-swf/src/commands/RespondActivityTaskFailedCommand.ts +++ b/clients/client-swf/src/commands/RespondActivityTaskFailedCommand.ts @@ -36,12 +36,10 @@ export interface RespondActivityTaskFailedCommandOutput extends __MetadataBearer * by thetaskToken has failed with reason (if specified). The
* reason and details appear in the ActivityTaskFailed
* event added to the workflow history.
- *
* A task is considered open from the time that it is scheduled until it is closed. * Therefore a task is reported as open while a worker is processing it. A task is closed after * it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed * out.
- * ** Access Control *
diff --git a/clients/client-swf/src/commands/RespondDecisionTaskCompletedCommand.ts b/clients/client-swf/src/commands/RespondDecisionTaskCompletedCommand.ts index f6368cb569ef9..884d777966797 100644 --- a/clients/client-swf/src/commands/RespondDecisionTaskCompletedCommand.ts +++ b/clients/client-swf/src/commands/RespondDecisionTaskCompletedCommand.ts @@ -38,15 +38,12 @@ export interface RespondDecisionTaskCompletedCommandOutput extends __MetadataBea *Used by deciders to tell the service that the DecisionTask identified
* by the taskToken has successfully completed. The decisions argument
* specifies the list of decisions made while processing the task.
A DecisionTaskCompleted event is added to the workflow history. The
* executionContext specified is attached to the event in the workflow execution
* history.
* Access Control *
- * *If an IAM policy grants permission to use RespondDecisionTaskCompleted, it
* can express permissions for the list of decisions in the decisions parameter.
* Each of the decisions has one or more parameters, much like a regular API call. To allow for
diff --git a/clients/client-swf/src/commands/SignalWorkflowExecutionCommand.ts b/clients/client-swf/src/commands/SignalWorkflowExecutionCommand.ts
index 098ad262a84d4..a405a8284ecf8 100644
--- a/clients/client-swf/src/commands/SignalWorkflowExecutionCommand.ts
+++ b/clients/client-swf/src/commands/SignalWorkflowExecutionCommand.ts
@@ -36,18 +36,15 @@ export interface SignalWorkflowExecutionCommandOutput extends __MetadataBearer {
* history and creates a decision task for the workflow execution identified by the given domain,
* workflowId and runId. The event is recorded with the specified user defined signalName and
* input (if provided).
If a runId isn't specified, then the WorkflowExecutionSignaled event is
* recorded in the history of the current open workflow with the matching workflowId in the
* domain.
If the specified workflow execution isn't open, this method fails with
* UnknownResource.
* Access Control *
diff --git a/clients/client-swf/src/commands/StartWorkflowExecutionCommand.ts b/clients/client-swf/src/commands/StartWorkflowExecutionCommand.ts index 066b4082adbae..a0eba37d8d787 100644 --- a/clients/client-swf/src/commands/StartWorkflowExecutionCommand.ts +++ b/clients/client-swf/src/commands/StartWorkflowExecutionCommand.ts @@ -34,9 +34,7 @@ export interface StartWorkflowExecutionCommandOutput extends Run, __MetadataBear * @public *Starts an execution of the workflow type in the specified domain using the provided
* workflowId and input data.
This action returns the newly started workflow execution.
- * ** Access Control *
diff --git a/clients/client-swf/src/commands/TerminateWorkflowExecutionCommand.ts b/clients/client-swf/src/commands/TerminateWorkflowExecutionCommand.ts index 91b4637f78886..9ee721535698a 100644 --- a/clients/client-swf/src/commands/TerminateWorkflowExecutionCommand.ts +++ b/clients/client-swf/src/commands/TerminateWorkflowExecutionCommand.ts @@ -36,23 +36,19 @@ export interface TerminateWorkflowExecutionCommandOutput extends __MetadataBeare * workflow execution identified by the given domain, runId, and workflowId. The child policy, * registered with the workflow type or specified when starting this execution, is applied to any * open child workflow executions of this workflow execution. - * *If the identified workflow execution was in progress, it is terminated * immediately.
*If a runId isn't specified, then the WorkflowExecutionTerminated event
* is recorded in the history of the current open workflow with the matching workflowId in the
* domain.
You should consider using RequestCancelWorkflowExecution action * instead because it allows the workflow to gracefully close while TerminateWorkflowExecution doesn't.
** Access Control *
diff --git a/clients/client-swf/src/endpoint/EndpointParameters.ts b/clients/client-swf/src/endpoint/EndpointParameters.ts index 1b03f6f9806df..8767fd293a14b 100644 --- a/clients/client-swf/src/endpoint/EndpointParameters.ts +++ b/clients/client-swf/src/endpoint/EndpointParameters.ts @@ -24,7 +24,7 @@ export const resolveClientEndpointParameters =Constrain the following parameters by using a Condition element with the
* appropriate keys.
+ *
* tag – A tag used to identify the workflow execution
+ *
* taskList – String constraint. The key is swf:taskList.name.
+ *
* workflowType.version – String constraint. The key is swf:workflowType.version.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the
+ *
Constrain the following parameters by using a Condition element with the
* appropriate keys.
* activityType.name – String constraint. The key is swf:activityType.name.
+ *
* activityType.version – String constraint. The key is swf:activityType.version.
+ *
* taskList – String constraint. The key is swf:taskList.name.
* 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.
The specified string 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.
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.
The specified string 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.
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.
+ *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-900 (1s-15m).
+ *If no value is supplied, then a default value of 900s is assumed.
*/ startToCloseTimeout?: string; } @@ -1864,22 +1870,22 @@ export interface SignalExternalWorkflowExecutionDecisionAttributes { *Constrain the following parameters by using a Condition element with the
* appropriate keys.
+ *
* tagList.member.N – The key is "swf:tagList.N" where N is the tag number from 0 to 4,
* inclusive.
+ *
* taskList – String constraint. The key is swf:taskList.name.
+ *
* workflowType.name – String constraint. The key is swf:workflowType.name.
+ *
* workflowType.version – String constraint. The key is swf:workflowType.version.
* 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.
The specified string 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.
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.
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.
* 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.
The specified string 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.
* Decision Failure *
- * *Decisions can fail for several reasons
- * *The ordering of decisions should follow a logical flow. Some decisions might not make sense in the current context of the workflow execution and therefore fails.
@@ -2139,12 +2148,10 @@ export interface StartTimerDecisionAttributes { *The decision lacks sufficient permissions.
*One of the following events might be added to the history to indicate an error. The event attribute's
* cause parameter indicates the cause. 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.
@@ -2154,57 +2161,57 @@ export interface StartTimerDecisionAttributes { *
- * RequestCancelActivityTaskFailed – A
+ * RequestCancelActivityTaskFailed – A
* RequestCancelActivityTask decision failed. This could happen if
* there is no open activity task with the specified activityId.
- * StartTimerFailed – A StartTimer decision failed. This
+ * StartTimerFailed – A StartTimer decision failed. This
* could happen if there is another open timer with the same timerId.
- * CancelTimerFailed – A CancelTimer decision failed.
+ * CancelTimerFailed – A CancelTimer decision failed.
* This could happen if there is no open timer with the specified
* timerId.
- * StartChildWorkflowExecutionFailed – A
+ * StartChildWorkflowExecutionFailed – A
* StartChildWorkflowExecution decision failed. This could happen
* if the workflow type specified isn't registered, is deprecated, or the decision
* isn't properly configured.
- * SignalExternalWorkflowExecutionFailed – A
+ * SignalExternalWorkflowExecutionFailed – A
* SignalExternalWorkflowExecution decision failed. This could
* happen if the workflowID specified in the decision was
* incorrect.
- * RequestCancelExternalWorkflowExecutionFailed – A
+ * RequestCancelExternalWorkflowExecutionFailed – A
* RequestCancelExternalWorkflowExecution decision failed. This
* could happen if the workflowID specified in the decision was
* incorrect.
- * CancelWorkflowExecutionFailed – A
+ * CancelWorkflowExecutionFailed – A
* CancelWorkflowExecution decision failed. This could happen if
* there is an unhandled decision task pending in the workflow execution.
- * CompleteWorkflowExecutionFailed – A
+ * CompleteWorkflowExecutionFailed – A
* CompleteWorkflowExecution decision failed. This could happen if
* there is an unhandled decision task pending in the workflow execution.
- * ContinueAsNewWorkflowExecutionFailed – A
+ * ContinueAsNewWorkflowExecutionFailed – A
* ContinueAsNewWorkflowExecution decision failed. This could
* happen if there is an unhandled decision task pending in the workflow execution
* or the ContinueAsNewWorkflowExecution decision was not configured
@@ -2212,7 +2219,7 @@ export interface StartTimerDecisionAttributes {
*
- * FailWorkflowExecutionFailed – A FailWorkflowExecution
+ * FailWorkflowExecutionFailed – A FailWorkflowExecution
* decision failed. This could happen if there is an unhandled decision task
* pending in the workflow execution.
*
* ScheduleActivityTaskDecisionAttributes
- *
+ *
*
*
* RequestCancelActivityTaskDecisionAttributes
- *
+ *
*
* CompleteWorkflowExecutionDecisionAttributes
*
- *
+ *
*
*
* FailWorkflowExecutionDecisionAttributes
*
- *
*
* RecordMarkerDecisionAttributes
*
- *
*
* StartTimerDecisionAttributes
*
- *
*
* CancelTimerDecisionAttributes
*
- *
*
* RequestCancelExternalWorkflowExecutionDecisionAttributes
*
- *
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
+ * after 24 hours. 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.
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
+ * after 24 hours. 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.
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
+ * after 24 hours. 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.
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
+ * after 24 hours. 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.
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
+ * after 24 hours. 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.
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
+ * after 24 hours. 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.
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.
arn.
*/
taskList: TaskList | undefined;
@@ -5654,11 +5654,10 @@ export interface PollForDecisionTaskInput {
/**
* Specifies the task list to poll for decision tasks.
- * - *The specified string must not start or end with whitespace. It must not contain a + *
The specified string 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.
arn.
*/
taskList: TaskList | undefined;
@@ -5673,9 +5672,8 @@ export interface PollForDecisionTaskInput {
* 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
+ * after 24 hours. 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.
When set to true, returns the events with eventTimestamp greater than or equal to eventTimestamp of the most recent DecisionTaskStarted event. By default, this parameter is set to false.
The name of the activity type within the domain.
- * - *The specified string must not start or end with whitespace. It must not contain a + *
The specified string 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.
arn.
*/
name: string | undefined;
@@ -5749,11 +5751,10 @@ export interface RegisterActivityTypeInput {
* 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 + *
The specified string 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.
arn.
*/
version: string | undefined;
@@ -5853,11 +5854,10 @@ export interface RegisterDomainInput {
/**
* 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.
arn.
*/
name: string | undefined;
@@ -5917,11 +5917,10 @@ export interface RegisterWorkflowTypeInput {
/**
* The name of the workflow type.
- * - *The specified string must not start or end with whitespace. It must not contain a + *
The specified string 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.
arn.
*/
name: string | undefined;
@@ -5932,11 +5931,10 @@ export interface RegisterWorkflowTypeInput {
* 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 + *
The specified string 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.
arn.
*/
version: string | undefined;
@@ -5958,7 +5956,6 @@ export interface RegisterWorkflowTypeInput {
* 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
@@ -6094,7 +6091,6 @@ export interface RespondActivityTaskCompletedInput {
export interface RespondActivityTaskFailedInput {
/**
*
The taskToken of the ActivityTask.
* taskToken is generated by the service and should be treated as an opaque value.
@@ -6193,6 +6189,10 @@ export interface SignalWorkflowExecutionInput {
export interface StartWorkflowExecutionInput {
/**
*
The name of the domain in which the workflow execution is created.
+ *The specified string 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.
workflowId at the same
* time within the same domain.
- *
- * The specified string must not start or end with whitespace. It must not contain a + *
The specified string 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.
arn.
*/
workflowId: string | undefined;
@@ -6224,11 +6223,10 @@ export interface StartWorkflowExecutionInput {
* 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 + *
The specified string 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.
arn.
*/
taskList?: TaskList;
@@ -6253,13 +6251,11 @@ export interface StartWorkflowExecutionInput {
/**
* 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 diff --git a/codegen/sdk-codegen/aws-models/swf.json b/codegen/sdk-codegen/aws-models/swf.json index 943f62874ec74..8951502d51c9b 100644 --- a/codegen/sdk-codegen/aws-models/swf.json +++ b/codegen/sdk-codegen/aws-models/swf.json @@ -431,13 +431,13 @@ "defaultTaskHeartbeatTimeout": { "target": "com.amazonaws.swf#DurationInSecondsOptional", "traits": { - "smithy.api#documentation": "
\n The default maximum time, in seconds, before which a worker processing a task must report\n progress by calling RecordActivityTaskHeartbeat.
\nYou can specify this value only when registering an activity type. The registered default value can be\n overridden when you schedule a task through the ScheduleActivityTask \n Decision. If the activity\n worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an\n UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid;\n 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.
\n The default maximum time, in seconds, before which a worker processing a task must report\n progress by calling RecordActivityTaskHeartbeat.
\nYou can specify this value only when registering an activity type. The registered default value can be\n overridden when you schedule a task through the ScheduleActivityTask\n Decision. If the activity\n worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an\n UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid;\n 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.
\n The default task list specified for this activity type at registration. This default is used if\n a task list isn't provided when a task is scheduled through the ScheduleActivityTask\n Decision. You can override the default registered task list when scheduling a task through the\n ScheduleActivityTask \n Decision.
\n The default task list specified for this activity type at registration. This default is used if\n a task list isn't provided when a task is scheduled through the ScheduleActivityTask\n Decision. You can override the default registered task list when scheduling a task through the\n ScheduleActivityTask\n Decision.
\n The default maximum duration, specified when registering the activity type, that a task of an\n activity type can wait before being assigned to a worker. You can override this default when scheduling a task\n through the ScheduleActivityTask \n Decision.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
\n The default maximum duration, specified when registering the activity type, that a task of an\n activity type can wait before being assigned to a worker. You can override this default when scheduling a task\n through the ScheduleActivityTask\n Decision.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution \n Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution\n Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution \n 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.
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution\n 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.
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution \n Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution\n Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution \n Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution\n Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution \n Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution\n Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution \n Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution\n Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.
Provides the details of the ContinueAsNewWorkflowExecution decision.
\n Access Control\n
\nYou can use IAM policies to control this decision's access to Amazon SWF resources as follows:
\nUse a Resource element with the domain name to limit the action to only\n specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the\n appropriate keys.
\n tag – A tag used to identify the workflow execution
\n taskList – String constraint. The key is swf:taskList.name.
\n workflowType.version – String constraint. The key is swf:workflowType.version.
If the caller doesn't have sufficient permissions to invoke the action, or the\n parameter values fall outside the specified constraints, the action fails. The associated event attribute's\n cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see\n Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Provides the details of the ContinueAsNewWorkflowExecution decision.
\n Access Control\n
\nYou can use IAM policies to control this decision's access to Amazon SWF resources as follows:
\nUse a Resource element with the domain name to limit the action to only\n specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the\n appropriate keys.
\n tag – A tag used to identify the workflow execution
\n taskList – String constraint. The key is swf:taskList.name.
\n workflowType.version – String constraint. The key is swf:workflowType.version.
If the caller doesn't have sufficient permissions to invoke the action, or the\n parameter values fall outside the specified constraints, the action fails. The associated event attribute's\n cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see\n Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Specifies a decision made by the decider. A decision can be one of these types:
\n\n CancelTimer – Cancels a previously started timer and records a TimerCanceled event in the\n history.
\n CancelWorkflowExecution – Closes the workflow execution and records a\n WorkflowExecutionCanceled event in the history.
\n CompleteWorkflowExecution – Closes the workflow execution and records a\n WorkflowExecutionCompleted event in the history .
\n ContinueAsNewWorkflowExecution – Closes the workflow execution and starts a new workflow execution of the\n same type using the same workflow ID and a unique run Id. A WorkflowExecutionContinuedAsNew event\n is recorded in the history.
\n FailWorkflowExecution – Closes the workflow execution and records a WorkflowExecutionFailed\n event in the history.
\n RecordMarker – Records a MarkerRecorded event in the history. Markers can be used for adding\n custom information in the history for instance to let deciders know that they don't need to look at the history\n beyond the marker event.
\n RequestCancelActivityTask – Attempts to cancel a previously scheduled activity task. If the activity task\n was scheduled but has not been assigned to a worker, then it is canceled. If the activity task was already\n assigned to a worker, then the worker is informed that cancellation has been requested in the response to\n RecordActivityTaskHeartbeat.
\n RequestCancelExternalWorkflowExecution – Requests that a request be made to cancel the specified external\n workflow execution and records a RequestCancelExternalWorkflowExecutionInitiated event in the\n history.
\n ScheduleActivityTask – Schedules an activity task.
\n SignalExternalWorkflowExecution – Requests a signal to be delivered to the specified external workflow\n execution and records a SignalExternalWorkflowExecutionInitiated event in the history.
\n StartChildWorkflowExecution – Requests that a child workflow execution be started and records a\n StartChildWorkflowExecutionInitiated event in the history. The child workflow execution is a\n separate workflow execution with its own history.
\n StartTimer – Starts a timer for this workflow execution and records a TimerStarted event in\n the history. This timer fires after the specified delay and record a TimerFired event.
\n Access Control\n
\nIf you grant permission to use RespondDecisionTaskCompleted, you can use IAM policies to express\n permissions for the list of decisions returned by this action as if they were members of the API. Treating\n decisions as a pseudo API maintains a uniform conceptual model and helps keep policies readable. For details and\n example IAM policies, see Using IAM to Manage Access to Amazon SWF\n Workflows in the Amazon SWF Developer Guide.
\n Decision Failure\n
\n\nDecisions can fail for several reasons
\n\nThe ordering of decisions should follow a logical flow. Some decisions might not make sense in the current context of the workflow execution and therefore fails.
\nA limit on your account was reached.
\nThe decision lacks sufficient permissions.
\nOne of the following events might be added to the history to indicate an error. The event attribute's\n cause parameter indicates the cause. If cause is set to OPERATION_NOT_PERMITTED, the decision failed\n because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows\n in the Amazon SWF Developer Guide.
\n ScheduleActivityTaskFailed – A ScheduleActivityTask decision failed. This could happen if the\n activity type specified in the decision isn't registered, is in a deprecated state, or the decision isn't\n properly configured.
\n RequestCancelActivityTaskFailed – A\n RequestCancelActivityTask decision failed. This could happen if\n there is no open activity task with the specified activityId.
\n StartTimerFailed – A StartTimer decision failed. This\n could happen if there is another open timer with the same timerId.
\n CancelTimerFailed – A CancelTimer decision failed.\n This could happen if there is no open timer with the specified\n timerId.
\n StartChildWorkflowExecutionFailed – A\n StartChildWorkflowExecution decision failed. This could happen\n if the workflow type specified isn't registered, is deprecated, or the decision\n isn't properly configured.
\n SignalExternalWorkflowExecutionFailed – A\n SignalExternalWorkflowExecution decision failed. This could\n happen if the workflowID specified in the decision was\n incorrect.
\n RequestCancelExternalWorkflowExecutionFailed – A\n RequestCancelExternalWorkflowExecution decision failed. This\n could happen if the workflowID specified in the decision was\n incorrect.
\n CancelWorkflowExecutionFailed – A\n CancelWorkflowExecution decision failed. This could happen if\n there is an unhandled decision task pending in the workflow execution.
\n CompleteWorkflowExecutionFailed – A\n CompleteWorkflowExecution decision failed. This could happen if\n there is an unhandled decision task pending in the workflow execution.
\n ContinueAsNewWorkflowExecutionFailed – A\n ContinueAsNewWorkflowExecution decision failed. This could\n happen if there is an unhandled decision task pending in the workflow execution\n or the ContinueAsNewWorkflowExecution decision was not configured\n correctly.
\n FailWorkflowExecutionFailed – A FailWorkflowExecution\n decision failed. This could happen if there is an unhandled decision task\n pending in the workflow execution.
The preceding error events might occur due to an error in the decider logic, which might put the workflow execution in an unstable state The cause field in the event structure for the error event indicates the cause of the error.
\nA workflow execution may be closed by the decider by returning one of the following decisions when completing\n a decision task: CompleteWorkflowExecution, FailWorkflowExecution,\n CancelWorkflowExecution and ContinueAsNewWorkflowExecution. An UnhandledDecision fault\n is returned if a workflow closing decision is specified and a signal or activity event had been added to the\n history while the decision task was being performed by the decider. Unlike the above situations which are logic\n issues, this fault is always possible because of race conditions in a distributed system. The right action here is\n to call RespondDecisionTaskCompleted without any decisions. This would result in another decision task\n with these new events included in the history. The decider should handle the new events and may decide to close\n the workflow execution.
\n How to Code a Decision\n
\nYou code a decision by first setting the decision type field to one of the above decision values, and then set the corresponding attributes field shown below:
\n\n \n ScheduleActivityTaskDecisionAttributes\n \n
\n \n RequestCancelActivityTaskDecisionAttributes\n \n
\n \n CompleteWorkflowExecutionDecisionAttributes\n \n
\n \n FailWorkflowExecutionDecisionAttributes\n \n
\n \n CancelWorkflowExecutionDecisionAttributes\n \n
\n \n RecordMarkerDecisionAttributes\n \n
\n \n StartTimerDecisionAttributes\n \n
\n \n CancelTimerDecisionAttributes\n \n
\n \n SignalExternalWorkflowExecutionDecisionAttributes\n \n
\n \n RequestCancelExternalWorkflowExecutionDecisionAttributes\n \n
Specifies a decision made by the decider. A decision can be one of these types:
\n\n CancelTimer – Cancels a previously started timer and records a TimerCanceled event in the\n history.
\n CancelWorkflowExecution – Closes the workflow execution and records a\n WorkflowExecutionCanceled event in the history.
\n CompleteWorkflowExecution – Closes the workflow execution and records a\n WorkflowExecutionCompleted event in the history .
\n ContinueAsNewWorkflowExecution – Closes the workflow execution and starts a new workflow execution of the\n same type using the same workflow ID and a unique run Id. A WorkflowExecutionContinuedAsNew event\n is recorded in the history.
\n FailWorkflowExecution – Closes the workflow execution and records a WorkflowExecutionFailed\n event in the history.
\n RecordMarker – Records a MarkerRecorded event in the history. Markers can be used for adding\n custom information in the history for instance to let deciders know that they don't need to look at the history\n beyond the marker event.
\n RequestCancelActivityTask – Attempts to cancel a previously scheduled activity task. If the activity task\n was scheduled but has not been assigned to a worker, then it is canceled. If the activity task was already\n assigned to a worker, then the worker is informed that cancellation has been requested in the response to\n RecordActivityTaskHeartbeat.
\n RequestCancelExternalWorkflowExecution – Requests that a request be made to cancel the specified external\n workflow execution and records a RequestCancelExternalWorkflowExecutionInitiated event in the\n history.
\n ScheduleActivityTask – Schedules an activity task.
\n SignalExternalWorkflowExecution – Requests a signal to be delivered to the specified external workflow\n execution and records a SignalExternalWorkflowExecutionInitiated event in the history.
\n StartChildWorkflowExecution – Requests that a child workflow execution be started and records a\n StartChildWorkflowExecutionInitiated event in the history. The child workflow execution is a\n separate workflow execution with its own history.
\n StartTimer – Starts a timer for this workflow execution and records a TimerStarted event in\n the history. This timer fires after the specified delay and record a TimerFired event.
\n Access Control\n
\nIf you grant permission to use RespondDecisionTaskCompleted, you can use IAM policies to express\n permissions for the list of decisions returned by this action as if they were members of the API. Treating\n decisions as a pseudo API maintains a uniform conceptual model and helps keep policies readable. For details and\n example IAM policies, see Using IAM to Manage Access to Amazon SWF\n Workflows in the Amazon SWF Developer Guide.
\n Decision Failure\n
\nDecisions can fail for several reasons
\nThe ordering of decisions should follow a logical flow. Some decisions might not make sense in the current context of the workflow execution and therefore fails.
\nA limit on your account was reached.
\nThe decision lacks sufficient permissions.
\nOne of the following events might be added to the history to indicate an error. The event attribute's\n cause parameter indicates the cause. If cause is set to OPERATION_NOT_PERMITTED, the decision failed\n because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows\n in the Amazon SWF Developer Guide.
\n ScheduleActivityTaskFailed – A ScheduleActivityTask decision failed. This could happen if the\n activity type specified in the decision isn't registered, is in a deprecated state, or the decision isn't\n properly configured.
\n RequestCancelActivityTaskFailed – A\n RequestCancelActivityTask decision failed. This could happen if\n there is no open activity task with the specified activityId.
\n StartTimerFailed – A StartTimer decision failed. This\n could happen if there is another open timer with the same timerId.
\n CancelTimerFailed – A CancelTimer decision failed.\n This could happen if there is no open timer with the specified\n timerId.
\n StartChildWorkflowExecutionFailed – A\n StartChildWorkflowExecution decision failed. This could happen\n if the workflow type specified isn't registered, is deprecated, or the decision\n isn't properly configured.
\n SignalExternalWorkflowExecutionFailed – A\n SignalExternalWorkflowExecution decision failed. This could\n happen if the workflowID specified in the decision was\n incorrect.
\n RequestCancelExternalWorkflowExecutionFailed – A\n RequestCancelExternalWorkflowExecution decision failed. This\n could happen if the workflowID specified in the decision was\n incorrect.
\n CancelWorkflowExecutionFailed – A\n CancelWorkflowExecution decision failed. This could happen if\n there is an unhandled decision task pending in the workflow execution.
\n CompleteWorkflowExecutionFailed – A\n CompleteWorkflowExecution decision failed. This could happen if\n there is an unhandled decision task pending in the workflow execution.
\n ContinueAsNewWorkflowExecutionFailed – A\n ContinueAsNewWorkflowExecution decision failed. This could\n happen if there is an unhandled decision task pending in the workflow execution\n or the ContinueAsNewWorkflowExecution decision was not configured\n correctly.
\n FailWorkflowExecutionFailed – A FailWorkflowExecution\n decision failed. This could happen if there is an unhandled decision task\n pending in the workflow execution.
The preceding error events might occur due to an error in the decider logic, which might put the workflow execution in an unstable state The cause field in the event structure for the error event indicates the cause of the error.
\nA workflow execution may be closed by the decider by returning one of the following decisions when completing\n a decision task: CompleteWorkflowExecution, FailWorkflowExecution,\n CancelWorkflowExecution and ContinueAsNewWorkflowExecution. An UnhandledDecision fault\n is returned if a workflow closing decision is specified and a signal or activity event had been added to the\n history while the decision task was being performed by the decider. Unlike the above situations which are logic\n issues, this fault is always possible because of race conditions in a distributed system. The right action here is\n to call RespondDecisionTaskCompleted without any decisions. This would result in another decision task\n with these new events included in the history. The decider should handle the new events and may decide to close\n the workflow execution.
\n How to Code a Decision\n
\nYou code a decision by first setting the decision type field to one of the above decision values, and then set the corresponding attributes field shown below:
\n\n \n ScheduleActivityTaskDecisionAttributes\n \n
\n \n RequestCancelActivityTaskDecisionAttributes\n \n
\n \n CompleteWorkflowExecutionDecisionAttributes\n \n
\n \n FailWorkflowExecutionDecisionAttributes\n \n
\n \n CancelWorkflowExecutionDecisionAttributes\n \n
\n \n RecordMarkerDecisionAttributes\n \n
\n \n StartTimerDecisionAttributes\n \n
\n \n CancelTimerDecisionAttributes\n \n
\n \n SignalExternalWorkflowExecutionDecisionAttributes\n \n
\n \n RequestCancelExternalWorkflowExecutionDecisionAttributes\n \n
If NextPageToken is returned there are more results\n available. The value of NextPageToken is a unique pagination token for each page. Make the call again using \n the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires \n after 60 seconds. Using an expired pagination token will return a 400 error: \"Specified token has \n exceeded its maximum lifetime\".
The configured maximumPageSize determines how many results can be returned\n in a single call.
If NextPageToken is returned there are more results\n available. The value of NextPageToken is a unique pagination token for each page. Make the call again using \n the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires \n after 24 hours. Using an expired pagination token will return a 400 error: \"Specified token has \n exceeded its maximum lifetime\".
The configured maximumPageSize determines how many results can be returned\n in a single call.
If NextPageToken is returned there are more results\n available. The value of NextPageToken is a unique pagination token for each page. Make the call again using \n the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires \n after 60 seconds. Using an expired pagination token will return a 400 error: \"Specified token has \n exceeded its maximum lifetime\".
The configured maximumPageSize determines how many results can be returned\n in a single call.
If NextPageToken is returned there are more results\n available. The value of NextPageToken is a unique pagination token for each page. Make the call again using \n the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires \n after 24 hours. Using an expired pagination token will return a 400 error: \"Specified token has \n exceeded its maximum lifetime\".
The configured maximumPageSize determines how many results can be returned\n in a single call.
If NextPageToken is returned there are more results\n available. The value of NextPageToken is a unique pagination token for each page. Make the call again using \n the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires \n after 60 seconds. Using an expired pagination token will return a 400 error: \"Specified token has \n exceeded its maximum lifetime\".
The configured maximumPageSize determines how many results can be returned\n in a single call.
If NextPageToken is returned there are more results\n available. The value of NextPageToken is a unique pagination token for each page. Make the call again using \n the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires \n after 24 hours. Using an expired pagination token will return a 400 error: \"Specified token has \n exceeded its maximum lifetime\".
The configured maximumPageSize determines how many results can be returned\n in a single call.
If NextPageToken is returned there are more results\n available. The value of NextPageToken is a unique pagination token for each page. Make the call again using \n the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires \n after 60 seconds. Using an expired pagination token will return a 400 error: \"Specified token has \n exceeded its maximum lifetime\".
The configured maximumPageSize determines how many results can be returned\n in a single call.
If NextPageToken is returned there are more results\n available. The value of NextPageToken is a unique pagination token for each page. Make the call again using \n the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires \n after 24 hours. Using an expired pagination token will return a 400 error: \"Specified token has \n exceeded its maximum lifetime\".
The configured maximumPageSize determines how many results can be returned\n in a single call.
If NextPageToken is returned there are more results\n available. The value of NextPageToken is a unique pagination token for each page. Make the call again using \n the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires \n after 60 seconds. Using an expired pagination token will return a 400 error: \"Specified token has \n exceeded its maximum lifetime\".
The configured maximumPageSize determines how many results can be returned\n in a single call.
If NextPageToken is returned there are more results\n available. The value of NextPageToken is a unique pagination token for each page. Make the call again using \n the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires \n after 24 hours. Using an expired pagination token will return a 400 error: \"Specified token has \n exceeded its maximum lifetime\".
The configured maximumPageSize determines how many results can be returned\n in a single call.
If NextPageToken is returned there are more results\n available. The value of NextPageToken is a unique pagination token for each page. Make the call again using \n the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires \n after 60 seconds. Using an expired pagination token will return a 400 error: \"Specified token has \n exceeded its maximum lifetime\".
The configured maximumPageSize determines how many results can be returned\n in a single call.
If NextPageToken is returned there are more results\n available. The value of NextPageToken is a unique pagination token for each page. Make the call again using \n the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires \n after 24 hours. Using an expired pagination token will return a 400 error: \"Specified token has \n exceeded its maximum lifetime\".
The configured maximumPageSize determines how many results can be returned\n in a single call.
Specifies the task list to poll for activity tasks.
\n \nThe specified string must not start or end with whitespace. It must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.
Specifies the task list to poll for activity tasks.
\nThe specified string must not start or end with whitespace. It must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.
Specifies the task list to poll for decision tasks.
\n \nThe specified string must not start or end with whitespace. It must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.
Specifies the task list to poll for decision tasks.
\nThe specified string must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.
If NextPageToken is returned there are more results\n available. The value of NextPageToken is a unique pagination token for each page. Make the call again using \n the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires \n after 60 seconds. Using an expired pagination token will return a 400 error: \"Specified token has \n exceeded its maximum lifetime\".
The configured maximumPageSize determines how many results can be returned\n 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\n the next page of history records. Calling PollForDecisionTask with a\n nextPageToken doesn't return a new decision task.
If NextPageToken is returned there are more results\n available. The value of NextPageToken is a unique pagination token for each page. Make the call again using \n the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires \n after 24 hours. Using an expired pagination token will return a 400 error: \"Specified token has \n exceeded its maximum lifetime\".
The configured maximumPageSize determines how many results can be returned\n 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\n the next page of history records. Calling PollForDecisionTask with a\n nextPageToken doesn't return a new decision task.
The maximum number of results that are returned per call.\n Use nextPageToken to obtain further pages of results.
This\n is an upper limit only; the actual number of results returned per call may be fewer than the\n specified maximum.
" + "smithy.api#documentation": "The maximum number of results that are returned per call.\n Use nextPageToken to obtain further pages of results.
This\n is an upper limit only; the actual number of results returned per call may be fewer than the\n specified maximum.
" } }, "reverseOrder": { @@ -4136,6 +4136,13 @@ "smithy.api#default": false, "smithy.api#documentation": "When set to true, returns the events in reverse order. By default the\n results are returned in ascending order of the eventTimestamp of the\n events.
When set to true, returns the events with eventTimestamp greater than or equal to eventTimestamp of the most recent DecisionTaskStarted event. By default, this parameter is set to false.
The name of the activity type within the domain.
\n \nThe specified string must not start or end with whitespace. It must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.
The name of the activity type within the domain.
\nThe specified string must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.
The version of the activity type.
\nThe activity type consists of the name and version, the combination of which must be\n unique within the domain.
\nThe specified string must not start or end with whitespace. It must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.
The version of the activity type.
\nThe activity type consists of the name and version, the combination of which must be\n unique within the domain.
\nThe specified string must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.
Name of the domain to register. The name must be unique in the region that the domain\n is registered in.
\n \nThe specified string must not start or end with whitespace. It must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.
Name of the domain to register. The name must be unique in the region that the domain\n is registered in.
\nThe specified string must not start or end with whitespace. It must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.
Tags to be added when registering a domain.
\nTags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.
Tags to be added when registering a domain.
\nTags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.
The name of the workflow type.
\n \nThe specified string must not start or end with whitespace. It must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.
The name of the workflow type.
\nThe specified string must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.
The version of the workflow type.
\nThe workflow type consists of the name and version, the combination of which must be\n unique within the domain. To get a list of all currently registered workflow types, use the\n ListWorkflowTypes action.
\nThe specified string must not start or end with whitespace. It must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.
The version of the workflow type.
\nThe workflow type consists of the name and version, the combination of which must be\n unique within the domain. To get a list of all currently registered workflow types, use the\n ListWorkflowTypes action.
\nThe specified string must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.
If set, specifies the default maximum duration for executions of this workflow type.\n You can override this default when starting an execution through the StartWorkflowExecution Action or StartChildWorkflowExecution\n Decision.
The duration is specified in seconds; an integer greater than or equal to 0. Unlike\n some of the other timeout parameters in Amazon SWF, you cannot specify a value of \"NONE\" for\n defaultExecutionStartToCloseTimeout; there is a one-year max limit on the time\n that a workflow execution can run. Exceeding this limit always causes the workflow execution\n to time out.
If set, specifies the default maximum duration for executions of this workflow type.\n You can override this default when starting an execution through the StartWorkflowExecution Action or StartChildWorkflowExecution\n Decision.
The duration is specified in seconds; an integer greater than or equal to 0. Unlike\n some of the other timeout parameters in Amazon SWF, you cannot specify a value of \"NONE\" for\n defaultExecutionStartToCloseTimeout; there is a one-year max limit on the time\n that a workflow execution can run. Exceeding this limit always causes the workflow execution\n to time out.
Records a WorkflowExecutionCancelRequested event in the currently running\n workflow execution identified by the given domain, workflowId, and runId. This logically\n requests the cancellation of the workflow execution as a whole. It is up to the decider to\n take appropriate actions when it receives an execution history with this event.
If the runId isn't specified, the WorkflowExecutionCancelRequested event\n is recorded in the history of the current open workflow execution with the specified\n workflowId in the domain.
Because this action allows the workflow to properly clean up and gracefully close, it\n should be used instead of TerminateWorkflowExecution when\n possible.
\n\n Access Control\n
\nYou can use IAM policies to control this action's access to Amazon SWF resources as\n follows:
\nUse a Resource element with the domain name to limit the action to\n only specified domains.
Use an Action element to allow or deny permission to call this\n action.
You cannot use an IAM policy to constrain this action's parameters.
\nIf the caller doesn't have sufficient permissions to invoke the action, or the\n parameter values fall outside the specified constraints, the action fails. The associated\n event attribute's cause parameter is set to OPERATION_NOT_PERMITTED.\n For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF\n Workflows in the Amazon SWF Developer Guide.
Records a WorkflowExecutionCancelRequested event in the currently running\n workflow execution identified by the given domain, workflowId, and runId. This logically\n requests the cancellation of the workflow execution as a whole. It is up to the decider to\n take appropriate actions when it receives an execution history with this event.
If the runId isn't specified, the WorkflowExecutionCancelRequested event\n is recorded in the history of the current open workflow execution with the specified\n workflowId in the domain.
Because this action allows the workflow to properly clean up and gracefully close, it\n should be used instead of TerminateWorkflowExecution when\n possible.
\n\n Access Control\n
\nYou can use IAM policies to control this action's access to Amazon SWF resources as\n follows:
\nUse a Resource element with the domain name to limit the action to\n only specified domains.
Use an Action element to allow or deny permission to call this\n action.
You cannot use an IAM policy to constrain this action's parameters.
\nIf the caller doesn't have sufficient permissions to invoke the action, or the\n parameter values fall outside the specified constraints, the action fails. The associated\n event attribute's cause parameter is set to OPERATION_NOT_PERMITTED.\n For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF\n Workflows in the Amazon SWF Developer Guide.
Tags are key-value pairs that can be associated with Amazon SWF state machines and\n activities.
\nTags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.
Tags are key-value pairs that can be associated with Amazon SWF state machines and\n activities.
\nTags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.
Used by workers to tell the service that the ActivityTask identified\n by the taskToken was successfully canceled. Additional details can\n be provided using the details argument.
These details (if provided) appear in the\n ActivityTaskCanceled event added to the workflow history.
Only use this operation if the canceled flag of a RecordActivityTaskHeartbeat request returns true and if the\n activity can be safely undone or abandoned.
A task is considered open from the time that it is scheduled until it is closed.\n Therefore a task is reported as open while a worker is processing it. A task is closed after\n it has been specified in a call to RespondActivityTaskCompleted,\n RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has\n timed\n out.
\n\n\n Access Control\n
\nYou can use IAM policies to control this action's access to Amazon SWF resources as\n follows:
\nUse a Resource element with the domain name to limit the action to\n only specified domains.
Use an Action element to allow or deny permission to call this\n action.
You cannot use an IAM policy to constrain this action's parameters.
\nIf the caller doesn't have sufficient permissions to invoke the action, or the\n parameter values fall outside the specified constraints, the action fails. The associated\n event attribute's cause parameter is set to OPERATION_NOT_PERMITTED.\n For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF\n Workflows in the Amazon SWF Developer Guide.
Used by workers to tell the service that the ActivityTask identified\n by the taskToken was successfully canceled. Additional details can\n be provided using the details argument.
These details (if provided) appear in the\n ActivityTaskCanceled event added to the workflow history.
Only use this operation if the canceled flag of a RecordActivityTaskHeartbeat request returns true and if the\n activity can be safely undone or abandoned.
A task is considered open from the time that it is scheduled until it is closed.\n Therefore a task is reported as open while a worker is processing it. A task is closed after\n it has been specified in a call to RespondActivityTaskCompleted,\n RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has\n timed\n out.
\n\n Access Control\n
\nYou can use IAM policies to control this action's access to Amazon SWF resources as\n follows:
\nUse a Resource element with the domain name to limit the action to\n only specified domains.
Use an Action element to allow or deny permission to call this\n action.
You cannot use an IAM policy to constrain this action's parameters.
\nIf the caller doesn't have sufficient permissions to invoke the action, or the\n parameter values fall outside the specified constraints, the action fails. The associated\n event attribute's cause parameter is set to OPERATION_NOT_PERMITTED.\n For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF\n Workflows in the Amazon SWF Developer Guide.
Used by workers to tell the service that the ActivityTask identified\n by the taskToken completed successfully with a result (if provided).\n The result appears in the ActivityTaskCompleted event in the\n workflow history.
If the requested task doesn't complete successfully, use RespondActivityTaskFailed instead. If the worker finds that the task is\n canceled through the canceled flag returned by RecordActivityTaskHeartbeat, it should cancel the task, clean up and then call\n RespondActivityTaskCanceled.
A task is considered open from the time that it is scheduled until it is closed.\n Therefore a task is reported as open while a worker is processing it. A task is closed after\n it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the\n task has timed\n out.
\n\n\n Access Control\n
\nYou can use IAM policies to control this action's access to Amazon SWF resources as\n follows:
\nUse a Resource element with the domain name to limit the action to\n only specified domains.
Use an Action element to allow or deny permission to call this\n action.
You cannot use an IAM policy to constrain this action's parameters.
\nIf the caller doesn't have sufficient permissions to invoke the action, or the\n parameter values fall outside the specified constraints, the action fails. The associated\n event attribute's cause parameter is set to OPERATION_NOT_PERMITTED.\n For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF\n Workflows in the Amazon SWF Developer Guide.
Used by workers to tell the service that the ActivityTask identified\n by the taskToken completed successfully with a result (if provided).\n The result appears in the ActivityTaskCompleted event in the\n workflow history.
If the requested task doesn't complete successfully, use RespondActivityTaskFailed instead. If the worker finds that the task is\n canceled through the canceled flag returned by RecordActivityTaskHeartbeat, it should cancel the task, clean up and then call\n RespondActivityTaskCanceled.
A task is considered open from the time that it is scheduled until it is closed.\n Therefore a task is reported as open while a worker is processing it. A task is closed after\n it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the\n task has timed\n out.
\n\n Access Control\n
\nYou can use IAM policies to control this action's access to Amazon SWF resources as\n follows:
\nUse a Resource element with the domain name to limit the action to\n only specified domains.
Use an Action element to allow or deny permission to call this\n action.
You cannot use an IAM policy to constrain this action's parameters.
\nIf the caller doesn't have sufficient permissions to invoke the action, or the\n parameter values fall outside the specified constraints, the action fails. The associated\n event attribute's cause parameter is set to OPERATION_NOT_PERMITTED.\n For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF\n Workflows in the Amazon SWF Developer Guide.
Used by workers to tell the service that the ActivityTask identified\n by the taskToken has failed with reason (if specified). The\n reason and details appear in the ActivityTaskFailed\n event added to the workflow history.
A task is considered open from the time that it is scheduled until it is closed.\n Therefore a task is reported as open while a worker is processing it. A task is closed after\n it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed\n out.
\n\n\n Access Control\n
\nYou can use IAM policies to control this action's access to Amazon SWF resources as\n follows:
\nUse a Resource element with the domain name to limit the action to\n only specified domains.
Use an Action element to allow or deny permission to call this\n action.
You cannot use an IAM policy to constrain this action's parameters.
\nIf the caller doesn't have sufficient permissions to invoke the action, or the\n parameter values fall outside the specified constraints, the action fails. The associated\n event attribute's cause parameter is set to OPERATION_NOT_PERMITTED.\n For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF\n Workflows in the Amazon SWF Developer Guide.
Used by workers to tell the service that the ActivityTask identified\n by the taskToken has failed with reason (if specified). The\n reason and details appear in the ActivityTaskFailed\n event added to the workflow history.
A task is considered open from the time that it is scheduled until it is closed.\n Therefore a task is reported as open while a worker is processing it. A task is closed after\n it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed\n out.
\n\n Access Control\n
\nYou can use IAM policies to control this action's access to Amazon SWF resources as\n follows:
\nUse a Resource element with the domain name to limit the action to\n only specified domains.
Use an Action element to allow or deny permission to call this\n action.
You cannot use an IAM policy to constrain this action's parameters.
\nIf the caller doesn't have sufficient permissions to invoke the action, or the\n parameter values fall outside the specified constraints, the action fails. The associated\n event attribute's cause parameter is set to OPERATION_NOT_PERMITTED.\n For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF\n Workflows in the Amazon SWF Developer Guide.
The taskToken of the ActivityTask.
\n taskToken is generated by the service and should be treated as an opaque value.\n If the task is passed to another process, its taskToken must also be passed.\n This enables it to provide its progress and respond with results.
The taskToken of the ActivityTask.
\n taskToken is generated by the service and should be treated as an opaque value.\n If the task is passed to another process, its taskToken must also be passed.\n This enables it to provide its progress and respond with results.
Used by deciders to tell the service that the DecisionTask identified\n by the taskToken has successfully completed. The decisions argument\n specifies the list of decisions made while processing the task.
A DecisionTaskCompleted event is added to the workflow history. The\n executionContext specified is attached to the event in the workflow execution\n history.
\n Access Control\n
\n\nIf an IAM policy grants permission to use RespondDecisionTaskCompleted, it\n can express permissions for the list of decisions in the decisions parameter.\n Each of the decisions has one or more parameters, much like a regular API call. To allow for\n policies to be as readable as possible, you can express permissions on decisions as if they\n were actual API calls, including applying conditions to some parameters. For more information,\n see Using\n IAM to Manage Access to Amazon SWF Workflows in the\n Amazon SWF Developer Guide.
Used by deciders to tell the service that the DecisionTask identified\n by the taskToken has successfully completed. The decisions argument\n specifies the list of decisions made while processing the task.
A DecisionTaskCompleted event is added to the workflow history. The\n executionContext specified is attached to the event in the workflow execution\n history.
\n Access Control\n
\nIf an IAM policy grants permission to use RespondDecisionTaskCompleted, it\n can express permissions for the list of decisions in the decisions parameter.\n Each of the decisions has one or more parameters, much like a regular API call. To allow for\n policies to be as readable as possible, you can express permissions on decisions as if they\n were actual API calls, including applying conditions to some parameters. For more information,\n see Using\n IAM to Manage Access to Amazon SWF Workflows in the\n Amazon SWF Developer Guide.
\n The activityId of the activity task.
The specified string must not start or end with whitespace. It must not contain a :\n (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not contain the literal string arn.
\n The activityId of the activity task.
The specified string must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.
If set, specifies the name of the task list in which to schedule the activity task. If not specified, the\n 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.
\nThe specified string must not start or end with whitespace. It must not contain a :\n (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not contain the literal string arn.
If set, specifies the name of the task list in which to schedule the activity task. If not specified, the\n 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.
\nThe specified string must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.
Provides the details of the ScheduleActivityTask decision.
\n Access Control\n
\nYou can use IAM policies to control this decision's access to Amazon SWF resources as follows:
\nUse a Resource element with the domain name to limit the action to only\n specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the\n appropriate keys.
\n activityType.name – String constraint. The key is swf:activityType.name.
\n activityType.version – String constraint. The key is swf:activityType.version.
\n taskList – String constraint. The key is swf:taskList.name.
If the caller doesn't have sufficient permissions to invoke the action, or the\n parameter values fall outside the specified constraints, the action fails. The associated event attribute's\n cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see\n Using IAM to Manage Access to Amazon SWF Workflows\n in the Amazon SWF Developer Guide.
Provides the details of the ScheduleActivityTask decision.
\n Access Control\n
\nYou can use IAM policies to control this decision's access to Amazon SWF resources as follows:
\nUse a Resource element with the domain name to limit the action to only\n specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the\n appropriate keys.
\n activityType.name – String constraint. The key is swf:activityType.name.
\n activityType.version – String constraint. The key is swf:activityType.version.
\n taskList – String constraint. The key is swf:taskList.name.
If the caller doesn't have sufficient permissions to invoke the action, or the\n parameter values fall outside the specified constraints, the action fails. The associated event attribute's\n cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see\n Using IAM to Manage Access to Amazon SWF Workflows\n in the Amazon SWF Developer Guide.
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.
" + "smithy.api#documentation": "The timeout value, in seconds, after which the Lambda function is considered to be\n failed once it has started. This can be any integer from 1-900 (1s-15m).
\nIf no value is supplied, then a default value of 900s is assumed.
" } } }, @@ -5480,7 +5487,7 @@ } ], "traits": { - "smithy.api#documentation": "Records a WorkflowExecutionSignaled event in the workflow execution\n history and creates a decision task for the workflow execution identified by the given domain,\n workflowId and runId. The event is recorded with the specified user defined signalName and\n input (if provided).
If a runId isn't specified, then the WorkflowExecutionSignaled event is\n recorded in the history of the current open workflow with the matching workflowId in the\n domain.
If the specified workflow execution isn't open, this method fails with\n UnknownResource.
\n Access Control\n
\nYou can use IAM policies to control this action's access to Amazon SWF resources as\n follows:
\nUse a Resource element with the domain name to limit the action to\n only specified domains.
Use an Action element to allow or deny permission to call this\n action.
You cannot use an IAM policy to constrain this action's parameters.
\nIf the caller doesn't have sufficient permissions to invoke the action, or the\n parameter values fall outside the specified constraints, the action fails. The associated\n event attribute's cause parameter is set to OPERATION_NOT_PERMITTED.\n For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF\n Workflows in the Amazon SWF Developer Guide.
Records a WorkflowExecutionSignaled event in the workflow execution\n history and creates a decision task for the workflow execution identified by the given domain,\n workflowId and runId. The event is recorded with the specified user defined signalName and\n input (if provided).
If a runId isn't specified, then the WorkflowExecutionSignaled event is\n recorded in the history of the current open workflow with the matching workflowId in the\n domain.
If the specified workflow execution isn't open, this method fails with\n UnknownResource.
\n Access Control\n
\nYou can use IAM policies to control this action's access to Amazon SWF resources as\n follows:
\nUse a Resource element with the domain name to limit the action to\n only specified domains.
Use an Action element to allow or deny permission to call this\n action.
You cannot use an IAM policy to constrain this action's parameters.
\nIf the caller doesn't have sufficient permissions to invoke the action, or the\n parameter values fall outside the specified constraints, the action fails. The associated\n event attribute's cause parameter is set to OPERATION_NOT_PERMITTED.\n For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF\n Workflows in the Amazon SWF Developer Guide.
The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon's cloud to\n coordinate work across distributed components. In Amazon SWF, a task\n represents a logical unit of work that is performed by a component of your workflow.\n Coordinating tasks in a workflow involves managing intertask dependencies, scheduling, and \n concurrency in accordance with the logical flow of the application.
\n\nAmazon SWF gives you full control over implementing tasks and coordinating them without\n worrying about underlying complexities such as tracking their progress and maintaining their\n state.
\n\nThis documentation serves as reference only. For a broader overview of the Amazon SWF\n programming model, see the \n Amazon SWF Developer Guide\n .
", + "smithy.api#documentation": "The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon's cloud to\n coordinate work across distributed components. In Amazon SWF, a task\n represents a logical unit of work that is performed by a component of your workflow.\n Coordinating tasks in a workflow involves managing intertask dependencies, scheduling, and \n concurrency in accordance with the logical flow of the application.
\nAmazon SWF gives you full control over implementing tasks and coordinating them without\n worrying about underlying complexities such as tracking their progress and maintaining their\n state.
\nThis documentation serves as reference only. For a broader overview of the Amazon SWF\n programming model, see the \n Amazon SWF Developer Guide\n .
", "smithy.api#title": "Amazon Simple Workflow Service", "smithy.api#xmlNamespace": { "uri": "http://swf.amazonaws.com/doc/2012-01-25" @@ -5662,7 +5669,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": true, + "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -5691,13 +5698,12 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "isSet", "argv": [ { - "ref": "Region" + "ref": "Endpoint" } - ], - "assign": "PartitionResult" + ] } ], "type": "tree", @@ -5705,14 +5711,20 @@ { "conditions": [ { - "fn": "isSet", + "fn": "booleanEquals", "argv": [ { - "ref": "Endpoint" - } + "ref": "UseFIPS" + }, + true ] } ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], "type": "tree", "rules": [ { @@ -5721,67 +5733,42 @@ "fn": "booleanEquals", "argv": [ { - "ref": "UseFIPS" + "ref": "UseDualStack" }, true ] } ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" + "endpoint": { + "url": { + "ref": "Endpoint" }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ { "conditions": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", + "fn": "isSet", "argv": [ { - "ref": "UseDualStack" - }, - true + "ref": "Region" + } ] } ], @@ -5790,179 +5777,240 @@ { "conditions": [ { - "fn": "booleanEquals", + "fn": "aws.partition", "argv": [ - true, { - "fn": "getAttr", + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseFIPS" }, - "supportsFIPS" + true ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, + }, { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" }, - "supportsDualStack" + true ] } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], + ], "type": "tree", "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://swf-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, { "conditions": [], - "endpoint": { - "url": "https://swf-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" } ] - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseFIPS" }, - "supportsFIPS" + true ] } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "stringEquals", + "fn": "booleanEquals", "argv": [ - "aws-us-gov", + true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, - "name" + "supportsFIPS" ] } ] } ], - "endpoint": { - "url": "https://swf.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws-us-gov", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://swf.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://swf-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] }, { "conditions": [], - "endpoint": { - "url": "https://swf-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" } ] - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" }, - "supportsDualStack" + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://swf.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] - } - ], - "type": "tree", - "rules": [ + }, { "conditions": [], "type": "tree", @@ -5970,7 +6018,7 @@ { "conditions": [], "endpoint": { - "url": "https://swf.{Region}.{PartitionResult#dualStackDnsSuffix}", + "url": "https://swf.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, @@ -5979,66 +6027,13 @@ ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } ] }, { "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "ref": "Region" - }, - "us-gov-east-1" - ] - } - ], - "endpoint": { - "url": "https://swf.us-gov-east-1.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "ref": "Region" - }, - "us-gov-west-1" - ] - } - ], - "endpoint": { - "url": "https://swf.us-gov-west-1.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://swf.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] } @@ -6047,42 +6042,55 @@ "smithy.rules#endpointTests": { "testCases": [ { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://swf.us-iso-east-1.c2s.ic.gov" + "url": "https://swf.af-south-1.amazonaws.com" } }, "params": { - "UseDualStack": false, + "Region": "af-south-1", "UseFIPS": false, - "Region": "us-iso-east-1" + "UseDualStack": false } }, { - "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://swf.us-iso-west-1.c2s.ic.gov" + "url": "https://swf.ap-east-1.amazonaws.com" } }, "params": { - "UseDualStack": false, + "Region": "ap-east-1", "UseFIPS": false, - "Region": "us-iso-west-1" + "UseDualStack": false } }, { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://swf-fips.us-iso-east-1.c2s.ic.gov" + "url": "https://swf.ap-northeast-1.amazonaws.com" } }, "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-iso-east-1" + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://swf.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false } }, { @@ -6093,87 +6101,87 @@ } }, "params": { - "UseDualStack": false, + "Region": "ap-northeast-3", "UseFIPS": false, - "Region": "ap-northeast-3" + "UseDualStack": false } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://swf.us-east-1.amazonaws.com" + "url": "https://swf.ap-south-1.amazonaws.com" } }, "params": { - "UseDualStack": false, + "Region": "ap-south-1", "UseFIPS": false, - "Region": "us-east-1" + "UseDualStack": false } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://swf-fips.us-east-1.amazonaws.com" + "url": "https://swf.ap-southeast-1.amazonaws.com" } }, "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-east-1" + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://swf.eu-west-1.amazonaws.com" + "url": "https://swf.ap-southeast-2.amazonaws.com" } }, "params": { - "UseDualStack": false, + "Region": "ap-southeast-2", "UseFIPS": false, - "Region": "eu-west-1" + "UseDualStack": false } }, { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://swf.eu-west-2.amazonaws.com" + "url": "https://swf.ap-southeast-3.amazonaws.com" } }, "params": { - "UseDualStack": false, + "Region": "ap-southeast-3", "UseFIPS": false, - "Region": "eu-west-2" + "UseDualStack": false } }, { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://swf.eu-west-3.amazonaws.com" + "url": "https://swf.ca-central-1.amazonaws.com" } }, "params": { - "UseDualStack": false, + "Region": "ca-central-1", "UseFIPS": false, - "Region": "eu-west-3" + "UseDualStack": false } }, { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://swf.me-south-1.amazonaws.com" + "url": "https://swf.eu-central-1.amazonaws.com" } }, "params": { - "UseDualStack": false, + "Region": "eu-central-1", "UseFIPS": false, - "Region": "me-south-1" + "UseDualStack": false } }, { @@ -6184,139 +6192,139 @@ } }, "params": { - "UseDualStack": false, + "Region": "eu-north-1", "UseFIPS": false, - "Region": "eu-north-1" + "UseDualStack": false } }, { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://swf.us-east-2.amazonaws.com" + "url": "https://swf.eu-south-1.amazonaws.com" } }, "params": { - "UseDualStack": false, + "Region": "eu-south-1", "UseFIPS": false, - "Region": "us-east-2" + "UseDualStack": false } }, { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://swf-fips.us-east-2.amazonaws.com" + "url": "https://swf.eu-west-1.amazonaws.com" } }, "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-east-2" + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://swf.sa-east-1.amazonaws.com" + "url": "https://swf.eu-west-2.amazonaws.com" } }, "params": { - "UseDualStack": false, + "Region": "eu-west-2", "UseFIPS": false, - "Region": "sa-east-1" + "UseDualStack": false } }, { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://swf.ap-east-1.amazonaws.com" + "url": "https://swf.eu-west-3.amazonaws.com" } }, "params": { - "UseDualStack": false, + "Region": "eu-west-3", "UseFIPS": false, - "Region": "ap-east-1" + "UseDualStack": false } }, { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://swf.eu-south-1.amazonaws.com" + "url": "https://swf.me-south-1.amazonaws.com" } }, "params": { - "UseDualStack": false, + "Region": "me-south-1", "UseFIPS": false, - "Region": "eu-south-1" + "UseDualStack": false } }, { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://swf.eu-central-1.amazonaws.com" + "url": "https://swf.sa-east-1.amazonaws.com" } }, "params": { - "UseDualStack": false, + "Region": "sa-east-1", "UseFIPS": false, - "Region": "eu-central-1" + "UseDualStack": false } }, { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://swf.ap-southeast-1.amazonaws.com" + "url": "https://swf.us-east-1.amazonaws.com" } }, "params": { - "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": false, - "Region": "ap-southeast-1" + "UseDualStack": false } }, { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://swf.ap-southeast-2.amazonaws.com" + "url": "https://swf-fips.us-east-1.amazonaws.com" } }, "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-southeast-2" + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://swf.ap-southeast-3.amazonaws.com" + "url": "https://swf.us-east-2.amazonaws.com" } }, "params": { - "UseDualStack": false, + "Region": "us-east-2", "UseFIPS": false, - "Region": "ap-southeast-3" + "UseDualStack": false } }, { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://swf.ca-central-1.amazonaws.com" + "url": "https://swf-fips.us-east-2.amazonaws.com" } }, "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "ca-central-1" + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false } }, { @@ -6327,9 +6335,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-west-1", "UseFIPS": false, - "Region": "us-west-1" + "UseDualStack": false } }, { @@ -6340,9 +6348,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-west-1", "UseFIPS": true, - "Region": "us-west-1" + "UseDualStack": false } }, { @@ -6353,9 +6361,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-west-2", "UseFIPS": false, - "Region": "us-west-2" + "UseDualStack": false } }, { @@ -6366,139 +6374,152 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-west-2", "UseFIPS": true, - "Region": "us-west-2" + "UseDualStack": false } }, { - "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://swf.af-south-1.amazonaws.com" + "url": "https://swf-fips.us-east-1.api.aws" } }, "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "af-south-1" + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://swf.ap-south-1.amazonaws.com" + "url": "https://swf.us-east-1.api.aws" } }, "params": { - "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": false, - "Region": "ap-south-1" + "UseDualStack": true } }, { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://swf.ap-northeast-1.amazonaws.com" + "url": "https://swf.cn-north-1.amazonaws.com.cn" } }, "params": { - "UseDualStack": false, + "Region": "cn-north-1", "UseFIPS": false, - "Region": "ap-northeast-1" + "UseDualStack": false } }, { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://swf.ap-northeast-2.amazonaws.com" + "url": "https://swf.cn-northwest-1.amazonaws.com.cn" } }, "params": { - "UseDualStack": false, + "Region": "cn-northwest-1", "UseFIPS": false, - "Region": "ap-northeast-2" + "UseDualStack": false } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://swf-fips.us-east-1.api.aws" + "url": "https://swf-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { - "UseDualStack": true, + "Region": "cn-north-1", "UseFIPS": true, - "Region": "us-east-1" + "UseDualStack": true } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://swf.us-east-1.api.aws" + "url": "https://swf-fips.cn-north-1.amazonaws.com.cn" } }, "params": { - "UseDualStack": true, + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://swf.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", "UseFIPS": false, - "Region": "us-east-1" + "UseDualStack": true } }, { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://swf.us-gov-west-1.amazonaws.com" + "url": "https://swf.us-gov-east-1.amazonaws.com" } }, "params": { - "UseDualStack": false, + "Region": "us-gov-east-1", "UseFIPS": false, - "Region": "us-gov-west-1" + "UseDualStack": false } }, { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://swf.us-gov-west-1.amazonaws.com" + "url": "https://swf.us-gov-east-1.amazonaws.com" } }, "params": { - "UseDualStack": false, + "Region": "us-gov-east-1", "UseFIPS": true, - "Region": "us-gov-west-1" + "UseDualStack": false } }, { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://swf.us-gov-east-1.amazonaws.com" + "url": "https://swf.us-gov-west-1.amazonaws.com" } }, "params": { - "UseDualStack": false, + "Region": "us-gov-west-1", "UseFIPS": false, - "Region": "us-gov-east-1" + "UseDualStack": false } }, { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://swf.us-gov-east-1.amazonaws.com" + "url": "https://swf.us-gov-west-1.amazonaws.com" } }, "params": { - "UseDualStack": false, + "Region": "us-gov-west-1", "UseFIPS": true, - "Region": "us-gov-east-1" + "UseDualStack": false } }, { @@ -6509,9 +6530,9 @@ } }, "params": { - "UseDualStack": true, + "Region": "us-gov-east-1", "UseFIPS": true, - "Region": "us-gov-east-1" + "UseDualStack": true } }, { @@ -6522,113 +6543,144 @@ } }, "params": { - "UseDualStack": true, + "Region": "us-gov-east-1", "UseFIPS": false, - "Region": "us-gov-east-1" + "UseDualStack": true } }, { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://swf.us-isob-east-1.sc2s.sgov.gov" + "url": "https://swf.us-iso-east-1.c2s.ic.gov" } }, "params": { - "UseDualStack": false, + "Region": "us-iso-east-1", "UseFIPS": false, - "Region": "us-isob-east-1" + "UseDualStack": false } }, { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://swf-fips.us-isob-east-1.sc2s.sgov.gov" + "url": "https://swf.us-iso-west-1.c2s.ic.gov" } }, "params": { - "UseDualStack": false, + "Region": "us-iso-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", "UseFIPS": true, - "Region": "us-isob-east-1" + "UseDualStack": true } }, { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://swf.cn-northwest-1.amazonaws.com.cn" + "url": "https://swf-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { - "UseDualStack": false, + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", "UseFIPS": false, - "Region": "cn-northwest-1" + "UseDualStack": true } }, { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://swf.cn-north-1.amazonaws.com.cn" + "url": "https://swf.us-isob-east-1.sc2s.sgov.gov" } }, "params": { - "UseDualStack": false, + "Region": "us-isob-east-1", "UseFIPS": false, - "Region": "cn-north-1" + "UseDualStack": false } }, { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", "expect": { - "endpoint": { - "url": "https://swf-fips.cn-north-1.api.amazonwebservices.com.cn" - } + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, + "Region": "us-isob-east-1", "UseFIPS": true, - "Region": "cn-north-1" + "UseDualStack": true } }, { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://swf-fips.cn-north-1.amazonaws.com.cn" + "url": "https://swf-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { - "UseDualStack": false, + "Region": "us-isob-east-1", "UseFIPS": true, - "Region": "cn-north-1" + "UseDualStack": false } }, { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { - "url": "https://swf.cn-north-1.api.amazonwebservices.com.cn" + "url": "https://example.com" } }, "params": { - "UseDualStack": true, + "Region": "us-east-1", "UseFIPS": false, - "Region": "cn-north-1" + "UseDualStack": false, + "Endpoint": "https://example.com" } }, { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -6638,9 +6690,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseDualStack": false, - "UseFIPS": true, "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -6650,17 +6702,29 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseDualStack": true, - "UseFIPS": false, "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, "Endpoint": "https://example.com" } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } ], "version": "1.0" } } }, + "com.amazonaws.swf#StartAtPreviousStartedEvent": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, "com.amazonaws.swf#StartChildWorkflowExecutionDecisionAttributes": { "type": "structure", "members": { @@ -6674,7 +6738,7 @@ "workflowId": { "target": "com.amazonaws.swf#WorkflowId", "traits": { - "smithy.api#documentation": "\n The workflowId of the workflow execution.
The specified string must not start or end with whitespace. It must not contain a :\n (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not contain the literal string arn.
\n The workflowId of the workflow execution.
The specified string must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.
The name of the task list to be used for decision tasks of the child workflow execution.
\nA 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.
\nThe specified string must not start or end with whitespace. It must not contain a :\n (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not contain the literal string arn.
The name of the task list to be used for decision tasks of the child workflow execution.
\nA 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.
\nThe specified string must not start or end with whitespace. It must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.
Provides the details of the StartChildWorkflowExecution decision.
\n Access Control\n
\nYou can use IAM policies to control this decision's access to Amazon SWF resources as follows:
\nUse a Resource element with the domain name to limit the action to only\n specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the\n appropriate keys.
\n tagList.member.N – The key is \"swf:tagList.N\" where N is the tag number from 0 to 4,\n inclusive.
\n taskList – String constraint. The key is swf:taskList.name.
\n workflowType.name – String constraint. The key is swf:workflowType.name.
\n workflowType.version – String constraint. The key is swf:workflowType.version.
If the caller doesn't have sufficient permissions to invoke the action, or the\n parameter values fall outside the specified constraints, the action fails. The associated event attribute's\n cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see\n Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Provides the details of the StartChildWorkflowExecution decision.
\n Access Control\n
\nYou can use IAM policies to control this decision's access to Amazon SWF resources as follows:
\nUse a Resource element with the domain name to limit the action to only\n specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the\n appropriate keys.
\n tagList.member.N – The key is \"swf:tagList.N\" where N is the tag number from 0 to 4,\n inclusive.
\n taskList – String constraint. The key is swf:taskList.name.
\n workflowType.name – String constraint. The key is swf:workflowType.name.
\n workflowType.version – String constraint. The key is swf:workflowType.version.
If the caller doesn't have sufficient permissions to invoke the action, or the\n parameter values fall outside the specified constraints, the action fails. The associated event attribute's\n cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see\n Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
The workflow type provided in the StartChildWorkflowExecution \n Decision that failed.
The workflow type provided in the StartChildWorkflowExecution\n Decision that failed.
When the cause is WORKFLOW_ALREADY_RUNNING, initiatedEventId is the ID of the StartChildWorkflowExecutionInitiated\n event that corresponds to the StartChildWorkflowExecution \n Decision to start the workflow execution. You can use this information to diagnose\n 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 \n StartChildWorkflowExecutionInitiated event doesn't exist.
When the cause is WORKFLOW_ALREADY_RUNNING, initiatedEventId is the ID of the StartChildWorkflowExecutionInitiated\n event that corresponds to the StartChildWorkflowExecution\n Decision to start the workflow execution. You can use this information to diagnose\n 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 \n StartChildWorkflowExecutionInitiated event doesn't exist.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution \n Decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution\n Decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the\n StartChildWorkflowExecution \n Decision to request this child workflow execution. This\n information can be useful for diagnosing problems by tracing back the cause of events.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the\n StartChildWorkflowExecution\n Decision to request this child workflow execution. This\n information can be useful for diagnosing problems by tracing back the cause of events.
\n The unique ID of the timer.
\nThe specified string must not start or end with whitespace. It must not contain a :\n (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not contain the literal string arn.
\n The unique ID of the timer.
\nThe specified string must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.
Starts an execution of the workflow type in the specified domain using the provided\n workflowId and input data.
This action returns the newly started workflow execution.
\n\n\n Access Control\n
\nYou can use IAM policies to control this action's access to Amazon SWF resources as\n follows:
\nUse a Resource element with the domain name to limit the action to\n only specified domains.
Use an Action element to allow or deny permission to call this\n action.
Constrain the following parameters by using a Condition element with\n the appropriate keys.
\n tagList.member.0: The key is swf:tagList.member.0.
\n tagList.member.1: The key is swf:tagList.member.1.
\n tagList.member.2: The key is swf:tagList.member.2.
\n tagList.member.3: The key is swf:tagList.member.3.
\n tagList.member.4: The key is swf:tagList.member.4.
\n taskList: String constraint. The key is\n swf:taskList.name.
\n workflowType.name: String constraint. The key is\n swf:workflowType.name.
\n workflowType.version: String constraint. The key is\n swf:workflowType.version.
If the caller doesn't have sufficient permissions to invoke the action, or the\n parameter values fall outside the specified constraints, the action fails. The associated\n event attribute's cause parameter is set to OPERATION_NOT_PERMITTED.\n For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF\n Workflows in the Amazon SWF Developer Guide.
Starts an execution of the workflow type in the specified domain using the provided\n workflowId and input data.
This action returns the newly started workflow execution.
\n\n Access Control\n
\nYou can use IAM policies to control this action's access to Amazon SWF resources as\n follows:
\nUse a Resource element with the domain name to limit the action to\n only specified domains.
Use an Action element to allow or deny permission to call this\n action.
Constrain the following parameters by using a Condition element with\n the appropriate keys.
\n tagList.member.0: The key is swf:tagList.member.0.
\n tagList.member.1: The key is swf:tagList.member.1.
\n tagList.member.2: The key is swf:tagList.member.2.
\n tagList.member.3: The key is swf:tagList.member.3.
\n tagList.member.4: The key is swf:tagList.member.4.
\n taskList: String constraint. The key is\n swf:taskList.name.
\n workflowType.name: String constraint. The key is\n swf:workflowType.name.
\n workflowType.version: String constraint. The key is\n swf:workflowType.version.
If the caller doesn't have sufficient permissions to invoke the action, or the\n parameter values fall outside the specified constraints, the action fails. The associated\n event attribute's cause parameter is set to OPERATION_NOT_PERMITTED.\n For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF\n Workflows in the Amazon SWF Developer Guide.
The name of the domain in which the workflow execution is created.
", + "smithy.api#documentation": "The name of the domain in which the workflow execution is created.
\nThe specified string must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.
The user defined identifier associated with the workflow execution. You can use this to\n associate a custom identifier with the workflow execution. You may specify the same identifier\n if a workflow execution is logically a restart of a previous execution.\n You cannot have two open workflow executions with the same workflowId at the same\n time within the same domain.
The specified string must not start or end with whitespace. It must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.
The user defined identifier associated with the workflow execution. You can use this to\n associate a custom identifier with the workflow execution. You may specify the same identifier\n if a workflow execution is logically a restart of a previous execution.\n You cannot have two open workflow executions with the same workflowId at the same\n time within the same domain.
The specified string must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.
The task list to use for the decision tasks generated for this workflow execution. This\n overrides the defaultTaskList specified when registering the workflow\n type.
A task list for this workflow execution must be specified either as a default for the\n workflow type or through this parameter. If neither this parameter is set nor a default task\n list was specified at registration time then a fault is returned.
\nThe specified string must not start or end with whitespace. It must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.
The task list to use for the decision tasks generated for this workflow execution. This\n overrides the defaultTaskList specified when registering the workflow\n type.
A task list for this workflow execution must be specified either as a default for the\n workflow type or through this parameter. If neither this parameter is set nor a default task\n list was specified at registration time then a fault is returned.
\nThe specified string must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.
The total duration for this workflow execution. This overrides the\n defaultExecutionStartToCloseTimeout specified when registering the workflow type.
\n\nThe duration is specified in seconds; an integer greater than or equal to\n 0. Exceeding this limit causes the workflow execution to time out. Unlike some\n of the other timeout parameters in Amazon SWF, you cannot specify a value of \"NONE\" for this\n timeout; there is a one-year max limit on the time that a workflow execution can\n run.
An execution start-to-close timeout must be specified either through this parameter\n or as a default when the workflow type is registered. If neither this parameter nor a\n default execution start-to-close timeout is specified, a fault is returned.
\nThe total duration for this workflow execution. This overrides the\n defaultExecutionStartToCloseTimeout specified when registering the workflow type.
\nThe duration is specified in seconds; an integer greater than or equal to\n 0. Exceeding this limit causes the workflow execution to time out. Unlike some\n of the other timeout parameters in Amazon SWF, you cannot specify a value of \"NONE\" for this\n timeout; there is a one-year max limit on the time that a workflow execution can\n run.
An execution start-to-close timeout must be specified either through this parameter\n or as a default when the workflow type is registered. If neither this parameter nor a\n default execution start-to-close timeout is specified, a fault is returned.
\nThe list of tags to add to a domain.
\nTags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.
The list of tags to add to a domain.
\nTags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.
Records a WorkflowExecutionTerminated event and forces closure of the\n workflow execution identified by the given domain, runId, and workflowId. The child policy,\n registered with the workflow type or specified when starting this execution, is applied to any\n open child workflow executions of this workflow execution.
If the identified workflow execution was in progress, it is terminated\n immediately.
\nIf a runId isn't specified, then the WorkflowExecutionTerminated event\n is recorded in the history of the current open workflow with the matching workflowId in the\n domain.
You should consider using RequestCancelWorkflowExecution action\n instead because it allows the workflow to gracefully close while TerminateWorkflowExecution doesn't.
\n\n Access Control\n
\nYou can use IAM policies to control this action's access to Amazon SWF resources as\n follows:
\nUse a Resource element with the domain name to limit the action to\n only specified domains.
Use an Action element to allow or deny permission to call this\n action.
You cannot use an IAM policy to constrain this action's parameters.
\nIf the caller doesn't have sufficient permissions to invoke the action, or the\n parameter values fall outside the specified constraints, the action fails. The associated\n event attribute's cause parameter is set to OPERATION_NOT_PERMITTED.\n For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF\n Workflows in the Amazon SWF Developer Guide.
Records a WorkflowExecutionTerminated event and forces closure of the\n workflow execution identified by the given domain, runId, and workflowId. The child policy,\n registered with the workflow type or specified when starting this execution, is applied to any\n open child workflow executions of this workflow execution.
If the identified workflow execution was in progress, it is terminated\n immediately.
\nIf a runId isn't specified, then the WorkflowExecutionTerminated event\n is recorded in the history of the current open workflow with the matching workflowId in the\n domain.
You should consider using RequestCancelWorkflowExecution action\n instead because it allows the workflow to gracefully close while TerminateWorkflowExecution doesn't.
\n\n Access Control\n
\nYou can use IAM policies to control this action's access to Amazon SWF resources as\n follows:
\nUse a Resource element with the domain name to limit the action to\n only specified domains.
Use an Action element to allow or deny permission to call this\n action.
You cannot use an IAM policy to constrain this action's parameters.
\nIf the caller doesn't have sufficient permissions to invoke the action, or the\n parameter values fall outside the specified constraints, the action fails. The associated\n event attribute's cause parameter is set to OPERATION_NOT_PERMITTED.\n For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF\n Workflows in the Amazon SWF Developer Guide.
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution \n Decision to start this workflow execution. The source event with\n 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\n events leading up to this event.
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution\n Decision to start this workflow execution. The source event with\n 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\n events leading up to this event.
\n The default maximum duration, specified when registering the workflow type, that a decision task\n for executions of this workflow type might take before returning completion or failure. If the task doesn'tdo close\n in the specified time then the task is automatically timed out and rescheduled. If the decider eventually reports\n a completion or failure, it is ignored. This default can be overridden when starting a workflow execution using\n the StartWorkflowExecution action or the StartChildWorkflowExecution \n Decision.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
\n The default maximum duration, specified when registering the workflow type, that a decision task\n for executions of this workflow type might take before returning completion or failure. If the task doesn'tdo close\n in the specified time then the task is automatically timed out and rescheduled. If the decider eventually reports\n a completion or failure, it is ignored. This default can be overridden when starting a workflow execution using\n the StartWorkflowExecution action or the StartChildWorkflowExecution\n Decision.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
\n The default maximum duration, specified when registering the workflow type, for executions of\n this workflow type. This default can be overridden when starting a workflow execution using the\n StartWorkflowExecution action or the StartChildWorkflowExecution \n Decision.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
\n The default maximum duration, specified when registering the workflow type, for executions of\n this workflow type. This default can be overridden when starting a workflow execution using the\n StartWorkflowExecution action or the StartChildWorkflowExecution\n Decision.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
\n The default policy to use for the child workflow executions when a workflow execution of this\n type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired\n timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution\n action or the StartChildWorkflowExecution \n Decision.
The supported child policies are:
\n\n TERMINATE – The child executions are terminated.
\n REQUEST_CANCEL – A request to cancel is attempted for each child\n execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider\n to take appropriate actions when it receives an execution history with this event.
\n ABANDON – No action is taken. The child executions continue to run.
\n The default policy to use for the child workflow executions when a workflow execution of this\n type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired\n timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution\n action or the StartChildWorkflowExecution\n Decision.
The supported child policies are:
\n\n TERMINATE – The child executions are terminated.
\n REQUEST_CANCEL – A request to cancel is attempted for each child\n execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider\n to take appropriate actions when it receives an execution history with this event.
\n ABANDON – No action is taken. The child executions continue to run.