RoboMakerClient

This section provides documentation for the AWS RoboMaker API operations.

Properties

Link copied to clipboard
abstract override val config: RoboMakerClient.Config

RoboMakerClient's configuration

Functions

Link copied to clipboard

Deletes one or more worlds in a batch operation.

Link copied to clipboard

Describes one or more simulation jobs.

Link copied to clipboard

Cancels the specified deployment job.

Link copied to clipboard

Cancels the specified simulation job.

Link copied to clipboard

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

Link copied to clipboard

Cancels the specified export job.

Link copied to clipboard

Cancels the specified world generator job.

Link copied to clipboard

Deploys a specific version of a robot application to robots in a fleet.

Link copied to clipboard
abstract suspend fun createFleet(input: CreateFleetRequest): CreateFleetResponse

Creates a fleet, a logical group of robots running the same robot application.

Link copied to clipboard
abstract suspend fun createRobot(input: CreateRobotRequest): CreateRobotResponse

Creates a robot.

Link copied to clipboard

Creates a robot application.

Link copied to clipboard

Creates a version of a robot application.

Link copied to clipboard

Creates a simulation application.

Link copied to clipboard

Creates a simulation application with a specific revision id.

Link copied to clipboard

Creates a simulation job.

Link copied to clipboard

Creates a world export job.

Link copied to clipboard

Creates worlds using the specified template.

Link copied to clipboard
abstract suspend fun createWorldTemplate(input: CreateWorldTemplateRequest = CreateWorldTemplateRequest { }): CreateWorldTemplateResponse

Creates a world template.

Link copied to clipboard
abstract suspend fun deleteFleet(input: DeleteFleetRequest): DeleteFleetResponse

Deletes a fleet.

Link copied to clipboard
abstract suspend fun deleteRobot(input: DeleteRobotRequest): DeleteRobotResponse

Deletes a robot.

Link copied to clipboard

Deletes a robot application.

Link copied to clipboard

Deletes a simulation application.

Link copied to clipboard

Deletes a world template.

Link copied to clipboard

Deregisters a robot.

Link copied to clipboard

Describes a deployment job.

Link copied to clipboard

Describes a fleet.

Link copied to clipboard

Describes a robot.

Link copied to clipboard

Describes a robot application.

Link copied to clipboard
Link copied to clipboard

Describes a simulation job.

Link copied to clipboard

Describes a simulation job batch.

Link copied to clipboard

Describes a world.

Link copied to clipboard

Describes a world export job.

Link copied to clipboard

Describes a world generation job.

Link copied to clipboard

Describes a world template.

Link copied to clipboard
abstract suspend fun getWorldTemplateBody(input: GetWorldTemplateBodyRequest = GetWorldTemplateBodyRequest { }): GetWorldTemplateBodyResponse

Gets the world template body.

Link copied to clipboard
abstract suspend fun listDeploymentJobs(input: ListDeploymentJobsRequest = ListDeploymentJobsRequest { }): ListDeploymentJobsResponse

Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.

Link copied to clipboard
abstract suspend fun listFleets(input: ListFleetsRequest = ListFleetsRequest { }): ListFleetsResponse

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

Link copied to clipboard
abstract suspend fun listRobotApplications(input: ListRobotApplicationsRequest = ListRobotApplicationsRequest { }): ListRobotApplicationsResponse

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

Link copied to clipboard
abstract suspend fun listRobots(input: ListRobotsRequest = ListRobotsRequest { }): ListRobotsResponse

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

Link copied to clipboard
abstract suspend fun listSimulationApplications(input: ListSimulationApplicationsRequest = ListSimulationApplicationsRequest { }): ListSimulationApplicationsResponse

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

Link copied to clipboard
abstract suspend fun listSimulationJobBatches(input: ListSimulationJobBatchesRequest = ListSimulationJobBatchesRequest { }): ListSimulationJobBatchesResponse

Returns a list simulation job batches. You can optionally provide filters to retrieve specific simulation batch jobs.

Link copied to clipboard
abstract suspend fun listSimulationJobs(input: ListSimulationJobsRequest = ListSimulationJobsRequest { }): ListSimulationJobsResponse

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

Link copied to clipboard

Lists all tags on a AWS RoboMaker resource.

Link copied to clipboard
abstract suspend fun listWorldExportJobs(input: ListWorldExportJobsRequest = ListWorldExportJobsRequest { }): ListWorldExportJobsResponse

Lists world export jobs.

Link copied to clipboard
abstract suspend fun listWorldGenerationJobs(input: ListWorldGenerationJobsRequest = ListWorldGenerationJobsRequest { }): ListWorldGenerationJobsResponse

Lists world generator jobs.

Link copied to clipboard
abstract suspend fun listWorlds(input: ListWorldsRequest = ListWorldsRequest { }): ListWorldsResponse

