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

awscli/examples/servicediscovery/update-instance-custom-health-status.rst

@@ -1,4 +1,4 @@
-**To update a custom health check**
+**Example 1: To update a custom health check**
 
 The following ``update-instance-custom-health-status`` example updates the status of the custom health check for the specified service and example service instance to ``HEALTHY``. ::
 
@@ -10,3 +10,16 @@ The following ``update-instance-custom-health-status`` example updates the statu
 This command produces no output.
 
 For more information, see `AWS Cloud Map service health check configuration <https://docs.aws.amazon.com/cloud-map/latest/dg/services-health-checks.html>`__ in the *AWS Cloud Map Developer Guide*.
+
+**Example 2: To update a custom health check using service ARN**
+
+The following ``update-instance-custom-health-status`` example updates the status of the custom health check using a service ARN. The ARN is required when updating health status for instances associated with namespaces that are shared with the your account. ::
+
+    aws servicediscovery update-instance-custom-health-status \
+        --service-id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita \
+        --instance-id web-server-01 \
+        --status HEALTHY
+
+This command produces no output.
+
+For more information, see `AWS Cloud Map service health check configuration <https://docs.aws.amazon.com/cloud-map/latest/dg/services-health-checks.html>`__ and `Cross-account AWS Cloud Map namespace sharing <https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html>`__ in the *AWS Cloud Map Developer Guide*.

awscli/examples/servicediscovery/update-private-dns-namespace.rst

@@ -1,18 +1,35 @@
-**To update a private DNS namespace**
+**Example 1: To update a private DNS namespace using ID**
 
-The following ``update-private-dns-namespace`` example updates the description of a private DNS namespace. ::
+The following ``update-private-dns-namespace`` example updates the description of a private DNS namespace using namespace ID. ::
 
     aws servicediscovery update-private-dns-namespace \
-        --id ns-bk3aEXAMPLE \
-        --updater-request-id example-private-request-id \
+        --id ns-abcd1234xmpl5678 \
+        --updater-request-id abcd1234-5678-90ab-cdef-xmpl12345678 \
         --namespace Description="The updated namespace description."
 
 Output::
 
     {
-        "OperationId": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd"
+        "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678"
     }
 
 To confirm that the operation succeeded, you can run ``get-operation``.
 
 For more information, see `AWS Cloud Map namespaces <https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-namespaces.html>`__ in the *AWS Cloud Map Developer Guide*.
+
+**Example 2: To update a private DNS namespace using ARN**
+
+The following ``update-private-dns-namespace`` example updates a private DNS namespace using its ARN. ::
+
+    aws servicediscovery update-private-dns-namespace \
+        --id arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-abcd1234xmpl5678 \
+        --updater-request-id abcd1234-5678-90ab-cdef-xmpl12345678 \
+        --namespace Description="The updated namespace description."
+
+Output::
+
+    {
+        "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678"
+    }
+
+For more information, see `AWS Cloud Map namespaces <https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-namespaces.html>`__ in the *AWS Cloud Map Developer Guide*.

awscli/examples/servicediscovery/update-public-dns-namespace.rst

@@ -1,18 +1,35 @@
-**To update a public DNS namespace**
+**Example 1: To update a public DNS namespace using ID**
 
-The following ``update-public-dns-namespace`` example updates the description of a public DNS namespace. ::
+The following ``update-public-dns-namespace`` example updates the description of a public DNS namespace using its ID. ::
 
     aws servicediscovery update-public-dns-namespace \
-        --id ns-bk3aEXAMPLE \
-        --updater-request-id example-public-request-id \
+        --id ns-abcd1234xmpl5678 \
+        --updater-request-id abcd1234-5678-90ab-cdef-xmpl12345678 \
         --namespace Description="The updated namespace description."
 
 Output::
 
     {
-        "OperationId": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd"
+        "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678"
     }
 
 To confirm that the operation succeeded, you can run ``get-operation``.
 
 For more information, see `AWS Cloud Map namespaces <https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-namespaces.html>`__ in the *AWS Cloud Map Developer Guide*.
