aws_marketplace_catalog
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.Summary
Functions
-
cancel_change_set(Client, Input)
Used to cancel an open change request.
- cancel_change_set(Client, Input0, Options0)
-
describe_change_set(Client, Catalog, ChangeSetId)
Provides information about a given change set.
- describe_change_set(Client, Catalog, ChangeSetId, QueryMap, HeadersMap)
- describe_change_set(Client, Catalog, ChangeSetId, QueryMap, HeadersMap, Options0)
-
describe_entity(Client, Catalog, EntityId)
Returns the metadata and content of the entity.
- describe_entity(Client, Catalog, EntityId, QueryMap, HeadersMap)
- describe_entity(Client, Catalog, EntityId, QueryMap, HeadersMap, Options0)
-
list_change_sets(Client, Input)
Returns the list of change sets owned by the account being used to make the call.
- list_change_sets(Client, Input0, Options0)
-
list_entities(Client, Input)
Provides the list of entities of a given type.
- list_entities(Client, Input0, Options0)
-
start_change_set(Client, Input)
This operation allows you to request changes for your entities.
- start_change_set(Client, Input0, Options0)
Functions
cancel_change_set(Client, Input)
Used to cancel an open change request.
Must be sent before the status of the request changes toAPPLYING
, the
final stage of completing your change request. You can describe a change
during the 60-day request history retention period for API calls.
cancel_change_set(Client, Input0, Options0)
describe_change_set(Client, Catalog, ChangeSetId)
Provides information about a given change set.
describe_change_set(Client, Catalog, ChangeSetId, QueryMap, HeadersMap)
describe_change_set(Client, Catalog, ChangeSetId, QueryMap, HeadersMap, Options0)
describe_entity(Client, Catalog, EntityId)
Returns the metadata and content of the entity.
describe_entity(Client, Catalog, EntityId, QueryMap, HeadersMap)
describe_entity(Client, Catalog, EntityId, QueryMap, HeadersMap, Options0)
list_change_sets(Client, Input)
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.
list_change_sets(Client, Input0, Options0)
list_entities(Client, Input)
Provides the list of entities of a given type.
list_entities(Client, Input0, Options0)
start_change_set(Client, Input)
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
.
AddRevisions
) against the same entity (entity-id@1)
.