awscli 1.40.17__py3-none-any.whl → 1.44.26__py3-none-any.whl

awscli/examples/cloudformation/describe-generated-template.rst

@@ -0,0 +1,62 @@
+**To describe a generated template**
+
+The following ``describe-generated-template`` example describes the specified template. ::
+
+    aws cloudformation describe-generated-template \
+        --generated-template-name MyTemplate
+
+Output::
+
+    {
+        "GeneratedTemplateId": "arn:aws:cloudformation:us-east-1:123456789012:generatedTemplate/7d881acf-f307-4ded-910e-f8fb49b96894",
+        "GeneratedTemplateName": "MyTemplate",
+        "Resources": [
+            {
+                "ResourceType": "AWS::EC2::SecurityGroup",
+                "LogicalResourceId": "EC2SecurityGroup",
+                "ResourceIdentifier": {
+                    "Id": "sg-1234567890abcdef0"
+                },
+                "ResourceStatus": "COMPLETE",
+                "ResourceStatusReason": "Resource Template complete",
+                "Warnings": []
+            },
+            {
+                "ResourceType": "AWS::EC2::Instance",
+                "LogicalResourceId": "EC2Instance",
+                "ResourceIdentifier": {
+                    "InstanceId": "i-1234567890abcdef0"
+                },
+                "ResourceStatus": "COMPLETE",
+                "ResourceStatusReason": "Resource Template complete",
+                "Warnings": []
+            },
+            {
+                "ResourceType": "AWS::EC2::KeyPair",
+                "LogicalResourceId": "EC2KeyPairSshkeypair",
+                "ResourceIdentifier": {
+                    "KeyName": "sshkeypair"
+                },
+                "ResourceStatus": "COMPLETE",
+                "ResourceStatusReason": "Resource Template complete",
+                "Warnings": []
+            }
+        ],
+        "Status": "COMPLETE",
+        "StatusReason": "All resources complete",
+        "CreationTime": "2025-09-23T19:38:06.435000+00:00",
+        "LastUpdatedTime": "2025-09-23T19:38:10.798000+00:00",
+        "Progress": {
+            "ResourcesSucceeded": 3,
+            "ResourcesFailed": 0,
+            "ResourcesProcessing": 0,
+            "ResourcesPending": 0
+        },
+        "TemplateConfiguration": {
+            "DeletionPolicy": "RETAIN",
+            "UpdateReplacePolicy": "RETAIN"
+        },
+        "TotalWarnings": 0
+    }
+
+For more information, see `Generating templates from existing resources <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/generate-IaC.html>`__ in the *AWS CloudFormation User Guide*.

awscli/examples/cloudformation/describe-resource-scan.rst

@@ -0,0 +1,38 @@
+**To describe a resource scan**
+
+The following ``describe-resource-scan`` example describes the resource scan with the specified scan ID. ::
+
+    aws cloudformation describe-resource-scan --region \
+        --resource-scan-id arn:aws:cloudformation:us-east-1:123456789012:resourceScan/0a699f15-489c-43ca-a3ef-3e6ecfa5da60
+
+Output::
+
+    {
+        "ResourceScanId": "arn:aws:cloudformation:us-east-1:123456789012:resourceScan/0a699f15-489c-43ca-a3ef-3e6ecfa5da60",
+        "Status": "COMPLETE",
+        "StartTime": "2025-08-21T03:10:38.485000+00:00",
+        "EndTime": "2025-08-21T03:20:28.485000+00:00",
+        "PercentageCompleted": 100.0,
+        "ResourceTypes": [
+            "AWS::CloudFront::CachePolicy",
+            "AWS::CloudFront::OriginRequestPolicy",
+            "AWS::EC2::DHCPOptions",
+            "AWS::EC2::InternetGateway",
+            "AWS::EC2::KeyPair",
+            "AWS::EC2::NetworkAcl",
+            "AWS::EC2::NetworkInsightsPath",
+            "AWS::EC2::NetworkInterface",
+            "AWS::EC2::PlacementGroup",
+            "AWS::EC2::Route",
+            "AWS::EC2::RouteTable",
+            "AWS::EC2::SecurityGroup",
+            "AWS::EC2::Subnet",
+            "AWS::EC2::SubnetCidrBlock",
+            "AWS::EC2::SubnetNetworkAclAssociation",
+            "AWS::EC2::SubnetRouteTableAssociation",
+            ...
+        ],
+        "ResourcesRead": 676
+    }
+
+For more information, see `Generating templates from existing resources <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/generate-IaC.html>`__ in the *AWS CloudFormation User Guide*.

awscli/examples/cloudformation/describe-stack-refactor.rst

