com.amazonaws.services.marketplacecatalog

Interface AWSMarketplaceCatalog

All Known Subinterfaces:

AWSMarketplaceCatalogAsync

All Known Implementing Classes:

AbstractAWSMarketplaceCatalog, AbstractAWSMarketplaceCatalogAsync, AWSMarketplaceCatalogAsyncClient, AWSMarketplaceCatalogClient

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

Interface for accessing AWS Marketplace Catalog.

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

Catalog API actions allow you to manage your entities through list, describe, and update capabilities. An entity can be a product or an offer on AWS Marketplace.

You can automate your entity update process by integrating the AWS Marketplace Catalog API with your AWS Marketplace product build or deployment pipelines. You can also create your own applications on top of the Catalog API to manage your products on AWS Marketplace.

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
BatchDescribeEntitiesResult	batchDescribeEntities(BatchDescribeEntitiesRequest batchDescribeEntitiesRequest) Returns metadata and content for multiple entities.
CancelChangeSetResult	cancelChangeSet(CancelChangeSetRequest cancelChangeSetRequest) Used to cancel an open change request.
DeleteResourcePolicyResult	deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest) Deletes a resource-based policy on an entity that is identified by its resource ARN.
DescribeChangeSetResult	describeChangeSet(DescribeChangeSetRequest describeChangeSetRequest) Provides information about a given change set.
DescribeEntityResult	describeEntity(DescribeEntityRequest describeEntityRequest) Returns the metadata and content of the entity.
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.
GetResourcePolicyResult	getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest) Gets a resource-based policy of an entity that is identified by its resource ARN.
ListChangeSetsResult	listChangeSets(ListChangeSetsRequest listChangeSetsRequest) Returns the list of change sets owned by the account being used to make the call.
ListEntitiesResult	listEntities(ListEntitiesRequest listEntitiesRequest) Provides the list of entities of a given type.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists all tags that have been added to a resource (either an entity or change set).
PutResourcePolicyResult	putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest) Attaches a resource-based policy to an entity.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartChangeSetResult	startChangeSet(StartChangeSetRequest startChangeSetRequest) Allows you to request changes for your entities.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Tags a resource (either an entity or change set).
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes a tag or list of tags from a resource (either an entity or change set).

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

batchDescribeEntities

BatchDescribeEntitiesResult batchDescribeEntities(BatchDescribeEntitiesRequest batchDescribeEntitiesRequest)

Returns metadata and content for multiple entities. This is the Batch version of the DescribeEntity API and uses the same IAM permission action as DescribeEntity API.

Parameters:

batchDescribeEntitiesRequest -

Returns:

Result of the BatchDescribeEntities operation returned by the service.

Throws:

AccessDeniedException - Access is denied.

HTTP status code: 403

InternalServiceException - There was an internal service exception.

HTTP status code: 500

ThrottlingException - Too many requests.

HTTP status code: 429

ValidationException - An error occurred during validation.

HTTP status code: 422

See Also:

AWS API Documentation

cancelChangeSet

CancelChangeSetResult cancelChangeSet(CancelChangeSetRequest cancelChangeSetRequest)

Used to cancel an open change request. Must be sent before the status of the request changes to APPLYING, the final stage of completing your change request. You can describe a change during the 60-day request history retention period for API calls.

Parameters:

cancelChangeSetRequest -

Returns:

Result of the CancelChangeSet operation returned by the service.

Throws:

InternalServiceException - There was an internal service exception.

HTTP status code: 500

AccessDeniedException - Access is denied.

HTTP status code: 403

ValidationException - An error occurred during validation.

HTTP status code: 422

ResourceNotFoundException - The specified resource wasn't found.

HTTP status code: 404

ResourceInUseException - The resource is currently in use.

ThrottlingException - Too many requests.

HTTP status code: 429

See Also:

AWS API Documentation

deleteResourcePolicy

DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)

Deletes a resource-based policy on an entity that is identified by its resource ARN.

Parameters:

deleteResourcePolicyRequest -

Returns:

Result of the DeleteResourcePolicy operation returned by the service.

Throws:

InternalServiceException - There was an internal service exception.

HTTP status code: 500

AccessDeniedException - Access is denied.

HTTP status code: 403

ValidationException - An error occurred during validation.

HTTP status code: 422

ResourceNotFoundException - The specified resource wasn't found.

HTTP status code: 404

ThrottlingException - Too many requests.

HTTP status code: 429

See Also:

AWS API Documentation

describeChangeSet

DescribeChangeSetResult describeChangeSet(DescribeChangeSetRequest describeChangeSetRequest)

Provides information about a given change set.

Parameters:

describeChangeSetRequest -

Returns:

Result of the DescribeChangeSet operation returned by the service.

Throws:

InternalServiceException - There was an internal service exception.

HTTP status code: 500

AccessDeniedException - Access is denied.

HTTP status code: 403

ValidationException - An error occurred during validation.

HTTP status code: 422

ResourceNotFoundException - The specified resource wasn't found.

HTTP status code: 404

ThrottlingException - Too many requests.

HTTP status code: 429

See Also:

AWS API Documentation

describeEntity

DescribeEntityResult describeEntity(DescribeEntityRequest describeEntityRequest)

Returns the metadata and content of the entity.

Parameters:

describeEntityRequest -

Returns:

Result of the DescribeEntity operation returned by the service.

Throws:

InternalServiceException - There was an internal service exception.

HTTP status code: 500

AccessDeniedException - Access is denied.

