AWS API Changes

2021/09/16 - AWS RoboMaker - 8 updated api methods

Changes Adding support to create container based Robot and Simulation applications by introducing an environment field

CreateRobotApplication (updated)

Link ¶
Changes (both)

{'environment': {'uri': 'string'}}

Creates a robot application.

See also: AWS API Documentation

Request Syntax

client.create_robot_application(
    name='string',
    sources=[
        {
            's3Bucket': 'string',
            's3Key': 'string',
            'architecture': 'X86_64'|'ARM64'|'ARMHF'
        },
    ],
    robotSoftwareSuite={
        'name': 'ROS'|'ROS2',
        'version': 'Kinetic'|'Melodic'|'Dashing'|'Foxy'
    },
    tags={
        'string': 'string'
    },
    environment={
        'uri': 'string'
    }
)

type name:

string

param name:

[REQUIRED]

The name of the robot application.

type sources:

list

param sources:

The sources of the robot application.

(dict) --

Information about a source configuration.
- s3Bucket (string) --
  
  The Amazon S3 bucket name.
- s3Key (string) --
  
  The s3 object key.
- architecture (string) --
  
  The target processor architecture for the application.

type robotSoftwareSuite:

dict

param robotSoftwareSuite:

[REQUIRED]

The robot software suite (ROS distribuition) 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).

type tags:

dict

param tags:

A map that contains tag keys and tag values that are attached to the robot application.

(string) --
- (string) --

type environment:

dict

param environment:

The object that contains that URI of the Docker image that you use for your robot application.

uri (string) --

The Docker image URI for either your robot or simulation applications.

