Data retrieval APIs for AWS CloudFormation
AWS CloudFormation provides the following APIs for data retrieval.
| Actions | Description | Access level |
|---|---|---|
| BatchDescribeTypeConfigurations | Return configuration data for the specified CloudFormation extensions | Read |
| DescribeAccountLimits | Retrieve your account's AWS CloudFormation limits | Read |
| DescribeChangeSet | Return the description for the specified change set | Read |
| DescribeChangeSetHooks | Return the Hook invocation information for the specified change set | Read |
| DescribeEvents | Return all related events for a specified operation | Read |
| DescribeGeneratedTemplate | Describe a generated template. The output includes details about the progress of the creation of a generated template | Read |
| DescribeOrganizationsAccess | Return information about the account's OrganizationAccess status | Read |
| DescribePublisher | Return information about a CloudFormation extension publisher | Read |
| DescribeResourceScan | Describe details of a resource scan | Read |
| DescribeStackDriftDetectionStatus | Return information about a stack drift detection operation | Read |
| DescribeStackEvents | Return all stack related events for a specified stack | Read |
| DescribeStackInstance | Return the stack instance that's associated with the specified stack set, AWS account, and region | Read |
| DescribeStackRefactor | Return the description for the specified stack refactor | Read |
| DescribeStackResource | Return a description of the specified resource in the specified stack | Read |
| DescribeStackResourceDrifts | Return drift information for the resources that have been checked for drift in the specified stack | Read |
| DescribeStackResources | Return AWS resource descriptions for running and deleted stacks | Read |
| DescribeStackSet | Return the description of the specified stack set | Read |
| DescribeStackSetOperation | Return the description of the specified stack set operation | Read |
| DescribeStacks | Return the description for the specified stack, and to all stacks when used in combination with the ListStacks action | List |
| DescribeType | Return information about the CloudFormation type requested | Read |
| DescribeTypeRegistration | Return information about the registration process for a CloudFormation type | Read |
| DetectStackDrift | Detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters | Read |
| DetectStackResourceDrift | Return information about whether a resource's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters | Read |
| DetectStackSetDrift | Enable users to detect drift on a stack set and the stack instances that belong to that stack set | Read |
| EstimateTemplateCost | Return the estimated monthly cost of a template | Read |
| GetGeneratedTemplate | Retrieve a generated template | Read |
| GetHookResult | Return detailed information about a specific hook invocation result | Read |
| GetStackPolicy | Return the stack policy for a specified stack | Read |
| GetTemplate | Return the template body for a specified stack | Read |
| GetTemplateSummary | Return information about a new or existing template | Read |
| ListAllHookResults | Return Hook invocations result information for a specified Hook, a combination of Hook and status, or all Hooks | List |
| ListChangeSets | Return the ID and status of each active change set for a stack. For example, AWS CloudFormation lists change sets that are in the CREATE_IN_PROGRESS or CREATE_PENDING state | List |
| ListExports | List all exported output values in the account and region in which you call this action | List |
| ListGeneratedTemplates | List your generated templates in this Region | List |
| ListHookResults | Return Hook invocations result information for the specified target | List |
| ListImports | List all stacks that are importing an exported output value | List |
| ListResourceScanRelatedResources | List the related resources for a list of resources from a resource scan. The response indicates whether each returned resource is already managed by CloudFormation | List |
| ListResourceScanResources | List the resources from a resource scan. The results can be filtered by resource identifier, resource type prefix, tag key, and tag value | List |
| ListResourceScans | List the resource scans from newest to oldest. By default it will return up to 10 resource scans | List |
| ListStackInstanceResourceDrifts | Return drift information for the resources that have been checked for drift in the specified stack instance | List |
| ListStackInstances | Return summary information about stack instances that are associated with the specified stack set | List |
| ListStackRefactorActions | Return the list of actions of the specified stack refactor | List |
| ListStackRefactors | Return the ID and status of each active stack refactor | List |
| ListStackResources | Return descriptions of all resources of the specified stack | List |
| ListStackSetAutoDeploymentTargets | Return summary information about StackSet Auto Deployment Targets | List |
| ListStackSetOperationResults | Return summary information about the results of a stack set operation | List |
| ListStackSetOperations | Return summary information about operations performed on a stack set | List |
| ListStackSets | Return summary information about stack sets that are associated with the user | List |
| ListStacks | Return the summary information for stacks whose status matches the specified StackStatusFilter. In combination with the DescribeStacks action, grants permission to list descriptions for stacks | List |
| ListTypeRegistrations | List CloudFormation type registration attempts | List |
| ListTypeVersions | List versions of a particular CloudFormation type | List |
| ListTypes | List available CloudFormation types | List |
| ValidateTemplate | Validate a specified template | Read |
