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

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

Returns metadata and content for multiple entities.

Used to cancel an open change request.

Deletes a resource-based policy on an entity that is identified by its resource ARN.

Provides information about a given change set.

Returns the metadata and content of the entity.

Gets a resource-based policy of an entity that is identified by its resource ARN.

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.

Lists all tags that have been added to a resource (either an entity or change set).

Attaches a resource-based policy to an entity.

Allows you to request changes for your entities.

Removes a tag or list of tags from a resource (either an entity or change set).

Functions

Link to this function

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

View Source

Returns metadata and content for multiple entities.

This is the Batch version of the DescribeEntity API and uses the same IAM permission action as DescribeEntity API.

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

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

View Source

Deletes a resource-based policy on an entity that is identified by its resource ARN.

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

get_resource_policy(client, resource_arn, options \\ [])

View Source

Gets a resource-based policy of an entity that is identified by its resource ARN.

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

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

View Source

Lists all tags that have been added to a resource (either an entity or change set).

Link to this function

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

View Source

Attaches a resource-based policy to an entity.

Examples of an entity include: AmiProduct and ContainerProduct.

Link to this function

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

View Source

Allows you to request changes for your entities.

Within a single ChangeSet, you can't 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 change set has completed (either succeeded, cancelled, or failed). If you try to start a change set containing a change against an entity that is already locked, you will receive a ResourceInUseException error.

For example, you can't start the ChangeSet described in the example later in this topic because it contains two changes to run 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. For information about change types for single-AMI products, see Working with single-AMI products. Also, for more information about change types available for container-based products, see Working with container products.

Link to this function

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

View Source

Tags a resource (either an entity or change set).

Link to this function

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

View Source

Removes a tag or list of tags from a resource (either an entity or change set).