AWS CloudFormation Registry API

openapi: 3.1.0
info:
  title: AWS Cloud Control Change Sets Registry API
  description: AWS Cloud Control API provides a uniform set of five API operations to create, read, update, delete, and list (CRUDL) supported cloud resources. It offers a standardized way to manage AWS and third-party resource types available in the CloudFormation Registry, without needing to learn each individual service API. You specify the resource type and a JSON blob of desired state, and Cloud Control API handles the rest.
  version: '2021-09-30'
  contact:
    name: AWS Support
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  x-logo:
    url: https://aws.amazon.com/cloudformation/logo.png
servers:
- url: https://cloudcontrolapi.{region}.amazonaws.com
  description: AWS Cloud Control API Regional Endpoint
  variables:
    region:
      default: us-east-1
      description: AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - eu-west-1
      - eu-west-2
      - eu-central-1
      - ap-southeast-1
      - ap-southeast-2
      - ap-northeast-1
security:
- AWS_Signature_V4: []
tags:
- name: Registry
  description: Operations for managing extension types in the CloudFormation Registry.
paths:
  /?Action=ListTypes:
    post:
      operationId: listTypes
      summary: List Available Extension Types in the Registry
      description: Returns summary information about extension types registered in the CloudFormation Registry.
      tags:
      - Registry
      parameters:
      - $ref: '#/components/parameters/VersionParam'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                Visibility:
                  type: string
                  enum:
                  - PUBLIC
                  - PRIVATE
                ProvisioningType:
                  type: string
                  enum:
                  - NON_PROVISIONABLE
                  - IMMUTABLE
                  - FULLY_MUTABLE
                Type:
                  type: string
                  enum:
                  - RESOURCE
                  - MODULE
                  - HOOK
                Filters:
                  type: object
                  properties:
                    Category:
                      type: string
                      enum:
                      - REGISTERED
                      - ACTIVATED
                      - THIRD_PARTY
                      - AWS_TYPES
                    PublisherId:
                      type: string
                    TypeNamePrefix:
                      type: string
                NextToken:
                  type: string
                  maxLength: 1024
                MaxResults:
                  type: integer
                  minimum: 1
                  maximum: 100
            examples:
              ListtypesRequestExample:
                summary: Default listTypes request
                x-microcks-default: true
                value:
                  Visibility: PUBLIC
                  ProvisioningType: NON_PROVISIONABLE
                  Type: RESOURCE
                  Filters:
                    Category: REGISTERED
                    PublisherId: '500123'
                    TypeNamePrefix: example_value
                  NextToken: example_value
                  MaxResults: 10
      responses:
        '200':
          description: Type summaries returned.
          content:
            application/xml:
              schema:
                type: object
                properties:
                  ListTypesResult:
                    type: object
                    properties:
                      TypeSummaries:
                        type: array
                        items:
                          $ref: '#/components/schemas/TypeSummary'
                      NextToken:
                        type: string
              examples:
                Listtypes200Example:
                  summary: Default listTypes 200 response
                  x-microcks-default: true
                  value:
                    ListTypesResult:
                      TypeSummaries:
                      - Type: RESOURCE
                        TypeName: example_value
                        TypeArn: example_value
                        DefaultVersionId: '500123'
                        Description: A sample description.
                        LastUpdated: '2026-01-15T10:30:00Z'
                        PublisherId: '500123'
                        PublisherName: example_value
                        IsActivated: true
                        OriginalTypeName: example_value
                        PublicVersionNumber: example_value
                        LatestPublicVersion: example_value
                      NextToken: example_value
        '400':
          $ref: '#/components/responses/ValidationError'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /?Action=DescribeType:
    post:
      operationId: describeType
      summary: Describe an Extension Type in the Registry
      description: Returns detailed information about an extension type registered in the CloudFormation Registry.
      tags:
      - Registry
      parameters:
      - $ref: '#/components/parameters/VersionParam'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                Type:
                  type: string
                  enum:
                  - RESOURCE
                  - MODULE
                  - HOOK
                TypeName:
                  type: string
                Arn:
                  type: string
                VersionId:
                  type: string
                PublisherId:
                  type: string
                PublicVersionNumber:
                  type: string
            examples:
              DescribetypeRequestExample:
                summary: Default describeType request
                x-microcks-default: true
                value:
                  Type: RESOURCE
                  TypeName: example_value
                  Arn: example_value
                  VersionId: '500123'
                  PublisherId: '500123'
                  PublicVersionNumber: example_value
      responses:
        '200':
          description: Type details returned.
          content:
            application/xml:
              schema:
                type: object
                properties:
                  DescribeTypeResult:
                    type: object
                    properties:
                      Arn:
                        type: string
                      Type:
                        type: string
                      TypeName:
                        type: string
                      Description:
                        type: string
                      Schema:
                        type: string
                      ProvisioningType:
                        type: string
                      Visibility:
                        type: string
                      DefaultVersionId:
                        type: string
                      IsDefaultVersion:
                        type: boolean
                      TimeCreated:
                        type: string
                        format: date-time
                      LastUpdated:
                        type: string
                        format: date-time
              examples:
                Describetype200Example:
                  summary: Default describeType 200 response
                  x-microcks-default: true
                  value:
                    DescribeTypeResult:
                      Arn: example_value
                      Type: example_value
                      TypeName: example_value
                      Description: A sample description.
                      Schema: example_value
                      ProvisioningType: example_value
                      Visibility: example_value
                      DefaultVersionId: '500123'
                      IsDefaultVersion: true
                      TimeCreated: '2026-01-15T10:30:00Z'
                      LastUpdated: '2026-01-15T10:30:00Z'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  parameters:
    VersionParam:
      name: Version
      in: query
      required: true
      schema:
        type: string
        default: '2010-05-15'
      description: The API version. Fixed to 2010-05-15.
  responses:
    ValidationError:
      description: The input fails to satisfy the constraints specified by the service.
      content:
        application/xml:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalError:
      description: An internal service error occurred.
      content:
        application/xml:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFoundError:
      description: The specified resource was not found.
      content:
        application/xml:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    ErrorResponse:
      type: object
      properties:
        Error:
          type: object
          properties:
            Type:
              type: string
            Code:
              type: string
            Message:
              type: string
          example: example_value
        RequestId:
          type: string
          example: '500123'
    TypeSummary:
      type: object
      properties:
        Type:
          type: string
          enum:
          - RESOURCE
          - MODULE
          - HOOK
          example: RESOURCE
        TypeName:
          type: string
          example: example_value
        TypeArn:
          type: string
          example: example_value
        DefaultVersionId:
          type: string
          example: '500123'
        Description:
          type: string
          example: A sample description.
        LastUpdated:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        PublisherId:
          type: string
          example: '500123'
        PublisherName:
          type: string
          example: example_value
        IsActivated:
          type: boolean
          example: true
        OriginalTypeName:
          type: string
          example: example_value
        PublicVersionNumber:
          type: string
          example: example_value
        LatestPublicVersion:
          type: string
          example: example_value
  securitySchemes:
    AWS_Signature_V4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4 authentication.