+
+**Example 2: To update a public DNS namespace using ARN**
+
+The following ``update-public-dns-namespace`` example updates a public DNS namespace using its ARN. ::
+
+    aws servicediscovery update-public-dns-namespace \
+        --id arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-abcd1234xmpl5678 \
+        --updater-request-id abcd1234-5678-90ab-cdef-xmpl12345678 \
+        --namespace Description="The updated namespace description."
+
+Output::
+
+    {
+        "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678"
+    }
+
+For more information, see `AWS Cloud Map namespaces <https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-namespaces.html>`__ in the *AWS Cloud Map Developer Guide*.

awscli/examples/servicediscovery/update-service-attributes.rst

@@ -1,11 +1,23 @@
- **To update a service to add an attribute**
+**Example 1: To update a service to add an attribute**
 
 The following ``update-service-attributes`` example updates the specified service to add a service attribute with a key ``Port`` and a value ``80``. ::
 
     aws servicediscovery update-service-attributes \
-        --service-id srv-e4anhexample0004 \
+        --service-id srv-abcd1234xmpl5678 \
         --attributes Port=80
 
 This command produces no output.
 
 For more information, see `AWS Cloud Map services <https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html>`__ in the *AWS Cloud Map Developer Guide*.
+
+**Example 2: To update a service attributes using ARN**
+
+The following ``update-service-attributes`` example updates a service using its ARN to add a service attribute. Specifying the ARN is necessary for adding attributes to services created in namespaces shared with your account. ::
+
+    aws servicediscovery update-service-attributes \
+        --service-id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678 \
+        --attributes Port=80
+
+This command produces no output.
+
+For more information, see  `AWS Cloud Map services <https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html>`__ and `Shared AWS Cloud Map namespaces <https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html>`__ in the *AWS Cloud Map Developer Guide*.

awscli/examples/servicediscovery/update-service.rst

@@ -1,17 +1,33 @@
-**To update a service**
+**Example 1: To update a service**
 
 The following ``update-service`` example updates a service to update the ``DnsConfig`` and ``HealthCheckConfig`` settings. ::
 
     aws servicediscovery update-service \
-        --id srv-e4anhexample0004 \
-        --service "DnsConfig={DnsRecords=[{"Type"="A","TTL"=60}]},HealthCheckConfig={"Type"="HTTP","ResourcePath"="/","FailureThreshold"="2"}"
+        --id srv-abcd1234xmpl5678 \
+        --service "DnsConfig={DnsRecords=[{Type=A,TTL=60}]},HealthCheckConfig={Type=HTTP,ResourcePath=/,FailureThreshold=2}"
 
 Output::
 
     {
-        "OperationId": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd"
+        "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678"
     }
 
 To confirm that the operation succeeded, you can run ``get-operation``.
 
 For more information about updating a service, see `Updating an AWS Cloud Map service <https://docs.aws.amazon.com/cloud-map/latest/dg/editing-services.html>`__ in the *AWS Cloud Map Developer Guide*.
+
+**Example 2: To update a service using ARN**
+
+The following ``update-service`` example updates a service using its ARN. Specifying an ARN is necessary for services that are created in namespaces shared with your account. ::
+
+    aws servicediscovery update-service \
+        --id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678 \
+        --service "DnsConfig={DnsRecords=[{Type=A,TTL=60}]},HealthCheckConfig={Type=HTTP,ResourcePath=/,FailureThreshold=2}"
+
+Output::
+
+    {
+        "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678"
+    }
+
+For more information about updating a service, see `Updating an AWS Cloud Map service <https://docs.aws.amazon.com/cloud-map/latest/dg/editing-services.html>`__ and `Shared AWS Cloud Map namespaces <https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html>`__ in the *AWS Cloud Map Developer Guide*.

awscli/examples/ssm/put-parameter.rst

@@ -15,7 +15,7 @@ Output::
         "Tier": "Standard"
     }
 
-For more information, see `Create a Systems Manager parameter (AWS CLI) <https://docs.aws.amazon.com/systems-manager/latest/userguide/param-create-cli.html>`__, 'Managing parameter tiers <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html>`__, and `Working with parameter policies <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html>`__ in the *AWS Systems Manager User Guide*.
+For more information, see `Create a Systems Manager parameter (AWS CLI) <https://docs.aws.amazon.com/systems-manager/latest/userguide/param-create-cli.html>`__, `Managing parameter tiers <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html>`__, and `Working with parameter policies <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html>`__ in the *AWS Systems Manager User Guide*.
 
 **Example 2: To create an advanced parameter**
 
