Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RoboMaker

This section provides documentation for the AWS RoboMaker API operations.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly config

The resolved configuration of RoboMakerClient class. This is resolved and normalized from the constructor configuration interface.

middlewareStack

Methods

batchDeleteWorlds

batchDescribeSimulationJob

cancelDeploymentJob

cancelSimulationJob

cancelSimulationJobBatch

cancelWorldExportJob

cancelWorldGenerationJob

createDeploymentJob

  • deprecated

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

    Parameters

    Returns Promise<CreateDeploymentJobCommandOutput>

  • deprecated

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

    Parameters

    Returns void

  • deprecated

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

    Parameters

    Returns void

  • deprecated

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

    Parameters

    • args: CreateDeploymentJobCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<CreateDeploymentJobCommandOutput>

  • deprecated

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

    Parameters

    Returns void

  • deprecated

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

    Parameters

    Returns void

createFleet

createRobot

createRobotApplication

createRobotApplicationVersion

createSimulationApplication

createSimulationApplicationVersion

createSimulationJob

createWorldExportJob

createWorldGenerationJob

createWorldTemplate

deleteFleet

deleteRobot

deleteRobotApplication

deleteSimulationApplication

deleteWorldTemplate

deregisterRobot

describeDeploymentJob

describeFleet

describeRobot

describeRobotApplication

describeSimulationApplication

describeSimulationJob

describeSimulationJobBatch

describeWorld

describeWorldExportJob

describeWorldGenerationJob

describeWorldTemplate

destroy

  • destroy(): void
  • Destroy 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.

    Returns void

getWorldTemplateBody

listDeploymentJobs

  • deprecated

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

    Parameters

    Returns Promise<ListDeploymentJobsCommandOutput>

  • deprecated

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

    Parameters

    Returns void

  • deprecated

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

    Parameters

    Returns void

  • deprecated

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

    Parameters

    • args: ListDeploymentJobsCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<ListDeploymentJobsCommandOutput>

  • deprecated

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

    Parameters

    Returns void

  • deprecated

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

    Parameters

    Returns void

listFleets

  • deprecated

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

    Parameters

    Returns Promise<ListFleetsCommandOutput>

  • deprecated

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

    Parameters

    Returns void

  • deprecated

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

    Parameters

    Returns void

  • deprecated

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

    Parameters

    • args: ListFleetsCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<ListFleetsCommandOutput>

  • deprecated

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

    Parameters

    Returns void

  • deprecated

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

    Parameters

    Returns void

listRobotApplications

listRobots

  • deprecated

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

    Parameters

    Returns Promise<ListRobotsCommandOutput>

  • deprecated

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

    Parameters

    Returns void

  • deprecated

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

    Parameters

    Returns void

  • deprecated

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

    Parameters

    • args: ListRobotsCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<ListRobotsCommandOutput>

  • deprecated

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

    Parameters

    Returns void

  • deprecated

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

    Parameters

    Returns void

listSimulationApplications

listSimulationJobBatches

listSimulationJobs

listTagsForResource

listWorldExportJobs

listWorldGenerationJobs

listWorldTemplates

listWorlds

registerRobot

restartSimulationJob

send

startSimulationJobBatch

syncDeploymentJob

  • deprecated

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

    Parameters

    Returns Promise<SyncDeploymentJobCommandOutput>

  • deprecated

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

    Parameters

    Returns void

  • deprecated

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

    Parameters

    Returns void

  • deprecated

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

    Parameters

    • args: SyncDeploymentJobCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<SyncDeploymentJobCommandOutput>

  • deprecated

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

    Parameters

    Returns void

  • deprecated

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

    Parameters

    Returns void

tagResource

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

    Parameters

    Returns Promise<TagResourceCommandOutput>

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

    Parameters

    Returns void

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

    Parameters