AWS Marketplace Catalog Service
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…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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.
Endpoints 15
- POSTBatch describe entities
/BatchDescribeEntitiesReturns metadata and content for multiple entities. This is the Batch version of the DescribeEntity API and uses the same IAM permission action as… - PATCHCancel change set
/CancelChangeSet?catalog=string&changeSetId=stringUsed 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.… - DELETEDelete resource policy
/DeleteResourcePolicy?resourceArn=stringDeletes a resource-based policy on an entity that is identified by its resource ARN. - POSTDescribe assessment
/DescribeAssessmentReturns the metadata and detailed results of a single assessment, including the framework that was evaluated, the overall assessment result, and a paginated… - GETDescribe change set
/DescribeChangeSet?catalog=string&changeSetId=stringProvides information about a given change set. - GETDescribe entity
/DescribeEntity?catalog=string&entityId=stringReturns the metadata and content of the entity. - GETGet resource policy
/GetResourcePolicy?resourceArn=stringGets a resource-based policy of an entity that is identified by its resource ARN. - POSTList assessments
/ListAssessmentsReturns a paginated list of assessments associated with an entity or change set in AWS Marketplace. An assessment is the result of evaluating a product or… - POSTList change sets
/ListChangeSetsReturns 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 ,… - POSTList entities
/ListEntitiesProvides the list of entities of a given type. - POSTList tags for resource
/ListTagsForResourceLists all tags that have been added to a resource (either an entity or change set ). - POSTPut resource policy
/PutResourcePolicyAttaches a resource-based policy to an entity. Examples of an entity include: AmiProduct and ContainerProduct . - POSTStart change set
/StartChangeSetAllows 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.… - POSTTag resource
/TagResourceTags a resource (either an entity or change set ). - POSTUntag resource
/UntagResourceRemoves a tag or list of tags from a resource (either an entity or change set ).
API details
- Base URL
https://catalog.marketplace.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 15 operations on 15 pathsPOST 10GET 3PATCH 1DELETE 1
- Description format
- AWS Smithy model, API version
2018-09-17 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS Marketplace Catalog Service in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Marketplace Catalog Service collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Batch describe entities” (POST /BatchDescribeEntities), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS Marketplace Catalog Service?
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… It is listed under E-commerce and has 15 endpoints.
Who publishes the AWS Marketplace Catalog Service?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS Marketplace Catalog Service?
Requests go to https://catalog.marketplace.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS Marketplace Catalog Service?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS Marketplace Catalog Service have?
15 operations on 15 paths (10 POST, 3 GET, 1 PATCH, 1 DELETE).
Is forking the AWS Marketplace Catalog Service free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.