|
895 | 895 | },
|
896 | 896 | "documentation":"<p>Returns descriptions of all resources of the specified stack.</p> <p>For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.</p>"
|
897 | 897 | },
|
| 898 | + "ListStackSetAutoDeploymentTargets":{ |
| 899 | + "name":"ListStackSetAutoDeploymentTargets", |
| 900 | + "http":{ |
| 901 | + "method":"POST", |
| 902 | + "requestUri":"/" |
| 903 | + }, |
| 904 | + "input":{"shape":"ListStackSetAutoDeploymentTargetsInput"}, |
| 905 | + "output":{ |
| 906 | + "shape":"ListStackSetAutoDeploymentTargetsOutput", |
| 907 | + "resultWrapper":"ListStackSetAutoDeploymentTargetsResult" |
| 908 | + }, |
| 909 | + "errors":[ |
| 910 | + {"shape":"StackSetNotFoundException"} |
| 911 | + ], |
| 912 | + "documentation":"<p>Returns summary information about deployment targets for a stack set.</p>" |
| 913 | + }, |
898 | 914 | "ListStackSetOperationResults":{
|
899 | 915 | "name":"ListStackSetOperationResults",
|
900 | 916 | "http":{
|
|
2058 | 2074 | },
|
2059 | 2075 | "Capabilities":{
|
2060 | 2076 | "shape":"Capabilities",
|
2061 |
| - "documentation":"<p>In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.</p> <ul> <li> <p> <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code> </p> <p>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.</p> <p>The following IAM resources require you to specify either the <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code> capability.</p> <ul> <li> <p>If you have IAM resources, you can specify either capability.</p> </li> <li> <p>If you have IAM resources with custom names, you <i>must</i> specify <code>CAPABILITY_NAMED_IAM</code>.</p> </li> <li> <p>If you don't specify either of these capabilities, CloudFormation returns an <code>InsufficientCapabilities</code> error.</p> </li> </ul> <p>If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html\"> <code>AWS::IAM::AccessKey</code> AWS::IAM::AccessKey</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html\"> <code>AWS::IAM::Group</code> </a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html\"> <code>AWS::IAM::InstanceProfile</code> </a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html\"> <code>AWS::IAM::Policy</code> </a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html\"> <code>AWS::IAM::Role</code> </a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html\"> <code>AWS::IAM::User</code> </a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html\"> <code>AWS::IAM::UserToGroupAddition</code> </a> </p> </li> </ul> <p>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>.</p> </li> <li> <p> <code>CAPABILITY_AUTO_EXPAND</code> </p> <p>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\"> <code>AWS::Include</code> </a> and <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html\"> <code>AWS::Serverless</code> </a> transforms, which are macros hosted by CloudFormation.</p> <p>If you want to create a stack from a stack template that contains macros <i>and</i> nested stacks, you must create the stack directly from the template using this capability.</p> <important> <p>You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.</p> <p>Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.</p> </important> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html\">Using CloudFormation macros to perform custom processing on templates</a>.</p> </li> </ul> <note> <p>Only one of the <code>Capabilities</code> and <code>ResourceType</code> parameters can be specified.</p> </note>" |
| 2077 | + "documentation":"<p>In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.</p> <ul> <li> <p> <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code> </p> <p>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.</p> <p>The following IAM resources require you to specify either the <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code> capability.</p> <ul> <li> <p>If you have IAM resources, you can specify either capability.</p> </li> <li> <p>If you have IAM resources with custom names, you <i>must</i> specify <code>CAPABILITY_NAMED_IAM</code>.</p> </li> <li> <p>If you don't specify either of these capabilities, CloudFormation returns an <code>InsufficientCapabilities</code> error.</p> </li> </ul> <p>If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html\"> <code>AWS::IAM::AccessKey</code> </a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html\"> <code>AWS::IAM::Group</code> </a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html\"> <code>AWS::IAM::InstanceProfile</code> </a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html\"> <code>AWS::IAM::Policy</code> </a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html\"> <code>AWS::IAM::Role</code> </a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html\"> <code>AWS::IAM::User</code> </a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html\"> <code>AWS::IAM::UserToGroupAddition</code> </a> </p> </li> </ul> <p>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>.</p> </li> <li> <p> <code>CAPABILITY_AUTO_EXPAND</code> </p> <p>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\"> <code>AWS::Include</code> </a> and <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html\"> <code>AWS::Serverless</code> </a> transforms, which are macros hosted by CloudFormation.</p> <p>If you want to create a stack from a stack template that contains macros <i>and</i> nested stacks, you must create the stack directly from the template using this capability.</p> <important> <p>You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.</p> <p>Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.</p> </important> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html\">Using CloudFormation macros to perform custom processing on templates</a>.</p> </li> </ul> <note> <p>Only one of the <code>Capabilities</code> and <code>ResourceType</code> parameters can be specified.</p> </note>" |
2062 | 2078 | },
|
2063 | 2079 | "ResourceTypes":{
|
2064 | 2080 | "shape":"ResourceTypes",
|
|
4301 | 4317 | },
|
4302 | 4318 | "documentation":"<p>The output for a <a>ListStackResources</a> action.</p>"
|
4303 | 4319 | },
|
| 4320 | + "ListStackSetAutoDeploymentTargetsInput":{ |
| 4321 | + "type":"structure", |
| 4322 | + "required":["StackSetName"], |
| 4323 | + "members":{ |
| 4324 | + "StackSetName":{ |
| 4325 | + "shape":"StackSetNameOrId", |
| 4326 | + "documentation":"<p>The name or unique ID of the stack set that you want to get automatic deployment targets for.</p>" |
| 4327 | + }, |
| 4328 | + "NextToken":{ |
| 4329 | + "shape":"NextToken", |
| 4330 | + "documentation":"<p>A string that identifies the next page of stack set deployment targets that you want to retrieve.</p>" |
| 4331 | + }, |
| 4332 | + "MaxResults":{ |
| 4333 | + "shape":"MaxResults", |
| 4334 | + "documentation":"<p>The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code> request parameter to get the next set of results.</p>" |
| 4335 | + }, |
| 4336 | + "CallAs":{ |
| 4337 | + "shape":"CallAs", |
| 4338 | + "documentation":"<p>Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for StackSets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html\">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p> </li> </ul>" |
| 4339 | + } |
| 4340 | + } |
| 4341 | + }, |
| 4342 | + "ListStackSetAutoDeploymentTargetsOutput":{ |
| 4343 | + "type":"structure", |
| 4344 | + "members":{ |
| 4345 | + "Summaries":{ |
| 4346 | + "shape":"StackSetAutoDeploymentTargetSummaries", |
| 4347 | + "documentation":"<p>An array of summaries of the deployment targets for the stack set.</p>" |
| 4348 | + }, |
| 4349 | + "NextToken":{ |
| 4350 | + "shape":"NextToken", |
| 4351 | + "documentation":"<p>If the request doesn't return all the remaining results, <code>NextToken</code> is set to a token. To retrieve the next set of results, call <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ListStackSetAutoDeploymentTargets.html\"> <code>ListStackSetAutoDeploymentTargets</code> </a> again and use that value for the <code>NextToken</code> parameter. If the request returns all results, <code>NextToken</code> is set to an empty string.</p>" |
| 4352 | + } |
| 4353 | + } |
| 4354 | + }, |
4304 | 4355 | "ListStackSetOperationResultsInput":{
|
4305 | 4356 | "type":"structure",
|
4306 | 4357 | "required":[
|
|
6224 | 6275 | "members":{
|
6225 | 6276 | "DetailedStatus":{
|
6226 | 6277 | "shape":"StackInstanceDetailedStatus",
|
6227 |
| - "documentation":"<ul> <li> <p> <code>CANCELLED</code>: The operation in the specified account and Region has been canceled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.</p> </li> <li> <p> <code>FAILED</code>: The operation in the specified account and Region failed. If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.</p> </li> <li> <p> <code>INOPERABLE</code>: A <code>DeleteStackInstances</code> operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further <code>UpdateStackSet</code> operations. You might need to perform a <code>DeleteStackInstances</code> operation, with <code>RetainStacks</code> set to <code>true</code>, to delete the stack instance, and then delete the stack manually.</p> </li> <li> <p> <code>PENDING</code>: The operation in the specified account and Region has yet to start.</p> </li> <li> <p> <code>RUNNING</code>: The operation in the specified account and Region is currently in progress.</p> </li> <li> <p> <code>SKIPPED_SUSPENDED_ACCOUNT</code>: The operation in the specified account and Region has been skipped because the account was suspended at the time of the operation.</p> </li> <li> <p> <code>SUCCEEDED</code>: The operation in the specified account and Region completed successfully.</p> </li> </ul>" |
| 6278 | + "documentation":"<ul> <li> <p> <code>CANCELLED</code>: The operation in the specified account and Region has been canceled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.</p> </li> <li> <p> <code>FAILED</code>: The operation in the specified account and Region failed. If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.</p> </li> <li> <p> <code>FAILED_IMPORT</code>: The import of the stack instance in the specified account and Region failed and left the stack in an unstable state. Once the issues causing the failure are fixed, the import operation can be retried. If enough stack set operations fail in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.</p> </li> <li> <p> <code>INOPERABLE</code>: A <code>DeleteStackInstances</code> operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further <code>UpdateStackSet</code> operations. You might need to perform a <code>DeleteStackInstances</code> operation, with <code>RetainStacks</code> set to <code>true</code>, to delete the stack instance, and then delete the stack manually.</p> </li> <li> <p> <code>PENDING</code>: The operation in the specified account and Region has yet to start.</p> </li> <li> <p> <code>RUNNING</code>: The operation in the specified account and Region is currently in progress.</p> </li> <li> <p> <code>SKIPPED_SUSPENDED_ACCOUNT</code>: The operation in the specified account and Region has been skipped because the account was suspended at the time of the operation.</p> </li> <li> <p> <code>SUCCEEDED</code>: The operation in the specified account and Region completed successfully.</p> </li> </ul>" |
6228 | 6279 | }
|
6229 | 6280 | },
|
6230 | 6281 | "documentation":"<p>The detailed status of the stack instance.</p>"
|
|
6785 | 6836 | "documentation":"<p>A structure that contains information about a stack set. A stack set enables you to provision stacks into Amazon Web Services accounts and across Regions by using a single CloudFormation template. In the stack set, you specify the template to use, in addition to any parameters and capabilities that the template requires.</p>"
|
6786 | 6837 | },
|
6787 | 6838 | "StackSetARN":{"type":"string"},
|
| 6839 | + "StackSetAutoDeploymentTargetSummaries":{ |
| 6840 | + "type":"list", |
| 6841 | + "member":{"shape":"StackSetAutoDeploymentTargetSummary"} |
| 6842 | + }, |
| 6843 | + "StackSetAutoDeploymentTargetSummary":{ |
| 6844 | + "type":"structure", |
| 6845 | + "members":{ |
| 6846 | + "OrganizationalUnitId":{ |
| 6847 | + "shape":"OrganizationalUnitId", |
| 6848 | + "documentation":"<p>The organization root ID or organizational unit (OU) IDs where the stack set is targeted.</p>" |
| 6849 | + }, |
| 6850 | + "Regions":{ |
| 6851 | + "shape":"RegionList", |
| 6852 | + "documentation":"<p>The list of Regions targeted for this organization or OU.</p>" |
| 6853 | + } |
| 6854 | + }, |
| 6855 | + "documentation":"<p>One of the targets for the stack set. Returned by the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ListStackSetAutoDeploymentTargets.html\"> <code>ListStackSetAutoDeploymentTargets</code> </a> API operation.</p>" |
| 6856 | + }, |
6788 | 6857 | "StackSetDriftDetectionDetails":{
|
6789 | 6858 | "type":"structure",
|
6790 | 6859 | "members":{
|
|
0 commit comments