@@ -0,0 +1,20 @@
+**To describe a stack refactor operation**
+
+The following ``describe-stack-refactor`` example describes the stack refactor operation with the specified stack refactor ID. ::
+
+    aws cloudformation describe-stack-refactor \
+        --stack-refactor-id 9c384f70-4e07-4ed7-a65d-fee5eb430841
+
+Output::
+
+    {
+        "StackRefactorId": "9c384f70-4e07-4ed7-a65d-fee5eb430841",
+        "StackIds": [
+            "arn:aws:cloudformation:us-east-1:123456789012:stack/Stack1/3e6a1ff0-94b1-11f0-aa6f-0a88d2e03acf",
+            "arn:aws:cloudformation:us-east-1:123456789012:stack/Stack2/5da91650-94b1-11f0-81cf-0a23500e151b"
+        ],
+        "ExecutionStatus": "AVAILABLE",
+        "Status": "CREATE_COMPLETE"
+    }
+
+For more information, see `Stack refactoring <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-refactoring.html>`__ in the *AWS CloudFormation User Guide*.

awscli/examples/cloudformation/execute-stack-refactor.rst

@@ -0,0 +1,10 @@
+**To complete a stack refactor operation**
+
+The following ``execute-stack-refactor`` example completes the stack refactor operation with the specified stack refactor ID. ::
+
+    aws cloudformation execute-stack-refactor \
+        --stack-refactor-id 9c384f70-4e07-4ed7-a65d-fee5eb430841
+
+This command produces no output.
+
+For more information, see `Stack refactoring <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-refactoring.html>`__ in the *AWS CloudFormation User Guide*.

awscli/examples/cloudformation/list-generated-templates.rst

@@ -0,0 +1,41 @@
+**To list generated templates**
+
+The following ``list-generated-templates`` example lists all generated templates. ::
+
+    aws cloudformation list-generated-templates
+
+Output::
+
+    {
+        "Summaries": [
+            {
+                "GeneratedTemplateId": "arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/7fc8512c-d8cb-4e02-b266-d39c48344e48",
+                "GeneratedTemplateName": "MyTemplate",
+                "Status": "COMPLETE",
+                "StatusReason": "All resources complete",
+                "CreationTime": "2025-09-23T20:13:24.283000+00:00",
+                "LastUpdatedTime": "2025-09-23T20:13:28.610000+00:00",
+                "NumberOfResources": 4
+            },
+            {
+                "GeneratedTemplateId": "arn:aws:cloudformation:us-east-1:123456789012:generatedTemplate/f10dd1c4-edc6-4823-8153-ab6112b8d051",
+                "GeneratedTemplateName": "MyEC2InstanceTemplate",
+                "Status": "COMPLETE",
+                "StatusReason": "All resources complete",
+                "CreationTime": "2024-08-08T19:35:49.790000+00:00",
+                "LastUpdatedTime": "2024-08-08T19:35:52.207000+00:00",
+                "NumberOfResources": 3
+            },
+            {
+                "GeneratedTemplateId": "arn:aws:cloudformation:us-east-1:123456789012:generatedTemplate/e5a1c89f-7ce2-41bd-9bdf-75b7c852e3ca",
+                "GeneratedTemplateName": "MyEKSNodeGroupTemplate",
+                "Status": "COMPLETE",
+                "StatusReason": "All resources complete",
+                "CreationTime": "2024-07-16T20:39:27.883000+00:00",
+                "LastUpdatedTime": "2024-07-16T20:39:35.766000+00:00",
+                "NumberOfResources": 4
+            }
+        ]
+    }
+
+For more information, see `Generating templates from existing resources <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/generate-IaC.html>`__ in the *AWS CloudFormation User Guide*.

awscli/examples/cloudformation/list-resource-scan-related-resources.rst

@@ -0,0 +1,47 @@
+**To list related resources from a resource scan**
+
+The following ``list-resource-scan-related-resources`` example lists resources from the specified resource scan that are related to resources in ``resources.json``. ::
+
+    aws cloudformation list-resource-scan-related-resources \
+        --resource-scan-id arn:aws:cloudformation:us-east-1:123456789012:resourceScan/0a699f15-489c-43ca-a3ef-3e6ecfa5da60 \
+        --resources file://resources.json
+
+Contents of ``resources.json``::
+
+    [
+        {
+            "ResourceType": "AWS::EKS::Cluster",
+            "ResourceIdentifier": {
+                "ClusterName": "MyAppClusterName"
+            }
+        },
+        {
+            "ResourceType": "AWS::AutoScaling::AutoScalingGroup",
+            "ResourceIdentifier": {
+                "AutoScalingGroupName": "MyAppASGName"
+            }
+        }
+    ]
+
+Output::
+
+    {
+        "RelatedResources": [
+            {
+                "ResourceType": "AWS::EKS::Nodegroup",
+                "ResourceIdentifier": {
+                    "NodegroupName": "MyAppNodegroupName"
+                },
+                "ManagedByStack": false
+            },
+            {
+                "ResourceType": "AWS::IAM::Role",
+                "ResourceIdentifier": {
+                    "RoleId": "arn:aws::iam::123456789012:role/MyAppIAMRole"
+                },
+                "ManagedByStack": false
+            }
+        ]
+    }
+
+For more information, see `Create a CloudFormation template from resources scanned with IaC generator <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/iac-generator-create-template-from-scanned-resources.html>`__ in the *AWS CloudFormation User Guide*.

