AWS Marketplace Entities API

openapi: 3.1.0
info:
  title: AWS Marketplace Catalog Change Sets Entities API
  version: '2018-09-17'
  description: 'The AWS Marketplace Catalog API lets approved sellers programmatically

    view and update their AWS Marketplace product entities and change sets.

    All operations are REST POST requests to named paths, with the JSON

    request body containing input parameters. Requests are signed with AWS

    Signature Version 4 (SigV4).


    See https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html

    '
servers:
- url: https://catalog.marketplace.{region}.amazonaws.com
  description: AWS Marketplace Catalog regional endpoint
  variables:
    region:
      default: us-east-1
security:
- SigV4: []
tags:
- name: Entities
paths:
  /ListEntities:
    post:
      tags:
      - Entities
      operationId: ListEntities
      summary: List entities in the catalog
      requestBody:
        $ref: '#/components/requestBodies/JsonBody'
      responses:
        '200':
          $ref: '#/components/responses/OK'
  /DescribeEntity:
    get:
      tags:
      - Entities
      operationId: DescribeEntity
      summary: Describe an entity
      parameters:
      - name: catalog
        in: query
        required: true
        schema:
          type: string
      - name: entityId
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          $ref: '#/components/responses/OK'
  /BatchDescribeEntities:
    post:
      tags:
      - Entities
      operationId: BatchDescribeEntities
      summary: Describe multiple entities in a single request
      requestBody:
        $ref: '#/components/requestBodies/JsonBody'
      responses:
        '200':
          $ref: '#/components/responses/OK'
components:
  responses:
    OK:
      description: Successful response
      content:
        application/json:
          schema:
            type: object
            additionalProperties: true
  requestBodies:
    JsonBody:
      required: true
      content:
        application/json:
          schema:
            type: object
            additionalProperties: true
  securitySchemes:
    SigV4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4 signed Authorization header