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.

Installation

NPM
npm install @aws-sdk/client-marketplace-catalog
Yarn
yarn add @aws-sdk/client-marketplace-catalog
pnpm
pnpm add @aws-sdk/client-marketplace-catalog

MarketplaceCatalogClient Operations

Command
Summary
BatchDescribeEntitiesCommand

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.

CancelChangeSetCommand

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.

DeleteResourcePolicyCommand

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

DescribeChangeSetCommand

Provides information about a given change set.

DescribeEntityCommand

Returns the metadata and content of the entity.

GetResourcePolicyCommand

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

ListChangeSetsCommand

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.

ListEntitiesCommand

Provides the list of entities of a given type.

ListTagsForResourceCommand

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

PutResourcePolicyCommand

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

StartChangeSetCommand

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-id1).

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 .

TagResourceCommand

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

UntagResourceCommand

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

MarketplaceCatalogClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: MarketplaceCatalogClientConfig