Package software.amazon.awssdk.services.marketplacecatalog

Interface MarketplaceCatalogClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

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

Service client for accessing AWS Marketplace Catalog. This can be created using the static builder() method.

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	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default BatchDescribeEntitiesResponse	batchDescribeEntities(Consumer<BatchDescribeEntitiesRequest.Builder> batchDescribeEntitiesRequest)	Returns metadata and content for multiple entities.
default BatchDescribeEntitiesResponse	batchDescribeEntities(BatchDescribeEntitiesRequest batchDescribeEntitiesRequest)	Returns metadata and content for multiple entities.
static MarketplaceCatalogClientBuilder	builder()	Create a builder that can be used to configure and create a MarketplaceCatalogClient.
default CancelChangeSetResponse	cancelChangeSet(Consumer<CancelChangeSetRequest.Builder> cancelChangeSetRequest)	Used to cancel an open change request.
default CancelChangeSetResponse	cancelChangeSet(CancelChangeSetRequest cancelChangeSetRequest)	Used to cancel an open change request.
static MarketplaceCatalogClient	create()	Create a MarketplaceCatalogClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default DeleteResourcePolicyResponse	deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest)	Deletes a resource-based policy on an entity that is identified by its resource ARN.
default DeleteResourcePolicyResponse	deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)	Deletes a resource-based policy on an entity that is identified by its resource ARN.
default DescribeChangeSetResponse	describeChangeSet(Consumer<DescribeChangeSetRequest.Builder> describeChangeSetRequest)	Provides information about a given change set.
default DescribeChangeSetResponse	describeChangeSet(DescribeChangeSetRequest describeChangeSetRequest)	Provides information about a given change set.
default DescribeEntityResponse	describeEntity(Consumer<DescribeEntityRequest.Builder> describeEntityRequest)	Returns the metadata and content of the entity.
default DescribeEntityResponse	describeEntity(DescribeEntityRequest describeEntityRequest)	Returns the metadata and content of the entity.
default GetResourcePolicyResponse	getResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest)	Gets a resource-based policy of an entity that is identified by its resource ARN.
default GetResourcePolicyResponse	getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)	Gets a resource-based policy of an entity that is identified by its resource ARN.
default ListChangeSetsResponse	listChangeSets(Consumer<ListChangeSetsRequest.Builder> listChangeSetsRequest)	Returns the list of change sets owned by the account being used to make the call.
default ListChangeSetsResponse	listChangeSets(ListChangeSetsRequest listChangeSetsRequest)	Returns the list of change sets owned by the account being used to make the call.
default ListChangeSetsIterable	listChangeSetsPaginator(Consumer<ListChangeSetsRequest.Builder> listChangeSetsRequest)	This is a variant of listChangeSets(software.amazon.awssdk.services.marketplacecatalog.model.ListChangeSetsRequest) operation.
default ListChangeSetsIterable	listChangeSetsPaginator(ListChangeSetsRequest listChangeSetsRequest)	This is a variant of listChangeSets(software.amazon.awssdk.services.marketplacecatalog.model.ListChangeSetsRequest) operation.
default ListEntitiesResponse	listEntities(Consumer<ListEntitiesRequest.Builder> listEntitiesRequest)	Provides the list of entities of a given type.
default ListEntitiesResponse	listEntities(ListEntitiesRequest listEntitiesRequest)	Provides the list of entities of a given type.
default ListEntitiesIterable	listEntitiesPaginator(Consumer<ListEntitiesRequest.Builder> listEntitiesRequest)	This is a variant of listEntities(software.amazon.awssdk.services.marketplacecatalog.model.ListEntitiesRequest) operation.
default ListEntitiesIterable	listEntitiesPaginator(ListEntitiesRequest listEntitiesRequest)	This is a variant of listEntities(software.amazon.awssdk.services.marketplacecatalog.model.ListEntitiesRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Lists all tags that have been added to a resource (either an entity or change set).
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists all tags that have been added to a resource (either an entity or change set).
default PutResourcePolicyResponse	putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest)	Attaches a resource-based policy to an entity.
default PutResourcePolicyResponse	putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)	Attaches a resource-based policy to an entity.
default MarketplaceCatalogServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default StartChangeSetResponse	startChangeSet(Consumer<StartChangeSetRequest.Builder> startChangeSetRequest)	Allows you to request changes for your entities.
default StartChangeSetResponse	startChangeSet(StartChangeSetRequest startChangeSetRequest)	Allows you to request changes for your entities.
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Tags a resource (either an entity or change set).
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Tags a resource (either an entity or change set).
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes a tag or list of tags from a resource (either an entity or change set).
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes a tag or list of tags from a resource (either an entity or change set).

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

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 Details

batchDescribeEntities

default BatchDescribeEntitiesResponse batchDescribeEntities(BatchDescribeEntitiesRequest batchDescribeEntitiesRequest)
                                                     throws AccessDeniedException,
InternalServiceException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
MarketplaceCatalogException

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.

See Also:

• AWS API Documentation

batchDescribeEntities

default BatchDescribeEntitiesResponse batchDescribeEntities(Consumer<BatchDescribeEntitiesRequest.Builder> batchDescribeEntitiesRequest)
                                                     throws AccessDeniedException,
InternalServiceException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
MarketplaceCatalogException

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.

This is a convenience which creates an instance of the BatchDescribeEntitiesRequest.Builder avoiding the need to create one manually via BatchDescribeEntitiesRequest.builder()

Parameters:

batchDescribeEntitiesRequest - A Consumer that will call methods on BatchDescribeEntitiesRequest.Builder to create a request.

Returns:

Result of the BatchDescribeEntities operation returned by the service.

See Also:

• AWS API Documentation

cancelChangeSet

default CancelChangeSetResponse cancelChangeSet(CancelChangeSetRequest cancelChangeSetRequest)
                                         throws InternalServiceException,
AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ResourceInUseException,
ThrottlingException,
AwsServiceException,
SdkClientException,
MarketplaceCatalogException

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.

See Also:

• AWS API Documentation

cancelChangeSet

default CancelChangeSetResponse cancelChangeSet(Consumer<CancelChangeSetRequest.Builder> cancelChangeSetRequest)
                                         throws InternalServiceException,
AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ResourceInUseException,
ThrottlingException,
AwsServiceException,
SdkClientException,
MarketplaceCatalogException

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.

This is a convenience which creates an instance of the CancelChangeSetRequest.Builder avoiding the need to create one manually via CancelChangeSetRequest.builder()

Parameters:

cancelChangeSetRequest - A Consumer that will call methods on CancelChangeSetRequest.Builder to create a request.

Returns:

Result of the CancelChangeSet operation returned by the service.

See Also:

• AWS API Documentation

deleteResourcePolicy

default DeleteResourcePolicyResponse deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)
                                                   throws InternalServiceException,
AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
MarketplaceCatalogException

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.

See Also:

• AWS API Documentation

deleteResourcePolicy

default DeleteResourcePolicyResponse deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest)
                                                   throws InternalServiceException,
AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
MarketplaceCatalogException

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

This is a convenience which creates an instance of the DeleteResourcePolicyRequest.Builder avoiding the need to create one manually via DeleteResourcePolicyRequest.builder()

Parameters:

deleteResourcePolicyRequest - A Consumer that will call methods on DeleteResourcePolicyRequest.Builder to create a request.

Returns:

Result of the DeleteResourcePolicy operation returned by the service.

See Also:

• AWS API Documentation

describeChangeSet

default DescribeChangeSetResponse describeChangeSet(DescribeChangeSetRequest describeChangeSetRequest)
                                             throws InternalServiceException,
AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
MarketplaceCatalogException

Provides information about a given change set.

Parameters:

describeChangeSetRequest -

Returns:

Result of the DescribeChangeSet operation returned by the service.

See Also:

• AWS API Documentation

describeChangeSet

default DescribeChangeSetResponse describeChangeSet(Consumer<DescribeChangeSetRequest.Builder> describeChangeSetRequest)
                                             throws InternalServiceException,
AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
MarketplaceCatalogException

Provides information about a given change set.

This is a convenience which creates an instance of the DescribeChangeSetRequest.Builder avoiding the need to create one manually via DescribeChangeSetRequest.builder()

Parameters:

describeChangeSetRequest - A Consumer that will call methods on DescribeChangeSetRequest.Builder to create a request.

Returns:

Result of the DescribeChangeSet operation returned by the service.

See Also:

• AWS API Documentation

describeEntity

default DescribeEntityResponse describeEntity(DescribeEntityRequest describeEntityRequest)
                                       throws InternalServiceException,
AccessDeniedException,
ValidationException,
ResourceNotSupportedException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
MarketplaceCatalogException

Returns the metadata and content of the entity.

Parameters:

describeEntityRequest -

Returns:

Result of the DescribeEntity operation returned by the service.

See Also:

• AWS API Documentation

describeEntity

default DescribeEntityResponse describeEntity(Consumer<DescribeEntityRequest.Builder> describeEntityRequest)
                                       throws InternalServiceException,
