@datafire/amazonaws_robomaker

DataFire integration for AWS RoboMaker

Usage no npm install needed!

<script type="module">
  import datafireAmazonawsRobomaker from 'https://cdn.skypack.dev/@datafire/amazonaws_robomaker';
</script>

README

@datafire/amazonaws_robomaker

Client library for AWS RoboMaker

Installation and Usage

npm install --save @datafire/amazonaws_robomaker

let amazonaws_robomaker = require('@datafire/amazonaws_robomaker').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

This section provides documentation for the AWS RoboMaker API operations.

Actions

BatchDeleteWorlds

amazonaws_robomaker.BatchDeleteWorlds({
  "worlds": []
}, context)

Input

  • input object
    • worlds required array: A list of Amazon Resource Names (arns) that correspond to worlds to delete.

Output

BatchDescribeSimulationJob

amazonaws_robomaker.BatchDescribeSimulationJob({
  "jobs": []
}, context)

Input

  • input object
    • jobs required array: A list of Amazon Resource Names (ARNs) of simulation jobs to describe.

Output

CancelDeploymentJob

amazonaws_robomaker.CancelDeploymentJob({
  "job": ""
}, context)

Input

  • input object
    • job required string: The deployment job ARN to cancel.

Output

CancelSimulationJob

amazonaws_robomaker.CancelSimulationJob({
  "job": ""
}, context)

Input

  • input object
    • job required string: The simulation job ARN to cancel.

Output

CancelSimulationJobBatch

amazonaws_robomaker.CancelSimulationJobBatch({
  "batch": ""
}, context)

Input

  • input object
    • batch required string: The id of the batch to cancel.

Output

CancelWorldExportJob

amazonaws_robomaker.CancelWorldExportJob({
  "job": ""
}, context)

Input

  • input object
    • job required string: The Amazon Resource Name (arn) of the world export job to cancel.

Output

CancelWorldGenerationJob

amazonaws_robomaker.CancelWorldGenerationJob({
  "job": ""
}, context)

Input

  • input object
    • job required string: The Amazon Resource Name (arn) of the world generator job to cancel.

Output

CreateDeploymentJob

amazonaws_robomaker.CreateDeploymentJob({
  "clientRequestToken": "",
  "fleet": "",
  "deploymentApplicationConfigs": []
}, context)

Input

  • input object
    • tags object: A map that contains tag keys and tag values that are attached to the deployment job.
    • clientRequestToken required string: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
    • deploymentApplicationConfigs required array: The deployment application configuration.
    • deploymentConfig object: Information about a deployment configuration.
      • concurrentDeploymentPercentage
      • downloadConditionFile
        • bucket required
        • etag
        • key required
      • failureThresholdPercentage
      • robotDeploymentTimeoutInSeconds
    • fleet required string: The Amazon Resource Name (ARN) of the fleet to deploy.

Output

CreateFleet

amazonaws_robomaker.CreateFleet({
  "name": ""
}, context)

Input

  • input object
    • tags object: A map that contains tag keys and tag values that are attached to the fleet.
    • name required string: The name of the fleet.

Output

CreateRobot

amazonaws_robomaker.CreateRobot({
  "name": "",
  "architecture": "",
  "greengrassGroupId": ""
}, context)

Input

  • input object
    • tags object: A map that contains tag keys and tag values that are attached to the robot.
    • architecture required string (values: X86_64, ARM64, ARMHF): The target architecture of the robot.
    • greengrassGroupId required string: The Greengrass group id.
    • name required string: The name for the robot.

Output

CreateRobotApplication

amazonaws_robomaker.CreateRobotApplication({
  "name": "",
  "sources": [],
  "robotSoftwareSuite": {}
}, context)

Input

  • input object
    • tags object: A map that contains tag keys and tag values that are attached to the robot application.
    • name required string: The name of the robot application.
    • robotSoftwareSuite required object: Information about a robot software suite (ROS distribution).
      • name
      • version
    • sources required array: The sources of the robot application.

Output

CreateRobotApplicationVersion

amazonaws_robomaker.CreateRobotApplicationVersion({
  "application": ""
}, context)

Input

  • input object
    • application required string: The application information for the robot application.
    • currentRevisionId string: 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.

Output

CreateSimulationApplication

amazonaws_robomaker.CreateSimulationApplication({
  "name": "",
  "sources": [],
  "simulationSoftwareSuite": {},
  "robotSoftwareSuite": {}
}, context)

Input

  • input object
    • tags object: A map that contains tag keys and tag values that are attached to the simulation application.
    • name required string: The name of the simulation application.
    • renderingEngine object: Information about a rendering engine.
      • name
      • version
    • robotSoftwareSuite required object: Information about a robot software suite (ROS distribution).
      • name
      • version
    • simulationSoftwareSuite required object: Information about a simulation software suite.
      • name
      • version
    • sources required array: The sources of the simulation application.

Output

CreateSimulationApplicationVersion

