RoboMaker / Paginator / ListWorldGenerationJobs

ListWorldGenerationJobs

class RoboMaker.Paginator.ListWorldGenerationJobs

paginator = client.get_paginator('list_world_generation_jobs')

paginate(**kwargs)

Creates an iterator that will paginate through responses from RoboMaker.Client.list_world_generation_jobs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• filters (list) –

  Optional filters to limit results. You can use status and templateId.

  • (dict) –

    Information about a filter.

    • name (string) –

      The name of the filter.

    • values (list) –

      A list of values.

      • (string) –

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'worldGenerationJobSummaries': [
        {
            'arn': 'string',
            'template': 'string',
            'createdAt': datetime(2015, 1, 1),
            'status': 'Pending'|'Running'|'Completed'|'Failed'|'PartialFailed'|'Canceling'|'Canceled',
            'worldCount': {
                'floorplanCount': 123,
                'interiorCountPerFloorplan': 123
            },
            'succeededWorldCount': 123,
            'failedWorldCount': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • worldGenerationJobSummaries (list) –

    Summary information for world generator jobs.

    • (dict) –

      Information about a world generator job.

      • arn (string) –

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

      • template (string) –

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

      • createdAt (datetime) –

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

      • 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.

      • worldCount (dict) –

        Information about the world count.

        • floorplanCount (integer) –

          The number of unique floorplans.

        • interiorCountPerFloorplan (integer) –

          The number of unique interiors per floorplan.

      • succeededWorldCount (integer) –

        The number of worlds that were generated.

      • failedWorldCount (integer) –

        The number of worlds that failed.

  • NextToken (string) –

    A token to resume pagination.