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

awscli/examples/application-signals/get-service-level-objective.rst

@@ -0,0 +1,53 @@
+**To return information about one SLO created in the account**
+
+The following ``get-service-level-objective`` example returns information about one SLO created in the account. ::
+
+    aws application-signals get-service-level-objective \
+        --id "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName" 
+
+Output::
+
+    {
+        "Slo": {
+            "Arn": "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName",
+            "Name": "SLOName",
+            "Description": "Description of your SLO",
+            "CreatedTime": "2024-12-24T22:19:18.624000+05:30",
+            "LastUpdatedTime": "2024-12-24T22:19:55.280000+05:30",
+            "Sli": {
+                "SliMetric": {
+                    "MetricDataQueries": [{
+                        "Id": "m1",
+                        "MetricStat": {
+                            "Metric": {
+                                "Namespace": "AWS/EC2",
+                                "MetricName": "CPUUtilization",
+                                "Dimensions": [{
+                                    "Name": "InstanceId",
+                                    "Value": "i-0e0987654321522"
+                                }]
+                            },
+                            "Period": 60,
+                            "Stat": "Average"
+                        },
+                        "ReturnData": true
+                    }]
+                },
+                "MetricThreshold": 200.0,
+                "ComparisonOperator": "LessThanOrEqualTo"
+            },
+            "EvaluationType": "PeriodBased",
+            "Goal": {
+                "Interval": {
+                    "RollingInterval": {
+                        "DurationUnit": "DAY",
+                        "Duration": 7
+                    }
+                },
+                "AttainmentGoal": 99.0,
+                "WarningThreshold": 50.0
+            }
+        }
+    }
+
+For more information, see `Application Signals <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html>`__ in the *Amazon CloudWatch User Guide*.

awscli/examples/application-signals/get-service.rst

@@ -0,0 +1,72 @@
+**To return information about a service discovered by Application Signals**
+
+The following ``get-service`` example returns information about a service discovered by Application Signals. ::
+
+    aws application-signals get-service \
+        --start-time 1732704000 \
+        --end-time 1732714500 \
+        --key-attributes Environment=lambda:default,Name=hello-world-python,Type=Service
+
+Output::
+
+    {
+        "Service": {
+            "KeyAttributes": {
+                "Environment": "lambda:default",
+                "Name": "hello-world-python",
+                "Type": "Service"
+            },
+            "AttributeMaps": [{
+                "Lambda.Function.Name": "hello-world-python",
+                "PlatformType": "AWS::Lambda"
+            }],
+            "MetricReferences": [{
+                "Namespace": "ApplicationSignals",
+                "MetricType": "LATENCY",
+                "Dimensions": [{
+                    "Name": "Environment",
+                    "Value": "lambda:default"
+                }, {
+                    "Name": "Service",
+                    "Value": "hello-world-python"
+                }],
+                "MetricName": "Latency"
+            }, {
+                "Namespace": "ApplicationSignals",
+                "MetricType": "FAULT",
+                "Dimensions": [{
+                    "Name": "Environment",
+                    "Value": "lambda:default"
+                }, {
+                    "Name": "Service",
+                    "Value": "hello-world-python"
+                }],
+                "MetricName": "Fault"
+            }, {
+                "Namespace": "ApplicationSignals",
+                "MetricType": "ERROR",
+                "Dimensions": [{
+                    "Name": "Environment",
+                    "Value": "lambda:default"
+                }, {
+                    "Name": "Service",
+                    "Value": "hello-world-python"
+                }],
+                "MetricName": "Error"
+            }],
+            "LogGroupReferences": [{
+                "Identifier": "/aws/lambda/hello-world-python",
+                "ResourceType": "AWS::Logs::LogGroup",
+                "Type": "AWS::Resource"
+            }]
+        },
+        "StartTime": "2024-11-27T10:00:00+00:00",
+        "EndTime": "2024-11-27T14:00:01+00:00",
+        "LogGroupReferences": [{
+            "Identifier": "/aws/lambda/hello-world-python",
+            "ResourceType": "AWS::Logs::LogGroup",
+            "Type": "AWS::Resource"
+        }]
+    }
+
+For more information, see `Application Signals <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html>`__ in the *Amazon CloudWatch User Guide*.

awscli/examples/application-signals/list-service-dependencies.rst

