@aws-sdk/client-marketplace-catalog
Advanced tools
AWS SDK for JavaScript Marketplace Catalog Client for Node.js, Browser and React Native
@aws-sdk/client-marketplace-catalog is a part of the AWS SDK for JavaScript. It allows developers to interact with the AWS Marketplace Catalog API, enabling them to manage and update their product listings on the AWS Marketplace.
ListEntities
This feature allows you to list entities in the AWS Marketplace Catalog. The code sample demonstrates how to list entities of a specific type from the AWS Marketplace.
const { MarketplaceCatalogClient, ListEntitiesCommand } = require('@aws-sdk/client-marketplace-catalog');
const client = new MarketplaceCatalogClient({ region: 'us-west-2' });
const listEntities = async () => {
const command = new ListEntitiesCommand({ Catalog: 'AWSMarketplace', EntityType: 'Entity' });
const response = await client.send(command);
console.log(response);
};
listEntities();DescribeEntity
This feature allows you to describe a specific entity in the AWS Marketplace Catalog. The code sample demonstrates how to retrieve details of a specific entity using its ID.
const { MarketplaceCatalogClient, DescribeEntityCommand } = require('@aws-sdk/client-marketplace-catalog');
const client = new MarketplaceCatalogClient({ region: 'us-west-2' });
const describeEntity = async (entityId) => {
const command = new DescribeEntityCommand({ Catalog: 'AWSMarketplace', EntityId: entityId });
const response = await client.send(command);
console.log(response);
};
describeEntity('example-entity-id');StartChangeSet
This feature allows you to start a change set in the AWS Marketplace Catalog. The code sample demonstrates how to initiate a change set to add a new entity to the catalog.
const { MarketplaceCatalogClient, StartChangeSetCommand } = require('@aws-sdk/client-marketplace-catalog');
const client = new MarketplaceCatalogClient({ region: 'us-west-2' });
const startChangeSet = async () => {
const command = new StartChangeSetCommand({
Catalog: 'AWSMarketplace',
ChangeSet: [
{
ChangeType: 'AddEntity',
Entity: {
Type: 'Entity',
Identifier: 'example-entity-id'
},
Details: JSON.stringify({
Name: 'Example Entity',
Description: 'This is an example entity.'
})
}
]
});
const response = await client.send(command);
console.log(response);
};
startChangeSet();@aws-sdk/client-s3 is another package in the AWS SDK for JavaScript. It allows developers to interact with Amazon S3, enabling them to manage and manipulate S3 buckets and objects. While it serves a different purpose compared to @aws-sdk/client-marketplace-catalog, it shares the same underlying SDK structure and principles.
@aws-sdk/client-dynamodb is a package in the AWS SDK for JavaScript that allows developers to interact with Amazon DynamoDB. It provides functionalities to manage and query DynamoDB tables. Similar to @aws-sdk/client-marketplace-catalog, it is part of the AWS SDK and follows similar patterns for interacting with AWS services.
@aws-sdk/client-ec2 is a package in the AWS SDK for JavaScript that allows developers to interact with Amazon EC2. It provides functionalities to manage EC2 instances, security groups, and other related resources. Like @aws-sdk/client-marketplace-catalog, it is part of the AWS SDK and uses similar methods for service interaction.
AWS SDK for JavaScript MarketplaceCatalog Client for Node.js, Browser and React Native.
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.
To install this package, simply type add or install @aws-sdk/client-marketplace-catalog using your favorite package manager:
npm install @aws-sdk/client-marketplace-catalogyarn add @aws-sdk/client-marketplace-catalogpnpm add @aws-sdk/client-marketplace-catalogThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the MarketplaceCatalogClient and
the commands you need, for example ListChangeSetsCommand:
// ES5 example
const { MarketplaceCatalogClient, ListChangeSetsCommand } = require("@aws-sdk/client-marketplace-catalog");
// ES6+ example
import { MarketplaceCatalogClient, ListChangeSetsCommand } from "@aws-sdk/client-marketplace-catalog";
To send a request, you:
send operation on client with command object as input.destroy() to close open connections.// a client can be shared by different commands.
const client = new MarketplaceCatalogClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new ListChangeSetsCommand(params);
We recommend using await operator to wait for the promise returned by send operation as follows:
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.
You can also use Promise chaining to execute send operation.
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
We do not recommend using callbacks because of callback hell, but they are supported by the send operation.
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript
import * as AWS from "@aws-sdk/client-marketplace-catalog";
const client = new AWS.MarketplaceCatalog({ region: "REGION" });
// async/await.
try {
const data = await client.listChangeSets(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listChangeSets(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listChangeSets(params, (err, data) => {
// process err and data.
});
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-marketplace-catalog package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
FAQs
AWS SDK for JavaScript Marketplace Catalog Client for Node.js, Browser and React Native
We found that @aws-sdk/client-marketplace-catalog demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Malicious Go packages are impersonating popular libraries to install hidden loader malware on Linux and macOS, targeting developers with obfuscated payloads.
Security News
Bybit's $1.46B hack by North Korea's Lazarus Group pushes 2025 crypto losses to $1.6B in just two months, already surpassing all of 2024's $1.49B total.
Security News
OpenSSF has published OSPS Baseline, an initiative designed to establish a minimum set of security-related best practices for open source software projects.