AWS IoT RoboRunner
API Reference
API Version 2018-05-10
AWS IoT RoboRunner: API Reference
Copyright © Amazon Web Services, Inc. and/or its affiliates. All rights reserved.
Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon.
Table of Contents
Welcome ... 1
Actions ... 2
CreateAction ... 4
Request Syntax ... 4
URI Request Parameters ... 4
Request Body ... 4
Response Syntax ... 5
Response Elements ... 6
Errors ... 7
See Also ... 7
CreateActionTemplate ... 9
Request Syntax ... 9
URI Request Parameters ... 9
Request Body ... 9
Response Syntax ... 10
Response Elements ... 10
Errors ... 11
See Also ... 11
CreateActionTemplateDependency ... 13
Request Syntax ... 13
URI Request Parameters ... 13
Request Body ... 13
Response Syntax ... 14
Response Elements ... 14
Errors ... 14
See Also ... 14
CreateActivity ... 16
Request Syntax ... 16
URI Request Parameters ... 16
Request Body ... 16
Response Syntax ... 18
Response Elements ... 18
Errors ... 19
See Also ... 19
CreateActivityDependency ... 21
Request Syntax ... 21
URI Request Parameters ... 21
Request Body ... 21
Response Syntax ... 22
Response Elements ... 22
Errors ... 22
See Also ... 22
CreateDestination ... 24
Request Syntax ... 24
URI Request Parameters ... 24
Request Body ... 24
Response Syntax ... 25
Response Elements ... 25
Errors ... 26
See Also ... 27
CreateDestinationRelationship ... 28
Request Syntax ... 28
URI Request Parameters ... 28
Request Body ... 28
Response Syntax ... 29
Response Elements ... 29
Errors ... 30
See Also ... 30
CreateSite ... 32
Request Syntax ... 32
URI Request Parameters ... 32
Request Body ... 32
Response Syntax ... 33
Response Elements ... 33
Errors ... 33
See Also ... 34
CreateTask ... 35
Request Syntax ... 35
URI Request Parameters ... 35
Request Body ... 35
Response Syntax ... 36
Response Elements ... 37
Errors ... 37
See Also ... 38
CreateTaskDependency ... 39
Request Syntax ... 39
URI Request Parameters ... 39
Request Body ... 39
Response Syntax ... 40
Response Elements ... 40
Errors ... 40
See Also ... 40
CreateWorker ... 42
Request Syntax ... 42
URI Request Parameters ... 42
Request Body ... 42
Response Syntax ... 43
Response Elements ... 43
Errors ... 44
See Also ... 45
CreateWorkerFleet ... 46
Request Syntax ... 46
URI Request Parameters ... 46
Request Body ... 46
Response Syntax ... 47
Response Elements ... 47
Errors ... 47
See Also ... 48
DeleteAction ... 49
Request Syntax ... 49
URI Request Parameters ... 49
Request Body ... 49
Response Syntax ... 49
Response Elements ... 49
Errors ... 49
See Also ... 50
DeleteActionTemplate ... 51
Request Syntax ... 51
URI Request Parameters ... 51
Request Body ... 51
Response Syntax ... 51
Response Elements ... 51
Errors ... 51
See Also ... 52
DeleteActionTemplateDependency ... 53
Request Syntax ... 53
URI Request Parameters ... 53
Request Body ... 53
Response Syntax ... 53
Response Elements ... 53
Errors ... 54
See Also ... 54
DeleteActivity ... 55
Request Syntax ... 55
URI Request Parameters ... 55
Request Body ... 55
Response Syntax ... 55
Response Elements ... 55
Errors ... 55
See Also ... 56
DeleteActivityDependency ... 57
Request Syntax ... 57
URI Request Parameters ... 57
Request Body ... 57
Response Syntax ... 57
Response Elements ... 57
Errors ... 58
See Also ... 58
DeleteDestination ... 59
Request Syntax ... 59
URI Request Parameters ... 59
Request Body ... 59
Response Syntax ... 59
Response Elements ... 59
Errors ... 59
See Also ... 60
DeleteDestinationRelationship ... 61
Request Syntax ... 61
URI Request Parameters ... 61
Request Body ... 61
Response Syntax ... 61
Response Elements ... 61
Errors ... 61
See Also ... 62
DeleteSite ... 63
Request Syntax ... 63
URI Request Parameters ... 63
Request Body ... 63
Response Syntax ... 63
Response Elements ... 63
Errors ... 63
See Also ... 64
DeleteTask ... 65
Request Syntax ... 65
URI Request Parameters ... 65
Request Body ... 65
Response Syntax ... 65
Response Elements ... 65
Errors ... 65
See Also ... 66
DeleteTaskDependency ... 67
Request Syntax ... 67
URI Request Parameters ... 67
Request Body ... 67
Response Syntax ... 67
Response Elements ... 67
Errors ... 68
See Also ... 68
DeleteWorker ... 69
Request Syntax ... 69
URI Request Parameters ... 69
Request Body ... 69
Response Syntax ... 69
Response Elements ... 69
Errors ... 69
See Also ... 70
DeleteWorkerFleet ... 71
Request Syntax ... 71
URI Request Parameters ... 71
Request Body ... 71
Response Syntax ... 71
Response Elements ... 71
Errors ... 71
See Also ... 72
GetAction ... 73
Request Syntax ... 73
URI Request Parameters ... 73
Request Body ... 73
Response Syntax ... 73
Response Elements ... 74
Errors ... 75
See Also ... 76
GetActionTemplate ... 77
Request Syntax ... 77
URI Request Parameters ... 77
Request Body ... 77
Response Syntax ... 77
Response Elements ... 77
Errors ... 79
See Also ... 79
GetActivity ... 80
Request Syntax ... 80
URI Request Parameters ... 80
Request Body ... 80
Response Syntax ... 80
Response Elements ... 80
Errors ... 82
See Also ... 83
GetDestination ... 84
Request Syntax ... 84
URI Request Parameters ... 84
Request Body ... 84
Response Syntax ... 84
Response Elements ... 84
Errors ... 86
See Also ... 86
GetDestinationRelationship ... 87
Request Syntax ... 87
URI Request Parameters ... 87
Request Body ... 87
Response Syntax ... 87
Response Elements ... 87
Errors ... 88
See Also ... 89
GetSite ... 90
Request Syntax ... 90
URI Request Parameters ... 90
Request Body ... 90
Response Syntax ... 90
Response Elements ... 90
Errors ... 91
See Also ... 92
GetTask ... 93
Request Syntax ... 93
URI Request Parameters ... 93
Request Body ... 93
Response Syntax ... 93
Response Elements ... 93
Errors ... 95
See Also ... 95
GetWorker ... 97
Request Syntax ... 97
URI Request Parameters ... 97
Request Body ... 97
Response Syntax ... 97
Response Elements ... 97
Errors ... 99
See Also ... 99
GetWorkerFleet ... 100
Request Syntax ... 100
URI Request Parameters ... 100
Request Body ... 100
Response Syntax ... 100
Response Elements ... 100
Errors ... 101
See Also ... 102
ListActions ... 103
Request Syntax ... 103
URI Request Parameters ... 103
Request Body ... 103
Response Syntax ... 103
Response Elements ... 104
Errors ... 104
See Also ... 105
ListActionTemplates ... 106
Request Syntax ... 106
URI Request Parameters ... 106
Request Body ... 106
Response Syntax ... 106
Response Elements ... 107
Errors ... 107
See Also ... 108
ListActivities ... 109
Request Syntax ... 109
URI Request Parameters ... 109
Request Body ... 110
Response Syntax ... 110
Response Elements ... 110
Errors ... 110
See Also ... 111
ListDestinationRelationships ... 112
Request Syntax ... 112
URI Request Parameters ... 112
Request Body ... 112
Response Syntax ... 112
Response Elements ... 113
Errors ... 113
See Also ... 114
ListDestinations ... 115
Request Syntax ... 115
URI Request Parameters ... 115
Request Body ... 115
Response Syntax ... 115
Response Elements ... 116
Errors ... 116
See Also ... 117
ListSites ... 118
Request Syntax ... 118
URI Request Parameters ... 118
Request Body ... 118
Response Syntax ... 118
Response Elements ... 118
Errors ... 119
See Also ... 119
ListTasks ... 121
Request Syntax ... 121
URI Request Parameters ... 121
Request Body ... 122
Response Syntax ... 122
Response Elements ... 122
Errors ... 123
See Also ... 123
ListWorkerFleets ... 124
Request Syntax ... 124
URI Request Parameters ... 124
Request Body ... 124
Response Syntax ... 124
Response Elements ... 125
Errors ... 125
See Also ... 126
ListWorkers ... 127
Request Syntax ... 127
URI Request Parameters ... 127
Request Body ... 127
Response Syntax ... 127
Response Elements ... 128
Errors ... 128
See Also ... 129
UpdateActionState ... 130
Request Syntax ... 130
URI Request Parameters ... 130
Request Body ... 130
Response Syntax ... 131
Response Elements ... 131
Errors ... 132
See Also ... 132
UpdateActivity ... 133
Request Syntax ... 133
URI Request Parameters ... 133
Request Body ... 133
Response Syntax ... 134
Response Elements ... 134
Errors ... 135
See Also ... 135
UpdateDestination ... 137
Request Syntax ... 137
URI Request Parameters ... 137
Request Body ... 137
Response Syntax ... 138
Response Elements ... 138
Errors ... 139
See Also ... 140
UpdateSite ... 141
Request Syntax ... 141
URI Request Parameters ... 141
Request Body ... 141
Response Syntax ... 142
Response Elements ... 142
Errors ... 143
See Also ... 143
UpdateTask ... 145
Request Syntax ... 145
URI Request Parameters ... 145
Request Body ... 145
Response Syntax ... 146
Response Elements ... 146
Errors ... 147
See Also ... 148
UpdateWorker ... 149
Request Syntax ... 149
URI Request Parameters ... 149
Request Body ... 149
Response Syntax ... 150
Response Elements ... 150
Errors ... 151
See Also ... 152
UpdateWorkerFleet ... 153
Request Syntax ... 153
URI Request Parameters ... 153
Request Body ... 153
Response Syntax ... 153
Response Elements ... 154
Errors ... 154
See Also ... 155
Data Types ... 156
Action ... 157
Contents ... 157
See Also ... 158
ActionDependency ... 160
Contents ... 160
See Also ... 160
ActionTemplate ... 161
Contents ... 161
See Also ... 162
ActionTemplateDependency ... 163
Contents ... 163
See Also ... 163
Activity ... 164
Contents ... 164
See Also ... 165
ActivityDependency ... 167
Contents ... 167
See Also ... 167
Destination ... 168
Contents ... 168
See Also ... 169
DestinationRelationship ... 170
Contents ... 170
See Also ... 171
Location ... 172
Contents ... 172
See Also ... 172
Site ... 173
Contents ... 173
See Also ... 174
Task ... 175
Contents ... 175
See Also ... 176
TaskDependency ... 178
Contents ... 178
See Also ... 178
Worker ... 179
Contents ... 179
See Also ... 180
WorkerFleet ... 181
Contents ... 181
See Also ... 182
Common Parameters ... 183
Common Errors ... 185
Welcome
Overview
This is the AWS IoT RoboRunner API Reference. For an introduction to the service, see What is AWS IoT RoboRunner? in the AWS IoT RoboRunner Developer Guide.
This document was last published on March 6, 2022.
Actions
The following actions are supported:
• CreateAction (p. 4)
• CreateActionTemplate (p. 9)
• CreateActionTemplateDependency (p. 13)
• CreateActivity (p. 16)
• CreateActivityDependency (p. 21)
• CreateDestination (p. 24)
• CreateDestinationRelationship (p. 28)
• CreateSite (p. 32)
• CreateTask (p. 35)
• CreateTaskDependency (p. 39)
• CreateWorker (p. 42)
• CreateWorkerFleet (p. 46)
• DeleteAction (p. 49)
• DeleteActionTemplate (p. 51)
• DeleteActionTemplateDependency (p. 53)
• DeleteActivity (p. 55)
• DeleteActivityDependency (p. 57)
• DeleteDestination (p. 59)
• DeleteDestinationRelationship (p. 61)
• DeleteSite (p. 63)
• DeleteTask (p. 65)
• DeleteTaskDependency (p. 67)
• DeleteWorker (p. 69)
• DeleteWorkerFleet (p. 71)
• GetAction (p. 73)
• GetActionTemplate (p. 77)
• GetActivity (p. 80)
• GetDestination (p. 84)
• GetDestinationRelationship (p. 87)
• GetSite (p. 90)
• GetTask (p. 93)
• GetWorker (p. 97)
• GetWorkerFleet (p. 100)
• ListActions (p. 103)
• ListActionTemplates (p. 106)
• ListActivities (p. 109)
• ListDestinationRelationships (p. 112)
• ListDestinations (p. 115)
• ListSites (p. 118)
• ListTasks (p. 121)
• ListWorkerFleets (p. 124)
• ListWorkers (p. 127)
• UpdateActionState (p. 130)
• UpdateActivity (p. 133)
• UpdateDestination (p. 137)
• UpdateSite (p. 141)
• UpdateTask (p. 145)
• UpdateWorker (p. 149)
• UpdateWorkerFleet (p. 153)
CreateAction
CreateAction
Creates an action.
Request Syntax
POST /createAction HTTP/1.1 Content-type: application/json {
"activity": "string", "clientToken": "string", "dependencies": [ {
"target": "string", "type": "string"
} ],
"name": "string", "payload": "string", "state": "string", "substate": "string", "worker": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
activity (p. 4)
The parent activity of the action.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:task/[\w-]+/activity/.*
Required: Yes clientToken (p. 4)
Token used for detecting replayed requests. Replayed requests will not be performed multiple times.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [!-~]*
Required: No dependencies (p. 4)
List of action dependencies.
Response Syntax
Type: Array of ActionDependency (p. 160) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: No name (p. 4)
Human friendly name of the resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes payload (p. 4)
JSON document describing an action achievable by a worker.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 131072.
Required: Yes state (p. 4)
An action's state.
Type: String
Valid Values: NEW | PLANNING | ALLOCATION | DISPATCHING | ACTIVE | SUCCEEDED | FAILED | CANCELLED | REJECTED
Required: No substate (p. 4)
An action's substate.
Type: String
Valid Values: PROCESSING | COMPLETE Required: No
worker (p. 4)
The worker fulfilling the action.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:worker/.*
Required: Yes
Response Syntax
HTTP/1.1 200
Response Elements
Content-type: application/json { "arn": "string",
"createdAt": number, "id": "string", "state": "string", "substate": "string", "updatedAt": number }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
arn (p. 5) 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/.*
createdAt (p. 5)
Timestamp at which the resource was created.
Type: Timestamp id (p. 5)
Action ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
state (p. 5)
An action's state.
Type: String
Valid Values: NEW | PLANNING | ALLOCATION | DISPATCHING | ACTIVE | SUCCEEDED | FAILED | CANCELLED | REJECTED
substate (p. 5)
An action's substate.
Type: String
Valid Values: PROCESSING | COMPLETE updatedAt (p. 5)
Timestamp at which the resource was last updated.
Type: Timestamp
Errors
Errors
For information about the errors that are common to all actions, see Common Errors (p. 185).
AccessDeniedException
Exception thrown if the user does not have sufficient access to perform this action.
HTTP Status Code: 403 ConflictException
Exception thrown if the request results in a state that is not allowed by IoT RoboRunner.
HTTP Status Code: 409 InternalServerException
Exception thrown if something goes wrong within Iot RoboRunner.
HTTP Status Code: 500 ResourceNotFoundException
Exception thrown if a resource referenced in the request doesn't exist.
HTTP Status Code: 404 ServiceQuotaExceededException
Exception thrown if the user's AWS account has reached a service limit and the operation cannot proceed.
HTTP Status Code: 402 ThrottlingException
Exception thrown if the API is called too quickly.
HTTP Status Code: 429 ValidationException
Exception thrown if the API parameters do not pass validation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
See Also
CreateActionTemplate
CreateActionTemplate
Creates an action template.
Request Syntax
POST /createActionTemplate HTTP/1.1 Content-type: application/json {
"clientToken": "string", "dependencies": [ {
"target": "string", "type": "string"
} ],
"name": "string", "payload": "string", "task": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
clientToken (p. 9)
Token used for detecting replayed requests. Replayed requests will not be performed multiple times.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [!-~]*
Required: No dependencies (p. 9)
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 name (p. 9)
The name of the action created from the template.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Response Syntax
Required: Yes payload (p. 9)
JSON document describing an action achievable by a worker.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 131072.
Required: Yes task (p. 9)
The task that the action template belongs to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:task/.*
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json { "arn": "string",
"createdAt": number, "id": "string", "site": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
arn (p. 10)
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/.*
createdAt (p. 10)
Timestamp at which the resource was created.
Type: Timestamp id (p. 10)
Action template ID.
Errors
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
site (p. 10) Facility ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:site/.*
Errors
For information about the errors that are common to all actions, see Common Errors (p. 185).
AccessDeniedException
Exception thrown if the user does not have sufficient access to perform this action.
HTTP Status Code: 403 ConflictException
Exception thrown if the request results in a state that is not allowed by IoT RoboRunner.
HTTP Status Code: 409 InternalServerException
Exception thrown if something goes wrong within Iot RoboRunner.
HTTP Status Code: 500 ResourceNotFoundException
Exception thrown if a resource referenced in the request doesn't exist.
HTTP Status Code: 404 ServiceQuotaExceededException
Exception thrown if the user's AWS account has reached a service limit and the operation cannot proceed.
HTTP Status Code: 402 ThrottlingException
Exception thrown if the API is called too quickly.
HTTP Status Code: 429 ValidationException
Exception thrown if the API parameters do not pass validation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
See Also
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateActionTemplateDependency
CreateActionTemplateDependency
Creates a dependency between two action templates.
Request Syntax
POST /createActionTemplateDependency HTTP/1.1 Content-type: application/json
{
"source": "string", "target": "string", "type": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
source (p. 13)
The action template to add the target dependency to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:task/[\w-]+/action-template/.*
Required: Yes target (p. 13)
The dependency to add to the source action template.
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 (p. 13)
Type of dependency between two action templates.
Type: String
Valid Values: MUST_ATTEMPT_BEFORE | MUST_SUCCEED_BEFORE Required: No
Response Syntax
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 185).
AccessDeniedException
Exception thrown if the user does not have sufficient access to perform this action.
HTTP Status Code: 403 ConflictException
Exception thrown if the request results in a state that is not allowed by IoT RoboRunner.
HTTP Status Code: 409 InternalServerException
Exception thrown if something goes wrong within Iot RoboRunner.
HTTP Status Code: 500 ResourceNotFoundException
Exception thrown if a resource referenced in the request doesn't exist.
HTTP Status Code: 404 ServiceQuotaExceededException
Exception thrown if the user's AWS account has reached a service limit and the operation cannot proceed.
HTTP Status Code: 402 ThrottlingException
Exception thrown if the API is called too quickly.
HTTP Status Code: 429 ValidationException
Exception thrown if the API parameters do not pass validation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
See Also
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateActivity
CreateActivity
Creates an activity.
Request Syntax
POST /createActivity HTTP/1.1 Content-type: application/json { "clientToken": "string", "dependencies": [ {
"target": "string", "type": "string"
} ],
"externalId": "string", "fleet": "string",
"parentActivity": "string", "payload": "string", "state": "string", "substate": "string", "task": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
clientToken (p. 16)
Token used for detecting replayed requests. Replayed requests will not be performed multiple times.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [!-~]*
Required: No dependencies (p. 16)
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 (p. 16)
ID used by an external system for the activity.
Request Body
Type: String
Length Constraints: Minimum length of 1. Maximum length of 140.
Required: No fleet (p. 16)
The worker fleet that the activity is dispatched to. Immutable after activity creation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:worker-fleet/.*
Required: Yes parentActivity (p. 16)
ARN of the parent activity.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:task/[\w-]+/activity/.*
Required: No payload (p. 16)
JSON document describing the activity.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 131072.
Required: Yes state (p. 16)
Activity state.
Type: String
Valid Values: NEW | PLANNING | ALLOCATING | DISPATCHING | ACTIVE | SUCCEEDED | FAILED | CANCELLED | REJECTED
Required: No substate (p. 16)
Activity substate.
Type: String
Valid Values: PROCESSING | COMPLETE Required: No
task (p. 16)
The task that the activity belongs to. Immutable after activity creation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Response Syntax
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:task/.*
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json { "arn": "string",
"createdAt": number, "id": "string", "site": "string", "state": "string", "updatedAt": number }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
arn (p. 18) Activity ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:task/[\w-]+/activity/.*
createdAt (p. 18)
Timestamp at which the resource was created.
Type: Timestamp id (p. 18)
Activity ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
site (p. 18) Facility ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:site/.*
state (p. 18) Activity state.
Errors
Type: String
Valid Values: NEW | PLANNING | ALLOCATING | DISPATCHING | ACTIVE | SUCCEEDED | FAILED | CANCELLED | REJECTED
updatedAt (p. 18)
Timestamp at which the resource was last updated.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Errors (p. 185).
AccessDeniedException
Exception thrown if the user does not have sufficient access to perform this action.
HTTP Status Code: 403 ConflictException
Exception thrown if the request results in a state that is not allowed by IoT RoboRunner.
HTTP Status Code: 409 InternalServerException
Exception thrown if something goes wrong within Iot RoboRunner.
HTTP Status Code: 500 ResourceNotFoundException
Exception thrown if a resource referenced in the request doesn't exist.
HTTP Status Code: 404 ServiceQuotaExceededException
Exception thrown if the user's AWS account has reached a service limit and the operation cannot proceed.
HTTP Status Code: 402 ThrottlingException
Exception thrown if the API is called too quickly.
HTTP Status Code: 429 ValidationException
Exception thrown if the API parameters do not pass validation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
See Also
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateActivityDependency
CreateActivityDependency
Creates an activity dependency.
Request Syntax
POST /createActivityDependency HTTP/1.1 Content-type: application/json
{
"source": "string", "target": "string", "type": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
source (p. 21)
The activity to add a dependency to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:task/[\w-]+/activity/.*
Required: Yes target (p. 21)
The dependency to add to the source activity.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:task/[\w-]+/activity/.*
Required: Yes type (p. 21)
A dependency relationship between two activities.
Type: String
Valid Values: MUST_ATTEMPT_BEFORE | MUST_SUCCEED_BEFORE Required: No
Response Syntax
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 185).
AccessDeniedException
Exception thrown if the user does not have sufficient access to perform this action.
HTTP Status Code: 403 ConflictException
Exception thrown if the request results in a state that is not allowed by IoT RoboRunner.
HTTP Status Code: 409 InternalServerException
Exception thrown if something goes wrong within Iot RoboRunner.
HTTP Status Code: 500 ResourceNotFoundException
Exception thrown if a resource referenced in the request doesn't exist.
HTTP Status Code: 404 ServiceQuotaExceededException
Exception thrown if the user's AWS account has reached a service limit and the operation cannot proceed.
HTTP Status Code: 402 ThrottlingException
Exception thrown if the API is called too quickly.
HTTP Status Code: 429 ValidationException
Exception thrown if the API parameters do not pass validation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
See Also
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateDestination
CreateDestination
Creates a destination.
Request Syntax
POST /createDestination HTTP/1.1 Content-type: application/json {
"additionalInformation": "string", "clientToken": "string",
"location": { "x": number, "y": number, "z": number },
"name": "string", "site": "string", "state": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
additionalInformation (p. 24)
JSON document containing additional metadata about the destination.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 131072.
Required: No clientToken (p. 24)
Token used for detecting replayed requests. Replayed requests will not be performed multiple times.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [!-~]*
Required: No location (p. 24)
Location in 3D space relative to the origin of the facility.
Type: Location (p. 172) object Required: No
Response Syntax
name (p. 24)
Human friendly name of the resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes site (p. 24)
Facility ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:site/.*
Required: Yes state (p. 24)
State of the destination.
Type: String
Valid Values: ENABLED | DISABLED | DECOMMISSIONED Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"arn": "string", "createdAt": number, "id": "string", "state": "string", "updatedAt": number }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
arn (p. 25)
Destination ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:destination/.*
Errors
createdAt (p. 25)
Timestamp at which the resource was created.
Type: Timestamp id (p. 25)
Destination ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
state (p. 25)
State of the destination.
Type: String
Valid Values: ENABLED | DISABLED | DECOMMISSIONED updatedAt (p. 25)
Timestamp at which the resource was last updated.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Errors (p. 185).
AccessDeniedException
Exception thrown if the user does not have sufficient access to perform this action.
HTTP Status Code: 403 ConflictException
Exception thrown if the request results in a state that is not allowed by IoT RoboRunner.
HTTP Status Code: 409 InternalServerException
Exception thrown if something goes wrong within Iot RoboRunner.
HTTP Status Code: 500 ResourceNotFoundException
Exception thrown if a resource referenced in the request doesn't exist.
HTTP Status Code: 404 ServiceQuotaExceededException
Exception thrown if the user's AWS account has reached a service limit and the operation cannot proceed.
HTTP Status Code: 402 ThrottlingException
Exception thrown if the API is called too quickly.
See Also
HTTP Status Code: 429 ValidationException
Exception thrown if the API parameters do not pass validation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateDestinationRelationship
CreateDestinationRelationship
Creates a destination relationship.
Request Syntax
POST /createDestinationRelationship HTTP/1.1 Content-type: application/json
{ "clientToken": "string", "relationshipType": "string", "sourceDestination": "string", "targetDestination": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
clientToken (p. 28)
Token used for detecting replayed requests. Replayed requests will not be performed multiple times.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [!-~]*
Required: No relationshipType (p. 28)
Type of relationship between two destinations.
Type: String
Valid Values: TRAVERSAL | COMPOSITION Required: Yes
sourceDestination (p. 28) Destination ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:destination/.*
Required: Yes
Response Syntax
targetDestination (p. 28) Destination ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:destination/.*
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json { "arn": "string",
"createdAt": number, "id": "string", "site": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
arn (p. 29)
Destination relationship ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:destination-relationship/.*
createdAt (p. 29)
Timestamp at which the resource was created.
Type: Timestamp id (p. 29)
Filters access by the destination relationship's identifier Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
site (p. 29) Facility ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Errors
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:site/.*
Errors
For information about the errors that are common to all actions, see Common Errors (p. 185).
AccessDeniedException
Exception thrown if the user does not have sufficient access to perform this action.
HTTP Status Code: 403 ConflictException
Exception thrown if the request results in a state that is not allowed by IoT RoboRunner.
HTTP Status Code: 409 InternalServerException
Exception thrown if something goes wrong within Iot RoboRunner.
HTTP Status Code: 500 ResourceNotFoundException
Exception thrown if a resource referenced in the request doesn't exist.
HTTP Status Code: 404 ServiceQuotaExceededException
Exception thrown if the user's AWS account has reached a service limit and the operation cannot proceed.
HTTP Status Code: 402 ThrottlingException
Exception thrown if the API is called too quickly.
HTTP Status Code: 429 ValidationException
Exception thrown if the API parameters do not pass validation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
See Also
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateSite
CreateSite
Creates a facility.
Request Syntax
POST /createSite HTTP/1.1 Content-type: application/json { "clientToken": "string", "countryCode": "string", "description": "string", "name": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
clientToken (p. 32)
Token used for detecting replayed requests. Replayed requests will not be performed multiple times.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [!-~]*
Required: No countryCode (p. 32)
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 description (p. 32)
High-level description of the facility.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 140.
Required: No name (p. 32)
Human friendly name of the resource.
Response Syntax
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"arn": "string", "createdAt": number, "id": "string", "updatedAt": number }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
arn (p. 33)
Facility ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:site/.*
createdAt (p. 33)
Timestamp at which the resource was created.
Type: Timestamp id (p. 33)
Facility ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
updatedAt (p. 33)
Timestamp at which the resource was last updated.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Errors (p. 185).
See Also
AccessDeniedException
Exception thrown if the user does not have sufficient access to perform this action.
HTTP Status Code: 403 ConflictException
Exception thrown if the request results in a state that is not allowed by IoT RoboRunner.
HTTP Status Code: 409 InternalServerException
Exception thrown if something goes wrong within Iot RoboRunner.
HTTP Status Code: 500 ServiceQuotaExceededException
Exception thrown if the user's AWS account has reached a service limit and the operation cannot proceed.
HTTP Status Code: 402 ThrottlingException
Exception thrown if the API is called too quickly.
HTTP Status Code: 429 ValidationException
Exception thrown if the API parameters do not pass validation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateTask
CreateTask
Grants permission to create a task
Request Syntax
POST /createTask HTTP/1.1 Content-type: application/json {
"clientToken": "string", "dependencies": [ {
"target": "string", "type": "string"
} ],
"fleet": "string", "parentTask": "string", "payload": "string", "site": "string", "state": "string", "substate": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
clientToken (p. 35)
Token used for detecting replayed requests. Replayed requests will not be performed multiple times.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [!-~]*
Required: No dependencies (p. 35)
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 (p. 35)
The fleet that performs the activity created from the task.
Type: String
Response Syntax
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:worker-fleet/.*
Required: No parentTask (p. 35)
The parent of the task. Immutable after task creation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:task/.*
Required: No payload (p. 35)
JSON document describing a task.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 131072.
Required: Yes site (p. 35)
Facility ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:site/.*
Required: Yes state (p. 35)
Task state.
Type: String
Valid Values: NEW | PLANNING | ALLOCATING | DISPATCHING | ACTIVE | SUCCEEDED | FAILED | CANCELLED | REJECTED
Required: No substate (p. 35)
Task substate.
Type: String
Valid Values: PROCESSING | COMPLETE Required: No
Response Syntax
HTTP/1.1 200
Response Elements
Content-type: application/json { "arn": "string",
"createdAt": number, "id": "string", "state": "string", "updatedAt": number }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
arn (p. 36) Task ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:task/.*
createdAt (p. 36)
Timestamp at which the resource was created.
Type: Timestamp id (p. 36)
Task ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
state (p. 36) Task state.
Type: String
Valid Values: NEW | PLANNING | ALLOCATING | DISPATCHING | ACTIVE | SUCCEEDED | FAILED | CANCELLED | REJECTED
updatedAt (p. 36)
Timestamp at which the resource was last updated.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Errors (p. 185).
AccessDeniedException
Exception thrown if the user does not have sufficient access to perform this action.
See Also
HTTP Status Code: 403 ConflictException
Exception thrown if the request results in a state that is not allowed by IoT RoboRunner.
HTTP Status Code: 409 InternalServerException
Exception thrown if something goes wrong within Iot RoboRunner.
HTTP Status Code: 500 ResourceNotFoundException
Exception thrown if a resource referenced in the request doesn't exist.
HTTP Status Code: 404 ServiceQuotaExceededException
Exception thrown if the user's AWS account has reached a service limit and the operation cannot proceed.
HTTP Status Code: 402 ThrottlingException
Exception thrown if the API is called too quickly.
HTTP Status Code: 429 ValidationException
Exception thrown if the API parameters do not pass validation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateTaskDependency
CreateTaskDependency
Creates a task dependency.
Request Syntax
POST /createTaskDependency HTTP/1.1 Content-type: application/json {
"source": "string", "target": "string", "type": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
source (p. 39)
The task to add a dependency to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:task/.*
Required: Yes target (p. 39)
The task to add as a dependency to the source task.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:task/.*
Required: Yes type (p. 39)
Type of dependency between two tasks.
Type: String
Valid Values: MUST_ATTEMPT_BEFORE | MUST_SUCCEED_BEFORE Required: No
Response Syntax
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 185).
AccessDeniedException
Exception thrown if the user does not have sufficient access to perform this action.
HTTP Status Code: 403 ConflictException
Exception thrown if the request results in a state that is not allowed by IoT RoboRunner.
HTTP Status Code: 409 InternalServerException
Exception thrown if something goes wrong within Iot RoboRunner.
HTTP Status Code: 500 ResourceNotFoundException
Exception thrown if a resource referenced in the request doesn't exist.
HTTP Status Code: 404 ServiceQuotaExceededException
Exception thrown if the user's AWS account has reached a service limit and the operation cannot proceed.
HTTP Status Code: 402 ThrottlingException
Exception thrown if the API is called too quickly.
HTTP Status Code: 429 ValidationException
Exception thrown if the API parameters do not pass validation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
See Also
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateWorker
CreateWorker
Creates a worker.
Request Syntax
POST /createWorker HTTP/1.1 Content-type: application/json { "additionalInformation": "string", "clientToken": "string",
"fleet": "string", "name": "string", "state": "string", "status": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
additionalInformation (p. 42)
JSON document that contains custom static attributes of the worker.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 131072.
Required: No clientToken (p. 42)
Token used for detecting replayed requests. Replayed requests will not be performed multiple times.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [!-~]*
Required: No fleet (p. 42)
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
Response Syntax
name (p. 42)
Human friendly name of the resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes state (p. 42)
Worker state.
Type: String
Valid Values: ENABLED | DISABLED | BUSY | DECOMMISSIONED Required: No
status (p. 42)
JSON document that contains custom status attributes of the worker.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 131072.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json { "arn": "string",
"createdAt": number, "id": "string", "site": "string", "updatedAt": number }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
arn (p. 43) Worker ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:worker/.*
createdAt (p. 43)
Timestamp at which the resource was created.
Errors
Type: Timestamp id (p. 43)
Worker ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
site (p. 43) Facility ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:site/.*
updatedAt (p. 43)
Timestamp at which the resource was last updated.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Errors (p. 185).
AccessDeniedException
Exception thrown if the user does not have sufficient access to perform this action.
HTTP Status Code: 403 ConflictException
Exception thrown if the request results in a state that is not allowed by IoT RoboRunner.
HTTP Status Code: 409 InternalServerException
Exception thrown if something goes wrong within Iot RoboRunner.
HTTP Status Code: 500 ResourceNotFoundException
Exception thrown if a resource referenced in the request doesn't exist.
HTTP Status Code: 404 ServiceQuotaExceededException
Exception thrown if the user's AWS account has reached a service limit and the operation cannot proceed.
HTTP Status Code: 402 ThrottlingException
Exception thrown if the API is called too quickly.
HTTP Status Code: 429
See Also
ValidationException
Exception thrown if the API parameters do not pass validation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateWorkerFleet
CreateWorkerFleet
Creates a worker fleet.
Request Syntax
POST /createWorkerFleet HTTP/1.1 Content-type: application/json {
"clientToken": "string", "name": "string",
"site": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
clientToken (p. 46)
Token used for detecting replayed requests. Replayed requests will not be performed multiple times.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [!-~]*
Required: No name (p. 46)
Human friendly name of the resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes site (p. 46)
Facility ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:site/.*
Required: Yes
Response Syntax
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"arn": "string", "createdAt": number, "id": "string", "updatedAt": number }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
arn (p. 47)
Worker fleet ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: arn:aws:iotroborunner:[\w-]+:\w+:worker-fleet/.*
createdAt (p. 47)
Timestamp at which the resource was created.
Type: Timestamp id (p. 47)
Worker fleet ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
updatedAt (p. 47)
Timestamp at which the resource was last updated.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Errors (p. 185).
AccessDeniedException
Exception thrown if the user does not have sufficient access to perform this action.
HTTP Status Code: 403 ConflictException
Exception thrown if the request results in a state that is not allowed by IoT RoboRunner.
See Also
HTTP Status Code: 409 InternalServerException
Exception thrown if something goes wrong within Iot RoboRunner.
HTTP Status Code: 500 ResourceNotFoundException
Exception thrown if a resource referenced in the request doesn't exist.
HTTP Status Code: 404 ServiceQuotaExceededException
Exception thrown if the user's AWS account has reached a service limit and the operation cannot proceed.
HTTP Status Code: 402 ThrottlingException
Exception thrown if the API is called too quickly.
HTTP Status Code: 429 ValidationException
Exception thrown if the API parameters do not pass validation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteAction
DeleteAction
Deletes an action.
Request Syntax
POST /deleteAction HTTP/1.1 Content-type: application/json { "id": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
id (p. 49) 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
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 185).
AccessDeniedException
Exception thrown if the user does not have sufficient access to perform this action.
HTTP Status Code: 403
See Also
ConflictException
Exception thrown if the request results in a state that is not allowed by IoT RoboRunner.
HTTP Status Code: 409 InternalServerException
Exception thrown if something goes wrong within Iot RoboRunner.
HTTP Status Code: 500 ResourceNotFoundException
Exception thrown if a resource referenced in the request doesn't exist.
HTTP Status Code: 404 ThrottlingException
Exception thrown if the API is called too quickly.
HTTP Status Code: 429 ValidationException
Exception thrown if the API parameters do not pass validation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteActionTemplate
DeleteActionTemplate
Deletes an action template.
Request Syntax
POST /deleteActionTemplate HTTP/1.1 Content-type: application/json { "id": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
id (p. 51)
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
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 185).
AccessDeniedException
Exception thrown if the user does not have sufficient access to perform this action.
HTTP Status Code: 403 ConflictException
Exception thrown if the request results in a state that is not allowed by IoT RoboRunner.
See Also
HTTP Status Code: 409 InternalServerException
Exception thrown if something goes wrong within Iot RoboRunner.
HTTP Status Code: 500 ResourceNotFoundException
Exception thrown if a resource referenced in the request doesn't exist.
HTTP Status Code: 404 ThrottlingException
Exception thrown if the API is called too quickly.
HTTP Status Code: 429 ValidationException
Exception thrown if the API parameters do not pass validation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