awscli/examples/cloudformation/list-resource-scan-resources.rst

@@ -0,0 +1,30 @@
+**To list resources from a resource scan**
+
+The following ``list-resource-scan-resources`` example lists resources from the specified resource scan, filtered by resource identifier. ::
+
+    aws cloudformation list-resource-scan-resources \
+        --resource-scan-id arn:aws:cloudformation:us-east-1:123456789012:resourceScan/0a699f15-489c-43ca-a3ef-3e6ecfa5da60 \
+        --resource-identifier MyApp
+
+Output::
+
+    {
+        "Resources": [
+            {
+                "ResourceType": "AWS::EKS::Cluster",
+                "ResourceIdentifier": {
+                    "ClusterName": "MyAppClusterName"
+                },
+                "ManagedByStack": false
+            },
+            {
+                "ResourceType": "AWS::AutoScaling::AutoScalingGroup",
+                "ResourceIdentifier": {
+                    "AutoScalingGroupName": "MyAppASGName"
+                },
+                "ManagedByStack": false
+            }
+        ]
+    }
+
+For more information, see `Create a CloudFormation template from resources scanned with IaC generator <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/iac-generator-create-template-from-scanned-resources.html>`__ in the *AWS CloudFormation User Guide*.

awscli/examples/cloudformation/list-stack-refactor-actions.rst

@@ -0,0 +1,71 @@
+**To list actions for a stack refactor operation**
+
+The following ``list-stack-refactor-actions`` example lists actions for the stack refactor operation with the specified stack refactor ID. ::
+
+    aws cloudformation list-stack-refactor-actions \
+        --stack-refactor-id 9c384f70-4e07-4ed7-a65d-fee5eb430841
+
+Output::
+
+    {
+        "StackRefactorActions": [
+            {
+                "Action": "MOVE",
+                "Entity": "RESOURCE",
+                "PhysicalResourceId": "MyTestLambdaRole",
+                "Description": "No configuration changes detected.",
+                "Detection": "AUTO",
+                "TagResources": [],
+                "UntagResources": [],
+                "ResourceMapping": {
+                    "Source": {
+                        "StackName": "arn:aws:cloudformation:us-east-1:123456789012:stack/Stack1/3e6a1ff0-94b1-11f0-aa6f-0a88d2e03acf",
+                        "LogicalResourceId": "MyLambdaRole"
+                    },
+                    "Destination": {
+                        "StackName": "arn:aws:cloudformation:us-east-1:123456789012:stack/Stack2/5da91650-94b1-11f0-81cf-0a23500e151b",
+                        "LogicalResourceId": "MyLambdaRole"
+                    }
+                }
+            },
+            {
+                "Action": "MOVE",
+                "Entity": "RESOURCE",
+                "PhysicalResourceId": "MyTestFunction",
+                "Description": "Resource configuration changes will be validated during refactor execution.",
+                "Detection": "AUTO",
+                "TagResources": [
+                    {
+                        "Key": "aws:cloudformation:stack-name",
+                        "Value": "Stack2"
+                    },
+                    {
+                        "Key": "aws:cloudformation:logical-id",
+                        "Value": "MyFunction"
+                    },
+                    {
+                        "Key": "aws:cloudformation:stack-id",
+                        "Value": "arn:aws:cloudformation:us-east-1:123456789012:stack/Stack2/5da91650-94b1-11f0-81cf-0a23500e151b"
+                    }
+                ],
+                "UntagResources": [
+                    "aws:cloudformation:stack-name",
+                    "aws:cloudformation:logical-id",
+                    "aws:cloudformation:stack-id"
+                ],
+                "ResourceMapping": {
+                    "Source": {
+                        "StackName": "arn:aws:cloudformation:us-east-1:123456789012:stack/Stack1/3e6a1ff0-94b1-11f0-aa6f-0a88d2e03acf",
+                        "LogicalResourceId": "MyFunction"
+                    },
+                    "Destination": {
+                        "StackName": "arn:aws:cloudformation:us-east-1:123456789012:stack/Stack2/5da91650-94b1-11f0-81cf-0a23500e151b",
+                        "LogicalResourceId": "MyFunction"
+                    }
+                }
+            }
+        ]
+    }
+
+
+For more information, see `Stack refactoring <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-refactoring.html>`__ in the *AWS CloudFormation User Guide*.

awscli/examples/cloudformation/start-resource-scan.rst

@@ -0,0 +1,14 @@
+**To start a resource scan**
+
+The following ``start-resource-scan`` example starts a resource scan that scans all existing resources in the current account and Region. ::
+
+    aws cloudformation start-resource-scan
+
+Output::
+
+    {
+        "ResourceScanId":
+          "arn:aws:cloudformation:us-east-1:123456789012:resourceScan/0a699f15-489c-43ca-a3ef-3e6ecfa5da60"
+    }
+
+For more information, see `Start a resource scan with CloudFormation IaC generator <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/iac-generator-start-resource-scan.html>`__ in the *AWS CloudFormation User Guide*.

awscli/examples/cloudfront/associate-distribution-tenant-web-acl.rst

@@ -0,0 +1,18 @@
+**To associate a web ACL with a CloudFront distribution tenant**
+
+The following ``associate-distribution-tenant-web-acl`` example associates a web ACL with a CloudFront distribution with ETag ``E13V1IB3VIYABC``. ::
+
+    aws cloudfront associate-distribution-tenant-web-acl \
+        --id dt_2wjDZi3hD1ivOXf6rpZJO1AB \
+        --if-match E13V1IB3VIYABC \
+        --web-acl-arn arn:aws:wafv2:us-east-1:123456789012:global/webacl/web-global-example/626900da-5f64-418b-ba9b-743f37123ABC
+
+Output::
+
+    {
+        "ETag": "E1VC38T7YXBABC",
+        "Id": "dt_2wjDZi3hD1ivOXf6rpZJO1AB",
+        "WebACLArn": "arn:aws:wafv2:us-east-1:123456789012:global/webacl/web-global-example/626900da-5f64-418b-ba9b-743f37123ABC"
+    }
+
+For more information, see `Use AWS WAF protections <https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-awswaf.html>`__ in the *Amazon CloudFront Developer Guide*.

awscli/examples/cloudfront/associate-distribution-web-acl.rst

@@ -0,0 +1,18 @@
+**To associate a web ACL with a CloudFront distribution**
+
+The following ``associate-distribution-web-acl`` example associates a web ACL with a CloudFront distribution. ::
+
+    aws cloudfront associate-distribution-web-acl \
+        --id E1XNX8R2GOAABC \
+        --if-match E2YWS1C2J3OABC \
+        --web-acl-arn arn:aws:wafv2:us-east-1:123456789012:global/webacl/web-global-example/626900da-5f64-418b-ba9b-743f3746cABC
+
+Output::
+
+    {
+        "ETag": "E3QE7ED60U0ABC",
+        "Id": "E1XNX8R2GOAABC",
+        "WebACLArn": "arn:aws:wafv2:us-east-1:123456789012:global/webacl/web-global-example/626900da-5f64-418b-ba9b-743f3746cABC"
+    }
+
+For more information, see `Use AWS WAF protections <https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-awswaf.html>`__ in the *Amazon CloudFront Developer Guide*.

awscli/examples/cloudfront/create-connection-group.rst

@@ -0,0 +1,39 @@
+**To create a connection group in CloudFront**
+
+The following ``create-connection-group`` example creates an enabled connection group, specifies an Anycast static IP list, and disables IPv6. ::
+
+    aws cloudfront create-connection-group \
+        --name cg-with-anycast-ip-list \
+        --no-ipv6-enabled \
+        --enabled \
+        --anycast-ip-list-id aip_CCkW6gKrDiBD4n78123ABC \
+        --tags "Items=[{Key=abc,Value=123}]"
+
+Output::
+
+    {
+        "ETag": "E23ZP02F085ABC",
+        "ConnectionGroup": {
+            "Id": "cg_2yb6uj74B4PCbfhT31WFdiSABC",
+            "Name": "cg-with-anycast-ip-list",
+            "Arn": "arn:aws:cloudfront::123456789012:connection-group/cg_2yb6uj74B4PCbfhT31WFdiSABC",
+            "CreatedTime": "2025-06-16T16:25:50.061000+00:00",
+            "LastModifiedTime": "2025-06-16T16:25:50.061000+00:00",
+            "Tags": {
+                "Items": [
+                    {
+                        "Key": "abc",
+                        "Value": "123"
+                    }
+                ]
+            },
+            "Ipv6Enabled": false,
+            "RoutingEndpoint": "dj6xusxq65abc.cloudfront.net",
+            "AnycastIpListId": "aip_CCkW6gKrDiBD4n78123ABC",
+            "Status": "InProgress",
+            "Enabled": true,
+            "IsDefault": false
+        }
+    }
+
+For more information, see `Create custom connection group (optional) <https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-connection-group.html>`__ in the *Amazon CloudFront Developer Guide*.