@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface MarketplaceCatalogAsyncClient extends SdkClient
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static MarketplaceCatalogAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
MarketplaceCatalogAsyncClient. |
default CompletableFuture<CancelChangeSetResponse> |
cancelChangeSet(CancelChangeSetRequest cancelChangeSetRequest)
Used to cancel an open change request.
|
default CompletableFuture<CancelChangeSetResponse> |
cancelChangeSet(Consumer<CancelChangeSetRequest.Builder> cancelChangeSetRequest)
Used to cancel an open change request.
|
static MarketplaceCatalogAsyncClient |
create()
Create a
MarketplaceCatalogAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<DescribeChangeSetResponse> |
describeChangeSet(Consumer<DescribeChangeSetRequest.Builder> describeChangeSetRequest)
Provides information about a given change set.
|
default CompletableFuture<DescribeChangeSetResponse> |
describeChangeSet(DescribeChangeSetRequest describeChangeSetRequest)
Provides information about a given change set.
|
default CompletableFuture<DescribeEntityResponse> |
describeEntity(Consumer<DescribeEntityRequest.Builder> describeEntityRequest)
Returns the metadata and content of the entity.
|
default CompletableFuture<DescribeEntityResponse> |
describeEntity(DescribeEntityRequest describeEntityRequest)
Returns the metadata and content of the entity.
|
default CompletableFuture<ListChangeSetsResponse> |
listChangeSets(Consumer<ListChangeSetsRequest.Builder> listChangeSetsRequest)
Returns the list of change sets owned by the account being used to make the call.
|
default CompletableFuture<ListChangeSetsResponse> |
listChangeSets(ListChangeSetsRequest listChangeSetsRequest)
Returns the list of change sets owned by the account being used to make the call.
|
default ListChangeSetsPublisher |
listChangeSetsPaginator(Consumer<ListChangeSetsRequest.Builder> listChangeSetsRequest)
Returns the list of change sets owned by the account being used to make the call.
|
default ListChangeSetsPublisher |
listChangeSetsPaginator(ListChangeSetsRequest listChangeSetsRequest)
Returns the list of change sets owned by the account being used to make the call.
|
default CompletableFuture<ListEntitiesResponse> |
listEntities(Consumer<ListEntitiesRequest.Builder> listEntitiesRequest)
Provides the list of entities of a given type.
|
default CompletableFuture<ListEntitiesResponse> |
listEntities(ListEntitiesRequest listEntitiesRequest)
Provides the list of entities of a given type.
|
default ListEntitiesPublisher |
listEntitiesPaginator(Consumer<ListEntitiesRequest.Builder> listEntitiesRequest)
Provides the list of entities of a given type.
|
default ListEntitiesPublisher |
listEntitiesPaginator(ListEntitiesRequest listEntitiesRequest)
Provides the list of entities of a given type.
|
default CompletableFuture<StartChangeSetResponse> |
startChangeSet(Consumer<StartChangeSetRequest.Builder> startChangeSetRequest)
This operation allows you to request changes for your entities.
|
default CompletableFuture<StartChangeSetResponse> |
startChangeSet(StartChangeSetRequest startChangeSetRequest)
This operation allows you to request changes for your entities.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static MarketplaceCatalogAsyncClient create()
MarketplaceCatalogAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static MarketplaceCatalogAsyncClientBuilder builder()
MarketplaceCatalogAsyncClient.default CompletableFuture<CancelChangeSetResponse> 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.
cancelChangeSetRequest - default CompletableFuture<CancelChangeSetResponse> cancelChangeSet(Consumer<CancelChangeSetRequest.Builder> 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.
This is a convenience which creates an instance of the CancelChangeSetRequest.Builder avoiding the need
to create one manually via CancelChangeSetRequest.builder()
cancelChangeSetRequest - A Consumer that will call methods on CancelChangeSetRequest.Builder to create a request.default CompletableFuture<DescribeChangeSetResponse> describeChangeSet(DescribeChangeSetRequest describeChangeSetRequest)
Provides information about a given change set.
describeChangeSetRequest - default CompletableFuture<DescribeChangeSetResponse> describeChangeSet(Consumer<DescribeChangeSetRequest.Builder> describeChangeSetRequest)
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()
describeChangeSetRequest - A Consumer that will call methods on DescribeChangeSetRequest.Builder to create a request.default CompletableFuture<DescribeEntityResponse> describeEntity(DescribeEntityRequest describeEntityRequest)
Returns the metadata and content of the entity.
describeEntityRequest - default CompletableFuture<DescribeEntityResponse> describeEntity(Consumer<DescribeEntityRequest.Builder> describeEntityRequest)
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()
describeEntityRequest - A Consumer that will call methods on DescribeEntityRequest.Builder to create a request.default CompletableFuture<ListChangeSetsResponse> 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.
listChangeSetsRequest - default CompletableFuture<ListChangeSetsResponse> listChangeSets(Consumer<ListChangeSetsRequest.Builder> 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.
This is a convenience which creates an instance of the ListChangeSetsRequest.Builder avoiding the need to
create one manually via ListChangeSetsRequest.builder()
listChangeSetsRequest - A Consumer that will call methods on ListChangeSetsRequest.Builder to create a request.default ListChangeSetsPublisher listChangeSetsPaginator(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.
This is a variant of
listChangeSets(software.amazon.awssdk.services.marketplacecatalog.model.ListChangeSetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.marketplacecatalog.paginators.ListChangeSetsPublisher publisher = client.listChangeSetsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.marketplacecatalog.paginators.ListChangeSetsPublisher publisher = client.listChangeSetsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.marketplacecatalog.model.ListChangeSetsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.marketplacecatalog.model.ListChangeSetsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listChangeSetsRequest - default ListChangeSetsPublisher listChangeSetsPaginator(Consumer<ListChangeSetsRequest.Builder> 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.
This is a variant of
listChangeSets(software.amazon.awssdk.services.marketplacecatalog.model.ListChangeSetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.marketplacecatalog.paginators.ListChangeSetsPublisher publisher = client.listChangeSetsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.marketplacecatalog.paginators.ListChangeSetsPublisher publisher = client.listChangeSetsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.marketplacecatalog.model.ListChangeSetsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.marketplacecatalog.model.ListChangeSetsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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()
listChangeSetsRequest - A Consumer that will call methods on ListChangeSetsRequest.Builder to create a request.default CompletableFuture<ListEntitiesResponse> listEntities(ListEntitiesRequest listEntitiesRequest)
Provides the list of entities of a given type.
listEntitiesRequest - default CompletableFuture<ListEntitiesResponse> listEntities(Consumer<ListEntitiesRequest.Builder> listEntitiesRequest)
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()
listEntitiesRequest - A Consumer that will call methods on ListEntitiesRequest.Builder to create a request.default ListEntitiesPublisher listEntitiesPaginator(ListEntitiesRequest listEntitiesRequest)
Provides the list of entities of a given type.
This is a variant of
listEntities(software.amazon.awssdk.services.marketplacecatalog.model.ListEntitiesRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.marketplacecatalog.paginators.ListEntitiesPublisher publisher = client.listEntitiesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.marketplacecatalog.paginators.ListEntitiesPublisher publisher = client.listEntitiesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.marketplacecatalog.model.ListEntitiesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.marketplacecatalog.model.ListEntitiesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listEntitiesRequest - default ListEntitiesPublisher listEntitiesPaginator(Consumer<ListEntitiesRequest.Builder> listEntitiesRequest)
Provides the list of entities of a given type.
This is a variant of
listEntities(software.amazon.awssdk.services.marketplacecatalog.model.ListEntitiesRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.marketplacecatalog.paginators.ListEntitiesPublisher publisher = client.listEntitiesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.marketplacecatalog.paginators.ListEntitiesPublisher publisher = client.listEntitiesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.marketplacecatalog.model.ListEntitiesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.marketplacecatalog.model.ListEntitiesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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()
listEntitiesRequest - A Consumer that will call methods on ListEntitiesRequest.Builder to create a request.default CompletableFuture<StartChangeSetResponse> startChangeSet(StartChangeSetRequest startChangeSetRequest)
This operation allows you to request changes for your entities. Within a single ChangeSet, you cannot 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 ChangeSet has completed (either succeeded,
cancelled, or failed). If you try to start a ChangeSet containing a change against an entity that is already
locked, you will receive a ResourceInUseException.
For example, you cannot start the ChangeSet described in the example later in this topic, because it contains two changes to execute 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.
startChangeSetRequest - default CompletableFuture<StartChangeSetResponse> startChangeSet(Consumer<StartChangeSetRequest.Builder> startChangeSetRequest)
This operation allows you to request changes for your entities. Within a single ChangeSet, you cannot 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 ChangeSet has completed (either succeeded,
cancelled, or failed). If you try to start a ChangeSet containing a change against an entity that is already
locked, you will receive a ResourceInUseException.
For example, you cannot start the ChangeSet described in the example later in this topic, because it contains two changes to execute 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.
This is a convenience which creates an instance of the StartChangeSetRequest.Builder avoiding the need to
create one manually via StartChangeSetRequest.builder()
startChangeSetRequest - A Consumer that will call methods on StartChangeSetRequest.Builder to create a request.