@@ -0,0 +1,96 @@
+**To return a list of service dependencies of the service that you specify**
+
+The following ``list-service-dependencies`` example returns a list of service dependencies of the service that you specify. ::
+
+    aws application-signals list-service-dependencies \
+        --start-time 1732021200 \
+        --end-time 1732107600 \
+        --key-attributes Environment=api-gateway:prod, Name=PetAdoptionStatusUpdater,Type=Service
+
+Output::
+
+    {
+        "ServiceDependencies": [{
+            "OperationName": "PUT /prod",
+            "DependencyKeyAttributes": {
+                "Environment": "lambda:default",
+                "Name": "Services-name",
+                "Type": "Service"
+            },
+            "DependencyOperationName": "Invoke",
+            "MetricReferences": [{
+                "Namespace": "ApplicationSignals",
+                "MetricType": "LATENCY",
+                "Dimensions": [{
+                    "Name": "Environment",
+                    "Value": "api-gateway:prod"
+                }, {
+                    "Name": "Operation",
+                    "Value": "PUT /prod"
+                }, {
+                    "Name": "RemoteEnvironment",
+                    "Value": "lambda:default"
+                }, {
+                    "Name": "RemoteOperation",
+                    "Value": "Invoke"
+                }, {
+                    "Name": "RemoteService",
+                    "Value": "Services-name"
+                }, {
+                    "Name": "Service",
+                    "Value": "PetAdoptionStatusUpdater"
+                }],
+                "MetricName": "Latency"
+            }, {
+                "Namespace": "ApplicationSignals",
+                "MetricType": "FAULT",
+                "Dimensions": [{
+                    "Name": "Environment",
+                    "Value": "api-gateway:prod"
+                }, {
+                    "Name": "Operation",
+                    "Value": "PUT /prod"
+                }, {
+                    "Name": "RemoteEnvironment",
+                    "Value": "lambda:default"
+                }, {
+                    "Name": "RemoteOperation",
+                    "Value": "Invoke"
+                }, {
+                    "Name": "RemoteService",
+                    "Value": "Services-name"
+                }, {
+                    "Name": "Service",
+                    "Value": "PetAdoptionStatusUpdater"
+                }],
+                "MetricName": "Fault"
+            }, {
+                "Namespace": "ApplicationSignals",
+                "MetricType": "ERROR",
+                "Dimensions": [{
+                    "Name": "Environment",
+                    "Value": "api-gateway:prod"
+                }, {
+                    "Name": "Operation",
+                    "Value": "PUT /prod"
+                }, {
+                    "Name": "RemoteEnvironment",
+                    "Value": "lambda:default"
+                }, {
+                    "Name": "RemoteOperation",
+                    "Value": "Invoke"
+                }, {
+                    "Name": "RemoteService",
+                    "Value": "Services-name"
+                }, {
+                    "Name": "Service",
+                    "Value": "PetAdoptionStatusUpdater"
+                }],
+                "MetricName": "Error"
+            }]
+        }],
+        "StartTime": "2024-11-19T13:00:00+00:00",
+        "EndTime": "2024-11-20T13:00:01+00:00"
+    }
+
+For more information, see `Application Signals <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html>`__ in the *Amazon CloudWatch User Guide*.

awscli/examples/application-signals/list-service-dependents.rst

@@ -0,0 +1,36 @@
+**To return the list of dependents that invoked the specified service during the provided time range**
+
+The following ``list-service-dependents`` example returns the list of dependents that invoked the specified service during the provided time range. ::
+
+    aws application-signals list-service-dependents \
+        --start-time 1732021200 \
+        --end-time 1732107600 \
+        --key-attributes Environment=generic:default,Name=PetSite,Type=Service
+
+Output::
+
+    {
+        "ServiceDependents": [{
+            "OperationName": "",
+            "DependentKeyAttributes": {
+                "Identifier": "pet-api-canary-hao",
+                "ResourceType": "AWS::Synthetics::Canary",
+                "Type": "AWS::Resource"
+            },
+            "DependentOperationName": "",
+            "MetricReferences": []
+        }, {
+            "OperationName": "",
+            "DependentKeyAttributes": {
+                "Identifier": "PetSite",
+                "ResourceType": "AWS::Synthetics::Canary",
+                "Type": "AWS::Resource"
+            },
+            "DependentOperationName": "",
+            "MetricReferences": []
+        }],
+        "StartTime": "2024-12-24T05:00:00+00:00",
+        "EndTime": "2024-12-25T06:00:01+00:00"
+    }
+
+For more information, see `Application Signals <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html>`__ in the *Amazon CloudWatch User Guide*.

