Package software.amazon.awssdk.services.marketplacedeployment

Interface MarketplaceDeploymentAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface MarketplaceDeploymentAsyncClient extends AwsClient
Service client for accessing AWS Marketplace Deployment Service 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.

The AWS Marketplace Deployment Service supports the Quick Launch experience, which is a deployment option for software as a service (SaaS) products. Quick Launch simplifies and reduces the time, resources, and steps required to configure, deploy, and launch a products. The AWS Marketplace Deployment Service provides sellers with a secure method for passing deployment parameters (for example, API keys and external IDs) to buyers during the Quick Launch experience.

  • Field Details

  • Method Details

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Lists all tags that have been added to a deployment parameter 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.
      • ThrottlingException Too many requests.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource wasn't found.
      • ValidationException An error occurred during validation.
      • InternalServerException There was an internal service exception.
      • 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.
      • MarketplaceDeploymentException 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)

      Lists all tags that have been added to a deployment parameter 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.
      • ThrottlingException Too many requests.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource wasn't found.
      • ValidationException An error occurred during validation.
      • InternalServerException There was an internal service exception.
      • 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.
      • MarketplaceDeploymentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putDeploymentParameter

      default CompletableFuture<PutDeploymentParameterResponse> putDeploymentParameter(PutDeploymentParameterRequest putDeploymentParameterRequest)

      Creates or updates a deployment parameter and is targeted by catalog and agreementId.

      Parameters:
      putDeploymentParameterRequest -
      Returns:
      A Java Future containing the result of the PutDeploymentParameter 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.
      • ThrottlingException Too many requests.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource wasn't found.
      • ServiceQuotaExceededException The maximum number of requests per account has been exceeded.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • ValidationException An error occurred during validation.
      • InternalServerException There was an internal service exception.
      • 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.
      • MarketplaceDeploymentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putDeploymentParameter

      default CompletableFuture<PutDeploymentParameterResponse> putDeploymentParameter(Consumer<PutDeploymentParameterRequest.Builder> putDeploymentParameterRequest)

      Creates or updates a deployment parameter and is targeted by catalog and agreementId.


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

      Parameters:
      putDeploymentParameterRequest - A Consumer that will call methods on PutDeploymentParameterRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutDeploymentParameter 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.
      • ThrottlingException Too many requests.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource wasn't found.
      • ServiceQuotaExceededException The maximum number of requests per account has been exceeded.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • ValidationException An error occurred during validation.
      • InternalServerException There was an internal service exception.
      • 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.
      • MarketplaceDeploymentException 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)

      Tags a resource.

      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.
      • ThrottlingException Too many requests.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource wasn't found.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • ValidationException An error occurred during validation.
      • InternalServerException There was an internal service exception.
      • 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.
      • MarketplaceDeploymentException 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)

      Tags a resource.


      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.
      • ThrottlingException Too many requests.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource wasn't found.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • ValidationException An error occurred during validation.
      • InternalServerException There was an internal service exception.
      • 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.
      • MarketplaceDeploymentException 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 a tag or list of tags from a 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.
      • ThrottlingException Too many requests.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource wasn't found.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • ValidationException An error occurred during validation.
      • InternalServerException There was an internal service exception.
      • 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.
      • MarketplaceDeploymentException 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 a tag or list of tags from a 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.
      • ThrottlingException Too many requests.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource wasn't found.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • ValidationException An error occurred during validation.
      • InternalServerException There was an internal service exception.
      • 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.
      • MarketplaceDeploymentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default MarketplaceDeploymentServiceClientConfiguration 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 MarketplaceDeploymentAsyncClient create()
      Create a MarketplaceDeploymentAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static MarketplaceDeploymentAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a MarketplaceDeploymentAsyncClient.