openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 799 kB

JSON

{"openapi":"3.0.0","info":{"version":"2010-05-15","x-release":"v4","title":"AWS CloudFormation","description":"<fullname>CloudFormation</fullname> CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and repeatedly. You can use CloudFormation to leverage Amazon Web Services 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 Amazon Web Services infrastructure. With CloudFormation, you declare all your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you. For more information about CloudFormation, see the <a href=\"http://aws.amazon.com/cloudformation/\">CloudFormation product page</a>. CloudFormation makes use of other Amazon Web Services products. If you need additional technical information about a specific Amazon Web Services product, you can find the product's technical documentation at <a href=\"https://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-driver":"external"}],"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://docs.aws.amazon.com/cloudformation/"},"servers":[{"url":"http://cloudformation.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The AWS CloudFormation multi-region endpoint"},{"url":"https://cloudformation.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The AWS CloudFormation multi-region endpoint"},{"url":"http://cloudformation.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The AWS CloudFormation endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://cloudformation.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The AWS CloudFormation endpoint for China (Beijing) and China (Ningxia)"}],"x-hasEquivalentPaths":true,"paths":{"/#Action=ActivateOrganizationsAccess":{"get":{"x-aws-operation-name":"ActivateOrganizationsAccess","operationId":"GET_ActivateOrganizationsAccess","description":"Activate trusted access with Organizations. With trusted access between StackSets and Organizations activated, the management account has permissions to create and manage StackSets for your organization.","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ActivateOrganizationsAccessOutput"}}}},"480":{"description":"InvalidOperationException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidOperationException"}}}},"481":{"description":"OperationNotFoundException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/OperationNotFoundException"}}}}},"parameters":[{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["ActivateOrganizationsAccess"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2010-05-15"]}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"post":{"x-aws-operation-name":"ActivateOrganizationsAccess","operationId":"POST_ActivateOrganizationsAccess","description":"Activate trusted access with Organizations. With trusted access between StackSets and Organizations activated, the management account has permissions to create and manage StackSets for your organization.","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ActivateOrganizationsAccessOutput"}}}},"480":{"description":"InvalidOperationException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidOperationException"}}}},"481":{"description":"OperationNotFoundException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/OperationNotFoundException"}}}}},"requestBody":{"content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ActivateOrganizationsAccessInput"}}}},"parameters":[{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["ActivateOrganizationsAccess"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2010-05-15"]}}]}},"/#Action=ActivateType":{"get":{"x-aws-operation-name":"ActivateType","operationId":"GET_ActivateType","description":"Activates a public third-party extension, making it available for use in stack templates. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html\">Using public extensions</a> in the CloudFormation User Guide. Once you have activated a public third-party extension in your account and Region, use <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html\">SetTypeConfiguration</a> to specify configuration properties for the extension. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration\">Configuring extensions at the account level</a> in the CloudFormation User Guide.","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ActivateTypeOutput"}}}},"480":{"description":"CFNRegistryException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/CFNRegistryException"}}}},"481":{"description":"TypeNotFoundException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/TypeNotFoundException"}}}}},"parameters":[{"name":"Type","in":"query","required":false,"description":"The extension type. Conditional: You must specify <code>PublicTypeArn</code>, or <code>TypeName</code>, <code>Type</code>, and <code>PublisherId</code>.","schema":{"type":"string","enum":["RESOURCE","MODULE","HOOK"]}},{"name":"PublicTypeArn","in":"query","required":false,"description":"The Amazon Resource Name (ARN) of the public extension. Conditional: You must specify <code>PublicTypeArn</code>, or <code>TypeName</code>, <code>Type</code>, and <code>PublisherId</code>.","schema":{"type":"string","pattern":"arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}::type/.+/[0-9a-zA-Z]{12,40}/.+","maxLength":1024}},{"name":"PublisherId","in":"query","required":false,"description":"The ID of the extension publisher. Conditional: You must specify <code>PublicTypeArn</code>, or <code>TypeName</code>, <code>Type</code>, and <code>PublisherId</code>.","schema":{"type":"string","pattern":"[0-9a-zA-Z]{12,40}","minLength":1,"maxLength":40}},{"name":"TypeName","in":"query","required":false,"description":"The name of the extension. Conditional: You must specify <code>PublicTypeArn</code>, or <code>TypeName</code>, <code>Type</code>, and <code>PublisherId</code>.","schema":{"type":"string","pattern":"[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}","minLength":10,"maxLength":204}},{"name":"TypeNameAlias","in":"query","required":false,"description":"An alias to assign to the public extension, in this account and Region. If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and Region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console. An extension alias must be unique within a given account and Region. You can activate the same public resource multiple times in the same account and Region, using different type name aliases.","schema":{"type":"string","pattern":"[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}","minLength":10,"maxLength":204}},{"name":"AutoUpdate","in":"query","required":false,"description":"Whether to automatically update the extension in this account and Region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated. The default is <code>true</code>.","schema":{"type":"boolean"}},{"name":"LoggingConfig","in":"query","required":false,"description":"Contains logging configuration information for an extension.","schema":{"type":"object","required":["LogRoleArn","LogGroupName"],"properties":{"LogRoleArn":{"allOf":[{"$ref":"#/components/schemas/RoleArn"},{"description":"The Amazon Resource Name (ARN) of the role that CloudFormation should assume when sending log entries to CloudWatch Logs."}]},"LogGroupName":{"allOf":[{"$ref":"#/components/schemas/LogGroupName"},{"description":"The Amazon CloudWatch Logs group to which CloudFormation sends error logging information when invoking the extension's handlers."}]}},"description":"Contains logging configuration information for an extension."}},{"name":"ExecutionRoleArn","in":"query","required":false,"description":"The name of the IAM execution role to use to activate the extension.","schema":{"type":"string","pattern":"arn:.+:iam::[0-9]{12}:role/.+","minLength":1,"maxLength":256}},{"name":"VersionBump","in":"query","required":false,"description":"Manually updates a previously-activated type to a new major or minor version, if available. You can also use this parameter to update the value of <code>AutoUpdate</code>. <ul> <li> <code>MAJOR</code>: CloudFormation updates the extension to the newest major version, if one is available. </li> <li> <code>MINOR</code>: CloudFormation updates the extension to the newest minor version, if one is available. </li> </ul>","schema":{"type":"string","enum":["MAJOR","MINOR"]}},{"name":"MajorVersion","in":"query","required":false,"description":"The major version of this extension you want to activate, if multiple major versions are available. The default is the latest major version. CloudFormation uses the latest available minor version of the major version selected. You can specify <code>MajorVersion</code> or <code>VersionBump</code>, but not both.","schema":{"type":"integer","minimum":1,"maximum":100000}},{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["ActivateType"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2010-05-15"]}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"post":{"x-aws-operation-name":"ActivateType","operationId":"POST_ActivateType","description":"Activates a public third-party extension, making it available for use in stack templates. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html\">Using public extensions</a> in the CloudFormation User Guide. Once you have activated a public third-party extension in your account and Region, use <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html\">SetTypeConfiguration</a> to specify configuration properties for the extension. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration\">Configuring extensions at the account level</a> in the CloudFormation User Guide.","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ActivateTypeOutput"}}}},"480":{"description":"CFNRegistryException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/CFNRegistryException"}}}},"481":{"description":"TypeNotFoundException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/TypeNotFoundException"}}}}},"requestBody":{"content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ActivateTypeInput"}}}},"parameters":[{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["ActivateType"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2010-05-15"]}}]}},"/#Action=BatchDescribeTypeConfigurations":{"get":{"x-aws-operation-name":"BatchDescribeTypeConfigurations","operationId":"GET_BatchDescribeTypeConfigurations","description":"Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and Region. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration\">Configuring extensions at the account level</a> in the CloudFormation User Guide.","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/BatchDescribeTypeConfigurationsOutput"}}}},"480":{"description":"TypeConfigurationNotFoundException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/TypeConfigurationNotFoundException"}}}},"481":{"description":"CFNRegistryException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/CFNRegistryException"}}}}},"parameters":[{"name":"TypeConfigurationIdentifiers","in":"query","required":true,"description":"The list of identifiers for the desired extension configurations.","schema":{"type":"array","items":{"$ref":"#/components/schemas/TypeConfigurationIdentifier"},"minItems":1}},{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["BatchDescribeTypeConfigurations"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2010-05-15"]}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"post":{"x-aws-operation-name":"BatchDescribeTypeConfigurations","operationId":"POST_BatchDescribeTypeConfigurations","description":"Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and Region. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration\">Configuring extensions at the account level</a> in the CloudFormation User Guide.","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/BatchDescribeTypeConfigurationsOutput"}}}},"480":{"description":"TypeConfigurationNotFoundException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/TypeConfigurationNotFoundException"}}}},"481":{"description":"CFNRegistryException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/CFNRegistryException"}}}}},"requestBody":{"content":{"text/xml":{"schema":{"$ref":"#/components/schemas/BatchDescribeTypeConfigurationsInput"}}}},"parameters":[{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["BatchDescribeTypeConfigurations"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2010-05-15"]}}]}},"/#Action=CancelUpdateStack":{"get":{"x-aws-operation-name":"CancelUpdateStack","operationId":"GET_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 <code>UPDATE_IN_PROGRESS</code> state. </note>","responses":{"200":{"description":"Success"},"480":{"description":"TokenAlreadyExistsException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/TokenAlreadyExistsException"}}}}},"parameters":[{"name":"StackName","in":"query","required":true,"description":"<note> If you don't pass a parameter to <code>StackName</code>, the API returns a response that describes all resources in the account. The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and avoid returning a response when no parameter is sent in the request: <code>{ \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Deny\", \"Action\": \"cloudformation:DescribeStacks\", \"NotResource\": \"arn:aws:cloudformation:*:*:stack/*/*\" }] }</code> </note> The name or the unique stack ID that's associated with the stack.","schema":{"type":"string"}},{"name":"ClientRequestToken","in":"query","required":false,"description":"A unique identifier for this <code>CancelUpdateStack</code> request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to cancel an update on a stack with the same name. You might retry <code>CancelUpdateStack</code> requests to ensure that CloudFormation successfully received them.","schema":{"type":"string","pattern":"[a-zA-Z0-9][-a-zA-Z0-9]*","minLength":1,"maxLength":128}},{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["CancelUpdateStack"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2010-05-15"]}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"post":{"x-aws-operation-name":"CancelUpdateStack","operationId":"POST_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 <code>UPDATE_IN_PROGRESS</code> state. </note>","responses":{"200":{"description":"Success"},"480":{"description":"TokenAlreadyExistsException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/TokenAlreadyExistsException"}}}}},"requestBody":{"content":{"text/xml":{"schema":{"$ref":"#/components/schemas/CancelUpdateStackInput"}}}},"parameters":[{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["CancelUpdateStack"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2010-05-15"]}}]}},"/#Action=ContinueUpdateRollback":{"get":{"x-aws-operation-name":"ContinueUpdateRollback","operationId":"GET_ContinueUpdateRollback","description":"For a specified stack that's 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=\"https://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 CloudFormation can't roll back all changes after a failed stack update. For example, you might have a stack that's rolling back to an old database instance that was deleted outside of CloudFormation. Because 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","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ContinueUpdateRollbackOutput"}}}},"480":{"description":"TokenAlreadyExistsException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/TokenAlreadyExistsException"}}}}},"parameters":[{"name":"StackName","in":"query","required":true,"description":"The name or the unique ID of the stack that you want to continue rolling back. <note> Don't specify the name of a nested stack (a stack that was created by using the <code>AWS::CloudFormation::Stack</code> resource). Instead, use this operation on the parent stack (the stack that contains the <code>AWS::CloudFormation::Stack</code> resource). </note>","schema":{"type":"string","pattern":"([a-zA-Z][-a-zA-Z0-9]*)|(arn:\\b(aws|aws-us-gov|aws-cn)\\b:[-a-zA-Z0-9:/._+]*)","minLength":1}},{"name":"RoleARN","in":"query","required":false,"description":"The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to roll back the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least permission. If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.","schema":{"type":"string","minLength":20,"maxLength":2048}},{"name":"ResourcesToSkip","in":"query","required":false,"description":"A list of the logical IDs of the resources that CloudFormation skips during the continue update rollback operation. You can specify only resources that are in the <code>UPDATE_FAILED</code> state because a rollback failed. You can't specify resources that are in the <code>UPDATE_FAILED</code> state for other reasons, for example, because an update was canceled. To check why a resource update failed, use the <a>DescribeStackResources</a> action, and view the resource status reason. <important> Specify this property to skip rolling back resources that CloudFormation can't successfully roll back. We recommend that you <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed\"> troubleshoot</a> resources before skipping them. CloudFormation sets the status of the specified resources to <code>UPDATE_COMPLETE</code> and continues to roll back the stack. After the rollback is complete, the state of the skipped resources will be inconsistent with the state of the resources in the stack template. Before performing another stack update, you must update the stack or resources to be consistent with each other. If you don't, subsequent stack updates might fail, and the stack will become unrecoverable. </important> Specify the minimum number of resources required to successfully roll back your stack. For example, a failed resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the dependent resources. To skip resources that are part of nested stacks, use the following format: <code>NestedStackName.ResourceLogicalID</code>. If you want to specify the logical ID of a stack resource (<code>Type: AWS::CloudFormation::Stack</code>) in the <code>ResourcesToSkip</code> list, then its corresponding embedded stack must be in one of the following states: <code>DELETE_IN_PROGRESS</code>, <code>DELETE_COMPLETE</code>, or <code>DELETE_FAILED</code>. <note> Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an example of a continue update rollback operation with nested stacks, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html#nested-stacks\">Using ResourcesToSkip to recover a nested stacks hierarchy</a>. </note>","schema":{"type":"array","items":{"$ref":"#/components/schemas/ResourceToSkip"}}},{"name":"ClientRequestToken","in":"query","required":false,"description":"A unique identifier for this <code>ContinueUpdateRollback</code> request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to continue the rollback to a stack with the same name. You might retry <code>ContinueUpdateRollback</code> requests to ensure that CloudFormation successfully received them.","schema":{"type":"string","pattern":"[a-zA-Z0-9][-a-zA-Z0-9]*","minLength":1,"maxLength":128}},{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["ContinueUpdateRollback"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2010-05-15"]}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"post":{"x-aws-operation-name":"ContinueUpdateRollback","operationId":"POST_ContinueUpdateRollback","description":"For a specified stack that's 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=\"https://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 CloudFormation can't roll back all changes after a failed stack update. For example, you might have a stack that's rolling back to an old database instance that was deleted outside of CloudFormation. Because 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","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ContinueUpdateRollbackOutput"}}}},"480":{"description":"TokenAlreadyExistsException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/TokenAlreadyExistsException"}}}}},"requestBody":{"content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ContinueUpdateRollbackInput"}}}},"parameters":[{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["ContinueUpdateRollback"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2010-05-15"]}}]}},"/#Action=CreateChangeSet":{"get":{"x-aws-operation-name":"CreateChangeSet","operationId":"GET_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 CloudFormation will create. If you create a change set for an existing stack, 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 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. To create a change set for an import operation, specify <code>IMPORT</code> for the <code>ChangeSetType</code> parameter. After the <code>CreateChangeSet</code> call successfully completes, 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. CloudFormation doesn't make changes until you execute the change set. To create a change set for the entire stack hierarchy, set <code>IncludeNestedStacks</code> to <code>True</code>.","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/CreateChangeSetOutput"}}}},"480":{"description":"AlreadyExistsException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/AlreadyExistsException"}}}},"481":{"description":"InsufficientCapabilitiesException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InsufficientCapabilitiesException"}}}},"482":{"description":"LimitExceededException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}}},"parameters":[{"name":"StackName","in":"query","required":true,"description":"The name or the unique ID of the stack for which you are creating a change set. CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values.","schema":{"type":"string","pattern":"([a-zA-Z][-a-zA-Z0-9]*)|(arn:\\b(aws|aws-us-gov|aws-cn)\\b:[-a-zA-Z0-9:/._+]*)","minLength":1}},{"name":"TemplateBody","in":"query","required":false,"description":"A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. CloudFormation generates the change set by comparing this template with the template of the stack that you specified. Conditional: You must specify only <code>TemplateBody</code> or <code>TemplateURL</code>.","schema":{"type":"string","minLength":1}},{"name":"TemplateURL","in":"query","required":false,"description":"The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation generates the change set by comparing this template with the stack that you specified. Conditional: You must specify only <code>TemplateBody</code> or <code>TemplateURL</code>.","schema":{"type":"string","minLength":1,"maxLength":1024}},{"name":"UsePreviousTemplate","in":"query","required":false,"description":"Whether to reuse the template that's associated with the stack to create the change set.","schema":{"type":"boolean"}},{"name":"Parameters","in":"query","required":false,"description":"A list of <code>Parameter</code> structures that specify input parameters for the change set. For more information, see the <a>Parameter</a> data type.","schema":{"type":"array","items":{"$ref":"#/components/schemas/Parameter"}}},{"name":"Capabilities","in":"query","required":false,"description":"In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack. <ul> <li> <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code> Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities. The following IAM resources require you to specify either the <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code> capability. <ul> <li> If you have IAM resources, you can specify either capability. </li> <li> If you have IAM resources with custom names, you must specify <code>CAPABILITY_NAMED_IAM</code>. </li> <li> If you don't specify either of these capabilities, CloudFormation returns an <code>InsufficientCapabilities</code> error. </li> </ul> If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary. <ul> <li> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html\"> AWS::IAM::AccessKey</a> </li> <li> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html\"> AWS::IAM::Group</a> </li> <li> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html\">AWS::IAM::InstanceProfile</a> </li> <li> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html\"> AWS::IAM::Policy</a> </li> <li> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html\"> AWS::IAM::Role</a> </li> <li> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html\"> AWS::IAM::User</a> </li> <li> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html\">AWS::IAM::UserToGroupAddition</a> </li> </ul> For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities\">Acknowledging IAM resources in CloudFormation templates</a>. </li> <li> <code>CAPABILITY_AUTO_EXPAND</code> Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html\">AWS::Include</a> and <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html\">AWS::Serverless</a> transforms, which are macros hosted by CloudFormation. <note> This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no effect. If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the <a>CreateStack</a> or <a>UpdateStack</a> action, and specifying this capability. </note> For more information about macros, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html\">Using CloudFormation macros to perform custom processing on templates</a>. </li> </ul>","schema":{"type":"array","items":{"$ref":"#/components/schemas/Capability"}}},{"name":"ResourceTypes","in":"query","required":false,"description":"The template resource types that you have permissions to work with if you execute this change set, such as <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or <code>Custom::MyCustomInstance</code>. If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for CloudFormation. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html\">Controlling access with Identity and Access Management</a> in the CloudFormation User Guide.","schema":{"type":"array","items":{"$ref":"#/components/schemas/ResourceType"}}},{"name":"RoleARN","in":"query","required":false,"description":"The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes when executing the change set. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least permission. If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.","schema":{"type":"string","minLength":20,"maxLength":2048}},{"name":"RollbackConfiguration","in":"query","required":false,"description":"The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.","schema":{"type":"object","properties":{"RollbackTriggers":{"allOf":[{"$ref":"#/components/schemas/RollbackTriggers"},{"description":"The triggers to monitor during stack creation or update actions. By default, CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those triggers replace any list of triggers previously specified for the stack. This means: <ul> <li> To use the rollback triggers previously specified for this stack, if any, don't specify this parameter. </li> <li> To specify new or updated rollback triggers, you must specify all the triggers that you want used for this stack, even triggers you've specified before (for example, when creating the stack or during a previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied to the stack. </li> <li> To remove all currently specified triggers, specify an empty list for this parameter. </li> </ul> If a specified trigger is missing, the entire stack operation fails and is rolled back."}]},"MonitoringTimeInMinutes":{"allOf":[{"$ref":"#/components/schemas/MonitoringTimeInMinutes"},{"description":"The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources. The default is 0 minutes. If you specify a monitoring period but don't specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CancelUpdateStack.html\">CancelUpdateStack</a>, for example) as necessary. If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes."}]}},"description":"Structure containing the rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards. Rollback triggers enable you to have CloudFormation monitor the state of your application during stack creation and updating, and to roll back that operation if the application breaches the threshold of any of the alarms you've specified. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-rollback-triggers.html\">Monitor and Roll Back Stack Operations</a>."}},{"name":"NotificationARNs","in":"query","required":false,"description":"The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.","schema":{"type":"array","items":{"$ref":"#/components/schemas/NotificationARN"},"maxItems":5}},{"name":"Tags","in":"query","required":false,"description":"Key-value pairs to associate with this stack. CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 50 tags.","schema":{"type":"array","items":{"$ref":"#/components/schemas/Tag"},"maxItems":50}},{"name":"ChangeSetName","in":"query","required":true,"description":"The name of the change set. The name must be unique among all change sets that are associated with the specified stack. A change set name can contain only alphanumeric, case sensitive characters, and hyphens. It must start with an alphabetical character and can't exceed 128 characters.","schema":{"type":"string","pattern":"[a-zA-Z][-a-zA-Z0-9]*","minLength":1,"maxLength":128}},{"name":"ClientToken","in":"query","required":false,"description":"A unique identifier for this <code>CreateChangeSet</code> request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to create another change set with the same name. You might retry <code>CreateChangeSet</code> requests to ensure that CloudFormation successfully received them.","schema":{"type":"string","minLength":1,"maxLength":128}},{"name":"Description","in":"query","required":false,"description":"A description to help you identify this change set.","schema":{"type":"string","minLength":1,"maxLength":1024}},{"name":"ChangeSetType","in":"query","required":false,"description":"The type of change set operation. To create a change set for a new stack, specify <code>CREATE</code>. To create a change set for an existing stack, specify <code>UPDATE</code>. To create a change set for an import operation, specify <code>IMPORT</code>. If you create a change set for a new stack, CloudFormation creates a stack with a unique stack ID, but no template or resources. The stack will be in the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-describing-stacks.html#d0e11995\">REVIEW_IN_PROGRESS</a> state until you execute the change set. By default, CloudFormation specifies <code>UPDATE</code>. You can't use the <code>UPDATE</code> type to create a change set for a new stack or the <code>CREATE</code> type to create a change set for an existing stack.","schema":{"type":"string","enum":["CREATE","UPDATE","IMPORT"]}},{"name":"ResourcesToImport","in":"query","required":false,"description":"The resources to import into your stack.","schema":{"type":"array","items":{"$ref":"#/components/schemas/ResourceToImport"},"maxItems":200}},{"name":"IncludeNestedStacks","in":"query","required":false,"description":"Creates a change set for the all nested stacks specified in the template. The default behavior of this action is set to <code>False</code>. To include nested sets in a change set, specify <code>True</code>.","schema":{"type":"boolean"}},{"name":"OnStackFailure","in":"query","required":false,"description":"Determines what action will be taken if stack creation fails. If this parameter is specified, the <code>DisableRollback</code> parameter to the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html\">ExecuteChangeSet</a> API operation must not be specified. This must be one of these values: <ul> <li> <code>DELETE</code> - Deletes the change set if the stack creation fails. This is only valid when the <code>ChangeSetType</code> parameter is set to <code>CREATE</code>. If the deletion of the stack fails, the status of the stack is <code>DELETE_FAILED</code>. </li> <li> <code>DO_NOTHING</code> - if the stack creation fails, do nothing. This is equivalent to specifying <code>true</code> for the <code>DisableRollback</code> parameter to the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html\">ExecuteChangeSet</a> API operation. </li> <li> <code>ROLLBACK</code> - if the stack creation fails, roll back the stack. This is equivalent to specifying <code>false</code> for the <code>DisableRollback</code> parameter to the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html\">ExecuteChangeSet</a> API operation. </li> </ul> For nested stacks, when the <code>OnStackFailure</code> parameter is set to <code>DELETE</code> for the change set for the parent stack, any failure in a child stack will cause the parent stack creation to fail and all stacks to be deleted.","schema":{"type":"string","enum":["DO_NOTHING","ROLLBACK","DELETE"]}},{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["CreateChangeSet"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2010-05-15"]}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"post":{"x-aws-operation-name":"CreateChangeSet","operationId":"POST_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 CloudFormation will create. If you create a change set for an existing stack, 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 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. To create a change set for an import operation, specify <code>IMPORT</code> for the <code>ChangeSetType</code> parameter. After the <code>CreateChangeSet</code> call successfully completes, 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. CloudFormation doesn't make changes until you execute the change set. To create a change set for the entire stack hierarchy, set <code>Inclu