@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSRoboMakerClient extends AmazonWebServiceClient implements AWSRoboMaker
This section provides documentation for the AWS RoboMaker API operations.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitshutdownpublic static AWSRoboMakerClientBuilder builder()
public BatchDescribeSimulationJobResult batchDescribeSimulationJob(BatchDescribeSimulationJobRequest request)
Describes one or more simulation jobs.
batchDescribeSimulationJob in interface AWSRoboMakerbatchDescribeSimulationJobRequest - 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.public CancelSimulationJobResult cancelSimulationJob(CancelSimulationJobRequest request)
Cancels the specified simulation job.
cancelSimulationJob in interface AWSRoboMakercancelSimulationJobRequest - 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.public CreateDeploymentJobResult createDeploymentJob(CreateDeploymentJobRequest request)
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.
After 90 days, deployment jobs expire and will be deleted. They will no longer be accessible.
createDeploymentJob in interface AWSRoboMakercreateDeploymentJobRequest - 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.ConcurrentDeploymentException - The failure percentage threshold percentage was met.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.public CreateFleetResult createFleet(CreateFleetRequest request)
Creates a fleet, a logical group of robots running the same robot application.
createFleet in interface AWSRoboMakercreateFleetRequest - 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.public CreateRobotResult createRobot(CreateRobotRequest request)
Creates a robot.
createRobot in interface AWSRoboMakercreateRobotRequest - 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 exists.public CreateRobotApplicationResult createRobotApplication(CreateRobotApplicationRequest request)
Creates a robot application.
createRobotApplication in interface AWSRoboMakercreateRobotApplicationRequest - 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 exists.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.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.public CreateRobotApplicationVersionResult createRobotApplicationVersion(CreateRobotApplicationVersionRequest request)
Creates a version of a robot application.
createRobotApplicationVersion in interface AWSRoboMakercreateRobotApplicationVersionRequest - 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.public CreateSimulationApplicationResult createSimulationApplication(CreateSimulationApplicationRequest request)
Creates a simulation application.
createSimulationApplication in interface AWSRoboMakercreateSimulationApplicationRequest - 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 exists.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.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.public CreateSimulationApplicationVersionResult createSimulationApplicationVersion(CreateSimulationApplicationVersionRequest request)
Creates a simulation application with a specific revision id.
createSimulationApplicationVersion in interface AWSRoboMakercreateSimulationApplicationVersionRequest - 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.public CreateSimulationJobResult createSimulationJob(CreateSimulationJobRequest request)
Creates a simulation job.
After 90 days, simulation jobs expire and will be deleted. They will no longer be accessible.
createSimulationJob in interface AWSRoboMakercreateSimulationJobRequest - 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.public DeleteFleetResult deleteFleet(DeleteFleetRequest request)
Deletes a fleet.
deleteFleet in interface AWSRoboMakerdeleteFleetRequest - 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.public DeleteRobotResult deleteRobot(DeleteRobotRequest request)
Deletes a robot.
deleteRobot in interface AWSRoboMakerdeleteRobotRequest - 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.public DeleteRobotApplicationResult deleteRobotApplication(DeleteRobotApplicationRequest request)
Deletes a robot application.
deleteRobotApplication in interface AWSRoboMakerdeleteRobotApplicationRequest - 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.public DeleteSimulationApplicationResult deleteSimulationApplication(DeleteSimulationApplicationRequest request)
Deletes a simulation application.
deleteSimulationApplication in interface AWSRoboMakerdeleteSimulationApplicationRequest - 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.public DeregisterRobotResult deregisterRobot(DeregisterRobotRequest request)
Deregisters a robot.
deregisterRobot in interface AWSRoboMakerderegisterRobotRequest - 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.public DescribeDeploymentJobResult describeDeploymentJob(DescribeDeploymentJobRequest request)
Describes a deployment job. [Does it work regardless of deployment status, e.g. Failed?]
describeDeploymentJob in interface AWSRoboMakerdescribeDeploymentJobRequest - 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.public DescribeFleetResult describeFleet(DescribeFleetRequest request)
Describes a fleet.
describeFleet in interface AWSRoboMakerdescribeFleetRequest - 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.public DescribeRobotResult describeRobot(DescribeRobotRequest request)
Describes a robot.
describeRobot in interface AWSRoboMakerdescribeRobotRequest - 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.public DescribeRobotApplicationResult describeRobotApplication(DescribeRobotApplicationRequest request)
Describes a robot application.
describeRobotApplication in interface AWSRoboMakerdescribeRobotApplicationRequest - 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.public DescribeSimulationApplicationResult describeSimulationApplication(DescribeSimulationApplicationRequest request)
Describes a simulation application.
describeSimulationApplication in interface AWSRoboMakerdescribeSimulationApplicationRequest - 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.public DescribeSimulationJobResult describeSimulationJob(DescribeSimulationJobRequest request)
Describes a simulation job.
describeSimulationJob in interface AWSRoboMakerdescribeSimulationJobRequest - 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.public ListDeploymentJobsResult listDeploymentJobs(ListDeploymentJobsRequest request)
Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.
listDeploymentJobs in interface AWSRoboMakerlistDeploymentJobsRequest - 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.public ListFleetsResult listFleets(ListFleetsRequest request)
Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.
listFleets in interface AWSRoboMakerlistFleetsRequest - 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.public ListRobotApplicationsResult listRobotApplications(ListRobotApplicationsRequest request)
Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications.
listRobotApplications in interface AWSRoboMakerlistRobotApplicationsRequest - 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.public ListRobotsResult listRobots(ListRobotsRequest request)
Returns a list of robots. You can optionally provide filters to retrieve specific robots.
listRobots in interface AWSRoboMakerlistRobotsRequest - 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.public ListSimulationApplicationsResult listSimulationApplications(ListSimulationApplicationsRequest request)
Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications.
listSimulationApplications in interface AWSRoboMakerlistSimulationApplicationsRequest - 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.public ListSimulationJobsResult listSimulationJobs(ListSimulationJobsRequest request)
Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs.
listSimulationJobs in interface AWSRoboMakerlistSimulationJobsRequest - 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.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists all tags on a AWS RoboMaker resource.
listTagsForResource in interface AWSRoboMakerlistTagsForResourceRequest - InternalServerException - AWS RoboMaker experienced a service issue. Try your call again.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.ThrottlingException - AWS RoboMaker is temporarily unable to process the request. Try your call again.public RegisterRobotResult registerRobot(RegisterRobotRequest request)
Registers a robot with a fleet.
registerRobot in interface AWSRoboMakerregisterRobotRequest - 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.public RestartSimulationJobResult restartSimulationJob(RestartSimulationJobRequest request)
Restarts a running simulation job.
restartSimulationJob in interface AWSRoboMakerrestartSimulationJobRequest - 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.public SyncDeploymentJobResult syncDeploymentJob(SyncDeploymentJobRequest request)
Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.
syncDeploymentJob in interface AWSRoboMakersyncDeploymentJobRequest - 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.ConcurrentDeploymentException - The failure percentage threshold percentage was met.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.public TagResourceResult tagResource(TagResourceRequest request)
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.
tagResource in interface AWSRoboMakertagResourceRequest - InternalServerException - AWS RoboMaker experienced a service issue. Try your call again.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.ThrottlingException - AWS RoboMaker is temporarily unable to process the request. Try your call again.public UntagResourceResult untagResource(UntagResourceRequest request)
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 .
untagResource in interface AWSRoboMakeruntagResourceRequest - InternalServerException - AWS RoboMaker experienced a service issue. Try your call again.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.ThrottlingException - AWS RoboMaker is temporarily unable to process the request. Try your call again.public UpdateRobotApplicationResult updateRobotApplication(UpdateRobotApplicationRequest request)
Updates a robot application.
updateRobotApplication in interface AWSRoboMakerupdateRobotApplicationRequest - 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.public UpdateSimulationApplicationResult updateSimulationApplication(UpdateSimulationApplicationRequest request)
Updates a simulation application.
updateSimulationApplication in interface AWSRoboMakerupdateSimulationApplicationRequest - 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.public 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 the request.
getCachedResponseMetadata in interface AWSRoboMakerrequest - The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.