RoboMaker / Client / list_simulation_applications

list_simulation_applications#

RoboMaker.Client.list_simulation_applications(**kwargs)#

Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications.

Request Syntax

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

Parameters:

versionQualifier (string) – The version qualifier of the simulation application.
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 ListSimulationApplications 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, ListSimulationApplications 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 ListSimulationApplications request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListSimulationApplications returns up to 100 results and a nextToken value if applicable.
filters (list) –
Optional list of filters to limit results.

The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.
- (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

{
    'simulationApplicationSummaries': [
        {
            'name': 'string',
            'arn': 'string',
            'version': 'string',
            'lastUpdatedAt': datetime(2015, 1, 1),
            'robotSoftwareSuite': {
                'name': 'ROS'|'ROS2'|'General',
                'version': 'Kinetic'|'Melodic'|'Dashing'|'Foxy'
            },
            'simulationSoftwareSuite': {
                'name': 'Gazebo'|'RosbagPlay'|'SimulationRuntime',
                'version': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- simulationApplicationSummaries (list) –
  
  A list of simulation application summaries that meet the criteria of the request.
  - (dict) –
    
    Summary information for a simulation application.
    - name (string) –
      
      The name of the simulation application.
    - arn (string) –
      
      The Amazon Resource Name (ARN) of the simulation application.
    - version (string) –
      
      The version of the simulation application.
    - lastUpdatedAt (datetime) –
      
      The time, in milliseconds since the epoch, when the simulation application was last updated.
    - robotSoftwareSuite (dict) –
      
      Information about a robot software suite (ROS distribution).
      - name (string) –
        
        The name of the robot software suite (ROS distribution).
      - version (string) –
        
        The version of the robot software suite (ROS distribution).
    - simulationSoftwareSuite (dict) –
      
      Information about a simulation software suite.
      - name (string) –
        
        The name of the simulation software suite.
      - version (string) –
        
        The version of the simulation software suite.
- 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 ListSimulationApplications 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.ThrottlingException
RoboMaker.Client.exceptions.InternalServerException