software.amazon.awssdk.services.marketplacedeployment.MarketplaceDeploymentAsyncClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of marketplacedeployment Show documentation
The AWS Java SDK for Marketplace Deployment module holds the client classes that are used for communicating with Marketplace Deployment.
The newest version!
/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
 * the License. A copy of the License is located at
 * 
 * http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
 * and limitations under the License.
 */

package software.amazon.awssdk.services.marketplacedeployment;

import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.awscore.AwsClient;
import software.amazon.awssdk.services.marketplacedeployment.model.ListTagsForResourceRequest;
import software.amazon.awssdk.services.marketplacedeployment.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.marketplacedeployment.model.PutDeploymentParameterRequest;
import software.amazon.awssdk.services.marketplacedeployment.model.PutDeploymentParameterResponse;
import software.amazon.awssdk.services.marketplacedeployment.model.TagResourceRequest;
import software.amazon.awssdk.services.marketplacedeployment.model.TagResourceResponse;
import software.amazon.awssdk.services.marketplacedeployment.model.UntagResourceRequest;
import software.amazon.awssdk.services.marketplacedeployment.model.UntagResourceResponse;

/**
 * Service client for accessing AWS Marketplace Deployment Service asynchronously. This can be created using the static
 * {@link #builder()} method.The asynchronous client performs non-blocking I/O when configured with any
 * {@code 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.
 * 
 */
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface MarketplaceDeploymentAsyncClient extends AwsClient {
    String SERVICE_NAME = "aws-marketplace";

    /**
     * Value for looking up the service's metadata from the
     * {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
     */
    String SERVICE_METADATA_ID = "deployment-marketplace";

    /**
     * 
     * Lists all tags that have been added to a deployment parameter resource.
     * 
     *
     * @param listTagsForResourceRequest
     * @return 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
     *         {@link 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.
     *         
     * @sample MarketplaceDeploymentAsyncClient.ListTagsForResource
     * @see AWS API Documentation
     */
    default CompletableFuture listTagsForResource(
            ListTagsForResourceRequest listTagsForResourceRequest) {
        throw new UnsupportedOperationException();
    }

    /**
     * 
     * Lists all tags that have been added to a deployment parameter resource.
     * 
     * 

     * 
     * This is a convenience which creates an instance of the {@link ListTagsForResourceRequest.Builder} avoiding the
     * need to create one manually via {@link ListTagsForResourceRequest#builder()}
     * 
     *
     * @param listTagsForResourceRequest
     *        A {@link Consumer} that will call methods on
     *        {@link software.amazon.awssdk.services.marketplacedeployment.model.ListTagsForResourceRequest.Builder} to
     *        create a request.
     * @return 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
     *         {@link 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.
     *         
     * @sample MarketplaceDeploymentAsyncClient.ListTagsForResource
     * @see AWS API Documentation
     */
    default CompletableFuture listTagsForResource(
            Consumer listTagsForResourceRequest) {
        return listTagsForResource(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest).build());
    }

    /**
     * 
     * Creates or updates a deployment parameter and is targeted by catalog and agreementId.
     * 
     *
     * @param putDeploymentParameterRequest
     * @return 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
     *         {@link 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.
     *         
     * @sample MarketplaceDeploymentAsyncClient.PutDeploymentParameter
     * @see AWS API Documentation
     */
    default CompletableFuture putDeploymentParameter(
            PutDeploymentParameterRequest putDeploymentParameterRequest) {
        throw new UnsupportedOperationException();
    }

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

     * 
     * This is a convenience which creates an instance of the {@link PutDeploymentParameterRequest.Builder} avoiding the
     * need to create one manually via {@link PutDeploymentParameterRequest#builder()}
     * 
     *
     * @param putDeploymentParameterRequest
     *        A {@link Consumer} that will call methods on
     *        {@link software.amazon.awssdk.services.marketplacedeployment.model.PutDeploymentParameterRequest.Builder}
     *        to create a request.
     * @return 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
     *         {@link 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.
     *         
     * @sample MarketplaceDeploymentAsyncClient.PutDeploymentParameter
     * @see AWS API Documentation
     */
    default CompletableFuture putDeploymentParameter(
            Consumer putDeploymentParameterRequest) {
        return putDeploymentParameter(PutDeploymentParameterRequest.builder().applyMutation(putDeploymentParameterRequest)
                .build());
    }

    /**
     * 
     * Tags a resource.
     * 
     *
     * @param tagResourceRequest
     * @return 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
     *         {@link 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.
     *         
     * @sample MarketplaceDeploymentAsyncClient.TagResource
     * @see AWS API Documentation
     */
    default CompletableFuture tagResource(TagResourceRequest tagResourceRequest) {
        throw new UnsupportedOperationException();
    }

    /**
     * 
     * Tags a resource.
     * 
     * 

     * 
     * This is a convenience which creates an instance of the {@link TagResourceRequest.Builder} avoiding the need to
     * create one manually via {@link TagResourceRequest#builder()}
     * 
     *
     * @param tagResourceRequest
     *        A {@link Consumer} that will call methods on
     *        {@link software.amazon.awssdk.services.marketplacedeployment.model.TagResourceRequest.Builder} to create a
     *        request.
     * @return 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
     *         {@link 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.
     *         
     * @sample MarketplaceDeploymentAsyncClient.TagResource
     * @see AWS API Documentation
     */
    default CompletableFuture tagResource(Consumer tagResourceRequest) {
        return tagResource(TagResourceRequest.builder().applyMutation(tagResourceRequest).build());
    }

    /**
     * 
     * Removes a tag or list of tags from a resource.
     * 
     *
     * @param untagResourceRequest
     * @return 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
     *         {@link 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.
     *         
     * @sample MarketplaceDeploymentAsyncClient.UntagResource
     * @see AWS API Documentation
     */
    default CompletableFuture untagResource(UntagResourceRequest untagResourceRequest) {
        throw new UnsupportedOperationException();
    }

    /**
     * 
     * Removes a tag or list of tags from a resource.
     * 
     * 

     * 
     * This is a convenience which creates an instance of the {@link UntagResourceRequest.Builder} avoiding the need to
     * create one manually via {@link UntagResourceRequest#builder()}
     * 
     *
     * @param untagResourceRequest
     *        A {@link Consumer} that will call methods on
     *        {@link software.amazon.awssdk.services.marketplacedeployment.model.UntagResourceRequest.Builder} to create
     *        a request.
     * @return 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
     *         {@link 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.
     *         
     * @sample MarketplaceDeploymentAsyncClient.UntagResource
     * @see AWS API Documentation
     */
    default CompletableFuture untagResource(Consumer untagResourceRequest) {
        return untagResource(UntagResourceRequest.builder().applyMutation(untagResourceRequest).build());
    }

    @Override
    default MarketplaceDeploymentServiceClientConfiguration serviceClientConfiguration() {
        throw new UnsupportedOperationException();
    }

    /**
     * Create a {@link MarketplaceDeploymentAsyncClient} with the region loaded from the
     * {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
     * {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
     */
    static MarketplaceDeploymentAsyncClient create() {
        return builder().build();
    }

    /**
     * Create a builder that can be used to configure and create a {@link MarketplaceDeploymentAsyncClient}.
     */
    static MarketplaceDeploymentAsyncClientBuilder builder() {
        return new DefaultMarketplaceDeploymentAsyncClientBuilder();
    }
}