AccessDeniedException,
ValidationException,
ResourceNotSupportedException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
MarketplaceCatalogException

Returns the metadata and content of the entity.

This is a convenience which creates an instance of the DescribeEntityRequest.Builder avoiding the need to create one manually via DescribeEntityRequest.builder()

Parameters:

describeEntityRequest - A Consumer that will call methods on DescribeEntityRequest.Builder to create a request.

Returns:

Result of the DescribeEntity operation returned by the service.

See Also:

• AWS API Documentation

getResourcePolicy

default GetResourcePolicyResponse getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)
                                             throws InternalServiceException,
AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
MarketplaceCatalogException

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.

See Also:

• AWS API Documentation

getResourcePolicy

default GetResourcePolicyResponse getResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest)
                                             throws InternalServiceException,
AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
MarketplaceCatalogException

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

This is a convenience which creates an instance of the GetResourcePolicyRequest.Builder avoiding the need to create one manually via GetResourcePolicyRequest.builder()

Parameters:

getResourcePolicyRequest - A Consumer that will call methods on GetResourcePolicyRequest.Builder to create a request.

Returns:

Result of the GetResourcePolicy operation returned by the service.

See Also:

• AWS API Documentation

listChangeSets

default ListChangeSetsResponse listChangeSets(ListChangeSetsRequest listChangeSetsRequest)
                                       throws InternalServiceException,
AccessDeniedException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
MarketplaceCatalogException

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.

See Also:

• AWS API Documentation

listChangeSets

default ListChangeSetsResponse listChangeSets(Consumer<ListChangeSetsRequest.Builder> listChangeSetsRequest)
                                       throws InternalServiceException,
AccessDeniedException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
MarketplaceCatalogException

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.

This is a convenience which creates an instance of the ListChangeSetsRequest.Builder avoiding the need to create one manually via ListChangeSetsRequest.builder()

Parameters:

listChangeSetsRequest - A Consumer that will call methods on ListChangeSetsRequest.Builder to create a request.

Returns:

Result of the ListChangeSets operation returned by the service.

See Also:

• AWS API Documentation

listChangeSetsPaginator

default ListChangeSetsIterable listChangeSetsPaginator(ListChangeSetsRequest listChangeSetsRequest)
                                                throws InternalServiceException,
AccessDeniedException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
MarketplaceCatalogException

