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

awscli/customizations/s3uploader.py

@@ -11,7 +11,6 @@
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
 
-import hashlib
 import logging
 import threading
 import os
@@ -19,6 +18,7 @@ import sys
 
 import botocore
 import botocore.exceptions
+from botocore.compat import get_md5
 from s3transfer.manager import TransferManager
 from s3transfer.subscribers import BaseSubscriber
 
@@ -27,6 +27,16 @@ from awscli.compat import collections_abc
 LOG = logging.getLogger(__name__)
 
 
+def _get_checksum():
+    hashlib_params = {"usedforsecurity": False}
+    try:
+        checksum = get_md5(**hashlib_params)
+    except botocore.exceptions.MD5UnavailableError:
+        import hashlib
+        checksum = hashlib.sha256(**hashlib_params)
+    return checksum
+
+
 class NoSuchBucketError(Exception):
     def __init__(self, **kwargs):
         msg = self.fmt.format(**kwargs)
@@ -81,7 +91,7 @@ class S3Uploader(object):
         """
         Uploads given file to S3
         :param file_name: Path to the file that will be uploaded
-        :param remote_path:  be uploaded
+        :param remote_path: Path where the file will be uploaded
         :return: VersionId of the latest upload
         """
 
@@ -128,7 +138,7 @@ class S3Uploader(object):
 
     def upload_with_dedup(self, file_name, extension=None):
         """
-        Makes and returns name of the S3 object based on the file's MD5 sum
+        Makes and returns name of the S3 object based on the file's checksum
 
         :param file_name: file to upload
         :param extension: String of file extension to append to the object
@@ -140,8 +150,8 @@ class S3Uploader(object):
         # and re-upload only if necessary. So the template points to same file
         # in multiple places, this will upload only once
 
-        filemd5 = self.file_checksum(file_name)
-        remote_path = filemd5
+        file_checksum = self.file_checksum(file_name)
+        remote_path = file_checksum
         if extension:
             remote_path = remote_path + "." + extension
 
@@ -172,7 +182,7 @@ class S3Uploader(object):
     def file_checksum(self, file_name):
 
         with open(file_name, "rb") as file_handle:
-            md5 = hashlib.md5()
+            checksum = _get_checksum()
             # Read file in chunks of 4096 bytes
             block_size = 4096
 
@@ -182,13 +192,13 @@ class S3Uploader(object):
 
             buf = file_handle.read(block_size)
             while len(buf) > 0:
-                md5.update(buf)
+                checksum.update(buf)
                 buf = file_handle.read(block_size)
 
             # Restore file cursor's position
             file_handle.seek(curpos)
 
-            return md5.hexdigest()
+            return checksum.hexdigest()
 
     def to_path_style_s3_url(self, key, version=None):
         """

awscli/customizations/scalarparse.py

