com.amazonaws.services.marketplacedeployment

Class AWSMarketplaceDeploymentClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.marketplacedeployment.AWSMarketplaceDeploymentClient

All Implemented Interfaces:

AWSMarketplaceDeployment

Direct Known Subclasses:

AWSMarketplaceDeploymentAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSMarketplaceDeploymentClient
extends AmazonWebServiceClient
implements AWSMarketplaceDeployment

Client for accessing AWS Marketplace Deployment Service. All service calls made using this client are blocking, and will not return until the service call completes.

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 and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.marketplacedeployment.AWSMarketplaceDeployment

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSMarketplaceDeploymentClientBuilder	builder()
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists all tags that have been added to a deployment parameter resource.
PutDeploymentParameterResult	putDeploymentParameter(PutDeploymentParameterRequest request) Creates or updates a deployment parameter and is targeted by catalog and agreementId.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) Tags a resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes a tag or list of tags from a resource.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AWSMarketplaceDeploymentClientBuilder builder()

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

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

Specified by:

listTagsForResource in interface AWSMarketplaceDeployment

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.

See Also:

AWS API Documentation

putDeploymentParameter

public PutDeploymentParameterResult putDeploymentParameter(PutDeploymentParameterRequest request)

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

Specified by:

putDeploymentParameter in interface AWSMarketplaceDeployment

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.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Tags a resource.

Specified by:

tagResource in interface AWSMarketplaceDeployment

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.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes a tag or list of tags from a resource.

Specified by:

untagResource in interface AWSMarketplaceDeployment

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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AWSMarketplaceDeployment

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from interface: AWSMarketplaceDeployment

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSMarketplaceDeployment

Overrides:

shutdown in class AmazonWebServiceClient