RoboMaker / Client / describe_fleet

describe_fleet#

RoboMaker.Client.describe_fleet(**kwargs)#

Describes a fleet.

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.

Request Syntax

response = client.describe_fleet(
    fleet='string'
)

Parameters:

fleet (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the fleet.

Return type:

dict

Returns:

Response Syntax

{
    'name': 'string',
    'arn': 'string',
    '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)
        },
    ],
    'createdAt': datetime(2015, 1, 1),
    'lastDeploymentStatus': 'Pending'|'Preparing'|'InProgress'|'Failed'|'Succeeded'|'Canceled',
    'lastDeploymentJob': 'string',
    'lastDeploymentTime': datetime(2015, 1, 1),
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) –
- name (string) –
  
  The name of the fleet.
- arn (string) –
  
  The Amazon Resource Name (ARN) of the fleet.
- robots (list) –
  
  A list of robots.
  - (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.
- createdAt (datetime) –
  
  The time, in milliseconds since the epoch, when the fleet was created.
- lastDeploymentStatus (string) –
  
  The status of the last deployment.
- lastDeploymentJob (string) –
  
  The Amazon Resource Name (ARN) of the last deployment job.
- lastDeploymentTime (datetime) –
  
  The time of the last deployment.
- tags (dict) –
  
  The list of all tags added to the specified fleet.
  - (string) –
    - (string) –

Exceptions

RoboMaker.Client.exceptions.ResourceNotFoundException
RoboMaker.Client.exceptions.InvalidParameterException
RoboMaker.Client.exceptions.InternalServerException
RoboMaker.Client.exceptions.ThrottlingException