awscli/examples/application-signals/list-service-level-objectives.rst

@@ -0,0 +1,17 @@
+**To return a list of SLOs created in this account.**
+
+The following ``list-service-level-objectives`` example returns a list of SLOs created in this account. ::
+
+    aws application-signals list-service-level-objectives
+
+Output::
+
+    {
+        "SloSummaries": [{
+            "Arn": "arn:aws:application-signals:us-east-1:123456789101:slo/test",
+            "Name": "test",
+            "CreatedTime": "2024-12-24T22:01:21.116000+05:30"
+        }]
+    }
+
+For more information, see `Application Signals <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html>`__ in the *Amazon CloudWatch User Guide*.

awscli/examples/application-signals/list-service-operations.rst

@@ -0,0 +1,63 @@
+**To return a list of the operations of this service that have been discovered by Application Signals**
+
+The following ``list-service-operations`` example returns a list of the operations of this service that have been discovered by Application Signals. ::
+
+    aws application-signals list-service-operations \
+        --start-time 1735017423 \
+        --end-time 1735103823 \
+        --key-attributes Environment=generic:default,Name=payforadoption,Type=Service
+
+Output::
+
+    {
+        "ServiceOperations": [{
+            "Name": "POST /api",
+            "MetricReferences": [{
+                "Namespace": "ApplicationSignals",
+                "MetricType": "LATENCY",
+                "Dimensions": [{
+                    "Name": "Environment",
+                    "Value": "generic:default"
+                }, {
+                    "Name": "Operation",
+                    "Value": "POST /api"
+                }, {
+                    "Name": "Service",
+                    "Value": "payforadoption"
+                }],
+                "MetricName": "Latency"
+            }, {
+                "Namespace": "ApplicationSignals",
+                "MetricType": "FAULT",
+                "Dimensions": [{
+                    "Name": "Environment",
+                    "Value": "generic:default"
+                }, {
+                    "Name": "Operation",
+                    "Value": "POST /api"
+                }, {
+                    "Name": "Service",
+                    "Value": "payforadoption"
+                }],
+                "MetricName": "Fault"
+            }, {
+                "Namespace": "ApplicationSignals",
+                "MetricType": "ERROR",
+                "Dimensions": [{
+                    "Name": "Environment",
+                    "Value": "generic:default"
+                }, {
+                    "Name": "Operation",
+                    "Value": "POST /api"
+                }, {
+                    "Name": "Service",
+                    "Value": "payforadoption"
+                }],
+                "MetricName": "Error"
+            }]
+        }],
+        "StartTime": "2024-12-24T05:00:00+00:00",
+        "EndTime": "2024-12-25T06:00:01+00:00"
+    }
+
+For more information, see `Application Signals <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html>`__ in the *Amazon CloudWatch User Guide*.

awscli/examples/application-signals/list-services.rst

@@ -0,0 +1,61 @@
+**To return a list of services that have been discovered by Application Signals**
+
+The following ``list-services`` example returns a list of services that have been discovered by Application Signals. ::
+
+    aws application-signals list-services \
+        --start-time 1734918791 \
+        --end-time 1734965591
+
+Output::
+
+    {
+        "ServiceSummaries": [{
+            "KeyAttributes": {
+                "Environment": "lambda:default",
+                "Name": "hello-world-python",
+                "Type": "Service"
+            },
+            "AttributeMaps": [{
+                "Lambda.Function.Name": "hello-world-python",
+                "PlatformType": "AWS::Lambda"
+            }],
+            "MetricReferences": [{
+                "Namespace": "ApplicationSignals",
+                "MetricType": "LATENCY",
+                "Dimensions": [{
+                    "Name": "Environment",
+                    "Value": "lambda:default"
+                }, {
+                    "Name": "Service",
+                    "Value": "hello-world-python"
+                }],
+                "MetricName": "Latency"
+            }, {
+                "Namespace": "ApplicationSignals",
+                "MetricType": "FAULT",
+                "Dimensions": [{
+                    "Name": "Environment",
+                    "Value": "lambda:default"
+                }, {
+                    "Name": "Service",
+                    "Value": "hello-world-python"
+                }],
+                "MetricName": "Fault"
+            }, {
+                "Namespace": "ApplicationSignals",
+                "MetricType": "ERROR",
+                "Dimensions": [{
+                    "Name": "Environment",
+                    "Value": "lambda:default"
+                }, {
+                    "Name": "Service",
+                    "Value": "hello-world-python"
+                }],
+                "MetricName": "Error"
+            }]
+        }],
+        "StartTime": "2024-11-27T10:00:00+00:00",
+        "EndTime": "2024-11-27T14:00:01+00:00"
+    }
+
+For more information, see `Application Signals <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html>`__ in the *Amazon CloudWatch User Guide*.

