MarketplaceCatalogClient

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.

Properties

Link copied to clipboard

MarketplaceCatalogClient's configuration

Functions

Link copied to clipboard

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 copied to clipboard

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 copied to clipboard

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

Link copied to clipboard

Provides information about a given change set.

Link copied to clipboard

Returns the metadata and content of the entity.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Provides the list of entities of a given type.

Link copied to clipboard

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

Link copied to clipboard

Attaches a resource-based policy to an entity. Examples of an entity include: AmiProduct and ContainerProduct.

Link copied to clipboard

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.

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

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

Link copied to clipboard

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

Inherited functions

Link copied to clipboard

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 copied to clipboard

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 copied to clipboard
expect abstract fun close()
Link copied to clipboard

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

Link copied to clipboard

Provides information about a given change set.

Link copied to clipboard

Returns the metadata and content of the entity.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Provides the list of entities of a given type.

Link copied to clipboard

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

Link copied to clipboard

Attaches a resource-based policy to an entity. Examples of an entity include: AmiProduct and ContainerProduct.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.