@@ -35,11 +35,11 @@ Output::
         "Tier": "Advanced"
     }
 
-For more information, see `Create a Systems Manager parameter (AWS CLI) <https://docs.aws.amazon.com/systems-manager/latest/userguide/param-create-cli.html>`__, 'Managing parameter tiers <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html>`__, and `Working with parameter policies <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html>`__ in the *AWS Systems Manager User Guide*.
+For more information, see `Create a Systems Manager parameter (AWS CLI) <https://docs.aws.amazon.com/systems-manager/latest/userguide/param-create-cli.html>`__, `Managing parameter tiers <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html>`__, and `Working with parameter policies <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html>`__ in the *AWS Systems Manager User Guide*.
 
 **Example 3: To convert a standard parameter to an advanced parameter**
 
-The following ``put-parameter`` example converts a existing standard parameter into an advanced parameter. ::
+The following ``put-parameter`` example converts an existing standard parameter into an advanced parameter. ::
 
     aws ssm put-parameter \
         --name "MyConvertedParameter" \
@@ -55,7 +55,7 @@ Output::
         "Tier": "Advanced"
     }
 
-For more information, see `Create a Systems Manager parameter (AWS CLI) <https://docs.aws.amazon.com/systems-manager/latest/userguide/param-create-cli.html>`__, 'Managing parameter tiers <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html>`__, and `Working with parameter policies <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html>`__ in the *AWS Systems Manager User Guide*.
+For more information, see `Create a Systems Manager parameter (AWS CLI) <https://docs.aws.amazon.com/systems-manager/latest/userguide/param-create-cli.html>`__, `Managing parameter tiers <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html>`__, and `Working with parameter policies <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html>`__ in the *AWS Systems Manager User Guide*.
 
 **Example 4: To create a parameter with a policy attached**
 
@@ -75,7 +75,7 @@ Output::
         "Tier": "Advanced"
     }
 
-For more information, see `Create a Systems Manager parameter (AWS CLI) <https://docs.aws.amazon.com/systems-manager/latest/userguide/param-create-cli.html>`__, 'Managing parameter tiers <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html>`__, and `Working with parameter policies <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html>`__ in the *AWS Systems Manager User Guide*.
+For more information, see `Create a Systems Manager parameter (AWS CLI) <https://docs.aws.amazon.com/systems-manager/latest/userguide/param-create-cli.html>`__, `Managing parameter tiers <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html>`__, and `Working with parameter policies <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html>`__ in the *AWS Systems Manager User Guide*.
 
 **Example 5: To add a policy to an existing parameter**
 
@@ -96,4 +96,4 @@ Output::
         "Tier": "Advanced"
     }
 
-For more information, see `Create a Systems Manager parameter (AWS CLI) <https://docs.aws.amazon.com/systems-manager/latest/userguide/param-create-cli.html>`__, 'Managing parameter tiers <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html>`__, and `Working with parameter policies <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html>`__ in the *AWS Systems Manager User Guide*.
+For more information, see `Create a Systems Manager parameter (AWS CLI) <https://docs.aws.amazon.com/systems-manager/latest/userguide/param-create-cli.html>`__, `Managing parameter tiers <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html>`__, and `Working with parameter policies <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html>`__ in the *AWS Systems Manager User Guide*.

awscli/examples/verifiedpermissions/update-policy.rst

@@ -1,21 +1,22 @@
-**Example 1: To create a static policy**
+**To update a static policy**
 
-The following ``create-policy`` example creates a static policy with a policy scope that specifies both a principal and a resource. ::
+The following ``update-policy`` example modifies an existing static policy by updating its description and statement. ::
 