awscli/examples/application-signals/list-tags-for-resource.rst

@@ -0,0 +1,17 @@
+**To display the tags associated with a CloudWatch resource**
+
+The following ``list-tags-for-resource`` example displays the tags associated with a CloudWatch resource. ::
+
+    aws application-signals list-tags-for-resource \
+        --resource-arn "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName"
+
+Output::
+
+    {
+        "Tags": [{
+            "Key": "test",
+            "Value": "value"
+        }]
+    }
+
+For more information, see `Application Signals <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html>`__ in the *Amazon CloudWatch User Guide*.

awscli/examples/application-signals/start-discovery.rst

@@ -0,0 +1,9 @@
+**To enable this Amazon Web Services account to be able to use CloudWatch Application Signals**
+
+The following ``start-discovery`` example enables this Amazon Web Services account to be able to use CloudWatch Application Signals by creating the *AWSServiceRoleForCloudWatchApplicationSignals* service-linked role. ::
+
+    aws application-signals start-discovery
+
+This command produces no output.
+
+For more information, see `Application Signals <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html>`__ in the *Amazon CloudWatch User Guide*.

awscli/examples/application-signals/tag-resource.rst

@@ -0,0 +1,11 @@
+**To assigns one or more tags (key-value pairs) to the specified CloudWatch resource, such as a service level objective**
+
+The following ``tag-resource`` example assigns one or more tags (key-value pairs) to the specified CloudWatch resource, such as a service level objective. ::
+
+    aws application-signals tag-resource \
+        --resource-arn "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName" \
+        --tags '{"Key":"test","Value":"value"}'
+
+This command produces no output.
+
+For more information, see `Application Signals <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html>`__ in the *Amazon CloudWatch User Guide*.

awscli/examples/application-signals/untag-resource.rst

@@ -0,0 +1,11 @@
+**To remove one or more tags from the specified resource**
+
+The following ``untag-resource`` example removes one or more tags from the specified resource. ::
+
+    aws application-signals untag-resource \
+        --resource-arn "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName" \
+        --tag-keys "test"
+
+This command produces no output.
+
+For more information, see `Application Signals <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html>`__ in the *Amazon CloudWatch User Guide*.

awscli/examples/application-signals/update-service-level-objective.rst

@@ -0,0 +1,69 @@
+**To update an existing service level objective (SLO)**
+
+The following ``update-service-level-objective`` example updates an existing service level objective (SLO). ::
+
+    aws application-signals update-service-level-objective \
+    --cli-input-json file://update-slo.json
+
+Contents of ``update-slo.json``::
+
+    {
+        "id": "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName",
+        "goal": {
+            "Interval": {
+                "RollingInterval": {
+                    "DurationUnit": "DAY",
+                    "Duration": 7
+                }
+            },
+            "AttainmentGoal": 90.0,
+            "WarningThreshold": 50.0
+        }
+    }
+
+Output::
+
+    {
+        "Slo": {
+            "Arn": "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName",
+            "Name": "SLOName",
+            "Description": "Description of your SLO",
+            "CreatedTime": "2024-12-24T22:19:18.624000+05:30",
+            "LastUpdatedTime": "2024-12-27T08:51:38.278000+05:30",
+            "Sli": {
+                "SliMetric": {
+                    "MetricDataQueries": [{
+                        "Id": "m1",
+                        "MetricStat": {
+                            "Metric": {
+                                "Namespace": "AWS/EC2",
+                                "MetricName": "CPUUtilization",
+                                "Dimensions": [{
+                                    "Name": "InstanceId",
+                                    "Value": "i-00987654345222"
+                                }]
+                            },
+                            "Period": 60,
+                            "Stat": "Average"
+                        },
+                        "ReturnData": true
+                    }]
+                },
+                "MetricThreshold": 200.0,
+                "ComparisonOperator": "LessThanOrEqualTo"
+            },
+            "EvaluationType": "PeriodBased",
+            "Goal": {
+                "Interval": {
+                    "RollingInterval": {
+                        "DurationUnit": "DAY",
+                        "Duration": 7
+                    }
+                },
+                "AttainmentGoal": 90.0,
+                "WarningThreshold": 50.0
+            }
+        }
+    }
+
+For more information, see `Application Signals <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html>`__ in the *Amazon CloudWatch User Guide*.

