AWS Marketplace Change Sets API

The Change Sets API from AWS Marketplace — 4 operation(s) for change sets.

OpenAPI Specification

aws-marketplace-change-sets-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: AWS Marketplace Catalog Change Sets 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: Change Sets
paths:
  /ListChangeSets:
    post:
      tags:
      - Change Sets
      operationId: ListChangeSets
      summary: List change sets
      requestBody:
        $ref: '#/components/requestBodies/JsonBody'
      responses:
        '200':
          $ref: '#/components/responses/OK'
  /DescribeChangeSet:
    get:
      tags:
      - Change Sets
      operationId: DescribeChangeSet
      summary: Describe a change set
      parameters:
      - name: catalog
        in: query
        required: true
        schema:
          type: string
      - name: changeSetId
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          $ref: '#/components/responses/OK'
  /StartChangeSet:
    post:
      tags:
      - Change Sets
      operationId: StartChangeSet
      summary: Start a change set
      requestBody:
        $ref: '#/components/requestBodies/JsonBody'
      responses:
        '200':
          $ref: '#/components/responses/OK'
  /CancelChangeSet:
    patch:
      tags:
      - Change Sets
      operationId: CancelChangeSet
      summary: Cancel a change set
      parameters:
      - name: catalog
        in: query
        required: true
        schema:
          type: string
      - name: changeSetId
        in: query
        required: true
        schema:
          type: string
      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