RoboMaker / Paginator / ListWorldExportJobs

ListWorldExportJobs

class RoboMaker.Paginator.ListWorldExportJobs

paginator = client.get_paginator('list_world_export_jobs')

paginate(**kwargs)

Creates an iterator that will paginate through responses from RoboMaker.Client.list_world_export_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 generationJobId 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

{
    'worldExportJobSummaries': [
        {
            'arn': 'string',
            'status': 'Pending'|'Running'|'Completed'|'Failed'|'Canceling'|'Canceled',
            'createdAt': datetime(2015, 1, 1),
            'worlds': [
                'string',
            ],
            'outputLocation': {
                's3Bucket': 'string',
                's3Prefix': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • worldExportJobSummaries (list) –

    Summary information for world export jobs.

    • (dict) –

      Information about a world export job.

      • arn (string) –

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

      • status (string) –

        The status of the world export job.

        Pending

        The world export job request is pending.

        Running

        The world export job is running.

        Completed

        The world export job completed.

        Failed

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

        Canceled

        The world export job was cancelled.

        Canceling

        The world export job is being cancelled.

      • createdAt (datetime) –

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

      • worlds (list) –

        A list of worlds.

        • (string) –

      • outputLocation (dict) –

        The output location.

        • s3Bucket (string) –

          The S3 bucket for output.

        • s3Prefix (string) –

          The S3 folder in the s3Bucket where output files will be placed.

  • NextToken (string) –

    A token to resume pagination.