robomaker/aws.sdk.kotlin.services.robomaker

Package-level declarations

Types

Link copied to clipboard
interface RoboMakerClient : SdkClient

This section provides documentation for the AWS RoboMaker API operations.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard
inline suspend fun RoboMakerClient.batchDeleteWorlds(crossinline block: BatchDeleteWorldsRequest.Builder.() -> Unit): BatchDeleteWorldsResponse

Deletes one or more worlds in a batch operation.

Link copied to clipboard
inline suspend fun RoboMakerClient.batchDescribeSimulationJob(crossinline block: BatchDescribeSimulationJobRequest.Builder.() -> Unit): BatchDescribeSimulationJobResponse

Describes one or more simulation jobs.

Link copied to clipboard
inline suspend fun RoboMakerClient.cancelDeploymentJob(crossinline block: CancelDeploymentJobRequest.Builder.() -> Unit): CancelDeploymentJobResponse

Cancels the specified deployment job.

Link copied to clipboard
inline suspend fun RoboMakerClient.cancelSimulationJob(crossinline block: CancelSimulationJobRequest.Builder.() -> Unit): CancelSimulationJobResponse

Cancels the specified simulation job.

Link copied to clipboard
inline suspend fun RoboMakerClient.cancelSimulationJobBatch(crossinline block: CancelSimulationJobBatchRequest.Builder.() -> Unit): CancelSimulationJobBatchResponse

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
inline suspend fun RoboMakerClient.cancelWorldExportJob(crossinline block: CancelWorldExportJobRequest.Builder.() -> Unit): CancelWorldExportJobResponse

Cancels the specified export job.

Link copied to clipboard
inline suspend fun RoboMakerClient.cancelWorldGenerationJob(crossinline block: CancelWorldGenerationJobRequest.Builder.() -> Unit): CancelWorldGenerationJobResponse

Cancels the specified world generator job.

Link copied to clipboard
inline suspend fun RoboMakerClient.createDeploymentJob(crossinline block: CreateDeploymentJobRequest.Builder.() -> Unit): CreateDeploymentJobResponse

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
inline suspend fun RoboMakerClient.createRobotApplication(crossinline block: CreateRobotApplicationRequest.Builder.() -> Unit): CreateRobotApplicationResponse

Creates a robot application.

Link copied to clipboard
inline suspend fun RoboMakerClient.createRobotApplicationVersion(crossinline block: CreateRobotApplicationVersionRequest.Builder.() -> Unit): CreateRobotApplicationVersionResponse

Creates a version of a robot application.

Link copied to clipboard
inline suspend fun RoboMakerClient.createSimulationApplication(crossinline block: CreateSimulationApplicationRequest.Builder.() -> Unit): CreateSimulationApplicationResponse

Creates a simulation application.

Link copied to clipboard
inline suspend fun RoboMakerClient.createSimulationApplicationVersion(crossinline block: CreateSimulationApplicationVersionRequest.Builder.() -> Unit): CreateSimulationApplicationVersionResponse

Creates a simulation application with a specific revision id.

Link copied to clipboard
inline suspend fun RoboMakerClient.createSimulationJob(crossinline block: CreateSimulationJobRequest.Builder.() -> Unit): CreateSimulationJobResponse

Creates a simulation job.

Link copied to clipboard
inline suspend fun RoboMakerClient.createWorldExportJob(crossinline block: CreateWorldExportJobRequest.Builder.() -> Unit): CreateWorldExportJobResponse

Creates a world export job.

Link copied to clipboard
inline suspend fun RoboMakerClient.createWorldGenerationJob(crossinline block: CreateWorldGenerationJobRequest.Builder.() -> Unit): CreateWorldGenerationJobResponse

Creates worlds using the specified template.

Link copied to clipboard
inline suspend fun RoboMakerClient.createWorldTemplate(crossinline block: CreateWorldTemplateRequest.Builder.() -> Unit): CreateWorldTemplateResponse

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
inline suspend fun RoboMakerClient.deleteRobotApplication(crossinline block: DeleteRobotApplicationRequest.Builder.() -> Unit): DeleteRobotApplicationResponse

Deletes a robot application.

Link copied to clipboard
inline suspend fun RoboMakerClient.deleteSimulationApplication(crossinline block: DeleteSimulationApplicationRequest.Builder.() -> Unit): DeleteSimulationApplicationResponse

Deletes a simulation application.

Link copied to clipboard
inline suspend fun RoboMakerClient.deleteWorldTemplate(crossinline block: DeleteWorldTemplateRequest.Builder.() -> Unit): DeleteWorldTemplateResponse

Deletes a world template.

Link copied to clipboard
inline suspend fun RoboMakerClient.deregisterRobot(crossinline block: DeregisterRobotRequest.Builder.() -> Unit): DeregisterRobotResponse

Deregisters a robot.

Link copied to clipboard
inline suspend fun RoboMakerClient.describeDeploymentJob(crossinline block: DescribeDeploymentJobRequest.Builder.() -> Unit): DescribeDeploymentJobResponse

Describes a deployment job.

Link copied to clipboard
inline suspend fun RoboMakerClient.describeFleet(crossinline block: DescribeFleetRequest.Builder.() -> Unit): DescribeFleetResponse

Describes a fleet.

Link copied to clipboard
inline suspend fun RoboMakerClient.describeRobot(crossinline block: DescribeRobotRequest.Builder.() -> Unit): DescribeRobotResponse

Describes a robot.