This is a variant of listChangeSets(software.amazon.awssdk.services.marketplacecatalog.model.ListChangeSetsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.marketplacecatalog.paginators.ListChangeSetsIterable responses = client.listChangeSetsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.marketplacecatalog.paginators.ListChangeSetsIterable responses = client
             .listChangeSetsPaginator(request);
     for (software.amazon.awssdk.services.marketplacecatalog.model.ListChangeSetsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.marketplacecatalog.paginators.ListChangeSetsIterable responses = client.listChangeSetsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listChangeSets(software.amazon.awssdk.services.marketplacecatalog.model.ListChangeSetsRequest) operation.

Parameters:

listChangeSetsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listChangeSetsPaginator

default ListChangeSetsIterable listChangeSetsPaginator(Consumer<ListChangeSetsRequest.Builder> listChangeSetsRequest)
                                                throws InternalServiceException,
AccessDeniedException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
MarketplaceCatalogException

This is a variant of listChangeSets(software.amazon.awssdk.services.marketplacecatalog.model.ListChangeSetsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.marketplacecatalog.paginators.ListChangeSetsIterable responses = client.listChangeSetsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.marketplacecatalog.paginators.ListChangeSetsIterable responses = client
             .listChangeSetsPaginator(request);
     for (software.amazon.awssdk.services.marketplacecatalog.model.ListChangeSetsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.marketplacecatalog.paginators.ListChangeSetsIterable responses = client.listChangeSetsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listChangeSets(software.amazon.awssdk.services.marketplacecatalog.model.ListChangeSetsRequest) operation.

This is a convenience which creates an instance of the ListChangeSetsRequest.Builder avoiding the need to create one manually via ListChangeSetsRequest.builder()

Parameters:

listChangeSetsRequest - A Consumer that will call methods on ListChangeSetsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listEntities

default ListEntitiesResponse listEntities(ListEntitiesRequest listEntitiesRequest)
                                   throws InternalServiceException,
AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
MarketplaceCatalogException

Provides the list of entities of a given type.

Parameters:

listEntitiesRequest -

Returns:

Result of the ListEntities operation returned by the service.

See Also:

• AWS API Documentation

listEntities

default ListEntitiesResponse listEntities(Consumer<ListEntitiesRequest.Builder> listEntitiesRequest)
                                   throws InternalServiceException,
AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
MarketplaceCatalogException

Provides the list of entities of a given type.

This is a convenience which creates an instance of the ListEntitiesRequest.Builder avoiding the need to create one manually via ListEntitiesRequest.builder()

Parameters:

listEntitiesRequest - A Consumer that will call methods on ListEntitiesRequest.Builder to create a request.

Returns:

Result of the ListEntities operation returned by the service.

See Also:

• AWS API Documentation

listEntitiesPaginator

default ListEntitiesIterable listEntitiesPaginator(ListEntitiesRequest listEntitiesRequest)
                                            throws InternalServiceException,
AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
MarketplaceCatalogException

This is a variant of listEntities(software.amazon.awssdk.services.marketplacecatalog.model.ListEntitiesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.marketplacecatalog.paginators.ListEntitiesIterable responses = client.listEntitiesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.marketplacecatalog.paginators.ListEntitiesIterable responses = client
             .listEntitiesPaginator(request);
     for (software.amazon.awssdk.services.marketplacecatalog.model.ListEntitiesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.marketplacecatalog.paginators.ListEntitiesIterable responses = client.listEntitiesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listEntities(software.amazon.awssdk.services.marketplacecatalog.model.ListEntitiesRequest) operation.

Parameters:

listEntitiesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listEntitiesPaginator

default ListEntitiesIterable listEntitiesPaginator(Consumer<ListEntitiesRequest.Builder> listEntitiesRequest)
                                            throws InternalServiceException,
AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
MarketplaceCatalogException

This is a variant of listEntities(software.amazon.awssdk.services.marketplacecatalog.model.ListEntitiesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.marketplacecatalog.paginators.ListEntitiesIterable responses = client.listEntitiesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.marketplacecatalog.paginators.ListEntitiesIterable responses = client
             .listEntitiesPaginator(request);
     for (software.amazon.awssdk.services.marketplacecatalog.model.ListEntitiesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.marketplacecatalog.paginators.ListEntitiesIterable responses = client.listEntitiesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listEntities(software.amazon.awssdk.services.marketplacecatalog.model.ListEntitiesRequest) operation.

This is a convenience which creates an instance of the ListEntitiesRequest.Builder avoiding the need to create one manually via ListEntitiesRequest.builder()

Parameters:

listEntitiesRequest - A Consumer that will call methods on ListEntitiesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
InternalServiceException,
AccessDeniedException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
MarketplaceCatalogException

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.

See Also:

• AWS API Documentation

listTagsForResource

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

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

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.

See Also:

• AWS API Documentation

putResourcePolicy

default PutResourcePolicyResponse putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)
                                             throws InternalServiceException,
AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
MarketplaceCatalogException

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.

See Also:

• AWS API Documentation

putResourcePolicy

default PutResourcePolicyResponse putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest)
                                             throws InternalServiceException,
AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
MarketplaceCatalogException

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

This is a convenience which creates an instance of the PutResourcePolicyRequest.Builder avoiding the need to create one manually via PutResourcePolicyRequest.builder()

Parameters:

putResourcePolicyRequest - A Consumer that will call methods on PutResourcePolicyRequest.Builder to create a request.

Returns:

Result of the PutResourcePolicy operation returned by the service.

See Also:

• AWS API Documentation

startChangeSet

default StartChangeSetResponse startChangeSet(StartChangeSetRequest startChangeSetRequest)
                                       throws InternalServiceException,
AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ResourceInUseException,
ThrottlingException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
MarketplaceCatalogException

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.

See Also:

• AWS API Documentation

startChangeSet

default StartChangeSetResponse startChangeSet(Consumer<StartChangeSetRequest.Builder> startChangeSetRequest)
                                       throws InternalServiceException,
AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ResourceInUseException,
ThrottlingException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
MarketplaceCatalogException

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.

This is a convenience which creates an instance of the StartChangeSetRequest.Builder avoiding the need to create one manually via StartChangeSetRequest.builder()

Parameters:

startChangeSetRequest - A Consumer that will call methods on StartChangeSetRequest.Builder to create a request.

Returns:

Result of the StartChangeSet operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ResourceNotFoundException,
InternalServiceException,
AccessDeniedException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
MarketplaceCatalogException

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

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

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

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

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.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ResourceNotFoundException,
InternalServiceException,
AccessDeniedException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
MarketplaceCatalogException

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.

See Also:

• AWS API Documentation

untagResource

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

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

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.

See Also:

• AWS API Documentation

create

static MarketplaceCatalogClient create()

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

builder

static MarketplaceCatalogClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default MarketplaceCatalogServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration