RoboMaker

import { RoboMaker } from "https://aws-api.deno.dev/v0.3/services/robomaker.ts?docs=full";

class RoboMaker {

constructor(apiFactory: client.ApiFactory);

async batchDeleteWorlds(params: BatchDeleteWorldsRequest, opts?: client.RequestOptions): Promise<BatchDeleteWorldsResponse>;

async batchDescribeSimulationJob(params: BatchDescribeSimulationJobRequest, opts?: client.RequestOptions): Promise<BatchDescribeSimulationJobResponse>;

async cancelDeploymentJob(params: CancelDeploymentJobRequest, opts?: client.RequestOptions): Promise<void>;

async cancelSimulationJob(params: CancelSimulationJobRequest, opts?: client.RequestOptions): Promise<void>;

async cancelSimulationJobBatch(params: CancelSimulationJobBatchRequest, opts?: client.RequestOptions): Promise<void>;

async cancelWorldExportJob(params: CancelWorldExportJobRequest, opts?: client.RequestOptions): Promise<void>;

async cancelWorldGenerationJob(params: CancelWorldGenerationJobRequest, opts?: client.RequestOptions): Promise<void>;

async createDeploymentJob(params: CreateDeploymentJobRequest, opts?: client.RequestOptions): Promise<CreateDeploymentJobResponse>;

async createFleet(params: CreateFleetRequest, opts?: client.RequestOptions): Promise<CreateFleetResponse>;

async createRobot(params: CreateRobotRequest, opts?: client.RequestOptions): Promise<CreateRobotResponse>;

async createRobotApplication(params: CreateRobotApplicationRequest, opts?: client.RequestOptions): Promise<CreateRobotApplicationResponse>;

async createRobotApplicationVersion(params: CreateRobotApplicationVersionRequest, opts?: client.RequestOptions): Promise<CreateRobotApplicationVersionResponse>;

async createSimulationApplication(params: CreateSimulationApplicationRequest, opts?: client.RequestOptions): Promise<CreateSimulationApplicationResponse>;

async createSimulationApplicationVersion(params: CreateSimulationApplicationVersionRequest, opts?: client.RequestOptions): Promise<CreateSimulationApplicationVersionResponse>;

async createSimulationJob(params: CreateSimulationJobRequest, opts?: client.RequestOptions): Promise<CreateSimulationJobResponse>;

async createWorldExportJob(params: CreateWorldExportJobRequest, opts?: client.RequestOptions): Promise<CreateWorldExportJobResponse>;

async createWorldGenerationJob(params: CreateWorldGenerationJobRequest, opts?: client.RequestOptions): Promise<CreateWorldGenerationJobResponse>;

async createWorldTemplate(params?: CreateWorldTemplateRequest, opts?: client.RequestOptions): Promise<CreateWorldTemplateResponse>;

async deleteFleet(params: DeleteFleetRequest, opts?: client.RequestOptions): Promise<void>;

async deleteRobot(params: DeleteRobotRequest, opts?: client.RequestOptions): Promise<void>;

async deleteRobotApplication(params: DeleteRobotApplicationRequest, opts?: client.RequestOptions): Promise<void>;

async deleteSimulationApplication(params: DeleteSimulationApplicationRequest, opts?: client.RequestOptions): Promise<void>;

async deleteWorldTemplate(params: DeleteWorldTemplateRequest, opts?: client.RequestOptions): Promise<void>;

async deregisterRobot(params: DeregisterRobotRequest, opts?: client.RequestOptions): Promise<DeregisterRobotResponse>;

async describeDeploymentJob(params: DescribeDeploymentJobRequest, opts?: client.RequestOptions): Promise<DescribeDeploymentJobResponse>;

async describeFleet(params: DescribeFleetRequest, opts?: client.RequestOptions): Promise<DescribeFleetResponse>;

async describeRobot(params: DescribeRobotRequest, opts?: client.RequestOptions): Promise<DescribeRobotResponse>;

async describeRobotApplication(params: DescribeRobotApplicationRequest, opts?: client.RequestOptions): Promise<DescribeRobotApplicationResponse>;

async describeSimulationApplication(params: DescribeSimulationApplicationRequest, opts?: client.RequestOptions): Promise<DescribeSimulationApplicationResponse>;

async describeSimulationJob(params: DescribeSimulationJobRequest, opts?: client.RequestOptions): Promise<DescribeSimulationJobResponse>;

async describeSimulationJobBatch(params: DescribeSimulationJobBatchRequest, opts?: client.RequestOptions): Promise<DescribeSimulationJobBatchResponse>;

async describeWorld(params: DescribeWorldRequest, opts?: client.RequestOptions): Promise<DescribeWorldResponse>;

async describeWorldExportJob(params: DescribeWorldExportJobRequest, opts?: client.RequestOptions): Promise<DescribeWorldExportJobResponse>;

async describeWorldGenerationJob(params: DescribeWorldGenerationJobRequest, opts?: client.RequestOptions): Promise<DescribeWorldGenerationJobResponse>;

async describeWorldTemplate(params: DescribeWorldTemplateRequest, opts?: client.RequestOptions): Promise<DescribeWorldTemplateResponse>;

async getWorldTemplateBody(params?: GetWorldTemplateBodyRequest, opts?: client.RequestOptions): Promise<GetWorldTemplateBodyResponse>;

async listDeploymentJobs(params?: ListDeploymentJobsRequest, opts?: client.RequestOptions): Promise<ListDeploymentJobsResponse>;

async listFleets(params?: ListFleetsRequest, opts?: client.RequestOptions): Promise<ListFleetsResponse>;

async listRobotApplications(params?: ListRobotApplicationsRequest, opts?: client.RequestOptions): Promise<ListRobotApplicationsResponse>;

async listRobots(params?: ListRobotsRequest, opts?: client.RequestOptions): Promise<ListRobotsResponse>;

async listSimulationApplications(params?: ListSimulationApplicationsRequest, opts?: client.RequestOptions): Promise<ListSimulationApplicationsResponse>;

async listSimulationJobBatches(params?: ListSimulationJobBatchesRequest, opts?: client.RequestOptions): Promise<ListSimulationJobBatchesResponse>;

async listSimulationJobs(params?: ListSimulationJobsRequest, opts?: client.RequestOptions): Promise<ListSimulationJobsResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async listWorldExportJobs(params?: ListWorldExportJobsRequest, opts?: client.RequestOptions): Promise<ListWorldExportJobsResponse>;

async listWorldGenerationJobs(params?: ListWorldGenerationJobsRequest, opts?: client.RequestOptions): Promise<ListWorldGenerationJobsResponse>;

async listWorlds(params?: ListWorldsRequest, opts?: client.RequestOptions): Promise<ListWorldsResponse>;

async listWorldTemplates(params?: ListWorldTemplatesRequest, opts?: client.RequestOptions): Promise<ListWorldTemplatesResponse>;

async registerRobot(params: RegisterRobotRequest, opts?: client.RequestOptions): Promise<RegisterRobotResponse>;

async restartSimulationJob(params: RestartSimulationJobRequest, opts?: client.RequestOptions): Promise<void>;

async startSimulationJobBatch(params: StartSimulationJobBatchRequest, opts?: client.RequestOptions): Promise<StartSimulationJobBatchResponse>;

async syncDeploymentJob(params: SyncDeploymentJobRequest, opts?: client.RequestOptions): Promise<SyncDeploymentJobResponse>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateRobotApplication(params: UpdateRobotApplicationRequest, opts?: client.RequestOptions): Promise<UpdateRobotApplicationResponse>;

async updateSimulationApplication(params: UpdateSimulationApplicationRequest, opts?: client.RequestOptions): Promise<UpdateSimulationApplicationResponse>;

async updateWorldTemplate(params: UpdateWorldTemplateRequest, opts?: client.RequestOptions): Promise<UpdateWorldTemplateResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new RoboMaker(apiFactory: client.ApiFactory)

[src]

§Methods

batchDeleteWorlds(params: BatchDeleteWorldsRequest, opts?: client.RequestOptions): Promise<BatchDeleteWorldsResponse>

[src]

Deletes one or more worlds in a batch operation.

batchDescribeSimulationJob(params: BatchDescribeSimulationJobRequest, opts?: client.RequestOptions): Promise<BatchDescribeSimulationJobResponse>

[src]

Describes one or more simulation jobs.

cancelDeploymentJob(params: CancelDeploymentJobRequest, opts?: client.RequestOptions): Promise<void>

[src]

Cancels the specified deployment job.

cancelSimulationJob(params: CancelSimulationJobRequest, opts?: client.RequestOptions): Promise<void>

[src]

Cancels the specified simulation job.

cancelSimulationJobBatch(params: CancelSimulationJobBatchRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

cancelWorldExportJob(params: CancelWorldExportJobRequest, opts?: client.RequestOptions): Promise<void>

[src]

Cancels the specified export job.

cancelWorldGenerationJob(params: CancelWorldGenerationJobRequest, opts?: client.RequestOptions): Promise<void>

[src]

Cancels the specified world generator job.

createDeploymentJob(params: CreateDeploymentJobRequest, opts?: client.RequestOptions): Promise<CreateDeploymentJobResponse>

[src]

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

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.

Note: After 90 days, deployment jobs expire and will be deleted. They will no longer be accessible.

createFleet(params: CreateFleetRequest, opts?: client.RequestOptions): Promise<CreateFleetResponse>

[src]

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

createRobot(params: CreateRobotRequest, opts?: client.RequestOptions): Promise<CreateRobotResponse>

[src]

Creates a robot.

createRobotApplication(params: CreateRobotApplicationRequest, opts?: client.RequestOptions): Promise<CreateRobotApplicationResponse>

[src]

Creates a robot application.

createRobotApplicationVersion(params: CreateRobotApplicationVersionRequest, opts?: client.RequestOptions): Promise<CreateRobotApplicationVersionResponse>

[src]

Creates a version of a robot application.

createSimulationApplication(params: CreateSimulationApplicationRequest, opts?: client.RequestOptions): Promise<CreateSimulationApplicationResponse>

[src]

Creates a simulation application.

createSimulationApplicationVersion(params: CreateSimulationApplicationVersionRequest, opts?: client.RequestOptions): Promise<CreateSimulationApplicationVersionResponse>

[src]

Creates a simulation application with a specific revision id.

createSimulationJob(params: CreateSimulationJobRequest, opts?: client.RequestOptions): Promise<CreateSimulationJobResponse>

[src]

Creates a simulation job.

Note: After 90 days, simulation jobs expire and will be deleted. They will no longer be accessible.

createWorldExportJob(params: CreateWorldExportJobRequest, opts?: client.RequestOptions): Promise<CreateWorldExportJobResponse>

[src]

Creates a world export job.

createWorldGenerationJob(params: CreateWorldGenerationJobRequest, opts?: client.RequestOptions): Promise<CreateWorldGenerationJobResponse>

[src]

Creates worlds using the specified template.

createWorldTemplate(params?: CreateWorldTemplateRequest, opts?: client.RequestOptions): Promise<CreateWorldTemplateResponse>

[src]

Creates a world template.

deleteFleet(params: DeleteFleetRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a fleet.

deleteRobot(params: DeleteRobotRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a robot.

deleteRobotApplication(params: DeleteRobotApplicationRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a robot application.

deleteSimulationApplication(params: DeleteSimulationApplicationRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a simulation application.

deleteWorldTemplate(params: DeleteWorldTemplateRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a world template.

deregisterRobot(params: DeregisterRobotRequest, opts?: client.RequestOptions): Promise<DeregisterRobotResponse>

[src]

Deregisters a robot.

describeDeploymentJob(params: DescribeDeploymentJobRequest, opts?: client.RequestOptions): Promise<DescribeDeploymentJobResponse>

[src]

Describes a deployment job.

describeFleet(params: DescribeFleetRequest, opts?: client.RequestOptions): Promise<DescribeFleetResponse>

[src]

Describes a fleet.

describeRobot(params: DescribeRobotRequest, opts?: client.RequestOptions): Promise<DescribeRobotResponse>

[src]

Describes a robot.

describeRobotApplication(params: DescribeRobotApplicationRequest, opts?: client.RequestOptions): Promise<DescribeRobotApplicationResponse>

[src]

Describes a robot application.

describeSimulationApplication(params: DescribeSimulationApplicationRequest, opts?: client.RequestOptions): Promise<DescribeSimulationApplicationResponse>

[src]

Describes a simulation application.

describeSimulationJob(params: DescribeSimulationJobRequest, opts?: client.RequestOptions): Promise<DescribeSimulationJobResponse>

[src]

Describes a simulation job.

describeSimulationJobBatch(params: DescribeSimulationJobBatchRequest, opts?: client.RequestOptions): Promise<DescribeSimulationJobBatchResponse>

[src]

Describes a simulation job batch.

describeWorld(params: DescribeWorldRequest, opts?: client.RequestOptions): Promise<DescribeWorldResponse>

[src]

Describes a world.

describeWorldExportJob(params: DescribeWorldExportJobRequest, opts?: client.RequestOptions): Promise<DescribeWorldExportJobResponse>

[src]

Describes a world export job.

describeWorldGenerationJob(params: DescribeWorldGenerationJobRequest, opts?: client.RequestOptions): Promise<DescribeWorldGenerationJobResponse>

[src]

Describes a world generation job.

describeWorldTemplate(params: DescribeWorldTemplateRequest, opts?: client.RequestOptions): Promise<DescribeWorldTemplateResponse>

[src]

Describes a world template.

getWorldTemplateBody(params?: GetWorldTemplateBodyRequest, opts?: client.RequestOptions): Promise<GetWorldTemplateBodyResponse>

[src]

Gets the world template body.

listDeploymentJobs(params?: ListDeploymentJobsRequest, opts?: client.RequestOptions): Promise<ListDeploymentJobsResponse>

[src]

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

listFleets(params?: ListFleetsRequest, opts?: client.RequestOptions): Promise<ListFleetsResponse>

[src]

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

listRobotApplications(params?: ListRobotApplicationsRequest, opts?: client.RequestOptions): Promise<ListRobotApplicationsResponse>

[src]

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

listRobots(params?: ListRobotsRequest, opts?: client.RequestOptions): Promise<ListRobotsResponse>

[src]

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

listSimulationApplications(params?: ListSimulationApplicationsRequest, opts?: client.RequestOptions): Promise<ListSimulationApplicationsResponse>

[src]

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

listSimulationJobBatches(params?: ListSimulationJobBatchesRequest, opts?: client.RequestOptions): Promise<ListSimulationJobBatchesResponse>

[src]

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

listSimulationJobs(params?: ListSimulationJobsRequest, opts?: client.RequestOptions): Promise<ListSimulationJobsResponse>

[src]

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

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

Lists all tags on a AWS RoboMaker resource.

listWorldExportJobs(params?: ListWorldExportJobsRequest, opts?: client.RequestOptions): Promise<ListWorldExportJobsResponse>

[src]

Lists world export jobs.

listWorldGenerationJobs(params?: ListWorldGenerationJobsRequest, opts?: client.RequestOptions): Promise<ListWorldGenerationJobsResponse>

[src]

Lists world generator jobs.

listWorlds(params?: ListWorldsRequest, opts?: client.RequestOptions): Promise<ListWorldsResponse>

[src]

Lists worlds.

listWorldTemplates(params?: ListWorldTemplatesRequest, opts?: client.RequestOptions): Promise<ListWorldTemplatesResponse>

[src]

Lists world templates.

registerRobot(params: RegisterRobotRequest, opts?: client.RequestOptions): Promise<RegisterRobotResponse>

[src]

Registers a robot with a fleet.

restartSimulationJob(params: RestartSimulationJobRequest, opts?: client.RequestOptions): Promise<void>

[src]

Restarts a running simulation job.

startSimulationJobBatch(params: StartSimulationJobBatchRequest, opts?: client.RequestOptions): Promise<StartSimulationJobBatchResponse>

[src]

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

syncDeploymentJob(params: SyncDeploymentJobRequest, opts?: client.RequestOptions): Promise<SyncDeploymentJobResponse>

[src]

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

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

updateRobotApplication(params: UpdateRobotApplicationRequest, opts?: client.RequestOptions): Promise<UpdateRobotApplicationResponse>

[src]

Updates a robot application.

updateSimulationApplication(params: UpdateSimulationApplicationRequest, opts?: client.RequestOptions): Promise<UpdateSimulationApplicationResponse>

[src]

Updates a simulation application.

updateWorldTemplate(params: UpdateWorldTemplateRequest, opts?: client.RequestOptions): Promise<UpdateWorldTemplateResponse>

[src]

Updates a world template.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]