AWS RoboMaker

{'worldDescriptionBody': 'string'}

Describes a world.

See also: AWS API Documentation

Request Syntax

client.describe_world(
    world='string'
)

type world:

string

param world:

[REQUIRED]

The Amazon Resource Name (arn) of the world you want to describe.

rtype:

dict

returns:

Response Syntax

{
    'arn': 'string',
    'generationJob': 'string',
    'template': 'string',
    'createdAt': datetime(2015, 1, 1),
    'tags': {
        'string': 'string'
    },
    'worldDescriptionBody': 'string'
}

Response Structure

• (dict) --

  • arn (string) --

    The Amazon Resource Name (arn) of the world.

  • generationJob (string) --

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

  • template (string) --

    The world template.

  • createdAt (datetime) --

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

  • tags (dict) --

    A map that contains tag keys and tag values that are attached to the world.

    • (string) --

      • (string) --

  • worldDescriptionBody (string) --

    Returns the JSON formatted string that describes the contents of your world.

{'version': 'string'}

Describes a world template.

See also: AWS API Documentation

Request Syntax

client.describe_world_template(
    template='string'
)

type template:

string

param template:

[REQUIRED]

The Amazon Resource Name (arn) of the world template you want to describe.

rtype:

dict

returns:

Response Syntax

{
    'arn': 'string',
    'clientRequestToken': 'string',
    'name': 'string',
    'createdAt': datetime(2015, 1, 1),
    'lastUpdatedAt': datetime(2015, 1, 1),
    'tags': {
        'string': 'string'
    },
    'version': 'string'
}

Response Structure

• (dict) --

  • arn (string) --

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

  • clientRequestToken (string) --

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

  • name (string) --

    The name of the world template.

  • createdAt (datetime) --

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

  • lastUpdatedAt (datetime) --

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

  • tags (dict) --

    A map that contains tag keys and tag values that are attached to the world template.

    • (string) --

      • (string) --

  • version (string) --

    The version of the world template that you're using.

{'templateSummaries': {'version': 'string'}}

Lists world templates.

See also: AWS API Documentation

Request Syntax

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

type nextToken:

string

param nextToken:

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.

type maxResults:

integer

param maxResults:

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.

rtype:

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.