diff -Nru awscli-1.16.301/awscli/clidocs.py awscli-1.17.14/awscli/clidocs.py --- awscli-1.16.301/awscli/clidocs.py 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/clidocs.py 2020-02-10 19:14:32.000000000 +0000 @@ -487,7 +487,7 @@ doc.style.h2('Output') operation_model = help_command.obj output_shape = operation_model.output_shape - if output_shape is None: + if output_shape is None or not output_shape.members: doc.write('None') else: for member_name, member_shape in output_shape.members.items(): diff -Nru awscli-1.16.301/awscli/compat.py awscli-1.17.14/awscli/compat.py --- awscli-1.16.301/awscli/compat.py 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/compat.py 2020-02-10 19:14:32.000000000 +0000 @@ -11,6 +11,7 @@ # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import sys +import re import shlex import os import os.path @@ -343,4 +344,184 @@ yield finally: for sig, user_signal in enumerate(signal_list): - signal.signal(user_signal, actual_signals[sig]) \ No newline at end of file + signal.signal(user_signal, actual_signals[sig]) + + +# linux_distribution is used by the CodeDeploy customization. Python 3.8 +# removed it from the stdlib, so it is vendored here in the case where the +# import fails. +try: + from platform import linux_distribution +except ImportError: + _UNIXCONFDIR = '/etc' + def _dist_try_harder(distname, version, id): + + """ Tries some special tricks to get the distribution + information in case the default method fails. + Currently supports older SuSE Linux, Caldera OpenLinux and + Slackware Linux distributions. + """ + if os.path.exists('/var/adm/inst-log/info'): + # SuSE Linux stores distribution information in that file + distname = 'SuSE' + with open('/var/adm/inst-log/info') as f: + for line in f: + tv = line.split() + if len(tv) == 2: + tag, value = tv + else: + continue + if tag == 'MIN_DIST_VERSION': + version = value.strip() + elif tag == 'DIST_IDENT': + values = value.split('-') + id = values[2] + return distname, version, id + + if os.path.exists('/etc/.installed'): + # Caldera OpenLinux has some infos in that file (thanks to Colin Kong) + with open('/etc/.installed') as f: + for line in f: + pkg = line.split('-') + if len(pkg) >= 2 and pkg[0] == 'OpenLinux': + # XXX does Caldera support non Intel platforms ? If yes, + # where can we find the needed id ? + return 'OpenLinux', pkg[1], id + + if os.path.isdir('/usr/lib/setup'): + # Check for slackware version tag file (thanks to Greg Andruk) + verfiles = os.listdir('/usr/lib/setup') + for n in range(len(verfiles)-1, -1, -1): + if verfiles[n][:14] != 'slack-version-': + del verfiles[n] + if verfiles: + verfiles.sort() + distname = 'slackware' + version = verfiles[-1][14:] + return distname, version, id + + return distname, version, id + + _release_filename = re.compile(r'(\w+)[-_](release|version)', re.ASCII) + _lsb_release_version = re.compile(r'(.+)' + r' release ' + r'([\d.]+)' + r'[^(]*(?:\((.+)\))?', re.ASCII) + _release_version = re.compile(r'([^0-9]+)' + r'(?: release )?' + r'([\d.]+)' + r'[^(]*(?:\((.+)\))?', re.ASCII) + + # See also http://www.novell.com/coolsolutions/feature/11251.html + # and http://linuxmafia.com/faq/Admin/release-files.html + # and http://data.linux-ntfs.org/rpm/whichrpm + # and http://www.die.net/doc/linux/man/man1/lsb_release.1.html + + _supported_dists = ( + 'SuSE', 'debian', 'fedora', 'redhat', 'centos', + 'mandrake', 'mandriva', 'rocks', 'slackware', 'yellowdog', 'gentoo', + 'UnitedLinux', 'turbolinux', 'arch', 'mageia') + + def _parse_release_file(firstline): + + # Default to empty 'version' and 'id' strings. Both defaults are used + # when 'firstline' is empty. 'id' defaults to empty when an id can not + # be deduced. + version = '' + id = '' + + # Parse the first line + m = _lsb_release_version.match(firstline) + if m is not None: + # LSB format: "distro release x.x (codename)" + return tuple(m.groups()) + + # Pre-LSB format: "distro x.x (codename)" + m = _release_version.match(firstline) + if m is not None: + return tuple(m.groups()) + + # Unknown format... take the first two words + l = firstline.strip().split() + if l: + version = l[0] + if len(l) > 1: + id = l[1] + return '', version, id + + _distributor_id_file_re = re.compile("(?:DISTRIB_ID\s*=)\s*(.*)", re.I) + _release_file_re = re.compile("(?:DISTRIB_RELEASE\s*=)\s*(.*)", re.I) + _codename_file_re = re.compile("(?:DISTRIB_CODENAME\s*=)\s*(.*)", re.I) + + def linux_distribution(distname='', version='', id='', + supported_dists=_supported_dists, + full_distribution_name=1): + return _linux_distribution(distname, version, id, supported_dists, + full_distribution_name) + + def _linux_distribution(distname, version, id, supported_dists, + full_distribution_name): + + """ Tries to determine the name of the Linux OS distribution name. + The function first looks for a distribution release file in + /etc and then reverts to _dist_try_harder() in case no + suitable files are found. + supported_dists may be given to define the set of Linux + distributions to look for. It defaults to a list of currently + supported Linux distributions identified by their release file + name. + If full_distribution_name is true (default), the full + distribution read from the OS is returned. Otherwise the short + name taken from supported_dists is used. + Returns a tuple (distname, version, id) which default to the + args given as parameters. + """ + # check for the Debian/Ubuntu /etc/lsb-release file first, needed so + # that the distribution doesn't get identified as Debian. + # https://bugs.python.org/issue9514 + try: + with open("/etc/lsb-release", "r") as etclsbrel: + for line in etclsbrel: + m = _distributor_id_file_re.search(line) + if m: + _u_distname = m.group(1).strip() + m = _release_file_re.search(line) + if m: + _u_version = m.group(1).strip() + m = _codename_file_re.search(line) + if m: + _u_id = m.group(1).strip() + if _u_distname and _u_version: + return (_u_distname, _u_version, _u_id) + except (EnvironmentError, UnboundLocalError): + pass + + try: + etc = os.listdir(_UNIXCONFDIR) + except OSError: + # Probably not a Unix system + return distname, version, id + etc.sort() + for file in etc: + m = _release_filename.match(file) + if m is not None: + _distname, dummy = m.groups() + if _distname in supported_dists: + distname = _distname + break + else: + return _dist_try_harder(distname, version, id) + + # Read the first line + with open(os.path.join(_UNIXCONFDIR, file), 'r', + encoding='utf-8', errors='surrogateescape') as f: + firstline = f.readline() + _distname, _version, _id = _parse_release_file(firstline) + + if _distname and full_distribution_name: + distname = _distname + if _version: + version = _version + if _id: + id = _id + return distname, version, id diff -Nru awscli-1.16.301/awscli/customizations/argrename.py awscli-1.17.14/awscli/customizations/argrename.py --- awscli-1.16.301/awscli/customizations/argrename.py 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/customizations/argrename.py 2020-02-10 19:14:32.000000000 +0000 @@ -58,6 +58,18 @@ 'apigatewayv2.update-api.version': 'api-version', 'pinpoint.get-campaign-version.version': 'campaign-version', 'pinpoint.get-segment-version.version': 'segment-version', + 'pinpoint.delete-email-template.version': 'template-version', + 'pinpoint.delete-push-template.version': 'template-version', + 'pinpoint.delete-sms-template.version': 'template-version', + 'pinpoint.delete-voice-template.version': 'template-version', + 'pinpoint.get-email-template.version': 'template-version', + 'pinpoint.get-push-template.version': 'template-version', + 'pinpoint.get-sms-template.version': 'template-version', + 'pinpoint.get-voice-template.version': 'template-version', + 'pinpoint.update-email-template.version': 'template-version', + 'pinpoint.update-push-template.version': 'template-version', + 'pinpoint.update-sms-template.version': 'template-version', + 'pinpoint.update-voice-template.version': 'template-version', 'stepfunctions.send-task-success.output': 'task-output', 'clouddirectory.publish-schema.version': 'schema-version', 'mturk.list-qualification-types.query': 'types-query', diff -Nru awscli-1.16.301/awscli/customizations/cloudtrail/validation.py awscli-1.17.14/awscli/customizations/cloudtrail/validation.py --- awscli-1.16.301/awscli/customizations/cloudtrail/validation.py 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/customizations/cloudtrail/validation.py 2020-02-10 19:14:32.000000000 +0000 @@ -134,12 +134,15 @@ "trail: '--account-id'") organization_id = organization_client.describe_organization()[ 'Organization']['Id'] - if not account_id: - account_id = get_account_id_from_arn(trail_arn) + # Determine the region from the ARN (e.g., arn:aws:cloudtrail:REGION:...) trail_region = trail_arn.split(':')[3] # Determine the name from the ARN (the last part after "/") trail_name = trail_arn.split('/')[-1] + # If account id is not specified parse it from trail ARN + if not account_id: + account_id = get_account_id_from_arn(trail_arn) + digest_provider = DigestProvider( account_id=account_id, trail_name=trail_name, s3_client_provider=s3_client_provider, diff -Nru awscli-1.16.301/awscli/customizations/codedeploy/utils.py awscli-1.17.14/awscli/customizations/codedeploy/utils.py --- awscli-1.16.301/awscli/customizations/codedeploy/utils.py 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/customizations/codedeploy/utils.py 2020-02-10 19:14:32.000000000 +0000 @@ -14,10 +14,12 @@ import platform import re +import awscli.compat from awscli.compat import urlopen, URLError from awscli.customizations.codedeploy.systems import System, Ubuntu, Windows, RHEL from socket import timeout + MAX_INSTANCE_NAME_LENGTH = 100 MAX_TAGS_PER_INSTANCE = 10 MAX_TAG_KEY_LENGTH = 128 @@ -99,9 +101,10 @@ def validate_instance(params): if platform.system() == 'Linux': - if 'Ubuntu' in platform.linux_distribution()[0]: + distribution = awscli.compat.linux_distribution()[0] + if 'Ubuntu' in distribution: params.system = Ubuntu(params) - if 'Red Hat Enterprise Linux Server' in platform.linux_distribution()[0]: + if 'Red Hat Enterprise Linux Server' in distribution: params.system = RHEL(params) elif platform.system() == 'Windows': params.system = Windows(params) diff -Nru awscli-1.16.301/awscli/customizations/dynamodb.py awscli-1.17.14/awscli/customizations/dynamodb.py --- awscli-1.16.301/awscli/customizations/dynamodb.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/customizations/dynamodb.py 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,53 @@ +# Copyright 2020 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 base64 +import binascii +import logging + +from awscli.compat import six + +logger = logging.getLogger(__name__) + + +def register_dynamodb_paginator_fix(event_emitter): + DynamoDBPaginatorFix(event_emitter).register_events() + + +def parse_last_evaluated_key_binary(parsed, **kwargs): + # Because we disable parsing blobs into a binary type and leave them as + # a base64 string if a binary field is present in the continuation token + # as is the case with dynamodb the binary will be double encoded. This + # ensures that the continuation token is properly converted to binary to + # avoid double encoding the contination token. + last_evaluated_key = parsed.get('LastEvaluatedKey', None) + if last_evaluated_key is None: + return + for key, val in last_evaluated_key.items(): + if 'B' in val: + val['B'] = base64.b64decode(val['B']) + + +class DynamoDBPaginatorFix(object): + def __init__(self, event_emitter): + self._event_emitter = event_emitter + + def register_events(self): + self._event_emitter.register( + 'calling-command.dynamodb.*', self._maybe_register_pagination_fix + ) + + def _maybe_register_pagination_fix(self, parsed_globals, **kwargs): + if parsed_globals.paginate: + self._event_emitter.register( + 'after-call.dynamodb.*', parse_last_evaluated_key_binary + ) diff -Nru awscli-1.16.301/awscli/customizations/ec2/bundleinstance.py awscli-1.17.14/awscli/customizations/ec2/bundleinstance.py --- awscli-1.16.301/awscli/customizations/ec2/bundleinstance.py 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/customizations/ec2/bundleinstance.py 2020-02-10 19:14:32.000000000 +0000 @@ -98,8 +98,8 @@ logger.debug(parsed_args) arg_dict = vars(parsed_args) if arg_dict['storage']: - for key in ('bucket', 'prefix', 'owner-akid', - 'owner-sak', 'policy'): + for key in ('bucket', 'prefix', 'owner_akid', + 'owner_sak', 'policy'): if arg_dict[key]: msg = ('Mixing the --storage option ' 'with the simple, scalar options is ' diff -Nru awscli-1.16.301/awscli/customizations/ecr.py awscli-1.17.14/awscli/customizations/ecr.py --- awscli-1.16.301/awscli/customizations/ecr.py 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/customizations/ecr.py 2020-02-10 19:14:32.000000000 +0000 @@ -18,15 +18,16 @@ def register_ecr_commands(cli): - cli.register('building-command-table.ecr', _inject_get_login) + cli.register('building-command-table.ecr', _inject_commands) -def _inject_get_login(command_table, session, **kwargs): +def _inject_commands(command_table, session, **kwargs): command_table['get-login'] = ECRLogin(session) + command_table['get-login-password'] = ECRGetLoginPassword(session) class ECRLogin(BasicCommand): - """Log in with docker login""" + """Log in with 'docker login'""" NAME = 'get-login' DESCRIPTION = BasicCommand.FROM_FILE('ecr/get-login_description.rst') @@ -49,8 +50,8 @@ 'help_text': ( "Specify if the '-e' flag should be included in the " "'docker login' command. The '-e' option has been deprecated " - "and is removed in docker version 17.06 and later. You must " - "specify --no-include-email if you're using docker version " + "and is removed in Docker version 17.06 and later. You must " + "specify --no-include-email if you're using Docker version " "17.06 or later. The default behavior is to include the " "'-e' flag in the 'docker login' output."), }, @@ -83,3 +84,24 @@ sys.stdout.write(' '.join(command)) sys.stdout.write('\n') return 0 + + +class ECRGetLoginPassword(BasicCommand): + """Get a password to be used with container clients such as Docker""" + NAME = 'get-login-password' + + DESCRIPTION = BasicCommand.FROM_FILE( + 'ecr/get-login-password_description.rst') + + def _run_main(self, parsed_args, parsed_globals): + ecr_client = create_client_from_parsed_globals( + self._session, + 'ecr', + parsed_globals) + result = ecr_client.get_authorization_token() + auth = result['authorizationData'][0] + auth_token = b64decode(auth['authorizationToken']).decode() + _, password = auth_token.split(':') + sys.stdout.write(password) + sys.stdout.write('\n') + return 0 diff -Nru awscli-1.16.301/awscli/customizations/emr/createcluster.py awscli-1.17.14/awscli/customizations/emr/createcluster.py --- awscli-1.16.301/awscli/customizations/emr/createcluster.py 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/customizations/emr/createcluster.py 2020-02-10 19:14:32.000000000 +0000 @@ -545,8 +545,8 @@ parsed_args, parsed_configs): if parsed_args.use_default_roles: configurations = [x for x in configurations - if x.name is not 'service_role' and - x.name is not 'instance_profile'] + if x.name != 'service_role' and + x.name != 'instance_profile'] return configurations def _handle_emrfs_parameters(self, cluster, emrfs_args, release_label): diff -Nru awscli-1.16.301/awscli/customizations/emr/emrutils.py awscli-1.17.14/awscli/customizations/emr/emrutils.py --- awscli-1.16.301/awscli/customizations/emr/emrutils.py 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/customizations/emr/emrutils.py 2020-02-10 19:14:32.000000000 +0000 @@ -240,7 +240,7 @@ values = [str(x) for x in values] if len(values) < 1: return "" - elif len(values) is 1: + elif len(values) == 1: return values[0] else: separator = '%s ' % separator diff -Nru awscli-1.16.301/awscli/customizations/s3uploader.py awscli-1.17.14/awscli/customizations/s3uploader.py --- awscli-1.16.301/awscli/customizations/s3uploader.py 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/customizations/s3uploader.py 2020-02-10 19:14:32.000000000 +0000 @@ -90,7 +90,7 @@ # Check if a file with same data exists if not self.force_upload and self.file_exists(remote_path): - LOG.debug("File with same data is already exists at {0}. " + LOG.debug("File with same data already exists at {0}. " "Skipping upload".format(remote_path)) return self.make_url(remote_path) diff -Nru awscli-1.16.301/awscli/examples/alexaforbusiness/create-network-profile.rst awscli-1.17.14/awscli/examples/alexaforbusiness/create-network-profile.rst --- awscli-1.16.301/awscli/examples/alexaforbusiness/create-network-profile.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/alexaforbusiness/create-network-profile.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,17 @@ +**To create a network profile** + +The following ``create-network-profile`` example creates a network profile with the specified details. :: + + aws alexaforbusiness create-network-profile \ + --network-profile-name Network123 \ + --ssid Janenetwork \ + --security-type WPA2_PSK \ + --current-password 12345 + +Output:: + + { + "NetworkProfileArn": "arn:aws:a4b:us-east-1:123456789012:network-profile/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222" + } + +For more information, see `Managing Network Profiles `__ in the *Alexa for Business Administration Guide*. diff -Nru awscli-1.16.301/awscli/examples/alexaforbusiness/delete-network-profile.rst awscli-1.17.14/awscli/examples/alexaforbusiness/delete-network-profile.rst --- awscli-1.16.301/awscli/examples/alexaforbusiness/delete-network-profile.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/alexaforbusiness/delete-network-profile.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a network profile** + +The following ``delete-network-profile`` example deletes the specified network profile. :: + + aws alexaforbusiness delete-network-profile \ + --network-profile-arn arn:aws:a4b:us-east-1:123456789012:network-profile/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222 + +This command produces no output. + +For more information, see `Managing Network Profiles `__ in the *Alexa for Business Administration Guide*. diff -Nru awscli-1.16.301/awscli/examples/alexaforbusiness/get-network-profile.rst awscli-1.17.14/awscli/examples/alexaforbusiness/get-network-profile.rst --- awscli-1.16.301/awscli/examples/alexaforbusiness/get-network-profile.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/alexaforbusiness/get-network-profile.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,20 @@ +**To get network profile details** + +The following ``get-network-profile`` example retrieves details of the specified network profile. :: + + aws alexaforbusiness get-network-profile \ + --network-profile-arn arn:aws:a4b:us-east-1:123456789012:network-profile/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 + +Output:: + + { + "NetworkProfile": { + "NetworkProfileArn": "arn:aws:a4b:us-east-1:123456789012:network-profile/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "NetworkProfileName": "Networkprofile", + "Ssid": "Janenetwork", + "SecurityType": "WPA2_PSK", + "CurrentPassword": "12345" + } + } + +For more information, see `Managing Network Profiles `__ in the *Alexa for Business Administration Guide*. diff -Nru awscli-1.16.301/awscli/examples/alexaforbusiness/search-network-profiles.rst awscli-1.17.14/awscli/examples/alexaforbusiness/search-network-profiles.rst --- awscli-1.16.301/awscli/examples/alexaforbusiness/search-network-profiles.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/alexaforbusiness/search-network-profiles.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,34 @@ +**To search network profiles** + +The following ``search-network-profiles`` example lists network profiles that meet a set of filter and sort criteria. In this example, all profiles are listed. :: + + aws alexaforbusiness search-network-profiles + +Output:: + + { + "NetworkProfiles": [ + { + "NetworkProfileArn": "arn:aws:a4b:us-east-1:123456789111:network-profile/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", + "NetworkProfileName": "Networkprofile1", + "Description": "Personal network", + "Ssid": "Janenetwork", + "SecurityType": "WPA2_PSK" + }, + { + "NetworkProfileArn": "arn:aws:a4b:us-east-1:123456789222:network-profile/a1b2c3d4-5678-90ab-cdef-EXAMPLE44444/a1b2c3d4-5678-90ab-cdef-EXAMPLE55555", + "NetworkProfileName": "Networkprofile2", + "Ssid": "Johnnetwork", + "SecurityType": "WPA2_PSK" + }, + { + "NetworkProfileArn": "arn:aws:a4b:us-east-1:123456789333:network-profile/a1b2c3d4-5678-90ab-cdef-EXAMPLE66666/a1b2c3d4-5678-90ab-cdef-EXAMPLE77777", + "NetworkProfileName": "Networkprofile3", + "Ssid": "Carlosnetwork", + "SecurityType": "WPA2_PSK" + } + ], + "TotalCount": 3 + } + +For more information, see `Managing Network Profiles `__ in the *Alexa for Business Administration Guide*. diff -Nru awscli-1.16.301/awscli/examples/alexaforbusiness/update-network-profile.rst awscli-1.17.14/awscli/examples/alexaforbusiness/update-network-profile.rst --- awscli-1.16.301/awscli/examples/alexaforbusiness/update-network-profile.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/alexaforbusiness/update-network-profile.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,11 @@ +**To update a network profile** + +The following ``update-network-profile`` example updates the specified network profile by using the network profile ARN. :: + + aws alexaforbusiness update-network-profile \ + --network-profile-arn arn:aws:a4b:us-east-1:123456789012:network-profile/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ + --network-profile-name Networkprofile + +This command produces no output. + +For more information, see `Managing Network Profiles `__ in the *Alexa for Business Administration Guide*. diff -Nru awscli-1.16.301/awscli/examples/apigateway/update-integration.rst awscli-1.17.14/awscli/examples/apigateway/update-integration.rst --- awscli-1.16.301/awscli/examples/apigateway/update-integration.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/apigateway/update-integration.rst 2020-02-10 19:14:32.000000000 +0000 @@ -2,23 +2,38 @@ Command:: - aws apigateway update-integration --rest-api-id a1b2c3d4e5 --resource-id a1b2c3 --http-method POST --patch-operations op='add',path='/requestTemplates/application~1json' + aws apigateway update-integration \ + --rest-api-id a1b2c3d4e5 \ + --resource-id a1b2c3 \ + --http-method POST \ + --patch-operations "op='add',path='/requestTemplates/application~1json'" **To update (replace) the 'Content-Type: application/json' Mapping Template configured with a custom template** Command:: - aws apigateway update-integration --rest-api-id a1b2c3d4e5 --resource-id a1b2c3 --http-method POST --patch-operations op='replace',path='/requestTemplates/application~1json',value='{"example": "json"}' + aws apigateway update-integration \ + --rest-api-id a1b2c3d4e5 \ + --resource-id a1b2c3 \ + --http-method POST \ + --patch-operations "op='replace',path='/requestTemplates/application~1json',value='{"example": "json"}'" **To update (replace) a custom template associated with 'Content-Type: application/json' with Input Passthrough** Command:: - aws apigateway update-integration --rest-api-id a1b2c3d4e5 --resource-id a1b2c3 --http-method POST --patch-operations op='replace',path='requestTemplates/application~1json' + aws apigateway update-integration \ + --rest-api-id a1b2c3d4e5 \ + --resource-id a1b2c3 \ + --http-method POST \ + --patch-operations "op='replace',path='requestTemplates/application~1json'" **To remove the 'Content-Type: application/json' Mapping Template** Command:: - aws apigateway update-integration --rest-api-id a1b2c3d4e5 --resource-id a1b2c3 --http-method POST --patch-operations op='remove',path='/requestTemplates/application~1json' - + aws apigateway update-integration \ + --rest-api-id a1b2c3d4e5 \ + --resource-id a1b2c3 \ + --http-method POST \ + --patch-operations "op='remove',path='/requestTemplates/application~1json'" diff -Nru awscli-1.16.301/awscli/examples/application-autoscaling/register-scalable-target.rst awscli-1.17.14/awscli/examples/application-autoscaling/register-scalable-target.rst --- awscli-1.16.301/awscli/examples/application-autoscaling/register-scalable-target.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/application-autoscaling/register-scalable-target.rst 2020-02-10 19:14:32.000000000 +0000 @@ -90,4 +90,26 @@ https://example.execute-api.us-west-2.amazonaws.com/prod/scalableTargetDimensions/1-23456789 +**Example 9: To register a new scalable target for Amazon Comprehend** + +The following ``register-scalable-target`` example registers the desired number of inference units to be used by the model for an Amazon Comprehend document classifier endpoint using the endpoint's ARN, with a minimum capacity of 1 inference unit and a maximum capacity of 3 inference units. Each inference unit represents a throughput of 100 characters per second. :: + + aws application-autoscaling register-scalable-target \ + --service-namespace comprehend \ + --scalable-dimension comprehend:document-classifier-endpoint:DesiredInferenceUnits \ + --resource-id arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE \ + --min-capacity 1 \ + --max-capacity 3 + +**Example 10: To register a new scalable target for AWS Lambda** + +The following ``register-scalable-target`` example registers the provisioned concurrency for an alias called ``BLUE`` for the Lambda function called ``my-function``, with a minimum capacity of 0 and a maximum capacity of 100. :: + + aws application-autoscaling register-scalable-target \ + --service-namespace lambda \ + --scalable-dimension lambda:function:ProvisionedConcurrency \ + --resource-id function:my-function:BLUE \ + --min-capacity 0 \ + --max-capacity 100 + For more information, see the `Application Auto Scaling User Guide `__. diff -Nru awscli-1.16.301/awscli/examples/budgets/create-budget.rst awscli-1.17.14/awscli/examples/budgets/create-budget.rst --- awscli-1.16.301/awscli/examples/budgets/create-budget.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/budgets/create-budget.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,57 +1,61 @@ -**To create a Cost and Usage budget** - -This example creates a Cost and Usage budget. - -Command:: - - aws budgets create-budget --account-id 111122223333 --budget file://budget.json --notifications-with-subscribers file://notifications-with-subscribers.json - -budget.json:: - - { - "BudgetLimit": { - "Amount": "100", - "Unit": "USD" - }, - "BudgetName": "Example Budget", - "BudgetType": "COST", - "CostFilters": { - "AZ" : [ "us-east-1" ] - }, - "CostTypes": { - "IncludeCredit": true, - "IncludeDiscount": true, - "IncludeOtherSubscription": true, - "IncludeRecurring": true, - "IncludeRefund": true, - "IncludeSubscription": true, - "IncludeSupport": true, - "IncludeTax": true, - "IncludeUpfront": true, - "UseBlended": false - }, - "TimePeriod": { - "Start": 1477958399, - "End": 3706473600 - }, - "TimeUnit": "MONTHLY" - } - -notifications-with-subscribers.json:: - - [ - { - "Notification": { - "ComparisonOperator": "GREATER_THAN", - "NotificationType": "ACTUAL", - "Threshold": 80, - "ThresholdType": "PERCENTAGE" - }, - "Subscribers": [ - { - "Address": "example@example.com", - "SubscriptionType": "EMAIL" - } - ] - } - ] +**To create a Cost and Usage budget** + +The following ``create-budget`` command creates a Cost and Usage budget. :: + + aws budgets create-budget \ + --account-id 111122223333 \ + --budget file://budget.json \ + --notifications-with-subscribers file://notifications-with-subscribers.json + +Contents of ``budget.json``:: + + { + "BudgetLimit": { + "Amount": "100", + "Unit": "USD" + }, + "BudgetName": "Example Tag Budget", + "BudgetType": "COST", + "CostFilters": { + "TagKeyValue": [ + "user:Key$value1", + "user:Key$value2" + ] + }, + "CostTypes": { + "IncludeCredit": true, + "IncludeDiscount": true, + "IncludeOtherSubscription": true, + "IncludeRecurring": true, + "IncludeRefund": true, + "IncludeSubscription": true, + "IncludeSupport": true, + "IncludeTax": true, + "IncludeUpfront": true, + "UseBlended": false + }, + "TimePeriod": { + "Start": 1477958399, + "End": 3706473600 + }, + "TimeUnit": "MONTHLY" + } + +Contents of ``notifications-with-subscribers.json``:: + + [ + { + "Notification": { + "ComparisonOperator": "GREATER_THAN", + "NotificationType": "ACTUAL", + "Threshold": 80, + "ThresholdType": "PERCENTAGE" + }, + "Subscribers": [ + { + "Address": "example@example.com", + "SubscriptionType": "EMAIL" + } + ] + } + ] diff -Nru awscli-1.16.301/awscli/examples/chime/associate-phone-numbers-with-voice-connector.rst awscli-1.17.14/awscli/examples/chime/associate-phone-numbers-with-voice-connector.rst --- awscli-1.16.301/awscli/examples/chime/associate-phone-numbers-with-voice-connector.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/chime/associate-phone-numbers-with-voice-connector.rst 2020-02-10 19:14:32.000000000 +0000 @@ -5,6 +5,7 @@ aws chime associate-phone-numbers-with-voice-connector \ --voice-connector-id abcdef1ghij2klmno3pqr4 \ --e164-phone-numbers "+12065550100" "+12065550101" + --force-associate Output:: diff -Nru awscli-1.16.301/awscli/examples/chime/associate-signin-delegate-groups-with-account.rst awscli-1.17.14/awscli/examples/chime/associate-signin-delegate-groups-with-account.rst --- awscli-1.16.301/awscli/examples/chime/associate-signin-delegate-groups-with-account.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/chime/associate-signin-delegate-groups-with-account.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,11 @@ +**To associate sign-in delegate groups** + +The following ``associate-signin-delegate-groups-with-account`` example associates the specified sign-in delegate group with the specified Amazon Chime account. :: + + aws chime associate-signin-delegate-groups-with-account \ + --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ + --signin-delegate-groups GroupName=my_users + +This command produces no output. + +For more information, see `Managing User Access and Permissions `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.16.301/awscli/examples/chime/batch-update-phone-number.rst awscli-1.17.14/awscli/examples/chime/batch-update-phone-number.rst --- awscli-1.16.301/awscli/examples/chime/batch-update-phone-number.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/chime/batch-update-phone-number.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,4 +1,4 @@ -**To update several phone numbers at the same time** +**To update several phone number product types at the same time** The following ``batch-update-phone-number`` example updates the product types for all of the specified phone numbers. :: @@ -11,4 +11,18 @@ "PhoneNumberErrors": [] } +**To update several phone number calling names at the same time** + +The following ``batch-update-phone-number`` example updates the calling names for all of the specified phone numbers. :: + + aws chime batch-update-phone-number \ + --update-phone-number-request-items PhoneNumberId=%2B14013143874,CallingName=phonenumber1 PhoneNumberId=%2B14013144061,CallingName=phonenumber2 + +Output:: + + { + "PhoneNumberErrors": [] + } + For more information, see `Working with Phone Numbers `__ in the *Amazon Chime Administration Guide*. + diff -Nru awscli-1.16.301/awscli/examples/chime/create-user.rst awscli-1.17.14/awscli/examples/chime/create-user.rst --- awscli-1.16.301/awscli/examples/chime/create-user.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/chime/create-user.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,28 @@ +**To create a user profile for a shared device** + +The following ``create-user`` example creates a shared device profile for the specified email address. :: + + aws chime create-user \ + --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ + --email roomdevice@example.com \ + --user-type SharedDevice + +Output:: + + { + "User": { + "UserId": "1ab2345c-67de-8901-f23g-45h678901j2k", + "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45", + "PrimaryEmail": "roomdevice@example.com", + "DisplayName": "Room Device", + "LicenseType": "Pro", + "UserType": "SharedDevice", + "UserRegistrationStatus": "Registered", + "RegisteredOn": "2020-01-15T22:38:09.806Z", + "AlexaForBusinessMetadata": { + "IsAlexaForBusinessEnabled": false + } + } + } + +For more information, see `Preparing for Setup `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.16.301/awscli/examples/chime/disassociate-signin-delegate-groups-from-account.rst awscli-1.17.14/awscli/examples/chime/disassociate-signin-delegate-groups-from-account.rst --- awscli-1.16.301/awscli/examples/chime/disassociate-signin-delegate-groups-from-account.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/chime/disassociate-signin-delegate-groups-from-account.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,11 @@ +**To disassociate sign-in delegate groups** + +The following ``disassociate-signin-delegate-groups-from-account`` example disassociates the specified sign-in delegate group from the specified Amazon Chime account. :: + + aws chime disassociate-signin-delegate-groups-from-account \ + --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ + --group-names "my_users" + +This command produces no output. + +For more information, see `Managing User Access and Permissions `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.16.301/awscli/examples/chime/get-phone-number.rst awscli-1.17.14/awscli/examples/chime/get-phone-number.rst --- awscli-1.16.301/awscli/examples/chime/get-phone-number.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/chime/get-phone-number.rst 2020-02-10 19:14:32.000000000 +0000 @@ -22,7 +22,14 @@ "InboundMMS": true, "OutboundMMS": true }, - "Associations": [], + "Associations": [ + { + "Value": "abcdef1ghij2klmno3pqr4", + "Name": "VoiceConnectorId", + "AssociatedTimestamp": "2019-10-28T18:40:37.453Z" + } + ], + "CallingNameStatus": "UpdateInProgress", "CreatedTimestamp": "2019-08-09T21:35:21.445Z", "UpdatedTimestamp": "2019-08-09T21:35:31.745Z" } diff -Nru awscli-1.16.301/awscli/examples/chime/list-phone-numbers.rst awscli-1.17.14/awscli/examples/chime/list-phone-numbers.rst --- awscli-1.16.301/awscli/examples/chime/list-phone-numbers.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/chime/list-phone-numbers.rst 2020-02-10 19:14:32.000000000 +0000 @@ -14,7 +14,7 @@ "E164PhoneNumber": "+12065550100", "Type": "Local", "ProductType": "VoiceConnector", - "Status": "Unassigned", + "Status": "Assigned", "Capabilities": { "InboundCall": true, "OutboundCall": true, @@ -23,16 +23,23 @@ "InboundMMS": true, "OutboundMMS": true }, - "Associations": [], - "CreatedTimestamp": "2019-08-09T21:35:21.445Z", - "UpdatedTimestamp": "2019-08-09T21:35:31.745Z" - } + "Associations": [ + { + "Value": "abcdef1ghij2klmno3pqr4", + "Name": "VoiceConnectorId", + "AssociatedTimestamp": "2019-10-28T18:40:37.453Z" + } + ], + "CallingNameStatus": "UpdateInProgress", + "CreatedTimestamp": "2019-08-12T22:10:20.521Z", + "UpdatedTimestamp": "2019-10-28T18:42:07.964Z" + }, { "PhoneNumberId": "%2B12065550101", "E164PhoneNumber": "+12065550101", "Type": "Local", "ProductType": "VoiceConnector", - "Status": "Unassigned", + "Status": "Assigned", "Capabilities": { "InboundCall": true, "OutboundCall": true, @@ -41,9 +48,16 @@ "InboundMMS": true, "OutboundMMS": true }, - "Associations": [], - "CreatedTimestamp": "2019-08-09T21:35:21.445Z", - "UpdatedTimestamp": "2019-08-09T21:35:31.745Z" + "Associations": [ + { + "Value": "abcdef1ghij2klmno3pqr4", + "Name": "VoiceConnectorId", + "AssociatedTimestamp": "2019-10-28T18:40:37.511Z" + } + ], + "CallingNameStatus": "UpdateInProgress", + "CreatedTimestamp": "2019-08-12T22:10:20.521Z", + "UpdatedTimestamp": "2019-10-28T18:42:07.960Z" } ] } diff -Nru awscli-1.16.301/awscli/examples/chime/list-voice-connector-groups.rst awscli-1.17.14/awscli/examples/chime/list-voice-connector-groups.rst --- awscli-1.16.301/awscli/examples/chime/list-voice-connector-groups.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/chime/list-voice-connector-groups.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,21 @@ +**To list Amazon Chime Voice Connector groups for an Amazon Chime account** + +The following ``list-voice-connector-groups`` example lists the Amazon Chime Voice Connector groups associated with the administrator's Amazon Chime account. :: + + aws chime list-voice-connector-groups + +Output:: + + { + "VoiceConnectorGroups": [ + { + "VoiceConnectorGroupId": "123a456b-c7d8-90e1-fg23-4h567jkl8901", + "Name": "myGroup", + "VoiceConnectorItems": [], + "CreatedTimestamp": "2019-09-18T16:38:34.734Z", + "UpdatedTimestamp": "2019-09-18T16:38:34.734Z" + } + ] + } + +For more information, see `Working with Amazon Chime Voice Connector groups `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.16.301/awscli/examples/cloudformation/deregister-type.rst awscli-1.17.14/awscli/examples/cloudformation/deregister-type.rst --- awscli-1.16.301/awscli/examples/cloudformation/deregister-type.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudformation/deregister-type.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,12 @@ +**To deregister a type version** + +The following ``deregister-type`` example removes the specified type version from active use in the CloudFormation registry, so that it can no longer be used in CloudFormation operations. :: + + aws cloudformation deregister-type \ + --type RESOURCE \ + --type-name My::Logs::LogGroup \ + --version-id 00000002 + +This command produces no output. + +For more information, see `Using the CloudFormation Registry `__ in the *AWS CloudFormation Users Guide*. diff -Nru awscli-1.16.301/awscli/examples/cloudformation/describe-type-registration.rst awscli-1.17.14/awscli/examples/cloudformation/describe-type-registration.rst --- awscli-1.16.301/awscli/examples/cloudformation/describe-type-registration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudformation/describe-type-registration.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,17 @@ +**To display type registration information** + +The following ``describe-type-registration`` example displays information about the specified type registration, including the type's current status, type, and version. :: + + aws cloudformation describe-type-registration \ + --registration-token a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 + +Output:: + + { + "ProgressStatus": "COMPLETE", + "TypeArn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/My-Logs-LogGroup", + "Description": "Deployment is currently in DEPLOY_STAGE of status COMPLETED; ", + "TypeVersionArn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/My-Logs-LogGroup/00000001" + } + +For more information, see `Using the CloudFormation Registry `__ in the *AWS CloudFormation Users Guide*. diff -Nru awscli-1.16.301/awscli/examples/cloudformation/describe-type.rst awscli-1.17.14/awscli/examples/cloudformation/describe-type.rst --- awscli-1.16.301/awscli/examples/cloudformation/describe-type.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudformation/describe-type.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,25 @@ +**To display type information** + +The following ``describe-type`` example displays information for the specified type. :: + + aws cloudformation describe-type \ + --type-name My::Logs::LogGroup \ + --type RESOURCE + +Output:: + + { + "SourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-logs.git", + "Description": "Customized resource derived from AWS::Logs::LogGroup", + "TimeCreated": "2019-12-03T23:29:33.321Z", + "Visibility": "PRIVATE", + "TypeName": "My::Logs::LogGroup", + "LastUpdated": "2019-12-03T23:29:33.321Z", + "DeprecatedStatus": "LIVE", + "ProvisioningType": "FULLY_MUTABLE", + "Type": "RESOURCE", + "Arn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/My-Logs-LogGroup/00000001", + "Schema": "[details omitted]" + } + +For more information, see `Using the CloudFormation Registry `__ in the *AWS CloudFormation Users Guide*. diff -Nru awscli-1.16.301/awscli/examples/cloudformation/detect-stack-set-drift.rst awscli-1.17.14/awscli/examples/cloudformation/detect-stack-set-drift.rst --- awscli-1.16.301/awscli/examples/cloudformation/detect-stack-set-drift.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudformation/detect-stack-set-drift.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,14 @@ +**To detect drift on a stack set and all associated stack instances** + +The following ``detect-stack-set-drift`` example initiates drift detection operations on the specified stack set, including all the stack instances associated with that stack set, and returns an operation ID that can be used to track the status of the drift operation. :: + + aws cloudformation detect-stack-set-drift \ + --stack-set-name stack-set-drift-example + +Output:: + + { + "OperationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" + } + +For more information, see `Detecting Unmanaged Configuration Changes in Stack Sets `__ in the *AWS CloudFormation Users Guide*. diff -Nru awscli-1.16.301/awscli/examples/cloudformation/list-type-registrations.rst awscli-1.17.14/awscli/examples/cloudformation/list-type-registrations.rst --- awscli-1.16.301/awscli/examples/cloudformation/list-type-registrations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudformation/list-type-registrations.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,20 @@ +**To list the completed registrations of a type** + +The following ``list-type-registrations`` example displays a list of the completed type registrations for the specified type. :: + + aws cloudformation list-type-registrations \ + --type RESOURCE \ + --type-name My::Logs::LogGroup \ + --registration-status-filter COMPLETE + +Output:: + + { + "RegistrationTokenList": [ + "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333" + ] + } + +For more information, see `Using the CloudFormation Registry `__ in the *AWS CloudFormation Users Guide*. diff -Nru awscli-1.16.301/awscli/examples/cloudformation/list-types.rst awscli-1.17.14/awscli/examples/cloudformation/list-types.rst --- awscli-1.16.301/awscli/examples/cloudformation/list-types.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudformation/list-types.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,30 @@ +**To list the private resource types in an account** + +The following ``list-types`` example displays a list of the private resource types currently registered in the current AWS account. :: + + aws cloudformation list-types + +Output:: + + { + "TypeSummaries": [ + { + "Description": "WordPress blog resource for internal use", + "LastUpdated": "2019-12-04T18:28:15.059Z", + "TypeName": "My::WordPress::BlogExample", + "TypeArn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/My-WordPress-BlogExample", + "DefaultVersionId": "00000005", + "Type": "RESOURCE" + }, + { + "Description": "Customized resource derived from AWS::Logs::LogGroup", + "LastUpdated": "2019-12-04T18:28:15.059Z", + "TypeName": "My::Logs::LogGroup", + "TypeArn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/My-Logs-LogGroup", + "DefaultVersionId": "00000003", + "Type": "RESOURCE" + } + ] + } + +For more information, see `Using the CloudFormation Registry `__ in the *AWS CloudFormation Users Guide*. diff -Nru awscli-1.16.301/awscli/examples/cloudformation/list-type-versions.rst awscli-1.17.14/awscli/examples/cloudformation/list-type-versions.rst --- awscli-1.16.301/awscli/examples/cloudformation/list-type-versions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudformation/list-type-versions.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,33 @@ +**To list versions of a type** + +The following ``list-type-versions`` example displays summary information of each version of the specified type whose status is ``LIVE``. :: + + aws cloudformation list-type-versions \ + --type RESOURCE \ + --type-name My::Logs::LogGroup \ + --deprecated-status LIVE + +Output:: + + { + "TypeVersionSummaries": [ + { + "Description": "Customized resource derived from AWS::Logs::LogGroup", + "TimeCreated": "2019-12-03T23:29:33.321Z", + "TypeName": "My::Logs::LogGroup", + "VersionId": "00000001", + "Type": "RESOURCE", + "Arn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/My-Logs-LogGroup/00000001" + }, + { + "Description": "Customized resource derived from AWS::Logs::LogGroup", + "TimeCreated": "2019-12-04T06:58:14.902Z", + "TypeName": "My::Logs::LogGroup", + "VersionId": "00000002", + "Type": "RESOURCE", + "Arn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/My-Logs-LogGroup/00000002" + } + ] + } + +For more information, see `Using the CloudFormation Registry `__ in the *AWS CloudFormation Users Guide*. diff -Nru awscli-1.16.301/awscli/examples/cloudformation/set-type-default-version.rst awscli-1.17.14/awscli/examples/cloudformation/set-type-default-version.rst --- awscli-1.16.301/awscli/examples/cloudformation/set-type-default-version.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudformation/set-type-default-version.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,12 @@ +**To set a type's default version** + +The following ``set-type-default-version`` example sets the specified type version to be used as the default for this type. :: + + aws cloudformation set-type-default-version \ + --type RESOURCE \ + --type-name My::Logs::LogGroup \ + --version-id 00000003 + +This command produces no output. + +For more information, see `Using the CloudFormation Registry `__ in the *AWS CloudFormation Users Guide*. diff -Nru awscli-1.16.301/awscli/examples/cloudfront/create-cloud-front-origin-access-identity.rst awscli-1.17.14/awscli/examples/cloudfront/create-cloud-front-origin-access-identity.rst --- awscli-1.16.301/awscli/examples/cloudfront/create-cloud-front-origin-access-identity.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/create-cloud-front-origin-access-identity.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,38 @@ +**To create a CloudFront origin access identity** + +The following example creates a CloudFront origin access identity (OAI) by +providing the OAI configuration as a command line argument:: + + aws cloudfront create-cloud-front-origin-access-identity \ + --cloud-front-origin-access-identity-config \ + CallerReference="cli-example",Comment="Example OAI" + +You can accomplish the same thing by providing the OAI configuration in a JSON +file, as shown in the following example:: + + aws cloudfront create-cloud-front-origin-access-identity \ + --cloud-front-origin-access-identity-config file://OAI-config.json + +The file ``OAI-config.json`` is a JSON document in the current directory that +contains the following:: + + { + "CallerReference": "cli-example", + "Comment": "Example OAI" + } + +Whether you provide the OAI configuration with a command line argument or a +JSON file, the output is the same:: + + { + "Location": "https://cloudfront.amazonaws.com/2019-03-26/origin-access-identity/cloudfront/E74FTE3AEXAMPLE", + "ETag": "E2QWRUHEXAMPLE", + "CloudFrontOriginAccessIdentity": { + "Id": "E74FTE3AEXAMPLE", + "S3CanonicalUserId": "cd13868f797c227fbea2830611a26fe0a21ba1b826ab4bed9b7771c9aEXAMPLE", + "CloudFrontOriginAccessIdentityConfig": { + "CallerReference": "cli-example", + "Comment": "Example OAI" + } + } + } diff -Nru awscli-1.16.301/awscli/examples/cloudfront/create-distribution.rst awscli-1.17.14/awscli/examples/cloudfront/create-distribution.rst --- awscli-1.16.301/awscli/examples/cloudfront/create-distribution.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/create-distribution.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,163 +1,235 @@ -**To create a CloudFront Web Distribution** +**To create a CloudFront distribution** -You can create a CloudFront web distribution for an S3 domain (such as -my-bucket.s3.amazonaws.com) or for a custom domain (such as example.com). -The following command shows an example for an S3 domain, and optionally also -specifies a default root object:: - - aws cloudfront create-distribution \ - --origin-domain-name my-bucket.s3.amazonaws.com \ - --default-root-object index.html - -Or you can use the following command together with a JSON document to do the -same thing:: - - aws cloudfront create-distribution --distribution-config file://distconfig.json - -The file ``distconfig.json`` is a JSON document in the current folder that defines a CloudFront distribution:: - - { - "CallerReference": "my-distribution-2015-09-01", - "Aliases": { - "Quantity": 0 - }, - "DefaultRootObject": "index.html", - "Origins": { - "Quantity": 1, - "Items": [ - { - "Id": "my-origin", - "DomainName": "my-bucket.s3.amazonaws.com", - "S3OriginConfig": { - "OriginAccessIdentity": "" - } +The following example creates a distribution for an S3 bucket named +``awsexamplebucket``, and also specifies ``index.html`` as the default root +object, using command line arguments:: + + aws cloudfront create-distribution \ + --origin-domain-name awsexamplebucket.s3.amazonaws.com \ + --default-root-object index.html + +Instead of using command line arguments, you can provide the distribution +configuration in a JSON file, as shown in the following example:: + + aws cloudfront create-distribution \ + --distribution-config file://dist-config.json + +The file ``dist-config.json`` is a JSON document in the current folder that +contains the following:: + + { + "CallerReference": "cli-example", + "Aliases": { + "Quantity": 0 + }, + "DefaultRootObject": "index.html", + "Origins": { + "Quantity": 1, + "Items": [ + { + "Id": "awsexamplebucket.s3.amazonaws.com-cli-example", + "DomainName": "awsexamplebucket.s3.amazonaws.com", + "OriginPath": "", + "CustomHeaders": { + "Quantity": 0 + }, + "S3OriginConfig": { + "OriginAccessIdentity": "" + } + } + ] + }, + "OriginGroups": { + "Quantity": 0 + }, + "DefaultCacheBehavior": { + "TargetOriginId": "awsexamplebucket.s3.amazonaws.com-cli-example", + "ForwardedValues": { + "QueryString": false, + "Cookies": { + "Forward": "none" + }, + "Headers": { + "Quantity": 0 + }, + "QueryStringCacheKeys": { + "Quantity": 0 + } + }, + "TrustedSigners": { + "Enabled": false, + "Quantity": 0 + }, + "ViewerProtocolPolicy": "allow-all", + "MinTTL": 0, + "AllowedMethods": { + "Quantity": 2, + "Items": [ + "HEAD", + "GET" + ], + "CachedMethods": { + "Quantity": 2, + "Items": [ + "HEAD", + "GET" + ] + } + }, + "SmoothStreaming": false, + "DefaultTTL": 86400, + "MaxTTL": 31536000, + "Compress": false, + "LambdaFunctionAssociations": { + "Quantity": 0 + }, + "FieldLevelEncryptionId": "" + }, + "CacheBehaviors": { + "Quantity": 0 + }, + "CustomErrorResponses": { + "Quantity": 0 + }, + "Comment": "", + "Logging": { + "Enabled": false, + "IncludeCookies": false, + "Bucket": "", + "Prefix": "" + }, + "PriceClass": "PriceClass_All", + "Enabled": true, + "ViewerCertificate": { + "CloudFrontDefaultCertificate": true, + "MinimumProtocolVersion": "TLSv1", + "CertificateSource": "cloudfront" + }, + "Restrictions": { + "GeoRestriction": { + "RestrictionType": "none", + "Quantity": 0 + } + }, + "WebACLId": "", + "HttpVersion": "http2", + "IsIPV6Enabled": true + } + +Whether you provide the distribution information with a command line argument +or a JSON file, the output is the same:: + + { + "Location": "https://cloudfront.amazonaws.com/2019-03-26/distribution/EMLARXS9EXAMPLE", + "ETag": "E9LHASXEXAMPLE", + "Distribution": { + "Id": "EMLARXS9EXAMPLE", + "ARN": "arn:aws:cloudfront::123456789012:distribution/EMLARXS9EXAMPLE", + "Status": "InProgress", + "LastModifiedTime": "2019-11-22T00:55:15.705Z", + "InProgressInvalidationBatches": 0, + "DomainName": "d111111abcdef8.cloudfront.net", + "ActiveTrustedSigners": { + "Enabled": false, + "Quantity": 0 + }, + "DistributionConfig": { + "CallerReference": "cli-example", + "Aliases": { + "Quantity": 0 + }, + "DefaultRootObject": "index.html", + "Origins": { + "Quantity": 1, + "Items": [ + { + "Id": "awsexamplebucket.s3.amazonaws.com-cli-example", + "DomainName": "awsexamplebucket.s3.amazonaws.com", + "OriginPath": "", + "CustomHeaders": { + "Quantity": 0 + }, + "S3OriginConfig": { + "OriginAccessIdentity": "" + } + } + ] + }, + "OriginGroups": { + "Quantity": 0 + }, + "DefaultCacheBehavior": { + "TargetOriginId": "awsexamplebucket.s3.amazonaws.com-cli-example", + "ForwardedValues": { + "QueryString": false, + "Cookies": { + "Forward": "none" + }, + "Headers": { + "Quantity": 0 + }, + "QueryStringCacheKeys": { + "Quantity": 0 + } + }, + "TrustedSigners": { + "Enabled": false, + "Quantity": 0 + }, + "ViewerProtocolPolicy": "allow-all", + "MinTTL": 0, + "AllowedMethods": { + "Quantity": 2, + "Items": [ + "HEAD", + "GET" + ], + "CachedMethods": { + "Quantity": 2, + "Items": [ + "HEAD", + "GET" + ] + } + }, + "SmoothStreaming": false, + "DefaultTTL": 86400, + "MaxTTL": 31536000, + "Compress": false, + "LambdaFunctionAssociations": { + "Quantity": 0 + }, + "FieldLevelEncryptionId": "" + }, + "CacheBehaviors": { + "Quantity": 0 + }, + "CustomErrorResponses": { + "Quantity": 0 + }, + "Comment": "", + "Logging": { + "Enabled": false, + "IncludeCookies": false, + "Bucket": "", + "Prefix": "" + }, + "PriceClass": "PriceClass_All", + "Enabled": true, + "ViewerCertificate": { + "CloudFrontDefaultCertificate": true, + "MinimumProtocolVersion": "TLSv1", + "CertificateSource": "cloudfront" + }, + "Restrictions": { + "GeoRestriction": { + "RestrictionType": "none", + "Quantity": 0 + } + }, + "WebACLId": "", + "HttpVersion": "http2", + "IsIPV6Enabled": true + } } - ] - }, - "DefaultCacheBehavior": { - "TargetOriginId": "my-origin", - "ForwardedValues": { - "QueryString": true, - "Cookies": { - "Forward": "none" - } - }, - "TrustedSigners": { - "Enabled": false, - "Quantity": 0 - }, - "ViewerProtocolPolicy": "allow-all", - "MinTTL": 3600 - }, - "CacheBehaviors": { - "Quantity": 0 - }, - "Comment": "", - "Logging": { - "Enabled": false, - "IncludeCookies": true, - "Bucket": "", - "Prefix": "" - }, - "PriceClass": "PriceClass_All", - "Enabled": true - } - - -Output:: - - { - "Distribution": { - "Status": "InProgress", - "DomainName": "d2wkuj2w9l34gt.cloudfront.net", - "InProgressInvalidationBatches": 0, - "DistributionConfig": { - "Comment": "", - "CacheBehaviors": { - "Quantity": 0 - }, - "Logging": { - "Bucket": "", - "Prefix": "", - "Enabled": false, - "IncludeCookies": false - }, - "Origins": { - "Items": [ - { - "OriginPath": "", - "S3OriginConfig": { - "OriginAccessIdentity": "" - }, - "Id": "my-origin", - "DomainName": "my-bucket.s3.amazonaws.com" - } - ], - "Quantity": 1 - }, - "DefaultRootObject": "", - "PriceClass": "PriceClass_All", - "Enabled": true, - "DefaultCacheBehavior": { - "TrustedSigners": { - "Enabled": false, - "Quantity": 0 - }, - "TargetOriginId": "my-origin", - "ViewerProtocolPolicy": "allow-all", - "ForwardedValues": { - "Headers": { - "Quantity": 0 - }, - "Cookies": { - "Forward": "none" - }, - "QueryString": true - }, - "MaxTTL": 31536000, - "SmoothStreaming": false, - "DefaultTTL": 86400, - "AllowedMethods": { - "Items": [ - "HEAD", - "GET" - ], - "CachedMethods": { - "Items": [ - "HEAD", - "GET" - ], - "Quantity": 2 - }, - "Quantity": 2 - }, - "MinTTL": 3600 - }, - "CallerReference": "my-distribution-2015-09-01", - "ViewerCertificate": { - "CloudFrontDefaultCertificate": true, - "MinimumProtocolVersion": "SSLv3" - }, - "CustomErrorResponses": { - "Quantity": 0 - }, - "Restrictions": { - "GeoRestriction": { - "RestrictionType": "none", - "Quantity": 0 - } - }, - "Aliases": { - "Quantity": 0 - } - }, - "ActiveTrustedSigners": { - "Enabled": false, - "Quantity": 0 - }, - "LastModifiedTime": "2015-08-31T21:11:29.093Z", - "Id": "S11A16G5KZMEQD" - }, - "ETag": "E37HOT42DHPVYH", - "Location": "https://cloudfront.amazonaws.com/2015-04-17/distribution/S11A16G5KZMEQD" - } + } diff -Nru awscli-1.16.301/awscli/examples/cloudfront/create-distribution-with-tags.rst awscli-1.17.14/awscli/examples/cloudfront/create-distribution-with-tags.rst --- awscli-1.16.301/awscli/examples/cloudfront/create-distribution-with-tags.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/create-distribution-with-tags.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,247 @@ +**To create a CloudFront distribution with tags** + +The following example creates a distribution with two tags by providing the +distribution configuration and tags in a JSON file named +``dist-config-with-tags.json``:: + + aws cloudfront create-distribution-with-tags \ + --distribution-config-with-tags file://dist-config-with-tags.json + +The file ``dist-config-with-tags.json`` is a JSON document in the current +folder that contains the following. Note the ``Tags`` object at the top of +the file, which contains two tags: + +- ``Name = ExampleDistribution`` +- ``Project = ExampleProject`` + +:: + + { + "Tags": { + "Items": [ + { + "Key": "Name", + "Value": "ExampleDistribution" + }, + { + "Key": "Project", + "Value": "ExampleProject" + } + ] + }, + "DistributionConfig": { + "CallerReference": "cli-example", + "Aliases": { + "Quantity": 0 + }, + "DefaultRootObject": "index.html", + "Origins": { + "Quantity": 1, + "Items": [ + { + "Id": "awsexamplebucket.s3.amazonaws.com-cli-example", + "DomainName": "awsexamplebucket.s3.amazonaws.com", + "OriginPath": "", + "CustomHeaders": { + "Quantity": 0 + }, + "S3OriginConfig": { + "OriginAccessIdentity": "" + } + } + ] + }, + "OriginGroups": { + "Quantity": 0 + }, + "DefaultCacheBehavior": { + "TargetOriginId": "awsexamplebucket.s3.amazonaws.com-cli-example", + "ForwardedValues": { + "QueryString": false, + "Cookies": { + "Forward": "none" + }, + "Headers": { + "Quantity": 0 + }, + "QueryStringCacheKeys": { + "Quantity": 0 + } + }, + "TrustedSigners": { + "Enabled": false, + "Quantity": 0 + }, + "ViewerProtocolPolicy": "allow-all", + "MinTTL": 0, + "AllowedMethods": { + "Quantity": 2, + "Items": [ + "HEAD", + "GET" + ], + "CachedMethods": { + "Quantity": 2, + "Items": [ + "HEAD", + "GET" + ] + } + }, + "SmoothStreaming": false, + "DefaultTTL": 86400, + "MaxTTL": 31536000, + "Compress": false, + "LambdaFunctionAssociations": { + "Quantity": 0 + }, + "FieldLevelEncryptionId": "" + }, + "CacheBehaviors": { + "Quantity": 0 + }, + "CustomErrorResponses": { + "Quantity": 0 + }, + "Comment": "", + "Logging": { + "Enabled": false, + "IncludeCookies": false, + "Bucket": "", + "Prefix": "" + }, + "PriceClass": "PriceClass_All", + "Enabled": true, + "ViewerCertificate": { + "CloudFrontDefaultCertificate": true, + "MinimumProtocolVersion": "TLSv1", + "CertificateSource": "cloudfront" + }, + "Restrictions": { + "GeoRestriction": { + "RestrictionType": "none", + "Quantity": 0 + } + }, + "WebACLId": "", + "HttpVersion": "http2", + "IsIPV6Enabled": true + } + } + +Output:: + + { + "Location": "https://cloudfront.amazonaws.com/2019-03-26/distribution/EDFDVBD6EXAMPLE", + "ETag": "E2QWRUHEXAMPLE", + "Distribution": { + "Id": "EDFDVBD6EXAMPLE", + "ARN": "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE", + "Status": "InProgress", + "LastModifiedTime": "2019-12-04T23:35:41.433Z", + "InProgressInvalidationBatches": 0, + "DomainName": "d111111abcdef8.cloudfront.net", + "ActiveTrustedSigners": { + "Enabled": false, + "Quantity": 0 + }, + "DistributionConfig": { + "CallerReference": "cli-example", + "Aliases": { + "Quantity": 0 + }, + "DefaultRootObject": "index.html", + "Origins": { + "Quantity": 1, + "Items": [ + { + "Id": "awsexamplebucket.s3.amazonaws.com-cli-example", + "DomainName": "awsexamplebucket.s3.amazonaws.com", + "OriginPath": "", + "CustomHeaders": { + "Quantity": 0 + }, + "S3OriginConfig": { + "OriginAccessIdentity": "" + } + } + ] + }, + "OriginGroups": { + "Quantity": 0 + }, + "DefaultCacheBehavior": { + "TargetOriginId": "awsexamplebucket.s3.amazonaws.com-cli-example", + "ForwardedValues": { + "QueryString": false, + "Cookies": { + "Forward": "none" + }, + "Headers": { + "Quantity": 0 + }, + "QueryStringCacheKeys": { + "Quantity": 0 + } + }, + "TrustedSigners": { + "Enabled": false, + "Quantity": 0 + }, + "ViewerProtocolPolicy": "allow-all", + "MinTTL": 0, + "AllowedMethods": { + "Quantity": 2, + "Items": [ + "HEAD", + "GET" + ], + "CachedMethods": { + "Quantity": 2, + "Items": [ + "HEAD", + "GET" + ] + } + }, + "SmoothStreaming": false, + "DefaultTTL": 86400, + "MaxTTL": 31536000, + "Compress": false, + "LambdaFunctionAssociations": { + "Quantity": 0 + }, + "FieldLevelEncryptionId": "" + }, + "CacheBehaviors": { + "Quantity": 0 + }, + "CustomErrorResponses": { + "Quantity": 0 + }, + "Comment": "", + "Logging": { + "Enabled": false, + "IncludeCookies": false, + "Bucket": "", + "Prefix": "" + }, + "PriceClass": "PriceClass_All", + "Enabled": true, + "ViewerCertificate": { + "CloudFrontDefaultCertificate": true, + "MinimumProtocolVersion": "TLSv1", + "CertificateSource": "cloudfront" + }, + "Restrictions": { + "GeoRestriction": { + "RestrictionType": "none", + "Quantity": 0 + } + }, + "WebACLId": "", + "HttpVersion": "http2", + "IsIPV6Enabled": true + } + } + } diff -Nru awscli-1.16.301/awscli/examples/cloudfront/create-field-level-encryption-config.rst awscli-1.17.14/awscli/examples/cloudfront/create-field-level-encryption-config.rst --- awscli-1.16.301/awscli/examples/cloudfront/create-field-level-encryption-config.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/create-field-level-encryption-config.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,80 @@ +**To create a CloudFront field-level encryption configuration** + +The following example creates a field-level encryption configuration by +providing the configuration parameters in a JSON file named +``fle-config.json``. Before you can create a field-level encryption +configuration, you must have a field-level encryption profile. To create a +profile, see the `create-field-level-encryption-profile +`_ command. + +For more information about CloudFront field-level +encryption, see +`Using Field-Level Encryption to Help Protect Sensitive Data `_ +in the *Amazon CloudFront Developer Guide*. + +:: + + aws cloudfront create-field-level-encryption-config \ + --field-level-encryption-config file://fle-config.json + +The file ``fle-config.json`` is a JSON document in the current +folder that contains the following:: + + { + "CallerReference": "cli-example", + "Comment": "Example FLE configuration", + "QueryArgProfileConfig": { + "ForwardWhenQueryArgProfileIsUnknown": true, + "QueryArgProfiles": { + "Quantity": 0 + } + }, + "ContentTypeProfileConfig": { + "ForwardWhenContentTypeIsUnknown": true, + "ContentTypeProfiles": { + "Quantity": 1, + "Items": [ + { + "Format": "URLEncoded", + "ProfileId": "P280MFCLSYOCVU", + "ContentType": "application/x-www-form-urlencoded" + } + ] + } + } + } + +Output:: + + { + "Location": "https://cloudfront.amazonaws.com/2019-03-26/field-level-encryption/C3KM2WVD605UAY", + "ETag": "E2P4Z4VU7TY5SG", + "FieldLevelEncryption": { + "Id": "C3KM2WVD605UAY", + "LastModifiedTime": "2019-12-10T21:30:18.974Z", + "FieldLevelEncryptionConfig": { + "CallerReference": "cli-example", + "Comment": "Example FLE configuration", + "QueryArgProfileConfig": { + "ForwardWhenQueryArgProfileIsUnknown": true, + "QueryArgProfiles": { + "Quantity": 0, + "Items": [] + } + }, + "ContentTypeProfileConfig": { + "ForwardWhenContentTypeIsUnknown": true, + "ContentTypeProfiles": { + "Quantity": 1, + "Items": [ + { + "Format": "URLEncoded", + "ProfileId": "P280MFCLSYOCVU", + "ContentType": "application/x-www-form-urlencoded" + } + ] + } + } + } + } + } diff -Nru awscli-1.16.301/awscli/examples/cloudfront/create-field-level-encryption-profile.rst awscli-1.17.14/awscli/examples/cloudfront/create-field-level-encryption-profile.rst --- awscli-1.16.301/awscli/examples/cloudfront/create-field-level-encryption-profile.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/create-field-level-encryption-profile.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,71 @@ +**To create a CloudFront field-level encryption profile** + +The following example creates a field-level encryption profile by providing the +parameters in a JSON file named ``fle-profile-config.json``. Before you can +create a field-level encryption profile, you must have a CloudFront public key. +To create a CloudFront public key, see the `create-public-key +`_ command. + +For more information about CloudFront field-level encryption, see +`Using Field-Level Encryption to Help Protect Sensitive Data `_ +in the *Amazon CloudFront Developer Guide*. + +:: + + aws cloudfront create-field-level-encryption-profile \ + --field-level-encryption-profile-config file://fle-profile-config.json + +The file ``fle-profile-config.json`` is a JSON document in the current folder +that contains the following:: + + { + "Name": "ExampleFLEProfile", + "CallerReference": "cli-example", + "Comment": "FLE profile for AWS CLI example", + "EncryptionEntities": { + "Quantity": 1, + "Items": [ + { + "PublicKeyId": "K2K8NC4HVFE3M0", + "ProviderId": "ExampleFLEProvider", + "FieldPatterns": { + "Quantity": 1, + "Items": [ + "ExampleSensitiveField" + ] + } + } + ] + } + } + +Output:: + + { + "Location": "https://cloudfront.amazonaws.com/2019-03-26/field-level-encryption-profile/PPK0UOSIF5WSV", + "ETag": "E2QWRUHEXAMPLE", + "FieldLevelEncryptionProfile": { + "Id": "PPK0UOSIF5WSV", + "LastModifiedTime": "2019-12-10T01:03:16.537Z", + "FieldLevelEncryptionProfileConfig": { + "Name": "ExampleFLEProfile", + "CallerReference": "cli-example", + "Comment": "FLE profile for AWS CLI example", + "EncryptionEntities": { + "Quantity": 1, + "Items": [ + { + "PublicKeyId": "K2K8NC4HVFE3M0", + "ProviderId": "ExampleFLEProvider", + "FieldPatterns": { + "Quantity": 1, + "Items": [ + "ExampleSensitiveField" + ] + } + } + ] + } + } + } + } diff -Nru awscli-1.16.301/awscli/examples/cloudfront/create-invalidation.rst awscli-1.17.14/awscli/examples/cloudfront/create-invalidation.rst --- awscli-1.16.301/awscli/examples/cloudfront/create-invalidation.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/create-invalidation.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,45 +1,75 @@ **To create an invalidation for a CloudFront distribution** -The following command creates an invalidation for a CloudFront distribution with the ID ``S11A16G5KZMEQD``:: - - aws cloudfront create-invalidation --distribution-id S11A16G5KZMEQD \ - --paths /index.html /error.html - -The --paths will automatically generate a random ``CallerReference`` every time. - -Or you can use the following command to do the same thing, so that you can have a chance to specify your own ``CallerReference`` here:: - - aws cloudfront create-invalidation --invalidation-batch file://invbatch.json --distribution-id S11A16G5KZMEQD - -The distribution ID is available in the output of ``create-distribution`` and ``list-distributions``. - -The file ``invbatch.json`` is a JSON document in the current folder that specifies two paths to invalidate:: - - { - "Paths": { - "Quantity": 2, - "Items": ["/index.html", "/error.html"] - }, - "CallerReference": "my-invalidation-2015-09-01" - } - -Output of both commands:: - - { - "Invalidation": { - "Status": "InProgress", - "InvalidationBatch": { - "Paths": { - "Items": [ - "/index.html", - "/error.html" - ], - "Quantity": 2 - }, - "CallerReference": "my-invalidation-2015-09-01" - }, - "Id": "YNY2LI2BVJ4NJU", - "CreateTime": "2015-08-31T21:15:52.042Z" - }, - "Location": "https://cloudfront.amazonaws.com/2015-04-17/distribution/S11A16G5KZMEQD/invalidation/YNY2LI2BVJ4NJU" - } +The following example creates an invalidation for the file +``/example-path/example-file.jpg`` in the CloudFront distribution with the ID +``EDFDVBD6EXAMPLE``:: + + aws cloudfront create-invalidation \ + --distribution-id EDFDVBD6EXAMPLE \ + --paths "/example-path/example-file.jpg" + +Output:: + + { + "Location": "https://cloudfront.amazonaws.com/2019-03-26/distribution/EDFDVBD6EXAMPLE/invalidation/I1JLWSDAP8FU89", + "Invalidation": { + "Id": "I1JLWSDAP8FU89", + "Status": "InProgress", + "CreateTime": "2019-12-05T18:24:51.407Z", + "InvalidationBatch": { + "Paths": { + "Quantity": 1, + "Items": [ + "/example-path/example-file.jpg" + ] + }, + "CallerReference": "cli-1575570291-670203" + } + } + } + +In the previous example, the AWS CLI automatically generated a random +``CallerReference``. To specify your own ``CallerReference``, or to avoid +passing the invalidation parameters as command line arguments, you can use a +JSON file. The following example creates an invalidation for two files, by +providing the invalidation parameters in a JSON file named +``inv-batch.json``:: + + aws cloudfront create-invalidation \ + --distribution-id EDFDVBD6EXAMPLE \ + --invalidation-batch file://inv-batch.json + +The file ``inv-batch.json`` is a JSON document in the current folder that +contains the following:: + + { + "Paths": { + "Quantity": 2, + "Items": [ + "/example-path/example-file.jpg", + "/example-path/example-file-2.jpg" + ] + }, + "CallerReference": "cli-example" + } + +Output:: + + { + "Location": "https://cloudfront.amazonaws.com/2019-03-26/distribution/EDFDVBD6EXAMPLE/invalidation/I2J0I21PCUYOIK", + "Invalidation": { + "Id": "I2J0I21PCUYOIK", + "Status": "InProgress", + "CreateTime": "2019-12-05T18:40:49.413Z", + "InvalidationBatch": { + "Paths": { + "Quantity": 2, + "Items": [ + "/example-path/example-file.jpg", + "/example-path/example-file-2.jpg" + ] + }, + "CallerReference": "cli-example" + } + } + } diff -Nru awscli-1.16.301/awscli/examples/cloudfront/create-public-key.rst awscli-1.17.14/awscli/examples/cloudfront/create-public-key.rst --- awscli-1.16.301/awscli/examples/cloudfront/create-public-key.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/create-public-key.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,42 @@ +**To create a CloudFront public key** + +The following example creates a CloudFront public key by providing the +parameters in a JSON file named ``pub-key-config.json``. Before you can use +this command, you must have a PEM-encoded public key. For more information, see +`Create an RSA Key Pair +`_ +in the *Amazon CloudFront Developer Guide*. + +:: + + aws cloudfront create-public-key \ + --public-key-config file://pub-key-config.json + +The file ``pub-key-config.json`` is a JSON document in the current folder that +contains the following. Note that the public key is encoded in PEM format. + +:: + + { + "CallerReference": "cli-example", + "Name": "ExampleKey", + "EncodedKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxPMbCA2Ks0lnd7IR+3pw\nwd3H/7jPGwj8bLUmore7bX+oeGpZ6QmLAe/1UOWcmZX2u70dYcSIzB1ofZtcn4cJ\nenHBAzO3ohBY/L1tQGJfS2A+omnN6H16VZE1JCK8XSJyfze7MDLcUyHZETdxuvRb\nA9X343/vMAuQPnhinFJ8Wdy8YBXSPpy7r95ylUQd9LfYTBzVZYG2tSesplcOkjM3\n2Uu+oMWxQAw1NINnSLPinMVsutJy6ZqlV3McWNWe4T+STGtWhrPNqJEn45sIcCx4\nq+kGZ2NQ0FyIyT2eiLKOX5Rgb/a36E/aMk4VoDsaenBQgG7WLTnstb9sr7MIhS6A\nrwIDAQAB\n-----END PUBLIC KEY-----\n", + "Comment": "example public key" + } + +Output:: + + { + "Location": "https://cloudfront.amazonaws.com/2019-03-26/public-key/KDFB19YGCR002", + "ETag": "E2QWRUHEXAMPLE", + "PublicKey": { + "Id": "KDFB19YGCR002", + "CreatedTime": "2019-12-05T18:51:43.781Z", + "PublicKeyConfig": { + "CallerReference": "cli-example", + "Name": "ExampleKey", + "EncodedKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxPMbCA2Ks0lnd7IR+3pw\nwd3H/7jPGwj8bLUmore7bX+oeGpZ6QmLAe/1UOWcmZX2u70dYcSIzB1ofZtcn4cJ\nenHBAzO3ohBY/L1tQGJfS2A+omnN6H16VZE1JCK8XSJyfze7MDLcUyHZETdxuvRb\nA9X343/vMAuQPnhinFJ8Wdy8YBXSPpy7r95ylUQd9LfYTBzVZYG2tSesplcOkjM3\n2Uu+oMWxQAw1NINnSLPinMVsutJy6ZqlV3McWNWe4T+STGtWhrPNqJEn45sIcCx4\nq+kGZ2NQ0FyIyT2eiLKOX5Rgb/a36E/aMk4VoDsaenBQgG7WLTnstb9sr7MIhS6A\nrwIDAQAB\n-----END PUBLIC KEY-----\n", + "Comment": "example public key" + } + } + } diff -Nru awscli-1.16.301/awscli/examples/cloudfront/delete-cloud-front-origin-access-identity.rst awscli-1.17.14/awscli/examples/cloudfront/delete-cloud-front-origin-access-identity.rst --- awscli-1.16.301/awscli/examples/cloudfront/delete-cloud-front-origin-access-identity.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/delete-cloud-front-origin-access-identity.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,23 @@ +**To delete a CloudFront origin access identity** + +The following example deletes the origin access identity (OAI) with the ID +``E74FTE3AEXAMPLE``. To delete an OAI, you must have the OAI's ID and ``ETag``. +The OAI ID is returned in the output of the +`create-cloud-front-origin-access-identity +`_ and +`list-cloud-front-origin-access-identities +`_ commands. +To get the ``ETag``, use the +`get-cloud-front-origin-access-identity +`_ or +`get-cloud-front-origin-access-identity-config +`_ command. +Use the ``--if-match`` option to provide the OAI's ``ETag``. + +:: + + aws cloudfront delete-cloud-front-origin-access-identity \ + --id E74FTE3AEXAMPLE \ + --if-match E2QWRUHEXAMPLE + +When successful, this command has no output. diff -Nru awscli-1.16.301/awscli/examples/cloudfront/delete-distribution.rst awscli-1.17.14/awscli/examples/cloudfront/delete-distribution.rst --- awscli-1.16.301/awscli/examples/cloudfront/delete-distribution.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/delete-distribution.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,7 +1,20 @@ **To delete a CloudFront distribution** -The following command deletes a CloudFront distribution with the ID ``S11A16G5KZMEQD``:: +The following example deletes the CloudFront distribution with the ID +``EDFDVBD6EXAMPLE``. Before you can delete a distribution, you must disable it. +To disable a distribution, use the `update-distribution +`_ command. For more information, see the +`update-distribution examples `_. - aws cloudfront delete-distribution --id S11A16G5KZMEQD --if-match 8UBQECEJX24ST +When a distribution is disabled, you can delete it. To delete a distribution, +you must use the ``--if-match`` option to provide the distribution's ``ETag``. +To get the ``ETag``, use the `get-distribution `_ or +`get-distribution-config `_ command. -The distribution ID is available in the output of ``create-distribution`` and ``list-distributions``. The distribution must be disabled with ``update-distribution`` prior to deletion. The ETag value ``8UBQECEJX24ST`` for the ``if-match`` parameter is available in the output of ``update-distribution``, ``get-distribution`` or ``get-distribution-config``. +:: + + aws cloudfront delete-distribution \ + --id EDFDVBD6EXAMPLE \ + --if-match E2QWRUHEXAMPLE + +When successful, this command has no output. diff -Nru awscli-1.16.301/awscli/examples/cloudfront/delete-field-level-encryption-config.rst awscli-1.17.14/awscli/examples/cloudfront/delete-field-level-encryption-config.rst --- awscli-1.16.301/awscli/examples/cloudfront/delete-field-level-encryption-config.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/delete-field-level-encryption-config.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,24 @@ +**To delete a CloudFront field-level encryption configuration** + +The following example deletes the CloudFront field-level encryption +configuration with the ID ``C3KM2WVD605UAY``. To delete a field-level +encryption configuration, you must have its ID and ``ETag``. The ID is returned +in the output of the +`create-field-level-encryption-config +`_ and +`list-field-level-encryption-configs +`_ commands. +To get the ``ETag``, use the +`get-field-level-encryption +`_ or +`get-field-level-encryption-config +`_ command. +Use the ``--if-match`` option to provide the configuration's ``ETag``. + +:: + + aws cloudfront delete-field-level-encryption-config \ + --id C3KM2WVD605UAY \ + --if-match E26M4BIAV81ZF6 + +When successful, this command has no output. diff -Nru awscli-1.16.301/awscli/examples/cloudfront/delete-field-level-encryption-profile.rst awscli-1.17.14/awscli/examples/cloudfront/delete-field-level-encryption-profile.rst --- awscli-1.16.301/awscli/examples/cloudfront/delete-field-level-encryption-profile.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/delete-field-level-encryption-profile.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,23 @@ +**To delete a CloudFront field-level encryption profile** + +The following example deletes the CloudFront field-level encryption profile +with the ID ``PPK0UOSIF5WSV``. To delete a field-level encryption profile, you +must have its ID and ``ETag``. The ID is returned in the output of the +`create-field-level-encryption-profile +`_ and +`list-field-level-encryption-profiles +`_ commands. +To get the ``ETag``, use the +`get-field-level-encryption-profile +`_ or +`get-field-level-encryption-profile-config +`_ command. +Use the ``--if-match`` option to provide the profile's ``ETag``. + +:: + + aws cloudfront delete-field-level-encryption-profile \ + --id PPK0UOSIF5WSV \ + --if-match EJETYFJ9CL66D + +When successful, this command has no output. diff -Nru awscli-1.16.301/awscli/examples/cloudfront/delete-public-key.rst awscli-1.17.14/awscli/examples/cloudfront/delete-public-key.rst --- awscli-1.16.301/awscli/examples/cloudfront/delete-public-key.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/delete-public-key.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,23 @@ +**To delete a CloudFront public key** + +The following example deletes the CloudFront public key with the ID +``KDFB19YGCR002``. To delete a public key, you must have its ID and ``ETag``. +The ID is returned in the output of the +`create-public-key +`_ and +`list-public-keys +`_ commands. +To get the ``ETag``, use the +`get-public-key +`_ or +`get-public-key-config +`_ command. +Use the ``--if-match`` option to provide the public key's ``ETag``. + +:: + + aws cloudfront delete-public-key \ + --id KDFB19YGCR002 \ + --if-match E2QWRUHEXAMPLE + +When successful, this command has no output. diff -Nru awscli-1.16.301/awscli/examples/cloudfront/get-cloud-front-origin-access-identity-config.rst awscli-1.17.14/awscli/examples/cloudfront/get-cloud-front-origin-access-identity-config.rst --- awscli-1.16.301/awscli/examples/cloudfront/get-cloud-front-origin-access-identity-config.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/get-cloud-front-origin-access-identity-config.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,23 @@ +**To get a CloudFront origin access identity configuration** + +The following example gets metadata about the CloudFront origin access identity +(OAI) with the ID ``E74FTE3AEXAMPLE``, including its ``ETag``. The OAI ID is +returned in the output of the +`create-cloud-front-origin-access-identity +`_ and +`list-cloud-front-origin-access-identities +`_ commands. + +:: + + aws cloudfront get-cloud-front-origin-access-identity-config --id E74FTE3AEXAMPLE + +Output:: + + { + "ETag": "E2QWRUHEXAMPLE", + "CloudFrontOriginAccessIdentityConfig": { + "CallerReference": "cli-example", + "Comment": "Example OAI" + } + } diff -Nru awscli-1.16.301/awscli/examples/cloudfront/get-cloud-front-origin-access-identity.rst awscli-1.17.14/awscli/examples/cloudfront/get-cloud-front-origin-access-identity.rst --- awscli-1.16.301/awscli/examples/cloudfront/get-cloud-front-origin-access-identity.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/get-cloud-front-origin-access-identity.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,27 @@ +**To get a CloudFront origin access identity** + +The following example gets the CloudFront origin access identity (OAI) with the +ID ``E74FTE3AEXAMPLE``, including its ``ETag`` and the associated S3 canonical +ID. The OAI ID is returned in the output of the +`create-cloud-front-origin-access-identity +`_ and +`list-cloud-front-origin-access-identities +`_ commands. + +:: + + aws cloudfront get-cloud-front-origin-access-identity --id E74FTE3AEXAMPLE + +Output:: + + { + "ETag": "E2QWRUHEXAMPLE", + "CloudFrontOriginAccessIdentity": { + "Id": "E74FTE3AEXAMPLE", + "S3CanonicalUserId": "cd13868f797c227fbea2830611a26fe0a21ba1b826ab4bed9b7771c9aEXAMPLE", + "CloudFrontOriginAccessIdentityConfig": { + "CallerReference": "cli-example", + "Comment": "Example OAI" + } + } + } diff -Nru awscli-1.16.301/awscli/examples/cloudfront/get-distribution-config.rst awscli-1.17.14/awscli/examples/cloudfront/get-distribution-config.rst --- awscli-1.16.301/awscli/examples/cloudfront/get-distribution-config.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/get-distribution-config.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,93 +1,114 @@ -**To get information about a Cloudfront distribution config** +**To get a CloudFront distribution configuration** -The following command gets a distribution config for a CloudFront distribution with the ID ``S11A16G5KZMEQD``:: +The following example gets metadata about the CloudFront distribution with the +ID ``EDFDVBD6EXAMPLE``, including its ``ETag``. The distribution ID is returned +in the `create-distribution `_ and +`list-distributions `_ commands. - aws cloudfront get-distribution-config --id S11A16G5KZMEQD +:: -The distribution ID is available in the output of ``create-distribution`` and ``list-distributions``. + aws cloudfront get-distribution-config --id EDFDVBD6EXAMPLE Output:: - { - "ETag": "E37HOT42DHPVYH", - "DistributionConfig": { - "Comment": "", - "CacheBehaviors": { - "Quantity": 0 - }, - "Logging": { - "Bucket": "", - "Prefix": "", - "Enabled": false, - "IncludeCookies": false - }, - "Origins": { - "Items": [ - { - "OriginPath": "", - "S3OriginConfig": { - "OriginAccessIdentity": "" - }, - "Id": "my-origin", - "DomainName": "my-bucket.s3.amazonaws.com" - } - ], - "Quantity": 1 - }, - "DefaultRootObject": "", - "PriceClass": "PriceClass_All", - "Enabled": true, - "DefaultCacheBehavior": { - "TrustedSigners": { - "Enabled": false, - "Quantity": 0 - }, - "TargetOriginId": "my-origin", - "ViewerProtocolPolicy": "allow-all", - "ForwardedValues": { - "Headers": { - "Quantity": 0 - }, - "Cookies": { - "Forward": "none" - }, - "QueryString": true - }, - "MaxTTL": 31536000, - "SmoothStreaming": false, - "DefaultTTL": 86400, - "AllowedMethods": { - "Items": [ - "HEAD", - "GET" - ], - "CachedMethods": { - "Items": [ - "HEAD", - "GET" - ], - "Quantity": 2 - }, - "Quantity": 2 - }, - "MinTTL": 3600 - }, - "CallerReference": "my-distribution-2015-09-01", - "ViewerCertificate": { - "CloudFrontDefaultCertificate": true, - "MinimumProtocolVersion": "SSLv3" - }, - "CustomErrorResponses": { - "Quantity": 0 - }, - "Restrictions": { - "GeoRestriction": { - "RestrictionType": "none", - "Quantity": 0 - } - }, - "Aliases": { - "Quantity": 0 - } - } - } + { + "ETag": "E2QWRUHEXAMPLE", + "DistributionConfig": { + "CallerReference": "cli-example", + "Aliases": { + "Quantity": 0 + }, + "DefaultRootObject": "index.html", + "Origins": { + "Quantity": 1, + "Items": [ + { + "Id": "awsexamplebucket.s3.amazonaws.com-cli-example", + "DomainName": "awsexamplebucket.s3.amazonaws.com", + "OriginPath": "", + "CustomHeaders": { + "Quantity": 0 + }, + "S3OriginConfig": { + "OriginAccessIdentity": "" + } + } + ] + }, + "OriginGroups": { + "Quantity": 0 + }, + "DefaultCacheBehavior": { + "TargetOriginId": "awsexamplebucket.s3.amazonaws.com-cli-example", + "ForwardedValues": { + "QueryString": false, + "Cookies": { + "Forward": "none" + }, + "Headers": { + "Quantity": 0 + }, + "QueryStringCacheKeys": { + "Quantity": 0 + } + }, + "TrustedSigners": { + "Enabled": false, + "Quantity": 0 + }, + "ViewerProtocolPolicy": "allow-all", + "MinTTL": 0, + "AllowedMethods": { + "Quantity": 2, + "Items": [ + "HEAD", + "GET" + ], + "CachedMethods": { + "Quantity": 2, + "Items": [ + "HEAD", + "GET" + ] + } + }, + "SmoothStreaming": false, + "DefaultTTL": 86400, + "MaxTTL": 31536000, + "Compress": false, + "LambdaFunctionAssociations": { + "Quantity": 0 + }, + "FieldLevelEncryptionId": "" + }, + "CacheBehaviors": { + "Quantity": 0 + }, + "CustomErrorResponses": { + "Quantity": 0 + }, + "Comment": "", + "Logging": { + "Enabled": false, + "IncludeCookies": false, + "Bucket": "", + "Prefix": "" + }, + "PriceClass": "PriceClass_All", + "Enabled": true, + "ViewerCertificate": { + "CloudFrontDefaultCertificate": true, + "MinimumProtocolVersion": "TLSv1", + "CertificateSource": "cloudfront" + }, + "Restrictions": { + "GeoRestriction": { + "RestrictionType": "none", + "Quantity": 0 + } + }, + "WebACLId": "", + "HttpVersion": "http2", + "IsIPV6Enabled": true + } + } diff -Nru awscli-1.16.301/awscli/examples/cloudfront/get-distribution.rst awscli-1.17.14/awscli/examples/cloudfront/get-distribution.rst --- awscli-1.16.301/awscli/examples/cloudfront/get-distribution.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/get-distribution.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,104 +1,126 @@ -**To get information about a CloudFront distribution** +**To get a CloudFront distribution** -The following command gets a distribution with the ID ``S11A16G5KZMEQD``:: +The following example gets the CloudFront distribution with the ID +``EDFDVBD6EXAMPLE``, including its ``ETag``. The distribution ID is returned in +the `create-distribution `_ and `list-distributions +`_ commands. - aws cloudfront get-distribution --id S11A16G5KZMEQD +:: -The distribution ID is available in the output of ``create-distribution`` and ``list-distributions``. + aws cloudfront get-distribution --id EDFDVBD6EXAMPLE Output:: - { - "Distribution": { - "Status": "Deployed", - "DomainName": "d2wkuj2w9l34gt.cloudfront.net", - "InProgressInvalidationBatches": 0, - "DistributionConfig": { - "Comment": "", - "CacheBehaviors": { - "Quantity": 0 - }, - "Logging": { - "Bucket": "", - "Prefix": "", - "Enabled": false, - "IncludeCookies": false - }, - "Origins": { - "Items": [ - { - "OriginPath": "", - "S3OriginConfig": { - "OriginAccessIdentity": "" - }, - "Id": "my-origin", - "DomainName": "my-bucket.s3.amazonaws.com" - } - ], - "Quantity": 1 - }, - "DefaultRootObject": "", - "PriceClass": "PriceClass_All", - "Enabled": true, - "DefaultCacheBehavior": { - "TrustedSigners": { - "Enabled": false, - "Quantity": 0 - }, - "TargetOriginId": "my-origin", - "ViewerProtocolPolicy": "allow-all", - "ForwardedValues": { - "Headers": { - "Quantity": 0 - }, - "Cookies": { - "Forward": "none" - }, - "QueryString": true - }, - "MaxTTL": 31536000, - "SmoothStreaming": false, - "DefaultTTL": 86400, - "AllowedMethods": { - "Items": [ - "HEAD", - "GET" - ], - "CachedMethods": { - "Items": [ - "HEAD", - "GET" - ], - "Quantity": 2 - }, - "Quantity": 2 - }, - "MinTTL": 3600 - }, - "CallerReference": "my-distribution-2015-09-01", - "ViewerCertificate": { - "CloudFrontDefaultCertificate": true, - "MinimumProtocolVersion": "SSLv3" - }, - "CustomErrorResponses": { - "Quantity": 0 - }, - "Restrictions": { - "GeoRestriction": { - "RestrictionType": "none", - "Quantity": 0 - } - }, - "Aliases": { - "Quantity": 0 - } - }, - "ActiveTrustedSigners": { - "Enabled": false, - "Quantity": 0 - }, - "LastModifiedTime": "2015-08-31T21:11:29.093Z", - "Id": "S11A16G5KZMEQD" - }, - "ETag": "E37HOT42DHPVYH" - } + { + "ETag": "E2QWRUHEXAMPLE", + "Distribution": { + "Id": "EDFDVBD6EXAMPLE", + "ARN": "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE", + "Status": "Deployed", + "LastModifiedTime": "2019-12-04T23:35:41.433Z", + "InProgressInvalidationBatches": 0, + "DomainName": "d111111abcdef8.cloudfront.net", + "ActiveTrustedSigners": { + "Enabled": false, + "Quantity": 0 + }, + "DistributionConfig": { + "CallerReference": "cli-example", + "Aliases": { + "Quantity": 0 + }, + "DefaultRootObject": "index.html", + "Origins": { + "Quantity": 1, + "Items": [ + { + "Id": "awsexamplebucket.s3.amazonaws.com-cli-example", + "DomainName": "awsexamplebucket.s3.amazonaws.com", + "OriginPath": "", + "CustomHeaders": { + "Quantity": 0 + }, + "S3OriginConfig": { + "OriginAccessIdentity": "" + } + } + ] + }, + "OriginGroups": { + "Quantity": 0 + }, + "DefaultCacheBehavior": { + "TargetOriginId": "awsexamplebucket.s3.amazonaws.com-cli-example", + "ForwardedValues": { + "QueryString": false, + "Cookies": { + "Forward": "none" + }, + "Headers": { + "Quantity": 0 + }, + "QueryStringCacheKeys": { + "Quantity": 0 + } + }, + "TrustedSigners": { + "Enabled": false, + "Quantity": 0 + }, + "ViewerProtocolPolicy": "allow-all", + "MinTTL": 0, + "AllowedMethods": { + "Quantity": 2, + "Items": [ + "HEAD", + "GET" + ], + "CachedMethods": { + "Quantity": 2, + "Items": [ + "HEAD", + "GET" + ] + } + }, + "SmoothStreaming": false, + "DefaultTTL": 86400, + "MaxTTL": 31536000, + "Compress": false, + "LambdaFunctionAssociations": { + "Quantity": 0 + }, + "FieldLevelEncryptionId": "" + }, + "CacheBehaviors": { + "Quantity": 0 + }, + "CustomErrorResponses": { + "Quantity": 0 + }, + "Comment": "", + "Logging": { + "Enabled": false, + "IncludeCookies": false, + "Bucket": "", + "Prefix": "" + }, + "PriceClass": "PriceClass_All", + "Enabled": true, + "ViewerCertificate": { + "CloudFrontDefaultCertificate": true, + "MinimumProtocolVersion": "TLSv1", + "CertificateSource": "cloudfront" + }, + "Restrictions": { + "GeoRestriction": { + "RestrictionType": "none", + "Quantity": 0 + } + }, + "WebACLId": "", + "HttpVersion": "http2", + "IsIPV6Enabled": true + } + } + } diff -Nru awscli-1.16.301/awscli/examples/cloudfront/get-field-level-encryption-config.rst awscli-1.17.14/awscli/examples/cloudfront/get-field-level-encryption-config.rst --- awscli-1.16.301/awscli/examples/cloudfront/get-field-level-encryption-config.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/get-field-level-encryption-config.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,36 @@ +**To get metadata about a CloudFront field-level encryption configuration** + +The following example gets metadata about the CloudFront field-level encryption +configuration with the ID ``C3KM2WVD605UAY``, including its ``ETag``:: + + aws cloudfront get-field-level-encryption-config --id C3KM2WVD605UAY + +Output:: + + { + "ETag": "E2P4Z4VU7TY5SG", + "FieldLevelEncryptionConfig": { + "CallerReference": "cli-example", + "Comment": "Example FLE configuration", + "QueryArgProfileConfig": { + "ForwardWhenQueryArgProfileIsUnknown": true, + "QueryArgProfiles": { + "Quantity": 0, + "Items": [] + } + }, + "ContentTypeProfileConfig": { + "ForwardWhenContentTypeIsUnknown": true, + "ContentTypeProfiles": { + "Quantity": 1, + "Items": [ + { + "Format": "URLEncoded", + "ProfileId": "P280MFCLSYOCVU", + "ContentType": "application/x-www-form-urlencoded" + } + ] + } + } + } + } diff -Nru awscli-1.16.301/awscli/examples/cloudfront/get-field-level-encryption-profile-config.rst awscli-1.17.14/awscli/examples/cloudfront/get-field-level-encryption-profile-config.rst --- awscli-1.16.301/awscli/examples/cloudfront/get-field-level-encryption-profile-config.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/get-field-level-encryption-profile-config.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,32 @@ +**To get a CloudFront field-level encryption profile configuration** + +The following example gets metadata about the CloudFront field-level encryption +profile with ID ``PPK0UOSIF5WSV`` , including its ``ETag``:: + + aws cloudfront get-field-level-encryption-profile-config --id PPK0UOSIF5WSV + +Output:: + + { + "ETag": "E1QQG65FS2L2GC", + "FieldLevelEncryptionProfileConfig": { + "Name": "ExampleFLEProfile", + "CallerReference": "cli-example", + "Comment": "FLE profile for AWS CLI example", + "EncryptionEntities": { + "Quantity": 1, + "Items": [ + { + "PublicKeyId": "K2K8NC4HVFE3M0", + "ProviderId": "ExampleFLEProvider", + "FieldPatterns": { + "Quantity": 1, + "Items": [ + "ExampleSensitiveField" + ] + } + } + ] + } + } + } diff -Nru awscli-1.16.301/awscli/examples/cloudfront/get-field-level-encryption-profile.rst awscli-1.17.14/awscli/examples/cloudfront/get-field-level-encryption-profile.rst --- awscli-1.16.301/awscli/examples/cloudfront/get-field-level-encryption-profile.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/get-field-level-encryption-profile.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,36 @@ +**To get a CloudFront field-level encryption profile** + +The following example gets the CloudFront field-level encryption profile with +ID ``PPK0UOSIF5WSV`` , including its ``ETag``:: + + aws cloudfront get-field-level-encryption-profile --id PPK0UOSIF5WSV + +Output:: + + { + "ETag": "E1QQG65FS2L2GC", + "FieldLevelEncryptionProfile": { + "Id": "PPK0UOSIF5WSV", + "LastModifiedTime": "2019-12-10T01:03:16.537Z", + "FieldLevelEncryptionProfileConfig": { + "Name": "ExampleFLEProfile", + "CallerReference": "cli-example", + "Comment": "FLE profile for AWS CLI example", + "EncryptionEntities": { + "Quantity": 1, + "Items": [ + { + "PublicKeyId": "K2K8NC4HVFE3M0", + "ProviderId": "ExampleFLEProvider", + "FieldPatterns": { + "Quantity": 1, + "Items": [ + "ExampleSensitiveField" + ] + } + } + ] + } + } + } + } diff -Nru awscli-1.16.301/awscli/examples/cloudfront/get-field-level-encryption.rst awscli-1.17.14/awscli/examples/cloudfront/get-field-level-encryption.rst --- awscli-1.16.301/awscli/examples/cloudfront/get-field-level-encryption.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/get-field-level-encryption.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,40 @@ +**To get a CloudFront field-level encryption configuration** + +The following example gets the CloudFront field-level encryption configuration +with the ID ``C3KM2WVD605UAY``, including its ``ETag``:: + + aws cloudfront get-field-level-encryption --id C3KM2WVD605UAY + +Output:: + + { + "ETag": "E2P4Z4VU7TY5SG", + "FieldLevelEncryption": { + "Id": "C3KM2WVD605UAY", + "LastModifiedTime": "2019-12-10T21:30:18.974Z", + "FieldLevelEncryptionConfig": { + "CallerReference": "cli-example", + "Comment": "Example FLE configuration", + "QueryArgProfileConfig": { + "ForwardWhenQueryArgProfileIsUnknown": true, + "QueryArgProfiles": { + "Quantity": 0, + "Items": [] + } + }, + "ContentTypeProfileConfig": { + "ForwardWhenContentTypeIsUnknown": true, + "ContentTypeProfiles": { + "Quantity": 1, + "Items": [ + { + "Format": "URLEncoded", + "ProfileId": "P280MFCLSYOCVU", + "ContentType": "application/x-www-form-urlencoded" + } + ] + } + } + } + } + } diff -Nru awscli-1.16.301/awscli/examples/cloudfront/get-invalidation.rst awscli-1.17.14/awscli/examples/cloudfront/get-invalidation.rst --- awscli-1.16.301/awscli/examples/cloudfront/get-invalidation.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/get-invalidation.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,27 +1,26 @@ -**To get information about an invalidation** +**To get a CloudFront invalidation** -The following command retrieves an invalidation with the ID ``YNY2LI2BVJ4NJU`` for a CloudFront web distribution with the ID ``S11A16G5KZMEQD``:: +The following example gets the invalidation with the ID ``I2J0I21PCUYOIK`` for +the CloudFront distribution with the ID ``EDFDVBD6EXAMPLE``:: - aws cloudfront get-invalidation --id YNY2LI2BVJ4NJU --distribution-id S11A16G5KZMEQD - -The distribution ID is available in the output of ``create-distribution`` and ``list-distributions``. The invalidation ID is available in the output of ``create-invalidation`` and ``list-invalidations``. + aws cloudfront get-invalidation --id I2J0I21PCUYOIK --distribution-id EDFDVBD6EXAMPLE Output:: - { - "Invalidation": { - "Status": "Completed", - "InvalidationBatch": { - "Paths": { - "Items": [ - "/index.html", - "/error.html" - ], - "Quantity": 2 - }, - "CallerReference": "my-invalidation-2015-09-01" - }, - "Id": "YNY2LI2BVJ4NJU", - "CreateTime": "2015-08-31T21:15:52.042Z" - } - } + { + "Invalidation": { + "Status": "Completed", + "InvalidationBatch": { + "Paths": { + "Items": [ + "/example-path/example-file.jpg", + "/example-path/example-file-2.jpg" + ], + "Quantity": 2 + }, + "CallerReference": "cli-example" + }, + "Id": "I2J0I21PCUYOIK", + "CreateTime": "2019-12-05T18:40:49.413Z" + } + } diff -Nru awscli-1.16.301/awscli/examples/cloudfront/get-public-key-config.rst awscli-1.17.14/awscli/examples/cloudfront/get-public-key-config.rst --- awscli-1.16.301/awscli/examples/cloudfront/get-public-key-config.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/get-public-key-config.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,22 @@ +**To get a CloudFront public key configuration** + +The following example gets metadata about the CloudFront public key with the ID +``KDFB19YGCR002``, including its ``ETag``. The public key ID is returned in the +`create-public-key `_ and `list-public-keys +`_ commands. + +:: + + aws cloudfront get-public-key-config --id KDFB19YGCR002 + +Output:: + + { + "ETag": "E2QWRUHEXAMPLE", + "PublicKeyConfig": { + "CallerReference": "cli-example", + "Name": "ExampleKey", + "EncodedKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxPMbCA2Ks0lnd7IR+3pw\nwd3H/7jPGwj8bLUmore7bX+oeGpZ6QmLAe/1UOWcmZX2u70dYcSIzB1ofZtcn4cJ\nenHBAzO3ohBY/L1tQGJfS2A+omnN6H16VZE1JCK8XSJyfze7MDLcUyHZETdxuvRb\nA9X343/vMAuQPnhinFJ8Wdy8YBXSPpy7r95ylUQd9LfYTBzVZYG2tSesplcOkjM3\n2Uu+oMWxQAw1NINnSLPinMVsutJy6ZqlV3McWNWe4T+STGtWhrPNqJEn45sIcCx4\nq+kGZ2NQ0FyIyT2eiLKOX5Rgb/a36E/aMk4VoDsaenBQgG7WLTnstb9sr7MIhS6A\nrwIDAQAB\n-----END PUBLIC KEY-----\n", + "Comment": "example public key" + } + } diff -Nru awscli-1.16.301/awscli/examples/cloudfront/get-public-key.rst awscli-1.17.14/awscli/examples/cloudfront/get-public-key.rst --- awscli-1.16.301/awscli/examples/cloudfront/get-public-key.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/get-public-key.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,26 @@ +**To get a CloudFront public key** + +The following example gets the CloudFront public key with the ID +``KDFB19YGCR002``, including its ``ETag``. The public key ID is returned in the +`create-public-key `_ and `list-public-keys +`_ commands. + +:: + + aws cloudfront get-public-key --id KDFB19YGCR002 + +Output:: + + { + "ETag": "E2QWRUHEXAMPLE", + "PublicKey": { + "Id": "KDFB19YGCR002", + "CreatedTime": "2019-12-05T18:51:43.781Z", + "PublicKeyConfig": { + "CallerReference": "cli-example", + "Name": "ExampleKey", + "EncodedKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxPMbCA2Ks0lnd7IR+3pw\nwd3H/7jPGwj8bLUmore7bX+oeGpZ6QmLAe/1UOWcmZX2u70dYcSIzB1ofZtcn4cJ\nenHBAzO3ohBY/L1tQGJfS2A+omnN6H16VZE1JCK8XSJyfze7MDLcUyHZETdxuvRb\nA9X343/vMAuQPnhinFJ8Wdy8YBXSPpy7r95ylUQd9LfYTBzVZYG2tSesplcOkjM3\n2Uu+oMWxQAw1NINnSLPinMVsutJy6ZqlV3McWNWe4T+STGtWhrPNqJEn45sIcCx4\nq+kGZ2NQ0FyIyT2eiLKOX5Rgb/a36E/aMk4VoDsaenBQgG7WLTnstb9sr7MIhS6A\nrwIDAQAB\n-----END PUBLIC KEY-----\n", + "Comment": "example public key" + } + } + } diff -Nru awscli-1.16.301/awscli/examples/cloudfront/list-cloud-front-origin-access-identities.rst awscli-1.17.14/awscli/examples/cloudfront/list-cloud-front-origin-access-identities.rst --- awscli-1.16.301/awscli/examples/cloudfront/list-cloud-front-origin-access-identities.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/list-cloud-front-origin-access-identities.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,30 @@ +**To list CloudFront origin access identities** + +The following example gets a list of the CloudFront origin access identities +(OAIs) in your AWS account:: + + aws cloudfront list-cloud-front-origin-access-identities + +Output:: + + { + "CloudFrontOriginAccessIdentityList": { + "Items": [ + { + "Id": "E74FTE3AEXAMPLE", + "S3CanonicalUserId": "cd13868f797c227fbea2830611a26fe0a21ba1b826ab4bed9b7771c9aEXAMPLE", + "Comment": "Example OAI" + }, + { + "Id": "EH1HDMBEXAMPLE", + "S3CanonicalUserId": "1489f6f2e6faacaae7ff64c4c3e6956c24f78788abfc1718c3527c263bf7a17EXAMPLE", + "Comment": "Test OAI" + }, + { + "Id": "E2X2C9TEXAMPLE", + "S3CanonicalUserId": "cbfeebb915a64749f9be546a45b3fcfd3a31c779673c13c4dd460911ae402c2EXAMPLE", + "Comment": "Example OAI #2" + } + ] + } + } diff -Nru awscli-1.16.301/awscli/examples/cloudfront/list-distributions.rst awscli-1.17.14/awscli/examples/cloudfront/list-distributions.rst --- awscli-1.16.301/awscli/examples/cloudfront/list-distributions.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/list-distributions.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,95 +1,330 @@ **To list CloudFront distributions** -The following command retrieves a list of distributions:: +The following example gets a list of the CloudFront distributions in your AWS +account:: - aws cloudfront list-distributions + aws cloudfront list-distributions Output:: - { - "DistributionList": { - "Marker": "", - "Items": [ - { - "Status": "Deployed", - "ARN": "arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5", - "CacheBehaviors": { - "Quantity": 0 - }, - "Origins": { - "Items": [ - { - "OriginPath": "", - "S3OriginConfig": { - "OriginAccessIdentity": "" - }, - "Id": "my-origin", - "DomainName": "my-bucket.s3.amazonaws.com" - } - ], - "Quantity": 1 - }, - "DomainName": "d2wkuj2w9l34gt.cloudfront.net", - "PriceClass": "PriceClass_All", - "Enabled": true, - "DefaultCacheBehavior": { - "TrustedSigners": { - "Enabled": false, - "Quantity": 0 - }, - "TargetOriginId": "my-origin", - "ViewerProtocolPolicy": "allow-all", - "ForwardedValues": { - "Headers": { - "Quantity": 0 - }, - "Cookies": { - "Forward": "none" - }, - "QueryString": true - }, - "MaxTTL": 31536000, - "SmoothStreaming": false, - "DefaultTTL": 86400, - "AllowedMethods": { - "Items": [ - "HEAD", - "GET" - ], - "CachedMethods": { - "Items": [ - "HEAD", - "GET" - ], - "Quantity": 2 - }, - "Quantity": 2 - }, - "MinTTL": 3600 - }, - "Comment": "", - "ViewerCertificate": { - "CloudFrontDefaultCertificate": true, - "MinimumProtocolVersion": "SSLv3" - }, - "CustomErrorResponses": { - "Quantity": 0 - }, - "LastModifiedTime": "2015-08-31T21:11:29.093Z", - "Id": "S11A16G5KZMEQD", - "Restrictions": { - "GeoRestriction": { - "RestrictionType": "none", - "Quantity": 0 - } - }, - "Aliases": { - "Quantity": 0 - } - } - ], - "IsTruncated": false, - "MaxItems": 100, - "Quantity": 1 - } - } + { + "DistributionList": { + "Items": [ + { + "Id": "EMLARXS9EXAMPLE", + "ARN": "arn:aws:cloudfront::123456789012:distribution/EMLARXS9EXAMPLE", + "Status": "InProgress", + "LastModifiedTime": "2019-11-22T00:55:15.705Z", + "InProgressInvalidationBatches": 0, + "DomainName": "d111111abcdef8.cloudfront.net", + "ActiveTrustedSigners": { + "Enabled": false, + "Quantity": 0 + }, + "DistributionConfig": { + "CallerReference": "cli-example", + "Aliases": { + "Quantity": 0 + }, + "DefaultRootObject": "index.html", + "Origins": { + "Quantity": 1, + "Items": [ + { + "Id": "awsexamplebucket.s3.amazonaws.com-cli-example", + "DomainName": "awsexamplebucket.s3.amazonaws.com", + "OriginPath": "", + "CustomHeaders": { + "Quantity": 0 + }, + "S3OriginConfig": { + "OriginAccessIdentity": "" + } + } + ] + }, + "OriginGroups": { + "Quantity": 0 + }, + "DefaultCacheBehavior": { + "TargetOriginId": "awsexamplebucket.s3.amazonaws.com-cli-example", + "ForwardedValues": { + "QueryString": false, + "Cookies": { + "Forward": "none" + }, + "Headers": { + "Quantity": 0 + }, + "QueryStringCacheKeys": { + "Quantity": 0 + } + }, + "TrustedSigners": { + "Enabled": false, + "Quantity": 0 + }, + "ViewerProtocolPolicy": "allow-all", + "MinTTL": 0, + "AllowedMethods": { + "Quantity": 2, + "Items": [ + "HEAD", + "GET" + ], + "CachedMethods": { + "Quantity": 2, + "Items": [ + "HEAD", + "GET" + ] + } + }, + "SmoothStreaming": false, + "DefaultTTL": 86400, + "MaxTTL": 31536000, + "Compress": false, + "LambdaFunctionAssociations": { + "Quantity": 0 + }, + "FieldLevelEncryptionId": "" + }, + "CacheBehaviors": { + "Quantity": 0 + }, + "CustomErrorResponses": { + "Quantity": 0 + }, + "Comment": "", + "Logging": { + "Enabled": false, + "IncludeCookies": false, + "Bucket": "", + "Prefix": "" + }, + "PriceClass": "PriceClass_All", + "Enabled": true, + "ViewerCertificate": { + "CloudFrontDefaultCertificate": true, + "MinimumProtocolVersion": "TLSv1", + "CertificateSource": "cloudfront" + }, + "Restrictions": { + "GeoRestriction": { + "RestrictionType": "none", + "Quantity": 0 + } + }, + "WebACLId": "", + "HttpVersion": "http2", + "IsIPV6Enabled": true + } + }, + { + "Id": "EDFDVBD6EXAMPLE", + "ARN": "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE", + "Status": "InProgress", + "LastModifiedTime": "2019-12-04T23:35:41.433Z", + "InProgressInvalidationBatches": 0, + "DomainName": "d930174dauwrn8.cloudfront.net", + "ActiveTrustedSigners": { + "Enabled": false, + "Quantity": 0 + }, + "DistributionConfig": { + "CallerReference": "cli-example", + "Aliases": { + "Quantity": 0 + }, + "DefaultRootObject": "index.html", + "Origins": { + "Quantity": 1, + "Items": [ + { + "Id": "awsexamplebucket1.s3.amazonaws.com-cli-example", + "DomainName": "awsexamplebucket1.s3.amazonaws.com", + "OriginPath": "", + "CustomHeaders": { + "Quantity": 0 + }, + "S3OriginConfig": { + "OriginAccessIdentity": "" + } + } + ] + }, + "OriginGroups": { + "Quantity": 0 + }, + "DefaultCacheBehavior": { + "TargetOriginId": "awsexamplebucket1.s3.amazonaws.com-cli-example", + "ForwardedValues": { + "QueryString": false, + "Cookies": { + "Forward": "none" + }, + "Headers": { + "Quantity": 0 + }, + "QueryStringCacheKeys": { + "Quantity": 0 + } + }, + "TrustedSigners": { + "Enabled": false, + "Quantity": 0 + }, + "ViewerProtocolPolicy": "allow-all", + "MinTTL": 0, + "AllowedMethods": { + "Quantity": 2, + "Items": [ + "HEAD", + "GET" + ], + "CachedMethods": { + "Quantity": 2, + "Items": [ + "HEAD", + "GET" + ] + } + }, + "SmoothStreaming": false, + "DefaultTTL": 86400, + "MaxTTL": 31536000, + "Compress": false, + "LambdaFunctionAssociations": { + "Quantity": 0 + }, + "FieldLevelEncryptionId": "" + }, + "CacheBehaviors": { + "Quantity": 0 + }, + "CustomErrorResponses": { + "Quantity": 0 + }, + "Comment": "", + "Logging": { + "Enabled": false, + "IncludeCookies": false, + "Bucket": "", + "Prefix": "" + }, + "PriceClass": "PriceClass_All", + "Enabled": true, + "ViewerCertificate": { + "CloudFrontDefaultCertificate": true, + "MinimumProtocolVersion": "TLSv1", + "CertificateSource": "cloudfront" + }, + "Restrictions": { + "GeoRestriction": { + "RestrictionType": "none", + "Quantity": 0 + } + }, + "WebACLId": "", + "HttpVersion": "http2", + "IsIPV6Enabled": true + } + }, + { + "Id": "E1X5IZQEXAMPLE", + "ARN": "arn:aws:cloudfront::123456789012:distribution/E1X5IZQEXAMPLE", + "Status": "Deployed", + "LastModifiedTime": "2019-11-06T21:31:48.864Z", + "DomainName": "d2e04y12345678.cloudfront.net", + "Aliases": { + "Quantity": 0 + }, + "Origins": { + "Quantity": 1, + "Items": [ + { + "Id": "awsexamplebucket2", + "DomainName": "awsexamplebucket2.s3.us-west-2.amazonaws.com", + "OriginPath": "", + "CustomHeaders": { + "Quantity": 0 + }, + "S3OriginConfig": { + "OriginAccessIdentity": "" + } + } + ] + }, + "OriginGroups": { + "Quantity": 0 + }, + "DefaultCacheBehavior": { + "TargetOriginId": "awsexamplebucket2", + "ForwardedValues": { + "QueryString": false, + "Cookies": { + "Forward": "none" + }, + "Headers": { + "Quantity": 0 + }, + "QueryStringCacheKeys": { + "Quantity": 0 + } + }, + "TrustedSigners": { + "Enabled": false, + "Quantity": 0 + }, + "ViewerProtocolPolicy": "allow-all", + "MinTTL": 0, + "AllowedMethods": { + "Quantity": 2, + "Items": [ + "HEAD", + "GET" + ], + "CachedMethods": { + "Quantity": 2, + "Items": [ + "HEAD", + "GET" + ] + } + }, + "SmoothStreaming": false, + "DefaultTTL": 86400, + "MaxTTL": 31536000, + "Compress": false, + "LambdaFunctionAssociations": { + "Quantity": 0 + }, + "FieldLevelEncryptionId": "" + }, + "CacheBehaviors": { + "Quantity": 0 + }, + "CustomErrorResponses": { + "Quantity": 0 + }, + "Comment": "", + "PriceClass": "PriceClass_All", + "Enabled": true, + "ViewerCertificate": { + "CloudFrontDefaultCertificate": true, + "MinimumProtocolVersion": "TLSv1", + "CertificateSource": "cloudfront" + }, + "Restrictions": { + "GeoRestriction": { + "RestrictionType": "none", + "Quantity": 0 + } + }, + "WebACLId": "", + "HttpVersion": "HTTP1_1", + "IsIPV6Enabled": true + } + ] + } + } diff -Nru awscli-1.16.301/awscli/examples/cloudfront/list-field-level-encryption-configs.rst awscli-1.17.14/awscli/examples/cloudfront/list-field-level-encryption-configs.rst --- awscli-1.16.301/awscli/examples/cloudfront/list-field-level-encryption-configs.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/list-field-level-encryption-configs.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,42 @@ +**To list CloudFront field-level encryption configurations** + +The following example gets a list of the CloudFront field-level encryption +configurations in your AWS account:: + + aws cloudfront list-field-level-encryption-configs + +Output:: + + { + "FieldLevelEncryptionList": { + "MaxItems": 100, + "Quantity": 1, + "Items": [ + { + "Id": "C3KM2WVD605UAY", + "LastModifiedTime": "2019-12-10T21:30:18.974Z", + "Comment": "Example FLE configuration", + "QueryArgProfileConfig": { + "ForwardWhenQueryArgProfileIsUnknown": true, + "QueryArgProfiles": { + "Quantity": 0, + "Items": [] + } + }, + "ContentTypeProfileConfig": { + "ForwardWhenContentTypeIsUnknown": true, + "ContentTypeProfiles": { + "Quantity": 1, + "Items": [ + { + "Format": "URLEncoded", + "ProfileId": "P280MFCLSYOCVU", + "ContentType": "application/x-www-form-urlencoded" + } + ] + } + } + } + ] + } + } diff -Nru awscli-1.16.301/awscli/examples/cloudfront/list-field-level-encryption-profiles.rst awscli-1.17.14/awscli/examples/cloudfront/list-field-level-encryption-profiles.rst --- awscli-1.16.301/awscli/examples/cloudfront/list-field-level-encryption-profiles.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/list-field-level-encryption-profiles.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,59 @@ +**To list CloudFront field-level encryption profiles** + +The following example gets a list of the CloudFront field-level encryption +profiles in your AWS account:: + + aws cloudfront list-field-level-encryption-profiles + +Output:: + + { + "FieldLevelEncryptionProfileList": { + "MaxItems": 100, + "Quantity": 2, + "Items": [ + { + "Id": "P280MFCLSYOCVU", + "LastModifiedTime": "2019-12-05T01:05:39.896Z", + "Name": "ExampleFLEProfile", + "EncryptionEntities": { + "Quantity": 1, + "Items": [ + { + "PublicKeyId": "K2K8NC4HVFE3M0", + "ProviderId": "ExampleFLEProvider", + "FieldPatterns": { + "Quantity": 1, + "Items": [ + "ExampleSensitiveField" + ] + } + } + ] + }, + "Comment": "FLE profile for AWS CLI example" + }, + { + "Id": "PPK0UOSIF5WSV", + "LastModifiedTime": "2019-12-10T01:03:16.537Z", + "Name": "ExampleFLEProfile2", + "EncryptionEntities": { + "Quantity": 1, + "Items": [ + { + "PublicKeyId": "K2ABC10EXAMPLE", + "ProviderId": "ExampleFLEProvider2", + "FieldPatterns": { + "Quantity": 1, + "Items": [ + "ExampleSensitiveField2" + ] + } + } + ] + }, + "Comment": "FLE profile #2 for AWS CLI example" + } + ] + } + } diff -Nru awscli-1.16.301/awscli/examples/cloudfront/list-invalidations.rst awscli-1.17.14/awscli/examples/cloudfront/list-invalidations.rst --- awscli-1.16.301/awscli/examples/cloudfront/list-invalidations.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/list-invalidations.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,25 +1,24 @@ **To list CloudFront invalidations** -The following command retrieves a list of invalidations for a CloudFront web distribution with the ID ``S11A16G5KZMEQD``:: +The following example gets a list of the invalidations for the CloudFront +distribution with the ID ``EDFDVBD6EXAMPLE``:: - aws cloudfront list-invalidations --distribution-id S11A16G5KZMEQD - -The distribution ID is available in the output of ``create-distribution`` and ``list-distributions``. + aws cloudfront list-invalidations --distribution-id EDFDVBD6EXAMPLE Output:: - { - "InvalidationList": { - "Marker": "", - "Items": [ - { - "Status": "Completed", - "Id": "YNY2LI2BVJ4NJU", - "CreateTime": "2015-08-31T21:15:52.042Z" - } - ], - "IsTruncated": false, - "MaxItems": 100, - "Quantity": 1 - } - } + { + "InvalidationList": { + "Marker": "", + "Items": [ + { + "Status": "Completed", + "Id": "YNY2LI2BVJ4NJU", + "CreateTime": "2019-08-31T21:15:52.042Z" + } + ], + "IsTruncated": false, + "MaxItems": 100, + "Quantity": 1 + } + } diff -Nru awscli-1.16.301/awscli/examples/cloudfront/list-public-keys.rst awscli-1.17.14/awscli/examples/cloudfront/list-public-keys.rst --- awscli-1.16.301/awscli/examples/cloudfront/list-public-keys.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/list-public-keys.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,31 @@ +**To list CloudFront public keys** + +The following example gets a list of the CloudFront public keys in your AWS +account:: + + aws cloudfront list-public-keys + +Output:: + + { + "PublicKeyList": { + "MaxItems": 100, + "Quantity": 2, + "Items": [ + { + "Id": "K2K8NC4HVFE3M0", + "Name": "ExampleKey", + "CreatedTime": "2019-12-05T01:04:28.818Z", + "EncodedKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxPMbCA2Ks0lnd7IR+3pw\nwd3H/7jPGwj8bLUmore7bX+oeGpZ6QmLAe/1UOWcmZX2u70dYcSIzB1ofZtcn4cJ\nenHBAzO3ohBY/L1tQGJfS2A+omnN6H16VZE1JCK8XSJyfze7MDLcUyHZETdxuvRb\nA9X343/vMAuQPnhinFJ8Wdy8YBXSPpy7r95ylUQd9LfYTBzVZYG2tSesplcOkjM3\n2Uu+oMWxQAw1NINnSLPinMVsutJy6ZqlV3McWNWe4T+STGtWhrPNqJEn45sIcCx4\nq+kGZ2NQ0FyIyT2eiLKOX5Rgb/a36E/aMk4VoDsaenBQgG7WLTnstb9sr7MIhS6A\nrwIDAQAB\n-----END PUBLIC KEY-----\n", + "Comment": "example public key" + }, + { + "Id": "K1S0LWQ2L5HTBU", + "Name": "ExampleKey2", + "CreatedTime": "2019-12-09T23:28:11.110Z", + "EncodedKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEApOCAg88A8+f4dujn9Izt\n26LxtgAkn2opGgo/NKpMiaisyw5qlg3f1gol7FV6pYNl78iJg3EO8JBbwtlH+cR9\nLGSf60NDeVhm76Oc39Np/vWgOdsGQcRbi9WmKZeSODqjQGzVZWqPmito3FzWVk6b\nfVY5N36U/RdbVAJm95Km+qaMYlbIdF40t72bi3IkKYV5hlB2XoDjlQ9F6ajQKyTB\nMHa3SN8q+3ZjQ4sJJ7D1V6r4wR8jDcFVD5NckWJmmgIVnkOQM37NYeoDnkaOuTpu\nha/+3b8tOb2z3LBVHPkp85zJRAOXacSwf5rZtPYKBNFsixTa2n55k2r218mOkMC4\nUwIDAQAB\n-----END PUBLIC KEY-----", + "Comment": "example public key #2" + } + ] + } + } diff -Nru awscli-1.16.301/awscli/examples/cloudfront/list-tags-for-resource.rst awscli-1.17.14/awscli/examples/cloudfront/list-tags-for-resource.rst --- awscli-1.16.301/awscli/examples/cloudfront/list-tags-for-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/list-tags-for-resource.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,27 @@ +**To list tags for a CloudFront distribution** + +The following example gets a list of the tags for a CloudFront distribution:: + + aws cloudfront list-tags-for-resource \ + --resource arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE + +Output:: + + { + "Tags": { + "Items": [ + { + "Key": "DateCreated", + "Value": "2019-12-04" + }, + { + "Key": "Name", + "Value": "Example name" + }, + { + "Key": "Project", + "Value": "Example project" + } + ] + } + } diff -Nru awscli-1.16.301/awscli/examples/cloudfront/sign.rst awscli-1.17.14/awscli/examples/cloudfront/sign.rst --- awscli-1.16.301/awscli/examples/cloudfront/sign.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/sign.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,21 @@ +**To sign a CloudFront URL** + +The following example signs a CloudFront URL. To sign a URL, you need the key +pair ID (called the **Access Key ID** in the AWS Management Console) and the +private key of the trusted signer's CloudFront key pair. For more information +about signed URLs, see `Serving Private Content with Signed URLs and Signed +Cookies +`_ +in the *Amazon CloudFront Developer Guide*. + +:: + + aws cloudfront sign \ + --url https://d111111abcdef8.cloudfront.net/private-content/private-file.html \ + --key-pair-id APKAEIBAERJR2EXAMPLE \ + --private-key file://cf-signer-priv-key.pem \ + --date-less-than 2020-01-01 + +Output:: + + https://d111111abcdef8.cloudfront.net/private-content/private-file.html?Expires=1577836800&Signature=nEXK7Kby47XKeZQKVc6pwkif6oZc-JWSpDkH0UH7EBGGqvgurkecCbgL5VfUAXyLQuJxFwRQWscz-owcq9KpmewCXrXQbPaJZNi9XSNwf4YKurPDQYaRQawKoeenH0GFteRf9ELK-Bs3nljTLjtbgzIUt7QJNKXcWr8AuUYikzGdJ4-qzx6WnxXfH~fxg4-GGl6l2kgCpXUB6Jx6K~Y3kpVOdzUPOIqFLHAnJojbhxqrVejomZZ2XrquDvNUCCIbePGnR3d24UPaLXG4FKOqNEaWDIBXu7jUUPwOyQCvpt-GNvjRJxqWf93uMobeMOiVYahb-e0KItiQewGcm0eLZQ__&Key-Pair-Id=APKAEIBAERJR2EXAMPLE diff -Nru awscli-1.16.301/awscli/examples/cloudfront/tag-resource.rst awscli-1.17.14/awscli/examples/cloudfront/tag-resource.rst --- awscli-1.16.301/awscli/examples/cloudfront/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/tag-resource.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,33 @@ +**To tag a CloudFront distribution** + +The following example adds two tags to a CloudFront distribution by using +command line arguments:: + + aws cloudfront tag-resource \ + --resource arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE \ + --tags Items=[{Key=Name,Value="Example name"},{Key=Project,Value="Example project"}] + +Instead of using command line arguments, you can provide the tags in a JSON +file, as shown in the following example:: + + aws cloudfront tag-resource \ + --resource arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE \ + --tags file://tags.json + +The file ``tags.json`` is a JSON document in the current folder that contains +the following:: + + { + "Items": [ + { + "Key": "Name", + "Value": "Example name" + }, + { + "Key": "Project", + "Value": "Example project" + } + ] + } + +When successful, this command has no output. diff -Nru awscli-1.16.301/awscli/examples/cloudfront/untag-resource.rst awscli-1.17.14/awscli/examples/cloudfront/untag-resource.rst --- awscli-1.16.301/awscli/examples/cloudfront/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/untag-resource.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,27 @@ +**To remove tags from a CloudFront distribution** + +The following example removes two tags from a CloudFront distribution by using +command line arguments:: + + aws cloudfront untag-resource \ + --resource arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE \ + --tag-keys Items=Name,Project + +Instead of using command line arguments, you can provide the tag keys in a JSON +file, as shown in the following example:: + + aws cloudfront untag-resource \ + --resource arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE \ + --tag-keys file://tag-keys.json + +The file ``tag-keys.json`` is a JSON document in the current folder that +contains the following:: + + { + "Items": [ + "Name", + "Project" + ] + } + +When successful, this command has no output. diff -Nru awscli-1.16.301/awscli/examples/cloudfront/update-cloud-front-origin-access-identity.rst awscli-1.17.14/awscli/examples/cloudfront/update-cloud-front-origin-access-identity.rst --- awscli-1.16.301/awscli/examples/cloudfront/update-cloud-front-origin-access-identity.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/update-cloud-front-origin-access-identity.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,56 @@ +**To update a CloudFront origin access identity** + +The following example updates the origin access identity (OAI) with the ID +``E74FTE3AEXAMPLE``. The only field that you can update is the OAI's +``Comment``. + +To update an OAI, you must have the OAI's ID and ``ETag``. The OAI ID is returned in the output of the +`create-cloud-front-origin-access-identity +`_ and +`list-cloud-front-origin-access-identities +`_ commands. +To get the ``ETag``, use the +`get-cloud-front-origin-access-identity +`_ or +`get-cloud-front-origin-access-identity-config +`_ command. +Use the ``--if-match`` option to provide the OAI's ``ETag``. + +:: + + aws cloudfront update-cloud-front-origin-access-identity \ + --id E74FTE3AEXAMPLE \ + --if-match E2QWRUHEXAMPLE \ + --cloud-front-origin-access-identity-config \ + CallerReference=cli-example,Comment="Example OAI Updated" + +You can accomplish the same thing by providing the OAI configuration in a JSON +file, as shown in the following example:: + + aws cloudfront update-cloud-front-origin-access-identity \ + --id E74FTE3AEXAMPLE \ + --if-match E2QWRUHEXAMPLE \ + --cloud-front-origin-access-identity-config file://OAI-config.json + +The file ``OAI-config.json`` is a JSON document in the current directory that +contains the following:: + + { + "CallerReference": "cli-example", + "Comment": "Example OAI Updated" + } + +Whether you provide the OAI configuration with a command line argument or a +JSON file, the output is the same:: + + { + "ETag": "E9LHASXEXAMPLE", + "CloudFrontOriginAccessIdentity": { + "Id": "E74FTE3AEXAMPLE", + "S3CanonicalUserId": "cd13868f797c227fbea2830611a26fe0a21ba1b826ab4bed9b7771c9aEXAMPLE", + "CloudFrontOriginAccessIdentityConfig": { + "CallerReference": "cli-example", + "Comment": "Example OAI Updated" + } + } + } diff -Nru awscli-1.16.301/awscli/examples/cloudfront/update-distribution.rst awscli-1.17.14/awscli/examples/cloudfront/update-distribution.rst --- awscli-1.16.301/awscli/examples/cloudfront/update-distribution.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/update-distribution.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,195 +1,375 @@ -**To update a CloudFront distribution** +**To update a CloudFront distribution's default root object** -The following command updates the Default Root Object to "index.html" -for a CloudFront distribution with the ID ``S11A16G5KZMEQD``:: +The following example updates the default root object to ``index.html`` for the +CloudFront distribution with the ID ``EDFDVBD6EXAMPLE``:: - aws cloudfront update-distribution --id S11A16G5KZMEQD \ - --default-root-object index.html + aws cloudfront update-distribution --id EDFDVBD6EXAMPLE \ + --default-root-object index.html -The following command disables a CloudFront distribution with the ID ``S11A16G5KZMEQD``:: +Output:: - aws cloudfront update-distribution --id S11A16G5KZMEQD --distribution-config file://distconfig-disabled.json --if-match E37HOT42DHPVYH + { + "ETag": "E2QWRUHEXAMPLE", + "Distribution": { + "Id": "EDFDVBD6EXAMPLE", + "ARN": "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE", + "Status": "InProgress", + "LastModifiedTime": "2019-12-06T18:55:39.870Z", + "InProgressInvalidationBatches": 0, + "DomainName": "d111111abcdef8.cloudfront.net", + "ActiveTrustedSigners": { + "Enabled": false, + "Quantity": 0 + }, + "DistributionConfig": { + "CallerReference": "6b10378d-49be-4c4b-a642-419ccaf8f3b5", + "Aliases": { + "Quantity": 0 + }, + "DefaultRootObject": "index.html", + "Origins": { + "Quantity": 1, + "Items": [ + { + "Id": "example-website", + "DomainName": "www.example.com", + "OriginPath": "", + "CustomHeaders": { + "Quantity": 0 + }, + "CustomOriginConfig": { + "HTTPPort": 80, + "HTTPSPort": 443, + "OriginProtocolPolicy": "match-viewer", + "OriginSslProtocols": { + "Quantity": 2, + "Items": [ + "SSLv3", + "TLSv1" + ] + }, + "OriginReadTimeout": 30, + "OriginKeepaliveTimeout": 5 + } + } + ] + }, + "OriginGroups": { + "Quantity": 0 + }, + "DefaultCacheBehavior": { + "TargetOriginId": "example-website", + "ForwardedValues": { + "QueryString": false, + "Cookies": { + "Forward": "none" + }, + "Headers": { + "Quantity": 1, + "Items": [ + "*" + ] + }, + "QueryStringCacheKeys": { + "Quantity": 0 + } + }, + "TrustedSigners": { + "Enabled": false, + "Quantity": 0 + }, + "ViewerProtocolPolicy": "allow-all", + "MinTTL": 0, + "AllowedMethods": { + "Quantity": 2, + "Items": [ + "HEAD", + "GET" + ], + "CachedMethods": { + "Quantity": 2, + "Items": [ + "HEAD", + "GET" + ] + } + }, + "SmoothStreaming": false, + "DefaultTTL": 86400, + "MaxTTL": 31536000, + "Compress": false, + "LambdaFunctionAssociations": { + "Quantity": 0 + }, + "FieldLevelEncryptionId": "" + }, + "CacheBehaviors": { + "Quantity": 0 + }, + "CustomErrorResponses": { + "Quantity": 0 + }, + "Comment": "", + "Logging": { + "Enabled": false, + "IncludeCookies": false, + "Bucket": "", + "Prefix": "" + }, + "PriceClass": "PriceClass_All", + "Enabled": true, + "ViewerCertificate": { + "CloudFrontDefaultCertificate": true, + "MinimumProtocolVersion": "TLSv1", + "CertificateSource": "cloudfront" + }, + "Restrictions": { + "GeoRestriction": { + "RestrictionType": "none", + "Quantity": 0 + } + }, + "WebACLId": "", + "HttpVersion": "http1.1", + "IsIPV6Enabled": true + } + } + } -The distribution ID is available in the output of ``create-distribution`` and ``list-distributions``. The ETag value ``E37HOT42DHPVYH`` for the ``if-match`` parameter is available in the output of ``create-distribution``, ``get-distribution`` or ``get-distribution-config``. +**To update a CloudFront distribution** -The file ``distconfig-disabled.json`` is a JSON document in the current folder that modifies the existing distribution config for ``S11A16G5KZMEQD`` to disable the distribution. This file was created by taking the existing config from the ``DistributionConfig`` key in the output of ``get-distribution-config`` and changing the ``Enabled`` key's value to ``false``:: +The following example disables the CloudFront distribution with the ID +``EMLARXS9EXAMPLE`` by providing the distribution configuration in a JSON file +named ``dist-config-disable.json``. To update a distribution, you must use the +``--if-match`` option to provide the distribution's ``ETag``. To get the +``ETag``, use the `get-distribution `_ or +`get-distribution-config `_ command. - { - "Comment": "", - "CacheBehaviors": { - "Quantity": 0 - }, - "Logging": { - "Bucket": "", - "Prefix": "", - "Enabled": false, - "IncludeCookies": false - }, - "Origins": { - "Items": [ - { - "OriginPath": "", - "S3OriginConfig": { - "OriginAccessIdentity": "" - }, - "Id": "my-origin", - "DomainName": "my-bucket.s3.amazonaws.com" - } - ], - "Quantity": 1 - }, - "DefaultRootObject": "", - "PriceClass": "PriceClass_All", - "Enabled": false, - "DefaultCacheBehavior": { - "TrustedSigners": { - "Enabled": false, +After you use the following example to disable a distribution, you can use the +`delete-distribution `_ command to delete it. + +:: + + aws cloudfront update-distribution \ + --id EMLARXS9EXAMPLE \ + --if-match E2QWRUHEXAMPLE \ + --distribution-config file://dist-config-disable.json + +The file ``dist-config-disable.json`` is a JSON document in the current folder +that contains the following. Note that the ``Enabled`` field is set to +``false``:: + + { + "CallerReference": "cli-1574382155-496510", + "Aliases": { "Quantity": 0 }, - "TargetOriginId": "my-origin", - "ViewerProtocolPolicy": "allow-all", - "ForwardedValues": { - "Headers": { - "Quantity": 0 + "DefaultRootObject": "index.html", + "Origins": { + "Quantity": 1, + "Items": [ + { + "Id": "awsexamplebucket.s3.amazonaws.com-1574382155-273939", + "DomainName": "awsexamplebucket.s3.amazonaws.com", + "OriginPath": "", + "CustomHeaders": { + "Quantity": 0 + }, + "S3OriginConfig": { + "OriginAccessIdentity": "" + } + } + ] + }, + "OriginGroups": { + "Quantity": 0 + }, + "DefaultCacheBehavior": { + "TargetOriginId": "awsexamplebucket.s3.amazonaws.com-1574382155-273939", + "ForwardedValues": { + "QueryString": false, + "Cookies": { + "Forward": "none" + }, + "Headers": { + "Quantity": 0 + }, + "QueryStringCacheKeys": { + "Quantity": 0 + } }, - "Cookies": { - "Forward": "none" + "TrustedSigners": { + "Enabled": false, + "Quantity": 0 }, - "QueryString": true - }, - "MaxTTL": 31536000, - "SmoothStreaming": false, - "DefaultTTL": 86400, - "AllowedMethods": { - "Items": [ - "HEAD", - "GET" - ], - "CachedMethods": { + "ViewerProtocolPolicy": "allow-all", + "MinTTL": 0, + "AllowedMethods": { + "Quantity": 2, "Items": [ "HEAD", "GET" ], - "Quantity": 2 + "CachedMethods": { + "Quantity": 2, + "Items": [ + "HEAD", + "GET" + ] + } + }, + "SmoothStreaming": false, + "DefaultTTL": 86400, + "MaxTTL": 31536000, + "Compress": false, + "LambdaFunctionAssociations": { + "Quantity": 0 }, - "Quantity": 2 + "FieldLevelEncryptionId": "" }, - "MinTTL": 3600 - }, - "CallerReference": "my-distribution-2015-09-01", - "ViewerCertificate": { - "CloudFrontDefaultCertificate": true, - "MinimumProtocolVersion": "SSLv3" - }, - "CustomErrorResponses": { - "Quantity": 0 - }, - "Restrictions": { - "GeoRestriction": { - "RestrictionType": "none", + "CacheBehaviors": { "Quantity": 0 - } - }, - "Aliases": { - "Quantity": 0 + }, + "CustomErrorResponses": { + "Quantity": 0 + }, + "Comment": "", + "Logging": { + "Enabled": false, + "IncludeCookies": false, + "Bucket": "", + "Prefix": "" + }, + "PriceClass": "PriceClass_All", + "Enabled": false, + "ViewerCertificate": { + "CloudFrontDefaultCertificate": true, + "MinimumProtocolVersion": "TLSv1", + "CertificateSource": "cloudfront" + }, + "Restrictions": { + "GeoRestriction": { + "RestrictionType": "none", + "Quantity": 0 + } + }, + "WebACLId": "", + "HttpVersion": "http2", + "IsIPV6Enabled": true } - } -After disabling a CloudFront distribution you can delete it with ``delete-distribution``. +Output:: -The output includes the updated distribution config. Note that the ``ETag`` value has also changed:: - - { - "Distribution": { - "Status": "InProgress", - "DomainName": "d2wkuj2w9l34gt.cloudfront.net", - "InProgressInvalidationBatches": 0, - "DistributionConfig": { - "Comment": "", - "CacheBehaviors": { - "Quantity": 0 - }, - "Logging": { - "Bucket": "", - "Prefix": "", - "Enabled": false, - "IncludeCookies": false - }, - "Origins": { - "Items": [ - { - "OriginPath": "", - "S3OriginConfig": { - "OriginAccessIdentity": "" - }, - "Id": "my-origin", - "DomainName": "my-bucket.s3.amazonaws.com" - } - ], - "Quantity": 1 - }, - "DefaultRootObject": "", - "PriceClass": "PriceClass_All", - "Enabled": false, - "DefaultCacheBehavior": { - "TrustedSigners": { - "Enabled": false, - "Quantity": 0 - }, - "TargetOriginId": "my-origin", - "ViewerProtocolPolicy": "allow-all", - "ForwardedValues": { - "Headers": { - "Quantity": 0 - }, - "Cookies": { - "Forward": "none" - }, - "QueryString": true - }, - "MaxTTL": 31536000, - "SmoothStreaming": false, - "DefaultTTL": 86400, - "AllowedMethods": { - "Items": [ - "HEAD", - "GET" - ], - "CachedMethods": { - "Items": [ - "HEAD", - "GET" - ], - "Quantity": 2 - }, - "Quantity": 2 - }, - "MinTTL": 3600 - }, - "CallerReference": "my-distribution-2015-09-01", - "ViewerCertificate": { - "CloudFrontDefaultCertificate": true, - "MinimumProtocolVersion": "SSLv3" - }, - "CustomErrorResponses": { - "Quantity": 0 - }, - "Restrictions": { - "GeoRestriction": { - "RestrictionType": "none", - "Quantity": 0 - } - }, - "Aliases": { - "Quantity": 0 - } - }, - "ActiveTrustedSigners": { - "Enabled": false, - "Quantity": 0 - }, - "LastModifiedTime": "2015-09-01T17:54:11.453Z", - "Id": "S11A16G5KZMEQD" - }, - "ETag": "8UBQECEJX24ST" - } + { + "ETag": "E9LHASXEXAMPLE", + "Distribution": { + "Id": "EMLARXS9EXAMPLE", + "ARN": "arn:aws:cloudfront::123456789012:distribution/EMLARXS9EXAMPLE", + "Status": "InProgress", + "LastModifiedTime": "2019-12-06T18:32:35.553Z", + "InProgressInvalidationBatches": 0, + "DomainName": "d111111abcdef8.cloudfront.net", + "ActiveTrustedSigners": { + "Enabled": false, + "Quantity": 0 + }, + "DistributionConfig": { + "CallerReference": "cli-1574382155-496510", + "Aliases": { + "Quantity": 0 + }, + "DefaultRootObject": "index.html", + "Origins": { + "Quantity": 1, + "Items": [ + { + "Id": "awsexamplebucket.s3.amazonaws.com-1574382155-273939", + "DomainName": "awsexamplebucket.s3.amazonaws.com", + "OriginPath": "", + "CustomHeaders": { + "Quantity": 0 + }, + "S3OriginConfig": { + "OriginAccessIdentity": "" + } + } + ] + }, + "OriginGroups": { + "Quantity": 0 + }, + "DefaultCacheBehavior": { + "TargetOriginId": "awsexamplebucket.s3.amazonaws.com-1574382155-273939", + "ForwardedValues": { + "QueryString": false, + "Cookies": { + "Forward": "none" + }, + "Headers": { + "Quantity": 0 + }, + "QueryStringCacheKeys": { + "Quantity": 0 + } + }, + "TrustedSigners": { + "Enabled": false, + "Quantity": 0 + }, + "ViewerProtocolPolicy": "allow-all", + "MinTTL": 0, + "AllowedMethods": { + "Quantity": 2, + "Items": [ + "HEAD", + "GET" + ], + "CachedMethods": { + "Quantity": 2, + "Items": [ + "HEAD", + "GET" + ] + } + }, + "SmoothStreaming": false, + "DefaultTTL": 86400, + "MaxTTL": 31536000, + "Compress": false, + "LambdaFunctionAssociations": { + "Quantity": 0 + }, + "FieldLevelEncryptionId": "" + }, + "CacheBehaviors": { + "Quantity": 0 + }, + "CustomErrorResponses": { + "Quantity": 0 + }, + "Comment": "", + "Logging": { + "Enabled": false, + "IncludeCookies": false, + "Bucket": "", + "Prefix": "" + }, + "PriceClass": "PriceClass_All", + "Enabled": false, + "ViewerCertificate": { + "CloudFrontDefaultCertificate": true, + "MinimumProtocolVersion": "TLSv1", + "CertificateSource": "cloudfront" + }, + "Restrictions": { + "GeoRestriction": { + "RestrictionType": "none", + "Quantity": 0 + } + }, + "WebACLId": "", + "HttpVersion": "http2", + "IsIPV6Enabled": true + } + } + } diff -Nru awscli-1.16.301/awscli/examples/cloudfront/update-field-level-encryption-config.rst awscli-1.17.14/awscli/examples/cloudfront/update-field-level-encryption-config.rst --- awscli-1.16.301/awscli/examples/cloudfront/update-field-level-encryption-config.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/update-field-level-encryption-config.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,86 @@ +**To update a CloudFront field-level encryption configuration** + +The following example updates the ``Comment`` field of the field-level +encryption configuration with the ID ``C3KM2WVD605UAY`` by providing the +parameters in a JSON file. + +To update a field-level encryption configuration, you must have the +configuration's ID and ``ETag``. The ID is returned in the output of the +`create-field-level-encryption-config +`_ and +`list-field-level-encryption-configs +`_ commands. +To get the ``ETag``, use the +`get-field-level-encryption +`_ or +`get-field-level-encryption-config +`_ command. +Use the ``--if-match`` option to provide the configuration's ``ETag``. + +:: + + aws cloudfront update-field-level-encryption-config \ + --id C3KM2WVD605UAY \ + --if-match E2P4Z4VU7TY5SG \ + --field-level-encryption-config file://fle-config.json + +The file ``fle-config.json`` is a JSON document in the current directory that +contains the following:: + + { + "CallerReference": "cli-example", + "Comment": "Updated example FLE configuration", + "QueryArgProfileConfig": { + "ForwardWhenQueryArgProfileIsUnknown": true, + "QueryArgProfiles": { + "Quantity": 0 + } + }, + "ContentTypeProfileConfig": { + "ForwardWhenContentTypeIsUnknown": true, + "ContentTypeProfiles": { + "Quantity": 1, + "Items": [ + { + "Format": "URLEncoded", + "ProfileId": "P280MFCLSYOCVU", + "ContentType": "application/x-www-form-urlencoded" + } + ] + } + } + } + +Output:: + + { + "ETag": "E26M4BIAV81ZF6", + "FieldLevelEncryption": { + "Id": "C3KM2WVD605UAY", + "LastModifiedTime": "2019-12-10T22:26:26.170Z", + "FieldLevelEncryptionConfig": { + "CallerReference": "cli-example", + "Comment": "Updated example FLE configuration", + "QueryArgProfileConfig": { + "ForwardWhenQueryArgProfileIsUnknown": true, + "QueryArgProfiles": { + "Quantity": 0, + "Items": [] + } + }, + "ContentTypeProfileConfig": { + "ForwardWhenContentTypeIsUnknown": true, + "ContentTypeProfiles": { + "Quantity": 1, + "Items": [ + { + "Format": "URLEncoded", + "ProfileId": "P280MFCLSYOCVU", + "ContentType": "application/x-www-form-urlencoded" + } + ] + } + } + } + } + } diff -Nru awscli-1.16.301/awscli/examples/cloudfront/update-field-level-encryption-profile.rst awscli-1.17.14/awscli/examples/cloudfront/update-field-level-encryption-profile.rst --- awscli-1.16.301/awscli/examples/cloudfront/update-field-level-encryption-profile.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudfront/update-field-level-encryption-profile.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,81 @@ +**To update a CloudFront field-level encryption profile** + +The following example updates the field-level encryption profile with the ID +``PPK0UOSIF5WSV``. This example updates the profile's ``Name`` and ``Comment``, +and adds a second ``FieldPatterns`` item, by providing the parameters in a JSON +file. + +To update a field-level encryption profile, you must have the profile's ID and ``ETag``. The ID is returned in the output of the +`create-field-level-encryption-profile +`_ and +`list-field-level-encryption-profiles +`_ commands. +To get the ``ETag``, use the +`get-field-level-encryption-profile +`_ or +`get-field-level-encryption-profile-config +`_ command. +Use the ``--if-match`` option to provide the profile's ``ETag``. + +:: + + aws cloudfront update-field-level-encryption-profile \ + --id PPK0UOSIF5WSV \ + --if-match E1QQG65FS2L2GC \ + --field-level-encryption-profile-config file://fle-profile-config.json + +The file ``fle-profile-config.json`` is a JSON document in the current +directory that contains the following:: + + { + "Name": "ExampleFLEProfileUpdated", + "CallerReference": "cli-example", + "Comment": "Updated FLE profile for AWS CLI example", + "EncryptionEntities": { + "Quantity": 1, + "Items": [ + { + "PublicKeyId": "K2K8NC4HVFE3M0", + "ProviderId": "ExampleFLEProvider", + "FieldPatterns": { + "Quantity": 2, + "Items": [ + "ExampleSensitiveField", + "SecondExampleSensitiveField" + ] + } + } + ] + } + } + +Output:: + + { + "ETag": "EJETYFJ9CL66D", + "FieldLevelEncryptionProfile": { + "Id": "PPK0UOSIF5WSV", + "LastModifiedTime": "2019-12-10T19:05:58.296Z", + "FieldLevelEncryptionProfileConfig": { + "Name": "ExampleFLEProfileUpdated", + "CallerReference": "cli-example", + "Comment": "Updated FLE profile for AWS CLI example", + "EncryptionEntities": { + "Quantity": 1, + "Items": [ + { + "PublicKeyId": "K2K8NC4HVFE3M0", + "ProviderId": "ExampleFLEProvider", + "FieldPatterns": { + "Quantity": 2, + "Items": [ + "ExampleSensitiveField", + "SecondExampleSensitiveField" + ] + } + } + ] + } + } + } + } diff -Nru awscli-1.16.301/awscli/examples/cloudwatch/list-metrics.rst awscli-1.17.14/awscli/examples/cloudwatch/list-metrics.rst --- awscli-1.16.301/awscli/examples/cloudwatch/list-metrics.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cloudwatch/list-metrics.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,93 +1,94 @@ -**To list the metrics for Amazon EC2** +**To list the metrics for Amazon SNS** -The following example uses the ``list-metrics`` command to list the metrics for Amazon SNS.:: +The following ``list-metrics`` example displays the metrics for Amazon SNS. :: - aws cloudwatch list-metrics --namespace "AWS/SNS" + aws cloudwatch list-metrics \ + --namespace "AWS/SNS" Output:: - { - "Metrics": [ - { - "Namespace": "AWS/SNS", - "Dimensions": [ - { - "Name": "TopicName", - "Value": "NotifyMe" - } - ], - "MetricName": "PublishSize" - }, - { - "Namespace": "AWS/SNS", - "Dimensions": [ - { - "Name": "TopicName", - "Value": "CFO" - } - ], - "MetricName": "PublishSize" - }, - { - "Namespace": "AWS/SNS", - "Dimensions": [ - { - "Name": "TopicName", - "Value": "NotifyMe" - } - ], - "MetricName": "NumberOfNotificationsFailed" - }, - { - "Namespace": "AWS/SNS", - "Dimensions": [ - { - "Name": "TopicName", - "Value": "NotifyMe" - } - ], - "MetricName": "NumberOfNotificationsDelivered" - }, - { - "Namespace": "AWS/SNS", - "Dimensions": [ - { - "Name": "TopicName", - "Value": "NotifyMe" - } - ], - "MetricName": "NumberOfMessagesPublished" - }, - { - "Namespace": "AWS/SNS", - "Dimensions": [ - { - "Name": "TopicName", - "Value": "CFO" - } - ], - "MetricName": "NumberOfMessagesPublished" - }, - { - "Namespace": "AWS/SNS", - "Dimensions": [ - { - "Name": "TopicName", - "Value": "CFO" - } - ], - "MetricName": "NumberOfNotificationsDelivered" - }, - { - "Namespace": "AWS/SNS", - "Dimensions": [ - { - "Name": "TopicName", - "Value": "CFO" - } - ], - "MetricName": "NumberOfNotificationsFailed" - } - ] - } + { + "Metrics": [ + { + "Namespace": "AWS/SNS", + "Dimensions": [ + { + "Name": "TopicName", + "Value": "NotifyMe" + } + ], + "MetricName": "PublishSize" + }, + { + "Namespace": "AWS/SNS", + "Dimensions": [ + { + "Name": "TopicName", + "Value": "CFO" + } + ], + "MetricName": "PublishSize" + }, + { + "Namespace": "AWS/SNS", + "Dimensions": [ + { + "Name": "TopicName", + "Value": "NotifyMe" + } + ], + "MetricName": "NumberOfNotificationsFailed" + }, + { + "Namespace": "AWS/SNS", + "Dimensions": [ + { + "Name": "TopicName", + "Value": "NotifyMe" + } + ], + "MetricName": "NumberOfNotificationsDelivered" + }, + { + "Namespace": "AWS/SNS", + "Dimensions": [ + { + "Name": "TopicName", + "Value": "NotifyMe" + } + ], + "MetricName": "NumberOfMessagesPublished" + }, + { + "Namespace": "AWS/SNS", + "Dimensions": [ + { + "Name": "TopicName", + "Value": "CFO" + } + ], + "MetricName": "NumberOfMessagesPublished" + }, + { + "Namespace": "AWS/SNS", + "Dimensions": [ + { + "Name": "TopicName", + "Value": "CFO" + } + ], + "MetricName": "NumberOfNotificationsDelivered" + }, + { + "Namespace": "AWS/SNS", + "Dimensions": [ + { + "Name": "TopicName", + "Value": "CFO" + } + ], + "MetricName": "NumberOfNotificationsFailed" + } + ] + } diff -Nru awscli-1.16.301/awscli/examples/codecommit/associate-approval-rule-template-with-repository.rst awscli-1.17.14/awscli/examples/codecommit/associate-approval-rule-template-with-repository.rst --- awscli-1.16.301/awscli/examples/codecommit/associate-approval-rule-template-with-repository.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/codecommit/associate-approval-rule-template-with-repository.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,11 @@ +**To associate an approval rule template with a repository** + +The following ``associate-approval-rule-template-with-repository`` example associates the specified approval rule template with a repository named ``MyDemoRepo``. :: + + aws codecommit associate-approval-rule-template-with-repository \ + --repository-name MyDemoRepo \ + --approval-rule-template-name 2-approver-rule-for-master + +This command produces no output. + +For more information, see `Associate an Approval Rule Template with a Repository `__ in the *AWS CodeCommit User Guide*. diff -Nru awscli-1.16.301/awscli/examples/codecommit/batch-associate-approval-rule-template-with-repositories.rst awscli-1.17.14/awscli/examples/codecommit/batch-associate-approval-rule-template-with-repositories.rst --- awscli-1.16.301/awscli/examples/codecommit/batch-associate-approval-rule-template-with-repositories.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/codecommit/batch-associate-approval-rule-template-with-repositories.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,21 @@ +**To associate an approval rule template with multiple repositories in a single operation** + +The following ``batch-associate-approval-rule-template-with-repositories`` example associates the specified approval rule template with repositories named ``MyDemoRepo`` and ``MyOtherDemoRepo``. + +Note: Approval rule templates are specific to the AWS Region where they are created. They can only be associated with repositories in that AWS Region. :: + + aws codecommit batch-associate-approval-rule-template-with-repositories \ + --repository-names MyDemoRepo, MyOtherDemoRepo \ + --approval-rule-template-name 2-approver-rule-for-master + +Output:: + + { + "associatedRepositoryNames": [ + "MyDemoRepo", + "MyOtherDemoRepo" + ], + "errors": [] + } + +For more information, see `Associate an Approval Rule Template with a Repository `__ in the *AWS CodeCommit User Guide*. diff -Nru awscli-1.16.301/awscli/examples/codecommit/batch-disassociate-approval-rule-template-from-repositories.rst awscli-1.17.14/awscli/examples/codecommit/batch-disassociate-approval-rule-template-from-repositories.rst --- awscli-1.16.301/awscli/examples/codecommit/batch-disassociate-approval-rule-template-from-repositories.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/codecommit/batch-disassociate-approval-rule-template-from-repositories.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,19 @@ +**To disassociate an approval rule template from multiple repositories in a single operation** + +The following ``batch-disassociate-approval-rule-template-from-repositories`` example disassociates the specified approval rule template from repositories named ``MyDemoRepo`` and ``MyOtherDemoRepo``. :: + + aws codecommit batch-disassociate-approval-rule-template-from-repositories \ + --repository-names MyDemoRepo, MyOtherDemoRepo \ + --approval-rule-template-name 1-approval-rule-for-all pull requests + +Output:: + + { + "disassociatedRepositoryNames": [ + "MyDemoRepo", + "MyOtherDemoRepo" + ], + "errors": [] + } + +For more information, see `Disassociate an Approval Rule Template `__ in the *AWS CodeCommit User Guide*. diff -Nru awscli-1.16.301/awscli/examples/codecommit/create-approval-rule-template.rst awscli-1.17.14/awscli/examples/codecommit/create-approval-rule-template.rst --- awscli-1.16.301/awscli/examples/codecommit/create-approval-rule-template.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/codecommit/create-approval-rule-template.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,25 @@ +**To create an approval rule template** + +The following ``create-approval-rule-template`` example creates an approval rule template named ``2-approver-rule-for-master ``. The template requires two users who assume the role of ``CodeCommitReview`` to approve any pull request before it can be merged to the ``master`` branch. :: + + aws codecommit create-approval-rule-template \ + --approval-rule-template-name 2-approver-rule-for-master \ + --approval-rule-template-description "Requires two developers from the team to approve the pull request if the destination branch is master" \ + --approval-rule-template-content "{\"Version\": \"2018-11-08\",\"DestinationReferences\": [\"refs/heads/master\"],\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}" + +Output:: + + { + "approvalRuleTemplate": { + "approvalRuleTemplateName": "2-approver-rule-for-master", + "creationDate": 1571356106.936, + "approvalRuleTemplateId": "dd8b17fe-EXAMPLE", + "approvalRuleTemplateContent": "{\"Version\": \"2018-11-08\",\"DestinationReferences\": [\"refs/heads/master\"],\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}", + "lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major", + "approvalRuleTemplateDescription": "Requires two developers from the team to approve the pull request if the destination branch is master", + "lastModifiedDate": 1571356106.936, + "ruleContentSha256": "4711b576EXAMPLE" + } + } + +For more information, see `Create an Approval Rule Template `__ in the *AWS CodeCommit User Guide*. diff -Nru awscli-1.16.301/awscli/examples/codecommit/create-pull-request-approval-rule.rst awscli-1.17.14/awscli/examples/codecommit/create-pull-request-approval-rule.rst --- awscli-1.16.301/awscli/examples/codecommit/create-pull-request-approval-rule.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/codecommit/create-pull-request-approval-rule.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,23 @@ +**To create an approval rule for a pull request** + +The following ``create-pull-request-approval-rule`` example creates an approval rule named ``Require two approved approvers`` for the specified pull request. The rule specifies that two approvals are required from an approval pool. The pool includes all users who access CodeCommit by assuming the role of ``CodeCommitReview`` in the ``123456789012`` AWS account. It also includes either an IAM user or federated user named ``Nikhil_Jayashankar`` from the same AWS account. :: + + aws codecommit create-pull-request-approval-rule \ + --approval-rule-name "Require two approved approvers" \ + --approval-rule-content "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"CodeCommitApprovers:123456789012:Nikhil_Jayashankar\", \"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}" + +Output:: + + { + "approvalRule": { + "approvalRuleName": "Require two approved approvers", + "lastModifiedDate": 1570752871.932, + "ruleContentSha256": "7c44e6ebEXAMPLE", + "creationDate": 1570752871.932, + "approvalRuleId": "aac33506-EXAMPLE", + "approvalRuleContent": "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"CodeCommitApprovers:123456789012:Nikhil_Jayashankar\", \"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}", + "lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major" + } + } + +For more information, see `Create an Approval Rule `__ in the *AWS CodeCommit User Guide*. diff -Nru awscli-1.16.301/awscli/examples/codecommit/delete-approval-rule-template.rst awscli-1.17.14/awscli/examples/codecommit/delete-approval-rule-template.rst --- awscli-1.16.301/awscli/examples/codecommit/delete-approval-rule-template.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/codecommit/delete-approval-rule-template.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,14 @@ +**To delete an approval rule template** + +The following ``delete-approval-rule-template`` example deletes the specified approval rule template. :: + + aws codecommit delete-approval-rule-template \ + --approval-rule-template-name 1-approver-for-all-pull-requests + +Output:: + + { + "approvalRuleTemplateId": "41de97b7-EXAMPLE" + } + +For more information, see `Delete an Approval Rule Template `__ in the *AWS CodeCommit User Guide*. diff -Nru awscli-1.16.301/awscli/examples/codecommit/delete-pull-request-approval-rule.rst awscli-1.17.14/awscli/examples/codecommit/delete-pull-request-approval-rule.rst --- awscli-1.16.301/awscli/examples/codecommit/delete-pull-request-approval-rule.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/codecommit/delete-pull-request-approval-rule.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,15 @@ +**To delete an approval rule for a pull request** + +The following ``delete-pull-request-approval-rule`` example deletes the approval rule named ``My Approval Rule`` for the specified pull request. :: + + aws codecommit delete-pull-request-approval-rule \ + --approval-rule-name "My Approval Rule" \ + --pull-request-id 15 + +Output:: + + { + "approvalRuleId": "077d8e8a8-EXAMPLE" + } + +For more information, see `Edit or Delete an Approval Rule `__ in the *AWS CodeCommit User Guide*. diff -Nru awscli-1.16.301/awscli/examples/codecommit/disassociate-approval-rule-template-from-repository.rst awscli-1.17.14/awscli/examples/codecommit/disassociate-approval-rule-template-from-repository.rst --- awscli-1.16.301/awscli/examples/codecommit/disassociate-approval-rule-template-from-repository.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/codecommit/disassociate-approval-rule-template-from-repository.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,11 @@ +**To disassociate an approval rule template from a repository** + +The following ``disassociate-approval-rule-template-from-repository`` example disassociates the specified approval rule template from a repository named ``MyDemoRepo``. :: + + aws codecommit disassociate-approval-rule-template-from-repository \ + --repository-name MyDemoRepo \ + --approval-rule-template-name 1-approver-rule-for-all-pull-requests + +This command produces no output. + +For more information, see `Disassociate an Approval Rule Template `__ in the *AWS CodeCommit User Guide*. diff -Nru awscli-1.16.301/awscli/examples/codecommit/evaluate-pull-request-approval-rules.rst awscli-1.17.14/awscli/examples/codecommit/evaluate-pull-request-approval-rules.rst --- awscli-1.16.301/awscli/examples/codecommit/evaluate-pull-request-approval-rules.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/codecommit/evaluate-pull-request-approval-rules.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,24 @@ +**To evaluate whether a pull request has all of its approval rules satisfied** + +The following ``evaluate-pull-request-approval-rules`` example evaluates the state of approval rules on the specified pull request. In this example, an approval rule has not been satisfied for the pull request, so the output of the command shows an ``approved`` value of ``false``. :: + + aws codecommit evaluate-pull-request-approval-rules \ + --pull-request-id 27 \ + --revision-id 9f29d167EXAMPLE + +Output:: + + { + "evaluation": { + "approved": false, + "approvalRulesNotSatisfied": [ + "Require two approved approvers" + ], + "overridden": false, + "approvalRulesSatisfied": [] + } + } + + + +For more information, see `Merge a Pull Request `__ in the *AWS CodeCommit User Guide*. diff -Nru awscli-1.16.301/awscli/examples/codecommit/get-approval-rule-template.rst awscli-1.17.14/awscli/examples/codecommit/get-approval-rule-template.rst --- awscli-1.16.301/awscli/examples/codecommit/get-approval-rule-template.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/codecommit/get-approval-rule-template.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,24 @@ +**To get the content of an approval rule template** + +The following ``get-approval-rule-template`` example gets the content of an approval rule template named ``1-approver-rule-for-all-pull-requests``. :: + + aws codecommit get-approval-rule-template \ + --approval-rule-template-name 1-approver-rule-for-all-pull-requests + +Output:: + + { + "approvalRuleTemplate": { + "approvalRuleTemplateContent": "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 1,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}", + "ruleContentSha256": "621181bbEXAMPLE", + "lastModifiedDate": 1571356106.936, + "creationDate": 1571356106.936, + "approvalRuleTemplateName": "1-approver-rule-for-all-pull-requests", + "lastModifiedUser": "arn:aws:iam::123456789012:user/Li_Juan", + "approvalRuleTemplateId": "a29abb15-EXAMPLE", + "approvalRuleTemplateDescription": "All pull requests must be approved by one developer on the team." + } + } + + +For more information, see `Manage Approval Rule Templates `__ in the *AWS CodeCommit User Guide*. diff -Nru awscli-1.16.301/awscli/examples/codecommit/get-pull-request-approval-states.rst awscli-1.17.14/awscli/examples/codecommit/get-pull-request-approval-states.rst --- awscli-1.16.301/awscli/examples/codecommit/get-pull-request-approval-states.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/codecommit/get-pull-request-approval-states.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,20 @@ +**To view approvals on a pull request** + +The following ``get-pull-request-approval-states`` example returns approvals for the specified pull request. :: + + aws codecommit get-pull-request-approval-states \ + --pull-request-id 8 \ + --revision-id 9f29d167EXAMPLE + +Output:: + + { + "approvals": [ + { + "userArn": "arn:aws:iam::123456789012:user/Mary_Major", + "approvalState": "APPROVE" + } + ] + } + +For more information, see `View Pull Requests `__ in the *AWS CodeCommit User Guide*. diff -Nru awscli-1.16.301/awscli/examples/codecommit/get-pull-request-override-state.rst awscli-1.17.14/awscli/examples/codecommit/get-pull-request-override-state.rst --- awscli-1.16.301/awscli/examples/codecommit/get-pull-request-override-state.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/codecommit/get-pull-request-override-state.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,16 @@ +**To get information about the override status of a pull request** + +The following ``get-pull-request-override-state`` example returns the override state for the specified pull request. In this example, the approval rules for the pull request were overridden by a user named Mary Major, so the output returns a value of ``true``.:: + + aws codecommit get-pull-request-override-state \ + --pull-request-id 34 \ + --revision-id 9f29d167EXAMPLE + +Output:: + + { + "overridden": true, + "overrider": "arn:aws:iam::123456789012:user/Mary_Major" + } + +For more information, see `Override Approval Rules on a Pull Request `__ in the *AWS CodeCommit User Guide*. diff -Nru awscli-1.16.301/awscli/examples/codecommit/list-approval-rule-templates.rst awscli-1.17.14/awscli/examples/codecommit/list-approval-rule-templates.rst --- awscli-1.16.301/awscli/examples/codecommit/list-approval-rule-templates.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/codecommit/list-approval-rule-templates.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,17 @@ +**To list all approval rule templates in an AWS Region** + +The following ``list-approval-rule-templates`` example lists all approval rule templates in the specified Region. If no AWS Region is specified as a parameter, the command returns approval rule templates for the region specified in the AWS CLI profile used to run the command. :: + + aws codecommit list-approval-rule-templates \ + --region us-east-2 + +Output:: + + { + "approvalRuleTemplateNames": [ + "2-approver-rule-for-master", + "1-approver-rule-for-all-pull-requests" + ] + } + +For more information, see `Manage Approval Rule Templates `__ in the *AWS CodeCommit User Guide*. diff -Nru awscli-1.16.301/awscli/examples/codecommit/list-associated-approval-rule-templates-for-repository.rst awscli-1.17.14/awscli/examples/codecommit/list-associated-approval-rule-templates-for-repository.rst --- awscli-1.16.301/awscli/examples/codecommit/list-associated-approval-rule-templates-for-repository.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/codecommit/list-associated-approval-rule-templates-for-repository.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,17 @@ +**To list all templates associated with a repository** + +The following ``list-associated-approval-rule-templates-for-repository`` example lists all approval rule templates associated with a repository named ``MyDemoRepo``. :: + + aws codecommit list-associated-approval-rule-templates-for-repository \ + --repository-name MyDemoRepo + +Output:: + + { + "approvalRuleTemplateNames": [ + "2-approver-rule-for-master", + "1-approver-rule-for-all-pull-requests" + ] + } + +For more information, see `Manage Approval Rule Templates `__ in the *AWS CodeCommit User Guide*. \ No newline at end of file diff -Nru awscli-1.16.301/awscli/examples/codecommit/list-repositories-for-approval-rule-template.rst awscli-1.17.14/awscli/examples/codecommit/list-repositories-for-approval-rule-template.rst --- awscli-1.16.301/awscli/examples/codecommit/list-repositories-for-approval-rule-template.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/codecommit/list-repositories-for-approval-rule-template.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,17 @@ +**To list all repositories associated with a template** + +The following ``list-repositories-for-approval-rule-template`` example lists all repositories associated with the specified approval rule template. :: + + aws codecommit list-repositories-for-approval-rule-template \ + --approval-rule-template-name 2-approver-rule-for-master + +Output:: + + { + "repositoryNames": [ + "MyDemoRepo", + "MyClonedRepo" + ] + } + +For more information, see `Manage Approval Rule Templates `__ in the *AWS CodeCommit User Guide*. diff -Nru awscli-1.16.301/awscli/examples/codecommit/override-pull-request-approval-rules.rst awscli-1.17.14/awscli/examples/codecommit/override-pull-request-approval-rules.rst --- awscli-1.16.301/awscli/examples/codecommit/override-pull-request-approval-rules.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/codecommit/override-pull-request-approval-rules.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,12 @@ +**To override approval rule requirements on a pull request** + +The following ``override-pull-request-approval-rules`` example overrides approval rules on the specified pull request. To revoke an override instead, set the ``--override-status`` parameter value to ``REVOKE``. :: + + aws codecommit override-pull-request-approval-rules \ + --pull-request-id 34 \ + --revision-id 927df8d8EXAMPLE \ + --override-status OVERRIDE + +This command produces no output. + +For more information, see `Override Approval Rules on a Pull Request `__ in the *AWS CodeCommit User Guide*. diff -Nru awscli-1.16.301/awscli/examples/codecommit/update-approval-rule-template-content.rst awscli-1.17.14/awscli/examples/codecommit/update-approval-rule-template-content.rst --- awscli-1.16.301/awscli/examples/codecommit/update-approval-rule-template-content.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/codecommit/update-approval-rule-template-content.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,24 @@ +**To update the content of an approval rule template** + +The following ``update-approval-rule-template-content`` example changes the content of the specified approval rule template to redefine the approval pool to users who assume the role of ``CodeCommitReview``. :: + + aws codecommit update-approval-rule-template-content \ + --approval-rule-template-name 1-approver-rule \ + --new-rule-content "{\"Version\": \"2018-11-08\",\"DestinationReferences\": [\"refs/heads/master\"],\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}" + +Output:: + + { + "approvalRuleTemplate": { + "creationDate": 1571352720.773, + "approvalRuleTemplateDescription": "Requires 1 approval for all pull requests from the CodeCommitReview pool", + "lastModifiedDate": 1571358728.41, + "approvalRuleTemplateId": "41de97b7-EXAMPLE", + "approvalRuleTemplateContent": "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 1,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}", + "approvalRuleTemplateName": "1-approver-rule-for-all-pull-requests", + "ruleContentSha256": "2f6c21a5EXAMPLE", + "lastModifiedUser": "arn:aws:iam::123456789012:user/Li_Juan" + } + } + +For more information, see `Manage Approval Rule Templates `__ in the *AWS CodeCommit User Guide*. diff -Nru awscli-1.16.301/awscli/examples/codecommit/update-approval-rule-template-description.rst awscli-1.17.14/awscli/examples/codecommit/update-approval-rule-template-description.rst --- awscli-1.16.301/awscli/examples/codecommit/update-approval-rule-template-description.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/codecommit/update-approval-rule-template-description.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,24 @@ +**To update the description of an approval rule template** + +The following ``update-approval-rule-template-description`` example changes the description of the specified approval rule template to ``Requires 1 approval for all pull requests from the CodeCommitReview pool``.:: + + aws codecommit update-approval-rule-template-description \ + --approval-rule-template-name 1-approver-rule-for-all-pull-requests \ + --approval-rule-template-description "Requires 1 approval for all pull requests from the CodeCommitReview pool" + +Output:: + + { + "approvalRuleTemplate": { + "creationDate": 1571352720.773, + "approvalRuleTemplateDescription": "Requires 1 approval for all pull requests from the CodeCommitReview pool", + "lastModifiedDate": 1571358728.41, + "approvalRuleTemplateId": "41de97b7-EXAMPLE", + "approvalRuleTemplateContent": "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 1,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}", + "approvalRuleTemplateName": "1-approver-rule-for-all-pull-requests", + "ruleContentSha256": "2f6c21a5EXAMPLE", + "lastModifiedUser": "arn:aws:iam::123456789012:user/Li_Juan" + } + } + +For more information, see `Manage Approval Rule Templates `__ in the *AWS CodeCommit User Guide*. diff -Nru awscli-1.16.301/awscli/examples/codecommit/update-approval-rule-template-name.rst awscli-1.17.14/awscli/examples/codecommit/update-approval-rule-template-name.rst --- awscli-1.16.301/awscli/examples/codecommit/update-approval-rule-template-name.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/codecommit/update-approval-rule-template-name.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,24 @@ +**To update the name of an approval rule template** + +The following ``update-approval-rule-template-name`` example changes the name of an approval rule template from ``1-approver-rule`` to `1-approver-rule-for-all-pull-requests``. :: + + aws codecommit update-approval-rule-template-name \ + --old-approval-rule-template-name 1-approver-rule \ + --new-approval-rule-template-name 1-approver-rule-for-all-pull-requests + +Output:: + + { + "approvalRuleTemplate": { + "approvalRuleTemplateName": "1-approver-rule-for-all-pull-requests", + "lastModifiedDate": 1571358241.619, + "approvalRuleTemplateId": "41de97b7-EXAMPLE", + "approvalRuleTemplateContent": "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 1,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}", + "creationDate": 1571352720.773, + "lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major", + "approvalRuleTemplateDescription": "All pull requests must be approved by one developer on the team.", + "ruleContentSha256": "2f6c21a5cEXAMPLE" + } + } + +For more information, see `Manage Approval Rule Templates `__ in the *AWS CodeCommit User Guide*. diff -Nru awscli-1.16.301/awscli/examples/codecommit/update-pull-request-approval-rule-content.rst awscli-1.17.14/awscli/examples/codecommit/update-pull-request-approval-rule-content.rst --- awscli-1.16.301/awscli/examples/codecommit/update-pull-request-approval-rule-content.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/codecommit/update-pull-request-approval-rule-content.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,25 @@ +**To edit an approval rule for a pull request** + +The following ``update-pull-request-approval-rule-content`` example updates she specified approval rule to require one user approval from an approval pool that includes any IAM user in the ``123456789012`` AWS account. :: + + aws codecommit update-pull-request-approval-rule-content \ + --pull-request-id 27 \ + --approval-rule-name "Require two approved approvers" \ + --approval-rule-content "{Version: 2018-11-08, Statements: [{Type: \"Approvers\", NumberOfApprovalsNeeded: 1, ApprovalPoolMembers:[\"CodeCommitApprovers:123456789012:user/*\"]}]}}" + +Output:: + + { + "approvalRule": { + "approvalRuleContent": "{Version: 2018-11-08, Statements: [{Type: \"Approvers\", NumberOfApprovalsNeeded: 1, ApprovalPoolMembers:[\"CodeCommitApprovers:123456789012:user/*\"]}]}}", + "approvalRuleId": "aac33506-EXAMPLE", + "originApprovalRuleTemplate": {}, + "creationDate": 1570752871.932, + "lastModifiedDate": 1570754058.333, + "approvalRuleName": Require two approved approvers", + "lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major", + "ruleContentSha256": "cd93921cEXAMPLE", + } + } + +For more information, see `Edit or Delete an Approval Rule `__ in the *AWS CodeCommit User Guide*. \ No newline at end of file diff -Nru awscli-1.16.301/awscli/examples/codecommit/update-pull-request-approval-state.rst awscli-1.17.14/awscli/examples/codecommit/update-pull-request-approval-state.rst --- awscli-1.16.301/awscli/examples/codecommit/update-pull-request-approval-state.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/codecommit/update-pull-request-approval-state.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,12 @@ +**To approve or revoke approval for a pull request** + +The following ``update-pull-request-approval-state`` example approves a pull request with the ID of ``27`` and a revision ID of ``9f29d167EXAMPLE``. If you wanted to revoke approval instead, then set the ``--approval-state`` parameter value to ``REVOKE``. :: + + aws codecommit update-pull-request-approval-state \ + --pull-request-id 27 \ + --revision-id 9f29d167EXAMPLE \ + --approval-state "APPROVE" + +This command produces no output. + +For more information, see `Review a Pull Request `__ in the *AWS CodeCommit User Guide*. diff -Nru awscli-1.16.301/awscli/examples/cognito-idp/admin-create-user.rst awscli-1.17.14/awscli/examples/cognito-idp/admin-create-user.rst --- awscli-1.16.301/awscli/examples/cognito-idp/admin-create-user.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cognito-idp/admin-create-user.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,35 +1,35 @@ **To create a user** -This example creates username diego@example.com. An email address and phone number -are specified. +The following ``admin-create-user`` example creates a user with the specified settings email address and phone number. :: -Command:: - - aws cognito-idp admin-create-user --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --user-attributes=Name=email,Value=kermit2@somewhere.com,Name=phone_number,Value="+15555551212" --message-action SUPPRESS + aws cognito-idp admin-create-user \ + --user-pool-id us-west-2_aaaaaaaaa \ + --username diego@example.com \ + --user-attributes Name=email,Value=kermit2@somewhere.com Name=phone_number,Value="+15555551212" \ + --message-action SUPPRESS Output:: - { - "User": { - "Username": "7325c1de-b05b-4f84-b321-9adc6e61f4a2", - "Enabled": true, - "UserStatus": "FORCE_CHANGE_PASSWORD", - "UserCreateDate": 1548099495.428, - "UserLastModifiedDate": 1548099495.428, - "Attributes": [ - { - "Name": "sub", - "Value": "7325c1de-b05b-4f84-b321-9adc6e61f4a2" - }, - { - "Name": "phone_number", - "Value": "+15555551212" - }, - { - "Name": "email", - "Value": "diego@example.com" - } - ] + { + "User": { + "Username": "7325c1de-b05b-4f84-b321-9adc6e61f4a2", + "Enabled": true, + "UserStatus": "FORCE_CHANGE_PASSWORD", + "UserCreateDate": 1548099495.428, + "UserLastModifiedDate": 1548099495.428, + "Attributes": [ + { + "Name": "sub", + "Value": "7325c1de-b05b-4f84-b321-9adc6e61f4a2" + }, + { + "Name": "phone_number", + "Value": "+15555551212" + }, + { + "Name": "email", + "Value": "diego@example.com" + } + ] + } } - } - diff -Nru awscli-1.16.301/awscli/examples/cognito-idp/delete-user-pool-domain.rst awscli-1.17.14/awscli/examples/cognito-idp/delete-user-pool-domain.rst --- awscli-1.16.301/awscli/examples/cognito-idp/delete-user-pool-domain.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/cognito-idp/delete-user-pool-domain.rst 2020-02-10 19:14:32.000000000 +0000 @@ -2,6 +2,6 @@ The following ``delete-user-pool-domain`` example deletes a user pool domain named ``my-domain`` :: - aws cognito-idp delete-user-pool \ + aws cognito-idp delete-user-pool-domain \ --user-pool-id us-west-2_aaaaaaaaa \ --domain my-domain diff -Nru awscli-1.16.301/awscli/examples/connect/create-user.rst awscli-1.17.14/awscli/examples/connect/create-user.rst --- awscli-1.16.301/awscli/examples/connect/create-user.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/connect/create-user.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,21 @@ +**To create a user** + +The following ``create-user`` example adds a user with the specified attributes to the specified Amazon Connect instance. :: + + aws connect create-user \ + --username Mary \ + --password Pass@Word1 \ + --identity-info FirstName=Mary,LastName=Major \ + --phone-config PhoneType=DESK_PHONE,AutoAccept=true,AfterContactWorkTimeLimit=60,DeskPhoneNumber=+15555551212 \ + --security-profile-id 12345678-1111-2222-aaaa-a1b2c3d4f5g7 \ + --routing-profile-id 87654321-9999-3434-abcd-x1y2z3a1b2c3 \ + --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 + +Output:: + + { + "UserId": "87654321-2222-1234-1234-111234567891", + "UserArn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent/87654321-2222-1234-1234-111234567891" + } + +For more information, see `Add Users `__ in the *Amazon Connect Administrator Guide*. diff -Nru awscli-1.16.301/awscli/examples/connect/delete-user.rst awscli-1.17.14/awscli/examples/connect/delete-user.rst --- awscli-1.16.301/awscli/examples/connect/delete-user.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/connect/delete-user.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,11 @@ +**To delete a user** + +The following ``delete-user`` example deletes the specified user from the specified Amazon Connect instance. :: + + aws connect delete-user \ + --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ + --user-id 87654321-2222-1234-1234-111234567891 + +This command produces no output. + +For more information, see `Manage Users `__ in the *Amazon Connect Administrator Guide*. diff -Nru awscli-1.16.301/awscli/examples/connect/describe-user-hierarchy-group.rst awscli-1.17.14/awscli/examples/connect/describe-user-hierarchy-group.rst --- awscli-1.16.301/awscli/examples/connect/describe-user-hierarchy-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/connect/describe-user-hierarchy-group.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,29 @@ +**To display the details for a hierarchy group** + +The following ``describe-user-hierarchy-group`` example displays the details for the specified Amazon Connect hierarchy group. :: + + aws connect describe-user-hierarchy-group \ + --hierarchy-group-id 12345678-1111-2222-800e-aaabbb555gg \ + --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 + +Output:: + + { + "HierarchyGroup": { + "Id": "12345678-1111-2222-800e-a2b3c4d5f6g7", + "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent-group/12345678-1111-2222-800e-a2b3c4d5f6g7", + "Name": "Example Corporation", + "LevelId": "1", + "HierarchyPath": { + "LevelOne": { + "Id": "abcdefgh-3333-4444-8af3-201123456789", + "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent-group/abcdefgh-3333-4444-8af3-201123456789", + "Name": "Example Corporation" + } + } + } + } + +For more information, see `Set Up Agent Hierarchies `__ in the *Amazon Connect Administrator Guide*. + + diff -Nru awscli-1.16.301/awscli/examples/connect/describe-user-hierarchy-structure.rst awscli-1.17.14/awscli/examples/connect/describe-user-hierarchy-structure.rst --- awscli-1.16.301/awscli/examples/connect/describe-user-hierarchy-structure.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/connect/describe-user-hierarchy-structure.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,30 @@ +**To display the details for a hierarchy structure** + +The following ``describe-user-hierarchy-structure`` example displays the details for the hierarchy structure for the specified Amazon Connect instance. :: + + aws connect describe-user-hierarchy-group \ + --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 + +Output:: + + { + "HierarchyStructure": { + "LevelOne": { + "Id": "12345678-1111-2222-800e-aaabbb555gg", + "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent-group-level/1", + "Name": "Corporation" + }, + "LevelTwo": { + "Id": "87654321-2222-3333-ac99-123456789102", + "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent-group-level/2", + "Name": "Services Division" + }, + "LevelThree": { + "Id": "abcdefgh-3333-4444-8af3-201123456789", + "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent-group-level/3", + "Name": "EU Site" + } + } + } + +For more information, see `Set Up Agent Hierarchies `__ in the *Amazon Connect Administrator Guide*. diff -Nru awscli-1.16.301/awscli/examples/connect/describe-user.rst awscli-1.17.14/awscli/examples/connect/describe-user.rst --- awscli-1.16.301/awscli/examples/connect/describe-user.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/connect/describe-user.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,36 @@ +**To display the details for a user** + +The following ``describe-user`` example displays the details for the specified Amazon Connect user. :: + + aws connect describe-user \ + --user-id 0c245dc0-0cf5-4e37-800e-2a7481cc8a60 + --instance-id 40c83b68-ea62-414c-97bb-d018e39e158e + +Output:: + + { + "User": { + "Id": "0c245dc0-0cf5-4e37-800e-2a7481cc8a60", + "Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/agent/0c245dc0-0cf5-4e37-800e-2a7481cc8a60", + "Username": "Jane", + "IdentityInfo": { + "FirstName": "Jane", + "LastName": "Doe", + "Email": "example.com" + }, + "PhoneConfig": { + "PhoneType": "SOFT_PHONE", + "AutoAccept": false, + "AfterContactWorkTimeLimit": 0, + "DeskPhoneNumber": "" + }, + "DirectoryUserId": "8b444cf6-b368-4f29-ba18-07af27405658", + "SecurityProfileIds": [ + "b6f85a42-1dc5-443b-b621-de0abf70c9cf" + ], + "RoutingProfileId": "0be36ee9-2b5f-4ef4-bcf7-87738e5be0e5", + "Tags": {} + } + } + +For more information, see `Manage Users `__ in the *Amazon Connect Administrator Guide*. diff -Nru awscli-1.16.301/awscli/examples/connect/get-contact-attributes.rst awscli-1.17.14/awscli/examples/connect/get-contact-attributes.rst --- awscli-1.16.301/awscli/examples/connect/get-contact-attributes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/connect/get-contact-attributes.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,17 @@ +**To retrieve the attributes for a contact** + +The following ``get-contact-attributes`` example retrieves the attributes that were set for the specified Amazon Connect contact. :: + + aws connect get-contact-attributes \ + --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ + --initial-contact-id 12345678-1111-2222-800e-a2b3c4d5f6g7 + +Output:: + + { + "Attributes": { + "greetingPlayed": "true" + } + } + +For more information, see `Use Amazon Connect Contact Attributes `__ in the *Amazon Connect Administrator Guide*. diff -Nru awscli-1.16.301/awscli/examples/connect/list-contact-flows.rst awscli-1.17.14/awscli/examples/connect/list-contact-flows.rst --- awscli-1.16.301/awscli/examples/connect/list-contact-flows.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/connect/list-contact-flows.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,33 @@ +**To list the contact flows in an instance** + +The following ``list-contact-flows`` example lists the contact flows in the specified Amazon Connect instance. :: + + aws connect list-contact-flows \ + --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 + +Output:: + + { + "ContactFlowSummaryList": [ + { + "Id": "12345678-1111-2222-800e-a2b3c4d5f6g7", + "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/contact-flow/12345678-1111-2222-800e-a2b3c4d5f6g7", + "Name": "Default queue transfer", + "ContactFlowType": "QUEUE_TRANSFER" + }, + { + "Id": "87654321-2222-3333-ac99-123456789102", + "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/contact-flow/87654321-2222-3333-ac99-123456789102", + "Name": "Default agent hold", + "ContactFlowType": "AGENT_HOLD" + }, + { + "Id": "abcdefgh-3333-4444-8af3-201123456789", + "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/contact-flow/abcdefgh-3333-4444-8af3-201123456789", + "Name": "Default customer hold", + "ContactFlowType": "CUSTOMER_HOLD" + }, + ] + } + +For more information, see `Create Amazon Connect Contact Flows `__ in the *Amazon Connect Administrator Guide*. diff -Nru awscli-1.16.301/awscli/examples/connect/list-hours-of-operations.rst awscli-1.17.14/awscli/examples/connect/list-hours-of-operations.rst --- awscli-1.16.301/awscli/examples/connect/list-hours-of-operations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/connect/list-hours-of-operations.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,20 @@ +**To list the hours of operation in an instance** + +The following ``list-hours-of-operations`` example lists the hours of operations for the specified Amazon Connect instance. :: + + aws connect list-hours-of-operations \ + --instance-id 40c83b68-ea62-414c-97bb-d018e39e158e + +Output:: + + { + "HoursOfOperationSummaryList": [ + { + "Id": "d69f1f84-7457-4924-8fbe-e64875546259", + "Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/operating-hours/d69f1f84-7457-4924-8fbe-e64875546259", + "Name": "Basic Hours" + } + ] + } + +For more information, see `Set the Hours of Operation for a Queue `__ in the *Amazon Connect Administrator Guide*. diff -Nru awscli-1.16.301/awscli/examples/connect/list-phone-numbers.rst awscli-1.17.14/awscli/examples/connect/list-phone-numbers.rst --- awscli-1.16.301/awscli/examples/connect/list-phone-numbers.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/connect/list-phone-numbers.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,30 @@ +**To list the phone numbers in an instance** + +The following ``list-phone-numbers`` example lists the phone numbers in the specified Amazon Connect instance. :: + + aws connect list-phone-numbers \ + --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 + +Output:: + + { + "PhoneNumberSummaryList": [ + { + "Id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/phone-number/xyz80zxy-xyz1-80zx-zx80-11111EXAMPLE", + "PhoneNumber": "+17065551212", + "PhoneNumberType": "DID", + "PhoneNumberCountryCode": "US" + }, + { + "Id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/phone-number/ccc0ccc-xyz1-80zx-zx80-22222EXAMPLE", + "PhoneNumber": "+18555551212", + "PhoneNumberType": "TOLL_FREE", + "PhoneNumberCountryCode": "US" + } + ] + } + +For more information, see `Set Up Phone Numbers for Your Contact Center `__ in the *Amazon Connect Administrator Guide*. + diff -Nru awscli-1.16.301/awscli/examples/connect/list-queues.rst awscli-1.17.14/awscli/examples/connect/list-queues.rst --- awscli-1.16.301/awscli/examples/connect/list-queues.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/connect/list-queues.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,36 @@ +**To list the queues in an instance** + +The following ``list-queues`` example lists the queues in the specified Amazon Connect instance. :: + + aws connect list-queues \ + --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 + +Output:: + + { + "QueueSummaryList": [ + { + "Id": "12345678-1111-2222-800e-a2b3c4d5f6g7", + "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/queue/agent/12345678-1111-2222-800e-a2b3c4d5f6g7", + "QueueType": "AGENT" + }, + { + "Id": "87654321-2222-3333-ac99-123456789102", + "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/queue/agent/87654321-2222-3333-ac99-123456789102", + "QueueType": "AGENT" + }, + { + "Id": "abcdefgh-3333-4444-8af3-201123456789", + "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/queue/agent/abcdefgh-3333-4444-8af3-201123456789", + "QueueType": "AGENT" + }, + { + "Id": "hgfedcba-4444-5555-a31f-123456789102", + "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/queue/hgfedcba-4444-5555-a31f-123456789102", + "Name": "BasicQueue", + "QueueType": "STANDARD" + }, + ] + } + +For more information, see `Create a Queue `__ in the *Amazon Connect Administrator Guide*. diff -Nru awscli-1.16.301/awscli/examples/connect/list-routing-profiles.rst awscli-1.17.14/awscli/examples/connect/list-routing-profiles.rst --- awscli-1.16.301/awscli/examples/connect/list-routing-profiles.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/connect/list-routing-profiles.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,20 @@ +**To list the routing profiles in an instance** + +The following ``list-routing-profiles`` example lists the routing profiles in the specified Amazon Connect instance. :: + + aws connect list-routing-profiles \ + --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 + +Output:: + + { + "RoutingProfileSummaryList": [ + { + "Id": "12345678-1111-2222-800e-a2b3c4d5f6g7", + "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/routing-profile/12345678-1111-2222-800e-a2b3c4d5f6g7", + "Name": "Basic Routing Profile" + }, + ] + } + +For more information, see `Create a Routing Profile `__ in the *Amazon Connect Administrator Guide*. diff -Nru awscli-1.16.301/awscli/examples/connect/list-security-profiles.rst awscli-1.17.14/awscli/examples/connect/list-security-profiles.rst --- awscli-1.16.301/awscli/examples/connect/list-security-profiles.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/connect/list-security-profiles.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,35 @@ +**To list the security profiles in an instance** + +The following ``list-security-profiles`` example lists the security profiles in the specified Amazon Connect instance. :: + + aws connect list-security-profiles \ + --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 + +Output:: + + { + "SecurityProfileSummaryList": [ + { + "Id": "12345678-1111-2222-800e-a2b3c4d5f6g7", + "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/security-profile/12345678-1111-2222-800e-a2b3c4d5f6g7", + "Name": "CallCenterManager" + }, + { + "Id": "87654321-2222-3333-ac99-123456789102", + "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/security-profile/87654321-2222-3333-ac99-123456789102", + "Name": "QualityAnalyst" + }, + { + "Id": "abcdefgh-3333-4444-8af3-201123456789", + "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/security-profile/abcdefgh-3333-4444-8af3-201123456789", + "Name": "Agent" + }, + { + "Id": "12345678-1111-2222-800e-x2y3c4d5fzzzz", + "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/security-profile/12345678-1111-2222-800e-x2y3c4d5fzzzz", + "Name": "Admin" + } + ] + } + +For more information, see `Assign Permissions: Security Profiles `__ in the *Amazon Connect Administrator Guide*. diff -Nru awscli-1.16.301/awscli/examples/connect/list-user-hierarchy-groups.rst awscli-1.17.14/awscli/examples/connect/list-user-hierarchy-groups.rst --- awscli-1.16.301/awscli/examples/connect/list-user-hierarchy-groups.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/connect/list-user-hierarchy-groups.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,20 @@ +**To list the user hierarchy groups in an instance** + +The following ``list-user-hierarchy-groups`` example lists the user hierarchy groups in the specified Amazon Connect instance. :: + + aws connect list-user-hierarchy-groups \ + --instance-id 40c83b68-ea62-414c-97bb-d018e39e158e + +Output:: + + { + "UserHierarchyGroupSummaryList": [ + { + "Id": "0e2f6d1d-b3ca-494b-8dbc-ba81d9f8182a", + "Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/agent-group/0e2f6d1d-b3ca-494b-8dbc-ba81d9f8182a", + "Name": "Example Corporation" + }, + ] + } + +For more information, see `Set Up Agent Hierarchies `__ in the *Amazon Connect Administrator Guide*. diff -Nru awscli-1.16.301/awscli/examples/connect/list-users.rst awscli-1.17.14/awscli/examples/connect/list-users.rst --- awscli-1.16.301/awscli/examples/connect/list-users.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/connect/list-users.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,35 @@ +**To list the user hierarchy groups in an instance** + +The following ``list-users`` example lists the users in the specified Amazon Connect instance. :: + + aws connect list-users \ + --instance-id 40c83b68-ea62-414c-97bb-d018e39e158e + +Output:: + + { + "UserSummaryList": [ + { + "Id": "0c245dc0-0cf5-4e37-800e-2a7481cc8a60", + "Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/agent/0c245dc0-0cf5-4e37-800e-2a7481cc8a60", + "Username": "Jane" + }, + { + "Id": "46f0c67c-3fc7-4806-ac99-403798788c14", + "Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/agent/46f0c67c-3fc7-4806-ac99-403798788c14", + "Username": "Paulo" + }, + { + "Id": "55a83578-95e1-4710-8af3-2b7afe310e48", + "Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/agent/55a83578-95e1-4710-8af3-2b7afe310e48", + "Username": "JohnD" + }, + { + "Id": "703e27b5-c9f0-4f1f-a239-64ccbb160125", + "Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/agent/703e27b5-c9f0-4f1f-a239-64ccbb160125", + "Username": "JohnS" + } + ] + } + +For more information, see `Add Users `__ in the *Amazon Connect Administrator Guide*. diff -Nru awscli-1.16.301/awscli/examples/connect/update-contact-attributes.rst awscli-1.17.14/awscli/examples/connect/update-contact-attributes.rst --- awscli-1.16.301/awscli/examples/connect/update-contact-attributes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/connect/update-contact-attributes.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,12 @@ +**To update a contact's attribute** + +The following ``update-contact-attributes`` example updates the ``greetingPlayed`` attribute for the specified Amazon Connect user. :: + + aws connect update-contact-attributes \ + --initial-contact-id 11111111-2222-3333-4444-12345678910 \ + --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ + --attributes greetingPlayed=false + +This command produces no output. + +For more information, see `Use Amazon Connect Contact Attributes `__ in the *Amazon Connect Administrator Guide*. diff -Nru awscli-1.16.301/awscli/examples/connect/update-user-hierarchy.rst awscli-1.17.14/awscli/examples/connect/update-user-hierarchy.rst --- awscli-1.16.301/awscli/examples/connect/update-user-hierarchy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/connect/update-user-hierarchy.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,12 @@ +**To update a user's hierarchy** + +The following ``update-user-hierarchy`` example updates the agent hierarchy for the specified Amazon Connect user. :: + + aws connect update-user-hierarchy \ + --hierarchy-group-id 12345678-a1b2-c3d4-e5f6-123456789abc \ + --user-id 87654321-2222-1234-1234-111234567891 \ + --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 + +This command produces no output. + +For more information, see `Configure Agent Settings `__ in the *Amazon Connect Administrator Guide*. diff -Nru awscli-1.16.301/awscli/examples/connect/update-user-identity-info.rst awscli-1.17.14/awscli/examples/connect/update-user-identity-info.rst --- awscli-1.16.301/awscli/examples/connect/update-user-identity-info.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/connect/update-user-identity-info.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,12 @@ +**To update a user's identity information** + +The following ``update-user-identity-info`` example updates the identity information for the specified Amazon Connect user. :: + + aws connect update-user-identity-info \ + --identity-info FirstName=Mary,LastName=Major,Email=marym@example.com \ + --user-id 87654321-2222-1234-1234-111234567891 \ + --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 + +This command produces no output. + +For more information, see `Configure Agent Settings `__ in the *Amazon Connect Administrator Guide*. diff -Nru awscli-1.16.301/awscli/examples/connect/update-user-phone-config.rst awscli-1.17.14/awscli/examples/connect/update-user-phone-config.rst --- awscli-1.16.301/awscli/examples/connect/update-user-phone-config.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/connect/update-user-phone-config.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,12 @@ +**To update a user's phone configuration** + +The following ``update-user-phone-config`` example updates the phone configuration for the specified user. :: + + aws connect update-user-phone-config \ + --phone-config PhoneType=SOFT_PHONE,AutoAccept=false,AfterContactWorkTimeLimit=60,DeskPhoneNumber=+18005551212 \ + --user-id 12345678-4444-3333-2222-111122223333 \ + --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 + +This command produces no output. + +For more information, see `Configure Agent Settings `__ in the *Amazon Connect Administrator Guide*. diff -Nru awscli-1.16.301/awscli/examples/connect/update-user-routing-profile.rst awscli-1.17.14/awscli/examples/connect/update-user-routing-profile.rst --- awscli-1.16.301/awscli/examples/connect/update-user-routing-profile.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/connect/update-user-routing-profile.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,12 @@ +**To update a user's routing profile** + +The following ``update-user-routing-profile`` example updates the routing profile for the specified Amazon Connect user. :: + + aws connect update-user-routing-profile \ + --routing-profile-id 12345678-1111-3333-2222-4444EXAMPLE \ + --user-id 87654321-2222-1234-1234-111234567891 \ + --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 + +This command produces no output. + +For more information, see `Configure Agent Settings `__ in the *Amazon Connect Administrator Guide*. diff -Nru awscli-1.16.301/awscli/examples/connect/update-user-security-profiles.rst awscli-1.17.14/awscli/examples/connect/update-user-security-profiles.rst --- awscli-1.16.301/awscli/examples/connect/update-user-security-profiles.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/connect/update-user-security-profiles.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,12 @@ +**To update a user's security profiles** + +The following ``update-user-security-profiles`` example updates the security profile for the specified Amazon Connect user. :: + + aws connect update-user-security-profiles \ + --security-profile-ids 12345678-1234-1234-1234-1234567892111 \ + --user-id 87654321-2222-1234-1234-111234567891 \ + --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 + +This command produces no output. + +For more information, see `Assign Permissions: Security Profiles `__ in the *Amazon Connect Administrator Guide*. diff -Nru awscli-1.16.301/awscli/examples/dax/create-cluster.rst awscli-1.17.14/awscli/examples/dax/create-cluster.rst --- awscli-1.16.301/awscli/examples/dax/create-cluster.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dax/create-cluster.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,45 @@ +**To create a DAX cluster** + +The following ``create-cluster`` example creates a DAX cluster with the specified settings. :: + + aws dax create-cluster \ + --cluster-name daxcluster \ + --node-type dax.r4.large \ + --replication-factor 3 \ + --iam-role-arn roleARN \ + --sse-specification Enabled=true + +Output:: + + { + "Cluster": { + "ClusterName": "daxcluster", + "ClusterArn": "arn:aws:dax:us-west-2:123456789012:cache/daxcluster", + "TotalNodes": 3, + "ActiveNodes": 0, + "NodeType": "dax.r4.large", + "Status": "creating", + "ClusterDiscoveryEndpoint": { + "Port": 8111 + }, + "PreferredMaintenanceWindow": "thu:13:00-thu:14:00", + "SubnetGroup": "default", + "SecurityGroups": [ + { + "SecurityGroupIdentifier": "sg-1af6e36e", + "Status": "active" + } + ], + "IamRoleArn": "arn:aws:iam::123456789012:role/DAXServiceRoleForDynamoDBAccess", + "ParameterGroup": { + "ParameterGroupName": "default.dax1.0", + "ParameterApplyStatus": "in-sync", + "NodeIdsToReboot": [] + }, + "SSEDescription": { + "Status": "ENABLED" + } + } + } + +For more information, see `Step 3: Create a DAX Cluster `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dax/create-parameter-group.rst awscli-1.17.14/awscli/examples/dax/create-parameter-group.rst --- awscli-1.16.301/awscli/examples/dax/create-parameter-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dax/create-parameter-group.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,18 @@ +**To create a parameter group** + +The following `` create-parameter-group`` example creates a parameter group with the specified settings. :: + + aws dax create-parameter-group \ + --parameter-group-name daxparametergroup \ + --description "A new parameter group" + +Output:: + + { + "ParameterGroup": { + "ParameterGroupName": "daxparametergroup", + "Description": "A new parameter group" + } + } + +For more information, see `Managing DAX Clusters `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dax/create-subnet-group.rst awscli-1.17.14/awscli/examples/dax/create-subnet-group.rst --- awscli-1.16.301/awscli/examples/dax/create-subnet-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dax/create-subnet-group.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,28 @@ +**To create a DAX subnet group** + +The following ``create-subnet-group`` example creates a subnet group with the specified settings. :: + + aws dax create-subnet-group \ + --subnet-group-name daxSubnetGroup \ + --subnet-ids subnet-11111111 subnet-22222222 + +Output:: + + { + "SubnetGroup": { + "SubnetGroupName": "daxSubnetGroup", + "VpcId": "vpc-05a1fa8e00c325226", + "Subnets": [ + { + "SubnetIdentifier": "subnet-11111111", + "SubnetAvailabilityZone": "us-west-2b" + }, + { + "SubnetIdentifier": "subnet-22222222", + "SubnetAvailabilityZone": "us-west-2c" + } + ] + } + } + +For more information, see `Step 2: Create a Subnet Group `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dax/decrease-replication-factor.rst awscli-1.17.14/awscli/examples/dax/decrease-replication-factor.rst --- awscli-1.16.301/awscli/examples/dax/decrease-replication-factor.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dax/decrease-replication-factor.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,78 @@ +**To remove one or more nodes from the cluster** + +The following ``decrease-replication-factor`` example decreases the number of nodes in the specified DAX cluster to one. :: + + aws dax decrease-replication-factor \ + --cluster-name daxcluster \ + --new-replication-factor 1 + +Output:: + + { + "Cluster": { + "ClusterName": "daxcluster", + "ClusterArn": "arn:aws:dax:us-west-2:123456789012:cache/daxcluster", + "TotalNodes": 3, + "ActiveNodes": 3, + "NodeType": "dax.r4.large", + "Status": "modifying", + "ClusterDiscoveryEndpoint": { + "Address": "daxcluster.ey3o9d.clustercfg.dax.usw2.cache.amazonaws.com", + "Port": 8111 + }, + "Nodes": [ + { + "NodeId": "daxcluster-a", + "Endpoint": { + "Address": "daxcluster-a.ey3o9d.0001.dax.usw2.cache.amazonaws.com", + "Port": 8111 + }, + "NodeCreateTime": 1576625059.509, + "AvailabilityZone": "us-west-2c", + "NodeStatus": "available", + "ParameterGroupStatus": "in-sync" + }, + { + "NodeId": "daxcluster-b", + "Endpoint": { + "Address": "daxcluster-b.ey3o9d.0001.dax.usw2.cache.amazonaws.com", + "Port": 8111 + }, + "NodeCreateTime": 1576625059.509, + "AvailabilityZone": "us-west-2a", + "NodeStatus": "available", + "ParameterGroupStatus": "in-sync" + }, + { + "NodeId": "daxcluster-c", + "Endpoint": { + "Address": "daxcluster-c.ey3o9d.0001.dax.usw2.cache.amazonaws.com", + "Port": 8111 + }, + "NodeCreateTime": 1576625059.509, + "AvailabilityZone": "us-west-2b", + "NodeStatus": "available", + "ParameterGroupStatus": "in-sync" + } + ], + "PreferredMaintenanceWindow": "thu:13:00-thu:14:00", + "SubnetGroup": "default", + "SecurityGroups": [ + { + "SecurityGroupIdentifier": "sg-1af6e36e", + "Status": "active" + } + ], + "IamRoleArn": "arn:aws:iam::123456789012:role/DAXServiceRoleForDynamoDBAccess", + "ParameterGroup": { + "ParameterGroupName": "default.dax1.0", + "ParameterApplyStatus": "in-sync", + "NodeIdsToReboot": [] + }, + "SSEDescription": { + "Status": "ENABLED" + } + } + } + +For more information, see `Managing DAX Clusters `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dax/delete-cluster.rst awscli-1.17.14/awscli/examples/dax/delete-cluster.rst --- awscli-1.16.301/awscli/examples/dax/delete-cluster.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dax/delete-cluster.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,42 @@ +**To delete a DAX cluster** + +The following ``delete-cluster`` example deletes the specified DAX cluster. :: + + aws dax delete-cluster \ + --cluster-name daxcluster + +Output:: + + { + "Cluster": { + "ClusterName": "daxcluster", + "ClusterArn": "arn:aws:dax:us-west-2:123456789012:cache/daxcluster", + "TotalNodes": 3, + "ActiveNodes": 0, + "NodeType": "dax.r4.large", + "Status": "deleting", + "ClusterDiscoveryEndpoint": { + "Address": "dd.ey3o9d.clustercfg.dax.usw2.cache.amazonaws.com", + "Port": 8111 + }, + "PreferredMaintenanceWindow": "fri:06:00-fri:07:00", + "SubnetGroup": "default", + "SecurityGroups": [ + { + "SecurityGroupIdentifier": "sg-1af6e36e", + "Status": "active" + } + ], + "IamRoleArn": "arn:aws:iam::123456789012:role/DAXServiceRoleForDynamoDBAccess", + "ParameterGroup": { + "ParameterGroupName": "default.dax1.0", + "ParameterApplyStatus": "in-sync", + "NodeIdsToReboot": [] + }, + "SSEDescription": { + "Status": "ENABLED" + } + } + } + +For more information, see `Managing DAX Clusters `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dax/delete-parameter-group.rst awscli-1.17.14/awscli/examples/dax/delete-parameter-group.rst --- awscli-1.16.301/awscli/examples/dax/delete-parameter-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dax/delete-parameter-group.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,14 @@ +**To delete a parameter group** + +The following ``delete-parameter-group`` example deletes the specified DAX parameter group. :: + + aws dax delete-parameter-group \ + --parameter-group-name daxparametergroup + +Output:: + + { + "DeletionMessage": "Parameter group daxparametergroup has been deleted." + } + +For more information, see `Managing DAX Clusters `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dax/delete-subnet-group.rst awscli-1.17.14/awscli/examples/dax/delete-subnet-group.rst --- awscli-1.16.301/awscli/examples/dax/delete-subnet-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dax/delete-subnet-group.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,14 @@ +**To delete a subnet group** + +The following ``delete-subnet-group`` example deletes the specified DAX subnet group. :: + + aws dax delete-subnet-group \ + --subnet-group-name daxSubnetGroup + +Output:: + + { + "DeletionMessage": "Subnet group daxSubnetGroup has been deleted." + } + +For more information, see `Managing DAX Clusters `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dax/describe-clusters.rst awscli-1.17.14/awscli/examples/dax/describe-clusters.rst --- awscli-1.16.301/awscli/examples/dax/describe-clusters.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dax/describe-clusters.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,56 @@ +**To return information about all provisioned DAX clusters** + +The following ``describe-clusters`` example displays details about all provisioned DAX clusters. :: + + aws dax describe-clusters + +Output:: + + { + "Clusters": [ + { + "ClusterName": "daxcluster", + "ClusterArn": "arn:aws:dax:us-west-2:123456789012:cache/daxcluster", + "TotalNodes": 1, + "ActiveNodes": 1, + "NodeType": "dax.r4.large", + "Status": "available", + "ClusterDiscoveryEndpoint": { + "Address": "daxcluster.ey3o9d.clustercfg.dax.usw2.cache.amazonaws.com", + "Port": 8111 + }, + "Nodes": [ + { + "NodeId": "daxcluster-a", + "Endpoint": { + "Address": "daxcluster-a.ey3o9d.0001.dax.usw2.cache.amazonaws.com", + "Port": 8111 + }, + "NodeCreateTime": 1576625059.509, + "AvailabilityZone": "us-west-2c", + "NodeStatus": "available", + "ParameterGroupStatus": "in-sync" + } + ], + "PreferredMaintenanceWindow": "thu:13:00-thu:14:00", + "SubnetGroup": "default", + "SecurityGroups": [ + { + "SecurityGroupIdentifier": "sg-1af6e36e", + "Status": "active" + } + ], + "IamRoleArn": "arn:aws:iam::123456789012:role/DAXServiceRoleForDynamoDBAccess", + "ParameterGroup": { + "ParameterGroupName": "default.dax1.0", + "ParameterApplyStatus": "in-sync", + "NodeIdsToReboot": [] + }, + "SSEDescription": { + "Status": "ENABLED" + } + } + ] + } + +For more information, see `Managing DAX Clusters `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dax/describe-default-parameters.rst awscli-1.17.14/awscli/examples/dax/describe-default-parameters.rst --- awscli-1.16.301/awscli/examples/dax/describe-default-parameters.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dax/describe-default-parameters.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,38 @@ +**To return the default system parameter information for DAX** + +The following ``describe-default-parameters`` example displays the default system parameter information for DAX. :: + + aws dax describe-default-parameters + +Output:: + + { + "Parameters": [ + { + "ParameterName": "query-ttl-millis", + "ParameterType": "DEFAULT", + "ParameterValue": "300000", + "NodeTypeSpecificValues": [], + "Description": "Duration in milliseconds for queries to remain cached", + "Source": "user", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": "TRUE", + "ChangeType": "IMMEDIATE" + }, + { + "ParameterName": "record-ttl-millis", + "ParameterType": "DEFAULT", + "ParameterValue": "300000", + "NodeTypeSpecificValues": [], + "Description": "Duration in milliseconds for records to remain valid in cache (Default: 0 = infinite)", + "Source": "user", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": "TRUE", + "ChangeType": "IMMEDIATE" + } + ] + } + +For more information, see `Managing DAX Clusters `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dax/describe-events.rst awscli-1.17.14/awscli/examples/dax/describe-events.rst --- awscli-1.16.301/awscli/examples/dax/describe-events.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dax/describe-events.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,44 @@ +**To return all events related to DAX clusters and parameter groups** + +The following ``describe-events`` example displays details of events that are related to DAX clusters and parameter groups. :: + + aws dax describe-events + +Output:: + + { + "Events": [ + { + "SourceName": "daxcluster", + "SourceType": "CLUSTER", + "Message": "Cluster deleted.", + "Date": 1576702736.706 + }, + { + "SourceName": "daxcluster", + "SourceType": "CLUSTER", + "Message": "Removed node daxcluster-b.", + "Date": 1576702691.738 + }, + { + "SourceName": "daxcluster", + "SourceType": "CLUSTER", + "Message": "Removed node daxcluster-a.", + "Date": 1576702633.498 + }, + { + "SourceName": "daxcluster", + "SourceType": "CLUSTER", + "Message": "Removed node daxcluster-c.", + "Date": 1576702631.329 + }, + { + "SourceName": "daxcluster", + "SourceType": "CLUSTER", + "Message": "Cluster created.", + "Date": 1576626560.057 + } + ] + } + +For more information, see `Managing DAX Clusters `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dax/describe-parameter-groups.rst awscli-1.17.14/awscli/examples/dax/describe-parameter-groups.rst --- awscli-1.16.301/awscli/examples/dax/describe-parameter-groups.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dax/describe-parameter-groups.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,18 @@ +**To describe the parameter groups defined in DAX** + +The following ``describe-parameter-groups`` example retrieves details about the parameter groups that are defined in DAX. :: + + aws dax describe-parameter-groups + +Output:: + + { + "ParameterGroups": [ + { + "ParameterGroupName": "default.dax1.0", + "Description": "Default parameter group for dax1.0" + } + ] + } + +For more information, see `Managing DAX Clusters `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dax/describe-parameters.rst awscli-1.17.14/awscli/examples/dax/describe-parameters.rst --- awscli-1.16.301/awscli/examples/dax/describe-parameters.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dax/describe-parameters.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,39 @@ +**To describe the parameters defined in a DAX parameter group** + +The following ``describe-parameters`` example retrieves details about the parameters that are defined in the specified DAX parameter group. :: + + aws dax describe-parameters \ + --parameter-group-name default.dax1.0 + +Output:: + + { + "Parameters": [ + { + "ParameterName": "query-ttl-millis", + "ParameterType": "DEFAULT", + "ParameterValue": "300000", + "NodeTypeSpecificValues": [], + "Description": "Duration in milliseconds for queries to remain cached", + "Source": "user", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": "TRUE", + "ChangeType": "IMMEDIATE" + }, + { + "ParameterName": "record-ttl-millis", + "ParameterType": "DEFAULT", + "ParameterValue": "300000", + "NodeTypeSpecificValues": [], + "Description": "Duration in milliseconds for records to remain valid in cache (Default: 0 = infinite)", + "Source": "user", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": "TRUE", + "ChangeType": "IMMEDIATE" + } + ] + } + +For more information, see `Managing DAX Clusters `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dax/describe-subnet-groups.rst awscli-1.17.14/awscli/examples/dax/describe-subnet-groups.rst --- awscli-1.16.301/awscli/examples/dax/describe-subnet-groups.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dax/describe-subnet-groups.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,37 @@ +**To describe subnet groups defined in DAX** + +The following ``describe-subnet-groups`` example retrieves details for the subnet groups defined in DAX. :: + + aws dax describe-subnet-groups + +Output:: + + { + "SubnetGroups": [ + { + "SubnetGroupName": "default", + "Description": "Default CacheSubnetGroup", + "VpcId": "vpc-ee70a196", + "Subnets": [ + { + "SubnetIdentifier": "subnet-874953af", + "SubnetAvailabilityZone": "us-west-2d" + }, + { + "SubnetIdentifier": "subnet-bd3d1fc4", + "SubnetAvailabilityZone": "us-west-2a" + }, + { + "SubnetIdentifier": "subnet-72c2ff28", + "SubnetAvailabilityZone": "us-west-2c" + }, + { + "SubnetIdentifier": "subnet-09e6aa42", + "SubnetAvailabilityZone": "us-west-2b" + } + ] + } + ] + } + +For more information, see `Managing DAX Clusters `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dax/increase-replication-factor.rst awscli-1.17.14/awscli/examples/dax/increase-replication-factor.rst --- awscli-1.16.301/awscli/examples/dax/increase-replication-factor.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dax/increase-replication-factor.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,64 @@ +**To increase the replication factor for a DAX cluster** + +The following ``increase-replication-factor`` example increases the specified DAX cluster's replication factor to 3. :: + + aws dax increase-replication-factor \ + --cluster-name daxcluster \ + --new-replication-factor 3 + +Output:: + + { + "Cluster": { + "ClusterName": "daxcluster", + "ClusterArn": "arn:aws:dax:us-west-2:123456789012:cache/daxcluster", + "TotalNodes": 3, + "ActiveNodes": 1, + "NodeType": "dax.r4.large", + "Status": "modifying", + "ClusterDiscoveryEndpoint": { + "Address": "daxcluster.ey3o9d.clustercfg.dax.usw2.cache.amazonaws.com", + "Port": 8111 + }, + "Nodes": [ + { + "NodeId": "daxcluster-a", + "Endpoint": { + "Address": "daxcluster-a.ey3o9d.0001.dax.usw2.cache.amazonaws.com", + "Port": 8111 + }, + "NodeCreateTime": 1576625059.509, + "AvailabilityZone": "us-west-2c", + "NodeStatus": "available", + "ParameterGroupStatus": "in-sync" + }, + { + "NodeId": "daxcluster-b", + "NodeStatus": "creating" + }, + { + "NodeId": "daxcluster-c", + "NodeStatus": "creating" + } + ], + "PreferredMaintenanceWindow": "thu:13:00-thu:14:00", + "SubnetGroup": "default", + "SecurityGroups": [ + { + "SecurityGroupIdentifier": "sg-1af6e36e", + "Status": "active" + } + ], + "IamRoleArn": "arn:aws:iam::123456789012:role/DAXServiceRoleForDynamoDBAccess", + "ParameterGroup": { + "ParameterGroupName": "default.dax1.0", + "ParameterApplyStatus": "in-sync", + "NodeIdsToReboot": [] + }, + "SSEDescription": { + "Status": "ENABLED" + } + } + } + +For more information, see `Managing DAX Clusters `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dax/list-tags.rst awscli-1.17.14/awscli/examples/dax/list-tags.rst --- awscli-1.16.301/awscli/examples/dax/list-tags.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dax/list-tags.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,19 @@ +**To list tags on a DAX resource** + +The following ``list-tags`` example lists the tag keys and values attached to the specified DAX cluster. :: + + aws dax list-tags \ + --resource-name arn:aws:dax:us-west-2:123456789012:cache/daxcluster + +Output:: + + { + "Tags": [ + { + "Key": "ClusterUsage", + "Value": "prod" + } + ] + } + +For more information, see `Managing DAX Clusters `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dax/tag-resource.rst awscli-1.17.14/awscli/examples/dax/tag-resource.rst --- awscli-1.16.301/awscli/examples/dax/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dax/tag-resource.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,20 @@ +**To tag a DAX resource** + +The following ``tag-resource`` example attaches the specified tag key name and associated value to the specified DAX cluster to describe the cluster usage. :: + + aws dax tag-resource \ + --resource-name arn:aws:dax:us-west-2:123456789012:cache/daxcluster \ + --tags="Key=ClusterUsage,Value=prod" + +Output:: + + { + "Tags": [ + { + "Key": "ClusterUsage", + "Value": "prod" + } + ] + } + +For more information, see `Managing DAX Clusters `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dax/untag-resource.rst awscli-1.17.14/awscli/examples/dax/untag-resource.rst --- awscli-1.16.301/awscli/examples/dax/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dax/untag-resource.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,15 @@ +**To remove tags from a DAX resource** + +The following ``untag-resource`` example removes the tag with the specified key name from a DAX cluster. :: + + aws dax untag-resource \ + --resource-name arn:aws:dax:us-west-2:123456789012:cache/daxcluster \ + --tag-keys="ClusterUsage" + +Output:: + + { + "Tags": [] + } + +For more information, see `Managing DAX Clusters `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/detective/accept-invitation.rst awscli-1.17.14/awscli/examples/detective/accept-invitation.rst --- awscli-1.16.301/awscli/examples/detective/accept-invitation.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/detective/accept-invitation.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,8 @@ +**To accept an invitation to become a member account in a behavior graph** + +The following ``accept-invitation`` example accepts an invitation to become a member account in the specified behavior graph. :: + + aws detective accept-invitation \ + --graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 + +For more information, see `Responding to a Behavior Graph Invitation `__ in the *Amazon Detective Administration Guide*. diff -Nru awscli-1.16.301/awscli/examples/detective/create-graph.rst awscli-1.17.14/awscli/examples/detective/create-graph.rst --- awscli-1.16.301/awscli/examples/detective/create-graph.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/detective/create-graph.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,13 @@ +**To enable Amazon Detective and create a new behavior graph** + +The following ``create-graph`` example enables Detective for the AWS account that runs the command in the Region where the command is run. The command creates a new behavior graph with that account as its master account. :: + + aws detective create-graph + +Output:: + + { + "GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:027c7c4610ea4aacaf0b883093cab899" + } + +For more information, see `Enabling Amazon Detective `__ in the *Amazon Detective Administration Guide*. diff -Nru awscli-1.16.301/awscli/examples/detective/create-members.rst awscli-1.17.14/awscli/examples/detective/create-members.rst --- awscli-1.16.301/awscli/examples/detective/create-members.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/detective/create-members.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,36 @@ +**To invite member accounts to a behavior graph** + +The following ``create-members`` example invites two AWS accounts to become member accounts in the specified behavior graph. For each account, the request provides the AWS account ID and the account root user email address. The request also includes a custom message to insert into the invitation email. :: + + aws detective create-members \ + --accounts AccountId=444455556666,EmailAddress=mmajor@example.com AccountId=123456789012,EmailAddress=jstiles@example.com \ + --graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 \ + --message "This is Paul Santos. I need to add your account to the data we use for security investigation in Amazon Detective. If you have any questions, contact me at psantos@example.com." + +Output:: + + { + "Members": [ + { + "AccountId": "444455556666", + "EmailAddress": "mmajor@example.com", + "GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:123412341234", + "InvitedTime": 1579826107000, + "MasterId": "111122223333", + "Status": "INVITED", + "UpdatedTime": 1579826107000 + }, + { + "AccountId": "123456789012", + "EmailAddress": "jstiles@example.com", + "GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:123412341234", + "InvitedTime": 1579826107000, + "MasterId": "111122223333", + "Status": "VERIFICATION_IN_PROGRESS", + "UpdatedTime": 1579826107000 + } + ], + "UnprocessedAccounts": [ ] + } + +For more information, see `Inviting Member Accounts to a Behavior Graph `__ in the *Amazon Detective Administration Guide*. diff -Nru awscli-1.16.301/awscli/examples/detective/delete-graph.rst awscli-1.17.14/awscli/examples/detective/delete-graph.rst --- awscli-1.16.301/awscli/examples/detective/delete-graph.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/detective/delete-graph.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,10 @@ +**To disable Detective and delete the behavior graph** + +The following ``delete-graph`` example disables Detective and deletes the specified behavior graph. :: + + aws detective delete-graph \ + --graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 + +This command produces no output. + +For more information, see `Disabling Amazon Detective `__ in the *Amazon Detective Administration Guide*. diff -Nru awscli-1.16.301/awscli/examples/detective/delete-members.rst awscli-1.17.14/awscli/examples/detective/delete-members.rst --- awscli-1.16.301/awscli/examples/detective/delete-members.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/detective/delete-members.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,16 @@ +**To remove member accounts from a behavior graph** + +The following ``delete-members`` example removes two member accounts from the specified behavior graph. :: + + aws detective delete-members \ + --account-ids 444455556666 123456789012 \ + --graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 + +Output:: + + { + "AccountIds": [ "444455556666", "123456789012" ], + "UnprocessedAccounts": [ ] + } + +For more information, see `Removing Member Accounts from a Behavior Graph `__ in the *Amazon Detective Administration Guide*. diff -Nru awscli-1.16.301/awscli/examples/detective/disassociate-membership.rst awscli-1.17.14/awscli/examples/detective/disassociate-membership.rst --- awscli-1.16.301/awscli/examples/detective/disassociate-membership.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/detective/disassociate-membership.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,8 @@ +**To resign membership from a behavior graph** + +The following ``disassociate-membership`` example removes the AWS account that runs the command from the specified behavior graph. :: + + aws detective disassociate-membership \ + --graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 + +For more information, see `Removing Your Account from a Behavior Graph `__ in the *Amazon Detective Administration Guide*. diff -Nru awscli-1.16.301/awscli/examples/detective/get-members.rst awscli-1.17.14/awscli/examples/detective/get-members.rst --- awscli-1.16.301/awscli/examples/detective/get-members.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/detective/get-members.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,35 @@ +**To retrieve information about selected behavior graph member accounts** + +The following ``get-members`` example displays details about two member accounts in the specified behavior graph. :: + + aws detective get-members \ + --account-ids 444455556666 123456789012 \ + --graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 + +Output:: + + { + "MemberDetails": [ + { + "AccountId": "444455556666", + "EmailAddress": "mmajor@example.com", + "GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:123412341234", + "InvitedTime": 1579826107000, + "MasterId": "111122223333", + "Status": "INVITED", + "UpdatedTime": 1579826107000 + } + { + "AccountId": "123456789012", + "EmailAddress": "jstiles@example.com", + "GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:123412341234", + "InvitedTime": 1579826107000, + "MasterId": "111122223333", + "Status": "INVITED", + "UpdatedTime": 1579826107000 + } + ], + "UnprocessedAccounts": [ ] + } + +For more information, see `Viewing the List of Accounts in a Behavior Graph `__ in the *Amazon Detective Administration Guide*. diff -Nru awscli-1.16.301/awscli/examples/detective/list-graphs.rst awscli-1.17.14/awscli/examples/detective/list-graphs.rst --- awscli-1.16.301/awscli/examples/detective/list-graphs.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/detective/list-graphs.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,16 @@ +**To view a list of behavior graphs that your account is the master for** + +The following ``list-graphs`` example retrieves the behavior graphs that the calling account is the master for within the current Region. :: + + aws detective list-graphs + +Output:: + + { + "GraphList": [ + { + "Arn": "arn:aws:detective:us-east-1:111122223333:graph:123412341234", + "CreatedTime": 1579736111000 + } + ] + } diff -Nru awscli-1.16.301/awscli/examples/detective/list-invitations.rst awscli-1.17.14/awscli/examples/detective/list-invitations.rst --- awscli-1.16.301/awscli/examples/detective/list-invitations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/detective/list-invitations.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,23 @@ +**To view a list of behavior graphs that an account is a member of or is invited to** + +The following ``list-invitations`` example retrieves the behavior graphs that the calling account has been invited to. The results include only open and accepted invitations. They do not include rejected invitations or removed memberships. :: + + aws detective list-invitations + +Output:: + + { + "Invitations": [ + { + "AccountId": "444455556666", + "EmailAddress": "mmajor@example.com", + "GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:123412341234", + "InvitedTime": 1579826107000, + "MasterId": "111122223333", + "Status": "INVITED", + "UpdatedTime": 1579826107000 + } + ] + } + +For more information, see `Viewing Your List of Behavior Graph Invitations `__ in the *Amazon Detective Administration Guide*. \ No newline at end of file diff -Nru awscli-1.16.301/awscli/examples/detective/list-members.rst awscli-1.17.14/awscli/examples/detective/list-members.rst --- awscli-1.16.301/awscli/examples/detective/list-members.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/detective/list-members.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,33 @@ +**To list the member accounts in a behavior graph** + +The following ``list-members`` example retrieves the invited and enabled member accounts for the specified behavior graph. The results do not include member accounts that were removed. :: + + aws detective list-members \ + --graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 + +Output:: + + { + "MemberDetails": [ + { + "AccountId": "444455556666", + "EmailAddress": "mmajor@example.com", + "GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:123412341234", + "InvitedTime": 1579826107000, + "MasterId": "111122223333", + "Status": "INVITED", + "UpdatedTime": 1579826107000 + }, + { + "AccountId": "123456789012", + "EmailAddress": "jstiles@example.com", + "GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:123412341234", + "InvitedTime": 1579826107000, + "MasterId": "111122223333", + "Status": "ENABLED", + "UpdatedTime": 1579973711000 + } + ] + } + +For more information, see `Viewing the List of Accounts in a Behavior Graph `__ in the *Amazon Detective Administration Guide*. diff -Nru awscli-1.16.301/awscli/examples/detective/reject-invitation.rst awscli-1.17.14/awscli/examples/detective/reject-invitation.rst --- awscli-1.16.301/awscli/examples/detective/reject-invitation.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/detective/reject-invitation.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,10 @@ +**To reject an invitation to become a member account in a behavior graph** + +The following ``reject-invitation`` example rejects an invitation to become a member account in the specified behavior graph. :: + + aws detective reject-invitation \ + --graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 + +This command produces no output. + +For more information, see `Responding to a Behavior Graph Invitation `__ in the *Amazon Detective Administration Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/batch-get-item.rst awscli-1.17.14/awscli/examples/dynamodb/batch-get-item.rst --- awscli-1.16.301/awscli/examples/dynamodb/batch-get-item.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/batch-get-item.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,54 +1,55 @@ **To retrieve multiple items from a table** -This example reads multiple items from the *MusicCollection* table using a batch of three GetItem requests. Only the *AlbumTitle* attribute is returned. +The following ``batch-get-items`` example reads multiple items from the ``MusicCollection`` table using a batch of three ``GetItem`` requests. The command returns only the ``AlbumTitle`` attribute. :: -Command:: + aws dynamodb batch-get-item \ + --request-items file://request-items.json - aws dynamodb batch-get-item --request-items file://request-items.json +Contents of ``request-items.json``:: -The arguments for ``--request-items`` are stored in a JSON file, ``request-items.json``. Here are the contents of that file:: - - { - "MusicCollection": { - "Keys": [ - { - "Artist": {"S": "No One You Know"}, - "SongTitle": {"S": "Call Me Today"} - }, - { - "Artist": {"S": "Acme Band"}, - "SongTitle": {"S": "Happy Day"} - }, - { - "Artist": {"S": "No One You Know"}, - "SongTitle": {"S": "Scared of My Shadow"} - } - ], - "ProjectionExpression":"AlbumTitle" - } - } + { + "MusicCollection": { + "Keys": [ + { + "Artist": {"S": "No One You Know"}, + "SongTitle": {"S": "Call Me Today"} + }, + { + "Artist": {"S": "Acme Band"}, + "SongTitle": {"S": "Happy Day"} + }, + { + "Artist": {"S": "No One You Know"}, + "SongTitle": {"S": "Scared of My Shadow"} + } + ], + "ProjectionExpression":"AlbumTitle" + } + } Output:: - { - "UnprocessedKeys": {}, - "Responses": { - "MusicCollection": [ - { - "AlbumTitle": { - "S": "Somewhat Famous" - } - }, - { - "AlbumTitle": { - "S": "Blue Sky Blues" - } - }, - { - "AlbumTitle": { - "S": "Louder Than Ever" - } - } - ] - } - } + { + "UnprocessedKeys": {}, + "Responses": { + "MusicCollection": [ + { + "AlbumTitle": { + "S": "Somewhat Famous" + } + }, + { + "AlbumTitle": { + "S": "Blue Sky Blues" + } + }, + { + "AlbumTitle": { + "S": "Louder Than Ever" + } + } + ] + } + } + +For more information, see `Batch Operations `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/batch-write-item.rst awscli-1.17.14/awscli/examples/dynamodb/batch-write-item.rst --- awscli-1.16.301/awscli/examples/dynamodb/batch-write-item.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/batch-write-item.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,47 +1,48 @@ **To add multiple items to a table** -This example adds three new items to the *MusicCollection* table using a batch of three PutItem requests. +The following ``batch-write-item`` example adds three new items to the ``MusicCollection`` table using a batch of three ``PutItem`` requests. :: -Command:: + aws dynamodb batch-write-item \ + --request-items file://request-items.json - aws dynamodb batch-write-item --request-items file://request-items.json +Contents of ``request-items.json``:: -The arguments for ``--request-items`` are stored in a JSON file, ``request-items.json``. Here are the contents of that file:: - - { - "MusicCollection": [ - { - "PutRequest": { - "Item": { - "Artist": {"S": "No One You Know"}, - "SongTitle": {"S": "Call Me Today"}, - "AlbumTitle": {"S": "Somewhat Famous"} - } - } - }, - { - "PutRequest": { - "Item": { - "Artist": {"S": "Acme Band"}, - "SongTitle": {"S": "Happy Day"}, - "AlbumTitle": {"S": "Songs About Life"} - } - } - }, - { - "PutRequest": { - "Item": { - "Artist": {"S": "No One You Know"}, - "SongTitle": {"S": "Scared of My Shadow"}, - "AlbumTitle": {"S": "Blue Sky Blues"} - } - } - } - ] - } + { + "MusicCollection": [ + { + "PutRequest": { + "Item": { + "Artist": {"S": "No One You Know"}, + "SongTitle": {"S": "Call Me Today"}, + "AlbumTitle": {"S": "Somewhat Famous"} + } + } + }, + { + "PutRequest": { + "Item": { + "Artist": {"S": "Acme Band"}, + "SongTitle": {"S": "Happy Day"}, + "AlbumTitle": {"S": "Songs About Life"} + } + } + }, + { + "PutRequest": { + "Item": { + "Artist": {"S": "No One You Know"}, + "SongTitle": {"S": "Scared of My Shadow"}, + "AlbumTitle": {"S": "Blue Sky Blues"} + } + } + } + ] + } Output:: - { - "UnprocessedItems": {} - } + { + "UnprocessedItems": {} + } + +For more information, see `Batch Operations `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/create-backup.rst awscli-1.17.14/awscli/examples/dynamodb/create-backup.rst --- awscli-1.16.301/awscli/examples/dynamodb/create-backup.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/create-backup.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,22 @@ +**To create a backup for an existing DynamoDB table** + +The following ``create-backup`` example creates a backup of the ``MusicCollection`` table. :: + + aws dynamodb create-backup \ + --table-name MusicCollection \ + --backup-name MusicCollectionBackup + +Output:: + + { + "BackupDetails": { + "BackupArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/backup/01576616366715-b4e58d3a", + "BackupName": "MusicCollectionBackup", + "BackupSizeBytes": 0, + "BackupStatus": "CREATING", + "BackupType": "USER", + "BackupCreationDateTime": 1576616366.715 + } + } + +For more information, see `On-Demand Backup and Restore for DynamoDB `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/create-global-table.rst awscli-1.17.14/awscli/examples/dynamodb/create-global-table.rst --- awscli-1.16.301/awscli/examples/dynamodb/create-global-table.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/create-global-table.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,29 @@ +**To create a global table** + +The following ``create-global-table`` example creates a global table from two identical tables in the specified, separate AWS Regions. :: + + aws dynamodb create-global-table \ + --global-table-name MusicCollection \ + --replication-group RegionName=us-east-2 RegionName=us-east-1 \ + --region us-east-2 + +Output:: + + { + "GlobalTableDescription": { + "ReplicationGroup": [ + { + "RegionName": "us-east-2" + }, + { + "RegionName": "us-east-1" + } + ], + "GlobalTableArn": "arn:aws:dynamodb::123456789012:global-table/MusicCollection", + "CreationDateTime": 1576625818.532, + "GlobalTableStatus": "CREATING", + "GlobalTableName": "MusicCollection" + } + } + +For more information, see `DynamoDB Global Tables `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/create-table.rst awscli-1.17.14/awscli/examples/dynamodb/create-table.rst --- awscli-1.16.301/awscli/examples/dynamodb/create-table.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/create-table.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,44 +1,48 @@ **To create a table** -This example creates a table named *MusicCollection*. +The following ``create-table`` example uses the specified attributes and key schema to create a table named ``MusicCollection``. :: -Command:: - - aws dynamodb create-table --table-name MusicCollection --attribute-definitions AttributeName=Artist,AttributeType=S AttributeName=SongTitle,AttributeType=S --key-schema AttributeName=Artist,KeyType=HASH AttributeName=SongTitle,KeyType=RANGE --provisioned-throughput ReadCapacityUnits=5,WriteCapacityUnits=5 + aws dynamodb create-table \ + --table-name MusicCollection \ + --attribute-definitions AttributeName=Artist,AttributeType=S AttributeName=SongTitle,AttributeType=S \ + --key-schema AttributeName=Artist,KeyType=HASH AttributeName=SongTitle,KeyType=RANGE \ + --provisioned-throughput ReadCapacityUnits=5,WriteCapacityUnits=5 Output:: - { - "TableDescription": { - "AttributeDefinitions": [ - { - "AttributeName": "Artist", - "AttributeType": "S" - }, - { - "AttributeName": "SongTitle", - "AttributeType": "S" - } - ], - "ProvisionedThroughput": { - "NumberOfDecreasesToday": 0, - "WriteCapacityUnits": 5, - "ReadCapacityUnits": 5 - }, - "TableSizeBytes": 0, - "TableName": "MusicCollection", - "TableStatus": "CREATING", - "KeySchema": [ - { - "KeyType": "HASH", - "AttributeName": "Artist" - }, - { - "KeyType": "RANGE", - "AttributeName": "SongTitle" - } - ], - "ItemCount": 0, - "CreationDateTime": 1421866952.062 - } - } + { + "TableDescription": { + "AttributeDefinitions": [ + { + "AttributeName": "Artist", + "AttributeType": "S" + }, + { + "AttributeName": "SongTitle", + "AttributeType": "S" + } + ], + "ProvisionedThroughput": { + "NumberOfDecreasesToday": 0, + "WriteCapacityUnits": 5, + "ReadCapacityUnits": 5 + }, + "TableSizeBytes": 0, + "TableName": "MusicCollection", + "TableStatus": "CREATING", + "KeySchema": [ + { + "KeyType": "HASH", + "AttributeName": "Artist" + }, + { + "KeyType": "RANGE", + "AttributeName": "SongTitle" + } + ], + "ItemCount": 0, + "CreationDateTime": 1421866952.062 + } + } + +For more information, see `Basic Operations for Tables `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/delete-backup.rst awscli-1.17.14/awscli/examples/dynamodb/delete-backup.rst --- awscli-1.16.301/awscli/examples/dynamodb/delete-backup.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/delete-backup.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,47 @@ +**To delete an existing DynamoDB backup** + +The following ``delete-backup`` example deletes the specified existing backup. :: + + aws dynamodb delete-backup \ + --backup-arn arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/backup/01576616366715-b4e58d3a + +Output:: + + { + "BackupDescription": { + "BackupDetails": { + "BackupArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/backup/01576616366715-b4e58d3a", + "BackupName": "MusicCollectionBackup", + "BackupSizeBytes": 0, + "BackupStatus": "DELETED", + "BackupType": "USER", + "BackupCreationDateTime": 1576616366.715 + }, + "SourceTableDetails": { + "TableName": "MusicCollection", + "TableId": "b0c04bcc-309b-4352-b2ae-9088af169fe2", + "TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection", + "TableSizeBytes": 0, + "KeySchema": [ + { + "AttributeName": "Artist", + "KeyType": "HASH" + }, + { + "AttributeName": "SongTitle", + "KeyType": "RANGE" + } + ], + "TableCreationDateTime": 1576615228.571, + "ProvisionedThroughput": { + "ReadCapacityUnits": 5, + "WriteCapacityUnits": 5 + }, + "ItemCount": 0, + "BillingMode": "PROVISIONED" + }, + "SourceTableFeatureDetails": {} + } + } + +For more information, see `On-Demand Backup and Restore for DynamoDB `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/delete-item.rst awscli-1.17.14/awscli/examples/dynamodb/delete-item.rst --- awscli-1.16.301/awscli/examples/dynamodb/delete-item.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/delete-item.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,23 +1,25 @@ **To delete an item** -This example deletes an item from the *MusicCollection* table. +The following ``delete-item`` example deletes an item from the ``MusicCollection`` table. :: -Command:: - - aws dynamodb delete-item --table-name MusicCollection --key file://key.json - -The arguments for ``--key`` are stored in a JSON file, ``key.json``. Here are the contents of that file:: - - { - "Artist": {"S": "No One You Know"}, - "SongTitle": {"S": "Scared of My Shadow"} - } + aws dynamodb delete-item \ + --table-name MusicCollection \ + --key file://key.json + +Contents of ``key.json``:: + + { + "Artist": {"S": "No One You Know"}, + "SongTitle": {"S": "Scared of My Shadow"} + } Output:: - { - "ConsumedCapacity": { - "CapacityUnits": 1.0, - "TableName": "MusicCollection" - } - } + { + "ConsumedCapacity": { + "CapacityUnits": 1.0, + "TableName": "MusicCollection" + } + } + +For more information, see `Writing an Item `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/delete-table.rst awscli-1.17.14/awscli/examples/dynamodb/delete-table.rst --- awscli-1.16.301/awscli/examples/dynamodb/delete-table.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/delete-table.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,23 +1,24 @@ **To delete a table** -This example deletes the *MusicCollection* table. +The following ``delete-table`` example deletes the ``MusicCollection`` table. :: -Command:: - - aws dynamodb delete-table --table-name MusicCollection + aws dynamodb delete-table \ + --table-name MusicCollection Output:: - { - "TableDescription": { - "TableStatus": "DELETING", - "TableSizeBytes": 0, - "ItemCount": 0, - "TableName": "MusicCollection", - "ProvisionedThroughput": { - "NumberOfDecreasesToday": 0, - "WriteCapacityUnits": 5, - "ReadCapacityUnits": 5 - } - } - } + { + "TableDescription": { + "TableStatus": "DELETING", + "TableSizeBytes": 0, + "ItemCount": 0, + "TableName": "MusicCollection", + "ProvisionedThroughput": { + "NumberOfDecreasesToday": 0, + "WriteCapacityUnits": 5, + "ReadCapacityUnits": 5 + } + } + } + +For more information, see `Deleting a Table `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/describe-backup.rst awscli-1.17.14/awscli/examples/dynamodb/describe-backup.rst --- awscli-1.16.301/awscli/examples/dynamodb/describe-backup.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/describe-backup.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,47 @@ +**To get information about an existing backup of a table** + +The following ``describe-backup`` example displays information about the specified existing backup. :: + + aws dynamodb describe-backup \ + --backup-arn arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/backup/01576616366715-b4e58d3a + +Output:: + + { + "BackupDescription": { + "BackupDetails": { + "BackupArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/backup/01576616366715-b4e58d3a", + "BackupName": "MusicCollectionBackup", + "BackupSizeBytes": 0, + "BackupStatus": "AVAILABLE", + "BackupType": "USER", + "BackupCreationDateTime": 1576616366.715 + }, + "SourceTableDetails": { + "TableName": "MusicCollection", + "TableId": "b0c04bcc-309b-4352-b2ae-9088af169fe2", + "TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection", + "TableSizeBytes": 0, + "KeySchema": [ + { + "AttributeName": "Artist", + "KeyType": "HASH" + }, + { + "AttributeName": "SongTitle", + "KeyType": "RANGE" + } + ], + "TableCreationDateTime": 1576615228.571, + "ProvisionedThroughput": { + "ReadCapacityUnits": 5, + "WriteCapacityUnits": 5 + }, + "ItemCount": 0, + "BillingMode": "PROVISIONED" + }, + "SourceTableFeatureDetails": {} + } + } + +For more information, see `On-Demand Backup and Restore for DynamoDB `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/describe-continuous-backups.rst awscli-1.17.14/awscli/examples/dynamodb/describe-continuous-backups.rst --- awscli-1.16.301/awscli/examples/dynamodb/describe-continuous-backups.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/describe-continuous-backups.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,19 @@ +**To get information about continuous backups for a DynamoDB table** + +The following ``describe-continuous-backups`` example displays details about the continuous backup settings for the ``MusicCollection`` table. :: + + aws dynamodb describe-continuous-backups \ + --table-name MusicCollection + +Output:: + + { + "ContinuousBackupsDescription": { + "ContinuousBackupsStatus": "ENABLED", + "PointInTimeRecoveryDescription": { + "PointInTimeRecoveryStatus": "DISABLED" + } + } + } + +For more information, see `Point-in-Time Recovery for DynamoDB `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/describe-contributor-insights.rst awscli-1.17.14/awscli/examples/dynamodb/describe-contributor-insights.rst --- awscli-1.16.301/awscli/examples/dynamodb/describe-contributor-insights.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/describe-contributor-insights.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,22 @@ +**To view Contributor Insights settings for a DynamoDB table** + +The following ``describe-contributor-insights`` example displays the Contributor Insights settings for the ``MusicCollection`` table. :: + + aws dynamodb describe-contributor-insights \ + --table-name MusicCollection + +Output:: + + { + "TableName": "MusicCollection", + "ContributorInsightsRuleList": [ + "DynamoDBContributorInsights-PKC-MusicCollection-1576629651520", + "DynamoDBContributorInsights-SKC-MusicCollection-1576629651520", + "DynamoDBContributorInsights-PKT-MusicCollection-1576629651520", + "DynamoDBContributorInsights-SKT-MusicCollection-1576629651520" + ], + "ContributorInsightsStatus": "ENABLED", + "LastUpdateDateTime": 1576629654.78 + } + +For more information, see `Analyzing Data Access Using CloudWatch Contributor Insights for DynamoDB `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/describe-endpoints.rst awscli-1.17.14/awscli/examples/dynamodb/describe-endpoints.rst --- awscli-1.16.301/awscli/examples/dynamodb/describe-endpoints.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/describe-endpoints.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,18 @@ +**To view regional endpoint information** + +The following ``describe-endpoints`` example displays details about the endpoints for the current AWS Region. :: + + aws dynamodb describe-endpoints + +Output:: + + { + "Endpoints": [ + { + "Address": "dynamodb.us-west-2.amazonaws.com", + "CachePeriodInMinutes": 1440 + } + ] + } + +For more information, see `Amazon DynamoDB Endpoints and Quotas `__ in the *AWS General Reference*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/describe-global-table.rst awscli-1.17.14/awscli/examples/dynamodb/describe-global-table.rst --- awscli-1.16.301/awscli/examples/dynamodb/describe-global-table.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/describe-global-table.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,27 @@ +**To display information about a DynamoDB global table** + +The following ``describe-global-table`` example displays details about the ``MusicCollection`` global table. :: + + aws dynamodb describe-global-table \ + --global-table-name MusicCollection + +Output:: + + { + "GlobalTableDescription": { + "ReplicationGroup": [ + { + "RegionName": "us-east-2" + }, + { + "RegionName": "us-east-1" + } + ], + "GlobalTableArn": "arn:aws:dynamodb::123456789012:global-table/MusicCollection", + "CreationDateTime": 1576625818.532, + "GlobalTableStatus": "ACTIVE", + "GlobalTableName": "MusicCollection" + } + } + +For more information, see `DynamoDB Global Tables `__ in the *Amazon DynamoDB Developer Guide*. \ No newline at end of file diff -Nru awscli-1.16.301/awscli/examples/dynamodb/describe-global-table-settings.rst awscli-1.17.14/awscli/examples/dynamodb/describe-global-table-settings.rst --- awscli-1.16.301/awscli/examples/dynamodb/describe-global-table-settings.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/describe-global-table-settings.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,40 @@ +**To get information about a DynamoDB global table's settings** + +The following ``describe-global-table-settings`` example displays the settings for the ``MusicCollection`` global table. :: + + aws dynamodb describe-global-table-settings \ + --global-table-name MusicCollection + +Output:: + + { + "GlobalTableName": "MusicCollection", + "ReplicaSettings": [ + { + "RegionName": "us-east-1", + "ReplicaStatus": "ACTIVE", + "ReplicaProvisionedReadCapacityUnits": 10, + "ReplicaProvisionedReadCapacityAutoScalingSettings": { + "AutoScalingDisabled": true + }, + "ReplicaProvisionedWriteCapacityUnits": 5, + "ReplicaProvisionedWriteCapacityAutoScalingSettings": { + "AutoScalingDisabled": true + } + }, + { + "RegionName": "us-east-2", + "ReplicaStatus": "ACTIVE", + "ReplicaProvisionedReadCapacityUnits": 10, + "ReplicaProvisionedReadCapacityAutoScalingSettings": { + "AutoScalingDisabled": true + }, + "ReplicaProvisionedWriteCapacityUnits": 5, + "ReplicaProvisionedWriteCapacityAutoScalingSettings": { + "AutoScalingDisabled": true + } + } + ] + } + +For more information, see `DynamoDB Global Tables `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/describe-limits.rst awscli-1.17.14/awscli/examples/dynamodb/describe-limits.rst --- awscli-1.16.301/awscli/examples/dynamodb/describe-limits.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/describe-limits.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,16 @@ +**To view provisioned-capacity limits** + +The following ``describe-limits`` example displays provisioned-capacity limits for your account in the current AWS Region. :: + + aws dynamodb describe-limits + +Output:: + + { + "AccountMaxReadCapacityUnits": 80000, + "AccountMaxWriteCapacityUnits": 80000, + "TableMaxReadCapacityUnits": 40000, + "TableMaxWriteCapacityUnits": 40000 + } + +For more information, see `Limits in DynamoDB `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/describe-table-replica-auto-scaling.rst awscli-1.17.14/awscli/examples/dynamodb/describe-table-replica-auto-scaling.rst --- awscli-1.16.301/awscli/examples/dynamodb/describe-table-replica-auto-scaling.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/describe-table-replica-auto-scaling.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,81 @@ +**To view auto scaling settings across replicas of a global table** + +The following ``describe-table-replica-auto-scaling`` example displays auto scaling settings across replicas of the ``MusicCollection`` global table. :: + + aws dynamodb describe-table-replica-auto-scaling \ + --table-name MusicCollection + +Output:: + + { + "TableAutoScalingDescription": { + "TableName": "MusicCollection", + "TableStatus": "ACTIVE", + "Replicas": [ + { + "RegionName": "us-east-1", + "GlobalSecondaryIndexes": [], + "ReplicaProvisionedReadCapacityAutoScalingSettings": { + "MinimumUnits": 5, + "MaximumUnits": 40000, + "AutoScalingRoleArn": "arn:aws:iam::123456789012:role/aws-service-role/dynamodb.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_DynamoDBTable", + "ScalingPolicies": [ + { + "PolicyName": "DynamoDBReadCapacityUtilization:table/MusicCollection", + "TargetTrackingScalingPolicyConfiguration": { + "TargetValue": 70.0 + } + } + ] + }, + "ReplicaProvisionedWriteCapacityAutoScalingSettings": { + "MinimumUnits": 5, + "MaximumUnits": 40000, + "AutoScalingRoleArn": "arn:aws:iam::123456789012:role/aws-service-role/dynamodb.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_DynamoDBTable", + "ScalingPolicies": [ + { + "PolicyName": "DynamoDBWriteCapacityUtilization:table/MusicCollection", + "TargetTrackingScalingPolicyConfiguration": { + "TargetValue": 70.0 + } + } + ] + }, + "ReplicaStatus": "ACTIVE" + }, + { + "RegionName": "us-east-2", + "GlobalSecondaryIndexes": [], + "ReplicaProvisionedReadCapacityAutoScalingSettings": { + "MinimumUnits": 5, + "MaximumUnits": 40000, + "AutoScalingRoleArn": "arn:aws:iam::123456789012:role/aws-service-role/dynamodb.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_DynamoDBTable", + "ScalingPolicies": [ + { + "PolicyName": "DynamoDBReadCapacityUtilization:table/MusicCollection", + "TargetTrackingScalingPolicyConfiguration": { + "TargetValue": 70.0 + } + } + ] + }, + "ReplicaProvisionedWriteCapacityAutoScalingSettings": { + "MinimumUnits": 5, + "MaximumUnits": 40000, + "AutoScalingRoleArn": "arn:aws:iam::123456789012:role/aws-service-role/dynamodb.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_DynamoDBTable", + "ScalingPolicies": [ + { + "PolicyName": "DynamoDBWriteCapacityUtilization:table/MusicCollection", + "TargetTrackingScalingPolicyConfiguration": { + "TargetValue": 70.0 + } + } + ] + }, + "ReplicaStatus": "ACTIVE" + } + ] + } + } + +For more information, see `DynamoDB Global Tables `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/describe-table.rst awscli-1.17.14/awscli/examples/dynamodb/describe-table.rst --- awscli-1.16.301/awscli/examples/dynamodb/describe-table.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/describe-table.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,44 +1,45 @@ **To describe a table** -This example describes the *MusicCollection* table. +The following ``describe-table`` example describes the ``MusicCollection`` table. :: -Command:: - - aws dynamodb describe-table --table-name MusicCollection + aws dynamodb describe-table \ + --table-name MusicCollection Output:: - { - "Table": { - "AttributeDefinitions": [ - { - "AttributeName": "Artist", - "AttributeType": "S" - }, - { - "AttributeName": "SongTitle", - "AttributeType": "S" - } - ], - "ProvisionedThroughput": { - "NumberOfDecreasesToday": 0, - "WriteCapacityUnits": 5, - "ReadCapacityUnits": 5 - }, - "TableSizeBytes": 0, - "TableName": "MusicCollection", - "TableStatus": "ACTIVE", - "KeySchema": [ - { - "KeyType": "HASH", - "AttributeName": "Artist" - }, - { - "KeyType": "RANGE", - "AttributeName": "SongTitle" - } - ], - "ItemCount": 0, - "CreationDateTime": 1421866952.062 - } - } + { + "Table": { + "AttributeDefinitions": [ + { + "AttributeName": "Artist", + "AttributeType": "S" + }, + { + "AttributeName": "SongTitle", + "AttributeType": "S" + } + ], + "ProvisionedThroughput": { + "NumberOfDecreasesToday": 0, + "WriteCapacityUnits": 5, + "ReadCapacityUnits": 5 + }, + "TableSizeBytes": 0, + "TableName": "MusicCollection", + "TableStatus": "ACTIVE", + "KeySchema": [ + { + "KeyType": "HASH", + "AttributeName": "Artist" + }, + { + "KeyType": "RANGE", + "AttributeName": "SongTitle" + } + ], + "ItemCount": 0, + "CreationDateTime": 1421866952.062 + } + } + +For more information, see `Describing a Table `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/describe-time-to-live.rst awscli-1.17.14/awscli/examples/dynamodb/describe-time-to-live.rst --- awscli-1.16.301/awscli/examples/dynamodb/describe-time-to-live.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/describe-time-to-live.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,17 @@ +**To view Time to Live settings for a table** + +The following ``describe-time-to-live`` example displays Time to Live settings for the ``MusicCollection`` table. :: + + aws dynamodb describe-time-to-live \ + --table-name MusicCollection + +Output:: + + { + "TimeToLiveDescription": { + "TimeToLiveStatus": "ENABLED", + "AttributeName": "ttl" + } + } + +For more information, see `Time to Live `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/get-item.rst awscli-1.17.14/awscli/examples/dynamodb/get-item.rst --- awscli-1.16.301/awscli/examples/dynamodb/get-item.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/get-item.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,32 +1,32 @@ **To read an item in a table** -This example retrieves an item from the *MusicCollection* table. The table has a hash-and-range primary key (*Artist* and *SongTitle*), so you must specify both of these attributes. - - -Command:: - - aws dynamodb get-item --table-name MusicCollection --key file://key.json - -The arguments for ``--key`` are stored in a JSON file, ``key.json``. Here are the contents of that file:: - - { - "Artist": {"S": "Acme Band"}, - "SongTitle": {"S": "Happy Day"} - } +The following ``get-item`` example retrieves an item from the ``MusicCollection`` table. The table has a hash-and-range primary key (``Artist`` and ``SongTitle``), so you must specify both of these attributes. :: + aws dynamodb get-item \ + --table-name MusicCollection \ + --key file://key.json + +Contents of ``key.json``:: + + { + "Artist": {"S": "Acme Band"}, + "SongTitle": {"S": "Happy Day"} + } Output:: - { - "Item": { - "AlbumTitle": { - "S": "Songs About Life" - }, - "SongTitle": { - "S": "Happy Day" - }, - "Artist": { - "S": "Acme Band" - } - } - } + { + "Item": { + "AlbumTitle": { + "S": "Songs About Life" + }, + "SongTitle": { + "S": "Happy Day" + }, + "Artist": { + "S": "Acme Band" + } + } + } + +For more information, see `Reading an Item `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/list-backups.rst awscli-1.17.14/awscli/examples/dynamodb/list-backups.rst --- awscli-1.16.301/awscli/examples/dynamodb/list-backups.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/list-backups.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,25 @@ +**To list existing DynamoDB backups** + +The following ``list-backups`` example lists all of your existing backups. :: + + aws dynamodb list-backups + +Output:: + + { + "BackupSummaries": [ + { + "TableName": "MusicCollection", + "TableId": "b0c04bcc-309b-4352-b2ae-9088af169fe2", + "TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection", + "BackupArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/backup/01576616366715-b4e58d3a", + "BackupName": "MusicCollectionBackup", + "BackupCreationDateTime": 1576616366.715, + "BackupStatus": "AVAILABLE", + "BackupType": "USER", + "BackupSizeBytes": 0 + } + ] + } + +For more information, see `On-Demand Backup and Restore for DynamoDB `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/list-contributor-insights.rst awscli-1.17.14/awscli/examples/dynamodb/list-contributor-insights.rst --- awscli-1.16.301/awscli/examples/dynamodb/list-contributor-insights.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/list-contributor-insights.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,18 @@ +**To view a list of Contributor Insights summaries** + +The following ``list-contributor-insights`` example displays a list of Contributor Insights summaries. :: + + aws dynamodb list-contributor-insights + +Output:: + + { + "ContributorInsightsSummaries": [ + { + "TableName": "MusicCollection", + "ContributorInsightsStatus": "ENABLED" + } + ] + } + +For more information, see `Analyzing Data Access Using CloudWatch Contributor Insights for DynamoDB `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/list-global-tables.rst awscli-1.17.14/awscli/examples/dynamodb/list-global-tables.rst --- awscli-1.16.301/awscli/examples/dynamodb/list-global-tables.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/list-global-tables.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,25 @@ +**To list existing DynamoDB global tables** + +The following ``list-global-tables`` example lists all of your existing global tables. :: + + aws dynamodb list-global-tables + +Output:: + + { + "GlobalTables": [ + { + "GlobalTableName": "MusicCollection", + "ReplicationGroup": [ + { + "RegionName": "us-east-2" + }, + { + "RegionName": "us-east-1" + } + ] + } + ] + } + +For more information, see `DynamoDB Global Tables `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/list-tables.rst awscli-1.17.14/awscli/examples/dynamodb/list-tables.rst --- awscli-1.16.301/awscli/examples/dynamodb/list-tables.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/list-tables.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,18 +1,18 @@ **To list tables** -This example lists all of the tables associated with the current AWS account and endpoint +The following ``list-tables`` example lists all of the tables associated with the current AWS account and Region. :: -Command:: - - aws dynamodb list-tables + aws dynamodb list-tables Output:: - { - "TableNames": [ - "Forum", - "ProductCatalog", - "Reply", - "Thread", - ] - } + { + "TableNames": [ + "Forum", + "ProductCatalog", + "Reply", + "Thread", + ] + } + +For more information, see `Listing Table Names `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/list-tags-of-resource.rst awscli-1.17.14/awscli/examples/dynamodb/list-tags-of-resource.rst --- awscli-1.16.301/awscli/examples/dynamodb/list-tags-of-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/list-tags-of-resource.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,19 @@ +**To list tags of a DynamoDB resource** + +The following ``list-tags-of-resource`` example displays tags for the ``MusicCollection`` table. :: + + aws dynamodb list-tags-of-resource \ + --resource-arn arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection + +Output:: + + { + "Tags": [ + { + "Key": "Owner", + "Value": "blueTeam" + } + ] + } + +For more information, see `Tagging for DynamoDB `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/put-item.rst awscli-1.17.14/awscli/examples/dynamodb/put-item.rst --- awscli-1.16.301/awscli/examples/dynamodb/put-item.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/put-item.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,40 +1,42 @@ -**To add an item to a table** +**Example1: To add an item to a table** -This example adds a new item to the *MusicCollection* table. +The following ``put-item`` example adds a new item to the *MusicCollection* table. :: -Command:: - - aws dynamodb put-item --table-name MusicCollection --item file://item.json --return-consumed-capacity TOTAL - -The arguments for ``--item`` are stored in a JSON file, ``item.json``. Here are the contents of that file:: - - { - "Artist": {"S": "No One You Know"}, - "SongTitle": {"S": "Call Me Today"}, - "AlbumTitle": {"S": "Somewhat Famous"} - } + aws dynamodb put-item \ + --table-name MusicCollection \ + --item file://item.json \ + --return-consumed-capacity TOTAL + +Contents of ``item.json``:: + + { + "Artist": {"S": "No One You Know"}, + "SongTitle": {"S": "Call Me Today"}, + "AlbumTitle": {"S": "Somewhat Famous"} + } Output:: - { - "ConsumedCapacity": { - "CapacityUnits": 1.0, - "TableName": "MusicCollection" - } - } + { + "ConsumedCapacity": { + "CapacityUnits": 1.0, + "TableName": "MusicCollection" + } + } +For more information, see `Writing an Item `__ in the *Amazon DynamoDB Developer Guide*. -**Conditional Expressions** +**Example2: To add an item to a table conditionally** -This example shows how to perform a one-line conditional expression operation. This put-item call to the table *MusicCollection* table will only succeed if the artist "Obscure Indie Band" does not exist in the table. +The following ``put-item`` example adds a new item to the ``MusicCollection`` table only if the artist "Obscure Indie Band" does not already exist in the table. :: -Command:: + aws dynamodb put-item \ + --table-name MusicCollection \ + --item '{"Artist": {"S": "Obscure Indie Band"}}' \ + --condition-expression "attribute_not_exists(Artist)" - aws dynamodb put-item --table-name MusicCollection --item '{"Artist": {"S": "Obscure Indie Band"}}' --condition-expression "attribute_not_exists(Artist)" +If the key already exists, you should see the following output:: + A client error (ConditionalCheckFailedException) occurred when calling the PutItem operation: The conditional request failed. -If the key already exists, you should see: - -Output:: - - A client error (ConditionalCheckFailedException) occurred when calling the PutItem operation: The conditional request failed +For more information, see `Condition Expressions `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/query.rst awscli-1.17.14/awscli/examples/dynamodb/query.rst --- awscli-1.16.301/awscli/examples/dynamodb/query.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/query.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,32 +1,35 @@ **To query an item** -This example queries items in the *MusicCollection* table. The table has a hash-and-range primary key (*Artist* and *SongTitle*), but this query only specifies the hash key value. It returns song titles by the artist named "No One You Know". +The following ``query`` example queries items in the ``MusicCollection`` table. The table has a hash-and-range primary key (``Artist`` and ``SongTitle``), but this query only specifies the hash key value. It returns song titles by the artist named "No One You Know". :: -Command:: - - aws dynamodb query --table-name MusicCollection --projection-expression "SongTitle" --key-condition-expression "Artist = :v1" --expression-attribute-values file://expression-attributes.json - - -The arguments for ``--expression-attribute-values`` are stored in a JSON file named ``expression-attributes.json``:: - - { - ":v1": {"S": "No One You Know"} - } + aws dynamodb query \ + --table-name MusicCollection \ + --projection-expression "SongTitle" \ + --key-condition-expression "Artist = :v1" \ + --expression-attribute-values file://expression-attributes.json + +Contents of ``expression-attributes.json``:: + + { + ":v1": {"S": "No One You Know"} + } Output:: - { - "Count": 2, - "Items": [ - { - "SongTitle": { - "S": "Call Me Today" - }, - "SongTitle": { - "S": "Scared of My Shadow" - } - } - ], - "ScannedCount": 2, - "ConsumedCapacity": null - } + { + "Count": 2, + "Items": [ + { + "SongTitle": { + "S": "Call Me Today" + }, + "SongTitle": { + "S": "Scared of My Shadow" + } + } + ], + "ScannedCount": 2, + "ConsumedCapacity": null + } + +For more information, see `Working with Queries in DynamoDB `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/restore-table-from-backup.rst awscli-1.17.14/awscli/examples/dynamodb/restore-table-from-backup.rst --- awscli-1.16.301/awscli/examples/dynamodb/restore-table-from-backup.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/restore-table-from-backup.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,57 @@ +**To restore a DynamoDB table from an existing backup** + +The following ``restore-table-from-backup`` example restores the specified table from an existing backup. :: + + aws dynamodb restore-table-from-backup \ + --target-table-name MusicCollection \ + --backup-arnarn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/backup/01576616366715-b4e58d3a + +Output:: + + { + "TableDescription": { + "AttributeDefinitions": [ + { + "AttributeName": "Artist", + "AttributeType": "S" + }, + { + "AttributeName": "SongTitle", + "AttributeType": "S" + } + ], + "TableName": "MusicCollection2", + "KeySchema": [ + { + "AttributeName": "Artist", + "KeyType": "HASH" + }, + { + "AttributeName": "SongTitle", + "KeyType": "RANGE" + } + ], + "TableStatus": "CREATING", + "CreationDateTime": 1576618274.326, + "ProvisionedThroughput": { + "NumberOfDecreasesToday": 0, + "ReadCapacityUnits": 5, + "WriteCapacityUnits": 5 + }, + "TableSizeBytes": 0, + "ItemCount": 0, + "TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection2", + "TableId": "114865c9-5ef3-496c-b4d1-c4cbdd2d44fb", + "BillingModeSummary": { + "BillingMode": "PROVISIONED" + }, + "RestoreSummary": { + "SourceBackupArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/backup/01576616366715-b4e58d3a", + "SourceTableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection", + "RestoreDateTime": 1576616366.715, + "RestoreInProgress": true + } + } + } + +For more information, see `On-Demand Backup and Restore for DynamoDB `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/restore-table-to-point-in-time.rst awscli-1.17.14/awscli/examples/dynamodb/restore-table-to-point-in-time.rst --- awscli-1.16.301/awscli/examples/dynamodb/restore-table-to-point-in-time.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/restore-table-to-point-in-time.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,57 @@ +**To restore a DynamoDB table to a point in time** + +The following ``restore-table-to-point-in-time`` example restores the ``MusicCollection`` table to the specified point in time. :: + + aws dynamodb restore-table-to-point-in-time \ + --source-table-name MusicCollection \ + --target-table-name MusicCollectionRestore \ + --restore-date-time 1576622404.0 + +Output:: + + { + "TableDescription": { + "AttributeDefinitions": [ + { + "AttributeName": "Artist", + "AttributeType": "S" + }, + { + "AttributeName": "SongTitle", + "AttributeType": "S" + } + ], + "TableName": "MusicCollectionRestore", + "KeySchema": [ + { + "AttributeName": "Artist", + "KeyType": "HASH" + }, + { + "AttributeName": "SongTitle", + "KeyType": "RANGE" + } + ], + "TableStatus": "CREATING", + "CreationDateTime": 1576623311.86, + "ProvisionedThroughput": { + "NumberOfDecreasesToday": 0, + "ReadCapacityUnits": 5, + "WriteCapacityUnits": 5 + }, + "TableSizeBytes": 0, + "ItemCount": 0, + "TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollectionRestore", + "TableId": "befd9e0e-1843-4dc6-a147-d6d00e85cb1f", + "BillingModeSummary": { + "BillingMode": "PROVISIONED" + }, + "RestoreSummary": { + "SourceTableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection", + "RestoreDateTime": 1576622404.0, + "RestoreInProgress": true + } + } + } + +For more information, see `Point-in-Time Recovery for DynamoDB `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/scan.rst awscli-1.17.14/awscli/examples/dynamodb/scan.rst --- awscli-1.16.301/awscli/examples/dynamodb/scan.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/scan.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,47 +1,51 @@ **To scan a table** -This example scans the entire *MusicCollection* table, and then narrows the results to songs by the artist "No One You Know". For each item, only the album title and song title are returned. +The following ``scan`` example scans the entire ``MusicCollection`` table, and then narrows the results to songs by the artist "No One You Know". For each item, only the album title and song title are returned. :: -Command:: - - aws dynamodb scan --table-name MusicCollection --filter-expression "Artist = :a" --projection-expression "#ST, #AT" --expression-attribute-names file://expression-attribute-names.json --expression-attribute-values file://expression-attribute-values.json - -The arguments for ``--expression-attribute-names`` are stored in a JSON file, ``expression-attribute-names.json``. Here are the contents of that file:: - - { - "#ST": "SongTitle", - "#AT":"AlbumTitle" - } - - -The arguments for ``--expression-attribute-values`` are stored in a JSON file, ``expression-attribute-values.json``. Here are the contents of that file:: - - { - ":a": {"S": "No One You Know"} - } + aws dynamodb scan \ + --table-name MusicCollection \ + --filter-expression "Artist = :a" \ + --projection-expression "#ST, #AT" \ + --expression-attribute-names file://expression-attribute-names.json \ + --expression-attribute-values file://expression-attribute-values.json + +Contents of ``expression-attribute-names.json``:: + + { + "#ST": "SongTitle", + "#AT":"AlbumTitle" + } + +Contents of ``expression-attribute-values.json``:: + + { + ":a": {"S": "No One You Know"} + } Output:: - { - "Count": 2, - "Items": [ - { - "SongTitle": { - "S": "Call Me Today" - }, - "AlbumTitle": { - "S": "Somewhat Famous" - } - }, - { - "SongTitle": { - "S": "Scared of My Shadow" - }, - "AlbumTitle": { - "S": "Blue Sky Blues" - } - } - ], - "ScannedCount": 3, - "ConsumedCapacity": null - } + { + "Count": 2, + "Items": [ + { + "SongTitle": { + "S": "Call Me Today" + }, + "AlbumTitle": { + "S": "Somewhat Famous" + } + }, + { + "SongTitle": { + "S": "Scared of My Shadow" + }, + "AlbumTitle": { + "S": "Blue Sky Blues" + } + } + ], + "ScannedCount": 3, + "ConsumedCapacity": null + } + +For more information, see `Working with Scans in DynamoDB `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/tag-resource.rst awscli-1.17.14/awscli/examples/dynamodb/tag-resource.rst --- awscli-1.16.301/awscli/examples/dynamodb/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/tag-resource.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,11 @@ +**To add tags to a DynamoDB resource** + +The following ``tag-resource`` example adds a tag key/value pair to the ``MusicCollection`` table. :: + + aws dynamodb tag-resource \ + --resource-arn arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection \ + --tags Key=Owner,Value=blueTeam + +This command produces no output. + +For more information, see `Tagging for DynamoDB `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/transact-get-items.rst awscli-1.17.14/awscli/examples/dynamodb/transact-get-items.rst --- awscli-1.16.301/awscli/examples/dynamodb/transact-get-items.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/transact-get-items.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,64 @@ +**To retrieve multiple items atomically from one or more tables** + +The following ``transact-get-items`` example retrieves multiple items atomically. :: + + aws dynamodb transact-get-items \ + --transact-items file://transact-items.json + +Contents of ``transact-items.json``:: + + [ + { + "Get": { + "Key": { + "Artist": {"S": "Acme Band"}, + "SongTitle": {"S": "Happy Day"} + }, + "TableName": "MusicCollection" + } + }, + { + "Get": { + "Key": { + "Artist": {"S": "No One You Know"}, + "SongTitle": {"S": "Call Me Today"} + }, + "TableName": "MusicCollection" + } + } + ] + +Output:: + + { + "Responses": [ + { + "Item": { + "AlbumTitle": { + "S": "Songs About Life" + }, + "Artist": { + "S": "Acme Band" + }, + "SongTitle": { + "S": "Happy Day" + } + } + }, + { + "Item": { + "AlbumTitle": { + "S": "Somewhat Famous" + }, + "Artist": { + "S": "No One You Know" + }, + "SongTitle": { + "S": "Call Me Today" + } + } + } + ] + } + +For more information, see `Managing Complex Workflows with DynamoDB Transactions `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/transact-write-items.rst awscli-1.17.14/awscli/examples/dynamodb/transact-write-items.rst --- awscli-1.16.301/awscli/examples/dynamodb/transact-write-items.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/transact-write-items.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,39 @@ +**To write items atomically to one or more tables** + +The following ``transact-write-items`` example updates one item and deletes another. The operation fails if either operation fails, or if either item contains a ``Rating`` attribute. :: + + aws dynamodb transact-write-items \ + --transact-items file://transact-items.json + +Contents of the ``transact-items.json`` file:: + + [ + { + "Update": { + "Key": { + "Artist": {"S": "Acme Band"}, + "SongTitle": {"S": "Happy Day"} + }, + "UpdateExpression": "SET AlbumTitle = :newval", + "ExpressionAttributeValues": { + ":newval": {"S": "Updated Album Title"} + }, + "TableName": "MusicCollection", + "ConditionExpression": "attribute_not_exists(Rating)" + } + }, + { + "Delete": { + "Key": { + "Artist": {"S": "No One You Know"}, + "SongTitle": {"S": "Call Me Today"} + }, + "TableName": "MusicCollection", + "ConditionExpression": "attribute_not_exists(Rating)" + } + } + ] + +This command produces no output. + +For more information, see `Managing Complex Workflows with DynamoDB Transactions `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/untag-resource.rst awscli-1.17.14/awscli/examples/dynamodb/untag-resource.rst --- awscli-1.16.301/awscli/examples/dynamodb/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/untag-resource.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,12 @@ +**To remove a tag from a DynamoDB resource** + +The following ``untag-resource`` example removes the tag with the key ``Owner`` from the ``MusicCollection`` table. :: + + aws dynamodb untag-resource \ + --resource-arn arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection \ + --tag-keys Owner + + +This command produces no output. + +For more information, see `Tagging for DynamoDB `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/update-continuous-backups.rst awscli-1.17.14/awscli/examples/dynamodb/update-continuous-backups.rst --- awscli-1.16.301/awscli/examples/dynamodb/update-continuous-backups.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/update-continuous-backups.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,22 @@ +**To update continuous backup settings for a DynamoDB table** + +The following ``update-continuous-backups`` example enables point-in-time recovery for the ``MusicCollection`` table. :: + + aws dynamodb update-continuous-backups \ + --table-name MusicCollection \ + --point-in-time-recovery-specification PointInTimeRecoveryEnabled=true + +Output:: + + { + "ContinuousBackupsDescription": { + "ContinuousBackupsStatus": "ENABLED", + "PointInTimeRecoveryDescription": { + "PointInTimeRecoveryStatus": "ENABLED", + "EarliestRestorableDateTime": 1576622404.0, + "LatestRestorableDateTime": 1576622404.0 + } + } + } + +For more information, see `Point-in-Time Recovery for DynamoDB `__ in the *Amazon DynamoDB Developer Guide*. \ No newline at end of file diff -Nru awscli-1.16.301/awscli/examples/dynamodb/update-contributor-insights.rst awscli-1.17.14/awscli/examples/dynamodb/update-contributor-insights.rst --- awscli-1.16.301/awscli/examples/dynamodb/update-contributor-insights.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/update-contributor-insights.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,16 @@ +**To enable Contributor Insights on a table** + +The following ``update-contributor-insights`` example enables Contributor Insights on the ``MusicCollection`` table. :: + + aws dynamodb update-contributor-insights \ + --table-name MusicCollection \ + --contributor-insights-action ENABLE + +Output:: + + { + "TableName": "MusicCollection", + "ContributorInsightsStatus": "ENABLING" + } + +For more information, see `Analyzing Data Access Using CloudWatch Contributor Insights for DynamoDB `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/update-global-table.rst awscli-1.17.14/awscli/examples/dynamodb/update-global-table.rst --- awscli-1.16.301/awscli/examples/dynamodb/update-global-table.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/update-global-table.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,31 @@ +**To update a DynamoDB global table** + +The following ``update-global-table`` example adds a replica in the specified Region to the ``MusicCollection`` global table. :: + + aws dynamodb update-global-table \ + --global-table-name MusicCollection \ + --replica-updates Create={RegionName=eu-west-1} + +Output:: + + { + "GlobalTableDescription": { + "ReplicationGroup": [ + { + "RegionName": "eu-west-1" + }, + { + "RegionName": "us-east-2" + }, + { + "RegionName": "us-east-1" + } + ], + "GlobalTableArn": "arn:aws:dynamodb::123456789012:global-table/MusicCollection", + "CreationDateTime": 1576625818.532, + "GlobalTableStatus": "ACTIVE", + "GlobalTableName": "MusicCollection" + } + } + +For more information, see `DynamoDB Global Tables `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/update-global-table-settings.rst awscli-1.17.14/awscli/examples/dynamodb/update-global-table-settings.rst --- awscli-1.16.301/awscli/examples/dynamodb/update-global-table-settings.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/update-global-table-settings.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,53 @@ +**To update provisioned write capacity settings on a DynamoDB global table** + +The following ``update-global-table-settings`` example sets the provisioned write capacity of the ``MusicCollection`` global table to 15. :: + + aws dynamodb update-global-table-settings \ + --global-table-name MusicCollection \ + --global-table-provisioned-write-capacity-units 15 + +Output:: + + { + "GlobalTableName": "MusicCollection", + "ReplicaSettings": [ + { + "RegionName": "eu-west-1", + "ReplicaStatus": "UPDATING", + "ReplicaProvisionedReadCapacityUnits": 10, + "ReplicaProvisionedReadCapacityAutoScalingSettings": { + "AutoScalingDisabled": true + }, + "ReplicaProvisionedWriteCapacityUnits": 10, + "ReplicaProvisionedWriteCapacityAutoScalingSettings": { + "AutoScalingDisabled": true + } + }, + { + "RegionName": "us-east-1", + "ReplicaStatus": "UPDATING", + "ReplicaProvisionedReadCapacityUnits": 10, + "ReplicaProvisionedReadCapacityAutoScalingSettings": { + "AutoScalingDisabled": true + }, + "ReplicaProvisionedWriteCapacityUnits": 10, + "ReplicaProvisionedWriteCapacityAutoScalingSettings": { + "AutoScalingDisabled": true + } + }, + { + "RegionName": "us-east-2", + "ReplicaStatus": "UPDATING", + "ReplicaProvisionedReadCapacityUnits": 10, + "ReplicaProvisionedReadCapacityAutoScalingSettings": { + "AutoScalingDisabled": true + }, + "ReplicaProvisionedWriteCapacityUnits": 10, + "ReplicaProvisionedWriteCapacityAutoScalingSettings": { + "AutoScalingDisabled": true + } + } + ] + } + +For more information, see `DynamoDB Global Tables `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/update-item.rst awscli-1.17.14/awscli/examples/dynamodb/update-item.rst --- awscli-1.16.301/awscli/examples/dynamodb/update-item.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/update-item.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,45 +1,52 @@ **To update an item in a table** -This example updates an item in the *MusicCollection* table. It adds a new attribute (*Year*) and modifies the *AlbumTitle* attribute. All of the attributes in the item, as they appear after the update, are returned in the response. +The following ``update-table`` example updates an item in the ``MusicCollection`` table. It adds a new attribute (``Year``) and modifies the ``AlbumTitle`` attribute. All of the attributes in the item, as they appear after the update, are returned in the response. :: - -Command:: - - aws dynamodb update-item --table-name MusicCollection --key file://key.json --update-expression "SET #Y = :y, #AT = :t" --expression-attribute-names file://expression-attribute-names.json --expression-attribute-values file://expression-attribute-values.json --return-values ALL_NEW - -The arguments for ``--key`` are stored in a JSON file, ``key.json``. Here are the contents of that file:: - - { - "Artist": {"S": "Acme Band"}, - "SongTitle": {"S": "Happy Day"} - } - - -The arguments for ``--expression-attribute-names`` are stored in a JSON file, ``expression-attribute-names.json``. Here are the contents of that file:: - - { - "#Y":"Year", "#AT":"AlbumTitle" - } - -The arguments for ``--expression-attribute-values`` are stored in a JSON file, ``expression-attribute-values.json``. Here are the contents of that file:: - - { - ":y":{"N": "2015"}, - ":t":{"S": "Louder Than Ever"} - } + aws dynamodb update-item \ + --table-name MusicCollection \ + --key file://key.json \ + --update-expression "SET #Y = :y, #AT = :t" \ + --expression-attribute-names file://expression-attribute-names.json \ + --expression-attribute-values file://expression-attribute-values.json \ + --return-values ALL_NEW + +Contents of ``key.json``:: + + { + "Artist": {"S": "Acme Band"}, + "SongTitle": {"S": "Happy Day"} + } + +Contents of ``expression-attribute-names.json``:: + + { + "#Y":"Year", "#AT":"AlbumTitle" + } + +Contents of ``expression-attribute-values.json``:: + + { + ":y":{"N": "2015"}, + ":t":{"S": "Louder Than Ever"} + } Output:: - { - "Item": { - "AlbumTitle": { - "S": "Songs About Life" - }, - "SongTitle": { - "S": "Happy Day" - }, - "Artist": { - "S": "Acme Band" - } - } - } + { + "Item": { + "AlbumTitle": { + "S": "Louder Than Ever" + }, + "SongTitle": { + "S": "Happy Day" + }, + "Artist": { + "S": "Acme Band" + }, + "Year": { + "N" : "2015" + } + } + } + +For more information, see `Writing an Item `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/update-table-replica-auto-scaling.rst awscli-1.17.14/awscli/examples/dynamodb/update-table-replica-auto-scaling.rst --- awscli-1.16.301/awscli/examples/dynamodb/update-table-replica-auto-scaling.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/update-table-replica-auto-scaling.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,127 @@ +**To update auto scaling settings across replicas of a global table** + +The following ``update-table-replica-auto-scaling`` example updates write capacity auto scaling settings across replicas of the specified global table. :: + + aws dynamodb update-table-replica-auto-scaling \ + --table-name MusicCollection \ + --provisioned-write-capacity-auto-scaling-update file://auto-scaling-policy.json + +Contents of ``auto-scaling-policy.json``:: + + { + "MinimumUnits": 10, + "MaximumUnits": 100, + "AutoScalingDisabled": false, + "ScalingPolicyUpdate": { + "PolicyName": "DynamoDBWriteCapacityUtilization:table/MusicCollection", + "TargetTrackingScalingPolicyConfiguration": { + "TargetValue": 80 + } + } + } + +Output:: + + { + "TableAutoScalingDescription": { + "TableName": "MusicCollection", + "TableStatus": "ACTIVE", + "Replicas": [ + { + "RegionName": "eu-central-1", + "GlobalSecondaryIndexes": [], + "ReplicaProvisionedReadCapacityAutoScalingSettings": { + "MinimumUnits": 5, + "MaximumUnits": 40000, + "AutoScalingRoleArn": "arn:aws:iam::123456789012:role/aws-service-role/dynamodb.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_DynamoDBTable", + "ScalingPolicies": [ + { + "PolicyName": "DynamoDBReadCapacityUtilization:table/MusicCollection", + "TargetTrackingScalingPolicyConfiguration": { + "TargetValue": 70.0 + } + } + ] + }, + "ReplicaProvisionedWriteCapacityAutoScalingSettings": { + "MinimumUnits": 10, + "MaximumUnits": 100, + "AutoScalingRoleArn": "arn:aws:iam::123456789012:role/aws-service-role/dynamodb.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_DynamoDBTable", + "ScalingPolicies": [ + { + "PolicyName": "DynamoDBWriteCapacityUtilization:table/MusicCollection", + "TargetTrackingScalingPolicyConfiguration": { + "TargetValue": 80.0 + } + } + ] + }, + "ReplicaStatus": "ACTIVE" + }, + { + "RegionName": "us-east-1", + "GlobalSecondaryIndexes": [], + "ReplicaProvisionedReadCapacityAutoScalingSettings": { + "MinimumUnits": 5, + "MaximumUnits": 40000, + "AutoScalingRoleArn": "arn:aws:iam::123456789012:role/aws-service-role/dynamodb.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_DynamoDBTable", + "ScalingPolicies": [ + { + "PolicyName": "DynamoDBReadCapacityUtilization:table/MusicCollection", + "TargetTrackingScalingPolicyConfiguration": { + "TargetValue": 70.0 + } + } + ] + }, + "ReplicaProvisionedWriteCapacityAutoScalingSettings": { + "MinimumUnits": 10, + "MaximumUnits": 100, + "AutoScalingRoleArn": "arn:aws:iam::123456789012:role/aws-service-role/dynamodb.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_DynamoDBTable", + "ScalingPolicies": [ + { + "PolicyName": "DynamoDBWriteCapacityUtilization:table/MusicCollection", + "TargetTrackingScalingPolicyConfiguration": { + "TargetValue": 80.0 + } + } + ] + }, + "ReplicaStatus": "ACTIVE" + }, + { + "RegionName": "us-east-2", + "GlobalSecondaryIndexes": [], + "ReplicaProvisionedReadCapacityAutoScalingSettings": { + "MinimumUnits": 5, + "MaximumUnits": 40000, + "AutoScalingRoleArn": "arn:aws:iam::123456789012:role/aws-service-role/dynamodb.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_DynamoDBTable", + "ScalingPolicies": [ + { + "PolicyName": "DynamoDBReadCapacityUtilization:table/MusicCollection", + "TargetTrackingScalingPolicyConfiguration": { + "TargetValue": 70.0 + } + } + ] + }, + "ReplicaProvisionedWriteCapacityAutoScalingSettings": { + "MinimumUnits": 10, + "MaximumUnits": 100, + "AutoScalingRoleArn": "arn:aws:iam::123456789012:role/aws-service-role/dynamodb.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_DynamoDBTable", + "ScalingPolicies": [ + { + "PolicyName": "DynamoDBWriteCapacityUtilization:table/MusicCollection", + "TargetTrackingScalingPolicyConfiguration": { + "TargetValue": 80.0 + } + } + ] + }, + "ReplicaStatus": "ACTIVE" + } + ] + } + } + +For more information, see `DynamoDB Global Tables `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/update-table.rst awscli-1.17.14/awscli/examples/dynamodb/update-table.rst --- awscli-1.16.301/awscli/examples/dynamodb/update-table.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/update-table.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,45 +1,47 @@ **To modify a table's provisioned throughput** -This example increases the provisioned read and write capacity on the *MusicCollection* table. +The following ``update-table`` example increases the provisioned read and write capacity on the ``MusicCollection`` table. :: -Command:: - - aws dynamodb update-table --table-name MusicCollection --provisioned-throughput ReadCapacityUnits=10,WriteCapacityUnits=10 + aws dynamodb update-table \ + --table-name MusicCollection \ + --provisioned-throughput ReadCapacityUnits=10,WriteCapacityUnits=10 Output:: - { - "TableDescription": { - "AttributeDefinitions": [ - { - "AttributeName": "Artist", - "AttributeType": "S" - }, - { - "AttributeName": "SongTitle", - "AttributeType": "S" - } - ], - "ProvisionedThroughput": { - "NumberOfDecreasesToday": 0, - "WriteCapacityUnits": 1, - "LastIncreaseDateTime": 1421874759.194, - "ReadCapacityUnits": 1 - }, - "TableSizeBytes": 0, - "TableName": "MusicCollection", - "TableStatus": "UPDATING", - "KeySchema": [ - { - "KeyType": "HASH", - "AttributeName": "Artist" - }, - { - "KeyType": "RANGE", - "AttributeName": "SongTitle" - } - ], - "ItemCount": 0, - "CreationDateTime": 1421866952.062 - } - } + { + "TableDescription": { + "AttributeDefinitions": [ + { + "AttributeName": "Artist", + "AttributeType": "S" + }, + { + "AttributeName": "SongTitle", + "AttributeType": "S" + } + ], + "ProvisionedThroughput": { + "NumberOfDecreasesToday": 0, + "WriteCapacityUnits": 1, + "LastIncreaseDateTime": 1421874759.194, + "ReadCapacityUnits": 1 + }, + "TableSizeBytes": 0, + "TableName": "MusicCollection", + "TableStatus": "UPDATING", + "KeySchema": [ + { + "KeyType": "HASH", + "AttributeName": "Artist" + }, + { + "KeyType": "RANGE", + "AttributeName": "SongTitle" + } + ], + "ItemCount": 0, + "CreationDateTime": 1421866952.062 + } + } + +For more information, see `Updating a Table `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/update-time-to-live.rst awscli-1.17.14/awscli/examples/dynamodb/update-time-to-live.rst --- awscli-1.16.301/awscli/examples/dynamodb/update-time-to-live.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/update-time-to-live.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,18 @@ +**To update Time to Live settings on a table** + +The following ``update-time-to-live`` example enables Time to Live on the specified table. :: + + aws dynamodb update-time-to-live \ + --table-name MusicCollection \ + --time-to-live-specification Enabled=true,AttributeName=ttl + +Output:: + + { + "TimeToLiveSpecification": { + "Enabled": true, + "AttributeName": "ttl" + } + } + +For more information, see `Time to Live `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodb/wait/table-exists.rst awscli-1.17.14/awscli/examples/dynamodb/wait/table-exists.rst --- awscli-1.16.301/awscli/examples/dynamodb/wait/table-exists.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodb/wait/table-exists.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,11 @@ +**To wait for the existence of a table** + +The following ``wait`` example pauses and resumes only after it can confirm that the specified table exists. :: + + aws dynamodb wait table-exists \ + --table-name MusicCollection + + +This command produces no output. + +For more information, see `Basic Operations for Tables `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodbstreams/describe-stream-edit.rst awscli-1.17.14/awscli/examples/dynamodbstreams/describe-stream-edit.rst --- awscli-1.16.301/awscli/examples/dynamodbstreams/describe-stream-edit.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodbstreams/describe-stream-edit.rst 1970-01-01 00:00:00.000000000 +0000 @@ -1,47 +0,0 @@ -**To get information about a DynamoDB stream** - -The following ``describe-stream`` command displays information about the specific DynamoDB stream. :: - - aws dynamodbstreams describe-stream \ - --stream-arn arn:aws:dynamodb:us-west-1:123456789012:table/Music/stream/2019-10-22T18:02:01.576 - -Output:: - - { - "StreamDescription": { - "StreamArn": "arn:aws:dynamodb:us-west-1:123456789012:table/Music/stream/2019-10-22T18:02:01.576", - "StreamLabel": "2019-10-22T18:02:01.576", - "StreamStatus": "ENABLED", - "StreamViewType": "NEW_AND_OLD_IMAGES", - "CreationRequestDateTime": 1571767321.571, - "TableName": "Music", - "KeySchema": [ - { - "AttributeName": "Artist", - "KeyType": "HASH" - }, - { - "AttributeName": "SongTitle", - "KeyType": "RANGE" - } - ], - "Shards": [ - { - "ShardId": "shardId-00000001571767321804-697ce3d2", - "SequenceNumberRange": { - "StartingSequenceNumber": "4000000000000642977831", - "EndingSequenceNumber": "4000000000000642977831" - } - }, - { - "ShardId": "shardId-00000001571780995058-40810d86", - "SequenceNumberRange": { - "StartingSequenceNumber": "757400000000005655171150" - }, - "ParentShardId": "shardId-00000001571767321804-697ce3d2" - } - ] - } - } - -For more information, see `Capturing Table Activity with DynamoDB Streams `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodbstreams/describe-stream.rst awscli-1.17.14/awscli/examples/dynamodbstreams/describe-stream.rst --- awscli-1.16.301/awscli/examples/dynamodbstreams/describe-stream.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodbstreams/describe-stream.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,47 @@ +**To get information about a DynamoDB stream** + +The following ``describe-stream`` command displays information about the specific DynamoDB stream. :: + + aws dynamodbstreams describe-stream \ + --stream-arn arn:aws:dynamodb:us-west-1:123456789012:table/Music/stream/2019-10-22T18:02:01.576 + +Output:: + + { + "StreamDescription": { + "StreamArn": "arn:aws:dynamodb:us-west-1:123456789012:table/Music/stream/2019-10-22T18:02:01.576", + "StreamLabel": "2019-10-22T18:02:01.576", + "StreamStatus": "ENABLED", + "StreamViewType": "NEW_AND_OLD_IMAGES", + "CreationRequestDateTime": 1571767321.571, + "TableName": "Music", + "KeySchema": [ + { + "AttributeName": "Artist", + "KeyType": "HASH" + }, + { + "AttributeName": "SongTitle", + "KeyType": "RANGE" + } + ], + "Shards": [ + { + "ShardId": "shardId-00000001571767321804-697ce3d2", + "SequenceNumberRange": { + "StartingSequenceNumber": "4000000000000642977831", + "EndingSequenceNumber": "4000000000000642977831" + } + }, + { + "ShardId": "shardId-00000001571780995058-40810d86", + "SequenceNumberRange": { + "StartingSequenceNumber": "757400000000005655171150" + }, + "ParentShardId": "shardId-00000001571767321804-697ce3d2" + } + ] + } + } + +For more information, see `Capturing Table Activity with DynamoDB Streams `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodbstreams/get-records-edit.rst awscli-1.17.14/awscli/examples/dynamodbstreams/get-records-edit.rst --- awscli-1.16.301/awscli/examples/dynamodbstreams/get-records-edit.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodbstreams/get-records-edit.rst 1970-01-01 00:00:00.000000000 +0000 @@ -1,135 +0,0 @@ -**To get records from a Dynamodb stream** - -The following ``get-records`` command retrieves records using the specified Amazon DynamoDB shard iterator. :: - - aws dynamodbstreams get-records \ - --shard-iterator "arn:aws:dynamodb:us-west-1:123456789012:table/Music/stream/2019-10-22T18:02:01.576|1|AAAAAAAAAAGgM3YZ89vLZZxjmoQeo33r9M4x3+zmmTLsiL86MfrF4+B4EbsByi52InVmiONmy6xVW4IRcIIbs1zO7MNIlqZfx8WQzMwVDyINtGG2hCLg78JKbYxFasXeePGlApTyf3rJxR765uyOVaBvBHAJuwF2TXIuxhaAlOupNGHr52qAC3a49ZOmf+CjNPlqQjnyRSAnfOwWmKhL1/KNParWSfz2odf780oOObIDIWRRMkt7+Hyzh9SD+hFxFAWR5C7QIlOXPc8mRBfNIazfrVCjJK8/jsjCzsqNyXKzJbhh+GXCoxYN+Kpmg4nyj1EAsYhbGL35muvHFoHjcyuynbsczbWaXNfThDwRAyvoTmc8XhHKtAWUbJiaVd8ZPtQwDsThCrmDRPIdmTRGWllGfUr5ezN5LscvkQezzgpaU5p8BgCqRzjv5Vl8LB6wHgQWNG+w/lEGS05ha1qNP+Vl4+tuhz2TRnhnJo/pny9GI/yGpce97mWvSPr5KPwy+Dtcm5BHayBs+PVYHITaTliInFlT+LCwvaz1QH3MY3b8A05Z800wjpktm60iQqtMeDwN4NX6FrcxR34JoFKGsgR8XkHVJzz2xr1xqSJ12ycpNTyHnndusw==" - -Output:: - - { - "Records": [ - { - "eventID": "c3b5d798eef6215d42f8137b19a88e50", - "eventName": "INSERT", - "eventVersion": "1.1", - "eventSource": "aws:dynamodb", - "awsRegion": "us-west-1", - "dynamodb": { - "ApproximateCreationDateTime": 1571849028.0, - "Keys": { - "Artist": { - "S": "No One You Know" - }, - "SongTitle": { - "S": "Call Me Today" - } - }, - "NewImage": { - "AlbumTitle": { - "S": "Somewhat Famous" - }, - "Artist": { - "S": "No One You Know" - }, - "Awards": { - "N": "1" - }, - "SongTitle": { - "S": "Call Me Today" - } - }, - "SequenceNumber": "700000000013256296913", - "SizeBytes": 119, - "StreamViewType": "NEW_AND_OLD_IMAGES" - } - }, - { - "eventID": "878960a6967867e2da16b27380a27328", - "eventName": "INSERT", - "eventVersion": "1.1", - "eventSource": "aws:dynamodb", - "awsRegion": "us-west-1", - "dynamodb": { - "ApproximateCreationDateTime": 1571849029.0, - "Keys": { - "Artist": { - "S": "Acme Band" - }, - "SongTitle": { - "S": "Happy Day" - } - }, - "NewImage": { - "AlbumTitle": { - "S": "Songs About Life" - }, - "Artist": { - "S": "Acme Band" - }, - "Awards": { - "N": "10" - }, - "SongTitle": { - "S": "Happy Day" - } - }, - "SequenceNumber": "800000000013256297217", - "SizeBytes": 100, - "StreamViewType": "NEW_AND_OLD_IMAGES" - } - }, - { - "eventID": "520fabde080e159fc3710b15ee1d4daa", - "eventName": "MODIFY", - "eventVersion": "1.1", - "eventSource": "aws:dynamodb", - "awsRegion": "us-west-1", - "dynamodb": { - "ApproximateCreationDateTime": 1571849734.0, - "Keys": { - "Artist": { - "S": "Acme Band" - }, - "SongTitle": { - "S": "Happy Day" - } - }, - "NewImage": { - "AlbumTitle": { - "S": "Updated Album Title" - }, - "Artist": { - "S": "Acme Band" - }, - "Awards": { - "N": "10" - }, - "SongTitle": { - "S": "Happy Day" - } - }, - "OldImage": { - "AlbumTitle": { - "S": "Songs About Life" - }, - "Artist": { - "S": "Acme Band" - }, - "Awards": { - "N": "10" - }, - "SongTitle": { - "S": "Happy Day" - } - }, - "SequenceNumber": "900000000013256687845", - "SizeBytes": 170, - "StreamViewType": "NEW_AND_OLD_IMAGES" - } - } - ], - "NextShardIterator": "arn:aws:dynamodb:us-west-1:123456789012:table/Music/stream/2019-10-23T16:41:08.740|1|AAAAAAAAAAEhEI04jkFLW+LKOwivjT8d/IHEh3iExV2xK00aTxEzVy1C1C7Kbb5+ZOW6bT9VQ2n1/mrs7+PRiaOZCHJu7JHJVW7zlsqOi/ges3fw8GYEymyL+piEk35cx67rQqwKKyq+Q6w9JyjreIOj4F2lWLV26lBwRTrIYC4IB7C3BZZK4715QwYdDxNdVHiSBRZX8UqoS6WOt0F87xZLNB9F/NhYBLXi/wcGvAcBcC0TNIOH+N0NqwtoB/FGCkNrf8YZ0xRoNN6RgGuVWHF3pxOhxEJeFZoSoJTIKeG9YcYxzi5Ci/mhdtm7tBXnbw5c6xmsGsBqTirNjlDyJLcWl8Cl0UOLX63Ufo/5QliztcjEbKsQe28x8LM8o7VH1Is0fF/ITt8awSA4igyJS0P87GN8Qri8kj8iaE35805jBHWF2wvwT6Iy2xGrR2r2HzYps9dwGOarVdEITaJfWzNoL4HajMhmREZLYfM7Pb0PvRMO7JkENyPIU6e2w16W1CvJO2EGFIxtNk+V04i1YIeHMXJfcwetNRuIbdQXfJht2NQZa4PVV6iknY6d19MrdbSTMKoqAuvp6g3Q2jH4t7GKCLWgodcPAn8g5+43DaNkh4Z5zKOfNw==" - } - -For more information, see `Capturing Table Activity with DynamoDB Streams `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodbstreams/get-records.rst awscli-1.17.14/awscli/examples/dynamodbstreams/get-records.rst --- awscli-1.16.301/awscli/examples/dynamodbstreams/get-records.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodbstreams/get-records.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,135 @@ +**To get records from a Dynamodb stream** + +The following ``get-records`` command retrieves records using the specified Amazon DynamoDB shard iterator. :: + + aws dynamodbstreams get-records \ + --shard-iterator "arn:aws:dynamodb:us-west-1:123456789012:table/Music/stream/2019-10-22T18:02:01.576|1|AAAAAAAAAAGgM3YZ89vLZZxjmoQeo33r9M4x3+zmmTLsiL86MfrF4+B4EbsByi52InVmiONmy6xVW4IRcIIbs1zO7MNIlqZfx8WQzMwVDyINtGG2hCLg78JKbYxFasXeePGlApTyf3rJxR765uyOVaBvBHAJuwF2TXIuxhaAlOupNGHr52qAC3a49ZOmf+CjNPlqQjnyRSAnfOwWmKhL1/KNParWSfz2odf780oOObIDIWRRMkt7+Hyzh9SD+hFxFAWR5C7QIlOXPc8mRBfNIazfrVCjJK8/jsjCzsqNyXKzJbhh+GXCoxYN+Kpmg4nyj1EAsYhbGL35muvHFoHjcyuynbsczbWaXNfThDwRAyvoTmc8XhHKtAWUbJiaVd8ZPtQwDsThCrmDRPIdmTRGWllGfUr5ezN5LscvkQezzgpaU5p8BgCqRzjv5Vl8LB6wHgQWNG+w/lEGS05ha1qNP+Vl4+tuhz2TRnhnJo/pny9GI/yGpce97mWvSPr5KPwy+Dtcm5BHayBs+PVYHITaTliInFlT+LCwvaz1QH3MY3b8A05Z800wjpktm60iQqtMeDwN4NX6FrcxR34JoFKGsgR8XkHVJzz2xr1xqSJ12ycpNTyHnndusw==" + +Output:: + + { + "Records": [ + { + "eventID": "c3b5d798eef6215d42f8137b19a88e50", + "eventName": "INSERT", + "eventVersion": "1.1", + "eventSource": "aws:dynamodb", + "awsRegion": "us-west-1", + "dynamodb": { + "ApproximateCreationDateTime": 1571849028.0, + "Keys": { + "Artist": { + "S": "No One You Know" + }, + "SongTitle": { + "S": "Call Me Today" + } + }, + "NewImage": { + "AlbumTitle": { + "S": "Somewhat Famous" + }, + "Artist": { + "S": "No One You Know" + }, + "Awards": { + "N": "1" + }, + "SongTitle": { + "S": "Call Me Today" + } + }, + "SequenceNumber": "700000000013256296913", + "SizeBytes": 119, + "StreamViewType": "NEW_AND_OLD_IMAGES" + } + }, + { + "eventID": "878960a6967867e2da16b27380a27328", + "eventName": "INSERT", + "eventVersion": "1.1", + "eventSource": "aws:dynamodb", + "awsRegion": "us-west-1", + "dynamodb": { + "ApproximateCreationDateTime": 1571849029.0, + "Keys": { + "Artist": { + "S": "Acme Band" + }, + "SongTitle": { + "S": "Happy Day" + } + }, + "NewImage": { + "AlbumTitle": { + "S": "Songs About Life" + }, + "Artist": { + "S": "Acme Band" + }, + "Awards": { + "N": "10" + }, + "SongTitle": { + "S": "Happy Day" + } + }, + "SequenceNumber": "800000000013256297217", + "SizeBytes": 100, + "StreamViewType": "NEW_AND_OLD_IMAGES" + } + }, + { + "eventID": "520fabde080e159fc3710b15ee1d4daa", + "eventName": "MODIFY", + "eventVersion": "1.1", + "eventSource": "aws:dynamodb", + "awsRegion": "us-west-1", + "dynamodb": { + "ApproximateCreationDateTime": 1571849734.0, + "Keys": { + "Artist": { + "S": "Acme Band" + }, + "SongTitle": { + "S": "Happy Day" + } + }, + "NewImage": { + "AlbumTitle": { + "S": "Updated Album Title" + }, + "Artist": { + "S": "Acme Band" + }, + "Awards": { + "N": "10" + }, + "SongTitle": { + "S": "Happy Day" + } + }, + "OldImage": { + "AlbumTitle": { + "S": "Songs About Life" + }, + "Artist": { + "S": "Acme Band" + }, + "Awards": { + "N": "10" + }, + "SongTitle": { + "S": "Happy Day" + } + }, + "SequenceNumber": "900000000013256687845", + "SizeBytes": 170, + "StreamViewType": "NEW_AND_OLD_IMAGES" + } + } + ], + "NextShardIterator": "arn:aws:dynamodb:us-west-1:123456789012:table/Music/stream/2019-10-23T16:41:08.740|1|AAAAAAAAAAEhEI04jkFLW+LKOwivjT8d/IHEh3iExV2xK00aTxEzVy1C1C7Kbb5+ZOW6bT9VQ2n1/mrs7+PRiaOZCHJu7JHJVW7zlsqOi/ges3fw8GYEymyL+piEk35cx67rQqwKKyq+Q6w9JyjreIOj4F2lWLV26lBwRTrIYC4IB7C3BZZK4715QwYdDxNdVHiSBRZX8UqoS6WOt0F87xZLNB9F/NhYBLXi/wcGvAcBcC0TNIOH+N0NqwtoB/FGCkNrf8YZ0xRoNN6RgGuVWHF3pxOhxEJeFZoSoJTIKeG9YcYxzi5Ci/mhdtm7tBXnbw5c6xmsGsBqTirNjlDyJLcWl8Cl0UOLX63Ufo/5QliztcjEbKsQe28x8LM8o7VH1Is0fF/ITt8awSA4igyJS0P87GN8Qri8kj8iaE35805jBHWF2wvwT6Iy2xGrR2r2HzYps9dwGOarVdEITaJfWzNoL4HajMhmREZLYfM7Pb0PvRMO7JkENyPIU6e2w16W1CvJO2EGFIxtNk+V04i1YIeHMXJfcwetNRuIbdQXfJht2NQZa4PVV6iknY6d19MrdbSTMKoqAuvp6g3Q2jH4t7GKCLWgodcPAn8g5+43DaNkh4Z5zKOfNw==" + } + +For more information, see `Capturing Table Activity with DynamoDB Streams `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodbstreams/get-shard-iterator-edit.rst awscli-1.17.14/awscli/examples/dynamodbstreams/get-shard-iterator-edit.rst --- awscli-1.16.301/awscli/examples/dynamodbstreams/get-shard-iterator-edit.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodbstreams/get-shard-iterator-edit.rst 1970-01-01 00:00:00.000000000 +0000 @@ -1,16 +0,0 @@ -**To get a shard iterator** - -The following ``get-shard-iterator`` command retrieves a shard iterator for the specified shard. :: - - aws dynamodbstreams get-shard-iterator \ - --stream-arn arn:aws:dynamodb:us-west-1:12356789012:table/Music/stream/2019-10-22T18:02:01.576 \ - --shard-id shardId-00000001571780995058-40810d86 \ - --shard-iterator-type LATEST - -Output:: - - { - "ShardIterator": "arn:aws:dynamodb:us-west-1:123456789012:table/Music/stream/2019-10-22T18:02:01.576|1|AAAAAAAAAAGgM3YZ89vLZZxjmoQeo33r9M4x3+zmmTLsiL86MfrF4+B4EbsByi52InVmiONmy6xVW4IRcIIbs1zO7MNIlqZfx8WQzMwVDyINtGG2hCLg78JKbYxFasXeePGlApTyf3rJxR765uyOVaBvBHAJuwF2TXIuxhaAlOupNGHr52qAC3a49ZOmf+CjNPlqQjnyRSAnfOwWmKhL1/KNParWSfz2odf780oOObIDIWRRMkt7+Hyzh9SD+hFxFAWR5C7QIlOXPc8mRBfNIazfrVCjJK8/jsjCzsqNyXKzJbhh+GXCoxYN+Kpmg4nyj1EAsYhbGL35muvHFoHjcyuynbsczbWaXNfThDwRAyvoTmc8XhHKtAWUbJiaVd8ZPtQwDsThCrmDRPIdmTRGWllGfUr5ezN5LscvkQezzgpaU5p8BgCqRzjv5Vl8LB6wHgQWNG+w/lEGS05ha1qNP+Vl4+tuhz2TRnhnJo/pny9GI/yGpce97mWvSPr5KPwy+Dtcm5BHayBs+PVYHITaTliInFlT+LCwvaz1QH3MY3b8A05Z800wjpktm60iQqtMeDwN4NX6FrcxR34JoFKGsgR8XkHVJzz2xr1xqSJ12ycpNTyHnndusw==" - } - -For more information, see `Capturing Table Activity with DynamoDB Streams `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodbstreams/get-shard-iterator.rst awscli-1.17.14/awscli/examples/dynamodbstreams/get-shard-iterator.rst --- awscli-1.16.301/awscli/examples/dynamodbstreams/get-shard-iterator.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodbstreams/get-shard-iterator.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,16 @@ +**To get a shard iterator** + +The following ``get-shard-iterator`` command retrieves a shard iterator for the specified shard. :: + + aws dynamodbstreams get-shard-iterator \ + --stream-arn arn:aws:dynamodb:us-west-1:12356789012:table/Music/stream/2019-10-22T18:02:01.576 \ + --shard-id shardId-00000001571780995058-40810d86 \ + --shard-iterator-type LATEST + +Output:: + + { + "ShardIterator": "arn:aws:dynamodb:us-west-1:123456789012:table/Music/stream/2019-10-22T18:02:01.576|1|AAAAAAAAAAGgM3YZ89vLZZxjmoQeo33r9M4x3+zmmTLsiL86MfrF4+B4EbsByi52InVmiONmy6xVW4IRcIIbs1zO7MNIlqZfx8WQzMwVDyINtGG2hCLg78JKbYxFasXeePGlApTyf3rJxR765uyOVaBvBHAJuwF2TXIuxhaAlOupNGHr52qAC3a49ZOmf+CjNPlqQjnyRSAnfOwWmKhL1/KNParWSfz2odf780oOObIDIWRRMkt7+Hyzh9SD+hFxFAWR5C7QIlOXPc8mRBfNIazfrVCjJK8/jsjCzsqNyXKzJbhh+GXCoxYN+Kpmg4nyj1EAsYhbGL35muvHFoHjcyuynbsczbWaXNfThDwRAyvoTmc8XhHKtAWUbJiaVd8ZPtQwDsThCrmDRPIdmTRGWllGfUr5ezN5LscvkQezzgpaU5p8BgCqRzjv5Vl8LB6wHgQWNG+w/lEGS05ha1qNP+Vl4+tuhz2TRnhnJo/pny9GI/yGpce97mWvSPr5KPwy+Dtcm5BHayBs+PVYHITaTliInFlT+LCwvaz1QH3MY3b8A05Z800wjpktm60iQqtMeDwN4NX6FrcxR34JoFKGsgR8XkHVJzz2xr1xqSJ12ycpNTyHnndusw==" + } + +For more information, see `Capturing Table Activity with DynamoDB Streams `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodbstreams/list-streams-edit.rst awscli-1.17.14/awscli/examples/dynamodbstreams/list-streams-edit.rst --- awscli-1.16.301/awscli/examples/dynamodbstreams/list-streams-edit.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodbstreams/list-streams-edit.rst 1970-01-01 00:00:00.000000000 +0000 @@ -1,19 +0,0 @@ -**To list DynamoDB streams** - -The following ``list-streams`` command lists all existing Amazon DynamoDB streams within the default AWS Region. :: - - aws dynamodbstreams list-streams - -Output:: - - { - "Streams": [ - { - "StreamArn": "arn:aws:dynamodb:us-west-1:123456789012:table/Music/stream/2019-10-22T18:02:01.576", - "TableName": "Music", - "StreamLabel": "2019-10-22T18:02:01.576" - } - ] - } - -For more information, see `Capturing Table Activity with DynamoDB Streams `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/dynamodbstreams/list-streams.rst awscli-1.17.14/awscli/examples/dynamodbstreams/list-streams.rst --- awscli-1.16.301/awscli/examples/dynamodbstreams/list-streams.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/dynamodbstreams/list-streams.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,19 @@ +**To list DynamoDB streams** + +The following ``list-streams`` command lists all existing Amazon DynamoDB streams within the default AWS Region. :: + + aws dynamodbstreams list-streams + +Output:: + + { + "Streams": [ + { + "StreamArn": "arn:aws:dynamodb:us-west-1:123456789012:table/Music/stream/2019-10-22T18:02:01.576", + "TableName": "Music", + "StreamLabel": "2019-10-22T18:02:01.576" + } + ] + } + +For more information, see `Capturing Table Activity with DynamoDB Streams `__ in the *Amazon DynamoDB Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/ec2/accept-transit-gateway-peering-attachment.rst awscli-1.17.14/awscli/examples/ec2/accept-transit-gateway-peering-attachment.rst --- awscli-1.16.301/awscli/examples/ec2/accept-transit-gateway-peering-attachment.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/accept-transit-gateway-peering-attachment.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,29 @@ +**To accept a transit gateway peering attachment** + +The following ``accept-transit-gateway-peering-attachment`` example accepts the specified transit gateway peering attachment. The ``--region`` parameter specifies the Region that the accepter transit gateway is located in. :: + + aws ec2 accept-transit-gateway-peering-attachment \ + --transit-gateway-attachment-id tgw-attach-4455667788aabbccd \ + --region us-east-2 + +Output:: + + { + "TransitGatewayPeeringAttachment": { + "TransitGatewayAttachmentId": "tgw-attach-4455667788aabbccd", + "RequesterTgwInfo": { + "TransitGatewayId": "tgw-123abc05e04123abc", + "OwnerId": "123456789012", + "Region": "us-west-2" + }, + "AccepterTgwInfo": { + "TransitGatewayId": "tgw-11223344aabbcc112", + "OwnerId": "123456789012", + "Region": "us-east-2" + }, + "State": "pending", + "CreationTime": "2019-12-09T11:38:31.000Z" + } + } + +For more information, see `Transit Gateway Peering Attachments `__ in the *Transit Gateways Guide*. diff -Nru awscli-1.16.301/awscli/examples/ec2/allocate-address.rst awscli-1.17.14/awscli/examples/ec2/allocate-address.rst --- awscli-1.16.301/awscli/examples/ec2/allocate-address.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/allocate-address.rst 2020-02-10 19:14:32.000000000 +0000 @@ -17,13 +17,15 @@ The following ``allocate-address`` example allocates an Elastic IP address to use with an instance in a VPC. :: aws ec2 allocate-address \ - --domain vpc + --domain vpc \ + --network-border-group us-west-2-lax-1 Output:: { - "PublicIp": "203.0.113.0", + "PublicIp": "70.224.234.241", + "AllocationId": "eipalloc-02463d08ceEXAMPLE", "PublicIpv4Pool": "amazon", - "Domain": "vpc", - "AllocationId": "eipalloc-07b6d55388acd1884" + "NetworkBorderGroup": "us-west-2-lax-1", + "Domain": "vpc" } diff -Nru awscli-1.16.301/awscli/examples/ec2/associate-transit-gateway-multicast-domain.rst awscli-1.17.14/awscli/examples/ec2/associate-transit-gateway-multicast-domain.rst --- awscli-1.16.301/awscli/examples/ec2/associate-transit-gateway-multicast-domain.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/associate-transit-gateway-multicast-domain.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,28 @@ +**To associate a transit gateway with a multicast domain** + +This example returns the route table propagations for the specified route table. :: + + aws ec2 associate-transit-gateway-multicast-domain \ + --transit-gateway-multicast-domain-id tgw-mcast-domain-0c4905cef79d6e597 \ + --transit-gateway-attachment-id tgw-attach-028c1dd0f8f5cbe8e \ + --subnet-id subnet-000de86e3b49c932a \ + --transit-gateway-multicast-domain-id tgw-mcast-domain-0c4905cef7EXAMPLE + +Output:: + + { + "Associations": { + "TransitGatewayMulticastDomainId": "tgw-mcast-domain-0c4905cef79d6e597", + "TransitGatewayAttachmentId": "tgw-attach-028c1dd0f8f5cbe8e", + "ResourceId": "vpc-01128d2c240c09bd5", + "ResourceType": "vpc", + "Subnets": [ + { + "SubnetId": "subnet-000de86e3b49c932a", + "State": "associating" + } + ] + } + } + +For more information, see 'Associate VPC Attachments and Subnets with a Transit Gateway Multicast Domain '__ in the *AWS Transit Gateways User Guide*. diff -Nru awscli-1.16.301/awscli/examples/ec2/associate-vpc-cidr-block.rst awscli-1.17.14/awscli/examples/ec2/associate-vpc-cidr-block.rst --- awscli-1.16.301/awscli/examples/ec2/associate-vpc-cidr-block.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/associate-vpc-cidr-block.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,40 +1,42 @@ -**To associate an IPv6 CIDR block with a VPC** +**Example 1: To associate an Amazon-provided IPv6 CIDR block with a VPC** -This example associates an IPv6 CIDR block with a VPC. +The following ``associate-vpc-cidr-block`` example associates an IPv6 CIDR block with the specified VPC.:: -Command:: - - aws ec2 associate-vpc-cidr-block --amazon-provided-ipv6-cidr-block --vpc-id vpc-a034d6c4 + aws ec2 associate-vpc-cidr-block \ + --amazon-provided-ipv6-cidr-block \ + --ipv6-cidr-block-network-border-group us-west-2-lax-1 \ + --vpc-id vpc-8EXAMPLE Output:: - { - "Ipv6CidrBlockAssociation": { - "Ipv6CidrBlockState": { - "State": "associating" - }, - "AssociationId": "vpc-cidr-assoc-eca54085" - }, - "VpcId": "vpc-a034d6c4" - } - -**To associate an additional IPv4 CIDR block with a VPC** - -This example associates the IPv4 CIDR block ``10.2.0.0/16`` with VPC ``vpc-1a2b3c4d``. - -Command:: - - aws ec2 associate-vpc-cidr-block --vpc-id vpc-1a2b3c4d --cidr-block 10.2.0.0/16 + { + "Ipv6CidrBlockAssociation": { + "AssociationId": "vpc-cidr-assoc-0838ce7d9dEXAMPLE", + "Ipv6CidrBlockState": { + "State": "associating" + }, + "NetworkBorderGroup": "us-west-2-lax-1" + }, + "VpcId": "vpc-8EXAMPLE" + } + +**Example 2:To associate an additional IPv4 CIDR block with a VPC** + +The following ``associate-vpc-cidr-block`` example associates the IPv4 CIDR block ``10.2.0.0/16`` with the specified VPC. :: + + aws ec2 associate-vpc-cidr-block \ + --vpc-id vpc-1EXAMPLE \ + --cidr-block 10.2.0.0/16 Output:: - { - "CidrBlockAssociation": { - "AssociationId": "vpc-cidr-assoc-2447724d", - "CidrBlock": "10.2.0.0/16", - "CidrBlockState": { - "State": "associating" - } - }, - "VpcId": "vpc-1a2b3c4d" - } \ No newline at end of file + { + "CidrBlockAssociation": { + "AssociationId": "vpc-cidr-assoc-2EXAMPLE", + "CidrBlock": "10.2.0.0/16", + "CidrBlockState": { + "State": "associating" + } + }, + "VpcId": "vpc-1EXAMPLE" + } diff -Nru awscli-1.16.301/awscli/examples/ec2/create-dhcp-options.rst awscli-1.17.14/awscli/examples/ec2/create-dhcp-options.rst --- awscli-1.16.301/awscli/examples/ec2/create-dhcp-options.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/create-dhcp-options.rst 2020-02-10 19:14:32.000000000 +0000 @@ -3,7 +3,10 @@ The following ``create-dhcp-options`` example creates a set of DHCP options that specifies the domain name, the domain name servers, and the NetBIOS node type. :: aws ec2 create-dhcp-options \ - --dhcp-configuration "Key=domain-name-servers,Values=10.2.5.1,10.2.5.2 Key=domain-name,Values=example.com Key=netbios-node-type,Values=2" + --dhcp-configuration \ + "Key=domain-name-servers,Values=10.2.5.1,10.2.5.2" \ + "Key=domain-name,Values=example.com" \ + "Key=netbios-node-type,Values=2" Output:: diff -Nru awscli-1.16.301/awscli/examples/ec2/create-launch-template.rst awscli-1.17.14/awscli/examples/ec2/create-launch-template.rst --- awscli-1.16.301/awscli/examples/ec2/create-launch-template.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/create-launch-template.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,49 +1,108 @@ -**To create a launch template** - -This example creates a launch template that specifies the subnet in which to launch the instance (``subnet-7b16de0c``), assigns a public IP address and an IPv6 address to the instance, and creates a tag for the instance (``purpose=webserver``). :: - - aws ec2 create-launch-template --launch-template-name TemplateForWebServer --version-description WebVersion1 --launch-template-data '{"NetworkInterfaces":[{"AssociatePublicIpAddress":true,"DeviceIndex":0,"Ipv6AddressCount":1,"SubnetId":"subnet-7b16de0c"}],"ImageId":"ami-8c1be5f6","InstanceType":"t2.small","TagSpecifications":[{"ResourceType":"instance","Tags":[{"Key":"purpose","Value":"webserver"}]}]}' - -Output:: - - { - "LaunchTemplate": { - "LatestVersionNumber": 1, - "LaunchTemplateId": "lt-01238c059e3466abc", - "LaunchTemplateName": "TemplateForWebServer", - "DefaultVersionNumber": 1, - "CreatedBy": "arn:aws:iam::123456789012:user/Bob", - "CreateTime": "2019-01-27T09:13:24.000Z" - } - } - -For more information, see `Launching an Instance from a Launch Template`_ in the *Amazon Elastic Compute Cloud User Guide*. - -**To create a launch template for Amazon EC2 Auto Scaling** - -This example creates a launch template named TemplateForAutoScaling with multiple tags and a block device mapping to specify an additional EBS volume when an instance launches. Specify a value for ``Groups`` that corresponds to security groups for the VPC that your Auto Scaling group will launch instances into. Specify the VPC and subnets as properties of the Auto Scaling group. :: - - aws ec2 create-launch-template --launch-template-name TemplateForAutoScaling --version-description AutoScalingVersion1 --launch-template-data '{"NetworkInterfaces":[{"DeviceIndex":0,"AssociatePublicIpAddress":true,"Groups":["sg-7c227019,sg-903004f8"],"DeleteOnTermination":true}],"ImageId":"ami-b42209de","InstanceType":"m4.large","TagSpecifications":[{"ResourceType":"instance","Tags":[{"Key":"environment","Value":"production"},{"Key":"purpose","Value":"webserver"}]},{"ResourceType":"volume","Tags":[{"Key":"environment","Value":"production"},{"Key":"cost-center","Value":"cc123"}]}],"BlockDeviceMappings":[{"DeviceName":"/dev/sda1","Ebs":{"VolumeSize":100}}]}' --region us-east-1 - -Output:: - - { - "LaunchTemplate": { - "LatestVersionNumber": 1, - "LaunchTemplateId": "lt-0123c79c33a54e0abc", - "LaunchTemplateName": "TemplateForAutoScaling", - "DefaultVersionNumber": 1, - "CreatedBy": "arn:aws:iam::123456789012:user/Bob", - "CreateTime": "2019-04-30T18:16:06.000Z" - } - } - -For more information, see `Creating a Launch Template for an Auto Scaling Group`_ in the *Amazon EC2 Auto Scaling User Guide*. - -For information about quoting JSON-formatted parameters, see `Quoting Strings`_ in the *AWS Command Line Interface User Guide*. - -.. _`Launching an Instance from a Launch Template`: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html - -.. _`Creating a Launch Template for an Auto Scaling Group`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html - -.. _`Quoting Strings`: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html#quoting-strings +**Example 1: To create a launch template** + +The following ``create-launch-template`` example creates a launch template that specifies the subnet in which to launch the instance , assigns a public IP address and an IPv6 address to the instance, and creates a tag for the instance. :: + + aws ec2 create-launch-template \ + --launch-template-name TemplateForWebServer \ + --version-description WebVersion1 \ + --launch-template-data '{"NetworkInterfaces":[{"AssociatePublicIpAddress":true,"DeviceIndex":0,"Ipv6AddressCount":1,"SubnetId":"subnet-7b16de0c"}],"ImageId":"ami-8c1be5f6","InstanceType":"t2.small","TagSpecifications":[{"ResourceType":"instance","Tags":[{"Key":"purpose","Value":"webserver"}]}]}' + +Output:: + + { + "LaunchTemplate": { + "LatestVersionNumber": 1, + "LaunchTemplateId": "lt-01238c059e3466abc", + "LaunchTemplateName": "TemplateForWebServer", + "DefaultVersionNumber": 1, + "CreatedBy": "arn:aws:iam::123456789012:user/Bob", + "CreateTime": "2019-01-27T09:13:24.000Z" + } + } + +For more information, see `Launching an Instance from a Launch Template`_ in the *Amazon Elastic Compute Cloud User Guide*. +For information about quoting JSON-formatted parameters, see `Quoting Strings`_ in the *AWS Command Line Interface User Guide*. + +**Example 2: To create a launch template for Amazon EC2 Auto Scaling** + +The following ``create-launch-template`` example creates a launch template with multiple tags and a block device mapping to specify an additional EBS volume when an instance launches. Specify a value for ``Groups`` that corresponds to security groups for the VPC that your Auto Scaling group will launch instances into. Specify the VPC and subnets as properties of the Auto Scaling group. :: + + aws ec2 create-launch-template \ + --launch-template-name TemplateForAutoScaling \ + --version-description AutoScalingVersion1 \ + --launch-template-data '{"NetworkInterfaces":[{"DeviceIndex":0,"AssociatePublicIpAddress":true,"Groups":["sg-7c227019,sg-903004f8"],"DeleteOnTermination":true}],"ImageId":"ami-b42209de","InstanceType":"m4.large","TagSpecifications":[{"ResourceType":"instance","Tags":[{"Key":"environment","Value":"production"},{"Key":"purpose","Value":"webserver"}]},{"ResourceType":"volume","Tags":[{"Key":"environment","Value":"production"},{"Key":"cost-center","Value":"cc123"}]}],"BlockDeviceMappings":[{"DeviceName":"/dev/sda1","Ebs":{"VolumeSize":100}}]}' --region us-east-1 + +Output:: + + { + "LaunchTemplate": { + "LatestVersionNumber": 1, + "LaunchTemplateId": "lt-0123c79c33a54e0abc", + "LaunchTemplateName": "TemplateForAutoScaling", + "DefaultVersionNumber": 1, + "CreatedBy": "arn:aws:iam::123456789012:user/Bob", + "CreateTime": "2019-04-30T18:16:06.000Z" + } + } + +For more information, see `Creating a Launch Template for an Auto Scaling Group`_ in the *Amazon EC2 Auto Scaling User Guide*. +For information about quoting JSON-formatted parameters, see `Quoting Strings`_ in the *AWS Command Line Interface User Guide*. + +**Example 3: To create a launch template that specifies encryption of EBS volumes** + +The following ``create-launch-template`` example creates a launch template that includes encrypted EBS volumes created from an unencrypted snapshot. It also tags the volumes during creation. If encryption by default is disabled, you must specify the ``"Encrypted"`` option as shown in the following example. If you use the ``"KmsKeyId"`` option to specify a customer managed CMK, you also must specify the ``"Encrypted"`` option even if encryption by default is enabled. :: + + aws ec2 create-launch-template \ + --launch-template-name TemplateForEncryption \ + --launch-template-data file://config.json + +Contents of ``config.json``:: + + { + "BlockDeviceMappings":[ + { + "DeviceName":"/dev/sda1", + "Ebs":{ + "VolumeType":"gp2", + "DeleteOnTermination":true, + "SnapshotId":"snap-066877671789bd71b", + "Encrypted":true, + "KmsKeyId":"arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef" + } + } + ], + "ImageId":"ami-00068cd7555f543d5", + "InstanceType":"c5.large", + "TagSpecifications":[ + { + "ResourceType":"volume", + "Tags":[ + { + "Key":"encrypted", + "Value":"yes" + } + ] + } + ] + } + +Output:: + + { + "LaunchTemplate": { + "LatestVersionNumber": 1, + "LaunchTemplateId": "lt-0d5bd51bcf8530abc", + "LaunchTemplateName": "TemplateForEncryption", + "DefaultVersionNumber": 1, + "CreatedBy": "arn:aws:iam::123456789012:user/Bob", + "CreateTime": "2020-01-07T19:08:36.000Z" + } + } + +For more information, see `Restoring an Amazon EBS Volume from a Snapshot`_ and `Encryption by Default`_ in the *Amazon Elastic Compute Cloud User Guide*. + +.. _`Launching an Instance from a Launch Template`: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html +.. _`Creating a Launch Template for an Auto Scaling Group`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html +.. _`Quoting Strings`: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html#quoting-strings +.. _`Restoring an Amazon EBS Volume from a Snapshot`: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-restoring-volume.html +.. _`Encryption by Default`: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default diff -Nru awscli-1.16.301/awscli/examples/ec2/create-local-gateway-route.rst awscli-1.17.14/awscli/examples/ec2/create-local-gateway-route.rst --- awscli-1.16.301/awscli/examples/ec2/create-local-gateway-route.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/create-local-gateway-route.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,19 @@ +**To create a static route for a local gateway route table** + +The following ``create-local-gateway-route`` example creates the specified route in the specified local gateway route table. :: + + aws ec2 create-local-gateway-route \ + --destination-cidr-block 0.0.0.0/0 \ + --local-gateway-route-table-id lgw-rtb-059615ef7dEXAMPLE + +Output:: + + { + "Route": { + "DestinationCidrBlock": "0.0.0.0/0", + "LocalGatewayVirtualInterfaceGroupId": "lgw-vif-grp-07145b276bEXAMPLE", + "Type": "static", + "State": "deleted", + "LocalGatewayRouteTableId": "lgw-rtb-059615ef7dEXAMPLE" + } + } diff -Nru awscli-1.16.301/awscli/examples/ec2/create-local-gateway-route-table-vpc-association.rst awscli-1.17.14/awscli/examples/ec2/create-local-gateway-route-table-vpc-association.rst --- awscli-1.16.301/awscli/examples/ec2/create-local-gateway-route-table-vpc-association.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/create-local-gateway-route-table-vpc-association.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,19 @@ +**To associate a VPC with a route table** + +The following ``create-local-gateway-route-table-vpc-association`` example associates the specified VPC with the specified local gateway route table. :: + + aws ec2 create-local-gateway-route-table-vpc-association \ + --local-gateway-route-table-id lgw-rtb-059615ef7dEXAMPLE \ + --vpc-id vpc-07ef66ac71EXAMPLE + +Output:: + + { + "LocalGatewayRouteTableVpcAssociation": { + "LocalGatewayRouteTableVpcAssociationId": "lgw-vpc-assoc-0ee765bcc8EXAMPLE", + "LocalGatewayRouteTableId": "lgw-rtb-059615ef7dEXAMPLE", + "LocalGatewayId": "lgw-09b493aa7cEXAMPLE", + "VpcId": "vpc-07ef66ac71EXAMPLE", + "State": "associated" + } + } diff -Nru awscli-1.16.301/awscli/examples/ec2/create-transit-gateway-peering-attachment.rst awscli-1.17.14/awscli/examples/ec2/create-transit-gateway-peering-attachment.rst --- awscli-1.16.301/awscli/examples/ec2/create-transit-gateway-peering-attachment.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/create-transit-gateway-peering-attachment.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,31 @@ +**To create a transit gateway peering attachment** + +The following ``create-transit-gateway-peering-attachment`` example creates a peering attachment request between the two specified transit gateways. :: + + aws ec2 create-transit-gateway-peering-attachment \ + --transit-gateway-id tgw-123abc05e04123abc \ + --peer-transit-gateway-id tgw-11223344aabbcc112 \ + --peer-account-id 123456789012 \ + --peer-region us-east-2 + +Output:: + + { + "TransitGatewayPeeringAttachment": { + "TransitGatewayAttachmentId": "tgw-attach-4455667788aabbccd", + "RequesterTgwInfo": { + "TransitGatewayId": "tgw-123abc05e04123abc", + "OwnerId": "123456789012", + "Region": "us-west-2" + }, + "AccepterTgwInfo": { + "TransitGatewayId": "tgw-11223344aabbcc112", + "OwnerId": "123456789012", + "Region": "us-east-2" + }, + "State": "initiatingRequest", + "CreationTime": "2019-12-09T11:38:05.000Z" + } + } + +For more information, see `Transit Gateway Peering Attachments `__ in the *Transit Gateways Guide*. diff -Nru awscli-1.16.301/awscli/examples/ec2/create-transit-gateway-vpc-attachment.rst awscli-1.17.14/awscli/examples/ec2/create-transit-gateway-vpc-attachment.rst --- awscli-1.16.301/awscli/examples/ec2/create-transit-gateway-vpc-attachment.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/create-transit-gateway-vpc-attachment.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,23 +1,23 @@ -**To associate a Transit Gateway with a VPC** +**Example 1: To associate a Transit Gateway with a VPC** The following ``create-transit-gateway-vpc-attachment`` example creates a transit gateway attachment to the specified VPC. :: aws ec2 create-transit-gateway-vpc-attachment \ --transit-gateway-id tgw-0262a0e521EXAMPLE \ --vpc-id vpc-07e8ffd50f49335df \ - --subnet-id subnet-0752213d59efde95a + --subnet-id subnet-0752213d59EXAMPLE Output:: { "TransitGatewayVpcAttachment": { - "TransitGatewayAttachmentId": "tgw-attach-0a34fe6b4fea0ff4a", + "TransitGatewayAttachmentId": "tgw-attach-0a34fe6b4fEXAMPLE", "TransitGatewayId": "tgw-0262a0e521EXAMPLE", "VpcId": "vpc-07e8ffd50fEXAMPLE", "VpcOwnerId": "111122223333", "State": "pending", "SubnetIds": [ - "subnet-0752213d59efde95a" + "subnet-0752213d59EXAMPLE" ], "CreationTime": "2019-07-10T17:33:46.000Z", "Options": { @@ -27,4 +27,34 @@ } } -For more information, see `Create a Transit Gateway Attachment to a VPC `__ in the *AWS Transit Gateways Guide*. +**Example 2: To associate a Transit Gateway with multiple subnets in a VPC** + +The following ``create-transit-gateway-vpc-attachment`` example creates a transit gateway attachment to the specified VPC and subnets. :: + + aws ec2 create-transit-gateway-vpc-attachment \ + --transit-gateway-id tgw-02f776b1a7EXAMPLE \ + --vpc-id vpc-3EXAMPLE \ + --subnet-ids "subnet-dEXAMPLE" "subnet-6EXAMPLE" + +Output:: + + { + "TransitGatewayVpcAttachment": { + "TransitGatewayAttachmentId": "tgw-attach-0e141e0bebEXAMPLE", + "TransitGatewayId": "tgw-02f776b1a7EXAMPLE", + "VpcId": "vpc-3EXAMPLE", + "VpcOwnerId": "111122223333", + "State": "pending", + "SubnetIds": [ + "subnet-6EXAMPLE", + "subnet-dEXAMPLE" + ], + "CreationTime": "2019-12-17T20:07:52.000Z", + "Options": { + "DnsSupport": "enable", + "Ipv6Support": "disable" + } + } + } + +For more information, see `Create a Transit Gateway Attachment to a VPC`__ in the *AWS Transit Gateways User Guide*. diff -Nru awscli-1.16.301/awscli/examples/ec2/create-vpc.rst awscli-1.17.14/awscli/examples/ec2/create-vpc.rst --- awscli-1.16.301/awscli/examples/ec2/create-vpc.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/create-vpc.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,8 +1,9 @@ -**To create a VPC** +**Example 1: To create a VPC** The following ``create-vpc`` example creates a VPC with the specified IPv4 CIDR block. :: aws ec2 create-vpc \ + --ipv6-cidr-block-network-border-group us-west-2-lax-1 \ --cidr-block 10.0.0.0/16 Output:: @@ -22,15 +23,16 @@ "CidrBlock": "10.0.0.0/16", "CidrBlockState": { "State": "associated" - } + } + "NetworkBorderGroup": "us-west-2-lax-1" } ], "IsDefault": false, "Tags": [] } - } + } -**To create a VPC with dedicated tenancy** +**Example 2: To create a VPC with dedicated tenancy** The following ``create-vpc`` example creates a VPC with the specified IPv4 CIDR block and dedicated tenancy. @@ -63,7 +65,7 @@ } } -**To create a VPC with an IPv6 CIDR block** +**Example 3: To create a VPC with an IPv6 CIDR block** The following ``create-vpc`` example creates a VPC with an Amazon-provided IPv6 CIDR block. @@ -76,23 +78,25 @@ { "Vpc": { "CidrBlock": "10.0.0.0/16", - "DhcpOptionsId": "dopt-19edf471", + "DhcpOptionsId": "dopt-dEXAMPLE", "State": "pending", - "VpcId": "vpc-07e8ffd50fEXAMPLE", - "OwnerId": "111122223333", + "VpcId": "vpc-0fc5e3406bEXAMPLE", + "OwnerId": "123456789012", "InstanceTenancy": "default", "Ipv6CidrBlockAssociationSet": [ { - "AssociationId": "vpc-cidr-assoc-0aed4e604eEXAMPLE", + "AssociationId": "vpc-cidr-assoc-068432c60bEXAMPLE", "Ipv6CidrBlock": "", "Ipv6CidrBlockState": { "State": "associating" - } + }, + "Ipv6Pool": "Amazon", + "NetworkBorderGroup": "us-west-2" } ], "CidrBlockAssociationSet": [ { - "AssociationId": "vpc-cidr-assoc-06472385d8EXAMPLE", + "AssociationId": "vpc-cidr-assoc-0669f8f9f5EXAMPLE", "CidrBlock": "10.0.0.0/16", "CidrBlockState": { "State": "associated" diff -Nru awscli-1.16.301/awscli/examples/ec2/delete-local-gateway-route.rst awscli-1.17.14/awscli/examples/ec2/delete-local-gateway-route.rst --- awscli-1.16.301/awscli/examples/ec2/delete-local-gateway-route.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/delete-local-gateway-route.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,19 @@ +**To delete a route from a local gateway route table** + +The following ``delete-local-gateway-route`` example deletes the specified route from the specified local gateway route table. :: + + aws ec2 delete-local-gateway-route \ + --destination-cidr-block 0.0.0.0/0 \ + --local-gateway-route-table-id lgw-rtb-059615ef7dEXAMPLE + +Output:: + + { + "Route": { + "DestinationCidrBlock": "0.0.0.0/0", + "LocalGatewayVirtualInterfaceGroupId": "lgw-vif-grp-07145b276bEXAMPLE", + "Type": "static", + "State": "deleted", + "LocalGatewayRouteTableId": "lgw-rtb-059615ef7EXAMPLE" + } + } diff -Nru awscli-1.16.301/awscli/examples/ec2/delete-transit-gateway-multicast-domain.rst awscli-1.17.14/awscli/examples/ec2/delete-transit-gateway-multicast-domain.rst --- awscli-1.16.301/awscli/examples/ec2/delete-transit-gateway-multicast-domain.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/delete-transit-gateway-multicast-domain.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,19 @@ +**To delete a transit gateway multicast domain** + +This example returns the route table propagations for the specified route table.:: + + aws ec2 delete-transit-gateway-multicast-domain \ + --transit-gateway-multicast-domain-id tgw-mcast-domain-0c4905cef7EXAMPLE + +Output:: + + { + "TransitGatewayMulticastDomain": { + "TransitGatewayMulticastDomainId": "tgw-mcast-domain-02bb79002bEXAMPLE", + "TransitGatewayId": "tgw-0d88d2d0d5EXAMPLE", + "State": "deleting", + "CreationTime": "2019-11-20T22:02:03.000Z" + } + } + +For more information, see 'Delete a Transit Gateway Multicast Domain'__ in the *AWS Transit Gateways User Guide*. diff -Nru awscli-1.16.301/awscli/examples/ec2/delete-transit-gateway-peering-attachment.rst awscli-1.17.14/awscli/examples/ec2/delete-transit-gateway-peering-attachment.rst --- awscli-1.16.301/awscli/examples/ec2/delete-transit-gateway-peering-attachment.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/delete-transit-gateway-peering-attachment.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,28 @@ +**To delete a transit gateway peering attachment** + +The following ``delete-transit-gateway-peering-attachment`` example deletes the specified transit gateway peering attachment. :: + + aws ec2 delete-transit-gateway-peering-attachment \ + --transit-gateway-attachment-id tgw-attach-4455667788aabbccd + +Output:: + + { + "TransitGatewayPeeringAttachment": { + "TransitGatewayAttachmentId": "tgw-attach-4455667788aabbccd", + "RequesterTgwInfo": { + "TransitGatewayId": "tgw-123abc05e04123abc", + "OwnerId": "123456789012", + "Region": "us-west-2" + }, + "AccepterTgwInfo": { + "TransitGatewayId": "tgw-11223344aabbcc112", + "OwnerId": "123456789012", + "Region": "us-east-2" + }, + "State": "deleting", + "CreationTime": "2019-12-09T11:38:31.000Z" + } + } + +For more information, see `Transit Gateway Peering Attachments `__ in the *Transit Gateways Guide*. diff -Nru awscli-1.16.301/awscli/examples/ec2/deregister-transit-gateway-multicast-group-members.rst awscli-1.17.14/awscli/examples/ec2/deregister-transit-gateway-multicast-group-members.rst --- awscli-1.16.301/awscli/examples/ec2/deregister-transit-gateway-multicast-group-members.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/deregister-transit-gateway-multicast-group-members.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,22 @@ +**To deregister group members from a multicast group** + +This example deregisters the specified network interface group member from the transit gateway multicast group. :: + + aws ec2 deregister-transit-gateway-multicast-group-members \ + --transit-gateway-multicast-domain-id tgw-mcast-domain-0c4905cef7EXAMPLE \ + --group-ip-address 224.0.1.0 \ + --network-interface-ids eni-0e246d3269EXAMPLE + +Output:: + + { + "DeregisteredMulticastGroupMembers": { + "TransitGatewayMulticastDomainId": "tgw-mcast-domain-0c4905cef7EXAMPLE", + "RegisteredNetworkInterfaceIds": [ + "eni-0e246d3269EXAMPLE" + ], + "GroupIpAddress": "224.0.1.0" + } + } + +For more information, see `Deregister Members from a Multicast Group `__ in the *AWS Transit Gateways Users Guide*. \ No newline at end of file diff -Nru awscli-1.16.301/awscli/examples/ec2/deregister-transit-gateway-multicast-group-source.rst awscli-1.17.14/awscli/examples/ec2/deregister-transit-gateway-multicast-group-source.rst --- awscli-1.16.301/awscli/examples/ec2/deregister-transit-gateway-multicast-group-source.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/deregister-transit-gateway-multicast-group-source.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,22 @@ +**To deregister a source from the transit gateway multicast group** + +This example deregisters the specified network interface group source from the multicast group. :: + + aws ec2 register-transit-gateway-multicast-group-sources \ + --transit-gateway-multicast-domain-id tgw-mcast-domain-0c4905cef79d6e597 \ + --group-ip-address 224.0.1.0 \ + --network-interface-ids eni-07f290fc3c090cbae + +Output:: + + { + "DeregisteredMulticastGroupSources": { + "TransitGatewayMulticastDomainId": "tgw-mcast-domain-0c4905cef79d6e597", + "DeregisteredNetworkInterfaceIds": [ + "eni-07f290fc3c090cbae" + ], + "GroupIpAddress": "224.0.1.0" + } + } + +For more information, see `Deregister Sources from a Multicast Group `__ in the *AWS Transit Gateways User Guide*. diff -Nru awscli-1.16.301/awscli/examples/ec2/describe-availability-zones.rst awscli-1.17.14/awscli/examples/ec2/describe-availability-zones.rst --- awscli-1.16.301/awscli/examples/ec2/describe-availability-zones.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/describe-availability-zones.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,33 +1,62 @@ **To describe your Availability Zones** -The following ``describe-availability-zones`` example describes the Availability Zones that are available to you. The response includes Availability Zones only for the current Region. :: +The following example ``describe-availability-zones`` displays details for the Availability Zones that are available to you. The response includes Availability Zones only for the current Region. In this example, it uses the profiles default ``us-west-2`` (Oregon) Region. :: aws ec2 describe-availability-zones -The following is example example output for the US East (Ohio) Region. :: +Output:: { "AvailabilityZones": [ { "State": "available", + "OptInStatus": "opt-in-not-required", "Messages": [], - "RegionName": "us-east-2", - "ZoneName": "us-east-2a", - "ZoneId": "use2-az1" + "RegionName": "us-west-2", + "ZoneName": "us-west-2a", + "ZoneId": "usw2-az1", + "GroupName": "us-west-2", + "NetworkBorderGroup": "us-west-2" }, { "State": "available", + "OptInStatus": "opt-in-not-required", "Messages": [], - "RegionName": "us-east-2", - "ZoneName": "us-east-2b", - "ZoneId": "use2-az2" + "RegionName": "us-west-2", + "ZoneName": "us-west-2b", + "ZoneId": "usw2-az2", + "GroupName": "us-west-2", + "NetworkBorderGroup": "us-west-2" }, { "State": "available", + "OptInStatus": "opt-in-not-required", "Messages": [], - "RegionName": "us-east-2", - "ZoneName": "us-east-2c", - "ZoneId": "use2-az3" + "RegionName": "us-west-2", + "ZoneName": "us-west-2c", + "ZoneId": "usw2-az3", + "GroupName": "us-west-2", + "NetworkBorderGroup": "us-west-2" + }, + { + "State": "available", + "OptInStatus": "opt-in-not-required", + "Messages": [], + "RegionName": "us-west-2", + "ZoneName": "us-west-2d", + "ZoneId": "usw2-az4", + "GroupName": "us-west-2", + "NetworkBorderGroup": "us-west-2" + }, + { + "State": "available", + "OptInStatus": "opted-in", + "Messages": [], + "RegionName": "us-west-2", + "ZoneName": "us-west-2-lax-1a", + "ZoneId": "usw2-lax1-az1", + "GroupName": "us-west-2-lax-1", + "NetworkBorderGroup": "us-west-2-lax-1" } ] } diff -Nru awscli-1.16.301/awscli/examples/ec2/describe-fast-snapshot-restores.rst awscli-1.17.14/awscli/examples/ec2/describe-fast-snapshot-restores.rst --- awscli-1.16.301/awscli/examples/ec2/describe-fast-snapshot-restores.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/describe-fast-snapshot-restores.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,29 @@ +**To describe fast snapshot restores** + +The following ``describe-fast-snapshot-restores`` example displays details for all fast snapshot restores with a state of ``disabled``. :: + + aws ec2 describe-fast-snapshot-restores \ + --filters Name=state,Values=disabled + +Output:: + + { + "FastSnapshotRestores": [ + { + "SnapshotId": "snap-1234567890abcdef0", + "AvailabilityZone": "us-west-2c", + "State": "disabled", + "StateTransitionReason": "Client.UserInitiated - Lifecycle state transition", + "OwnerId": "123456789012", + "EnablingTime": "2020-01-25T23:57:49.596Z", + "OptimizingTime": "2020-01-25T23:58:25.573Z", + "EnabledTime": "2020-01-25T23:59:29.852Z", + "DisablingTime": "2020-01-26T00:40:56.069Z", + "DisabledTime": "2020-01-26T00:41:27.390Z" + } + ] + } + +The following ``describe-fast-snapshot-restores`` example describes all fast snapshot restores. :: + + aws ec2 describe-fast-snapshot-restores diff -Nru awscli-1.16.301/awscli/examples/ec2/describe-instances.rst awscli-1.17.14/awscli/examples/ec2/describe-instances.rst --- awscli-1.16.301/awscli/examples/ec2/describe-instances.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/describe-instances.rst 2020-02-10 19:14:32.000000000 +0000 @@ -2,22 +2,27 @@ The following ``describe-instances`` example displays details about the specified instance. :: - aws ec2 describe-instances \ - --instance-ids i-1234567890abcdef0 + aws ec2 describe-instances --instance-ids i-1234567890abcdef0 **Example 2: To describe instances based on instance type** The following ``describe-instances`` example displays details about only instances of the specified type. :: - aws ec2 describe-instances \ - --filters Name=instance-type,Values=m5.large + aws ec2 describe-instances --filters Name=instance-type,Values=m5.large -**Example 3: To describe instances based on a tag key and value** +**Example 3: To describe instances based on tags** -The following ``describe-instances`` example displays details about only those instances that have a tag with the specified key name and value. :: +The following ``describe-instances`` example displays details about only those instances that have a tag with the specified tag key (Owner), regardless of the tag value. :: - aws ec2 describe-instances \ - --filters "Name=tag-key,Values=Owner" + aws ec2 describe-instances --filters "Name=tag-key,Values=Owner" + +The following ``describe-instances`` example displays details about only those instances that have a tag with the specified tag value (my-team), regardless of the tag key. :: + + aws ec2 describe-instances --filters "Name=tag-value,Values=my-team" + +The following ``describe-instances`` example displays details about only those instances that have the specified tag (Owner=my-team). :: + + aws ec2 describe-instances --filters "Name=tag:Owner,Values=my-team" **Example 4: To filter the results based on multiple conditions** @@ -28,8 +33,7 @@ The following ``describe-instances`` example uses a JSON input file to perform the same filtering as the previous example. When filters get more complicated, they can be easier to specify in a JSON file. :: - aws ec2 describe-instances \ - --filters file://filters.json + aws ec2 describe-instances --filters file://filters.json Contents of ``filters.json``:: @@ -164,4 +168,4 @@ } ], -For more information, see `Describing Instances in a Placement Group `__ in the *Amazon Elastic Compute Cloud Users Guide*. +For more information, see `Describing Instances in a Placement Group `__ in the *Amazon Elastic Compute Cloud Users Guide*. \ No newline at end of file diff -Nru awscli-1.16.301/awscli/examples/ec2/describe-instance-type-offerings.rst awscli-1.17.14/awscli/examples/ec2/describe-instance-type-offerings.rst --- awscli-1.16.301/awscli/examples/ec2/describe-instance-type-offerings.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/describe-instance-type-offerings.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,82 @@ +**Example 1: To list the instance types offered in a Region** + +The following ``describe-instance-type-offerings`` example lists the instance types offered in the Region configured as the default Region for the AWS CLI. :: + + aws ec2 describe-instance-type-offerings + +To list the instance types offered in a different Region, specify the Region using the ``--region`` parameter. :: + + aws ec2 describe-instance-type-offerings \ + --region us-east-2 + +Output:: + + { + "InstanceTypeOfferings": [ + { + "InstanceType": "m5.2xlarge", + "LocationType": "region", + "Location": "us-east-2" + }, + { + "InstanceType": "t3.micro", + "LocationType": "region", + "Location": "us-east-2" + }, + ... + ] + } + +**Example 2: To list the instance types offered in an Availability Zone** + +The following ``describe-instance-type-offerings`` example lists the instance types offered in the specified Availability Zone. The Availability Zone must be in the specified Region. :: + + aws ec2 describe-instance-type-offerings \ + --location-type availability-zone \ + --filters Name=location,Values=us-east-2a \ + --region us-east-2 + +**Example 3: To check whether an instance type is supported** + +The following ``describe-instance-type-offerings`` command indicates whether the ``c5.xlarge`` instance type is supported in the specified Region. :: + + aws ec2 describe-instance-type-offerings \ + --filters Name=instance-type,Values=c5.xlarge \ + --region us-east-2 + +The following ``describe-instance-type-offerings`` example lists all C5 instance types that are supported in the specified Region. :: + + aws ec2 describe-instance-type-offerings \ + --filters Name=instance-type,Values=c5* \ + --query "InstanceTypeOfferings[].InstanceType" \ + --region us-east-2 + +Output:: + + [ + "c5d.12xlarge", + "c5d.9xlarge", + "c5n.xlarge", + "c5.xlarge", + "c5d.metal", + "c5n.metal", + "c5.large", + "c5d.2xlarge", + "c5n.4xlarge", + "c5.2xlarge", + "c5n.large", + "c5n.9xlarge", + "c5d.large", + "c5.18xlarge", + "c5d.18xlarge", + "c5.12xlarge", + "c5n.18xlarge", + "c5.metal", + "c5d.4xlarge", + "c5.24xlarge", + "c5d.xlarge", + "c5n.2xlarge", + "c5d.24xlarge", + "c5.9xlarge", + "c5.4xlarge" + ] diff -Nru awscli-1.16.301/awscli/examples/ec2/describe-instance-types.rst awscli-1.17.14/awscli/examples/ec2/describe-instance-types.rst --- awscli-1.16.301/awscli/examples/ec2/describe-instance-types.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/describe-instance-types.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,97 @@ +**Example 1: To describe an instance type** + +The following ``describe-instance-types`` example displays details for the specified instance type. :: + + aws ec2 describe-instance-types \ + --instance-types t2.micro + +Output:: + + { + "InstanceTypes": [ + { + "InstanceType": "t2.micro", + "CurrentGeneration": true, + "FreeTierEligible": true, + "SupportedUsageClasses": [ + "on-demand", + "spot" + ], + "SupportedRootDeviceTypes": [ + "ebs" + ], + "BareMetal": false, + "Hypervisor": "xen", + "ProcessorInfo": { + "SupportedArchitectures": [ + "i386", + "x86_64" + ], + "SustainedClockSpeedInGhz": 2.5 + }, + "VCpuInfo": { + "DefaultVCpus": 1, + "DefaultCores": 1, + "DefaultThreadsPerCore": 1, + "ValidCores": [ + 1 + ], + "ValidThreadsPerCore": [ + 1 + ] + }, + "MemoryInfo": { + "SizeInMiB": 1024 + }, + "InstanceStorageSupported": false, + "EbsInfo": { + "EbsOptimizedSupport": "unsupported", + "EncryptionSupport": "supported" + }, + "NetworkInfo": { + "NetworkPerformance": "Low to Moderate", + "MaximumNetworkInterfaces": 2, + "Ipv4AddressesPerInterface": 2, + "Ipv6AddressesPerInterface": 2, + "Ipv6Supported": true, + "EnaSupport": "unsupported" + }, + "PlacementGroupInfo": { + "SupportedStrategies": [ + "partition", + "spread" + ] + }, + "HibernationSupported": false, + "BurstablePerformanceSupported": true, + "DedicatedHostsSupported": false, + "AutoRecoverySupported": true + } + ] + } + +**Example 2: To filter the available instance types** + +You can specify a filter to scope the results to instance types that have a specific characteristic. The following ``describe-instance-types`` example lists the instance types that support hibernation. :: + + aws ec2 describe-instance-types --filters Name=hibernation-supported,Values=true --query InstanceTypes[].InstanceType + +Output:: + + [ + "m5.8xlarge", + "r3.large", + "c3.8xlarge", + "r5.large", + "m4.4xlarge", + "c4.large", + "m5.xlarge", + "m4.xlarge", + "c3.large", + "c4.8xlarge", + "c4.4xlarge", + "c5.xlarge", + "c5.12xlarge", + "r5.4xlarge", + "c5.4xlarge" + ] diff -Nru awscli-1.16.301/awscli/examples/ec2/describe-ipv6-pools.rst awscli-1.17.14/awscli/examples/ec2/describe-ipv6-pools.rst --- awscli-1.16.301/awscli/examples/ec2/describe-ipv6-pools.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/describe-ipv6-pools.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,26 @@ +**To describe your IPv6 address pools** + +The following ``describe-ipv6-pools`` example displays details for all of your IPv6 address pools. :: + + aws ec2 describe-ipv6-pools + +Output:: + + { + "Ipv6Pools": [ + { + "PoolId": "ipv6pool-ec2-012345abc12345abc", + "PoolCidrBlocks": [ + { + "Cidr": "2001:db8:123::/48" + } + ], + "Tags": [ + { + "Key": "pool-1", + "Value": "public" + } + ] + } + ] + } diff -Nru awscli-1.16.301/awscli/examples/ec2/describe-local-gateway-route-tables.rst awscli-1.17.14/awscli/examples/ec2/describe-local-gateway-route-tables.rst --- awscli-1.16.301/awscli/examples/ec2/describe-local-gateway-route-tables.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/describe-local-gateway-route-tables.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,18 @@ +**To describe your Local Gateway Route Tables** + +The following ``describe-local-gateway-route-tables`` example displays details about the local gateway route tables. :: + + aws ec2 describe-local-gateway-route-tables + +Output:: + + { + "LocalGatewayRouteTables": [ + { + "LocalGatewayRouteTableId": "lgw-rtb-059615ef7deEXAMPLE", + "LocalGatewayId": "lgw-09b493aa7cEXAMPLE", + "OutpostArn": "arn:aws:outposts:us-west-2:111122223333:outpost/op-0dc11b66edEXAMPLE", + "State": "available" + } + ] + } diff -Nru awscli-1.16.301/awscli/examples/ec2/describe-local-gateway-route-table-vpc-associations.rst awscli-1.17.14/awscli/examples/ec2/describe-local-gateway-route-table-vpc-associations.rst --- awscli-1.16.301/awscli/examples/ec2/describe-local-gateway-route-table-vpc-associations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/describe-local-gateway-route-table-vpc-associations.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,18 @@ +**To describe the associations between VPCs and local gateway route tables** + +The following ``describe-local-gateway-route-table-vpc-associations`` example displays details for the specified association between VPCs and local gateway route tables. :: + + aws ec2 describe-local-gateway-route-table-vpc-associations \ + --local-gateway-route-table-vpc-association-id lgw-vpc-assoc-0e0f27af15EXAMPLE + +Output:: + + { + "LocalGatewayRouteTableVpcAssociation": { + "LocalGatewayRouteTableVpcAssociationId": "lgw-vpc-assoc-0e0f27af1EXAMPLE", + "LocalGatewayRouteTableId": "lgw-rtb-059615ef7dEXAMPLE", + "LocalGatewayId": "lgw-09b493aa7cEXAMPLE", + "VpcId": "vpc-0efe9bde08EXAMPLE", + "State": "associated" + } + } diff -Nru awscli-1.16.301/awscli/examples/ec2/describe-local-gateways.rst awscli-1.17.14/awscli/examples/ec2/describe-local-gateways.rst --- awscli-1.16.301/awscli/examples/ec2/describe-local-gateways.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/describe-local-gateways.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,18 @@ +**To describe your Local Gateways** + +The following ``describe-local-gateways`` example displays details for the local gateways that are available to you. :: + + aws ec2 describe-local-gateways + +Output:: + + { + "LocalGateways": [ + { + "LocalGatewayId": "lgw-09b493aa7cEXAMPLE", + "OutpostArn": "arn:aws:outposts:us-west-2:123456789012:outpost/op-0dc11b66ed59f995a", + "OwnerId": "123456789012", + "State": "available" + } + ] + } diff -Nru awscli-1.16.301/awscli/examples/ec2/describe-transit-gateway-peering-attachments.rst awscli-1.17.14/awscli/examples/ec2/describe-transit-gateway-peering-attachments.rst --- awscli-1.16.301/awscli/examples/ec2/describe-transit-gateway-peering-attachments.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/describe-transit-gateway-peering-attachments.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,30 @@ +**To describe your transit gateway peering attachments** + +The following ``describe-transit-gateway-peering-attachments`` example displays details for all of your transit gateway peering attachments. :: + + aws ec2 describe-transit-gateway-peering-attachments + +Output:: + + { + "TransitGatewayPeeringAttachments": [ + { + "TransitGatewayAttachmentId": "tgw-attach-4455667788aabbccd", + "RequesterTgwInfo": { + "TransitGatewayId": "tgw-123abc05e04123abc", + "OwnerId": "123456789012", + "Region": "us-west-2" + }, + "AccepterTgwInfo": { + "TransitGatewayId": "tgw-11223344aabbcc112", + "OwnerId": "123456789012", + "Region": "us-east-2" + }, + "State": "pendingAcceptance", + "CreationTime": "2019-12-09T11:38:05.000Z", + "Tags": [] + } + ] + } + +For more information, see `Transit Gateway Peering Attachments `__ in the *Transit Gateways Guide*. diff -Nru awscli-1.16.301/awscli/examples/ec2/disable-fast-snapshot-restores.rst awscli-1.17.14/awscli/examples/ec2/disable-fast-snapshot-restores.rst --- awscli-1.16.301/awscli/examples/ec2/disable-fast-snapshot-restores.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/disable-fast-snapshot-restores.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,23 @@ +**To disable fast snapshot restore** + +The following ``disable-fast-snapshot-restores`` example disables fast snapshot restore for the specified snapshot in the specified Availability Zone. :: + + aws ec2 disable-fast-snapshot-restores \ + --availability-zones us-east-2a \ + --source-snapshot-ids snap-1234567890abcdef0 + +Output:: + + { + "Successful": [ + { + "SnapshotId": "snap-1234567890abcdef0" + "AvailabilityZone": "us-east-2a", + "State": "disabling", + "StateTransitionReason": "Client.UserInitiated", + "OwnerId": "123456789012", + "EnablingTime": "2020-01-25T23:57:49.602Z" + } + ], + "Unsuccessful": [] + } diff -Nru awscli-1.16.301/awscli/examples/ec2/disassociate-transit-gateway-multicast-domain.rst awscli-1.17.14/awscli/examples/ec2/disassociate-transit-gateway-multicast-domain.rst --- awscli-1.16.301/awscli/examples/ec2/disassociate-transit-gateway-multicast-domain.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/disassociate-transit-gateway-multicast-domain.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,27 @@ +**To disassociate subnets from a multicast domain** + +This example disassociates a subnet from the specified multicast domain. :: + + aws ec2 disassociate-transit-gateway-multicast-domain \ + --transit-gateway-attachment-id tgw-attach-070e571cd1EXAMPLE \ + --subnet-id subnet-000de86e3bEXAMPLE \ + --transit-gateway-multicast-domain-id tgw-mcast-domain-0c4905cef7EXAMPLE + +Output:: + + { + "Associations": { + "TransitGatewayMulticastDomainId": "tgw-mcast-domain-0c4905cef7EXAMPLE", + "TransitGatewayAttachmentId": "tgw-attach-070e571cd1EXAMPLE", + "ResourceId": "vpc-7EXAMPLE", + "ResourceType": "vpc", + "Subnets": [ + { + "SubnetId": "subnet-000de86e3bEXAMPLE", + "State": "disassociating" + } + ] + } + } + +For more information, see 'Disassociate Subnets from a Transit Gateway Multicast Domain'__ in the *AWS Transit Gateways User Guide*'. diff -Nru awscli-1.16.301/awscli/examples/ec2/enable-fast-snapshot-restores.rst awscli-1.17.14/awscli/examples/ec2/enable-fast-snapshot-restores.rst --- awscli-1.16.301/awscli/examples/ec2/enable-fast-snapshot-restores.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/enable-fast-snapshot-restores.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,31 @@ +**To enable fast snapshot restore** + +The following ``enable-fast-snapshot-restores`` example enables fast snapshot restore for the specified snapshot in the specified Availability Zones. :: + + aws ec2 enable-fast-snapshot-restores \ + --availability-zones us-east-2a us-east-2b \ + --source-snapshot-ids snap-1234567890abcdef0 + +Output:: + + { + "Successful": [ + { + "SnapshotId": "snap-1234567890abcdef0" + "AvailabilityZone": "us-east-2a", + "State": "enabling", + "StateTransitionReason": "Client.UserInitiated", + "OwnerId": "123456789012", + "EnablingTime": "2020-01-25T23:57:49.602Z" + }, + { + "SnapshotId": "snap-1234567890abcdef0" + "AvailabilityZone": "us-east-2b", + "State": "enabling", + "StateTransitionReason": "Client.UserInitiated", + "OwnerId": "123456789012", + "EnablingTime": "2020-01-25T23:57:49.596Z" + } + ], + "Unsuccessful": [] + } diff -Nru awscli-1.16.301/awscli/examples/ec2/get-associated-ipv6-pool-cidrs.rst awscli-1.17.14/awscli/examples/ec2/get-associated-ipv6-pool-cidrs.rst --- awscli-1.16.301/awscli/examples/ec2/get-associated-ipv6-pool-cidrs.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/get-associated-ipv6-pool-cidrs.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,17 @@ +**To get the associations for an IPv6 address pool** + +The following ``get-associated-ipv6-pool-cidrs`` example gets the associations for the specified IPv6 address pool. :: + + aws ec2 get-associated-ipv6-pool-cidrs \ + --pool-id ipv6pool-ec2-012345abc12345abc + +Output:: + + { + "Ipv6CidrAssociations": [ + { + "Ipv6Cidr": "2001:db8:1234:1a00::/56", + "AssociatedResource": "vpc-111111222222333ab" + } + ] + } diff -Nru awscli-1.16.301/awscli/examples/ec2/get-default-credit-specification.rst awscli-1.17.14/awscli/examples/ec2/get-default-credit-specification.rst --- awscli-1.16.301/awscli/examples/ec2/get-default-credit-specification.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/get-default-credit-specification.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,15 @@ +**To describe the default credit option** + +The following ``get-default-credit-specification`` example describes the default credit option for T2 instances. :: + + aws ec2 get-default-credit-specification \ + --instance-family t2 + +Output:: + + { + "InstanceFamilyCreditSpecification": { + "InstanceFamily": "t2", + "CpuCredits": "standard" + } + } diff -Nru awscli-1.16.301/awscli/examples/ec2/get-transit-gateway-multicast-domain-associations.rst awscli-1.17.14/awscli/examples/ec2/get-transit-gateway-multicast-domain-associations.rst --- awscli-1.16.301/awscli/examples/ec2/get-transit-gateway-multicast-domain-associations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/get-transit-gateway-multicast-domain-associations.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,60 @@ +**To view the information about the transit gateway multicast domain associations** + +This example returns the associations for the specified transit gateway multicast domain. :: + + aws ec2 get-transit-gateway-multicast-domain-associations \ + --transit-gateway-multicast-domain-id tgw-mcast-domain-0c4905cef7EXAMPLE + +Output:: + + { + "MulticastDomainAssociations": [ + { + "TransitGatewayAttachmentId": "tgw-attach-028c1dd0f8EXAMPLE", + "ResourceId": "vpc-01128d2c24EXAMPLE", + "ResourceType": "vpc", + "Subnet": { + "SubnetId": "subnet-000de86e3bEXAMPLE", + "State": "associated" + } + }, + { + "TransitGatewayAttachmentId": "tgw-attach-070e571cd1EXAMPLE", + "ResourceId": "vpc-7EXAMPLE", + "ResourceType": "vpc", + "Subnet": { + "SubnetId": "subnet-4EXAMPLE", + "State": "associated" + } + }, + { + "TransitGatewayAttachmentId": "tgw-attach-070e571cd1EXAMPLE", + "ResourceId": "vpc-7EXAMPLE", + "ResourceType": "vpc", + "Subnet": { + "SubnetId": "subnet-5EXAMPLE", + "State": "associated" + } + }, + { + "TransitGatewayAttachmentId": "tgw-attach-070e571cd1EXAMPLE", + "ResourceId": "vpc-7EXAMPLE", + "ResourceType": "vpc", + "Subnet": { + "SubnetId": "subnet-aEXAMPLE", + "State": "associated" + } + }, + { + "TransitGatewayAttachmentId": "tgw-attach-070e571cd1EXAMPLE", + "ResourceId": "vpc-7EXAMPLE", + "ResourceType": "vpc", + "Subnet": { + "SubnetId": "subnet-fEXAMPLE", + "State": "associated" + } + } + ] + } + +For more information, see 'View Your Transit Gateway Multicast Domain Associations '__ in the *AWS Transit Gateways User Guide*. diff -Nru awscli-1.16.301/awscli/examples/ec2/modify-default-credit-specification.rst awscli-1.17.14/awscli/examples/ec2/modify-default-credit-specification.rst --- awscli-1.16.301/awscli/examples/ec2/modify-default-credit-specification.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/modify-default-credit-specification.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,16 @@ +**To modify the default credit option** + +The following ``modify-default-credit-specification`` example modifies the default credit option for T2 instances. :: + + aws ec2 modify-default-credit-specification \ + --instance-family t2 \ + --cpu-credits unlimited + +Output:: + + { + "InstanceFamilyCreditSpecification": { + "InstanceFamily": "t2", + "CpuCredits": "unlimited" + } + } diff -Nru awscli-1.16.301/awscli/examples/ec2/modify-fpga-image-attribute.rst awscli-1.17.14/awscli/examples/ec2/modify-fpga-image-attribute.rst --- awscli-1.16.301/awscli/examples/ec2/modify-fpga-image-attribute.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/modify-fpga-image-attribute.rst 2020-02-10 19:14:32.000000000 +0000 @@ -4,7 +4,7 @@ Command:: - aws ec2 modify-fpga-image-attribute --attribute loadPermission --fpga-image-id afi-0d123e123bfc85abc --load-permission Add=[{UserId=123456789012} + aws ec2 modify-fpga-image-attribute --attribute loadPermission --fpga-image-id afi-0d123e123bfc85abc --load-permission Add=[{UserId=123456789012}] Output:: diff -Nru awscli-1.16.301/awscli/examples/ec2/register-transit-gateway-multicast-group-members.rst awscli-1.17.14/awscli/examples/ec2/register-transit-gateway-multicast-group-members.rst --- awscli-1.16.301/awscli/examples/ec2/register-transit-gateway-multicast-group-members.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/register-transit-gateway-multicast-group-members.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,22 @@ +**To view the information about the transit gateway multicast domain associations** + +This example returns the associations for the specified transit gateway multicast domain. :: + + aws ec2 register-transit-gateway-multicast-group-members \ + --transit-gateway-multicast-domain-id tgw-mcast-domain-0c4905cef79d6e597 \ + --group-ip-address 224.0.1.0 \ + --network-interface-ids eni-0e246d32695012e81 + +Output:: + + { + "RegisteredMulticastGroupMembers": { + "TransitGatewayMulticastDomainId": "tgw-mcast-domain-0c4905cef79d6e597", + "RegisteredNetworkInterfaceIds": [ + "eni-0e246d32695012e81" + ], + "GroupIpAddress": "224.0.1.0" + } + } + +For more information, see `Register Members with a Multicast Group `__ in the *AWS Transit Gateways User Guide*. diff -Nru awscli-1.16.301/awscli/examples/ec2/register-transit-gateway-multicast-group-source.rst awscli-1.17.14/awscli/examples/ec2/register-transit-gateway-multicast-group-source.rst --- awscli-1.16.301/awscli/examples/ec2/register-transit-gateway-multicast-group-source.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/register-transit-gateway-multicast-group-source.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,22 @@ +**To register a source with a transit gateway multicast group.** + +This example registers the specified network interface group source with a multicast group. :: + + aws ec2 register-transit-gateway-multicast-group-sources \ + --transit-gateway-multicast-domain-id tgw-mcast-domain-0c4905cef79d6e597 \ + --group-ip-address 224.0.1.0 \ + --network-interface-ids eni-07f290fc3c090cbae + +Output:: + + { + "RegisteredMulticastGroupSources": { + "TransitGatewayMulticastDomainId": "tgw-mcast-domain-0c4905cef79d6e597", + "RegisteredNetworkInterfaceIds": [ + "eni-07f290fc3c090cbae" + ], + "GroupIpAddress": "224.0.1.0" + } + } + +For more information, see `Register Sources with a Multicast Group `__ in the *AWS Transit Gateways User Guide*. diff -Nru awscli-1.16.301/awscli/examples/ec2/reject-transit-gateway-peering-attachment.rst awscli-1.17.14/awscli/examples/ec2/reject-transit-gateway-peering-attachment.rst --- awscli-1.16.301/awscli/examples/ec2/reject-transit-gateway-peering-attachment.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/reject-transit-gateway-peering-attachment.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,29 @@ +**To reject a transit gateway peering attachment** + +The following ``reject-transit-gateway-peering-attachment`` example rejects the specified transit gateway peering attachment request. The ``--region`` parameter specifies the Region that the accepter transit gateway is located in. :: + + aws ec2 reject-transit-gateway-peering-attachment \ + --transit-gateway-attachment-id tgw-attach-4455667788aabbccd \ + --region us-east-2 + +Output:: + + { + "TransitGatewayPeeringAttachment": { + "TransitGatewayAttachmentId": "tgw-attach-4455667788aabbccd", + "RequesterTgwInfo": { + "TransitGatewayId": "tgw-123abc05e04123abc", + "OwnerId": "123456789012", + "Region": "us-west-2" + }, + "AccepterTgwInfo": { + "TransitGatewayId": "tgw-11223344aabbcc112", + "OwnerId": "123456789012", + "Region": "us-east-2" + }, + "State": "rejecting", + "CreationTime": "2019-12-09T11:50:31.000Z" + } + } + +For more information, see `Transit Gateway Peering Attachments `__ in the *Transit Gateways Guide*. diff -Nru awscli-1.16.301/awscli/examples/ec2/reject-transit-gateway-vpc-attachments.rst awscli-1.17.14/awscli/examples/ec2/reject-transit-gateway-vpc-attachments.rst --- awscli-1.16.301/awscli/examples/ec2/reject-transit-gateway-vpc-attachments.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/reject-transit-gateway-vpc-attachments.rst 2020-02-10 19:14:32.000000000 +0000 @@ -12,7 +12,7 @@ "TransitGatewayAttachmentId": "tgw-attach-0a34fe6b4fEXAMPLE", "TransitGatewayId": "tgw-0262a0e521EXAMPLE", "VpcId": "vpc-07e8ffd50fEXAMPLE", - "VpcOwnerId": "123456789012", + "VpcOwnerId": "111122223333", "State": "pending", "SubnetIds": [ "subnet-0752213d59EXAMPLE" @@ -25,4 +25,4 @@ } } -For more information, see `Transit Gateway Attachments to a VPC `__ in the *AWS Transit Gateways*. +For more information, see `Transit Gateway Attachments to a VPC `__ in the *AWS Transit Gateways User Guide*. diff -Nru awscli-1.16.301/awscli/examples/ec2/run-instances.rst awscli-1.17.14/awscli/examples/ec2/run-instances.rst --- awscli-1.16.301/awscli/examples/ec2/run-instances.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/run-instances.rst 2020-02-10 19:14:32.000000000 +0000 @@ -350,3 +350,49 @@ --key-name MyKeyPair \ --subnet-id subnet-6e7f829e\ --placement "GroupName = HDFS-Group-A, PartitionNumber = 3" + +**Example 11: To require the use of Instance Metadata Service Version 2 on a new instance** + +The following ``run-instances`` example launches a ``c3.large`` instance with ``metadata-options`` set to ``HttpTokens=required``. Because the secure token header is set to ``required`` for metadata retrieval requests, this opts in the instance to require using IMDSv2 when requesting instance metadata. + +**Note:** +- When specifying a value for ``HttpTokens``, you must also set ``HttpEndpoint`` to ``enabled``. +- In the example, the ``--count`` and ``--security-group`` parameters are not included. For ``--count``, the default is ``1``. If you have a default VPC and a default security group, they are used. :: + + aws ec2 run-instances \ + --image-id ami-1a2b3c4d \ + --instance-type c3.large \ + --key-name MyKeyPair \ + --metadata-options "HttpEndpoint=enabled,HttpTokens=required" + +For more information, see `Configuring the Instance Metadata Service `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. + +**Example 12: To turn off access to instance metadata on a new instance** + +The following ``run-instances`` example launches a ``c3.large`` instance with ``metadata-options`` set to ``HttpEndpoint=disabled``. When the HTTP endpoint of the instance metadata service is set to ``disabled``, access to your instance metadata is turned off regardless of which version of the instance metadata service you are using. You can reverse this change at any time by enabling the HTTP endpoint, using the ``modify-instance-metadata-options`` command. + +**Note:** In the example, the ``--count`` and ``--security-group`` parameters are not included. For ``--count``, the default is ``1``. If you have a default VPC and a default security group, they are used. :: + + aws ec2 run-instances \ + --image-id ami-1a2b3c4d \ + --instance-type c3.large \ + --key-name MyKeyPair \ + --metadata-options "HttpEndpoint=disabled" + +For more information, see `Configuring the Instance Metadata Service `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. + +**Example 13: To specify the PUT response hop limit on a new instance** + +The following ``run-instances`` example launches a ``c3.large`` instance with ``metadata-options`` set to ``HttpTokens=required`` and ``HttpPutResponseHopLimit=3``. Because the secure token header is set to ``required`` for metadata retrieval requests, this opts in the instance to require using IMDSv2 when requesting instance metadata. In this example, ``HttpPutResponseHopLimit=3`` sets the allowable number of network hops for the instance metadata PUT response to ``3``. + +**Note:** +- When specifying a value for ``HttpTokens`` or ``HttpPutResponseHopLimit``, you must also set ``HttpEndpoint`` to ``enabled``. +- In the example, the ``--count`` and ``--security-group`` parameters are not included. For ``--count``, the default is ``1``. If you have a default VPC and a default security group, they are used. :: + + aws ec2 run-instances \ + --image-id ami-1a2b3c4d \ + --instance-type c3.large \ + --key-name MyKeyPair \ + --metadata-options "HttpEndpoint=enabled,HttpTokens=required,HttpPutResponseHopLimit=3" + +For more information, see `Configuring the Instance Metadata Service `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. diff -Nru awscli-1.16.301/awscli/examples/ec2/search-local-gateway-routes.rst awscli-1.17.14/awscli/examples/ec2/search-local-gateway-routes.rst --- awscli-1.16.301/awscli/examples/ec2/search-local-gateway-routes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/search-local-gateway-routes.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,19 @@ +**To search for routes in a local gateway route table** + + The following ``search-local-gateway-routes`` example searches for static routes in the specified local gateway route table. :: + + aws ec2 search-local-gateway-routes \ + --local-gateway-route-table-id lgw-rtb-059615ef7dEXAMPLE \ + --filters "Name=type,Values=static" + +Output:: + + { + "Route": { + "DestinationCidrBlock": "0.0.0.0/0", + "LocalGatewayVirtualInterfaceGroupId": "lgw-vif-grp-07145b276bEXAMPLE", + "Type": "static", + "State": "deleted", + "LocalGatewayRouteTableId": "lgw-rtb-059615ef7EXAMPLE" + } + } diff -Nru awscli-1.16.301/awscli/examples/ec2/search-transit-gateway-multicast-groups.rst awscli-1.17.14/awscli/examples/ec2/search-transit-gateway-multicast-groups.rst --- awscli-1.16.301/awscli/examples/ec2/search-transit-gateway-multicast-groups.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/search-transit-gateway-multicast-groups.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,26 @@ +**To search one or more transit gateway multicast groups and return the group membership information** + +The following ``search-transit-gateway-multicast-groups`` example returns the group membership of the specified multicast group. :: + + aws ec2 search-transit-gateway-multicast-groups \ + --transit-gateway-multicast-domain-id tgw-mcast-domain-000fb24d04EXAMPLE + +Output:: + + { + "MulticastGroups": [ + { + "GroupIpAddress": "224.0.1.0", + "TransitGatewayAttachmentId": "tgw-attach-0372e72386EXAMPLE", + "SubnetId": "subnet-0187aff814EXAMPLE", + "ResourceId": "vpc-0065acced4EXAMPLE", + "ResourceType": "vpc", + "NetworkInterfaceId": "eni-03847706f6EXAMPLE", + "GroupMember": false, + "GroupSource": true, + "SourceType": "static" + } + ] + } + +For more information, see `View Your Multicast Groups `__ in the *AWS Transit Gateways User Guide*. diff -Nru awscli-1.16.301/awscli/examples/ec2/wait/bundle-task-complete.rst awscli-1.17.14/awscli/examples/ec2/wait/bundle-task-complete.rst --- awscli-1.16.301/awscli/examples/ec2/wait/bundle-task-complete.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/wait/bundle-task-complete.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,8 @@ +**To pause running until a bundle task is completed** + +The following ``wait bundle-task-completed`` example pauses and continues only after it can confirm that the specified bundle task is completed. :: + + aws ec2 wait bundle-task-completed \ + --bundle-ids bun-2a4e041c + +This command produces no output. \ No newline at end of file diff -Nru awscli-1.16.301/awscli/examples/ec2/wait/conversion-task-cancelled.rst awscli-1.17.14/awscli/examples/ec2/wait/conversion-task-cancelled.rst --- awscli-1.16.301/awscli/examples/ec2/wait/conversion-task-cancelled.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/wait/conversion-task-cancelled.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,8 @@ +**To pause running until a conversion task is cancelled** + +The following ``wait conversion-task-cancelled`` example pauses and continues only after it can confirm that the specified conversion task is cancelled. :: + + aws ec2 wait conversion-task-cancelled \ + --conversion-task-ids import-i-fh95npoc + +This command produces no output. diff -Nru awscli-1.16.301/awscli/examples/ec2/wait/conversion-task-completed.rst awscli-1.17.14/awscli/examples/ec2/wait/conversion-task-completed.rst --- awscli-1.16.301/awscli/examples/ec2/wait/conversion-task-completed.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/wait/conversion-task-completed.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,8 @@ +**To pause running until a conversion task is completed** + +The following ``wait conversion-task-completed`` example pauses and continues only after it can confirm that the specified conversion task is completed. :: + + aws ec2 wait conversion-task-completed \ + --conversion-task-ids import-i-fh95npoc + +This command produces no output. diff -Nru awscli-1.16.301/awscli/examples/ec2/wait/conversion-task-deleted.rst awscli-1.17.14/awscli/examples/ec2/wait/conversion-task-deleted.rst --- awscli-1.16.301/awscli/examples/ec2/wait/conversion-task-deleted.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/wait/conversion-task-deleted.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,8 @@ +**To pause running until a conversion task is deleted** + +The following ``wait conversion-task-deleted`` example pauses and continues only after it can confirm that the specified conversion task is deleted. :: + + aws ec2 wait conversion-task-deleted \ + --conversion-task-ids import-i-fh95npoc + +This command produces no output. diff -Nru awscli-1.16.301/awscli/examples/ec2/wait/export-task-cancelled.rst awscli-1.17.14/awscli/examples/ec2/wait/export-task-cancelled.rst --- awscli-1.16.301/awscli/examples/ec2/wait/export-task-cancelled.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/wait/export-task-cancelled.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,8 @@ +**To pause running until an export task is cancelled** + +The following ``wait export-task-cancelled`` example pauses and continues only after it can confirm that the specified export task is cancelled. :: + + aws ec2 wait export-task-cancelled \ + --export-task-ids export-i-fgelt0i7 + +This command produces no output. diff -Nru awscli-1.16.301/awscli/examples/ec2/wait/export-task-completed.rst awscli-1.17.14/awscli/examples/ec2/wait/export-task-completed.rst --- awscli-1.16.301/awscli/examples/ec2/wait/export-task-completed.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/wait/export-task-completed.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,8 @@ +**To pause running until an export task is completed** + +The following ``wait export-task-completed`` example pauses and continues only after it can confirm that the specified export task is completed. :: + + aws ec2 wait export-task-completed \ + --export-task-ids export-i-fgelt0i7 + +This command produces no output. diff -Nru awscli-1.16.301/awscli/examples/ec2/wait/security-group-exists.rst awscli-1.17.14/awscli/examples/ec2/wait/security-group-exists.rst --- awscli-1.16.301/awscli/examples/ec2/wait/security-group-exists.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ec2/wait/security-group-exists.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,8 @@ +**To pause running until a security group exists** + +The following ``wait security-group-exists`` example pauses and continues only after it can confirm that the specified security group exists. :: + + aws ec2 wait security-group-exists \ + --group-ids sg-07e789d0fb10492ee + +This command produces no output. diff -Nru awscli-1.16.301/awscli/examples/ecr/create-repository.rst awscli-1.17.14/awscli/examples/ecr/create-repository.rst --- awscli-1.16.301/awscli/examples/ecr/create-repository.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ecr/create-repository.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,18 +1,62 @@ -**To create a repository** +**Example 1: To create a repository** -This example creates a repository called ``nginx-web-app`` inside the -``project-a`` namespace in the default registry for an account. +The following ``create-repository`` example creates a repository inside the specified namespace in the default registry for an account. :: -Command:: + aws ecr create-repository \ + --repository-name project-a/nginx-web-app - aws ecr create-repository --repository-name project-a/nginx-web-app +Output:: + + { + "repository": { + "registryId": "123456789012", + "repositoryName": "sample-repo", + "repositoryArn": "arn:aws:ecr:us-west-2:123456789012:repository/project-a/nginx-web-app" + } + } + +For more information, see `Creating a Repository `__ in the *Amazon ECR User Guide*. + +**Example 2: To create a repository configured with image tag immutability** + +The following ``create-repository`` example creates a repository configured for tag immutability in the default registry for an account. :: + + aws ecr create-repository \ + --repository-name sample-repo \ + --image-tag-mutability IMMUTABLE + +Output:: + + { + "repository": { + "registryId": "123456789012", + "repositoryName": "sample-repo", + "repositoryArn": "arn:aws:ecr:us-west-2:123456789012:repository/sample-repo", + "imageTagMutability": "IMMUTABLE" + } + } + +For more information, see `Image Tag Mutability `__ in the *Amazon ECR User Guide*. + +**Example 3: To create a repository configured with a scanning configuration** + +The following ``create-repository`` example creates a repository configured to perform a vulnerability scan on image push in the default registry for an account. :: + + aws ecr create-repository \ + --repository-name sample-repo \ + --image-scanning-configuration scanOnPush=true Output:: - { - "repository": { - "registryId": "", - "repositoryName": "project-a/nginx-web-app", - "repositoryArn": "arn:aws:ecr:us-west-2::repository/project-a/nginx-web-app" - } - } + { + "repository": { + "registryId": "123456789012", + "repositoryName": "sample-repo", + "repositoryArn": "arn:aws:ecr:us-west-2:123456789012:repository/sample-repo", + "imageScanningConfiguration": { + "scanOnPush": true + } + } + } + +For more information, see `Image Scanning `__ in the *Amazon ECR User Guide*. \ No newline at end of file diff -Nru awscli-1.16.301/awscli/examples/ecr/delete-repository.rst awscli-1.17.14/awscli/examples/ecr/delete-repository.rst --- awscli-1.16.301/awscli/examples/ecr/delete-repository.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ecr/delete-repository.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,19 +1,19 @@ **To delete a repository** -This example command force deletes a repository named ``ubuntu`` in the default -registry for an account. The ``--force`` flag is required if the repository -contains images. +The following ``delete-repository`` example command force deletes the specified repository in the default registry for an account. The ``--force`` flag is required if the repository contains images. :: -Command:: - - aws ecr delete-repository --force --repository-name ubuntu + aws ecr delete-repository \ + --repository-name ubuntu \ + --force Output:: - { - "repository": { - "registryId": "", - "repositoryName": "ubuntu", - "repositoryArn": "arn:aws:ecr:us-west-2::repository/ubuntu" - } - } + { + "repository": { + "registryId": "123456789012", + "repositoryName": "ubuntu", + "repositoryArn": "arn:aws:ecr:us-west-2:123456789012:repository/ubuntu" + } + } + +For more information, see `Deleting a Repository `__ in the *Amazon ECR User Guide*. diff -Nru awscli-1.16.301/awscli/examples/ecr/describe-image-scan-findings.rst awscli-1.17.14/awscli/examples/ecr/describe-image-scan-findings.rst --- awscli-1.16.301/awscli/examples/ecr/describe-image-scan-findings.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ecr/describe-image-scan-findings.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,56 @@ +**To describe the scan findings for an image** + +The following ``describe-image-scan-findings`` example returns the image scan findings for an image using the image digest in the specified repository in the default registry for an account. :: + + aws ecr describe-image-scan-findings \ + --repository-name sample-repo \ + --image-id imageDigest=sha256:74b2c688c700ec95a93e478cdb959737c148df3fbf5ea706abe0318726e885e6 + +Output:: + + { + "imageScanFindings": { + "findings": [ + { + "name": "CVE-2019-5188", + "description": "A code execution vulnerability exists in the directory rehashing functionality of E2fsprogs e2fsck 1.45.4. A specially crafted ext4 directory can cause an out-of-bounds write on the stack, resulting in code execution. An attacker can corrupt a partition to trigger this vulnerability.", + "uri": "http://people.ubuntu.com/~ubuntu-security/cve/CVE-2019-5188", + "severity": "MEDIUM", + "attributes": [ + { + "key": "package_version", + "value": "1.44.1-1ubuntu1.1" + }, + { + "key": "package_name", + "value": "e2fsprogs" + }, + { + "key": "CVSS2_VECTOR", + "value": "AV:L/AC:L/Au:N/C:P/I:P/A:P" + }, + { + "key": "CVSS2_SCORE", + "value": "4.6" + } + ] + } + ], + "imageScanCompletedAt": 1579839105.0, + "vulnerabilitySourceUpdatedAt": 1579811117.0, + "findingSeverityCounts": { + "MEDIUM": 1 + } + }, + "registryId": "123456789012", + "repositoryName": "sample-repo", + "imageId": { + "imageDigest": "sha256:74b2c688c700ec95a93e478cdb959737c148df3fbf5ea706abe0318726e885e6" + }, + "imageScanStatus": { + "status": "COMPLETE", + "description": "The scan was completed successfully." + } + } + +For more information, see `Image Scanning `__ in the *Amazon ECR User Guide*. diff -Nru awscli-1.16.301/awscli/examples/ecr/get-authorization-token.rst awscli-1.17.14/awscli/examples/ecr/get-authorization-token.rst --- awscli-1.16.301/awscli/examples/ecr/get-authorization-token.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ecr/get-authorization-token.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,58 +1,17 @@ **To get an authorization token for your default registry** -This example command gets an authorization token for your default registry. +The following ``get-authorization-token`` example command gets an authorization token for your default registry. :: -Command:: - - aws ecr get-authorization-token - -Output:: - - { - "authorizationData": [ - { - "authorizationToken": "QVdTOkN...", - "expiresAt": 1448875853.241, - "proxyEndpoint": "https://.dkr.ecr.us-west-2.amazonaws.com" - } - ] - } - - -**To get the decoded password for your default registry** - -This example command gets an authorization token for your default registry and -returns the decoded password for you to use in a ``docker login`` command. - -.. note:: - - Mac OSX users should use the ``-D`` option to ``base64`` to decode the - token data. - -Command:: - - aws ecr get-authorization-token --output text \ - --query 'authorizationData[].authorizationToken' \ - | base64 -D | cut -d: -f2 - - -**To `docker login` with your decoded password** - -This example command uses your decoded password to add authentication -information to your Docker installation by using the ``docker login`` command. -The user name is ``AWS``, and you can use any email you want (Amazon ECR does -nothing with this information, but ``docker login`` required the email field). - -.. note:: - - The final argument is the ``proxyEndpoint`` returned from - ``get-authorization-token`` without the ``https://`` prefix. - -Command:: - - docker login -u AWS -p -e .dkr.ecr.us-west-2.amazonaws.com + aws ecr get-authorization-token Output:: - WARNING: login credentials saved in $HOME/.docker/config.json - Login Succeeded + { + "authorizationData": [ + { + "authorizationToken": "QVdTOkN...", + "expiresAt": 1448875853.241, + "proxyEndpoint": "https://123456789012.dkr.ecr.us-west-2.amazonaws.com" + } + ] + } diff -Nru awscli-1.16.301/awscli/examples/ecr/get-lifecycle-policy-preview.rst awscli-1.17.14/awscli/examples/ecr/get-lifecycle-policy-preview.rst --- awscli-1.16.301/awscli/examples/ecr/get-lifecycle-policy-preview.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ecr/get-lifecycle-policy-preview.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,6 +1,8 @@ **To retrieve details for a lifecycle policy preview** -The following ``get-lifecycle-policy-preview`` example retrieves the result of a lifecycle policy preview for a repository called ``project-a/amazon-ecs-sample`` in the default registry for an account. :: +The following ``get-lifecycle-policy-preview`` example retrieves the result of a lifecycle policy preview for the specified repository in the default registry for an account. + +Command:: aws ecr get-lifecycle-policy-preview \ --repository-name "project-a/amazon-ecs-sample" @@ -8,7 +10,7 @@ Output:: { - "registryId": "", + "registryId": "012345678910", "repositoryName": "project-a/amazon-ecs-sample", "lifecyclePolicyText": "{\n \"rules\": [\n {\n \"rulePriority\": 1,\n \"description\": \"Expire images older than 14 days\",\n \"selection\": {\n \"tagStatus\": \"untagged\",\n \"countType\": \"sinceImagePushed\",\n \"countUnit\": \"days\",\n \"countNumber\": 14\n },\n \"action\": {\n \"type\": \"expire\"\n }\n }\n ]\n}\n", "status": "COMPLETE", @@ -17,3 +19,5 @@ "expiringImageTotalCount": 0 } } + +For more information, see `Lifecycle Policies `__ in the *Amazon ECR User Guide*. diff -Nru awscli-1.16.301/awscli/examples/ecr/get-lifecycle-policy.rst awscli-1.17.14/awscli/examples/ecr/get-lifecycle-policy.rst --- awscli-1.16.301/awscli/examples/ecr/get-lifecycle-policy.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ecr/get-lifecycle-policy.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,16 +1,17 @@ **To retrieve a lifecycle policy** -This example retrieves the lifecycle policy for a repository called ``project-a/amazon-ecs-sample`` in the default registry for an account. +The following ``get-lifecycle-policy`` example displays details of the lifecycle policy for the specified repository in the default registry for the account. :: -Command:: - - aws ecr get-lifecycle-policy --repository-name "project-a/amazon-ecs-sample" + aws ecr get-lifecycle-policy \ + --repository-name "project-a/amazon-ecs-sample" Output:: - { - "registryId": "", - "repositoryName": "project-a/amazon-ecs-sample", - "lifecyclePolicyText": "{\"rules\":[{\"rulePriority\":1,\"description\":\"Expire images older than 14 days\",\"selection\":{\"tagStatus\":\"untagged\",\"countType\":\"sinceImagePushed\",\"countUnit\":\"days\",\"countNumber\":14},\"action\":{\"type\":\"expire\"}}]}", - "lastEvaluatedAt": 1504295007.0 - } + { + "registryId": "123456789012", + "repositoryName": "project-a/amazon-ecs-sample", + "lifecyclePolicyText": "{\"rules\":[{\"rulePriority\":1,\"description\":\"Expire images older than 14 days\",\"selection\":{\"tagStatus\":\"untagged\",\"countType\":\"sinceImagePushed\",\"countUnit\":\"days\",\"countNumber\":14},\"action\":{\"type\":\"expire\"}}]}", + "lastEvaluatedAt": 1504295007.0 + } + +For more information, see `Lifecycle Policies `__ in the *Amazon ECR User Guide*. diff -Nru awscli-1.16.301/awscli/examples/ecr/get-login_description.rst awscli-1.17.14/awscli/examples/ecr/get-login_description.rst --- awscli-1.16.301/awscli/examples/ecr/get-login_description.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ecr/get-login_description.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,3 +1,5 @@ + **Note:** This command is deprecated. Use ``get-login-password`` instead. + **To log in to an Amazon ECR registry** This command retrieves a token that is valid for a specified registry for 12 @@ -9,7 +11,7 @@ .. note:: - This command writes displays ``docker login`` commands to stdout with + This command displays ``docker login`` commands to stdout with authentication credentials. Your credentials could be visible by other users on your system in a process list display or a command history. If you are not on a secure system, you should consider this risk and login diff -Nru awscli-1.16.301/awscli/examples/ecr/get-login-password_description.rst awscli-1.17.14/awscli/examples/ecr/get-login-password_description.rst --- awscli-1.16.301/awscli/examples/ecr/get-login-password_description.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ecr/get-login-password_description.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,15 @@ +**To log in to an Amazon ECR registry** + +This command retrieves and prints a password that is valid for a specified +registry for 12 hours. You can pass the password to the login command of the +container client of your preference, such as Docker. After you have logged in +to an Amazon ECR registry with this command, you can use the Docker CLI to push +and pull images from that registry until the token expires. + +.. note:: + + This command displays password(s) to stdout with authentication credentials. + Your credentials could be visible by other users on your system in a process + list display or a command history. If you are not on a secure system, you + should consider this risk and login interactively. For more information, + see ``get-authorization-token``. diff -Nru awscli-1.16.301/awscli/examples/ecr/get-login-password.rst awscli-1.17.14/awscli/examples/ecr/get-login-password.rst --- awscli-1.16.301/awscli/examples/ecr/get-login-password.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ecr/get-login-password.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,16 @@ +**To retrieve a password to your default registry** + +This example prints a password that you can use with a container client of your +choice to log in to your default Amazon ECR registry. + +Command:: + + aws ecr get-login-password + +Output:: + + + +Usage with Docker:: + + aws ecr get-login-password | docker login --username AWS --password-stdin https://.dkr.ecr..amazonaws.com diff -Nru awscli-1.16.301/awscli/examples/ecr/put-image-scanning-configuration.rst awscli-1.17.14/awscli/examples/ecr/put-image-scanning-configuration.rst --- awscli-1.16.301/awscli/examples/ecr/put-image-scanning-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ecr/put-image-scanning-configuration.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,19 @@ +**To update the image scanning configuration for a repository** + +The following ``put-image-scanning-configuration`` example updates the image scanning configuration for the specified repository. :: + + aws ecr put-image-scanning-configuration \ + --repository-name sample-repo \ + --image-scanning-configuration scanOnPush=true + +Output:: + + { + "registryId": "012345678910", + "repositoryName": "sample-repo", + "imageScanningConfiguration": { + "scanOnPush": true + } + } + +For more information, see `Image Scanning `__ in the *Amazon ECR User Guide*. diff -Nru awscli-1.16.301/awscli/examples/ecr/put-image-tag-mutability.rst awscli-1.17.14/awscli/examples/ecr/put-image-tag-mutability.rst --- awscli-1.16.301/awscli/examples/ecr/put-image-tag-mutability.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ecr/put-image-tag-mutability.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,15 +1,17 @@ -**To make a repository's image tags immutable** +**To update the image tag mutability setting for a repository** -The following ``put-image-tag-mutability`` example sets immutable image tags on the ``hello-world`` repository. :: +The following ``put-image-tag-mutability`` example configures the specified repository for tag immutability. This prevents all image tags within the repository from being overwritten. :: aws ecr put-image-tag-mutability \ - --repository-name hello-world \ + --repository-name hello-repository \ --image-tag-mutability IMMUTABLE Output:: { - "registryId": "012345678910", - "repositoryName": "hello-world", - "imageTagMutability": "IMMUTABLE" + "registryId": "012345678910", + "repositoryName": "sample-repo", + "imageTagMutability": "IMMUTABLE" } + +For more information, see `Image Tag Mutability `__ in the *Amazon ECR User Guide*. diff -Nru awscli-1.16.301/awscli/examples/ecr/put-lifecycle-policy.rst awscli-1.17.14/awscli/examples/ecr/put-lifecycle-policy.rst --- awscli-1.16.301/awscli/examples/ecr/put-lifecycle-policy.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ecr/put-lifecycle-policy.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,15 +1,14 @@ **To create a lifecycle policy** -This example creates a lifecycle policy defined by ``policy.json` for a repository called -``project-a/amazon-ecs-sample`` in the default registry for an account. +The following ``put-lifecycle-policy`` example creates a lifecycle policy for the specified repository in the default registry for an account. :: -Command:: + aws ecr put-lifecycle-policy \ + --repository-name "project-a/amazon-ecs-sample" \ + --lifecycle-policy-text "file://policy.json" - aws ecr put-lifecycle-policy --repository-name "project-a/amazon-ecs-sample" --lifecycle-policy-text "file://policy.json" +Contents of ``policy.json``:: -JSON file format:: - - { + { "rules": [ { "rulePriority": 1, @@ -25,12 +24,14 @@ } } ] - } + } Output:: - { - "registryId": "", - "repositoryName": "project-a/amazon-ecs-sample", - "lifecyclePolicyText": "{\"rules\":[{\"rulePriority\":1,\"description\":\"Expire images older than 14 days\",\"selection\":{\"tagStatus\":\"untagged\",\"countType\":\"sinceImagePushed\",\"countUnit\":\"days\",\"countNumber\":14},\"action\":{\"type\":\"expire\"}}]}" - } + { + "registryId": "", + "repositoryName": "project-a/amazon-ecs-sample", + "lifecyclePolicyText": "{\"rules\":[{\"rulePriority\":1,\"description\":\"Expire images older than 14 days\",\"selection\":{\"tagStatus\":\"untagged\",\"countType\":\"sinceImagePushed\",\"countUnit\":\"days\",\"countNumber\":14},\"action\":{\"type\":\"expire\"}}]}" + } + +For more information, see `Lifecycle Policies `__ in the *Amazon ECR User Guide*. diff -Nru awscli-1.16.301/awscli/examples/ecr/start-image-scan.rst awscli-1.17.14/awscli/examples/ecr/start-image-scan.rst --- awscli-1.16.301/awscli/examples/ecr/start-image-scan.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ecr/start-image-scan.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,22 @@ +**To start an image vulnerability scan** + +The following ``start-image-scan`` example starts an image scan for and specified by the image digest in the `specified` repository. :: + + aws ecr start-image-scan \ + --repository-name sample-repo \ + --image-id imageDigest=sha256:74b2c688c700ec95a93e478cdb959737c148df3fbf5ea706abe0318726e885e6 + +Output:: + + { + "registryId": "012345678910", + "repositoryName": "sample-repo", + "imageId": { + "imageDigest": "sha256:74b2c688c700ec95a93e478cdb959737c148df3fbf5ea706abe0318726e885e6" + }, + "imageScanStatus": { + "status": "IN_PROGRESS" + } + } + +For more information, see `Image Scanning `__ in the *Amazon ECR User Guide*. diff -Nru awscli-1.16.301/awscli/examples/ecr/start-lifecycle-policy-preview.rst awscli-1.17.14/awscli/examples/ecr/start-lifecycle-policy-preview.rst --- awscli-1.16.301/awscli/examples/ecr/start-lifecycle-policy-preview.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/ecr/start-lifecycle-policy-preview.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,15 +1,14 @@ **To create a lifecycle policy preview** -This example creates a lifecycle policy preview defined by ``policy.json` for a repository called -``project-a/amazon-ecs-sample`` in the default registry for an account. +The following ``start-lifecycle-policy-preview`` example creates a lifecycle policy preview defined by a JSON file for the specified repository. :: -Command:: + aws ecr start-lifecycle-policy-preview \ + --repository-name "project-a/amazon-ecs-sample" \ + --lifecycle-policy-text "file://policy.json" - aws ecr start-lifecycle-policy-preview --repository-name "project-a/amazon-ecs-sample" --lifecycle-policy-text "file://policy.json" +Contents of ``policy.json``:: -JSON file format:: - - { + { "rules": [ { "rulePriority": 1, @@ -25,13 +24,13 @@ } } ] - } + } Output:: - { - "registryId": "", + { + "registryId": "012345678910", "repositoryName": "project-a/amazon-ecs-sample", "lifecyclePolicyText": "{\n \"rules\": [\n {\n \"rulePriority\": 1,\n \"description\": \"Expire images older than 14 days\",\n \"selection\": {\n \"tagStatus\": \"untagged\",\n \"countType\": \"sinceImagePushed\",\n \"countUnit\": \"days\",\n \"countNumber\": 14\n },\n \"action\": {\n \"type\": \"expire\"\n }\n }\n ]\n}\n", "status": "IN_PROGRESS" - } + } diff -Nru awscli-1.16.301/awscli/examples/gamelift/create-build.rst awscli-1.17.14/awscli/examples/gamelift/create-build.rst --- awscli-1.16.301/awscli/examples/gamelift/create-build.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/gamelift/create-build.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,70 @@ +**Example1: To create a game build from files in an S3 bucket** + +The following ``create-build`` example creates a custom game build resource. It uses zipped files that are stored in an S3 location in an AWS account that you control. This example assumes that you've already created an IAM role that gives Amazon GameLift permission to access the S3 location. Since the request does not specify an operating system, the new build resource defaults to WINDOWS_2012. :: + + aws gamelift create-build \ + --storage-location file://storage-loc.json \ + --name MegaFrogRaceServer.NA \ + --build-version 12345.678 + +Contents of ``storage-loc.json``:: + + { + "Bucket":"MegaFrogRaceServer_NA_build_files" + "Key":"MegaFrogRaceServer_build_123.zip" + "RoleArn":"arn:aws:iam::123456789012:role/gamelift" + } + +Output:: + + { + "Build": { + "BuildArn": "arn:aws:gamelift:us-west-2::build/build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "BuildId": "build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "CreationTime": 1496708916.18, + "Name": "MegaFrogRaceServer.NA", + "OperatingSystem": "WINDOWS_2012", + "SizeOnDisk": 479303, + "Status": "INITIALIZED", + "Version": "12345.678" + }, + "StorageLocation": { + "Bucket": "MegaFrogRaceServer_NA_build_files", + "Key": "MegaFrogRaceServer_build_123.zip" + } + } + +**Example2: To create a game build resource for manually uploading files to GameLift** + +The following ``create-build`` example creates a new build resource. It also gets a storage location and temporary credentials that allow you to manually upload your game build to the GameLift location in Amazon S3. Once you've successfully uploaded your build, the GameLift service validates the build and updates the new build's status. :: + + aws gamelift create-build \ + --name MegaFrogRaceServer.NA \ + --build-version 12345.678 \ + --operating-system AMAZON_LINUX + +Output:: + + { + "Build": { + "BuildArn": "arn:aws:gamelift:us-west-2::build/build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "BuildId": "build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "CreationTime": 1496708916.18, + "Name": "MegaFrogRaceServer.NA", + "OperatingSystem": "AMAZON_LINUX", + "SizeOnDisk": 0, + "Status": "INITIALIZED", + "Version": "12345.678" + }, + "StorageLocation": { + "Bucket": "gamelift-builds-us-west-2", + "Key": "123456789012/build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" + }, + "UploadCredentials": { + "AccessKeyId": "AKIAIOSFODNN7EXAMPLE", + "SecretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "SessionToken": "AgoGb3JpZ2luENz...EXAMPLETOKEN==" + } + } + +For more information, see `Upload a Custom Server Build to GameLift `__ in the *Amazon GameLift Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/gamelift/create-fleet.rst awscli-1.17.14/awscli/examples/gamelift/create-fleet.rst --- awscli-1.16.301/awscli/examples/gamelift/create-fleet.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/gamelift/create-fleet.rst 2020-02-10 19:14:32.000000000 +0000 @@ -3,9 +3,9 @@ The following ``create-fleet`` example creates a minimally configured fleet of on-demand Linux instances to host a custom server build. You can complete the configuration by using ``update-fleet``. :: aws gamelift create-fleet \ - --name MegaFrogRace.NA.v2 \ + --name MegaFrogRaceServer.NA.v2 \ --description 'Hosts for v2 North America' \ - --build-id build-1111aaaa-22bb-33cc-44dd-5555eeee66ff \ + --build-id build-1111aaaa-22bb-33cc-44dd-5555eeee66ff \ --certificate-configuration 'CertificateType=GENERATED' \ --ec2-instance-type c4.large \ --fleet-type ON_DEMAND \ @@ -17,7 +17,7 @@ "FleetAttributes": { "BuildId": "build-1111aaaa-22bb-33cc-44dd-5555eeee66ff", "CertificateConfiguration": { - "CertificateType": "GENERATED" + "CertificateType": "GENERATED" }, "CreationTime": 1496365885.44, "Description": "Hosts for v2 North America", @@ -45,7 +45,7 @@ --certificate-configuration 'CertificateType=GENERATED' \ --ec2-instance-type c4.large \ --fleet-type SPOT \ - --runtime-configuration 'ServerProcesses=[{LaunchPath==C:\game\Bin64.Release.Dedicated\MegaFrogRace_Server.exe,ConcurrentExecutions=1}]' + --runtime-configuration 'ServerProcesses=[{LaunchPath=C:\game\Bin64.Release.Dedicated\MegaFrogRace_Server.exe,ConcurrentExecutions=1}]' Output:: @@ -53,7 +53,7 @@ "FleetAttributes": { "BuildId": "build-2222aaaa-33bb-44cc-55dd-6666eeee77ff", "CertificateConfiguration": { - "CertificateType": "GENERATED" + "CertificateType": "GENERATED" }, "CreationTime": 1496365885.44, "Description": "Hosts for v2 North America", @@ -70,6 +70,7 @@ } } + **Example 3: To create a fully configured fleet** The following ``create-fleet`` example creates a fleet of Spot Windows instances for a custom server build, with most commonly used configuration settings provided. :: @@ -89,20 +90,20 @@ Contents of ``runtime-config.json``:: - GameSessionActivationTimeoutSeconds=300, - MaxConcurrentGameSessionActivations=2, - ServerProcesses=[ - {LaunchPath=C:\game\Bin64.Release.Dedicated\MegaFrogRace_Server.exe,Parameters=-debug,ConcurrentExecutions=1}, - {LaunchPath=C:\game\Bin64.Release.Dedicated\MegaFrogRace_Server.exe,ConcurrentExecutions=1}] + GameSessionActivationTimeoutSeconds=300, + MaxConcurrentGameSessionActivations=2, + ServerProcesses=[ + {LaunchPath=C:\game\Bin64.Release.Dedicated\MegaFrogRace_Server.exe,Parameters=-debug,ConcurrentExecutions=1}, + {LaunchPath=C:\game\Bin64.Release.Dedicated\MegaFrogRace_Server.exe,ConcurrentExecutions=1}] Output:: { "FleetAttributes": { - "InstanceRoleArn": "arn:aws:iam::123456789012:role/GameLiftS3Access", + "InstanceRoleArn": "arn:aws:iam::444455556666:role/GameLiftS3Access", "Status": "NEW", "InstanceType": "c4.large", - "FleetArn": "arn:aws:gamelift:us-west-2:123456789012:fleet/fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", + "FleetArn": "arn:aws:gamelift:us-west-2:444455556666:fleet/fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", "FleetId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", "Description": "Hosts for v2 North America", "FleetType": "SPOT", @@ -124,7 +125,7 @@ **Example 4: To create a Realtime Servers fleet** -The following ``create-fleet`` example creates a fleet of Spot instances with a Realtime configuration script that has been uploaded to Amazon GameLift. All Realtime servers are deployed onto Linux machines. For the purposes of this example, assume that the uploaded Realtime script includes multiple script files, with the Init() function located in the script file called "MainScript.js". As shown, this file is identified as the launch script in the runtime configuration. :: +The following ``create-fleet`` example creates a fleet of Spot instances with a Realtime configuration script that has been uploaded to Amazon GameLift. All Realtime servers are deployed onto Linux machines. For the purposes of this example, assume that the uploaded Realtime script includes multiple script files, with the ``Init()`` function located in the script file called ``MainScript.js``. As shown, this file is identified as the launch script in the runtime configuration. :: aws gamelift create-fleet \ --name MegaFrogRace.NA.realtime \ @@ -132,8 +133,7 @@ --script-id script-1111aaaa-22bb-33cc-44dd-5555eeee66ff \ --ec2-instance-type c4.large \ --fleet-type SPOT \ - --certificate-configuration 'CertificateType=GENERATED' \ - --runtime-configuration 'ServerProcesses=[{LaunchPath=/local/game/MainScript.js,Parameters=+map Winter444,ConcurrentExecutions=5}]' + --certificate-configuration 'CertificateType=GENERATED' --runtime-configuration 'ServerProcesses=[{LaunchPath=/local/game/MainScript.js,Parameters=+map Winter444,ConcurrentExecutions=5}]' Output:: @@ -149,7 +149,7 @@ }, "Name": "MegaFrogRace.NA.realtime", "ScriptId": "script-1111aaaa-22bb-33cc-44dd-5555eeee66ff", - "FleetArn": "arn:aws:gamelift:us-west-2:123456789012:fleet/fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", + "FleetArn": "arn:aws:gamelift:us-west-2:444455556666:fleet/fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", "FleetType": "SPOT", "MetricGroups": [ "default" diff -Nru awscli-1.16.301/awscli/examples/gamelift/create-game-session-queue.rst awscli-1.17.14/awscli/examples/gamelift/create-game-session-queue.rst --- awscli-1.16.301/awscli/examples/gamelift/create-game-session-queue.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/gamelift/create-game-session-queue.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,86 @@ +**Example1: To set up an ordered game session queue** + +The following ``create-game-session-queue`` example creates a new game session queue with destinations in two regions. It also configures the queue so that game session requests time out after waiting 10 minutes for placement. Since no latency policies are defined, GameLift attempts to place all game sessions with the first destination listed. :: + + aws gamelift create-game-session-queue \ + --name MegaFrogRaceServer-NA \ + --destinations file://destinations.json \ + --timeout-in-seconds 600 + +Contents of ``destinations.json``:: + + { + "Destinations": [ + {"DestinationArn": "arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }, + {"DestinationArn": "arn:aws:gamelift:us-west-1::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222" } + ] + } + +Output:: + + { + "GameSessionQueues": [ + { + "Name": "MegaFrogRaceServer-NA", + "GameSessionQueueArn": "arn:aws:gamelift:us-west-2:123456789012:gamesessionqueue/MegaFrogRaceServer-NA", + "TimeoutInSeconds": 600, + "Destinations": [ + {"DestinationArn": "arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"}, + {"DestinationArn": "arn:aws:gamelift:us-west-1::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"} + ] + } + ] + } + +**Example2: To set up a game session queue with player latency policies** + +The following ``create-game-session-queue`` example creates a new game session queue with two player latency policies. The first policy sets a 100ms latency cap that is enforced during the first minute of a game session placement attempt. The second policy raises the latency cap to 200ms until the placement request times out at 3 minutes. :: + + aws gamelift create-game-session-queue \ + --name MegaFrogRaceServer-NA \ + --destinations file://destinations.json \ + --player-latency-policies file://latency-policies.json \ + --timeout-in-seconds 180 + +Contents of ``destinations.json``:: + + { + "Destinations": [ + { "DestinationArn": "arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }, + { "DestinationArn": "arn:aws:gamelift:us-east-1::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222" } + ] + } + +Contents of ``latency-policies.json``:: + + { + "PlayerLatencyPolicies": [ + {"MaximumIndividualPlayerLatencyMilliseconds": 200}, + {"MaximumIndividualPlayerLatencyMilliseconds": 100, "PolicyDurationSeconds": 60} + ] + } + +Output:: + + { + "GameSessionQueue": { + "Name": "MegaFrogRaceServer-NA", + "GameSessionQueueArn": "arn:aws:gamelift:us-west-2:111122223333:gamesessionqueue/MegaFrogRaceServer-NA", + "TimeoutInSeconds": 600, + "PlayerLatencyPolicies": [ + { + "MaximumIndividualPlayerLatencyMilliseconds": 100, + "PolicyDurationSeconds": 60 + }, + { + "MaximumIndividualPlayerLatencyMilliseconds": 200 + } + ] + "Destinations": [ + {"DestinationArn": "arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"}, + {"DestinationArn": "arn:aws:gamelift:us-east-1::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"} + ], + } + } + +For more information, see `Create a Queue `__ in the *Amazon GameLift Developer Guide*. \ No newline at end of file diff -Nru awscli-1.16.301/awscli/examples/gamelift/delete-build.rst awscli-1.17.14/awscli/examples/gamelift/delete-build.rst --- awscli-1.16.301/awscli/examples/gamelift/delete-build.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/gamelift/delete-build.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,8 @@ +**To delete a custom game build** + +The following ``delete-build`` example removes a build from your Amazon GameLift account. After the build is deleted, you cannot use it to create new fleets. This operation cannot be undone. :: + + aws gamelift delete-build \ + --build-id build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 + +This command produces no output. diff -Nru awscli-1.16.301/awscli/examples/gamelift/delete-fleet.rst awscli-1.17.14/awscli/examples/gamelift/delete-fleet.rst --- awscli-1.16.301/awscli/examples/gamelift/delete-fleet.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/gamelift/delete-fleet.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a fleet that is no longer in use** + +The following ``delete-fleet`` example removes a fleet that has been scaled down to zero instances. If the fleet capacity is greater than zero, the request fails with an HTTP 400 error. :: + + aws gamelift delete-fleet \ + --fleet-id fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 + +This command produces no output. + +For more information, see `Manage GameLift Fleets `__ in the *Amazon GameLift Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/gamelift/delete-game-session-queue.rst awscli-1.17.14/awscli/examples/gamelift/delete-game-session-queue.rst --- awscli-1.16.301/awscli/examples/gamelift/delete-game-session-queue.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/gamelift/delete-game-session-queue.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,8 @@ +**To delete a game session queue** + +The following ``delete-game-session-queue`` example deletes a specified game session queue. :: + + aws gamelift delete-game-session-queue \ + --name MegaFrogRace-NA + +This command produces no output. diff -Nru awscli-1.16.301/awscli/examples/gamelift/describe-build.rst awscli-1.17.14/awscli/examples/gamelift/describe-build.rst --- awscli-1.16.301/awscli/examples/gamelift/describe-build.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/gamelift/describe-build.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,23 @@ +**To get information on a custom game build** + +The following ``describe-build`` example retrieves properties for a game server build resource. :: + + aws gamelift describe-build \ + --build-id build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 + +Output:: + + { + "Build": { + "BuildArn": "arn:aws:gamelift:us-west-2::build/build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "BuildId": "build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "CreationTime": 1496708916.18, + "Name": "My_Game_Server_Build_One", + "OperatingSystem": "AMAZON_LINUX", + "SizeOnDisk": 1304924, + "Status": "READY", + "Version": "12345.678" + } + } + +For more information, see `Upload a Custom Server Build to GameLift `__ in the *Amazon GameLift Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/gamelift/describe-ec2-instance-limits.rst awscli-1.17.14/awscli/examples/gamelift/describe-ec2-instance-limits.rst --- awscli-1.16.301/awscli/examples/gamelift/describe-ec2-instance-limits.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/gamelift/describe-ec2-instance-limits.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,20 @@ +**To retrieve service limits for an EC2 instance type** + +The following ``describe-ec2-instance-limits`` example displays the maximum allowed instances and current instances in use for the specified EC2 instance type in the current Region. The result indicates that only five of the allowed twenty instances are being used. :: + + aws gamelift describe-ec2-instance-limits \ + --ec2-instance-type m5.large + +Output:: + + { + "EC2InstanceLimits": [ + { + "EC2InstanceType": ""m5.large", + "CurrentInstances": 5, + "InstanceLimit": 20 + } + ] + } + +For more information, see `Choose Computing Resources `__ in the *Amazon GameLift Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/gamelift/describe-fleet-attributes.rst awscli-1.17.14/awscli/examples/gamelift/describe-fleet-attributes.rst --- awscli-1.16.301/awscli/examples/gamelift/describe-fleet-attributes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/gamelift/describe-fleet-attributes.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,102 @@ +**Example1: To view attributes for a list of fleets** + +The following ``describe-fleet-attributes`` example retrieves fleet attributes for two specified fleets. As shown, the requested fleets are deployed with the same build, one for On-Demand instances and one for Spot instances, with some minor configuration differences. :: + + aws gamelift describe-fleet-attributes \ + --fleet-ids arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222 + +Output:: + + { + "FleetAttributes": [ + { + "FleetId": "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "FleetArn": "arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "FleetType": "ON_DEMAND", + "InstanceType": "c4.large", + "Description": "On-demand hosts for v2 North America", + "Name": "MegaFrogRaceServer.NA.v2-od", + "CreationTime": 1568836191.995, + "Status": "ACTIVE", + "BuildId": "build-a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", + "BuildArn": "arn:aws:gamelift:us-west-2::build/build-a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", + "ServerLaunchPath": "C:\\game\\MegaFrogRace_Server.exe", + "ServerLaunchParameters": "+gamelift_start_server", + "NewGameSessionProtectionPolicy": "NoProtection", + "OperatingSystem": "WINDOWS_2012", + "MetricGroups": [ + "default" + ], + "CertificateConfiguration": { + "CertificateType": "DISABLED" + } + }, + { + "FleetId": "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "FleetArn": "arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "FleetType": "SPOT", + "InstanceType": "c4.large", + "Description": "On-demand hosts for v2 North America", + "Name": "MegaFrogRaceServer.NA.v2-spot", + "CreationTime": 1568838275.379, + "Status": "ACTIVATING", + "BuildId": "build-a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", + "BuildArn": "arn:aws:gamelift:us-west-2::build/build-a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", + "ServerLaunchPath": "C:\\game\\MegaFrogRace_Server.exe", + "NewGameSessionProtectionPolicy": "NoProtection", + "OperatingSystem": "WINDOWS_2012", + "MetricGroups": [ + "default" + ], + "CertificateConfiguration": { + "CertificateType": "GENERATED" + } + } + ] + } + +**Example2: To request attributes for all fleets** + +The following ``describe-fleet-attributes`` returns fleet attributes for all fleets with any status. This example illustrates the use of pagination parameters to return one fleet at a time. :: + + aws gamelift describe-fleet-attributes \ + --limit 1 + +Output:: + + { + "FleetAttributes": [ + { + "FleetId": "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "FleetArn": "arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "FleetType": "SPOT", + "InstanceType": "c4.large", + "Description": "On-demand hosts for v2 North America", + "Name": "MegaFrogRaceServer.NA.v2-spot", + "CreationTime": 1568838275.379, + "Status": "ACTIVATING", + "BuildId": "build-a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", + "BuildArn": "arn:aws:gamelift:us-west-2::build/build-a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", + "ServerLaunchPath": "C:\\game\\MegaFrogRace_Server.exe", + "NewGameSessionProtectionPolicy": "NoProtection", + "OperatingSystem": "WINDOWS_2012", + "MetricGroups": [ + "default" + ], + "CertificateConfiguration": { + "CertificateType": "GENERATED" + } + } + ], + "NextToken": "eyJhd3NBY2NvdW50SWQiOnsicyI6IjMwMjc3NjAxNjM5OCJ9LCJidWlsZElkIjp7InMiOiJidWlsZC01NWYxZTZmMS1jY2FlLTQ3YTctOWI5ZS1iYjFkYTQwMjEXAMPLE2" + } + +The output includes a ``NextToken`` value that you can use when you call the command a second time. Pass the value to the ``--next-token`` parameter to specify where to pick up the output. The following command returns the second result in the output. :: + + aws gamelift describe-fleet-attributes \ + --limit 1 \ + --next-token eyJhd3NBY2NvdW50SWQiOnsicyI6IjMwMjc3NjAxNjM5OCJ9LCJidWlsZElkIjp7InMiOiJidWlsZC01NWYxZTZmMS1jY2FlLTQ3YTctOWI5ZS1iYjFkYTQwMjEXAMPLE1 + +Repeat until the response doesn't include a ``NextToken`` value. + +For more information, see `Setting Up GameLift Fleets `__ in the *Amazon GameLift Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/gamelift/describe-fleet-capacity.rst awscli-1.17.14/awscli/examples/gamelift/describe-fleet-capacity.rst --- awscli-1.16.301/awscli/examples/gamelift/describe-fleet-capacity.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/gamelift/describe-fleet-capacity.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,42 @@ +**To view capacity status for a list of fleets** + +The following ``describe-fleet-capacity`` example retrieves current capacity for two specified fleets. :: + + aws gamelift describe-fleet-capacity \ + --fleet-ids arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222 + +Output:: + + { + "FleetCapacity": [ + { + "FleetId": "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "InstanceType": "c5.large", + "InstanceCounts": { + "DESIRED": 10, + "MINIMUM": 1, + "MAXIMUM": 20, + "PENDING": 0, + "ACTIVE": 10, + "IDLE": 3, + "TERMINATING": 0 + } + }, + { + "FleetId": "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "InstanceType": "c5.large", + "InstanceCounts": { + "DESIRED": 13, + "MINIMUM": 1, + "MAXIMUM": 20, + "PENDING": 0, + "ACTIVE": 15, + "IDLE": 2, + "TERMINATING": 2 + } + } + + ] + } + +For more information, see `GameLift Metrics for Fleets `__ in the *Amazon GameLift Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/gamelift/describe-fleet-events.rst awscli-1.17.14/awscli/examples/gamelift/describe-fleet-events.rst --- awscli-1.16.301/awscli/examples/gamelift/describe-fleet-events.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/gamelift/describe-fleet-events.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,55 @@ +**To request events for a specified time span** + +The following ``describe-fleet-events`` example diplays details of all fleet-related events that occurred during the specified time span. :: + + aws gamelift describe-fleet-events \ + --fleet-id arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ + --start-time 1579647600 \ + --end-time 1579649400 \ + --limit 5 + +Output:: + + { + "Events": [ + { + "EventId": "a37b6892-5d07-4d3b-8b47-80244ecf66b9", + "ResourceId": "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "EventCode": "FLEET_STATE_ACTIVE", + "Message": "Fleet fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 changed state to ACTIVE", + "EventTime": 1579649342.191 + }, + { + "EventId": "67da4ec9-92a3-4d95-886a-5d6772c24063", + "ResourceId": "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "EventCode": "FLEET_STATE_ACTIVATING", + "Message": "Fleet fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 changed state to ACTIVATING", + "EventTime": 1579649321.427 + }, + { + "EventId": "23813a46-a9e6-4a53-8847-f12e6a8381ac", + "ResourceId": "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "EventCode": "FLEET_STATE_BUILDING", + "Message": "Fleet fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 changed state to BUILDING", + "EventTime": 1579649321.243 + }, + { + "EventId": "3bf217d0-1d44-42f9-9202-433ed475d2e8", + "ResourceId": "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "EventCode": "FLEET_STATE_VALIDATING", + "Message": "Fleet fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 changed state to VALIDATING", + "EventTime": 1579649197.449 + }, + { + "EventId": "2ecd0130-5986-44eb-99a7-62df27741084", + "ResourceId": "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "EventCode": "FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND", + "Message": "Failed to find a valid path", + "EventTime": 1569319075.839, + "PreSignedLogUrl": "https://gamelift-event-logs-prod-us-west-2.s3.us-west-2.amazonaws.com/logs/fleet-83422059-8329-42a2-a4d6-c4444386a6f8/events/2ecd0130-5986-44eb-99a7-62df27741084/FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND.txt?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEB8aCXVzLXdlc3QtMiJHMEUCIHV5K%2FLPx8h310D%2FAvx0%2FZxsDy5XA3cJOwPdu3T0eBa%2FAiEA1yovokcZYy%2FV4CWW6l26aFyiSHO%2Bxz%2FBMAhEHYHMQNcqkQMImP%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARAAGgw3NDEwNjE1OTIxNzEiDI8rsZtzLzlwEDQhXSrlAtl5Ae%2Fgo6FCIzqXPbXfBOnSvFYqeDlriZarEpKqKrUt8mXQv9iqHResqCph9AKo49lwgSYTT2QoSxnrD7%2FUgv%2BZm2pVuczvuKtUA0fcx6s0GxpjIAzdIE%2F5P%2FB7B9M%2BVZ%2F9KF82hbJi0HTE6Y7BjKsEgFCvk4UXILhfjtan9iQl8%2F21ZTurAcJbm7Y5tuLF9SWSK3%2BEa7VXOcCK4D4O1sMjmdRm0q0CKZ%2FIaXoHkNvg0RVTa0hIqdvpaDQlsSBNdqTXbjHTu6fETE9Y9Ky%2BiJK5KiUG%2F59GjCpDcvS1FqKeLUEmKT7wysGmvjMc2n%2Fr%2F9VxQfte7w9srXwlLAQuwhiXAAyI5ICMZ5JvzjzQwTqD4CHTVKUUDwL%2BRZzbuuqkJObZml02CkRGp%2B74RTAzLbWptVqZTIfzctiCTmWxb%2FmKyELRYsVLrwNJ%2BGJ7%2BCrN0RC%2FjlgfLYIZyeAqjPgAu5HjgX%2BM7jCo9M7wBTrnAXKOFQuf9dvA84SuwXOJFp17LYGjrHMKv0qC3GfbTMrZ6kzeNV9awKCpXB2Gnx9z2KvIlJdqirWVpvHVGwKCmJBCesDzjJHrae3neogI1uW%2F9C6%2B4jIZPME3jXmZcEHqqw5uvAVF7aeIavtUZU8pxpDIWT0YE4p3Kriy2AA7ziCRKtVfjV839InyLk8LUjsioWK2qlpg2HXKFLpAXw1QsQyxYmFMB9sGKOUlbL7Jdkk%2BYUq8%2FDTlLxqj1S%2FiO4TI0Wo7ilAo%2FKKWWF4guuNDexj8EOOynSp1yImB%2BZf2Fua3O44W4eEXAMPLE33333&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20170621T231808Z&X-Amz-SignedHeaders=host&X-Amz-Expires=900&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20170621%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" + } + ], + "NextToken": "eyJhd3NBY2NvdW50SWQiOnsicyI6IjMwMjc3NjAxNjM5OCJ9LCJidWlsZElkIjp7InMiOiJidWlsZC01NWYxZTZmMS1jY2FlLTQ3YTctOWI5ZS1iYjFkYTQwMjEXAMPLE2" + } + +For more information, see `Debug GameLift Fleet Issues `__ in the *Amazon GameLift Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/gamelift/describe-fleet-port-settings.rst awscli-1.17.14/awscli/examples/gamelift/describe-fleet-port-settings.rst --- awscli-1.16.301/awscli/examples/gamelift/describe-fleet-port-settings.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/gamelift/describe-fleet-port-settings.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,27 @@ +**To view inbound connection permissions for a fleet** + +The following ``describe-fleet-port-settings`` example retrieves connection settings for a specified fleet. :: + + aws gamelift describe-fleet-port-settings \ + --fleet-id arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 + +Output:: + + { + "InboundPermissions": [ + { + "FromPort": 33400, + "ToPort": 33500, + "IpRange": "0.0.0.0/0", + "Protocol": "UDP" + }, + { + "FromPort": 1900, + "ToPort": 2000, + "IpRange": "0.0.0.0/0", + "Protocol": "TCP" + } + ] + } + +For more information, see `Setting Up GameLift Fleets `__ in the *Amazon GameLift Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/gamelift/describe-fleet-utilization.rst awscli-1.17.14/awscli/examples/gamelift/describe-fleet-utilization.rst --- awscli-1.16.301/awscli/examples/gamelift/describe-fleet-utilization.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/gamelift/describe-fleet-utilization.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,61 @@ +**Example1: To view usage data for a list of fleets** + +The following ``describe-fleet-utilization`` example retrieves current usage information for one specified fleet. :: + + aws gamelift describe-fleet-utilization \ + --fleet-ids arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 + +Output:: + + { + "FleetUtilization": [ + { + "FleetId": "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "ActiveServerProcessCount": 100, + "ActiveGameSessionCount": 62, + "CurrentPlayerSessionCount": 329, + "MaximumPlayerSessionCount": 1000 + } + ] + } + +**Example2: To request usage data for all fleets** + +The following ``describe-fleet-utilization`` returns fleet usage data for all fleets with any status. This example uses pagination parameters to return data for two fleets at a time. :: + + aws gamelift describe-fleet-utilization \ + --limit 2 + +Output:: + + { + "FleetUtilization": [ + { + "FleetId": "fleet-1111aaaa-22bb-33cc-44dd-5555eeee66ff", + "ActiveServerProcessCount": 100, + "ActiveGameSessionCount": 13, + "CurrentPlayerSessionCount": 98, + "MaximumPlayerSessionCount": 1000 + }, + { + "FleetId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", + "ActiveServerProcessCount": 100, + "ActiveGameSessionCount": 62, + "CurrentPlayerSessionCount": 329, + "MaximumPlayerSessionCount": 1000 + } + ], + "NextToken": "eyJhd3NBY2NvdW50SWQiOnsicyI6IjMwMjc3NjAxNjM5OCJ9LCJidWlsZElkIjp7InMiOiJidWlsZC01NWYxZTZmMS1jY2FlLTQ3YTctOWI5ZS1iYjFkYTQwMjEXAMPLE2" + } + +Call the command a second time, passing the ``NextToken`` value as the argument to the ``--next-token`` parameter to see the next two results. :: + + aws gamelift describe-fleet-utilization \ + --limit 2 \ + --next-token eyJhd3NBY2NvdW50SWQiOnsicyI6IjMwMjc3NjAxNjM5OCJ9LCJidWlsZElkIjp7InMiOiJidWlsZC01NWYxZTZmMS1jY2FlLTQ3YTctOWI5ZS1iYjFkYTQwMjEXAMPLE2 + +Repeat until the response no longer includes a ``NextToken`` value in the output. + +For more information, see `GameLift Metrics for Fleets `__ in the *Amazon GameLift Developer Guide*. + + diff -Nru awscli-1.16.301/awscli/examples/gamelift/describe-game-session-queues.rst awscli-1.17.14/awscli/examples/gamelift/describe-game-session-queues.rst --- awscli-1.16.301/awscli/examples/gamelift/describe-game-session-queues.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/gamelift/describe-game-session-queues.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,36 @@ +**To view game session queues** + +The following ``describe-game-session-queues`` example retrieves properties for two specified queues. :: + + aws gamelift describe-game-session-queues \ + --names MegaFrogRace-NA MegaFrogRace-EU + +Output:: + + { + "GameSessionQueues": [ + { + "Destinations": [ + {"DestinationArn": "arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"}, + {"DestinationArn": "arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"} + ], + "Name": "MegaFrogRace-NA", + "TimeoutInSeconds": 600, + "GameSessionQueueArn": "arn:aws:gamelift:us-west-2::gamesessionqueue/MegaFrogRace-NA", + "PlayerLatencyPolicies": [ + {"MaximumIndividualPlayerLatencyMilliseconds": 200}, + {"MaximumIndividualPlayerLatencyMilliseconds": 100, "PolicyDurationSeconds": 60} + ] + }, + { + "Destinations": [ + {"DestinationArn": "arn:aws:gamelift:eu-west-3::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"} + ], + "Name": "MegaFrogRace-EU", + "TimeoutInSeconds": 600, + "GameSessionQueueArn": "arn:aws:gamelift:us-west-2::gamesessionqueue/MegaFrogRace-EU" + } + ] + } + +For more information, see `Using Multi-Region Queues `__ in the *Amazon GameLift Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/gamelift/describe-runtime-configuration.rst awscli-1.17.14/awscli/examples/gamelift/describe-runtime-configuration.rst --- awscli-1.16.301/awscli/examples/gamelift/describe-runtime-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/gamelift/describe-runtime-configuration.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,29 @@ +**To request the runtime configuration for a fleet** + +The following ``describe-runtime-configuration`` example retrieves details about the current runtime configuration for a specified fleet. :: + + aws gamelift describe-runtime-configuration \ + --fleet-id fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 + +Output:: + + { + "RuntimeConfiguration": { + "ServerProcesses": [ + { + "LaunchPath": "C:\game\Bin64.Release.Dedicated\MegaFrogRace_Server.exe", + "Parameters": "+gamelift_start_server", + "ConcurrentExecutions": 3 + }, + { + "LaunchPath": "C:\game\Bin64.Release.Dedicated\MegaFrogRace_Server.exe", + "Parameters": "+gamelift_start_server +debug", + "ConcurrentExecutions": 1 + } + ], + "MaxConcurrentGameSessionActivations": 2147483647, + "GameSessionActivationTimeoutSeconds": 300 + } + } + +For more information, see `Run Multiple Processes on a Fleet `__ in the *Amazon GameLift Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/gamelift/list-builds.rst awscli-1.17.14/awscli/examples/gamelift/list-builds.rst --- awscli-1.16.301/awscli/examples/gamelift/list-builds.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/gamelift/list-builds.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,67 @@ +**Example1: To get a list of custom game builds** + +The following ``list-builds`` example retrieves properties for all game server builds in the current Region. The sample request illustrates how to use the pagination parameters, ``Limit`` and ``NextToken``, to retrieve the results in sequential sets. The first command retrieves the first two builds. Because there are more than two available, the response includes a ``NextToken`` to indicate that more results are available. :: + + aws gamelift list-builds \ + --limit 2 + +Output:: + + { + "Builds": [ + { + "BuildArn": "arn:aws:gamelift:us-west-2::build/build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "BuildId": "build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "CreationTime": 1495664528.723, + "Name": "My_Game_Server_Build_One", + "OperatingSystem": "WINDOWS_2012", + "SizeOnDisk": 8567781, + "Status": "READY", + "Version": "12345.678" + }, + { + "BuildArn": "arn:aws:gamelift:us-west-2::build/build-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "BuildId": "build-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "CreationTime": 1495528748.555, + "Name": "My_Game_Server_Build_Two", + "OperatingSystem": "AMAZON_LINUX_2", + "SizeOnDisk": 8567781, + "Status": "FAILED", + "Version": "23456.789" + } + ], + "NextToken": "eyJhd3NBY2NvdW50SWQiOnsicyI6IjMwMjc3NjAxNjM5OCJ9LCJidWlsZElkIjp7InMiOiJidWlsZC01NWYxZTZmMS1jY2FlLTQ3YTctOWI5ZS1iYjFkYTQwMjJEXAMPLE=" + } + +You can then call the command again with the ``--next-token`` parameter as follows to see the next two builds. :: + + aws gamelift list-builds \ + --limit 2 + --next-token eyJhd3NBY2NvdW50SWQiOnsicyI6IjMwMjc3NjAxNjM5OCJ9LCJidWlsZElkIjp7InMiOiJidWlsZC01NWYxZTZmMS1jY2FlLTQ3YTctOWI5ZS1iYjFkYTQwMjJEXAMPLE= + +Repeat until the response doesn't include a ``NextToken`` value. + +**Example2: To get a list of custom game builds in failure status** + +The following ``list-builds`` example retrieves properties for all game server builds in the current region that currently have status FAILED. :: + + aws gamelift list-builds \ + --status FAILED + +Output:: + + { + "Builds": [ + { + "BuildArn": "arn:aws:gamelift:us-west-2::build/build-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "BuildId": "build-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "CreationTime": 1495528748.555, + "Name": "My_Game_Server_Build_Two", + "OperatingSystem": "AMAZON_LINUX_2", + "SizeOnDisk": 8567781, + "Status": "FAILED", + "Version": "23456.789" + } + ] + } + diff -Nru awscli-1.16.301/awscli/examples/gamelift/list-fleets.rst awscli-1.17.14/awscli/examples/gamelift/list-fleets.rst --- awscli-1.16.301/awscli/examples/gamelift/list-fleets.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/gamelift/list-fleets.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,39 @@ +**Example1: To get a list of all fleets in a Region** + +The following ``list-fleets`` example displays the fleet IDs of all fleets in the current Region. This example uses pagination parameters to retrieve two fleet IDs at a time. The response includes a ``next-token`` attribute, which indicates that there are more results to retrieve. :: + + aws gamelift list-fleets \ + --limit 2 + +Output:: + + { + "FleetIds": [ + "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222" + ], + "NextToken": "eyJhd3NBY2NvdW50SWQiOnsicyI6IjMwMjc3NjAxNjM5OCJ9LCJidWlsZElkIjp7InMiOiJidWlsZC01NWYxZTZmMS1jY2FlLTQ3YTctOWI5ZS1iYjFkYTQwMjJEXAMPLE=" + } + +You can pass the ``NextToken`` value from the previous response in the next command, as shown here to get the next two results. :: + + aws gamelift list-fleets \ + --limit 2 \ + --next-token eyJhd3NBY2NvdW50SWQiOnsicyI6IjMwMjc3NjAxNjM5OCJ9LCJidWlsZElkIjp7InMiOiJidWlsZC00NDRlZjQxZS1hM2I1LTQ2NDYtODJmMy0zYzI4ZTgxNjVjEXAMPLE= + +**Example2: To get a list of all fleets in a Region with a specific build or script** + +The following ``list-builds`` example retrieves the IDs of fleets that are deployed with the specified game build. If you're working with Realtime Servers, you can provide a script ID in place of a build ID. Because this example does not specify the limit parameter, the results can include up to 16 fleet IDs. :: + + aws gamelift list-fleets \ + --build-id build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 + +Output:: + + { + "FleetIds": [ + "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", + "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE44444" + ] + } diff -Nru awscli-1.16.301/awscli/examples/gamelift/request-upload-credentials.rst awscli-1.17.14/awscli/examples/gamelift/request-upload-credentials.rst --- awscli-1.16.301/awscli/examples/gamelift/request-upload-credentials.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/gamelift/request-upload-credentials.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,22 @@ +**To refresh access credentials for uploading a build** + +The following ``create-build`` example obtains new, valid access credentials for uploading a GameLift build file to an Amazon S3 location. Credentials have a limited life span. You get the build ID from the response to the original ``CreateBuild`` request. :: + + aws gamelift request-upload-credentials \ + --build-id build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 + +Output:: + + { + "StorageLocation": { + "Bucket": "gamelift-builds-us-west-2", + "Key": "123456789012/build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" + }, + "UploadCredentials": { + "AccessKeyId": "AKIAIOSFODNN7EXAMPLE", + "SecretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "SessionToken": "AgoGb3JpZ2luENz...EXAMPLETOKEN==" + } + } + +For more information, see `Upload a Custom Server Build to GameLift `__ in the *Amazon GameLift Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/gamelift/start-fleet-actions.rst awscli-1.17.14/awscli/examples/gamelift/start-fleet-actions.rst --- awscli-1.16.301/awscli/examples/gamelift/start-fleet-actions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/gamelift/start-fleet-actions.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,9 @@ +**To restart fleet automatic scaling activity** + +The following ``start-fleet-actions`` example resumes the use of all scaling policies that are defined for the specified fleet but were stopped by calling``stop-fleet-actions``. After starting, the scaling policies immediately begin tracking their respective metrics. :: + + aws gamelift start-fleet-actions \ + --fleet-id fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ + --actions AUTO_SCALING + +This command produces no output. diff -Nru awscli-1.16.301/awscli/examples/gamelift/stop-fleet-actions.rst awscli-1.17.14/awscli/examples/gamelift/stop-fleet-actions.rst --- awscli-1.16.301/awscli/examples/gamelift/stop-fleet-actions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/gamelift/stop-fleet-actions.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,10 @@ +**To stop a fleet's automatic scaling activity** + +The following ``stop-fleet-actions`` example stops the use of all scaling policies that are defined for the specified fleet. After the policies are suspended, fleet capacity remains at the same active instance count unless you adjust it manually. :: + + aws gamelift start-fleet-actions \ + --fleet-id fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ + --actions AUTO_SCALING + +This command produces no output. + diff -Nru awscli-1.16.301/awscli/examples/gamelift/update-build.rst awscli-1.17.14/awscli/examples/gamelift/update-build.rst --- awscli-1.16.301/awscli/examples/gamelift/update-build.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/gamelift/update-build.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,25 @@ +**To update a custom game build** + +The following ``update-build`` example changes the name and version information that is associated with a specified build resource. The returned build object verifies that the changes were made successfully. :: + + aws gamelift update-build \ + --build-id build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ + --name MegaFrogRaceServer.NA.east \ + --build-version 12345.east + +Output:: + + { + "Build": { + "BuildArn": "arn:aws:gamelift:us-west-2::build/build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "BuildId": "build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "CreationTime": 1496708916.18, + "Name": "MegaFrogRaceServer.NA.east", + "OperatingSystem": "AMAZON_LINUX_2", + "SizeOnDisk": 1304924, + "Status": "READY", + "Version": "12345.east" + } + } + +For more information, see `Update Your Build Files `__ in the *Amazon GameLift Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/gamelift/update-game-session-queue.rst awscli-1.17.14/awscli/examples/gamelift/update-game-session-queue.rst --- awscli-1.16.301/awscli/examples/gamelift/update-game-session-queue.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/gamelift/update-game-session-queue.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,50 @@ +**To update a game session queue configuration** + +The following ``update-game-session-queue`` example adds a new destination and updates the player latency policies for an existing game session queue. :: + + aws gamelift update-game-session-queue \ + --name MegaFrogRace-NA \ + --destinations file://destinations.json \ + --player-latency-policies file://latency-policies.json + +Contents of ``destinations.json``:: + + { + "Destinations": [ + {"DestinationArn": "arn:aws:gamelift:us-west-2::fleet/fleet-1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"}, + {"DestinationArn": "arn:aws:gamelift:us-east-1::fleet/fleet-5c6d3c4d-5e6f-7a8b-9c0d-1e2f3a4b5a2b"}, + {"DestinationArn": "arn:aws:gamelift:us-east-1::alias/alias-11aa22bb-3c4d-5e6f-000a-1111aaaa22bb"} + ] + } + +Contents of ``latency-policies.json``:: + + { + "PlayerLatencyPolicies": [ + {"MaximumIndividualPlayerLatencyMilliseconds": 200}, + {"MaximumIndividualPlayerLatencyMilliseconds": 150, "PolicyDurationSeconds": 120}, + {"MaximumIndividualPlayerLatencyMilliseconds": 100, "PolicyDurationSeconds": 120} + ] + } + +Output:: + + { + "GameSessionQueue": { + "Destinations": [ + {"DestinationArn": "arn:aws:gamelift:us-west-2::fleet/fleet-1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"}, + {"DestinationArn": "arn:aws:gamelift:us-east-1::fleet/fleet-5c6d3c4d-5e6f-7a8b-9c0d-1e2f3a4b5a2b"}, + {"DestinationArn": "arn:aws:gamelift:us-east-1::alias/alias-11aa22bb-3c4d-5e6f-000a-1111aaaa22bb"} + ], + "GameSessionQueueArn": "arn:aws:gamelift:us-west-2:111122223333:gamesessionqueue/MegaFrogRace-NA", + "Name": "MegaFrogRace-NA", + "TimeoutInSeconds": 600, + "PlayerLatencyPolicies": [ + {"MaximumIndividualPlayerLatencyMilliseconds": 200}, + {"MaximumIndividualPlayerLatencyMilliseconds": 150, "PolicyDurationSeconds": 120}, + {"MaximumIndividualPlayerLatencyMilliseconds": 100, "PolicyDurationSeconds": 120} + ] + } + } + +For more information, see `Using Multi-Region Queues `__ in the *Amazon GameLift Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/gamelift/upload-build.rst awscli-1.17.14/awscli/examples/gamelift/upload-build.rst --- awscli-1.16.301/awscli/examples/gamelift/upload-build.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/gamelift/upload-build.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,41 @@ +**Example1: To upload a Linux game server build** + +The following ``upload-build`` example uploads Linux game server build files from a file directory to the GameLift service and creates a build resource. :: + + aws gamelift upload-build \ + --name MegaFrogRaceServer.NA \ + --build-version 2.0.1 \ + --build-root ~/MegaFrogRace_Server/release-na \ + --operating-system AMAZON_LINUX_2 + +Output:: + + Uploading ~/MegaFrogRace_Server/release-na: 16.0 KiB / 74.6 KiB (21.45%) + Uploading ~/MegaFrogRace_Server/release-na: 32.0 KiB / 74.6 KiB (42.89%) + Uploading ~/MegaFrogRace_Server/release-na: 48.0 KiB / 74.6 KiB (64.34%) + Uploading ~/MegaFrogRace_Server/release-na: 64.0 KiB / 74.6 KiB (85.79%) + Uploading ~/MegaFrogRace_Server/release-na: 74.6 KiB / 74.6 KiB (100.00%) + Successfully uploaded ~/MegaFrogRace_Server/release-na to AWS GameLift + Build ID: build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 + +**Example2: To upload a Windows game server build** + +The following ``upload-build`` example uploads Windows game server build files from a directory to the GameLift service and creates a build record. :: + + aws gamelift upload-build \ + --name MegaFrogRaceServer.NA \ + --build-version 2.0.1 \ + --build-root C:\MegaFrogRace_Server\release-na \ + --operating-system WINDOWS_2012 + +Output:: + + Uploading C:\MegaFrogRace_Server\release-na: 16.0 KiB / 74.6 KiB (21.45%) + Uploading C:\MegaFrogRace_Server\release-na: 32.0 KiB / 74.6 KiB (42.89%) + Uploading C:\MegaFrogRace_Server\release-na: 48.0 KiB / 74.6 KiB (64.34%) + Uploading C:\MegaFrogRace_Server\release-na: 64.0 KiB / 74.6 KiB (85.79%) + Uploading C:\MegaFrogRace_Server\release-na: 74.6 KiB / 74.6 KiB (100.00%) + Successfully uploaded C:\MegaFrogRace_Server\release-na to AWS GameLift + Build ID: build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 + +For more information, see `Upload a Custom Server Build to GameLift `__ in the *Amazon GameLift Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/greengrass/list-bulk-deployment-detailed-reports.rst awscli-1.17.14/awscli/examples/greengrass/list-bulk-deployment-detailed-reports.rst --- awscli-1.16.301/awscli/examples/greengrass/list-bulk-deployment-detailed-reports.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/greengrass/list-bulk-deployment-detailed-reports.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,32 @@ +**To list information about individual deployments in a bulk deployment** + +The following ``list-bulk-deployment-detailed-reports`` example displays information about the individual deployments in a bulk deployment operation, including status. :: + + aws greengrass list-bulk-deployment-detailed-reports \ + --bulk-deployment-id 42ce9c42-489b-4ed4-b905-8996aa50ef9d + +Output:: + + { + "Deployments": [ + { + "DeploymentType": "NewDeployment", + "DeploymentStatus": "Success", + "DeploymentId": "123456789012:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "DeploymentArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333/deployments/123456789012:123456789012:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "GroupArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333/versions/123456789012:a1b2c3d4-5678-90ab-cdef-EXAMPLE44444", + "CreatedAt": "2020-01-21T21:34:16.501Z" + }, + { + "DeploymentType": "NewDeployment", + "DeploymentStatus": "InProgress", + "DeploymentId": "123456789012:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "DeploymentArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/a1b2c3d4-5678-90ab-cdef-EXAMPLE55555/deployments/123456789012:123456789012:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "GroupArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/a1b2c3d4-5678-90ab-cdef-EXAMPLE55555/versions/a1b2c3d4-5678-90ab-cdef-EXAMPLE66666", + "CreatedAt": "2020-01-21T21:34:16.486Z" + }, + ... + ] + } + +For more information, see `Create Bulk Deployments for Groups `__ in the *AWS IoT Greengrass Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/greengrass/list-function-definitions-versions.rst awscli-1.17.14/awscli/examples/greengrass/list-function-definitions-versions.rst --- awscli-1.16.301/awscli/examples/greengrass/list-function-definitions-versions.rst 2019-12-11 19:07:40.000000000 +0000 +++ awscli-1.17.14/awscli/examples/greengrass/list-function-definitions-versions.rst 1970-01-01 00:00:00.000000000 +0000 @@ -1,37 +0,0 @@ -**To list the versions of a Lambda function** - -The following ``list-function-definition-versions`` example lists all of the versions of the specified Lambda function. You can use the ``list-function-definitions`` command to get the ID. :: - - aws greengrass list-function-definition-versions \ - --function-definition-id "063f5d1a-1dd1-40b4-9b51-56f8993d0f85" - -Output:: - - { - "Versions": [ - { - "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/063f5d1a-1dd1-40b4-9b51-56f8993d0f85/versions/9748fda7-1589-4fcc-ac94-f5559e88678b", - "CreationTimestamp": "2019-06-18T17:04:30.776Z", - "Id": "063f5d1a-1dd1-40b4-9b51-56f8993d0f85", - "Version": "9748fda7-1589-4fcc-ac94-f5559e88678b" - }, - { - "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/063f5d1a-1dd1-40b4-9b51-56f8993d0f85/versions/9b08df77-26f2-4c29-93d2-769715edcfec", - "CreationTimestamp": "2019-06-18T17:02:44.087Z", - "Id": "063f5d1a-1dd1-40b4-9b51-56f8993d0f85", - "Version": "9b08df77-26f2-4c29-93d2-769715edcfec" - }, - { - "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/063f5d1a-1dd1-40b4-9b51-56f8993d0f85/versions/4236239f-94f7-4b90-a2f8-2a24c829d21e", - "CreationTimestamp": "2019-06-18T17:01:42.284Z", - "Id": "063f5d1a-1dd1-40b4-9b51-56f8993d0f85", - "Version": "4236239f-94f7-4b90-a2f8-2a24c829d21e" - }, - { - "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/063f5d1a-1dd1-40b4-9b51-56f8993d0f85/versions/343408bb-549a-4fbe-b043-853643179a39", - "CreationTimestamp": "2019-06-18T16:21:21.431Z", - "Id": "063f5d1a-1dd1-40b4-9b51-56f8993d0f85", - "Version": "343408bb-549a-4fbe-b043-853643179a39" - } - ] - } diff -Nru awscli-1.16.301/awscli/examples/greengrass/list-function-definition-versions.rst awscli-1.17.14/awscli/examples/greengrass/list-function-definition-versions.rst --- awscli-1.16.301/awscli/examples/greengrass/list-function-definition-versions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/greengrass/list-function-definition-versions.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,37 @@ +**To list the versions of a Lambda function** + +The following ``list-function-definition-versions`` example lists all of the versions of the specified Lambda function. You can use the ``list-function-definitions`` command to get the ID. :: + + aws greengrass list-function-definition-versions \ + --function-definition-id "063f5d1a-1dd1-40b4-9b51-56f8993d0f85" + +Output:: + + { + "Versions": [ + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/063f5d1a-1dd1-40b4-9b51-56f8993d0f85/versions/9748fda7-1589-4fcc-ac94-f5559e88678b", + "CreationTimestamp": "2019-06-18T17:04:30.776Z", + "Id": "063f5d1a-1dd1-40b4-9b51-56f8993d0f85", + "Version": "9748fda7-1589-4fcc-ac94-f5559e88678b" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/063f5d1a-1dd1-40b4-9b51-56f8993d0f85/versions/9b08df77-26f2-4c29-93d2-769715edcfec", + "CreationTimestamp": "2019-06-18T17:02:44.087Z", + "Id": "063f5d1a-1dd1-40b4-9b51-56f8993d0f85", + "Version": "9b08df77-26f2-4c29-93d2-769715edcfec" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/063f5d1a-1dd1-40b4-9b51-56f8993d0f85/versions/4236239f-94f7-4b90-a2f8-2a24c829d21e", + "CreationTimestamp": "2019-06-18T17:01:42.284Z", + "Id": "063f5d1a-1dd1-40b4-9b51-56f8993d0f85", + "Version": "4236239f-94f7-4b90-a2f8-2a24c829d21e" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/063f5d1a-1dd1-40b4-9b51-56f8993d0f85/versions/343408bb-549a-4fbe-b043-853643179a39", + "CreationTimestamp": "2019-06-18T16:21:21.431Z", + "Id": "063f5d1a-1dd1-40b4-9b51-56f8993d0f85", + "Version": "343408bb-549a-4fbe-b043-853643179a39" + } + ] + } diff -Nru awscli-1.16.301/awscli/examples/iam/list-policies.rst awscli-1.17.14/awscli/examples/iam/list-policies.rst --- awscli-1.16.301/awscli/examples/iam/list-policies.rst 2019-12-11 19:07:42.000000000 +0000 +++ awscli-1.17.14/awscli/examples/iam/list-policies.rst 2020-02-10 19:14:32.000000000 +0000 @@ -23,11 +23,11 @@ }, { "PolicyName": "ASamplePolicy", - "CreateDate": "2015-06-17T19:23;32Z", - "AttachmentCount": "0", - "IsAttachable": "true", + "CreateDate": "2015-06-17T19:23;32Z", + "AttachmentCount": "0", + "IsAttachable": "true", "PolicyId": "Z27SI6FQMGNQ2EXAMPLE1", - "DefaultVersionId": "v1", + "DefaultVersionId": "v1", "Path": "/", "Arn": "arn:aws:iam::123456789012:policy/ASamplePolicy", "UpdateDate": "2015-06-17T19:23:32Z" @@ -37,4 +37,4 @@ For more information, see `Overview of IAM Policies`_ in the *Using IAM* guide. -.. _`Overview of IAM Policies`: http://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html \ No newline at end of file +.. _`Overview of IAM Policies`: http://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html diff -Nru awscli-1.16.301/awscli/examples/iot/cancel-audit-mitigation-actions-task.rst awscli-1.17.14/awscli/examples/iot/cancel-audit-mitigation-actions-task.rst --- awscli-1.16.301/awscli/examples/iot/cancel-audit-mitigation-actions-task.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/iot/cancel-audit-mitigation-actions-task.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,10 @@ +**To cancel an audit mitigation actions task** + +The following ``cancel-audit-mitigations-action-task`` example cancels the application of mitigation actions for the specified task. You cannot cancel tasks that are already completed. :: + + aws iot cancel-audit-mitigation-actions-task + --task-id "myActionsTaskId" + +This command produces no output. + +For more information, see `CancelAuditMitigationActionsTask (Mitigation Action Commands) `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/iot/create-domain-configuration.rst awscli-1.17.14/awscli/examples/iot/create-domain-configuration.rst --- awscli-1.16.301/awscli/examples/iot/create-domain-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/iot/create-domain-configuration.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,16 @@ +**To create a domain configuration** + +The following ``create-domain-configuration`` example creates an AWS-managed domain configuration with a service type of ``DATA``. :: + + aws iot create-domain-configuration \ + --domain-configuration-name "additionalDataDomain" \ + --service-type "DATA" + +Output:: + + { + "domainConfigurationName": "additionalDataDomain", + "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/additionalDataDomain/dikMh" + } + +For more information, see `Configurable Endpoints `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/iot/create-mitigation-action.rst awscli-1.17.14/awscli/examples/iot/create-mitigation-action.rst --- awscli-1.16.301/awscli/examples/iot/create-mitigation-action.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/iot/create-mitigation-action.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,29 @@ +**To create a mitigation action** + +The following ``create-mitigation-action`` example defines a mitigation action named ``AddThingsToQuarantineGroup1Action`` that, when applied, moves things into the thing group named ``QuarantineGroup1``. This action overrides dynamic thing groups. :: + + aws iot create-mitigation-action --cli-input-json file::params.json + +Contents of ``params.json``:: + + { + "actionName": "AddThingsToQuarantineGroup1Action", + "actionParams": { + "addThingsToThingGroupParams": { + "thingGroupNames": [ + "QuarantineGroup1" + ], + "overrideDynamicGroups": true + } + }, + "roleArn": "arn:aws:iam::123456789012:role/service-role/MoveThingsToQuarantineGroupRole" + } + +Output:: + + { + "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/AddThingsToQuarantineGroup1Action", + "actionId": "992e9a63-a899-439a-aa50-4e20c52367e1" + } + +For more information, see `CreateMitigationAction (Mitigation Action Commands) `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/iot/delete-domain-configuration.rst awscli-1.17.14/awscli/examples/iot/delete-domain-configuration.rst --- awscli-1.16.301/awscli/examples/iot/delete-domain-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/iot/delete-domain-configuration.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,11 @@ +**To delete a domain configuration** + +The following ``delete-domain-configuration`` example deletes a domain configuration named ``additionalDataDomain`` from your AWS account. :: + + aws iot update-domain-configuration \ + --domain-configuration-name "additionalDataDomain" \ + --domain-configuration-status "DISABLED" + +This command produces no output. + +For more information, see `Configurable Endpoints `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/iot/delete-mitigation-action.rst awscli-1.17.14/awscli/examples/iot/delete-mitigation-action.rst --- awscli-1.16.301/awscli/examples/iot/delete-mitigation-action.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/iot/delete-mitigation-action.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a mitigation action** + +The following ``delete-mitigation-action`` example deletes the specified mitigation action. :: + + aws iot delete-mitigation-action \ + --action-name AddThingsToQuarantineGroup1Action + +This command produces no output. + +For more information, see `DeleteMitigationAction (Mitigation Action Commands) `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/iot/describe-audit-finding.rst awscli-1.17.14/awscli/examples/iot/describe-audit-finding.rst --- awscli-1.16.301/awscli/examples/iot/describe-audit-finding.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/iot/describe-audit-finding.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,32 @@ +**To list details for an audit finding** + +The following ``describe-audit-finding`` example lists the details for the specified AWS IoT Device Defender audit finding. An audit can produce multiple findings. Use the ``list-audit-findings`` command to get a list of the findings from an audit to get the ``findingId``. :: + + aws iot describe-audit-finding \ + --finding-id "ef4826b8-e55a-44b9-b460-5c485355371b" + +Output:: + + { + "finding": { + "findingId": "ef4826b8-e55a-44b9-b460-5c485355371b", + "taskId": "873ed69c74a9ec8fa9b8e88e9abc4661", + "checkName": "IOT_POLICY_OVERLY_PERMISSIVE_CHECK", + "taskStartTime": 1576012045.745, + "findingTime": 1576012046.168, + "severity": "CRITICAL", + "nonCompliantResource": { + "resourceType": "IOT_POLICY", + "resourceIdentifier": { + "policyVersionIdentifier": { + "policyName": "smp-ggrass-group_Core-policy", + "policyVersionId": "1" + } + } + }, + "reasonForNonCompliance": "Policy allows broad access to IoT data plane actions: [iot:Subscribe, iot:Connect, iot:GetThingShadow, iot:DeleteThingShadow, iot:UpdateThingShadow, iot:Publish].", + "reasonForNonComplianceCode": "ALLOWS_BROAD_ACCESS_TO_IOT_DATA_PLANE_ACTIONS" + } + } + +For more information, see `Check Audit Results (Audit Commands) `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/iot/describe-audit-mitigation-actions-task.rst awscli-1.17.14/awscli/examples/iot/describe-audit-mitigation-actions-task.rst --- awscli-1.16.301/awscli/examples/iot/describe-audit-mitigation-actions-task.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/iot/describe-audit-mitigation-actions-task.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,47 @@ +**To show the details of an audit mitigation actions task** + +The following ``describe-audit-mitigation-actions-task`` example shows the details for the specified task, where the ``ResetPolicyVersionAction`` was applied to a finding. The results include when the task started and ended, how many findings were targeted (and the outcome), and the definition of the action that is applied as part of this task. :: + + aws iot describe-audit-mitigation-actions-task \ + --task-id ResetPolicyTask01 + +Output:: + + { + "taskStatus": "COMPLETED", + "startTime": "2019-12-10T15:13:19.457000-08:00", + "endTime": "2019-12-10T15:13:19.947000-08:00", + "taskStatistics": { + "IOT_POLICY_OVERLY_PERMISSIVE_CHECK": { + "totalFindingsCount": 1, + "failedFindingsCount": 0, + "succeededFindingsCount": 1, + "skippedFindingsCount": 0, + "canceledFindingsCount": 0 + } + }, + "target": { + "findingIds": [ + "ef4826b8-e55a-44b9-b460-5c485355371b" + ] + }, + "auditCheckToActionsMapping": { + "IOT_POLICY_OVERLY_PERMISSIVE_CHECK": [ + "ResetPolicyVersionAction" + ] + }, + "actionsDefinition": [ + { + "name": "ResetPolicyVersionAction", + "id": "1ea0b415-bef1-4a01-bd13-72fb63c59afb", + "roleArn": "arn:aws:iam::123456789012:role/service-role/ReplacePolicyVersionRole", + "actionParams": { + "replaceDefaultPolicyVersionParams": { + "templateName": "BLANK_POLICY" + } + } + } + ] + } + +For more information, see `DescribeAuditMitigationActionsTask (Mitigation Action Commands) `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/iot/describe-domain-configuration.rst awscli-1.17.14/awscli/examples/iot/describe-domain-configuration.rst --- awscli-1.16.301/awscli/examples/iot/describe-domain-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/iot/describe-domain-configuration.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,20 @@ +**To describe a domain configuration** + +The following ``describe-domain-configuration`` example displays details about the specified domain configuration. :: + + aws iot describe-domain-configuration \ + --domain-configuration-name "additionalDataDomain" + +Output:: + + { + "domainConfigurationName": "additionalDataDomain", + "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/additionalDataDomain/dikMh", + "domainName": "d01645582h24k4we2vblw-ats.iot.us-west-2.amazonaws.com", + "serverCertificates": [], + "domainConfigurationStatus": "ENABLED", + "serviceType": "DATA", + "domainType": "AWS_MANAGED" + } + +For more information, see `Configurable Endpoints `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/iot/describe-mitigation-action.rst awscli-1.17.14/awscli/examples/iot/describe-mitigation-action.rst --- awscli-1.16.301/awscli/examples/iot/describe-mitigation-action.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/iot/describe-mitigation-action.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,28 @@ +**To view the details for a defined mitigation action** + +The following ``describe-mitigation-action`` example displays details for the specified mitigation action. :: + + aws iot describe-mitigation-action \ + --action-name AddThingsToQuarantineGroupAction + +Output:: + + { + "actionName": "AddThingsToQuarantineGroupAction", + "actionType": "ADD_THINGS_TO_THING_GROUP", + "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/AddThingsToQuarantineGroupAction", + "actionId": "2fd2726d-98e1-4abf-b10f-09465ccd6bfa", + "roleArn": "arn:aws:iam::123456789012:role/service-role/MoveThingsToQuarantineGroupRole", + "actionParams": { + "addThingsToThingGroupParams": { + "thingGroupNames": [ + "QuarantineGroup1" + ], + "overrideDynamicGroups": true + } + }, + "creationDate": "2019-12-10T11:09:35.999000-08:00", + "lastModifiedDate": "2019-12-10T11:09:35.999000-08:00" + } + +For more information, see `DescribeMitigationAction (Mitigation Action Commands) `__ in the *AWS IoT Developer Guide*. \ No newline at end of file diff -Nru awscli-1.16.301/awscli/examples/iot/get-cardinality.rst awscli-1.17.14/awscli/examples/iot/get-cardinality.rst --- awscli-1.16.301/awscli/examples/iot/get-cardinality.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/iot/get-cardinality.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,42 @@ +**To return the approximate count of unique values that match the query** + +You can use the following setup script to create 10 things representing 10 temperature sensors. Each new thing has 3 attributes. :: + + # Bash script. If in other shells, type `bash` before running + Temperatures=(70 71 72 73 74 75 47 97 98 99) + Racks=(Rack1 Rack1 Rack2 Rack2 Rack3 Rack4 Rack5 Rack6 Rack6 Rack6) + IsNormal=(true true true true true true false false false false) + for ((i=0; i<10 ; i++)) + do + thing=$(aws iot create-thing --thing-name "TempSensor$i" --attribute-payload attributes="{temperature=${Temperatures[i]},rackId=${Racks[i]},stateNormal=${IsNormal[i]}}") + aws iot describe-thing --thing-name "TempSensor$i" + done + +Example output of the setup script:: + + { + "version": 1, + "thingName": "TempSensor0", + "defaultClientId": "TempSensor0", + "attributes": { + "rackId": "Rack1", + "stateNormal": "true", + "temperature": "70" + }, + "thingArn": "arn:aws:iot:us-east-1:123456789012:thing/TempSensor0", + "thingId": "example1-90ab-cdef-fedc-ba987example" + } + +The following ``get-cardinality`` example queries the 10 sensors created by the setup script and returns the number of racks that have temperature sensors reporting abnormal temperature values. If the temperature value is below 60 or above 80, the temperature sensor is in an abnormal state. :: + + aws iot get-cardinality \ + --aggregation-field "attributes.rackId" \ + --query-string "thingName:TempSensor* AND attributes.stateNormal:false" + +Output:: + + { + "cardinality": 2 + } + +For more information, see `Querying for Aggregate Data`__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/iot/get-percentiles.rst awscli-1.17.14/awscli/examples/iot/get-percentiles.rst --- awscli-1.16.301/awscli/examples/iot/get-percentiles.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/iot/get-percentiles.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,60 @@ +**To group the aggregated values that match the query into percentile groupings** + +You can use the following setup script to create 10 things representing 10 temperature sensors. Each new thing has 1 attribute. :: + + # Bash script. If in other shells, type `bash` before running + Temperatures=(70 71 72 73 74 75 47 97 98 99) + for ((i=0; i<10 ; i++)) + do + thing=$(aws iot create-thing --thing-name "TempSensor$i" --attribute-payload attributes="{temperature=${Temperatures[i]}}") + aws iot describe-thing --thing-name "TempSensor$i" + done + +Example output of the setup script:: + + { + "version": 1, + "thingName": "TempSensor0", + "defaultClientId": "TempSensor0", + "attributes": { + "temperature": "70" + }, + "thingArn": "arn:aws:iot:us-east-1:123456789012:thing/TempSensor0", + "thingId": "example1-90ab-cdef-fedc-ba987example" + } + +The following ``get-percentiles`` example queries the 10 sensors created by the setup script and returns a value for each percentile group specified. The percentile group "10" contains the aggregated field value that occurs in approximately 10 percent of the values that match the query. In the following output, {"percent": 10.0, "value": 67.7} means approximately 10.0% of the temperature values are below 67.7. :: + + aws iot get-percentiles \ + --aggregation-field "attributes.temperature" \ + --query-string "thingName:TempSensor*" \ + --percents 10 25 50 75 90 + +Output:: + + { + "percentiles": [ + { + "percent": 10.0, + "value": 67.7 + }, + { + "percent": 25.0, + "value": 71.25 + }, + { + "percent": 50.0, + "value": 73.5 + }, + { + "percent": 75.0, + "value": 91.5 + }, + { + "percent": 90.0, + "value": 98.1 + } + ] + } + +For more information, see `Querying for Aggregate Data `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/iot/list-audit-mitigation-actions-executions.rst awscli-1.17.14/awscli/examples/iot/list-audit-mitigation-actions-executions.rst --- awscli-1.16.301/awscli/examples/iot/list-audit-mitigation-actions-executions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/iot/list-audit-mitigation-actions-executions.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,27 @@ +**To list the details of an audit mitigation action execution** + +An audit mitigation action task applies a mitigation action to one or more findings from an AWS IoT Device +Defender audit. The following ``list-audit-mitigation-actions-executions`` example lists the details for the +mitigation action task with the specified ``taskId`` and for the specified finding. :: + + aws iot list-audit-mitigation-actions-executions \ + --task-id myActionsTaskId \ + --finding-id 0edbaaec-2fe1-4cf5-abc9-d4c3e51f7464 + +Output:: + + { + "actionsExecutions": [ + { + "taskId": "myActionsTaskId", + "findingId": "0edbaaec-2fe1-4cf5-abc9-d4c3e51f7464", + "actionName": "ResetPolicyVersionAction", + "actionId": "1ea0b415-bef1-4a01-bd13-72fb63c59afb", + "status": "COMPLETED", + "startTime": "2019-12-10T15:19:13.279000-08:00", + "endTime": "2019-12-10T15:19:13.337000-08:00" + } + ] + } + +For more information, see `ListAuditMitigationActionsExecutions (Mitigation Action Commands) `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/iot/list-audit-mitigation-actions-tasks.rst awscli-1.17.14/awscli/examples/iot/list-audit-mitigation-actions-tasks.rst --- awscli-1.16.301/awscli/examples/iot/list-audit-mitigation-actions-tasks.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/iot/list-audit-mitigation-actions-tasks.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,34 @@ +**To list audit mitigation action tasks** + +The following ``list-audit-mitigation-actions-tasks`` example lists the mitigation actions that were applied to findings within the specified time period. :: + + aws iot create-mitigation-action --cli-input-json file://params.json + +Contents of ``params.json``:: + + { + "actionName": "AddThingsToQuarantineGroup1Action", + "actionParams": { + "addThingsToThingGroupParams": { + "thingGroupNames": [ + "QuarantineGroup1" + ], + "overrideDynamicGroups": true + } + }, + "roleArn": "arn:aws:iam::123456789012:role/service-role/MoveThingsToQuarantineGroupRole" + } + +Output:: + + { + "tasks": [ + { + "taskId": "ResetPolicyTask01", + "startTime": "2019-12-10T15:13:19.457000-08:00", + "taskStatus": "COMPLETED" + } + ] + } + +For more information, see `ListAuditMitigationActionsTasks (Mitigation Action Commands) `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/iot/list-domain-configurations.rst awscli-1.17.14/awscli/examples/iot/list-domain-configurations.rst --- awscli-1.16.301/awscli/examples/iot/list-domain-configurations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/iot/list-domain-configurations.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,37 @@ +**To list domain configurations** + +The following ``list-domain-configurations`` example lists the domain configurations in your AWS account that have the specified service type. :: + + aws iot list-domain-configurations \ + --service-type "DATA" + +Output:: + + { + "domainConfigurations": + [ + { + "domainConfigurationName": "additionalDataDomain", + "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/additionalDataDomain/dikMh", + "serviceType": "DATA" + }, + + { + "domainConfigurationName": "iot:Jobs", + "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/iot:Jobs", + "serviceType": "JOBS" + }, + { + "domainConfigurationName": "iot:Data-ATS", + "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/iot:Data-ATS", + "serviceType": "DATA" + }, + { + "domainConfigurationName": "iot:CredentialProvider", + "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/iot:CredentialProvider", + "serviceType": "CREDENTIAL_PROVIDER" + } + ] + } + +For more information, see `Configurable Endpoints `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/iot/list-mitigations-actions.rst awscli-1.17.14/awscli/examples/iot/list-mitigations-actions.rst --- awscli-1.16.301/awscli/examples/iot/list-mitigations-actions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/iot/list-mitigations-actions.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,44 @@ +**To list all defined mitigation actions** + +The following ``list-mitigations-actions`` example lists all defined mitigation actions for your AWS account and Region. For each action, the name, ARN, and creation date are listed. :: + + aws iot list-mitigation-actions + +Output:: + + { + "actionIdentifiers": [ + { + "actionName": "DeactivateCACertAction", + "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/DeactivateCACertAction", + "creationDate": "2019-12-10T11:12:47.574000-08:00" + }, + { + "actionName": "ResetPolicyVersionAction", + "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/ResetPolicyVersionAction", + "creationDate": "2019-12-10T11:11:48.920000-08:00" + }, + { + "actionName": "PublishFindingToSNSAction", + "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/PublishFindingToSNSAction", + "creationDate": "2019-12-10T11:10:49.546000-08:00" + }, + { + "actionName": "AddThingsToQuarantineGroupAction", + "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/AddThingsToQuarantineGroupAction", + "creationDate": "2019-12-10T11:09:35.999000-08:00" + }, + { + "actionName": "UpdateDeviceCertAction", + "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/UpdateDeviceCertAction", + "creationDate": "2019-12-10T11:08:44.263000-08:00" + }, + { + "actionName": "SampleMitigationAction", + "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/SampleMitigationAction", + "creationDate": "2019-12-10T11:03:41.840000-08:00" + } + ] + } + +For more information, see `ListMitigationActions (Mitigation Action Commands) `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/iot/start-audit-mitigation-actions-task.rst awscli-1.17.14/awscli/examples/iot/start-audit-mitigation-actions-task.rst --- awscli-1.16.301/awscli/examples/iot/start-audit-mitigation-actions-task.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/iot/start-audit-mitigation-actions-task.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,17 @@ +**To apply a mitigation action to the findings from an audit** + +The following ``start-audit-mitigation-actions-task`` example applies the ``ResetPolicyVersionAction`` action (which clears the policy) to the specified single finding. :: + + aws iot start-audit-mitigation-actions-task \ + --task-id "myActionsTaskId" \ + --target "findingIds=[\"0edbaaec-2fe1-4cf5-abc9-d4c3e51f7464\"]" \ + --audit-check-to-actions-mapping "IOT_POLICY_OVERLY_PERMISSIVE_CHECK=[\"ResetPolicyVersionAction\"]" \ + --client-request-token "adhadhahda" + +Output:: + + { + "taskId": "myActionsTaskId" + } + +For more information, see `StartAuditMitigationActionsTask (Mitigation Action Commands) `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/iot/update-domain-configuration.rst awscli-1.17.14/awscli/examples/iot/update-domain-configuration.rst --- awscli-1.16.301/awscli/examples/iot/update-domain-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/iot/update-domain-configuration.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,16 @@ +**To update a domain configuration** + +The following ``update-domain-configuration`` example disables the specified domain configuration. :: + + aws iot update-domain-configuration \ + --domain-configuration-name "additionalDataDomain" \ + --domain-configuration-status "DISABLED" + +Output:: + + { + "domainConfigurationName": "additionalDataDomain", + "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/additionalDataDomain/dikMh" + } + +For more information, see `Configurable Endpoints `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/iot/update-mitigation-action.rst awscli-1.17.14/awscli/examples/iot/update-mitigation-action.rst --- awscli-1.16.301/awscli/examples/iot/update-mitigation-action.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/iot/update-mitigation-action.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,15 @@ +**To update a mitigation action** + +The following ``update-mitigation-action`` example updates the specified mitigation action named ``AddThingsToQuarantineGroupAction``, changes the thing group name, and sets ``overrideDynamicGroups`` to ``false``. You can verify your changes by using the ``describe-mitigation-action`` command. :: + + aws iot update-mitigation-action \ + --cli-input-json "{ \"actionName\": \"AddThingsToQuarantineGroupAction\", \"actionParams\": { \"addThingsToThingGroupParams\": {\"thingGroupNames\":[\"QuarantineGroup2\"],\"overrideDynamicGroups\": false}}}" + +Output:: + + { + "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/AddThingsToQuarantineGroupAction", + "actionId": "2fd2726d-98e1-4abf-b10f-09465ccd6bfa" + } + +For more information, see `UpdateMitigationAction (Mitigation Action Commands) `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/kinesis/add-tags-to-stream.rst awscli-1.17.14/awscli/examples/kinesis/add-tags-to-stream.rst --- awscli-1.16.301/awscli/examples/kinesis/add-tags-to-stream.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/kinesis/add-tags-to-stream.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,11 @@ +**To add tags to a data stream** + +The following ``add-tags-to-stream`` example assigns a tag with the key ``samplekey`` and value ``example`` to the specified stream. :: + + aws kinesis add-tags-to-stream \ + --stream-name samplestream \ + --tags samplekey=example + +This command produces no output. + +For more information, see `Tagging Your Streams `__ in the *Amazon Kinesis Data Streams Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/kinesis/create-stream.rst awscli-1.17.14/awscli/examples/kinesis/create-stream.rst --- awscli-1.16.301/awscli/examples/kinesis/create-stream.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/kinesis/create-stream.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,11 @@ +**To create a data stream** + +The following ``create-stream`` example creates a data stream named samplestream with 3 shards. :: + + aws kinesis create-stream \ + --stream-name samplestream \ + --shard-count 3 + +This command produces no output. + +For more information, see `Creating a Stream `__ in the *Amazon Kinesis Data Streams Developer Guide*. \ No newline at end of file diff -Nru awscli-1.16.301/awscli/examples/kinesis/decrease-stream-retention-period.rst awscli-1.17.14/awscli/examples/kinesis/decrease-stream-retention-period.rst --- awscli-1.16.301/awscli/examples/kinesis/decrease-stream-retention-period.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/kinesis/decrease-stream-retention-period.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,11 @@ +**To decrease data stream retention period** + +The following ``decrease-stream-retention-period`` example decreases the retention period (the length of time data records are accessible after they are added to the stream) of a stream named samplestream to 48 hours. :: + + aws kinesis decrease-stream-retention-period \ + --stream-name samplestream \ + --retention-period-hours 48 + +This command produces no output. + +For more information, see `Changing the Data Retention Period `__ in the *Amazon Kinesis Data Streams Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/kinesis/delete-stream.rst awscli-1.17.14/awscli/examples/kinesis/delete-stream.rst --- awscli-1.16.301/awscli/examples/kinesis/delete-stream.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/kinesis/delete-stream.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a data stream** + +The following ``delete-stream`` example deletes the specified data stream. :: + + aws kinesis delete-stream \ + --stream-name samplestream + +This command produces no output. + +For more information, see `Deleting a Stream `__ in the *Amazon Kinesis Data Streams Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/kinesis/deregister-stream-consumer.rst awscli-1.17.14/awscli/examples/kinesis/deregister-stream-consumer.rst --- awscli-1.16.301/awscli/examples/kinesis/deregister-stream-consumer.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/kinesis/deregister-stream-consumer.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,11 @@ +**To deregister a data stream consumer** + +The following ``deregister-stream-consumer`` example deregisters the specified consumer from the specified data stream. :: + + aws kinesis deregister-stream-consumer \ + --stream-arn arn:aws:kinesis:us-west-2:123456789012:stream/samplestream \ + --consumer-name KinesisConsumerApplication + +This command produces no output. + +For more information, see `Developing Consumers with Enhanced Fan-Out Using the Kinesis Data Streams API `__ in the *Amazon Kinesis Data Streams Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/kinesis/describe-limits.rst awscli-1.17.14/awscli/examples/kinesis/describe-limits.rst --- awscli-1.16.301/awscli/examples/kinesis/describe-limits.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/kinesis/describe-limits.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,14 @@ +**To describe shard limits** + +The following ``describe-limits`` example displays the shard limits and usage for the current AWS account. :: + + aws kinesis describe-limits + +Output:: + + { + "ShardLimit": 500, + "OpenShardCount": 29 + } + +For more information, see `Resharding a Stream `__ in the *Amazon Kinesis Data Streams Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/kinesis/describe-stream-consumer.rst awscli-1.17.14/awscli/examples/kinesis/describe-stream-consumer.rst --- awscli-1.16.301/awscli/examples/kinesis/describe-stream-consumer.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/kinesis/describe-stream-consumer.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,21 @@ +**To describe a data stream consumer** + +The following ``describe-stream-consumer`` example returns the description of the specified consumer, registered with the specified data stream. :: + + aws kinesis describe-stream-consumer \ + --stream-arn arn:aws:kinesis:us-west-2:012345678912:stream/samplestream \ + --consumer-name KinesisConsumerApplication + +Output:: + + { + "ConsumerDescription": { + "ConsumerName": "KinesisConsumerApplication", + "ConsumerARN": "arn:aws:kinesis:us-west-2:123456789012:stream/samplestream/consumer/KinesisConsumerApplication:1572383852", + "ConsumerStatus": "ACTIVE", + "ConsumerCreationTimestamp": 1572383852.0, + "StreamARN": "arn:aws:kinesis:us-west-2:123456789012:stream/samplestream" + } + } + +For more information, see `Reading Data from Amazon Kinesis Data Streams `__ in the *Amazon Kinesis Data Streams Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/kinesis/describe-stream.rst awscli-1.17.14/awscli/examples/kinesis/describe-stream.rst --- awscli-1.16.301/awscli/examples/kinesis/describe-stream.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/kinesis/describe-stream.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,60 @@ +**To describe a data stream** + +The following ``describe-stream`` example returns the details of the specified data stream. :: + + aws kinesis describe-stream \ + --stream-name samplestream + +Output:: + + { + "StreamDescription": { + "Shards": [ + { + "ShardId": "shardId-000000000000", + "HashKeyRange": { + "StartingHashKey": "0", + "EndingHashKey": "113427455640312821154458202477256070484" + }, + "SequenceNumberRange": { + "StartingSequenceNumber": "49600871682957036442365024926191073437251060580128653314" + } + }, + { + "ShardId": "shardId-000000000001", + "HashKeyRange": { + "StartingHashKey": "113427455640312821154458202477256070485", + "EndingHashKey": "226854911280625642308916404954512140969" + }, + "SequenceNumberRange": { + "StartingSequenceNumber": "49600871682979337187563555549332609155523708941634633746" + } + }, + { + "ShardId": "shardId-000000000002", + "HashKeyRange": { + "StartingHashKey": "226854911280625642308916404954512140970", + "EndingHashKey": "340282366920938463463374607431768211455" + }, + "SequenceNumberRange": { + "StartingSequenceNumber": "49600871683001637932762086172474144873796357303140614178" + } + } + ], + "StreamARN": "arn:aws:kinesis:us-west-2:123456789012:stream/samplestream", + "StreamName": "samplestream", + "StreamStatus": "ACTIVE", + "RetentionPeriodHours": 24, + "EnhancedMonitoring": [ + { + "ShardLevelMetrics": [] + } + ], + "EncryptionType": "NONE", + "KeyId": null, + "StreamCreationTimestamp": 1572297168.0 + } + } + + +For more information, see `Creatinga and Managing Streams `__ in the *Amazon Kinesis Data Streams Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/kinesis/describe-stream-summary.rst awscli-1.17.14/awscli/examples/kinesis/describe-stream-summary.rst --- awscli-1.16.301/awscli/examples/kinesis/describe-stream-summary.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/kinesis/describe-stream-summary.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,28 @@ +**To describe a data stream summary** + +The following ``describe-stream-summary`` example provides a summarized description (without the shard list) of the specified data stream. :: + + aws kinesis describe-stream-summary \ + --stream-name samplestream + +Output:: + + { + "StreamDescriptionSummary": { + "StreamName": "samplestream", + "StreamARN": "arn:aws:kinesis:us-west-2:123456789012:stream/samplestream", + "StreamStatus": "ACTIVE", + "RetentionPeriodHours": 48, + "StreamCreationTimestamp": 1572297168.0, + "EnhancedMonitoring": [ + { + "ShardLevelMetrics": [] + } + ], + "EncryptionType": "NONE", + "OpenShardCount": 3, + "ConsumerCount": 0 + } + } + +For more information, see `Creating and Managing Streams `__ in the *Amazon Kinesis Data Streams Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/kinesis/disable-enhanced-monitoring.rst awscli-1.17.14/awscli/examples/kinesis/disable-enhanced-monitoring.rst --- awscli-1.16.301/awscli/examples/kinesis/disable-enhanced-monitoring.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/kinesis/disable-enhanced-monitoring.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,24 @@ +**To disable enhanced monitoring for shard-level metrics** + +The following ``disable-enhanced-monitoring`` example disables enhanced Kinesis data stream monitoring for shard-level metrics. :: + + aws kinesis disable-enhanced-monitoring \ + --stream-name samplestream --shard-level-metrics ALL + +Output:: + + { + "StreamName": "samplestream", + "CurrentShardLevelMetrics": [ + "IncomingBytes", + "OutgoingRecords", + "IteratorAgeMilliseconds", + "IncomingRecords", + "ReadProvisionedThroughputExceeded", + "WriteProvisionedThroughputExceeded", + "OutgoingBytes" + ], + "DesiredShardLevelMetrics": [] + } + +For more information, see `Monitoring Streams in Amazon Kinesis Data Streams `__ in the *Amazon Kinesis Data Streams Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/kinesis/enable-enhanced-monitoring.rst awscli-1.17.14/awscli/examples/kinesis/enable-enhanced-monitoring.rst --- awscli-1.16.301/awscli/examples/kinesis/enable-enhanced-monitoring.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/kinesis/enable-enhanced-monitoring.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,25 @@ +**To enable enhanced monitoring for shard-level metrics** + +The following ``enable-enhanced-monitoring`` example enables enhanced Kinesis data stream monitoring for shard-level metrics. :: + + aws kinesis enable-enhanced-monitoring \ + --stream-name samplestream \ + --shard-level-metrics ALL + +Output:: + + { + "StreamName": "samplestream", + "CurrentShardLevelMetrics": [], + "DesiredShardLevelMetrics": [ + "IncomingBytes", + "OutgoingRecords", + "IteratorAgeMilliseconds", + "IncomingRecords", + "ReadProvisionedThroughputExceeded", + "WriteProvisionedThroughputExceeded", + "OutgoingBytes" + ] + } + +For more information, see `Monitoring Streams in Amazon Kinesis Data Streams `__ in the *Amazon Kinesis Data Streams Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/kinesis/get-records.rst awscli-1.17.14/awscli/examples/kinesis/get-records.rst --- awscli-1.16.301/awscli/examples/kinesis/get-records.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/kinesis/get-records.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,15 @@ +**To obtain records from a shard** + +The following ``get-records`` example gets data records from a Kinesis data stream's shard using the specified shard iterator. :: + + aws kinesis get-records \ + --shard-iterator AAAAAAAAAAF7/0mWD7IuHj1yGv/TKuNgx2ukD5xipCY4cy4gU96orWwZwcSXh3K9tAmGYeOZyLZrvzzeOFVf9iN99hUPw/w/b0YWYeehfNvnf1DYt5XpDJghLKr3DzgznkTmMymDP3R+3wRKeuEw6/kdxY2yKJH0veaiekaVc4N2VwK/GvaGP2Hh9Fg7N++q0Adg6fIDQPt4p8RpavDbk+A4sL9SWGE1 + +Output:: + + { + "Records": [], + "MillisBehindLatest": 80742000 + } + +For more information, see `Developing Consumers Using the Kinesis Data Streams API with the AWS SDK for Java `__ in the *Amazon Kinesis Data Streams Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/kinesis/get-shard-iterator.rst awscli-1.17.14/awscli/examples/kinesis/get-shard-iterator.rst --- awscli-1.16.301/awscli/examples/kinesis/get-shard-iterator.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/kinesis/get-shard-iterator.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,16 @@ +**To obtain a shard iterator** + +The following ``get-shard-iterator`` example uses the ``AT_SEQUENCE_NUMBER`` shard iterator type and generates a shard iterator to start reading data records exactly from the position denoted by the specified sequence number. :: + + aws kinesis get-shard-iterator \ + --stream-name samplestream \ + --shard-id shardId-000000000001 \ + --shard-iterator-type LATEST + +Output:: + + { + "ShardIterator": "AAAAAAAAAAFEvJjIYI+3jw/4aqgH9FifJ+n48XWTh/IFIsbILP6o5eDueD39NXNBfpZ10WL5K6ADXk8w+5H+Qhd9cFA9k268CPXCz/kebq1TGYI7Vy+lUkA9BuN3xvATxMBGxRY3zYK05gqgvaIRn94O8SqeEqwhigwZxNWxID3Ej7YYYcxQi8Q/fIrCjGAy/n2r5Z9G864YpWDfN9upNNQAR/iiOWKs" + } + +For more information, see `Developing Consumers Using the Kinesis Data Streams API with the AWS SDK for Java `__ in the *Amazon Kinesis Data Streams Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/kinesis/increase-stream-retention-period.rst awscli-1.17.14/awscli/examples/kinesis/increase-stream-retention-period.rst --- awscli-1.16.301/awscli/examples/kinesis/increase-stream-retention-period.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/kinesis/increase-stream-retention-period.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,11 @@ +**To increase data stream retention period** + +The following ``increase-stream-retention-period`` example increases the retention period (the length of time data records are accessible after they are added to the stream) of the specified stream to 168 hours. :: + + aws kinesis increase-stream-retention-period \ + --stream-name samplestream \ + --retention-period-hours 168 + +This command produces no output. + +For more information, see `Changing the Data Retention Period `__ in the *Amazon Kinesis Data Streams Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/kinesis/list-shards.rst awscli-1.17.14/awscli/examples/kinesis/list-shards.rst --- awscli-1.16.301/awscli/examples/kinesis/list-shards.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/kinesis/list-shards.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,36 @@ +**To list shards in a data stream** + +The following ``list-shards`` example lists all shards in the specified stream starting with the shard whose ID immediately follows the specified ``exclusive-start-shard-id`` of ``shardId-000000000000``. :: + + aws kinesis list-shards \ + --stream-name samplestream \ + --exclusive-start-shard-id shardId-000000000000 + +Output:: + + { + "Shards": [ + { + "ShardId": "shardId-000000000001", + "HashKeyRange": { + "StartingHashKey": "113427455640312821154458202477256070485", + "EndingHashKey": "226854911280625642308916404954512140969" + }, + "SequenceNumberRange": { + "StartingSequenceNumber": "49600871682979337187563555549332609155523708941634633746" + } + }, + { + "ShardId": "shardId-000000000002", + "HashKeyRange": { + "StartingHashKey": "226854911280625642308916404954512140970", + "EndingHashKey": "340282366920938463463374607431768211455" + }, + "SequenceNumberRange": { + "StartingSequenceNumber": "49600871683001637932762086172474144873796357303140614178" + } + } + ] + } + +For more information, see `Listing Shards `__ in the *Amazon Kinesis Data Streams Developer Guide*. \ No newline at end of file diff -Nru awscli-1.16.301/awscli/examples/kinesis/list-streams.rst awscli-1.17.14/awscli/examples/kinesis/list-streams.rst --- awscli-1.16.301/awscli/examples/kinesis/list-streams.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/kinesis/list-streams.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,16 @@ +**To list data streams** + +The following ``list-streams`` example lists all active data streams in the current account and region. :: + + aws kinesis list-streams + +Output:: + + { + "StreamNames": [ + "samplestream", + "samplestream1" + ] + } + +For more information, see `Listing Streams `__ in the *Amazon Kinesis Data Streams Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/kinesis/list-tags-for-stream.rst awscli-1.17.14/awscli/examples/kinesis/list-tags-for-stream.rst --- awscli-1.16.301/awscli/examples/kinesis/list-tags-for-stream.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/kinesis/list-tags-for-stream.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,20 @@ +**To list tags for a data stream** + +The following ``list-tags-for-stream`` example lists the tags attached to the specified data stream. :: + + aws kinesis list-tags-for-stream \ + --stream-name samplestream + +Output:: + + { + "Tags": [ + { + "Key": "samplekey", + "Value": "example" + } + ], + "HasMoreTags": false + } + +For more information, see `Tagging Your Streams `__ in the *Amazon Kinesis Data Streams Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/kinesis/merge-shards.rst awscli-1.17.14/awscli/examples/kinesis/merge-shards.rst --- awscli-1.16.301/awscli/examples/kinesis/merge-shards.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/kinesis/merge-shards.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,12 @@ +**To merge shards** + +The following ``merge-shards`` example merges two adjacent shards with IDs of shardId-000000000000 and shardId-000000000001 in the specified data stream and combines them into a single shard. :: + + aws kinesis merge-shards \ + --stream-name samplestream \ + --shard-to-merge shardId-000000000000 \ + --adjacent-shard-to-merge shardId-000000000001 + +This command produces no output. + +For more information, see `Merging Two Shards `__ in the *Amazon Kinesis Data Streams Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/kinesis/put-record.rst awscli-1.17.14/awscli/examples/kinesis/put-record.rst --- awscli-1.16.301/awscli/examples/kinesis/put-record.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/kinesis/put-record.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,18 @@ +**To write a record into a data stream** + +The following ``put-record`` example writes a single data record into the specified data stream using the specified partition key. :: + + aws kinesis put-record \ + --stream-name samplestream \ + --data sampledatarecord \ + --partition-key samplepartitionkey + +Output:: + + { + "ShardId": "shardId-000000000009", + "SequenceNumber": "49600902273357540915989931256901506243878407835297513618", + "EncryptionType": "KMS" + } + +For more information, see `Developing Producers Using the Amazon Kinesis Data Streams API with the AWS SDK for Java `__ in the *Amazon Kinesis Data Streams Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/kinesis/put-records.rst awscli-1.17.14/awscli/examples/kinesis/put-records.rst --- awscli-1.16.301/awscli/examples/kinesis/put-records.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/kinesis/put-records.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,26 @@ +**To write multiple records into a data stream** + +The following ``put-records`` example writes a data record using the specified partition key and another data record using a different partition key in a single call. :: + + aws kinesis put-records \ + --stream-name samplestream \ + --records Data=blob1,PartitionKey=partitionkey1 Data=blob2,PartitionKey=partitionkey2 + +Output:: + + { + "FailedRecordCount": 0, + "Records": [ + { + "SequenceNumber": "49600883331171471519674795588238531498465399900093808706", + "ShardId": "shardId-000000000004" + }, + { + "SequenceNumber": "49600902273357540915989931256902715169698037101720764562", + "ShardId": "shardId-000000000009" + } + ], + "EncryptionType": "KMS" + } + +For more information, see `Developing Producers Using the Amazon Kinesis Data Streams API with the AWS SDK for Java `__ in the *Amazon Kinesis Data Streams Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/kinesis/register-stream-consumer.rst awscli-1.17.14/awscli/examples/kinesis/register-stream-consumer.rst --- awscli-1.16.301/awscli/examples/kinesis/register-stream-consumer.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/kinesis/register-stream-consumer.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,20 @@ +**To register a data stream consumer** + +The following ``register-stream-consumer`` example registers a consumer called ``KinesisConsumerApplication`` with the specified data stream. :: + + aws kinesis register-stream-consumer \ + --stream-arn arn:aws:kinesis:us-west-2:012345678912:stream/samplestream \ + --consumer-name KinesisConsumerApplication + +Output:: + + { + "Consumer": { + "ConsumerName": "KinesisConsumerApplication", + "ConsumerARN": "arn:aws:kinesis:us-west-2: 123456789012:stream/samplestream/consumer/KinesisConsumerApplication:1572383852", + "ConsumerStatus": "CREATING", + "ConsumerCreationTimestamp": 1572383852.0 + } + } + +For more information, see `Developing Consumers with Enhanced Fan-Out Using the Kinesis Data Streams API `__ in the *Amazon Kinesis Data Streams Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/kinesis/remove-tags-from-stream.rst awscli-1.17.14/awscli/examples/kinesis/remove-tags-from-stream.rst --- awscli-1.16.301/awscli/examples/kinesis/remove-tags-from-stream.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/kinesis/remove-tags-from-stream.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,11 @@ +**To remove tags from a data stream** + +The following ``remove-tags-from-stream`` example removes the tag with the specified key from the specified data stream. :: + + aws kinesis remove-tags-from-stream \ + --stream-name samplestream \ + --tag-keys samplekey + +This command produces no output. + +For more information, see `Tagging Your Streams `__ in the *Amazon Kinesis Data Streams Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/kinesis/split-shard.rst awscli-1.17.14/awscli/examples/kinesis/split-shard.rst --- awscli-1.16.301/awscli/examples/kinesis/split-shard.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/kinesis/split-shard.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,12 @@ +**To split shards** + +The following ``split-shard`` example splits the specified shard into two new shards using a new starting hash key of 10. :: + + aws kinesis split-shard \ + --stream-name samplestream \ + --shard-to-split shardId-000000000000 \ + --new-starting-hash-key 10 + +This command produces no output. + +For more information, see `Splitting a Shard `__ in the *Amazon Kinesis Data Streams Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/kinesis/start-stream-encryption.rst awscli-1.17.14/awscli/examples/kinesis/start-stream-encryption.rst --- awscli-1.16.301/awscli/examples/kinesis/start-stream-encryption.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/kinesis/start-stream-encryption.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,12 @@ +**To enable data stream encryption** + +The following ``start-stream-encryption`` example enables server-side encryption for the specified stream, using the specified AWS KMS key. :: + + aws kinesis start-stream-encryption \ + --encryption-type KMS \ + --key-id arn:aws:kms:us-west-2:012345678912:key/a3c4a7cd-728b-45dd-b334-4d3eb496e452 \ + --stream-name samplestream + +This command produces no output. + +For more information, see `Data Protection in Amazon Kinesis Data Streams `__ in the *Amazon Kinesis Data Streams Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/kinesis/stop-stream-encryption.rst awscli-1.17.14/awscli/examples/kinesis/stop-stream-encryption.rst --- awscli-1.16.301/awscli/examples/kinesis/stop-stream-encryption.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/kinesis/stop-stream-encryption.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,12 @@ +**To disable data stream encryption** + +The following ``stop-stream-encryption`` example disables server-side encryption for the specified stream, using the specified AWS KMS key. :: + + aws kinesis start-stream-encryption \ + --encryption-type KMS \ + --key-id arn:aws:kms:us-west-2:012345678912:key/a3c4a7cd-728b-45dd-b334-4d3eb496e452 \ + --stream-name samplestream + +This command produces no output. + +For more information, see `Data Protection in Amazon Kinesis Data Streams `__ in the *Amazon Kinesis Data Streams Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/kinesis/update-shard-count.rst awscli-1.17.14/awscli/examples/kinesis/update-shard-count.rst --- awscli-1.16.301/awscli/examples/kinesis/update-shard-count.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/kinesis/update-shard-count.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,18 @@ +**To update the shard count in a data stream** + +The following ``update-shard-count`` example updates the shard count of the specified data stream to 6. This example uses uniform scaling, which creates shards of equal size. :: + + aws kinesis update-shard-count \ + --stream-name samplestream \ + --scaling-type UNIFORM_SCALING \ + --target-shard-count 6 + +Output:: + + { + "StreamName": "samplestream", + "CurrentShardCount": 3, + "TargetShardCount": 6 + } + +For more information, see `Resharding a Stream `__ in the *Amazon Kinesis Data Streams Developer Guide*. diff -Nru awscli-1.16.301/awscli/examples/lambda/delete-function-event-invoke-config.rst awscli-1.17.14/awscli/examples/lambda/delete-function-event-invoke-config.rst --- awscli-1.16.301/awscli/examples/lambda/delete-function-event-invoke-config.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/lambda/delete-function-event-invoke-config.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,5 @@ +**To delete an asynchronous invocation configuration** + +The following ``delete-function-event-invoke-config`` example deletes the asynchronous invocation configuration for the ``GREEN`` alias of the specified function. :: + + aws lambda delete-function-event-invoke-config --function-name my-function:GREEN diff -Nru awscli-1.16.301/awscli/examples/lambda/delete-provisioned-concurrency-config.rst awscli-1.17.14/awscli/examples/lambda/delete-provisioned-concurrency-config.rst --- awscli-1.16.301/awscli/examples/lambda/delete-provisioned-concurrency-config.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/lambda/delete-provisioned-concurrency-config.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,7 @@ +**To delete a provisioned concurrency configuration** + +The following ``delete-provisioned-concurrency-config`` example deletes the provisioned concurrency configuration for the ``GREEN`` alias of the specified function. :: + + aws lambda delete-provisioned-concurrency-config \ + --function-name my-function \ + --qualifier GREEN diff -Nru awscli-1.16.301/awscli/examples/lambda/get-function-concurrency.rst awscli-1.17.14/awscli/examples/lambda/get-function-concurrency.rst --- awscli-1.16.301/awscli/examples/lambda/get-function-concurrency.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/lambda/get-function-concurrency.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,12 @@ +**To view the reserved concurrency setting for a function** + +The following ``get-function-concurrency`` example retrieves the reserved concurrency setting for the specified function. :: + + aws lambda get-function-concurrency \ + --function-name my-function + +Output:: + + { + "ReservedConcurrentExecutions": 250 + } diff -Nru awscli-1.16.301/awscli/examples/lambda/get-function-event-invoke-config.rst awscli-1.17.14/awscli/examples/lambda/get-function-event-invoke-config.rst --- awscli-1.16.301/awscli/examples/lambda/get-function-event-invoke-config.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/lambda/get-function-event-invoke-config.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,21 @@ +**To view an asynchronous invocation configuration** + +The following ``get-function-event-invoke-config`` example retrieves the asynchronous invocation configuration for the ``BLUE`` alias of the specified function. :: + + aws lambda get-function-event-invoke-config \ + --function-name my-function:BLUE + +Output:: + + { + "LastModified": 1577824396.653, + "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:BLUE", + "MaximumRetryAttempts": 0, + "MaximumEventAgeInSeconds": 3600, + "DestinationConfig": { + "OnSuccess": {}, + "OnFailure": { + "Destination": "arn:aws:sqs:us-east-2:123456789012:failed-invocations" + } + } + } \ No newline at end of file diff -Nru awscli-1.16.301/awscli/examples/lambda/get-provisioned-concurrency-config.rst awscli-1.17.14/awscli/examples/lambda/get-provisioned-concurrency-config.rst --- awscli-1.16.301/awscli/examples/lambda/get-provisioned-concurrency-config.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/lambda/get-provisioned-concurrency-config.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,17 @@ +**To view a provisioned concurrency configuration** + +The following ``get-provisioned-concurrency-config`` example displays details for the provisioned concurrency configuration for the ``BLUE`` alias of the specified function. :: + + aws lambda get-provisioned-concurrency-config \ + --function-name my-function \ + --qualifier BLUE + +Output:: + + { + "RequestedProvisionedConcurrentExecutions": 100, + "AvailableProvisionedConcurrentExecutions": 100, + "AllocatedProvisionedConcurrentExecutions": 100, + "Status": "READY", + "LastModified": "2019-12-31T20:28:49+0000" + } diff -Nru awscli-1.16.301/awscli/examples/lambda/invoke.rst awscli-1.17.14/awscli/examples/lambda/invoke.rst --- awscli-1.16.301/awscli/examples/lambda/invoke.rst 2019-12-11 19:07:42.000000000 +0000 +++ awscli-1.17.14/awscli/examples/lambda/invoke.rst 2020-02-10 19:14:32.000000000 +0000 @@ -2,7 +2,7 @@ The following ``invoke`` example invokes the ``my-function`` function synchronously. :: - aws lambda invoke + aws lambda invoke \ --function-name my-function \ --payload '{ "name": "Bob" }' \ response.json @@ -20,7 +20,7 @@ The following ``invoke`` example invokes the ``my-function`` function asynchronously. :: - aws lambda invoke + aws lambda invoke \ --function-name my-function \ --invocation-type Event \ --payload '{ "name": "Bob" }' \ diff -Nru awscli-1.16.301/awscli/examples/lambda/list-function-event-invoke-configs.rst awscli-1.17.14/awscli/examples/lambda/list-function-event-invoke-configs.rst --- awscli-1.16.301/awscli/examples/lambda/list-function-event-invoke-configs.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/lambda/list-function-event-invoke-configs.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,25 @@ +**To view a list of asynchronous invocation configurations** + +The following ``list-function-event-invoke-configs`` example lists the asynchronous invocation configurations for the specified function. :: + + aws lambda list-function-event-invoke-configs \ + --function-name my-function + +Output:: + + { + "FunctionEventInvokeConfigs": [ + { + "LastModified": 1577824406.719, + "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:GREEN", + "MaximumRetryAttempts": 2, + "MaximumEventAgeInSeconds": 1800 + }, + { + "LastModified": 1577824396.653, + "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:BLUE", + "MaximumRetryAttempts": 0, + "MaximumEventAgeInSeconds": 3600 + } + ] + } diff -Nru awscli-1.16.301/awscli/examples/lambda/list-provisioned-concurrency-configs.rst awscli-1.17.14/awscli/examples/lambda/list-provisioned-concurrency-configs.rst --- awscli-1.16.301/awscli/examples/lambda/list-provisioned-concurrency-configs.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/lambda/list-provisioned-concurrency-configs.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,29 @@ +**To get a list of provisioned concurrency configurations** + +The following ``list-provisioned-concurrency-configs`` example lists the provisioned concurrency configurations for the specified function. :: + + aws lambda list-provisioned-concurrency-configs \ + --function-name my-function + +Output:: + + { + "ProvisionedConcurrencyConfigs": [ + { + "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:GREEN", + "RequestedProvisionedConcurrentExecutions": 100, + "AvailableProvisionedConcurrentExecutions": 100, + "AllocatedProvisionedConcurrentExecutions": 100, + "Status": "READY", + "LastModified": "2019-12-31T20:29:00+0000" + }, + { + "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:BLUE", + "RequestedProvisionedConcurrentExecutions": 100, + "AvailableProvisionedConcurrentExecutions": 100, + "AllocatedProvisionedConcurrentExecutions": 100, + "Status": "READY", + "LastModified": "2019-12-31T20:28:49+0000" + } + ] + } diff -Nru awscli-1.16.301/awscli/examples/lambda/put-function-event-invoke-config.rst awscli-1.17.14/awscli/examples/lambda/put-function-event-invoke-config.rst --- awscli-1.16.301/awscli/examples/lambda/put-function-event-invoke-config.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/lambda/put-function-event-invoke-config.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,21 @@ +**To configure error handling for asynchronous invocation** + +The following ``put-function-event-invoke-config`` example sets a maximum event age of one hour and disables retries for the specified function. :: + + aws lambda put-function-event-invoke-config \ + --function-name my-function \ + --maximum-event-age-in-seconds 3600 \ + --maximum-retry-attempts 0 + +Output:: + + { + "LastModified": 1573686021.479, + "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:$LATEST", + "MaximumRetryAttempts": 0, + "MaximumEventAgeInSeconds": 3600, + "DestinationConfig": { + "OnSuccess": {}, + "OnFailure": {} + } + } diff -Nru awscli-1.16.301/awscli/examples/lambda/put-provisioned-concurrency-config.rst awscli-1.17.14/awscli/examples/lambda/put-provisioned-concurrency-config.rst --- awscli-1.16.301/awscli/examples/lambda/put-provisioned-concurrency-config.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/lambda/put-provisioned-concurrency-config.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,17 @@ +**To allocate provisioned concurrency** + +The following ``put-provisioned-concurrency-config`` example allocates 100 provisioned concurrency for the ``BLUE`` alias of the specified function. :: + + aws lambda put-provisioned-concurrency-config \ + --function-name my-function \ + --qualifier BLUE \ + --provisioned-concurrent-executions 100 + +Output:: + + { + "Requested ProvisionedConcurrentExecutions": 100, + "Allocated ProvisionedConcurrentExecutions": 0, + "Status": "IN_PROGRESS", + "LastModified": "2019-11-21T19:32:12+0000" + } diff -Nru awscli-1.16.301/awscli/examples/lambda/update-function-event-invoke-config.rst awscli-1.17.14/awscli/examples/lambda/update-function-event-invoke-config.rst --- awscli-1.16.301/awscli/examples/lambda/update-function-event-invoke-config.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/lambda/update-function-event-invoke-config.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,22 @@ +**To update an asynchronous invocation configuration** + +The following ``update-function-event-invoke-config`` example adds an on-failure destination to the existing asynchronous invocation configuration for the specified function. :: + + aws lambda update-function-event-invoke-config \ + --function-name my-function \ + --destination-config '{"OnFailure":{"Destination": "arn:aws:sqs:us-east-2:123456789012:destination"}}' + +Output:: + + { + "LastModified": 1573687896.493, + "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:$LATEST", + "MaximumRetryAttempts": 0, + "MaximumEventAgeInSeconds": 3600, + "DestinationConfig": { + "OnSuccess": {}, + "OnFailure": { + "Destination": "arn:aws:sqs:us-east-2:123456789012:destination" + } + } + } diff -Nru awscli-1.16.301/awscli/examples/medialive/create-channel.rst awscli-1.17.14/awscli/examples/medialive/create-channel.rst --- awscli-1.16.301/awscli/examples/medialive/create-channel.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/medialive/create-channel.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,165 @@ +**To create a channel** + +The following ``create-channel`` example creates a channel by passing in a JSON file that contains the parameters that you want to specify. + +The channel in this example ingests an HLS PULL input that connects to a source that contains video, audio, and embedded captions. The channel creates one HLS output group with an Akamai server as the destination. The output group contains two outputs: one for the H.265 video and AAC audio, and one for the Web-VTT captions, in English only. + +The JSON for this example channel includes the minimum required parameters for a channel that uses an HLS PULL input and that produces an HLS output group with Akamai as the destination. The JSON contains these main sections: + +* ``InputAttachments``, which specifies one source for the audio, and one source for the captions. It does not specify a video selector, which means that MediaLive extracts the first video it finds in the source. +* ``Destinations``, which contains the two IP addresses (URLs) for the single output group in this channel. These addresses require passwords. +* ``EncoderSettings``, which contains subsections. + + * ``AudioDescriptions``, which specifies that the channel contains one audio output asset, which uses the source from InputAttachments, and produces audio in AAC format. + * ``CaptionDescriptions``, which specifies that the channel contains one captions output asset, which uses the source from InputAttachments, and produces captions in Web-VTT format. + * ``VideoDescriptions``, which specifies that the channel contains one video output asset, with the specified resolution. + * ``OutputGroups``, which specifies the output groups. In this example there is one group named ``Akamai``. The connection is made using HLS PUT. The output group contains two outputs. One output is for the video asset (named ``Video_high``) and the audio asset (named ``Audio_EN``). One output is for the captions asset (named ``WebVTT_EN``). + +In this example, some of the parameters contain no value or contain nested empty parameters. For example, OutputSettings for the ``Video_and_audio`` output contains several nested parameters that end at an empty parameter M3u8Settings. This parameter must be included, but you can omit one, several, or all its children, which means that the child will take its default value or be null. + +All the parameters that apply to this example channel but that aren't specified in this file will either take the default value, be set to null, or take a unique value generated by MediaLive. :: + + aws medialive create-channel \ + --cli-input-jason file://channel-in-hls-out-hls-akamai.json + + +Contents of ``channel-in-hls-out-hls-akamai.json``:: + + { + "Name": "News_West", + "RoleArn": "arn:aws:iam::111122223333:role/MediaLiveAccessRole", + "InputAttachments": [ + { + "InputAttachmentName": "local_news", + "InputId": "1234567", + "InputSettings": { + "AudioSelectors": [ + { + "Name": "English-Audio", + "SelectorSettings": { + "AudioLanguageSelection": { + "LanguageCode": "EN" + } + } + } + ], + "CaptionSelectors": [ + { + "LanguageCode": "ENE", + "Name": "English_embedded" + } + ] + } + } + ], + "Destinations": [ + { + "Id": "akamai-server-west", + "Settings": [ + { + "PasswordParam": "/medialive/examplecorp1", + "Url": "http://203.0.113.55/news/news_west", + "Username": "examplecorp" + }, + { + "PasswordParam": "/medialive/examplecorp2", + "Url": "http://203.0.113.82/news/news_west", + "Username": "examplecorp" + } + ] + } + ], + "EncoderSettings": { + "AudioDescriptions": [ + { + "AudioSelectorName": "English-Audio", + "CodecSettings": { + "AacSettings": {} + }, + "Name": "Audio_EN" + } + ], + "CaptionDescriptions": [ + { + "CaptionSelectorName": "English_embedded", + "DestinationSettings": { + "WebvttDestinationSettings": {} + }, + "Name": "WebVTT_EN" + } + ], + "VideoDescriptions": [ + { + "Height": 720, + "Name": "Video_high", + "Width": 1280 + } + ], + "OutputGroups": [ + { + "Name": "Akamai", + "OutputGroupSettings": { + "HlsGroupSettings": { + "Destination": { + "DestinationRefId": "akamai-server-west" + }, + "HlsCdnSettings": { + "HlsBasicPutSettings": {} + } + } + }, + "Outputs": [ + { + "AudioDescriptionNames": [ + "Audio_EN" + ], + "OutputName": "Video_and_audio", + "OutputSettings": { + "HlsOutputSettings": { + "HlsSettings": { + "StandardHlsSettings": { + "M3u8Settings": {} + } + }, + "NameModifier": "_1" + } + }, + "VideoDescriptionName": "Video_high" + }, + { + "CaptionDescriptionNames": [ + "WebVTT_EN" + ], + "OutputName": "Captions-WebVTT", + "OutputSettings": { + "HlsOutputSettings": { + "HlsSettings": { + "StandardHlsSettings": { + "M3u8Settings": {} + } + }, + "NameModifier": "_2" + } + } + } + ] + } + ], + "TimecodeConfig": { + "Source": "EMBEDDED" + } + } + } + +**Output:** + +The output repeats back the contents of the JSON file, plus the following values. All parameters are ordered alphabetically. + +* ``ARN`` for the channel. The last part of the ARN is the unique channel ID. +* ``EgressEndpoints`` is blank in this example channel because it used only for PUSH inputs. When it applies it shows the addresses on MediaLive that content is pushed to. +* ``OutputGroups``, ``Outputs``. These show all the parameters for the output group and outputs, including those that you didn't include but that are relevant to this channel. The parameters might be empty (perhaps indicating the parameter or feature is disabled in this channel configuration) or might show the default value that will apply. +* ``LogLevel`` is set to the default (DISABLED). +* ``Tags`` is set to the default (null). +* ``PipelinesRunningCount`` and ``State`` show the current status of the channel. + +For more information, see `Creating a Channel from Scratch`__ in the *AWS Elemental MediaLive User Guide*. \ No newline at end of file diff -Nru awscli-1.16.301/awscli/examples/medialive/create-input.rst awscli-1.17.14/awscli/examples/medialive/create-input.rst --- awscli-1.16.301/awscli/examples/medialive/create-input.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/medialive/create-input.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,41 @@ +**To create an input** + +The following ``create-input`` example creates an ``HLS PULL`` input by passing in a JSON file that contains the parameters that apply to this type of input. The JSON for this example input specifies two sources (addresses) to the input, in order to support redundancy in the ingest. These addresses require passwords. :: + + aws medialive create-channel \ + --cli-input-jason file://input-hls-pull-news.json + +Contents of ``input-hls-pull-news.json``:: + + { + "Name": "local_news", + "RequestId": "cli000059", + "Sources": [ + { + "Url": "https://203.0.113.13/newschannel/anytownusa.m3u8", + "Username": "examplecorp", + "PasswordParam": "/medialive/examplecorp1" + }, + { + "Url": "https://198.51.100.54/fillervideos/oceanwaves.mp4", + "Username": "examplecorp", + "PasswordParam": "examplecorp2" + } + ], + "Type": "URL_PULL" + } + +**Output:** + +The output repeats back the contents of the JSON file, plus the following values. All parameters are ordered alphabetically. + +* ``Arn`` for the input. The last part of the ARN is the unique input ID. +* ``Attached Channels``, which is always empty for a newly created input. +* ``Destinations``, which is empty in this example because it is used only with a PUSH input. +* ``Id`` for the input, the same as the ID in the ARN. +* ``MediaConnectFlows``, which is empty in this example because it is used only with an input of type MediaConnect. +* ``SecurityGroups``, which is empty in this example because it is used only with a PUSH input. +* ``State`` of this input. +* ``Tags``, which is empty (the default for this parameter). + +For more information, see `Creating an Input `__ in the *AWS Elemental MediaLive User Guide*. diff -Nru awscli-1.16.301/awscli/examples/mediapackage-vod/create-asset.rst awscli-1.17.14/awscli/examples/mediapackage-vod/create-asset.rst --- awscli-1.16.301/awscli/examples/mediapackage-vod/create-asset.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/mediapackage-vod/create-asset.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,31 @@ +**To create an asset** + +The following ``create-asset`` example creates an asset named ``Chicken_Asset`` in the current AWS account. The asset ingests the file ``30sec_chicken.smil`` to MediaPackage. :: + + aws mediapackage-vod create-asset \ + --id chicken_asset \ + --packaging-group-id hls_chicken_gp \ + --source-role-arn arn:aws:iam::111122223333:role/EMP_Vod \ + --source-arn arn:aws:s3::111122223333:video-bucket/A/30sec_chicken.smil + +Output:: + + { + "Arn":"arn:aws:mediapackage-vod:us-west-2:111122223333:assets/chicken_asset", + "Id":"chicken_asset", + "PackagingGroupId":"hls_chicken_gp", + "SourceArn":"arn:aws:s3::111122223333:video-bucket/A/30sec_chicken.smil", + "SourceRoleArn":"arn:aws:iam::111122223333:role/EMP_Vod", + "EgressEndpoints":[ + { + "PackagingConfigurationId":"New_config_1", + "Url":"https://c75ea2668ab49d02bca7ae10ef31c59e.egress.mediapackage-vod.us-west-2.amazonaws.com/out/v1/6644b55df1744261ab3732a8e5cdaf07/904b06a58c7645e08d57d40d064216ac/f5b2e633ff4942228095d164c10074f3/index.m3u8" + }, + { + "PackagingConfigurationId":"new_hls", + "Url":" https://c75ea2668ab49d02bca7ae10ef31c59e.egress.mediapackage-vod.us-west-2.amazonaws.com/out/v1/6644b55df1744261ab3732a8e5cdaf07/fe8f1f00a80e424cb4f8da4095835e9e/7370ec57432343af816332356d2bd5c6/string.m3u8" + } + ] + } + +For more information, see `Ingest an Asset `__ in the *AWS Elemental MediaPackage User Guide*. diff -Nru awscli-1.16.301/awscli/examples/mediapackage-vod/create-packaging-configuration.rst awscli-1.17.14/awscli/examples/mediapackage-vod/create-packaging-configuration.rst --- awscli-1.16.301/awscli/examples/mediapackage-vod/create-packaging-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/mediapackage-vod/create-packaging-configuration.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,57 @@ +**To create a packaging configuration** + +The following ``create-packaging-configuration`` example creates a packaging configuration named ``new_hls`` in the packaging group named ``hls_chicken``. This example uses a file on disk named ``hls_pc.json`` to provide the details. :: + + aws mediapackage-vod create-packaging-configuration \ + --id new_hls \ + --packaging-group-id hls_chicken \ + --hls-package file://hls_pc.json + +Contents of ``hls_pc.json``:: + + { + "HlsManifests":[ + { + "AdMarkers":"NONE", + "IncludeIframeOnlyStream":false, + "ManifestName":"string", + "ProgramDateTimeIntervalSeconds":60, + "RepeatExtXKey":true, + "StreamSelection":{ + "MaxVideoBitsPerSecond":1000, + "MinVideoBitsPerSecond":0, + "StreamOrder":"ORIGINAL" + } + } + ], + "SegmentDurationSeconds":6, + "UseAudioRenditionGroup":false + } + +Output:: + + { + "Arn":"arn:aws:mediapackage-vod:us-west-2:111122223333:packaging-configurations/new_hls", + "Id":"new_hls", + "PackagingGroupId":"hls_chicken", + "HlsManifests":{ + "SegmentDurationSeconds":6, + "UseAudioRenditionGroup":false, + "HlsMarkers":[ + { + "AdMarkers":"NONE", + "IncludeIframeOnlyStream":false, + "ManifestName":"string", + "ProgramDateTimeIntervalSeconds":60, + "RepeatExtXKey":true, + "StreamSelection":{ + "MaxVideoBitsPerSecond":1000, + "MinVideoBitsPerSecond":0, + "StreamOrder":"ORIGINAL" + } + } + ] + } + } + +For more information, see `Creating a Packaging Configuration `__ in the *AWS Elemental MediaPackage User Guide*. diff -Nru awscli-1.16.301/awscli/examples/mediapackage-vod/create-packaging-group.rst awscli-1.17.14/awscli/examples/mediapackage-vod/create-packaging-group.rst --- awscli-1.16.301/awscli/examples/mediapackage-vod/create-packaging-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/mediapackage-vod/create-packaging-group.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,15 @@ +**To create a packaging group** + +The following ``create-packaging-group`` example lists all of the packaging groups that are configured in the current AWS account. :: + + aws mediapackage-vod create-packaging-group \ + --id hls_chicken + +Output:: + + { + "Arn": "arn:aws:mediapackage-vod:us-west-2:111122223333:packaging-groups/hls_chicken", + "Id": "hls_chicken" + } + +For more information, see `Creating a Packaging Group `__ in the *AWS Elemental MediaPackage User Guide*. diff -Nru awscli-1.16.301/awscli/examples/mediapackage-vod/delete-asset.rst awscli-1.17.14/awscli/examples/mediapackage-vod/delete-asset.rst --- awscli-1.16.301/awscli/examples/mediapackage-vod/delete-asset.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/mediapackage-vod/delete-asset.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete an asset** + +The following ``delete-asset`` example deletes the asset named ``30sec_chicken``. :: + + aws mediapackage-vod delete-asset \ + --id 30sec_chicken + +This command produces no output. + +For more information, see `Deleting an Asset `__ in the *AWS Elemental MediaPackage User Guide*. diff -Nru awscli-1.16.301/awscli/examples/mediapackage-vod/delete-packaging-configuration.rst awscli-1.17.14/awscli/examples/mediapackage-vod/delete-packaging-configuration.rst --- awscli-1.16.301/awscli/examples/mediapackage-vod/delete-packaging-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/mediapackage-vod/delete-packaging-configuration.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a packaging configuration** + +The following ``delete-packaging-configuration`` example deletes the packaging configuration named ``CMAF``. :: + + aws mediapackage-vod delete-packaging-configuration \ + --id CMAF + +This command produces no output. + +For more information, see `Deleting a Packaging Configuration `__ in the *AWS Elemental MediaPackage User Guide*. diff -Nru awscli-1.16.301/awscli/examples/mediapackage-vod/delete-packaging-group.rst awscli-1.17.14/awscli/examples/mediapackage-vod/delete-packaging-group.rst --- awscli-1.16.301/awscli/examples/mediapackage-vod/delete-packaging-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/mediapackage-vod/delete-packaging-group.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a packaging group** + +The following ``delete-packaging-group`` example deletes the packaging group named ``Dash_widevine``. :: + + aws mediapackage-vod delete-packaging-group \ + --id Dash_widevine + +This command produces no output. + +For more information, see `Deleting a Packaging Group `__ in the *AWS Elemental MediaPackage User Guide*. diff -Nru awscli-1.16.301/awscli/examples/mediapackage-vod/describe-asset.rst awscli-1.17.14/awscli/examples/mediapackage-vod/describe-asset.rst --- awscli-1.16.301/awscli/examples/mediapackage-vod/describe-asset.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/mediapackage-vod/describe-asset.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,32 @@ +**To describe an asset** + +The following ``describe-asset`` example displays all of the details of the asset named ``30sec_chicken``. :: + + aws mediapackage-vod describe-asset \ + --id 30sec_chicken + +Output:: + + { + "Arn":"arn:aws:mediapackage-vod:us-west-2:111122223333:assets/30sec_chicken", + "Id":"30sec_chicken", + "PackagingGroupId":"Packaging_group_1", + "SourceArn":"arn:aws:s3::111122223333:video-bucket/A/30sec_chicken.smil", + "SourceRoleArn":"arn:aws:iam::111122223333:role/EMP_Vod", + "EgressEndpoints":[ + { + "PackagingConfigurationId":"DASH", + "Url":"https://a5f46a44118ba3e3724ef39ef532e701.egress.mediapackage-vod.us-west-2.amazonaws.com/out/v1/aad7962c569946119c2d5a691be5663c/66c25aff456d463aae0855172b3beb27/4ddfda6da17c4c279a1b8401cba31892/index.mpd" + }, + { + "PackagingConfigurationId":"HLS", + "Url":"https://a5f46a44118ba3e3724ef39ef532e701.egress.mediapackage-vod.us-west-2.amazonaws.com/out/v1/aad7962c569946119c2d5a691be5663c/6e5bf286a3414254a2bf0d22ae148d7e/06b5875b4d004c3cbdc4da2dc4d14638/index.m3u8" + }, + { + "PackagingConfigurationId":"CMAF", + "Url":"https://a5f46a44118ba3e3724ef39ef532e701.egress.mediapackage-vod.us-west-2.amazonaws.com/out/v1/aad7962c569946119c2d5a691be5663c/628fb5d8d89e4702958b020af27fde0e/05eb062214064238ad6330a443aff7f7/index.m3u8" + } + ] + } + +For more information, see `Viewing Asset Details `__ in the *AWS Elemental MediaPackage User Guide*. diff -Nru awscli-1.16.301/awscli/examples/mediapackage-vod/describe-packaging-configuration.rst awscli-1.17.14/awscli/examples/mediapackage-vod/describe-packaging-configuration.rst --- awscli-1.16.301/awscli/examples/mediapackage-vod/describe-packaging-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/mediapackage-vod/describe-packaging-configuration.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,28 @@ +**To describe a packaging configuration** + +The following ``describe-packaging-configuration`` example displays all of the details of the packaging configuration named ``DASH``. :: + + aws mediapackage-vod describe-packaging-configuration \ + --id DASH + +Output:: + + { + "Arn":"arn:aws:mediapackage-vod:us-west-2:111122223333:packaging-configurations/DASH", + "Id":"DASH", + "PackagingGroupId":"Packaging_group_1", + "DashPackage":[ + { + "SegmentDurationSeconds":"2" + }, + { + "DashManifests":{ + "ManifestName":"index", + "MinBufferTimeSeconds":"30", + "Profile":"NONE" + } + } + ] + } + +For more information, see `Viewing Packaging Configuration Details `__ in the *AWS Elemental MediaPackage User Guide*. diff -Nru awscli-1.16.301/awscli/examples/mediapackage-vod/describe-packaging-group.rst awscli-1.17.14/awscli/examples/mediapackage-vod/describe-packaging-group.rst --- awscli-1.16.301/awscli/examples/mediapackage-vod/describe-packaging-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/mediapackage-vod/describe-packaging-group.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,15 @@ +**To describe a packaging group** + +The following ``describe-packaging-group`` example displays all of the details of the packaging group named ``Packaging_group_1``. :: + + aws mediapackage-vod describe-packaging-group \ + --id Packaging_group_1 + +Output:: + + { + "Arn": "arn:aws:mediapackage-vod:us-west-2:111122223333:packaging-groups/Packaging_group_1", + "Id": "Packaging_group_1" + } + +For more information, see `Viewing Packaging Group Details `__ in the *AWS Elemental MediaPackage User Guide*. diff -Nru awscli-1.16.301/awscli/examples/mediapackage-vod/list-assets.rst awscli-1.17.14/awscli/examples/mediapackage-vod/list-assets.rst --- awscli-1.16.301/awscli/examples/mediapackage-vod/list-assets.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/mediapackage-vod/list-assets.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,19 @@ +**To list all assets** + +The following ``list-assets`` example ists all of the assets that are configured in the current AWS account. :: + + aws mediapackage-vod list-assets + +Output:: + + { + "Assets": [ + "Arn": "arn:aws:mediapackage-vod:us-west-2:111122223333:assets/30sec_chicken", + "Id": "30sec_chicken", + "PackagingGroupId": "Packaging_group_1", + "SourceArn": "arn:aws:s3::111122223333:video-bucket/A/30sec_chicken.smil", + "SourceRoleArn": "arn:aws:iam::111122223333:role/EMP_Vod" + ] + } + +For more information, see `Viewing Asset Details `__ in the *AWS Elemental MediaPackage User Guide*. diff -Nru awscli-1.16.301/awscli/examples/mediapackage-vod/list-packaging-configurations.rst awscli-1.17.14/awscli/examples/mediapackage-vod/list-packaging-configurations.rst --- awscli-1.16.301/awscli/examples/mediapackage-vod/list-packaging-configurations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/mediapackage-vod/list-packaging-configurations.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,103 @@ +**To list all packaging configurations** + +The following ``list-packaging-configurations`` example lists all of the packaging configurations that are configured on the packaging group named ``Packaging_group_1``. :: + + aws mediapackage-vod list-packaging-configurations \ + --packaging-group-id Packaging_group_1 + +Output:: + + { + "PackagingConfigurations":[ + { + "Arn":"arn:aws:mediapackage-vod:us-west-2:111122223333:packaging-configurations/CMAF", + "Id":"CMAF", + "PackagingGroupId":"Packaging_group_1", + "CmafPackage":[ + { + "SegmentDurationSeconds":"2" + }, + { + "HlsManifests":{ + "AdMarkers":"NONE", + "RepeatExtXKey":"False", + "ManifestName":"index", + "ProgramDateTimeIntervalSeconds":"0", + "IncludeIframeOnlyStream":"False" + } + } + ] + }, + { + "Arn":"arn:aws:mediapackage-vod:us-west-2:111122223333:packaging-configurations/DASH", + "Id":"DASH", + "PackagingGroupId":"Packaging_group_1", + "DashPackage":[ + { + "SegmentDurationSeconds":"2" + }, + { + "DashManifests":{ + "ManifestName":"index", + "MinBufferTimeSeconds":"30", + "Profile":"NONE" + } + } + ] + }, + { + "Arn":"arn:aws:mediapackage-vod:us-west-2:111122223333:packaging-configurations/HLS", + "Id":"HLS", + "PackagingGroupId":"Packaging_group_1", + "HlsPackage":[ + { + "SegmentDurationSeconds":"6", + "UseAudioRenditionGroup":"False" + }, + { + "HlsManifests":{ + "AdMarkers":"NONE", + "RepeatExtXKey":"False", + "ManifestName":"index", + "ProgramDateTimeIntervalSeconds":"0", + "IncludeIframeOnlyStream":"False" + } + } + ] + }, + { + "Arn":"arn:aws:mediapackage-vod:us-west-2:111122223333:packaging-configurations/New_config_0_copy", + "Id":"New_config_0_copy", + "PackagingGroupId":"Packaging_group_1", + "HlsPackage":[ + { + "SegmentDurationSeconds":"6", + "UseAudioRenditionGroup":"False" + }, + { + "Encryption":{ + "EncryptionMethod":"AWS_128", + "SpekeKeyProvider":{ + "RoleArn":"arn:aws:iam:111122223333::role/SPEKERole", + "Url":"https://lfgubdvs97.execute-api.us-west-2.amazonaws.com/EkeStage/copyProtection/", + "SystemIds":[ + "81376844-f976-481e-a84e-cc25d39b0b33" + ] + } + } + }, + { + "HlsManifests":{ + "AdMarkers":"NONE", + "RepeatExtXKey":"False", + "ManifestName":"index", + "ProgramDateTimeIntervalSeconds":"0", + "IncludeIframeOnlyStream":"False" + } + } + ] + } + ] + } + +For more information, see `Viewing Packaging Configuration Details `__ in the *AWS Elemental MediaPackage User Guide*. diff -Nru awscli-1.16.301/awscli/examples/mediapackage-vod/list-packaging-groups.rst awscli-1.17.14/awscli/examples/mediapackage-vod/list-packaging-groups.rst --- awscli-1.16.301/awscli/examples/mediapackage-vod/list-packaging-groups.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/mediapackage-vod/list-packaging-groups.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,26 @@ +**To list all packaging groups** + +The following ``list-packaging-groups`` example lists all of the packaging groups that are configured in the current AWS account. :: + + aws mediapackage-vod list-packaging-groups + +Output:: + + { + "PackagingGroups": [ + { + "Arn": "arn:aws:mediapackage-vod:us-west-2:111122223333:packaging-groups/Dash_widevine", + "Id": "Dash_widevine" + }, + { + "Arn": "arn:aws:mediapackage-vod:us-west-2:111122223333:packaging-groups/Encrypted_HLS", + "Id": "Encrypted_HLS" + }, + { + "Arn": "arn:aws:mediapackage-vod:us-west-2:111122223333:packaging-groups/Packaging_group_1", + "Id": "Packaging_group_1" + } + ] + } + +For more information, see `Viewing Packaging Group Details `__ in the *AWS Elemental MediaPackage User Guide*. diff -Nru awscli-1.16.301/awscli/examples/mediatailor/delete-playback-configuration.rst awscli-1.17.14/awscli/examples/mediatailor/delete-playback-configuration.rst --- awscli-1.16.301/awscli/examples/mediatailor/delete-playback-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/mediatailor/delete-playback-configuration.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a configuration** + +The following ``delete-playback-configuration`` deletes a configuration named ``campaign_short``. :: + + aws mediatailor delete-playback-configuration \ + --name campaign_short + +This command produces no output. + +For more information, see `Deleting a Configuration `__ in the *AWS Elemental MediaTailor User Guide*. diff -Nru awscli-1.16.301/awscli/examples/mediatailor/get-playback-configuration.rst awscli-1.17.14/awscli/examples/mediatailor/get-playback-configuration.rst --- awscli-1.16.301/awscli/examples/mediatailor/get-playback-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/mediatailor/get-playback-configuration.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,29 @@ +**To describe a configuration** + +The following ``get-playback-configuration`` displays all of the details of the configuration named ``west_campaign``. :: + + aws mediatailor get-playback-configuration \ + --name west_campaign + +Output:: + + { + "AdDecisionServerUrl": "http://your.ads.url", + "CdnConfiguration": {}, + "DashConfiguration": { + "ManifestEndpointPrefix": "https://170c14299689462897d0cc45fc2000bb.mediatailor.us-west-2.amazonaws.com/v1/dash/1cbfeaaecb69778e0c167d0505a2bc57da2b1754/west_campaign/", + "MpdLocation": "EMT_DEFAULT", + "OriginManifestType": "MULTI_PERIOD" + }, + "HlsConfiguration": { + "ManifestEndpointPrefix": "https://170c14299689462897d0cc45fc2000bb.mediatailor.us-west-2.amazonaws.com/v1/master/1cbfeaaecb69778e0c167d0505a2bc57da2b1754/west_campaign/" + }, + "Name": "west_campaign", + "PlaybackConfigurationArn": "arn:aws:mediatailor:us-west-2:123456789012:playbackConfiguration/west_campaign", + "PlaybackEndpointPrefix": "https://170c14299689462897d0cc45fc2000bb.mediatailor.us-west-2.amazonaws.com", + "SessionInitializationEndpointPrefix": "https://170c14299689462897d0cc45fc2000bb.mediatailor.us-west-2.amazonaws.com/v1/session/1cbfeaaecb69778e0c167d0505a2bc57da2b1754/west_campaign/", + "Tags": {}, + "VideoContentSourceUrl": "https://8343f7014c0ea438.mediapackage.us-west-2.amazonaws.com/out/v1/683f0f2ff7cd43a48902e6dcd5e16dcf/index.m3u8" + } + +For more information, see `Viewing a Configuration `__ in the *AWS Elemental MediaTailor User Guide*. diff -Nru awscli-1.16.301/awscli/examples/mediatailor/list-playback-configurations.rst awscli-1.17.14/awscli/examples/mediatailor/list-playback-configurations.rst --- awscli-1.16.301/awscli/examples/mediatailor/list-playback-configurations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/mediatailor/list-playback-configurations.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,51 @@ +**To list all configurations** + +The following ``list-playback-configurations`` displays all of the details of the configuration on the current AWS account. :: + + aws mediatailor list-playback-configurations + +Output:: + + { + "Items": [ + { + "AdDecisionServerUrl": "http://your.ads.url", + "CdnConfiguration": {}, + "DashConfiguration": { + "ManifestEndpointPrefix": "https://170c14299689462897d0cc45fc2000bb.mediatailor.us-west-2.amazonaws.com/v1/dash/1cbfeaaecb69778e0c167d0505a2bc57da2b1754/west_campaign/", + "MpdLocation": "EMT_DEFAULT", + "OriginManifestType": "MULTI_PERIOD" + }, + "HlsConfiguration": { + "ManifestEndpointPrefix": "https://170c14299689462897d0cc45fc2000bb.mediatailor.us-west-2.amazonaws.com/v1/master/1cbfeaaecb69778e0c167d0505a2bc57da2b1754/west_campaign/" + }, + "Name": "west_campaign", + "PlaybackConfigurationArn": "arn:aws:mediatailor:us-west-2:123456789012:playbackConfiguration/west_campaign", + "PlaybackEndpointPrefix": "https://170c14299689462897d0cc45fc2000bb.mediatailor.us-west-2.amazonaws.com", + "SessionInitializationEndpointPrefix": "https://170c14299689462897d0cc45fc2000bb.mediatailor.us-west-2.amazonaws.com/v1/session/1cbfeaaecb69778e0c167d0505a2bc57da2b1754/west_campaign/", + "Tags": {}, + "VideoContentSourceUrl": "https://8343f7014c0ea438.mediapackage.us-west-2.amazonaws.com/out/v1/683f0f2ff7cd43a48902e6dcd5e16dcf/index.m3u8" + }, + { + "AdDecisionServerUrl": "http://your.ads.url", + "CdnConfiguration": {}, + "DashConfiguration": { + "ManifestEndpointPrefix": "https://73511f91d6a24ca2b93f3cf1d7cedd67.mediatailor.us-west-2.amazonaws.com/v1/dash/1cbfeaaecb69778e0c167d0505a2bc57da2b1754/sports_campaign/", + "MpdLocation": "DISABLED", + "OriginManifestType": "MULTI_PERIOD" + }, + "HlsConfiguration": { + "ManifestEndpointPrefix": "https://73511f91d6a24ca2b93f3cf1d7cedd67.mediatailor.us-west-2.amazonaws.com/v1/master/1cbfeaaecb69778e0c167d0505a2bc57da2b1754/sports_campaign/" + }, + "Name": "sports_campaign", + "PlaybackConfigurationArn": "arn:aws:mediatailor:us-west-2:123456789012:playbackConfiguration/sports_campaign", + "PlaybackEndpointPrefix": "https://73511f91d6a24ca2b93f3cf1d7cedd67.mediatailor.us-west-2.amazonaws.com", + "SessionInitializationEndpointPrefix": "https://73511f91d6a24ca2b93f3cf1d7cedd67.mediatailor.us-west-2.amazonaws.com/v1/session/1cbfeaaecb69778e0c167d0505a2bc57da2b1754/sports_campaign/", + "SlateAdUrl": "http://s3.bucket/slate_ad.mp4", + "Tags": {}, + "VideoContentSourceUrl": "https://c4af3793bf76b33c.mediapackage.us-west-2.amazonaws.com/out/v1/1dc6718be36f4f34bb9cd86bc50925e6/sports_endpoint/index.m3u8" + } + ] + } + +For more information, see `Viewing a Configuration`__ in the *AWS Elemental MediaTailor User Guide*. diff -Nru awscli-1.16.301/awscli/examples/mediatailor/put-playback-configuration.rst awscli-1.17.14/awscli/examples/mediatailor/put-playback-configuration.rst --- awscli-1.16.301/awscli/examples/mediatailor/put-playback-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/mediatailor/put-playback-configuration.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,31 @@ +**To create a configuration** + +The following ``put-playback-configuration`` creates a configuration named ``campaign_short``. :: + + aws mediatailor put-playback-configuration \ + --name campaign_short \ + --ad-decision-server-url http://your.ads.url \ + --video-content-source-url http://video.bucket/index.m3u8 + +Output:: + + { + "AdDecisionServerUrl": "http://your.ads.url", + "CdnConfiguration": {}, + "DashConfiguration": { + "ManifestEndpointPrefix": "https://13484114d38f4383bc0d6a7cb879bd00.mediatailor.us-west-2.amazonaws.com/v1/dash/1cbfeaaecb69778e0c167d0505a2bc57da2b1754/campaign_short/", + "MpdLocation": "EMT_DEFAULT", + "OriginManifestType": "MULTI_PERIOD" + }, + "HlsConfiguration": { + "ManifestEndpointPrefix": "https://13484114d38f4383bc0d6a7cb879bd00.mediatailor.us-west-2.amazonaws.com/v1/master/1cbfeaaecb69778e0c167d0505a2bc57da2b1754/campaign_short/" + }, + "Name": "campaign_short", + "PlaybackConfigurationArn": "arn:aws:mediatailor:us-west-2:123456789012:playbackConfiguration/campaign_short", + "PlaybackEndpointPrefix": "https://13484114d38f4383bc0d6a7cb879bd00.mediatailor.us-west-2.amazonaws.com", + "SessionInitializationEndpointPrefix": "https://13484114d38f4383bc0d6a7cb879bd00.mediatailor.us-west-2.amazonaws.com/v1/session/1cbfeaaecb69778e0c167d0505a2bc57da2b1754/campaign_short/", + "Tags": {}, + "VideoContentSourceUrl": "http://video.bucket/index.m3u8" + } + +For more information, see `Creating a Configuration `__ in the *AWS Elemental MediaTailor User Guide*. diff -Nru awscli-1.16.301/awscli/examples/networkmanager/associate-customer-gateway.rst awscli-1.17.14/awscli/examples/networkmanager/associate-customer-gateway.rst --- awscli-1.16.301/awscli/examples/networkmanager/associate-customer-gateway.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/associate-customer-gateway.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,22 @@ +**To associate a customer gateway** + +The following ``associate-customer-gateway`` example associates customer gateway ``cgw-11223344556677889`` in the specified global network with device ``device-07f6fd08867abc123``. :: + + aws networkmanager associate-customer-gateway \ + --customer-gateway-arn arn:aws:ec2:us-west-2:123456789012:customer-gateway/cgw-11223344556677889 \ + --global-network-id global-network-01231231231231231 \ + --device-id device-07f6fd08867abc123 \ + --region us-west-2 + +Output:: + + { + "CustomerGatewayAssociation": { + "CustomerGatewayArn": "arn:aws:ec2:us-west-2:123456789012:customer-gateway/cgw-11223344556677889", + "GlobalNetworkId": "global-network-01231231231231231", + "DeviceId": "device-07f6fd08867abc123", + "State": "PENDING" + } + } + +For more information, see `Customer Gateway Associations `__ in the *Transit Gateway Network Manager Guide*. diff -Nru awscli-1.16.301/awscli/examples/networkmanager/associate-link.rst awscli-1.17.14/awscli/examples/networkmanager/associate-link.rst --- awscli-1.16.301/awscli/examples/networkmanager/associate-link.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/associate-link.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,22 @@ +**To associate a link** + +The following ``associate-link`` example associates link ``link-11112222aaaabbbb1`` with device ``device-07f6fd08867abc123``. The link and device are in the specified global network. :: + + aws networkmanager associate-link \ + --global-network-id global-network-01231231231231231 \ + --device-id device-07f6fd08867abc123 \ + --link-id link-11112222aaaabbbb1 \ + --region us-west-2 + +Output:: + + { + "LinkAssociation": { + "GlobalNetworkId": "global-network-01231231231231231", + "DeviceId": "device-07f6fd08867abc123", + "LinkId": "link-11112222aaaabbbb1", + "LinkAssociationState": "PENDING" + } + } + +For more information, see `Device and Link Associations `__ in the *Transit Gateway Network Manager Guide*. diff -Nru awscli-1.16.301/awscli/examples/networkmanager/create-device.rst awscli-1.17.14/awscli/examples/networkmanager/create-device.rst --- awscli-1.16.301/awscli/examples/networkmanager/create-device.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/create-device.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,31 @@ +**To create a device** + +The following ``create-device`` example creates a device in the specified global network. The device details include a description, the type, vendor, model, and serial number. :: + + aws networkmanager create-device + --global-network-id global-network-01231231231231231 \ + --description "New York office device" \ + --type "office device" \ + --vendor "anycompany" \ + --model "abcabc" \ + --serial-number "1234" \ + --region us-west-2 + +Output:: + + { + "Device": { + "DeviceId": "device-07f6fd08867abc123", + "DeviceArn": "arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123", + "GlobalNetworkId": "global-network-01231231231231231", + "Description": "New York office device", + "Type": "office device", + "Vendor": "anycompany", + "Model": "abcabc", + "SerialNumber": "1234", + "CreatedAt": 1575554005.0, + "State": "PENDING" + } + } + +For more information, see `Working with Devices `__ in the *Transit Gateway Network Manager Guide*. diff -Nru awscli-1.16.301/awscli/examples/networkmanager/create-global-network.rst awscli-1.17.14/awscli/examples/networkmanager/create-global-network.rst --- awscli-1.16.301/awscli/examples/networkmanager/create-global-network.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/create-global-network.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,21 @@ +**To create a global network** + +The following ``create-global-network`` example creates a new global network in your account with the description 'My global network'. :: + + aws networkmanager create-global-network \ + --description "Head offices global network" \ + --region us-west-2 + +Output:: + + { + "GlobalNetwork": { + "GlobalNetworkId": "global-network-01231231231231231", + "GlobalNetworkArn": "arn:aws:networkmanager::123456789012:global-network/global-network-01231231231231231", + "Description": "Head offices global network", + "CreatedAt": 1575553525.0, + "State": "PENDING" + } + } + +For more information, see `Global Networks `__ in the *Transit Gateway Network Manager Guide*. diff -Nru awscli-1.16.301/awscli/examples/networkmanager/create-link.rst awscli-1.17.14/awscli/examples/networkmanager/create-link.rst --- awscli-1.16.301/awscli/examples/networkmanager/create-link.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/create-link.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,34 @@ +**To create a link** + +The following ``create-link`` example creates a link in the specified global network. The link includes a description and details about the link type, bandwidth, and provider. The site ID indicates the site to which the link is associated. :: + + aws networkmanager create-link \ + --global-network-id global-network-01231231231231231 \ + --description "VPN Link" \ + --type "broadband" \ + --bandwidth UploadSpeed=10,DownloadSpeed=20 \ + --provider "AnyCompany" \ + --site-id site-444555aaabbb11223 \ + --region us-west-2 + +Output:: + + { + "Link": { + "LinkId": "link-11112222aaaabbbb1", + "LinkArn": "arn:aws:networkmanager::123456789012:link/global-network-01231231231231231/link-11112222aaaabbbb1", + "GlobalNetworkId": "global-network-01231231231231231", + "SiteId": "site-444555aaabbb11223", + "Description": "VPN Link", + "Type": "broadband", + "Bandwidth": { + "UploadSpeed": 10, + "DownloadSpeed": 20 + }, + "Provider": "AnyCompany", + "CreatedAt": 1575555811.0, + "State": "PENDING" + } + } + +For more information, see `Working with Links `__ in the *Transit Gateway Network Manager Guide*. diff -Nru awscli-1.16.301/awscli/examples/networkmanager/create-site.rst awscli-1.17.14/awscli/examples/networkmanager/create-site.rst --- awscli-1.16.301/awscli/examples/networkmanager/create-site.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/create-site.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,28 @@ +**To create a site** + +The following ``create-site`` example creates a site in the specified global network. The site details include a description and the location information. :: + + aws networkmanager create-site \ + --global-network-id global-network-01231231231231231 \ + --description "New York head office" \ + --location Latitude=40.7128,Longitude=-74.0060 \ + --region us-west-2 + +Output:: + + { + "Site": { + "SiteId": "site-444555aaabbb11223", + "SiteArn": "arn:aws:networkmanager::123456789012:site/global-network-01231231231231231/site-444555aaabbb11223", + "GlobalNetworkId": "global-network-01231231231231231", + "Description": "New York head office", + "Location": { + "Latitude": "40.7128", + "Longitude": "-74.0060" + }, + "CreatedAt": 1575554300.0, + "State": "PENDING" + } + } + +For more information, see `Working with Sites `__ in the *Transit Gateway Network Manager Guide*. diff -Nru awscli-1.16.301/awscli/examples/networkmanager/delete-bucket-analytics-configuration.rst awscli-1.17.14/awscli/examples/networkmanager/delete-bucket-analytics-configuration.rst --- awscli-1.16.301/awscli/examples/networkmanager/delete-bucket-analytics-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/delete-bucket-analytics-configuration.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,9 @@ +**To delete an analytics configuration for a bucket** + +The following ``delete-bucket-analytics-configuration`` example removes the analytics configuration for the specified bucket and ID. :: + + aws s3api delete-bucket-analytics-configuration \ + --bucket my-bucket \ + --id 1 + +This command produces no output. \ No newline at end of file diff -Nru awscli-1.16.301/awscli/examples/networkmanager/delete-bucket-metrics-configuration.rst awscli-1.17.14/awscli/examples/networkmanager/delete-bucket-metrics-configuration.rst --- awscli-1.16.301/awscli/examples/networkmanager/delete-bucket-metrics-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/delete-bucket-metrics-configuration.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,9 @@ +**To delete a metrics configuration for a bucket** + +The following ``delete-bucket-metrics-configuration`` example removes the metrics configuration for the specified bucket and ID. :: + + aws s3api delete-bucket-metrics-configuration \ + --bucket my-bucket \ + --id 123 + +This command produces no output. \ No newline at end of file diff -Nru awscli-1.16.301/awscli/examples/networkmanager/delete-device.rst awscli-1.17.14/awscli/examples/networkmanager/delete-device.rst --- awscli-1.16.301/awscli/examples/networkmanager/delete-device.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/delete-device.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,28 @@ +**To delete a device** + +The following ``delete-device`` example deletes the specified device from the specified global network. :: + + aws networkmanager delete-device \ + --global-network-id global-network-01231231231231231 \ + --device-id device-07f6fd08867abc123 \ + --region us-west-2 + +Output:: + + { + "Device": { + "DeviceId": "device-07f6fd08867abc123", + "DeviceArn": "arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123", + "GlobalNetworkId": "global-network-01231231231231231", + "Description": "New York office device", + "Type": "office device", + "Vendor": "anycompany", + "Model": "abcabc", + "SerialNumber": "1234", + "SiteId": "site-444555aaabbb11223", + "CreatedAt": 1575554005.0, + "State": "DELETING" + } + } + +For more information, see `Working with Devices `__ in the *Transit Gateway Network Manager Guide*. diff -Nru awscli-1.16.301/awscli/examples/networkmanager/delete-global-network.rst awscli-1.17.14/awscli/examples/networkmanager/delete-global-network.rst --- awscli-1.16.301/awscli/examples/networkmanager/delete-global-network.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/delete-global-network.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,21 @@ +**To delete a global network** + +The following ``delete-global-network`` example deletes the specified global network. :: + + aws networkmanager delete-global-network \ + --global-network-id global-network-01231231231231231 \ + --region us-west-2 + +Output:: + + { + "GlobalNetwork": { + "GlobalNetworkId": "global-network-01231231231231231", + "GlobalNetworkArn": "arn:aws:networkmanager::123456789012:global-network/global-network-01231231231231231", + "Description": "Head offices global network", + "CreatedAt": 1575553525.0, + "State": "DELETING" + } + } + +For more information, see `Global Networks `__ in the *Transit Gateway Network Manager Guide*. diff -Nru awscli-1.16.301/awscli/examples/networkmanager/delete-link.rst awscli-1.17.14/awscli/examples/networkmanager/delete-link.rst --- awscli-1.16.301/awscli/examples/networkmanager/delete-link.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/delete-link.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,30 @@ +**To delete a link** + +The following ``delete-link`` example deletes the specified link from the specified global network. :: + + aws networkmanager delete-link \ + --global-network-id global-network-01231231231231231 \ + --link-id link-11112222aaaabbbb1 \ + --region us-west-2 + +Output:: + + { + "Link": { + "LinkId": "link-11112222aaaabbbb1", + "LinkArn": "arn:aws:networkmanager::123456789012:link/global-network-01231231231231231/link-11112222aaaabbbb1", + "GlobalNetworkId": "global-network-01231231231231231", + "SiteId": "site-444555aaabbb11223", + "Description": "VPN Link", + "Type": "broadband", + "Bandwidth": { + "UploadSpeed": 20, + "DownloadSpeed": 20 + }, + "Provider": "AnyCompany", + "CreatedAt": 1575555811.0, + "State": "DELETING" + } + } + +For more information, see `Working with Links `__ in the *Transit Gateway Network Manager Guide*. diff -Nru awscli-1.16.301/awscli/examples/networkmanager/delete-public-access-block.rst awscli-1.17.14/awscli/examples/networkmanager/delete-public-access-block.rst --- awscli-1.16.301/awscli/examples/networkmanager/delete-public-access-block.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/delete-public-access-block.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,8 @@ +**To delete the block public access configuration for a bucket** + +The following ``delete-public-access-block`` example removes the block public access configuration on the specified bucket. :: + + aws s3api delete-public-access-block \ + --bucket my-bucket + +This command produces no output. diff -Nru awscli-1.16.301/awscli/examples/networkmanager/delete-site.rst awscli-1.17.14/awscli/examples/networkmanager/delete-site.rst --- awscli-1.16.301/awscli/examples/networkmanager/delete-site.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/delete-site.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,27 @@ +**To delete a site** + +The following ``delete-site`` example deletes the specified site (``site-444555aaabbb11223``) in the specified global network. :: + + aws networkmanager delete-site \ + --global-network-id global-network-01231231231231231 \ + --site-id site-444555aaabbb11223 \ + --region us-west-2 + +Output:: + + { + "Site": { + "SiteId": "site-444555aaabbb11223", + "SiteArn": "arn:aws:networkmanager::123456789012:site/global-network-01231231231231231/site-444555aaabbb11223", + "GlobalNetworkId": "global-network-01231231231231231", + "Description": "New York head office", + "Location": { + "Latitude": "40.7128", + "Longitude": "-74.0060" + }, + "CreatedAt": 1575554300.0, + "State": "DELETING" + } + } + +For more information, see `Working with Sites `__ in the *Transit Gateway Network Manager Guide*. diff -Nru awscli-1.16.301/awscli/examples/networkmanager/deregister-transit-gateway.rst awscli-1.17.14/awscli/examples/networkmanager/deregister-transit-gateway.rst --- awscli-1.16.301/awscli/examples/networkmanager/deregister-transit-gateway.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/deregister-transit-gateway.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,22 @@ +**To deregister a transit gateway from a global network** + +The following ``deregister-transit-gateway`` example deregisters the specified transit gateway from the specified global network. :: + + aws networkmanager deregister-transit-gateway \ + --global-network-id global-network-01231231231231231 \ + --transit-gateway-arn arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-123abc05e04123abc \ + --region us-west-2 + +Output:: + + { + "TransitGatewayRegistration": { + "GlobalNetworkId": "global-network-01231231231231231", + "TransitGatewayArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-123abc05e04123abc", + "State": { + "Code": "DELETING" + } + } + } + +For more information, see `Transit Gateway Registrations `__ in the *Transit Gateway Network Manager Guide*. diff -Nru awscli-1.16.301/awscli/examples/networkmanager/describe-global-networks.rst awscli-1.17.14/awscli/examples/networkmanager/describe-global-networks.rst --- awscli-1.16.301/awscli/examples/networkmanager/describe-global-networks.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/describe-global-networks.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,20 @@ +**To describe your global networks** + +The following ``describe-global-networks`` example describes all of your global networks in your account. :: + + aws networkmanager describe-global-networks \ + --region us-west-2 + +Output:: + + { + "GlobalNetworks": [ + { + "GlobalNetworkId": "global-network-01231231231231231", + "GlobalNetworkArn": "arn:aws:networkmanager::123456789012:global-network/global-network-01231231231231231", + "Description": "Company 1 global network", + "CreatedAt": 1575553525.0, + "State": "AVAILABLE" + } + ] + } diff -Nru awscli-1.16.301/awscli/examples/networkmanager/disassociate-customer-gateway.rst awscli-1.17.14/awscli/examples/networkmanager/disassociate-customer-gateway.rst --- awscli-1.16.301/awscli/examples/networkmanager/disassociate-customer-gateway.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/disassociate-customer-gateway.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,21 @@ +**To disassociate a customer gateway** + +The following ``disassociate-customer-gateway`` example disassociates the specified customer gateway (``cgw-11223344556677889``) from the specified global network. :: + + aws networkmanager disassociate-customer-gateway \ + --global-network-id global-network-01231231231231231 \ + --customer-gateway-arn arn:aws:ec2:us-west-2:123456789012:customer-gateway/cgw-11223344556677889 \ + --region us-west-2 + +Output:: + + { + "CustomerGatewayAssociation": { + "CustomerGatewayArn": "arn:aws:ec2:us-west-2:123456789012:customer-gateway/cgw-11223344556677889", + "GlobalNetworkId": "global-network-01231231231231231", + "DeviceId": "device-07f6fd08867abc123", + "State": "DELETING" + } + } + +For more information, see `Customer Gateway Associations `__ in the *Transit Gateway Network Manager Guide*. diff -Nru awscli-1.16.301/awscli/examples/networkmanager/disassociate-link.rst awscli-1.17.14/awscli/examples/networkmanager/disassociate-link.rst --- awscli-1.16.301/awscli/examples/networkmanager/disassociate-link.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/disassociate-link.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,22 @@ +**To disassociate a link** + +The following ``disassociate-link`` example disassociates the specified link from device ``device-07f6fd08867abc123`` in the specified global network. :: + + aws networkmanager disassociate-link \ + --global-network-id global-network-01231231231231231 \ + --device-id device-07f6fd08867abc123 \ + --link-id link-11112222aaaabbbb1 \ + --region us-west-2 + +Output:: + + { + "LinkAssociation": { + "GlobalNetworkId": "global-network-01231231231231231", + "DeviceId": "device-07f6fd08867abc123", + "LinkId": "link-11112222aaaabbbb1", + "LinkAssociationState": "DELETING" + } + } + +For more information, see `Device and Link Associations `__ in the *Transit Gateway Network Manager Guide*. diff -Nru awscli-1.16.301/awscli/examples/networkmanager/get-bucket-analytics-configuration.rst awscli-1.17.14/awscli/examples/networkmanager/get-bucket-analytics-configuration.rst --- awscli-1.16.301/awscli/examples/networkmanager/get-bucket-analytics-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/get-bucket-analytics-configuration.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,16 @@ +**To retrieve the analytics configuration for a bucket with a specific ID** + +The following ``get-bucket-analytics-configuration`` example displays the analytics configuration for the specified bucket and ID. :: + + aws s3api get-bucket-analytics-configuration \ + --bucket my-bucket \ + --id 1 + +Output:: + + { + "AnalyticsConfiguration": { + "StorageClassAnalysis": {}, + "Id": "1" + } + } diff -Nru awscli-1.16.301/awscli/examples/networkmanager/get-bucket-metrics-configuration.rst awscli-1.17.14/awscli/examples/networkmanager/get-bucket-metrics-configuration.rst --- awscli-1.16.301/awscli/examples/networkmanager/get-bucket-metrics-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/get-bucket-metrics-configuration.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,18 @@ +**To retrieve the metrics configuration for a bucket with a specific ID** + +The following ``get-bucket-metrics-configuration`` example displays the metrics configuration for the specified bucket and ID. :: + + aws s3api get-bucket-metrics-configuration \ + --bucket my-bucket \ + --id 123 + +Output:: + + { + "MetricsConfiguration": { + "Filter": { + "Prefix": "logs" + }, + "Id": "123" + } + } diff -Nru awscli-1.16.301/awscli/examples/networkmanager/get-customer-gateway-associations.rst awscli-1.17.14/awscli/examples/networkmanager/get-customer-gateway-associations.rst --- awscli-1.16.301/awscli/examples/networkmanager/get-customer-gateway-associations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/get-customer-gateway-associations.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,20 @@ +**To get your customer gateway associations** + +The following ``get-customer-gateway-associations`` example gets the customer gateway associations for the specified global network. :: + + aws networkmanager get-customer-gateway-associations \ + --global-network-id global-network-01231231231231231 \ + --region us-west-2 + +Output:: + + { + "CustomerGatewayAssociations": [ + { + "CustomerGatewayArn": "arn:aws:ec2:us-west-2:123456789012:customer-gateway/cgw-11223344556677889", + "GlobalNetworkId": "global-network-01231231231231231", + "DeviceId": "device-07f6fd08867abc123", + "State": "AVAILABLE" + } + ] + } diff -Nru awscli-1.16.301/awscli/examples/networkmanager/get-devices.rst awscli-1.17.14/awscli/examples/networkmanager/get-devices.rst --- awscli-1.16.301/awscli/examples/networkmanager/get-devices.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/get-devices.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,26 @@ +**To get your devices** + +The following ``get-devices`` example gets the devices in the specified global network. :: + + aws networkmanager get-devices \ + --global-network-id global-network-01231231231231231 \ + --region us-west-2 + +Output:: + + { + "Devices": [ + { + "DeviceId": "device-07f6fd08867abc123", + "DeviceArn": "arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123", + "GlobalNetworkId": "global-network-01231231231231231", + "Description": "NY office device", + "Type": "office device", + "Vendor": "anycompany", + "Model": "abcabc", + "SerialNumber": "1234", + "CreatedAt": 1575554005.0, + "State": "AVAILABLE" + } + ] + } diff -Nru awscli-1.16.301/awscli/examples/networkmanager/get-link-associations.rst awscli-1.17.14/awscli/examples/networkmanager/get-link-associations.rst --- awscli-1.16.301/awscli/examples/networkmanager/get-link-associations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/get-link-associations.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,20 @@ +**To get your link associations** + +The following ``get-link-associations`` example gets the link associations in the specified global network. :: + + aws networkmanager get-link-associations \ + --global-network-id global-network-01231231231231231 \ + --region us-west-2 + +Output:: + + { + "LinkAssociations": [ + { + "GlobalNetworkId": "global-network-01231231231231231", + "DeviceId": "device-07f6fd08867abc123", + "LinkId": "link-11112222aaaabbbb1", + "LinkAssociationState": "AVAILABLE" + } + ] + } diff -Nru awscli-1.16.301/awscli/examples/networkmanager/get-links.rst awscli-1.17.14/awscli/examples/networkmanager/get-links.rst --- awscli-1.16.301/awscli/examples/networkmanager/get-links.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/get-links.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,29 @@ +**To get your links** + +The following ``get-links`` example gets the links in the specified global network. :: + + aws networkmanager get-links \ + --global-network-id global-network-01231231231231231 \ + --region us-west-2 + +Output:: + + { + "Links": [ + { + "LinkId": "link-11112222aaaabbbb1", + "LinkArn": "arn:aws:networkmanager::123456789012:link/global-network-01231231231231231/link-11112222aaaabbbb1", + "GlobalNetworkId": "global-network-01231231231231231", + "SiteId": "site-444555aaabbb11223", + "Description": "VPN Link", + "Type": "broadband", + "Bandwidth": { + "UploadSpeed": 10, + "DownloadSpeed": 20 + }, + "Provider": "AnyCompany", + "CreatedAt": 1575555811.0, + "State": "AVAILABLE" + } + ] + } diff -Nru awscli-1.16.301/awscli/examples/networkmanager/get-object-retention.rst awscli-1.17.14/awscli/examples/networkmanager/get-object-retention.rst --- awscli-1.16.301/awscli/examples/networkmanager/get-object-retention.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/get-object-retention.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,16 @@ +**To retrieve the object retention configuration for an object** + +The following ``get-object-retention`` example retrieves the object retention configuration for the specified object. :: + + aws s3api get-object-retention \ + --bucket my-bucket-with-object-lock \ + --key doc1.rtf + +Output:: + + { + "Retention": { + "Mode": "GOVERNANCE", + "RetainUntilDate": "2025-01-01T00:00:00.000Z" + } + } diff -Nru awscli-1.16.301/awscli/examples/networkmanager/get-public-access-block.rst awscli-1.17.14/awscli/examples/networkmanager/get-public-access-block.rst --- awscli-1.16.301/awscli/examples/networkmanager/get-public-access-block.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/get-public-access-block.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,16 @@ +**To set or modify the block public access configuration for a bucket** + +The following ``get-public-access-block`` example displays the block public access configuration for the specified bucket. :: + + aws s3api get-public-access-block --bucket my-bucket + +Output:: + + { + "PublicAccessBlockConfiguration": { + "IgnorePublicAcls": true, + "BlockPublicPolicy": true, + "BlockPublicAcls": true, + "RestrictPublicBuckets": true + } + } diff -Nru awscli-1.16.301/awscli/examples/networkmanager/get-sites.rst awscli-1.17.14/awscli/examples/networkmanager/get-sites.rst --- awscli-1.16.301/awscli/examples/networkmanager/get-sites.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/get-sites.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,26 @@ +**To get your sites** + +The following ``get-sites`` example gets the sites in the specified global network. :: + + aws networkmanager get-sites \ + --global-network-id global-network-01231231231231231 \ + --region us-west-2 + +Output:: + + { + "Sites": [ + { + "SiteId": "site-444555aaabbb11223", + "SiteArn": "arn:aws:networkmanager::123456789012:site/global-network-01231231231231231/site-444555aaabbb11223", + "GlobalNetworkId": "global-network-01231231231231231", + "Description": "NY head office", + "Location": { + "Latitude": "40.7128", + "Longitude": "-74.0060" + }, + "CreatedAt": 1575554528.0, + "State": "AVAILABLE" + } + ] + } diff -Nru awscli-1.16.301/awscli/examples/networkmanager/get-transit-gateway-registrations.rst awscli-1.17.14/awscli/examples/networkmanager/get-transit-gateway-registrations.rst --- awscli-1.16.301/awscli/examples/networkmanager/get-transit-gateway-registrations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/get-transit-gateway-registrations.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,21 @@ +**To get your transit gateway registrations** + +The following ``get-transit-gateway-registrations`` example gets the transit gateways that are registered to the specified global network. :: + + aws networkmanager get-transit-gateway-registrations \ + --global-network-id global-network-01231231231231231 \ + --region us-west-2 + +Output:: + + { + "TransitGatewayRegistrations": [ + { + "GlobalNetworkId": "global-network-01231231231231231", + "TransitGatewayArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-123abc05e04123abc", + "State": { + "Code": "AVAILABLE" + } + } + ] + } diff -Nru awscli-1.16.301/awscli/examples/networkmanager/list-bucket-analytics-configurations.rst awscli-1.17.14/awscli/examples/networkmanager/list-bucket-analytics-configurations.rst --- awscli-1.16.301/awscli/examples/networkmanager/list-bucket-analytics-configurations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/list-bucket-analytics-configurations.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,18 @@ +**To retrieve a list of analytics configurations for a bucket** + +The following ``list-bucket-analytics-configurations`` retrieves a list of analytics configurations for the specified bucket. :: + + aws s3api list-bucket-analytics-configurations \ + --bucket my-bucket + +Output:: + + { + "AnalyticsConfigurationList": [ + { + "StorageClassAnalysis": {}, + "Id": "1" + } + ], + "IsTruncated": false + } diff -Nru awscli-1.16.301/awscli/examples/networkmanager/list-bucket-metrics-configurations.rst awscli-1.17.14/awscli/examples/networkmanager/list-bucket-metrics-configurations.rst --- awscli-1.16.301/awscli/examples/networkmanager/list-bucket-metrics-configurations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/list-bucket-metrics-configurations.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,26 @@ +**To retrieve a list of metrics configurations for a bucket** + +The following ``list-bucket-metrics-configurations`` example retrieves a list of metrics configurations for the specified bucket. :: + + aws s3api list-bucket-metrics-configurations \ + --bucket my-bucket + +Output:: + + { + "IsTruncated": false, + "MetricsConfigurationList": [ + { + "Filter": { + "Prefix": "logs" + }, + "Id": "123" + }, + { + "Filter": { + "Prefix": "tmp" + }, + "Id": "234" + } + ] + } diff -Nru awscli-1.16.301/awscli/examples/networkmanager/list-tags-for-resource.rst awscli-1.17.14/awscli/examples/networkmanager/list-tags-for-resource.rst --- awscli-1.16.301/awscli/examples/networkmanager/list-tags-for-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/list-tags-for-resource.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,18 @@ +**To list the tags for a resource** + +The following ``list-tags-for-resource`` example lists the tags for the specified device resource (``device-07f6fd08867abc123``). :: + + aws networkmanager list-tags-for-resource \ + --resource-arn arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123 \ + --region us-west-2 + +Output:: + + { + "TagList": [ + { + "Key": "Network", + "Value": "Northeast" + } + ] + } diff -Nru awscli-1.16.301/awscli/examples/networkmanager/put-bucket-metrics-configuration.rst awscli-1.17.14/awscli/examples/networkmanager/put-bucket-metrics-configuration.rst --- awscli-1.16.301/awscli/examples/networkmanager/put-bucket-metrics-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/put-bucket-metrics-configuration.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,10 @@ +**To set a metrics configuration for a bucket** + +The following ``put-bucket-metrics-configuration`` example sets a metric configuration with ID 123 for the specified bucket. :: + + aws s3api put-bucket-metrics-configuration \ + --bucket my-bucket \ + --id 123 \ + --metrics-configuration '{"Id": "123", "Filter": {"Prefix": "logs"}}' + +This command produces no output. diff -Nru awscli-1.16.301/awscli/examples/networkmanager/put-object-retention.rst awscli-1.17.14/awscli/examples/networkmanager/put-object-retention.rst --- awscli-1.16.301/awscli/examples/networkmanager/put-object-retention.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/put-object-retention.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,10 @@ +**To set an object retention configuration for an object** + +The following ``put-object-retention`` example sets an object retention configuration for the specified object until 2025-01-01. :: + + aws s3api put-object-retention \ + --bucket my-bucket-with-object-lock \ + --key doc1.rtf \ + --retention '{ "Mode": "GOVERNANCE", "RetainUntilDate": "2025-01-01T00:00:00" }' + +This command produces no output. \ No newline at end of file diff -Nru awscli-1.16.301/awscli/examples/networkmanager/put-public-access-block.rst awscli-1.17.14/awscli/examples/networkmanager/put-public-access-block.rst --- awscli-1.16.301/awscli/examples/networkmanager/put-public-access-block.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/put-public-access-block.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,9 @@ +**To set the block public access configuration for a bucket** + +The following ``put-public-access-block`` example sets a restrictive block public access configuration for the specified bucket. :: + + aws s3api put-public-access-block \ + --bucket my-bucket \ + --public-access-block-configuration "BlockPublicAcls=true,IgnorePublicAcls=true,BlockPublicPolicy=true,RestrictPublicBuckets=true" + +This command produces no output. diff -Nru awscli-1.16.301/awscli/examples/networkmanager/register-transit-gateway.rst awscli-1.17.14/awscli/examples/networkmanager/register-transit-gateway.rst --- awscli-1.16.301/awscli/examples/networkmanager/register-transit-gateway.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/register-transit-gateway.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,22 @@ +**To register a transit gateway in a global network** + +The following ``register-transit-gateway`` example registers transit gateway ``tgw-123abc05e04123abc`` in the specified global network. :: + + aws networkmanager register-transit-gateway \ + --global-network-id global-network-01231231231231231 \ + --transit-gateway-arn arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-123abc05e04123abc \ + --region us-west-2 + +Output:: + + { + "TransitGatewayRegistration": { + "GlobalNetworkId": "global-network-01231231231231231", + "TransitGatewayArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-123abc05e04123abc", + "State": { + "Code": "PENDING" + } + } + } + +For more information, see `Transit Gateway Registrations `__ in the *Transit Gateway Network Manager Guide*. diff -Nru awscli-1.16.301/awscli/examples/networkmanager/tag-resource.rst awscli-1.17.14/awscli/examples/networkmanager/tag-resource.rst --- awscli-1.16.301/awscli/examples/networkmanager/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/tag-resource.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,10 @@ +**To apply tags to a resource** + +The following ``tag-resource`` example applies the tag ``Network=Northeast`` to the device ``device-07f6fd08867abc123``. :: + + aws networkmanager tag-resource \ + --resource-arn arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123 \ + --tags Key=Network,Value=Northeast \ + --region us-west-2 + +This command produces no output. diff -Nru awscli-1.16.301/awscli/examples/networkmanager/untag-resource.rst awscli-1.17.14/awscli/examples/networkmanager/untag-resource.rst --- awscli-1.16.301/awscli/examples/networkmanager/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/untag-resource.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,10 @@ +**To remove tags from a resource** + +The following ``untag-resource`` example removes the tag with the key ``Network`` from the device ``device-07f6fd08867abc123``. :: + + aws networkmanager untag-resource \ + --resource-arn arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123 ] + --tag-keys Network \ + --region us-west-2 + +This command produces no output. \ No newline at end of file diff -Nru awscli-1.16.301/awscli/examples/networkmanager/update-device.rst awscli-1.17.14/awscli/examples/networkmanager/update-device.rst --- awscli-1.16.301/awscli/examples/networkmanager/update-device.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/update-device.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,29 @@ +**To update a device** + +The following ``update-device`` example updates device ``device-07f6fd08867abc123`` by specifying a site ID for the device. :: + + aws networkmanager update-device \ + --global-network-id global-network-01231231231231231 \ + --device-id device-07f6fd08867abc123 \ + --site-id site-444555aaabbb11223 \ + --region us-west-2 + +Output:: + + { + "Device": { + "DeviceId": "device-07f6fd08867abc123", + "DeviceArn": "arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123", + "GlobalNetworkId": "global-network-01231231231231231", + "Description": "NY office device", + "Type": "Office device", + "Vendor": "anycompany", + "Model": "abcabc", + "SerialNumber": "1234", + "SiteId": "site-444555aaabbb11223", + "CreatedAt": 1575554005.0, + "State": "UPDATING" + } + } + +For more information, see `Working with Devices `__ in the *Transit Gateway Network Manager Guide*. diff -Nru awscli-1.16.301/awscli/examples/networkmanager/update-global-network.rst awscli-1.17.14/awscli/examples/networkmanager/update-global-network.rst --- awscli-1.16.301/awscli/examples/networkmanager/update-global-network.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/update-global-network.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,22 @@ +**To update a global network** + +The following ``update-global-network`` example updates the description for global network ``global-network-01231231231231231``. :: + + aws networkmanager update-global-network \ + --global-network-id global-network-01231231231231231 \ + --description "Head offices" \ + --region us-west-2 + +Output:: + + { + "GlobalNetwork": { + "GlobalNetworkId": "global-network-01231231231231231", + "GlobalNetworkArn": "arn:aws:networkmanager::123456789012:global-network/global-network-01231231231231231", + "Description": "Head offices", + "CreatedAt": 1575553525.0, + "State": "UPDATING" + } + } + +For more information, see `Global Networks `__ in the *Transit Gateway Network Manager Guide*. diff -Nru awscli-1.16.301/awscli/examples/networkmanager/update-link.rst awscli-1.17.14/awscli/examples/networkmanager/update-link.rst --- awscli-1.16.301/awscli/examples/networkmanager/update-link.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/update-link.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,31 @@ +**To update a link** + +The following ``update-link`` example updates the bandwidth information for link ``link-11112222aaaabbbb1``. :: + + aws networkmanager update-link \ + --global-network-id global-network-01231231231231231 \ + --link-id link-11112222aaaabbbb1 \ + --bandwidth UploadSpeed=20,DownloadSpeed=20 \ + --region us-west-2 + +Output:: + + { + "Link": { + "LinkId": "link-11112222aaaabbbb1", + "LinkArn": "arn:aws:networkmanager::123456789012:link/global-network-01231231231231231/link-11112222aaaabbbb1", + "GlobalNetworkId": "global-network-01231231231231231", + "SiteId": "site-444555aaabbb11223", + "Description": "VPN Link", + "Type": "broadband", + "Bandwidth": { + "UploadSpeed": 20, + "DownloadSpeed": 20 + }, + "Provider": "AnyCompany", + "CreatedAt": 1575555811.0, + "State": "UPDATING" + } + } + +For more information, see `Working with Links `__ in the *Transit Gateway Network Manager Guide*. diff -Nru awscli-1.16.301/awscli/examples/networkmanager/update-site.rst awscli-1.17.14/awscli/examples/networkmanager/update-site.rst --- awscli-1.16.301/awscli/examples/networkmanager/update-site.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/networkmanager/update-site.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,28 @@ +**To update a site** + +The following ``update-site`` example updates the description for site ``site-444555aaabbb11223`` in the specified global network. :: + + aws networkmanager update-site \ + --global-network-id global-network-01231231231231231 \ + --site-id site-444555aaabbb11223 \ + --description "New York Office site" \ + --region us-west-2 + +Output:: + + { + "Site": { + "SiteId": "site-444555aaabbb11223", + "SiteArn": "arn:aws:networkmanager::123456789012:site/global-network-01231231231231231/site-444555aaabbb11223", + "GlobalNetworkId": "global-network-01231231231231231", + "Description": "New York Office site", + "Location": { + "Latitude": "40.7128", + "Longitude": "-74.0060" + }, + "CreatedAt": 1575554528.0, + "State": "UPDATING" + } + } + +For more information, see `Working with Sites `__ in the *Transit Gateway Network Manager Guide*. diff -Nru awscli-1.16.301/awscli/examples/rds/describe-db-instances.rst awscli-1.17.14/awscli/examples/rds/describe-db-instances.rst --- awscli-1.16.301/awscli/examples/rds/describe-db-instances.rst 2019-12-11 19:07:42.000000000 +0000 +++ awscli-1.17.14/awscli/examples/rds/describe-db-instances.rst 2020-02-10 19:14:32.000000000 +0000 @@ -1,24 +1,26 @@ -**To describe a DB instance** - -The following ``describe-db-instances`` example retrieves details about the specified DB instance. :: - - aws rds describe-db-instances \ - --db-instance-identifier test-instance - -Output:: - - { - "DBInstance": { - "DBInstanceIdentifier": "test-instance", - "DBInstanceClass": "db.m1.small", - "Engine": "mysql", - "DBInstanceStatus": "available", - "MasterUsername": "myawsuser", - "Endpoint": { - "Address": "test-instance.cdgmuqiadpid.us-east-1.rds.amazonaws.com", - "Port": 3306, - "HostedZoneId": "Z2R2ITUGPM61AM" - }, - ...some output truncated... - } - } +**To describe a DB instance** + +The following ``describe-db-instances`` example retrieves details about the specified DB instance. :: + + aws rds describe-db-instances \ + --db-instance-identifier mydbinstancecf + +Output:: + + { + "DBInstances": [ + { + "DBInstanceIdentifier": "mydbinstancecf", + "DBInstanceClass": "db.t3.small", + "Engine": "mysql", + "DBInstanceStatus": "available", + "MasterUsername": "masterawsuser", + "Endpoint": { + "Address": "mydbinstancecf.abcexample.us-east-1.rds.amazonaws.com", + "Port": 3306, + "HostedZoneId": "Z2R2ITUGPM61AM" + }, + ...some output truncated... + } + ] + } diff -Nru awscli-1.16.301/awscli/examples/redshift/accept-reserved-node-exchange.rst awscli-1.17.14/awscli/examples/redshift/accept-reserved-node-exchange.rst --- awscli-1.16.301/awscli/examples/redshift/accept-reserved-node-exchange.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/redshift/accept-reserved-node-exchange.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,34 @@ +**To accept reserved node exchange** + +The following ``accept-reserved-node-exchange`` example accepts exchange of a DC1 reserved node for a DC2 reserved node. :: + + aws redshift accept-reserved-node-exchange / + --reserved-node-id 12345678-12ab-12a1-1a2a-12ab-12a12EXAMPLE / + --target-reserved-node-offering-id 12345678-12ab-12a1-1a2a-12ab-12a12EXAMPLE + +Output:: + + { + "ExchangedReservedNode": { + "ReservedNodeId": "12345678-12ab-12a1-1a2a-12ab-12a12EXAMPLE", + "ReservedNodeOfferingId": "12345678-12ab-12a1-1a2a-12ab-12a12EXAMPLE", + "NodeType": "dc2.large", + "StartTime": "2019-12-06T21:17:26Z", + "Duration": 31536000, + "FixedPrice": 0.0, + "UsagePrice": 0.0, + "CurrencyCode": "USD", + "NodeCount": 1, + "State": "exchanging", + "OfferingType": "All Upfront", + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.0, + "RecurringChargeFrequency": "Hourly" + } + ], + "ReservedNodeOfferingType": "Regular" + } + } + +For more information, see `Upgrading Reserved Nodes With the AWS CLI `__ in the *Amazon Redshift Cluster Management Guide*. diff -Nru awscli-1.16.301/awscli/examples/redshift/batch-delete-cluster-snapshots.rst awscli-1.17.14/awscli/examples/redshift/batch-delete-cluster-snapshots.rst --- awscli-1.16.301/awscli/examples/redshift/batch-delete-cluster-snapshots.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/redshift/batch-delete-cluster-snapshots.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,17 @@ +**To delete a set of cluster snapshots** + +The following ``batch-delete-cluster-snapshots`` example deletes a set of manual cluster snapshots. :: + + aws redshift batch-delete-cluster-snapshots \ + --identifiers SnapshotIdentifier=mycluster-2019-11-06-14-12 SnapshotIdentifier=mycluster-2019-11-06-14-20 + +Output:: + + { + "Resources": [ + "mycluster-2019-11-06-14-12", + "mycluster-2019-11-06-14-20" + ] + } + +For more information, see `Amazon Redshift Snapshots `__ in the *Amazon Redshift Cluster Management Guide*. diff -Nru awscli-1.16.301/awscli/examples/redshift/batch-modify-cluster-snapshots.rst awscli-1.17.14/awscli/examples/redshift/batch-modify-cluster-snapshots.rst --- awscli-1.16.301/awscli/examples/redshift/batch-modify-cluster-snapshots.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/redshift/batch-modify-cluster-snapshots.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,31 @@ +**To modify a set of cluster snapshots** + +The following ``batch-modify-cluster-snapshots`` example modifies the settings for a set of cluster snapshots. :: + + aws redshift batch-modify-cluster-snapshots \ + --snapshot-identifier-list mycluster-2019-11-06-16-31 mycluster-2019-11-06-16-32 \ + --manual-snapshot-retention-period 30 + +Output:: + + { + "Resources": [ + "mycluster-2019-11-06-16-31", + "mycluster-2019-11-06-16-32" + ], + "Errors": [], + "ResponseMetadata": { + "RequestId": "12345678-12ab-12a1-1a2a-12ab-12a12EXAMPLE", + "HTTPStatusCode": 200, + "HTTPHeaders": { + "x-amzn-requestid": "12345678-12ab-12a1-1a2a-12ab-12a12EXAMPLE, + "content-type": "text/xml", + "content-length": "480", + "date": "Sat, 07 Dec 2019 00:36:09 GMT", + "connection": "keep-alive" + }, + "RetryAttempts": 0 + } + } + +For more information, see `Amazon Redshift Snapshots `__ in the *Amazon Redshift Cluster Management Guide*. diff -Nru awscli-1.16.301/awscli/examples/redshift/cancel-resize.rst awscli-1.17.14/awscli/examples/redshift/cancel-resize.rst --- awscli-1.16.301/awscli/examples/redshift/cancel-resize.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/redshift/cancel-resize.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,19 @@ +**To cancel resize of a cluster** + +The following ``cancel-resize`` example cancels a classic resize operation for a cluster. :: + + aws redshift cancel-resize \ + --cluster-identifier mycluster + +Output:: + + { + "TargetNodeType": "dc2.large", + "TargetNumberOfNodes": 2, + "TargetClusterType": "multi-node", + "Status": "CANCELLING", + "ResizeType": "ClassicResize", + "TargetEncryptionType": "NONE" + } + +For more information, see `Resizing Clusters in Amazon Redshift `__ in the *Amazon Redshift Cluster Management Guide*. diff -Nru awscli-1.16.301/awscli/examples/redshift/create-event-subscription.rst awscli-1.17.14/awscli/examples/redshift/create-event-subscription.rst --- awscli-1.16.301/awscli/examples/redshift/create-event-subscription.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/redshift/create-event-subscription.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,31 @@ +**To create a notification subscription for an event** + +The following ``create-event-subscription`` example creates an event notification subscription. :: + + aws redshift create-event-subscription \ + --subscription-name mysubscription \ + --sns-topic-arn arn:aws:sns:us-west-2:123456789012:MySNStopic \ + --source-type cluster \ + --source-ids mycluster + +Output:: + + { + "EventSubscription": { + "CustomerAwsId": "123456789012", + "CustSubscriptionId": "mysubscription", + "SnsTopicArn": "arn:aws:sns:us-west-2:123456789012:MySNStopic", + "Status": "active", + "SubscriptionCreationTime": "2019-12-09T20:05:19.365Z", + "SourceType": "cluster", + "SourceIdsList": [ + "mycluster" + ], + "EventCategoriesList": [], + "Severity": "INFO", + "Enabled": true, + "Tags": [] + } + } + +For more information, see `Subscribing to Amazon Redshift Event Notifications `__ in the *Amazon Redshift Cluster Management Guide*. diff -Nru awscli-1.16.301/awscli/examples/redshift/create-hsm-client-certificate.rst awscli-1.17.14/awscli/examples/redshift/create-hsm-client-certificate.rst --- awscli-1.16.301/awscli/examples/redshift/create-hsm-client-certificate.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/redshift/create-hsm-client-certificate.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,32 @@ +**To create an HSM client certificate** + +The following ``create-hsm-client-certificate`` example generates an HSM client certificate that a cluster can use to connect to an HSM. :: + + aws redshift create-hsm-client-certificate \ + --hsm-client-certificate-identifier myhsmclientcert + +Output:: + + { + "HsmClientCertificate": { + "HsmClientCertificateIdentifier": "myhsmclientcert", + "HsmClientCertificatePublicKey": "-----BEGIN CERTIFICATE----- + MIICiEXAMPLECQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC + VVMxCzAJBgNVBAgTEXAMPLEwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 + b24xFDASBgNVBAsTC0lBTSBDb25EXAMPLEIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd + BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb2EXAMPLETEwNDI1MjA0NTIxWhcN + MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBEXAMPLEMRAwDgYD + EXAMPLETZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z + b2xlMRIwEAEXAMPLEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt + YXpvbi5jb20wgZ8wDQYJKEXAMPLEAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ + 21uUSfwfEvySWtC2XADZ4nB+BLYgVIk6EXAMPLE3G93vUEIO3IyNoH/f0wYK8m9T + rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugEXAMPLEzZswY6786m86gpE + Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEEXAMPLEEAtCu4 + nUhVVxYUEXAMPLEh8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb + FFBjvSfpJIlJ00zbhNYS5f6GEXAMPLEl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb + NYiytVbZPQUQ5Yaxu2jXnimvw3rEXAMPLE=-----END CERTIFICATE-----\n", + "Tags": [] + } + } + +For more information, see `Amazon Redshift API Permissions Reference `__ in the *Amazon Redshift Cluster Management Guide*. diff -Nru awscli-1.16.301/awscli/examples/redshift/create-hsm-configuration.rst awscli-1.17.14/awscli/examples/redshift/create-hsm-configuration.rst --- awscli-1.16.301/awscli/examples/redshift/create-hsm-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/redshift/create-hsm-configuration.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,23 @@ +**To create an HSM configuration** + +The following ``create-hsm-configuration`` example creates the specified HSM configuration that contains information required by a cluster to store and use database encryption keys in a hardware security module (HSM). :: + + aws redshift create-hsm-configuration / + --hsm-configuration-identifier myhsmconnection + --description "My HSM connection" + --hsm-ip-address 192.0.2.09 + --hsm-partition-name myhsmpartition / + --hsm-partition-password A1b2c3d4 / + --hsm-server-public-certificate myhsmclientcert + +Output:: + + { + "HsmConfiguration": { + "HsmConfigurationIdentifier": "myhsmconnection", + "Description": "My HSM connection", + "HsmIpAddress": "192.0.2.09", + "HsmPartitionName": "myhsmpartition", + "Tags": [] + } + } diff -Nru awscli-1.16.301/awscli/examples/redshift/create-snapshot-copy-grant.rst awscli-1.17.14/awscli/examples/redshift/create-snapshot-copy-grant.rst --- awscli-1.16.301/awscli/examples/redshift/create-snapshot-copy-grant.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/redshift/create-snapshot-copy-grant.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,18 @@ +**To create a snapshot copy grant** + +The following ``create-snapshot-copy-grant`` example creates a snapshot copy grant and encrypts copied snapshots in a destination AWS Region. :: + + aws redshift create-snapshot-copy-grant \ + --snapshot-copy-grant-name mysnapshotcopygrantname + +Output:: + + { + "SnapshotCopyGrant": { + "SnapshotCopyGrantName": "mysnapshotcopygrantname", + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/bPxRfih3yCo8nvbEXAMPLEKEY", + "Tags": [] + } + } + +For more information, see `Amazon Redshift Database Encryption `__ in the *Amazon Redshift Cluster Management Guide*. diff -Nru awscli-1.16.301/awscli/examples/redshift/create-snapshot-schedule.rst awscli-1.17.14/awscli/examples/redshift/create-snapshot-schedule.rst --- awscli-1.16.301/awscli/examples/redshift/create-snapshot-schedule.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/redshift/create-snapshot-schedule.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,21 @@ +**To create snapshot schedule** + +The following ``create-snapshot-schedule`` example creates a snapshot schedule with the specified description and a rate of every 12 hours. :: + + aws redshift create-snapshot-schedule \ + --schedule-definitions "rate(12 hours)" \ + --schedule-identifier mysnapshotschedule \ + --schedule-description "My schedule description" + +Output:: + + { + "ScheduleDefinitions": [ + "rate(12 hours)" + ], + "ScheduleIdentifier": "mysnapshotschedule", + "ScheduleDescription": "My schedule description", + "Tags": [] + } + +For more information, see `Automated Snapshot Schedules `__ in the *Amazon Redshift Cluster Management Guide*. diff -Nru awscli-1.16.301/awscli/examples/redshift/create-tags.rst awscli-1.17.14/awscli/examples/redshift/create-tags.rst --- awscli-1.16.301/awscli/examples/redshift/create-tags.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/redshift/create-tags.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,11 @@ +**To create tags for a cluster** + +The following ``create-tags`` example adds the specified tag key/value pair to the specified cluster. :: + + aws redshift create-tags \ + --resource-name arn:aws:redshift:us-west-2:123456789012:cluster:mycluster \ + --tags "Key"="mytags","Value"="tag1" + +This command does not produce any output. + +For more information, see `Tagging Resources in Amazon Redshift `__ in the *Amazon Redshift Cluster Management Guide*. diff -Nru awscli-1.16.301/awscli/examples/redshift/delete-event-subscription.rst awscli-1.17.14/awscli/examples/redshift/delete-event-subscription.rst --- awscli-1.16.301/awscli/examples/redshift/delete-event-subscription.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/redshift/delete-event-subscription.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete event subscription** + +The following ``delete-event-subscription`` example deletes the specified event notification subscription. :: + + aws redshift delete-event-subscription \ + --subscription-name mysubscription + +This command does not produce any output. + +For more information, see `Subscribing to Amazon Redshift Event Notifications `__ in the *Amazon Redshift Cluster Management Guide*. diff -Nru awscli-1.16.301/awscli/examples/redshift/delete-hsm-client-certificate.rst awscli-1.17.14/awscli/examples/redshift/delete-hsm-client-certificate.rst --- awscli-1.16.301/awscli/examples/redshift/delete-hsm-client-certificate.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/redshift/delete-hsm-client-certificate.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete HSM client certificate** + +The following ``delete-hsm-client-certificate`` example deletes an HSM client certificate. :: + + aws redshift delete-hsm-client-certificate \ + --hsm-client-certificate-identifier myhsmclientcert + +This command does not produce any output. + +For more information, see `Amazon Redshift API Permissions Reference `__ in the *Amazon Redshift Cluster Management Guide*. diff -Nru awscli-1.16.301/awscli/examples/redshift/delete-hsm-configuration.rst awscli-1.17.14/awscli/examples/redshift/delete-hsm-configuration.rst --- awscli-1.16.301/awscli/examples/redshift/delete-hsm-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/redshift/delete-hsm-configuration.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,8 @@ +**To delete an HSM configuration** + +The following ``delete-hsm-configuration`` example deletes the specified HSM configuration from the current AWS account. :: + + aws redshift delete-hsm-configuration / + --hsm-configuration-identifier myhsmconnection + +This command does not produce any output. diff -Nru awscli-1.16.301/awscli/examples/redshift/delete-scheduled-action.rst awscli-1.17.14/awscli/examples/redshift/delete-scheduled-action.rst --- awscli-1.16.301/awscli/examples/redshift/delete-scheduled-action.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/redshift/delete-scheduled-action.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,8 @@ +**To delete scheduled action** + +The following ``delete-scheduled-action`` example deletes the specified scheduled action. :: + + aws redshift delete-scheduled-action \ + --scheduled-action-name myscheduledaction + +This command does not produce any output. diff -Nru awscli-1.16.301/awscli/examples/redshift/delete-snapshot-copy-grant.rst awscli-1.17.14/awscli/examples/redshift/delete-snapshot-copy-grant.rst --- awscli-1.16.301/awscli/examples/redshift/delete-snapshot-copy-grant.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/redshift/delete-snapshot-copy-grant.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete snapshot copy grant** + +The following ``delete-snapshot-copy-grant`` example deletes the specified snapshot copy grant. :: + + aws redshift delete-snapshot-copy-grant \ + --snapshot-copy-grant-name mysnapshotcopygrantname + +This command does not produce any output. + +For more information, see `Amazon Redshift Database Encryption `__ in the *Amazon Redshift Cluster Management Guide*. diff -Nru awscli-1.16.301/awscli/examples/redshift/delete-snapshot-schedule.rst awscli-1.17.14/awscli/examples/redshift/delete-snapshot-schedule.rst --- awscli-1.16.301/awscli/examples/redshift/delete-snapshot-schedule.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/redshift/delete-snapshot-schedule.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete snapshot schedule** + +The following ``delete-snapshot-schedule`` example deletes the specified snapshot schedule. You must disassociate clusters before deleting the schedule. :: + + aws redshift delete-snapshot-schedule \ + --schedule-identifier mysnapshotschedule + +This command does not produce any output. + +For more information, see `Automated Snapshot Schedules `__ in the *Amazon Redshift Cluster Management Guide*. diff -Nru awscli-1.16.301/awscli/examples/redshift/delete-tags.rst awscli-1.17.14/awscli/examples/redshift/delete-tags.rst --- awscli-1.16.301/awscli/examples/redshift/delete-tags.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/redshift/delete-tags.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,11 @@ +**To delete tags from a cluster** + +The following ``delete-tags`` example deletes the tags with the specified key names from the specified cluster. :: + + aws redshift delete-tags \ + --resource-name arn:aws:redshift:us-west-2:123456789012:cluster:mycluster \ + --tag-keys "clustertagkey" "clustertagvalue" + +This command does not produce any output. + +For more information, see `Tagging Resources in Amazon Redshift `__ in the *Amazon Redshift Cluster Management Guide*. diff -Nru awscli-1.16.301/awscli/examples/redshift/describe-account-attributes.rst awscli-1.17.14/awscli/examples/redshift/describe-account-attributes.rst --- awscli-1.16.301/awscli/examples/redshift/describe-account-attributes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/redshift/describe-account-attributes.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,20 @@ +**To describe attributes of an AWS account** + +The following ``describe-account-attributes`` example displays the attributes attached to the calling AWS account. :: + + aws redshift describe-account-attributes + +Output:: + + { + "AccountAttributes": [ + { + "AttributeName": "max-defer-maintenance-duration", + "AttributeValues": [ + { + "AttributeValue": "45" + } + ] + } + ] + } diff -Nru awscli-1.16.301/awscli/examples/redshift/describe-cluster-db-revisions.rst awscli-1.17.14/awscli/examples/redshift/describe-cluster-db-revisions.rst --- awscli-1.16.301/awscli/examples/redshift/describe-cluster-db-revisions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/redshift/describe-cluster-db-revisions.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,19 @@ +**To describe DB revisions for a cluster** + +The following ``describe-cluster-db-revisions`` example displays the details of an array of ``ClusterDbRevision`` objects for the specified cluster. :: + + aws redshift describe-cluster-db-revisions \ + --cluster-identifier mycluster + +Output:: + + { + "ClusterDbRevisions": [ + { + "ClusterIdentifier": "mycluster", + "CurrentDatabaseRevision": "11420", + "DatabaseRevisionReleaseDate": "2019-11-22T16:43:49.597Z", + "RevisionTargets": [] + } + ] + } diff -Nru awscli-1.16.301/awscli/examples/redshift/describe-cluster-tracks.rst awscli-1.17.14/awscli/examples/redshift/describe-cluster-tracks.rst --- awscli-1.16.301/awscli/examples/redshift/describe-cluster-tracks.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/redshift/describe-cluster-tracks.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,42 @@ +**To describe cluster tracks** + +The following ``describe-cluster-tracks`` example displays details of the available maintenance tracks. :: + + aws redshift describe-cluster-tracks \ + --maintenance-track-name current + +Output:: + + { + "MaintenanceTracks": [ + { + "MaintenanceTrackName": "current", + "DatabaseVersion": "1.0.11420", + "UpdateTargets": [ + { + "MaintenanceTrackName": "preview_features", + "DatabaseVersion": "1.0.11746", + "SupportedOperations": [ + { + "OperationName": "restore-from-cluster-snapshot" + } + ] + }, + { + "MaintenanceTrackName": "trailing", + "DatabaseVersion": "1.0.11116", + "SupportedOperations": [ + { + "OperationName": "restore-from-cluster-snapshot" + }, + { + "OperationName": "modify-cluster" + } + ] + } + ] + } + ] + } + +For more information, see `Choosing Cluster Maintenance Tracks `__ in the *Amazon Redshift Cluster Management Guide*. diff -Nru awscli-1.16.301/awscli/examples/redshift/describe-event-categories.rst awscli-1.17.14/awscli/examples/redshift/describe-event-categories.rst --- awscli-1.16.301/awscli/examples/redshift/describe-event-categories.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.17.14/awscli/examples/redshift/describe-event-categories.rst 2020-02-10 19:14:32.000000000 +0000 @@ -0,0 +1,42 @@ +**To describe event categories for a cluster** + +The following ``describe-event-categories`` example displays details for the event categories for a cluster. :: + + aws redshift describe-event-categories \ + --source-type cluster + +Output:: + + { + "EventCategoriesMapList": [ + { + "SourceType": "cluster", + "Events": [ + { + "EventId": "REDSHIFT-EVENT-2000", + "EventCategories": [ + "management" + ], + "EventDescription": "Cluster created at