Package software.amazon.awssdk.services.marketplacedeployment

Interface MarketplaceDeploymentClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface MarketplaceDeploymentClient
extends AwsClient

Service client for accessing AWS Marketplace Deployment Service. This can be created using the static builder() 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 String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static MarketplaceDeploymentClientBuilder	builder()	Create a builder that can be used to configure and create a MarketplaceDeploymentClient.
static MarketplaceDeploymentClient	create()	Create a MarketplaceDeploymentClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Lists all tags that have been added to a deployment parameter resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists all tags that have been added to a deployment parameter resource.
default PutDeploymentParameterResponse	putDeploymentParameter(Consumer<PutDeploymentParameterRequest.Builder> putDeploymentParameterRequest)	Creates or updates a deployment parameter and is targeted by catalog and agreementId.
default PutDeploymentParameterResponse	putDeploymentParameter(PutDeploymentParameterRequest putDeploymentParameterRequest)	Creates or updates a deployment parameter and is targeted by catalog and agreementId.
default MarketplaceDeploymentServiceClientConfiguration	serviceClientConfiguration()
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Tags a resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Tags a resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes a tag or list of tags from a resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes a tag or list of tags from a resource.

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 the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ThrottlingException,
                                                        AccessDeniedException,
                                                        ResourceNotFoundException,
                                                        ValidationException,
                                                        InternalServerException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        MarketplaceDeploymentException

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

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ThrottlingException,
                                                        AccessDeniedException,
                                                        ResourceNotFoundException,
                                                        ValidationException,
                                                        InternalServerException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        MarketplaceDeploymentException

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:

Result of the ListTagsForResource operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

putDeploymentParameter

default PutDeploymentParameterResponse putDeploymentParameter(PutDeploymentParameterRequest putDeploymentParameterRequest)
                                                       throws ThrottlingException,
                                                              AccessDeniedException,
                                                              ResourceNotFoundException,
                                                              ServiceQuotaExceededException,
                                                              ConflictException,
                                                              ValidationException,
                                                              InternalServerException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              MarketplaceDeploymentException

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

Parameters:

putDeploymentParameterRequest -

Returns:

Result of the PutDeploymentParameter operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

putDeploymentParameter

default PutDeploymentParameterResponse putDeploymentParameter(Consumer<PutDeploymentParameterRequest.Builder> putDeploymentParameterRequest)
                                                       throws ThrottlingException,
                                                              AccessDeniedException,
                                                              ResourceNotFoundException,
                                                              ServiceQuotaExceededException,
                                                              ConflictException,
                                                              ValidationException,
                                                              InternalServerException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              MarketplaceDeploymentException

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:

Result of the PutDeploymentParameter operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ThrottlingException,
                                        AccessDeniedException,
                                        ResourceNotFoundException,
                                        ConflictException,
                                        ValidationException,
                                        InternalServerException,
                                        AwsServiceException,
                                        SdkClientException,
                                        MarketplaceDeploymentException

Tags a resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ThrottlingException,
                                        AccessDeniedException,
                                        ResourceNotFoundException,
                                        ConflictException,
                                        ValidationException,
                                        InternalServerException,
                                        AwsServiceException,
                                        SdkClientException,
                                        MarketplaceDeploymentException

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:

Result of the TagResource operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ThrottlingException,
                                            AccessDeniedException,
                                            ResourceNotFoundException,
                                            ConflictException,
                                            ValidationException,
                                            InternalServerException,
                                            AwsServiceException,
                                            SdkClientException,
                                            MarketplaceDeploymentException

Removes a tag or list of tags from a resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ThrottlingException,
                                            AccessDeniedException,
                                            ResourceNotFoundException,
                                            ConflictException,
                                            ValidationException,
                                            InternalServerException,
                                            AwsServiceException,
                                            SdkClientException,
                                            MarketplaceDeploymentException

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:

Result of the UntagResource operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

create

static MarketplaceDeploymentClient create()

Create a MarketplaceDeploymentClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static MarketplaceDeploymentClientBuilder builder()

Create a builder that can be used to configure and create a MarketplaceDeploymentClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default MarketplaceDeploymentServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient