@adpt/cloud

swagger: '2.0' info: version: '2010-05-15' x-release: v4 title: AWS CloudFormation description: '<fullname>AWS CloudFormation</fullname> AWS CloudFormation allows you to create and manage AWS infrastructure deployments predictably and repeatedly. You can use AWS CloudFormation to leverage AWS products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly-reliable, highly scalable, cost-effective applications without creating or configuring the underlying AWS infrastructure. With AWS CloudFormation, you declare all of your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. AWS CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you. For more information about AWS CloudFormation, see the <a href="http://aws.amazon.com/cloudformation/">AWS CloudFormation Product Page</a>. Amazon CloudFormation makes use of other AWS products. If you need additional technical information about a specific AWS product, you can find the product''s technical documentation at <a href="http://docs.aws.amazon.com/">docs.aws.amazon.com</a>.' x-logo: url: 'https://twitter.com/awscloud/profile_image?size=original' backgroundColor: '#FFFFFF' termsOfService: 'https://aws.amazon.com/service-terms/' contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: 'https://github.com/mermade/aws2openapi' x-twitter: PermittedSoc license: name: Apache 2.0 License url: 'http://www.apache.org/licenses/' x-providerName: amazonaws.com x-serviceName: cloudformation x-origin: - contentType: application/json url: 'https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/cloudformation-2010-05-15.normal.json' converter: url: 'https://github.com/mermade/aws2openapi' version: 1.0.0 x-apisguru-direct: true x-apiClientRegistration: url: 'https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct' x-apisguru-categories: - cloud x-preferred: true externalDocs: description: Amazon Web Services documentation url: 'https://aws.amazon.com/cloudformation/' host: cloudformation.amazonaws.com basePath: / x-hasEquivalentPaths: true schemes: - https - http consumes: [] produces: [] parameters: Action: name: Action in: query type: string required: false Version: name: Version in: query type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header type: string required: false X-Amz-Date: name: X-Amz-Date in: header type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header type: string required: false securityDefinitions: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 security: - hmac: [] paths: /: post: operationId: CancelUpdateStack description: 'Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration. <note> You can cancel only stacks that are in the UPDATE_IN_PROGRESS state. </note>' responses: '200': description: Success '480': description: TokenAlreadyExistsException schema: $ref: '#/definitions/TokenAlreadyExistsException' parameters: - name: body in: body required: true schema: $ref: '#/definitions/CancelUpdateStackInput' parameters: - $ref: '#/parameters/Action' - $ref: '#/parameters/Version' - $ref: '#/parameters/X-Amz-Content-Sha256' - $ref: '#/parameters/X-Amz-Date' - $ref: '#/parameters/X-Amz-Algorithm' - $ref: '#/parameters/X-Amz-Credential' - $ref: '#/parameters/X-Amz-Security-Token' - $ref: '#/parameters/X-Amz-Signature' - $ref: '#/parameters/X-Amz-SignedHeaders' '/#ContinueUpdateRollback': post: operationId: ContinueUpdateRollback description: 'For a specified stack that is in the <code>UPDATE_ROLLBACK_FAILED</code> state, continues rolling it back to the <code>UPDATE_ROLLBACK_COMPLETE</code> state. Depending on the cause of the failure, you can manually <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed"> fix the error</a> and continue the rollback. By continuing the rollback, you can return your stack to a working state (the <code>UPDATE_ROLLBACK_COMPLETE</code> state), and then try to update the stack again. A stack goes into the <code>UPDATE_ROLLBACK_FAILED</code> state when AWS CloudFormation cannot roll back all changes after a failed stack update. For example, you might have a stack that is rolling back to an old database instance that was deleted outside of AWS CloudFormation. Because AWS CloudFormation doesn''t know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail.' responses: '200': description: Success schema: $ref: '#/definitions/ContinueUpdateRollbackOutput' '480': description: TokenAlreadyExistsException schema: $ref: '#/definitions/TokenAlreadyExistsException' parameters: - name: body in: body required: true schema: $ref: '#/definitions/ContinueUpdateRollbackInput' parameters: - $ref: '#/parameters/Action' - $ref: '#/parameters/Version' - $ref: '#/parameters/X-Amz-Content-Sha256' - $ref: '#/parameters/X-Amz-Date' - $ref: '#/parameters/X-Amz-Algorithm' - $ref: '#/parameters/X-Amz-Credential' - $ref: '#/parameters/X-Amz-Security-Token' - $ref: '#/parameters/X-Amz-Signature' - $ref: '#/parameters/X-Amz-SignedHeaders' '/#CreateChangeSet': post: operationId: CreateChangeSet description: 'Creates a list of changes that will be applied to a stack so that you can review the changes before executing them. You can create a change set for a stack that doesn''t exist or an existing stack. If you create a change set for a stack that doesn''t exist, the change set shows all of the resources that AWS CloudFormation will create. If you create a change set for an existing stack, AWS CloudFormation compares the stack''s information with the information that you submit in the change set and lists the differences. Use change sets to understand which resources AWS CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update a stack. To create a change set for a stack that doesn''t exist, for the <code>ChangeSetType</code> parameter, specify <code>CREATE</code>. To create a change set for an existing stack, specify <code>UPDATE</code> for the <code>ChangeSetType</code> parameter. After the <code>CreateChangeSet</code> call successfully completes, AWS CloudFormation starts creating the change set. To check the status of the change set or to review it, use the <a>DescribeChangeSet</a> action. When you are satisfied with the changes the change set will make, execute the change set by using the <a>ExecuteChangeSet</a> action. AWS CloudFormation doesn''t make changes until you execute the change set.' responses: '200': description: Success schema: $ref: '#/definitions/CreateChangeSetOutput' '480': description: AlreadyExistsException schema: $ref: '#/definitions/AlreadyExistsException' '481': description: InsufficientCapabilitiesException schema: $ref: '#/definitions/InsufficientCapabilitiesException' '482': description: LimitExceededException schema: $ref: '#/definitions/LimitExceededException' parameters: - name: body in: body required: true schema: $ref: '#/definitions/CreateChangeSetInput' parameters: - $ref: '#/parameters/Action' - $ref: '#/parameters/Version' - $ref: '#/parameters/X-Amz-Content-Sha256' - $ref: '#/parameters/X-Amz-Date' - $ref: '#/parameters/X-Amz-Algorithm' - $ref: '#/parameters/X-Amz-Credential' - $ref: '#/parameters/X-Amz-Security-Token' - $ref: '#/parameters/X-Amz-Signature' - $ref: '#/parameters/X-Amz-SignedHeaders' '/#CreateStack': post: operationId: CreateStack description: 'Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack via the <a>DescribeStacks</a> API.' responses: '200': description: Success schema: $ref: '#/definitions/CreateStackOutput' '480': description: LimitExceededException schema: $ref: '#/definitions/LimitExceededException' '481': description: AlreadyExistsException schema: $ref: '#/definitions/AlreadyExistsException' '482': description: TokenAlreadyExistsException schema: $ref: '#/definitions/TokenAlreadyExistsException' '483': description: InsufficientCapabilitiesException schema: $ref: '#/definitions/InsufficientCapabilitiesException' parameters: - name: body in: body required: true schema: $ref: '#/definitions/CreateStackInput' parameters: - $ref: '#/parameters/Action' - $ref: '#/parameters/Version' - $ref: '#/parameters/X-Amz-Content-Sha256' - $ref: '#/parameters/X-Amz-Date' - $ref: '#/parameters/X-Amz-Algorithm' - $ref: '#/parameters/X-Amz-Credential' - $ref: '#/parameters/X-Amz-Security-Token' - $ref: '#/parameters/X-Amz-Signature' - $ref: '#/parameters/X-Amz-SignedHeaders' '/#CreateStackInstances': post: operationId: CreateStackInstances description: 'Creates stack instances for the specified accounts, within the specified regions. A stack instance refers to a stack in a specific account and region. <code>Accounts</code> and <code>Regions</code> are required parameters—you must specify at least one account and one region. ' responses: '200': description: Success schema: $ref: '#/definitions/CreateStackInstancesOutput' '480': description: StackSetNotFoundException schema: $ref: '#/definitions/StackSetNotFoundException' '481': description: OperationInProgressException schema: $ref: '#/definitions/OperationInProgressException' '482': description: OperationIdAlreadyExistsException schema: $ref: '#/definitions/OperationIdAlreadyExistsException' '483': description: StaleRequestException schema: $ref: '#/definitions/StaleRequestException' '484': description: InvalidOperationException schema: $ref: '#/definitions/InvalidOperationException' '485': description: LimitExceededException schema: $ref: '#/definitions/LimitExceededException' parameters: - name: body in: body required: true schema: $ref: '#/definitions/CreateStackInstancesInput' parameters: - $ref: '#/parameters/Action' - $ref: '#/parameters/Version' - $ref: '#/parameters/X-Amz-Content-Sha256' - $ref: '#/parameters/X-Amz-Date' - $ref: '#/parameters/X-Amz-Algorithm' - $ref: '#/parameters/X-Amz-Credential' - $ref: '#/parameters/X-Amz-Security-Token' - $ref: '#/parameters/X-Amz-Signature' - $ref: '#/parameters/X-Amz-SignedHeaders' '/#CreateStackSet': post: operationId: CreateStackSet description: Creates a stack set. responses: '200': description: Success schema: $ref: '#/definitions/CreateStackSetOutput' '480': description: NameAlreadyExistsException schema: $ref: '#/definitions/NameAlreadyExistsException' '481': description: CreatedButModifiedException schema: $ref: '#/definitions/CreatedButModifiedException' '482': description: LimitExceededException schema: $ref: '#/definitions/LimitExceededException' parameters: - name: body in: body required: true schema: $ref: '#/definitions/CreateStackSetInput' parameters: - $ref: '#/parameters/Action' - $ref: '#/parameters/Version' - $ref: '#/parameters/X-Amz-Content-Sha256' - $ref: '#/parameters/X-Amz-Date' - $ref: '#/parameters/X-Amz-Algorithm' - $ref: '#/parameters/X-Amz-Credential' - $ref: '#/parameters/X-Amz-Security-Token' - $ref: '#/parameters/X-Amz-Signature' - $ref: '#/parameters/X-Amz-SignedHeaders' '/#DeleteChangeSet': post: operationId: DeleteChangeSet description: 'Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set. If the call successfully completes, AWS CloudFormation successfully deleted the change set.' responses: '200': description: Success schema: $ref: '#/definitions/DeleteChangeSetOutput' '480': description: InvalidChangeSetStatusException schema: $ref: '#/definitions/InvalidChangeSetStatusException' parameters: - name: body in: body required: true schema: $ref: '#/definitions/DeleteChangeSetInput' parameters: - $ref: '#/parameters/Action' - $ref: '#/parameters/Version' - $ref: '#/parameters/X-Amz-Content-Sha256' - $ref: '#/parameters/X-Amz-Date' - $ref: '#/parameters/X-Amz-Algorithm' - $ref: '#/parameters/X-Amz-Credential' - $ref: '#/parameters/X-Amz-Security-Token' - $ref: '#/parameters/X-Amz-Signature' - $ref: '#/parameters/X-Amz-SignedHeaders' '/#DeleteStack': post: operationId: DeleteStack description: 'Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the <a>DescribeStacks</a> API if the deletion has been completed successfully.' responses: '200': description: Success '480': description: TokenAlreadyExistsException schema: $ref: '#/definitions/TokenAlreadyExistsException' parameters: - name: body in: body required: true schema: $ref: '#/definitions/DeleteStackInput' parameters: - $ref: '#/parameters/Action' - $ref: '#/parameters/Version' - $ref: '#/parameters/X-Amz-Content-Sha256' - $ref: '#/parameters/X-Amz-Date' - $ref: '#/parameters/X-Amz-Algorithm' - $ref: '#/parameters/X-Amz-Credential' - $ref: '#/parameters/X-Amz-Security-Token' - $ref: '#/parameters/X-Amz-Signature' - $ref: '#/parameters/X-Amz-SignedHeaders' '/#DeleteStackInstances': post: operationId: DeleteStackInstances description: 'Deletes stack instances for the specified accounts, in the specified regions. ' responses: '200': description: Success schema: $ref: '#/definitions/DeleteStackInstancesOutput' '480': description: StackSetNotFoundException schema: $ref: '#/definitions/StackSetNotFoundException' '481': description: OperationInProgressException schema: $ref: '#/definitions/OperationInProgressException' '482': description: OperationIdAlreadyExistsException schema: $ref: '#/definitions/OperationIdAlreadyExistsException' '483': description: StaleRequestException schema: $ref: '#/definitions/StaleRequestException' '484': description: InvalidOperationException schema: $ref: '#/definitions/InvalidOperationException' parameters: - name: body in: body required: true schema: $ref: '#/definitions/DeleteStackInstancesInput' parameters: - $ref: '#/parameters/Action' - $ref: '#/parameters/Version' - $ref: '#/parameters/X-Amz-Content-Sha256' - $ref: '#/parameters/X-Amz-Date' - $ref: '#/parameters/X-Amz-Algorithm' - $ref: '#/parameters/X-Amz-Credential' - $ref: '#/parameters/X-Amz-Security-Token' - $ref: '#/parameters/X-Amz-Signature' - $ref: '#/parameters/X-Amz-SignedHeaders' '/#DeleteStackSet': post: operationId: DeleteStackSet description: 'Deletes a stack set. Before you can delete a stack set, all of its member stack instances must be deleted. For more information about how to do this, see <a>DeleteStackInstances</a>. ' responses: '200': description: Success schema: $ref: '#/definitions/DeleteStackSetOutput' '480': description: StackSetNotEmptyException schema: $ref: '#/definitions/StackSetNotEmptyException' '481': description: OperationInProgressException schema: $ref: '#/definitions/OperationInProgressException' parameters: - name: body in: body required: true schema: $ref: '#/definitions/DeleteStackSetInput' parameters: - $ref: '#/parameters/Action' - $ref: '#/parameters/Version' - $ref: '#/parameters/X-Amz-Content-Sha256' - $ref: '#/parameters/X-Amz-Date' - $ref: '#/parameters/X-Amz-Algorithm' - $ref: '#/parameters/X-Amz-Credential' - $ref: '#/parameters/X-Amz-Security-Token' - $ref: '#/parameters/X-Amz-Signature' - $ref: '#/parameters/X-Amz-SignedHeaders' '/#DescribeAccountLimits': post: operationId: DescribeAccountLimits description: 'Retrieves your account''s AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account.' responses: '200': description: Success schema: $ref: '#/definitions/DescribeAccountLimitsOutput' parameters: - name: body in: body required: true schema: $ref: '#/definitions/DescribeAccountLimitsInput' parameters: - $ref: '#/parameters/Action' - $ref: '#/parameters/Version' - $ref: '#/parameters/X-Amz-Content-Sha256' - $ref: '#/parameters/X-Amz-Date' - $ref: '#/parameters/X-Amz-Algorithm' - $ref: '#/parameters/X-Amz-Credential' - $ref: '#/parameters/X-Amz-Security-Token' - $ref: '#/parameters/X-Amz-Signature' - $ref: '#/parameters/X-Amz-SignedHeaders' '/#DescribeChangeSet': post: operationId: DescribeChangeSet description: 'Returns the inputs for the change set and a list of changes that AWS CloudFormation will make if you execute the change set. For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-changesets.html">Updating Stacks Using Change Sets</a> in the AWS CloudFormation User Guide.' responses: '200': description: Success schema: $ref: '#/definitions/DescribeChangeSetOutput' '480': description: ChangeSetNotFoundException schema: $ref: '#/definitions/ChangeSetNotFoundException' parameters: - name: body in: body required: true schema: $ref: '#/definitions/DescribeChangeSetInput' parameters: - $ref: '#/parameters/Action' - $ref: '#/parameters/Version' - $ref: '#/parameters/X-Amz-Content-Sha256' - $ref: '#/parameters/X-Amz-Date' - $ref: '#/parameters/X-Amz-Algorithm' - $ref: '#/parameters/X-Amz-Credential' - $ref: '#/parameters/X-Amz-Security-Token' - $ref: '#/parameters/X-Amz-Signature' - $ref: '#/parameters/X-Amz-SignedHeaders' '/#DescribeStackDriftDetectionStatus': post: operationId: DescribeStackDriftDetectionStatus description: 'Returns information about a stack drift detection operation. A stack drift detection operation 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. A stack is considered to have drifted if one or more of its resources have drifted. For more information on stack and resource drift, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html">Detecting Unregulated Configuration Changes to Stacks and Resources</a>. Use <a>DetectStackDrift</a> to initiate a stack drift detection operation. <code>DetectStackDrift</code> returns a <code>StackDriftDetectionId</code> you can use to monitor the progress of the operation using <code>DescribeStackDriftDetectionStatus</code>. Once the drift detection operation has completed, use <a>DescribeStackResourceDrifts</a> to return drift information about the stack and its resources.' responses: '200': description: Success schema: $ref: '#/definitions/DescribeStackDriftDetectionStatusOutput' parameters: - name: body in: body required: true schema: $ref: '#/definitions/DescribeStackDriftDetectionStatusInput' parameters: - $ref: '#/parameters/Action' - $ref: '#/parameters/Version' - $ref: '#/parameters/X-Amz-Content-Sha256' - $ref: '#/parameters/X-Amz-Date' - $ref: '#/parameters/X-Amz-Algorithm' - $ref: '#/parameters/X-Amz-Credential' - $ref: '#/parameters/X-Amz-Security-Token' - $ref: '#/parameters/X-Amz-Signature' - $ref: '#/parameters/X-Amz-SignedHeaders' '/#DescribeStackEvents': post: operationId: DescribeStackEvents description: 'Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack''s event history, go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/concept-stack.html">Stacks</a> in the AWS CloudFormation User Guide. <note> You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID). </note>' responses: '200': description: Success schema: $ref: '#/definitions/DescribeStackEventsOutput' parameters: - name: body in: body required: true schema: $ref: '#/definitions/DescribeStackEventsInput' - name: NextToken type: string in: query description: Pagination token required: false parameters: - $ref: '#/parameters/Action' - $ref: '#/parameters/Version' - $ref: '#/parameters/X-Amz-Content-Sha256' - $ref: '#/parameters/X-Amz-Date' - $ref: '#/parameters/X-Amz-Algorithm' - $ref: '#/parameters/X-Amz-Credential' - $ref: '#/parameters/X-Amz-Security-Token' - $ref: '#/parameters/X-Amz-Signature' - $ref: '#/parameters/X-Amz-SignedHeaders' '/#DescribeStackInstance': post: operationId: DescribeStackInstance description: 'Returns the stack instance that''s associated with the specified stack set, AWS account, and region. For a list of stack instances that are associated with a specific stack set, use <a>ListStackInstances</a>.' responses: '200': description: Success schema: $ref: '#/definitions/DescribeStackInstanceOutput' '480': description: StackSetNotFoundException schema: $ref: '#/definitions/StackSetNotFoundException' '481': description: StackInstanceNotFoundException schema: $ref: '#/definitions/StackInstanceNotFoundException' parameters: - name: body in: body required: true schema: $ref: '#/definitions/DescribeStackInstanceInput' parameters: - $ref: '#/parameters/Action' - $ref: '#/parameters/Version' - $ref: '#/parameters/X-Amz-Content-Sha256' - $ref: '#/parameters/X-Amz-Date' - $ref: '#/parameters/X-Amz-Algorithm' - $ref: '#/parameters/X-Amz-Credential' - $ref: '#/parameters/X-Amz-Security-Token' - $ref: '#/parameters/X-Amz-Signature' - $ref: '#/parameters/X-Amz-SignedHeaders' '/#DescribeStackResource': post: operationId: DescribeStackResource description: 'Returns a description of the specified resource in the specified stack. For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.' responses: '200': description: Success schema: $ref: '#/definitions/DescribeStackResourceOutput' parameters: - name: body in: body required: true schema: $ref: '#/definitions/DescribeStackResourceInput' parameters: - $ref: '#/parameters/Action' - $ref: '#/parameters/Version' - $ref: '#/parameters/X-Amz-Content-Sha256' - $ref: '#/parameters/X-Amz-Date' - $ref: '#/parameters/X-Amz-Algorithm' - $ref: '#/parameters/X-Amz-Credential' - $ref: '#/parameters/X-Amz-Security-Token' - $ref: '#/parameters/X-Amz-Signature' - $ref: '#/parameters/X-Amz-SignedHeaders' '/#DescribeStackResourceDrifts': post: operationId: DescribeStackResourceDrifts description: 'Returns drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where AWS CloudFormation detects configuration drift. For a given stack, there will be one <code>StackResourceDrift</code> for each stack resource that has been checked for drift. Resources that have not yet been checked for drift are not included. Resources that do not currently support drift detection are not checked, and so not included. For a list of resources that support drift detection, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html">Resources that Support Drift Detection</a>. Use <a>DetectStackResourceDrift</a> to detect drift on individual resources, or <a>DetectStackDrift</a> to detect drift on all supported resources for a given stack.' responses: '200': description: Success schema: $ref: '#/definitions/DescribeStackResourceDriftsOutput' parameters: - name: body in: body required: true schema: $ref: '#/definitions/DescribeStackResourceDriftsInput' - name: MaxResults type: string in: query description: Pagination limit required: false - name: NextToken type: string in: query description: Pagination token required: false parameters: - $ref: '#/parameters/Action' - $ref: '#/parameters/Version' - $ref: '#/parameters/X-Amz-Content-Sha256' - $ref: '#/parameters/X-Amz-Date' - $ref: '#/parameters/X-Amz-Algorithm' - $ref: '#/parameters/X-Amz-Credential' - $ref: '#/parameters/X-Amz-Security-Token' - $ref: '#/parameters/X-Amz-Signature' - $ref: '#/parameters/X-Amz-SignedHeaders' '/#DescribeStackResources': post: operationId: DescribeStackResources description: 'Returns AWS resource descriptions for running and deleted stacks. If <code>StackName</code> is specified, all the associated resources that are part of the stack are returned. If <code>PhysicalResourceId</code> is specified, the associated resources of the stack that the resource belongs to are returned. <note> Only the first 100 resources will be returned. If your stack has more resources than this, you should use <code>ListStackResources</code> instead. </note> For deleted stacks, <code>DescribeStackResources</code> returns resource information for up to 90 days after the stack has been deleted. You must specify either <code>StackName</code> or <code>PhysicalResourceId</code>, but not both. In addition, you can specify <code>LogicalResourceId</code> to filter the returned result. For more information about resources, the <code>LogicalResourceId</code> and <code>PhysicalResourceId</code>, go to the <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/">AWS CloudFormation User Guide</a>. <note> A <code>ValidationError</code> is returned if you specify both <code>StackName</code> and <code>PhysicalResourceId</code> in the same request. </note>' responses: '200': description: Success schema: $ref: '#/definitions/DescribeStackResourcesOutput' parameters: - name: body in: body required: true schema: $ref: '#/definitions/DescribeStackResourcesInput' parameters: - $ref: '#/parameters/Action' - $ref: '#/parameters/Version' - $ref: '#/parameters/X-Amz-Content-Sha256' - $ref: '#/parameters/X-Amz-Date' - $ref: '#/parameters/X-Amz-Algorithm' - $ref: '#/parameters/X-Amz-Credential' - $ref: '#/parameters/X-Amz-Security-Token' - $ref: '#/parameters/X-Amz-Signature' - $ref: '#/parameters/X-Amz-SignedHeaders' '/#DescribeStackSet': post: operationId: DescribeStackSet description: 'Returns the description of the specified stack set. ' responses: '200': description: Success schema: $ref: '#/definitions/DescribeStackSetOutput' '480': description: StackSetNotFoundException schema: $ref: '#/definitions/StackSetNotFoundException' parameters: - name: body in: body required: true schema: $ref: '#/definitions/DescribeStackSetInput' parameters: - $ref: '#/parameters/Action' - $ref: '#/parameters/Version' - $ref: '#/parameters/X-Amz-Content-Sha256' - $ref: '#/parameters/X-Amz-Date' - $ref: '#/parameters/X-Amz-Algorithm' - $ref: '#/parameters/X-Amz-Credential' - $ref: '#/parameters/X-Amz-Security-Token' - $ref: '#/parameters/X-Amz-Signature' - $ref: '#/parameters/X-Amz-SignedHeaders' '/#DescribeStackSetOperation': post: operationId: DescribeStackSetOperation description: 'Returns the description of the specified stack set operation. ' responses: '200': description: Success schema: $ref: '#/definitions/DescribeStackSetOperationOutput' '480': description: StackSetNotFoundException schema: $ref: '#/definitions/StackSetNotFoundException' '481': description: OperationNotFoundException schema: $ref: '#/definitions/OperationNotFoundException' parameters: - name: body in: body required: true schema: $ref: '#/definitions/DescribeStackSetOperationInput' parameters: - $ref: '#/parameters/Action' - $ref: '#/parameters/Version' - $ref: '#/parameters/X-Amz-Content-Sha256' - $ref: '#/parameters/X-Amz-Date' - $ref: '#/parameters/X-Amz-Algorithm' - $ref: '#/parameters/X-Amz-Credential' - $ref: '#/parameters/X-Amz-Security-Token' - $ref: '#/parameters/X-Amz-Signature' - $ref: '#/parameters/X-Amz-SignedHeaders' '/#DescribeStacks': post: operationId: DescribeStacks description: 'Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. <note> If the stack does not exist, an <code>AmazonCloudFormationException</code> is returned. </note>' responses: '200': description: Success schema: $ref: '#/definitions/DescribeStacksOutput' parameters: - name: body in: body required: true schema: $ref: '#/definitions/DescribeStacksInput' - name: NextToken type: string in: query description: Pagination token required: false parameters: - $ref: '#/parameters/Action' - $ref: '#/parameters/Version' - $ref: '#/parameters/X-Amz-Content-Sha256' - $ref: '#/parameters/X-Amz-Date' - $ref: '#/parameters/X-Amz-Algorithm' - $ref: '#/parameters/X-Amz-Credential' - $ref: '#/parameters/X-Amz-Security-Token' - $ref: '#/parameters/X-Amz-Signature' - $ref: '#/parameters/X-Amz-SignedHeaders' '/#DetectStackDrift': post: operationId: DetectStackDrift description: '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. For each resource in the stack that supports drift detection, AWS CloudFormation compares the actual configuration of the resource with its expected template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A stack is considered to have drifted if one or more of its resources differ from their expected template configurations. For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html">Detecting Unregulated Configuration Changes to Stacks and Resources</a>. Use <code>DetectStackDrift</code> to detect drift on all supported resources for a given stack, or <a>DetectStackResourceDrift</a> to detect drift on individual resources. For a list of stack resources that currently support drift detection, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html">Resources that Support Drift Detection</a>. <code>DetectStackDrift</code> can take up to several minutes, depending on the number of resources contained within the stack. Use <a>DescribeStackDriftDetectionStatus</a> to monitor the progress of a detect stack drift operation. Once the drift detection operation has completed, use <a>DescribeStackResourceDrifts</a> to return drift information about the stack and its resources. When detecting drift on a stack, AWS CloudFormation does not detect drift on any nested stacks belonging to that stack. Perform <code>DetectStackDrift</code> directly on the nested stack itself.' responses: '200': description: Success schema: $ref: '#/definitions/DetectStackDriftOutput' parameters: - name: body in: body required: true schema: $ref: '#/definitions/DetectStackDriftInput' parameters: - $ref: '#/parameters/Action' - $ref: '#/parameters/Version' - $ref: '#/parameters/X-Amz-Content-Sha256' - $ref: '#/parameters/X-Amz-Date' - $ref: '#/parameters/X-Amz-Algorithm' - $ref: '#/parameters/X-Amz-Credential' - $ref: '#/parameters/X-Amz-Security-Token' - $ref: '#/parameters/X-Amz-Signature' - $ref: '#/parameters/X-Amz-SignedHeaders' '/#DetectStackResourceDrift': post: operationId: DetectStackResourceDrift description: 'Returns 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. This information includes actual and expected property values for resources in which AWS CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information about stack and resource drift, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html">Detecting Unregulated Configuration Changes to Stacks and Resources</a>. Use <code>DetectStackResourceDrift</code> to detect drift on individual resources, or <a>DetectStackDrift</a> to detect drift on all resources in a given stack that support drift detection. Resources that do not currently support drift detection cannot be checked. For a list of resources that support drift detection, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html">Resources that Support Drift Detection</a>.' responses: '200': description: Success schema: $ref: '#/definitions/DetectStackResourceDriftOutput' parameters: - name: body in: body required: true schema: $ref: '#/definitions/DetectStackResourceDriftInput' parameters: - $ref: '#/parameters/Action' - $ref: '#/parameters/Version' - $ref: '#/parameters/X-Amz-Content-Sha256' - $ref: '#/parameters/X-Amz-Date' - $ref: '#/parameters/X-Amz-Algorithm' - $ref: '#/parameters/X-Amz-Credential' - $ref: '#/parameters/X-Amz-Security-Token' - $ref: '#/parameters/X-Amz-Signature' - $ref: '#/parameters/X-Amz-SignedHeaders' '/#EstimateTemplateCost': post: operationId: EstimateTemplateCost description: Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template. responses: '200': description: Success schema: $ref: '#/definitions/EstimateTemplateCostOutput' parameters: - name: body in: body required: true schema: $ref: '#/definitions/EstimateTemplateCostInput' parameters: - $ref: '#/parameters/Action' - $ref: '#/parameters/Version' - $ref: '#/parameters/X-Amz-Content-Sha256' - $ref: '#/parameters/X-Amz-Date' - $ref: '#/parameters/X-Amz-Algorithm' - $ref: '#/parameters/X-Amz-Credential' - $ref: '#/parameters/X-Amz-Security-Token' - $ref: '#/parameters/X-Amz-Signature' - $ref: '#/parameters/X-Amz-SignedHeaders' '/#ExecuteChangeSet': post: operationId: ExecuteChangeSet description: 'Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, AWS CloudFormation starts updating the stack. Use the <a>DescribeStacks</a> action to view the status of the update. When you execute a change set, AWS CloudFormation deletes all other change sets associated with the stack because they aren''t valid for the updated stack. If a stack policy is associated with the stack, AWS CloudFormation enforces the policy during the update. You can''t specify a temporary stack policy that overrides the current policy.' responses: '200': description: Success schema: $ref: '#/definitions/ExecuteChangeSetOutput' '480': description: InvalidChangeSetStatusException schema: $ref: '#/definitions/InvalidChangeSetStatusException' '481': description: ChangeSetNotFoundException schema: $ref: '#/definitions/ChangeSetNotFoundException' '482': description: InsufficientCapabilitiesException schema: $ref: '#/definitions/InsufficientCapabilitiesException' '483': description: TokenAlreadyExistsException schema: $ref: '#/definitions/TokenAlreadyExistsException' parameters: - name: body in: body required: true schema: $ref: '#/definitions/ExecuteChangeSetInput' parameters: - $ref: '#/parameters/Action' - $ref: '#/parameters/Version' - $ref: '#/parameters/X-Amz-Content-Sha256' - $ref: '#/parameters/X-Amz-Date' - $ref: '#/parameters/X-Amz-Algorithm' - $ref: '#/parameters/X-Amz-Credential' - $ref: '#/parameters/X-Amz-Security-Token' - $ref: '#/parameters/X-Amz-Signature' - $ref: '#/parameters/X-Amz-SignedHeaders' '/#GetStackPolicy': post: operationId: GetStackPolicy description: 'Returns the stack policy for a specified stack. If a stack doesn''t have a policy, a null value is returned.' responses: '200': description: Success schema: $ref: '#/definitions/GetStackPolicyOutput' parameters: - name: body in: body required: true schema: $ref: '#/definitions/GetStackPolicyInput' parameters: - $ref: '#/parameters/Action' - $ref: '#/parameters/Version' - $ref: '#/parameters/X-Amz-Content-Sha256' - $ref: '#/parameters/X-Amz-Date' - $ref: '#/parameters/X-Amz-Algorithm' - $ref: '#/parameters/X-Amz-Credential' - $ref: '#/parameters/X-Amz-Security-Token' - $ref: '#/parameters/X-Amz-Signature' - $ref: '#/parameters/X-Amz-SignedHeaders' '/#GetTemplate': post: operationId: GetTemplate description: 'Returns the template body for a specified stack. You can get the template for running or deleted stacks. For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted. <note> If the template does not exist, a <code>ValidationError</code> is returned. </note>' responses: '200': description: Success schema: $ref: '#/definitions/GetTemplateOutput' '480': description: ChangeSetNotFoundException schema: $ref: '#/definitions/ChangeSetNotFoundException' parameters: - name: body in: body required: true schema: $ref: '#/definitions/GetTemplateInput' parameters: - $ref: '#/parameters/Action' - $ref: '#/parameters/Version' - $ref: '#/parameters/X-Amz-Content-Sha256' - $ref: '#/parameters/X-Amz-Date' - $ref: '#/parameters/X-Amz-Algorithm' - $ref: '#/parameters/X-Amz-Credential' - $ref: '#/parameters/X-Amz-Security-Token' - $ref: '#/parameters/X-Amz-Signature' - $ref: '#/parameters/X-Amz-SignedHeaders' '/#GetTemplateSummary': post: operationId: GetTemplateSummary description: 'Returns information about a new or existing template. The <code>GetTemplateSummary</code> action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack or stack set. You can use the <code>GetTemplateSummary</code> action when you submit a template, or you can get template information for a stack set, or a running or deleted stack. For deleted stacks, <code>GetTemplateSummary</code> returns the template information for up to 90 days after the stack has been deleted. If the template does not exist, a <code>ValidationError</code> is returned.' responses: '200': description: Success schema: $ref: '#/definitions/GetTemplateSummaryOutput' '480': description: StackSetNotFoundException schema: $ref: '#/definitions/StackSetNotFoundException' parameters: - name: body in: body required: true schema: $ref: '#/definitions/GetTemplateSummaryInput' parameters: - $ref: '#/parameters/Action' - $ref: '#/parameters/Version' - $ref: '#/parameters/X-Amz-Content-Sha256' - $ref: '#/parameters/X-Amz-Date' - $ref: '#/parameters/X-Amz-Algorithm' - $ref: '#/parameters/X-Amz-Credential' - $ref: '#/parameters/X-Amz-Security-Token' - $ref: '#/parameters/X-Amz-Signature' - $ref: '#/parameters/X-Amz-SignedHeaders' '/#ListChangeSets': post: operationId: ListChangeSets description: 'Returns the ID and status of each active change set for a stack. For example, AWS CloudFormation lists change sets that are in the <code>CREATE_IN_PROGRESS</code> or <code>CREATE_PENDING</code> state.' responses: '200': description: Success schema: $ref: '#/definitions/ListChangeSetsOutput' parameters: - name: body in: body required: true schema: $ref: '#/definitions/ListChangeSetsInput' parameters: - $ref: '#/parameters/Action' - $ref: '#/parameters/Version' - $ref: '#/parameters/X-Amz-Content-Sha256' - $ref: '#/parameters/X-Amz-Date' - $ref: '#/parameters/X-Amz-Algorithm' - $ref: '#/parameters/X-Amz-Credential' - $ref: '#/parameters/X-Amz-Security-Token' - $ref: '#/parameters/X-Amz-Signature' - $ref: '#/parameters/X-Amz-SignedHeaders' '/#ListExports': post: operationId: ListExports description: 'Lists all exported output values in the account and region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html"> <code>Fn::ImportValue</code> </a> function. For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-exports.html"> AWS CloudFormation Export Stack Output Values</a>.' responses: '200': description: Success schema: $ref: '#/definitions/ListExportsOutput' parameters: - name: body in: body required: true schema: $ref: '#/definitions/ListExportsInput' - name: NextToken type: string in: query description: Pagination token required: false parameters: - $ref: '#/parameters/Action' - $ref: '#/parameters/Version' - $ref: '#/parameters/X-Amz-Content-Sha256' - $ref: '#/parameters/X-Amz-Date' - $ref: '#/parameters/X-Amz-Algorithm' - $ref: '#/parameters/X-Amz-Credential' - $ref: '#/parameters/X-Amz-Security-Token' - $ref: '#/parameters/X-Amz-Signature' - $ref: '#/parameters/X-Amz-SignedHeaders' '/#ListImports': post: operationId: ListImports description: 'Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first use this action to see which stacks are using it. To see the exported output values in your account, see <a>ListExports</a>. For more information about importing an exported output value, see the <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html"> <code>Fn::ImportValue</code> </a> function. ' responses: '200': description: Success schema: $ref: '#/definitions/ListImportsOutput' parameters: - name: body in: body required: true schema: $ref: '#/definitions/ListImportsInput' - name: NextToken type: string in: query description: Pagination token required: false parameters: - $ref: '#/parameters/Action' - $ref: '#/parameters/Version' - $ref: '#/parameters/X-Amz-Content-Sha256' - $ref: '#/parameters/X-Amz-Date' - $ref: '#/parameters/X-Amz-Algorithm' - $ref: '#/parameters/X-Amz-Credential' - $ref: '#/parameters/X-Amz-Security-Token' - $ref: '#/parameters/X-Amz-Signature' - $ref: '#/parameters/X-Amz-SignedHeaders' '/#ListStackInstances': post: operationId: ListStackInstances description: Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific AWS account name or region. r