create_simulation_application¶

RoboMaker.Client.create_simulation_application(**kwargs)¶

Creates a simulation application.

Request Syntax

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

Parameters

name (string) --
[REQUIRED]

The name of the simulation application.
sources (list) --
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.
simulationSoftwareSuite (dict) --
[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.
robotSoftwareSuite (dict) --
[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).
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.
tags (dict) --
A map that contains tag keys and tag values that are attached to the simulation application.
- (string) --
  - (string) --
environment (dict) --
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.

Return type

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'|'SimulationRuntime',
        'version': 'string'
    },
    'robotSoftwareSuite': {
        'name': 'ROS'|'ROS2'|'General',
        '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.

Exceptions

RoboMaker.Client.exceptions.InvalidParameterException
RoboMaker.Client.exceptions.ResourceAlreadyExistsException
RoboMaker.Client.exceptions.LimitExceededException
RoboMaker.Client.exceptions.ThrottlingException
RoboMaker.Client.exceptions.InternalServerException
RoboMaker.Client.exceptions.IdempotentParameterMismatchException

Table Of Contents

create_simulation_application¶