RoboMaker / Client / list_robots

list_robots

RoboMaker.Client.list_robots(**kwargs)

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

Warning

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

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 = client.list_robots(
    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 ListRobots 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, ListRobots 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 ListRobots request with the returned nextToken value. This value can be between 1 and 200. If this parameter is not used, then ListRobots returns up to 200 results and a nextToken value if applicable.

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

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

    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 ListRobots 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.ResourceNotFoundException

• RoboMaker.Client.exceptions.InvalidParameterException

• RoboMaker.Client.exceptions.InternalServerException

• RoboMaker.Client.exceptions.ThrottlingException