RoboMaker / Client / list_world_templates

list_world_templates

RoboMaker.Client.list_world_templates(**kwargs)

Lists world templates.

See also: AWS API Documentation

Request Syntax

response = client.list_world_templates(
    nextToken='string',
    maxResults=123
)

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 ListWorldTemplates 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, ListWorldTemplates 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 ListWorldTemplates request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorldTemplates returns up to 100 results and a nextToken value if applicable.

Return type:

dict

Returns:

Response Syntax

{
    'templateSummaries': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1),
            'name': 'string',
            'version': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • templateSummaries (list) –

    Summary information for templates.

    • (dict) –

      Summary information for a template.

      • arn (string) –

        The Amazon Resource Name (ARN) of the template.

      • createdAt (datetime) –

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

      • lastUpdatedAt (datetime) –

        The time, in milliseconds since the epoch, when the template was last updated.

      • name (string) –

        The name of the template.

      • version (string) –

        The version of the template that you’re using.

  • 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 ListWorldTemplates 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