RoboMaker / Client / describe_robot_application

describe_robot_application#

RoboMaker.Client.describe_robot_application(**kwargs)#

Describes a robot application.

Request Syntax

response = client.describe_robot_application(
    application='string',
    applicationVersion='string'
)

Parameters:

application (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the robot application.
applicationVersion (string) – The version of the robot application to describe.

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'name': 'string',
    'version': 'string',
    'sources': [
        {
            's3Bucket': 'string',
            's3Key': 'string',
            'etag': 'string',
            'architecture': 'X86_64'|'ARM64'|'ARMHF'
        },
    ],
    'robotSoftwareSuite': {
        'name': 'ROS'|'ROS2'|'General',
        'version': 'Kinetic'|'Melodic'|'Dashing'|'Foxy'
    },
    'revisionId': 'string',
    'lastUpdatedAt': datetime(2015, 1, 1),
    'tags': {
        'string': 'string'
    },
    'environment': {
        'uri': 'string'
    },
    'imageDigest': 'string'
}

Response Structure

(dict) –
- arn (string) –
  
  The Amazon Resource Name (ARN) of the robot application.
- name (string) –
  
  The name of the robot application.
- version (string) –
  
  The version of the robot application.
- sources (list) –
  
  The sources of the robot application.
  - (dict) –
    
    Information about a source.
    - s3Bucket (string) –
      
      The s3 bucket name.
    - s3Key (string) –
      
      The s3 object key.
    - etag (string) –
      
      A hash of the object specified by s3Bucket and s3Key.
    - architecture (string) –
      
      The taget processor architecture for the application.
- robotSoftwareSuite (dict) –
  
  The robot software suite (ROS distribution) used by the robot application.
  - name (string) –
    
    The name of the robot software suite (ROS distribution).
  - version (string) –
    
    The version of the robot software suite (ROS distribution).
- revisionId (string) –
  
  The revision id of the robot application.
- lastUpdatedAt (datetime) –
  
  The time, in milliseconds since the epoch, when the robot application was last updated.
- tags (dict) –
  
  The list of all tags added to the specified robot application.
  - (string) –
    - (string) –
- environment (dict) –
  
  The object that contains the Docker image URI used to create the robot application.
  - uri (string) –
    
    The Docker image URI for either your robot or simulation applications.
- imageDigest (string) –
  
  A SHA256 identifier for the Docker image that you use for your robot application.

Exceptions

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