RoboMaker / Paginator / ListRobotApplications

ListRobotApplications

class RoboMaker.Paginator.ListRobotApplications

paginator = client.get_paginator('list_robot_applications')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    versionQualifier='string',
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• versionQualifier (string) – The version qualifier of the robot application.

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

• 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

{
    '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.

        • name (string) –

          The name of the robot software suite. General is the only supported value.

        • version (string) –

          The version of the robot software suite. Not applicable for General software suite.

  • NextToken (string) –

    A token to resume pagination.