-    aws verifiedpermissions create-policy \
-        --definition file://definition.txt \
+    aws verifiedpermissions update-policy \
+        --policy-id SPEXAMPLEabcdefg111111 \
+        --definition file://updated-definition.txt \
         --policy-store-id PSEXAMPLEabcdefg111111
 
 The ``statement`` parameter takes a string representation of a JSON object. It contains embedded quotation marks (") within the outermost quotation mark pair. This requires you to convert the JSON to a string by preceding all embedded quotation marks with a backslash character ( \" ) and combining all lines into a single text line with no line breaks.
 
-Example strings can be displayed wrapped across multiple lines here for readability, but the operation requires the parameters be submitted as single line strings.
+You can display example strings wrapped across multiple lines for readability, but the operation requires the parameters to be submitted as single-line strings.
 
-Contents of file ``definition.txt``::
+Contents of file ``updated-definition.txt``::
 
     {
         "static": {
-            "description":  "Grant everyone of janeFriends UserGroup access to the vacationFolder Album",
-            "statement": "permit(principal in UserGroup::\"janeFriends\", action, resource in Album::\"vacationFolder\" );"
+            "description": "Updated policy to grant janeFriends UserGroup access to the vacationFolder Album with view action only",
+            "statement": "permit(principal in UserGroup::\"janeFriends\", action == Action::\"view\", resource in Album::\"vacationFolder\" );"
         }
     }
 
@@ -37,73 +38,4 @@ Output::
         }
     }
 
-**Example 2: To create a static policy that grants access to a resource to everyone**
-
-The following ``create-policy`` example creates a static policy with a policy scope that specifies only a resource. ::
-
-    aws verifiedpermissions create-policy \
-        --definition file://definition2.txt \
-        --policy-store-id PSEXAMPLEabcdefg111111
-
-Contents of file ``definition2.txt``::
-
-    {
-        "static": {
-            "description":  "Grant everyone access to the publicFolder Album",
-            "statement": "permit(principal, action, resource in Album::\"publicFolder\");"
-        }
-    }
-
-Output::
-
-    {
-        "createdDate": "2023-06-12T20:39:44.975897+00:00",
-        "lastUpdatedDate": "2023-06-12T20:39:44.975897+00:00",
-        "policyId": "PbfR73F8oh5MMfr9uRtFDB",
-        "policyStoreId": "PSEXAMPLEabcdefg222222",
-        "policyType": "STATIC",
-        "resource": {
-            "entityId": "publicFolder",
-            "entityType": "Album"
-        }
-    }
-
-**Example 3: To create a template-linked policy that is associated with the specified template**
-
-The following ``create-policy`` example creates a template-linked policy using the specified policy template and associates the specified principal to use with the new template-linked policy. ::
-
-    aws verifiedpermissions create-policy \
-        --definition file://definition2.txt \
-        --policy-store-id PSEXAMPLEabcdefg111111
-
-Contents of definition3.txt::
-
-    {
-        "templateLinked": {
-            "policyTemplateId": "PTEXAMPLEabcdefg111111",
-            "principal": {
-                "entityType": "User",
-                "entityId": "alice"
-            }
-        }
-    }
-
-Output::
-
-    {
-        "createdDate": "2023-06-12T20:49:51.490211+00:00",
-        "lastUpdatedDate": "2023-06-12T20:49:51.490211+00:00",
-        "policyId": "TPEXAMPLEabcdefg111111",
-        "policyStoreId": "PSEXAMPLEabcdefg111111",
-        "policyType": "TEMPLATE_LINKED",
-        "principal": {
-            "entityId": "alice",
-            "entityType": "User"
-        },
-        "resource": {
-            "entityId": "VacationPhoto94.jpg",
-            "entityType": "Photo"
-        }
-    }
-
-For more information about policies, see `Amazon Verified Permissions policies <https://docs.aws.amazon.com/verifiedpermissions/latest/userguide/policies.html>`__ in the *Amazon Verified Permissions User Guide*.
+For more information about policies, see `Amazon Verified Permissions policies <https://docs.aws.amazon.com/verifiedpermissions/latest/userguide/policies.html>`__ in the *Amazon Verified Permissions User Guide*.

awscli/examples/workspaces/describe-workspace-directories.rst

@@ -28,7 +28,6 @@ Output::
                 "WorkspaceSecurityGroupId": "sg-0d89e927e5645d7c5",
                 "State": "REGISTERED",
                 "WorkspaceCreationProperties": {
-                    "EnableWorkDocs": false,
                     "EnableInternetAccess": false,
                     "UserEnabledAsLocalAdministrator": true,
                     "EnableMaintenanceMode": true
@@ -55,4 +54,4 @@ Output::
         ]
     }
 
