RoboMaker / Paginator / ListSimulationJobs

ListSimulationJobs

class RoboMaker.Paginator.ListSimulationJobs

paginator = client.get_paginator('list_simulation_jobs')

paginate(**kwargs)

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

  The filter names status and simulationApplicationName and robotApplicationName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Preparing or the status Running.

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

{
    'simulationJobSummaries': [
        {
            'arn': 'string',
            'lastUpdatedAt': datetime(2015, 1, 1),
            'name': 'string',
            'status': 'Pending'|'Preparing'|'Running'|'Restarting'|'Completed'|'Failed'|'RunningFailed'|'Terminating'|'Terminated'|'Canceled',
            'simulationApplicationNames': [
                'string',
            ],
            'robotApplicationNames': [
                'string',
            ],
            'dataSourceNames': [
                'string',
            ],
            'computeType': 'CPU'|'GPU_AND_CPU'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • simulationJobSummaries (list) –

    A list of simulation job summaries that meet the criteria of the request.

    • (dict) –

      Summary information for a simulation job.

      • arn (string) –

        The Amazon Resource Name (ARN) of the simulation job.

      • lastUpdatedAt (datetime) –

        The time, in milliseconds since the epoch, when the simulation job was last updated.

      • name (string) –

        The name of the simulation job.

      • status (string) –

        The status of the simulation job.

      • simulationApplicationNames (list) –

        A list of simulation job simulation application names.

        • (string) –

      • robotApplicationNames (list) –

        A list of simulation job robot application names.

        • (string) –

      • dataSourceNames (list) –

        The names of the data sources.

        • (string) –

      • computeType (string) –

        The compute type for the simulation job summary.

  • NextToken (string) –

    A token to resume pagination.