AWS.MarketplaceCatalog (aws-elixir v0.8.0) View Source

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.

Link to this section Summary

Functions

Used to cancel an open change request.

Provides information about a given change set.

Returns the metadata and content of the entity.

Returns the list of change sets owned by the account being used to make the call.

Provides the list of entities of a given type.

This operation allows you to request changes for your entities.

Link to this section Functions

Link to this function

cancel_change_set(client, input, options \\ [])

View Source

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.

Link to this function

describe_change_set(client, catalog, change_set_id, options \\ [])

View Source

Provides information about a given change set.

Link to this function

describe_entity(client, catalog, entity_id, options \\ [])

View Source

Returns the metadata and content of the entity.

Link to this function

list_change_sets(client, input, options \\ [])

View Source

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.

Link to this function

list_entities(client, input, options \\ [])

View Source

Provides the list of entities of a given type.

Link to this function

start_change_set(client, input, options \\ [])

View Source

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.