AWS CloudFormation

AWS CloudFormation Stack Resources API

Operations for describing resources within a stack.

GitHub OpenAPI

Operations 4

POST /?Action=DescribeStackResource Describe a Specific Resource in a Stack #
POST /?Action=DescribeStackResources Describe All Resources in a Stack #
POST /?Action=ListStackResources List Resources in a Stack #
POST /?Action=SignalResource Send a Signal to a Resource in a Stack #

Documentation

📖
Documentation
https://docs.aws.amazon.com/cloudformation/
📖
APIReference
https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/Welcome.html
📖
GettingStarted
https://aws.amazon.com/cloudformation/getting-started/
📖
Documentation
https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/what-is-cloudcontrolapi.html
📖
APIReference
https://docs.aws.amazon.com/cloudcontrolapi/index.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/cloudformation/refs/heads/main/openapi/cloudformation-stack-resources-api-openapi.yml

Other Resources

🔗
Pricing
https://aws.amazon.com/cloudformation/pricing/
🔗
ChangeLog
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/document-history.html
🔗
SDKs
https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cloudformation.html

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/cloudformation-stack-resources-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cloudformation-stack-resources-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: AWS CloudFormation Stack Resources API
  description: AWS CloudFormation gives you an easy way to model a collection of related AWS and third-party resources, provision them quickly and consistently, and manage them throughout their lifecycles. It uses templates to define stacks of resources and provides API operations for creating, updating, and deleting stacks. The API uses a query-style interface where all operations are submitted as POST requests with an Action parameter.
  version: '2010-05-15'
  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://cloudformation.{region}.amazonaws.com
  description: AWS CloudFormation 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: Stack Resources
  description: Operations for describing resources within a stack.