amazonaws_robomaker.CreateSimulationApplicationVersion({
  "application": ""
}, context)

Input

  • input object
    • application required string: The application information for the simulation application.
    • currentRevisionId string: 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.

Output

CreateSimulationJob

amazonaws_robomaker.CreateSimulationJob({
  "maxJobDurationInSeconds": 0,
  "iamRole": ""
}, context)

Input

  • input object
    • tags object: A map that contains tag keys and tag values that are attached to the simulation job.
    • clientRequestToken string: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
    • compute object: Compute information for the simulation job.
      • simulationUnitLimit
    • dataSources array:

      Specify data sources to mount read-only files from S3 into your simulation. These files are available under /opt/robomaker/datasources/data_source_name.

      There is a limit of 100 files and a combined size of 25GB for all DataSourceConfig objects.

    • failureBehavior string (values: Fail, Continue):

      The failure behavior the simulation job.

      Continue

      Restart the simulation job in the same host instance.

      Fail

      Stop the simulation job and terminate the instance.

    • iamRole required string: The IAM role name that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job.
    • loggingConfig object: The logging configuration.
      • recordAllRosTopics
    • maxJobDurationInSeconds required integer: The maximum simulation job duration in seconds (up to 14 days or 1,209,600 seconds. When maxJobDurationInSeconds is reached, the simulation job will status will transition to Completed.
    • outputLocation object: The output location.
      • s3Bucket
      • s3Prefix
    • robotApplications array: The robot application to use in the simulation job.
    • simulationApplications array: The simulation application to use in the simulation job.
    • vpcConfig object: If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and two subnet IDs.

Output

CreateWorldExportJob

amazonaws_robomaker.CreateWorldExportJob({
  "worlds": [],
  "outputLocation": {},
  "iamRole": ""
}, context)

Input

  • input object
    • tags object: A map that contains tag keys and tag values that are attached to the world export job.
    • clientRequestToken string: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
    • iamRole required string: The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.
    • outputLocation required object: The output location.
      • s3Bucket
      • s3Prefix
    • worlds required array: A list of Amazon Resource Names (arns) that correspond to worlds to export.

Output

CreateWorldGenerationJob

amazonaws_robomaker.CreateWorldGenerationJob({
  "template": "",
  "worldCount": {}
}, context)

Input

  • input object
    • tags object: A map that contains tag keys and tag values that are attached to the world generator job.
    • clientRequestToken string: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
    • template required string: The Amazon Resource Name (arn) of the world template describing the worlds you want to create.
    • worldCount required object:

      The number of worlds that will be created. You can configure the number of unique floorplans and the number of unique interiors for each floor plan. For example, if you want 1 world with 20 unique interiors, you set floorplanCount = 1 and interiorCountPerFloorplan = 20. This will result in 20 worlds (floorplanCount * interiorCountPerFloorplan).

      If you set floorplanCount = 4 and interiorCountPerFloorplan = 5, there will be 20 worlds with 5 unique floor plans.

      • floorplanCount
      • interiorCountPerFloorplan
    • worldTags object: A map that contains tag keys and tag values that are attached to the generated worlds.

Output

CreateWorldTemplate

amazonaws_robomaker.CreateWorldTemplate({}, context)

Input

  • input object
    • tags object: A map that contains tag keys and tag values that are attached to the world template.
    • clientRequestToken string: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
    • name string: The name of the world template.
    • templateBody string: The world template body.
    • templateLocation object: Information about a template location.
      • s3Bucket
      • s3Key

Output

DeleteFleet

amazonaws_robomaker.DeleteFleet({
  "fleet": ""
}, context)

Input

  • input object
    • fleet required string: The Amazon Resource Name (ARN) of the fleet.

Output

DeleteRobot

amazonaws_robomaker.DeleteRobot({
  "robot": ""
}, context)

Input

  • input object
    • robot required string: The Amazon Resource Name (ARN) of the robot.

Output

DeleteRobotApplication

amazonaws_robomaker.DeleteRobotApplication({
  "application": ""
}, context)

Input

  • input object
    • application required string: The Amazon Resource Name (ARN) of the the robot application.
    • applicationVersion string: The version of the robot application to delete.

Output

DeleteSimulationApplication

amazonaws_robomaker.DeleteSimulationApplication({
  "application": ""
}, context)

Input

  • input object
    • application required string: The application information for the simulation application to delete.
    • applicationVersion string: The version of the simulation application to delete.

Output

DeleteWorldTemplate

amazonaws_robomaker.DeleteWorldTemplate({
  "template": ""
}, context)

Input

  • input object
    • template required string: The Amazon Resource Name (arn) of the world template you want to delete.

Output

DeregisterRobot

amazonaws_robomaker.DeregisterRobot({
  "fleet": "",
  "robot": ""
}, context)

Input

  • input object
    • fleet required string: The Amazon Resource Name (ARN) of the fleet.
    • robot required string: The Amazon Resource Name (ARN) of the robot.

Output

DescribeDeploymentJob

amazonaws_robomaker.DescribeDeploymentJob({
  "job": ""
}, context)

Input

  • input object
    • job required string: The Amazon Resource Name (ARN) of the deployment job.

Output

DescribeFleet

amazonaws_robomaker.DescribeFleet({
  "fleet": ""
}, context)

Input

  • input object
    • fleet required string: The Amazon Resource Name (ARN) of the fleet.

Output

DescribeRobot

amazonaws_robomaker.DescribeRobot({
  "robot": ""
}, context)

Input

  • input object
    • robot required string: The Amazon Resource Name (ARN) of the robot to be described.

Output

DescribeRobotApplication

amazonaws_robomaker.DescribeRobotApplication({
  "application": ""
}, context)

Input

  • input object
    • application required string: The Amazon Resource Name (ARN) of the robot application.
    • applicationVersion string: The version of the robot application to describe.

Output

DescribeSimulationApplication

amazonaws_robomaker.DescribeSimulationApplication({
  "application": ""
}, context)

Input

  • input object
    • application required string: The application information for the simulation application.
    • applicationVersion string: The version of the simulation application to describe.

Output

DescribeSimulationJob

amazonaws_robomaker.DescribeSimulationJob({
  "job": ""
}, context)

Input

  • input object
    • job required string: The Amazon Resource Name (ARN) of the simulation job to be described.

Output

DescribeSimulationJobBatch

amazonaws_robomaker.DescribeSimulationJobBatch({
  "batch": ""
}, context)

Input

  • input object
    • batch required string: The id of the batch to describe.

Output

DescribeWorld

amazonaws_robomaker.DescribeWorld({
  "world": ""
}, context)

Input

  • input object
    • world required string: The Amazon Resource Name (arn) of the world you want to describe.

Output

DescribeWorldExportJob

amazonaws_robomaker.DescribeWorldExportJob({
  "job": ""
}, context)

Input

  • input object
    • job required string: The Amazon Resource Name (arn) of the world export job to describe.

Output

DescribeWorldGenerationJob

amazonaws_robomaker.DescribeWorldGenerationJob({
  "job": ""
}, context)

Input

  • input object
    • job required string: The Amazon Resource Name (arn) of the world generation job to describe.

Output

DescribeWorldTemplate

amazonaws_robomaker.DescribeWorldTemplate({
  "template": ""
}, context)

Input

  • input object
    • template required string: The Amazon Resource Name (arn) of the world template you want to describe.

Output

GetWorldTemplateBody

amazonaws_robomaker.GetWorldTemplateBody({}, context)

Input

  • input object
    • generationJob string: The Amazon Resource Name (arn) of the world generator job.
    • template string: The Amazon Resource Name (arn) of the world template.

Output

ListDeploymentJobs

amazonaws_robomaker.ListDeploymentJobs({}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • filters array:

      Optional filters to limit results.

      The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status InProgress or the status Pending.

    • maxResults integer: When this parameter is used, ListDeploymentJobs 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 ListDeploymentJobs request with the returned nextToken value. This value can be between 1 and 200. If this parameter is not used, then ListDeploymentJobs returns up to 200 results and a nextToken value if applicable.
    • 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 ListDeploymentJobs 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.

Output

ListFleets

amazonaws_robomaker.ListFleets({}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • filters array:

      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.

    • maxResults integer: When this parameter is used, ListFleets 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 ListFleets request with the returned nextToken value. This value can be between 1 and 200. If this parameter is not used, then ListFleets returns up to 200 results and a nextToken value if applicable.
    • 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 ListFleets 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.

      This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Output

ListRobotApplications

amazonaws_robomaker.ListRobotApplications({}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • filters array:

      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.

    • maxResults integer: 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.
    • 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.
    • versionQualifier string: The version qualifier of the robot application.

Output

ListRobots

amazonaws_robomaker.ListRobots({}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • filters array:

      Optional filters to limit results.

      The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Registered or the status Available.

    • maxResults integer: When this parameter is used, ListRobots 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 ListRobots request with the returned nextToken value. This value can be between 1 and 200. If this parameter is not used, then ListRobots returns up to 200 results and a nextToken value if applicable.
    • 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 ListRobots 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.

Output

ListSimulationApplications

amazonaws_robomaker.ListSimulationApplications({}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • filters array:

      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.

    • maxResults integer: 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.
    • 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.
    • versionQualifier string: The version qualifier of the simulation application.

Output

ListSimulationJobBatches

amazonaws_robomaker.ListSimulationJobBatches({}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • filters array: Optional filters to limit results.
    • maxResults integer: When this parameter is used, ListSimulationJobBatches 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 ListSimulationJobBatches request with the returned nextToken value.
    • 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 ListSimulationJobBatches 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.

Output

ListSimulationJobs

amazonaws_robomaker.ListSimulationJobs({}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • filters array:

      Optional filters to limit results.

      The filter names status and simulationApplicationName and robotApplicationName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Preparing or the status Running.

    • maxResults integer: When this parameter is used, ListSimulationJobs 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 ListSimulationJobs request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then ListSimulationJobs returns up to 1000 results and a nextToken value if applicable.
    • 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 ListSimulationJobs 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.

Output

ListWorldExportJobs

amazonaws_robomaker.ListWorldExportJobs({}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • filters array: Optional filters to limit results. You can use generationJobId and templateId.
    • maxResults integer: When this parameter is used, ListWorldExportJobs 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 ListWorldExportJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorldExportJobs returns up to 100 results and a nextToken value if applicable.
    • 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 ListWorldExportJobs 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.

Output

ListWorldGenerationJobs

amazonaws_robomaker.ListWorldGenerationJobs({}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • filters array: Optional filters to limit results. You can use status and templateId.
    • maxResults integer: When this parameter is used, ListWorldGeneratorJobs 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 ListWorldGeneratorJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorldGeneratorJobs returns up to 100 results and a nextToken value if applicable.
    • 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 ListWorldGenerationJobsRequest 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.

Output

ListWorldTemplates

amazonaws_robomaker.ListWorldTemplates({}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • maxResults integer: When this parameter is used, ListWorldTemplates 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 ListWorldTemplates request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorldTemplates returns up to 100 results and a nextToken value if applicable.
    • 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 ListWorldTemplates 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.

Output

ListWorlds

amazonaws_robomaker.ListWorlds({}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • filters array: Optional filters to limit results. You can use status.
    • maxResults integer: When this parameter is used, ListWorlds 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 ListWorlds request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorlds returns up to 100 results and a nextToken value if applicable.
    • 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 ListWorlds 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.

Output

RegisterRobot

amazonaws_robomaker.RegisterRobot({
  "fleet": "",
  "robot": ""
}, context)

Input

  • input object
    • fleet required string: The Amazon Resource Name (ARN) of the fleet.
    • robot required string: The Amazon Resource Name (ARN) of the robot.

Output

RestartSimulationJob

amazonaws_robomaker.RestartSimulationJob({
  "job": ""
}, context)

Input

  • input object
    • job required string: The Amazon Resource Name (ARN) of the simulation job.

Output

StartSimulationJobBatch

amazonaws_robomaker.StartSimulationJobBatch({
  "createSimulationJobRequests": []
}, context)

Input

  • input object
    • tags object: A map that contains tag keys and tag values that are attached to the deployment job batch.
    • batchPolicy object: Information about the batch policy.
      • maxConcurrency
      • timeoutInSeconds
    • clientRequestToken string: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
    • createSimulationJobRequests required array: A list of simulation job requests to create in the batch.

Output

SyncDeploymentJob

amazonaws_robomaker.SyncDeploymentJob({
  "clientRequestToken": "",
  "fleet": ""
}, context)

Input

  • input object
    • clientRequestToken required string: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
    • fleet required string: The target fleet for the synchronization.

Output

ListTagsForResource

amazonaws_robomaker.ListTagsForResource({
  "resourceArn": ""
}, context)

Input

  • input object
    • resourceArn required string

Output

TagResource

amazonaws_robomaker.TagResource({
  "resourceArn": "",
  "tags": {}
}, context)

Input

  • input object
    • resourceArn required string
    • tags required object: A map that contains tag keys and tag values that are attached to the resource.

Output

UntagResource

amazonaws_robomaker.UntagResource({
  "resourceArn": "",
  "tagKeys": []
}, context)

Input

  • input object
    • resourceArn required string
    • tagKeys required array

Output

UpdateRobotApplication

amazonaws_robomaker.UpdateRobotApplication({
  "application": "",
  "sources": [],
  "robotSoftwareSuite": {}
}, context)

Input

  • input object
    • application required string: The application information for the robot application.
    • currentRevisionId string: The revision id for the robot application.
    • robotSoftwareSuite required object: Information about a robot software suite (ROS distribution).
      • name
      • version
    • sources required array: The sources of the robot application.

Output

UpdateSimulationApplication

amazonaws_robomaker.UpdateSimulationApplication({
  "application": "",
  "sources": [],
  "simulationSoftwareSuite": {},
  "robotSoftwareSuite": {}
}, context)

Input

  • input object
    • application required string: The application information for the simulation application.
    • currentRevisionId string: The revision id for the robot application.
    • renderingEngine object: Information about a rendering engine.
      • name
      • version
    • robotSoftwareSuite required object: Information about a robot software suite (ROS distribution).
      • name
      • version
    • simulationSoftwareSuite required object: Information about a simulation software suite.
      • name
      • version
    • sources required array: The sources of the simulation application.

Output

UpdateWorldTemplate

amazonaws_robomaker.UpdateWorldTemplate({
  "template": ""
}, context)

Input

  • input object
    • name string: The name of the template.
    • template required string: The Amazon Resource Name (arn) of the world template to update.
    • templateBody string: The world template body.
    • templateLocation object: Information about a template location.
      • s3Bucket
      • s3Key

Output

Definitions

Architecture

  • Architecture string (values: X86_64, ARM64, ARMHF)

Arn

  • Arn string

Arns

  • Arns array

BatchDeleteWorldsRequest

  • BatchDeleteWorldsRequest object
    • worlds required

BatchDeleteWorldsResponse

  • BatchDeleteWorldsResponse object
    • unprocessedWorlds

BatchDescribeSimulationJobRequest

  • BatchDescribeSimulationJobRequest object
    • jobs required

BatchDescribeSimulationJobResponse

  • BatchDescribeSimulationJobResponse object

BatchPolicy

  • BatchPolicy object: Information about the batch policy.
    • maxConcurrency
    • timeoutInSeconds

BatchTimeoutInSeconds

  • BatchTimeoutInSeconds integer

Boolean

  • Boolean boolean

BoxedBoolean

  • BoxedBoolean boolean

CancelDeploymentJobRequest

  • CancelDeploymentJobRequest object
    • job required

CancelDeploymentJobResponse

  • CancelDeploymentJobResponse object

CancelSimulationJobBatchRequest

  • CancelSimulationJobBatchRequest object
    • batch required

CancelSimulationJobBatchResponse

  • CancelSimulationJobBatchResponse object

CancelSimulationJobRequest

  • CancelSimulationJobRequest object
    • job required

CancelSimulationJobResponse

  • CancelSimulationJobResponse object

CancelWorldExportJobRequest

  • CancelWorldExportJobRequest object
    • job required

CancelWorldExportJobResponse

  • CancelWorldExportJobResponse object

CancelWorldGenerationJobRequest

  • CancelWorldGenerationJobRequest object
    • job required

CancelWorldGenerationJobResponse

  • CancelWorldGenerationJobResponse object

ClientRequestToken

  • ClientRequestToken string

Command

  • Command string

Compute

  • Compute object: Compute information for the simulation job.
    • simulationUnitLimit

ComputeResponse

  • ComputeResponse object: Compute information for the simulation job
    • simulationUnitLimit

ConcurrentDeploymentException

CreateDeploymentJobRequest

  • CreateDeploymentJobRequest object
    • tags
    • clientRequestToken required
    • deploymentApplicationConfigs required
    • deploymentConfig
      • concurrentDeploymentPercentage
      • downloadConditionFile
        • bucket required
        • etag
        • key required
      • failureThresholdPercentage
      • robotDeploymentTimeoutInSeconds
    • fleet required

CreateDeploymentJobResponse

  • CreateDeploymentJobResponse object
    • tags
    • arn
    • createdAt
    • deploymentApplicationConfigs
    • deploymentConfig
      • concurrentDeploymentPercentage
      • downloadConditionFile
        • bucket required
        • etag
        • key required
      • failureThresholdPercentage
      • robotDeploymentTimeoutInSeconds
    • failureCode
    • failureReason
    • fleet
    • status

CreateFleetRequest

  • CreateFleetRequest object
    • tags
    • name required

CreateFleetResponse

  • CreateFleetResponse object
    • tags
    • arn
    • createdAt
    • name

CreateRobotApplicationRequest

  • CreateRobotApplicationRequest object
    • tags
    • name required
    • robotSoftwareSuite required
      • name
      • version
    • sources required

CreateRobotApplicationResponse

  • CreateRobotApplicationResponse object
    • tags
    • arn
    • lastUpdatedAt
    • name
    • revisionId
    • robotSoftwareSuite
      • name
      • version
    • sources
    • version

CreateRobotApplicationVersionRequest

  • CreateRobotApplicationVersionRequest object
    • application required
    • currentRevisionId

CreateRobotApplicationVersionResponse

  • CreateRobotApplicationVersionResponse object
    • arn
    • lastUpdatedAt
    • name
    • revisionId
    • robotSoftwareSuite
      • name
      • version
    • sources
    • version

CreateRobotRequest

  • CreateRobotRequest object
    • tags
    • architecture required
    • greengrassGroupId required
    • name required

CreateRobotResponse

  • CreateRobotResponse object
    • tags
    • architecture
    • arn
    • createdAt
    • greengrassGroupId
    • name

CreateSimulationApplicationRequest

  • CreateSimulationApplicationRequest object
    • tags
    • name required
    • renderingEngine
      • name
      • version
    • robotSoftwareSuite required
      • name
      • version
    • simulationSoftwareSuite required
      • name
      • version
    • sources required

CreateSimulationApplicationResponse

  • CreateSimulationApplicationResponse object
    • tags
    • arn
    • lastUpdatedAt
    • name
    • renderingEngine
      • name
      • version
    • revisionId
    • robotSoftwareSuite
      • name
      • version
    • simulationSoftwareSuite
      • name
      • version
    • sources
    • version

CreateSimulationApplicationVersionRequest

  • CreateSimulationApplicationVersionRequest object
    • application required
    • currentRevisionId

CreateSimulationApplicationVersionResponse

  • CreateSimulationApplicationVersionResponse object
    • arn
    • lastUpdatedAt
    • name
    • renderingEngine
      • name
      • version
    • revisionId
    • robotSoftwareSuite
      • name
      • version
    • simulationSoftwareSuite
      • name
      • version
    • sources
    • version

CreateSimulationJobRequest

  • CreateSimulationJobRequest object

CreateSimulationJobRequests

CreateSimulationJobResponse

  • CreateSimulationJobResponse object
    • tags
    • arn
    • clientRequestToken
    • compute
      • simulationUnitLimit
    • dataSources
    • failureBehavior
    • failureCode
    • iamRole
    • lastStartedAt
    • lastUpdatedAt
    • loggingConfig
      • recordAllRosTopics required
    • maxJobDurationInSeconds
    • outputLocation
      • s3Bucket
      • s3Prefix
    • robotApplications
    • simulationApplications
    • simulationTimeMillis
    • status
    • vpcConfig

CreateWorldExportJobRequest

  • CreateWorldExportJobRequest object
    • tags
    • clientRequestToken
    • iamRole required
    • outputLocation required OutputLocation
    • worlds required

CreateWorldExportJobResponse

  • CreateWorldExportJobResponse object
    • tags
    • arn
    • clientRequestToken
    • createdAt
    • failureCode
    • iamRole
    • outputLocation OutputLocation
    • status

CreateWorldGenerationJobRequest

  • CreateWorldGenerationJobRequest object
    • tags
    • clientRequestToken
    • template required
    • worldCount required
      • floorplanCount
      • interiorCountPerFloorplan
    • worldTags

CreateWorldGenerationJobResponse

  • CreateWorldGenerationJobResponse object
    • tags
    • arn
    • clientRequestToken
    • createdAt
    • failureCode
    • status
    • template
    • worldCount
      • floorplanCount
      • interiorCountPerFloorplan
    • worldTags

CreateWorldTemplateRequest

  • CreateWorldTemplateRequest object
    • tags
    • clientRequestToken
    • name
    • templateBody
    • templateLocation
      • s3Bucket required
      • s3Key required

CreateWorldTemplateResponse

  • CreateWorldTemplateResponse object
    • tags
    • arn
    • clientRequestToken
    • createdAt
    • name

CreatedAt

  • CreatedAt string

DataSource

  • DataSource object: Information about a data source.

DataSourceConfig

  • DataSourceConfig object: Information about a data source.
    • name required
    • s3Bucket required
    • s3Keys required

DataSourceConfigs

DataSourceNames

  • DataSourceNames array

DataSources

DeleteFleetRequest

  • DeleteFleetRequest object
    • fleet required

DeleteFleetResponse

  • DeleteFleetResponse object

DeleteRobotApplicationRequest

  • DeleteRobotApplicationRequest object
    • application required
    • applicationVersion

DeleteRobotApplicationResponse

  • DeleteRobotApplicationResponse object

DeleteRobotRequest

  • DeleteRobotRequest object
    • robot required

DeleteRobotResponse

  • DeleteRobotResponse object

DeleteSimulationApplicationRequest

  • DeleteSimulationApplicationRequest object
    • application required
    • applicationVersion

DeleteSimulationApplicationResponse

  • DeleteSimulationApplicationResponse object

DeleteWorldTemplateRequest

  • DeleteWorldTemplateRequest object
    • template required

DeleteWorldTemplateResponse

  • DeleteWorldTemplateResponse object

DeploymentApplicationConfig

  • DeploymentApplicationConfig object: Information about a deployment application configuration.
    • application required
    • applicationVersion required
    • launchConfig required
      • environmentVariables
      • launchFile required
      • packageName required
      • postLaunchFile
      • preLaunchFile

DeploymentApplicationConfigs

DeploymentConfig

  • DeploymentConfig object: Information about a deployment configuration.
    • concurrentDeploymentPercentage
    • downloadConditionFile
      • bucket required
      • etag
      • key required
    • failureThresholdPercentage
    • robotDeploymentTimeoutInSeconds

DeploymentJob

  • DeploymentJob object: Information about a deployment job.
    • arn
    • createdAt
    • deploymentApplicationConfigs
    • deploymentConfig
      • concurrentDeploymentPercentage
      • downloadConditionFile
        • bucket required
        • etag
        • key required
      • failureThresholdPercentage
      • robotDeploymentTimeoutInSeconds
    • failureCode
    • failureReason
    • fleet
    • status

DeploymentJobErrorCode

  • DeploymentJobErrorCode string (values: ResourceNotFound, EnvironmentSetupError, EtagMismatch, FailureThresholdBreached, RobotDeploymentAborted, RobotDeploymentNoResponse, RobotAgentConnectionTimeout, GreengrassDeploymentFailed, InvalidGreengrassGroup, MissingRobotArchitecture, MissingRobotApplicationArchitecture, MissingRobotDeploymentResource, GreengrassGroupVersionDoesNotExist, LambdaDeleted, ExtractingBundleFailure, PreLaunchFileFailure, PostLaunchFileFailure, BadPermissionError, DownloadConditionFailed, InternalServerError)

DeploymentJobs

DeploymentLaunchConfig

  • DeploymentLaunchConfig object: Configuration information for a deployment launch.
    • environmentVariables
    • launchFile required
    • packageName required
    • postLaunchFile
    • preLaunchFile

DeploymentStatus

  • DeploymentStatus string (values: Pending, Preparing, InProgress, Failed, Succeeded, Canceled)

DeploymentTimeout

  • DeploymentTimeout integer

DeploymentVersion

  • DeploymentVersion string

DeregisterRobotRequest

  • DeregisterRobotRequest object
    • fleet required
    • robot required

DeregisterRobotResponse

  • DeregisterRobotResponse object
    • fleet
    • robot

DescribeDeploymentJobRequest

  • DescribeDeploymentJobRequest object
    • job required

DescribeDeploymentJobResponse

  • DescribeDeploymentJobResponse object
    • tags
    • arn
    • createdAt
    • deploymentApplicationConfigs
    • deploymentConfig
      • concurrentDeploymentPercentage
      • downloadConditionFile
        • bucket required
        • etag
        • key required
      • failureThresholdPercentage
      • robotDeploymentTimeoutInSeconds
    • failureCode
    • failureReason
    • fleet
    • robotDeploymentSummary
    • status

DescribeFleetRequest

  • DescribeFleetRequest object
    • fleet required

DescribeFleetResponse

  • DescribeFleetResponse object
    • tags
    • arn
    • createdAt
    • lastDeploymentJob
    • lastDeploymentStatus
    • lastDeploymentTime
    • name
    • robots

DescribeRobotApplicationRequest

  • DescribeRobotApplicationRequest object
    • application required
    • applicationVersion

DescribeRobotApplicationResponse

  • DescribeRobotApplicationResponse object
    • tags
    • arn
    • lastUpdatedAt
    • name
    • revisionId
    • robotSoftwareSuite
      • name
      • version
    • sources
    • version

DescribeRobotRequest

  • DescribeRobotRequest object
    • robot required

DescribeRobotResponse

  • DescribeRobotResponse object
    • tags
    • architecture
    • arn
    • createdAt
    • fleetArn
    • greengrassGroupId
    • lastDeploymentJob
    • lastDeploymentTime
    • name
    • status

DescribeSimulationApplicationRequest

  • DescribeSimulationApplicationRequest object
    • application required
    • applicationVersion

DescribeSimulationApplicationResponse

  • DescribeSimulationApplicationResponse object
    • tags
    • arn
    • lastUpdatedAt
    • name
    • renderingEngine
      • name
      • version
    • revisionId
    • robotSoftwareSuite
      • name
      • version
    • simulationSoftwareSuite
      • name
      • version
    • sources
    • version

DescribeSimulationJobBatchRequest

  • DescribeSimulationJobBatchRequest object
    • batch required

DescribeSimulationJobBatchResponse

DescribeSimulationJobRequest

  • DescribeSimulationJobRequest object
    • job required

DescribeSimulationJobResponse

  • DescribeSimulationJobResponse object
    • tags
    • arn
    • clientRequestToken
    • compute
      • simulationUnitLimit
    • dataSources
    • failureBehavior
    • failureCode
    • failureReason
    • iamRole
    • lastStartedAt
    • lastUpdatedAt
    • loggingConfig
      • recordAllRosTopics required
    • maxJobDurationInSeconds
    • name
    • networkInterface
      • networkInterfaceId
      • privateIpAddress
      • publicIpAddress
    • outputLocation
      • s3Bucket
      • s3Prefix
    • robotApplications
    • simulationApplications
    • simulationTimeMillis
    • status
    • vpcConfig

DescribeWorldExportJobRequest

  • DescribeWorldExportJobRequest object
    • job required

DescribeWorldExportJobResponse

  • DescribeWorldExportJobResponse object
    • tags
    • arn
    • clientRequestToken
    • createdAt
    • failureCode
    • failureReason
    • iamRole
    • outputLocation OutputLocation
    • status
    • worlds

DescribeWorldGenerationJobRequest

  • DescribeWorldGenerationJobRequest object
    • job required

DescribeWorldGenerationJobResponse

  • DescribeWorldGenerationJobResponse object
    • tags
    • arn
    • clientRequestToken
    • createdAt
    • failureCode
    • failureReason
    • finishedWorldsSummary
      • failureSummary
      • finishedCount
      • succeededWorlds
    • status
    • template
    • worldCount
      • floorplanCount
      • interiorCountPerFloorplan
    • worldTags

DescribeWorldRequest

  • DescribeWorldRequest object
    • world required

DescribeWorldResponse

  • DescribeWorldResponse object
    • tags
    • arn
    • createdAt
    • generationJob
    • template

DescribeWorldTemplateRequest

  • DescribeWorldTemplateRequest object
    • template required

DescribeWorldTemplateResponse

  • DescribeWorldTemplateResponse object
    • tags
    • arn
    • clientRequestToken
    • createdAt
    • lastUpdatedAt
    • name

EnvironmentVariableKey

  • EnvironmentVariableKey string

EnvironmentVariableMap

  • EnvironmentVariableMap object

EnvironmentVariableValue

  • EnvironmentVariableValue string

FailedAt

  • FailedAt string

FailedCreateSimulationJobRequest

FailedCreateSimulationJobRequests

FailureBehavior

  • FailureBehavior string (values: Fail, Continue)

FailureSummary

  • FailureSummary object: Information about worlds that failed.

Filter

  • Filter object: Information about a filter.
    • name
    • values

FilterValues

  • FilterValues array

Filters

FinishedWorldsSummary

  • FinishedWorldsSummary object: Information about worlds that finished.
    • failureSummary
    • finishedCount
    • succeededWorlds

Fleet

  • Fleet object: Information about a fleet.
    • arn
    • createdAt
    • lastDeploymentJob
    • lastDeploymentStatus
    • lastDeploymentTime
    • name

Fleets

  • Fleets array

FloorplanCount

  • FloorplanCount integer

GenericInteger

  • GenericInteger integer

GenericString

  • GenericString string

GetWorldTemplateBodyRequest

  • GetWorldTemplateBodyRequest object
    • generationJob
    • template

GetWorldTemplateBodyResponse

  • GetWorldTemplateBodyResponse object
    • templateBody

IamRole

  • IamRole string

Id

  • Id string

IdempotentParameterMismatchException

Integer

  • Integer integer

InteriorCountPerFloorplan

  • InteriorCountPerFloorplan integer

InternalServerException

InvalidParameterException

JobDuration

  • JobDuration integer

Json

  • Json string

LastStartedAt

  • LastStartedAt string

LastUpdatedAt

  • LastUpdatedAt string

LaunchConfig

  • LaunchConfig object: Information about a launch configuration.
    • environmentVariables
    • launchFile required
    • packageName required
    • portForwardingConfig
    • streamUI

LimitExceededException

ListDeploymentJobsRequest

  • ListDeploymentJobsRequest object
    • filters
    • maxResults
    • nextToken

ListDeploymentJobsResponse

  • ListDeploymentJobsResponse object

ListFleetsRequest

  • ListFleetsRequest object
    • filters
    • maxResults
    • nextToken

ListFleetsResponse

  • ListFleetsResponse object
    • fleetDetails
    • nextToken

ListRobotApplicationsRequest

  • ListRobotApplicationsRequest object
    • filters
    • maxResults
    • nextToken
    • versionQualifier

ListRobotApplicationsResponse

ListRobotsRequest

  • ListRobotsRequest object
    • filters
    • maxResults
    • nextToken

ListRobotsResponse

  • ListRobotsResponse object
    • nextToken
    • robots

ListSimulationApplicationsRequest

  • ListSimulationApplicationsRequest object
    • filters
    • maxResults
    • nextToken
    • versionQualifier

ListSimulationApplicationsResponse

ListSimulationJobBatchesRequest

  • ListSimulationJobBatchesRequest object
    • filters
    • maxResults
    • nextToken

ListSimulationJobBatchesResponse

ListSimulationJobsRequest

  • ListSimulationJobsRequest object
    • filters
    • maxResults
    • nextToken

ListSimulationJobsResponse

  • ListSimulationJobsResponse object

ListTagsForResourceRequest

  • ListTagsForResourceRequest object

ListTagsForResourceResponse

  • ListTagsForResourceResponse object
    • tags

ListWorldExportJobsRequest

  • ListWorldExportJobsRequest object
    • filters
    • maxResults
    • nextToken

ListWorldExportJobsResponse

  • ListWorldExportJobsResponse object

ListWorldGenerationJobsRequest

  • ListWorldGenerationJobsRequest object
    • filters
    • maxResults
    • nextToken

ListWorldGenerationJobsResponse

ListWorldTemplatesRequest

  • ListWorldTemplatesRequest object
    • maxResults
    • nextToken

ListWorldTemplatesResponse

  • ListWorldTemplatesResponse object

ListWorldsRequest

  • ListWorldsRequest object
    • filters
    • maxResults
    • nextToken

ListWorldsResponse

  • ListWorldsResponse object

LoggingConfig

  • LoggingConfig object: The logging configuration.
    • recordAllRosTopics required

MaxConcurrency

  • MaxConcurrency integer

MaxResults

  • MaxResults integer

Name

  • Name string

NetworkInterface

  • NetworkInterface object: Describes a network interface.
    • networkInterfaceId
    • privateIpAddress
    • publicIpAddress

NonEmptyString

  • NonEmptyString string

NonSystemPort

  • NonSystemPort integer

OutputLocation

  • OutputLocation object: The output location.
    • s3Bucket
    • s3Prefix

PaginationToken

  • Pa