/* * Copyright 2018-2023 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.iotroborunner; import javax.annotation.Generated; import com.amazonaws.*; import com.amazonaws.regions.*; import com.amazonaws.services.iotroborunner.model.*; /** * Interface for accessing AWS IoT RoboRunner. *

* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.iotroborunner.AbstractAWSIoTRoboRunner} instead. *

*

*

* An example service, deployed with the Octane Service creator, which will echo the string *

*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSIoTRoboRunner { /** * 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 = "iotroborunner"; /** *

* Grants permission to create a destination *

* * @param createDestinationRequest * @return Result of the CreateDestination operation returned by the service. * @throws ConflictException * Exception thrown if a resource in a create request already exists. * @throws AccessDeniedException * User does not have sufficient access to perform this action. * @throws ValidationException * Exception thrown if an invalid parameter is provided to an API. * @throws ResourceNotFoundException * Exception thrown if a resource referenced in the request doesn't exist. * @throws ThrottlingException * Exception thrown if the api has been called too quickly be the client. * @throws InternalServerException * Exception thrown if something goes wrong within the service. * @throws ServiceQuotaExceededException * Exception thrown if the user's AWS account has reached a service limit and the operation cannot proceed. * @sample AWSIoTRoboRunner.CreateDestination * @see AWS API Documentation */ CreateDestinationResult createDestination(CreateDestinationRequest createDestinationRequest); /** *

* Grants permission to create a site *

* * @param createSiteRequest * @return Result of the CreateSite operation returned by the service. * @throws ConflictException * Exception thrown if a resource in a create request already exists. * @throws AccessDeniedException * User does not have sufficient access to perform this action. * @throws ValidationException * Exception thrown if an invalid parameter is provided to an API. * @throws ThrottlingException * Exception thrown if the api has been called too quickly be the client. * @throws InternalServerException * Exception thrown if something goes wrong within the service. * @throws ServiceQuotaExceededException * Exception thrown if the user's AWS account has reached a service limit and the operation cannot proceed. * @sample AWSIoTRoboRunner.CreateSite * @see AWS API * Documentation */ CreateSiteResult createSite(CreateSiteRequest createSiteRequest); /** *

* Grants permission to create a worker *

* * @param createWorkerRequest * @return Result of the CreateWorker operation returned by the service. * @throws ConflictException * Exception thrown if a resource in a create request already exists. * @throws AccessDeniedException * User does not have sufficient access to perform this action. * @throws ValidationException * Exception thrown if an invalid parameter is provided to an API. * @throws ResourceNotFoundException * Exception thrown if a resource referenced in the request doesn't exist. * @throws ThrottlingException * Exception thrown if the api has been called too quickly be the client. * @throws InternalServerException * Exception thrown if something goes wrong within the service. * @throws ServiceQuotaExceededException * Exception thrown if the user's AWS account has reached a service limit and the operation cannot proceed. * @sample AWSIoTRoboRunner.CreateWorker * @see AWS * API Documentation */ CreateWorkerResult createWorker(CreateWorkerRequest createWorkerRequest); /** *

* Grants permission to create a worker fleet *

* * @param createWorkerFleetRequest * @return Result of the CreateWorkerFleet operation returned by the service. * @throws ConflictException * Exception thrown if a resource in a create request already exists. * @throws AccessDeniedException * User does not have sufficient access to perform this action. * @throws ValidationException * Exception thrown if an invalid parameter is provided to an API. * @throws ResourceNotFoundException * Exception thrown if a resource referenced in the request doesn't exist. * @throws ThrottlingException * Exception thrown if the api has been called too quickly be the client. * @throws InternalServerException * Exception thrown if something goes wrong within the service. * @throws ServiceQuotaExceededException * Exception thrown if the user's AWS account has reached a service limit and the operation cannot proceed. * @sample AWSIoTRoboRunner.CreateWorkerFleet * @see AWS API Documentation */ CreateWorkerFleetResult createWorkerFleet(CreateWorkerFleetRequest createWorkerFleetRequest); /** *

* Grants permission to delete a destination *

* * @param deleteDestinationRequest * @return Result of the DeleteDestination operation returned by the service. * @throws ConflictException * Exception thrown if a resource in a create request already exists. * @throws AccessDeniedException * User does not have sufficient access to perform this action. * @throws ValidationException * Exception thrown if an invalid parameter is provided to an API. * @throws ResourceNotFoundException * Exception thrown if a resource referenced in the request doesn't exist. * @throws ThrottlingException * Exception thrown if the api has been called too quickly be the client. * @throws InternalServerException * Exception thrown if something goes wrong within the service. * @sample AWSIoTRoboRunner.DeleteDestination * @see AWS API Documentation */ DeleteDestinationResult deleteDestination(DeleteDestinationRequest deleteDestinationRequest); /** *

* Grants permission to delete a site *

* * @param deleteSiteRequest * @return Result of the DeleteSite operation returned by the service. * @throws ConflictException * Exception thrown if a resource in a create request already exists. * @throws AccessDeniedException * User does not have sufficient access to perform this action. * @throws ValidationException * Exception thrown if an invalid parameter is provided to an API. * @throws ResourceNotFoundException * Exception thrown if a resource referenced in the request doesn't exist. * @throws ThrottlingException * Exception thrown if the api has been called too quickly be the client. * @throws InternalServerException * Exception thrown if something goes wrong within the service. * @sample AWSIoTRoboRunner.DeleteSite * @see AWS API * Documentation */ DeleteSiteResult deleteSite(DeleteSiteRequest deleteSiteRequest); /** *

* Grants permission to delete a worker *

* * @param deleteWorkerRequest * @return Result of the DeleteWorker operation returned by the service. * @throws ConflictException * Exception thrown if a resource in a create request already exists. * @throws AccessDeniedException * User does not have sufficient access to perform this action. * @throws ValidationException * Exception thrown if an invalid parameter is provided to an API. * @throws ResourceNotFoundException * Exception thrown if a resource referenced in the request doesn't exist. * @throws ThrottlingException * Exception thrown if the api has been called too quickly be the client. * @throws InternalServerException * Exception thrown if something goes wrong within the service. * @sample AWSIoTRoboRunner.DeleteWorker * @see AWS * API Documentation */ DeleteWorkerResult deleteWorker(DeleteWorkerRequest deleteWorkerRequest); /** *

* Grants permission to delete a worker fleet *

* * @param deleteWorkerFleetRequest * @return Result of the DeleteWorkerFleet operation returned by the service. * @throws ConflictException * Exception thrown if a resource in a create request already exists. * @throws AccessDeniedException * User does not have sufficient access to perform this action. * @throws ValidationException * Exception thrown if an invalid parameter is provided to an API. * @throws ResourceNotFoundException * Exception thrown if a resource referenced in the request doesn't exist. * @throws ThrottlingException * Exception thrown if the api has been called too quickly be the client. * @throws InternalServerException * Exception thrown if something goes wrong within the service. * @sample AWSIoTRoboRunner.DeleteWorkerFleet * @see AWS API Documentation */ DeleteWorkerFleetResult deleteWorkerFleet(DeleteWorkerFleetRequest deleteWorkerFleetRequest); /** *

* Grants permission to get a destination *

* * @param getDestinationRequest * @return Result of the GetDestination operation returned by the service. * @throws AccessDeniedException * User does not have sufficient access to perform this action. * @throws ValidationException * Exception thrown if an invalid parameter is provided to an API. * @throws ResourceNotFoundException * Exception thrown if a resource referenced in the request doesn't exist. * @throws ThrottlingException * Exception thrown if the api has been called too quickly be the client. * @throws InternalServerException * Exception thrown if something goes wrong within the service. * @sample AWSIoTRoboRunner.GetDestination * @see AWS * API Documentation */ GetDestinationResult getDestination(GetDestinationRequest getDestinationRequest); /** *

* Grants permission to get a site *

* * @param getSiteRequest * @return Result of the GetSite operation returned by the service. * @throws AccessDeniedException * User does not have sufficient access to perform this action. * @throws ValidationException * Exception thrown if an invalid parameter is provided to an API. * @throws ResourceNotFoundException * Exception thrown if a resource referenced in the request doesn't exist. * @throws ThrottlingException * Exception thrown if the api has been called too quickly be the client. * @throws InternalServerException * Exception thrown if something goes wrong within the service. * @sample AWSIoTRoboRunner.GetSite * @see AWS API * Documentation */ GetSiteResult getSite(GetSiteRequest getSiteRequest); /** *

* Grants permission to get a worker *

* * @param getWorkerRequest * @return Result of the GetWorker operation returned by the service. * @throws AccessDeniedException * User does not have sufficient access to perform this action. * @throws ValidationException * Exception thrown if an invalid parameter is provided to an API. * @throws ResourceNotFoundException * Exception thrown if a resource referenced in the request doesn't exist. * @throws ThrottlingException * Exception thrown if the api has been called too quickly be the client. * @throws InternalServerException * Exception thrown if something goes wrong within the service. * @sample AWSIoTRoboRunner.GetWorker * @see AWS API * Documentation */ GetWorkerResult getWorker(GetWorkerRequest getWorkerRequest); /** *

* Grants permission to get a worker fleet *

* * @param getWorkerFleetRequest * @return Result of the GetWorkerFleet operation returned by the service. * @throws AccessDeniedException * User does not have sufficient access to perform this action. * @throws ValidationException * Exception thrown if an invalid parameter is provided to an API. * @throws ResourceNotFoundException * Exception thrown if a resource referenced in the request doesn't exist. * @throws ThrottlingException * Exception thrown if the api has been called too quickly be the client. * @throws InternalServerException * Exception thrown if something goes wrong within the service. * @sample AWSIoTRoboRunner.GetWorkerFleet * @see AWS * API Documentation */ GetWorkerFleetResult getWorkerFleet(GetWorkerFleetRequest getWorkerFleetRequest); /** *

* Grants permission to list destinations *

* * @param listDestinationsRequest * @return Result of the ListDestinations operation returned by the service. * @throws AccessDeniedException * User does not have sufficient access to perform this action. * @throws ValidationException * Exception thrown if an invalid parameter is provided to an API. * @throws ResourceNotFoundException * Exception thrown if a resource referenced in the request doesn't exist. * @throws ThrottlingException * Exception thrown if the api has been called too quickly be the client. * @throws InternalServerException * Exception thrown if something goes wrong within the service. * @sample AWSIoTRoboRunner.ListDestinations * @see AWS API Documentation */ ListDestinationsResult listDestinations(ListDestinationsRequest listDestinationsRequest); /** *

* Grants permission to list sites *

* * @param listSitesRequest * @return Result of the ListSites operation returned by the service. * @throws AccessDeniedException * User does not have sufficient access to perform this action. * @throws ValidationException * Exception thrown if an invalid parameter is provided to an API. * @throws ThrottlingException * Exception thrown if the api has been called too quickly be the client. * @throws InternalServerException * Exception thrown if something goes wrong within the service. * @sample AWSIoTRoboRunner.ListSites * @see AWS API * Documentation */ ListSitesResult listSites(ListSitesRequest listSitesRequest); /** *

* Grants permission to list worker fleets *

* * @param listWorkerFleetsRequest * @return Result of the ListWorkerFleets operation returned by the service. * @throws AccessDeniedException * User does not have sufficient access to perform this action. * @throws ValidationException * Exception thrown if an invalid parameter is provided to an API. * @throws ResourceNotFoundException * Exception thrown if a resource referenced in the request doesn't exist. * @throws ThrottlingException * Exception thrown if the api has been called too quickly be the client. * @throws InternalServerException * Exception thrown if something goes wrong within the service. * @sample AWSIoTRoboRunner.ListWorkerFleets * @see AWS API Documentation */ ListWorkerFleetsResult listWorkerFleets(ListWorkerFleetsRequest listWorkerFleetsRequest); /** *

* Grants permission to list workers *

* * @param listWorkersRequest * @return Result of the ListWorkers operation returned by the service. * @throws AccessDeniedException * User does not have sufficient access to perform this action. * @throws ValidationException * Exception thrown if an invalid parameter is provided to an API. * @throws ResourceNotFoundException * Exception thrown if a resource referenced in the request doesn't exist. * @throws ThrottlingException * Exception thrown if the api has been called too quickly be the client. * @throws InternalServerException * Exception thrown if something goes wrong within the service. * @sample AWSIoTRoboRunner.ListWorkers * @see AWS API * Documentation */ ListWorkersResult listWorkers(ListWorkersRequest listWorkersRequest); /** *

* Grants permission to update a destination *

* * @param updateDestinationRequest * @return Result of the UpdateDestination operation returned by the service. * @throws AccessDeniedException * User does not have sufficient access to perform this action. * @throws ValidationException * Exception thrown if an invalid parameter is provided to an API. * @throws ResourceNotFoundException * Exception thrown if a resource referenced in the request doesn't exist. * @throws ThrottlingException * Exception thrown if the api has been called too quickly be the client. * @throws InternalServerException * Exception thrown if something goes wrong within the service. * @sample AWSIoTRoboRunner.UpdateDestination * @see AWS API Documentation */ UpdateDestinationResult updateDestination(UpdateDestinationRequest updateDestinationRequest); /** *

* Grants permission to update a site *

* * @param updateSiteRequest * @return Result of the UpdateSite operation returned by the service. * @throws AccessDeniedException * User does not have sufficient access to perform this action. * @throws ValidationException * Exception thrown if an invalid parameter is provided to an API. * @throws ResourceNotFoundException * Exception thrown if a resource referenced in the request doesn't exist. * @throws ThrottlingException * Exception thrown if the api has been called too quickly be the client. * @throws InternalServerException * Exception thrown if something goes wrong within the service. * @sample AWSIoTRoboRunner.UpdateSite * @see AWS API * Documentation */ UpdateSiteResult updateSite(UpdateSiteRequest updateSiteRequest); /** *

* Grants permission to update a worker *

* * @param updateWorkerRequest * @return Result of the UpdateWorker operation returned by the service. * @throws AccessDeniedException * User does not have sufficient access to perform this action. * @throws ValidationException * Exception thrown if an invalid parameter is provided to an API. * @throws ResourceNotFoundException * Exception thrown if a resource referenced in the request doesn't exist. * @throws ThrottlingException * Exception thrown if the api has been called too quickly be the client. * @throws InternalServerException * Exception thrown if something goes wrong within the service. * @sample AWSIoTRoboRunner.UpdateWorker * @see AWS * API Documentation */ UpdateWorkerResult updateWorker(UpdateWorkerRequest updateWorkerRequest); /** *

* Grants permission to update a worker fleet *

* * @param updateWorkerFleetRequest * @return Result of the UpdateWorkerFleet operation returned by the service. * @throws AccessDeniedException * User does not have sufficient access to perform this action. * @throws ValidationException * Exception thrown if an invalid parameter is provided to an API. * @throws ResourceNotFoundException * Exception thrown if a resource referenced in the request doesn't exist. * @throws ThrottlingException * Exception thrown if the api has been called too quickly be the client. * @throws InternalServerException * Exception thrown if something goes wrong within the service. * @sample AWSIoTRoboRunner.UpdateWorkerFleet * @see AWS API Documentation */ UpdateWorkerFleetResult updateWorkerFleet(UpdateWorkerFleetRequest updateWorkerFleetRequest); /** * 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); }