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

awscli/customizations/s3/syncstrategy/caseconflict.py

@@ -0,0 +1,96 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+import logging
+import os
+import sys
+
+from awscli.customizations.s3.syncstrategy.base import BaseSync
+from awscli.customizations.utils import uni_print
+
+LOG = logging.getLogger(__name__)
+
+
+class CaseConflictException(Exception):
+    pass
+
+
+class CaseConflictSync(BaseSync):
+    DOC_URI = (
+        "https://docs.aws.amazon.com/cli/v1/topic/"
+        "s3-case-insensitivity.html"
+    )
+
+    def __init__(
+            self,
+            sync_type='file_not_at_dest',
+            on_case_conflict='ignore',
+            submitted=None,
+    ):
+        super().__init__(sync_type)
+        self._on_case_conflict = on_case_conflict
+        if submitted is None:
+            submitted = set()
+        self._submitted = submitted
+
+    @property
+    def submitted(self):
+        return self._submitted
+
+    def determine_should_sync(self, src_file, dest_file):
+        # `src_file.compare_key` and `dest_file.compare_key` are not equal.
+        # This could mean that they're completely different or differ
+        # only by case. eg, `/tmp/a` and `/tmp/b` versus `/tmp/a` and `/tmp/A`.
+        # If the source file's destination already exists, that means it
+        # differs only by case and the conflict needs to be handled.
+        should_sync = True
+        # Normalize compare key for case sensitivity.
+        lower_compare_key = src_file.compare_key.lower()
+        if lower_compare_key in self._submitted or os.path.exists(
+                src_file.dest
+        ):
+            handler = getattr(self, f"_handle_{self._on_case_conflict}")
+            should_sync = handler(src_file)
+        if should_sync:
+            LOG.debug(f"syncing: {src_file.src} -> {src_file.dest}")
+            self._submitted.add(lower_compare_key)
+            # Set properties so that a subscriber can be created
+            # that removes the key from the set after download finishes.
+            src_file.case_conflict_submitted = self._submitted
+            src_file.case_conflict_key = lower_compare_key
+        return should_sync
+
+    @staticmethod
+    def _handle_ignore(src_file):
+        return True
+
+    @staticmethod
+    def _handle_skip(src_file):
+        msg = (
+            f"warning: Skipping {src_file.src} -> {src_file.dest} "
+            "because a file whose name differs only by case either exists "
+            "or is being downloaded.\n"
+        )
+        uni_print(msg, sys.stderr)
+        return False
+
+    @staticmethod
+    def _handle_warn(src_file):
+        msg = (
+            f"warning: Downloading {src_file.src} -> {src_file.dest} "
+            "despite a file whose name differs only by case either existing "
+            "or being downloaded. This behavior is not defined on "
+            "case-insensitive filesystems and may result in overwriting "
+            "existing files or race conditions between concurrent downloads. "
+            f"For more information, see {CaseConflictSync.DOC_URI}.\n"
+        )
+        uni_print(msg, sys.stderr)
+        return True
+
+    @staticmethod
+    def _handle_error(src_file):
+        msg = (
+            f"Failed to download {src_file.src} -> {src_file.dest} "
+            "because a file whose name differs only by case either exists "
+            "or is being downloaded."
+        )
+        raise CaseConflictException(msg)

awscli/customizations/s3/utils.py

@@ -690,6 +690,20 @@ class OnDoneFilteredSubscriber(BaseSubscriber):
         pass
 
 
+class CaseConflictCleanupSubscriber(BaseSubscriber):
+    """
+    A subscriber which removes object compare key from case conflict set
+    when download finishes.
+    """
+
+    def __init__(self, submitted, case_conflict_key):
+        self._submitted = submitted
+        self._key = case_conflict_key
+
+    def on_done(self, future, **kwargs):
+        self._submitted.discard(self._key)
+
+
 class DeleteSourceSubscriber(OnDoneFilteredSubscriber):
     """A subscriber which deletes the source of the transfer."""
     def _on_success(self, future):

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/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/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*.

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*.