CreateWorldGenerationJob
Creates worlds using the specified template.
Request Syntax
POST /createWorldGenerationJob HTTP/1.1
Content-type: application/json
{
"clientRequestToken": "string
",
"tags": {
"string
" : "string
"
},
"template": "string
",
"worldCount": {
"floorplanCount": number
,
"interiorCountPerFloorplan": number
},
"worldTags": {
"string
" : "string
"
}
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- clientRequestToken
-
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9_\-=]*
Required: No
-
A map that contains tag keys and tag values that are attached to the world generator job.
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
- template
-
The Amazon Resource Name (arn) of the world template describing the worlds you want to create.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern:
arn:.*
Required: Yes
- worldCount
-
Information about the world count.
Type: WorldCount object
Required: Yes
- worldTags
-
A map that contains tag keys and tag values that are attached to the generated worlds.
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",
"clientRequestToken": "string",
"createdAt": number,
"failureCode": "string",
"status": "string",
"tags": {
"string" : "string"
},
"template": "string",
"worldCount": {
"floorplanCount": number,
"interiorCountPerFloorplan": number
},
"worldTags": {
"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.
- arn
-
The Amazon Resource Name (ARN) of the world generator job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern:
arn:.*
- clientRequestToken
-
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9_\-=]*
- createdAt
-
The time, in milliseconds since the epoch, when the world generator job was created.
Type: Timestamp
- failureCode
-
The failure code of the world generator job if it failed:
- InternalServiceError
-
Internal service error.
- LimitExceeded
-
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
- ResourceNotFound
-
The specified resource could not be found.
- RequestThrottled
-
The request was throttled.
- InvalidInput
-
An input parameter in the request is not valid.
Type: String
Valid Values:
InternalServiceError | LimitExceeded | ResourceNotFound | RequestThrottled | InvalidInput | AllWorldGenerationFailed
- status
-
The status of the world generator job.
- Pending
-
The world generator job request is pending.
- Running
-
The world generator job is running.
- Completed
-
The world generator job completed.
- Failed
-
The world generator job failed. See
failureCode
for more information. - PartialFailed
-
Some worlds did not generate.
- Canceled
-
The world generator job was cancelled.
- Canceling
-
The world generator job is being cancelled.
Type: String
Valid Values:
Pending | Running | Completed | Failed | PartialFailed | Canceling | Canceled
-
A map that contains tag keys and tag values that are attached to the world generator job.
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 _.\-\/+=:]*
- template
-
The Amazon Resource Name (arn) of the world template.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern:
arn:.*
- worldCount
-
Information about the world count.
Type: WorldCount object
- worldTags
-
A map that contains tag keys and tag values that are attached to the generated worlds.
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.
- 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
- ResourceNotFoundException
-
The specified resource does not exist.
HTTP Status Code: 400
- ServiceUnavailableException
-
The request has failed due to a temporary failure of the server.
HTTP Status Code: 503
- 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: