RoboMaker / Client / create_world_template

create_world_template#

RoboMaker.Client.create_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/.

Creates a world template.

See also: AWS API Documentation

Request Syntax

response = client.create_world_template(
    clientRequestToken='string',
    name='string',
    templateBody='string',
    templateLocation={
        's3Bucket': 'string',
        's3Key': 'string'
    },
    tags={
        'string': 'string'
    }
)
Parameters:

  • clientRequestToken (string) – Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

  • name (string) – The name of the world template.

  • templateBody (string) – The world template body.

  • templateLocation (dict) –

    The location of the world template.

    • s3Bucket (string) – [REQUIRED]

      The Amazon S3 bucket name.

    • s3Key (string) – [REQUIRED]

      The list of S3 keys identifying the data source files.

  • tags (dict) –

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

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'clientRequestToken': 'string',
    'createdAt': datetime(2015, 1, 1),
    'name': 'string',
    'tags': {
        'string': '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.

    • createdAt (datetime) –

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

    • name (string) –

      The name of the world template.

    • tags (dict) –

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

      • (string) –

        • (string) –

Exceptions

  • RoboMaker.Client.exceptions.InvalidParameterException

  • RoboMaker.Client.exceptions.ResourceAlreadyExistsException

  • RoboMaker.Client.exceptions.ResourceNotFoundException

  • RoboMaker.Client.exceptions.LimitExceededException

  • RoboMaker.Client.exceptions.ThrottlingException

  • RoboMaker.Client.exceptions.InternalServerException