-For more information, see `Manage directories for WorkSpaces <https://docs.aws.amazon.com/workspaces/latest/adminguide/manage-workspaces-directory.html>`__ in the *Amazon WorkSpaces Administration Guide*.
+For more information, see `Manage directories for WorkSpaces Personal <https://docs.aws.amazon.com/workspaces/latest/adminguide/manage-workspaces-directory.html>`__ in the *Amazon WorkSpaces Administration Guide*.

awscli/examples/workspaces/register-workspace-directory.rst

@@ -3,9 +3,8 @@
 The following ``register-workspace-directory`` example registers the specified directory for use with Amazon WorkSpaces. ::
 
     aws workspaces register-workspace-directory \
-        --directory-id d-926722edaf \
-        --no-enable-work-docs
+        --directory-id d-926722edaf
 
 This command produces no output.
 
-For more information, see `Register a directory with WorkSpaces <https://docs.aws.amazon.com/workspaces/latest/adminguide/register-deregister-directory.html>`__ in the *Amazon WorkSpaces Administration Guide*.
+For more information, see `Register an existing AWS Directory Service directory with WorkSpaces Personal <https://docs.aws.amazon.com/workspaces/latest/adminguide/register-deregister-directory.html>`__ in the *Amazon WorkSpaces Administration Guide*.

awscli/handlers.py

@@ -83,8 +83,6 @@ from awscli.customizations.kinesis import (
 from awscli.customizations.kms import register_fix_kms_create_grant_docs
 from awscli.customizations.logs import register_logs_commands
 from awscli.customizations.mturk import register_alias_mturk_command
-from awscli.customizations.opsworks import initialize as opsworks_init
-from awscli.customizations.opsworkscm import register_alias_opsworks_cm
 from awscli.customizations.overridesslcommonname import (
     register_override_ssl_common_name,
 )
@@ -188,7 +186,6 @@ def awscli_initialize(event_handlers):
     register_get_status(event_handlers)
     register_rename_config(event_handlers)
     register_scalar_parser(event_handlers)
-    opsworks_init(event_handlers)
     register_lambda_create_function(event_handlers)
     register_fix_kms_create_grant_docs(event_handlers)
     register_create_hosted_zone_doc_fix(event_handlers)
@@ -208,7 +205,6 @@ def awscli_initialize(event_handlers):
     register_gamelift_commands(event_handlers)
     register_ec2_page_size_injector(event_handlers)
     cloudformation_init(event_handlers)
-    register_alias_opsworks_cm(event_handlers)
     register_alias_mturk_command(event_handlers)
     register_alias_sagemaker_runtime_command(event_handlers)
     register_alias_socialmessaging_command(event_handlers)

awscli/paramfile.py

@@ -10,6 +10,8 @@
 # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
+import sys
+
 import copy
 import logging
 import os
@@ -20,6 +22,7 @@ from botocore.httpsession import URLLib3Session
 
 from awscli import argprocess
 from awscli.compat import compat_open
+from awscli.utils import resolve_v2_debug_mode
 
 logger = logging.getLogger(__name__)
 
@@ -166,7 +169,7 @@ class URIArgumentHandler:
             prefixes.update(REMOTE_PREFIX_MAP)
         self._prefixes = prefixes
 
-    def __call__(self, event_name, param, value, **kwargs):
+    def __call__(self, event_name, param, value, parsed_globals=None, **kwargs):
         """Handler that supports param values from URIs."""
         cli_argument = param
         qualified_param_name = '.'.join(event_name.split('.')[1:])
@@ -175,13 +178,27 @@ class URIArgumentHandler:
         ):
             return
         else:
-            return self._check_for_uri_param(cli_argument, value)
+            return self._check_for_uri_param(cli_argument, value, parsed_globals)
 
-    def _check_for_uri_param(self, param, value):
+    def _check_for_uri_param(self, param, value, parsed_globals):
         if isinstance(value, list) and len(value) == 1:
             value = value[0]
         try:
-            return get_paramfile(value, self._prefixes)
+            param_file = get_paramfile(value, self._prefixes)
+            if param_file is not None and resolve_v2_debug_mode(parsed_globals):
+                print(
+                    '\nAWS CLI v2 UPGRADE WARNING: For input parameters that '
+                    'have a prefix of `http://` or `https://`, AWS CLI v2 '
+                    'will not automatically request the content of the URL '
+                    'for the parameter, and the `cli_follow_urlparam` option '
+                    'has been removed. For guidance on how to adapt this '
+                    'command to AWS CLI v2 usage, see '
+                    'https://docs.aws.amazon.com/cli/latest/userguide/'
+                    'cliv2-migration-changes.html'
+                    '#cliv2-migration-paramfile.\n',
+                    file=sys.stderr,
+                )
+            return param_file
         except ResourceLoadingError as e:
             raise argprocess.ParamError(param.cli_name, str(e))
 

awscli/testutils.py

@@ -27,7 +27,9 @@ import json
 import logging
 import os
 import platform
+import random
 import shutil
+import string
 import sys
 import tempfile
 import time
@@ -36,6 +38,7 @@ import uuid
 from pprint import pformat
 from subprocess import PIPE, Popen
 from unittest import mock
+from pathlib import Path
 
 import botocore.loaders
 from botocore.awsrequest import AWSResponse
@@ -43,11 +46,17 @@ from botocore.exceptions import ClientError, WaiterError
 
 import awscli.clidriver
 from awscli.compat import BytesIO, StringIO
+from awscli.utils import create_nested_client
 
 _LOADER = botocore.loaders.Loader()
 INTEG_LOG = logging.getLogger('awscli.tests.integration')
 AWS_CMD = None
 
+with tempfile.TemporaryDirectory() as tmpdir:
+    with open(Path(tmpdir) / 'aws-cli-tmp-file', 'w') as f:
+        pass
+    CASE_INSENSITIVE = (Path(tmpdir) / 'AWS-CLI-TMP-FILE').exists()
+
 
 def skip_if_windows(reason):
     """Decorator to skip tests that should not be run on windows.
@@ -68,6 +77,15 @@ def skip_if_windows(reason):
     return decorator
 
 
+def skip_if_case_sensitive():
+    def decorator(func):
+        return unittest.skipIf(
+            not CASE_INSENSITIVE,
+            "This test requires a case-insensitive filesystem."
+        )(func)
+    return decorator
+
+
 def create_clidriver():
     driver = awscli.clidriver.create_clidriver()
     session = driver.session
@@ -143,7 +161,7 @@ def create_bucket(session, name=None, region=None):
     """
     if not region:
         region = 'us-west-2'
-    client = session.create_client('s3', region_name=region)
+    client = create_nested_client(session, 's3', region_name=region)
     if name:
         bucket_name = name
     else:
@@ -172,7 +190,7 @@ def create_dir_bucket(session, name=None, location=None):
     if not location:
         location = ('us-west-2', 'usw2-az1')
     region, az = location
-    client = session.create_client('s3', region_name=region)
+    client = create_nested_client(session, 's3', region_name=region)
     if name:
         bucket_name = name
     else:
@@ -778,7 +796,7 @@ class BaseS3CLICommand(unittest.TestCase):
         self.session = botocore.session.get_session()
         self.regions = {}
         self.region = 'us-west-2'
-        self.client = self.session.create_client('s3', region_name=self.region)
+        self.client = create_nested_client(self.session, 's3', region_name=self.region)
         self.extra_setup()
 
     def extra_setup(self):
@@ -799,7 +817,7 @@ class BaseS3CLICommand(unittest.TestCase):
 
     def create_client_for_bucket(self, bucket_name):
         region = self.regions.get(bucket_name, self.region)
-        client = self.session.create_client('s3', region_name=region)
+        client = create_nested_client(self.session, 's3', region_name=region)
         return client
 
     def assert_key_contents_equal(self, bucket, key, expected_contents):

awscli/topics/config-vars.rst

@@ -98,7 +98,7 @@ The valid values of the ``output`` configuration variable are:
 ``cli_timestamp_format`` controls the format of timestamps displayed by the AWS CLI.
 The valid values of the ``cli_timestamp_format`` configuration variable are:
 
-* none - Display the timestamp exactly as received from the HTTP response.
+* wire - Display the timestamp exactly as received from the HTTP response.
 * iso8601 - Reformat timestamp using iso8601 in the UTC timezone.
 
 ``cli_follow_urlparam`` controls whether or not the CLI will attempt to follow

awscli/topics/s3-case-insensitivity.rst

@@ -0,0 +1,105 @@
+:title: AWS CLI S3 Case-Insensitivity
+:description: Using 'aws s3' commands on case-insensitive filesystems
+:category: S3
+:related command: s3 cp, s3 sync, s3 mv
+
+
+This page explains how to detect and handle potential case conflicts when
+downloading multiple objects from S3 to a local case-insensitive filesystem
+using a single AWS CLI command.
+
+Case conflicts
+==============
+S3 object keys are case-sensitive meaning that a bucket can have a set of
+key names that differ only by case, for example, ``a.txt`` and ``A.txt``.
+
+The AWS CLI offers high-level S3 commands that manage transfers of
+multiple S3 objects using a single command:
+
+* ``aws s3 sync``
+* ``aws s3 cp --recursive``
+* ``aws s3 mv --recursive``
+
+Case conflicts can occur on case-insensitive filesystems when an S3 bucket
+has multiple objects whose keys differ only by case and a single AWS CLI
+command is called to download multiple S3 objects **OR** a local file
+already exists whose name differs only by case.
+
+For example, consider an S3 bucket with the following stored objects:
+
+* ``a.txt``
+* ``A.txt``
+
+When the following AWS CLI command is called, the AWS CLI will submit
+requests to download ``a.txt`` and ``A.txt``. Since only
+one can exist on a case-insensitive filesystem, the last download to finish
+will be the file that's locally available.
+
+.. code-block::
+
+    aws s3 sync s3://examplebucket ./mylocaldir
+
+Detecting and handling case conflicts
+=====================================
+To detect and handle case conflicts, you can specify the ``--case-conflict``
+parameter. The following values are valid options:
+
+* ``error`` - When a case conflict is detected, the command will immediately
+  fail and abort in-progress downloads.
+* ``warn`` - When a case conflict is detected, the AWS CLI will
+  display a warning.
+* ``skip`` - When a case conflict is detected, the command will skip
+  downloading the object and continue and display a warning.
+* ``ignore`` - (Default) Case conflicts will not be detected or handled.
+
+
+Continuing the prior example, the following describes what happens when
+appending the ``--case-conflict`` parameter with possible values:
+
+``--case-conflict error``
+
+1. Submit a download request for ``A.txt``.
+2. Detect that ``a.txt`` conflicts with an object that's been submitted for download.
+3. Throw an error. If ``A.txt`` finished downloading, it will be locally available. Otherwise, the download request for ``A.txt`` will be aborted.
+
+``--case-conflict warn``
+
+1. Submit a download request for ``A.txt``.
+2. Detect that ``a.txt`` conflicts with an object that's been submitted for download.
+3. Display a warning.
+4. Submit a download request for ``a.txt``, downloading ``A.txt`` and ``a.txt`` in parallel.
+
+``--case-conflict skip``
+
+1. Submit a download request for ``A.txt``.
+2. Detect that ``a.txt`` conflicts with an object that's been submitted for download.
+3. Skip downloading ``a.txt`` and continue.
+
+``--case-conflict ignore``
+
+1. Submit a download request for ``A.txt``.
+2. Submit a download request for ``a.txt``, downloading ``A.txt`` and ``a.txt`` in parallel.
+
+If your local filesystem is case-sensitive, there's no need to detect and
+handle case conflicts. We recommend setting ``--case-conflict ignore``
+in this case.
+
+S3 Express directory buckets
+============================
+Detecting case conflicts is **NOT** supported when the source is an S3 Express
+directory bucket. When operating on directory buckets, valid values for the
+``--case-conflict`` parameter are:
+
+* ``warn``
+* ``ignore``
+
+The following values are invalid when operating on directory buckets:
+
+* ``error``
+* ``skip``
+
+For example, calling the following command will fail:
+
+.. code-block::
+
+    aws s3 cp s3://mydirbucket--usw2-az1--x-s3 ./mylocaldir --recursive --case-conflict error