Link copied to clipboard
inline suspend fun RoboMakerClient.describeRobotApplication(crossinline block: DescribeRobotApplicationRequest.Builder.() -> Unit): DescribeRobotApplicationResponse

Describes a robot application.

Link copied to clipboard
inline suspend fun RoboMakerClient.describeSimulationApplication(crossinline block: DescribeSimulationApplicationRequest.Builder.() -> Unit): DescribeSimulationApplicationResponse

Describes a simulation application.

Link copied to clipboard
inline suspend fun RoboMakerClient.describeSimulationJob(crossinline block: DescribeSimulationJobRequest.Builder.() -> Unit): DescribeSimulationJobResponse

Describes a simulation job.

Link copied to clipboard
inline suspend fun RoboMakerClient.describeSimulationJobBatch(crossinline block: DescribeSimulationJobBatchRequest.Builder.() -> Unit): DescribeSimulationJobBatchResponse

Describes a simulation job batch.

Link copied to clipboard
inline suspend fun RoboMakerClient.describeWorld(crossinline block: DescribeWorldRequest.Builder.() -> Unit): DescribeWorldResponse

Describes a world.

Link copied to clipboard
inline suspend fun RoboMakerClient.describeWorldExportJob(crossinline block: DescribeWorldExportJobRequest.Builder.() -> Unit): DescribeWorldExportJobResponse

Describes a world export job.

Link copied to clipboard
inline suspend fun RoboMakerClient.describeWorldGenerationJob(crossinline block: DescribeWorldGenerationJobRequest.Builder.() -> Unit): DescribeWorldGenerationJobResponse

Describes a world generation job.

Link copied to clipboard
inline suspend fun RoboMakerClient.describeWorldTemplate(crossinline block: DescribeWorldTemplateRequest.Builder.() -> Unit): DescribeWorldTemplateResponse

Describes a world template.

Link copied to clipboard
inline suspend fun RoboMakerClient.getWorldTemplateBody(crossinline block: GetWorldTemplateBodyRequest.Builder.() -> Unit): GetWorldTemplateBodyResponse

Gets the world template body.

Link copied to clipboard
inline suspend fun RoboMakerClient.listDeploymentJobs(crossinline block: ListDeploymentJobsRequest.Builder.() -> Unit): ListDeploymentJobsResponse

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
inline suspend fun RoboMakerClient.listRobotApplications(crossinline block: ListRobotApplicationsRequest.Builder.() -> Unit): ListRobotApplicationsResponse

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
inline suspend fun RoboMakerClient.listSimulationApplications(crossinline block: ListSimulationApplicationsRequest.Builder.() -> Unit): ListSimulationApplicationsResponse

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

Link copied to clipboard
inline suspend fun RoboMakerClient.listSimulationJobBatches(crossinline block: ListSimulationJobBatchesRequest.Builder.() -> Unit): ListSimulationJobBatchesResponse

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

Link copied to clipboard
inline suspend fun RoboMakerClient.listSimulationJobs(crossinline block: ListSimulationJobsRequest.Builder.() -> Unit): ListSimulationJobsResponse

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

Link copied to clipboard
inline suspend fun RoboMakerClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists all tags on a AWS RoboMaker resource.

Link copied to clipboard
inline suspend fun RoboMakerClient.listWorldExportJobs(crossinline block: ListWorldExportJobsRequest.Builder.() -> Unit): ListWorldExportJobsResponse

Lists world export jobs.

Link copied to clipboard
inline suspend fun RoboMakerClient.listWorldGenerationJobs(crossinline block: ListWorldGenerationJobsRequest.Builder.() -> Unit): ListWorldGenerationJobsResponse

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
inline suspend fun RoboMakerClient.listWorldTemplates(crossinline block: ListWorldTemplatesRequest.Builder.() -> Unit): ListWorldTemplatesResponse

Lists world templates.

Link copied to clipboard
inline suspend fun RoboMakerClient.registerRobot(crossinline block: RegisterRobotRequest.Builder.() -> Unit): RegisterRobotResponse

Registers a robot with a fleet.

Link copied to clipboard
inline suspend fun RoboMakerClient.restartSimulationJob(crossinline block: RestartSimulationJobRequest.Builder.() -> Unit): RestartSimulationJobResponse

Restarts a running simulation job.

Link copied to clipboard
inline suspend fun RoboMakerClient.startSimulationJobBatch(crossinline block: StartSimulationJobBatchRequest.Builder.() -> Unit): StartSimulationJobBatchResponse

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

Link copied to clipboard
inline suspend fun RoboMakerClient.syncDeploymentJob(crossinline block: SyncDeploymentJobRequest.Builder.() -> Unit): SyncDeploymentJobResponse

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
inline suspend fun RoboMakerClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes the specified tags from the specified AWS RoboMaker resource.

Link copied to clipboard
inline suspend fun RoboMakerClient.updateRobotApplication(crossinline block: UpdateRobotApplicationRequest.Builder.() -> Unit): UpdateRobotApplicationResponse

Updates a robot application.

Link copied to clipboard
inline suspend fun RoboMakerClient.updateSimulationApplication(crossinline block: UpdateSimulationApplicationRequest.Builder.() -> Unit): UpdateSimulationApplicationResponse

Updates a simulation application.

Link copied to clipboard
inline suspend fun RoboMakerClient.updateWorldTemplate(crossinline block: UpdateWorldTemplateRequest.Builder.() -> Unit): UpdateWorldTemplateResponse

Updates a world template.

Link copied to clipboard
fun RoboMakerClient.withConfig(block: RoboMakerClient.Config.Builder.() -> Unit): RoboMakerClient

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.