CreateRobotApplication
Creates a robot application.
Request Syntax
POST /createRobotApplication HTTP/1.1
Content-type: application/json
{
"environment": {
"uri": "string"
},
"name": "string",
"robotSoftwareSuite": {
"name": "string",
"version": "string"
},
"sources": [
{
"architecture": "string",
"s3Bucket": "string",
"s3Key": "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.
- environment
-
The object that contains that URI of the Docker image that you use for your robot application.
Type: Environment object
Required: No
- name
-
The name of the robot application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[a-zA-Z0-9_\-]*Required: Yes
- robotSoftwareSuite
-
The robot software suite used by the robot application.
Type: RobotSoftwareSuite object
Required: Yes
- sources
-
The sources of the robot application.
Type: Array of SourceConfig objects
Required: No
- tags
-
A map that contains tag keys and tag values that are attached to the robot application.
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
{
"arn": "string",
"environment": {
"uri": "string"
},
"lastUpdatedAt": number,
"name": "string",
"revisionId": "string",
"robotSoftwareSuite": {
"name": "string",
"version": "string"
},
"sources": [
{
"architecture": "string",
"etag": "string",
"s3Bucket": "string",
"s3Key": "string"
}
],
"tags": {
"string" : "string"
},
"version": "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
-
The Amazon Resource Name (ARN) of the robot application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern:
arn:.* - environment
-
An object that contains the Docker image URI used to a create your robot application.
Type: Environment object
- lastUpdatedAt
-
The time, in milliseconds since the epoch, when the robot application was last updated.
Type: Timestamp
- name
-
The name of the robot application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[a-zA-Z0-9_\-]* - revisionId
-
The revision id of the robot application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 40.
Pattern:
[a-zA-Z0-9_.\-]* - robotSoftwareSuite
-
The robot software suite used by the robot application.
Type: RobotSoftwareSuite object
- sources
-
The sources of the robot application.
Type: Array of Source objects
- tags
-
The list of all tags added to the robot application.
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 _.\-\/+=:]* - version
-
The version of the robot application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
(\$LATEST)|[0-9]*
Errors
For information about the errors that are common to all actions, see Common Errors.
- IdempotentParameterMismatchException
-
The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.
HTTP Status Code: 400
- 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:
