RoboMaker / Client / describe_world_template

describe_world_template

RoboMaker.Client.describe_world_template(**kwargs)

Warning

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.

Describes a world template.

See also: AWS API Documentation

Request Syntax

response = client.describe_world_template(
    template='string'
)

Parameters:

template (string) –

[REQUIRED]

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

Return type:

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.

Exceptions

• RoboMaker.Client.exceptions.InvalidParameterException

• RoboMaker.Client.exceptions.ResourceNotFoundException

• RoboMaker.Client.exceptions.ThrottlingException

• RoboMaker.Client.exceptions.InternalServerException