AWS RoboMaker

2021/04/30 - AWS RoboMaker - 10 updated api methods

Changes  Adds ROS2 Foxy as a supported Robot Software Suite Version and Gazebo 11 as a supported Simulation Software Suite Version

CreateRobotApplication (updated) Link ¶
Changes (both) 
{'robotSoftwareSuite': {'version': {'Foxy'}}}

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'
    }
)
type name:

string

param name:

[REQUIRED]

The name of the robot application.

type sources:

list

param sources:

[REQUIRED]

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

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'
    }
}

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

CreateRobotApplicationVersion (updated) Link ¶
Changes (response) 
{'robotSoftwareSuite': {'version': {'Foxy'}}}

Creates a version of a robot application.

See also: AWS API Documentation

Request Syntax

client.create_robot_application_version(
    application='string',
    currentRevisionId='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.

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'
}

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.

CreateSimulationApplication (updated) Link ¶
Changes (both) 
{'robotSoftwareSuite': {'version': {'Foxy'}}}

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'
    }
)
type name:

string

param name:

[REQUIRED]

The name of the simulation application.

type sources:

list

param sources:

[REQUIRED]

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

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'
    }
}

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

CreateSimulationApplicationVersion (updated) Link ¶
Changes (response) 
{'robotSoftwareSuite': {'version': {'Foxy'}}}

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

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'
}

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.

DescribeRobotApplication (updated) Link ¶
Changes (response) 
{'robotSoftwareSuite': {'version': {'Foxy'}}}

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'
    }
}

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

DescribeSimulationApplication (updated) Link ¶
Changes (response) 
{'robotSoftwareSuite': {'version': {'Foxy'}}}

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'
    }
}

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

ListRobotApplications (updated) Link ¶
Changes (response) 
{'robotApplicationSummaries': {'robotSoftwareSuite': {'version': {'Foxy'}}}}

Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications.

See also: AWS API Documentation

Request Syntax

client.list_robot_applications(
    versionQualifier='string',
    nextToken='string',
    maxResults=123,
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ]
)
type versionQualifier:

string

param versionQualifier:

The version qualifier of the robot application.

type nextToken:

string

param nextToken:

If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListRobotApplications again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

type maxResults:

integer

param maxResults:

When this parameter is used, ListRobotApplications only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListRobotApplications request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListRobotApplications returns up to 100 results and a nextToken value if applicable.

type filters:

list

param filters:

Optional filters to limit results.

The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.

  • (dict) --

    Information about a filter.

    • name (string) --

      The name of the filter.

    • values (list) --

      A list of values.

      • (string) --

rtype:

dict

returns:

Response Syntax

{
    'robotApplicationSummaries': [
        {
            'name': 'string',
            'arn': 'string',
            'version': 'string',
            'lastUpdatedAt': datetime(2015, 1, 1),
            'robotSoftwareSuite': {
                'name': 'ROS'|'ROS2',
                'version': 'Kinetic'|'Melodic'|'Dashing'|'Foxy'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • robotApplicationSummaries (list) --

      A list of robot application summaries that meet the criteria of the request.

      • (dict) --

        Summary information for a robot application.

        • name (string) --

          The name of the robot application.

        • arn (string) --

          The Amazon Resource Name (ARN) of the robot.

        • version (string) --

          The version of the robot application.

        • lastUpdatedAt (datetime) --

          The time, in milliseconds since the epoch, when the robot application was last updated.

        • robotSoftwareSuite (dict) --

          Information about a 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).

    • nextToken (string) --

      If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListRobotApplications again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

ListSimulationApplications (updated) Link ¶
Changes (response) 
{'simulationApplicationSummaries': {'robotSoftwareSuite': {'version': {'Foxy'}}}}

Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications.

See also: AWS API Documentation

Request Syntax

client.list_simulation_applications(
    versionQualifier='string',
    nextToken='string',
    maxResults=123,
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ]
)
type versionQualifier:

string

param versionQualifier:

The version qualifier of the simulation application.

type nextToken:

string

param nextToken:

If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationApplications again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

type maxResults:

integer

param maxResults:

When this parameter is used, ListSimulationApplications only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListSimulationApplications request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListSimulationApplications returns up to 100 results and a nextToken value if applicable.

type filters:

list

param filters:

Optional list of filters to limit results.

The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.

  • (dict) --

    Information about a filter.

    • name (string) --

      The name of the filter.

    • values (list) --

      A list of values.

      • (string) --

rtype:

dict

returns:

Response Syntax

{
    'simulationApplicationSummaries': [
        {
            'name': 'string',
            'arn': 'string',
            'version': 'string',
            'lastUpdatedAt': datetime(2015, 1, 1),
            'robotSoftwareSuite': {
                'name': 'ROS'|'ROS2',
                'version': 'Kinetic'|'Melodic'|'Dashing'|'Foxy'
            },
            'simulationSoftwareSuite': {
                'name': 'Gazebo'|'RosbagPlay',
                'version': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • simulationApplicationSummaries (list) --

      A list of simulation application summaries that meet the criteria of the request.

      • (dict) --

        Summary information for a simulation application.

        • name (string) --

          The name of the simulation application.

        • arn (string) --

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

        • version (string) --

          The version of the simulation application.

        • lastUpdatedAt (datetime) --

          The time, in milliseconds since the epoch, when the simulation application was last updated.

        • robotSoftwareSuite (dict) --

          Information about a 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).

        • simulationSoftwareSuite (dict) --

          Information about a simulation software suite.

          • name (string) --

            The name of the simulation software suite.

          • version (string) --

            The version of the simulation software suite.

    • nextToken (string) --

      If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationApplications again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

UpdateRobotApplication (updated) Link ¶
Changes (both) 
{'robotSoftwareSuite': {'version': {'Foxy'}}}

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'
)
type application:

string

param application:

[REQUIRED]

The application information for the robot application.

type sources:

list

param sources:

[REQUIRED]

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.

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'
}

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.

UpdateSimulationApplication (updated) Link ¶
Changes (both) 
{'robotSoftwareSuite': {'version': {'Foxy'}}}

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'
)
type application:

string

param application:

[REQUIRED]

The application information for the simulation application.

type sources:

list

param sources:

[REQUIRED]

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.

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'
}

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.