@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSRoboMaker
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSRoboMaker instead.
his section provides documentation for the AWS RoboMaker API operations.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
static final String ENDPOINT_PREFIX
BatchDescribeSimulationJobResult batchDescribeSimulationJob(BatchDescribeSimulationJobRequest batchDescribeSimulationJobRequest)
Describes one or more simulation jobs.
batchDescribeSimulationJobRequest - ResourceNotFoundException - The specified resource does not exist.InvalidParameterException - A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException - AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException - AWS RoboMaker is temporarily unable to process the request. Try your call again.CancelSimulationJobResult cancelSimulationJob(CancelSimulationJobRequest cancelSimulationJobRequest)
Cancels the specified simulation job.
cancelSimulationJobRequest - ResourceNotFoundException - The specified resource does not exist.InvalidParameterException - A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException - AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException - AWS RoboMaker is temporarily unable to process the request. Try your call again.CreateDeploymentJobResult createDeploymentJob(CreateDeploymentJobRequest createDeploymentJobRequest)
Creates a deployment job.
createDeploymentJobRequest - ResourceNotFoundException - The specified resource does not exist.InvalidParameterException - A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException - AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException - AWS RoboMaker is temporarily unable to process the request. Try your call again.LimitExceededException - The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
exceeds the maximum number allowed.ConcurrentDeploymentExceptionIdempotentParameterMismatchException - The request uses the same client token as a previous, but non-identical request. Do not reuse a client
token with different requests, unless the requests are identical.CreateFleetResult createFleet(CreateFleetRequest createFleetRequest)
Creates a fleet, a logical group of robots running the same robot application.
createFleetRequest - InvalidParameterException - A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException - AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException - AWS RoboMaker is temporarily unable to process the request. Try your call again.LimitExceededException - The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
exceeds the maximum number allowed.CreateRobotResult createRobot(CreateRobotRequest createRobotRequest)
Creates a robot.
createRobotRequest - InvalidParameterException - A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException - AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException - AWS RoboMaker is temporarily unable to process the request. Try your call again.LimitExceededException - The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
exceeds the maximum number allowed.ResourceAlreadyExistsException - The specified resource already existsCreateRobotApplicationResult createRobotApplication(CreateRobotApplicationRequest createRobotApplicationRequest)
Creates a robot application.
createRobotApplicationRequest - InvalidParameterException - A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.ResourceAlreadyExistsException - The specified resource already existsLimitExceededException - The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
exceeds the maximum number allowed.ThrottlingException - AWS RoboMaker is temporarily unable to process the request. Try your call again.InternalServerException - AWS RoboMaker experienced a service issue. Try your call again.IdempotentParameterMismatchException - The request uses the same client token as a previous, but non-identical request. Do not reuse a client
token with different requests, unless the requests are identical.CreateRobotApplicationVersionResult createRobotApplicationVersion(CreateRobotApplicationVersionRequest createRobotApplicationVersionRequest)
Creates a version of a robot application.
createRobotApplicationVersionRequest - InvalidParameterException - A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.IdempotentParameterMismatchException - The request uses the same client token as a previous, but non-identical request. Do not reuse a client
token with different requests, unless the requests are identical.LimitExceededException - The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
exceeds the maximum number allowed.ThrottlingException - AWS RoboMaker is temporarily unable to process the request. Try your call again.InternalServerException - AWS RoboMaker experienced a service issue. Try your call again.CreateSimulationApplicationResult createSimulationApplication(CreateSimulationApplicationRequest createSimulationApplicationRequest)
Creates a simulation application.
createSimulationApplicationRequest - InvalidParameterException - A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.ResourceAlreadyExistsException - The specified resource already existsLimitExceededException - The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
exceeds the maximum number allowed.ThrottlingException - AWS RoboMaker is temporarily unable to process the request. Try your call again.InternalServerException - AWS RoboMaker experienced a service issue. Try your call again.IdempotentParameterMismatchException - The request uses the same client token as a previous, but non-identical request. Do not reuse a client
token with different requests, unless the requests are identical.CreateSimulationApplicationVersionResult createSimulationApplicationVersion(CreateSimulationApplicationVersionRequest createSimulationApplicationVersionRequest)
Creates a simulation application with a specific revision id.
createSimulationApplicationVersionRequest - InvalidParameterException - A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.IdempotentParameterMismatchException - The request uses the same client token as a previous, but non-identical request. Do not reuse a client
token with different requests, unless the requests are identical.LimitExceededException - The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
exceeds the maximum number allowed.ThrottlingException - AWS RoboMaker is temporarily unable to process the request. Try your call again.InternalServerException - AWS RoboMaker experienced a service issue. Try your call again.CreateSimulationJobResult createSimulationJob(CreateSimulationJobRequest createSimulationJobRequest)
Creates a simulation job.
createSimulationJobRequest - ResourceNotFoundException - The specified resource does not exist.InvalidParameterException - A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException - AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException - AWS RoboMaker is temporarily unable to process the request. Try your call again.LimitExceededException - The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
exceeds the maximum number allowed.IdempotentParameterMismatchException - The request uses the same client token as a previous, but non-identical request. Do not reuse a client
token with different requests, unless the requests are identical.DeleteFleetResult deleteFleet(DeleteFleetRequest deleteFleetRequest)
Deletes a fleet.
deleteFleetRequest - InvalidParameterException - A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException - AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException - AWS RoboMaker is temporarily unable to process the request. Try your call again.DeleteRobotResult deleteRobot(DeleteRobotRequest deleteRobotRequest)
Deletes a robot.
deleteRobotRequest - InvalidParameterException - A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException - AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException - AWS RoboMaker is temporarily unable to process the request. Try your call again.DeleteRobotApplicationResult deleteRobotApplication(DeleteRobotApplicationRequest deleteRobotApplicationRequest)
Deletes a robot application.
deleteRobotApplicationRequest - InvalidParameterException - A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.ThrottlingException - AWS RoboMaker is temporarily unable to process the request. Try your call again.InternalServerException - AWS RoboMaker experienced a service issue. Try your call again.DeleteSimulationApplicationResult deleteSimulationApplication(DeleteSimulationApplicationRequest deleteSimulationApplicationRequest)
Deletes a simulation application.
deleteSimulationApplicationRequest - InvalidParameterException - A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.ThrottlingException - AWS RoboMaker is temporarily unable to process the request. Try your call again.InternalServerException - AWS RoboMaker experienced a service issue. Try your call again.DeregisterRobotResult deregisterRobot(DeregisterRobotRequest deregisterRobotRequest)
Deregisters a robot.
deregisterRobotRequest - InvalidParameterException - A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException - AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException - AWS RoboMaker is temporarily unable to process the request. Try your call again.ResourceNotFoundException - The specified resource does not exist.DescribeDeploymentJobResult describeDeploymentJob(DescribeDeploymentJobRequest describeDeploymentJobRequest)
Describes a deployment job. [Does it work regardless of deployment status, e.g. Failed?]
describeDeploymentJobRequest - ResourceNotFoundException - The specified resource does not exist.InvalidParameterException - A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException - AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException - AWS RoboMaker is temporarily unable to process the request. Try your call again.DescribeFleetResult describeFleet(DescribeFleetRequest describeFleetRequest)
Describes a fleet.
describeFleetRequest - ResourceNotFoundException - The specified resource does not exist.InvalidParameterException - A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException - AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException - AWS RoboMaker is temporarily unable to process the request. Try your call again.DescribeRobotResult describeRobot(DescribeRobotRequest describeRobotRequest)
Describes a robot.
describeRobotRequest - ResourceNotFoundException - The specified resource does not exist.InvalidParameterException - A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException - AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException - AWS RoboMaker is temporarily unable to process the request. Try your call again.DescribeRobotApplicationResult describeRobotApplication(DescribeRobotApplicationRequest describeRobotApplicationRequest)
Describes a robot application.
describeRobotApplicationRequest - InvalidParameterException - A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.ResourceNotFoundException - The specified resource does not exist.ThrottlingException - AWS RoboMaker is temporarily unable to process the request. Try your call again.InternalServerException - AWS RoboMaker experienced a service issue. Try your call again.DescribeSimulationApplicationResult describeSimulationApplication(DescribeSimulationApplicationRequest describeSimulationApplicationRequest)
Describes a simulation application.
describeSimulationApplicationRequest - InvalidParameterException - A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.ResourceNotFoundException - The specified resource does not exist.ThrottlingException - AWS RoboMaker is temporarily unable to process the request. Try your call again.InternalServerException - AWS RoboMaker experienced a service issue. Try your call again.DescribeSimulationJobResult describeSimulationJob(DescribeSimulationJobRequest describeSimulationJobRequest)
Describes a simulation job.
describeSimulationJobRequest - ResourceNotFoundException - The specified resource does not exist.InvalidParameterException - A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException - AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException - AWS RoboMaker is temporarily unable to process the request. Try your call again.ListDeploymentJobsResult listDeploymentJobs(ListDeploymentJobsRequest listDeploymentJobsRequest)
Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.
listDeploymentJobsRequest - ResourceNotFoundException - The specified resource does not exist.InvalidParameterException - A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException - AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException - AWS RoboMaker is temporarily unable to process the request. Try your call again.ListFleetsResult listFleets(ListFleetsRequest listFleetsRequest)
Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.
listFleetsRequest - ResourceNotFoundException - The specified resource does not exist.InvalidParameterException - A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException - AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException - AWS RoboMaker is temporarily unable to process the request. Try your call again.ListRobotApplicationsResult listRobotApplications(ListRobotApplicationsRequest listRobotApplicationsRequest)
Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications.
listRobotApplicationsRequest - InvalidParameterException - A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.ThrottlingException - AWS RoboMaker is temporarily unable to process the request. Try your call again.InternalServerException - AWS RoboMaker experienced a service issue. Try your call again.ListRobotsResult listRobots(ListRobotsRequest listRobotsRequest)
Returns a list of robots. You can optionally provide filters to retrieve specific robots.
listRobotsRequest - ResourceNotFoundException - The specified resource does not exist.InvalidParameterException - A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException - AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException - AWS RoboMaker is temporarily unable to process the request. Try your call again.ListSimulationApplicationsResult listSimulationApplications(ListSimulationApplicationsRequest listSimulationApplicationsRequest)
Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications.
listSimulationApplicationsRequest - InvalidParameterException - A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.ThrottlingException - AWS RoboMaker is temporarily unable to process the request. Try your call again.InternalServerException - AWS RoboMaker experienced a service issue. Try your call again.ListSimulationJobsResult listSimulationJobs(ListSimulationJobsRequest listSimulationJobsRequest)
Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs.
listSimulationJobsRequest - InvalidParameterException - A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException - AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException - AWS RoboMaker is temporarily unable to process the request. Try your call again.RegisterRobotResult registerRobot(RegisterRobotRequest registerRobotRequest)
Registers a robot with a fleet.
registerRobotRequest - InvalidParameterException - A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException - AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException - AWS RoboMaker is temporarily unable to process the request. Try your call again.LimitExceededException - The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
exceeds the maximum number allowed.ResourceNotFoundException - The specified resource does not exist.RestartSimulationJobResult restartSimulationJob(RestartSimulationJobRequest restartSimulationJobRequest)
Restarts a running simulation job.
restartSimulationJobRequest - ResourceNotFoundException - The specified resource does not exist.ThrottlingException - AWS RoboMaker is temporarily unable to process the request. Try your call again.LimitExceededException - The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
exceeds the maximum number allowed.InvalidParameterException - A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException - AWS RoboMaker experienced a service issue. Try your call again.SyncDeploymentJobResult syncDeploymentJob(SyncDeploymentJobRequest syncDeploymentJobRequest)
Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.
syncDeploymentJobRequest - ResourceNotFoundException - The specified resource does not exist.InvalidParameterException - A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException - AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException - AWS RoboMaker is temporarily unable to process the request. Try your call again.LimitExceededException - The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
exceeds the maximum number allowed.ConcurrentDeploymentExceptionIdempotentParameterMismatchException - The request uses the same client token as a previous, but non-identical request. Do not reuse a client
token with different requests, unless the requests are identical.UpdateRobotApplicationResult updateRobotApplication(UpdateRobotApplicationRequest updateRobotApplicationRequest)
Updates a robot application.
updateRobotApplicationRequest - InvalidParameterException - A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.ResourceNotFoundException - The specified resource does not exist.LimitExceededException - The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
exceeds the maximum number allowed.ThrottlingException - AWS RoboMaker is temporarily unable to process the request. Try your call again.InternalServerException - AWS RoboMaker experienced a service issue. Try your call again.UpdateSimulationApplicationResult updateSimulationApplication(UpdateSimulationApplicationRequest updateSimulationApplicationRequest)
Updates a simulation application.
updateSimulationApplicationRequest - InvalidParameterException - A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.ResourceNotFoundException - The specified resource does not exist.LimitExceededException - The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
exceeds the maximum number allowed.ThrottlingException - AWS RoboMaker is temporarily unable to process the request. Try your call again.InternalServerException - AWS RoboMaker experienced a service issue. Try your call again.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.Copyright © 2019. All rights reserved.