Amazon RoboMaker · Schema
ListWorldsRequest
ListWorldsRequest schema from openapi
RoboticsSimulation
Properties
| Name | Type | Description |
|---|---|---|
| nextToken | object | |
| maxResults | object | |
| filters | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-robomaker/refs/heads/main/json-schema/amazon-robomaker-openapi-list-worlds-request-schema.json",
"title": "ListWorldsRequest",
"description": "ListWorldsRequest schema from openapi",
"type": "object",
"properties": {
"nextToken": {
"allOf": [
{
"$ref": "#/components/schemas/PaginationToken"
},
{
"description": "If the previous paginated request did not return all of the remaining results, the response object's <code>nextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListWorlds</code> again and assign that token to the request object's <code>nextToken</code> parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. "
}
]
},
"maxResults": {
"allOf": [
{
"$ref": "#/components/schemas/MaxResults"
},
{
"description": "When this parameter is used, <code>ListWorlds</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListWorlds</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListWorlds</code> returns up to 100 results and a <code>nextToken</code> value if applicable. "
}
]
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/Filters"
},
{
"description": "Optional filters to limit results. You can use <code>status</code>."
}
]
}
}
}