Readonly
configThe resolved configuration of RoboMakerClient class. This is resolved and normalized from the constructor configuration interface.
Deletes one or more worlds in a batch operation.
Optional
options: HttpHandlerOptionsOptional
data: BatchDeleteWorldsCommandOutputOptional
data: BatchDeleteWorldsCommandOutputDescribes one or more simulation jobs.
Optional
options: HttpHandlerOptionsOptional
data: BatchDescribeSimulationJobCommandOutputOptional
data: BatchDescribeSimulationJobCommandOutputCancels the specified deployment job.
This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.
Optional
options: HttpHandlerOptionsOptional
data: CancelDeploymentJobCommandOutputOptional
data: CancelDeploymentJobCommandOutputCancels the specified simulation job.
Optional
options: HttpHandlerOptionsOptional
data: CancelSimulationJobCommandOutputOptional
data: CancelSimulationJobCommandOutputCancels a simulation job batch. When you cancel a simulation job batch, you are also cancelling all of the active simulation jobs created as part of the batch.
Optional
options: HttpHandlerOptionsOptional
data: CancelSimulationJobBatchCommandOutputOptional
data: CancelSimulationJobBatchCommandOutputCancels the specified export job.
Optional
options: HttpHandlerOptionsOptional
data: CancelWorldExportJobCommandOutputOptional
data: CancelWorldExportJobCommandOutputCancels the specified world generator job.
Optional
options: HttpHandlerOptionsOptional
data: CancelWorldGenerationJobCommandOutputOptional
data: CancelWorldGenerationJobCommandOutputDeploys a specific version of a robot application to robots in a fleet.
This API is no longer supported and will throw an error if used.
The robot application must have a numbered applicationVersion
for
consistency reasons. To create a new version, use
CreateRobotApplicationVersion
or see Creating a Robot Application Version.
After 90 days, deployment jobs expire and will be deleted. They will no longer be accessible.
Optional
options: HttpHandlerOptionsOptional
data: CreateDeploymentJobCommandOutputOptional
data: CreateDeploymentJobCommandOutputCreates a fleet, a logical group of robots running the same robot application.
This API is no longer supported and will throw an error if used.
Optional
options: HttpHandlerOptionsOptional
data: CreateFleetCommandOutputOptional
data: CreateFleetCommandOutputCreates a robot.
This API is no longer supported and will throw an error if used.
Optional
options: HttpHandlerOptionsOptional
data: CreateRobotCommandOutputOptional
data: CreateRobotCommandOutputCreates a robot application.
Optional
options: HttpHandlerOptionsOptional
data: CreateRobotApplicationCommandOutputOptional
data: CreateRobotApplicationCommandOutputCreates a version of a robot application.
Optional
options: HttpHandlerOptionsOptional
data: CreateRobotApplicationVersionCommandOutputOptional
data: CreateRobotApplicationVersionCommandOutputCreates a simulation application.
Optional
options: HttpHandlerOptionsOptional
data: CreateSimulationApplicationCommandOutputOptional
data: CreateSimulationApplicationCommandOutputCreates a simulation application with a specific revision id.
Optional
options: HttpHandlerOptionsOptional
data: CreateSimulationApplicationVersionCommandOutputOptional
data: CreateSimulationApplicationVersionCommandOutputCreates a simulation job.
After 90 days, simulation jobs expire and will be deleted. They will no longer be accessible.
Optional
options: HttpHandlerOptionsOptional
data: CreateSimulationJobCommandOutputOptional
data: CreateSimulationJobCommandOutputCreates a world export job.
Optional
options: HttpHandlerOptionsOptional
data: CreateWorldExportJobCommandOutputOptional
data: CreateWorldExportJobCommandOutputCreates worlds using the specified template.
Optional
options: HttpHandlerOptionsOptional
data: CreateWorldGenerationJobCommandOutputOptional
data: CreateWorldGenerationJobCommandOutputCreates a world template.
Optional
options: HttpHandlerOptionsOptional
data: CreateWorldTemplateCommandOutputOptional
data: CreateWorldTemplateCommandOutputDeletes a fleet.
This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.
Optional
options: HttpHandlerOptionsOptional
data: DeleteFleetCommandOutputOptional
data: DeleteFleetCommandOutputDeletes a robot.
This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.
Optional
options: HttpHandlerOptionsOptional
data: DeleteRobotCommandOutputOptional
data: DeleteRobotCommandOutputDeletes a robot application.
Optional
options: HttpHandlerOptionsOptional
data: DeleteRobotApplicationCommandOutputOptional
data: DeleteRobotApplicationCommandOutputDeletes a simulation application.
Optional
options: HttpHandlerOptionsOptional
data: DeleteSimulationApplicationCommandOutputOptional
data: DeleteSimulationApplicationCommandOutputDeletes a world template.
Optional
options: HttpHandlerOptionsOptional
data: DeleteWorldTemplateCommandOutputOptional
data: DeleteWorldTemplateCommandOutputDeregisters a robot.
This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.
Optional
options: HttpHandlerOptionsOptional
data: DeregisterRobotCommandOutputOptional
data: DeregisterRobotCommandOutputDescribes a deployment job.
This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.
Optional
options: HttpHandlerOptionsOptional
data: DescribeDeploymentJobCommandOutputOptional
data: DescribeDeploymentJobCommandOutputDescribes a fleet.
This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.
Optional
options: HttpHandlerOptionsOptional
data: DescribeFleetCommandOutputOptional
data: DescribeFleetCommandOutputDescribes a robot.
This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.
Optional
options: HttpHandlerOptionsOptional
data: DescribeRobotCommandOutputOptional
data: DescribeRobotCommandOutputDescribes a robot application.
Optional
options: HttpHandlerOptionsOptional
data: DescribeRobotApplicationCommandOutputOptional
data: DescribeRobotApplicationCommandOutputDescribes a simulation application.
Optional
options: HttpHandlerOptionsOptional
data: DescribeSimulationApplicationCommandOutputOptional
data: DescribeSimulationApplicationCommandOutputDescribes a simulation job.
Optional
options: HttpHandlerOptionsOptional
data: DescribeSimulationJobCommandOutputOptional
data: DescribeSimulationJobCommandOutputDescribes a simulation job batch.
Optional
options: HttpHandlerOptionsOptional
data: DescribeSimulationJobBatchCommandOutputOptional
data: DescribeSimulationJobBatchCommandOutputDescribes a world.
Optional
options: HttpHandlerOptionsOptional
data: DescribeWorldCommandOutputOptional
data: DescribeWorldCommandOutputDescribes a world export job.
Optional
options: HttpHandlerOptionsOptional
data: DescribeWorldExportJobCommandOutputOptional
data: DescribeWorldExportJobCommandOutputDescribes a world generation job.
Optional
options: HttpHandlerOptionsOptional
data: DescribeWorldGenerationJobCommandOutputOptional
data: DescribeWorldGenerationJobCommandOutputDescribes a world template.
Optional
options: HttpHandlerOptionsOptional
data: DescribeWorldTemplateCommandOutputOptional
data: DescribeWorldTemplateCommandOutputDestroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.
Gets the world template body.
Optional
options: HttpHandlerOptionsOptional
data: GetWorldTemplateBodyCommandOutputOptional
data: GetWorldTemplateBodyCommandOutputReturns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.
This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.
Optional
options: HttpHandlerOptionsOptional
data: ListDeploymentJobsCommandOutputOptional
data: ListDeploymentJobsCommandOutputReturns a list of fleets. You can optionally provide filters to retrieve specific fleets.
This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.
Optional
options: HttpHandlerOptionsOptional
data: ListFleetsCommandOutputOptional
data: ListFleetsCommandOutputReturns a list of robot application. You can optionally provide filters to retrieve specific robot applications.
Optional
options: HttpHandlerOptionsOptional
data: ListRobotApplicationsCommandOutputOptional
data: ListRobotApplicationsCommandOutputReturns a list of robots. You can optionally provide filters to retrieve specific robots.
This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.
Optional
options: HttpHandlerOptionsOptional
data: ListRobotsCommandOutputOptional
data: ListRobotsCommandOutputReturns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications.
Optional
options: HttpHandlerOptionsOptional
data: ListSimulationApplicationsCommandOutputOptional
data: ListSimulationApplicationsCommandOutputReturns a list simulation job batches. You can optionally provide filters to retrieve specific simulation batch jobs.
Optional
options: HttpHandlerOptionsOptional
data: ListSimulationJobBatchesCommandOutputOptional
data: ListSimulationJobBatchesCommandOutputReturns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs.
Optional
options: HttpHandlerOptionsOptional
data: ListSimulationJobsCommandOutputOptional
data: ListSimulationJobsCommandOutputLists all tags on a AWS RoboMaker resource.
Optional
options: HttpHandlerOptionsOptional
data: ListTagsForResourceCommandOutputOptional
data: ListTagsForResourceCommandOutputLists world export jobs.
Optional
options: HttpHandlerOptionsOptional
data: ListWorldExportJobsCommandOutputOptional
data: ListWorldExportJobsCommandOutputLists world generator jobs.
Optional
options: HttpHandlerOptionsOptional
data: ListWorldGenerationJobsCommandOutputOptional
data: ListWorldGenerationJobsCommandOutputLists world templates.
Optional
options: HttpHandlerOptionsOptional
data: ListWorldTemplatesCommandOutputOptional
data: ListWorldTemplatesCommandOutputLists worlds.
Optional
options: HttpHandlerOptionsOptional
data: ListWorldsCommandOutputOptional
data: ListWorldsCommandOutputRegisters a robot with a fleet.
This API is no longer supported and will throw an error if used.
Optional
options: HttpHandlerOptionsOptional
data: RegisterRobotCommandOutputOptional
data: RegisterRobotCommandOutputRestarts a running simulation job.
Optional
options: HttpHandlerOptionsOptional
data: RestartSimulationJobCommandOutputOptional
data: RestartSimulationJobCommandOutputOptional
options: HttpHandlerOptionsOptional
data: OutputTypeOptional
data: OutputTypeStarts a new simulation job batch. The batch is defined using one or more
SimulationJobRequest
objects.
Optional
options: HttpHandlerOptionsOptional
data: StartSimulationJobBatchCommandOutputOptional
data: StartSimulationJobBatchCommandOutputSyncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.
This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.
Optional
options: HttpHandlerOptionsOptional
data: SyncDeploymentJobCommandOutputOptional
data: SyncDeploymentJobCommandOutputAdds or edits tags for a AWS RoboMaker resource.
Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty strings.
For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.
Optional
options: HttpHandlerOptionsOptional
data: TagResourceCommandOutputOptional
data: TagResourceCommandOutputRemoves the specified tags from the specified AWS RoboMaker resource.
To remove a tag, specify the tag key. To change the tag value of an existing tag key,
use
TagResource
.
Optional
options: HttpHandlerOptionsOptional
data: UntagResourceCommandOutputOptional
data: UntagResourceCommandOutputUpdates a robot application.
Optional
options: HttpHandlerOptionsOptional
data: UpdateRobotApplicationCommandOutputOptional
data: UpdateRobotApplicationCommandOutputUpdates a simulation application.
Optional
options: HttpHandlerOptionsOptional
data: UpdateSimulationApplicationCommandOutputOptional
data: UpdateSimulationApplicationCommandOutputUpdates a world template.
Optional
options: HttpHandlerOptionsOptional
data: UpdateWorldTemplateCommandOutputOptional
data: UpdateWorldTemplateCommandOutput
This section provides documentation for the AWS RoboMaker API operations.