Merge commit '952d073e8ea55e4a68c6772e443807d86e5a0590' into stage-release-develop

* commit '952d073e8ea55e4a68c6772e443807d86e5a0590':
  Add pagination backcompat for kinesis list-streams

Author: aws-sdk-python-automation

awscli/customizations/kinesis.py

@@ -0,0 +1,46 @@
+# Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# 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.
+
+
+def register_kinesis_list_streams_pagination_backcompat(event_emitter):
+    # The ListStreams previously used the ExclusiveStartStreamName parameter
+    # for input tokens to pagination. This operation was then updated to
+    # also allow for the typical NextToken input and output parameters. The
+    # pagination model was also updated to use the NextToken field instead of
+    # the ExclusiveStartStreamName field for input tokens. However, the
+    # ExclusiveStartStreamName is still a valid parameter to control pagination
+    # of this operation and is incompatible with the NextToken parameter. So,
+    # the CLI needs to continue to treat the ExclusiveStartStreamName as if it
+    # is a raw input token parameter to the API by disabling auto-pagination if
+    # provided. Otherwise, if it was treated as a normal API parameter, errors
+    # would be thrown when paginating across multiple pages since the parameter
+    # is incompatible with the NextToken parameter.
+    event_emitter.register(
+        'building-argument-table.kinesis.list-streams',
+        undocument_exclusive_start_stream_name,
+    )
+    event_emitter.register(
+        'operation-args-parsed.kinesis.list-streams',
+        disable_pagination_when_exclusive_start_stream_name_provided,
+    )
+
+
+def undocument_exclusive_start_stream_name(argument_table, **kwargs):
+    argument_table['exclusive-start-stream-name']._UNDOCUMENTED = True
+
+
+def disable_pagination_when_exclusive_start_stream_name_provided(
+    parsed_args, parsed_globals, **kwargs
+):
+    if parsed_args.exclusive_start_stream_name is not None:
+        parsed_globals.paginate = False

awscli/handlers.py

@@ -92,6 +92,8 @@
 from awscli.customizations.sms_voice import register_sms_voice_hide
 from awscli.customizations.dynamodb import register_dynamodb_paginator_fix
 from awscli.customizations.overridesslcommonname import register_override_ssl_common_name
+from awscli.customizations.kinesis import \
+    register_kinesis_list_streams_pagination_backcompat
 
 
 def awscli_initialize(event_handlers):
@@ -185,3 +187,4 @@ def awscli_initialize(event_handlers):
     register_sms_voice_hide(event_handlers)
     register_dynamodb_paginator_fix(event_handlers)
     register_override_ssl_common_name(event_handlers)
+    register_kinesis_list_streams_pagination_backcompat(event_handlers)

tests/functional/kinesis/test_list_streams.py

@@ -0,0 +1,52 @@
+# Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# 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 json
+
+from awscli.testutils import BaseAWSCommandParamsTest, BaseAWSHelpOutputTest
+
+
+class TestListStreams(BaseAWSCommandParamsTest):
+
+    prefix = ['kinesis', 'list-streams']
+
+    def test_exclusive_start_stream_name_disables_auto_pagination(self):
+        cmdline = self.prefix + ['--exclusive-start-stream-name', 'stream-1']
+        self.parsed_responses = [
+            {
+                'StreamNames': ['stream-1', 'stream-2'],
+                'StreamSummaries': [
+                    {'StreamName': 'stream-1'},
+                    {'StreamName': 'stream-2'},
+                ],
+                'HasMoreStreams': True,
+                'NextToken': 'token',
+            }
+        ]
+        expected_params = {'ExclusiveStartStreamName': 'stream-1'}
+        stdout, _, _ = self.assert_params_for_cmd(cmdline, expected_params)
+        output = json.dumps(stdout)
+        self.assertIn('NextToken', output)
+        self.assertIn('HasMoreStreams', output)
+
+    def test_exclusive_start_stream_name_incompatible_with_page_args(self):
+        cmdline = self.prefix + ['--exclusive-start-stream-name', 'stream-1']
+        cmdline += ['--page-size', '1']
+        _, stderr, _ = self.run_cmd(cmdline, expected_rc=255)
+        self.assertIn('Error during pagination: Cannot specify', stderr)
+        self.assertIn('--page-size', stderr)
+
+
+class TestListStreamsHelp(BaseAWSHelpOutputTest):
+    def test_exclusive_start_stream_name_is_undocumented(self):
+        self.driver.main(['kinesis', 'list-streams', 'help'])
+        self.assert_not_contains('--exclusive-start-steam-name')