awscli/examples/cloudformation/_package_description.rst

@@ -49,8 +49,8 @@ current working directory. The exception is ``AWS::ApiGateway::RestApi``;
 if you don't specify a ``BodyS3Location``, this command will not upload an artifact to S3.
 
 Before the command uploads artifacts, it checks if the artifacts are already
-present in the S3 bucket to prevent unnecessary uploads. The command uses MD5
-checksums to compare files. If the values match, the command doesn't upload the
-artifacts. Use the ``--force-upload flag`` to skip this check and always upload the
-artifacts.
+present in the S3 bucket to prevent unnecessary uploads. If the values match, the
+command doesn't upload the artifacts. Use the ``--force-upload flag`` to skip this
+check and always upload the artifacts. The command uses MD5 checksums to compare
+files by default. If MD5 is not available in the environment, a SHA256 checksum is used.
 

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

@@ -0,0 +1,50 @@
+**To create a generated template from scanned resources**
+
+The following ``create-generated-template`` example creates a generated template named ``MyTemplate`` from scanned resources. ::
+
+    aws cloudformation create-generated-template \
+        --generated-template-name MyTemplate \
+        --resources file://resources.json
+
+Contents of ``resources.json``::
+
+    [
+        {
+            "ResourceType": "AWS::EKS::Cluster",
+            "LogicalResourceId":"MyCluster",
+            "ResourceIdentifier": {
+                "ClusterName": "MyAppClusterName"
+            }
+        },
+        {
+            "ResourceType": "AWS::AutoScaling::AutoScalingGroup",
+            "LogicalResourceId":"MyASG",
+            "ResourceIdentifier": {
+                "AutoScalingGroupName": "MyAppASGName"
+            }
+        },
+        {
+            "ResourceType": "AWS::EKS::Nodegroup",
+            "LogicalResourceId":"MyNodegroup",
+            "ResourceIdentifier": {
+                "NodegroupName": "MyAppNodegroupName"
+            }
+        },
+        {
+            "ResourceType": "AWS::IAM::Role",
+            "LogicalResourceId":"MyRole",
+            "ResourceIdentifier": {
+                "RoleId": "arn:aws::iam::123456789012:role/MyAppIAMRole"
+            }
+        }
+    ]
+
+Output::
+
+    {
+      "Arn":
+        "arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/7fc8512c-d8cb-4e02-b266-d39c48344e48",
+      "Name": "MyTemplate"
+    }
+
+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/create-stack-refactor.rst

@@ -0,0 +1,16 @@
+**To create the stack definition for a stack refactor operation**
+
+The following ``create-stack-refactor`` example creates the stack definition for stack refactoring. ::
+
+    aws cloudformation create-stack-refactor \
+        --stack-definitions \
+          StackName=Stack1,TemplateBody@=file://template1-updated.yaml \
+          StackName=Stack2,TemplateBody@=file://template2-updated.yaml
+
+Output::
+
+    {
+        "StackRefactorId": "9c384f70-4e07-4ed7-a65d-fee5eb430841"
+    }
+
+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/delete-generated-template.rst

@@ -0,0 +1,10 @@
+**To delete a generated template**
+
+The following ``delete-generated-template`` example deletes the specified template. ::
+
+    aws cloudformation delete-generated-template \
+        --generated-template-name MyTemplate
+
+This command produces no output.
+
+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*.