Data retrieval APIs for AWS CloudFormation - AWS Online Register of Data Formats

Data retrieval APIs for AWS CloudFormation

AWS CloudFormation provides the following APIs for data retrieval.

Actions Description Access level
BatchDescribeTypeConfigurationsReturn configuration data for the specified CloudFormation extensionsRead
DescribeAccountLimitsRetrieve your account's AWS CloudFormation limitsRead
DescribeChangeSetReturn the description for the specified change setRead
DescribeChangeSetHooksReturn the Hook invocation information for the specified change setRead
DescribeGeneratedTemplateDescribe a generated template. The output includes details about the progress of the creation of a generated templateRead
DescribeOrganizationsAccessReturn information about the account's OrganizationAccess statusRead
DescribePublisherReturn information about a CloudFormation extension publisherRead
DescribeResourceScanDescribe details of a resource scanRead
DescribeStackDriftDetectionStatusReturn information about a stack drift detection operationRead
DescribeStackEventsReturn all stack related events for a specified stackRead
DescribeStackInstanceReturn the stack instance that's associated with the specified stack set, AWS account, and regionRead
DescribeStackRefactorReturn the description for the specified stack refactorRead
DescribeStackResourceReturn a description of the specified resource in the specified stackRead
DescribeStackResourceDriftsReturn drift information for the resources that have been checked for drift in the specified stackRead
DescribeStackResourcesReturn AWS resource descriptions for running and deleted stacksRead
DescribeStackSetReturn the description of the specified stack setRead
DescribeStackSetOperationReturn the description of the specified stack set operationRead
DescribeStacksReturn the description for the specified stack, and to all stacks when used in combination with the ListStacks actionList
DescribeTypeReturn information about the CloudFormation type requestedRead
DescribeTypeRegistrationReturn information about the registration process for a CloudFormation typeRead
DetectStackDriftDetects 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 parametersRead
DetectStackResourceDriftReturn 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 parametersRead
DetectStackSetDriftEnable users to detect drift on a stack set and the stack instances that belong to that stack setRead
EstimateTemplateCostReturn the estimated monthly cost of a templateRead
GetGeneratedTemplateRetrieve a generated templateRead
GetStackPolicyReturn the stack policy for a specified stackRead
GetTemplateReturn the template body for a specified stackRead
GetTemplateSummaryReturn information about a new or existing templateRead
ListChangeSetsReturn 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 stateList
ListExportsList all exported output values in the account and region in which you call this actionList
ListGeneratedTemplatesList your generated templates in this RegionList
ListHookResultsReturn Hook invocations result information for the specified targetList
ListImportsList all stacks that are importing an exported output valueList
ListResourceScanRelatedResourcesList the related resources for a list of resources from a resource scan. The response indicates whether each returned resource is already managed by CloudFormationList
ListResourceScanResourcesList the resources from a resource scan. The results can be filtered by resource identifier, resource type prefix, tag key, and tag valueList
ListResourceScansList the resource scans from newest to oldest. By default it will return up to 10 resource scansList
ListStackInstanceResourceDriftsReturn drift information for the resources that have been checked for drift in the specified stack instanceList
ListStackInstancesReturn summary information about stack instances that are associated with the specified stack setList
ListStackRefactorActionsReturn the list of actions of the specified stack refactorList
ListStackRefactorsReturn the ID and status of each active stack refactorList
ListStackResourcesReturn descriptions of all resources of the specified stackList
ListStackSetAutoDeploymentTargetsReturn summary information about StackSet Auto Deployment TargetsList
ListStackSetOperationResultsReturn summary information about the results of a stack set operationList
ListStackSetOperationsReturn summary information about operations performed on a stack setList
ListStackSetsReturn summary information about stack sets that are associated with the userList
ListStacksReturn the summary information for stacks whose status matches the specified StackStatusFilter. In combination with the DescribeStacks action, grants permission to list descriptions for stacksList
ListTypeRegistrationsList CloudFormation type registration attemptsList
ListTypeVersionsList versions of a particular CloudFormation typeList
ListTypesList available CloudFormation typesList
ValidateTemplateValidate a specified templateRead