com.amazonaws.services.iotroborunner

Class AWSIoTRoboRunnerClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.iotroborunner.AWSIoTRoboRunnerClient

All Implemented Interfaces:

AWSIoTRoboRunner

Direct Known Subclasses:

AWSIoTRoboRunnerAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSIoTRoboRunnerClient
extends AmazonWebServiceClient
implements AWSIoTRoboRunner

Client for accessing AWS IoT RoboRunner. All service calls made using this client are blocking, and will not return until the service call completes.

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

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.iotroborunner.AWSIoTRoboRunner

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSIoTRoboRunnerClientBuilder	builder()
CreateDestinationResult	createDestination(CreateDestinationRequest request) Grants permission to create a destination
CreateSiteResult	createSite(CreateSiteRequest request) Grants permission to create a site
CreateWorkerResult	createWorker(CreateWorkerRequest request) Grants permission to create a worker
CreateWorkerFleetResult	createWorkerFleet(CreateWorkerFleetRequest request) Grants permission to create a worker fleet
DeleteDestinationResult	deleteDestination(DeleteDestinationRequest request) Grants permission to delete a destination
DeleteSiteResult	deleteSite(DeleteSiteRequest request) Grants permission to delete a site
DeleteWorkerResult	deleteWorker(DeleteWorkerRequest request) Grants permission to delete a worker
DeleteWorkerFleetResult	deleteWorkerFleet(DeleteWorkerFleetRequest request) Grants permission to delete a worker fleet
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetDestinationResult	getDestination(GetDestinationRequest request) Grants permission to get a destination
GetSiteResult	getSite(GetSiteRequest request) Grants permission to get a site
GetWorkerResult	getWorker(GetWorkerRequest request) Grants permission to get a worker
GetWorkerFleetResult	getWorkerFleet(GetWorkerFleetRequest request) Grants permission to get a worker fleet
ListDestinationsResult	listDestinations(ListDestinationsRequest request) Grants permission to list destinations
ListSitesResult	listSites(ListSitesRequest request) Grants permission to list sites
ListWorkerFleetsResult	listWorkerFleets(ListWorkerFleetsRequest request) Grants permission to list worker fleets
ListWorkersResult	listWorkers(ListWorkersRequest request) Grants permission to list workers
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateDestinationResult	updateDestination(UpdateDestinationRequest request) Grants permission to update a destination
UpdateSiteResult	updateSite(UpdateSiteRequest request) Grants permission to update a site
UpdateWorkerResult	updateWorker(UpdateWorkerRequest request) Grants permission to update a worker
UpdateWorkerFleetResult	updateWorkerFleet(UpdateWorkerFleetRequest request) Grants permission to update a worker fleet

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AWSIoTRoboRunnerClientBuilder builder()

createDestination

public CreateDestinationResult createDestination(CreateDestinationRequest request)

Grants permission to create a destination

Specified by:

createDestination in interface AWSIoTRoboRunner

Parameters:

createDestinationRequest -

Returns:

Result of the CreateDestination operation returned by the service.

Throws:

ConflictException - Exception thrown if a resource in a create request already exists.

AccessDeniedException - User does not have sufficient access to perform this action.

ValidationException - Exception thrown if an invalid parameter is provided to an API.

ResourceNotFoundException - Exception thrown if a resource referenced in the request doesn't exist.

ThrottlingException - Exception thrown if the api has been called too quickly be the client.

InternalServerException - Exception thrown if something goes wrong within the service.

ServiceQuotaExceededException - Exception thrown if the user's AWS account has reached a service limit and the operation cannot proceed.

See Also:

AWS API Documentation

createSite

public CreateSiteResult createSite(CreateSiteRequest request)

Grants permission to create a site

Specified by:

createSite in interface AWSIoTRoboRunner

Parameters:

createSiteRequest -

Returns:

Result of the CreateSite operation returned by the service.

Throws:

ConflictException - Exception thrown if a resource in a create request already exists.

AccessDeniedException - User does not have sufficient access to perform this action.

ValidationException - Exception thrown if an invalid parameter is provided to an API.

ThrottlingException - Exception thrown if the api has been called too quickly be the client.

InternalServerException - Exception thrown if something goes wrong within the service.

ServiceQuotaExceededException - Exception thrown if the user's AWS account has reached a service limit and the operation cannot proceed.

See Also:

AWS API Documentation

createWorker

public CreateWorkerResult createWorker(CreateWorkerRequest request)

