AWS RoboMaker is no longer available to new customers. Existing customers of
AWS RoboMaker can continue to use the service as normal.
AWS Batch is now the preferred service to run containerized simulations.
Learn more.
RegisterRobot
This action has been deprecated.
Registers a robot with a fleet.
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.
Request Syntax
POST /registerRobot HTTP/1.1
Content-type: application/json
{
"fleet": "string",
"robot": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- fleet
-
The Amazon Resource Name (ARN) of the fleet.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern:
arn:.*Required: Yes
- robot
-
The Amazon Resource Name (ARN) of the robot.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern:
arn:.*Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"fleet": "string",
"robot": "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.
- fleet
-
The Amazon Resource Name (ARN) of the fleet that the robot will join.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern:
arn:.* - robot
-
Information about the robot registration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern:
arn:.*
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
- ResourceNotFoundException
-
The specified resource does not exist.
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:
