Amazon Simple Workflow Service · Schema
RegisterActivityTypeInput
AutomationTask CoordinationWorkflow
Properties
| Name | Type | Description |
|---|---|---|
| domain | object | |
| name | object | |
| version | object | |
| description | object | |
| defaultTaskStartToCloseTimeout | object | |
| defaultTaskHeartbeatTimeout | object | |
| defaultTaskList | object | |
| defaultTaskPriority | object | |
| defaultTaskScheduleToStartTimeout | object | |
| defaultTaskScheduleToCloseTimeout | object |
JSON Schema
{
"type": "object",
"required": [
"domain",
"name",
"version"
],
"title": "RegisterActivityTypeInput",
"properties": {
"domain": {
"allOf": [
{
"$ref": "#/components/schemas/DomainName"
},
{
"description": "The name of the domain in which this activity is to be registered."
}
]
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/Name"
},
{
"description": "<p>The name of the activity type within the domain.</p> <p>The specified string must not contain a <code>:</code> (colon), <code>/</code> (slash), <code>|</code> (vertical bar), or any control characters (<code>\\u0000-\\u001f</code> | <code>\\u007f-\\u009f</code>). Also, it must <i>not</i> be the literal string <code>arn</code>.</p>"
}
]
},
"version": {
"allOf": [
{
"$ref": "#/components/schemas/Version"
},
{
"description": "<p>The version of the activity type.</p> <note> <p>The activity type consists of the name and version, the combination of which must be unique within the domain.</p> </note> <p>The specified string must not contain a <code>:</code> (colon), <code>/</code> (slash), <code>|</code> (vertical bar), or any control characters (<code>\\u0000-\\u001f</code> | <code>\\u007f-\\u009f</code>). Also, it must <i>not</i> be the literal string <code>arn</code>.</p>"
}
]
},
"description": {
"allOf": [
{
"$ref": "#/components/schemas/Description"
},
{
"description": "A textual description of the activity type."
}
]
},
"defaultTaskStartToCloseTimeout": {
"allOf": [
{
"$ref": "#/components/schemas/DurationInSecondsOptional"
},
{
"description": "<p>If set, specifies the default maximum duration that a worker can take to process tasks of this activity type. This default can be overridden when scheduling an activity task using the <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>If set, specifies the default maximum time before which a worker processing a task of this type must report progress by calling <a>RecordActivityTaskHeartbeat</a>. If the timeout is exceeded, the activity task is automatically timed out. This default can be overridden when scheduling an activity task using 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": "If set, specifies the default task list to use for scheduling tasks of this activity type. This default task list is used if a task list isn't provided when a task is scheduled through the <code>ScheduleActivityTask</code> <a>Decision</a>."
}
]
},
"defaultTaskPriority": {
"allOf": [
{
"$ref": "#/components/schemas/TaskPriority"
},
{
"description": "<p>The default task priority to assign to the activity type. If not assigned, then <code>0</code> is used. 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>in the <i>Amazon SWF Developer Guide</i>.</i>.</p>"
}
]
},
"defaultTaskScheduleToStartTimeout": {
"allOf": [
{
"$ref": "#/components/schemas/DurationInSecondsOptional"
},
{
"description": "<p>If set, specifies the default maximum duration that a task of this activity type can wait before being assigned to a worker. This default can be overridden when scheduling an activity task using the <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>If set, specifies the default maximum duration for a task of this activity type. This default can be overridden when scheduling an activity task using the <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>"
}
]
}
},
"$schema": "http://json-schema.org/draft-07/schema#"
}