Grants permission to create a worker

Specified by:

createWorker in interface AWSIoTRoboRunner

Parameters:

createWorkerRequest -

Returns:

Result of the CreateWorker operation returned by the service.

Throws:

ConflictException - Exception thrown if a resource in a create request already exists.

AccessDeniedException - User does not have sufficient access to perform this action.

ValidationException - Exception thrown if an invalid parameter is provided to an API.

ResourceNotFoundException - Exception thrown if a resource referenced in the request doesn't exist.

ThrottlingException - Exception thrown if the api has been called too quickly be the client.

InternalServerException - Exception thrown if something goes wrong within the service.

ServiceQuotaExceededException - Exception thrown if the user's AWS account has reached a service limit and the operation cannot proceed.

See Also:

AWS API Documentation

createWorkerFleet

public CreateWorkerFleetResult createWorkerFleet(CreateWorkerFleetRequest request)

Grants permission to create a worker fleet

Specified by:

createWorkerFleet in interface AWSIoTRoboRunner

Parameters:

createWorkerFleetRequest -

Returns:

Result of the CreateWorkerFleet operation returned by the service.

Throws:

ConflictException - Exception thrown if a resource in a create request already exists.

AccessDeniedException - User does not have sufficient access to perform this action.

ValidationException - Exception thrown if an invalid parameter is provided to an API.

ResourceNotFoundException - Exception thrown if a resource referenced in the request doesn't exist.

ThrottlingException - Exception thrown if the api has been called too quickly be the client.

InternalServerException - Exception thrown if something goes wrong within the service.

ServiceQuotaExceededException - Exception thrown if the user's AWS account has reached a service limit and the operation cannot proceed.

See Also:

AWS API Documentation

deleteDestination

public DeleteDestinationResult deleteDestination(DeleteDestinationRequest request)

Grants permission to delete a destination

Specified by:

deleteDestination in interface AWSIoTRoboRunner

Parameters:

deleteDestinationRequest -

Returns:

Result of the DeleteDestination operation returned by the service.

Throws:

ConflictException - Exception thrown if a resource in a create request already exists.

AccessDeniedException - User does not have sufficient access to perform this action.

ValidationException - Exception thrown if an invalid parameter is provided to an API.

ResourceNotFoundException - Exception thrown if a resource referenced in the request doesn't exist.

ThrottlingException - Exception thrown if the api has been called too quickly be the client.

InternalServerException - Exception thrown if something goes wrong within the service.

See Also:

AWS API Documentation

deleteSite

public DeleteSiteResult deleteSite(DeleteSiteRequest request)

Grants permission to delete a site

Specified by:

deleteSite in interface AWSIoTRoboRunner

Parameters:

deleteSiteRequest -

Returns:

Result of the DeleteSite operation returned by the service.

Throws:

ConflictException - Exception thrown if a resource in a create request already exists.

AccessDeniedException - User does not have sufficient access to perform this action.

ValidationException - Exception thrown if an invalid parameter is provided to an API.

ResourceNotFoundException - Exception thrown if a resource referenced in the request doesn't exist.

ThrottlingException - Exception thrown if the api has been called too quickly be the client.

InternalServerException - Exception thrown if something goes wrong within the service.

See Also:

AWS API Documentation

deleteWorker

public DeleteWorkerResult deleteWorker(DeleteWorkerRequest request)

Grants permission to delete a worker

Specified by:

deleteWorker in interface AWSIoTRoboRunner

Parameters:

deleteWorkerRequest -

Returns:

Result of the DeleteWorker operation returned by the service.

Throws:

ConflictException - Exception thrown if a resource in a create request already exists.

AccessDeniedException - User does not have sufficient access to perform this action.

ValidationException - Exception thrown if an invalid parameter is provided to an API.

ResourceNotFoundException - Exception thrown if a resource referenced in the request doesn't exist.

ThrottlingException - Exception thrown if the api has been called too quickly be the client.

InternalServerException - Exception thrown if something goes wrong within the service.

See Also:

AWS API Documentation

deleteWorkerFleet

public DeleteWorkerFleetResult deleteWorkerFleet(DeleteWorkerFleetRequest request)

Grants permission to delete a worker fleet

Specified by:

deleteWorkerFleet in interface AWSIoTRoboRunner

Parameters:

deleteWorkerFleetRequest -

Returns:

Result of the DeleteWorkerFleet operation returned by the service.

Throws:

ConflictException - Exception thrown if a resource in a create request already exists.

AccessDeniedException - User does not have sufficient access to perform this action.

ValidationException - Exception thrown if an invalid parameter is provided to an API.

ResourceNotFoundException - Exception thrown if a resource referenced in the request doesn't exist.

ThrottlingException - Exception thrown if the api has been called too quickly be the client.

InternalServerException - Exception thrown if something goes wrong within the service.

See Also:

AWS API Documentation

getDestination

public GetDestinationResult getDestination(GetDestinationRequest request)

Grants permission to get a destination

Specified by:

getDestination in interface AWSIoTRoboRunner

Parameters:

getDestinationRequest -

Returns:

Result of the GetDestination operation returned by the service.

Throws:

AccessDeniedException - User does not have sufficient access to perform this action.

ValidationException - Exception thrown if an invalid parameter is provided to an API.

ResourceNotFoundException - Exception thrown if a resource referenced in the request doesn't exist.

ThrottlingException - Exception thrown if the api has been called too quickly be the client.

InternalServerException - Exception thrown if something goes wrong within the service.

See Also:

AWS API Documentation

getSite

public GetSiteResult getSite(GetSiteRequest request)

Grants permission to get a site

Specified by:

getSite in interface AWSIoTRoboRunner

Parameters:

getSiteRequest -

Returns:

Result of the GetSite operation returned by the service.

Throws:

AccessDeniedException - User does not have sufficient access to perform this action.

ValidationException - Exception thrown if an invalid parameter is provided to an API.

ResourceNotFoundException - Exception thrown if a resource referenced in the request doesn't exist.

ThrottlingException - Exception thrown if the api has been called too quickly be the client.

InternalServerException - Exception thrown if something goes wrong within the service.

See Also:

AWS API Documentation

getWorker

public GetWorkerResult getWorker(GetWorkerRequest request)

Grants permission to get a worker

Specified by:

getWorker in interface AWSIoTRoboRunner

Parameters:

getWorkerRequest -

Returns:

Result of the GetWorker operation returned by the service.

Throws:

AccessDeniedException - User does not have sufficient access to perform this action.

ValidationException - Exception thrown if an invalid parameter is provided to an API.

ResourceNotFoundException - Exception thrown if a resource referenced in the request doesn't exist.

ThrottlingException - Exception thrown if the api has been called too quickly be the client.

InternalServerException - Exception thrown if something goes wrong within the service.

See Also:

AWS API Documentation

getWorkerFleet

public GetWorkerFleetResult getWorkerFleet(GetWorkerFleetRequest request)

Grants permission to get a worker fleet

Specified by:

getWorkerFleet in interface AWSIoTRoboRunner

Parameters:

getWorkerFleetRequest -

Returns:

Result of the GetWorkerFleet operation returned by the service.

Throws:

AccessDeniedException - User does not have sufficient access to perform this action.

ValidationException - Exception thrown if an invalid parameter is provided to an API.

ResourceNotFoundException - Exception thrown if a resource referenced in the request doesn't exist.

ThrottlingException - Exception thrown if the api has been called too quickly be the client.

InternalServerException - Exception thrown if something goes wrong within the service.

See Also:

AWS API Documentation

listDestinations

public ListDestinationsResult listDestinations(ListDestinationsRequest request)

Grants permission to list destinations

Specified by:

listDestinations in interface AWSIoTRoboRunner

Parameters:

listDestinationsRequest -

Returns:

Result of the ListDestinations operation returned by the service.

Throws:

AccessDeniedException - User does not have sufficient access to perform this action.

ValidationException - Exception thrown if an invalid parameter is provided to an API.

ResourceNotFoundException - Exception thrown if a resource referenced in the request doesn't exist.

ThrottlingException - Exception thrown if the api has been called too quickly be the client.

InternalServerException - Exception thrown if something goes wrong within the service.

See Also:

AWS API Documentation

listSites

public ListSitesResult listSites(ListSitesRequest request)

Grants permission to list sites

Specified by:

listSites in interface AWSIoTRoboRunner

Parameters:

listSitesRequest -

Returns:

Result of the ListSites operation returned by the service.

Throws:

AccessDeniedException - User does not have sufficient access to perform this action.

ValidationException - Exception thrown if an invalid parameter is provided to an API.

ThrottlingException - Exception thrown if the api has been called too quickly be the client.

InternalServerException - Exception thrown if something goes wrong within the service.

See Also:

AWS API Documentation

listWorkerFleets

public ListWorkerFleetsResult listWorkerFleets(ListWorkerFleetsRequest request)

Grants permission to list worker fleets

Specified by:

listWorkerFleets in interface AWSIoTRoboRunner

Parameters:

listWorkerFleetsRequest -

Returns:

Result of the ListWorkerFleets operation returned by the service.

Throws:

AccessDeniedException - User does not have sufficient access to perform this action.

ValidationException - Exception thrown if an invalid parameter is provided to an API.

ResourceNotFoundException - Exception thrown if a resource referenced in the request doesn't exist.

ThrottlingException - Exception thrown if the api has been called too quickly be the client.

InternalServerException - Exception thrown if something goes wrong within the service.

See Also:

AWS API Documentation

listWorkers

public ListWorkersResult listWorkers(ListWorkersRequest request)

Grants permission to list workers

Specified by:

listWorkers in interface AWSIoTRoboRunner

Parameters:

listWorkersRequest -

Returns:

Result of the ListWorkers operation returned by the service.

Throws:

AccessDeniedException - User does not have sufficient access to perform this action.

ValidationException - Exception thrown if an invalid parameter is provided to an API.

ResourceNotFoundException - Exception thrown if a resource referenced in the request doesn't exist.

ThrottlingException - Exception thrown if the api has been called too quickly be the client.

InternalServerException - Exception thrown if something goes wrong within the service.

See Also:

AWS API Documentation

updateDestination

public UpdateDestinationResult updateDestination(UpdateDestinationRequest request)

Grants permission to update a destination

Specified by:

updateDestination in interface AWSIoTRoboRunner

Parameters:

updateDestinationRequest -

Returns:

Result of the UpdateDestination operation returned by the service.

Throws:

AccessDeniedException - User does not have sufficient access to perform this action.

ValidationException - Exception thrown if an invalid parameter is provided to an API.

ResourceNotFoundException - Exception thrown if a resource referenced in the request doesn't exist.

ThrottlingException - Exception thrown if the api has been called too quickly be the client.

InternalServerException - Exception thrown if something goes wrong within the service.

See Also:

AWS API Documentation

updateSite

public UpdateSiteResult updateSite(UpdateSiteRequest request)

Grants permission to update a site

Specified by:

updateSite in interface AWSIoTRoboRunner

Parameters:

updateSiteRequest -

Returns:

Result of the UpdateSite operation returned by the service.

Throws:

AccessDeniedException - User does not have sufficient access to perform this action.

ValidationException - Exception thrown if an invalid parameter is provided to an API.

ResourceNotFoundException - Exception thrown if a resource referenced in the request doesn't exist.

ThrottlingException - Exception thrown if the api has been called too quickly be the client.

InternalServerException - Exception thrown if something goes wrong within the service.

See Also:

AWS API Documentation

updateWorker

public UpdateWorkerResult updateWorker(UpdateWorkerRequest request)

Grants permission to update a worker

Specified by:

updateWorker in interface AWSIoTRoboRunner

Parameters:

updateWorkerRequest -

Returns:

Result of the UpdateWorker operation returned by the service.

Throws:

AccessDeniedException - User does not have sufficient access to perform this action.

ValidationException - Exception thrown if an invalid parameter is provided to an API.

ResourceNotFoundException - Exception thrown if a resource referenced in the request doesn't exist.

ThrottlingException - Exception thrown if the api has been called too quickly be the client.

InternalServerException - Exception thrown if something goes wrong within the service.

See Also:

AWS API Documentation

updateWorkerFleet

public UpdateWorkerFleetResult updateWorkerFleet(UpdateWorkerFleetRequest request)

Grants permission to update a worker fleet

Specified by:

updateWorkerFleet in interface AWSIoTRoboRunner

Parameters:

updateWorkerFleetRequest -

Returns:

Result of the UpdateWorkerFleet operation returned by the service.

Throws:

AccessDeniedException - User does not have sufficient access to perform this action.

ValidationException - Exception thrown if an invalid parameter is provided to an API.

ResourceNotFoundException - Exception thrown if a resource referenced in the request doesn't exist.

ThrottlingException - Exception thrown if the api has been called too quickly be the client.

InternalServerException - Exception thrown if something goes wrong within the service.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

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 the request.

Specified by:

getCachedResponseMetadata in interface AWSIoTRoboRunner

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSIoTRoboRunner

Overrides:

shutdown in class AmazonWebServiceClient