rtype:

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',
        'version': 'Kinetic'|'Melodic'|'Dashing'|'Foxy'
    },
    'lastUpdatedAt': datetime(2015, 1, 1),
    'revisionId': 'string',
    'tags': {
        'string': 'string'
    },
    'environment': {
        'uri': '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).
- lastUpdatedAt (datetime) --
  
  The time, in milliseconds since the epoch, when the robot application was last updated.
- revisionId (string) --
  
  The revision id of the robot application.
- tags (dict) --
  
  The list of all tags added to the robot application.
  - (string) --
    - (string) --
- environment (dict) --
  
  An object that contains the Docker image URI used to a create your robot application.
  - uri (string) --
    
    The Docker image URI for either your robot or simulation applications.

CreateRobotApplicationVersion (updated)

Link ¶
Changes (request, response)
Request

{'imageDigest': 'string', 's3Etags': ['string']}

Response

{'environment': {'uri': 'string'}}

Creates a version of a robot application.

See also: AWS API Documentation

Request Syntax

client.create_robot_application_version(
    application='string',
    currentRevisionId='string',
    s3Etags=[
        'string',
    ],
    imageDigest='string'
)

type application:

string

param application:

[REQUIRED]

The application information for the robot application.

type currentRevisionId:

string

param currentRevisionId:

The current revision id for the robot application. If you provide a value and it matches the latest revision ID, a new version will be created.

type s3Etags:

list

param s3Etags:

The Amazon S3 identifier for the zip file bundle that you use for your robot application.

(string) --

type imageDigest:

string

param imageDigest:

A SHA256 identifier for the Docker image that you use for your robot application.

rtype:

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',
        'version': 'Kinetic'|'Melodic'|'Dashing'|'Foxy'
    },
    'lastUpdatedAt': datetime(2015, 1, 1),
    'revisionId': 'string',
    'environment': {
        'uri': '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).
- lastUpdatedAt (datetime) --
  
  The time, in milliseconds since the epoch, when the robot application was last updated.
- revisionId (string) --
  
  The revision id of the robot application.
- environment (dict) --
  
  The object that contains the Docker image URI used to create your robot application.
  - uri (string) --
    
    The Docker image URI for either your robot or simulation applications.

CreateSimulationApplication (updated)

Link ¶
Changes (both)

{'environment': {'uri': 'string'}}

Creates a simulation application.

See also: AWS API Documentation

Request Syntax

client.create_simulation_application(
    name='string',
    sources=[
        {
            's3Bucket': 'string',
            's3Key': 'string',
            'architecture': 'X86_64'|'ARM64'|'ARMHF'
        },
    ],
    simulationSoftwareSuite={
        'name': 'Gazebo'|'RosbagPlay',
        'version': 'string'
    },
    robotSoftwareSuite={
        'name': 'ROS'|'ROS2',
        'version': 'Kinetic'|'Melodic'|'Dashing'|'Foxy'
    },
    renderingEngine={
        'name': 'OGRE',
        'version': 'string'
    },
    tags={
        'string': 'string'
    },
    environment={
        'uri': 'string'
    }
)

type name:

string

param name:

[REQUIRED]

The name of the simulation application.

type sources:

list

param sources:

The sources of the simulation application.

(dict) --

Information about a source configuration.
- s3Bucket (string) --
  
  The Amazon S3 bucket name.
- s3Key (string) --
  
  The s3 object key.
- architecture (string) --
  
  The target processor architecture for the application.

type simulationSoftwareSuite:

dict

param simulationSoftwareSuite:

[REQUIRED]

The simulation software suite used by the simulation application.

name (string) --

The name of the simulation software suite.
version (string) --

The version of the simulation software suite.

type robotSoftwareSuite:

dict

param robotSoftwareSuite:

[REQUIRED]

The robot software suite (ROS distribution) used by the simulation application.

name (string) --

The name of the robot software suite (ROS distribution).
version (string) --

The version of the robot software suite (ROS distribution).

type renderingEngine:

dict

param renderingEngine:

The rendering engine for the simulation application.

name (string) --

The name of the rendering engine.
version (string) --

The version of the rendering engine.

type tags:

dict

param tags:

A map that contains tag keys and tag values that are attached to the simulation application.

(string) --
- (string) --

type environment:

dict

param environment:

The object that contains the Docker image URI used to create your simulation application.

uri (string) --

The Docker image URI for either your robot or simulation applications.

rtype:

dict

returns:

Response Syntax

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

Response Structure

(dict) --
- arn (string) --
  
  The Amazon Resource Name (ARN) of the simulation application.
- name (string) --
  
  The name of the simulation application.
- version (string) --
  
  The version of the simulation application.
- sources (list) --
  
  The sources of the simulation 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.
- simulationSoftwareSuite (dict) --
  
  The simulation software suite used by the simulation application.
  - name (string) --
    
    The name of the simulation software suite.
  - version (string) --
    
    The version of the simulation software suite.
- robotSoftwareSuite (dict) --
  
  Information about the robot software suite (ROS distribution).
  - name (string) --
    
    The name of the robot software suite (ROS distribution).
  - version (string) --
    
    The version of the robot software suite (ROS distribution).
- renderingEngine (dict) --
  
  The rendering engine for the simulation application.
  - name (string) --
    
    The name of the rendering engine.
  - version (string) --
    
    The version of the rendering engine.
- lastUpdatedAt (datetime) --
  
  The time, in milliseconds since the epoch, when the simulation application was last updated.
- revisionId (string) --
  
  The revision id of the simulation application.
- tags (dict) --
  
  The list of all tags added to the simulation application.
  - (string) --
    - (string) --
- environment (dict) --
  
  The object that contains the Docker image URI that you used to create your simulation application.
  - uri (string) --
    
    The Docker image URI for either your robot or simulation applications.

CreateSimulationApplicationVersion (updated)

Link ¶
Changes (request, response)
Request

{'imageDigest': 'string', 's3Etags': ['string']}

Response

{'environment': {'uri': 'string'}}

Creates a simulation application with a specific revision id.

See also: AWS API Documentation

Request Syntax

client.create_simulation_application_version(
    application='string',
    currentRevisionId='string',
    s3Etags=[
        'string',
    ],
    imageDigest='string'
)

type application:

string

param application:

[REQUIRED]

The application information for the simulation application.

type currentRevisionId:

string

param currentRevisionId:

The current revision id for the simulation application. If you provide a value and it matches the latest revision ID, a new version will be created.

type s3Etags:

list

param s3Etags:

The Amazon S3 eTag identifier for the zip file bundle that you use to create the simulation application.

(string) --

type imageDigest:

string

param imageDigest:

The SHA256 digest used to identify the Docker image URI used to created the simulation application.

rtype:

dict

returns:

Response Syntax

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

Response Structure

(dict) --
- arn (string) --
  
  The Amazon Resource Name (ARN) of the simulation application.
- name (string) --
  
  The name of the simulation application.
- version (string) --
  
  The version of the simulation application.
- sources (list) --
  
  The sources of the simulation 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.
- simulationSoftwareSuite (dict) --
  
  The simulation software suite used by the simulation application.
  - name (string) --
    
    The name of the simulation software suite.
  - version (string) --
    
    The version of the simulation software suite.
- robotSoftwareSuite (dict) --
  
  Information about the robot software suite (ROS distribution).
  - name (string) --
    
    The name of the robot software suite (ROS distribution).
  - version (string) --
    
    The version of the robot software suite (ROS distribution).
- renderingEngine (dict) --
  
  The rendering engine for the simulation application.
  - name (string) --
    
    The name of the rendering engine.
  - version (string) --
    
    The version of the rendering engine.
- lastUpdatedAt (datetime) --
  
  The time, in milliseconds since the epoch, when the simulation application was last updated.
- revisionId (string) --
  
  The revision ID of the simulation application.
- environment (dict) --
  
  The object that contains the Docker image URI used to create the simulation application.
  - uri (string) --
    
    The Docker image URI for either your robot or simulation applications.

DescribeRobotApplication (updated)

Link ¶
Changes (response)

{'environment': {'uri': 'string'}, 'imageDigest': 'string'}

Describes a robot application.

See also: AWS API Documentation

Request Syntax

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

type application:

string

param application:

[REQUIRED]

The Amazon Resource Name (ARN) of the robot application.

type applicationVersion:

string

param applicationVersion:

The version of the robot application to describe.

rtype:

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',
        '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.

DescribeSimulationApplication (updated)

Link ¶
Changes (response)

{'environment': {'uri': 'string'}, 'imageDigest': 'string'}

Describes a simulation application.

See also: AWS API Documentation

Request Syntax

client.describe_simulation_application(
    application='string',
    applicationVersion='string'
)

type application:

string

param application:

[REQUIRED]

The application information for the simulation application.

type applicationVersion:

string

param applicationVersion:

The version of the simulation application to describe.

rtype:

dict

returns:

Response Syntax

{
    'arn': 'string',
    'name': 'string',
    'version': 'string',
    'sources': [
        {
            's3Bucket': 'string',
            's3Key': 'string',
            'etag': 'string',
            'architecture': 'X86_64'|'ARM64'|'ARMHF'
        },
    ],
    'simulationSoftwareSuite': {
        'name': 'Gazebo'|'RosbagPlay',
        'version': 'string'
    },
    'robotSoftwareSuite': {
        'name': 'ROS'|'ROS2',
        'version': 'Kinetic'|'Melodic'|'Dashing'|'Foxy'
    },
    'renderingEngine': {
        'name': 'OGRE',
        'version': 'string'
    },
    '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 simulation application.
- name (string) --
  
  The name of the simulation application.
- version (string) --
  
  The version of the simulation application.
- sources (list) --
  
  The sources of the simulation 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.
- simulationSoftwareSuite (dict) --
  
  The simulation software suite used by the simulation application.
  - name (string) --
    
    The name of the simulation software suite.
  - version (string) --
    
    The version of the simulation software suite.
- robotSoftwareSuite (dict) --
  
  Information about the robot software suite (ROS distribution).
  - name (string) --
    
    The name of the robot software suite (ROS distribution).
  - version (string) --
    
    The version of the robot software suite (ROS distribution).
- renderingEngine (dict) --
  
  The rendering engine for the simulation application.
  - name (string) --
    
    The name of the rendering engine.
  - version (string) --
    
    The version of the rendering engine.
- revisionId (string) --
  
  The revision id of the simulation application.
- lastUpdatedAt (datetime) --
  
  The time, in milliseconds since the epoch, when the simulation application was last updated.
- tags (dict) --
  
  The list of all tags added to the specified simulation application.
  - (string) --
    - (string) --
- environment (dict) --
  
  The object that contains the Docker image URI used to create the simulation 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 simulation application.

UpdateRobotApplication (updated)

Link ¶
Changes (both)

{'environment': {'uri': 'string'}}

Updates a robot application.

See also: AWS API Documentation

Request Syntax

client.update_robot_application(
    application='string',
    sources=[
        {
            's3Bucket': 'string',
            's3Key': 'string',
            'architecture': 'X86_64'|'ARM64'|'ARMHF'
        },
    ],
    robotSoftwareSuite={
        'name': 'ROS'|'ROS2',
        'version': 'Kinetic'|'Melodic'|'Dashing'|'Foxy'
    },
    currentRevisionId='string',
    environment={
        'uri': 'string'
    }
)

type application:

string

param application:

[REQUIRED]

The application information for the robot application.

type sources:

list

param sources:

The sources of the robot application.

(dict) --

Information about a source configuration.
- s3Bucket (string) --
  
  The Amazon S3 bucket name.
- s3Key (string) --
  
  The s3 object key.
- architecture (string) --
  
  The target processor architecture for the application.

type robotSoftwareSuite:

dict

param robotSoftwareSuite:

[REQUIRED]

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

type currentRevisionId:

string

param currentRevisionId:

The revision id for the robot application.

type environment:

dict

param environment:

The object that contains the Docker image URI for your robot application.

uri (string) --

The Docker image URI for either your robot or simulation applications.

rtype:

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',
        'version': 'Kinetic'|'Melodic'|'Dashing'|'Foxy'
    },
    'lastUpdatedAt': datetime(2015, 1, 1),
    'revisionId': 'string',
    'environment': {
        'uri': 'string'
    }
}

