com.amazonaws.services.marketplacecatalog

Class AWSMarketplaceCatalogClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.marketplacecatalog.AWSMarketplaceCatalogClient

All Implemented Interfaces:

AWSMarketplaceCatalog

Direct Known Subclasses:

AWSMarketplaceCatalogAsyncClient

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

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

Catalog API actions allow you to create, describe, list, and delete changes to your published entities. An entity is 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
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.marketplacecatalog.AWSMarketplaceCatalog

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSMarketplaceCatalogClientBuilder	builder()
CancelChangeSetResult	cancelChangeSet(CancelChangeSetRequest request) Used to cancel an open change request.
DescribeChangeSetResult	describeChangeSet(DescribeChangeSetRequest request) Provides information about a given change set.
DescribeEntityResult	describeEntity(DescribeEntityRequest request) 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.
ListChangeSetsResult	listChangeSets(ListChangeSetsRequest request) Returns the list of change sets owned by the account being used to make the call.
ListEntitiesResult	listEntities(ListEntitiesRequest request) Provides the list of entities of a given type.
StartChangeSetResult	startChangeSet(StartChangeSetRequest request) This operation allows you to request changes in your entities.

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, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amazonaws.services.marketplacecatalog.AWSMarketplaceCatalog

shutdown

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AWSMarketplaceCatalogClientBuilder builder()

cancelChangeSet

public CancelChangeSetResult cancelChangeSet(CancelChangeSetRequest request)

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.

Specified by:

cancelChangeSet in interface AWSMarketplaceCatalog

Parameters:

cancelChangeSetRequest -

Returns:

Result of the CancelChangeSet operation returned by the service.

Throws:

InternalServiceException - There was an internal service exception.

AccessDeniedException - Access is denied.

ValidationException - An error occurred during validation.

ResourceNotFoundException - The specified resource wasn't found.

ResourceInUseException - The resource is currently in use.

ThrottlingException - Too many requests.

See Also:

AWS API Documentation

describeChangeSet

public DescribeChangeSetResult describeChangeSet(DescribeChangeSetRequest request)

Provides information about a given change set.

Specified by:

describeChangeSet in interface AWSMarketplaceCatalog

Parameters:

describeChangeSetRequest -

Returns:

Result of the DescribeChangeSet operation returned by the service.

Throws:

InternalServiceException - There was an internal service exception.

AccessDeniedException - Access is denied.

ValidationException - An error occurred during validation.

ResourceNotFoundException - The specified resource wasn't found.

ThrottlingException - Too many requests.

See Also:

AWS API Documentation

describeEntity

public DescribeEntityResult describeEntity(DescribeEntityRequest request)

Returns the metadata and content of the entity.

Specified by:

describeEntity in interface AWSMarketplaceCatalog

Parameters:

describeEntityRequest -

Returns:

Result of the DescribeEntity operation returned by the service.

Throws:

InternalServiceException - There was an internal service exception.

AccessDeniedException - Access is denied.

ValidationException - An error occurred during validation.

ResourceNotSupportedException - Currently, the specified resource is not supported.

ResourceNotFoundException - The specified resource wasn't found.

ThrottlingException - Too many requests.

See Also:

AWS API Documentation

listChangeSets

public ListChangeSetsResult listChangeSets(ListChangeSetsRequest request)

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.

Specified by:

listChangeSets in interface AWSMarketplaceCatalog

Parameters:

listChangeSetsRequest -

Returns:

Result of the ListChangeSets operation returned by the service.

Throws:

InternalServiceException - There was an internal service exception.

AccessDeniedException - Access is denied.

ValidationException - An error occurred during validation.

ThrottlingException - Too many requests.

See Also:

AWS API Documentation

listEntities

public ListEntitiesResult listEntities(ListEntitiesRequest request)

Provides the list of entities of a given type.

Specified by:

listEntities in interface AWSMarketplaceCatalog

Parameters:

listEntitiesRequest -

Returns:

Result of the ListEntities operation returned by the service.

Throws:

InternalServiceException - There was an internal service exception.

AccessDeniedException - Access is denied.

ValidationException - An error occurred during validation.

ResourceNotFoundException - The specified resource wasn't found.

ThrottlingException - Too many requests.

See Also:

AWS API Documentation

startChangeSet

public StartChangeSetResult startChangeSet(StartChangeSetRequest request)

This operation allows you to request changes in your entities.

Specified by:

startChangeSet in interface AWSMarketplaceCatalog

Parameters:

startChangeSetRequest -

Returns:

Result of the StartChangeSet operation returned by the service.

Throws:

InternalServiceException - There was an internal service exception.

AccessDeniedException - Access is denied.

ValidationException - An error occurred during validation.

ResourceNotFoundException - The specified resource wasn't found.

ResourceInUseException - The resource is currently in use.

ThrottlingException - Too many requests.

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

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 AWSMarketplaceCatalog

Parameters:

request - The originally executed request

Returns:

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