End of support notice: On September 10, 2025, AWS
will discontinue support for AWS RoboMaker. After September 10, 2025, you will
no longer be able to access the AWS RoboMaker console or AWS RoboMaker resources.
For more information on transitioning to AWS Batch to help run containerized
simulations, visit this blog
post
CreateRobot
This action has been deprecated.
Important
End of support notice: On September 10, 2025, AWS
will discontinue support for AWS RoboMaker. After September 10, 2025, you will
no longer be able to access the AWS RoboMaker console or AWS RoboMaker resources.
For more information on transitioning to AWS Batch to help run containerized
simulations, visit this blog
post
Important
This API is no longer supported and will throw an error if used. For more information, see the January 31, 2022 update in the Support policy page.
Creates a robot.
Request Syntax
POST /createRobot HTTP/1.1
Content-type: application/json
{
"architecture": "string
",
"greengrassGroupId": "string
",
"name": "string
",
"tags": {
"string
" : "string
"
}
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- architecture
-
The target architecture of the robot.
Type: String
Valid Values:
X86_64 | ARM64 | ARMHF
Required: Yes
- greengrassGroupId
-
The Greengrass group id.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern:
.*
Required: Yes
- name
-
The name for the robot.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[a-zA-Z0-9_\-]*
Required: Yes
-
A map that contains tag keys and tag values that are attached to the robot.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
[a-zA-Z0-9 _.\-\/+=:]*
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern:
[a-zA-Z0-9 _.\-\/+=:]*
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"architecture": "string",
"arn": "string",
"createdAt": number,
"greengrassGroupId": "string",
"name": "string",
"tags": {
"string" : "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.
- architecture
-
The target architecture of the robot.
Type: String
Valid Values:
X86_64 | ARM64 | ARMHF
- arn
-
The Amazon Resource Name (ARN) of the robot.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern:
arn:.*
- createdAt
-
The time, in milliseconds since the epoch, when the robot was created.
Type: Timestamp
- greengrassGroupId
-
The Amazon Resource Name (ARN) of the Greengrass group associated with the robot.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern:
.*
- name
-
The name of the robot.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[a-zA-Z0-9_\-]*
-
The list of all tags added to the robot.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
[a-zA-Z0-9 _.\-\/+=:]*
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern:
[a-zA-Z0-9 _.\-\/+=:]*
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerException
-
AWS RoboMaker experienced a service issue. Try your call again.
HTTP Status Code: 500
- InvalidParameterException
-
A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.
HTTP Status Code: 400
- LimitExceededException
-
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
HTTP Status Code: 400
- ResourceAlreadyExistsException
-
The specified resource already exists.
HTTP Status Code: 400
- ThrottlingException
-
AWS RoboMaker is temporarily unable to process the request. Try your call again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: