@Generated(value="software.amazon.awssdk:codegen") public interface RoboMakerAsyncClient extends SdkClient
builder()
method.
his section provides documentation for the AWS RoboMaker API operations.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
serviceNameclosestatic final String SERVICE_NAME
static RoboMakerAsyncClient create()
RoboMakerAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static RoboMakerAsyncClientBuilder builder()
RoboMakerAsyncClient.default CompletableFuture<BatchDescribeSimulationJobResponse> batchDescribeSimulationJob(BatchDescribeSimulationJobRequest batchDescribeSimulationJobRequest)
Describes one or more simulation jobs.
batchDescribeSimulationJobRequest - default CompletableFuture<BatchDescribeSimulationJobResponse> batchDescribeSimulationJob(Consumer<BatchDescribeSimulationJobRequest.Builder> batchDescribeSimulationJobRequest)
Describes one or more simulation jobs.
This is a convenience which creates an instance of the BatchDescribeSimulationJobRequest.Builder avoiding
the need to create one manually via BatchDescribeSimulationJobRequest.builder()
batchDescribeSimulationJobRequest - A Consumer that will call methods on BatchDescribeSimulationJobRequest.Builder to create a
request.default CompletableFuture<CancelSimulationJobResponse> cancelSimulationJob(CancelSimulationJobRequest cancelSimulationJobRequest)
Cancels the specified simulation job.
cancelSimulationJobRequest - default CompletableFuture<CancelSimulationJobResponse> cancelSimulationJob(Consumer<CancelSimulationJobRequest.Builder> cancelSimulationJobRequest)
Cancels the specified simulation job.
This is a convenience which creates an instance of the CancelSimulationJobRequest.Builder avoiding the
need to create one manually via CancelSimulationJobRequest.builder()
cancelSimulationJobRequest - A Consumer that will call methods on CancelSimulationJobRequest.Builder to create a
request.default CompletableFuture<CreateDeploymentJobResponse> createDeploymentJob(CreateDeploymentJobRequest createDeploymentJobRequest)
Creates a deployment job.
createDeploymentJobRequest - default CompletableFuture<CreateDeploymentJobResponse> createDeploymentJob(Consumer<CreateDeploymentJobRequest.Builder> createDeploymentJobRequest)
Creates a deployment job.
This is a convenience which creates an instance of the CreateDeploymentJobRequest.Builder avoiding the
need to create one manually via CreateDeploymentJobRequest.builder()
createDeploymentJobRequest - A Consumer that will call methods on CreateDeploymentJobRequest.Builder to create a
request.default CompletableFuture<CreateFleetResponse> createFleet(CreateFleetRequest createFleetRequest)
Creates a fleet, a logical group of robots running the same robot application.
createFleetRequest - default CompletableFuture<CreateFleetResponse> createFleet(Consumer<CreateFleetRequest.Builder> createFleetRequest)
Creates a fleet, a logical group of robots running the same robot application.
This is a convenience which creates an instance of the CreateFleetRequest.Builder avoiding the need to
create one manually via CreateFleetRequest.builder()
createFleetRequest - A Consumer that will call methods on CreateFleetRequest.Builder to create a request.default CompletableFuture<CreateRobotResponse> createRobot(CreateRobotRequest createRobotRequest)
Creates a robot.
createRobotRequest - default CompletableFuture<CreateRobotResponse> createRobot(Consumer<CreateRobotRequest.Builder> createRobotRequest)
Creates a robot.
This is a convenience which creates an instance of the CreateRobotRequest.Builder avoiding the need to
create one manually via CreateRobotRequest.builder()
createRobotRequest - A Consumer that will call methods on CreateRobotRequest.Builder to create a request.default CompletableFuture<CreateRobotApplicationResponse> createRobotApplication(CreateRobotApplicationRequest createRobotApplicationRequest)
Creates a robot application.
createRobotApplicationRequest - default CompletableFuture<CreateRobotApplicationResponse> createRobotApplication(Consumer<CreateRobotApplicationRequest.Builder> createRobotApplicationRequest)
Creates a robot application.
This is a convenience which creates an instance of the CreateRobotApplicationRequest.Builder avoiding the
need to create one manually via CreateRobotApplicationRequest.builder()
createRobotApplicationRequest - A Consumer that will call methods on CreateRobotApplicationRequest.Builder to create a
request.default CompletableFuture<CreateRobotApplicationVersionResponse> createRobotApplicationVersion(CreateRobotApplicationVersionRequest createRobotApplicationVersionRequest)
Creates a version of a robot application.
createRobotApplicationVersionRequest - default CompletableFuture<CreateRobotApplicationVersionResponse> createRobotApplicationVersion(Consumer<CreateRobotApplicationVersionRequest.Builder> createRobotApplicationVersionRequest)
Creates a version of a robot application.
This is a convenience which creates an instance of the CreateRobotApplicationVersionRequest.Builder
avoiding the need to create one manually via CreateRobotApplicationVersionRequest.builder()
createRobotApplicationVersionRequest - A Consumer that will call methods on CreateRobotApplicationVersionRequest.Builder to
create a request.default CompletableFuture<CreateSimulationApplicationResponse> createSimulationApplication(CreateSimulationApplicationRequest createSimulationApplicationRequest)
Creates a simulation application.
createSimulationApplicationRequest - default CompletableFuture<CreateSimulationApplicationResponse> createSimulationApplication(Consumer<CreateSimulationApplicationRequest.Builder> createSimulationApplicationRequest)
Creates a simulation application.
This is a convenience which creates an instance of the CreateSimulationApplicationRequest.Builder
avoiding the need to create one manually via CreateSimulationApplicationRequest.builder()
createSimulationApplicationRequest - A Consumer that will call methods on CreateSimulationApplicationRequest.Builder to create
a request.default CompletableFuture<CreateSimulationApplicationVersionResponse> createSimulationApplicationVersion(CreateSimulationApplicationVersionRequest createSimulationApplicationVersionRequest)
Creates a simulation application with a specific revision id.
createSimulationApplicationVersionRequest - default CompletableFuture<CreateSimulationApplicationVersionResponse> createSimulationApplicationVersion(Consumer<CreateSimulationApplicationVersionRequest.Builder> createSimulationApplicationVersionRequest)
Creates a simulation application with a specific revision id.
This is a convenience which creates an instance of the CreateSimulationApplicationVersionRequest.Builder
avoiding the need to create one manually via CreateSimulationApplicationVersionRequest.builder()
createSimulationApplicationVersionRequest - A Consumer that will call methods on CreateSimulationApplicationVersionRequest.Builder to
create a request.default CompletableFuture<CreateSimulationJobResponse> createSimulationJob(CreateSimulationJobRequest createSimulationJobRequest)
Creates a simulation job.
createSimulationJobRequest - default CompletableFuture<CreateSimulationJobResponse> createSimulationJob(Consumer<CreateSimulationJobRequest.Builder> createSimulationJobRequest)
Creates a simulation job.
This is a convenience which creates an instance of the CreateSimulationJobRequest.Builder avoiding the
need to create one manually via CreateSimulationJobRequest.builder()
createSimulationJobRequest - A Consumer that will call methods on CreateSimulationJobRequest.Builder to create a
request.default CompletableFuture<DeleteFleetResponse> deleteFleet(DeleteFleetRequest deleteFleetRequest)
Deletes a fleet.
deleteFleetRequest - default CompletableFuture<DeleteFleetResponse> deleteFleet(Consumer<DeleteFleetRequest.Builder> deleteFleetRequest)
Deletes a fleet.
This is a convenience which creates an instance of the DeleteFleetRequest.Builder avoiding the need to
create one manually via DeleteFleetRequest.builder()
deleteFleetRequest - A Consumer that will call methods on DeleteFleetRequest.Builder to create a request.default CompletableFuture<DeleteRobotResponse> deleteRobot(DeleteRobotRequest deleteRobotRequest)
Deletes a robot.
deleteRobotRequest - default CompletableFuture<DeleteRobotResponse> deleteRobot(Consumer<DeleteRobotRequest.Builder> deleteRobotRequest)
Deletes a robot.
This is a convenience which creates an instance of the DeleteRobotRequest.Builder avoiding the need to
create one manually via DeleteRobotRequest.builder()
deleteRobotRequest - A Consumer that will call methods on DeleteRobotRequest.Builder to create a request.default CompletableFuture<DeleteRobotApplicationResponse> deleteRobotApplication(DeleteRobotApplicationRequest deleteRobotApplicationRequest)
Deletes a robot application.
deleteRobotApplicationRequest - default CompletableFuture<DeleteRobotApplicationResponse> deleteRobotApplication(Consumer<DeleteRobotApplicationRequest.Builder> deleteRobotApplicationRequest)
Deletes a robot application.
This is a convenience which creates an instance of the DeleteRobotApplicationRequest.Builder avoiding the
need to create one manually via DeleteRobotApplicationRequest.builder()
deleteRobotApplicationRequest - A Consumer that will call methods on DeleteRobotApplicationRequest.Builder to create a
request.default CompletableFuture<DeleteSimulationApplicationResponse> deleteSimulationApplication(DeleteSimulationApplicationRequest deleteSimulationApplicationRequest)
Deletes a simulation application.
deleteSimulationApplicationRequest - default CompletableFuture<DeleteSimulationApplicationResponse> deleteSimulationApplication(Consumer<DeleteSimulationApplicationRequest.Builder> deleteSimulationApplicationRequest)
Deletes a simulation application.
This is a convenience which creates an instance of the DeleteSimulationApplicationRequest.Builder
avoiding the need to create one manually via DeleteSimulationApplicationRequest.builder()
deleteSimulationApplicationRequest - A Consumer that will call methods on DeleteSimulationApplicationRequest.Builder to create
a request.default CompletableFuture<DeregisterRobotResponse> deregisterRobot(DeregisterRobotRequest deregisterRobotRequest)
Deregisters a robot.
deregisterRobotRequest - default CompletableFuture<DeregisterRobotResponse> deregisterRobot(Consumer<DeregisterRobotRequest.Builder> deregisterRobotRequest)
Deregisters a robot.
This is a convenience which creates an instance of the DeregisterRobotRequest.Builder avoiding the need
to create one manually via DeregisterRobotRequest.builder()
deregisterRobotRequest - A Consumer that will call methods on DeregisterRobotRequest.Builder to create a request.default CompletableFuture<DescribeDeploymentJobResponse> describeDeploymentJob(DescribeDeploymentJobRequest describeDeploymentJobRequest)
Describes a deployment job. [Does it work regardless of deployment status, e.g. Failed?]
describeDeploymentJobRequest - default CompletableFuture<DescribeDeploymentJobResponse> describeDeploymentJob(Consumer<DescribeDeploymentJobRequest.Builder> describeDeploymentJobRequest)
Describes a deployment job. [Does it work regardless of deployment status, e.g. Failed?]
This is a convenience which creates an instance of the DescribeDeploymentJobRequest.Builder avoiding the
need to create one manually via DescribeDeploymentJobRequest.builder()
describeDeploymentJobRequest - A Consumer that will call methods on DescribeDeploymentJobRequest.Builder to create a
request.default CompletableFuture<DescribeFleetResponse> describeFleet(DescribeFleetRequest describeFleetRequest)
Describes a fleet.
describeFleetRequest - default CompletableFuture<DescribeFleetResponse> describeFleet(Consumer<DescribeFleetRequest.Builder> describeFleetRequest)
Describes a fleet.
This is a convenience which creates an instance of the DescribeFleetRequest.Builder avoiding the need to
create one manually via DescribeFleetRequest.builder()
describeFleetRequest - A Consumer that will call methods on DescribeFleetRequest.Builder to create a request.default CompletableFuture<DescribeRobotResponse> describeRobot(DescribeRobotRequest describeRobotRequest)
Describes a robot.
describeRobotRequest - default CompletableFuture<DescribeRobotResponse> describeRobot(Consumer<DescribeRobotRequest.Builder> describeRobotRequest)
Describes a robot.
This is a convenience which creates an instance of the DescribeRobotRequest.Builder avoiding the need to
create one manually via DescribeRobotRequest.builder()
describeRobotRequest - A Consumer that will call methods on DescribeRobotRequest.Builder to create a request.default CompletableFuture<DescribeRobotApplicationResponse> describeRobotApplication(DescribeRobotApplicationRequest describeRobotApplicationRequest)
Describes a robot application.
describeRobotApplicationRequest - default CompletableFuture<DescribeRobotApplicationResponse> describeRobotApplication(Consumer<DescribeRobotApplicationRequest.Builder> describeRobotApplicationRequest)
Describes a robot application.
This is a convenience which creates an instance of the DescribeRobotApplicationRequest.Builder avoiding
the need to create one manually via DescribeRobotApplicationRequest.builder()
describeRobotApplicationRequest - A Consumer that will call methods on DescribeRobotApplicationRequest.Builder to create a
request.default CompletableFuture<DescribeSimulationApplicationResponse> describeSimulationApplication(DescribeSimulationApplicationRequest describeSimulationApplicationRequest)
Describes a simulation application.
describeSimulationApplicationRequest - default CompletableFuture<DescribeSimulationApplicationResponse> describeSimulationApplication(Consumer<DescribeSimulationApplicationRequest.Builder> describeSimulationApplicationRequest)
Describes a simulation application.
This is a convenience which creates an instance of the DescribeSimulationApplicationRequest.Builder
avoiding the need to create one manually via DescribeSimulationApplicationRequest.builder()
describeSimulationApplicationRequest - A Consumer that will call methods on DescribeSimulationApplicationRequest.Builder to
create a request.default CompletableFuture<DescribeSimulationJobResponse> describeSimulationJob(DescribeSimulationJobRequest describeSimulationJobRequest)
Describes a simulation job.
describeSimulationJobRequest - default CompletableFuture<DescribeSimulationJobResponse> describeSimulationJob(Consumer<DescribeSimulationJobRequest.Builder> describeSimulationJobRequest)
Describes a simulation job.
This is a convenience which creates an instance of the DescribeSimulationJobRequest.Builder avoiding the
need to create one manually via DescribeSimulationJobRequest.builder()
describeSimulationJobRequest - A Consumer that will call methods on DescribeSimulationJobRequest.Builder to create a
request.default CompletableFuture<ListDeploymentJobsResponse> listDeploymentJobs(ListDeploymentJobsRequest listDeploymentJobsRequest)
Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.
listDeploymentJobsRequest - default CompletableFuture<ListDeploymentJobsResponse> listDeploymentJobs(Consumer<ListDeploymentJobsRequest.Builder> listDeploymentJobsRequest)
Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.
This is a convenience which creates an instance of the ListDeploymentJobsRequest.Builder avoiding the
need to create one manually via ListDeploymentJobsRequest.builder()
listDeploymentJobsRequest - A Consumer that will call methods on ListDeploymentJobsRequest.Builder to create a
request.default CompletableFuture<ListDeploymentJobsResponse> listDeploymentJobs()
Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.
default CompletableFuture<ListFleetsResponse> listFleets(ListFleetsRequest listFleetsRequest)
Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.
listFleetsRequest - default CompletableFuture<ListFleetsResponse> listFleets(Consumer<ListFleetsRequest.Builder> listFleetsRequest)
Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.
This is a convenience which creates an instance of the ListFleetsRequest.Builder avoiding the need to
create one manually via ListFleetsRequest.builder()
listFleetsRequest - A Consumer that will call methods on ListFleetsRequest.Builder to create a request.default CompletableFuture<ListFleetsResponse> listFleets()
Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.
default CompletableFuture<ListRobotApplicationsResponse> listRobotApplications(ListRobotApplicationsRequest listRobotApplicationsRequest)
Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications.
listRobotApplicationsRequest - default CompletableFuture<ListRobotApplicationsResponse> listRobotApplications(Consumer<ListRobotApplicationsRequest.Builder> listRobotApplicationsRequest)
Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications.
This is a convenience which creates an instance of the ListRobotApplicationsRequest.Builder avoiding the
need to create one manually via ListRobotApplicationsRequest.builder()
listRobotApplicationsRequest - A Consumer that will call methods on ListRobotApplicationsRequest.Builder to create a
request.default CompletableFuture<ListRobotApplicationsResponse> listRobotApplications()
Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications.
default CompletableFuture<ListRobotsResponse> listRobots(ListRobotsRequest listRobotsRequest)
Returns a list of robots. You can optionally provide filters to retrieve specific robots.
listRobotsRequest - default CompletableFuture<ListRobotsResponse> listRobots(Consumer<ListRobotsRequest.Builder> listRobotsRequest)
Returns a list of robots. You can optionally provide filters to retrieve specific robots.
This is a convenience which creates an instance of the ListRobotsRequest.Builder avoiding the need to
create one manually via ListRobotsRequest.builder()
listRobotsRequest - A Consumer that will call methods on ListRobotsRequest.Builder to create a request.default CompletableFuture<ListRobotsResponse> listRobots()
Returns a list of robots. You can optionally provide filters to retrieve specific robots.
default CompletableFuture<ListSimulationApplicationsResponse> listSimulationApplications(ListSimulationApplicationsRequest listSimulationApplicationsRequest)
Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications.
listSimulationApplicationsRequest - default CompletableFuture<ListSimulationApplicationsResponse> listSimulationApplications(Consumer<ListSimulationApplicationsRequest.Builder> listSimulationApplicationsRequest)
Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications.
This is a convenience which creates an instance of the ListSimulationApplicationsRequest.Builder avoiding
the need to create one manually via ListSimulationApplicationsRequest.builder()
listSimulationApplicationsRequest - A Consumer that will call methods on ListSimulationApplicationsRequest.Builder to create a
request.default CompletableFuture<ListSimulationApplicationsResponse> listSimulationApplications()
Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications.
default CompletableFuture<ListSimulationJobsResponse> listSimulationJobs(ListSimulationJobsRequest listSimulationJobsRequest)
Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs.
listSimulationJobsRequest - default CompletableFuture<ListSimulationJobsResponse> listSimulationJobs(Consumer<ListSimulationJobsRequest.Builder> listSimulationJobsRequest)
Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs.
This is a convenience which creates an instance of the ListSimulationJobsRequest.Builder avoiding the
need to create one manually via ListSimulationJobsRequest.builder()
listSimulationJobsRequest - A Consumer that will call methods on ListSimulationJobsRequest.Builder to create a
request.default CompletableFuture<ListSimulationJobsResponse> listSimulationJobs()
Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs.
default CompletableFuture<RegisterRobotResponse> registerRobot(RegisterRobotRequest registerRobotRequest)
Registers a robot with a fleet.
registerRobotRequest - default CompletableFuture<RegisterRobotResponse> registerRobot(Consumer<RegisterRobotRequest.Builder> registerRobotRequest)
Registers a robot with a fleet.
This is a convenience which creates an instance of the RegisterRobotRequest.Builder avoiding the need to
create one manually via RegisterRobotRequest.builder()
registerRobotRequest - A Consumer that will call methods on RegisterRobotRequest.Builder to create a request.default CompletableFuture<RestartSimulationJobResponse> restartSimulationJob(RestartSimulationJobRequest restartSimulationJobRequest)
Restarts a running simulation job.
restartSimulationJobRequest - default CompletableFuture<RestartSimulationJobResponse> restartSimulationJob(Consumer<RestartSimulationJobRequest.Builder> restartSimulationJobRequest)
Restarts a running simulation job.
This is a convenience which creates an instance of the RestartSimulationJobRequest.Builder avoiding the
need to create one manually via RestartSimulationJobRequest.builder()
restartSimulationJobRequest - A Consumer that will call methods on RestartSimulationJobRequest.Builder to create a
request.default CompletableFuture<SyncDeploymentJobResponse> syncDeploymentJob(SyncDeploymentJobRequest syncDeploymentJobRequest)
Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.
syncDeploymentJobRequest - default CompletableFuture<SyncDeploymentJobResponse> syncDeploymentJob(Consumer<SyncDeploymentJobRequest.Builder> syncDeploymentJobRequest)
Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.
This is a convenience which creates an instance of the SyncDeploymentJobRequest.Builder avoiding the need
to create one manually via SyncDeploymentJobRequest.builder()
syncDeploymentJobRequest - A Consumer that will call methods on SyncDeploymentJobRequest.Builder to create a request.default CompletableFuture<UpdateRobotApplicationResponse> updateRobotApplication(UpdateRobotApplicationRequest updateRobotApplicationRequest)
Updates a robot application.
updateRobotApplicationRequest - default CompletableFuture<UpdateRobotApplicationResponse> updateRobotApplication(Consumer<UpdateRobotApplicationRequest.Builder> updateRobotApplicationRequest)
Updates a robot application.
This is a convenience which creates an instance of the UpdateRobotApplicationRequest.Builder avoiding the
need to create one manually via UpdateRobotApplicationRequest.builder()
updateRobotApplicationRequest - A Consumer that will call methods on UpdateRobotApplicationRequest.Builder to create a
request.default CompletableFuture<UpdateSimulationApplicationResponse> updateSimulationApplication(UpdateSimulationApplicationRequest updateSimulationApplicationRequest)
Updates a simulation application.
updateSimulationApplicationRequest - default CompletableFuture<UpdateSimulationApplicationResponse> updateSimulationApplication(Consumer<UpdateSimulationApplicationRequest.Builder> updateSimulationApplicationRequest)
Updates a simulation application.
This is a convenience which creates an instance of the UpdateSimulationApplicationRequest.Builder
avoiding the need to create one manually via UpdateSimulationApplicationRequest.builder()
updateSimulationApplicationRequest - A Consumer that will call methods on UpdateSimulationApplicationRequest.Builder to create
a request.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.