paths:
  /?Action=DescribeStackResource:
    post:
      operationId: describeStackResource
      summary: Describe a Specific Resource in a Stack
      description: Returns a description of the specified resource in the specified stack.
      tags:
      - Stack Resources
      parameters:
      - $ref: '#/components/parameters/VersionParam'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - StackName
              - LogicalResourceId
              properties:
                StackName:
                  type: string
                LogicalResourceId:
                  type: string
                  description: The logical name of the resource as specified in the template.
            examples:
              DescribestackresourceRequestExample:
                summary: Default describeStackResource request
                x-microcks-default: true
                value:
                  StackName: example_value
                  LogicalResourceId: '500123'
      responses:
        '200':
          description: Stack resource details returned successfully.
          content:
            application/xml:
              schema:
                type: object
                properties:
                  DescribeStackResourceResult:
                    type: object
                    properties:
                      StackResourceDetail:
                        $ref: '#/components/schemas/StackResource'
              examples:
                Describestackresource200Example:
                  summary: Default describeStackResource 200 response
                  x-microcks-default: true
                  value:
                    DescribeStackResourceResult:
                      StackResourceDetail:
                        StackName: example_value
                        StackId: '500123'
                        LogicalResourceId: '500123'
                        PhysicalResourceId: '500123'
                        ResourceType: example_value
                        Timestamp: '2026-01-15T10:30:00Z'
                        ResourceStatus: CREATE_IN_PROGRESS
                        ResourceStatusReason: example_value
                        Description: A sample description.
        '400':
          $ref: '#/components/responses/ValidationError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /?Action=DescribeStackResources:
    post:
      operationId: describeStackResources
      summary: Describe All Resources in a Stack
      description: Returns AWS resource descriptions for running or deleted stacks. You must specify a StackName or PhysicalResourceId.
      tags:
      - Stack Resources
      parameters:
      - $ref: '#/components/parameters/VersionParam'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                StackName:
                  type: string
                LogicalResourceId:
                  type: string
                PhysicalResourceId:
                  type: string
            examples:
              DescribestackresourcesRequestExample:
                summary: Default describeStackResources request
                x-microcks-default: true
                value:
                  StackName: example_value
                  LogicalResourceId: '500123'
                  PhysicalResourceId: '500123'
      responses:
        '200':
          description: Stack resources returned successfully.
          content:
            application/xml:
              schema:
                type: object
                properties:
                  DescribeStackResourcesResult:
                    type: object
                    properties:
                      StackResources:
                        type: array
                        items:
                          $ref: '#/components/schemas/StackResource'
              examples:
                Describestackresources200Example:
                  summary: Default describeStackResources 200 response
                  x-microcks-default: true
                  value:
                    DescribeStackResourcesResult:
                      StackResources:
                      - StackName: example_value
                        StackId: '500123'
                        LogicalResourceId: '500123'
                        PhysicalResourceId: '500123'
                        ResourceType: example_value
                        Timestamp: '2026-01-15T10:30:00Z'
                        ResourceStatus: CREATE_IN_PROGRESS
                        ResourceStatusReason: example_value
                        Description: A sample description.
        '400':
          $ref: '#/components/responses/ValidationError'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /?Action=ListStackResources:
    post:
      operationId: listStackResources
      summary: List Resources in a Stack
      description: Returns descriptions of all resources of the specified stack.
      tags:
      - Stack Resources
      parameters:
      - $ref: '#/components/parameters/VersionParam'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - StackName
              properties:
                StackName:
                  type: string
                NextToken:
                  type: string
                  maxLength: 1024
            examples:
              ListstackresourcesRequestExample:
                summary: Default listStackResources request
                x-microcks-default: true
                value:
                  StackName: example_value
                  NextToken: example_value
      responses:
        '200':
          description: Stack resource summaries returned.
          content:
            application/xml:
              schema:
                type: object
                properties:
                  ListStackResourcesResult:
                    type: object
                    properties:
                      StackResourceSummaries:
                        type: array
                        items:
                          $ref: '#/components/schemas/StackResourceSummary'
                      NextToken:
                        type: string
              examples:
                Liststackresources200Example:
                  summary: Default listStackResources 200 response
                  x-microcks-default: true
                  value:
                    ListStackResourcesResult:
                      StackResourceSummaries:
                      - LogicalResourceId: '500123'
                        PhysicalResourceId: '500123'
                        ResourceType: example_value
                        LastUpdatedTimestamp: '2026-01-15T10:30:00Z'
                        ResourceStatus: example_value
                        ResourceStatusReason: example_value
                      NextToken: example_value
        '400':
          $ref: '#/components/responses/ValidationError'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /?Action=SignalResource:
    post:
      operationId: signalResource
      summary: Send a Signal to a Resource in a Stack
      description: Sends a signal to the specified resource with a success or failure status. You can use the SignalResource operation in conjunction with a creation policy or update policy.
      tags:
      - Stack Resources
      parameters:
      - $ref: '#/components/parameters/VersionParam'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - StackName
              - LogicalResourceId
              - UniqueId
              - Status
              properties:
                StackName:
                  type: string
                LogicalResourceId:
                  type: string
                UniqueId:
                  type: string
                  description: A unique ID of the signal.
                  maxLength: 64
                Status:
                  type: string
                  enum:
                  - SUCCESS
                  - FAILURE
            examples:
              SignalresourceRequestExample:
                summary: Default signalResource request
                x-microcks-default: true
                value:
                  StackName: example_value
                  LogicalResourceId: '500123'
                  UniqueId: '500123'
                  Status: SUCCESS
      responses:
        '200':
          description: Signal sent successfully.
        '400':
          $ref: '#/components/responses/ValidationError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  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'
    StackResourceDriftInformation:
      type: object
      required:
      - StackResourceDriftStatus
      properties:
        StackResourceDriftStatus:
          type: string
          enum:
          - IN_SYNC
          - MODIFIED
          - DELETED
          - NOT_CHECKED
          example: IN_SYNC
        LastCheckTimestamp:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
    ModuleInfo:
      type: object
      properties:
        TypeHierarchy:
          type: string
          description: A concatenated list of the module type hierarchy. For modules within other modules the format is Module1::Module2.
          example: example_value
        LogicalIdHierarchy:
          type: string
          description: A concatenated list of the logical IDs of the module.
          example: example_value
    StackResource:
      type: object
      required:
      - LogicalResourceId
      - ResourceType
      - ResourceStatus
      - Timestamp
      properties:
        StackName:
          type: string
          description: The name of the stack.
          example: example_value
        StackId:
          type: string
          description: Unique identifier of the stack.
          example: '500123'
        LogicalResourceId:
          type: string
          description: The logical name of the resource specified in the template.
          example: '500123'
        PhysicalResourceId:
          type: string
          description: The name or unique identifier of the physical resource.
          example: '500123'
        ResourceType:
          type: string
          description: Type of AWS resource.
          minLength: 1
          maxLength: 256
          example: example_value
        Timestamp:
          type: string
          format: date-time
          description: Time the status was updated.
          example: '2026-01-15T10:30:00Z'
        ResourceStatus:
          type: string
          description: Current status of the resource.
          enum:
          - CREATE_IN_PROGRESS
          - CREATE_FAILED
          - CREATE_COMPLETE
          - DELETE_IN_PROGRESS
          - DELETE_FAILED
          - DELETE_COMPLETE
          - UPDATE_IN_PROGRESS
          - UPDATE_FAILED
          - UPDATE_COMPLETE
          - IMPORT_FAILED
          - IMPORT_COMPLETE
          - IMPORT_IN_PROGRESS
          - IMPORT_ROLLBACK_IN_PROGRESS
          - IMPORT_ROLLBACK_FAILED
          - IMPORT_ROLLBACK_COMPLETE
          - ROLLBACK_IN_PROGRESS
          - ROLLBACK_COMPLETE
          example: CREATE_IN_PROGRESS
        ResourceStatusReason:
          type: string
          description: Message associated with the resource status.
          example: example_value
        Description:
          type: string
          description: User-defined description.
          maxLength: 1024
          example: A sample description.
        DriftInformation:
          $ref: '#/components/schemas/StackResourceDriftInformation'
        ModuleInfo:
          $ref: '#/components/schemas/ModuleInfo'
    StackResourceSummary:
      type: object
      required:
      - LogicalResourceId
      - ResourceType
      - ResourceStatus
      - LastUpdatedTimestamp
      properties:
        LogicalResourceId:
          type: string
          example: '500123'
        PhysicalResourceId:
          type: string
          example: '500123'
        ResourceType:
          type: string
          example: example_value
        LastUpdatedTimestamp:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        ResourceStatus:
          type: string
          example: example_value
        ResourceStatusReason:
          type: string
          example: example_value
        DriftInformation:
          $ref: '#/components/schemas/StackResourceDriftInformation'
        ModuleInfo:
          $ref: '#/components/schemas/ModuleInfo'
  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:
    InternalError:
      description: An internal service error occurred.
      content:
        application/xml:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ValidationError:
      description: The input fails to satisfy the constraints specified by the service.
      content:
        application/xml:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFoundError:
      description: The specified resource was not found.
      content:
        application/xml:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    AWS_Signature_V4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4 authentication.