ContinueAsNewWorkflowExecutionDecisionAttributes

Provides the details of the ContinueAsNewWorkflowExecution decision.

Access Control

You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

AutomationTask CoordinationWorkflow

Properties

Name Type Description
input object
executionStartToCloseTimeout object
taskList object
taskPriority object
taskStartToCloseTimeout object
childPolicy object
tagList object
workflowTypeVersion object
lambdaRole object
View JSON Schema on GitHub

JSON Schema

amazon-swf-continueasnewworkflowexecutiondecisionattributes-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "input": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Data"
        },
        {
          "description": "The input provided to the new workflow execution."
        }
      ]
    },
    "executionStartToCloseTimeout": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DurationInSecondsOptional"
        },
        {
          "description": "<p>If set, specifies the total duration for this workflow execution. This overrides the <code>defaultExecutionStartToCloseTimeout</code> specified when registering the workflow type.</p> <p>The duration is specified in seconds, an integer greater than or equal to <code>0</code>. You can use <code>NONE</code> to specify unlimited duration.</p> <note> <p>An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this field. If neither this field is set nor a default execution start-to-close timeout was specified at registration time then a fault is returned.</p> </note>"
        }
      ]
    },
    "taskList": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TaskList"
        },
        {
          "description": "The task list to use for the decisions of the new (continued) workflow execution."
        }
      ]
    },
    "taskPriority": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TaskPriority"
        },
        {
          "description": "<p> The task priority that, if set, specifies the priority for the decision tasks for this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that range from Java's <code>Integer.MIN_VALUE</code> (-2147483648) to <code>Integer.MAX_VALUE</code> (2147483647). Higher numbers indicate higher priority.</p> <p>For more information about setting task priority, see <a href=\"https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html\">Setting Task Priority</a> in the <i>Amazon SWF Developer Guide</i>.</p>"
        }
      ]
    },
    "taskStartToCloseTimeout": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DurationInSecondsOptional"
        },
        {
          "description": "<p>Specifies the maximum duration of decision tasks for the new workflow execution. This parameter overrides the <code>defaultTaskStartToCloseTimout</code> specified when registering the workflow type using <a>RegisterWorkflowType</a>.</p> <p>The duration is specified in seconds, an integer greater than or equal to <code>0</code>. You can use <code>NONE</code> to specify unlimited duration.</p> <note> <p>A task start-to-close timeout for the new workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.</p> </note>"
        }
      ]
    },
    "childPolicy": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ChildPolicy"
        },
        {
          "description": "<p>If set, specifies the policy to use for the child workflow executions of the new execution if it is terminated by calling the <a>TerminateWorkflowExecution</a> action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using <a>RegisterWorkflowType</a>.</p> <p>The supported child policies are:</p> <ul> <li> <p> <code>TERMINATE</code> \u2013 The child executions are terminated.</p> </li> <li> <p> <code>REQUEST_CANCEL</code> \u2013 A request to cancel is attempted for each child execution by recording a <code>WorkflowExecutionCancelRequested</code> event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.</p> </li> <li> <p> <code>ABANDON</code> \u2013 No action is taken. The child executions continue to run.</p> </li> </ul> <note> <p>A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.</p> </note>"
        }
      ]
    },
    "tagList": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TagList"
        },
        {
          "description": "The list of tags to associate with the new workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling <a>ListOpenWorkflowExecutions</a> or <a>ListClosedWorkflowExecutions</a> and specifying a <a>TagFilter</a>."
        }
      ]
    },
    "workflowTypeVersion": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Version"
        },
        {
          "description": "The version of the workflow to start."
        }
      ]
    },
    "lambdaRole": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Arn"
        },
        {
          "description": "The IAM role to attach to the new (continued) execution."
        }
      ]
    }
  },
  "description": "<p>Provides the details of the <code>ContinueAsNewWorkflowExecution</code> decision.</p> <p> <b>Access Control</b> </p> <p>You can use IAM policies to control this decision's access to Amazon SWF resources as follows:</p> <ul> <li> <p>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</p> </li> <li> <p>Use an <code>Action</code> element to allow or deny permission to call this action.</p> </li> <li> <p>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys.</p> <ul> <li> <p> <code>tag</code> \u2013 A tag used to identify the workflow execution</p> </li> <li> <p> <code>taskList</code> \u2013 String constraint. The key is <code>swf:taskList.name</code>.</p> </li> <li> <p> <code>workflowType.version</code> \u2013 String constraint. The key is <code>swf:workflowType.version</code>.</p> </li> </ul> </li> </ul> <p>If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>. For details and example IAM policies, see <a href=\"https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ContinueAsNewWorkflowExecutionDecisionAttributes"
}