AWS CloudFormation Request Status API
Operations for tracking the status of asynchronous resource operations and cancelling in-progress requests.
AWS CloudFormation Request Status 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 Request Status. 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 3 operations across 3 paths, and defines 3 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
AWS CloudFormation Request Status 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 3
Across 3 paths, the API surfaces 3 operations — 3 POST. Each is listed below with its method, path, parameters, and response codes.
Operations for tracking the status of asynchronous resource operations and cancelling in-progress requests.
Schemas 3
The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are ProgressEvent (11 properties), HookProgressEvent (8 properties), ErrorResponse (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from AWS CloudFormation 12
Other APIs AWS CloudFormation publishes across the network.