HTTP status code: 403

ValidationException - An error occurred during validation.

HTTP status code: 422

ResourceNotSupportedException - Currently, the specified resource is not supported.

ResourceNotFoundException - The specified resource wasn't found.

HTTP status code: 404

ThrottlingException - Too many requests.

HTTP status code: 429

See Also:

AWS API Documentation

getResourcePolicy

GetResourcePolicyResult getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)

Gets a resource-based policy of an entity that is identified by its resource ARN.

Parameters:

getResourcePolicyRequest -

Returns:

Result of the GetResourcePolicy operation returned by the service.

Throws:

InternalServiceException - There was an internal service exception.

HTTP status code: 500

AccessDeniedException - Access is denied.

HTTP status code: 403

ValidationException - An error occurred during validation.

HTTP status code: 422

ResourceNotFoundException - The specified resource wasn't found.

HTTP status code: 404

ThrottlingException - Too many requests.

HTTP status code: 429

See Also:

AWS API Documentation

listChangeSets

ListChangeSetsResult listChangeSets(ListChangeSetsRequest listChangeSetsRequest)

Returns the list of change sets owned by the account being used to make the call. You can filter this list by providing any combination of entityId, ChangeSetName, and status. If you provide more than one filter, the API operation applies a logical AND between the filters.

You can describe a change during the 60-day request history retention period for API calls.

Parameters:

listChangeSetsRequest -

Returns:

Result of the ListChangeSets operation returned by the service.

Throws:

InternalServiceException - There was an internal service exception.

HTTP status code: 500

AccessDeniedException - Access is denied.

HTTP status code: 403

ValidationException - An error occurred during validation.

HTTP status code: 422

ThrottlingException - Too many requests.

HTTP status code: 429

See Also:

AWS API Documentation

listEntities

ListEntitiesResult listEntities(ListEntitiesRequest listEntitiesRequest)

Provides the list of entities of a given type.

Parameters:

listEntitiesRequest -

Returns:

Result of the ListEntities operation returned by the service.

Throws:

InternalServiceException - There was an internal service exception.

HTTP status code: 500

AccessDeniedException - Access is denied.

HTTP status code: 403

ValidationException - An error occurred during validation.

HTTP status code: 422

ResourceNotFoundException - The specified resource wasn't found.

HTTP status code: 404

ThrottlingException - Too many requests.

HTTP status code: 429

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists all tags that have been added to a resource (either an entity or change set).

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource wasn't found.

HTTP status code: 404

InternalServiceException - There was an internal service exception.

HTTP status code: 500

AccessDeniedException - Access is denied.

HTTP status code: 403

ValidationException - An error occurred during validation.

HTTP status code: 422

ThrottlingException - Too many requests.

HTTP status code: 429

See Also:

AWS API Documentation

putResourcePolicy

PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)

Attaches a resource-based policy to an entity. Examples of an entity include: AmiProduct and ContainerProduct.

Parameters:

putResourcePolicyRequest -

Returns:

Result of the PutResourcePolicy operation returned by the service.

Throws:

InternalServiceException - There was an internal service exception.

HTTP status code: 500

AccessDeniedException - Access is denied.

HTTP status code: 403

ValidationException - An error occurred during validation.

HTTP status code: 422

ResourceNotFoundException - The specified resource wasn't found.

HTTP status code: 404

ThrottlingException - Too many requests.

HTTP status code: 429

See Also:

AWS API Documentation

startChangeSet

StartChangeSetResult startChangeSet(StartChangeSetRequest startChangeSetRequest)

Allows you to request changes for your entities. Within a single ChangeSet, you can't start the same change type against the same entity multiple times. Additionally, when a ChangeSet is running, all the entities targeted by the different changes are locked until the change set has completed (either succeeded, cancelled, or failed). If you try to start a change set containing a change against an entity that is already locked, you will receive a ResourceInUseException error.

For example, you can't start the ChangeSet described in the example later in this topic because it contains two changes to run the same change type ( AddRevisions) against the same entity (entity-id@1).

For more information about working with change sets, see Working with change sets. For information about change types for single-AMI products, see Working with single-AMI products. Also, for more information about change types available for container-based products, see Working with container products.

Parameters:

startChangeSetRequest -

Returns:

Result of the StartChangeSet operation returned by the service.

Throws:

InternalServiceException - There was an internal service exception.

HTTP status code: 500

AccessDeniedException - Access is denied.

HTTP status code: 403

ValidationException - An error occurred during validation.

HTTP status code: 422

ResourceNotFoundException - The specified resource wasn't found.

HTTP status code: 404

ResourceInUseException - The resource is currently in use.

ThrottlingException - Too many requests.

HTTP status code: 429

ServiceQuotaExceededException - The maximum number of open requests per account has been exceeded.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Tags a resource (either an entity or change set).

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource wasn't found.

HTTP status code: 404

InternalServiceException - There was an internal service exception.

HTTP status code: 500

AccessDeniedException - Access is denied.

HTTP status code: 403

ValidationException - An error occurred during validation.

HTTP status code: 422

ThrottlingException - Too many requests.

HTTP status code: 429

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes a tag or list of tags from a resource (either an entity or change set).

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource wasn't found.

HTTP status code: 404

InternalServiceException - There was an internal service exception.

HTTP status code: 500

AccessDeniedException - Access is denied.

HTTP status code: 403

ValidationException - An error occurred during validation.

HTTP status code: 422

ThrottlingException - Too many requests.

HTTP status code: 429

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.