com.amazonaws.services.robomaker.AWSRoboMaker Maven / Gradle / Ivy
/*
* Copyright 2014-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.robomaker;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.robomaker.model.*;
/**
* Interface for accessing RoboMaker.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.robomaker.AbstractAWSRoboMaker} instead.
*
*
*
* This section provides documentation for the AWS RoboMaker API operations.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSRoboMaker {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "robomaker";
/**
*
* Describes one or more simulation jobs.
*
*
* @param batchDescribeSimulationJobRequest
* @return Result of the BatchDescribeSimulationJob operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws 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.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @sample AWSRoboMaker.BatchDescribeSimulationJob
* @see AWS API Documentation
*/
BatchDescribeSimulationJobResult batchDescribeSimulationJob(BatchDescribeSimulationJobRequest batchDescribeSimulationJobRequest);
/**
*
* Cancels the specified deployment job.
*
*
* @param cancelDeploymentJobRequest
* @return Result of the CancelDeploymentJob operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws 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.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @sample AWSRoboMaker.CancelDeploymentJob
* @see AWS
* API Documentation
*/
CancelDeploymentJobResult cancelDeploymentJob(CancelDeploymentJobRequest cancelDeploymentJobRequest);
/**
*
* Cancels the specified simulation job.
*
*
* @param cancelSimulationJobRequest
* @return Result of the CancelSimulationJob operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws 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.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @sample AWSRoboMaker.CancelSimulationJob
* @see AWS
* API Documentation
*/
CancelSimulationJobResult cancelSimulationJob(CancelSimulationJobRequest cancelSimulationJobRequest);
/**
*
* 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.
*
*
*
* @param createDeploymentJobRequest
* @return Result of the CreateDeploymentJob operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws 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.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @throws LimitExceededException
* The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
* exceeds the maximum number allowed.
* @throws ConcurrentDeploymentException
* The failure percentage threshold percentage was met.
* @throws 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.
* @sample AWSRoboMaker.CreateDeploymentJob
* @see AWS
* API Documentation
*/
CreateDeploymentJobResult createDeploymentJob(CreateDeploymentJobRequest createDeploymentJobRequest);
/**
*
* Creates a fleet, a logical group of robots running the same robot application.
*
*
* @param createFleetRequest
* @return Result of the CreateFleet operation returned by the service.
* @throws 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.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @throws LimitExceededException
* The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
* exceeds the maximum number allowed.
* @sample AWSRoboMaker.CreateFleet
* @see AWS API
* Documentation
*/
CreateFleetResult createFleet(CreateFleetRequest createFleetRequest);
/**
*
* Creates a robot.
*
*
* @param createRobotRequest
* @return Result of the CreateRobot operation returned by the service.
* @throws 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.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @throws LimitExceededException
* The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
* exceeds the maximum number allowed.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @sample AWSRoboMaker.CreateRobot
* @see AWS API
* Documentation
*/
CreateRobotResult createRobot(CreateRobotRequest createRobotRequest);
/**
*
* Creates a robot application.
*
*
* @param createRobotApplicationRequest
* @return Result of the CreateRobotApplication operation returned by the service.
* @throws 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.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws LimitExceededException
* The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
* exceeds the maximum number allowed.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @throws 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.
* @sample AWSRoboMaker.CreateRobotApplication
* @see AWS API Documentation
*/
CreateRobotApplicationResult createRobotApplication(CreateRobotApplicationRequest createRobotApplicationRequest);
/**
*
* Creates a version of a robot application.
*
*
* @param createRobotApplicationVersionRequest
* @return Result of the CreateRobotApplicationVersion operation returned by the service.
* @throws 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.
* @throws 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.
* @throws LimitExceededException
* The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
* exceeds the maximum number allowed.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @sample AWSRoboMaker.CreateRobotApplicationVersion
* @see AWS API Documentation
*/
CreateRobotApplicationVersionResult createRobotApplicationVersion(CreateRobotApplicationVersionRequest createRobotApplicationVersionRequest);
/**
*
* Creates a simulation application.
*
*
* @param createSimulationApplicationRequest
* @return Result of the CreateSimulationApplication operation returned by the service.
* @throws 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.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws LimitExceededException
* The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
* exceeds the maximum number allowed.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @throws 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.
* @sample AWSRoboMaker.CreateSimulationApplication
* @see AWS API Documentation
*/
CreateSimulationApplicationResult createSimulationApplication(CreateSimulationApplicationRequest createSimulationApplicationRequest);
/**
*
* Creates a simulation application with a specific revision id.
*
*
* @param createSimulationApplicationVersionRequest
* @return Result of the CreateSimulationApplicationVersion operation returned by the service.
* @throws 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.
* @throws 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.
* @throws LimitExceededException
* The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
* exceeds the maximum number allowed.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @sample AWSRoboMaker.CreateSimulationApplicationVersion
* @see AWS API Documentation
*/
CreateSimulationApplicationVersionResult createSimulationApplicationVersion(
CreateSimulationApplicationVersionRequest createSimulationApplicationVersionRequest);
/**
*
* Creates a simulation job.
*
*
*
* After 90 days, simulation jobs expire and will be deleted. They will no longer be accessible.
*
*
*
* @param createSimulationJobRequest
* @return Result of the CreateSimulationJob operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws 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.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @throws LimitExceededException
* The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
* exceeds the maximum number allowed.
* @throws 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.
* @sample AWSRoboMaker.CreateSimulationJob
* @see AWS
* API Documentation
*/
CreateSimulationJobResult createSimulationJob(CreateSimulationJobRequest createSimulationJobRequest);
/**
*
* Deletes a fleet.
*
*
* @param deleteFleetRequest
* @return Result of the DeleteFleet operation returned by the service.
* @throws 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.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @sample AWSRoboMaker.DeleteFleet
* @see AWS API
* Documentation
*/
DeleteFleetResult deleteFleet(DeleteFleetRequest deleteFleetRequest);
/**
*
* Deletes a robot.
*
*
* @param deleteRobotRequest
* @return Result of the DeleteRobot operation returned by the service.
* @throws 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.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @sample AWSRoboMaker.DeleteRobot
* @see AWS API
* Documentation
*/
DeleteRobotResult deleteRobot(DeleteRobotRequest deleteRobotRequest);
/**
*
* Deletes a robot application.
*
*
* @param deleteRobotApplicationRequest
* @return Result of the DeleteRobotApplication operation returned by the service.
* @throws 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.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @sample AWSRoboMaker.DeleteRobotApplication
* @see AWS API Documentation
*/
DeleteRobotApplicationResult deleteRobotApplication(DeleteRobotApplicationRequest deleteRobotApplicationRequest);
/**
*
* Deletes a simulation application.
*
*
* @param deleteSimulationApplicationRequest
* @return Result of the DeleteSimulationApplication operation returned by the service.
* @throws 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.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @sample AWSRoboMaker.DeleteSimulationApplication
* @see AWS API Documentation
*/
DeleteSimulationApplicationResult deleteSimulationApplication(DeleteSimulationApplicationRequest deleteSimulationApplicationRequest);
/**
*
* Deregisters a robot.
*
*
* @param deregisterRobotRequest
* @return Result of the DeregisterRobot operation returned by the service.
* @throws 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.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AWSRoboMaker.DeregisterRobot
* @see AWS API
* Documentation
*/
DeregisterRobotResult deregisterRobot(DeregisterRobotRequest deregisterRobotRequest);
/**
*
* Describes a deployment job. [Does it work regardless of deployment status, e.g. Failed?]
*
*
* @param describeDeploymentJobRequest
* @return Result of the DescribeDeploymentJob operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws 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.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @sample AWSRoboMaker.DescribeDeploymentJob
* @see AWS API Documentation
*/
DescribeDeploymentJobResult describeDeploymentJob(DescribeDeploymentJobRequest describeDeploymentJobRequest);
/**
*
* Describes a fleet.
*
*
* @param describeFleetRequest
* @return Result of the DescribeFleet operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws 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.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @sample AWSRoboMaker.DescribeFleet
* @see AWS API
* Documentation
*/
DescribeFleetResult describeFleet(DescribeFleetRequest describeFleetRequest);
/**
*
* Describes a robot.
*
*
* @param describeRobotRequest
* @return Result of the DescribeRobot operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws 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.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @sample AWSRoboMaker.DescribeRobot
* @see AWS API
* Documentation
*/
DescribeRobotResult describeRobot(DescribeRobotRequest describeRobotRequest);
/**
*
* Describes a robot application.
*
*
* @param describeRobotApplicationRequest
* @return Result of the DescribeRobotApplication operation returned by the service.
* @throws 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.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @sample AWSRoboMaker.DescribeRobotApplication
* @see AWS API Documentation
*/
DescribeRobotApplicationResult describeRobotApplication(DescribeRobotApplicationRequest describeRobotApplicationRequest);
/**
*
* Describes a simulation application.
*
*
* @param describeSimulationApplicationRequest
* @return Result of the DescribeSimulationApplication operation returned by the service.
* @throws 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.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @sample AWSRoboMaker.DescribeSimulationApplication
* @see AWS API Documentation
*/
DescribeSimulationApplicationResult describeSimulationApplication(DescribeSimulationApplicationRequest describeSimulationApplicationRequest);
/**
*
* Describes a simulation job.
*
*
* @param describeSimulationJobRequest
* @return Result of the DescribeSimulationJob operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws 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.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @sample AWSRoboMaker.DescribeSimulationJob
* @see AWS API Documentation
*/
DescribeSimulationJobResult describeSimulationJob(DescribeSimulationJobRequest describeSimulationJobRequest);
/**
*
* Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment
* jobs.
*
*
*
*
*
*
* @param listDeploymentJobsRequest
* @return Result of the ListDeploymentJobs operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws 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.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @sample AWSRoboMaker.ListDeploymentJobs
* @see AWS
* API Documentation
*/
ListDeploymentJobsResult listDeploymentJobs(ListDeploymentJobsRequest listDeploymentJobsRequest);
/**
*
* Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.
*
*
* @param listFleetsRequest
* @return Result of the ListFleets operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws 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.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @sample AWSRoboMaker.ListFleets
* @see AWS API
* Documentation
*/
ListFleetsResult listFleets(ListFleetsRequest listFleetsRequest);
/**
*
* Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications.
*
*
* @param listRobotApplicationsRequest
* @return Result of the ListRobotApplications operation returned by the service.
* @throws 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.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @sample AWSRoboMaker.ListRobotApplications
* @see AWS API Documentation
*/
ListRobotApplicationsResult listRobotApplications(ListRobotApplicationsRequest listRobotApplicationsRequest);
/**
*
* Returns a list of robots. You can optionally provide filters to retrieve specific robots.
*
*
* @param listRobotsRequest
* @return Result of the ListRobots operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws 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.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @sample AWSRoboMaker.ListRobots
* @see AWS API
* Documentation
*/
ListRobotsResult listRobots(ListRobotsRequest listRobotsRequest);
/**
*
* Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation
* applications.
*
*
* @param listSimulationApplicationsRequest
* @return Result of the ListSimulationApplications operation returned by the service.
* @throws 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.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @sample AWSRoboMaker.ListSimulationApplications
* @see AWS API Documentation
*/
ListSimulationApplicationsResult listSimulationApplications(ListSimulationApplicationsRequest listSimulationApplicationsRequest);
/**
*
* Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs.
*
*
* @param listSimulationJobsRequest
* @return Result of the ListSimulationJobs operation returned by the service.
* @throws 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.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @sample AWSRoboMaker.ListSimulationJobs
* @see AWS
* API Documentation
*/
ListSimulationJobsResult listSimulationJobs(ListSimulationJobsRequest listSimulationJobsRequest);
/**
*
* Lists all tags on a AWS RoboMaker resource.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws 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.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @sample AWSRoboMaker.ListTagsForResource
* @see AWS
* API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Registers a robot with a fleet.
*
*
* @param registerRobotRequest
* @return Result of the RegisterRobot operation returned by the service.
* @throws 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.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @throws LimitExceededException
* The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
* exceeds the maximum number allowed.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AWSRoboMaker.RegisterRobot
* @see AWS API
* Documentation
*/
RegisterRobotResult registerRobot(RegisterRobotRequest registerRobotRequest);
/**
*
* Restarts a running simulation job.
*
*
* @param restartSimulationJobRequest
* @return Result of the RestartSimulationJob operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @throws LimitExceededException
* The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
* exceeds the maximum number allowed.
* @throws 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.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @sample AWSRoboMaker.RestartSimulationJob
* @see AWS
* API Documentation
*/
RestartSimulationJobResult restartSimulationJob(RestartSimulationJobRequest restartSimulationJobRequest);
/**
*
* Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.
*
*
* @param syncDeploymentJobRequest
* @return Result of the SyncDeploymentJob operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws 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.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @throws LimitExceededException
* The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
* exceeds the maximum number allowed.
* @throws ConcurrentDeploymentException
* The failure percentage threshold percentage was met.
* @throws 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.
* @sample AWSRoboMaker.SyncDeploymentJob
* @see AWS
* API Documentation
*/
SyncDeploymentJobResult syncDeploymentJob(SyncDeploymentJobRequest syncDeploymentJobRequest);
/**
*
* 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.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws 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.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @sample AWSRoboMaker.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* 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 .
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws 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.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @sample AWSRoboMaker.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Updates a robot application.
*
*
* @param updateRobotApplicationRequest
* @return Result of the UpdateRobotApplication operation returned by the service.
* @throws 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.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws LimitExceededException
* The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
* exceeds the maximum number allowed.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @sample AWSRoboMaker.UpdateRobotApplication
* @see AWS API Documentation
*/
UpdateRobotApplicationResult updateRobotApplication(UpdateRobotApplicationRequest updateRobotApplicationRequest);
/**
*
* Updates a simulation application.
*
*
* @param updateSimulationApplicationRequest
* @return Result of the UpdateSimulationApplication operation returned by the service.
* @throws 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.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws LimitExceededException
* The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
* exceeds the maximum number allowed.
* @throws ThrottlingException
* AWS RoboMaker is temporarily unable to process the request. Try your call again.
* @throws InternalServerException
* AWS RoboMaker experienced a service issue. Try your call again.
* @sample AWSRoboMaker.UpdateSimulationApplication
* @see AWS API Documentation
*/
UpdateSimulationApplicationResult updateSimulationApplication(UpdateSimulationApplicationRequest updateSimulationApplicationRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy