RoboMaker / Paginator / ListRobots

ListRobots

class RoboMaker.Paginator.ListRobots

paginator = client.get_paginator('list_robots')

paginate(**kwargs)

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

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

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.

  The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Registered or the status Available.

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

{
    'robots': [
        {
            'arn': 'string',
            'name': 'string',
            'fleetArn': 'string',
            'status': 'Available'|'Registered'|'PendingNewDeployment'|'Deploying'|'Failed'|'InSync'|'NoResponse',
            'greenGrassGroupId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'architecture': 'X86_64'|'ARM64'|'ARMHF',
            'lastDeploymentJob': 'string',
            'lastDeploymentTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • robots (list) –

    A list of robots that meet the criteria of the request.

    • (dict) –

      Information about a robot.

      • arn (string) –

        The Amazon Resource Name (ARN) of the robot.

      • name (string) –

        The name of the robot.

      • fleetArn (string) –

        The Amazon Resource Name (ARN) of the fleet.

      • status (string) –

        The status of the robot.

      • greenGrassGroupId (string) –

        The Greengrass group associated with the robot.

      • createdAt (datetime) –

        The time, in milliseconds since the epoch, when the robot was created.

      • architecture (string) –

        The architecture of the robot.

      • lastDeploymentJob (string) –

        The Amazon Resource Name (ARN) of the last deployment job.

      • lastDeploymentTime (datetime) –

        The time of the last deployment.

  • NextToken (string) –

    A token to resume pagination.