RoboMaker / Paginator / ListSimulationJobBatches

ListSimulationJobBatches

class RoboMaker.Paginator.ListSimulationJobBatches

paginator = client.get_paginator('list_simulation_job_batches')

paginate(**kwargs)

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

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.

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

{
    'simulationJobBatchSummaries': [
        {
            'arn': 'string',
            'lastUpdatedAt': datetime(2015, 1, 1),
            'createdAt': datetime(2015, 1, 1),
            'status': 'Pending'|'InProgress'|'Failed'|'Completed'|'Canceled'|'Canceling'|'Completing'|'TimingOut'|'TimedOut',
            'failedRequestCount': 123,
            'pendingRequestCount': 123,
            'createdRequestCount': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • simulationJobBatchSummaries (list) –

    A list of simulation job batch summaries.

    • (dict) –

      Information about a simulation job batch.

      • arn (string) –

        The Amazon Resource Name (ARN) of the batch.

      • lastUpdatedAt (datetime) –

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

      • createdAt (datetime) –

        The time, in milliseconds since the epoch, when the simulation job batch was created.

      • status (string) –

        The status of the simulation job batch.

        Pending

        The simulation job batch request is pending.

        InProgress

        The simulation job batch is in progress.

        Failed

        The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like InternalServiceError ). See failureCode and failureReason for more information.

        Completed

        The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to InternalServiceError and (2) when all created simulation jobs have reached a terminal state (for example, Completed or Failed ).

        Canceled

        The simulation batch job was cancelled.

        Canceling

        The simulation batch job is being cancelled.

        Completing

        The simulation batch job is completing.

        TimingOut

        The simulation job batch is timing out.

        If a batch timing out, and there are pending requests that were failing due to an internal failure (like InternalServiceError ), the batch status will be Failed . If there are no such failing request, the batch status will be TimedOut .

        TimedOut

        The simulation batch job timed out.

      • failedRequestCount (integer) –

        The number of failed simulation job requests.

      • pendingRequestCount (integer) –

        The number of pending simulation job requests.

      • createdRequestCount (integer) –

        The number of created simulation job requests.

  • NextToken (string) –

    A token to resume pagination.