Lists worlds.

Link copied to clipboard
abstract suspend fun listWorldTemplates(input: ListWorldTemplatesRequest = ListWorldTemplatesRequest { }): ListWorldTemplatesResponse

Lists world templates.

Link copied to clipboard

Registers a robot with a fleet.

Link copied to clipboard

Restarts a running simulation job.

Link copied to clipboard

Starts a new simulation job batch. The batch is defined using one or more SimulationJobRequest objects.

Link copied to clipboard

Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds or edits tags for a AWS RoboMaker resource.

Link copied to clipboard

Removes the specified tags from the specified AWS RoboMaker resource.

Link copied to clipboard

Updates a robot application.

Link copied to clipboard

Updates a simulation application.

Link copied to clipboard

Updates a world template.

Inherited functions

Link copied to clipboard

Deletes one or more worlds in a batch operation.

Link copied to clipboard

Describes one or more simulation jobs.

Link copied to clipboard

Cancels the specified deployment job.

Link copied to clipboard

Cancels the specified simulation job.

Link copied to clipboard

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

Link copied to clipboard

Cancels the specified export job.

Link copied to clipboard

Cancels the specified world generator job.

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard

Deploys a specific version of a robot application to robots in a fleet.

Link copied to clipboard
inline suspend fun RoboMakerClient.createFleet(crossinline block: CreateFleetRequest.Builder.() -> Unit): CreateFleetResponse

Creates a fleet, a logical group of robots running the same robot application.

Link copied to clipboard
inline suspend fun RoboMakerClient.createRobot(crossinline block: CreateRobotRequest.Builder.() -> Unit): CreateRobotResponse

Creates a robot.

Link copied to clipboard

Creates a robot application.

Link copied to clipboard

Creates a version of a robot application.

Link copied to clipboard

Creates a simulation application.

Link copied to clipboard

Creates a simulation application with a specific revision id.

Link copied to clipboard

Creates a simulation job.

Link copied to clipboard

Creates a world export job.

Link copied to clipboard

Creates worlds using the specified template.

Link copied to clipboard

Creates a world template.

Link copied to clipboard
inline suspend fun RoboMakerClient.deleteFleet(crossinline block: DeleteFleetRequest.Builder.() -> Unit): DeleteFleetResponse

Deletes a fleet.

Link copied to clipboard
inline suspend fun RoboMakerClient.deleteRobot(crossinline block: DeleteRobotRequest.Builder.() -> Unit): DeleteRobotResponse

Deletes a robot.

Link copied to clipboard

Deletes a robot application.

Link copied to clipboard

Deletes a simulation application.

Link copied to clipboard

Deletes a world template.

Link copied to clipboard

Deregisters a robot.

Link copied to clipboard

Describes a deployment job.

Link copied to clipboard

Describes a fleet.

Link copied to clipboard

Describes a robot.

Link copied to clipboard

Describes a robot application.

Link copied to clipboard
Link copied to clipboard

Describes a simulation job.

Link copied to clipboard

Describes a simulation job batch.

Link copied to clipboard

Describes a world.

Link copied to clipboard

Describes a world export job.

Link copied to clipboard

Describes a world generation job.

Link copied to clipboard

Describes a world template.

Link copied to clipboard

Gets the world template body.

Link copied to clipboard

Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.

Link copied to clipboard
inline suspend fun RoboMakerClient.listFleets(crossinline block: ListFleetsRequest.Builder.() -> Unit): ListFleetsResponse

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

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard
inline suspend fun RoboMakerClient.listRobots(crossinline block: ListRobotsRequest.Builder.() -> Unit): ListRobotsResponse

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

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

Returns a list simulation job batches. You can optionally provide filters to retrieve specific simulation batch jobs.

Link copied to clipboard

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

Link copied to clipboard

Lists all tags on a AWS RoboMaker resource.

Link copied to clipboard

Lists world export jobs.

Link copied to clipboard

Lists world generator jobs.

Link copied to clipboard
inline suspend fun RoboMakerClient.listWorlds(crossinline block: ListWorldsRequest.Builder.() -> Unit): ListWorldsResponse

Lists worlds.

Link copied to clipboard
Link copied to clipboard

Lists world templates.

Link copied to clipboard

Registers a robot with a fleet.

Link copied to clipboard

Restarts a running simulation job.

Link copied to clipboard

Starts a new simulation job batch. The batch is defined using one or more SimulationJobRequest objects.

Link copied to clipboard

Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.

Link copied to clipboard
inline suspend fun RoboMakerClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds or edits tags for a AWS RoboMaker resource.

Link copied to clipboard

Removes the specified tags from the specified AWS RoboMaker resource.

Link copied to clipboard

Updates a robot application.

Link copied to clipboard

Updates a simulation application.

Link copied to clipboard

Updates a world template.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.