Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AWS CloudFormation Change Sets API

Operations for creating and managing change sets to preview stack changes.

AWS CloudFormation Change Sets API is one of 13 APIs that AWS CloudFormation publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Change Sets. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a getting-started guide, and a changelog.

This API exposes 5 operations across 5 paths, and defines 10 schemas. It is described by OpenAPI 3.1.0, at version 2021-09-30.

Requests are made against a single base URL, https://cloudcontrolapi.{region}.amazonaws.com.

5 operations 5 paths 10 schemas 5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2021-09-30
Base URL
https://cloudformation.{region}.amazonaws.com
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

AWS CloudFormation Change Sets API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (AWS_Signature_V4). By default, every request must be authenticated.

  • AWS_Signature_V4 — AWS Signature Version 4 authentication.

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 5 POST. Each is listed below with its method, path, parameters, and response codes.

Change Sets 5

Operations for creating and managing change sets to preview stack changes.

POST
/?Action=CreateChangeSet
Create a Change Set to Preview Stack Changes
createChangeSet 1 param body → 200400500
POST
/?Action=DescribeChangeSet
Describe a Change Set
describeChangeSet 1 param body → 200400404500
POST
/?Action=ExecuteChangeSet
Execute a Change Set
executeChangeSet 1 param body → 200400404409500
POST
/?Action=DeleteChangeSet
Delete a Change Set
deleteChangeSet 1 param body → 200400404409500
POST
/?Action=ListChangeSets
List All Change Sets for a Stack
listChangeSets 1 param body → 200400500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are ChangeSetDetail (17 properties), ChangeSetSummary (13 properties), ResourceChange (7 properties), ResourceChangeDetail (4 properties). Each schema is shown below with its type and property counts.

ChangeSetSummary
object
13 properties
RollbackConfiguration
object
2 properties
Parameter
object
4 properties
Change
object
2 properties
Tag
object
2 properties 2 required
ChangeSetDetail
object
17 properties
ResourceChangeDetail
object
4 properties
RollbackTrigger
object
2 properties 2 required
ErrorResponse
object
2 properties
ResourceChange
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cloudformation-change-sets-api-openapi.yml Raw ↑

Other APIs AWS CloudFormation publishes across the network.

AWS CloudFormation Exports API
AWS CloudFormation Registry API
AWS CloudFormation Request Status API
AWS CloudFormation Resources API
AWS CloudFormation Stack Drift API
AWS CloudFormation Stack Events API
AWS CloudFormation Stack Instances API
AWS CloudFormation Stack Policies API
AWS CloudFormation Stack Resources API
AWS CloudFormation Stack Sets API
AWS CloudFormation Stacks API
AWS CloudFormation Templates API