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 staticbuilder()method.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 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
-
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.- 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:
- AWS API Documentation
-
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.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.- 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:
- AWS API Documentation
-
putDeploymentParameter
default CompletableFuture<PutDeploymentParameterResponse> putDeploymentParameter(PutDeploymentParameterRequest putDeploymentParameterRequest)
Creates or updates a deployment parameter and is targeted by
catalogandagreementId.- 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.- 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:
- AWS API Documentation
-
putDeploymentParameter
default CompletableFuture<PutDeploymentParameterResponse> putDeploymentParameter(Consumer<PutDeploymentParameterRequest.Builder> putDeploymentParameterRequest)
Creates or updates a deployment parameter and is targeted by
catalogandagreementId.
This is a convenience which creates an instance of the
PutDeploymentParameterRequest.Builderavoiding the need to create one manually viaPutDeploymentParameterRequest.builder()- Parameters:
putDeploymentParameterRequest- AConsumerthat will call methods onPutDeploymentParameterRequest.Builderto 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.- 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:
- AWS API Documentation
-
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.- 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:
- AWS API Documentation
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Tags a resource.
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.- 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:
- AWS API Documentation
-
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.- 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:
- AWS API Documentation
-
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.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.- 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:
- AWS API Documentation
-
serviceClientConfiguration
default MarketplaceDeploymentServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
create
static MarketplaceDeploymentAsyncClient create()
Create aMarketplaceDeploymentAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static MarketplaceDeploymentAsyncClientBuilder builder()
Create a builder that can be used to configure and create aMarketplaceDeploymentAsyncClient.
-
-