RoboMaker / Client / create_world_generation_job

create_world_generation_job

RoboMaker.Client.create_world_generation_job(**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 worlds using the specified template.

See also: AWS API Documentation

Request Syntax

response = client.create_world_generation_job(
    clientRequestToken='string',
    template='string',
    worldCount={
        'floorplanCount': 123,
        'interiorCountPerFloorplan': 123
    },
    tags={
        'string': 'string'
    },
    worldTags={
        'string': 'string'
    }
)

Parameters:

• clientRequestToken (string) –

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

  This field is autopopulated if not provided.

• template (string) –

  [REQUIRED]

  The Amazon Resource Name (arn) of the world template describing the worlds you want to create.

• worldCount (dict) –

  [REQUIRED]

  Information about the world count.

  • floorplanCount (integer) –

    The number of unique floorplans.

  • interiorCountPerFloorplan (integer) –

    The number of unique interiors per floorplan.

• tags (dict) –

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

  • (string) –

    • (string) –

• worldTags (dict) –

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

  • (string) –

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'status': 'Pending'|'Running'|'Completed'|'Failed'|'PartialFailed'|'Canceling'|'Canceled',
    'createdAt': datetime(2015, 1, 1),
    'failureCode': 'InternalServiceError'|'LimitExceeded'|'ResourceNotFound'|'RequestThrottled'|'InvalidInput'|'AllWorldGenerationFailed',
    'clientRequestToken': 'string',
    'template': 'string',
    'worldCount': {
        'floorplanCount': 123,
        'interiorCountPerFloorplan': 123
    },
    'tags': {
        'string': 'string'
    },
    'worldTags': {
        'string': 'string'
    }
}

Response Structure

• (dict) –

  • arn (string) –

    The Amazon Resource Name (ARN) of the world generator job.

  • status (string) –

    The status of the world generator job.

    Pending

    The world generator job request is pending.

    Running

    The world generator job is running.

    Completed

    The world generator job completed.

    Failed

    The world generator job failed. See failureCode for more information.

    PartialFailed

    Some worlds did not generate.

    Canceled

    The world generator job was cancelled.

    Canceling

    The world generator job is being cancelled.

  • createdAt (datetime) –

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

  • failureCode (string) –

    The failure code of the world generator job if it failed:

    InternalServiceError

    Internal service error.

    LimitExceeded

    The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

    ResourceNotFound

    The specified resource could not be found.

    RequestThrottled

    The request was throttled.

    InvalidInput

    An input parameter in the request is not valid.

  • clientRequestToken (string) –

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

  • template (string) –

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

  • worldCount (dict) –

    Information about the world count.

    • floorplanCount (integer) –

      The number of unique floorplans.

    • interiorCountPerFloorplan (integer) –

      The number of unique interiors per floorplan.

  • tags (dict) –

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

    • (string) –

      • (string) –

  • worldTags (dict) –

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

    • (string) –

      • (string) –

Exceptions

• RoboMaker.Client.exceptions.ResourceNotFoundException

• RoboMaker.Client.exceptions.InvalidParameterException

• RoboMaker.Client.exceptions.InternalServerException

• RoboMaker.Client.exceptions.ThrottlingException

• RoboMaker.Client.exceptions.LimitExceededException

• RoboMaker.Client.exceptions.IdempotentParameterMismatchException

• RoboMaker.Client.exceptions.ServiceUnavailableException