RoboMaker / Client / list_robot_applications

list_robot_applications#

RoboMaker.Client.list_robot_applications(**kwargs)#

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

Request Syntax

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

Parameters:

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

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

Response Structure

(dict) –
- robotApplicationSummaries (list) –
  
  A list of robot application summaries that meet the criteria of the request.
  - (dict) –
    
    Summary information for a robot application.
    - name (string) –
      
      The name of the robot application.
    - arn (string) –
      
      The Amazon Resource Name (ARN) of the robot.
    - version (string) –
      
      The version of the robot application.
    - lastUpdatedAt (datetime) –
      
      The time, in milliseconds since the epoch, when the robot 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).
- 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 ListRobotApplications 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