describe_world

describe_world(**kwargs)

Describes a world.

See also: AWS API Documentation

Request Syntax

response = client.describe_world(
    world='string'
)
Parameters
world (string) --

[REQUIRED]

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

Return type
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.

Exceptions

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