com.amazonaws.services.marketplacedeployment

Interface AWSMarketplaceDeployment

All Known Subinterfaces:

AWSMarketplaceDeploymentAsync

All Known Implementing Classes:

AbstractAWSMarketplaceDeployment, AbstractAWSMarketplaceDeploymentAsync, AWSMarketplaceDeploymentAsyncClient, AWSMarketplaceDeploymentClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSMarketplaceDeployment

Interface for accessing AWS Marketplace Deployment Service.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSMarketplaceDeployment instead.

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
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
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 listTagsForResourceRequest) Lists all tags that have been added to a deployment parameter resource.
PutDeploymentParameterResult	putDeploymentParameter(PutDeploymentParameterRequest putDeploymentParameterRequest) 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 tagResourceRequest) Tags a resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes a tag or list of tags from a resource.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

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.

See Also:

AWS API Documentation

putDeploymentParameter

PutDeploymentParameterResult putDeploymentParameter(PutDeploymentParameterRequest putDeploymentParameterRequest)

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.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

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.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

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.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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