com.amazonaws.services.iotroborunner

Interface AWSIoTRoboRunner

All Known Subinterfaces:

AWSIoTRoboRunnerAsync

All Known Implementing Classes:

AbstractAWSIoTRoboRunner, AbstractAWSIoTRoboRunnerAsync, AWSIoTRoboRunnerAsyncClient, AWSIoTRoboRunnerClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSIoTRoboRunner

Interface for accessing AWS IoT RoboRunner.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSIoTRoboRunner instead.

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateDestinationResult	createDestination(CreateDestinationRequest createDestinationRequest) Grants permission to create a destination
CreateSiteResult	createSite(CreateSiteRequest createSiteRequest) Grants permission to create a site
CreateWorkerResult	createWorker(CreateWorkerRequest createWorkerRequest) Grants permission to create a worker
CreateWorkerFleetResult	createWorkerFleet(CreateWorkerFleetRequest createWorkerFleetRequest) Grants permission to create a worker fleet
DeleteDestinationResult	deleteDestination(DeleteDestinationRequest deleteDestinationRequest) Grants permission to delete a destination
DeleteSiteResult	deleteSite(DeleteSiteRequest deleteSiteRequest) Grants permission to delete a site
DeleteWorkerResult	deleteWorker(DeleteWorkerRequest deleteWorkerRequest) Grants permission to delete a worker
DeleteWorkerFleetResult	deleteWorkerFleet(DeleteWorkerFleetRequest deleteWorkerFleetRequest) 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 getDestinationRequest) Grants permission to get a destination
GetSiteResult	getSite(GetSiteRequest getSiteRequest) Grants permission to get a site
GetWorkerResult	getWorker(GetWorkerRequest getWorkerRequest) Grants permission to get a worker
GetWorkerFleetResult	getWorkerFleet(GetWorkerFleetRequest getWorkerFleetRequest) Grants permission to get a worker fleet
ListDestinationsResult	listDestinations(ListDestinationsRequest listDestinationsRequest) Grants permission to list destinations
ListSitesResult	listSites(ListSitesRequest listSitesRequest) Grants permission to list sites
ListWorkerFleetsResult	listWorkerFleets(ListWorkerFleetsRequest listWorkerFleetsRequest) Grants permission to list worker fleets
ListWorkersResult	listWorkers(ListWorkersRequest listWorkersRequest) Grants permission to list workers
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateDestinationResult	updateDestination(UpdateDestinationRequest updateDestinationRequest) Grants permission to update a destination
UpdateSiteResult	updateSite(UpdateSiteRequest updateSiteRequest) Grants permission to update a site
UpdateWorkerResult	updateWorker(UpdateWorkerRequest updateWorkerRequest) Grants permission to update a worker
UpdateWorkerFleetResult	updateWorkerFleet(UpdateWorkerFleetRequest updateWorkerFleetRequest) Grants permission to update a worker fleet

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

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 Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createDestination

CreateDestinationResult createDestination(CreateDestinationRequest createDestinationRequest)

Grants permission to create a destination

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

CreateSiteResult createSite(CreateSiteRequest createSiteRequest)

Grants permission to create a site

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

CreateWorkerResult createWorker(CreateWorkerRequest createWorkerRequest)

Grants permission to create a worker

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

CreateWorkerFleetResult createWorkerFleet(CreateWorkerFleetRequest createWorkerFleetRequest)

Grants permission to create a worker fleet

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

DeleteDestinationResult deleteDestination(DeleteDestinationRequest deleteDestinationRequest)

Grants permission to delete a destination

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

DeleteSiteResult deleteSite(DeleteSiteRequest deleteSiteRequest)

Grants permission to delete a site

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

DeleteWorkerResult deleteWorker(DeleteWorkerRequest deleteWorkerRequest)

Grants permission to delete a worker

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

DeleteWorkerFleetResult deleteWorkerFleet(DeleteWorkerFleetRequest deleteWorkerFleetRequest)

Grants permission to delete a worker fleet

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

GetDestinationResult getDestination(GetDestinationRequest getDestinationRequest)

Grants permission to get a destination

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

GetSiteResult getSite(GetSiteRequest getSiteRequest)

Grants permission to get a site

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

GetWorkerResult getWorker(GetWorkerRequest getWorkerRequest)

Grants permission to get a worker

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

GetWorkerFleetResult getWorkerFleet(GetWorkerFleetRequest getWorkerFleetRequest)

Grants permission to get a worker fleet

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

ListDestinationsResult listDestinations(ListDestinationsRequest listDestinationsRequest)

Grants permission to list destinations

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

ListSitesResult listSites(ListSitesRequest listSitesRequest)

Grants permission to list sites

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

ListWorkerFleetsResult listWorkerFleets(ListWorkerFleetsRequest listWorkerFleetsRequest)

Grants permission to list worker fleets

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

ListWorkersResult listWorkers(ListWorkersRequest listWorkersRequest)

Grants permission to list workers

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

UpdateDestinationResult updateDestination(UpdateDestinationRequest updateDestinationRequest)

Grants permission to update a destination

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

UpdateSiteResult updateSite(UpdateSiteRequest updateSiteRequest)

Grants permission to update a site

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

UpdateWorkerResult updateWorker(UpdateWorkerRequest updateWorkerRequest)

Grants permission to update a worker

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

UpdateWorkerFleetResult updateWorkerFleet(UpdateWorkerFleetRequest updateWorkerFleetRequest)

Grants permission to update a worker fleet

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

shutdown

void shutdown()

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.

getCachedResponseMetadata

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

Parameters:

request - The originally executed request.

Returns:

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