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 static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported 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 Details

  • Method Details

    • 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 invoke Throwable.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:

    • 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.Builder avoiding the need to create one manually via CreateConfigurationManagerRequest.builder()

      Parameters:
      createConfigurationManagerRequest - A Consumer that will call methods on CreateConfigurationManagerRequest.Builder to 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 invoke Throwable.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:

    • 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 invoke Throwable.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:

    • deleteConfigurationManager

      default CompletableFuture<DeleteConfigurationManagerResponse> deleteConfigurationManager(Consumer<DeleteConfigurationManagerRequest.Builder> deleteConfigurationManagerRequest)

      Deletes a configuration manager.


      This is a convenience which creates an instance of the DeleteConfigurationManagerRequest.Builder avoiding the need to create one manually via DeleteConfigurationManagerRequest.builder()

      Parameters:
      deleteConfigurationManagerRequest - A Consumer that will call methods on DeleteConfigurationManagerRequest.Builder to 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 invoke Throwable.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:

    • 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 invoke Throwable.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:

    • getConfigurationManager

      default CompletableFuture<GetConfigurationManagerResponse> getConfigurationManager(Consumer<GetConfigurationManagerRequest.Builder> getConfigurationManagerRequest)

      Returns a configuration manager.


      This is a convenience which creates an instance of the GetConfigurationManagerRequest.Builder avoiding the need to create one manually via GetConfigurationManagerRequest.builder()

      Parameters:
      getConfigurationManagerRequest - A Consumer that will call methods on GetConfigurationManagerRequest.Builder to 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 invoke Throwable.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:

    • 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 invoke Throwable.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:

    • 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.Builder avoiding the need to create one manually via GetServiceSettingsRequest.builder()

      Parameters:
      getServiceSettingsRequest - A Consumer that will call methods on GetServiceSettingsRequest.Builder to 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 invoke Throwable.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:

    • 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 invoke Throwable.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:

    • 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.Builder avoiding the need to create one manually via ListConfigurationManagersRequest.builder()

      Parameters:
      listConfigurationManagersRequest - A Consumer that will call methods on ListConfigurationManagersRequest.Builder to 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 invoke Throwable.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:

    • 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 new Subscription i.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 
       
 software.amazon.awssdk.services.ssmquicksetup.paginators.ListConfigurationManagersPublisher publisher = client.listConfigurationManagersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 invoke Throwable.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:

    • 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 new Subscription i.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 
       
 software.amazon.awssdk.services.ssmquicksetup.paginators.ListConfigurationManagersPublisher publisher = client.listConfigurationManagersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.Builder avoiding the need to create one manually via ListConfigurationManagersRequest.builder()

      Parameters:
      listConfigurationManagersRequest - A Consumer that will call methods on ListConfigurationManagersRequest.Builder to 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 invoke Throwable.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:

    • 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 invoke Throwable.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:

    • 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.Builder avoiding the need to create one manually via ListQuickSetupTypesRequest.builder()

      Parameters:
      listQuickSetupTypesRequest - A Consumer that will call methods on ListQuickSetupTypesRequest.Builder to 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 invoke Throwable.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:

    • 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 invoke Throwable.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:

    • 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.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to 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 invoke Throwable.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:

    • 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 invoke Throwable.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:

    • 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.Builder avoiding the need to create one manually via TagResourceRequest.builder()

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to 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 invoke Throwable.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:

    • 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 invoke Throwable.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:

    • 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.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to 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 invoke Throwable.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:

    • 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 invoke Throwable.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:

    • 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.Builder avoiding the need to create one manually via UpdateConfigurationDefinitionRequest.builder()

      Parameters:
      updateConfigurationDefinitionRequest - A Consumer that will call methods on UpdateConfigurationDefinitionRequest.Builder to 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 invoke Throwable.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:

    • 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 invoke Throwable.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:

    • 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.Builder avoiding the need to create one manually via UpdateConfigurationManagerRequest.builder()

      Parameters:
      updateConfigurationManagerRequest - A Consumer that will call methods on UpdateConfigurationManagerRequest.Builder to 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 invoke Throwable.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:

    • 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 invoke Throwable.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:

    • 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.Builder avoiding the need to create one manually via UpdateServiceSettingsRequest.builder()

      Parameters:
      updateServiceSettingsRequest - A Consumer that will call methods on UpdateServiceSettingsRequest.Builder to 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 invoke Throwable.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:

    • serviceClientConfiguration

      default SsmQuickSetupServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static SsmQuickSetupAsyncClient create()
      Create a SsmQuickSetupAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static SsmQuickSetupAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a SsmQuickSetupAsyncClient.