@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSMarketplaceCatalogAsync extends AWSMarketplaceCatalog
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSMarketplaceCatalogAsync
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.
ENDPOINT_PREFIX
cancelChangeSet, describeChangeSet, describeEntity, getCachedResponseMetadata, listChangeSets, listEntities, shutdown, startChangeSet
Future<CancelChangeSetResult> cancelChangeSetAsync(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
- Future<CancelChangeSetResult> cancelChangeSetAsync(CancelChangeSetRequest cancelChangeSetRequest, AsyncHandler<CancelChangeSetRequest,CancelChangeSetResult> asyncHandler)
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
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeChangeSetResult> describeChangeSetAsync(DescribeChangeSetRequest describeChangeSetRequest)
Provides information about a given change set.
describeChangeSetRequest
- Future<DescribeChangeSetResult> describeChangeSetAsync(DescribeChangeSetRequest describeChangeSetRequest, AsyncHandler<DescribeChangeSetRequest,DescribeChangeSetResult> asyncHandler)
Provides information about a given change set.
describeChangeSetRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeEntityResult> describeEntityAsync(DescribeEntityRequest describeEntityRequest)
Returns the metadata and content of the entity.
describeEntityRequest
- Future<DescribeEntityResult> describeEntityAsync(DescribeEntityRequest describeEntityRequest, AsyncHandler<DescribeEntityRequest,DescribeEntityResult> asyncHandler)
Returns the metadata and content of the entity.
describeEntityRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListChangeSetsResult> listChangeSetsAsync(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
- Future<ListChangeSetsResult> listChangeSetsAsync(ListChangeSetsRequest listChangeSetsRequest, AsyncHandler<ListChangeSetsRequest,ListChangeSetsResult> asyncHandler)
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
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListEntitiesResult> listEntitiesAsync(ListEntitiesRequest listEntitiesRequest)
Provides the list of entities of a given type.
listEntitiesRequest
- Future<ListEntitiesResult> listEntitiesAsync(ListEntitiesRequest listEntitiesRequest, AsyncHandler<ListEntitiesRequest,ListEntitiesResult> asyncHandler)
Provides the list of entities of a given type.
listEntitiesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartChangeSetResult> startChangeSetAsync(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
- Future<StartChangeSetResult> startChangeSetAsync(StartChangeSetRequest startChangeSetRequest, AsyncHandler<StartChangeSetRequest,StartChangeSetResult> asyncHandler)
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
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.