RoboMaker / Client / list_simulation_job_batches

list_simulation_job_batches#

RoboMaker.Client.list_simulation_job_batches(**kwargs)#

Returns a list simulation job batches. You can optionally provide filters to retrieve specific simulation batch jobs.

Request Syntax

response = client.list_simulation_job_batches(
    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 ListSimulationJobBatches 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, ListSimulationJobBatches 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 ListSimulationJobBatches request with the returned nextToken value.
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) –

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

RoboMaker.Client.exceptions.InvalidParameterException
RoboMaker.Client.exceptions.InternalServerException