ActivityTypeConfiguration

Configuration settings registered with the activity type.

AutomationTask CoordinationWorkflow

Properties

Name Type Description
defaultTaskStartToCloseTimeout object
defaultTaskHeartbeatTimeout object
defaultTaskList object
defaultTaskPriority object
defaultTaskScheduleToStartTimeout object
defaultTaskScheduleToCloseTimeout object
View JSON Schema on GitHub

JSON Schema

amazon-swf-activitytypeconfiguration-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "defaultTaskStartToCloseTimeout": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DurationInSecondsOptional"
        },
        {
          "description": "<p> The default maximum duration for tasks of an activity type specified when registering the activity type. You can override this default when scheduling a task through the <code>ScheduleActivityTask</code> <a>Decision</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>"
        }
      ]
    },
    "defaultTaskHeartbeatTimeout": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DurationInSecondsOptional"
        },
        {
          "description": "<p> The default maximum time, in seconds, before which a worker processing a task must report progress by calling <a>RecordActivityTaskHeartbeat</a>.</p> <p>You can specify this value only when <i>registering</i> an activity type. The registered default value can be overridden when you schedule a task through the <code>ScheduleActivityTask</code> <a>Decision</a>. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an <code>UnknownResource</code> fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.</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>"
        }
      ]
    },
    "defaultTaskList": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TaskList"
        },
        {
          "description": " The default task list specified for this activity type at registration. This default is used if a task list isn't provided when a task is scheduled through the <code>ScheduleActivityTask</code> <a>Decision</a>. You can override the default registered task list when scheduling a task through the <code>ScheduleActivityTask</code> <a>Decision</a>."
        }
      ]
    },
    "defaultTaskPriority": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TaskPriority"
        },
        {
          "description": "<p> The default task priority for tasks of this activity type, specified at registration. If not set, then <code>0</code> is used as the default priority. This default can be overridden when scheduling an activity task.</p> <p>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>"
        }
      ]
    },
    "defaultTaskScheduleToStartTimeout": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DurationInSecondsOptional"
        },
        {
          "description": "<p> The default maximum duration, specified when registering the activity type, that a task of an activity type can wait before being assigned to a worker. You can override this default when scheduling a task through the <code>ScheduleActivityTask</code> <a>Decision</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>"
        }
      ]
    },
    "defaultTaskScheduleToCloseTimeout": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DurationInSecondsOptional"
        },
        {
          "description": "<p> The default maximum duration, specified when registering the activity type, for tasks of this activity type. You can override this default when scheduling a task through the <code>ScheduleActivityTask</code> <a>Decision</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>"
        }
      ]
    }
  },
  "description": "Configuration settings registered with the activity type.",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ActivityTypeConfiguration"
}