The AWS IoT RoboRunner API contains several data types that various actions use. This section describes each data type in detail.
Note
The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.
The following data types are supported:
• Action (p. 157)
• ActionDependency (p. 160)
• ActionTemplate (p. 161)
• ActionTemplateDependency (p. 163)
• Activity (p. 164)
• ActivityDependency (p. 167)
• Destination (p. 168)
• DestinationRelationship (p. 170)
• Location (p. 172)
• Site (p. 173)
• Task (p. 175)
• TaskDependency (p. 178)
• Worker (p. 179)
• WorkerFleet (p. 181)
Action
Action
An action to be completed by a worker.
Contents
activity
Activity ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:task/[\w-]+/activity/.*
Required: Yes arn
Action ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:task/[\w-]+/activity/[\w-]+/
action/.*
Required: Yes createdAt
Timestamp at which the resource was created.
Type: Timestamp Required: Yes dependencies
List of action dependencies.
Type: Array of ActionDependency (p. 160) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: No id
Action ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes name
The name of the action as provided by its action template.
Type: String
See Also
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes payload
JSON document describing an action achievable by a worker.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 131072.
Required: Yes state
An action's state.
Type: String
Valid Values: NEW | PLANNING | ALLOCATION | DISPATCHING | ACTIVE | SUCCEEDED | FAILED | CANCELLED | REJECTED
Required: Yes substate
An action's substate.
Type: String
Valid Values: PROCESSING | COMPLETE Required: No
updatedAt
Timestamp at which the resource was last updated.
Type: Timestamp Required: Yes worker
Worker ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:worker/.*
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
See Also
ActionDependency
ActionDependency
A dependency assigned to an action.
Contents
target
Action ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:task/[\w-]+/activity/[\w-]+/
action/.*
Required: Yes type
Type of dependency between two actions.
Type: String
Valid Values: MUST_ATTEMPT_BEFORE | MUST_SUCCEED_BEFORE Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ActionTemplate
ActionTemplate
A template containing a JSON payload. This payload describes an action achievable by a worker.
Contents
arn
Action template ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:task/[\w-]+/action-template/.*
Required: Yes createdAt
Timestamp at which the resource was created.
Type: Timestamp Required: Yes dependencies
List of action template dependencies.
Type: Array of ActionTemplateDependency (p. 163) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: No id
Action template ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes name
The name of the action created from the template.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes payload
JSON document describing an action achievable by a worker.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 131072.
See Also
Required: Yes site
Facility ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:site/.*
Required: Yes task
Task ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:task/.*
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ActionTemplateDependency
ActionTemplateDependency
A dependency to be assigned to an action template.
Contents
target
Action template ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:task/[\w-]+/action-template/.*
Required: Yes type
Type of dependency between two action templates.
Type: String
Valid Values: MUST_ATTEMPT_BEFORE | MUST_SUCCEED_BEFORE Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Activity
Activity
An activity which can be performed by a worker. Activities can be processed into a collection of actions.
Contents
arn
Activity ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:task/[\w-]+/activity/.*
Required: Yes createdAt
Timestamp at which the resource was created.
Type: Timestamp Required: Yes dependencies
List of activity dependencies.
Type: Array of ActivityDependency (p. 167) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: No externalId
ID used by an external system for the activity.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 140.
Required: No id
Activity ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes payload
JSON document describing the activity.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 131072.
See Also
Required: Yes site
Facility ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:site/.*
Required: Yes state
Activity state.
Type: String
Valid Values: NEW | PLANNING | ALLOCATING | DISPATCHING | ACTIVE | SUCCEEDED | FAILED | CANCELLED | REJECTED
Required: Yes substate
Activity substate.
Type: String
Valid Values: PROCESSING | COMPLETE Required: No
task
Task ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:task/.*
Required: Yes updatedAt
Timestamp at which the resource was last updated.
Type: Timestamp Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
See Also
ActivityDependency
ActivityDependency
A dependency to be assigned to an activity.
Contents
target
Activity ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:task/[\w-]+/activity/.*
Required: Yes type
A dependency relationship between two activities.
Type: String
Valid Values: MUST_ATTEMPT_BEFORE | MUST_SUCCEED_BEFORE Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Destination
Destination
Area within a facility where work can be performed.
Contents
additionalInformation
JSON document containing additional metadata about the destination.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 131072.
Required: No arn
Destination ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:destination/.*
Required: Yes createdAt
Timestamp at which the resource was created.
Type: Timestamp Required: Yes id
Destination ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes location
Location in 3D space relative to the origin of the facility.
Type: Location (p. 172) object Required: No
name
Human friendly name of the resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
See Also
site
Facility ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:site/.*
Required: Yes state
State of the destination.
Type: String
Valid Values: ENABLED | DISABLED | DECOMMISSIONED Required: Yes
updatedAt
Timestamp at which the resource was last updated.
Type: Timestamp Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DestinationRelationship
DestinationRelationship
A relationship between two destinations.
Contents
arn
Destination relationship ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:destination-relationship/.*
Required: Yes createdAt
Timestamp at which the resource was created.
Type: Timestamp Required: Yes id
Filters access by the destination relationship's identifier Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes relationshipType
Type of relationship between two destinations.
Type: String
Valid Values: TRAVERSAL | COMPOSITION Required: Yes
site
Facility ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:site/.*
Required: Yes sourceDestination
Destination ARN.
Type: String
See Also
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:destination/.*
Required: Yes targetDestination
Destination ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:destination/.*
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Location
Location
Location in 3D space relative to the origin of the facility.
Contents
x
X coordinate in meters.
Type: Double Required: Yes y
Y coordinate in meters.
Type: Double Required: Yes z
Z coordinate in meters.
Type: Double Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Site
Site
Facility containing destinations, workers, activities, and tasks.
Contents
arn
Facility ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:site/.*
Required: Yes countryCode
A valid ISO 3166-1 alpha-2 code for the country in which the facility resides. e.g., US.
Type: String
Length Constraints: Fixed length of 2.
Pattern: [a-zA-Z]{2}
Required: Yes createdAt
Timestamp at which the resource was created.
Type: Timestamp Required: Yes description
High-level description of the facility.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 140.
Required: No id
Facility ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes name
The name of the facility. Mutable after creation.
Type: String
See Also
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes updatedAt
Timestamp at which the resource was last updated.
Type: Timestamp Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Task
Task
A high-level description of a piece of work to be performed. Tasks are broken down into activities, which are broken down into actions.
Contents
arn
Task ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:task/.*
Required: Yes createdAt
Timestamp at which the resource was created.
Type: Timestamp Required: Yes dependencies
List of task dependencies.
Type: Array of TaskDependency (p. 178) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: No fleet
The fleet that the task belongs to. Immutable after task creation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:worker-fleet/.*
Required: No id
Task ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes parentTask
The parent of the task. Immutable after task creation.
Type: String
See Also
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:task/.*
Required: No payload
JSON document describing a task.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 131072.
Required: Yes site
Facility ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:site/.*
Required: Yes state
Task state.
Type: String
Valid Values: NEW | PLANNING | ALLOCATING | DISPATCHING | ACTIVE | SUCCEEDED | FAILED | CANCELLED | REJECTED
Required: Yes substate
Task substate.
Type: String
Valid Values: PROCESSING | COMPLETE Required: No
updatedAt
Timestamp at which the resource was last updated.
Type: Timestamp Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
See Also
• AWS SDK for Java V2
• AWS SDK for Ruby V3
TaskDependency
TaskDependency
Dependency to be assigned to a task.
Contents
target Task ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:task/.*
Required: Yes type
Type of dependency between two tasks.
Type: String
Valid Values: MUST_ATTEMPT_BEFORE | MUST_SUCCEED_BEFORE Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Worker
Worker
A unit capable of performing tasks.
Contents
additionalInformation
JSON blob containing additional unstructured worker information.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 131072.
Required: No arn
Worker ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:worker/.*
Required: Yes createdAt
Timestamp at which the resource was created.
Type: Timestamp Required: Yes fleet
Worker fleet ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:worker-fleet/.*
Required: Yes id
Worker ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes name
Human friendly name of the resource.
Type: String
See Also
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes site
Facility ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:site/.*
Required: Yes state
Worker state.
Type: String
Valid Values: ENABLED | DISABLED | BUSY | DECOMMISSIONED Required: Yes
status
JSON blob containing unstructured worker status information.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 131072.
Required: No updatedAt
Timestamp at which the resource was last updated.
Type: Timestamp Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
WorkerFleet
WorkerFleet
A collection of workers organized within a facility.
Contents
arn
Worker fleet ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:worker-fleet/.*
Required: Yes createdAt
Timestamp at which the resource was created.
Type: Timestamp Required: Yes id
Worker fleet ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes name
Human friendly name of the resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes site
Facility ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:site/.*
Required: Yes updatedAt
Timestamp at which the resource was last updated.
Type: Timestamp
See Also
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3