RoboMaker / Client / describe_robot

describe_robot

RoboMaker.Client.describe_robot(**kwargs)

Describes a robot.

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.describe_robot(
    robot='string'
)

Parameters:

robot (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the robot to be described.

Return type:

dict

Returns:

Response Syntax

{
    '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),
    'tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) –

  • 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 fleet.

  • greengrassGroupId (string) –

    The Greengrass group id.

  • createdAt (datetime) –

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

  • architecture (string) –

    The target architecture of the robot application.

  • lastDeploymentJob (string) –

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

  • lastDeploymentTime (datetime) –

    The time of the last deployment job.

  • tags (dict) –

    The list of all tags added to the specified robot.

    • (string) –

      • (string) –

Exceptions

• RoboMaker.Client.exceptions.ResourceNotFoundException

• RoboMaker.Client.exceptions.InvalidParameterException

• RoboMaker.Client.exceptions.InternalServerException

• RoboMaker.Client.exceptions.ThrottlingException