list_worlds

RoboMaker.Client.list_worlds(**kwargs)

Lists worlds.

See also: AWS API Documentation

Request Syntax

response = client.list_worlds(
    nextToken='string',
    maxResults=123,
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ]
)

Parameters

• nextToken (string) -- If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorlds again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
• maxResults (integer) -- When this parameter is used, ListWorlds only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListWorlds request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorlds returns up to 100 results and a nextToken value if applicable.
• filters (list) --

  Optional filters to limit results. You can use status .

  • (dict) --

    Information about a filter.

    • name (string) --

      The name of the filter.

    • values (list) --

      A list of values.

      • (string) --

Return type

dict

Returns

Response Syntax

{
    'worldSummaries': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'generationJob': 'string',
            'template': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • worldSummaries (list) --

    Summary information for worlds.

    • (dict) --

      Information about a world.

      • arn (string) --

        The Amazon Resource Name (ARN) of the world.

      • createdAt (datetime) --

        The time, in milliseconds since the epoch, when the world was created.

      • generationJob (string) --

        The Amazon Resource Name (arn) of the world generation job.

      • template (string) --

        The Amazon Resource Name (arn) of the world template.

  • nextToken (string) --

    If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorlds again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Exceptions

• RoboMaker.Client.exceptions.InvalidParameterException
• RoboMaker.Client.exceptions.ThrottlingException
• RoboMaker.Client.exceptions.InternalServerException