RoboMaker / Client / list_world_generation_jobs

list_world_generation_jobs

RoboMaker.Client.list_world_generation_jobs(**kwargs)

Lists world generator jobs.

See also: AWS API Documentation

Request Syntax

response = client.list_world_generation_jobs(
    nextToken='string',
    maxResults=123,
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ]
)
Parameters:

  • nextToken (string) – If the previous paginated request did not return all of the remaining results, the response object’s nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldGenerationJobsRequest again and assign that token to the request object’s nextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

  • maxResults (integer) – When this parameter is used, ListWorldGeneratorJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListWorldGeneratorJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorldGeneratorJobs returns up to 100 results and a nextToken value if applicable.

  • 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) –

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) –

      If the previous paginated request did not return all of the remaining results, the response object’s nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldGeneratorJobsRequest again and assign that token to the request object’s nextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

Exceptions