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": [
"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": [
"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
HTTP Status Code: 500