RoboMaker / Client / describe_simulation_application

describe_simulation_application

RoboMaker.Client.describe_simulation_application(**kwargs)

Warning

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.

Describes a simulation application.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• application (string) –

  [REQUIRED]

  The application information for the simulation application.

• applicationVersion (string) – The version of the simulation 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'
        },
    ],
    'simulationSoftwareSuite': {
        'name': 'Gazebo'|'RosbagPlay'|'SimulationRuntime',
        'version': 'string'
    },
    'robotSoftwareSuite': {
        'name': 'ROS'|'ROS2'|'General',
        '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. SimulationRuntime is the only supported value.

    • version (string) –

      The version of the simulation software suite. Not applicable for SimulationRuntime.

  • robotSoftwareSuite (dict) –

    Information about the robot software suite.

    • name (string) –

      The name of the robot software suite. General is the only supported value.

    • version (string) –

      The version of the robot software suite. Not applicable for General software suite.

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

Exceptions

• RoboMaker.Client.exceptions.InvalidParameterException

• RoboMaker.Client.exceptions.ResourceNotFoundException

• RoboMaker.Client.exceptions.ThrottlingException

• RoboMaker.Client.exceptions.InternalServerException