@@ -27,9 +27,14 @@ There's nothing currently done for timestamps, but this will change
 in the future.
 
 """
+import sys
+
 from botocore.utils import parse_timestamp
 from botocore.exceptions import ProfileNotFound
 
+from awscli.customizations.utils import uni_print
+from awscli.utils import resolve_v2_debug_mode
+
 
 def register_scalar_parser(event_handlers):
     event_handlers.register_first(
@@ -44,12 +49,20 @@ def iso_format(value):
     return parse_timestamp(value).isoformat()
 
 
-def add_timestamp_parser(session):
+def add_timestamp_parser(session, v2_debug=False):
     factory = session.get_component('response_parser_factory')
+    print_v2_debug_warnings = v2_debug
     try:
         timestamp_format = session.get_scoped_config().get(
             'cli_timestamp_format',
-            'none')
+            None)
+        if timestamp_format is not None:
+            # We do not want to print v2 debug warnings if the user explicitly
+            # configured the cli_timestamp_format, they would not be
+            # broken in that case.
+            print_v2_debug_warnings = False
+        else:
+            timestamp_format = 'wire'
     except ProfileNotFound:
         # If a --profile is provided that does not exist, loading
         # a value from get_scoped_config will crash the CLI.
@@ -57,23 +70,49 @@ def add_timestamp_parser(session):
         # the session-initialized event, which happens before a
         # profile can be created, even if the command would have
         # successfully created a profile. Instead of crashing here
-        # on a ProfileNotFound the CLI should just use 'none'.
-        timestamp_format = 'none'
-    if timestamp_format == 'none':
+        # on a ProfileNotFound the CLI should just use 'wire'.
+        timestamp_format = 'wire'
+    # We also support 'none' for backwards compatibility reasons, though we
+    # document 'wire' instead.
+    if timestamp_format == 'wire' or timestamp_format == 'none':
         # For backwards compatibility reasons, we replace botocore's timestamp
         # parser (which parses to a datetime.datetime object) with the
         # identity function which prints the date exactly the same as it comes
         # across the wire.
-        timestamp_parser = identity
+        encountered_timestamp = False
+        def identity_with_warning(x):
+            # To prevent printing the same warning for each timestamp in the
+            # response, we utilize a reference to a nonlocal variable to track
+            # if we have already printed the warning.
+            nonlocal encountered_timestamp
+            if not encountered_timestamp:
+                encountered_timestamp = True
+                uni_print(
+                    '\nAWS CLI v2 UPGRADE WARNING: In AWS CLI v2, all '
+                    'timestamp response values are returned in the ISO 8601 '
+                    'format. This is different from v1 behavior, where the '
+                    'timestamps are returned as they appear in the service '
+                    'API response. To retain AWS CLI v1 behavior in AWS CLI '
+                    'v2, set the configuration variable '
+                    '`cli_timestamp_format` to `wire`. See '
+                    'https://docs.aws.amazon.com/cli/latest/userguide/'
+                    'cliv2-migration-changes.html'
+                    '#cliv2-migration-timestamp.\n',
+                    out_file=sys.stderr
+                )
+            return identity(x)
+
+        timestamp_parser = identity_with_warning \
+            if print_v2_debug_warnings else identity
     elif timestamp_format == 'iso8601':
         timestamp_parser = iso_format
     else:
         raise ValueError('Unknown cli_timestamp_format value: %s, valid values'
-                         ' are "none" or "iso8601"' % timestamp_format)
+                         ' are "none", "wire" or "iso8601"' % timestamp_format)
     factory.set_parser_defaults(timestamp_parser=timestamp_parser)
 
 
-def add_scalar_parsers(session, **kwargs):
+def add_scalar_parsers(session, parsed_args=None, **kwargs):
     factory = session.get_component('response_parser_factory')
     factory.set_parser_defaults(blob_parser=identity)
-    add_timestamp_parser(session)
+    add_timestamp_parser(session, resolve_v2_debug_mode(parsed_args))

awscli/customizations/utils.py

@@ -18,6 +18,7 @@ import copy
 import sys
 
 from botocore.exceptions import ClientError
+from awscli.utils import create_nested_client
 
 
 def rename_argument(argument_table, existing_name, new_name):
@@ -172,7 +173,7 @@ def create_client_from_parsed_globals(session, service_name, parsed_globals,
         client_args['verify'] = parsed_globals.verify_ssl
     if overrides:
         client_args.update(overrides)
-    return session.create_client(service_name, **client_args)
+    return create_nested_client(session, service_name, **client_args)
 
 
 def uni_print(statement, out_file=None):

awscli/customizations/waiters.py

@@ -16,6 +16,7 @@ from botocore.exceptions import DataNotFoundError
 from awscli.clidriver import ServiceOperation
 from awscli.customizations.commands import BasicCommand, BasicHelp, \
     BasicDocHandler
+from awscli.utils import create_nested_client
 
 
 def register_add_waiters(cli):
@@ -200,8 +201,8 @@ class WaiterCaller(object):
         self._waiter_name = waiter_name
 
     def invoke(self, service_name, operation_name, parameters, parsed_globals):
-        client = self._session.create_client(
-            service_name, region_name=parsed_globals.region,
+        client = create_nested_client(
+            self._session, service_name, region_name=parsed_globals.region,
             endpoint_url=parsed_globals.endpoint_url,
             verify=parsed_globals.verify_ssl)
         waiter = client.get_waiter(xform_name(self._waiter_name))

awscli/data/cli.json

@@ -64,6 +64,11 @@
             "dest": "connect_timeout",
             "type": "int",
             "help": "<p>The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.</p>"
+        },
+        "v2-debug": {
+            "action": "store_true",
+            "dest": "v2_debug",
+            "help": "<p>Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.</p>"
         }
     }
 }

awscli/examples/apigateway/update-vpc-link.rst

@@ -0,0 +1,47 @@
+**Example 1: To update an existing VPC link name**
+
+The following ``update-vpc-link`` example updates the name of the specified VPC link. ::
+
+    aws apigateway update-vpc-link  \
+        --vpc-link-id ab3de6 \
+        --patch-operations op=replace,path=/name,value=my-vpc-link
+
+Output::
+
+    {
+        "id": "ab3de6",
+        "name": "my-vpc-link",
+        "targetArns": [
+            "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/net/my-lb/12a456s89aaa12345"
+        ],
+        "status": "AVAILABLE",
+        "statusMessage": "Your vpc link is ready for use",
+        "tags": {}
+    }
+
+For more information, see `Updating existing VPC link <https://docs.aws.amazon.com/cli/latest/reference/apigateway/update-vpc-link.html>`__ in the *AWS CLI Command Reference*.
+
+
+**Example 2: To update an existing VPC link name and description**
+
+The following ``update-vpc-link`` example updates name of the specified VPC link. ::
+
+    aws apigateway update-vpc-link  \
+        --vpc-link-id ab3de6 \
+        --patch-operations op=replace,path=/name,value=my-vpc-link op=replace,path=/description,value="My custom description"
+
+Output::
+
+    {
+        "id": "ab3de6",
+        "name": "my-vpc-link",
+        "description": "My custom description",
+        "targetArns": [
+            "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/net/my-lb/12a456s89aaa12345"
+        ],
+        "status": "AVAILABLE",
+        "statusMessage": "Your vpc link is ready for use",
+        "tags": {}
+    }
+
+For more information, see `Updating existing VPC link <https://docs.aws.amazon.com/cli/latest/reference/apigateway/update-vpc-link.html>`__ in the *AWS CLI Command Reference*.

awscli/examples/apigatewayv2/create-routing-rule.rst

@@ -0,0 +1,52 @@
+**To create a routing rule**
+
+The following ``create-routing-rule`` example creates a routing rule with a priority of ``50``. ::
+
+    aws apigatewayv2 create-routing-rule \
+        --domain-name 'regional.example.com' \
+        --priority 50 \
+        --conditions '[ \
+            { \
+                "MatchBasePaths": { \
+                    "AnyOf": [ \
+                        "PetStoreShopper" \
+                    ] \
+                } \
+            } \
+        ]' \
+        --actions '[ \
+            { \
+                "InvokeApi": { \
+                    "ApiId": "abcd1234", \
+                    "Stage": "prod" \
+                } \
+            } \
+        ]'
+
+Output::
+
+    {
+        "Actions": [
+            {
+                "InvokeApi": {
+                    "ApiId": "abcd1234",
+                    "Stage": "prod",
+                    "StripBasePath": false
+                }
+            }
+        ],
+        "Conditions": [
+            {
+                "MatchBasePaths": {
+                    "AnyOf": [
+                        "PetStoreShopper"
+                    ]
+                }
+            }
+        ],
+        "Priority": 50,
+        "RoutingRuleArn": "arn:aws:apigateway:us-east-2:123456789012:/domainnames/regional.example.com/routingrules/aaa111",
+        "RoutingRuleId": "aaa111"
+    }
+
+For more information, see `Routing rules to connect API stages to a custom domain name for REST APIs <https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-routing-rules.html>`__ in the *Amazon API Gateway Developer Guide*.

awscli/examples/apigatewayv2/delete-routing-rule.rst

@@ -0,0 +1,11 @@
+**To delete a routing rule**
+
+The following ``delete-routing-rule`` example deletes a routing rule for a custom domain name. ::
+
+    aws apigatewayv2 delete-routing-rule \
+        --domain-name 'regional.example.com' \
+        --routing-rule-id aaa111
+
+This command produces no output.
+
+For more information, see `Routing rules to connect API stages to a custom domain name for REST APIs <https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-routing-rules.html>`__ in the *Amazon API Gateway Developer Guide*.

awscli/examples/apigatewayv2/get-routing-rule.rst

@@ -0,0 +1,35 @@
+**To get a routing rule**
+
+The following ``get-routing-rule`` example gets a routing rule for a domain name. ::
+
+    aws apigatewayv2 get-routing-rule \
+        --domain-name 'regional.example.com' \
+        --routing-rule-id aaa111
+
+Output::
+
+    {
+        "Actions": [
+            {
+                "InvokeApi": {
+                    "ApiId": "abcd1234",
+                    "Stage": "prod",
+                    "StripBasePath": false
+                }
+            }
+        ],
+        "Conditions": [
+            {
+                "MatchBasePaths": {
+                    "AnyOf": [
+                        "PetStoreShopper"
+                    ]
+                }
+            }
+        ],
+        "Priority": 50,
+        "RoutingRuleArn": "arn:aws:apigateway:us-east-2:123456789012:/domainnames/regional.example.com/routingrules/aaa111",
+        "RoutingRuleId": "aaa111"
+    }
+
+For more information, see `Routing rules to connect API stages to a custom domain name for REST APIs <https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-routing-rules.html>`__ in the *Amazon API Gateway Developer Guide*.

awscli/examples/apigatewayv2/list-routing-rules.rst

@@ -0,0 +1,38 @@
+**To list routing rules**
+
+The following ``list-routing-rules`` example lists the routing rules for a domain name. ::
+
+    aws apigatewayv2 list-routing-rules \
+        --domain-name 'regional.example.com'
+
+Output::
+
+    {
+        "RoutingRules": [
+            {
+                "Actions": [
+                    {
+                        "InvokeApi": {
+                            "ApiId": "abcd1234",
+                            "Stage": "prod",
+                            "StripBasePath": false
+                        }
+                    }
+                ],
+                "Conditions": [
+                    {
+                        "MatchBasePaths": {
+                            "AnyOf": [
+                                "PetStoreShopper"
+                            ]
+                        }
+                    }
+                ],
+                "Priority": 150,
+                "RoutingRuleArn": "arn:aws:apigateway:us-east-1:123456789012:/domainnames/regional.example.com/routingrules/aaa111",
+                "RoutingRuleId": "aaa111"
+            }
+        ]
+    }
+
+For more information, see `Routing rules to connect API stages to a custom domain name for REST APIs <https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-routing-rules.html>`__ in the *Amazon API Gateway Developer Guide*.

awscli/examples/apigatewayv2/put-routing-rule.rst

@@ -0,0 +1,52 @@
+**To update a routing rule**
+
+The following ``put-routing-rule`` example updates the priority of a routing rule. ::
+
+    aws apigatewayv2 put-routing-rule \
+        --domain-name 'regional.example.com' \
+        --priority 150 \
+        --conditions '[ \
+            { \
+                "MatchBasePaths": { \
+                    "AnyOf": [ \
+                        "PetStoreShopper" \
+                    ] \
+                } \
+            } \
+        ]' \
+        --actions '[ \
+            { \
+                "InvokeApi": { \
+                    "ApiId": "abcd1234", \
+                    "Stage": "prod" \
+                } \
+            } \
+        ]'
+
+Output::
+
+    {
+        "Actions": [
+            {
+                "InvokeApi": {
+                    "ApiId": "abcd1234",
+                    "Stage": "prod",
+                    "StripBasePath": false
+                }
+            }
+        ],
+        "Conditions": [
+            {
+                "MatchBasePaths": {
+                    "AnyOf": [
+                        "PetStoreShopper"
+                    ]
+                }
+            }
+        ],
+        "Priority": 150,
+        "RoutingRuleArn": "arn:aws:apigateway:us-east-2:123456789012:/domainnames/regional.example.com/routingrules/aaa111",
+        "RoutingRuleId": "aaa111"
+    }
+
+For more information, see `Routing rules to connect API stages to a custom domain name for REST APIs <https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-routing-rules.html>`__ in the *Amazon API Gateway Developer Guide*.

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

@@ -0,0 +1,99 @@
+**To retrieve one or more service level objective (SLO) budget reports.**
+
+The following ``batch-get-service-level-objective-budget-report`` example retrieves one or more service level objective (SLO) budget reports. ::
+
+    aws application-signals batch-get-service-level-objective-budget-report \
+    --timestamp 1735059869 \
+    --slo-ids "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName1" "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName2"
+
+Output::
+
+    {
+        "Timestamp": "2024-12-24T22:34:29+05:30",
+        "Reports": [{
+                "Arn": "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName1",
+                "Name": "Your SLO Name",
+                "EvaluationType": "PeriodBased",
+                "BudgetStatus": "OK",
+                "Attainment": 100.0,
+                "TotalBudgetSeconds": 6048,
+                "BudgetSecondsRemaining": 6048,
+                "Sli": {
+                    "SliMetric": {
+                        "MetricDataQueries": [{
+                            "Id": "m1",
+                            "MetricStat": {
+                                "Metric": {
+                                    "Namespace": "AWS/EC2",
+                                    "MetricName": "CPUUtilization",
+                                    "Dimensions": [{
+                                        "Name": "InstanceId",
+                                        "Value": "i-0e098765432522"
+                                    }]
+                                },
+                                "Period": 60,
+                                "Stat": "Average"
+                            },
+                            "ReturnData": true
+                        }]
+                    },
+                    "MetricThreshold": 200.0,
+                    "ComparisonOperator": "LessThanOrEqualTo"
+                },
+                "Goal": {
+                    "Interval": {
+                        "RollingInterval": {
+                            "DurationUnit": "DAY",
+                            "Duration": 7
+                        }
+                    },
+                    "AttainmentGoal": 99.0,
+                    "WarningThreshold": 50.0
+                }
+            },
+            {
+                "Arn": "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName2",
+                "Name": "test",
+                "EvaluationType": "PeriodBased",
+                "BudgetStatus": "BREACHED",
+                "Attainment": 97.39583275,
+                "TotalBudgetSeconds": 86,
+                "BudgetSecondsRemaining": -2154,
+                "Sli": {
+                    "SliMetric": {
+                        "MetricDataQueries": [{
+                            "Id": "cwMetric",
+                            "MetricStat": {
+                                "Metric": {
+                                    "Namespace": "AWS/EC2",
+                                    "MetricName": "CPUUtilization",
+                                    "Dimensions": [{
+                                        "Name": "InstanceId",
+                                        "Value": "i-0e12345678922"
+                                    }]
+                                },
+                                "Period": 300,
+                                "Stat": "Average"
+                            },
+                            "ReturnData": true
+                        }]
+                    },
+                    "MetricThreshold": 5.0,
+                    "ComparisonOperator": "GreaterThan"
+                },
+                "Goal": {
+                    "Interval": {
+                        "RollingInterval": {
+                            "DurationUnit": "DAY",
+                            "Duration": 1
+                        }
+                    },
+                    "AttainmentGoal": 99.9,
+                    "WarningThreshold": 30.0
+                }
+            }
+        ],
+        "Errors": []
+    }
+
+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/create-service-level-objective.rst

@@ -0,0 +1,88 @@
+**To create a service level objective (SLO)**
+
+The following ``create-service-level-objective`` example creates a service level objective (SLO), which can help you ensure that your critical business operations are meeting customer expectations. ::
+
+    aws application-signals create-service-level-objective \
+        --name "SLOName" \
+        --description "Description of your SLO" \
+        --sli-config file://sli-config.json
+
+Contents of ``sli-config.json``::
+
+    {
+        "SliMetricConfig": {
+            "MetricDataQueries": [
+                {
+                    "Id": "m1",
+                    "MetricStat": {
+                        "Metric": {
+                            "Namespace": "AWS/EC2",
+                            "MetricName": "CPUUtilization",
+                            "Dimensions": [
+                                {
+                                    "Name": "InstanceId",
+                                    "Value": "i-0e5a1234561522"
+                                }
+                            ]
+                        },
+                        "Period": 60,
+                        "Stat": "Average"
+                    },
+                    "ReturnData": true
+                }
+            ]
+        },
+        "MetricThreshold": 200,
+        "ComparisonOperator": "LessThanOrEqualTo"
+    }
+    
+Output::
+
+    {
+        "Slo": {
+        "Arn": "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName",
+        "Name": "SLOName",
+        "Description": "Description of your SLO",
+        "CreatedTime": "2024-12-27T08:16:09.032000+05:30",
+        "LastUpdatedTime": "2024-12-27T08:16:09.032000+05:30",
+        "Sli": {
+            "SliMetric": {
+                "MetricDataQueries": [
+                    {
+                        "Id": "m1",
+                        "MetricStat": {
+                            "Metric": {
+                                "Namespace": "AWS/EC2",
+                                "MetricName": "CPUUtilization",
+                                "Dimensions": [
+                                    {
+                                        "Name": "InstanceId",
+                                        "Value": "i-0e59876543234522"
+                                    }
+                                ]
+                            },
+                            "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/delete-service-level-objective.rst

@@ -0,0 +1,10 @@
+**To delete the specified service level objective.**
+
+The following ``delete-service-level-objective`` example deletes the specified service level objective. ::
+
+    aws application-signals delete-service-level-objective \
+        --id "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName"
+
+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*.