Response Structure

(dict) --
- arn (string) --
  
  The Amazon Resource Name (ARN) of the updated 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).
- lastUpdatedAt (datetime) --
  
  The time, in milliseconds since the epoch, when the robot application was last updated.
- revisionId (string) --
  
  The revision id of the robot application.
- environment (dict) --
  
  The object that contains the Docker image URI for your robot application.
  - uri (string) --
    
    The Docker image URI for either your robot or simulation applications.

UpdateSimulationApplication (updated)

Link ¶
Changes (both)

{'environment': {'uri': 'string'}}

Updates a simulation application.

See also: AWS API Documentation

Request Syntax

client.update_simulation_application(
    application='string',
    sources=[
        {
            's3Bucket': 'string',
            's3Key': 'string',
            'architecture': 'X86_64'|'ARM64'|'ARMHF'
        },
    ],
    simulationSoftwareSuite={
        'name': 'Gazebo'|'RosbagPlay',
        'version': 'string'
    },
    robotSoftwareSuite={
        'name': 'ROS'|'ROS2',
        'version': 'Kinetic'|'Melodic'|'Dashing'|'Foxy'
    },
    renderingEngine={
        'name': 'OGRE',
        'version': 'string'
    },
    currentRevisionId='string',
    environment={
        'uri': 'string'
    }
)

