MarketplaceCatalog class

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.

Constructors

MarketplaceCatalog({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

cancelChangeSet({required String catalog, required String changeSetId}) → Future<CancelChangeSetResponse>

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.

close() → void

Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.

describeChangeSet({required String catalog, required String changeSetId}) → Future<DescribeChangeSetResponse>

Provides information about a given change set.

describeEntity({required String catalog, required String entityId}) → Future<DescribeEntityResponse>

Returns the metadata and content of the entity.

listChangeSets({required String catalog, List<Filter>? filterList, int? maxResults, String? nextToken, Sort? sort}) → Future<ListChangeSetsResponse>

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.

listEntities({required String catalog, required String entityType, List<Filter>? filterList, int? maxResults, String? nextToken, Sort? sort}) → Future<ListEntitiesResponse>

Provides the list of entities of a given type.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

startChangeSet({required String catalog, required List<Change> changeSet, String? changeSetName, String? clientRequestToken}) → Future<StartChangeSetResponse>

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.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited