Interface IotRoboRunnerClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface IotRoboRunnerClient extends AwsClient
Service client for accessing AWS IoT RoboRunner. This can be created using the staticbuilder()method.An example service, deployed with the Octane Service creator, which will echo the string
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
createDestination
default CreateDestinationResponse createDestination(CreateDestinationRequest createDestinationRequest) throws ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IotRoboRunnerException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createDestination
default CreateDestinationResponse createDestination(Consumer<CreateDestinationRequest.Builder> createDestinationRequest) throws ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IotRoboRunnerException
Grants permission to create a destination
This is a convenience which creates an instance of the
CreateDestinationRequest.Builderavoiding the need to create one manually viaCreateDestinationRequest.builder()- Parameters:
createDestinationRequest- AConsumerthat will call methods onCreateDestinationRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createSite
default CreateSiteResponse createSite(CreateSiteRequest createSiteRequest) throws ConflictException, AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IotRoboRunnerException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createSite
default CreateSiteResponse createSite(Consumer<CreateSiteRequest.Builder> createSiteRequest) throws ConflictException, AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IotRoboRunnerException
Grants permission to create a site
This is a convenience which creates an instance of the
CreateSiteRequest.Builderavoiding the need to create one manually viaCreateSiteRequest.builder()- Parameters:
createSiteRequest- AConsumerthat will call methods onCreateSiteRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createWorker
default CreateWorkerResponse createWorker(CreateWorkerRequest createWorkerRequest) throws ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IotRoboRunnerException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createWorker
default CreateWorkerResponse createWorker(Consumer<CreateWorkerRequest.Builder> createWorkerRequest) throws ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IotRoboRunnerException
Grants permission to create a worker
This is a convenience which creates an instance of the
CreateWorkerRequest.Builderavoiding the need to create one manually viaCreateWorkerRequest.builder()- Parameters:
createWorkerRequest- AConsumerthat will call methods onCreateWorkerRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createWorkerFleet
default CreateWorkerFleetResponse createWorkerFleet(CreateWorkerFleetRequest createWorkerFleetRequest) throws ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IotRoboRunnerException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createWorkerFleet
default CreateWorkerFleetResponse createWorkerFleet(Consumer<CreateWorkerFleetRequest.Builder> createWorkerFleetRequest) throws ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IotRoboRunnerException
Grants permission to create a worker fleet
This is a convenience which creates an instance of the
CreateWorkerFleetRequest.Builderavoiding the need to create one manually viaCreateWorkerFleetRequest.builder()- Parameters:
createWorkerFleetRequest- AConsumerthat will call methods onCreateWorkerFleetRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDestination
default DeleteDestinationResponse deleteDestination(DeleteDestinationRequest deleteDestinationRequest) throws ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDestination
default DeleteDestinationResponse deleteDestination(Consumer<DeleteDestinationRequest.Builder> deleteDestinationRequest) throws ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
Grants permission to delete a destination
This is a convenience which creates an instance of the
DeleteDestinationRequest.Builderavoiding the need to create one manually viaDeleteDestinationRequest.builder()- Parameters:
deleteDestinationRequest- AConsumerthat will call methods onDeleteDestinationRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteSite
default DeleteSiteResponse deleteSite(DeleteSiteRequest deleteSiteRequest) throws ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteSite
default DeleteSiteResponse deleteSite(Consumer<DeleteSiteRequest.Builder> deleteSiteRequest) throws ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
Grants permission to delete a site
This is a convenience which creates an instance of the
DeleteSiteRequest.Builderavoiding the need to create one manually viaDeleteSiteRequest.builder()- Parameters:
deleteSiteRequest- AConsumerthat will call methods onDeleteSiteRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteWorker
default DeleteWorkerResponse deleteWorker(DeleteWorkerRequest deleteWorkerRequest) throws ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteWorker
default DeleteWorkerResponse deleteWorker(Consumer<DeleteWorkerRequest.Builder> deleteWorkerRequest) throws ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
Grants permission to delete a worker
This is a convenience which creates an instance of the
DeleteWorkerRequest.Builderavoiding the need to create one manually viaDeleteWorkerRequest.builder()- Parameters:
deleteWorkerRequest- AConsumerthat will call methods onDeleteWorkerRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteWorkerFleet
default DeleteWorkerFleetResponse deleteWorkerFleet(DeleteWorkerFleetRequest deleteWorkerFleetRequest) throws ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteWorkerFleet
default DeleteWorkerFleetResponse deleteWorkerFleet(Consumer<DeleteWorkerFleetRequest.Builder> deleteWorkerFleetRequest) throws ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
Grants permission to delete a worker fleet
This is a convenience which creates an instance of the
DeleteWorkerFleetRequest.Builderavoiding the need to create one manually viaDeleteWorkerFleetRequest.builder()- Parameters:
deleteWorkerFleetRequest- AConsumerthat will call methods onDeleteWorkerFleetRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getDestination
default GetDestinationResponse getDestination(GetDestinationRequest getDestinationRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getDestination
default GetDestinationResponse getDestination(Consumer<GetDestinationRequest.Builder> getDestinationRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
Grants permission to get a destination
This is a convenience which creates an instance of the
GetDestinationRequest.Builderavoiding the need to create one manually viaGetDestinationRequest.builder()- Parameters:
getDestinationRequest- AConsumerthat will call methods onGetDestinationRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getSite
default GetSiteResponse getSite(GetSiteRequest getSiteRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getSite
default GetSiteResponse getSite(Consumer<GetSiteRequest.Builder> getSiteRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
Grants permission to get a site
This is a convenience which creates an instance of the
GetSiteRequest.Builderavoiding the need to create one manually viaGetSiteRequest.builder()- Parameters:
getSiteRequest- AConsumerthat will call methods onGetSiteRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getWorker
default GetWorkerResponse getWorker(GetWorkerRequest getWorkerRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getWorker
default GetWorkerResponse getWorker(Consumer<GetWorkerRequest.Builder> getWorkerRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
Grants permission to get a worker
This is a convenience which creates an instance of the
GetWorkerRequest.Builderavoiding the need to create one manually viaGetWorkerRequest.builder()- Parameters:
getWorkerRequest- AConsumerthat will call methods onGetWorkerRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getWorkerFleet
default GetWorkerFleetResponse getWorkerFleet(GetWorkerFleetRequest getWorkerFleetRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getWorkerFleet
default GetWorkerFleetResponse getWorkerFleet(Consumer<GetWorkerFleetRequest.Builder> getWorkerFleetRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
Grants permission to get a worker fleet
This is a convenience which creates an instance of the
GetWorkerFleetRequest.Builderavoiding the need to create one manually viaGetWorkerFleetRequest.builder()- Parameters:
getWorkerFleetRequest- AConsumerthat will call methods onGetWorkerFleetRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listDestinations
default ListDestinationsResponse listDestinations(ListDestinationsRequest listDestinationsRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listDestinations
default ListDestinationsResponse listDestinations(Consumer<ListDestinationsRequest.Builder> listDestinationsRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
Grants permission to list destinations
This is a convenience which creates an instance of the
ListDestinationsRequest.Builderavoiding the need to create one manually viaListDestinationsRequest.builder()- Parameters:
listDestinationsRequest- AConsumerthat will call methods onListDestinationsRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listDestinationsPaginator
default ListDestinationsIterable listDestinationsPaginator(ListDestinationsRequest listDestinationsRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
This is a variant of
listDestinations(software.amazon.awssdk.services.iotroborunner.model.ListDestinationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotroborunner.paginators.ListDestinationsIterable responses = client.listDestinationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotroborunner.paginators.ListDestinationsIterable responses = client .listDestinationsPaginator(request); for (software.amazon.awssdk.services.iotroborunner.model.ListDestinationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotroborunner.paginators.ListDestinationsIterable responses = client.listDestinationsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDestinations(software.amazon.awssdk.services.iotroborunner.model.ListDestinationsRequest)operation.- Parameters:
listDestinationsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listDestinationsPaginator
default ListDestinationsIterable listDestinationsPaginator(Consumer<ListDestinationsRequest.Builder> listDestinationsRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
This is a variant of
listDestinations(software.amazon.awssdk.services.iotroborunner.model.ListDestinationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotroborunner.paginators.ListDestinationsIterable responses = client.listDestinationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotroborunner.paginators.ListDestinationsIterable responses = client .listDestinationsPaginator(request); for (software.amazon.awssdk.services.iotroborunner.model.ListDestinationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotroborunner.paginators.ListDestinationsIterable responses = client.listDestinationsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDestinations(software.amazon.awssdk.services.iotroborunner.model.ListDestinationsRequest)operation.
This is a convenience which creates an instance of the
ListDestinationsRequest.Builderavoiding the need to create one manually viaListDestinationsRequest.builder()- Parameters:
listDestinationsRequest- AConsumerthat will call methods onListDestinationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listSites
default ListSitesResponse listSites(ListSitesRequest listSitesRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listSites
default ListSitesResponse listSites(Consumer<ListSitesRequest.Builder> listSitesRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
Grants permission to list sites
This is a convenience which creates an instance of the
ListSitesRequest.Builderavoiding the need to create one manually viaListSitesRequest.builder()- Parameters:
listSitesRequest- AConsumerthat will call methods onListSitesRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listSitesPaginator
default ListSitesIterable listSitesPaginator(ListSitesRequest listSitesRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
This is a variant of
listSites(software.amazon.awssdk.services.iotroborunner.model.ListSitesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotroborunner.paginators.ListSitesIterable responses = client.listSitesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotroborunner.paginators.ListSitesIterable responses = client.listSitesPaginator(request); for (software.amazon.awssdk.services.iotroborunner.model.ListSitesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotroborunner.paginators.ListSitesIterable responses = client.listSitesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSites(software.amazon.awssdk.services.iotroborunner.model.ListSitesRequest)operation.- Parameters:
listSitesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listSitesPaginator
default ListSitesIterable listSitesPaginator(Consumer<ListSitesRequest.Builder> listSitesRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
This is a variant of
listSites(software.amazon.awssdk.services.iotroborunner.model.ListSitesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotroborunner.paginators.ListSitesIterable responses = client.listSitesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotroborunner.paginators.ListSitesIterable responses = client.listSitesPaginator(request); for (software.amazon.awssdk.services.iotroborunner.model.ListSitesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotroborunner.paginators.ListSitesIterable responses = client.listSitesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSites(software.amazon.awssdk.services.iotroborunner.model.ListSitesRequest)operation.
This is a convenience which creates an instance of the
ListSitesRequest.Builderavoiding the need to create one manually viaListSitesRequest.builder()- Parameters:
listSitesRequest- AConsumerthat will call methods onListSitesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkerFleets
default ListWorkerFleetsResponse listWorkerFleets(ListWorkerFleetsRequest listWorkerFleetsRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkerFleets
default ListWorkerFleetsResponse listWorkerFleets(Consumer<ListWorkerFleetsRequest.Builder> listWorkerFleetsRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
Grants permission to list worker fleets
This is a convenience which creates an instance of the
ListWorkerFleetsRequest.Builderavoiding the need to create one manually viaListWorkerFleetsRequest.builder()- Parameters:
listWorkerFleetsRequest- AConsumerthat will call methods onListWorkerFleetsRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkerFleetsPaginator
default ListWorkerFleetsIterable listWorkerFleetsPaginator(ListWorkerFleetsRequest listWorkerFleetsRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
This is a variant of
listWorkerFleets(software.amazon.awssdk.services.iotroborunner.model.ListWorkerFleetsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotroborunner.paginators.ListWorkerFleetsIterable responses = client.listWorkerFleetsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotroborunner.paginators.ListWorkerFleetsIterable responses = client .listWorkerFleetsPaginator(request); for (software.amazon.awssdk.services.iotroborunner.model.ListWorkerFleetsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotroborunner.paginators.ListWorkerFleetsIterable responses = client.listWorkerFleetsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWorkerFleets(software.amazon.awssdk.services.iotroborunner.model.ListWorkerFleetsRequest)operation.- Parameters:
listWorkerFleetsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkerFleetsPaginator
default ListWorkerFleetsIterable listWorkerFleetsPaginator(Consumer<ListWorkerFleetsRequest.Builder> listWorkerFleetsRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
This is a variant of
listWorkerFleets(software.amazon.awssdk.services.iotroborunner.model.ListWorkerFleetsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotroborunner.paginators.ListWorkerFleetsIterable responses = client.listWorkerFleetsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotroborunner.paginators.ListWorkerFleetsIterable responses = client .listWorkerFleetsPaginator(request); for (software.amazon.awssdk.services.iotroborunner.model.ListWorkerFleetsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotroborunner.paginators.ListWorkerFleetsIterable responses = client.listWorkerFleetsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWorkerFleets(software.amazon.awssdk.services.iotroborunner.model.ListWorkerFleetsRequest)operation.
This is a convenience which creates an instance of the
ListWorkerFleetsRequest.Builderavoiding the need to create one manually viaListWorkerFleetsRequest.builder()- Parameters:
listWorkerFleetsRequest- AConsumerthat will call methods onListWorkerFleetsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkers
default ListWorkersResponse listWorkers(ListWorkersRequest listWorkersRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkers
default ListWorkersResponse listWorkers(Consumer<ListWorkersRequest.Builder> listWorkersRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
Grants permission to list workers
This is a convenience which creates an instance of the
ListWorkersRequest.Builderavoiding the need to create one manually viaListWorkersRequest.builder()- Parameters:
listWorkersRequest- AConsumerthat will call methods onListWorkersRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkersPaginator
default ListWorkersIterable listWorkersPaginator(ListWorkersRequest listWorkersRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
This is a variant of
listWorkers(software.amazon.awssdk.services.iotroborunner.model.ListWorkersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotroborunner.paginators.ListWorkersIterable responses = client.listWorkersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotroborunner.paginators.ListWorkersIterable responses = client.listWorkersPaginator(request); for (software.amazon.awssdk.services.iotroborunner.model.ListWorkersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotroborunner.paginators.ListWorkersIterable responses = client.listWorkersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWorkers(software.amazon.awssdk.services.iotroborunner.model.ListWorkersRequest)operation.- Parameters:
listWorkersRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkersPaginator
default ListWorkersIterable listWorkersPaginator(Consumer<ListWorkersRequest.Builder> listWorkersRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
This is a variant of
listWorkers(software.amazon.awssdk.services.iotroborunner.model.ListWorkersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.iotroborunner.paginators.ListWorkersIterable responses = client.listWorkersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.iotroborunner.paginators.ListWorkersIterable responses = client.listWorkersPaginator(request); for (software.amazon.awssdk.services.iotroborunner.model.ListWorkersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.iotroborunner.paginators.ListWorkersIterable responses = client.listWorkersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWorkers(software.amazon.awssdk.services.iotroborunner.model.ListWorkersRequest)operation.
This is a convenience which creates an instance of the
ListWorkersRequest.Builderavoiding the need to create one manually viaListWorkersRequest.builder()- Parameters:
listWorkersRequest- AConsumerthat will call methods onListWorkersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateDestination
default UpdateDestinationResponse updateDestination(UpdateDestinationRequest updateDestinationRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateDestination
default UpdateDestinationResponse updateDestination(Consumer<UpdateDestinationRequest.Builder> updateDestinationRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
Grants permission to update a destination
This is a convenience which creates an instance of the
UpdateDestinationRequest.Builderavoiding the need to create one manually viaUpdateDestinationRequest.builder()- Parameters:
updateDestinationRequest- AConsumerthat will call methods onUpdateDestinationRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateSite
default UpdateSiteResponse updateSite(UpdateSiteRequest updateSiteRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateSite
default UpdateSiteResponse updateSite(Consumer<UpdateSiteRequest.Builder> updateSiteRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
Grants permission to update a site
This is a convenience which creates an instance of the
UpdateSiteRequest.Builderavoiding the need to create one manually viaUpdateSiteRequest.builder()- Parameters:
updateSiteRequest- AConsumerthat will call methods onUpdateSiteRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateWorker
default UpdateWorkerResponse updateWorker(UpdateWorkerRequest updateWorkerRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateWorker
default UpdateWorkerResponse updateWorker(Consumer<UpdateWorkerRequest.Builder> updateWorkerRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
Grants permission to update a worker
This is a convenience which creates an instance of the
UpdateWorkerRequest.Builderavoiding the need to create one manually viaUpdateWorkerRequest.builder()- Parameters:
updateWorkerRequest- AConsumerthat will call methods onUpdateWorkerRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateWorkerFleet
default UpdateWorkerFleetResponse updateWorkerFleet(UpdateWorkerFleetRequest updateWorkerFleetRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateWorkerFleet
default UpdateWorkerFleetResponse updateWorkerFleet(Consumer<UpdateWorkerFleetRequest.Builder> updateWorkerFleetRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotRoboRunnerException
Grants permission to update a worker fleet
This is a convenience which creates an instance of the
UpdateWorkerFleetRequest.Builderavoiding the need to create one manually viaUpdateWorkerFleetRequest.builder()- Parameters:
updateWorkerFleetRequest- AConsumerthat will call methods onUpdateWorkerFleetRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.IotRoboRunnerException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
create
static IotRoboRunnerClient create()
Create aIotRoboRunnerClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static IotRoboRunnerClientBuilder builder()
Create a builder that can be used to configure and create aIotRoboRunnerClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default IotRoboRunnerServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-