type application:

string

param application:

[REQUIRED]

The application information for the simulation application.

type sources:

list

param sources:

The sources of the simulation application.

(dict) --

Information about a source configuration.
- s3Bucket (string) --
  
  The Amazon S3 bucket name.
- s3Key (string) --
  
  The s3 object key.
- architecture (string) --
  
  The target processor architecture for the application.

type simulationSoftwareSuite:

dict

param simulationSoftwareSuite:

[REQUIRED]

The simulation software suite used by the simulation application.

name (string) --

The name of the simulation software suite.
version (string) --

The version of the simulation software suite.

type robotSoftwareSuite:

dict

param robotSoftwareSuite:

[REQUIRED]

Information about the robot software suite (ROS distribution).

name (string) --

The name of the robot software suite (ROS distribution).
version (string) --

The version of the robot software suite (ROS distribution).

type renderingEngine:

dict

param renderingEngine:

The rendering engine for the simulation application.

name (string) --

The name of the rendering engine.
version (string) --

The version of the rendering engine.

type currentRevisionId:

string

param currentRevisionId:

The revision id for the robot application.

type environment:

dict

param environment:

The object that contains the Docker image URI for your simulation application.

uri (string) --

The Docker image URI for either your robot or simulation applications.

rtype:

dict

returns:

Response Syntax

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

Response Structure

(dict) --
- arn (string) --
  
  The Amazon Resource Name (ARN) of the updated simulation application.
- name (string) --
  
  The name of the simulation application.
- version (string) --
  
  The version of the robot application.
- sources (list) --
  
  The sources of the simulation 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.
- simulationSoftwareSuite (dict) --
  
  The simulation software suite used by the simulation application.
  - name (string) --
    
    The name of the simulation software suite.
  - version (string) --
    
    The version of the simulation software suite.
- robotSoftwareSuite (dict) --
  
  Information about the robot software suite (ROS distribution).
  - name (string) --
    
    The name of the robot software suite (ROS distribution).
  - version (string) --
    
    The version of the robot software suite (ROS distribution).
- renderingEngine (dict) --
  
  The rendering engine for the simulation application.
  - name (string) --
    
    The name of the rendering engine.
  - version (string) --
    
    The version of the rendering engine.
- lastUpdatedAt (datetime) --
  
  The time, in milliseconds since the epoch, when the simulation application was last updated.
- revisionId (string) --
  
  The revision id of the simulation application.
- environment (dict) --
  
  The object that contains the Docker image URI used for your simulation application.
  - uri (string) --
    
    The Docker image URI for either your robot or simulation applications.