Interface SsmQuickSetupAsyncClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface SsmQuickSetupAsyncClient extends AwsClient
Service client for accessing AWS Systems Manager QuickSetup asynchronously. This can be created using the staticbuilder()method.The asynchronous client performs non-blocking I/O when configured with anySdkAsyncHttpClientsupported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.Quick Setup helps you quickly configure frequently used services and features with recommended best practices. Quick Setup simplifies setting up services, including Systems Manager, by automating common or recommended tasks.
-
-
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
-
createConfigurationManager
default CompletableFuture<CreateConfigurationManagerResponse> createConfigurationManager(CreateConfigurationManagerRequest createConfigurationManagerRequest)
Creates a Quick Setup configuration manager resource. This object is a collection of desired state configurations for multiple configuration definitions and summaries describing the deployments of those definitions.
- Parameters:
createConfigurationManagerRequest-- Returns:
- A Java Future containing the result of the CreateConfigurationManager operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The request is invalid. Verify the values provided for the request parameters are accurate.
- ConflictException Another request is being processed. Wait a few minutes and try again.
- InternalServerException An error occurred on the server side.
- AccessDeniedException The requester has insufficient permissions to perform the operation.
- ThrottlingException The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- 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.
- SsmQuickSetupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createConfigurationManager
default CompletableFuture<CreateConfigurationManagerResponse> createConfigurationManager(Consumer<CreateConfigurationManagerRequest.Builder> createConfigurationManagerRequest)
Creates a Quick Setup configuration manager resource. This object is a collection of desired state configurations for multiple configuration definitions and summaries describing the deployments of those definitions.
This is a convenience which creates an instance of the
CreateConfigurationManagerRequest.Builderavoiding the need to create one manually viaCreateConfigurationManagerRequest.builder()- Parameters:
createConfigurationManagerRequest- AConsumerthat will call methods onCreateConfigurationManagerRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateConfigurationManager operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The request is invalid. Verify the values provided for the request parameters are accurate.
- ConflictException Another request is being processed. Wait a few minutes and try again.
- InternalServerException An error occurred on the server side.
- AccessDeniedException The requester has insufficient permissions to perform the operation.
- ThrottlingException The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- 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.
- SsmQuickSetupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteConfigurationManager
default CompletableFuture<DeleteConfigurationManagerResponse> deleteConfigurationManager(DeleteConfigurationManagerRequest deleteConfigurationManagerRequest)
Deletes a configuration manager.
- Parameters:
deleteConfigurationManagerRequest-- Returns:
- A Java Future containing the result of the DeleteConfigurationManager operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The request is invalid. Verify the values provided for the request parameters are accurate.
- ConflictException Another request is being processed. Wait a few minutes and try again.
- InternalServerException An error occurred on the server side.
- AccessDeniedException The requester has insufficient permissions to perform the operation.
- ThrottlingException The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- ResourceNotFoundException The resource couldn't be found. Check the ID or name and try again.
- 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.
- SsmQuickSetupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteConfigurationManager
default CompletableFuture<DeleteConfigurationManagerResponse> deleteConfigurationManager(Consumer<DeleteConfigurationManagerRequest.Builder> deleteConfigurationManagerRequest)
Deletes a configuration manager.
This is a convenience which creates an instance of the
DeleteConfigurationManagerRequest.Builderavoiding the need to create one manually viaDeleteConfigurationManagerRequest.builder()- Parameters:
deleteConfigurationManagerRequest- AConsumerthat will call methods onDeleteConfigurationManagerRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteConfigurationManager operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The request is invalid. Verify the values provided for the request parameters are accurate.
- ConflictException Another request is being processed. Wait a few minutes and try again.
- InternalServerException An error occurred on the server side.
- AccessDeniedException The requester has insufficient permissions to perform the operation.
- ThrottlingException The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- ResourceNotFoundException The resource couldn't be found. Check the ID or name and try again.
- 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.
- SsmQuickSetupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getConfiguration
default CompletableFuture<GetConfigurationResponse> getConfiguration(GetConfigurationRequest getConfigurationRequest)
Returns details about the specified configuration.
- Parameters:
getConfigurationRequest-- Returns:
- A Java Future containing the result of the GetConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The request is invalid. Verify the values provided for the request parameters are accurate.
- ConflictException Another request is being processed. Wait a few minutes and try again.
- InternalServerException An error occurred on the server side.
- AccessDeniedException The requester has insufficient permissions to perform the operation.
- ThrottlingException The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- ResourceNotFoundException The resource couldn't be found. Check the ID or name and try again.
- 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.
- SsmQuickSetupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getConfiguration
default CompletableFuture<GetConfigurationResponse> getConfiguration(Consumer<GetConfigurationRequest.Builder> getConfigurationRequest)
Returns details about the specified configuration.
This is a convenience which creates an instance of the
GetConfigurationRequest.Builderavoiding the need to create one manually viaGetConfigurationRequest.builder()- Parameters:
getConfigurationRequest- AConsumerthat will call methods onGetConfigurationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The request is invalid. Verify the values provided for the request parameters are accurate.
- ConflictException Another request is being processed. Wait a few minutes and try again.
- InternalServerException An error occurred on the server side.
- AccessDeniedException The requester has insufficient permissions to perform the operation.
- ThrottlingException The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- ResourceNotFoundException The resource couldn't be found. Check the ID or name and try again.
- 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.
- SsmQuickSetupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getConfigurationManager
default CompletableFuture<GetConfigurationManagerResponse> getConfigurationManager(GetConfigurationManagerRequest getConfigurationManagerRequest)
Returns a configuration manager.
- Parameters:
getConfigurationManagerRequest-- Returns:
- A Java Future containing the result of the GetConfigurationManager operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The request is invalid. Verify the values provided for the request parameters are accurate.
- ConflictException Another request is being processed. Wait a few minutes and try again.
- InternalServerException An error occurred on the server side.
- AccessDeniedException The requester has insufficient permissions to perform the operation.
- ThrottlingException The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- ResourceNotFoundException The resource couldn't be found. Check the ID or name and try again.
- 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.
- SsmQuickSetupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getConfigurationManager
default CompletableFuture<GetConfigurationManagerResponse> getConfigurationManager(Consumer<GetConfigurationManagerRequest.Builder> getConfigurationManagerRequest)
Returns a configuration manager.
This is a convenience which creates an instance of the
GetConfigurationManagerRequest.Builderavoiding the need to create one manually viaGetConfigurationManagerRequest.builder()- Parameters:
getConfigurationManagerRequest- AConsumerthat will call methods onGetConfigurationManagerRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetConfigurationManager operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The request is invalid. Verify the values provided for the request parameters are accurate.
- ConflictException Another request is being processed. Wait a few minutes and try again.
- InternalServerException An error occurred on the server side.
- AccessDeniedException The requester has insufficient permissions to perform the operation.
- ThrottlingException The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- ResourceNotFoundException The resource couldn't be found. Check the ID or name and try again.
- 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.
- SsmQuickSetupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getServiceSettings
default CompletableFuture<GetServiceSettingsResponse> getServiceSettings(GetServiceSettingsRequest getServiceSettingsRequest)
Returns settings configured for Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.
- Parameters:
getServiceSettingsRequest-- Returns:
- A Java Future containing the result of the GetServiceSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConflictException Another request is being processed. Wait a few minutes and try again.
- InternalServerException An error occurred on the server side.
- AccessDeniedException The requester has insufficient permissions to perform the operation.
- ThrottlingException The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- 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.
- SsmQuickSetupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getServiceSettings
default CompletableFuture<GetServiceSettingsResponse> getServiceSettings(Consumer<GetServiceSettingsRequest.Builder> getServiceSettingsRequest)
Returns settings configured for Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.
This is a convenience which creates an instance of the
GetServiceSettingsRequest.Builderavoiding the need to create one manually viaGetServiceSettingsRequest.builder()- Parameters:
getServiceSettingsRequest- AConsumerthat will call methods onGetServiceSettingsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetServiceSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConflictException Another request is being processed. Wait a few minutes and try again.
- InternalServerException An error occurred on the server side.
- AccessDeniedException The requester has insufficient permissions to perform the operation.
- ThrottlingException The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- 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.
- SsmQuickSetupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listConfigurationManagers
default CompletableFuture<ListConfigurationManagersResponse> listConfigurationManagers(ListConfigurationManagersRequest listConfigurationManagersRequest)
Returns Quick Setup configuration managers.
- Parameters:
listConfigurationManagersRequest-- Returns:
- A Java Future containing the result of the ListConfigurationManagers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The request is invalid. Verify the values provided for the request parameters are accurate.
- ConflictException Another request is being processed. Wait a few minutes and try again.
- InternalServerException An error occurred on the server side.
- AccessDeniedException The requester has insufficient permissions to perform the operation.
- ThrottlingException The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- 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.
- SsmQuickSetupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listConfigurationManagers
default CompletableFuture<ListConfigurationManagersResponse> listConfigurationManagers(Consumer<ListConfigurationManagersRequest.Builder> listConfigurationManagersRequest)
Returns Quick Setup configuration managers.
This is a convenience which creates an instance of the
ListConfigurationManagersRequest.Builderavoiding the need to create one manually viaListConfigurationManagersRequest.builder()- Parameters:
listConfigurationManagersRequest- AConsumerthat will call methods onListConfigurationManagersRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListConfigurationManagers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The request is invalid. Verify the values provided for the request parameters are accurate.
- ConflictException Another request is being processed. Wait a few minutes and try again.
- InternalServerException An error occurred on the server side.
- AccessDeniedException The requester has insufficient permissions to perform the operation.
- ThrottlingException The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- 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.
- SsmQuickSetupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listConfigurationManagersPaginator
default ListConfigurationManagersPublisher listConfigurationManagersPaginator(ListConfigurationManagersRequest listConfigurationManagersRequest)
This is a variant of
listConfigurationManagers(software.amazon.awssdk.services.ssmquicksetup.model.ListConfigurationManagersRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.ssmquicksetup.paginators.ListConfigurationManagersPublisher publisher = client.listConfigurationManagersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.ssmquicksetup.paginators.ListConfigurationManagersPublisher publisher = client.listConfigurationManagersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmquicksetup.model.ListConfigurationManagersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssmquicksetup.model.ListConfigurationManagersResponse response) { //... }; });Please notice that the configuration of MaxItems 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
listConfigurationManagers(software.amazon.awssdk.services.ssmquicksetup.model.ListConfigurationManagersRequest)operation.- Parameters:
listConfigurationManagersRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The request is invalid. Verify the values provided for the request parameters are accurate.
- ConflictException Another request is being processed. Wait a few minutes and try again.
- InternalServerException An error occurred on the server side.
- AccessDeniedException The requester has insufficient permissions to perform the operation.
- ThrottlingException The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- 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.
- SsmQuickSetupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listConfigurationManagersPaginator
default ListConfigurationManagersPublisher listConfigurationManagersPaginator(Consumer<ListConfigurationManagersRequest.Builder> listConfigurationManagersRequest)
This is a variant of
listConfigurationManagers(software.amazon.awssdk.services.ssmquicksetup.model.ListConfigurationManagersRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.ssmquicksetup.paginators.ListConfigurationManagersPublisher publisher = client.listConfigurationManagersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.ssmquicksetup.paginators.ListConfigurationManagersPublisher publisher = client.listConfigurationManagersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmquicksetup.model.ListConfigurationManagersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssmquicksetup.model.ListConfigurationManagersResponse response) { //... }; });Please notice that the configuration of MaxItems 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
listConfigurationManagers(software.amazon.awssdk.services.ssmquicksetup.model.ListConfigurationManagersRequest)operation.
This is a convenience which creates an instance of the
ListConfigurationManagersRequest.Builderavoiding the need to create one manually viaListConfigurationManagersRequest.builder()- Parameters:
listConfigurationManagersRequest- AConsumerthat will call methods onListConfigurationManagersRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The request is invalid. Verify the values provided for the request parameters are accurate.
- ConflictException Another request is being processed. Wait a few minutes and try again.
- InternalServerException An error occurred on the server side.
- AccessDeniedException The requester has insufficient permissions to perform the operation.
- ThrottlingException The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- 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.
- SsmQuickSetupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listConfigurations
default CompletableFuture<ListConfigurationsResponse> listConfigurations(ListConfigurationsRequest listConfigurationsRequest)
Returns configurations deployed by Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.
- Parameters:
listConfigurationsRequest-- Returns:
- A Java Future containing the result of the ListConfigurations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The request is invalid. Verify the values provided for the request parameters are accurate.
- InternalServerException An error occurred on the server side.
- AccessDeniedException The requester has insufficient permissions to perform the operation.
- ThrottlingException The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- ResourceNotFoundException The resource couldn't be found. Check the ID or name and try again.
- 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.
- SsmQuickSetupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listConfigurations
default CompletableFuture<ListConfigurationsResponse> listConfigurations(Consumer<ListConfigurationsRequest.Builder> listConfigurationsRequest)
Returns configurations deployed by Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.
This is a convenience which creates an instance of the
ListConfigurationsRequest.Builderavoiding the need to create one manually viaListConfigurationsRequest.builder()- Parameters:
listConfigurationsRequest- AConsumerthat will call methods onListConfigurationsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListConfigurations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The request is invalid. Verify the values provided for the request parameters are accurate.
- InternalServerException An error occurred on the server side.
- AccessDeniedException The requester has insufficient permissions to perform the operation.
- ThrottlingException The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- ResourceNotFoundException The resource couldn't be found. Check the ID or name and try again.
- 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.
- SsmQuickSetupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listConfigurationsPaginator
default ListConfigurationsPublisher listConfigurationsPaginator(ListConfigurationsRequest listConfigurationsRequest)
This is a variant of
listConfigurations(software.amazon.awssdk.services.ssmquicksetup.model.ListConfigurationsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.ssmquicksetup.paginators.ListConfigurationsPublisher publisher = client.listConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.ssmquicksetup.paginators.ListConfigurationsPublisher publisher = client.listConfigurationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmquicksetup.model.ListConfigurationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssmquicksetup.model.ListConfigurationsResponse response) { //... }; });Please notice that the configuration of MaxItems 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
listConfigurations(software.amazon.awssdk.services.ssmquicksetup.model.ListConfigurationsRequest)operation.- Parameters:
listConfigurationsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The request is invalid. Verify the values provided for the request parameters are accurate.
- InternalServerException An error occurred on the server side.
- AccessDeniedException The requester has insufficient permissions to perform the operation.
- ThrottlingException The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- ResourceNotFoundException The resource couldn't be found. Check the ID or name and try again.
- 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.
- SsmQuickSetupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listConfigurationsPaginator
default ListConfigurationsPublisher listConfigurationsPaginator(Consumer<ListConfigurationsRequest.Builder> listConfigurationsRequest)
This is a variant of
listConfigurations(software.amazon.awssdk.services.ssmquicksetup.model.ListConfigurationsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.ssmquicksetup.paginators.ListConfigurationsPublisher publisher = client.listConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.ssmquicksetup.paginators.ListConfigurationsPublisher publisher = client.listConfigurationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmquicksetup.model.ListConfigurationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssmquicksetup.model.ListConfigurationsResponse response) { //... }; });Please notice that the configuration of MaxItems 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
listConfigurations(software.amazon.awssdk.services.ssmquicksetup.model.ListConfigurationsRequest)operation.
This is a convenience which creates an instance of the
ListConfigurationsRequest.Builderavoiding the need to create one manually viaListConfigurationsRequest.builder()- Parameters:
listConfigurationsRequest- AConsumerthat will call methods onListConfigurationsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The request is invalid. Verify the values provided for the request parameters are accurate.
- InternalServerException An error occurred on the server side.
- AccessDeniedException The requester has insufficient permissions to perform the operation.
- ThrottlingException The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- ResourceNotFoundException The resource couldn't be found. Check the ID or name and try again.
- 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.
- SsmQuickSetupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listQuickSetupTypes
default CompletableFuture<ListQuickSetupTypesResponse> listQuickSetupTypes(ListQuickSetupTypesRequest listQuickSetupTypesRequest)
Returns the available Quick Setup types.
- Parameters:
listQuickSetupTypesRequest-- Returns:
- A Java Future containing the result of the ListQuickSetupTypes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConflictException Another request is being processed. Wait a few minutes and try again.
- InternalServerException An error occurred on the server side.
- AccessDeniedException The requester has insufficient permissions to perform the operation.
- ThrottlingException The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- 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.
- SsmQuickSetupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listQuickSetupTypes
default CompletableFuture<ListQuickSetupTypesResponse> listQuickSetupTypes(Consumer<ListQuickSetupTypesRequest.Builder> listQuickSetupTypesRequest)
Returns the available Quick Setup types.
This is a convenience which creates an instance of the
ListQuickSetupTypesRequest.Builderavoiding the need to create one manually viaListQuickSetupTypesRequest.builder()- Parameters:
listQuickSetupTypesRequest- AConsumerthat will call methods onListQuickSetupTypesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListQuickSetupTypes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConflictException Another request is being processed. Wait a few minutes and try again.
- InternalServerException An error occurred on the server side.
- AccessDeniedException The requester has insufficient permissions to perform the operation.
- ThrottlingException The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- 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.
- SsmQuickSetupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns tags assigned to the resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The request is invalid. Verify the values provided for the request parameters are accurate.
- ConflictException Another request is being processed. Wait a few minutes and try again.
- InternalServerException An error occurred on the server side.
- AccessDeniedException The requester has insufficient permissions to perform the operation.
- ThrottlingException The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- ResourceNotFoundException The resource couldn't be found. Check the ID or name and try again.
- 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.
- SsmQuickSetupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns tags assigned to the resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The request is invalid. Verify the values provided for the request parameters are accurate.
- ConflictException Another request is being processed. Wait a few minutes and try again.
- InternalServerException An error occurred on the server side.
- AccessDeniedException The requester has insufficient permissions to perform the operation.
- ThrottlingException The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- ResourceNotFoundException The resource couldn't be found. Check the ID or name and try again.
- 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.
- SsmQuickSetupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Assigns key-value pairs of metadata to Amazon Web Services resources.
- Parameters:
tagResourceRequest-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The request is invalid. Verify the values provided for the request parameters are accurate.
- ConflictException Another request is being processed. Wait a few minutes and try again.
- InternalServerException An error occurred on the server side.
- AccessDeniedException The requester has insufficient permissions to perform the operation.
- ThrottlingException The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- ResourceNotFoundException The resource couldn't be found. Check the ID or name and try again.
- 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.
- SsmQuickSetupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Assigns key-value pairs of metadata to Amazon Web Services resources.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The request is invalid. Verify the values provided for the request parameters are accurate.
- ConflictException Another request is being processed. Wait a few minutes and try again.
- InternalServerException An error occurred on the server side.
- AccessDeniedException The requester has insufficient permissions to perform the operation.
- ThrottlingException The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- ResourceNotFoundException The resource couldn't be found. Check the ID or name and try again.
- 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.
- SsmQuickSetupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from the specified resource.
- Parameters:
untagResourceRequest-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The request is invalid. Verify the values provided for the request parameters are accurate.
- ConflictException Another request is being processed. Wait a few minutes and try again.
- InternalServerException An error occurred on the server side.
- AccessDeniedException The requester has insufficient permissions to perform the operation.
- ThrottlingException The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- ResourceNotFoundException The resource couldn't be found. Check the ID or name and try again.
- 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.
- SsmQuickSetupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from the specified resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The request is invalid. Verify the values provided for the request parameters are accurate.
- ConflictException Another request is being processed. Wait a few minutes and try again.
- InternalServerException An error occurred on the server side.
- AccessDeniedException The requester has insufficient permissions to perform the operation.
- ThrottlingException The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- ResourceNotFoundException The resource couldn't be found. Check the ID or name and try again.
- 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.
- SsmQuickSetupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateConfigurationDefinition
default CompletableFuture<UpdateConfigurationDefinitionResponse> updateConfigurationDefinition(UpdateConfigurationDefinitionRequest updateConfigurationDefinitionRequest)
Updates a Quick Setup configuration definition.
- Parameters:
updateConfigurationDefinitionRequest-- Returns:
- A Java Future containing the result of the UpdateConfigurationDefinition operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The request is invalid. Verify the values provided for the request parameters are accurate.
- ConflictException Another request is being processed. Wait a few minutes and try again.
- InternalServerException An error occurred on the server side.
- AccessDeniedException The requester has insufficient permissions to perform the operation.
- ThrottlingException The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- ResourceNotFoundException The resource couldn't be found. Check the ID or name and try again.
- 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.
- SsmQuickSetupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateConfigurationDefinition
default CompletableFuture<UpdateConfigurationDefinitionResponse> updateConfigurationDefinition(Consumer<UpdateConfigurationDefinitionRequest.Builder> updateConfigurationDefinitionRequest)
Updates a Quick Setup configuration definition.
This is a convenience which creates an instance of the
UpdateConfigurationDefinitionRequest.Builderavoiding the need to create one manually viaUpdateConfigurationDefinitionRequest.builder()- Parameters:
updateConfigurationDefinitionRequest- AConsumerthat will call methods onUpdateConfigurationDefinitionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateConfigurationDefinition operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The request is invalid. Verify the values provided for the request parameters are accurate.
- ConflictException Another request is being processed. Wait a few minutes and try again.
- InternalServerException An error occurred on the server side.
- AccessDeniedException The requester has insufficient permissions to perform the operation.
- ThrottlingException The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- ResourceNotFoundException The resource couldn't be found. Check the ID or name and try again.
- 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.
- SsmQuickSetupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateConfigurationManager
default CompletableFuture<UpdateConfigurationManagerResponse> updateConfigurationManager(UpdateConfigurationManagerRequest updateConfigurationManagerRequest)
Updates a Quick Setup configuration manager.
- Parameters:
updateConfigurationManagerRequest-- Returns:
- A Java Future containing the result of the UpdateConfigurationManager operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The request is invalid. Verify the values provided for the request parameters are accurate.
- ConflictException Another request is being processed. Wait a few minutes and try again.
- InternalServerException An error occurred on the server side.
- AccessDeniedException The requester has insufficient permissions to perform the operation.
- ThrottlingException The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- ResourceNotFoundException The resource couldn't be found. Check the ID or name and try again.
- 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.
- SsmQuickSetupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateConfigurationManager
default CompletableFuture<UpdateConfigurationManagerResponse> updateConfigurationManager(Consumer<UpdateConfigurationManagerRequest.Builder> updateConfigurationManagerRequest)
Updates a Quick Setup configuration manager.
This is a convenience which creates an instance of the
UpdateConfigurationManagerRequest.Builderavoiding the need to create one manually viaUpdateConfigurationManagerRequest.builder()- Parameters:
updateConfigurationManagerRequest- AConsumerthat will call methods onUpdateConfigurationManagerRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateConfigurationManager operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The request is invalid. Verify the values provided for the request parameters are accurate.
- ConflictException Another request is being processed. Wait a few minutes and try again.
- InternalServerException An error occurred on the server side.
- AccessDeniedException The requester has insufficient permissions to perform the operation.
- ThrottlingException The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- ResourceNotFoundException The resource couldn't be found. Check the ID or name and try again.
- 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.
- SsmQuickSetupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateServiceSettings
default CompletableFuture<UpdateServiceSettingsResponse> updateServiceSettings(UpdateServiceSettingsRequest updateServiceSettingsRequest)
Updates settings configured for Quick Setup.
- Parameters:
updateServiceSettingsRequest-- Returns:
- A Java Future containing the result of the UpdateServiceSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The request is invalid. Verify the values provided for the request parameters are accurate.
- ConflictException Another request is being processed. Wait a few minutes and try again.
- InternalServerException An error occurred on the server side.
- AccessDeniedException The requester has insufficient permissions to perform the operation.
- ThrottlingException The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- 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.
- SsmQuickSetupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateServiceSettings
default CompletableFuture<UpdateServiceSettingsResponse> updateServiceSettings(Consumer<UpdateServiceSettingsRequest.Builder> updateServiceSettingsRequest)
Updates settings configured for Quick Setup.
This is a convenience which creates an instance of the
UpdateServiceSettingsRequest.Builderavoiding the need to create one manually viaUpdateServiceSettingsRequest.builder()- Parameters:
updateServiceSettingsRequest- AConsumerthat will call methods onUpdateServiceSettingsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateServiceSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The request is invalid. Verify the values provided for the request parameters are accurate.
- ConflictException Another request is being processed. Wait a few minutes and try again.
- InternalServerException An error occurred on the server side.
- AccessDeniedException The requester has insufficient permissions to perform the operation.
- ThrottlingException The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- 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.
- SsmQuickSetupException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
serviceClientConfiguration
default SsmQuickSetupServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
create
static SsmQuickSetupAsyncClient create()
Create aSsmQuickSetupAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static SsmQuickSetupAsyncClientBuilder builder()
Create a builder that can be used to configure and create aSsmQuickSetupAsyncClient.
-
-