diff -Nru awscli-1.11.13/awscli/alias.py awscli-1.18.69/awscli/alias.py --- awscli-1.11.13/awscli/alias.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/alias.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,283 @@ +# Copyright 2016 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 logging +import os +import shlex +import subprocess + +from botocore.configloader import raw_config_parse + +from awscli.compat import compat_shell_quote +from awscli.commands import CLICommand +from awscli.utils import emit_top_level_args_parsed_event + + +LOG = logging.getLogger(__name__) + + +class InvalidAliasException(Exception): + pass + + +class AliasLoader(object): + def __init__(self, + alias_filename=os.path.expanduser( + os.path.join('~', '.aws', 'cli', 'alias'))): + """Interface for loading and interacting with alias file + + :param alias_filename: The name of the file to load aliases from. + This file must be an INI file. + """ + self._filename = alias_filename + self._aliases = None + + def _build_aliases(self): + self._aliases = self._load_aliases() + self._cleanup_alias_values(self._aliases.get('toplevel', {})) + + def _load_aliases(self): + if os.path.exists(self._filename): + return raw_config_parse( + self._filename, parse_subsections=False) + return {'toplevel': {}} + + def _cleanup_alias_values(self, aliases): + for alias in aliases: + # Beginning and end line separators should not be included + # in the internal representation of the alias value. + aliases[alias] = aliases[alias].strip() + + def get_aliases(self): + if self._aliases is None: + self._build_aliases() + return self._aliases.get('toplevel', {}) + + +class AliasCommandInjector(object): + def __init__(self, session, alias_loader): + """Injects alias commands for a command table + + :type session: botocore.session.Session + :param session: The botocore session + + :type alias_loader: awscli.alias.AliasLoader + :param alias_loader: The alias loader to use + """ + self._session = session + self._alias_loader = alias_loader + + def inject_aliases(self, command_table, parser): + for alias_name, alias_value in \ + self._alias_loader.get_aliases().items(): + if alias_value.startswith('!'): + alias_cmd = ExternalAliasCommand(alias_name, alias_value) + else: + service_alias_cmd_args = [ + alias_name, alias_value, self._session, command_table, + parser + ] + # If the alias name matches something already in the + # command table provide the command it is about + # to clobber as a possible reference that it will + # need to proxy to. + if alias_name in command_table: + service_alias_cmd_args.append( + command_table[alias_name]) + alias_cmd = ServiceAliasCommand(*service_alias_cmd_args) + command_table[alias_name] = alias_cmd + + +class BaseAliasCommand(CLICommand): + _UNDOCUMENTED = True + + def __init__(self, alias_name, alias_value): + """Base class for alias command + + :type alias_name: string + :param alias_name: The name of the alias + + :type alias_value: string + :param alias_value: The parsed value of the alias. This can be + retrieved from `AliasLoader.get_aliases()[alias_name]` + """ + self._alias_name = alias_name + self._alias_value = alias_value + + def __call__(self, args, parsed_args): + raise NotImplementedError('__call__') + + @property + def name(self): + return self._alias_name + + @name.setter + def name(self, value): + self._alias_name = value + + +class ServiceAliasCommand(BaseAliasCommand): + UNSUPPORTED_GLOBAL_PARAMETERS = [ + 'debug', + 'profile' + ] + + def __init__(self, alias_name, alias_value, session, command_table, + parser, shadow_proxy_command=None): + """Command for a `toplevel` subcommand alias + + :type alias_name: string + :param alias_name: The name of the alias + + :type alias_value: string + :param alias_value: The parsed value of the alias. This can be + retrieved from `AliasLoader.get_aliases()[alias_name]` + + :type session: botocore.session.Session + :param session: The botocore session + + :type command_table: dict + :param command_table: The command table containing all of the + possible service command objects that a particular alias could + redirect to. + + :type parser: awscli.argparser.MainArgParser + :param parser: The parser to parse commands provided at the top level + of a CLI command which includes service commands and global + parameters. This is used to parse the service commmand and any + global parameters from the alias's value. + + :type shadow_proxy_command: CLICommand + :param shadow_proxy_command: A built-in command that + potentially shadows the alias in name. If the alias + references this command in its value, the alias should proxy + to this command as oppposed to proxy to itself in the command + table + """ + super(ServiceAliasCommand, self).__init__(alias_name, alias_value) + self._session = session + self._command_table = command_table + self._parser = parser + self._shadow_proxy_command = shadow_proxy_command + + def __call__(self, args, parsed_globals): + alias_args = self._get_alias_args() + parsed_alias_args, remaining = self._parser.parse_known_args( + alias_args) + self._update_parsed_globals(parsed_alias_args, parsed_globals) + # Take any of the remaining arguments that were not parsed out and + # prepend them to the remaining args provided to the alias. + remaining.extend(args) + LOG.debug( + 'Alias %r passing on arguments: %r to %r command', + self._alias_name, remaining, parsed_alias_args.command) + # Pass the update remaing args and global args to the service command + # the alias proxied to. + command = self._command_table[parsed_alias_args.command] + if self._shadow_proxy_command: + shadow_name = self._shadow_proxy_command.name + # Use the shadow command only if the aliases value + # uses that command indicating it needs to proxy over to + # a built-in command. + if shadow_name == parsed_alias_args.command: + LOG.debug( + 'Using shadowed command object: %s ' + 'for alias: %s', self._shadow_proxy_command, + self._alias_name + ) + command = self._shadow_proxy_command + return command(remaining, parsed_globals) + + def _get_alias_args(self): + try: + alias_args = shlex.split(self._alias_value) + except ValueError as e: + raise InvalidAliasException( + 'Value of alias "%s" could not be parsed. ' + 'Received error: %s when parsing:\n%s' % ( + self._alias_name, e, self._alias_value) + ) + + alias_args = [arg.strip(os.linesep) for arg in alias_args] + LOG.debug( + 'Expanded subcommand alias %r with value: %r to: %r', + self._alias_name, self._alias_value, alias_args + ) + return alias_args + + def _update_parsed_globals(self, parsed_alias_args, parsed_globals): + global_params_to_update = self._get_global_parameters_to_update( + parsed_alias_args) + # Emit the top level args parsed event to ensure all possible + # customizations that typically get applied are applied to the + # global parameters provided in the alias before updating + # the original provided global parameter values + # and passing those onto subsequent commands. + emit_top_level_args_parsed_event(self._session, parsed_alias_args) + for param_name in global_params_to_update: + updated_param_value = getattr(parsed_alias_args, param_name) + setattr(parsed_globals, param_name, updated_param_value) + + def _get_global_parameters_to_update(self, parsed_alias_args): + # Retrieve a list of global parameters that the newly parsed args + # from the alias will have to clobber from the originally provided + # parsed globals. + global_params_to_update = [] + for parsed_param, value in vars(parsed_alias_args).items(): + # To determine which parameters in the alias were global values + # compare the parsed alias parameters to the default as + # specified by the parser. If the parsed values from the alias + # differs from the default value in the parser, + # that global parameter must have been provided in the alias. + if self._parser.get_default(parsed_param) != value: + if parsed_param in self.UNSUPPORTED_GLOBAL_PARAMETERS: + raise InvalidAliasException( + 'Global parameter "--%s" detected in alias "%s" ' + 'which is not support in subcommand aliases.' % ( + parsed_param, self._alias_name)) + else: + global_params_to_update.append(parsed_param) + return global_params_to_update + + +class ExternalAliasCommand(BaseAliasCommand): + def __init__(self, alias_name, alias_value, invoker=subprocess.call): + """Command for external aliases + + Executes command external of CLI as opposed to being a proxy + to another command. + + :type alias_name: string + :param alias_name: The name of the alias + + :type alias_value: string + :param alias_value: The parsed value of the alias. This can be + retrieved from `AliasLoader.get_aliases()[alias_name]` + + :type invoker: callable + :param invoker: Callable to run arguments of external alias. The + signature should match that of ``subprocess.call`` + """ + self._alias_name = alias_name + self._alias_value = alias_value + self._invoker = invoker + + def __call__(self, args, parsed_globals): + command_components = [ + self._alias_value[1:] + ] + command_components.extend(compat_shell_quote(a) for a in args) + command = ' '.join(command_components) + LOG.debug( + 'Using external alias %r with value: %r to run: %r', + self._alias_name, self._alias_value, command) + return self._invoker(command, shell=True) diff -Nru awscli-1.11.13/awscli/argparser.py awscli-1.18.69/awscli/argparser.py --- awscli-1.11.13/awscli/argparser.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/argparser.py 2020-05-28 19:25:48.000000000 +0000 @@ -29,6 +29,35 @@ ) +class CommandAction(argparse.Action): + """Custom action for CLI command arguments + + Allows the choices for the argument to be mutable. The choices + are dynamically retrieved from the keys of the referenced command + table + """ + def __init__(self, option_strings, dest, command_table, **kwargs): + self.command_table = command_table + super(CommandAction, self).__init__( + option_strings, dest, choices=self.choices, **kwargs + ) + + def __call__(self, parser, namespace, values, option_string=None): + setattr(namespace, self.dest, values) + + @property + def choices(self): + return list(self.command_table.keys()) + + @choices.setter + def choices(self, val): + # argparse.Action will always try to set this value upon + # instantiation, but this value should be dynamically + # generated from the command table keys. So make this a + # NOOP if argparse.Action tries to set this value. + pass + + class CLIArgParser(argparse.ArgumentParser): Formatter = argparse.RawTextHelpFormatter @@ -84,13 +113,14 @@ Formatter = argparse.RawTextHelpFormatter def __init__(self, command_table, version_string, - description, argument_table): + description, argument_table, prog=None): super(MainArgParser, self).__init__( formatter_class=self.Formatter, add_help=False, conflict_handler='resolve', description=description, - usage=USAGE) + usage=USAGE, + prog=prog) self._build(command_table, version_string, argument_table) def _create_choice_help(self, choices): @@ -106,7 +136,8 @@ self.add_argument('--version', action="version", version=version_string, help='Display the version of this tool') - self.add_argument('command', choices=list(command_table.keys())) + self.add_argument('command', action=CommandAction, + command_table=command_table) class ServiceArgParser(CLIArgParser): @@ -121,7 +152,8 @@ self._service_name = service_name def _build(self, operations_table): - self.add_argument('operation', choices=list(operations_table.keys())) + self.add_argument('operation', action=CommandAction, + command_table=operations_table) class ArgTableArgParser(CLIArgParser): @@ -145,8 +177,8 @@ argument = argument_table[arg_name] argument.add_to_parser(self) if command_table: - self.add_argument('subcommand', choices=list(command_table.keys()), - nargs='?') + self.add_argument('subcommand', action=CommandAction, + command_table=command_table, nargs='?') def parse_known_args(self, args, namespace=None): if len(args) == 1 and args[0] == 'help': diff -Nru awscli-1.11.13/awscli/argprocess.py awscli-1.18.69/awscli/argprocess.py --- awscli-1.11.13/awscli/argprocess.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/argprocess.py 2020-05-28 19:25:48.000000000 +0000 @@ -18,11 +18,9 @@ from botocore.compat import OrderedDict, json from awscli import SCALAR_TYPES, COMPLEX_TYPES -from awscli.paramfile import get_paramfile, ResourceLoadingError -from awscli.paramfile import PARAMFILE_DISABLED from awscli import shorthand from awscli.utils import find_service_and_method_in_event_name - +from botocore.utils import is_json_value_header LOG = logging.getLogger('awscli.argprocess') @@ -88,27 +86,6 @@ return value -def uri_param(event_name, param, value, **kwargs): - """Handler that supports param values from URIs. - """ - cli_argument = param - qualified_param_name = '.'.join(event_name.split('.')[1:]) - if qualified_param_name in PARAMFILE_DISABLED or \ - getattr(cli_argument, 'no_paramfile', None): - return - else: - return _check_for_uri_param(cli_argument, value) - - -def _check_for_uri_param(param, value): - if isinstance(value, list) and len(value) == 1: - value = value[0] - try: - return get_paramfile(value) - except ResourceLoadingError as e: - raise ParamError(param.cli_name, six.text_type(e)) - - def detect_shape_structure(param): stack = [] return _detect_shape_structure(param, stack) @@ -166,8 +143,19 @@ cli_argument.cli_name) +def _special_type(model): + # check if model is jsonvalue header and that value is serializable + if model.serialization.get('jsonvalue') and \ + model.serialization.get('location') == 'header' and \ + model.type_name == 'string': + return True + return False + + def _unpack_cli_arg(argument_model, value, cli_name): - if argument_model.type_name in SCALAR_TYPES: + if is_json_value_header(argument_model): + return _unpack_json_cli_arg(argument_model, value, cli_name) + elif argument_model.type_name in SCALAR_TYPES: return unpack_scalar_cli_arg( argument_model, value, cli_name) elif argument_model.type_name in COMPLEX_TYPES: @@ -177,6 +165,15 @@ return six.text_type(value) +def _unpack_json_cli_arg(argument_model, value, cli_name): + try: + return json.loads(value, object_pairs_hook=OrderedDict) + except ValueError as e: + raise ParamError( + cli_name, "Invalid JSON: %s\nJSON received: %s" + % (e, value)) + + def _unpack_complex_cli_arg(argument_model, value, cli_name): type_name = argument_model.type_name if type_name == 'structure' or type_name == 'map': @@ -248,7 +245,7 @@ class ParamShorthand(object): - def _uses_old_list_case(self, service_name, operation_name, argument_name): + def _uses_old_list_case(self, service_id, operation_name, argument_name): """ Determines whether a given operation for a service needs to use the deprecated shorthand parsing case for lists of structures that only have @@ -263,14 +260,14 @@ 'rebuild-workspaces': ['rebuild-workspace-requests'], 'terminate-workspaces': ['terminate-workspace-requests'] }, - 'elb': { + 'elastic-load-balancing': { 'remove-tags': ['tags'], 'describe-instance-health': ['instances'], 'deregister-instances-from-load-balancer': ['instances'], 'register-instances-with-load-balancer': ['instances'] } } - cases = cases.get(service_name, {}).get(operation_name, []) + cases = cases.get(service_id, {}).get(operation_name, []) return argument_name in cases @@ -311,18 +308,18 @@ if not self._should_parse_as_shorthand(cli_argument, value): return else: - service_name, operation_name = \ + service_id, operation_name = \ find_service_and_method_in_event_name(event_name) return self._parse_as_shorthand( - cli_argument, value, service_name, operation_name) + cli_argument, value, service_id, operation_name) - def _parse_as_shorthand(self, cli_argument, value, service_name, + def _parse_as_shorthand(self, cli_argument, value, service_id, operation_name): try: LOG.debug("Parsing param %s as shorthand", cli_argument.cli_name) handled_value = self._handle_special_cases( - cli_argument, value, service_name, operation_name) + cli_argument, value, service_id, operation_name) if handled_value is not None: return handled_value if isinstance(value, list): @@ -341,13 +338,13 @@ raise ParamError(cli_argument.cli_name, str(e)) except (ParamError, ParamUnknownKeyError) as e: # The shorthand parse methods don't have the cli_name, - # so any ParamError won't have this value. To accomodate + # so any ParamError won't have this value. To accommodate # this, ParamErrors are caught and reraised with the cli_name # injected. raise ParamError(cli_argument.cli_name, str(e)) return parsed - def _handle_special_cases(self, cli_argument, value, service_name, + def _handle_special_cases(self, cli_argument, value, service_id, operation_name): # We need to handle a few special cases that the previous # parser handled in order to stay backwards compatible. @@ -355,7 +352,7 @@ if model.type_name == 'list' and \ model.member.type_name == 'structure' and \ len(model.member.members) == 1 and \ - self._uses_old_list_case(service_name, operation_name, cli_argument.name): + self._uses_old_list_case(service_id, operation_name, cli_argument.name): # First special case is handling a list of structures # of a single element such as: # @@ -414,7 +411,7 @@ return _is_complex_shape(argument_model) return False - def generate_shorthand_example(self, cli_argument, service_name, + def generate_shorthand_example(self, cli_argument, service_id, operation_name): """Generate documentation for a CLI argument. @@ -430,7 +427,7 @@ """ docstring = self._handle_special_cases( - cli_argument, service_name, operation_name) + cli_argument, service_id, operation_name) if docstring is self._DONT_DOC: return None elif docstring: @@ -448,14 +445,18 @@ except TooComplexError: return '' - def _handle_special_cases(self, cli_argument, service_name, operation_name): + def _handle_special_cases(self, cli_argument, service_id, operation_name): model = cli_argument.argument_model if model.type_name == 'list' and \ model.member.type_name == 'structure' and \ len(model.member.members) == 1 and \ self._uses_old_list_case( - service_name, operation_name, cli_argument.name): + service_id, operation_name, cli_argument.name): member_name = list(model.member.members)[0] + # Handle special case where the min/max is exactly one. + metadata = model.metadata + if metadata.get('min') == 1 and metadata.get('max') == 1: + return '%s %s1' % (cli_argument.cli_name, member_name) return '%s %s1 %s2 %s3' % (cli_argument.cli_name, member_name, member_name, member_name) elif model.type_name == 'structure' and \ diff -Nru awscli-1.11.13/awscli/clidocs.py awscli-1.18.69/awscli/clidocs.py --- awscli-1.11.13/awscli/clidocs.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/clidocs.py 2020-05-28 19:25:48.000000000 +0000 @@ -15,6 +15,7 @@ from botocore import xform_name from botocore.docs.bcdoc.docevents import DOC_EVENTS from botocore.model import StringShape +from botocore.utils import is_json_value_header from awscli import SCALAR_TYPES from awscli.argprocess import ParamShorthandDocGen @@ -29,7 +30,6 @@ def __init__(self, help_command): self.help_command = help_command self.register(help_command.session, help_command.event_class) - self.help_command.doc.translation_map = self.build_translation_map() self._arg_groups = self._build_arg_table_groups(help_command) self._documented_arg_groups = [] @@ -40,8 +40,10 @@ arg_groups.setdefault(arg.group_name, []).append(arg) return arg_groups - def build_translation_map(self): - return dict() + def _get_argument_type_name(self, shape, default): + if is_json_value_header(shape): + return 'JSON' + return default def _map_handlers(self, session, event_class, mapfn): for event in DOC_EVENTS: @@ -160,7 +162,8 @@ self._documented_arg_groups.append(argument.group_name) else: name = '``%s``' % argument.cli_name - doc.write('%s (%s)\n' % (name, argument.cli_type_name)) + doc.write('%s (%s)\n' % (name, self._get_argument_type_name( + argument.argument_model, argument.cli_type_name))) doc.style.indent() doc.include_doc_string(argument.documentation) self._document_enums(argument, doc) @@ -242,13 +245,6 @@ class ServiceDocumentEventHandler(CLIDocumentEventHandler): - def build_translation_map(self): - d = {} - service_model = self.help_command.obj - for operation_name in service_model.operation_names: - d[operation_name] = xform_name(operation_name, '-') - return d - # A service document has no synopsis. def doc_synopsis_start(self, help_command, **kwargs): pass @@ -300,36 +296,41 @@ class OperationDocumentEventHandler(CLIDocumentEventHandler): - def build_translation_map(self): - operation_model = self.help_command.obj - d = {} - for cli_name, cli_argument in self.help_command.arg_table.items(): - if cli_argument.argument_model is not None: - argument_name = cli_argument.argument_model.name - if argument_name in d: - previous_mapping = d[argument_name] - # If the argument name is a boolean argument, we want the - # the translation to default to the one that does not start - # with --no-. So we check if the cli parameter currently - # being used starts with no- and if stripping off the no- - # results in the new proposed cli argument name. If it - # does, we assume we have the postive form of the argument - # which is the name we want to use in doc translations. - if cli_argument.cli_type_name == 'boolean' and \ - previous_mapping.startswith('no-') and \ - cli_name == previous_mapping[3:]: - d[argument_name] = cli_name - else: - d[argument_name] = cli_name - for operation_name in operation_model.service_model.operation_names: - d[operation_name] = xform_name(operation_name, '-') - return d + AWS_DOC_BASE = 'https://docs.aws.amazon.com/goto/WebAPI' def doc_description(self, help_command, **kwargs): doc = help_command.doc operation_model = help_command.obj doc.style.h2('Description') doc.include_doc_string(operation_model.documentation) + self._add_webapi_crosslink(help_command) + self._add_top_level_args_reference(help_command) + + def _add_top_level_args_reference(self, help_command): + help_command.doc.writeln('') + help_command.doc.write("See ") + help_command.doc.style.internal_link( + title="'aws help'", + page='/reference/index' + ) + help_command.doc.writeln(' for descriptions of global parameters.') + + def _add_webapi_crosslink(self, help_command): + doc = help_command.doc + operation_model = help_command.obj + service_model = operation_model.service_model + service_uid = service_model.metadata.get('uid') + if service_uid is None: + # If there's no service_uid in the model, we can't + # be certain if the generated cross link will work + # so we don't generate any crosslink info. + return + doc.style.new_paragraph() + doc.write("See also: ") + link = '%s/%s/%s' % (self.AWS_DOC_BASE, service_uid, + operation_model.name) + doc.style.external_link(title="AWS API Documentation", link=link) + doc.writeln('') def _json_example_value_name(self, argument_model, include_enum_values=True): # If include_enum_values is True, then the valid enum values @@ -389,12 +390,12 @@ doc.style.dedent() doc.write('}') elif argument_model.type_name == 'structure': - doc.write('{') - doc.style.indent() - doc.style.new_line() self._doc_input_structure_members(doc, argument_model, stack) def _doc_input_structure_members(self, doc, argument_model, stack): + doc.write('{') + doc.style.indent() + doc.style.new_line() members = argument_model.members for i, member_name in enumerate(members): member_model = members[member_name] @@ -414,13 +415,12 @@ if i < len(members) - 1: doc.write(',') doc.style.new_line() - else: - doc.style.dedent() - doc.style.new_line() + doc.style.dedent() + doc.style.new_line() doc.write('}') def doc_option_example(self, arg_name, help_command, event_name, **kwargs): - service_name, operation_name = \ + service_id, operation_name = \ find_service_and_method_in_event_name(event_name) doc = help_command.doc cli_argument = help_command.arg_table[arg_name] @@ -433,7 +433,7 @@ docgen = ParamShorthandDocGen() if docgen.supports_shorthand(cli_argument.argument_model): example_shorthand_syntax = docgen.generate_shorthand_example( - cli_argument, service_name, operation_name) + cli_argument, service_id, operation_name) if example_shorthand_syntax is None: # If the shorthand syntax returns a value of None, # this indicates to us that there is no example @@ -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(): @@ -511,7 +511,8 @@ def _do_doc_member_for_output(self, doc, member_name, member_shape, stack): docs = member_shape.documentation if member_name: - doc.write('%s -> (%s)' % (member_name, member_shape.type_name)) + doc.write('%s -> (%s)' % (member_name, self._get_argument_type_name( + member_shape, member_shape.type_name))) else: doc.write('(%s)' % member_shape.type_name) doc.style.indent() @@ -534,6 +535,9 @@ doc.style.dedent() doc.style.new_paragraph() + def doc_options_end(self, help_command, **kwargs): + self._add_top_level_args_reference(help_command) + class TopicListerDocumentEventHandler(CLIDocumentEventHandler): DESCRIPTION = ( @@ -547,7 +551,6 @@ def __init__(self, help_command): self.help_command = help_command self.register(help_command.session, help_command.event_class) - self.help_command.doc.translation_map = self.build_translation_map() self._topic_tag_db = TopicTagDB() self._topic_tag_db.load_json_index() diff -Nru awscli-1.11.13/awscli/clidriver.py awscli-1.18.69/awscli/clidriver.py --- awscli-1.11.13/awscli/clidriver.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/clidriver.py 2020-05-28 19:25:48.000000000 +0000 @@ -21,10 +21,14 @@ from botocore.compat import copy_kwargs, OrderedDict from botocore.exceptions import NoCredentialsError from botocore.exceptions import NoRegionError +from botocore.history import get_global_history_recorder from awscli import EnvironmentVariables, __version__ +from awscli.compat import get_stderr_text_writer from awscli.formatter import get_formatter from awscli.plugin import load_plugins +from awscli.commands import CLICommand +from awscli.compat import six from awscli.argparser import MainArgParser from awscli.argparser import ServiceArgParser from awscli.argparser import ArgTableArgParser @@ -38,24 +42,40 @@ from awscli.arguments import CLIArgument from awscli.arguments import UnknownArgumentError from awscli.argprocess import unpack_argument +from awscli.alias import AliasLoader +from awscli.alias import AliasCommandInjector +from awscli.utils import emit_top_level_args_parsed_event +from awscli.utils import write_exception LOG = logging.getLogger('awscli.clidriver') LOG_FORMAT = ( '%(asctime)s - %(threadName)s - %(name)s - %(levelname)s - %(message)s') +HISTORY_RECORDER = get_global_history_recorder() +# Don't remove this line. The idna encoding +# is used by getaddrinfo when dealing with unicode hostnames, +# and in some cases, there appears to be a race condition +# where threads will get a LookupError on getaddrinfo() saying +# that the encoding doesn't exist. Using the idna encoding before +# running any CLI code (and any threads it may create) ensures that +# the encodings.idna is imported and registered in the codecs registry, +# which will stop the LookupErrors from happening. +# See: https://bugs.python.org/issue29288 +u''.encode('idna') def main(): driver = create_clidriver() - return driver.main() + rc = driver.main() + HISTORY_RECORDER.record('CLI_RC', rc, 'CLI') + return rc def create_clidriver(): - emitter = HierarchicalEmitter() - session = botocore.session.Session(EnvironmentVariables, emitter) + session = botocore.session.Session(EnvironmentVariables) _set_user_agent_for_session(session) load_plugins(session.full_config.get('plugins', {}), - event_hooks=emitter) + event_hooks=session.get_component('event_emitter')) driver = CLIDriver(session=session) return driver @@ -77,6 +97,7 @@ self._cli_data = None self._command_table = None self._argument_table = None + self.alias_loader = AliasLoader() def _get_cli_data(self): # Not crazy about this but the data in here is needed in @@ -120,6 +141,12 @@ service_name=service_name) return commands + def _add_aliases(self, command_table, parser): + parser = self._create_parser(command_table) + injector = AliasCommandInjector( + self.session, self.alias_loader) + injector.inject_aliases(command_table, parser) + def _build_argument_table(self): argument_table = OrderedDict() cli_data = self._get_cli_data() @@ -152,15 +179,15 @@ cli_data.get('synopsis', None), cli_data.get('help_usage', None)) - def _create_parser(self): + def _create_parser(self, command_table): # Also add a 'help' command. - command_table = self._get_command_table() command_table['help'] = self.create_help_command() cli_data = self._get_cli_data() parser = MainArgParser( command_table, self.session.user_agent(), cli_data.get('description', None), - self._get_argument_table()) + self._get_argument_table(), + prog="aws") return parser def main(self, args=None): @@ -173,8 +200,9 @@ """ if args is None: args = sys.argv[1:] - parser = self._create_parser() command_table = self._get_command_table() + parser = self._create_parser(command_table) + self._add_aliases(command_table, parser) parsed_args, remaining = parser.parse_known_args(args) try: # Because _handle_top_level_args emits events, it's possible @@ -182,7 +210,10 @@ # general exception handling logic as calling into the # command table. This is why it's in the try/except clause. self._handle_top_level_args(parsed_args) - self._emit_session_event() + self._emit_session_event(parsed_args) + HISTORY_RECORDER.record( + 'CLI_VERSION', self.session.user_agent(), 'CLI') + HISTORY_RECORDER.record('CLI_ARGUMENTS', args, 'CLI') return command_table[parsed_args.command](remaining, parsed_args) except UnknownArgumentError as e: sys.stderr.write("usage: %s\n" % USAGE) @@ -208,17 +239,18 @@ except Exception as e: LOG.debug("Exception caught in main()", exc_info=True) LOG.debug("Exiting with rc 255") - sys.stderr.write("\n") - sys.stderr.write("%s\n" % e) + write_exception(e, outfile=get_stderr_text_writer()) return 255 - def _emit_session_event(self): + def _emit_session_event(self, parsed_args): # This event is guaranteed to run after the session has been # initialized and a profile has been set. This was previously # problematic because if something in CLIDriver caused the # session components to be reset (such as session.profile = foo) # then all the prior registered components would be removed. - self.session.emit('session-initialized', session=self.session) + self.session.emit( + 'session-initialized', session=self.session, + parsed_args=parsed_args) def _show_error(self, msg): LOG.debug(msg, exc_info=True) @@ -226,10 +258,11 @@ sys.stderr.write('\n') def _handle_top_level_args(self, args): - self.session.emit( - 'top-level-args-parsed', parsed_args=args, session=self.session) + emit_top_level_args_parsed_event(self.session, args) if args.profile: self.session.set_config_variable('profile', args.profile) + if args.region: + self.session.set_config_variable('region', args.region) if args.debug: # TODO: # Unfortunately, by setting debug mode here, we miss out @@ -241,6 +274,8 @@ format_string=LOG_FORMAT) self.session.set_stream_logger('s3transfer', logging.DEBUG, format_string=LOG_FORMAT) + self.session.set_stream_logger('urllib3', logging.DEBUG, + format_string=LOG_FORMAT) LOG.debug("CLI version: %s", self.session.user_agent()) LOG.debug("Arguments entered to CLI: %s", sys.argv[1:]) @@ -249,64 +284,6 @@ log_level=logging.ERROR) -class CLICommand(object): - - """Interface for a CLI command. - - This class represents a top level CLI command - (``aws ec2``, ``aws s3``, ``aws config``). - - """ - - @property - def name(self): - # Subclasses must implement a name. - raise NotImplementedError("name") - - @name.setter - def name(self, value): - # Subclasses must implement setting/changing the cmd name. - raise NotImplementedError("name") - - @property - def lineage(self): - # Represents how to get to a specific command using the CLI. - # It includes all commands that came before it and itself in - # a list. - return [self] - - @property - def lineage_names(self): - # Represents the lineage of a command in terms of command ``name`` - return [cmd.name for cmd in self.lineage] - - def __call__(self, args, parsed_globals): - """Invoke CLI operation. - - :type args: str - :param args: The remaining command line args. - - :type parsed_globals: ``argparse.Namespace`` - :param parsed_globals: The parsed arguments so far. - - :rtype: int - :return: The return code of the operation. This will be used - as the RC code for the ``aws`` process. - - """ - # Subclasses are expected to implement this method. - pass - - def create_help_command(self): - # Subclasses are expected to implement this method if they want - # help docs. - return None - - @property - def arg_table(self): - return {} - - class ServiceCommand(CLICommand): """A service command for the CLI. @@ -468,6 +445,8 @@ self._lineage = [self] self._operation_model = operation_model self._session = session + if operation_model.deprecated: + self._UNDOCUMENTED = True @property def name(self): @@ -600,7 +579,8 @@ cli_arg_name = xform_name(arg_name, '-') arg_class = self.ARG_TYPES.get(arg_shape.type_name, self.DEFAULT_ARG_CLASS) - is_required = arg_name in required_arguments + is_token = arg_shape.metadata.get('idempotencyToken', False) + is_required = arg_name in required_arguments and not is_token event_emitter = self._session.get_component('event_emitter') arg_object = arg_class( name=cli_arg_name, @@ -666,6 +646,13 @@ service_name, region_name=parsed_globals.region, endpoint_url=parsed_globals.endpoint_url, verify=parsed_globals.verify_ssl) + response = self._make_client_call( + client, operation_name, parameters, parsed_globals) + self._display_response(operation_name, response, parsed_globals) + return 0 + + def _make_client_call(self, client, operation_name, parameters, + parsed_globals): py_operation_name = xform_name(operation_name) if client.can_paginate(py_operation_name) and parsed_globals.paginate: paginator = client.get_paginator(py_operation_name) @@ -673,8 +660,7 @@ else: response = getattr(client, xform_name(operation_name))( **parameters) - self._display_response(operation_name, response, parsed_globals) - return 0 + return response def _display_response(self, command_name, response, parsed_globals): diff -Nru awscli-1.11.13/awscli/commands.py awscli-1.18.69/awscli/commands.py --- awscli-1.11.13/awscli/commands.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/commands.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,70 @@ +# Copyright 2016 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. + + +class CLICommand(object): + + """Interface for a CLI command. + + This class represents a top level CLI command + (``aws ec2``, ``aws s3``, ``aws config``). + + """ + + @property + def name(self): + # Subclasses must implement a name. + raise NotImplementedError("name") + + @name.setter + def name(self, value): + # Subclasses must implement setting/changing the cmd name. + raise NotImplementedError("name") + + @property + def lineage(self): + # Represents how to get to a specific command using the CLI. + # It includes all commands that came before it and itself in + # a list. + return [self] + + @property + def lineage_names(self): + # Represents the lineage of a command in terms of command ``name`` + return [cmd.name for cmd in self.lineage] + + def __call__(self, args, parsed_globals): + """Invoke CLI operation. + + :type args: str + :param args: The remaining command line args. + + :type parsed_globals: ``argparse.Namespace`` + :param parsed_globals: The parsed arguments so far. + + :rtype: int + :return: The return code of the operation. This will be used + as the RC code for the ``aws`` process. + + """ + # Subclasses are expected to implement this method. + pass + + def create_help_command(self): + # Subclasses are expected to implement this method if they want + # help docs. + return None + + @property + def arg_table(self): + return {} diff -Nru awscli-1.11.13/awscli/compat.py awscli-1.18.69/awscli/compat.py --- awscli-1.11.13/awscli/compat.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/compat.py 2020-05-28 19:25:48.000000000 +0000 @@ -11,12 +11,20 @@ # 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 +import platform import zipfile +import signal +import contextlib from botocore.compat import six #import botocore.compat +from botocore.compat import OrderedDict + # If you ever want to import from the vendored six. Add it here and then # import from awscli.compat. Also try to keep it in alphabetical order. # This may get large. @@ -25,7 +33,9 @@ queue = six.moves.queue shlex_quote = six.moves.shlex_quote StringIO = six.StringIO +BytesIO = six.BytesIO urlopen = six.moves.urllib.request.urlopen +binary_type = six.binary_type # Most, but not all, python installations will have zlib. This is required to # compress any files we send via a push. If we can't compress, we can still @@ -37,6 +47,29 @@ ZIP_COMPRESSION_MODE = zipfile.ZIP_STORED +try: + import sqlite3 +except ImportError: + sqlite3 = None + + +is_windows = sys.platform == 'win32' + + +if is_windows: + default_pager = 'more' +else: + default_pager = 'less -R' + + +class StdinMissingError(Exception): + def __init__(self): + message = ( + 'stdin is required for this operation, but is not available.' + ) + super(StdinMissingError, self).__init__(message) + + class NonTranslatedStdout(object): """ This context manager sets the line-end translation mode for stdout. @@ -58,7 +91,16 @@ msvcrt.setmode(sys.stdout.fileno(), self.previous_mode) +def ensure_text_type(s): + if isinstance(s, six.text_type): + return s + if isinstance(s, six.binary_type): + return s.decode('utf-8') + raise ValueError("Expected str, unicode or bytes, received %s." % type(s)) + + if six.PY3: + import collections.abc as collections_abc import locale import urllib.parse as urlparse @@ -66,10 +108,16 @@ raw_input = input - binary_stdin = sys.stdin.buffer + def get_binary_stdin(): + if sys.stdin is None: + raise StdinMissingError() + return sys.stdin.buffer - def get_stdout_text_writer(): - return sys.stdout + def get_binary_stdout(): + return sys.stdout.buffer + + def _get_text_writer(stream, errors): + return stream def compat_open(filename, mode='r', encoding=None): """Back-port open() that accepts an encoding argument. @@ -102,6 +150,7 @@ else: import codecs + import collections as collections_abc import locale import io import urlparse @@ -110,20 +159,38 @@ raw_input = raw_input - binary_stdin = sys.stdin + def get_binary_stdin(): + if sys.stdin is None: + raise StdinMissingError() + return sys.stdin - def get_stdout_text_writer(): + def get_binary_stdout(): + return sys.stdout + + def _get_text_writer(stream, errors): # In python3, all the sys.stdout/sys.stderr streams are in text # mode. This means they expect unicode, and will encode the # unicode automatically before actually writing to stdout/stderr. # In python2, that's not the case. In order to provide a consistent # interface, we can create a wrapper around sys.stdout that will take # unicode, and automatically encode it to the preferred encoding. - # That way consumers can just call get_stdout_text_writer() and write - # unicode to the returned stream. Note that get_stdout_text_writer - # just returns sys.stdout in the PY3 section above because python3 + # That way consumers can just call get_text_writer(stream) and write + # unicode to the returned stream. Note that get_text_writer + # just returns the stream in the PY3 section above because python3 # handles this. - return codecs.getwriter(locale.getpreferredencoding())(sys.stdout) + + # We're going to use the preferred encoding, but in cases that there is + # no preferred encoding we're going to fall back to assuming ASCII is + # what we should use. This will currently break the use of + # PYTHONIOENCODING, which would require checking stream.encoding first, + # however, the existing behavior is to only use + # locale.getpreferredencoding() and so in the hope of not breaking what + # is currently working, we will continue to only use that. + encoding = locale.getpreferredencoding() + if encoding is None: + encoding = "ascii" + + return codecs.getwriter(encoding)(stream, errors) def compat_open(filename, mode='r', encoding=None): # See docstring for compat_open in the PY3 section above. @@ -138,6 +205,14 @@ stdout.write(statement) +def get_stdout_text_writer(): + return _get_text_writer(sys.stdout, errors="strict") + + +def get_stderr_text_writer(): + return _get_text_writer(sys.stderr, errors="replace") + + def compat_input(prompt): """ Cygwin's pty's are based on pipes. Therefore, when it interacts with a Win32 @@ -153,3 +228,300 @@ sys.stdout.write(prompt) sys.stdout.flush() return raw_input() + + +def compat_shell_quote(s, platform=None): + """Return a shell-escaped version of the string *s* + + Unfortunately `shlex.quote` doesn't support Windows, so this method + provides that functionality. + """ + if platform is None: + platform = sys.platform + + if platform == "win32": + return _windows_shell_quote(s) + else: + return shlex_quote(s) + + +def _windows_shell_quote(s): + """Return a Windows shell-escaped version of the string *s* + + Windows has potentially bizarre rules depending on where you look. When + spawning a process via the Windows C runtime the rules are as follows: + + https://docs.microsoft.com/en-us/cpp/cpp/parsing-cpp-command-line-arguments + + To summarize the relevant bits: + + * Only space and tab are valid delimiters + * Double quotes are the only valid quotes + * Backslash is interpreted literally unless it is part of a chain that + leads up to a double quote. Then the backslashes escape the backslashes, + and if there is an odd number the final backslash escapes the quote. + + :param s: A string to escape + :return: An escaped string + """ + if not s: + return '""' + + buff = [] + num_backspaces = 0 + for character in s: + if character == '\\': + # We can't simply append backslashes because we don't know if + # they will need to be escaped. Instead we separately keep track + # of how many we've seen. + num_backspaces += 1 + elif character == '"': + if num_backspaces > 0: + # The backslashes are part of a chain that lead up to a + # double quote, so they need to be escaped. + buff.append('\\' * (num_backspaces * 2)) + num_backspaces = 0 + + # The double quote also needs to be escaped. The fact that we're + # seeing it at all means that it must have been escaped in the + # original source. + buff.append('\\"') + else: + if num_backspaces > 0: + # The backslashes aren't part of a chain leading up to a + # double quote, so they can be inserted directly without + # being escaped. + buff.append('\\' * num_backspaces) + num_backspaces = 0 + buff.append(character) + + # There may be some leftover backspaces if they were on the trailing + # end, so they're added back in here. + if num_backspaces > 0: + buff.append('\\' * num_backspaces) + + new_s = ''.join(buff) + if ' ' in new_s or '\t' in new_s: + # If there are any spaces or tabs then the string needs to be double + # quoted. + return '"%s"' % new_s + return new_s + + +def get_popen_kwargs_for_pager_cmd(pager_cmd=None): + """Returns the default pager to use dependent on platform + + :rtype: str + :returns: A string represent the paging command to run based on the + platform being used. + """ + popen_kwargs = {} + if pager_cmd is None: + pager_cmd = default_pager + # Similar to what we do with the help command, we need to specify + # shell as True to make it work in the pager for Windows + if is_windows: + popen_kwargs = {'shell': True} + else: + pager_cmd = shlex.split(pager_cmd) + popen_kwargs['args'] = pager_cmd + return popen_kwargs + + +@contextlib.contextmanager +def ignore_user_entered_signals(): + """ + Ignores user entered signals to avoid process getting killed. + """ + if is_windows: + signal_list = [signal.SIGINT] + else: + signal_list = [signal.SIGINT, signal.SIGQUIT, signal.SIGTSTP] + actual_signals = [] + for user_signal in signal_list: + actual_signals.append(signal.signal(user_signal, signal.SIG_IGN)) + try: + yield + finally: + for sig, user_signal in enumerate(signal_list): + 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.11.13/awscli/customizations/argrename.py awscli-1.18.69/awscli/customizations/argrename.py --- awscli-1.11.13/awscli/customizations/argrename.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/argrename.py 2020-05-28 19:25:48.000000000 +0000 @@ -43,13 +43,55 @@ 'codepipeline.create-custom-action-type.version': 'action-version', 'codepipeline.delete-custom-action-type.version': 'action-version', 'kinesisanalytics.add-application-output.output': 'application-output', + 'kinesisanalyticsv2.add-application-output.output': 'application-output', 'route53.delete-traffic-policy.version': 'traffic-policy-version', 'route53.get-traffic-policy.version': 'traffic-policy-version', 'route53.update-traffic-policy-comment.version': 'traffic-policy-version', 'gamelift.create-build.version': 'build-version', 'gamelift.update-build.version': 'build-version', + 'gamelift.create-script.version': 'script-version', + 'gamelift.update-script.version': 'script-version', 'route53domains.view-billing.start': 'start-time', 'route53domains.view-billing.end': 'end-time', + 'apigateway.create-rest-api.version': 'api-version', + 'apigatewayv2.create-api.version': 'api-version', + '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', + 'workdocs.create-notification-subscription.endpoint': + 'notification-endpoint', + 'workdocs.describe-users.query': 'user-query', + 'lex-models.delete-bot.version': 'bot-version', + 'lex-models.delete-intent.version': 'intent-version', + 'lex-models.delete-slot-type.version': 'slot-type-version', + 'lex-models.get-intent.version': 'intent-version', + 'lex-models.get-slot-type.version': 'slot-type-version', + 'lex-models.delete-bot-version.version': 'bot-version', + 'lex-models.delete-intent-version.version': 'intent-version', + 'lex-models.delete-slot-type-version.version': 'slot-type-version', + 'lex-models.get-export.version': 'resource-version', + 'mobile.create-project.region': 'project-region', + 'rekognition.create-stream-processor.output': 'stream-processor-output', + 'eks.create-cluster.version': 'kubernetes-version', + 'eks.update-cluster-version.version': 'kubernetes-version', + 'eks.create-nodegroup.version': 'kubernetes-version', + 'eks.update-nodegroup-version.version': 'kubernetes-version', + 'schemas.*.version': 'schema-version', } # Same format as ARGUMENT_RENAMES, but instead of renaming the arguments, @@ -65,6 +107,22 @@ 'storagegateway.describe-cached-iscsi-volumes.volume-arns': 'volume-ar-ns', 'storagegateway.describe-stored-iscsi-volumes.volume-arns': 'volume-ar-ns', 'route53domains.view-billing.start-time': 'start', + # These come from the xform_name() changes that no longer separates words + # by numbers. + 'deploy.create-deployment-group.ec2-tag-set': 'ec-2-tag-set', + 'deploy.list-application-revisions.s3-bucket': 's-3-bucket', + 'deploy.list-application-revisions.s3-key-prefix': 's-3-key-prefix', + 'deploy.update-deployment-group.ec2-tag-set': 'ec-2-tag-set', + 'iam.enable-mfa-device.authentication-code1': 'authentication-code-1', + 'iam.enable-mfa-device.authentication-code2': 'authentication-code-2', + 'iam.resync-mfa-device.authentication-code1': 'authentication-code-1', + 'iam.resync-mfa-device.authentication-code2': 'authentication-code-2', + 'importexport.get-shipping-label.street1': 'street-1', + 'importexport.get-shipping-label.street2': 'street-2', + 'importexport.get-shipping-label.street3': 'street-3', + 'lambda.publish-version.code-sha256': 'code-sha-256', + 'lightsail.import-key-pair.public-key-base64': 'public-key-base-64', + 'opsworks.register-volume.ec2-volume-id': 'ec-2-volume-id', } diff -Nru awscli-1.11.13/awscli/customizations/assumerole.py awscli-1.18.69/awscli/customizations/assumerole.py --- awscli-1.11.13/awscli/customizations/assumerole.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/assumerole.py 2020-05-28 19:25:48.000000000 +0000 @@ -1,10 +1,11 @@ import os -import json import logging from botocore.exceptions import ProfileNotFound +from botocore.credentials import JSONFileCache LOG = logging.getLogger(__name__) +CACHE_DIR = os.path.expanduser(os.path.join('~', '.aws', 'cli', 'cache')) def register_assume_role_provider(event_handlers): @@ -36,53 +37,9 @@ "assume-role cred provider cache. Not configuring " "JSONFileCache for assume-role.") return - provider = cred_chain.get_provider('assume-role') - provider.cache = JSONFileCache() - - -class JSONFileCache(object): - """JSON file cache. - - This provides a dict like interface that stores JSON serializable - objects. - - The objects are serialized to JSON and stored in a file. These - values can be retrieved at a later time. - - """ - - CACHE_DIR = os.path.expanduser(os.path.join('~', '.aws', 'cli', 'cache')) - - def __init__(self, working_dir=CACHE_DIR): - self._working_dir = working_dir - - def __contains__(self, cache_key): - actual_key = self._convert_cache_key(cache_key) - return os.path.isfile(actual_key) - - def __getitem__(self, cache_key): - """Retrieve value from a cache key.""" - actual_key = self._convert_cache_key(cache_key) - try: - with open(actual_key) as f: - return json.load(f) - except (OSError, ValueError, IOError): - raise KeyError(cache_key) - - def __setitem__(self, cache_key, value): - full_key = self._convert_cache_key(cache_key) - try: - file_content = json.dumps(value) - except (TypeError, ValueError): - raise ValueError("Value cannot be cached, must be " - "JSON serializable: %s" % value) - if not os.path.isdir(self._working_dir): - os.makedirs(self._working_dir) - with os.fdopen(os.open(full_key, - os.O_WRONLY | os.O_CREAT, 0o600), 'w') as f: - f.truncate() - f.write(file_content) - - def _convert_cache_key(self, cache_key): - full_path = os.path.join(self._working_dir, cache_key + '.json') - return full_path + assume_role_provider = cred_chain.get_provider('assume-role') + assume_role_provider.cache = JSONFileCache(CACHE_DIR) + web_identity_provider = cred_chain.get_provider( + 'assume-role-with-web-identity' + ) + web_identity_provider.cache = JSONFileCache(CACHE_DIR) diff -Nru awscli-1.11.13/awscli/customizations/awslambda.py awscli-1.18.69/awscli/customizations/awslambda.py --- awscli-1.11.13/awscli/customizations/awslambda.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/awslambda.py 2020-05-28 19:25:48.000000000 +0000 @@ -17,19 +17,24 @@ from botocore.vendored import six from awscli.arguments import CustomArgument, CLIArgument -from awscli.customizations import utils + ERROR_MSG = ( "--zip-file must be a zip file with the fileb:// prefix.\n" "Example usage: --zip-file fileb://path/to/file.zip") -ZIP_DOCSTRING = ('

The path to the zip file of the code you are uploading. ' - 'Example: fileb://code.zip

') +ZIP_DOCSTRING = ( + '

The path to the zip file of the {param_type} you are uploading. ' + 'Specify --zip-file or --{param_type}, but not both. ' + 'Example: fileb://{param_type}.zip

' +) def register_lambda_create_function(cli): cli.register('building-argument-table.lambda.create-function', - _extract_code_and_zip_file_arguments) + ZipFileArgumentHoister('Code').hoist) + cli.register('building-argument-table.lambda.publish-layer-version', + ZipFileArgumentHoister('Content').hoist) cli.register('building-argument-table.lambda.update-function-code', _modify_zipfile_docstring) cli.register('process-cli-arg.lambda.update-function-code', @@ -41,20 +46,36 @@ _should_contain_zip_content(value) -def _extract_code_and_zip_file_arguments(session, argument_table, **kwargs): - argument_table['zip-file'] = ZipFileArgument( - 'zip-file', help_text=ZIP_DOCSTRING, cli_type_name='blob') - code_argument = argument_table['code'] - code_model = copy.deepcopy(code_argument.argument_model) - del code_model.members['ZipFile'] - argument_table['code'] = CodeArgument( - name='code', - argument_model=code_model, - operation_model=code_argument._operation_model, - is_required=False, - event_emitter=session.get_component('event_emitter'), - serialized_name='Code' - ) +class ZipFileArgumentHoister(object): + """Hoists a ZipFile argument up to the top level. + + Injects a top-level ZipFileArgument into the argument table which maps + a --zip-file parameter to the underlying ``serialized_name`` ZipFile + shape. Repalces the old ZipFile argument with an instance of + ReplacedZipFileArgument to prevent its usage and recommend the new + top-level injected parameter. + """ + def __init__(self, serialized_name): + self._serialized_name = serialized_name + self._name = serialized_name.lower() + + def hoist(self, session, argument_table, **kwargs): + help_text = ZIP_DOCSTRING.format(param_type=self._name) + argument_table['zip-file'] = ZipFileArgument( + 'zip-file', help_text=help_text, cli_type_name='blob', + serialized_name=self._serialized_name + ) + argument = argument_table[self._name] + model = copy.deepcopy(argument.argument_model) + del model.members['ZipFile'] + argument_table[self._name] = ReplacedZipFileArgument( + name=self._name, + argument_model=model, + operation_model=argument._operation_model, + is_required=False, + event_emitter=session.get_component('event_emitter'), + serialized_name=self._serialized_name, + ) def _modify_zipfile_docstring(session, argument_table, **kwargs): @@ -78,28 +99,54 @@ class ZipFileArgument(CustomArgument): + """A new ZipFile argument to be injected at the top level. + + This class injects a ZipFile argument under the specified serialized_name + parameter. This can be used to take a top level parameter like --zip-file + and inject it into a nested different parameter like Code so + --zip-file foo.zip winds up being serilized as + { 'Code': { 'ZipFile': } }. + """ + def __init__(self, *args, **kwargs): + self._param_to_replace = kwargs.pop('serialized_name') + super(ZipFileArgument, self).__init__(*args, **kwargs) + def add_to_params(self, parameters, value): if value is None: return _should_contain_zip_content(value) zip_file_param = {'ZipFile': value} - if parameters.get('Code'): - parameters['Code'].update(zip_file_param) + if parameters.get(self._param_to_replace): + parameters[self._param_to_replace].update(zip_file_param) else: - parameters['Code'] = zip_file_param + parameters[self._param_to_replace] = zip_file_param + + +class ReplacedZipFileArgument(CLIArgument): + """A replacement arugment for nested ZipFile argument. + This prevents the use of a non-working nested argument that expects binary. + Instead an instance of ZipFileArgument should be injected at the top level + and used instead. That way fileb:// can be used to load the binary + contents. And the argument class can inject those bytes into the correct + serialization name. + """ + def __init__(self, *args, **kwargs): + super(ReplacedZipFileArgument, self).__init__(*args, **kwargs) + self._cli_name = '--%s' % kwargs['name'] + self._param_to_replace = kwargs['serialized_name'] -class CodeArgument(CLIArgument): def add_to_params(self, parameters, value): if value is None: return unpacked = self._unpack_argument(value) if 'ZipFile' in unpacked: - raise ValueError("ZipFile cannot be provided " - "as part of the --code argument. " - "Please use the '--zip-file' " - "option instead to specify a zip file.") - if parameters.get('Code'): - parameters['Code'].update(unpacked) + raise ValueError( + "ZipFile cannot be provided " + "as part of the %s argument. " + "Please use the '--zip-file' " + "option instead to specify a zip file." % self._cli_name) + if parameters.get(self._param_to_replace): + parameters[self._param_to_replace].update(unpacked) else: - parameters['Code'] = unpacked + parameters[self._param_to_replace] = unpacked diff -Nru awscli-1.11.13/awscli/customizations/cliinputjson.py awscli-1.18.69/awscli/customizations/cliinputjson.py --- awscli-1.11.13/awscli/customizations/cliinputjson.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/cliinputjson.py 2020-05-28 19:25:48.000000000 +0000 @@ -12,7 +12,7 @@ # language governing permissions and limitations under the License. import json -from awscli.paramfile import get_paramfile +from awscli.paramfile import get_paramfile, LOCAL_PREFIX_MAP from awscli.argprocess import ParamError from awscli.customizations.arguments import OverrideRequiredArgsArgument @@ -42,7 +42,9 @@ 'provided. The JSON string follows the format provided ' 'by ``--generate-cli-skeleton``. If other arguments are ' 'provided on the command line, the CLI values will override ' - 'the JSON-provided values.' + 'the JSON-provided values. It is not possible to pass ' + 'arbitrary binary values using a JSON-provided value as ' + 'the string will be taken literally.' } def __init__(self, session): @@ -50,7 +52,7 @@ def _register_argument_action(self): self._session.register( - 'calling-command', self.add_to_call_parameters) + 'calling-command.*', self.add_to_call_parameters) super(CliInputJSONArgument, self)._register_argument_action() def add_to_call_parameters(self, call_parameters, parsed_args, @@ -60,7 +62,7 @@ input_json = getattr(parsed_args, 'cli_input_json', None) if input_json is not None: # Retrieve the JSON from the file if needed. - retrieved_json = get_paramfile(input_json) + retrieved_json = get_paramfile(input_json, LOCAL_PREFIX_MAP) # Nothing was retrieved from the file. So assume the argument # is already a JSON string. if retrieved_json is None: diff -Nru awscli-1.11.13/awscli/customizations/cloudformation/artifact_exporter.py awscli-1.18.69/awscli/customizations/cloudformation/artifact_exporter.py --- awscli-1.11.13/awscli/customizations/cloudformation/artifact_exporter.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/cloudformation/artifact_exporter.py 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,640 @@ +# Copyright 2012-2015 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 logging +import os +import tempfile +import zipfile +import contextlib +import uuid +import shutil +from awscli.compat import six +from botocore.utils import set_value_from_jmespath + +from awscli.compat import urlparse +from contextlib import contextmanager +from awscli.customizations.cloudformation import exceptions +from awscli.customizations.cloudformation.yamlhelper import yaml_dump, \ + yaml_parse +import jmespath + + +LOG = logging.getLogger(__name__) + + +def is_path_value_valid(path): + return isinstance(path, six.string_types) + + +def make_abs_path(directory, path): + if is_path_value_valid(path) and not os.path.isabs(path): + return os.path.normpath(os.path.join(directory, path)) + else: + return path + + +def is_s3_url(url): + try: + parse_s3_url(url) + return True + except ValueError: + return False + + +def is_local_folder(path): + return is_path_value_valid(path) and os.path.isdir(path) + + +def is_local_file(path): + return is_path_value_valid(path) and os.path.isfile(path) + + +def is_zip_file(path): + return ( + is_path_value_valid(path) and + zipfile.is_zipfile(path)) + + +def parse_s3_url(url, + bucket_name_property="Bucket", + object_key_property="Key", + version_property=None): + + if isinstance(url, six.string_types) \ + and url.startswith("s3://"): + + # Python < 2.7.10 don't parse query parameters from URI with custom + # scheme such as s3://blah/blah. As a workaround, remove scheme + # altogether to trigger the parser "s3://foo/bar?v=1" =>"//foo/bar?v=1" + parsed = urlparse.urlparse(url[3:]) + query = urlparse.parse_qs(parsed.query) + + if parsed.netloc and parsed.path: + result = dict() + result[bucket_name_property] = parsed.netloc + result[object_key_property] = parsed.path.lstrip('/') + + # If there is a query string that has a single versionId field, + # set the object version and return + if version_property is not None \ + and 'versionId' in query \ + and len(query['versionId']) == 1: + result[version_property] = query['versionId'][0] + + return result + + raise ValueError("URL given to the parse method is not a valid S3 url " + "{0}".format(url)) + + +def upload_local_artifacts(resource_id, resource_dict, property_name, + parent_dir, uploader): + """ + Upload local artifacts referenced by the property at given resource and + return S3 URL of the uploaded object. It is the responsibility of callers + to ensure property value is a valid string + + If path refers to a file, this method will upload the file. If path refers + to a folder, this method will zip the folder and upload the zip to S3. + If path is omitted, this method will zip the current working folder and + upload. + + If path is already a path to S3 object, this method does nothing. + + :param resource_id: Id of the CloudFormation resource + :param resource_dict: Dictionary containing resource definition + :param property_name: Property name of CloudFormation resource where this + local path is present + :param parent_dir: Resolve all relative paths with respect to this + directory + :param uploader: Method to upload files to S3 + + :return: S3 URL of the uploaded object + :raise: ValueError if path is not a S3 URL or a local path + """ + + local_path = jmespath.search(property_name, resource_dict) + + if local_path is None: + # Build the root directory and upload to S3 + local_path = parent_dir + + if is_s3_url(local_path): + # A valid CloudFormation template will specify artifacts as S3 URLs. + # This check is supporting the case where your resource does not + # refer to local artifacts + # Nothing to do if property value is an S3 URL + LOG.debug("Property {0} of {1} is already a S3 URL" + .format(property_name, resource_id)) + return local_path + + local_path = make_abs_path(parent_dir, local_path) + + # Or, pointing to a folder. Zip the folder and upload + if is_local_folder(local_path): + return zip_and_upload(local_path, uploader) + + # Path could be pointing to a file. Upload the file + elif is_local_file(local_path): + return uploader.upload_with_dedup(local_path) + + raise exceptions.InvalidLocalPathError( + resource_id=resource_id, + property_name=property_name, + local_path=local_path) + + +def zip_and_upload(local_path, uploader): + with zip_folder(local_path) as zipfile: + return uploader.upload_with_dedup(zipfile) + + +@contextmanager +def zip_folder(folder_path): + """ + Zip the entire folder and return a file to the zip. Use this inside + a "with" statement to cleanup the zipfile after it is used. + + :param folder_path: + :return: Name of the zipfile + """ + + filename = os.path.join( + tempfile.gettempdir(), "data-" + uuid.uuid4().hex) + + zipfile_name = make_zip(filename, folder_path) + try: + yield zipfile_name + finally: + if os.path.exists(zipfile_name): + os.remove(zipfile_name) + + +def make_zip(filename, source_root): + zipfile_name = "{0}.zip".format(filename) + source_root = os.path.abspath(source_root) + with open(zipfile_name, 'wb') as f: + zip_file = zipfile.ZipFile(f, 'w', zipfile.ZIP_DEFLATED) + with contextlib.closing(zip_file) as zf: + for root, dirs, files in os.walk(source_root, followlinks=True): + for filename in files: + full_path = os.path.join(root, filename) + relative_path = os.path.relpath( + full_path, source_root) + zf.write(full_path, relative_path) + + return zipfile_name + + +@contextmanager +def mktempfile(): + directory = tempfile.gettempdir() + filename = os.path.join(directory, uuid.uuid4().hex) + + try: + with open(filename, "w+") as handle: + yield handle + finally: + if os.path.exists(filename): + os.remove(filename) + + +def copy_to_temp_dir(filepath): + tmp_dir = tempfile.mkdtemp() + dst = os.path.join(tmp_dir, os.path.basename(filepath)) + shutil.copyfile(filepath, dst) + return tmp_dir + + +class Resource(object): + """ + Base class representing a CloudFormation resource that can be exported + """ + + RESOURCE_TYPE = None + PROPERTY_NAME = None + PACKAGE_NULL_PROPERTY = True + # Set this property to True in base class if you want the exporter to zip + # up the file before uploading This is useful for Lambda functions. + FORCE_ZIP = False + + def __init__(self, uploader): + self.uploader = uploader + + def export(self, resource_id, resource_dict, parent_dir): + if resource_dict is None: + return + + property_value = jmespath.search(self.PROPERTY_NAME, resource_dict) + + if not property_value and not self.PACKAGE_NULL_PROPERTY: + return + + if isinstance(property_value, dict): + LOG.debug("Property {0} of {1} resource is not a URL" + .format(self.PROPERTY_NAME, resource_id)) + return + + # If property is a file but not a zip file, place file in temp + # folder and send the temp folder to be zipped + temp_dir = None + if is_local_file(property_value) and not \ + is_zip_file(property_value) and self.FORCE_ZIP: + temp_dir = copy_to_temp_dir(property_value) + set_value_from_jmespath(resource_dict, self.PROPERTY_NAME, temp_dir) + + try: + self.do_export(resource_id, resource_dict, parent_dir) + + except Exception as ex: + LOG.debug("Unable to export", exc_info=ex) + raise exceptions.ExportFailedError( + resource_id=resource_id, + property_name=self.PROPERTY_NAME, + property_value=property_value, + ex=ex) + finally: + if temp_dir: + shutil.rmtree(temp_dir) + + def do_export(self, resource_id, resource_dict, parent_dir): + """ + Default export action is to upload artifacts and set the property to + S3 URL of the uploaded object + """ + uploaded_url = upload_local_artifacts(resource_id, resource_dict, + self.PROPERTY_NAME, + parent_dir, self.uploader) + set_value_from_jmespath(resource_dict, self.PROPERTY_NAME, uploaded_url) + + +class ResourceWithS3UrlDict(Resource): + """ + Represents CloudFormation resources that need the S3 URL to be specified as + an dict like {Bucket: "", Key: "", Version: ""} + """ + + BUCKET_NAME_PROPERTY = None + OBJECT_KEY_PROPERTY = None + VERSION_PROPERTY = None + + def __init__(self, uploader): + super(ResourceWithS3UrlDict, self).__init__(uploader) + + def do_export(self, resource_id, resource_dict, parent_dir): + """ + Upload to S3 and set property to an dict representing the S3 url + of the uploaded object + """ + + artifact_s3_url = \ + upload_local_artifacts(resource_id, resource_dict, + self.PROPERTY_NAME, + parent_dir, self.uploader) + + parsed_url = parse_s3_url( + artifact_s3_url, + bucket_name_property=self.BUCKET_NAME_PROPERTY, + object_key_property=self.OBJECT_KEY_PROPERTY, + version_property=self.VERSION_PROPERTY) + set_value_from_jmespath(resource_dict, self.PROPERTY_NAME, parsed_url) + + +class ServerlessFunctionResource(Resource): + RESOURCE_TYPE = "AWS::Serverless::Function" + PROPERTY_NAME = "CodeUri" + FORCE_ZIP = True + + +class ServerlessApiResource(Resource): + RESOURCE_TYPE = "AWS::Serverless::Api" + PROPERTY_NAME = "DefinitionUri" + # Don't package the directory if DefinitionUri is omitted. + # Necessary to support DefinitionBody + PACKAGE_NULL_PROPERTY = False + + +class GraphQLSchemaResource(Resource): + RESOURCE_TYPE = "AWS::AppSync::GraphQLSchema" + PROPERTY_NAME = "DefinitionS3Location" + # Don't package the directory if DefinitionS3Location is omitted. + # Necessary to support Definition + PACKAGE_NULL_PROPERTY = False + + +class AppSyncResolverRequestTemplateResource(Resource): + RESOURCE_TYPE = "AWS::AppSync::Resolver" + PROPERTY_NAME = "RequestMappingTemplateS3Location" + # Don't package the directory if RequestMappingTemplateS3Location is omitted. + # Necessary to support RequestMappingTemplate + PACKAGE_NULL_PROPERTY = False + + +class AppSyncResolverResponseTemplateResource(Resource): + RESOURCE_TYPE = "AWS::AppSync::Resolver" + PROPERTY_NAME = "ResponseMappingTemplateS3Location" + # Don't package the directory if ResponseMappingTemplateS3Location is omitted. + # Necessary to support ResponseMappingTemplate + PACKAGE_NULL_PROPERTY = False + + +class AppSyncFunctionConfigurationRequestTemplateResource(Resource): + RESOURCE_TYPE = "AWS::AppSync::FunctionConfiguration" + PROPERTY_NAME = "RequestMappingTemplateS3Location" + # Don't package the directory if RequestMappingTemplateS3Location is omitted. + # Necessary to support RequestMappingTemplate + PACKAGE_NULL_PROPERTY = False + + +class AppSyncFunctionConfigurationResponseTemplateResource(Resource): + RESOURCE_TYPE = "AWS::AppSync::FunctionConfiguration" + PROPERTY_NAME = "ResponseMappingTemplateS3Location" + # Don't package the directory if ResponseMappingTemplateS3Location is omitted. + # Necessary to support ResponseMappingTemplate + PACKAGE_NULL_PROPERTY = False + + +class LambdaFunctionResource(ResourceWithS3UrlDict): + RESOURCE_TYPE = "AWS::Lambda::Function" + PROPERTY_NAME = "Code" + BUCKET_NAME_PROPERTY = "S3Bucket" + OBJECT_KEY_PROPERTY = "S3Key" + VERSION_PROPERTY = "S3ObjectVersion" + FORCE_ZIP = True + + +class ApiGatewayRestApiResource(ResourceWithS3UrlDict): + RESOURCE_TYPE = "AWS::ApiGateway::RestApi" + PROPERTY_NAME = "BodyS3Location" + PACKAGE_NULL_PROPERTY = False + BUCKET_NAME_PROPERTY = "Bucket" + OBJECT_KEY_PROPERTY = "Key" + VERSION_PROPERTY = "Version" + + +class ElasticBeanstalkApplicationVersion(ResourceWithS3UrlDict): + RESOURCE_TYPE = "AWS::ElasticBeanstalk::ApplicationVersion" + PROPERTY_NAME = "SourceBundle" + BUCKET_NAME_PROPERTY = "S3Bucket" + OBJECT_KEY_PROPERTY = "S3Key" + VERSION_PROPERTY = None + + +class LambdaLayerVersionResource(ResourceWithS3UrlDict): + RESOURCE_TYPE = "AWS::Lambda::LayerVersion" + PROPERTY_NAME = "Content" + BUCKET_NAME_PROPERTY = "S3Bucket" + OBJECT_KEY_PROPERTY = "S3Key" + VERSION_PROPERTY = "S3ObjectVersion" + FORCE_ZIP = True + + +class ServerlessLayerVersionResource(Resource): + RESOURCE_TYPE = "AWS::Serverless::LayerVersion" + PROPERTY_NAME = "ContentUri" + FORCE_ZIP = True + + +class ServerlessRepoApplicationReadme(Resource): + RESOURCE_TYPE = "AWS::ServerlessRepo::Application" + PROPERTY_NAME = "ReadmeUrl" + PACKAGE_NULL_PROPERTY = False + + +class ServerlessRepoApplicationLicense(Resource): + RESOURCE_TYPE = "AWS::ServerlessRepo::Application" + PROPERTY_NAME = "LicenseUrl" + PACKAGE_NULL_PROPERTY = False + + +class CloudFormationStackResource(Resource): + """ + Represents CloudFormation::Stack resource that can refer to a nested + stack template via TemplateURL property. + """ + RESOURCE_TYPE = "AWS::CloudFormation::Stack" + PROPERTY_NAME = "TemplateURL" + + def __init__(self, uploader): + super(CloudFormationStackResource, self).__init__(uploader) + + def do_export(self, resource_id, resource_dict, parent_dir): + """ + If the nested stack template is valid, this method will + export on the nested template, upload the exported template to S3 + and set property to URL of the uploaded S3 template + """ + + template_path = resource_dict.get(self.PROPERTY_NAME, None) + + if template_path is None or is_s3_url(template_path) or \ + template_path.startswith("http://") or \ + template_path.startswith("https://"): + # Nothing to do + return + + abs_template_path = make_abs_path(parent_dir, template_path) + if not is_local_file(abs_template_path): + raise exceptions.InvalidTemplateUrlParameterError( + property_name=self.PROPERTY_NAME, + resource_id=resource_id, + template_path=abs_template_path) + + exported_template_dict = \ + Template(template_path, parent_dir, self.uploader).export() + + exported_template_str = yaml_dump(exported_template_dict) + + with mktempfile() as temporary_file: + temporary_file.write(exported_template_str) + temporary_file.flush() + + url = self.uploader.upload_with_dedup( + temporary_file.name, "template") + + # TemplateUrl property requires S3 URL to be in path-style format + parts = parse_s3_url(url, version_property="Version") + s3_path_url = self.uploader.to_path_style_s3_url( + parts["Key"], parts.get("Version", None)) + set_value_from_jmespath(resource_dict, self.PROPERTY_NAME, s3_path_url) + + +class ServerlessApplicationResource(CloudFormationStackResource): + """ + Represents Serverless::Application resource that can refer to a nested + app template via Location property. + """ + RESOURCE_TYPE = "AWS::Serverless::Application" + PROPERTY_NAME = "Location" + + + +class GlueJobCommandScriptLocationResource(Resource): + """ + Represents Glue::Job resource. + """ + RESOURCE_TYPE = "AWS::Glue::Job" + # Note the PROPERTY_NAME includes a '.' implying it's nested. + PROPERTY_NAME = "Command.ScriptLocation" + + +RESOURCES_EXPORT_LIST = [ + ServerlessFunctionResource, + ServerlessApiResource, + GraphQLSchemaResource, + AppSyncResolverRequestTemplateResource, + AppSyncResolverResponseTemplateResource, + AppSyncFunctionConfigurationRequestTemplateResource, + AppSyncFunctionConfigurationResponseTemplateResource, + ApiGatewayRestApiResource, + LambdaFunctionResource, + ElasticBeanstalkApplicationVersion, + CloudFormationStackResource, + ServerlessApplicationResource, + ServerlessLayerVersionResource, + LambdaLayerVersionResource, + GlueJobCommandScriptLocationResource, +] + +METADATA_EXPORT_LIST = [ + ServerlessRepoApplicationReadme, + ServerlessRepoApplicationLicense +] + + +def include_transform_export_handler(template_dict, uploader, parent_dir): + if template_dict.get("Name", None) != "AWS::Include": + return template_dict + + include_location = template_dict.get("Parameters", {}).get("Location", None) + if not include_location \ + or not is_path_value_valid(include_location) \ + or is_s3_url(include_location): + # `include_location` is either empty, or not a string, or an S3 URI + return template_dict + + # We are confident at this point that `include_location` is a string containing the local path + abs_include_location = os.path.join(parent_dir, include_location) + if is_local_file(abs_include_location): + template_dict["Parameters"]["Location"] = uploader.upload_with_dedup(abs_include_location) + else: + raise exceptions.InvalidLocalPathError( + resource_id="AWS::Include", + property_name="Location", + local_path=abs_include_location) + + return template_dict + + +GLOBAL_EXPORT_DICT = { + "Fn::Transform": include_transform_export_handler +} + + +class Template(object): + """ + Class to export a CloudFormation template + """ + + def __init__(self, template_path, parent_dir, uploader, + resources_to_export=RESOURCES_EXPORT_LIST, + metadata_to_export=METADATA_EXPORT_LIST): + """ + Reads the template and makes it ready for export + """ + + if not (is_local_folder(parent_dir) and os.path.isabs(parent_dir)): + raise ValueError("parent_dir parameter must be " + "an absolute path to a folder {0}" + .format(parent_dir)) + + abs_template_path = make_abs_path(parent_dir, template_path) + template_dir = os.path.dirname(abs_template_path) + + with open(abs_template_path, "r") as handle: + template_str = handle.read() + + self.template_dict = yaml_parse(template_str) + self.template_dir = template_dir + self.resources_to_export = resources_to_export + self.metadata_to_export = metadata_to_export + self.uploader = uploader + + def export_global_artifacts(self, template_dict): + """ + Template params such as AWS::Include transforms are not specific to + any resource type but contain artifacts that should be exported, + here we iterate through the template dict and export params with a + handler defined in GLOBAL_EXPORT_DICT + """ + for key, val in template_dict.items(): + if key in GLOBAL_EXPORT_DICT: + template_dict[key] = GLOBAL_EXPORT_DICT[key](val, self.uploader, self.template_dir) + elif isinstance(val, dict): + self.export_global_artifacts(val) + elif isinstance(val, list): + for item in val: + if isinstance(item, dict): + self.export_global_artifacts(item) + return template_dict + + def export_metadata(self, template_dict): + """ + Exports the local artifacts referenced by the metadata section in + the given template to an s3 bucket. + + :return: The template with references to artifacts that have been + exported to s3. + """ + if "Metadata" not in template_dict: + return template_dict + + for metadata_type, metadata_dict in template_dict["Metadata"].items(): + for exporter_class in self.metadata_to_export: + if exporter_class.RESOURCE_TYPE != metadata_type: + continue + + exporter = exporter_class(self.uploader) + exporter.export(metadata_type, metadata_dict, self.template_dir) + + return template_dict + + def export(self): + """ + Exports the local artifacts referenced by the given template to an + s3 bucket. + + :return: The template with references to artifacts that have been + exported to s3. + """ + self.template_dict = self.export_metadata(self.template_dict) + + if "Resources" not in self.template_dict: + return self.template_dict + + self.template_dict = self.export_global_artifacts(self.template_dict) + + for resource_id, resource in self.template_dict["Resources"].items(): + + resource_type = resource.get("Type", None) + resource_dict = resource.get("Properties", None) + + for exporter_class in self.resources_to_export: + if exporter_class.RESOURCE_TYPE != resource_type: + continue + + # Export code resources + exporter = exporter_class(self.uploader) + exporter.export(resource_id, resource_dict, self.template_dir) + + return self.template_dict diff -Nru awscli-1.11.13/awscli/customizations/cloudformation/deployer.py awscli-1.18.69/awscli/customizations/cloudformation/deployer.py --- awscli-1.11.13/awscli/customizations/cloudformation/deployer.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/cloudformation/deployer.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,229 @@ +# Copyright 2012-2015 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 sys +import time +import logging +import botocore +import collections + +from awscli.customizations.cloudformation import exceptions +from awscli.customizations.cloudformation.artifact_exporter import mktempfile, parse_s3_url + +from datetime import datetime + +LOG = logging.getLogger(__name__) + +ChangeSetResult = collections.namedtuple( + "ChangeSetResult", ["changeset_id", "changeset_type"]) + + +class Deployer(object): + + def __init__(self, cloudformation_client, + changeset_prefix="awscli-cloudformation-package-deploy-"): + self._client = cloudformation_client + self.changeset_prefix = changeset_prefix + + def has_stack(self, stack_name): + """ + Checks if a CloudFormation stack with given name exists + + :param stack_name: Name or ID of the stack + :return: True if stack exists. False otherwise + """ + try: + resp = self._client.describe_stacks(StackName=stack_name) + if len(resp["Stacks"]) != 1: + return False + + # When you run CreateChangeSet on a a stack that does not exist, + # CloudFormation will create a stack and set it's status + # REVIEW_IN_PROGRESS. However this stack is cannot be manipulated + # by "update" commands. Under this circumstances, we treat like + # this stack does not exist and call CreateChangeSet will + # ChangeSetType set to CREATE and not UPDATE. + stack = resp["Stacks"][0] + return stack["StackStatus"] != "REVIEW_IN_PROGRESS" + + except botocore.exceptions.ClientError as e: + # If a stack does not exist, describe_stacks will throw an + # exception. Unfortunately we don't have a better way than parsing + # the exception msg to understand the nature of this exception. + msg = str(e) + + if "Stack with id {0} does not exist".format(stack_name) in msg: + LOG.debug("Stack with id {0} does not exist".format( + stack_name)) + return False + else: + # We don't know anything about this exception. Don't handle + LOG.debug("Unable to get stack details.", exc_info=e) + raise e + + def create_changeset(self, stack_name, cfn_template, + parameter_values, capabilities, role_arn, + notification_arns, s3_uploader, tags): + """ + Call Cloudformation to create a changeset and wait for it to complete + + :param stack_name: Name or ID of stack + :param cfn_template: CloudFormation template string + :param parameter_values: Template parameters object + :param capabilities: Array of capabilities passed to CloudFormation + :param tags: Array of tags passed to CloudFormation + :return: + """ + + now = datetime.utcnow().isoformat() + description = "Created by AWS CLI at {0} UTC".format(now) + + # Each changeset will get a unique name based on time + changeset_name = self.changeset_prefix + str(int(time.time())) + + if not self.has_stack(stack_name): + changeset_type = "CREATE" + # When creating a new stack, UsePreviousValue=True is invalid. + # For such parameters, users should either override with new value, + # or set a Default value in template to successfully create a stack. + parameter_values = [x for x in parameter_values + if not x.get("UsePreviousValue", False)] + else: + changeset_type = "UPDATE" + # UsePreviousValue not valid if parameter is new + summary = self._client.get_template_summary(StackName=stack_name) + existing_parameters = [parameter['ParameterKey'] for parameter in \ + summary['Parameters']] + parameter_values = [x for x in parameter_values + if not (x.get("UsePreviousValue", False) and \ + x["ParameterKey"] not in existing_parameters)] + + kwargs = { + 'ChangeSetName': changeset_name, + 'StackName': stack_name, + 'TemplateBody': cfn_template, + 'ChangeSetType': changeset_type, + 'Parameters': parameter_values, + 'Capabilities': capabilities, + 'Description': description, + 'Tags': tags, + } + + # If an S3 uploader is available, use TemplateURL to deploy rather than + # TemplateBody. This is required for large templates. + if s3_uploader: + with mktempfile() as temporary_file: + temporary_file.write(kwargs.pop('TemplateBody')) + temporary_file.flush() + url = s3_uploader.upload_with_dedup( + temporary_file.name, "template") + # TemplateUrl property requires S3 URL to be in path-style format + parts = parse_s3_url(url, version_property="Version") + kwargs['TemplateURL'] = s3_uploader.to_path_style_s3_url(parts["Key"], parts.get("Version", None)) + + # don't set these arguments if not specified to use existing values + if role_arn is not None: + kwargs['RoleARN'] = role_arn + if notification_arns is not None: + kwargs['NotificationARNs'] = notification_arns + try: + resp = self._client.create_change_set(**kwargs) + return ChangeSetResult(resp["Id"], changeset_type) + except Exception as ex: + LOG.debug("Unable to create changeset", exc_info=ex) + raise ex + + def wait_for_changeset(self, changeset_id, stack_name): + """ + Waits until the changeset creation completes + + :param changeset_id: ID or name of the changeset + :param stack_name: Stack name + :return: Latest status of the create-change-set operation + """ + sys.stdout.write("\nWaiting for changeset to be created..\n") + sys.stdout.flush() + + # Wait for changeset to be created + waiter = self._client.get_waiter("change_set_create_complete") + # Poll every 5 seconds. Changeset creation should be fast + waiter_config = {'Delay': 5} + try: + waiter.wait(ChangeSetName=changeset_id, StackName=stack_name, + WaiterConfig=waiter_config) + except botocore.exceptions.WaiterError as ex: + LOG.debug("Create changeset waiter exception", exc_info=ex) + + resp = ex.last_response + status = resp["Status"] + reason = resp["StatusReason"] + + if status == "FAILED" and \ + "The submitted information didn't contain changes." in reason or \ + "No updates are to be performed" in reason: + raise exceptions.ChangeEmptyError(stack_name=stack_name) + + raise RuntimeError("Failed to create the changeset: {0} " + "Status: {1}. Reason: {2}" + .format(ex, status, reason)) + + def execute_changeset(self, changeset_id, stack_name): + """ + Calls CloudFormation to execute changeset + + :param changeset_id: ID of the changeset + :param stack_name: Name or ID of the stack + :return: Response from execute-change-set call + """ + return self._client.execute_change_set( + ChangeSetName=changeset_id, + StackName=stack_name) + + def wait_for_execute(self, stack_name, changeset_type): + + sys.stdout.write("Waiting for stack create/update to complete\n") + sys.stdout.flush() + + # Pick the right waiter + if changeset_type == "CREATE": + waiter = self._client.get_waiter("stack_create_complete") + elif changeset_type == "UPDATE": + waiter = self._client.get_waiter("stack_update_complete") + else: + raise RuntimeError("Invalid changeset type {0}" + .format(changeset_type)) + + # Poll every 5 seconds. Optimizing for the case when the stack has only + # minimal changes, such the Code for Lambda Function + waiter_config = { + 'Delay': 5, + 'MaxAttempts': 720, + } + + try: + waiter.wait(StackName=stack_name, WaiterConfig=waiter_config) + except botocore.exceptions.WaiterError as ex: + LOG.debug("Execute changeset waiter exception", exc_info=ex) + + raise exceptions.DeployFailedError(stack_name=stack_name) + + def create_and_wait_for_changeset(self, stack_name, cfn_template, + parameter_values, capabilities, role_arn, + notification_arns, s3_uploader, tags): + + result = self.create_changeset( + stack_name, cfn_template, parameter_values, capabilities, + role_arn, notification_arns, s3_uploader, tags) + self.wait_for_changeset(result.changeset_id, stack_name) + + return result diff -Nru awscli-1.11.13/awscli/customizations/cloudformation/deploy.py awscli-1.18.69/awscli/customizations/cloudformation/deploy.py --- awscli-1.11.13/awscli/customizations/cloudformation/deploy.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/cloudformation/deploy.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,387 @@ +# Copyright 2015 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 os +import sys +import logging + +from botocore.client import Config + +from awscli.customizations.cloudformation import exceptions +from awscli.customizations.cloudformation.deployer import Deployer +from awscli.customizations.s3uploader import S3Uploader +from awscli.customizations.cloudformation.yamlhelper import yaml_parse + +from awscli.customizations.commands import BasicCommand +from awscli.compat import get_stdout_text_writer +from awscli.utils import write_exception + +LOG = logging.getLogger(__name__) + + +class DeployCommand(BasicCommand): + + MSG_NO_EXECUTE_CHANGESET = \ + ("Changeset created successfully. Run the following command to " + "review changes:" + "\n" + "aws cloudformation describe-change-set --change-set-name " + "{changeset_id}" + "\n") + + MSG_EXECUTE_SUCCESS = "Successfully created/updated stack - {stack_name}\n" + + PARAMETER_OVERRIDE_CMD = "parameter-overrides" + TAGS_CMD = "tags" + + NAME = 'deploy' + DESCRIPTION = BasicCommand.FROM_FILE("cloudformation", + "_deploy_description.rst") + + ARG_TABLE = [ + { + 'name': 'template-file', + 'required': True, + 'help_text': ( + 'The path where your AWS CloudFormation' + ' template is located.' + ) + }, + { + 'name': 'stack-name', + 'action': 'store', + 'required': True, + 'help_text': ( + 'The name of the AWS CloudFormation stack you\'re deploying to.' + ' If you specify an existing stack, the command updates the' + ' stack. If you specify a new stack, the command creates it.' + ) + }, + { + 'name': 's3-bucket', + 'required': False, + 'help_text': ( + 'The name of the S3 bucket where this command uploads your ' + 'CloudFormation template. This is required the deployments of ' + 'templates sized greater than 51,200 bytes' + ) + }, + { + "name": "force-upload", + "action": "store_true", + "help_text": ( + 'Indicates whether to override existing files in the S3 bucket.' + ' Specify this flag to upload artifacts even if they ' + ' match existing artifacts in the S3 bucket.' + ) + }, + { + 'name': 's3-prefix', + 'help_text': ( + 'A prefix name that the command adds to the' + ' artifacts\' name when it uploads them to the S3 bucket.' + ' The prefix name is a path name (folder name) for' + ' the S3 bucket.' + ) + }, + + { + 'name': 'kms-key-id', + 'help_text': ( + 'The ID of an AWS KMS key that the command uses' + ' to encrypt artifacts that are at rest in the S3 bucket.' + ) + }, + { + 'name': PARAMETER_OVERRIDE_CMD, + 'action': 'store', + 'required': False, + 'schema': { + 'type': 'array', + 'items': { + 'type': 'string' + } + }, + 'default': [], + 'help_text': ( + 'A list of parameter structures that specify input parameters' + ' for your stack template. If you\'re updating a stack and you' + ' don\'t specify a parameter, the command uses the stack\'s' + ' existing value. For new stacks, you must specify' + ' parameters that don\'t have a default value.' + ' Syntax: ParameterKey1=ParameterValue1' + ' ParameterKey2=ParameterValue2 ...' + ) + }, + { + 'name': 'capabilities', + 'action': 'store', + 'required': False, + 'schema': { + 'type': 'array', + 'items': { + 'type': 'string', + 'enum': [ + 'CAPABILITY_IAM', + 'CAPABILITY_NAMED_IAM' + ] + } + }, + 'default': [], + 'help_text': ( + 'A list of capabilities that you must specify before AWS' + ' Cloudformation can create certain stacks. Some stack' + ' templates might include resources that can affect' + ' permissions in your AWS account, for example, by creating' + ' new AWS Identity and Access Management (IAM) users. For' + ' those stacks, you must explicitly acknowledge their' + ' capabilities by specifying this parameter. ' + ' The only valid values are CAPABILITY_IAM and' + ' CAPABILITY_NAMED_IAM. If you have IAM resources, you can' + ' specify either capability. If you have IAM resources with' + ' custom names, you must specify CAPABILITY_NAMED_IAM. If you' + ' don\'t specify this parameter, this action returns an' + ' InsufficientCapabilities error.' + ) + + }, + { + 'name': 'no-execute-changeset', + 'action': 'store_false', + 'dest': 'execute_changeset', + 'required': False, + 'help_text': ( + 'Indicates whether to execute the change set. Specify this' + ' flag if you want to view your stack changes before' + ' executing the change set. The command creates an' + ' AWS CloudFormation change set and then exits without' + ' executing the change set. After you view the change set,' + ' execute it to implement your changes.' + ) + }, + { + 'name': 'role-arn', + 'required': False, + 'help_text': ( + 'The Amazon Resource Name (ARN) of an AWS Identity and Access ' + 'Management (IAM) role that AWS CloudFormation assumes when ' + 'executing the change set.' + ) + }, + { + 'name': 'notification-arns', + 'required': False, + 'schema': { + 'type': 'array', + 'items': { + 'type': 'string' + } + }, + 'help_text': ( + 'Amazon Simple Notification Service topic Amazon Resource Names' + ' (ARNs) that AWS CloudFormation associates with the stack.' + ) + }, + { + 'name': 'fail-on-empty-changeset', + 'required': False, + 'action': 'store_true', + 'group_name': 'fail-on-empty-changeset', + 'dest': 'fail_on_empty_changeset', + 'default': True, + 'help_text': ( + 'Specify if the CLI should return a non-zero exit code if ' + 'there are no changes to be made to the stack. The default ' + 'behavior is to return a non-zero exit code.' + ) + }, + { + 'name': 'no-fail-on-empty-changeset', + 'required': False, + 'action': 'store_false', + 'group_name': 'fail-on-empty-changeset', + 'dest': 'fail_on_empty_changeset', + 'default': True, + 'help_text': ( + 'Causes the CLI to return an exit code of 0 if there are no ' + 'changes to be made to the stack.' + ) + }, + { + 'name': TAGS_CMD, + 'action': 'store', + 'required': False, + 'schema': { + 'type': 'array', + 'items': { + 'type': 'string' + } + }, + 'default': [], + 'help_text': ( + 'A list of tags to associate with the stack that is created' + ' or updated. AWS CloudFormation also propagates these tags' + ' to resources in the stack if the resource supports it.' + ' Syntax: TagKey1=TagValue1 TagKey2=TagValue2 ...' + ) + } + ] + + def _run_main(self, parsed_args, parsed_globals): + cloudformation_client = \ + self._session.create_client( + 'cloudformation', region_name=parsed_globals.region, + endpoint_url=parsed_globals.endpoint_url, + verify=parsed_globals.verify_ssl) + + template_path = parsed_args.template_file + if not os.path.isfile(template_path): + raise exceptions.InvalidTemplatePathError( + template_path=template_path) + + # Parse parameters + with open(template_path, "r") as handle: + template_str = handle.read() + + stack_name = parsed_args.stack_name + parameter_overrides = self.parse_key_value_arg( + parsed_args.parameter_overrides, + self.PARAMETER_OVERRIDE_CMD) + + tags_dict = self.parse_key_value_arg(parsed_args.tags, self.TAGS_CMD) + tags = [{"Key": key, "Value": value} + for key, value in tags_dict.items()] + + template_dict = yaml_parse(template_str) + + parameters = self.merge_parameters(template_dict, parameter_overrides) + + template_size = os.path.getsize(parsed_args.template_file) + if template_size > 51200 and not parsed_args.s3_bucket: + raise exceptions.DeployBucketRequiredError() + + bucket = parsed_args.s3_bucket + if bucket: + s3_client = self._session.create_client( + "s3", + config=Config(signature_version='s3v4'), + region_name=parsed_globals.region, + verify=parsed_globals.verify_ssl) + + s3_uploader = S3Uploader(s3_client, + bucket, + parsed_args.s3_prefix, + parsed_args.kms_key_id, + parsed_args.force_upload) + else: + s3_uploader = None + + deployer = Deployer(cloudformation_client) + return self.deploy(deployer, stack_name, template_str, + parameters, parsed_args.capabilities, + parsed_args.execute_changeset, parsed_args.role_arn, + parsed_args.notification_arns, s3_uploader, + tags, + parsed_args.fail_on_empty_changeset) + + def deploy(self, deployer, stack_name, template_str, + parameters, capabilities, execute_changeset, role_arn, + notification_arns, s3_uploader, tags, + fail_on_empty_changeset=True): + try: + result = deployer.create_and_wait_for_changeset( + stack_name=stack_name, + cfn_template=template_str, + parameter_values=parameters, + capabilities=capabilities, + role_arn=role_arn, + notification_arns=notification_arns, + s3_uploader=s3_uploader, + tags=tags + ) + except exceptions.ChangeEmptyError as ex: + if fail_on_empty_changeset: + raise + write_exception(ex, outfile=get_stdout_text_writer()) + return 0 + + if execute_changeset: + deployer.execute_changeset(result.changeset_id, stack_name) + deployer.wait_for_execute(stack_name, result.changeset_type) + sys.stdout.write(self.MSG_EXECUTE_SUCCESS.format( + stack_name=stack_name)) + else: + sys.stdout.write(self.MSG_NO_EXECUTE_CHANGESET.format( + changeset_id=result.changeset_id)) + + sys.stdout.flush() + return 0 + + def merge_parameters(self, template_dict, parameter_overrides): + """ + CloudFormation CreateChangeset requires a value for every parameter + from the template, either specifying a new value or use previous value. + For convenience, this method will accept new parameter values and + generates a dict of all parameters in a format that ChangeSet API + will accept + + :param parameter_overrides: + :return: + """ + parameter_values = [] + + if not isinstance(template_dict.get("Parameters", None), dict): + return parameter_values + + for key, value in template_dict["Parameters"].items(): + + obj = { + "ParameterKey": key + } + + if key in parameter_overrides: + obj["ParameterValue"] = parameter_overrides[key] + else: + obj["UsePreviousValue"] = True + + parameter_values.append(obj) + + return parameter_values + + def parse_key_value_arg(self, arg_value, argname): + """ + Converts arguments that are passed as list of "Key=Value" strings + into a real dictionary. + + :param arg_value list: Array of strings, where each string is of + form Key=Value + :param argname string: Name of the argument that contains the value + :return dict: Dictionary representing the key/value pairs + """ + result = {} + for data in arg_value: + + # Split at first '=' from left + key_value_pair = data.split("=", 1) + + if len(key_value_pair) != 2: + raise exceptions.InvalidKeyValuePairArgumentError( + argname=argname, + value=key_value_pair) + + result[key_value_pair[0]] = key_value_pair[1] + + return result + + + diff -Nru awscli-1.11.13/awscli/customizations/cloudformation/exceptions.py awscli-1.18.69/awscli/customizations/cloudformation/exceptions.py --- awscli-1.11.13/awscli/customizations/cloudformation/exceptions.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/cloudformation/exceptions.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,55 @@ + +class CloudFormationCommandError(Exception): + fmt = 'An unspecified error occurred' + + def __init__(self, **kwargs): + msg = self.fmt.format(**kwargs) + Exception.__init__(self, msg) + self.kwargs = kwargs + + +class InvalidTemplatePathError(CloudFormationCommandError): + fmt = "Invalid template path {template_path}" + + +class ChangeEmptyError(CloudFormationCommandError): + fmt = "No changes to deploy. Stack {stack_name} is up to date" + + +class InvalidLocalPathError(CloudFormationCommandError): + fmt = ("Parameter {property_name} of resource {resource_id} refers " + "to a file or folder that does not exist {local_path}") + + +class InvalidTemplateUrlParameterError(CloudFormationCommandError): + fmt = ("{property_name} parameter of {resource_id} resource is invalid. " + "It must be a S3 URL or path to CloudFormation " + "template file. Actual: {template_path}") + + +class ExportFailedError(CloudFormationCommandError): + fmt = ("Unable to upload artifact {property_value} referenced " + "by {property_name} parameter of {resource_id} resource." + "\n" + "{ex}") + + +class InvalidKeyValuePairArgumentError(CloudFormationCommandError): + fmt = ("{value} value passed to --{argname} must be of format " + "Key=Value") + + +class DeployFailedError(CloudFormationCommandError): + fmt = \ + ("Failed to create/update the stack. Run the following command" + "\n" + "to fetch the list of events leading up to the failure" + "\n" + "aws cloudformation describe-stack-events --stack-name {stack_name}") + +class DeployBucketRequiredError(CloudFormationCommandError): + fmt = \ + ("Templates with a size greater than 51,200 bytes must be deployed " + "via an S3 Bucket. Please add the --s3-bucket parameter to your " + "command. The local template will be copied to that S3 bucket and " + "then deployed.") diff -Nru awscli-1.11.13/awscli/customizations/cloudformation/__init__.py awscli-1.18.69/awscli/customizations/cloudformation/__init__.py --- awscli-1.11.13/awscli/customizations/cloudformation/__init__.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/cloudformation/__init__.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,31 @@ +# Copyright 2012-2015 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. +from awscli.customizations.cloudformation.package import PackageCommand +from awscli.customizations.cloudformation.deploy import DeployCommand + + +def initialize(cli): + """ + The entry point for CloudFormation high level commands. + """ + cli.register('building-command-table.cloudformation', inject_commands) + + +def inject_commands(command_table, session, **kwargs): + """ + Called when the CloudFormation command table is being built. Used to + inject new high level commands into the command list. These high level + commands must not collide with existing low-level API call names. + """ + command_table['package'] = PackageCommand(session) + command_table['deploy'] = DeployCommand(session) diff -Nru awscli-1.11.13/awscli/customizations/cloudformation/package.py awscli-1.18.69/awscli/customizations/cloudformation/package.py --- awscli-1.11.13/awscli/customizations/cloudformation/package.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/cloudformation/package.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,181 @@ +# Copyright 2012-2015 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 os +import logging +import sys + +import json + +from botocore.client import Config + +from awscli.customizations.cloudformation.artifact_exporter import Template +from awscli.customizations.cloudformation.yamlhelper import yaml_dump +from awscli.customizations.cloudformation import exceptions +from awscli.customizations.commands import BasicCommand +from awscli.customizations.s3uploader import S3Uploader + +LOG = logging.getLogger(__name__) + + +class PackageCommand(BasicCommand): + + MSG_PACKAGED_TEMPLATE_WRITTEN = ( + "Successfully packaged artifacts and wrote output template " + "to file {output_file_name}." + "\n" + "Execute the following command to deploy the packaged template" + "\n" + "aws cloudformation deploy --template-file {output_file_path} " + "--stack-name " + "\n") + + NAME = "package" + + DESCRIPTION = BasicCommand.FROM_FILE("cloudformation", + "_package_description.rst") + + ARG_TABLE = [ + { + 'name': 'template-file', + 'required': True, + 'help_text': ( + 'The path where your AWS CloudFormation' + ' template is located.' + ) + }, + + { + 'name': 's3-bucket', + 'required': True, + 'help_text': ( + 'The name of the S3 bucket where this command uploads' + ' the artifacts that are referenced in your template.' + ) + }, + + { + 'name': 's3-prefix', + 'help_text': ( + 'A prefix name that the command adds to the' + ' artifacts\' name when it uploads them to the S3 bucket.' + ' The prefix name is a path name (folder name) for' + ' the S3 bucket.' + ) + }, + + { + 'name': 'kms-key-id', + 'help_text': ( + 'The ID of an AWS KMS key that the command uses' + ' to encrypt artifacts that are at rest in the S3 bucket.' + ) + }, + + { + "name": "output-template-file", + "help_text": ( + "The path to the file where the command writes the" + " output AWS CloudFormation template. If you don't specify" + " a path, the command writes the template to the standard" + " output." + ) + }, + + { + "name": "use-json", + "action": "store_true", + "help_text": ( + "Indicates whether to use JSON as the format for the output AWS" + " CloudFormation template. YAML is used by default." + ) + }, + + { + "name": "force-upload", + "action": "store_true", + "help_text": ( + 'Indicates whether to override existing files in the S3 bucket.' + ' Specify this flag to upload artifacts even if they ' + ' match existing artifacts in the S3 bucket.' + ) + }, + { + "name": "metadata", + "cli_type_name": "map", + "schema": { + "type": "map", + "key": {"type": "string"}, + "value": {"type": "string"} + }, + "help_text": "A map of metadata to attach to *ALL* the artifacts that" + " are referenced in your template." + } + ] + + def _run_main(self, parsed_args, parsed_globals): + s3_client = self._session.create_client( + "s3", + config=Config(signature_version='s3v4'), + region_name=parsed_globals.region, + verify=parsed_globals.verify_ssl) + + template_path = parsed_args.template_file + if not os.path.isfile(template_path): + raise exceptions.InvalidTemplatePathError( + template_path=template_path) + + bucket = parsed_args.s3_bucket + + self.s3_uploader = S3Uploader(s3_client, + bucket, + parsed_args.s3_prefix, + parsed_args.kms_key_id, + parsed_args.force_upload) + # attach the given metadata to the artifacts to be uploaded + self.s3_uploader.artifact_metadata = parsed_args.metadata + + output_file = parsed_args.output_template_file + use_json = parsed_args.use_json + exported_str = self._export(template_path, use_json) + + sys.stdout.write("\n") + self.write_output(output_file, exported_str) + + if output_file: + msg = self.MSG_PACKAGED_TEMPLATE_WRITTEN.format( + output_file_name=output_file, + output_file_path=os.path.abspath(output_file)) + sys.stdout.write(msg) + + sys.stdout.flush() + return 0 + + def _export(self, template_path, use_json): + template = Template(template_path, os.getcwd(), self.s3_uploader) + exported_template = template.export() + + if use_json: + exported_str = json.dumps(exported_template, indent=4, ensure_ascii=False) + else: + exported_str = yaml_dump(exported_template) + + return exported_str + + def write_output(self, output_file_name, data): + if output_file_name is None: + sys.stdout.write(data) + return + + with open(output_file_name, "w") as fp: + fp.write(data) diff -Nru awscli-1.11.13/awscli/customizations/cloudformation/yamlhelper.py awscli-1.18.69/awscli/customizations/cloudformation/yamlhelper.py --- awscli-1.11.13/awscli/customizations/cloudformation/yamlhelper.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/cloudformation/yamlhelper.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,99 @@ +# Copyright 2012-2015 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. +from botocore.compat import json +from botocore.compat import OrderedDict + +import yaml +from yaml.resolver import ScalarNode, SequenceNode + +from awscli.compat import six + + +def intrinsics_multi_constructor(loader, tag_prefix, node): + """ + YAML constructor to parse CloudFormation intrinsics. + This will return a dictionary with key being the instrinsic name + """ + + # Get the actual tag name excluding the first exclamation + tag = node.tag[1:] + + # Some intrinsic functions doesn't support prefix "Fn::" + prefix = "Fn::" + if tag in ["Ref", "Condition"]: + prefix = "" + + cfntag = prefix + tag + + if tag == "GetAtt" and isinstance(node.value, six.string_types): + # ShortHand notation for !GetAtt accepts Resource.Attribute format + # while the standard notation is to use an array + # [Resource, Attribute]. Convert shorthand to standard format + value = node.value.split(".", 1) + + elif isinstance(node, ScalarNode): + # Value of this node is scalar + value = loader.construct_scalar(node) + + elif isinstance(node, SequenceNode): + # Value of this node is an array (Ex: [1,2]) + value = loader.construct_sequence(node) + + else: + # Value of this node is an mapping (ex: {foo: bar}) + value = loader.construct_mapping(node) + + return {cfntag: value} + + +def _dict_representer(dumper, data): + return dumper.represent_dict(data.items()) + + +def yaml_dump(dict_to_dump): + """ + Dumps the dictionary as a YAML document + :param dict_to_dump: + :return: + """ + FlattenAliasDumper.add_representer(OrderedDict, _dict_representer) + return yaml.dump( + dict_to_dump, + default_flow_style=False, + Dumper=FlattenAliasDumper, + ) + + +def _dict_constructor(loader, node): + # Necessary in order to make yaml merge tags work + loader.flatten_mapping(node) + return OrderedDict(loader.construct_pairs(node)) + + +def yaml_parse(yamlstr): + """Parse a yaml string""" + try: + # PyYAML doesn't support json as well as it should, so if the input + # is actually just json it is better to parse it with the standard + # json parser. + return json.loads(yamlstr, object_pairs_hook=OrderedDict) + except ValueError: + yaml.SafeLoader.add_constructor(yaml.resolver.BaseResolver.DEFAULT_MAPPING_TAG, _dict_constructor) + yaml.SafeLoader.add_multi_constructor( + "!", intrinsics_multi_constructor) + return yaml.safe_load(yamlstr) + + +class FlattenAliasDumper(yaml.SafeDumper): + def ignore_aliases(self, data): + return True diff -Nru awscli-1.11.13/awscli/customizations/cloudfront.py awscli-1.18.69/awscli/customizations/cloudfront.py --- awscli-1.11.13/awscli/customizations/cloudfront.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/cloudfront.py 2020-05-28 19:25:48.000000000 +0000 @@ -48,7 +48,8 @@ 'default-root-object', CreateDefaultRootObject(argument_table))) context = {} - event_handler.register('top-level-args-parsed', context.update) + event_handler.register( + 'top-level-args-parsed', context.update, unique_id='cloudfront') event_handler.register( 'operation-args-parsed.cloudfront.update-distribution', validate_mutually_exclusive_handler( diff -Nru awscli-1.11.13/awscli/customizations/cloudtrail/subscribe.py awscli-1.18.69/awscli/customizations/cloudtrail/subscribe.py --- awscli-1.11.13/awscli/customizations/cloudtrail/subscribe.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/cloudtrail/subscribe.py 2020-05-28 19:25:48.000000000 +0000 @@ -58,8 +58,8 @@ {'name': 'sns-custom-policy', 'help_text': 'Custom SNS policy template or URL'} ] - UPDATE = False + _UNDOCUMENTED = True def _run_main(self, args, parsed_globals): self.setup_services(args, parsed_globals) diff -Nru awscli-1.11.13/awscli/customizations/cloudtrail/validation.py awscli-1.18.69/awscli/customizations/cloudtrail/validation.py --- awscli-1.11.13/awscli/customizations/cloudtrail/validation.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/cloudtrail/validation.py 2020-05-28 19:25:48.000000000 +0000 @@ -29,6 +29,7 @@ get_account_id_from_arn from awscli.customizations.commands import BasicCommand from botocore.exceptions import ClientError +from awscli.schema import ParameterRequiredError LOG = logging.getLogger(__name__) @@ -77,14 +78,17 @@ raise ValueError('Invalid trail ARN provided: %s' % trail_arn) -def create_digest_traverser(cloudtrail_client, s3_client_provider, trail_arn, +def create_digest_traverser(cloudtrail_client, organization_client, + s3_client_provider, trail_arn, trail_source_region=None, on_invalid=None, on_gap=None, on_missing=None, bucket=None, - prefix=None): + prefix=None, account_id=None): """Creates a CloudTrail DigestTraverser and its object graph. :type cloudtrail_client: botocore.client.CloudTrail :param cloudtrail_client: Client used to connect to CloudTrail + :type organization_client: botocore.client.organizations + :param organization_client: Client used to connect to Organizations :type s3_client_provider: S3ClientProvider :param s3_client_provider: Used to create Amazon S3 client per/region. :param trail_arn: CloudTrail trail ARN @@ -100,6 +104,9 @@ :param prefix: bucket: Key prefix prepended to each digest and log placed in the Amazon S3 bucket if it is different than the prefix that is currently associated with the trail. + :param account_id: The account id for which the digest files are + validated. For normal trails this is the caller account, for + organization trails it is the member accout. ``on_gap``, ``on_invalid``, and ``on_missing`` callbacks are invoked with the following named arguments: @@ -112,22 +119,36 @@ - ``message``: (optional) Message string about the notification. """ assert_cloudtrail_arn_is_valid(trail_arn) - account_id = get_account_id_from_arn(trail_arn) + organization_id = None if bucket is None: # Determine the bucket and prefix based on the trail arn. trail_info = get_trail_by_arn(cloudtrail_client, trail_arn) LOG.debug('Loaded trail info: %s', trail_info) bucket = trail_info['S3BucketName'] prefix = trail_info.get('S3KeyPrefix', None) + is_org_trail = trail_info['IsOrganizationTrail'] + if is_org_trail: + if not account_id: + raise ParameterRequiredError( + "Missing required parameter for organization " + "trail: '--account-id'") + organization_id = organization_client.describe_organization()[ + 'Organization']['Id'] + # 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, trail_source_region=trail_source_region, - trail_home_region=trail_region) + trail_home_region=trail_region, + organization_id=organization_id) return DigestTraverser( digest_provider=digest_provider, starting_bucket=bucket, starting_prefix=prefix, on_invalid=on_invalid, on_gap=on_gap, @@ -224,12 +245,14 @@ one digest to the next. """ def __init__(self, s3_client_provider, account_id, trail_name, - trail_home_region, trail_source_region=None): + trail_home_region, trail_source_region=None, + organization_id=None): self._client_provider = s3_client_provider self.trail_name = trail_name self.account_id = account_id self.trail_home_region = trail_home_region self.trail_source_region = trail_source_region or trail_home_region + self.organization_id = organization_id def load_digest_keys_in_range(self, bucket, prefix, start_date, end_date): """Returns a list of digest keys in the date range. @@ -300,28 +323,46 @@ """ # Subtract one minute to ensure the dates are inclusive. date = start_date - timedelta(minutes=1) - template = ('AWSLogs/{account}/CloudTrail-Digest/{source_region}/' - '{ymd}/{account}_CloudTrail-Digest_{source_region}_{name}_' - '{home_region}_{date}.json.gz') - key = template.format(account=self.account_id, date=format_date(date), - ymd=date.strftime('%Y/%m/%d'), - source_region=self.trail_source_region, - home_region=self.trail_home_region, - name=self.trail_name) + template = 'AWSLogs/' + template_params = { + 'account_id': self.account_id, + 'date': format_date(date), + 'ymd': date.strftime('%Y/%m/%d'), + 'source_region': self.trail_source_region, + 'home_region': self.trail_home_region, + 'name': self.trail_name + } + if self.organization_id: + template += '{organization_id}/' + template_params['organization_id'] = self.organization_id + template += ( + '{account_id}/CloudTrail-Digest/{source_region}/' + '{ymd}/{account_id}_CloudTrail-Digest_{source_region}_{name}_' + '{home_region}_{date}.json.gz' + ) + key = template.format(**template_params) if key_prefix: key = key_prefix + '/' + key return key def _create_digest_key_regex(self, key_prefix): """Creates a regular expression used to match against S3 keys""" - template = ('AWSLogs/{account}/CloudTrail\\-Digest/{source_region}/' - '\\d+/\\d+/\\d+/{account}_CloudTrail\\-Digest_' - '{source_region}_{name}_{home_region}_.+\\.json\\.gz') - key = template.format( - account=re.escape(self.account_id), - source_region=re.escape(self.trail_source_region), - home_region=re.escape(self.trail_home_region), - name=re.escape(self.trail_name)) + template = 'AWSLogs/' + template_params = { + 'account_id': re.escape(self.account_id), + 'source_region': re.escape(self.trail_source_region), + 'home_region': re.escape(self.trail_home_region), + 'name': re.escape(self.trail_name) + } + if self.organization_id: + template += '{organization_id}/' + template_params['organization_id'] = self.organization_id + template += ( + '{account_id}/CloudTrail\\-Digest/{source_region}/' + '\\d+/\\d+/\\d+/{account_id}_CloudTrail\\-Digest_' + '{source_region}_{name}_{home_region}_.+\\.json\\.gz' + ) + key = template.format(**template_params) if key_prefix: key = re.escape(key_prefix) + '/' + key return '^' + key + '$' @@ -585,6 +626,8 @@ log files. - The digest and log files must not have been moved from the original S3 location where CloudTrail delivered them. + - For organization trails you must have access to describe-organization to + validate digest files When you disable Log File Validation, the chain of digest files is broken after one hour. CloudTrail will not digest log files that were delivered @@ -629,6 +672,11 @@ 'digest files are stored. If not specified, the CLI ' 'will determine the prefix automatically by calling ' 'describe_trails.')}, + {'name': 'account-id', 'cli_type_name': 'string', + 'help_text': ('Optionally specifies the account for validating logs. ' + 'This parameter is needed for organization trails ' + 'for validating logs for specific account inside an ' + 'organization')}, {'name': 'verbose', 'cli_type_name': 'boolean', 'action': 'store_true', 'help_text': 'Display verbose log validation information'} @@ -644,6 +692,7 @@ self.s3_prefix = None self.s3_client_provider = None self.cloudtrail_client = None + self.account_id = None self._source_region = None self._valid_digests = 0 self._invalid_digests = 0 @@ -666,6 +715,7 @@ self.is_verbose = args.verbose self.s3_bucket = args.s3_bucket self.s3_prefix = args.s3_prefix + self.account_id = args.account_id self.start_time = normalize_date(parse_date(args.start_time)) if args.end_time: self.end_time = normalize_date(parse_date(args.end_time)) @@ -688,6 +738,9 @@ self._session, self._source_region) client_args = {'region_name': parsed_globals.region, 'verify': parsed_globals.verify_ssl} + self.organization_client = self._session.create_client( + 'organizations', **client_args) + if parsed_globals.endpoint_url is not None: client_args['endpoint_url'] = parsed_globals.endpoint_url self.cloudtrail_client = self._session.create_client( @@ -696,10 +749,12 @@ def _call(self): traverser = create_digest_traverser( trail_arn=self.trail_arn, cloudtrail_client=self.cloudtrail_client, + organization_client=self.organization_client, trail_source_region=self._source_region, s3_client_provider=self.s3_client_provider, bucket=self.s3_bucket, prefix=self.s3_prefix, on_missing=self._on_missing_digest, - on_invalid=self._on_invalid_digest, on_gap=self._on_digest_gap) + on_invalid=self._on_invalid_digest, on_gap=self._on_digest_gap, + account_id=self.account_id) self._write_startup_text() digests = traverser.traverse(self.start_time, self.end_time) for digest in digests: diff -Nru awscli-1.11.13/awscli/customizations/codecommit.py awscli-1.18.69/awscli/customizations/codecommit.py --- awscli-1.11.13/awscli/customizations/codecommit.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/codecommit.py 2020-05-28 19:25:48.000000000 +0000 @@ -122,8 +122,10 @@ def read_git_parameters(self): parsed = {} for line in sys.stdin: - key, value = line.strip().split('=', 1) - parsed[key] = value + line = line.strip() + if line: + key, value = line.split('=', 1) + parsed[key] = value return parsed def extract_url(self, parameters): @@ -133,10 +135,10 @@ return url def extract_region(self, parameters, parsed_globals): - match = re.match(r'git-codecommit\.([^.]+)\.amazonaws\.com', + match = re.match(r'(vpce-.+\.)?git-codecommit(-fips)?\.([^.]+)\.(vpce\.)?amazonaws\.com', parameters['host']) if match is not None: - return match.group(1) + return match.group(3) elif parsed_globals.region is not None: return parsed_globals.region else: diff -Nru awscli-1.11.13/awscli/customizations/codedeploy/utils.py awscli-1.18.69/awscli/customizations/codedeploy/utils.py --- awscli-1.11.13/awscli/customizations/codedeploy/utils.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/codedeploy/utils.py 2020-05-28 19:25:48.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 @@ -83,7 +85,7 @@ MAX_TAG_KEY_LENGTH ) ) - if len(tag['Value']) > MAX_TAG_KEY_LENGTH: + if len(tag['Value']) > MAX_TAG_VALUE_LENGTH: raise ValueError( 'Tag Value cannot be longer than {0} characters.'.format( MAX_TAG_VALUE_LENGTH @@ -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.11.13/awscli/customizations/commands.py awscli-1.18.69/awscli/customizations/commands.py --- awscli-1.11.13/awscli/customizations/commands.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/commands.py 2020-05-28 19:25:48.000000000 +0000 @@ -366,13 +366,11 @@ super(BasicDocHandler, self).__init__(help_command) self.doc = help_command.doc - def build_translation_map(self): - return {} - def doc_description(self, help_command, **kwargs): self.doc.style.h2('Description') self.doc.write(help_command.description) self.doc.style.new_paragraph() + self._add_top_level_args_reference(help_command) def doc_synopsis_start(self, help_command, **kwargs): if not help_command.synopsis: @@ -440,3 +438,6 @@ def doc_output(self, help_command, event_name, **kwargs): pass + + def doc_options_end(self, help_command, **kwargs): + self._add_top_level_args_reference(help_command) diff -Nru awscli-1.11.13/awscli/customizations/configure/addmodel.py awscli-1.18.69/awscli/customizations/configure/addmodel.py --- awscli-1.11.13/awscli/customizations/configure/addmodel.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/configure/addmodel.py 2020-05-28 19:25:48.000000000 +0000 @@ -114,7 +114,7 @@ os.makedirs(model_directory) # Write the model to the specified location - with open(model_location, 'w') as f: - f.write(parsed_args.service_model) + with open(model_location, 'wb') as f: + f.write(parsed_args.service_model.encode('utf-8')) return 0 diff -Nru awscli-1.11.13/awscli/customizations/configure/configure.py awscli-1.18.69/awscli/customizations/configure/configure.py --- awscli-1.11.13/awscli/customizations/configure/configure.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/configure/configure.py 2020-05-28 19:25:48.000000000 +0000 @@ -23,7 +23,7 @@ from awscli.customizations.configure.list import ConfigureListCommand from awscli.customizations.configure.writer import ConfigFileWriter -from . import mask_value +from . import mask_value, profile_to_section logger = logging.getLogger(__name__) @@ -112,11 +112,11 @@ config_filename = os.path.expanduser( self._session.get_config_variable('config_file')) if new_values: - self._write_out_creds_file_values(new_values, - parsed_globals.profile) - if parsed_globals.profile is not None: - new_values['__section__'] = ( - 'profile %s' % parsed_globals.profile) + profile = self._session.profile + self._write_out_creds_file_values(new_values, profile) + if profile is not None: + section = profile_to_section(profile) + new_values['__section__'] = section self._config_writer.update_config(new_values, config_filename) def _write_out_creds_file_values(self, new_values, profile_name): diff -Nru awscli-1.11.13/awscli/customizations/configure/get.py awscli-1.18.69/awscli/customizations/configure/get.py --- awscli-1.11.13/awscli/customizations/configure/get.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/configure/get.py 2020-05-28 19:25:48.000000000 +0000 @@ -11,17 +11,21 @@ # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import sys +import logging from awscli.customizations.commands import BasicCommand +from awscli.compat import six from . import PREDEFINED_SECTION_NAMES +LOG = logging.getLogger(__name__) + class ConfigureGetCommand(BasicCommand): NAME = 'get' DESCRIPTION = BasicCommand.FROM_FILE('configure', 'get', '_description.rst') - SYNOPSIS = ('aws configure get varname [--profile profile-name]') + SYNOPSIS = 'aws configure get varname [--profile profile-name]' EXAMPLES = BasicCommand.FROM_FILE('configure', 'get', '_examples.rst') ARG_TABLE = [ {'name': 'varname', @@ -30,13 +34,14 @@ 'cli_type_name': 'string', 'positional_arg': True}, ] - def __init__(self, session, stream=sys.stdout): + def __init__(self, session, stream=sys.stdout, error_stream=sys.stderr): super(ConfigureGetCommand, self).__init__(session) self._stream = stream + self._error_stream = error_stream def _run_main(self, args, parsed_globals): varname = args.varname - value = None + if '.' not in varname: # get_scoped_config() returns the config variables in the config # file (not the logical_var names), which is what we want. @@ -44,17 +49,30 @@ value = config.get(varname) else: value = self._get_dotted_config_value(varname) - if value is not None: + + LOG.debug(u'Config value retrieved: %s' % value) + + if isinstance(value, six.string_types): self._stream.write(value) self._stream.write('\n') return 0 + elif isinstance(value, dict): + # TODO: add support for this. We would need to print it off in + # the same format as the config file. + self._error_stream.write( + 'varname (%s) must reference a value, not a section or ' + 'sub-section.' % varname + ) + return 1 else: return 1 def _get_dotted_config_value(self, varname): parts = varname.split('.') num_dots = varname.count('.') - # Logic to deal with predefined sections like [preview], [plugin] and etc. + + # Logic to deal with predefined sections like [preview], [plugin] and + # etc. if num_dots == 1 and parts[0] in PREDEFINED_SECTION_NAMES: full_config = self._session.full_config section, config_name = varname.split('.') @@ -64,18 +82,23 @@ value = full_config['profiles'].get( section, {}).get(config_name) return value + if parts[0] == 'profile': profile_name = parts[1] config_name = parts[2] remaining = parts[3:] - # Check if varname starts with 'default' profile (e.g. default.emr-dev.emr.instance_profile) - # If not, go further to check if varname starts with a known profile name - elif parts[0] == 'default' or (parts[0] in self._session.full_config['profiles']): + # Check if varname starts with 'default' profile (e.g. + # default.emr-dev.emr.instance_profile) If not, go further to check + # if varname starts with a known profile name + elif parts[0] == 'default' or ( + parts[0] in self._session.full_config['profiles']): profile_name = parts[0] config_name = parts[1] remaining = parts[2:] else: profile_name = self._session.get_config_variable('profile') + if profile_name is None: + profile_name = 'default' config_name = parts[0] remaining = parts[1:] diff -Nru awscli-1.11.13/awscli/customizations/configure/__init__.py awscli-1.18.69/awscli/customizations/configure/__init__.py --- awscli-1.11.13/awscli/customizations/configure/__init__.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/configure/__init__.py 2020-05-28 19:25:48.000000000 +0000 @@ -10,8 +10,12 @@ # 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 string +from botocore.vendored.six.moves import shlex_quote + NOT_SET = '' PREDEFINED_SECTION_NAMES = ('preview', 'plugins') +_WHITESPACE = ' \t' class ConfigValue(object): @@ -36,3 +40,10 @@ return 'None' else: return ('*' * 16) + current_value[-4:] + + +def profile_to_section(profile_name): + """Converts a profile name to a section header to be used in the config.""" + if any(c in _WHITESPACE for c in profile_name): + profile_name = shlex_quote(profile_name) + return 'profile %s' % profile_name diff -Nru awscli-1.11.13/awscli/customizations/configure/set.py awscli-1.18.69/awscli/customizations/configure/set.py --- awscli-1.11.13/awscli/customizations/configure/set.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/configure/set.py 2020-05-28 19:25:48.000000000 +0000 @@ -15,7 +15,7 @@ from awscli.customizations.commands import BasicCommand from awscli.customizations.configure.writer import ConfigFileWriter -from . import PREDEFINED_SECTION_NAMES +from . import PREDEFINED_SECTION_NAMES, profile_to_section class ConfigureSetCommand(BasicCommand): @@ -60,7 +60,7 @@ # profile (or leave it as the 'default' section if # no profile is set). if self._session.profile is not None: - section = 'profile %s' % self._session.profile + section = profile_to_section(self._session.profile) else: # First figure out if it's been scoped to a profile. parts = varname.split('.') @@ -71,14 +71,14 @@ remaining = parts[1:] else: # [profile, profile_name, ...] - section = "profile %s" % parts[1] + section = profile_to_section(parts[1]) remaining = parts[2:] varname = remaining[0] if len(remaining) == 2: value = {remaining[1]: value} elif parts[0] not in PREDEFINED_SECTION_NAMES: if self._session.profile is not None: - section = 'profile %s' % self._session.profile + section = profile_to_section(self._session.profile) else: profile_name = self._session.get_config_variable('profile') if profile_name is not None: diff -Nru awscli-1.11.13/awscli/customizations/datapipeline/__init__.py awscli-1.18.69/awscli/customizations/datapipeline/__init__.py --- awscli-1.11.13/awscli/customizations/datapipeline/__init__.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/datapipeline/__init__.py 2020-05-28 19:25:48.000000000 +0000 @@ -50,6 +50,7 @@ you can use the same key name and specify each value as a key value pair. e.g. arrayValue=value1 arrayValue=value2 """ +MAX_ITEMS_PER_DESCRIBE = 100 class DocSectionNotFoundError(Exception): @@ -305,7 +306,10 @@ key = argument_components[0] value = argument_components[1] if key in parameter_object: - parameter_object[key] = [parameter_object[key], value] + if isinstance(parameter_object[key], list): + parameter_object[key].append(value) + else: + parameter_object[key] = [parameter_object[key], value] else: parameter_object[key] = value except IndexError: @@ -390,8 +394,7 @@ def _list_runs(self, parsed_args, parsed_globals): query = QueryArgBuilder().build_query(parsed_args) object_ids = self._query_objects(parsed_args.pipeline_id, query) - objects = self._describe_objects(parsed_args.pipeline_id, object_ids)[ - 'pipelineObjects'] + objects = self._describe_objects(parsed_args.pipeline_id, object_ids) converted = convert_described_objects( objects, sort_key_func=lambda x: (x.get('@scheduledStartTime'), @@ -400,9 +403,17 @@ formatter(self.NAME, converted) def _describe_objects(self, pipeline_id, object_ids): - parsed = self.client.describe_objects( - pipelineId=pipeline_id, objectIds=object_ids) - return parsed + # DescribeObjects will only accept 100 objectIds at a time, + # so we need to break up the list passed in into chunks that are at + # most that size. We then aggregate the results to return. + objects = [] + for i in range(0, len(object_ids), MAX_ITEMS_PER_DESCRIBE): + current_object_ids = object_ids[i:i + MAX_ITEMS_PER_DESCRIBE] + result = self.client.describe_objects( + pipelineId=pipeline_id, objectIds=current_object_ids) + objects.extend(result['pipelineObjects']) + + return objects def _query_objects(self, pipeline_id, query): paginator = self.client.get_paginator('query_objects').paginate( diff -Nru awscli-1.11.13/awscli/customizations/dlm/constants.py awscli-1.18.69/awscli/customizations/dlm/constants.py --- awscli-1.11.13/awscli/customizations/dlm/constants.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/dlm/constants.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,35 @@ +# Copyright 2018 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. + +# Declare all the constants used by Lifecycle in this file + +# Lifecycle role names +LIFECYCLE_DEFAULT_ROLE_NAME = "AWSDataLifecycleManagerDefaultRole" + +# Lifecycle role arn names +LIFECYCLE_DEFAULT_MANAGED_POLICY_NAME = "AWSDataLifecycleManagerServiceRole" + +POLICY_ARN_PATTERN = "arn:{0}:iam::aws:policy/service-role/{1}" + +# Assume Role Policy definitions for roles +LIFECYCLE_DEFAULT_ROLE_ASSUME_POLICY = { + "Version": "2012-10-17", + "Statement": [ + { + "Sid": "", + "Effect": "Allow", + "Principal": {"Service": "dlm.amazonaws.com"}, + "Action": "sts:AssumeRole" + } + ] +} diff -Nru awscli-1.11.13/awscli/customizations/dlm/createdefaultrole.py awscli-1.18.69/awscli/customizations/dlm/createdefaultrole.py --- awscli-1.11.13/awscli/customizations/dlm/createdefaultrole.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/dlm/createdefaultrole.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,155 @@ +# Copyright 2018 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. + +# Class to create default roles for lifecycle +import logging +from awscli.clidriver import CLIOperationCaller +from awscli.customizations.utils import get_policy_arn_suffix +from awscli.customizations.commands import BasicCommand +from awscli.customizations.dlm.iam import IAM +from awscli.customizations.dlm.constants \ + import LIFECYCLE_DEFAULT_ROLE_NAME, \ + LIFECYCLE_DEFAULT_ROLE_ASSUME_POLICY, \ + LIFECYCLE_DEFAULT_MANAGED_POLICY_NAME, \ + POLICY_ARN_PATTERN + +LOG = logging.getLogger(__name__) + + +def _construct_result(create_role_response, get_policy_response): + get_policy_response.pop('ResponseMetadata', None) + create_role_response.pop('ResponseMetadata', None) + result = {'RolePolicy': get_policy_response} + result.update(create_role_response) + return result + + +# Display the result as formatted json +def display_response(session, operation_name, result, parsed_globals): + if result is not None: + cli_operation_caller = CLIOperationCaller(session) + # Calling a private method. Should be changed after the functionality + # is moved outside CliOperationCaller. + cli_operation_caller._display_response( + operation_name, result, parsed_globals) + + +# Get policy arn from region and policy name +def get_policy_arn(region, policy_name): + region_suffix = get_policy_arn_suffix(region) + role_arn = POLICY_ARN_PATTERN.format(region_suffix, policy_name) + return role_arn + + +# Method to parse the arguments to get the region value +def get_region(session, parsed_globals): + region = parsed_globals.region + if region is None: + region = session.get_config_variable('region') + return region + + +class CreateDefaultRole(BasicCommand): + NAME = "create-default-role" + DESCRIPTION = ('Creates the default IAM role ' + + LIFECYCLE_DEFAULT_ROLE_NAME + + ' which will be used by Lifecycle service.\n' + 'If the role does not exist, create-default-role ' + 'will automatically create it and set its policy.' + ' If the role has been already ' + 'created, create-default-role' + ' will not update its policy.' + '\n') + ARG_TABLE = [ + {'name': 'iam-endpoint', + 'no_paramfile': True, + 'help_text': '

The IAM endpoint to call for creating the roles.' + ' This is optional and should only be specified when a' + ' custom endpoint should be called for IAM operations' + '.

'} + ] + + def __init__(self, session): + super(CreateDefaultRole, self).__init__(session) + + def _run_main(self, parsed_args, parsed_globals): + """Call to run the commands""" + + self._region = get_region(self._session, parsed_globals) + self._endpoint_url = parsed_args.iam_endpoint + self._iam_client = IAM(self._session.create_client( + 'iam', + region_name=self._region, + endpoint_url=self._endpoint_url, + verify=parsed_globals.verify_ssl + )) + + result = self._create_default_role_if_not_exists(parsed_globals) + + display_response( + self._session, + 'create_role', + result, + parsed_globals + ) + + return 0 + + def _create_default_role_if_not_exists(self, parsed_globals): + """Method to create default lifecycle role + if it doesn't exist already + """ + role_name = LIFECYCLE_DEFAULT_ROLE_NAME + assume_role_policy = LIFECYCLE_DEFAULT_ROLE_ASSUME_POLICY + + if self._iam_client.check_if_role_exists(role_name): + LOG.debug('Role %s exists', role_name) + return None + + LOG.debug('Role %s does not exist. ' + 'Creating default role for Lifecycle', role_name) + + # Get Region + region = get_region(self._session, parsed_globals) + + if region is None: + raise ValueError('You must specify a region. ' + 'You can also configure your region ' + 'by running "aws configure".') + + managed_policy_arn = get_policy_arn( + region, + LIFECYCLE_DEFAULT_MANAGED_POLICY_NAME + ) + + # Don't proceed if managed policy does not exist + if not self._iam_client.check_if_policy_exists(managed_policy_arn): + LOG.debug('Managed Policy %s does not exist.', managed_policy_arn) + return None + + LOG.debug('Managed Policy %s exists.', managed_policy_arn) + # Create default role + create_role_response = \ + self._iam_client.create_role_with_trust_policy( + role_name, + assume_role_policy + ) + # Attach policy to role + self._iam_client.attach_policy_to_role( + managed_policy_arn, + role_name + ) + + # Construct result + get_policy_response = self._iam_client.get_policy(managed_policy_arn) + return _construct_result(create_role_response, get_policy_response) diff -Nru awscli-1.11.13/awscli/customizations/dlm/dlm.py awscli-1.18.69/awscli/customizations/dlm/dlm.py --- awscli-1.11.13/awscli/customizations/dlm/dlm.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/dlm/dlm.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,30 @@ +# Copyright 2018 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. + +from awscli.customizations.dlm.createdefaultrole import CreateDefaultRole + + +def dlm_initialize(cli): + """ + The entry point for Lifecycle high level commands. + """ + cli.register('building-command-table.dlm', register_commands) + + +def register_commands(command_table, session, **kwargs): + """ + Called when the Lifecycle command table is being built. Used to inject new + high level commands into the command list. These high level commands + must not collide with existing low-level API call names. + """ + command_table['create-default-role'] = CreateDefaultRole(session) diff -Nru awscli-1.11.13/awscli/customizations/dlm/iam.py awscli-1.18.69/awscli/customizations/dlm/iam.py --- awscli-1.11.13/awscli/customizations/dlm/iam.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/dlm/iam.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,51 @@ +import json + + +class IAM(object): + + def __init__(self, iam_client): + self.iam_client = iam_client + + def check_if_role_exists(self, role_name): + """Method to verify if a particular role exists""" + try: + self.iam_client.get_role(RoleName=role_name) + except self.iam_client.exceptions.NoSuchEntityException: + return False + return True + + def check_if_policy_exists(self, policy_arn): + """Method to verify if a particular policy exists""" + try: + self.iam_client.get_policy(PolicyArn=policy_arn) + except self.iam_client.exceptions.NoSuchEntityException: + return False + return True + + def attach_policy_to_role(self, policy_arn, role_name): + """Method to attach LifecyclePolicy to role specified by role_name""" + return self.iam_client.attach_role_policy( + PolicyArn=policy_arn, + RoleName=role_name + ) + + def create_role_with_trust_policy(self, role_name, assume_role_policy): + """Method to create role with a given role name + and assume_role_policy + """ + return self.iam_client.create_role( + RoleName=role_name, + AssumeRolePolicyDocument=json.dumps(assume_role_policy)) + + def get_policy(self, arn): + """Method to get the Policy for a particular ARN + This is used to display the policy contents to the user + """ + pol_det = self.iam_client.get_policy(PolicyArn=arn) + policy_version_details = self.iam_client.get_policy_version( + PolicyArn=arn, + VersionId=pol_det.get("Policy", {}).get("DefaultVersionId", "") + ) + return policy_version_details\ + .get("PolicyVersion", {})\ + .get("Document", {}) diff -Nru awscli-1.11.13/awscli/customizations/dlm/__init__.py awscli-1.18.69/awscli/customizations/dlm/__init__.py --- awscli-1.11.13/awscli/customizations/dlm/__init__.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/dlm/__init__.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,12 @@ +# Copyright 2018 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. diff -Nru awscli-1.11.13/awscli/customizations/dynamodb.py awscli-1.18.69/awscli/customizations/dynamodb.py --- awscli-1.11.13/awscli/customizations/dynamodb.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/dynamodb.py 2020-05-28 19:25:48.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.11.13/awscli/customizations/ec2/bundleinstance.py awscli-1.18.69/awscli/customizations/ec2/bundleinstance.py --- awscli-1.11.13/awscli/customizations/ec2/bundleinstance.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/ec2/bundleinstance.py 2020-05-28 19:25:48.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.11.13/awscli/customizations/ec2/runinstances.py awscli-1.18.69/awscli/customizations/ec2/runinstances.py --- awscli-1.11.13/awscli/customizations/ec2/runinstances.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/ec2/runinstances.py 2020-05-28 19:25:48.000000000 +0000 @@ -42,6 +42,7 @@ '[EC2-VPC] If specified a public IP address will be assigned ' 'to the new instance in a VPC.') + def _add_params(argument_table, **kwargs): arg = SecondaryPrivateIpAddressesArgument( name='secondary-private-ip-addresses', @@ -97,28 +98,32 @@ 'AssociatePublicIpAddress' ] if 'NetworkInterfaces' in params: - ni = params['NetworkInterfaces'] - for network_interface_param in network_interface_params: - if network_interface_param in ni[0]: - if 'SubnetId' in params: - ni[0]['SubnetId'] = params['SubnetId'] - del params['SubnetId'] - if 'SecurityGroupIds' in params: - ni[0]['Groups'] = params['SecurityGroupIds'] - del params['SecurityGroupIds'] - if 'PrivateIpAddress' in params: - ip_addr = {'PrivateIpAddress': params['PrivateIpAddress'], - 'Primary': True} - ni[0]['PrivateIpAddresses'] = [ip_addr] - del params['PrivateIpAddress'] - return + interface = params['NetworkInterfaces'][0] + if any(param in interface for param in network_interface_params): + if 'SubnetId' in params: + interface['SubnetId'] = params['SubnetId'] + del params['SubnetId'] + if 'SecurityGroupIds' in params: + interface['Groups'] = params['SecurityGroupIds'] + del params['SecurityGroupIds'] + if 'PrivateIpAddress' in params: + ip_addr = {'PrivateIpAddress': params['PrivateIpAddress'], + 'Primary': True} + interface['PrivateIpAddresses'] = [ip_addr] + del params['PrivateIpAddress'] + if 'Ipv6AddressCount' in params: + interface['Ipv6AddressCount'] = params['Ipv6AddressCount'] + del params['Ipv6AddressCount'] + if 'Ipv6Addresses' in params: + interface['Ipv6Addresses'] = params['Ipv6Addresses'] + del params['Ipv6Addresses'] EVENTS = [ ('building-argument-table.ec2.run-instances', _add_params), ('operation-args-parsed.ec2.run-instances', _check_args), ('before-parameter-build.ec2.RunInstances', _fix_args), - ] +] def register_runinstances(event_handler): @@ -147,11 +152,9 @@ def add_to_params(self, parameters, value): if value: - value = [{'PrivateIpAddress': v, 'Primary': False} for - v in value] - _build_network_interfaces(parameters, - 'PrivateIpAddresses', - value) + value = [{'PrivateIpAddress': v, 'Primary': False} for v in value] + _build_network_interfaces( + parameters, 'PrivateIpAddresses', value) class SecondaryPrivateIpAddressCountArgument(CustomArgument): @@ -162,24 +165,21 @@ def add_to_params(self, parameters, value): if value: - _build_network_interfaces(parameters, - 'SecondaryPrivateIpAddressCount', - value) + _build_network_interfaces( + parameters, 'SecondaryPrivateIpAddressCount', value) class AssociatePublicIpAddressArgument(CustomArgument): def add_to_params(self, parameters, value): if value is True: - _build_network_interfaces(parameters, - 'AssociatePublicIpAddress', - value) + _build_network_interfaces( + parameters, 'AssociatePublicIpAddress', value) class NoAssociatePublicIpAddressArgument(CustomArgument): def add_to_params(self, parameters, value): if value is False: - _build_network_interfaces(parameters, - 'AssociatePublicIpAddress', - value) + _build_network_interfaces( + parameters, 'AssociatePublicIpAddress', value) diff -Nru awscli-1.11.13/awscli/customizations/ec2/secgroupsimplify.py awscli-1.18.69/awscli/customizations/ec2/secgroupsimplify.py --- awscli-1.11.13/awscli/customizations/ec2/secgroupsimplify.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/ec2/secgroupsimplify.py 2020-05-28 19:25:48.000000000 +0000 @@ -94,10 +94,9 @@ ('doc-description.ec2.revoke-security-group-ingress', _add_docs), ('doc-description.ec2.revoke-security-groupdoc-ingress', _add_docs), ] -PROTOCOL_DOCS = ('

The IP protocol of this permission.

' - '

Valid protocol values: tcp, ' - 'udp, icmp, ' - 'all

' +PROTOCOL_DOCS = ('

The IP protocol: tcp | ' + 'udp | icmp

' + '

(VPC only) Use all to specify all protocols.

' '

If this argument is provided without also providing the ' 'port argument, then it will be applied to all ' 'ports for the specified protocol.

') @@ -110,8 +109,7 @@ ' all ICMP types. A value of -1 just for type' ' indicates all ICMP codes for the specified ICMP type.

') CIDR_DOCS = '

The CIDR IP range.

' -SOURCEGROUP_DOCS = ('

The name or ID of the source security group. ' - 'Cannot be used when specifying a CIDR IP address.') +SOURCEGROUP_DOCS = ('

The name or ID of the source security group.

') GROUPOWNER_DOCS = ('

The AWS account ID that owns the source security ' 'group. Cannot be used when specifying a CIDR IP ' 'address.

') diff -Nru awscli-1.11.13/awscli/customizations/ecr.py awscli-1.18.69/awscli/customizations/ecr.py --- awscli-1.11.13/awscli/customizations/ecr.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/ecr.py 2020-05-28 19:25:48.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') @@ -38,7 +39,31 @@ 'Amazon ECR registries that you want to log in to.', 'required': False, 'nargs': '+' - } + }, + { + 'name': 'include-email', + 'action': 'store_true', + 'group_name': 'include-email', + 'dest': 'include_email', + 'default': True, + 'required': False, + '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 " + "17.06 or later. The default behavior is to include the " + "'-e' flag in the 'docker login' output."), + }, + { + 'name': 'no-include-email', + 'help_text': 'Include email arg', + 'action': 'store_false', + 'default': True, + 'group_name': 'include-email', + 'dest': 'include_email', + 'required': False, + }, ] def _run_main(self, parsed_args, parsed_globals): @@ -52,6 +77,31 @@ for auth in result['authorizationData']: auth_token = b64decode(auth['authorizationToken']).decode() username, password = auth_token.split(':') - sys.stdout.write('docker login -u %s -p %s -e none %s\n' - % (username, password, auth['proxyEndpoint'])) + command = ['docker', 'login', '-u', username, '-p', password] + if parsed_args.include_email: + command.extend(['-e', 'none']) + command.append(auth['proxyEndpoint']) + 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.11.13/awscli/customizations/ecs/deploy.py awscli-1.18.69/awscli/customizations/ecs/deploy.py --- awscli-1.11.13/awscli/customizations/ecs/deploy.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/ecs/deploy.py 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,453 @@ +# Copyright 2018 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 hashlib +import json +import os +import sys + +from botocore import compat, config +from botocore.exceptions import ClientError +from awscli.compat import compat_open +from awscli.customizations.ecs import exceptions, filehelpers +from awscli.customizations.commands import BasicCommand + +TIMEOUT_BUFFER_MIN = 10 +DEFAULT_DELAY_SEC = 15 +MAX_WAIT_MIN = 360 # 6 hours + + +class ECSDeploy(BasicCommand): + NAME = 'deploy' + + DESCRIPTION = ( + "Deploys a new task definition to the specified ECS service. " + "Only services that use CodeDeploy for deployments are supported. " + "This command will register a new task definition, update the " + "CodeDeploy appspec with the new task definition revision, create a " + "CodeDeploy deployment, and wait for the deployment to successfully " + "complete. This command will exit with a return code of 255 if the " + "deployment does not succeed within 30 minutes by default or " + "up to 10 minutes more than your deployment group's configured wait " + "time (max of 6 hours)." + ) + + ARG_TABLE = [ + { + 'name': 'service', + 'help_text': ("The short name or full Amazon Resource Name " + "(ARN) of the service to update"), + 'required': True + }, + { + 'name': 'task-definition', + 'help_text': ("The file path where your task definition file is " + "located. The format of the file must be the same " + "as the JSON output of: aws ecs " + "register-task-definition " + "--generate-cli-skeleton"), + 'required': True + }, + { + 'name': 'codedeploy-appspec', + 'help_text': ("The file path where your AWS CodeDeploy appspec " + "file is located. The appspec file may be in JSON " + "or YAML format. The TaskDefinition " + "property will be updated within the appspec with " + "the newly registered task definition ARN, " + "overwriting any placeholder values in the file."), + 'required': True + }, + { + 'name': 'cluster', + 'help_text': ("The short name or full Amazon Resource Name " + "(ARN) of the cluster that your service is " + "running within. If you do not specify a " + "cluster, the \"default\" cluster is assumed."), + 'required': False + }, + { + 'name': 'codedeploy-application', + 'help_text': ("The name of the AWS CodeDeploy application " + "to use for the deployment. The specified " + "application must use the 'ECS' compute " + "platform. If you do not specify an " + "application, the application name " + "AppECS-[CLUSTER_NAME]-[SERVICE_NAME] " + "is assumed."), + 'required': False + }, + { + 'name': 'codedeploy-deployment-group', + 'help_text': ("The name of the AWS CodeDeploy deployment " + "group to use for the deployment. The " + "specified deployment group must be associated " + "with the specified ECS service and cluster. " + "If you do not specify a deployment group, " + "the deployment group name " + "DgpECS-[CLUSTER_NAME]-[SERVICE_NAME] " + "is assumed."), + 'required': False + } + ] + + MSG_TASK_DEF_REGISTERED = \ + "Successfully registered new ECS task definition {arn}\n" + + MSG_CREATED_DEPLOYMENT = "Successfully created deployment {id}\n" + + MSG_SUCCESS = ("Successfully deployed {task_def} to " + "service '{service}'\n") + + USER_AGENT_EXTRA = 'customization/ecs-deploy' + + def _run_main(self, parsed_args, parsed_globals): + + register_task_def_kwargs, appspec_obj = \ + self._load_file_args(parsed_args.task_definition, + parsed_args.codedeploy_appspec) + + ecs_client_wrapper = ECSClient( + self._session, parsed_args, parsed_globals, self.USER_AGENT_EXTRA) + + self.resources = self._get_resource_names( + parsed_args, ecs_client_wrapper) + + codedeploy_client = self._session.create_client( + 'codedeploy', + region_name=parsed_globals.region, + verify=parsed_globals.verify_ssl, + config=config.Config(user_agent_extra=self.USER_AGENT_EXTRA)) + + self._validate_code_deploy_resources(codedeploy_client) + + self.wait_time = self._cd_validator.get_deployment_wait_time() + + self.task_def_arn = self._register_task_def( + register_task_def_kwargs, ecs_client_wrapper) + + self._create_and_wait_for_deployment(codedeploy_client, appspec_obj) + + def _create_and_wait_for_deployment(self, client, appspec): + deployer = CodeDeployer(client, appspec) + deployer.update_task_def_arn(self.task_def_arn) + deployment_id = deployer.create_deployment( + self.resources['app_name'], + self.resources['deployment_group_name']) + + sys.stdout.write(self.MSG_CREATED_DEPLOYMENT.format( + id=deployment_id)) + + deployer.wait_for_deploy_success(deployment_id, self.wait_time) + service_name = self.resources['service'] + + sys.stdout.write( + self.MSG_SUCCESS.format( + task_def=self.task_def_arn, service=service_name)) + sys.stdout.flush() + + def _get_file_contents(self, file_path): + full_path = os.path.expandvars(os.path.expanduser(file_path)) + try: + with compat_open(full_path) as f: + return f.read() + except (OSError, IOError, UnicodeDecodeError) as e: + raise exceptions.FileLoadError( + file_path=file_path, error=e) + + def _get_resource_names(self, args, ecs_client): + service_details = ecs_client.get_service_details() + service_name = service_details['service_name'] + cluster_name = service_details['cluster_name'] + + application_name = filehelpers.get_app_name( + service_name, cluster_name, args.codedeploy_application) + deployment_group_name = filehelpers.get_deploy_group_name( + service_name, cluster_name, args.codedeploy_deployment_group) + + return { + 'service': service_name, + 'service_arn': service_details['service_arn'], + 'cluster': cluster_name, + 'cluster_arn': service_details['cluster_arn'], + 'app_name': application_name, + 'deployment_group_name': deployment_group_name + } + + def _load_file_args(self, task_def_arg, appspec_arg): + task_def_string = self._get_file_contents(task_def_arg) + register_task_def_kwargs = json.loads(task_def_string) + + appspec_string = self._get_file_contents(appspec_arg) + appspec_obj = filehelpers.parse_appspec(appspec_string) + + return register_task_def_kwargs, appspec_obj + + def _register_task_def(self, task_def_kwargs, ecs_client): + response = ecs_client.register_task_definition(task_def_kwargs) + + task_def_arn = response['taskDefinition']['taskDefinitionArn'] + + sys.stdout.write(self.MSG_TASK_DEF_REGISTERED.format( + arn=task_def_arn)) + sys.stdout.flush() + + return task_def_arn + + def _validate_code_deploy_resources(self, client): + validator = CodeDeployValidator(client, self.resources) + validator.describe_cd_resources() + validator.validate_all() + self._cd_validator = validator + + +class CodeDeployer(): + + MSG_WAITING = ("Waiting for {deployment_id} to succeed " + "(will wait up to {wait} minutes)...\n") + + def __init__(self, cd_client, appspec_dict): + self._client = cd_client + self._appspec_dict = appspec_dict + + def create_deployment(self, app_name, deploy_grp_name): + request_obj = self._get_create_deploy_request( + app_name, deploy_grp_name) + + try: + response = self._client.create_deployment(**request_obj) + except ClientError as e: + raise exceptions.ServiceClientError( + action='create deployment', error=e) + + return response['deploymentId'] + + def _get_appspec_hash(self): + appspec_str = json.dumps(self._appspec_dict) + appspec_encoded = compat.ensure_bytes(appspec_str) + return hashlib.sha256(appspec_encoded).hexdigest() + + def _get_create_deploy_request(self, app_name, deploy_grp_name): + return { + "applicationName": app_name, + "deploymentGroupName": deploy_grp_name, + "revision": { + "revisionType": "AppSpecContent", + "appSpecContent": { + "content": json.dumps(self._appspec_dict), + "sha256": self._get_appspec_hash() + } + } + } + + def update_task_def_arn(self, new_arn): + """ + Inserts the ARN of the previously created ECS task definition + into the provided appspec. + + Expected format of ECS appspec (YAML) is: + version: 0.0 + resources: + - : + type: AWS::ECS::Service + properties: + taskDefinition: # replace this + loadBalancerInfo: + containerName: + containerPort: + """ + appspec_obj = self._appspec_dict + + resources_key = filehelpers.find_required_key( + 'codedeploy-appspec', appspec_obj, 'resources') + updated_resources = [] + + # 'resources' is a list of string:obj dictionaries + for resource in appspec_obj[resources_key]: + for name in resource: + # get content of resource + resource_content = resource[name] + # get resource properties + properties_key = filehelpers.find_required_key( + name, resource_content, 'properties') + properties_content = resource_content[properties_key] + # find task definition property + task_def_key = filehelpers.find_required_key( + properties_key, properties_content, 'taskDefinition') + + # insert new task def ARN into resource + properties_content[task_def_key] = new_arn + + updated_resources.append(resource) + + appspec_obj[resources_key] = updated_resources + self._appspec_dict = appspec_obj + + def wait_for_deploy_success(self, id, wait_min): + waiter = self._client.get_waiter("deployment_successful") + + if wait_min is not None and wait_min > MAX_WAIT_MIN: + wait_min = MAX_WAIT_MIN + + elif wait_min is None or wait_min < 30: + wait_min = 30 + + delay_sec = DEFAULT_DELAY_SEC + max_attempts = (wait_min * 60) / delay_sec + config = { + 'Delay': delay_sec, + 'MaxAttempts': max_attempts + } + + self._show_deploy_wait_msg(id, wait_min) + waiter.wait(deploymentId=id, WaiterConfig=config) + + def _show_deploy_wait_msg(self, id, wait_min): + sys.stdout.write( + self.MSG_WAITING.format(deployment_id=id, + wait=wait_min)) + sys.stdout.flush() + + +class CodeDeployValidator(): + def __init__(self, cd_client, resources): + self._client = cd_client + self._resource_names = resources + + def describe_cd_resources(self): + try: + self.app_details = self._client.get_application( + applicationName=self._resource_names['app_name']) + except ClientError as e: + raise exceptions.ServiceClientError( + action='describe Code Deploy application', error=e) + + try: + dgp = self._resource_names['deployment_group_name'] + app = self._resource_names['app_name'] + self.deployment_group_details = self._client.get_deployment_group( + applicationName=app, deploymentGroupName=dgp) + except ClientError as e: + raise exceptions.ServiceClientError( + action='describe Code Deploy deployment group', error=e) + + def get_deployment_wait_time(self): + + if (not hasattr(self, 'deployment_group_details') or + self.deployment_group_details is None): + return None + else: + dgp_info = self.deployment_group_details['deploymentGroupInfo'] + blue_green_info = dgp_info['blueGreenDeploymentConfiguration'] + + deploy_ready_wait_min = \ + blue_green_info['deploymentReadyOption']['waitTimeInMinutes'] + + terminate_key = 'terminateBlueInstancesOnDeploymentSuccess' + termination_wait_min = \ + blue_green_info[terminate_key]['terminationWaitTimeInMinutes'] + + configured_wait = deploy_ready_wait_min + termination_wait_min + + return configured_wait + TIMEOUT_BUFFER_MIN + + def validate_all(self): + self.validate_application() + self.validate_deployment_group() + + def validate_application(self): + app_name = self._resource_names['app_name'] + if self.app_details['application']['computePlatform'] != 'ECS': + raise exceptions.InvalidPlatformError( + resource='Application', name=app_name) + + def validate_deployment_group(self): + dgp = self._resource_names['deployment_group_name'] + service = self._resource_names['service'] + service_arn = self._resource_names['service_arn'] + cluster = self._resource_names['cluster'] + cluster_arn = self._resource_names['cluster_arn'] + + grp_info = self.deployment_group_details['deploymentGroupInfo'] + compute_platform = grp_info['computePlatform'] + + if compute_platform != 'ECS': + raise exceptions.InvalidPlatformError( + resource='Deployment Group', name=dgp) + + target_services = \ + self.deployment_group_details['deploymentGroupInfo']['ecsServices'] + + # either ECS resource names or ARNs can be stored, so check both + for target in target_services: + target_serv = target['serviceName'] + if target_serv != service and target_serv != service_arn: + raise exceptions.InvalidProperyError( + dg_name=dgp, resource='service', resource_name=service) + + target_cluster = target['clusterName'] + if target_cluster != cluster and target_cluster != cluster_arn: + raise exceptions.InvalidProperyError( + dg_name=dgp, resource='cluster', resource_name=cluster) + + +class ECSClient(): + + def __init__(self, session, parsed_args, parsed_globals, user_agent_extra): + self._args = parsed_args + self._custom_config = config.Config(user_agent_extra=user_agent_extra) + self._client = session.create_client( + 'ecs', + region_name=parsed_globals.region, + endpoint_url=parsed_globals.endpoint_url, + verify=parsed_globals.verify_ssl, + config=self._custom_config) + + def get_service_details(self): + cluster = self._args.cluster + + if cluster is None or '': + cluster = 'default' + + try: + service_response = self._client.describe_services( + cluster=cluster, services=[self._args.service]) + except ClientError as e: + raise exceptions.ServiceClientError( + action='describe ECS service', error=e) + + if len(service_response['services']) == 0: + raise exceptions.InvalidServiceError( + service=self._args.service, cluster=cluster) + + service_details = service_response['services'][0] + cluster_name = \ + filehelpers.get_cluster_name_from_arn( + service_details['clusterArn']) + + return { + 'service_arn': service_details['serviceArn'], + 'service_name': service_details['serviceName'], + 'cluster_arn': service_details['clusterArn'], + 'cluster_name': cluster_name + } + + def register_task_definition(self, kwargs): + try: + response = \ + self._client.register_task_definition(**kwargs) + except ClientError as e: + raise exceptions.ServiceClientError( + action='register ECS task definition', error=e) + + return response diff -Nru awscli-1.11.13/awscli/customizations/ecs/exceptions.py awscli-1.18.69/awscli/customizations/ecs/exceptions.py --- awscli-1.11.13/awscli/customizations/ecs/exceptions.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/ecs/exceptions.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,48 @@ +# Copyright 2018 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. + + +class ECSError(Exception): + """ Base class for all ECSErrors.""" + fmt = 'An unspecified error occurred' + + def __init__(self, **kwargs): + msg = self.fmt.format(**kwargs) + super(ECSError, self).__init__(msg) + self.kwargs = kwargs + + +class MissingPropertyError(ECSError): + fmt = \ + "Error: Resource '{resource}' must include property '{prop_name}'" + + +class FileLoadError(ECSError): + fmt = "Error: Unable to load file at {file_path}: {error}" + + +class InvalidPlatformError(ECSError): + fmt = "Error: {resource} '{name}' must support 'ECS' compute platform" + + +class InvalidProperyError(ECSError): + fmt = ("Error: deployment group '{dg_name}' does not target " + "ECS {resource} '{resource_name}'") + + +class InvalidServiceError(ECSError): + fmt = "Error: Service '{service}' not found in cluster '{cluster}'" + + +class ServiceClientError(ECSError): + fmt = "Failed to {action}:\n{error}" \ No newline at end of file diff -Nru awscli-1.11.13/awscli/customizations/ecs/filehelpers.py awscli-1.18.69/awscli/customizations/ecs/filehelpers.py --- awscli-1.11.13/awscli/customizations/ecs/filehelpers.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/ecs/filehelpers.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,81 @@ +# Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"). You +# may not use this file except in compliance with the License. A copy of +# the License is located at +# +# http://aws.amazon.com/apache2.0/ +# +# or in the "license" file accompanying this file. This file is +# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF +# ANY KIND, either express or implied. See the License for the specific +# language governing permissions and limitations under the License. + +import json +import yaml + +from awscli.customizations.ecs import exceptions + +MAX_CHAR_LENGTH = 46 +APP_PREFIX = 'AppECS-' +DGP_PREFIX = 'DgpECS-' + + +def find_required_key(resource_name, obj, key): + + if obj is None: + raise exceptions.MissingPropertyError( + resource=resource_name, prop_name=key) + + result = _get_case_insensitive_key(obj, key) + + if result is None: + raise exceptions.MissingPropertyError( + resource=resource_name, prop_name=key) + else: + return result + + +def _get_case_insensitive_key(target_obj, target_key): + key_to_match = target_key.lower() + key_list = target_obj.keys() + + for key in key_list: + if key.lower() == key_to_match: + return key + + +def get_app_name(service, cluster, app_value): + if app_value is not None: + return app_value + else: + suffix = _get_ecs_suffix(service, cluster) + return APP_PREFIX + suffix + + +def get_cluster_name_from_arn(arn): + return arn.split('/')[1] + + +def get_deploy_group_name(service, cluster, dg_value): + if dg_value is not None: + return dg_value + else: + suffix = _get_ecs_suffix(service, cluster) + return DGP_PREFIX + suffix + + +def _get_ecs_suffix(service, cluster): + if cluster is None: + cluster_name = 'default' + else: + cluster_name = cluster[:MAX_CHAR_LENGTH] + + return cluster_name + '-' + service[:MAX_CHAR_LENGTH] + + +def parse_appspec(appspec_str): + try: + return json.loads(appspec_str) + except ValueError: + return yaml.safe_load(appspec_str) diff -Nru awscli-1.11.13/awscli/customizations/ecs/__init__.py awscli-1.18.69/awscli/customizations/ecs/__init__.py --- awscli-1.11.13/awscli/customizations/ecs/__init__.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/ecs/__init__.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,27 @@ +# Copyright 2018 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. + +from awscli.customizations.ecs.deploy import ECSDeploy + +def initialize(cli): + """ + The entry point for ECS high level commands. + """ + cli.register('building-command-table.ecs', inject_commands) + +def inject_commands(command_table, session, **kwargs): + """ + Called when the ECS command table is being built. Used to inject new + high level commands into the command list. + """ + command_table['deploy'] = ECSDeploy(session) \ No newline at end of file diff -Nru awscli-1.11.13/awscli/customizations/eks/exceptions.py awscli-1.18.69/awscli/customizations/eks/exceptions.py --- awscli-1.11.13/awscli/customizations/eks/exceptions.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/eks/exceptions.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,20 @@ +# Copyright 2018 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. + + +class EKSError(Exception): + """ Base class for all EKSErrors.""" + + +class EKSClusterError(EKSError): + """ Raised when a cluster is not in the correct state.""" diff -Nru awscli-1.11.13/awscli/customizations/eks/get_token.py awscli-1.18.69/awscli/customizations/eks/get_token.py --- awscli-1.11.13/awscli/customizations/eks/get_token.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/eks/get_token.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,151 @@ +# Copyright 2019 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 botocore +import json + +from datetime import datetime, timedelta +from botocore.signers import RequestSigner +from botocore.model import ServiceId + +from awscli.customizations.commands import BasicCommand +from awscli.customizations.utils import uni_print + +AUTH_SERVICE = "sts" +AUTH_COMMAND = "GetCallerIdentity" +AUTH_API_VERSION = "2011-06-15" +AUTH_SIGNING_VERSION = "v4" + +# Presigned url timeout in seconds +URL_TIMEOUT = 60 + +TOKEN_EXPIRATION_MINS = 14 + +TOKEN_PREFIX = 'k8s-aws-v1.' + +CLUSTER_NAME_HEADER = 'x-k8s-aws-id' + + +class GetTokenCommand(BasicCommand): + NAME = 'get-token' + + DESCRIPTION = ("Get a token for authentication with an Amazon EKS cluster. " + "This can be used as an alternative to the " + "aws-iam-authenticator.") + + ARG_TABLE = [ + { + 'name': 'cluster-name', + 'help_text': ("Specify the name of the Amazon EKS cluster to create a token for."), + 'required': True + }, + { + 'name': 'role-arn', + 'help_text': ("Assume this role for credentials when signing the token."), + 'required': False + } + ] + + def get_expiration_time(self): + token_expiration = datetime.utcnow() + timedelta(minutes=TOKEN_EXPIRATION_MINS) + return token_expiration.strftime('%Y-%m-%dT%H:%M:%SZ') + + def _run_main(self, parsed_args, parsed_globals): + client_factory = STSClientFactory(self._session) + sts_client = client_factory.get_sts_client( + region_name=parsed_globals.region, + role_arn=parsed_args.role_arn) + token = TokenGenerator(sts_client).get_token(parsed_args.cluster_name) + + # By default STS signs the url for 15 minutes so we are creating a + # rfc3339 timestamp with expiration in 14 minutes as part of the token, which + # is used by some clients (client-go) who will refresh the token after 14 mins + token_expiration = self.get_expiration_time() + + full_object = { + "kind": "ExecCredential", + "apiVersion": "client.authentication.k8s.io/v1alpha1", + "spec": {}, + "status": { + "expirationTimestamp": token_expiration, + "token": token + } + } + + uni_print(json.dumps(full_object)) + uni_print('\n') + return 0 + + +class TokenGenerator(object): + def __init__(self, sts_client): + self._sts_client = sts_client + + def get_token(self, cluster_name): + """ Generate a presigned url token to pass to kubectl. """ + url = self._get_presigned_url(cluster_name) + token = TOKEN_PREFIX + base64.urlsafe_b64encode( + url.encode('utf-8')).decode('utf-8').rstrip('=') + return token + + def _get_presigned_url(self, cluster_name): + return self._sts_client.generate_presigned_url( + 'get_caller_identity', + Params={'ClusterName': cluster_name}, + ExpiresIn=URL_TIMEOUT, + HttpMethod='GET', + ) + + +class STSClientFactory(object): + def __init__(self, session): + self._session = session + + def get_sts_client(self, region_name=None, role_arn=None): + client_kwargs = { + 'region_name': region_name + } + if role_arn is not None: + creds = self._get_role_credentials(region_name, role_arn) + client_kwargs['aws_access_key_id'] = creds['AccessKeyId'] + client_kwargs['aws_secret_access_key'] = creds['SecretAccessKey'] + client_kwargs['aws_session_token'] = creds['SessionToken'] + sts = self._session.create_client('sts', **client_kwargs) + self._register_cluster_name_handlers(sts) + return sts + + def _get_role_credentials(self, region_name, role_arn): + sts = self._session.create_client('sts', region_name) + return sts.assume_role( + RoleArn=role_arn, + RoleSessionName='EKSGetTokenAuth' + )['Credentials'] + + def _register_cluster_name_handlers(self, sts_client): + sts_client.meta.events.register( + 'provide-client-params.sts.GetCallerIdentity', + self._retrieve_cluster_name + ) + sts_client.meta.events.register( + 'before-sign.sts.GetCallerIdentity', + self._inject_cluster_name_header + ) + + def _retrieve_cluster_name(self, params, context, **kwargs): + if 'ClusterName' in params: + context['eks_cluster'] = params.pop('ClusterName') + + def _inject_cluster_name_header(self, request, **kwargs): + if 'eks_cluster' in request.context: + request.headers[ + CLUSTER_NAME_HEADER] = request.context['eks_cluster'] diff -Nru awscli-1.11.13/awscli/customizations/eks/__init__.py awscli-1.18.69/awscli/customizations/eks/__init__.py --- awscli-1.11.13/awscli/customizations/eks/__init__.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/eks/__init__.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,31 @@ +# Copyright 2018 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. + +from awscli.customizations.eks.update_kubeconfig import UpdateKubeconfigCommand +from awscli.customizations.eks.get_token import GetTokenCommand + + +def initialize(cli): + """ + The entry point for EKS high level commands. + """ + cli.register('building-command-table.eks', inject_commands) + + +def inject_commands(command_table, session, **kwargs): + """ + Called when the EKS command table is being built. + Used to inject new high level commands into the command list. + """ + command_table['update-kubeconfig'] = UpdateKubeconfigCommand(session) + command_table['get-token'] = GetTokenCommand(session) diff -Nru awscli-1.11.13/awscli/customizations/eks/kubeconfig.py awscli-1.18.69/awscli/customizations/eks/kubeconfig.py --- awscli-1.11.13/awscli/customizations/eks/kubeconfig.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/eks/kubeconfig.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,271 @@ +# Copyright 2018 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 os +import yaml +import logging +import errno +from botocore.compat import OrderedDict + +from awscli.customizations.eks.exceptions import EKSError +from awscli.customizations.eks.ordered_yaml import (ordered_yaml_load, + ordered_yaml_dump) + + +class KubeconfigError(EKSError): + """ Base class for all kubeconfig errors.""" + + +class KubeconfigCorruptedError(KubeconfigError): + """ Raised when a kubeconfig cannot be parsed.""" + + +class KubeconfigInaccessableError(KubeconfigError): + """ Raised when a kubeconfig cannot be opened for read/writing.""" + + +def _get_new_kubeconfig_content(): + return OrderedDict([ + ("apiVersion", "v1"), + ("clusters", []), + ("contexts", []), + ("current-context", ""), + ("kind", "Config"), + ("preferences", OrderedDict()), + ("users", []) + ]) + + +class Kubeconfig(object): + def __init__(self, path, content=None): + self.path = path + if content is None: + content = _get_new_kubeconfig_content() + self.content = content + + def dump_content(self): + """ Return the stored content in yaml format. """ + return ordered_yaml_dump(self.content) + + def has_cluster(self, name): + """ + Return true if this kubeconfig contains an entry + For the passed cluster name. + """ + if 'clusters' not in self.content: + return False + return name in [cluster['name'] + for cluster in self.content['clusters']] + + +class KubeconfigValidator(object): + def __init__(self): + # Validation_content is an empty Kubeconfig + # It is used as a way to know what types different entries should be + self._validation_content = Kubeconfig(None, None).content + + def validate_config(self, config): + """ + Raises KubeconfigCorruptedError if the passed content is invalid + + :param config: The config to validate + :type config: Kubeconfig + """ + if not isinstance(config, Kubeconfig): + raise KubeconfigCorruptedError("Internal error: " + "Not a Kubeconfig object.") + self._validate_config_types(config) + self._validate_list_entry_types(config) + + def _validate_config_types(self, config): + """ + Raises KubeconfigCorruptedError if any of the entries in config + are the wrong type + + :param config: The config to validate + :type config: Kubeconfig + """ + if not isinstance(config.content, dict): + raise KubeconfigCorruptedError("Content not a dictionary.") + for key, value in self._validation_content.items(): + if (key in config.content and + config.content[key] is not None and + not isinstance(config.content[key], type(value))): + raise KubeconfigCorruptedError( + "{0} is wrong type:{1} " + "(Should be {2})".format( + key, + type(config.content[key]), + type(value) + ) + ) + + def _validate_list_entry_types(self, config): + """ + Raises KubeconfigCorruptedError if any lists in config contain objects + which are not dictionaries + + :param config: The config to validate + :type config: Kubeconfig + """ + for key, value in self._validation_content.items(): + if (key in config.content and + type(config.content[key]) == list): + for element in config.content[key]: + if not isinstance(element, OrderedDict): + raise KubeconfigCorruptedError( + "Entry in {0} not a dictionary.".format(key)) + + +class KubeconfigLoader(object): + def __init__(self, validator=None): + if validator is None: + validator = KubeconfigValidator() + self._validator = validator + + def load_kubeconfig(self, path): + """ + Loads the kubeconfig found at the given path. + If no file is found at the given path, + Generate a new kubeconfig to write back. + If the kubeconfig is valid, loads the content from it. + If the kubeconfig is invalid, throw the relevant exception. + + :param path: The path to load a kubeconfig from + :type path: string + + :raises KubeconfigInaccessableError: if the kubeconfig can't be opened + :raises KubeconfigCorruptedError: if the kubeconfig is invalid + + :return: The loaded kubeconfig + :rtype: Kubeconfig + """ + try: + with open(path, "r") as stream: + loaded_content = ordered_yaml_load(stream) + except IOError as e: + if e.errno == errno.ENOENT: + loaded_content = None + else: + raise KubeconfigInaccessableError( + "Can't open kubeconfig for reading: {0}".format(e)) + except yaml.YAMLError as e: + raise KubeconfigCorruptedError( + "YamlError while loading kubeconfig: {0}".format(e)) + + loaded_config = Kubeconfig(path, loaded_content) + self._validator.validate_config(loaded_config) + + return loaded_config + + +class KubeconfigWriter(object): + def write_kubeconfig(self, config): + """ + Write config to disk. + OK if the file doesn't exist. + + :param config: The kubeconfig to write + :type config: Kubeconfig + + :raises KubeconfigInaccessableError: if the kubeconfig + can't be opened for writing + """ + directory = os.path.dirname(config.path) + + try: + os.makedirs(directory) + except OSError as e: + if e.errno != errno.EEXIST: + raise KubeconfigInaccessableError( + "Can't create directory for writing: {0}".format(e)) + try: + with open(config.path, "w+") as stream: + ordered_yaml_dump(config.content, stream) + except IOError as e: + raise KubeconfigInaccessableError( + "Can't open kubeconfig for writing: {0}".format(e)) + + +class KubeconfigAppender(object): + def insert_entry(self, config, key, entry): + """ + Insert entry into the array at content[key] + Overwrite an existing entry if they share the same name + + :param config: The kubeconfig to insert an entry into + :type config: Kubeconfig + """ + if key not in config.content: + config.content[key] = [] + array = config.content[key] + if not isinstance(array, list): + raise KubeconfigError("Tried to insert into {0}," + "which is a {1} " + "not a {2}".format(key, + type(array), + list)) + found = False + for counter, existing_entry in enumerate(array): + if "name" in existing_entry and\ + "name" in entry and\ + existing_entry["name"] == entry["name"]: + array[counter] = entry + found = True + + if not found: + array.append(entry) + + config.content[key] = array + return config + + def _make_context(self, cluster, user, alias=None): + """ Generate a context to associate cluster and user with a given alias.""" + return OrderedDict([ + ("context", OrderedDict([ + ("cluster", cluster["name"]), + ("user", user["name"]) + ])), + ("name", alias or user["name"]) + ]) + + def insert_cluster_user_pair(self, config, cluster, user, alias=None): + """ + Insert the passed cluster entry and user entry, + then make a context to associate them + and set current-context to be the new context. + Returns the new context + + :param config: the Kubeconfig to insert the pair into + :type config: Kubeconfig + + :param cluster: the cluster entry + :type cluster: OrderedDict + + :param user: the user entry + :type user: OrderedDict + + :param alias: the alias for the context; defaults top user entry name + :type context: str + + :return: The generated context + :rtype: OrderedDict + """ + context = self._make_context(cluster, user, alias=alias) + self.insert_entry(config, "clusters", cluster) + self.insert_entry(config, "users", user) + self.insert_entry(config, "contexts", context) + + config.content["current-context"] = context["name"] + + return context diff -Nru awscli-1.11.13/awscli/customizations/eks/ordered_yaml.py awscli-1.18.69/awscli/customizations/eks/ordered_yaml.py --- awscli-1.11.13/awscli/customizations/eks/ordered_yaml.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/eks/ordered_yaml.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,62 @@ +# Copyright 2018 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 yaml +from botocore.compat import OrderedDict + + +class SafeOrderedLoader(yaml.SafeLoader): + """ Safely load a yaml file into an OrderedDict.""" + + +class SafeOrderedDumper(yaml.SafeDumper): + """ Safely dump an OrderedDict as yaml.""" + + +def _ordered_constructor(loader, node): + loader.flatten_mapping(node) + return OrderedDict(loader.construct_pairs(node)) + + +SafeOrderedLoader.add_constructor( + yaml.resolver.BaseResolver.DEFAULT_MAPPING_TAG, + _ordered_constructor) + + +def _ordered_representer(dumper, data): + return dumper.represent_mapping( + yaml.resolver.BaseResolver.DEFAULT_MAPPING_TAG, + data.items()) + + +SafeOrderedDumper.add_representer(OrderedDict, _ordered_representer) + + +def ordered_yaml_load(stream): + """ Load an OrderedDict object from a yaml stream.""" + return yaml.load(stream, SafeOrderedLoader) + + +def ordered_yaml_dump(to_dump, stream=None): + """ + Dump an OrderedDict object to yaml. + + :param to_dump: The OrderedDict to dump + :type to_dump: OrderedDict + + :param stream: The file to dump to + If not given or if None, only return the value + :type stream: file + """ + return yaml.dump(to_dump, stream, + SafeOrderedDumper, default_flow_style=False) diff -Nru awscli-1.11.13/awscli/customizations/eks/update_kubeconfig.py awscli-1.18.69/awscli/customizations/eks/update_kubeconfig.py --- awscli-1.11.13/awscli/customizations/eks/update_kubeconfig.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/eks/update_kubeconfig.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,324 @@ +# Copyright 2018 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 os +import logging + +from botocore.compat import OrderedDict + +from awscli.customizations.commands import BasicCommand +from awscli.customizations.utils import uni_print +from awscli.customizations.eks.exceptions import EKSClusterError +from awscli.customizations.eks.kubeconfig import (Kubeconfig, + KubeconfigError, + KubeconfigLoader, + KubeconfigWriter, + KubeconfigValidator, + KubeconfigAppender) +from awscli.customizations.eks.ordered_yaml import ordered_yaml_dump + +LOG = logging.getLogger(__name__) + +DEFAULT_PATH = os.path.expanduser("~/.kube/config") + +# Use the endpoint for kubernetes 1.10 +# To get the most recent endpoint we will need to +# Do a check on the cluster's version number +API_VERSION = "client.authentication.k8s.io/v1alpha1" + +class UpdateKubeconfigCommand(BasicCommand): + NAME = 'update-kubeconfig' + + DESCRIPTION = BasicCommand.FROM_FILE( + 'eks', + 'update-kubeconfig', + '_description.rst' + ) + + ARG_TABLE = [ + { + 'name': 'name', + 'help_text': ("The name of the cluster for which " + "to create a kubeconfig entry. " + "This cluster must exist in your account and in the " + "specified or configured default Region " + "for your AWS CLI installation."), + 'required': True + }, + { + 'name': 'kubeconfig', + 'help_text': ("Optionally specify a kubeconfig file to append " + "with your configuration. " + "By default, the configuration is written to the " + "first file path in the KUBECONFIG " + "environment variable (if it is set) " + "or the default kubeconfig path (.kube/config) " + "in your home directory."), + 'required': False + }, + { + 'name': 'role-arn', + 'help_text': ("To assume a role for cluster authentication, " + "specify an IAM role ARN with this option. " + "For example, if you created a cluster " + "while assuming an IAM role, " + "then you must also assume that role to " + "connect to the cluster the first time."), + 'required': False + }, + { + 'name': 'dry-run', + 'action': 'store_true', + 'default': False, + 'help_text': ("Print the merged kubeconfig to stdout instead of " + "writing it to the specified file."), + 'required': False + }, + { + 'name': 'verbose', + 'action': 'store_true', + 'default': False, + 'help_text': ("Print more detailed output " + "when writing to the kubeconfig file, " + "including the appended entries.") + }, + { + 'name': 'alias', + 'help_text': ("Alias for the cluster context name. " + "Defaults to match cluster ARN."), + 'required': False + } + ] + + def _display_entries(self, entries): + """ + Display entries in yaml format + + :param entries: a list of OrderedDicts to be printed + :type entries: list + """ + uni_print("Entries:\n\n") + for entry in entries: + uni_print(ordered_yaml_dump(entry)) + uni_print("\n") + + def _run_main(self, parsed_args, parsed_globals): + client = EKSClient(self._session, + parsed_args.name, + parsed_args.role_arn, + parsed_globals) + new_cluster_dict = client.get_cluster_entry() + new_user_dict = client.get_user_entry() + + config_selector = KubeconfigSelector( + os.environ.get("KUBECONFIG", ""), + parsed_args.kubeconfig + ) + config = config_selector.choose_kubeconfig( + new_cluster_dict["name"] + ) + updating_existing = config.has_cluster(new_cluster_dict["name"]) + appender = KubeconfigAppender() + new_context_dict = appender.insert_cluster_user_pair(config, + new_cluster_dict, + new_user_dict, + parsed_args.alias) + + if parsed_args.dry_run: + uni_print(config.dump_content()) + else: + writer = KubeconfigWriter() + writer.write_kubeconfig(config) + + if updating_existing: + uni_print("Updated context {0} in {1}\n".format( + new_context_dict["name"], config.path + )) + else: + uni_print("Added new context {0} to {1}\n".format( + new_context_dict["name"], config.path + )) + + if parsed_args.verbose: + self._display_entries([ + new_context_dict, + new_user_dict, + new_cluster_dict + ]) + + + +class KubeconfigSelector(object): + + def __init__(self, env_variable, path_in, validator=None, + loader=None): + """ + Parse KUBECONFIG into a list of absolute paths. + Also replace the empty list with DEFAULT_PATH + + :param env_variable: KUBECONFIG as a long string + :type env_variable: string + + :param path_in: The path passed in through the CLI + :type path_in: string or None + """ + if validator is None: + validator = KubeconfigValidator() + self._validator = validator + + if loader is None: + loader = KubeconfigLoader(validator) + self._loader = loader + + if path_in is not None: + # Override environment variable + self._paths = [self._expand_path(path_in)] + else: + # Get the list of paths from the environment variable + if env_variable == "": + env_variable = DEFAULT_PATH + self._paths = [self._expand_path(element) + for element in env_variable.split(os.pathsep) + if len(element.strip()) > 0] + if len(self._paths) == 0: + self._paths = [DEFAULT_PATH] + + def choose_kubeconfig(self, cluster_name): + """ + Choose which kubeconfig file to read from. + If name is already an entry in one of the $KUBECONFIG files, + choose that one. + Otherwise choose the first file. + + :param cluster_name: The name of the cluster which is going to be added + :type cluster_name: String + + :return: a chosen Kubeconfig based on above rules + :rtype: Kubeconfig + """ + # Search for an existing entry to update + for candidate_path in self._paths: + try: + loaded_config = self._loader.load_kubeconfig(candidate_path) + + if loaded_config.has_cluster(cluster_name): + LOG.debug("Found entry to update at {0}".format( + candidate_path + )) + return loaded_config + except KubeconfigError as e: + LOG.warning("Passing {0}:{1}".format(candidate_path, e)) + + # No entry was found, use the first file in KUBECONFIG + # + # Note: This could raise KubeconfigErrors if paths[0] is corrupted + return self._loader.load_kubeconfig(self._paths[0]) + + def _expand_path(self, path): + """ A helper to expand a path to a full absolute path. """ + return os.path.abspath(os.path.expanduser(path)) + + +class EKSClient(object): + def __init__(self, session, cluster_name, role_arn, parsed_globals=None): + self._session = session + self._cluster_name = cluster_name + self._role_arn = role_arn + self._cluster_description = None + self._globals = parsed_globals + + def _get_cluster_description(self): + """ + Use an eks describe-cluster call to get the cluster description + Cache the response in self._cluster_description. + describe-cluster will only be called once. + """ + if self._cluster_description is None: + if self._globals is None: + client = self._session.create_client("eks") + else: + client = self._session.create_client( + "eks", + region_name=self._globals.region, + endpoint_url=self._globals.endpoint_url, + verify=self._globals.verify_ssl + ) + full_description = client.describe_cluster(name=self._cluster_name) + self._cluster_description = full_description["cluster"] + + if "status" not in self._cluster_description: + raise EKSClusterError("Cluster not found") + if self._cluster_description["status"] != "ACTIVE": + raise EKSClusterError("Cluster status not active") + + return self._cluster_description + + def get_cluster_entry(self): + """ + Return a cluster entry generated using + the previously obtained description. + """ + + cert_data = self._get_cluster_description().get("certificateAuthority", + {"data": ""})["data"] + endpoint = self._get_cluster_description().get("endpoint") + arn = self._get_cluster_description().get("arn") + + return OrderedDict([ + ("cluster", OrderedDict([ + ("certificate-authority-data", cert_data), + ("server", endpoint) + ])), + ("name", arn) + ]) + + def get_user_entry(self): + """ + Return a user entry generated using + the previously obtained description. + """ + + region = self._get_cluster_description().get("arn").split(":")[3] + + generated_user = OrderedDict([ + ("name", self._get_cluster_description().get("arn", "")), + ("user", OrderedDict([ + ("exec", OrderedDict([ + ("apiVersion", API_VERSION), + ("args", + [ + "--region", + region, + "eks", + "get-token", + "--cluster-name", + self._cluster_name, + ]), + ("command", "aws") + ])) + ])) + ]) + + if self._role_arn is not None: + generated_user["user"]["exec"]["args"].extend([ + "--role", + self._role_arn + ]) + + if self._session.profile: + generated_user["user"]["exec"]["env"] = [OrderedDict([ + ("name", "AWS_PROFILE"), + ("value", self._session.profile) + ])] + + return generated_user diff -Nru awscli-1.11.13/awscli/customizations/emr/addinstancegroups.py awscli-1.18.69/awscli/customizations/emr/addinstancegroups.py --- awscli-1.11.13/awscli/customizations/emr/addinstancegroups.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/emr/addinstancegroups.py 2020-05-28 19:25:48.000000000 +0000 @@ -51,13 +51,16 @@ def _construct_result(self, add_instance_groups_result): jobFlowId = None instanceGroupIds = None + clusterArn = None if add_instance_groups_result is not None: jobFlowId = add_instance_groups_result.get('JobFlowId') instanceGroupIds = add_instance_groups_result.get( 'InstanceGroupIds') + clusterArn = add_instance_groups_result.get('ClusterArn') if jobFlowId is not None and instanceGroupIds is not None: return {'ClusterId': jobFlowId, - 'InstanceGroupIds': instanceGroupIds} + 'InstanceGroupIds': instanceGroupIds, + 'ClusterArn': clusterArn} else: return {} diff -Nru awscli-1.11.13/awscli/customizations/emr/argumentschema.py awscli-1.18.69/awscli/customizations/emr/argumentschema.py --- awscli-1.11.13/awscli/customizations/emr/argumentschema.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/emr/argumentschema.py 2020-05-28 19:26:18.000000000 +0000 @@ -14,6 +14,48 @@ from awscli.customizations.emr import helptext from awscli.customizations.emr.createdefaultroles import EC2_ROLE_NAME +CONFIGURATIONS_PROPERTIES_SCHEMA = { + "type": "map", + "key": { + "type": "string", + "description": "Configuration key" + }, + "value": { + "type": "string", + "description": "Configuration value" + }, + "description": "Application configuration properties" +} + +CONFIGURATIONS_CLASSIFICATION_SCHEMA = { + "type": "string", + "description": "Application configuration classification name", +} + +INNER_CONFIGURATIONS_SCHEMA = { + "type": "array", + "items": { + "type": "object", + "properties": { + "Classification": CONFIGURATIONS_CLASSIFICATION_SCHEMA, + "Properties": CONFIGURATIONS_PROPERTIES_SCHEMA + } + }, + "description": "Instance group application configurations." +} + +OUTER_CONFIGURATIONS_SCHEMA = { + "type": "array", + "items": { + "type": "object", + "properties": { + "Classification": CONFIGURATIONS_CLASSIFICATION_SCHEMA, + "Properties": CONFIGURATIONS_PROPERTIES_SCHEMA, + "Configurations": INNER_CONFIGURATIONS_SCHEMA + } + }, + "description": "Instance group application configurations." +} INSTANCE_GROUPS_SCHEMA = { "type": "array", @@ -93,11 +135,283 @@ } } } - } + }, + "AutoScalingPolicy": { + "type": "object", + "description": "Auto Scaling policy that will be associated with the instance group.", + "properties": { + "Constraints": { + "type": "object", + "description": "The Constraints that will be associated to an Auto Scaling policy.", + "properties": { + "MinCapacity": { + "type": "integer", + "description": "The minimum value for the instances to scale in" + " to in response to scaling activities." + }, + "MaxCapacity": { + "type": "integer", + "description": "The maximum value for the instances to scale out to in response" + " to scaling activities" + } + } + }, + "Rules": { + "type": "array", + "description": "The Rules associated to an Auto Scaling policy.", + "items": { + "type": "object", + "properties": { + "Name": { + "type": "string", + "description": "Name of the Auto Scaling rule." + }, + "Description": { + "type": "string", + "description": "Description of the Auto Scaling rule." + }, + "Action": { + "type": "object", + "description": "The Action associated to an Auto Scaling rule.", + "properties": { + "Market": { # Required for Instance Fleets + "type": "string", + "description": "Market type of the Amazon EC2 instances used to create a " + "cluster node by Auto Scaling action.", + "enum": ["ON_DEMAND", "SPOT"] + }, + "SimpleScalingPolicyConfiguration": { + "type": "object", + "description": "The Simple scaling configuration that will be associated" + "to Auto Scaling action.", + "properties": { + "AdjustmentType": { + "type": "string", + "description": "Specifies how the ScalingAdjustment parameter is " + "interpreted.", + "enum": ["CHANGE_IN_CAPACITY", "PERCENT_CHANGE_IN_CAPACITY", + "EXACT_CAPACITY"] + }, + "ScalingAdjustment": { + "type": "integer", + "description": "The amount by which to scale, based on the " + "specified adjustment type." + }, + "CoolDown": { + "type": "integer", + "description": "The amount of time, in seconds, after a scaling " + "activity completes and before the next scaling " + "activity can start." + } + } + } + } + }, + "Trigger": { + "type": "object", + "description": "The Trigger associated to an Auto Scaling rule.", + "properties": { + "CloudWatchAlarmDefinition": { + "type": "object", + "description": "The Alarm to be registered with CloudWatch, to trigger" + " scaling activities.", + "properties": { + "ComparisonOperator": { + "type": "string", + "description": "The arithmetic operation to use when comparing the" + " specified Statistic and Threshold." + }, + "EvaluationPeriods": { + "type": "integer", + "description": "The number of periods over which data is compared" + " to the specified threshold." + }, + "MetricName": { + "type": "string", + "description": "The name for the alarm's associated metric." + }, + "Namespace": { + "type": "string", + "description": "The namespace for the alarm's associated metric." + }, + "Period": { + "type": "integer", + "description": "The period in seconds over which the specified " + "statistic is applied." + }, + "Statistic": { + "type": "string", + "description": "The statistic to apply to the alarm's associated " + "metric." + }, + "Threshold": { + "type": "double", + "description": "The value against which the specified statistic is " + "compared." + }, + "Unit": { + "type": "string", + "description": "The statistic's unit of measure." + }, + "Dimensions": { + "type": "array", + "description": "The dimensions for the alarm's associated metric.", + "items": { + "type": "object", + "properties": { + "Key": { + "type": "string", + "description": "Dimension Key." + }, + "Value": { + "type": "string", + "description": "Dimension Value." + } + } + } + } + } + } + } + } + } + } + } + } + }, + "Configurations": OUTER_CONFIGURATIONS_SCHEMA } } } +INSTANCE_FLEETS_SCHEMA = { + "type": "array", + "items": { + "type": "object", + "properties": { + "Name": { + "type": "string", + "description": "Friendly name given to the instance fleet." + }, + "InstanceFleetType": { + "type": "string", + "description": "The type of the instance fleet in the cluster.", + "enum": ["MASTER", "CORE", "TASK"], + "required": True + }, + "TargetOnDemandCapacity": { + "type": "integer", + "description": "Target on-demand capacity for the instance fleet." + }, + "TargetSpotCapacity": { + "type": "integer", + "description": "Target spot capacity for the instance fleet." + }, + "InstanceTypeConfigs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "InstanceType": { + "type": "string", + "description": "The Amazon EC2 instance type for the instance fleet.", + "required": True + }, + "WeightedCapacity": { + "type": "integer", + "description": "The weight assigned to an instance type, which will impact the overall fulfillment of the capacity." + }, + "BidPrice": { + "type": "string", + "description": "Bid price for each Amazon EC2 instance in the " + "instance fleet when launching nodes as Spot Instances, " + "expressed in USD." + }, + "BidPriceAsPercentageOfOnDemandPrice": { + "type": "double", + "description": "Bid price as percentage of on-demand price." + }, + "EbsConfiguration": { + "type": "object", + "description": "EBS configuration that is associated with the instance group.", + "properties": { + "EbsOptimized": { + "type": "boolean", + "description": "Boolean flag used to tag EBS-optimized instances.", + }, + "EbsBlockDeviceConfigs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "VolumeSpecification" : { + "type": "object", + "description": "The EBS volume specification that is created " + "and attached to each instance in the instance group.", + "properties": { + "VolumeType": { + "type": "string", + "description": "The EBS volume type that is attached to all " + "the instances in the instance group. Valid types are: " + "gp2, io1, and standard.", + "required": True + }, + "SizeInGB": { + "type": "integer", + "description": "The EBS volume size, in GB, that is attached " + "to all the instances in the instance group.", + "required": True + }, + "Iops": { + "type": "integer", + "description": "The IOPS of the EBS volume that is attached to " + "all the instances in the instance group.", + } + } + }, + "VolumesPerInstance": { + "type": "integer", + "description": "The number of EBS volumes that will be created and " + "attached to each instance in the instance group.", + } + } + } + } + } + }, + "Configurations": OUTER_CONFIGURATIONS_SCHEMA + } + } + }, + "LaunchSpecifications": { + "type": "object", + "properties" : { + "SpotSpecification": { + "type": "object", + "properties": { + "TimeoutDurationMinutes": { + "type": "integer", + "description": "The time, in minutes, after which the action specified in TimeoutAction field will be performed if requested resources are unavailable." + }, + "TimeoutAction": { + "type": "string", + "description": "The action that is performed after TimeoutDurationMinutes.", + "enum": [ + "TERMINATE_CLUSTER", + "SWITCH_TO_ONDEMAND" + ] + }, + "BlockDurationMinutes": { + "type": "integer", + "description": "Block duration in minutes." + } + } + } + } + } + } + } +} EC2_ATTRIBUTES_SCHEMA = { "type": "object", @@ -118,10 +432,25 @@ "the cluster is launched in the normal Amazon Web Services " "cloud, outside of an Amazon VPC. " }, + "SubnetIds": { + "type": "array", + "description": + "List of SubnetIds.", + "items": { + "type": "string" + } + }, "AvailabilityZone": { "type": "string", "description": "The Availability Zone the cluster will run in." }, + "AvailabilityZones": { + "type": "array", + "description": "List of AvailabilityZones.", + "items": { + "type": "string" + } + }, "InstanceProfile": { "type": "string", "description": @@ -344,3 +673,78 @@ "type": "string" } } + +KERBEROS_ATTRIBUTES_SCHEMA = { + "type": "object", + "properties": { + "Realm": { + "type": "string", + "description": "The name of Kerberos realm." + }, + "KdcAdminPassword": { + "type": "string", + "description": "The password of Kerberos administrator." + }, + "CrossRealmTrustPrincipalPassword": { + "type": "string", + "description": "The password to establish cross-realm trusts." + }, + "ADDomainJoinUser": { + "type": "string", + "description": "The name of the user with privileges to join instances to Active Directory." + }, + "ADDomainJoinPassword": { + "type": "string", + "description": "The password of the user with privileges to join instances to Active Directory." + } + } +} + +MANAGED_SCALING_POLICY_SCHEMA = { + "type": "object", + "properties": { + "ComputeLimits": { + "type": "object", + "description": + "The EC2 unit limits for a managed scaling policy. " + "The managed scaling activity of a cluster is not allowed to go above " + "or below these limits. The limits apply to CORE and TASK groups " + "and exclude the capacity of the MASTER group.", + "properties": { + "MinimumCapacityUnits": { + "type": "integer", + "description": + "The lower boundary of EC2 units. It is measured through " + "VCPU cores or instances for instance groups and measured " + "through units for instance fleets. Managed scaling " + "activities are not allowed beyond this boundary.", + "required": True + }, + "MaximumCapacityUnits": { + "type": "integer", + "description": + "The upper boundary of EC2 units. It is measured through " + "VCPU cores or instances for instance groups and measured " + "through units for instance fleets. Managed scaling " + "activities are not allowed beyond this boundary.", + "required": True + }, + "MaximumOnDemandCapacityUnits": { + "type": "integer", + "description": + "The upper boundary of on-demand EC2 units. It is measured through " + "VCPU cores or instances for instance groups and measured " + "through units for instance fleets. The on-demand units are not " + "allowed to scale beyond this boundary. " + "This value must be lower than MaximumCapacityUnits." + }, + "UnitType": { + "type": "string", + "description": "The unit type used for specifying a managed scaling policy.", + "enum": ["VCPU", "Instances", "InstanceFleetUnits"], + "required": True + } + } + } + } +} diff -Nru awscli-1.11.13/awscli/customizations/emr/constants.py awscli-1.18.69/awscli/customizations/emr/constants.py --- awscli-1.11.13/awscli/customizations/emr/constants.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/emr/constants.py 2020-05-28 19:25:48.000000000 +0000 @@ -15,10 +15,13 @@ EC2_ROLE_NAME = "EMR_EC2_DefaultRole" EMR_ROLE_NAME = "EMR_DefaultRole" -EC2_ROLE_ARN_PATTERN = ("arn:{{region_suffix}}:iam::aws:policy/service-role/" - "AmazonElasticMapReduceforEC2Role") -EMR_ROLE_ARN_PATTERN = ("arn:{{region_suffix}}:iam::aws:policy/service-role/" - "AmazonElasticMapReduceRole") +EMR_AUTOSCALING_ROLE_NAME = "EMR_AutoScaling_DefaultRole" +ROLE_ARN_PATTERN = "arn:{{region_suffix}}:iam::aws:policy/service-role/{{policy_name}}" +EC2_ROLE_POLICY_NAME = "AmazonElasticMapReduceforEC2Role" +EMR_ROLE_POLICY_NAME = "AmazonElasticMapReduceRole" +EMR_AUTOSCALING_ROLE_POLICY_NAME = "AmazonElasticMapReduceforAutoScalingRole" +EMR_AUTOSCALING_SERVICE_NAME = "application-autoscaling" +EMR_AUTOSCALING_SERVICE_PRINCIPAL = "application-autoscaling.amazonaws.com" # Action on failure CONTINUE = 'CONTINUE' @@ -174,7 +177,7 @@ EC2 = 'ec2' EMR = 'elasticmapreduce' - +APPLICATION_AUTOSCALING = 'application-autoscaling' LATEST = 'latest' APPLICATIONS = ["HIVE", "PIG", "HBASE", "GANGLIA", "IMPALA", "SPARK", "MAPR", @@ -189,3 +192,5 @@ 'WAITING', 'TERMINATING'] LIST_CLUSTERS_TERMINATED_STATES = ['TERMINATED'] LIST_CLUSTERS_FAILED_STATES = ['TERMINATED_WITH_ERRORS'] + +INSTANCE_FLEET_TYPE = 'INSTANCE_FLEET' diff -Nru awscli-1.11.13/awscli/customizations/emr/createcluster.py awscli-1.18.69/awscli/customizations/emr/createcluster.py --- awscli-1.11.13/awscli/customizations/emr/createcluster.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/emr/createcluster.py 2020-05-28 19:26:18.000000000 +0000 @@ -23,6 +23,7 @@ from awscli.customizations.emr import hbaseutils from awscli.customizations.emr import helptext from awscli.customizations.emr import instancegroupsutils +from awscli.customizations.emr import instancefleetsutils from awscli.customizations.emr import steputils from awscli.customizations.emr.command import Command from awscli.customizations.emr.constants import EC2_ROLE_NAME @@ -50,6 +51,9 @@ 'help_text': helptext.AUTO_TERMINATE}, {'name': 'no-auto-terminate', 'action': 'store_true', 'group_name': 'auto_terminate'}, + {'name': 'instance-fleets', + 'schema': argumentschema.INSTANCE_FLEETS_SCHEMA, + 'help_text': helptext.INSTANCE_FLEETS}, {'name': 'name', 'default': 'Development Cluster', 'help_text': helptext.CLUSTER_NAME}, @@ -57,6 +61,8 @@ 'help_text': helptext.LOG_URI}, {'name': 'service-role', 'help_text': helptext.SERVICE_ROLE}, + {'name': 'auto-scaling-role', + 'help_text': helptext.AUTOSCALING_ROLE}, {'name': 'use-default-roles', 'action': 'store_true', 'help_text': helptext.USE_DEFAULT_ROLES}, {'name': 'configurations', @@ -69,6 +75,8 @@ 'help_text': helptext.TERMINATION_PROTECTED}, {'name': 'no-termination-protected', 'action': 'store_true', 'group_name': 'termination_protected'}, + {'name': 'scale-down-behavior', + 'help_text': helptext.SCALE_DOWN_BEHAVIOR}, {'name': 'visible-to-all-users', 'action': 'store_true', 'group_name': 'visibility', 'help_text': helptext.VISIBILITY}, @@ -100,9 +108,24 @@ 'schema': argumentschema.HBASE_RESTORE_FROM_BACKUP_SCHEMA, 'help_text': helptext.RESTORE_FROM_HBASE}, {'name': 'security-configuration', - 'help_text': helptext.SECURITY_CONFIG} + 'help_text': helptext.SECURITY_CONFIG}, + {'name': 'custom-ami-id', + 'help_text' : helptext.CUSTOM_AMI_ID}, + {'name': 'ebs-root-volume-size', + 'help_text' : helptext.EBS_ROOT_VOLUME_SIZE}, + {'name': 'repo-upgrade-on-boot', + 'help_text' : helptext.REPO_UPGRADE_ON_BOOT}, + {'name': 'kerberos-attributes', + 'schema': argumentschema.KERBEROS_ATTRIBUTES_SCHEMA, + 'help_text': helptext.KERBEROS_ATTRIBUTES}, + {'name': 'step-concurrency-level', + 'cli_type_name': 'integer', + 'help_text': helptext.STEP_CONCURRENCY_LEVEL}, + {'name': 'managed-scaling-policy', + 'schema': argumentschema.MANAGED_SCALING_POLICY_SCHEMA, + 'help_text': helptext.MANAGED_SCALING_POLICY} ] - SYNOPSIS = BasicCommand.FROM_FILE('emr', 'create-cluster-synopsis.rst') + SYNOPSIS = BasicCommand.FROM_FILE('emr', 'create-cluster-synopsis.txt') EXAMPLES = BasicCommand.FROM_FILE('emr', 'create-cluster-examples.rst') def _run_main_command(self, parsed_args, parsed_globals): @@ -130,12 +153,23 @@ option2="--ec2-attributes InstanceProfile", message=service_role_validation_message) + if parsed_args.instance_groups is not None and \ + parsed_args.instance_fleets is not None: + raise exceptions.MutualExclusiveOptionError( + option1="--instance-groups", + option2="--instance-fleets") + instances_config = {} - instances_config['InstanceGroups'] = \ - instancegroupsutils.validate_and_build_instance_groups( - instance_groups=parsed_args.instance_groups, - instance_type=parsed_args.instance_type, - instance_count=parsed_args.instance_count) + if parsed_args.instance_fleets is not None: + instances_config['InstanceFleets'] = \ + instancefleetsutils.validate_and_build_instance_fleets( + parsed_args.instance_fleets) + else: + instances_config['InstanceGroups'] = \ + instancegroupsutils.validate_and_build_instance_groups( + instance_groups=parsed_args.instance_groups, + instance_type=parsed_args.instance_type, + instance_count=parsed_args.instance_count) if parsed_args.release_label is not None: params["ReleaseLabel"] = parsed_args.release_label @@ -166,6 +200,17 @@ emrutils.apply_dict(params, 'ServiceRole', parsed_args.service_role) + if parsed_args.instance_groups is not None: + for instance_group in instances_config['InstanceGroups']: + if 'AutoScalingPolicy' in instance_group.keys(): + if parsed_args.auto_scaling_role is None: + raise exceptions.MissingAutoScalingRoleError() + + emrutils.apply_dict(params, 'AutoScalingRole', parsed_args.auto_scaling_role) + + if parsed_args.scale_down_behavior is not None: + emrutils.apply_dict(params, 'ScaleDownBehavior', parsed_args.scale_down_behavior) + if ( parsed_args.no_auto_terminate is False and parsed_args.auto_terminate is False): @@ -273,6 +318,31 @@ emrutils.apply_dict( params, 'SecurityConfiguration', parsed_args.security_configuration) + if parsed_args.custom_ami_id is not None: + emrutils.apply_dict( + params, 'CustomAmiId', parsed_args.custom_ami_id + ) + if parsed_args.ebs_root_volume_size is not None: + emrutils.apply_dict( + params, 'EbsRootVolumeSize', int(parsed_args.ebs_root_volume_size) + ) + + if parsed_args.repo_upgrade_on_boot is not None: + emrutils.apply_dict( + params, 'RepoUpgradeOnBoot', parsed_args.repo_upgrade_on_boot + ) + + if parsed_args.kerberos_attributes is not None: + emrutils.apply_dict( + params, 'KerberosAttributes', parsed_args.kerberos_attributes) + + if parsed_args.step_concurrency_level is not None: + params['StepConcurrencyLevel'] = parsed_args.step_concurrency_level + + if parsed_args.managed_scaling_policy is not None: + emrutils.apply_dict( + params, 'ManagedScalingPolicy', parsed_args.managed_scaling_policy) + self._validate_required_applications(parsed_args) run_job_flow_response = emrutils.call( @@ -287,18 +357,33 @@ def _construct_result(self, run_job_flow_result): jobFlowId = None + clusterArn = None if run_job_flow_result is not None: jobFlowId = run_job_flow_result.get('JobFlowId') + clusterArn = run_job_flow_result.get('ClusterArn') if jobFlowId is not None: - return {'ClusterId': jobFlowId} + return {'ClusterId': jobFlowId, + 'ClusterArn': clusterArn } else: return {} def _build_ec2_attributes(self, cluster, parsed_attrs): keys = parsed_attrs.keys() instances = cluster['Instances'] - if 'AvailabilityZone' in keys and 'SubnetId' in keys: + + if ('SubnetId' in keys and 'SubnetIds' in keys): + raise exceptions.MutualExclusiveOptionError( + option1="SubnetId", + option2="SubnetIds") + + if ('AvailabilityZone' in keys and 'AvailabilityZones' in keys): + raise exceptions.MutualExclusiveOptionError( + option1="AvailabilityZone", + option2="AvailabilityZones") + + if ('SubnetId' in keys or 'SubnetIds' in keys) \ + and ('AvailabilityZone' in keys or 'AvailabilityZones' in keys): raise exceptions.SubnetAndAzValidationError emrutils.apply_params( @@ -307,6 +392,9 @@ emrutils.apply_params( src_params=parsed_attrs, src_key='SubnetId', dest_params=instances, dest_key='Ec2SubnetId') + emrutils.apply_params( + src_params=parsed_attrs, src_key='SubnetIds', + dest_params=instances, dest_key='Ec2SubnetIds') if 'AvailabilityZone' in keys: instances['Placement'] = dict() @@ -315,6 +403,13 @@ dest_params=instances['Placement'], dest_key='AvailabilityZone') + if 'AvailabilityZones' in keys: + instances['Placement'] = dict() + emrutils.apply_params( + src_params=parsed_attrs, src_key='AvailabilityZones', + dest_params=instances['Placement'], + dest_key='AvailabilityZones') + emrutils.apply_params( src_params=parsed_attrs, src_key='InstanceProfile', dest_params=cluster, dest_key='JobFlowRole') @@ -457,8 +552,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.11.13/awscli/customizations/emr/createdefaultroles.py awscli-1.18.69/awscli/customizations/emr/createdefaultroles.py --- awscli-1.11.13/awscli/customizations/emr/createdefaultroles.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/emr/createdefaultroles.py 2020-05-28 19:25:48.000000000 +0000 @@ -13,21 +13,29 @@ import logging import re - - import botocore.exceptions +import botocore.session from botocore import xform_name +from awscli.customizations.utils import get_policy_arn_suffix from awscli.customizations.emr import configutils from awscli.customizations.emr import emrutils from awscli.customizations.emr import exceptions from awscli.customizations.emr.command import Command from awscli.customizations.emr.constants import EC2 from awscli.customizations.emr.constants import EC2_ROLE_NAME -from awscli.customizations.emr.constants import EC2_ROLE_ARN_PATTERN +from awscli.customizations.emr.constants import ROLE_ARN_PATTERN from awscli.customizations.emr.constants import EMR from awscli.customizations.emr.constants import EMR_ROLE_NAME -from awscli.customizations.emr.constants import EMR_ROLE_ARN_PATTERN +from awscli.customizations.emr.constants import EMR_AUTOSCALING_ROLE_NAME +from awscli.customizations.emr.constants import APPLICATION_AUTOSCALING +from awscli.customizations.emr.constants import EC2_ROLE_POLICY_NAME +from awscli.customizations.emr.constants import EMR_ROLE_POLICY_NAME +from awscli.customizations.emr.constants \ + import EMR_AUTOSCALING_ROLE_POLICY_NAME +from awscli.customizations.emr.constants import EMR_AUTOSCALING_SERVICE_NAME +from awscli.customizations.emr.constants \ + import EMR_AUTOSCALING_SERVICE_PRINCIPAL from awscli.customizations.emr.exceptions import ResolveServicePrincipalError @@ -48,43 +56,35 @@ } -def get_service_role_policy_arn(region): - region_suffix = _get_policy_arn_suffix(region) - return EMR_ROLE_ARN_PATTERN.replace("{{region_suffix}}", region_suffix) - - -def get_ec2_role_policy_arn(region): - region_suffix = _get_policy_arn_suffix(region) - return EC2_ROLE_ARN_PATTERN.replace("{{region_suffix}}", region_suffix) - - -def _get_policy_arn_suffix(region): - region_string = region.lower() - if region_string.startswith("cn-"): - return "aws-cn" - elif region_string.startswith("us-gov"): - return "aws-us-gov" - else: - return "aws" +def get_role_policy_arn(region, policy_name): + region_suffix = get_policy_arn_suffix(region) + role_arn = ROLE_ARN_PATTERN.replace("{{region_suffix}}", region_suffix) + role_arn = role_arn.replace("{{policy_name}}", policy_name) + return role_arn -def get_service_principal(service, endpoint_host): - return service + '.' + _get_suffix(endpoint_host) +def get_service_principal(service, endpoint_host, session=None): + suffix, region = _get_suffix_and_region_from_endpoint_host(endpoint_host) + if session is None: + session = botocore.session.Session() + if service == EMR_AUTOSCALING_SERVICE_NAME: + if region not in session.get_available_regions('emr', 'aws-cn'): + return EMR_AUTOSCALING_SERVICE_PRINCIPAL -def _get_suffix(endpoint_host): - return _get_suffix_from_endpoint_host(endpoint_host) + return service + '.' + suffix -def _get_suffix_from_endpoint_host(endpoint_host): +def _get_suffix_and_region_from_endpoint_host(endpoint_host): suffix_match = _get_regex_match_from_endpoint_host(endpoint_host) if suffix_match is not None and suffix_match.lastindex >= 3: suffix = suffix_match.group(3) + region = suffix_match.group(2) else: raise ResolveServicePrincipalError - return suffix + return suffix, region def _get_regex_match_from_endpoint_host(endpoint_host): @@ -128,10 +128,6 @@ ] def _run_main_command(self, parsed_args, parsed_globals): - ec2_result = None - ec2_policy = None - emr_result = None - emr_policy = None self.iam_endpoint_url = parsed_args.iam_endpoint @@ -146,19 +142,11 @@ LOG.debug('elasticmapreduce endpoint used for resolving' ' service principal: ' + self.emr_endpoint_url) - # Check if the default EC2 Role for EMR exists. - role_name = EC2_ROLE_NAME - if self.check_if_role_exists(role_name, parsed_globals): - LOG.debug('Role ' + role_name + ' exists.') - else: - LOG.debug('Role ' + role_name + ' does not exist.' - ' Creating default role for EC2: ' + role_name) - role_arn = get_ec2_role_policy_arn(self.region) - ec2_result = self._create_role_with_role_policy( - role_name, EC2, role_arn, parsed_globals) - ec2_policy = self._get_role_policy(role_arn, parsed_globals) + # Create default EC2 Role for EMR if it does not exist. + ec2_result, ec2_policy = self._create_role_if_not_exists(parsed_globals, EC2_ROLE_NAME, + EC2_ROLE_POLICY_NAME, [EC2]) - # Check if the default EC2 Instance Profile for EMR exists. + # Create default EC2 Instance Profile for EMR if it does not exist. instance_profile_name = EC2_ROLE_NAME if self.check_if_instance_profile_exists(instance_profile_name, parsed_globals): @@ -171,28 +159,41 @@ instance_profile_name, parsed_globals) - # Check if the default EMR Role exists. - role_name = EMR_ROLE_NAME - if self.check_if_role_exists(role_name, parsed_globals): - LOG.debug('Role ' + role_name + ' exists.') - else: - LOG.debug('Role ' + role_name + ' does not exist.' - ' Creating default role for EMR: ' + role_name) - role_arn = get_service_role_policy_arn(self.region) - emr_result = self._create_role_with_role_policy( - role_name, EMR, role_arn, parsed_globals) - emr_policy = self._get_role_policy(role_arn, parsed_globals) + # Create default EMR Role if it does not exist. + emr_result, emr_policy = self._create_role_if_not_exists(parsed_globals, EMR_ROLE_NAME, + EMR_ROLE_POLICY_NAME, [EMR]) + + # Create default EMR AutoScaling Role if it does not exist. + emr_autoscaling_result, emr_autoscaling_policy = \ + self._create_role_if_not_exists(parsed_globals, EMR_AUTOSCALING_ROLE_NAME, + EMR_AUTOSCALING_ROLE_POLICY_NAME, [EMR, APPLICATION_AUTOSCALING]) configutils.update_roles(self._session) emrutils.display_response( self._session, 'create_role', self._construct_result(ec2_result, ec2_policy, - emr_result, emr_policy), + emr_result, emr_policy, + emr_autoscaling_result, emr_autoscaling_policy), parsed_globals) return 0 + def _create_role_if_not_exists(self, parsed_globals, role_name, policy_name, service_names): + result = None + policy = None + + if self.check_if_role_exists(role_name, parsed_globals): + LOG.debug('Role ' + role_name + ' exists.') + else: + LOG.debug('Role ' + role_name + ' does not exist.' + ' Creating default role: ' + role_name) + role_arn = get_role_policy_arn(self.region, policy_name) + result = self._create_role_with_role_policy( + role_name, service_names, role_arn, parsed_globals) + policy = self._get_role_policy(role_arn, parsed_globals) + return result, policy + def _check_for_iam_endpoint(self, region, iam_endpoint): try: self._session.create_client('emr', region) @@ -201,12 +202,15 @@ raise exceptions.UnknownIamEndpointError(region=region) def _construct_result(self, ec2_response, ec2_policy, - emr_response, emr_policy): + emr_response, emr_policy, + emr_autoscaling_response, emr_autoscaling_policy): result = [] self._construct_role_and_role_policy_structure( result, ec2_response, ec2_policy) self._construct_role_and_role_policy_structure( result, emr_response, emr_policy) + self._construct_role_and_role_policy_structure( + result, emr_autoscaling_response, emr_autoscaling_policy) return result def _construct_role_and_role_policy_structure( @@ -217,13 +221,13 @@ def check_if_role_exists(self, role_name, parsed_globals): parameters = {'RoleName': role_name} + try: self._call_iam_operation('GetRole', parameters, parsed_globals) except botocore.exceptions.ClientError as e: - role_not_found_msg = \ - 'The role with name %s cannot be found.' % role_name - error_message = e.response.get('Error', {}).get('Message', '') - if role_not_found_msg in error_message: + role_not_found_code = "NoSuchEntity" + error_code = e.response.get('Error', {}).get('Code', '') + if role_not_found_code == error_code: # No role error. return False else: @@ -239,10 +243,9 @@ self._call_iam_operation('GetInstanceProfile', parameters, parsed_globals) except botocore.exceptions.ClientError as e: - profile_not_found_msg = \ - 'Instance Profile %s cannot be found.' % instance_profile_name - error_message = e.response.get('Error', {}).get('Message') - if profile_not_found_msg in error_message: + profile_not_found_code = 'NoSuchEntity' + error_code = e.response.get('Error', {}).get('Code') + if profile_not_found_code == error_code: # No instance profile error. return False else: @@ -263,9 +266,17 @@ return policy_version_details["PolicyVersion"]["Document"] def _create_role_with_role_policy( - self, role_name, service_name, role_arn, parsed_globals): - service_principal = get_service_principal(service_name, - self.emr_endpoint_url) + self, role_name, service_names, role_arn, parsed_globals): + + if len(service_names) == 1: + service_principal = get_service_principal( + service_names[0], self.emr_endpoint_url, self._session) + else: + service_principal = [] + for service in service_names: + service_principal.append(get_service_principal( + service, self.emr_endpoint_url, self._session)) + LOG.debug(service_principal) parameters = {'RoleName': role_name} diff -Nru awscli-1.11.13/awscli/customizations/emr/describecluster.py awscli-1.18.69/awscli/customizations/emr/describecluster.py --- awscli-1.11.13/awscli/customizations/emr/describecluster.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/emr/describecluster.py 2020-05-28 19:25:48.000000000 +0000 @@ -32,12 +32,35 @@ def _run_main_command(self, parsed_args, parsed_globals): parameters = {'ClusterId': parsed_args.cluster_id} + list_instance_fleets_result = None + list_instance_groups_result = None + is_fleet_based_cluster = False describe_cluster_result = self._call( self._session, 'describe_cluster', parameters, parsed_globals) - list_instance_groups_result = self._call( - self._session, 'list_instance_groups', parameters, parsed_globals) + + if 'Cluster' in describe_cluster_result: + describe_cluster = describe_cluster_result['Cluster'] + if describe_cluster.get('InstanceCollectionType') == constants.INSTANCE_FLEET_TYPE: + is_fleet_based_cluster = True + + if 'Ec2InstanceAttributes' in describe_cluster: + ec2_instance_attr_keys = \ + describe_cluster['Ec2InstanceAttributes'].keys() + ec2_instance_attr = \ + describe_cluster['Ec2InstanceAttributes'] + else: + ec2_instance_attr_keys = {} + + if is_fleet_based_cluster: + list_instance_fleets_result = self._call( + self._session, 'list_instance_fleets', parameters, + parsed_globals) + else: + list_instance_groups_result = self._call( + self._session, 'list_instance_groups', parameters, + parsed_globals) list_bootstrap_actions_result = self._call( self._session, 'list_bootstrap_actions', @@ -45,6 +68,7 @@ constructed_result = self._construct_result( describe_cluster_result, + list_instance_fleets_result, list_instance_groups_result, list_bootstrap_actions_result) @@ -67,12 +91,15 @@ return key def _construct_result( - self, describe_cluster_result, list_instance_groups_result, - list_bootstrap_actions_result): + self, describe_cluster_result, list_instance_fleets_result, + list_instance_groups_result, list_bootstrap_actions_result): result = describe_cluster_result - result['Cluster']['InstanceGroups'] = [] result['Cluster']['BootstrapActions'] = [] + if (list_instance_fleets_result is not None and + list_instance_fleets_result.get('InstanceFleets') is not None): + result['Cluster']['InstanceFleets'] = \ + list_instance_fleets_result.get('InstanceFleets') if (list_instance_groups_result is not None and list_instance_groups_result.get('InstanceGroups') is not None): result['Cluster']['InstanceGroups'] = \ diff -Nru awscli-1.11.13/awscli/customizations/emr/emrutils.py awscli-1.18.69/awscli/customizations/emr/emrutils.py --- awscli-1.11.13/awscli/customizations/emr/emrutils.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/emr/emrutils.py 2020-05-28 19:25:48.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.11.13/awscli/customizations/emr/exceptions.py awscli-1.18.69/awscli/customizations/emr/exceptions.py --- awscli-1.11.13/awscli/customizations/emr/exceptions.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/emr/exceptions.py 2020-05-28 19:25:48.000000000 +0000 @@ -19,7 +19,7 @@ :ivar msg: The descriptive message associated with the error. """ - fmt = 'An unspecified error occured' + fmt = 'An unspecified error occurred' def __init__(self, **kwargs): msg = self.fmt.format(**kwargs) @@ -334,3 +334,9 @@ fmt = ("aws: error: {command} is not supported with " "'{release_label}' release.") + +class MissingAutoScalingRoleError(EmrError): + + fmt = ("aws: error: Must specify --auto-scaling-role when configuring an " + "AutoScaling policy for an instance group.") + diff -Nru awscli-1.11.13/awscli/customizations/emr/helptext.py awscli-1.18.69/awscli/customizations/emr/helptext.py --- awscli-1.11.13/awscli/customizations/emr/helptext.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/emr/helptext.py 2020-05-28 19:26:18.000000000 +0000 @@ -15,158 +15,210 @@ from awscli.customizations.emr.createdefaultroles import EC2_ROLE_NAME TERMINATE_CLUSTERS = ( - 'Shuts down a list of clusters. When a cluster is shut' - ' down, any step not yet completed is canceled and the ' + 'Shuts down one or more clusters, each specified by cluster ID. ' + 'Use this command only on clusters that do not have termination ' + 'protection enabled. Clusters with termination protection enabled ' + 'are not terminated. When a cluster is shut ' + 'down, any step not yet completed is canceled and the ' 'Amazon EC2 instances in the cluster are terminated. ' - 'Any log files not already saved are uploaded to' - ' Amazon S3 if a LogUri was specified when the cluster was created.' - " 'terminate-clusters' is asynchronous. Depending on the" - ' configuration of the cluster, it may take from 5 to 20 minutes for the' - ' cluster to completely terminate and release allocated resources such as' - ' Amazon EC2 instances.') + 'Any log files not already saved are uploaded to ' + 'Amazon S3 if a --log-uri was specified when the cluster was created. ' + 'The maximum number of clusters allowed in the list is 10. ' + 'The command is asynchronous. Depending on the ' + 'configuration of the cluster, it may take from 5 to 20 minutes for the ' + 'cluster to terminate completely and release allocated resources such as ' + 'Amazon EC2 instances.') CLUSTER_ID = ( - '

A unique string that identifies the cluster. This' - ' identifier is returned by create-cluster and can also be' - ' obtained from list-clusters.

') + '

A unique string that identifies a cluster. The ' + 'create-cluster command returns this identifier. You can ' + 'use the list-clusters command to get cluster IDs.

') HBASE_BACKUP_DIR = ( - '

Amazon S3 location of the Hbase backup.

Example:

' - 's3://mybucket/mybackup

where mybucket is the' - ' specified Amazon S3 bucket and mybackup is the specified backup' - ' location. The path argument must begin with s3:// in order to denote' - ' that the path argument refers to an Amazon S3 folder.

') + '

The Amazon S3 location of the Hbase backup. Example: ' + 's3://mybucket/mybackup, where mybucket is the ' + 'specified Amazon S3 bucket and mybackup is the specified backup ' + 'location. The path argument must begin with s3://, which ' + 'refers to an Amazon S3 bucket.

') HBASE_BACKUP_VERSION = ( - '

Backup version to restore from. If not specified the latest backup ' - 'in the specified location will be used.

') + '

The backup version to restore from. If not specified, the latest backup ' + 'in the specified location is used.

') # create-cluster options help text + +CREATE_CLUSTER_DESCRIPTION = ( + 'Creates an Amazon EMR cluster with the specified configurations.\n' + '\nQuick start:\n' + '\naws emr create-cluster --release-label ' + ' --instance-type --instance-count \n' + '\nValues for the following can be set in the AWS CLI' + ' config file using the "aws configure set" command: --service-role, --log-uri,' + ' and InstanceProfile and KeyName arguments under --ec2-attributes.') + CLUSTER_NAME = ( - '

The name of the cluster. The default is "Development Cluster".

') + '

The name of the cluster. If not provided, the default is "Development Cluster".

') LOG_URI = ( - '

The location in Amazon S3 to write the log files ' - 'of the cluster. If a value is not provided, ' - 'logs are not created.

') + '

Specifies the location in Amazon S3 to which log files ' + 'are periodically written. If a value is not provided, ' + 'logs files are not written to Amazon S3 from the master node ' + 'and are lost if the master node terminates.

') SERVICE_ROLE = ( - '

Allows EMR to call other AWS Services such as EC2 on your behalf.

' - 'To create the default Service Role ' + EMR_ROLE_NAME + ',' - ' use aws emr create-default-roles command.

' - 'This command will also create the default EC2 instance profile ' - '' + EC2_ROLE_NAME + '.') + '

Specifies an IAM service role, which Amazon EMR requires to call other AWS services ' + 'on your behalf during cluster operation. This parameter ' + 'is usually specified when a customized service role is used. ' + 'To specify the default service role, as well as the default instance ' + 'profile, use the --use-default-roles parameter. ' + 'If the role and instance profile do not already exist, use the ' + 'aws emr create-default-roles command to create them.

') + +AUTOSCALING_ROLE = ( + '

Specify --auto-scaling-role EMR_AutoScaling_DefaultRole' + ' if an automatic scaling policy is specified for an instance group' + ' using the --instance-groups parameter. This default' + ' IAM role allows the automatic scaling feature' + ' to launch and terminate Amazon EC2 instances during scaling operations.

') USE_DEFAULT_ROLES = ( - '

Uses --service-role=' + EMR_ROLE_NAME + ', and ' - '--ec2-attributes InstanceProfile=' + EC2_ROLE_NAME + '' - 'To create the default service role and instance profile' - ' use aws emr create-default-roles command.

') + '

Specifies that the cluster should use the default' + ' service role (EMR_DefaultRole) and instance profile (EMR_EC2_DefaultRole)' + ' for permissions to access other AWS services.

' + '

Make sure that the role and instance profile exist first. To create them,' + ' use the create-default-roles command.

') AMI_VERSION = ( - '

The version number of the Amazon Machine Image (AMI) ' - 'to use for Amazon EC2 instances in the cluster. ' - 'For example,--ami-version 3.1.0 You cannot specify both a release label' - ' (emr-4.0.0 and later) and an AMI version (3.x or 2.x) on a cluster

' - '

For details about the AMIs currently supported by Amazon ' - 'Elastic MapReduce, go to AMI Versions Supported in Amazon Elastic ' - 'MapReduce in the Amazon Elastic MapReduce Developer\'s Guide.

' - '

http://docs.aws.amazon.com/ElasticMapReduce/latest/DeveloperGuide/' - 'ami-versions-supported.html

') + '

Applies only to Amazon EMR release versions earlier than 4.0. Use' + ' --release-label for 4.0 and later. Specifies' + ' the version of Amazon Linux Amazon Machine Image (AMI)' + ' to use when launching Amazon EC2 instances in the cluster.' + ' For example, --ami-version 3.1.0.') RELEASE_LABEL = ( - '

The identifier for the EMR release, which includes a set of software,' - ' to use with Amazon EC2 instances that are part of an Amazon EMR cluster.' - ' For example, --release-label emr-4.0.0 You cannot specify both a' - ' release label (emr-4.0.0 and later) and AMI version (3.x or 2.x) on a' - ' cluster.

' - '

For details about the releases available in Amazon Elastic MapReduce,' - ' go to Releases Available in Amazon Elastic MapReduce in the' - ' Amazon Elastic MapReduce Documentation.

' - '

http://docs.aws.amazon.com/ElasticMapReduce/latest/Applications/' - 'emr-release.html

Please use ami-version if you want to specify AMI' - ' Versions for your Amazon EMR cluster (3.x and 2.x)

') + '

Specifies the Amazon EMR release version, which determines' + ' the versions of application software that are installed on the cluster.' + ' For example, --release-label emr-5.15.0 installs' + ' the application versions and features available in that version.' + ' For details about application versions and features available' + ' in each release, see the Amazon EMR Release Guide:

' + '

https://docs.aws.amazon.com/emr/ReleaseGuide

' + '

Use --release-label only for Amazon EMR release version 4.0' + ' and later. Use --ami-version for earlier versions.' + ' You cannot specify both a release label and AMI version.

') CONFIGURATIONS = ( - '

Specifies new configuration values for applications installed on your' - ' cluster when using an EMR release (emr-4.0.0 and later). The' - ' configuration files available for editing in each application (for' - ' example: yarn-site for YARN) can be found in the Amazon EMR Developer\'s' - ' Guide in the respective application\'s section. Currently on the CLI,' - ' you can only specify these values in a JSON file stored locally or in' - ' Amazon S3, and you supply the path to this file to this parameter.

' - '

For example:

' - '
  • To specify configurations from a local file --configurations' - ' file://configurations.json
    • ' - '
  • To specify configurations from a file in Amazon S3 ' - '--configurations https://s3.amazonaws.com/myBucket/configurations.json' - '
    • ' - '

    For more information about configuring applications in EMR release,' - ' go to the Amazon EMR Documentation:

    ' - '

    http://docs.aws.amazon.com/ElasticMapReduce/latest/Applications/' - 'emr-configure-apps.html

    ' -) + '

    Specifies a JSON file that contains configuration classifications,' + ' which you can use to customize applications that Amazon EMR installs' + ' when cluster instances launch. Applies only to Amazon EMR 4.0 and later.' + ' The file referenced can either be stored locally (for example,' + ' --configurations file://configurations.json)' + ' or stored in Amazon S3 (for example, --configurations' + ' https://s3.amazonaws.com/myBucket/configurations.json).' + ' Each classification usually corresponds to the xml configuration' + ' file for an application, such as yarn-site for YARN. For a list of' + ' available configuration classifications and example JSON, see' + ' the following topic in the Amazon EMR Release Guide:

    ' + '

    https://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-configure-apps.html

    ') INSTANCE_GROUPS = ( - '

    A specification of the number and type' - ' of Amazon EC2 instances to create instance groups in a cluster.

    ' - '

    Each instance group takes the following parameters: ' - '[Name], InstanceGroupType, InstanceType, InstanceCount,' - ' [BidPrice], [EbsConfiguration]. [EbsConfiguration] is optional.' - ' EbsConfiguration takes the following parameters: EbsOptimized' - ' and EbsBlockDeviceConfigs. EbsBlockDeviceConfigs is an array of EBS volume' - ' specifications, which takes the following parameters : ([VolumeType], ' - ' [SizeInGB], Iops) and VolumesPerInstance which is the count of EBS volumes' - ' per instance with this specification.

    ') + '

    Specifies the number and type of Amazon EC2 instances' + ' to create for each node type in a cluster, using uniform instance groups.' + ' You can specify either --instance-groups or' + ' --instance-fleets but not both.' + ' For more information, see the following topic in the EMR Management Guide:

    ' + '

    https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-instance-group-configuration.html

    ' + '

    You can specify arguments individually using multiple' + ' InstanceGroupType argument blocks, one for the MASTER' + ' instance group, one for a CORE instance group,' + ' and optional, multiple TASK instance groups.

    ' + '

    If you specify inline JSON structures, enclose the entire' + ' InstanceGroupType argument block in single quotation marks.' + '

    Each InstanceGroupType block takes the following inline arguments.' + ' Optional arguments are shown in [square brackets].

    ' + '
  • [Name] - An optional friendly name for the instance group.
    • ' + '
  • InstanceGroupType - MASTER, CORE, or TASK.
    • ' + '
  • InstanceType - The type of EC2 instance, for' + ' example m4.large,' + ' to use for all nodes in the instance group.
    • ' + '
  • InstanceCount - The number of EC2 instances to provision in the instance group.
    • ' + '
  • [BidPrice] - If specified, indicates that the instance group uses Spot Instances.' + ' This is the maximum price you are willing to pay for Spot Instances. Specify OnDemandPrice' + ' to set the amount equal to the On-Demand price, or specify an amount in USD.
    • ' + '
  • [EbsConfiguration] - Specifies additional Amazon EBS storage volumes attached' + ' to EC2 instances using an inline JSON structure.
    • ' + '
  • [AutoScalingPolicy] - Specifies an automatic scaling policy for the' + ' instance group using an inline JSON structure.
    • ') + +INSTANCE_FLEETS = ( + '

    Applies only to Amazon EMR release version 5.0 and later. Specifies' + ' the number and type of Amazon EC2 instances to create' + ' for each node type in a cluster, using instance fleets.' + ' You can specify either --instance-fleets or' + ' --instance-groups but not both.' + ' For more information and examples, see the following topic in the Amazon EMR Management Guide:

    ' + '

    https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-instance-fleet.html

    ' + '

    You can specify arguments individually using multiple' + ' InstanceFleetType argument blocks, one for the MASTER' + ' instance fleet, one for a CORE instance fleet,' + ' and an optional TASK instance fleet.

    ' + '

    The following arguments can be specified for each instance fleet. Optional arguments are shown in [square brackets].

    ' + '
  • [Name] - An optional friendly name for the instance fleet.
    • ' + '
  • InstanceFleetType - MASTER, CORE, or TASK.
    • ' + '
  • TargetOnDemandCapacity - The target capacity of On-Demand units' + ' for the instance fleet, which determines how many On-Demand Instances to provision.' + ' The WeightedCapacity specified for an instance type within' + ' InstanceTypeConfigs counts toward this total when an instance type' + ' with the On-Demand purchasing option launches.
    • ' + '
  • TargetSpotCapacity - The target capacity of Spot units' + ' for the instance fleet, which determines how many Spot Instances to provision.' + ' The WeightedCapacity specified for an instance type within' + ' InstanceTypeConfigs counts toward this total when an instance' + ' type with the Spot purchasing option launches.
    • ' + '
  • [LaunchSpecifications] - When TargetSpotCapacity is specified,' + ' specifies the block duration and timeout action for Spot Instances.' + '
  • InstanceTypeConfigs - Specifies up to five EC2 instance types to' + ' use in the instance fleet, including details such as Spot price and Amazon EBS configuration.
    • ') INSTANCE_TYPE = ( - '

    Shortcut option for --instance-groups. A specification of the ' - 'type of Amazon EC2 instances used together with --instance-count ' - '(optional) to create instance groups in a cluster. ' - 'Specifying the --instance-type argument without ' - 'also specifying --instance-count launches a single-node cluster.

    ') + '

    Shortcut parameter as an alternative to --instance-groups.' + ' Specifies the type of Amazon EC2 instance to use in a cluster.' + ' If used without the --instance-count parameter,' + ' the cluster consists of a single master node running on the EC2 instance type' + ' specified. When used together with --instance-count,' + ' one instance is used for the master node, and the remainder' + ' are used for the core node type.

    ') INSTANCE_COUNT = ( - '

    Shortcut option for --instance-groups. ' - 'A specification of the number of Amazon EC2 instances used together with' - ' --instance-type to create instance groups in a cluster. EMR will use one' - ' node as the cluster\'s master node and use the remainder of the nodes as' - ' core nodes. Specifying the --instance-type argument without ' - 'also specifying --instance-count launches a single-node cluster.

    ') + '

    Shortcut parameter as an alternative to --instance-groups' + ' when used together with --instance-type. Specifies the' + ' number of Amazon EC2 instances to create for a cluster.' + ' One instance is used for the master node, and the remainder' + ' are used for the core node type.

    ') ADDITIONAL_INFO = ( - '

    Specifies additional information during cluster creation

    ') + '

    Specifies additional information during cluster creation.

    ') EC2_ATTRIBUTES = ( - '

    Specifies the following Amazon EC2 attributes: KeyName,' - ' AvailabilityZone, SubnetId, InstanceProfile,' - ' EmrManagedMasterSecurityGroup, EmrManagedSlaveSecurityGroup,' - ' AdditionalMasterSecurityGroups and AdditionalSlaveSecurityGroups.' - ' AvailabilityZone and Subnet cannot be specified together.' - ' To create the default instance profile ' + - EC2_ROLE_NAME + ',' - ' use aws emr create-default-roles command.

    ' - 'This command will also create the default EMR service role ' - '' + EMR_ROLE_NAME + '.' - '
  • KeyName - the name of the AWS EC2 key pair you are using ' - 'to launch the cluster.
    • ' - '
  • AvailabilityZone - An isolated resource ' - 'location within a region.
    • ' - '
  • SubnetId - Assign the EMR cluster to this Amazon VPC Subnet.
    • ' - '
  • InstanceProfile - Provides access to other AWS services such as S3,' - ' DynamoDB from EC2 instances that are launched by EMR..
    • ' - '
  • EmrManagedMasterSecurityGroup - The identifier of the Amazon EC2' - ' security group' - ' for the master node.
    • ' - '
  • EmrManagedSlaveSecurityGroup - The identifier of the Amazon EC2' - ' security group' - ' for the slave nodes.
    • ' - '
  • ServiceAccessSecurityGroup - The identifier of the Amazon EC2 ' - 'security group for the Amazon EMR service ' - 'to access clusters in VPC private subnets
    • ' - '
  • AdditionalMasterSecurityGroups - A list of additional Amazon EC2' - ' security group IDs for the master node
    • ' - '
  • AdditionalSlaveSecurityGroups - A list of additional Amazon EC2' + '

    Configures cluster and Amazon EC2 instance configurations. Accepts' + ' the following arguments:

    ' + '
  • KeyName - Specifies the name of the AWS EC2 key pair that will be used for' + ' SSH connections to the master node and other instances on the cluster.
    • ' + '
  • AvailabilityZone - Specifies the availability zone in which to launch' + ' the cluster. For example, us-west-1b.
    • ' + '
  • SubnetId - Specifies the VPC subnet in which to create the cluster.
    • ' + '
  • InstanceProfile - An IAM role that allows EC2 instances to' + ' access other AWS services, such as Amazon S3, that' + ' are required for operations.
    • ' + '
  • EmrManagedMasterSecurityGroup - The security group ID of the Amazon EC2' + ' security group for the master node.
    • ' + '
  • EmrManagedSlaveSecurityGroup - The security group ID of the Amazon EC2' + ' security group for the slave nodes.
    • ' + '
  • ServiceAccessSecurityGroup - The security group ID of the Amazon EC2 ' + 'security group for Amazon EMR access to clusters in VPC private subnets.
    • ' + '
  • AdditionalMasterSecurityGroups - A list of additional Amazon EC2' + ' security group IDs for the master node.
    • ' + '
  • AdditionalSlaveSecurityGroups - A list of additional Amazon EC2' ' security group IDs for the slave nodes.
    • ') AUTO_TERMINATE = ( @@ -175,135 +227,195 @@ TERMINATION_PROTECTED = ( '

    Specifies whether to lock the cluster to prevent the' - ' Amazon EC2 instances from being terminated by API call, ' - 'user intervention, or in the event of an error. Termination protection ' - 'is off by default.

    ') + ' Amazon EC2 instances from being terminated by API call,' + ' user intervention, or an error.

    ') +SCALE_DOWN_BEHAVIOR = ( + '

    Specifies the way that individual Amazon EC2 instances terminate' + ' when an automatic scale-in activity occurs or an instance group is resized.

    ' + '

    Accepted values:

    ' + '
  • TERMINATE_AT_TASK_COMPLETION - Specifies that Amazon EMR' + ' blacklists and drains tasks from nodes before terminating the instance.
    • ' + '
  • TERMINATE_AT_INSTANCE_HOUR - Specifies that Amazon EMR' + ' terminate EC2 instances at the instance-hour boundary, regardless of when' + ' the request to terminate was submitted.
    • ' +) VISIBILITY = ( '

    Specifies whether the cluster is visible to all IAM users of' - ' the AWS account associated with the cluster. If set to ' - '--visible-to-all-users, all IAM users of that AWS account' - ' can view and (if they have the proper policy permisions set) manage' - ' the cluster. If it is set to --no-visible-to-all-users,' + ' the AWS account associated with the cluster. If set to' + ' --visible-to-all-users, all IAM users of that AWS account' + ' can view it. If they have the proper policy permissions set, they can ' + ' also manage the cluster. If it is set to --no-visible-to-all-users,' ' only the IAM user that created the cluster can view and manage it. ' - ' Clusters are visible by default.

    ') + ' Clusters are visible by default.

    ') DEBUGGING = ( - '

    Enables debugging for the cluster. The debugging tool is a' - ' graphical user interface that you can use to browse the log files from' - ' the console (https://console.aws.amazon.com/elasticmapreduce/' - ' ). When you enable debugging on a cluster, Amazon EMR archives' - ' the log files to Amazon S3 and then indexes those files. You can then' - ' use the graphical interface to browse the step, job, task, and task' - ' attempt logs for the cluster in an intuitive way.

    Requires' - ' --log-uri to be specified

    ') + '

    Specifies that the debugging tool is enabled for the cluster,' + ' which allows you to browse log files using the Amazon EMR console.' + ' Turning debugging on requires that you specify --log-uri' + ' because log files must be stored in Amazon S3 so that' + ' Amazon EMR can index them for viewing in the console.

    ') TAGS = ( - '

    A list of tags to associate with a cluster and propagate to' - ' each Amazon EC2 instance in the cluster. ' - 'They are user-defined key/value pairs that' - ' consist of a required key string with a maximum of 128 characters' - ' and an optional value string with a maximum of 256 characters.

    ' - '

    You can specify tags in key=value format or to add a' - ' tag without value just write key name, key.

    ' - '

    Syntax:

    Multiple tags separated by a space.

    ' - '

    --tags key1=value1 key2=value2

    ') + '

    A list of tags to associate with a cluster, which apply to' + ' each Amazon EC2 instance in the cluster. Tags are key-value pairs that' + ' consist of a required key string' + ' with a maximum of 128 characters, and an optional value string' + ' with a maximum of 256 characters.

    ' + '

    You can specify tags in key=value format or you can add a' + ' tag without a value using only the key name, for example key.' + ' Use a space to separate multiple tags.

    ') BOOTSTRAP_ACTIONS = ( - '

    Specifies a list of bootstrap actions to run when creating a' - ' cluster. You can use bootstrap actions to install additional software' - ' and to change the configuration of applications on the cluster.' - ' Bootstrap actions are scripts that are run on the cluster nodes when' - ' Amazon EMR launches the cluster. They run before Hadoop starts and' - ' before the node begins processing data.

    ' - '

    Each bootstrap action takes the following parameters: ' - 'Path, [Name] and [Args]. ' - 'Note: Args should either be a comma-separated list of values ' - '(e.g. Args=arg1,arg2,arg3) or a bracket-enclosed list of values ' - 'and/or key-value pairs (e.g. Args=[arg1,arg2=arg3,arg4]).

    ') + '

    Specifies a list of bootstrap actions to run on each EC2 instance when' + ' a cluster is created. Bootstrap actions run on each instance' + ' immediately after Amazon EMR provisions the EC2 instance and' + ' before Amazon EMR installs specified applications.

    ' + '

    You can specify a bootstrap action as an inline JSON structure' + ' enclosed in single quotation marks, or you can use a shorthand' + ' syntax, specifying multiple bootstrap actions, each separated' + ' by a space. When using the shorthand syntax, each bootstrap' + ' action takes the following parameters, separated by' + ' commas with no trailing space. Optional parameters' + ' are shown in [square brackets].

    ' + '
  • Path - The path and file name of the script' + ' to run, which must be accessible to each instance in the cluster.' + ' For example, Path=s3://mybucket/myscript.sh.
    • ' + '
  • [Name] - A friendly name to help you identify' + ' the bootstrap action. For example, Name=BootstrapAction1
    • ' + '
  • [Args] - A comma-separated list of arguments' + ' to pass to the bootstrap action script. Arguments can be' + ' either a list of values (Args=arg1,arg2,arg3)' + ' or a list of key-value pairs, as well as optional values,' + ' enclosed in square brackets (Args=[arg1,arg2=arg2value,arg3])
    • .') APPLICATIONS = ( - '

    Installs applications such as Hadoop, Spark, Hue, Hive, Pig, HBase,' - ' Ganglia and Impala or the MapR distribution when creating a cluster.' - ' Available applications vary by EMR release, and the set of components' - ' installed when specifying an Application Name can be found in the Amazon' - ' EMR Developer\'s Guide. Note: If you are using an AMI version instead of' - ' an EMR release, some applications take optional Args for configuration.' - ' Args should either be a comma-separated list of values' - ' (e.g. Args=arg1,arg2,arg3) or a bracket-enclosed list of values' - ' and/or key-value pairs (e.g. Args=[arg1,arg2=arg3,arg4]).

    ') + '

    Specifies the applications to install on the cluster.' + ' Available applications and their respective versions vary' + ' by Amazon EMR release. For more information, see the' + ' Amazon EMR Release Guide:

    ' + '

    https://docs.aws.amazon.com/emr/latest/ReleaseGuide/

    ' + '

    When using versions of Amazon EMR earlier than 4.0,' + ' some applications take optional arguments for configuration.' + ' Arguments should either be a comma-separated list of values' + ' (Args=arg1,arg2,arg3) or a bracket-enclosed list of values' + ' and key-value pairs (Args=[arg1,arg2=arg3,arg4]).

    ') EMR_FS = ( - '

    Configures certain features in EMRFS like consistent' - ' view, Amazon S3 client-side and server-side encryption.

    ' - '
  • Encryption - enables Amazon S3 server-side encryption or' - ' Amazon S3 client-side encryption and takes the mutually exclusive' - ' values, ServerSide or ClientSide.
    • ' - '
  • ProviderType - the encryption ProviderType, which is either Custom' - ' or KMS
    • ' - '
  • KMSKeyId - the AWS KMS KeyId, the alias' - ' you mapped to the KeyId, or the full ARN of the key that' - ' includes the region, account ID, and the KeyId.
    • ' - '
  • CustomProviderLocation - the S3 URI of' - ' the custom EncryptionMaterialsProvider class.
    • ' - '
  • CustomProviderClass - the name of the' - ' custom EncryptionMaterialsProvider class you are using.
    • ' - '
  • Consistent - setting to true enables consistent view.
    • ' - '
  • RetryCount - the number of times EMRFS consistent view will check' - ' for list consistency before returning an error.
    • ' - '
  • RetryPeriod - the interval at which EMRFS consistent view will' - ' recheck for consistency of objects it tracks.
    • ' - '
  • SSE - deprecated in favor of Encryption=ServerSide
    • ' - '
  • Args - optional arguments you can supply in configuring EMRFS.
    • ') + '

    Specifies EMRFS configuration options, such as consistent view' + ' and Amazon S3 encryption parameters.

    ' + '

    When you use Amazon EMR release version 4.8.0 or later, we recommend' + ' that you use the --configurations option together' + ' with the emrfs-site configuration classification' + ' to configure EMRFS, and use security configurations' + ' to configure encryption for EMRFS data in Amazon S3 instead.' + ' For more information, see the following topic in the Amazon EMR Management Guide:

    ' + '

    https://docs.aws.amazon.com/emr/latest/ManagementGuide/emrfs-configure-consistent-view.html

    ') RESTORE_FROM_HBASE = ( - '

    Launches a new HBase cluster and populates it with' - ' data from a previous backup of an HBase cluster. You must install HBase' - ' using the --applications option.' - ' Note: this is only supported by AMI versions (3.x and 2.x).

    ') - + '

    Applies only when using Amazon EMR release versions earlier than 4.0.' + ' Launches a new HBase cluster and populates it with' + ' data from a previous backup of an HBase cluster. HBase' + ' must be installed using the --applications option.

    ') STEPS = ( - '

    A list of steps to be executed by the cluster. A step can be' - ' specified either using the shorthand syntax, JSON file or as a JSON' - ' string. Note: [Args] supplied with steps should either be a' - ' comma-separated list of values (e.g. Args=arg1,arg2,arg3) or' - ' a bracket-enclosed list of values and/or key-value pairs' - ' (e.g. Args=[arg1,arg2=arg3,arg4]).

    ') + '

    Specifies a list of steps to be executed by the cluster. Steps run' + ' only on the master node after applications are installed' + ' and are used to submit work to a cluster. A step can be' + ' specified using the shorthand syntax, by referencing a JSON file' + ' or by specifying an inline JSON structure. Args supplied with steps' + ' should be a comma-separated list of values (Args=arg1,arg2,arg3) or' + ' a bracket-enclosed list of values and key-value' + ' pairs (Args=[arg1,arg2=value,arg4).

    ') INSTALL_APPLICATIONS = ( '

    The applications to be installed.' ' Takes the following parameters: ' - 'Name and Args.') + 'Name and Args.

    ') + +EBS_ROOT_VOLUME_SIZE = ( + '

    Applies only to Amazon EMR release version 4.0 and earlier. Specifies the size,' + ' in GiB, of the EBS root device volume of the Amazon Linux AMI' + ' that is used for each EC2 instance in the cluster.

    ') + +SECURITY_CONFIG = ( + '

    Specifies the name of a security configuration to use for the cluster.' + ' A security configuration defines data encryption settings and' + ' other security options. For more information, see' + ' the following topic in the Amazon EMR Management Guide:

    ' + '

    https://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-encryption-enable-security-configuration.html

    ' + '

    Use list-security-configurations to get a list of available' + ' security configurations in the active account.

    ') + +CUSTOM_AMI_ID = ( + '

    Applies only to Amazon EMR release version 5.7.0 and later.' + ' Specifies the AMI ID of a custom AMI to use' + ' when Amazon EMR provisions EC2 instances. A custom' + ' AMI can be used to encrypt the Amazon EBS root volume. It' + ' can also be used instead of bootstrap actions to customize' + ' cluster node configurations. For more information, see' + ' the following topic in the Amazon EMR Management Guide:

    ' + '

    https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-custom-ami.html

    ') + +REPO_UPGRADE_ON_BOOT = ( + '

    Applies only when a --custom-ami-id is' + ' specified. On first boot, by default, Amazon Linux AMIs' + ' connect to package repositories to install security updates' + ' before other services start. You can set this parameter' + ' using --rep-upgrade-on-boot NONE to' + ' disable these updates. CAUTION: This creates additional' + ' security risks.

    ') + +KERBEROS_ATTRIBUTES = ( + '

    Specifies required cluster attributes for Kerberos when Kerberos authentication' + ' is enabled in the specified --security-configuration.' + ' Takes the following arguments:

    ' + '
  • Realm - Specifies the name of the Kerberos' + ' realm to which all nodes in a cluster belong. For example,' + ' Realm=EC2.INTERNAL.
    • ' + '
  • KdcAdminPassword - Specifies the password used within the cluster' + ' for the kadmin service, which maintains Kerberos principals, password' + ' policies, and keytabs for the cluster.
    • ' + '
  • CrossRealmTrustPrincipalPassword - Required when establishing a cross-realm trust' + ' with a KDC in a different realm. This is the cross-realm principal password,' + ' which must be identical across realms.
    • ' + '
  • ADDomainJoinUser - Required when establishing trust with an Active Directory' + ' domain. This is the User logon name of an AD account with sufficient privileges to join resouces to the domain.
    • ' + '
  • ADDomainJoinPassword - The AD password for ADDomainJoinUser.
    • ') + +# end create-cluster options help descriptions LIST_CLUSTERS_CLUSTER_STATES = ( - '

    The cluster state filters to apply when listing clusters.

    ' - '

    Syntax:' - '"string" "string" ...

    ' - '

    Where valid values are:

    ' - '
  • STARTING
    • ' - '
  • BOOTSTRAPPING
    • ' - '
  • RUNNING
    • ' - '
  • WAITING
    • ' - '
  • TERMINATING
    • ' - '
  • TERMINATED
    • ' - '
  • TERMINATED_WITH_ERRORS

    • ') + '

    Specifies that only clusters in the states specified are' + ' listed. Alternatively, you can use the shorthand' + ' form for single states or a group of states.

    ' + '

    Takes the following state values:

    ' + '
  • STARTING
    • ' + '
  • BOOTSTRAPPING
    • ' + '
  • RUNNING
    • ' + '
  • WAITING
    • ' + '
  • TERMINATING
    • ' + '
  • TERMINATED
    • ' + '
  • TERMINATED_WITH_ERRORS
    • ') LIST_CLUSTERS_STATE_FILTERS = ( - '

    Shortcut option for --cluster-states.

    ' - '
  • --active filters clusters in \'STARTING\',' - '\'BOOTSTRAPPING\',\'RUNNING\',' - '\'WAITING\', or \'TERMINATING\' states.
    • ' - '
  • --terminated filters clusters in \'TERMINATED\' state.
    • ' - '
  • --failed filters clusters in \'TERMINATED_WITH_ERRORS\' state.
    • ') + '

    Shortcut options for --cluster-states. The' + ' following shortcut options can be specified:

    ' + '
  • --active - list only clusters that' + ' are STARTING,BOOTSTRAPPING,' + ' RUNNING, WAITING, or TERMINATING.
    • ' + '
  • --terminated - list only clusters that are TERMINATED.
    • ' + '
  • --failed - list only clusters that are TERMINATED_WITH_ERRORS.
    • ') LIST_CLUSTERS_CREATED_AFTER = ( - '

    The creation date and time beginning value filter for ' - 'listing clusters. For example, 2014-07-15T00:01:30.

    ') + '

    List only those clusters created after the date and time' + ' specified in the format yyyy-mm-ddThh:mm:ss. For example,' + ' --created-after 2017-07-04T00:01:30.

    ') LIST_CLUSTERS_CREATED_BEFORE = ( - '

    The creation date and time end value filter for ' - 'listing clusters. For example, 2014-07-15T00:01:30.

    ') + '

    List only those clusters created after the date and time' + ' specified in the format yyyy-mm-ddThh:mm:ss. For example,' + ' --created-after 2017-07-04T00:01:30.

    ') EMR_MANAGED_MASTER_SECURITY_GROUP = ( '

    The identifier of the Amazon EC2 security group ' @@ -315,8 +427,7 @@ SERVICE_ACCESS_SECURITY_GROUP = ( '

    The identifier of the Amazon EC2 security group ' - 'for the Amazon EMR service to access ' - 'clusters in VPC private subnets.

    ') + 'for Amazon EMR to access clusters in VPC private subnets.

    ') ADDITIONAL_MASTER_SECURITY_GROUPS = ( '

    A list of additional Amazon EC2 security group IDs for ' @@ -327,17 +438,20 @@ 'the slave nodes.

    ') AVAILABLE_ONLY_FOR_AMI_VERSIONS = ( - 'This command is only available for AMI Versions (3.x and 2.x).') + 'This command is only available when using Amazon EMR versions' + 'earlier than 4.0.') -CREATE_CLUSTER_DESCRIPTION = ( - 'Creates an Amazon EMR cluster with specified software.\n' - '\nQuick start:\n\naws emr create-cluster --release-label ' - ' --instance-type [--instance-count ]\n\n' - 'Values for variables Instance Profile (under EC2 Attributes),' - ' Service Role, Log URI, and Key Name (under EC2 Attributes) can be set in' - ' the AWS CLI config file using the "aws configure set" command.\n') +STEP_CONCURRENCY_LEVEL = ( + 'This command specifies the step concurrency level of the cluster.' + 'Default is 1 which is non-concurrent.' +) -SECURITY_CONFIG = ( - '

    The name of a security configuration in the AWS account. ' - 'Use list-security-configurations to get a list of available ' - 'security configurations.

    ') \ No newline at end of file +MANAGED_SCALING_POLICY = ( + '

    Managed scaling policy for an Amazon EMR cluster. The policy ' + 'specifies the limits for resources that can be added or terminated ' + 'from a cluster. You can specify the ComputeLimits which include ' + 'the MaximumCapacityUnits, MinimumCapacityUnits, ' + 'MaximumOnDemandCapacityUnits and UnitType. For an ' + 'InstanceFleet cluster, the UnitType must be InstanceFleetUnits. For ' + 'InstanceGroup clusters, the UnitType can be either VCPU or Instances.

    ' +) diff -Nru awscli-1.11.13/awscli/customizations/emr/instancefleetsutils.py awscli-1.18.69/awscli/customizations/emr/instancefleetsutils.py --- awscli-1.11.13/awscli/customizations/emr/instancefleetsutils.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/emr/instancefleetsutils.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,57 @@ +# Copyright 2014 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. + +from awscli.customizations.emr import constants +from awscli.customizations.emr import exceptions + + +def validate_and_build_instance_fleets(parsed_instance_fleets): + """ + Helper method that converts --instance-fleets option value in + create-cluster to Amazon Elastic MapReduce InstanceFleetConfig + data type. + """ + instance_fleets = [] + for instance_fleet in parsed_instance_fleets: + instance_fleet_config = {} + + keys = instance_fleet.keys() + + if 'Name' in keys: + instance_fleet_config['Name'] = instance_fleet['Name'] + else: + instance_fleet_config['Name'] = instance_fleet['InstanceFleetType'] + instance_fleet_config['InstanceFleetType'] = instance_fleet['InstanceFleetType'] + + if 'TargetOnDemandCapacity' in keys: + instance_fleet_config['TargetOnDemandCapacity'] = instance_fleet['TargetOnDemandCapacity'] + + if 'TargetSpotCapacity' in keys: + instance_fleet_config['TargetSpotCapacity'] = instance_fleet['TargetSpotCapacity'] + + if 'InstanceTypeConfigs' in keys: + if 'TargetSpotCapacity' in keys: + for instance_type_config in instance_fleet['InstanceTypeConfigs']: + instance_type_config_keys = instance_type_config.keys() + instance_fleet_config['InstanceTypeConfigs'] = instance_fleet['InstanceTypeConfigs'] + + if 'LaunchSpecifications' in keys: + instanceFleetProvisioningSpecifications = instance_fleet['LaunchSpecifications'] + instance_fleet_config['LaunchSpecifications'] = {} + + if 'SpotSpecification' in instanceFleetProvisioningSpecifications: + instance_fleet_config['LaunchSpecifications']['SpotSpecification'] = \ + instanceFleetProvisioningSpecifications['SpotSpecification'] + + instance_fleets.append(instance_fleet_config) + return instance_fleets diff -Nru awscli-1.11.13/awscli/customizations/emr/instancegroupsutils.py awscli-1.18.69/awscli/customizations/emr/instancegroupsutils.py --- awscli-1.11.13/awscli/customizations/emr/instancegroupsutils.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/emr/instancegroupsutils.py 2020-05-28 19:25:48.000000000 +0000 @@ -35,12 +35,20 @@ ig_config['InstanceRole'] = instance_group['InstanceGroupType'].upper() if 'BidPrice' in keys: - ig_config['BidPrice'] = instance_group['BidPrice'] + if instance_group['BidPrice'] != 'OnDemandPrice': + ig_config['BidPrice'] = instance_group['BidPrice'] ig_config['Market'] = constants.SPOT else: ig_config['Market'] = constants.ON_DEMAND if 'EbsConfiguration' in keys: ig_config['EbsConfiguration'] = instance_group['EbsConfiguration'] + + if 'AutoScalingPolicy' in keys: + ig_config['AutoScalingPolicy'] = instance_group['AutoScalingPolicy'] + + if 'Configurations' in keys: + ig_config['Configurations'] = instance_group['Configurations'] + instance_groups.append(ig_config) return instance_groups diff -Nru awscli-1.11.13/awscli/customizations/generatecliskeleton.py awscli-1.18.69/awscli/customizations/generatecliskeleton.py --- awscli-1.11.13/awscli/customizations/generatecliskeleton.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/generatecliskeleton.py 2020-05-28 19:25:48.000000000 +0000 @@ -13,9 +13,13 @@ import json import sys +from botocore import xform_name +from botocore.stub import Stubber from botocore.utils import ArgumentGenerator +from awscli.clidriver import CLIOperationCaller from awscli.customizations.arguments import OverrideRequiredArgsArgument +from awscli.utils import json_encoder def register_generate_cli_skeleton(cli): @@ -36,18 +40,21 @@ The argument, if present in the command line, will prevent the intended command from taking place. Instead, it will generate a JSON skeleton and - print it to standard output. This JSON skeleton then can be filled out - and can be used as input to ``--input-cli-json`` in order to run the - command with the filled out JSON skeleton. + print it to standard output. """ ARG_DATA = { 'name': 'generate-cli-skeleton', - 'help_text': 'Prints a sample input JSON to standard output. Note the ' - 'specified operation is not run if this argument is ' - 'specified. The sample input can be used as an argument ' - 'for ``--cli-input-json``.', - 'action': 'store_true', - 'group_name': 'generate_cli_skeleton' + 'help_text': ( + 'Prints a JSON skeleton to standard output without sending ' + 'an API request. If provided with no value or the value ' + '``input``, prints a sample input JSON that can be used as an ' + 'argument for ``--cli-input-json``. If provided with the value ' + '``output``, it validates the command inputs and returns a ' + 'sample output JSON for that command.' + ), + 'nargs': '?', + 'const': 'input', + 'choices': ['input', 'output'], } def __init__(self, session, operation_model): @@ -59,29 +66,70 @@ 'calling-command.*', self.generate_json_skeleton) super(GenerateCliSkeletonArgument, self)._register_argument_action() + def override_required_args(self, argument_table, args, **kwargs): + arg_name = '--' + self.name + if arg_name in args: + arg_location = args.index(arg_name) + try: + # If the value of --generate-cli-skeleton is ``output``, + # do not force required arguments to be optional as + # ``--generate-cli-skeleton output`` validates commands + # as well as print out the sample output. + if args[arg_location + 1] == 'output': + return + except IndexError: + pass + super(GenerateCliSkeletonArgument, self).override_required_args( + argument_table, args, **kwargs) + def generate_json_skeleton(self, call_parameters, parsed_args, parsed_globals, **kwargs): - - # Only perform the method if the ``--generate-cli-skeleton`` was - # included in the command line. - if getattr(parsed_args, 'generate_cli_skeleton', False): - - # Obtain the model of the operation + if getattr(parsed_args, 'generate_cli_skeleton', None): + for_output = parsed_args.generate_cli_skeleton == 'output' operation_model = self._operation_model - # Generate the skeleton based on the ``input_shape``. - argument_generator = ArgumentGenerator() - operation_input_shape = operation_model.input_shape - # If the ``input_shape`` is ``None``, generate an empty - # dictionary. - if operation_input_shape is None: - skeleton = {} + if for_output: + service_name = operation_model.service_model.service_name + operation_name = operation_model.name + # TODO: It would be better to abstract this logic into + # classes for both the input and output option such that + # a similar set of inputs are taken in and output + # similar functionality. + return StubbedCLIOperationCaller(self._session).invoke( + service_name, operation_name, call_parameters, + parsed_globals) else: - skeleton = argument_generator.generate_skeleton( - operation_input_shape) + argument_generator = ArgumentGenerator() + operation_input_shape = operation_model.input_shape + if operation_input_shape is None: + skeleton = {} + else: + skeleton = argument_generator.generate_skeleton( + operation_input_shape) + + sys.stdout.write( + json.dumps(skeleton, indent=4, default=json_encoder) + ) + sys.stdout.write('\n') + return 0 - # Write the generated skeleton to standard output. - sys.stdout.write(json.dumps(skeleton, indent=4)) - sys.stdout.write('\n') - # This is the return code - return 0 + +class StubbedCLIOperationCaller(CLIOperationCaller): + """A stubbed CLIOperationCaller + + It generates a fake response and uses the response and provided parameters + to make a stubbed client call for an operation command. + """ + def _make_client_call(self, client, operation_name, parameters, + parsed_globals): + method_name = xform_name(operation_name) + operation_model = client.meta.service_model.operation_model( + operation_name) + fake_response = {} + if operation_model.output_shape: + argument_generator = ArgumentGenerator(use_member_names=True) + fake_response = argument_generator.generate_skeleton( + operation_model.output_shape) + with Stubber(client) as stubber: + stubber.add_response(method_name, fake_response) + return getattr(client, method_name)(**parameters) diff -Nru awscli-1.11.13/awscli/customizations/globalargs.py awscli-1.18.69/awscli/customizations/globalargs.py --- awscli-1.11.13/awscli/customizations/globalargs.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/globalargs.py 2020-05-28 19:25:48.000000000 +0000 @@ -22,11 +22,16 @@ def register_parse_global_args(cli): - cli.register('top-level-args-parsed', resolve_types) - cli.register('top-level-args-parsed', no_sign_request) - cli.register('top-level-args-parsed', resolve_verify_ssl) - cli.register('top-level-args-parsed', resolve_cli_read_timeout) - cli.register('top-level-args-parsed', resolve_cli_connect_timeout) + cli.register('top-level-args-parsed', resolve_types, + unique_id='resolve-types') + cli.register('top-level-args-parsed', no_sign_request, + unique_id='no-sign') + cli.register('top-level-args-parsed', resolve_verify_ssl, + unique_id='resolve-verify-ssl') + cli.register('top-level-args-parsed', resolve_cli_read_timeout, + unique_id='resolve-cli-read-timeout') + cli.register('top-level-args-parsed', resolve_cli_connect_timeout, + unique_id='resolve-cli-connect-timeout') def resolve_types(parsed_args, **kwargs): @@ -80,7 +85,8 @@ if not parsed_args.sign_request: # In order to make signing disabled for all requests # we need to use botocore's ``disable_signing()`` handler. - session.register('choose-signer', disable_signing) + session.register( + 'choose-signer', disable_signing, unique_id='disable-signing') def resolve_cli_connect_timeout(parsed_args, session, **kwargs): diff -Nru awscli-1.11.13/awscli/customizations/history/commands.py awscli-1.18.69/awscli/customizations/history/commands.py --- awscli-1.11.13/awscli/customizations/history/commands.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/history/commands.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,63 @@ +# Copyright 2017 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 os + +from awscli.compat import is_windows +from awscli.utils import is_a_tty +from awscli.utils import OutputStreamFactory + +from awscli.customizations.commands import BasicCommand +from awscli.customizations.history.db import DatabaseConnection +from awscli.customizations.history.constants import HISTORY_FILENAME_ENV_VAR +from awscli.customizations.history.constants import DEFAULT_HISTORY_FILENAME +from awscli.customizations.history.db import DatabaseRecordReader + + +class HistorySubcommand(BasicCommand): + def __init__(self, session, db_reader=None, output_stream_factory=None): + super(HistorySubcommand, self).__init__(session) + self._db_reader = db_reader + self._output_stream_factory = output_stream_factory + if output_stream_factory is None: + self._output_stream_factory = OutputStreamFactory() + + def _connect_to_history_db(self): + if self._db_reader is None: + connection = DatabaseConnection(self._get_history_db_filename()) + self._db_reader = DatabaseRecordReader(connection) + + def _close_history_db(self): + self._db_reader.close() + + def _get_history_db_filename(self): + filename = os.environ.get( + HISTORY_FILENAME_ENV_VAR, DEFAULT_HISTORY_FILENAME) + if not os.path.exists(filename): + raise RuntimeError( + 'Could not locate history. Make sure cli_history is set to ' + 'enabled in the ~/.aws/config file' + ) + return filename + + def _should_use_color(self, parsed_globals): + if parsed_globals.color == 'on': + return True + elif parsed_globals.color == 'off': + return False + return is_a_tty() and not is_windows + + def _get_output_stream(self, preferred_pager=None): + if is_a_tty(): + return self._output_stream_factory.get_pager_stream( + preferred_pager) + return self._output_stream_factory.get_stdout_stream() diff -Nru awscli-1.11.13/awscli/customizations/history/constants.py awscli-1.18.69/awscli/customizations/history/constants.py --- awscli-1.11.13/awscli/customizations/history/constants.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/history/constants.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +# Copyright 2017 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 os + + +HISTORY_FILENAME_ENV_VAR = 'AWS_CLI_HISTORY_FILE' +DEFAULT_HISTORY_FILENAME = os.path.expanduser( + os.path.join('~', '.aws', 'cli', 'history', 'history.db')) diff -Nru awscli-1.11.13/awscli/customizations/history/db.py awscli-1.18.69/awscli/customizations/history/db.py --- awscli-1.11.13/awscli/customizations/history/db.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/history/db.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,272 @@ +# Copyright 2017 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 uuid +import time +import json +import datetime +import threading +import logging +from awscli.compat import collections_abc + +from botocore.history import BaseHistoryHandler + +from awscli.compat import sqlite3 +from awscli.compat import binary_type + + +LOG = logging.getLogger(__name__) + + +class DatabaseConnection(object): + _CREATE_TABLE = """ + CREATE TABLE IF NOT EXISTS records ( + id TEXT, + request_id TEXT, + source TEXT, + event_type TEXT, + timestamp INTEGER, + payload TEXT + )""" + _ENABLE_WAL = 'PRAGMA journal_mode=WAL' + + def __init__(self, db_filename): + self._connection = sqlite3.connect( + db_filename, check_same_thread=False, isolation_level=None) + self._ensure_database_setup() + + def close(self): + self._connection.close() + + def execute(self, query, *parameters): + return self._connection.execute(query, *parameters) + + def _ensure_database_setup(self): + self._create_record_table() + self._try_to_enable_wal() + + def _create_record_table(self): + self.execute(self._CREATE_TABLE) + + def _try_to_enable_wal(self): + try: + self.execute(self._ENABLE_WAL) + except sqlite3.Error: + # This is just a performance enhancement so it is optional. Not all + # systems will have a sqlite compiled with the WAL enabled. + LOG.debug('Failed to enable sqlite WAL.') + + @property + def row_factory(self): + return self._connection.row_factory + + @row_factory.setter + def row_factory(self, row_factory): + self._connection.row_factory = row_factory + + +class PayloadSerializer(json.JSONEncoder): + def _encode_mutable_mapping(self, obj): + return dict(obj) + + def _encode_datetime(self, obj): + return obj.isoformat() + + def _try_decode_bytes(self, obj): + try: + obj = obj.decode('utf-8') + except UnicodeDecodeError: + obj = '' + return obj + + def _remove_non_unicode_stings(self, obj): + if isinstance(obj, str): + obj = self._try_decode_bytes(obj) + elif isinstance(obj, dict): + obj = dict((k, self._remove_non_unicode_stings(v)) for k, v + in obj.items()) + elif isinstance(obj, (list, tuple)): + obj = [self._remove_non_unicode_stings(o) for o in obj] + return obj + + def encode(self, obj): + try: + return super(PayloadSerializer, self).encode(obj) + except UnicodeDecodeError: + # This happens in PY2 in the case where a record payload has some + # binary data in it that is not utf-8 encodable. PY2 will not call + # the default method on the individual field with bytes in it since + # it thinks it can handle it with the normal string serialization + # method. Since it cannot tell the difference between a utf-8 str + # and a str with raw bytes in it we will get a UnicodeDecodeError + # here at the top level. There are no hooks into the serialization + # process in PY2 that allow us to fix this behavior, so instead + # when we encounter the unicode error we climb the structure + # ourselves and replace all strings that are not utf-8 decodable + # and try to encode again. + scrubbed_obj = self._remove_non_unicode_stings(obj) + return super(PayloadSerializer, self).encode(scrubbed_obj) + + def default(self, obj): + if isinstance(obj, datetime.datetime): + return self._encode_datetime(obj) + elif isinstance(obj, collections_abc.MutableMapping): + return self._encode_mutable_mapping(obj) + elif isinstance(obj, binary_type): + # In PY3 the bytes type differs from the str type so the default + # method will be called when a bytes object is encountered. + # We call the same _try_decode_bytes method that either decodes it + # to a utf-8 string and continues serialization, or removes the + # value if it is not valid utf-8 string. + return self._try_decode_bytes(obj) + else: + return repr(obj) + + +class DatabaseRecordWriter(object): + _WRITE_RECORD = """ + INSERT INTO records( + id, request_id, source, event_type, timestamp, payload) + VALUES (?,?,?,?,?,?) """ + + def __init__(self, connection): + self._connection = connection + self._lock = threading.Lock() + + def close(self): + self._connection.close() + + def write_record(self, record): + db_record = self._create_db_record(record) + with self._lock: + self._connection.execute(self._WRITE_RECORD, db_record) + + def _create_db_record(self, record): + event_type = record['event_type'] + json_serialized_payload = json.dumps(record['payload'], + cls=PayloadSerializer) + db_record = ( + record['command_id'], + record.get('request_id'), + record['source'], + event_type, + record['timestamp'], + json_serialized_payload + ) + return db_record + + +class DatabaseRecordReader(object): + _ORDERING = 'ORDER BY timestamp' + _GET_LAST_ID_RECORDS = """ + SELECT * FROM records + WHERE id = + (SELECT id FROM records WHERE timestamp = + (SELECT max(timestamp) FROM records)) %s;""" % _ORDERING + _GET_RECORDS_BY_ID = 'SELECT * from records where id = ? %s' % _ORDERING + _GET_ALL_RECORDS = ( + 'SELECT a.id AS id_a, ' + ' b.id AS id_b, ' + ' a.timestamp as timestamp, ' + ' a.payload AS args, ' + ' b.payload AS rc ' + 'FROM records a, records b ' + 'where a.event_type == "CLI_ARGUMENTS" AND ' + ' b.event_type = "CLI_RC" AND ' + ' id_a == id_b ' + '%s DESC' % _ORDERING + ) + + def __init__(self, connection): + self._connection = connection + self._connection.row_factory = self._row_factory + + def close(self): + self._connection.close() + + def _row_factory(self, cursor, row): + d = {} + for idx, col in enumerate(cursor.description): + val = row[idx] + if col[0] == 'payload': + val = json.loads(val) + d[col[0]] = val + return d + + def iter_latest_records(self): + cursor = self._connection.execute(self._GET_LAST_ID_RECORDS) + for row in cursor: + yield row + + def iter_records(self, record_id): + cursor = self._connection.execute(self._GET_RECORDS_BY_ID, [record_id]) + for row in cursor: + yield row + + def iter_all_records(self): + cursor = self._connection.execute(self._GET_ALL_RECORDS) + for row in cursor: + yield row + + +class RecordBuilder(object): + _REQUEST_LIFECYCLE_EVENTS = set( + ['API_CALL', 'HTTP_REQUEST', 'HTTP_RESPONSE', 'PARSED_RESPONSE']) + _START_OF_REQUEST_LIFECYCLE_EVENT = 'API_CALL' + + def __init__(self): + self._identifier = None + self._locals = threading.local() + + def _get_current_thread_request_id(self): + request_id = getattr(self._locals, 'request_id', None) + return request_id + + def _start_http_lifecycle(self): + setattr(self._locals, 'request_id', str(uuid.uuid4())) + + def _get_request_id(self, event_type): + if event_type == self._START_OF_REQUEST_LIFECYCLE_EVENT: + self._start_http_lifecycle() + if event_type in self._REQUEST_LIFECYCLE_EVENTS: + request_id = self._get_current_thread_request_id() + return request_id + return None + + def _get_identifier(self): + if self._identifier is None: + self._identifier = str(uuid.uuid4()) + return self._identifier + + def build_record(self, event_type, payload, source): + uid = self._get_identifier() + record = { + 'command_id': uid, + 'event_type': event_type, + 'payload': payload, + 'source': source, + 'timestamp': int(time.time() * 1000) + } + request_id = self._get_request_id(event_type) + if request_id: + record['request_id'] = request_id + return record + + +class DatabaseHistoryHandler(BaseHistoryHandler): + def __init__(self, writer, record_builder): + self._writer = writer + self._record_builder = record_builder + + def emit(self, event_type, payload, source): + record = self._record_builder.build_record(event_type, payload, source) + self._writer.write_record(record) diff -Nru awscli-1.11.13/awscli/customizations/history/filters.py awscli-1.18.69/awscli/customizations/history/filters.py --- awscli-1.11.13/awscli/customizations/history/filters.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/history/filters.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +import re + + +class RegexFilter(object): + def __init__(self, pattern, replacement): + self._pattern = pattern + self._replacement = replacement + self._regex = None + + def filter_text(self, text): + regex = self._get_regex() + filtered_text = regex.subn(self._replacement, text) + return filtered_text[0] + + def _get_regex(self): + if self._regex is None: + self._regex = re.compile(self._pattern) + return self._regex diff -Nru awscli-1.11.13/awscli/customizations/history/__init__.py awscli-1.18.69/awscli/customizations/history/__init__.py --- awscli-1.11.13/awscli/customizations/history/__init__.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/history/__init__.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,107 @@ +# Copyright 2017 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 os +import sys +import logging + +from botocore.history import get_global_history_recorder +from botocore.exceptions import ProfileNotFound + +from awscli.compat import sqlite3 +from awscli.customizations.commands import BasicCommand +from awscli.customizations.history.constants import HISTORY_FILENAME_ENV_VAR +from awscli.customizations.history.constants import DEFAULT_HISTORY_FILENAME +from awscli.customizations.history.db import DatabaseConnection +from awscli.customizations.history.db import DatabaseRecordWriter +from awscli.customizations.history.db import RecordBuilder +from awscli.customizations.history.db import DatabaseHistoryHandler +from awscli.customizations.history.show import ShowCommand +from awscli.customizations.history.list import ListCommand + + +LOG = logging.getLogger(__name__) +HISTORY_RECORDER = get_global_history_recorder() + + +def register_history_mode(event_handlers): + event_handlers.register( + 'session-initialized', attach_history_handler) + + +def register_history_commands(event_handlers): + event_handlers.register( + "building-command-table.main", add_history_commands) + + +def attach_history_handler(session, parsed_args, **kwargs): + if _should_enable_cli_history(session, parsed_args): + LOG.debug('Enabling CLI history') + + history_filename = os.environ.get( + HISTORY_FILENAME_ENV_VAR, DEFAULT_HISTORY_FILENAME) + if not os.path.isdir(os.path.dirname(history_filename)): + os.makedirs(os.path.dirname(history_filename)) + + connection = DatabaseConnection(history_filename) + writer = DatabaseRecordWriter(connection) + record_builder = RecordBuilder() + db_handler = DatabaseHistoryHandler(writer, record_builder) + + HISTORY_RECORDER.add_handler(db_handler) + HISTORY_RECORDER.enable() + + +def _should_enable_cli_history(session, parsed_args): + if parsed_args.command == 'history': + return False + try: + scoped_config = session.get_scoped_config() + except ProfileNotFound: + # If the profile does not exist, cli history is definitely not + # enabled, but don't let the error get propogated as commands down + # the road may handle this such as the configure set command with + # a --profile flag set. + return False + has_history_enabled = scoped_config.get('cli_history') == 'enabled' + if has_history_enabled and sqlite3 is None: + if has_history_enabled: + sys.stderr.write( + 'cli_history is enabled but sqlite3 is unavailable. ' + 'Unable to collect CLI history.\n' + ) + return False + return has_history_enabled + + +def add_history_commands(command_table, session, **kwargs): + command_table['history'] = HistoryCommand(session) + + +class HistoryCommand(BasicCommand): + NAME = 'history' + DESCRIPTION = ( + 'Commands to interact with the history of AWS CLI commands ran ' + 'over time. To record the history of AWS CLI commands set ' + '``cli_history`` to ``enabled`` in the ``~/.aws/config`` file. ' + 'This can be done by running:\n\n' + '``$ aws configure set cli_history enabled``' + ) + SUBCOMMANDS = [ + {'name': 'show', 'command_class': ShowCommand}, + {'name': 'list', 'command_class': ListCommand} + ] + + def _run_main(self, parsed_args, parsed_globals): + if parsed_args.subcommand is None: + raise ValueError("usage: aws [options] " + "[parameters]\naws: error: too few arguments") diff -Nru awscli-1.11.13/awscli/customizations/history/list.py awscli-1.18.69/awscli/customizations/history/list.py --- awscli-1.11.13/awscli/customizations/history/list.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/history/list.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,122 @@ +# Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"). You +# may not use this file except in compliance with the License. A copy of +# the License is located at +# +# http://aws.amazon.com/apache2.0/ +# +# or in the "license" file accompanying this file. This file is +# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF +# ANY KIND, either express or implied. See the License for the specific +# language governing permissions and limitations under the License. +import json +import datetime + +from awscli.compat import default_pager +from awscli.customizations.history.commands import HistorySubcommand + + +class ListCommand(HistorySubcommand): + NAME = 'list' + DESCRIPTION = ( + 'Shows a list of previously run commands and their command_ids. ' + 'Each row shows only a bare minimum of details including the ' + 'command_id, date, arguments and return code. You can use the ' + '``history show`` with the command_id to see more details about ' + 'a particular entry.' + ) + _COL_WIDTHS = { + 'id_a': 38, + 'timestamp': 24, + 'args': 50, + 'rc': 0 + } + + def _run_main(self, parsed_args, parsed_globals): + self._connect_to_history_db() + try: + raw_records = self._db_reader.iter_all_records() + records = RecordAdapter(raw_records) + if not records.has_next(): + raise RuntimeError( + 'No commands were found in your history. Make sure you have ' + 'enabled history mode by adding "cli_history = enabled" ' + 'to the config file.') + + preferred_pager = self._get_preferred_pager() + with self._get_output_stream(preferred_pager) as output_stream: + formatter = TextFormatter(self._COL_WIDTHS, output_stream) + formatter(records) + finally: + self._close_history_db() + return 0 + + def _get_preferred_pager(self): + preferred_pager = default_pager + if preferred_pager.startswith('less'): + preferred_pager = 'less -SR' + return preferred_pager + + +class RecordAdapter(object): + """This class is just to read one ahead to make sure there are records + + If there are no records we can just exit early. + """ + def __init__(self, records): + self._records = records + self._next = None + self._advance() + + def has_next(self): + return self._next is not None + + def _advance(self): + try: + self._next = next(self._records) + except StopIteration: + self._next = None + + def __iter__(self): + while self.has_next(): + yield self._next + self._advance() + + +class TextFormatter(object): + def __init__(self, col_widths, output_stream): + self._col_widths = col_widths + self._output_stream = output_stream + + def _format_time(self, timestamp): + command_time = datetime.datetime.fromtimestamp(timestamp / 1000) + formatted = datetime.datetime.strftime( + command_time, '%Y-%m-%d %I:%M:%S %p') + return formatted + + def _format_args(self, args, arg_width): + json_value = json.loads(args) + formatted = ' '.join(json_value[:2]) + if len(formatted) >= arg_width: + formatted = '%s...' % formatted[:arg_width-4] + return formatted + + def _format_record(self, record): + fmt_string = "{0:<%s}{1:<%s}{2:<%s}{3}\n" % ( + self._col_widths['id_a'], + self._col_widths['timestamp'], + self._col_widths['args'] + ) + record_line = fmt_string.format( + record['id_a'], + self._format_time(record['timestamp']), + self._format_args(record['args'], self._col_widths['args']), + record['rc'] + ) + return record_line + + def __call__(self, record_adapter): + for record in record_adapter: + formatted_record = self._format_record(record) + self._output_stream.write(formatted_record.encode('utf-8')) diff -Nru awscli-1.11.13/awscli/customizations/history/show.py awscli-1.18.69/awscli/customizations/history/show.py --- awscli-1.11.13/awscli/customizations/history/show.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/history/show.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,411 @@ +# Copyright 2017 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 datetime +import json +import sys +import xml.parsers.expat +import xml.dom.minidom + +import colorama + +from awscli.table import COLORAMA_KWARGS +from awscli.compat import six +from awscli.customizations.history.commands import HistorySubcommand +from awscli.customizations.history.filters import RegexFilter + + +class Formatter(object): + def __init__(self, output=None, include=None, exclude=None): + """Formats and outputs CLI history events + + :type output: File-like obj + :param output: The stream to write the formatted event to. By default + sys.stdout is used. + + :type include: list + :param include: A filter specifying which event to only be displayed. + This parameter is mutually exclusive with exclude. + + :type exclude: list + :param exclude: A filter specifying which events to exclude from being + displayed. This parameter is mutually exclusive with include. + + """ + self._output = output + if self._output is None: + self._output = sys.stdout + if include and exclude: + raise ValueError( + 'Either input or exclude can be provided but not both') + self._include = include + self._exclude = exclude + + def display(self, event_record): + """Displays a formatted version of the event record + + :type event_record: dict + :param event_record: The event record to format and display. + """ + if self._should_display(event_record): + self._display(event_record) + + def _display(self, event_record): + raise NotImplementedError('_display()') + + def _should_display(self, event_record): + if self._include: + return event_record['event_type'] in self._include + elif self._exclude: + return event_record['event_type'] not in self._exclude + else: + return True + + +class DetailedFormatter(Formatter): + _SIG_FILTER = RegexFilter( + 'Signature=([a-z0-9]{4})[a-z0-9]{60}', + r'Signature=\1...', + ) + + _SECTIONS = { + 'CLI_VERSION': { + 'title': 'AWS CLI command entered', + 'values': [ + {'description': 'with AWS CLI version'} + ] + }, + 'CLI_ARGUMENTS': { + 'values': [ + {'description': 'with arguments'} + ] + }, + 'API_CALL': { + 'title': 'API call made', + 'values': [ + { + 'description': 'to service', + 'payload_key': 'service' + }, + { + 'description': 'using operation', + 'payload_key': 'operation' + }, + { + 'description': 'with parameters', + 'payload_key': 'params', + 'value_format': 'dictionary' + } + ] + }, + 'HTTP_REQUEST': { + 'title': 'HTTP request sent', + 'values': [ + { + 'description': 'to URL', + 'payload_key': 'url' + }, + { + 'description': 'with method', + 'payload_key': 'method' + }, + { + 'description': 'with headers', + 'payload_key': 'headers', + 'value_format': 'dictionary', + 'filters': [_SIG_FILTER] + }, + { + 'description': 'with body', + 'payload_key': 'body', + 'value_format': 'http_body' + } + + ] + }, + 'HTTP_RESPONSE': { + 'title': 'HTTP response received', + 'values': [ + { + 'description': 'with status code', + 'payload_key': 'status_code' + }, + { + 'description': 'with headers', + 'payload_key': 'headers', + 'value_format': 'dictionary' + }, + { + 'description': 'with body', + 'payload_key': 'body', + 'value_format': 'http_body' + } + ] + }, + 'PARSED_RESPONSE': { + 'title': 'HTTP response parsed', + 'values': [ + { + 'description': 'parsed to', + 'value_format': 'dictionary' + } + ] + }, + 'CLI_RC': { + 'title': 'AWS CLI command exited', + 'values': [ + {'description': 'with return code'} + ] + }, + } + + _COMPONENT_COLORS = { + 'title': colorama.Style.BRIGHT, + 'description': colorama.Fore.CYAN + } + + def __init__(self, output=None, include=None, exclude=None, colorize=True): + super(DetailedFormatter, self).__init__(output, include, exclude) + self._request_id_to_api_num = {} + self._num_api_calls = 0 + self._colorize = colorize + self._value_pformatter = SectionValuePrettyFormatter() + if self._colorize: + colorama.init(**COLORAMA_KWARGS) + + def _display(self, event_record): + section_definition = self._SECTIONS.get(event_record['event_type']) + if section_definition is not None: + self._display_section(event_record, section_definition) + + def _display_section(self, event_record, section_definition): + if 'title' in section_definition: + self._display_title(section_definition['title'], event_record) + for value_definition in section_definition['values']: + self._display_value(value_definition, event_record) + + def _display_title(self, title, event_record): + formatted_title = self._format_section_title(title, event_record) + self._write_output(formatted_title) + + def _display_value(self, value_definition, event_record): + value_description = value_definition['description'] + event_record_payload = event_record['payload'] + value = event_record_payload + if 'payload_key' in value_definition: + value = event_record_payload[value_definition['payload_key']] + formatted_value = self._format_description(value_description) + formatted_value += self._format_value( + value, event_record, value_definition.get('value_format') + ) + if 'filters' in value_definition: + for text_filter in value_definition['filters']: + formatted_value = text_filter.filter_text(formatted_value) + self._write_output(formatted_value) + + def _write_output(self, content): + if isinstance(content, six.text_type): + content = content.encode('utf-8') + self._output.write(content) + + def _format_section_title(self, title, event_record): + formatted_title = title + api_num = self._get_api_num(event_record) + if api_num is not None: + formatted_title = ('[%s] ' % api_num) + formatted_title + formatted_title = self._color_if_configured(formatted_title, 'title') + formatted_title += '\n' + + formatted_timestamp = self._format_description('at time') + formatted_timestamp += self._format_value( + event_record['timestamp'], event_record, value_format='timestamp') + + return '\n' + formatted_title + formatted_timestamp + + def _get_api_num(self, event_record): + request_id = event_record['request_id'] + if request_id: + if request_id not in self._request_id_to_api_num: + self._request_id_to_api_num[ + request_id] = self._num_api_calls + self._num_api_calls += 1 + return self._request_id_to_api_num[request_id] + + def _format_description(self, value_description): + return self._color_if_configured( + value_description + ': ', 'description') + + def _format_value(self, value, event_record, value_format=None): + if value_format: + formatted_value = self._value_pformatter.pformat( + value, value_format, event_record) + else: + formatted_value = str(value) + return formatted_value + '\n' + + def _color_if_configured(self, text, component): + if self._colorize: + color = self._COMPONENT_COLORS[component] + return color + text + colorama.Style.RESET_ALL + return text + + +class SectionValuePrettyFormatter(object): + def pformat(self, value, value_format, event_record): + return getattr(self, '_pformat_' + value_format)(value, event_record) + + def _pformat_timestamp(self, event_timestamp, event_record=None): + return datetime.datetime.fromtimestamp( + event_timestamp/1000.0).strftime('%Y-%m-%d %H:%M:%S.%f')[:-3] + + def _pformat_dictionary(self, obj, event_record=None): + return json.dumps(obj=obj, sort_keys=True, indent=4) + + def _pformat_http_body(self, body, event_record): + if not body: + return 'There is no associated body' + elif event_record['payload'].get('streaming', False): + return 'The body is a stream and will not be displayed' + elif self._is_xml(body): + # TODO: Figure out a way to minimize the number of times we have + # to parse the XML. Currently at worst, it will take three times. + # One to determine if it is XML, another to stip whitespace, and + # a third to convert to make it pretty. This is an issue as it + # can cause issues when there are large XML payloads such as + # an s3 ListObjects call. + return self._get_pretty_xml(body) + elif self._is_json_structure(body): + return self._get_pretty_json(body) + else: + return body + + def _get_pretty_xml(self, body): + # The body is parsed and whitespace is stripped because some services + # like ec2 already return pretty XML and if toprettyxml() was applied + # to it, it will add even more newlines and spaces on top of it. + # So this just removes all whitespace from the start to prevent the + # chance of adding to much newlines and spaces when toprettyxml() + # is called. + stripped_body = self._strip_whitespace(body) + xml_dom = xml.dom.minidom.parseString(stripped_body) + return xml_dom.toprettyxml(indent=' '*4, newl='\n') + + def _get_pretty_json(self, body): + # The json body is loaded so it can be dumped in a format that + # is desired. + obj = json.loads(body) + return self._pformat_dictionary(obj) + + def _is_xml(self, body): + try: + xml.dom.minidom.parseString(body) + except xml.parsers.expat.ExpatError: + return False + return True + + def _strip_whitespace(self, xml_string): + xml_dom = xml.dom.minidom.parseString(xml_string) + return ''.join( + [line.strip() for line in xml_dom.toxml().splitlines()] + ) + + def _is_json_structure(self, body): + if body.startswith('{'): + try: + json.loads(body) + return True + except json.decoder.JSONDecodeError: + return False + return False + + +class ShowCommand(HistorySubcommand): + NAME = 'show' + DESCRIPTION = ( + 'Shows the various events related to running a specific CLI command. ' + 'If this command is ran without any positional arguments, it will ' + 'display the events for the last CLI command ran.' + ) + FORMATTERS = { + 'detailed': DetailedFormatter + } + ARG_TABLE = [ + {'name': 'command_id', 'nargs': '?', 'default': 'latest', + 'positional_arg': True, + 'help_text': ( + 'The ID of the CLI command to show. If this positional argument ' + 'is omitted, it will show the last the CLI command ran.')}, + {'name': 'include', 'nargs': '+', + 'help_text': ( + 'Specifies which events to **only** include when showing the ' + 'CLI command. This argument is mutually exclusive with ' + '``--exclude``.')}, + {'name': 'exclude', 'nargs': '+', + 'help_text': ( + 'Specifies which events to exclude when showing the ' + 'CLI command. This argument is mutually exclusive with ' + '``--include``.')}, + {'name': 'format', 'choices': FORMATTERS.keys(), + 'default': 'detailed', 'help_text': ( + 'Specifies which format to use in showing the events for ' + 'the specified CLI command. The following formats are ' + 'supported:\n\n' + '
      ' + '
    • detailed - This the default format. It prints out a ' + 'detailed overview of the CLI command ran. It displays all ' + 'of the key events in the command lifecycle where each ' + 'important event has a title and its important values ' + 'underneath. The events are ordered by timestamp and events of ' + 'the same API call are associated together with the ' + '[``api_id``] notation where events that share the same ' + '``api_id`` belong to the lifecycle of the same API call.' + '
      • ' + '
    ' + ) + } + ] + + def _run_main(self, parsed_args, parsed_globals): + self._connect_to_history_db() + try: + self._validate_args(parsed_args) + with self._get_output_stream() as output_stream: + formatter = self._get_formatter( + parsed_args, parsed_globals, output_stream) + for record in self._get_record_iterator(parsed_args): + formatter.display(record) + finally: + self._close_history_db() + return 0 + + def _validate_args(self, parsed_args): + if parsed_args.exclude and parsed_args.include: + raise ValueError( + 'Either --exclude or --include can be provided but not both') + + def _get_formatter(self, parsed_args, parsed_globals, output_stream): + format_type = parsed_args.format + formatter_kwargs = { + 'include': parsed_args.include, + 'exclude': parsed_args.exclude, + 'output': output_stream + } + if format_type == 'detailed': + formatter_kwargs['colorize'] = self._should_use_color( + parsed_globals) + return self.FORMATTERS[format_type](**formatter_kwargs) + + def _get_record_iterator(self, parsed_args): + if parsed_args.command_id == 'latest': + return self._db_reader.iter_latest_records() + else: + return self._db_reader.iter_records(parsed_args.command_id) diff -Nru awscli-1.11.13/awscli/customizations/mturk.py awscli-1.18.69/awscli/customizations/mturk.py --- awscli-1.11.13/awscli/customizations/mturk.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/mturk.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,28 @@ +# Copyright 2017 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. +from awscli.customizations.utils import make_hidden_command_alias + + +def register_alias_mturk_command(event_emitter): + event_emitter.register( + 'building-command-table.mturk', + alias_mturk_command + ) + + +def alias_mturk_command(command_table, **kwargs): + make_hidden_command_alias( + command_table, + existing_name='list-hits-for-qualification-type', + alias_name='list-hi-ts-for-qualification-type', + ) diff -Nru awscli-1.11.13/awscli/customizations/opsworkscm.py awscli-1.18.69/awscli/customizations/opsworkscm.py --- awscli-1.11.13/awscli/customizations/opsworkscm.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/opsworkscm.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +# Copyright 2016 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. +from awscli.customizations.utils import alias_command + + +def register_alias_opsworks_cm(event_emitter): + event_emitter.register('building-command-table.main', alias_opsworks_cm) + + +def alias_opsworks_cm(command_table, **kwargs): + alias_command(command_table, 'opsworkscm', 'opsworks-cm') diff -Nru awscli-1.11.13/awscli/customizations/opsworks.py awscli-1.18.69/awscli/customizations/opsworks.py --- awscli-1.11.13/awscli/customizations/opsworks.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/opsworks.py 2020-05-28 19:25:48.000000000 +0000 @@ -24,7 +24,7 @@ from botocore.exceptions import ClientError -from awscli.compat import shlex_quote, urlopen +from awscli.compat import shlex_quote, urlopen, ensure_text_type from awscli.customizations.commands import BasicCommand from awscli.customizations.utils import create_client_from_parsed_globals @@ -34,6 +34,7 @@ IAM_USER_POLICY_NAME = "OpsWorks-Instance" IAM_USER_POLICY_TIMEOUT = datetime.timedelta(minutes=15) IAM_PATH = '/AWS/OpsWorks/' +IAM_POLICY_ARN = 'arn:aws:iam::aws:policy/AWSOpsWorksInstanceRegistration' HOSTNAME_RE = re.compile(r"^(?!-)[a-z0-9-]{1,63}(?A token to specify where to start paginating. This is the NextToken from a previously truncated response.

    +

    For usage examples, see Pagination in the AWS Command Line Interface User +Guide.

    """ MAX_ITEMS_HELP = """ -

    The total number of items to return. If the total number -of items available is more than the value specified in -max-items then a NextToken will -be provided in the output that you can use to resume pagination. -This NextToken response element should not be -used directly outside of the AWS CLI.

    +

    The total number of items to return in the command's output. +If the total number of items available is more than the value +specified, a NextToken is provided in the command's +output. To resume pagination, provide the +NextToken value in the starting-token +argument of a subsequent command. Do not use the +NextToken response element directly outside of the +AWS CLI.

    +

    For usage examples, see Pagination in the AWS Command Line Interface User +Guide.

    """ PAGE_SIZE_HELP = """ -

    The size of each page.

    +

    The size of each page to get in the AWS service call. This +does not affect the number of items returned in the command's +output. Setting a smaller page size results in more calls to +the AWS service, retrieving fewer items in each call. This can +help prevent the AWS service calls from timing out.

    +

    For usage examples, see Pagination in the AWS Command Line Interface User +Guide.

    """ @@ -237,6 +255,7 @@ type_map = { 'string': str, 'integer': int, + 'long': int, } def __init__(self, name, documentation, parse_type, serialized_name): diff -Nru awscli-1.11.13/awscli/customizations/preview.py awscli-1.18.69/awscli/customizations/preview.py --- awscli-1.11.13/awscli/customizations/preview.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/preview.py 2020-05-28 19:25:48.000000000 +0000 @@ -38,7 +38,6 @@ PREVIEW_SERVICES = [ - 'cloudfront', 'sdb', ] diff -Nru awscli-1.11.13/awscli/customizations/putmetricdata.py awscli-1.18.69/awscli/customizations/putmetricdata.py --- awscli-1.11.13/awscli/customizations/putmetricdata.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/putmetricdata.py 2020-05-28 19:25:48.000000000 +0000 @@ -20,6 +20,7 @@ * --value * --statistic-values * --unit +* --storage-resolution """ import decimal @@ -30,8 +31,8 @@ def register_put_metric_data(event_handler): - event_handler.register('building-argument-table.cloudwatch.put-metric-data', - _promote_args) + event_handler.register( + 'building-argument-table.cloudwatch.put-metric-data', _promote_args) event_handler.register( 'operation-args-parsed.cloudwatch.put-metric-data', validate_mutually_exclusive_handler( @@ -39,7 +40,7 @@ 'dimensions', 'statistic_values'])) -def _promote_args(argument_table, **kwargs): +def _promote_args(argument_table, operation_model, **kwargs): # We're providing top level params for metric-data. This means # that metric-data is now longer a required arg. We do need # to check that either metric-data or the complex args we've added @@ -66,14 +67,27 @@ argument_table['dimensions'] = PutMetricArgument( 'dimensions', help_text=( - 'The --dimension argument further expands ' - 'on the identity of a metric using a Name=Value' + 'The --dimensions argument further expands ' + 'on the identity of a metric using a Name=Value ' 'pair, separated by commas, for example: ' - '--dimensions User=SomeUser,Stack=Test')) + '--dimensions InstanceID=1-23456789,InstanceType=m1.small' + '. Note that the --dimensions argument has a ' + 'different format when used in get-metric-data, ' + 'where for the same example you would use the format ' + '--dimensions Name=InstanceID,Value=i-aaba32d4 ' + 'Name=InstanceType,value=m1.small .' + ) + ) argument_table['statistic-values'] = PutMetricArgument( 'statistic-values', help_text='A set of statistical values describing ' 'the metric.') + metric_data = operation_model.input_shape.members['MetricData'].member + storage_resolution = metric_data.members['StorageResolution'] + argument_table['storage-resolution'] = PutMetricArgument( + 'storage-resolution', help_text=storage_resolution.documentation + ) + def insert_first_element(name): def _wrap_add_to_params(func): @@ -138,3 +152,7 @@ # convert these to a decimal value to preserve precision. statistics[key] = decimal.Decimal(value) first_element['StatisticValues'] = statistics + + @insert_first_element('MetricData') + def _add_param_storage_resolution(self, first_element, value): + first_element['StorageResolution'] = int(value) diff -Nru awscli-1.11.13/awscli/customizations/rds.py awscli-1.18.69/awscli/customizations/rds.py --- awscli-1.11.13/awscli/customizations/rds.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/rds.py 2020-05-28 19:25:48.000000000 +0000 @@ -27,6 +27,8 @@ from awscli.clidriver import ServiceOperation from awscli.clidriver import CLIOperationCaller from awscli.customizations import utils +from awscli.customizations.commands import BasicCommand +from awscli.customizations.utils import uni_print def register_rds_modify_split(cli): @@ -37,6 +39,15 @@ _rename_remove_option) +def register_add_generate_db_auth_token(cli): + cli.register('building-command-table.rds', _add_generate_db_auth_token) + + +def _add_generate_db_auth_token(command_table, session, **kwargs): + command = GenerateDBAuthTokenCommand(session) + command_table['generate-db-auth-token'] = command + + def _rename_add_option(argument_table, **kwargs): utils.rename_argument(argument_table, 'options-to-include', new_name='options') @@ -67,3 +78,32 @@ session=session, operation_model=modify_operation_model, operation_caller=CLIOperationCaller(session)) + + +class GenerateDBAuthTokenCommand(BasicCommand): + NAME = 'generate-db-auth-token' + DESCRIPTION = ( + 'Generates an auth token used to connect to a db with IAM credentials.' + ) + ARG_TABLE = [ + {'name': 'hostname', 'required': True, + 'help_text': 'The hostname of the database to connect to.'}, + {'name': 'port', 'cli_type_name': 'integer', 'required': True, + 'help_text': 'The port number the database is listening on.'}, + {'name': 'username', 'required': True, + 'help_text': 'The username to log in as.'} + ] + + def _run_main(self, parsed_args, parsed_globals): + rds = self._session.create_client( + 'rds', parsed_globals.region, parsed_globals.endpoint_url, + parsed_globals.verify_ssl + ) + token = rds.generate_db_auth_token( + DBHostname=parsed_args.hostname, + Port=parsed_args.port, + DBUsername=parsed_args.username + ) + uni_print(token) + uni_print('\n') + return 0 diff -Nru awscli-1.11.13/awscli/customizations/rekognition.py awscli-1.18.69/awscli/customizations/rekognition.py --- awscli-1.11.13/awscli/customizations/rekognition.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/rekognition.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,92 @@ +# Copyright 2018 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 re + +from awscli.arguments import CustomArgument + + +IMAGE_FILE_DOCSTRING = ('

    The content of the image to be uploaded. ' + 'To specify the content of a local file use the ' + 'fileb:// prefix. ' + 'Example: fileb://image.png

    ') +IMAGE_DOCSTRING_ADDENDUM = ('

    To specify a local file use --%s ' + 'instead.

    ') + + +FILE_PARAMETER_UPDATES = { + 'compare-faces.source-image': 'source-image-bytes', + 'compare-faces.target-image': 'target-image-bytes', + '*.image': 'image-bytes', +} + + +def register_rekognition_detect_labels(cli): + for target, new_param in FILE_PARAMETER_UPDATES.items(): + operation, old_param = target.rsplit('.', 1) + cli.register('building-argument-table.rekognition.%s' % operation, + ImageArgUpdater(old_param, new_param)) + + +class ImageArgUpdater(object): + def __init__(self, source_param, new_param): + self._source_param = source_param + self._new_param = new_param + + def __call__(self, session, argument_table, **kwargs): + if not self._valid_target(argument_table): + return + self._update_param( + argument_table, self._source_param, self._new_param) + + def _valid_target(self, argument_table): + # We need to ensure that the target parameter is a shape that + # looks like it is the Image shape. This means checking that it + # has a member named Bytes of the blob type. + if self._source_param in argument_table: + param = argument_table[self._source_param] + input_model = param.argument_model + bytes_member = input_model.members.get('Bytes') + if bytes_member is not None and bytes_member.type_name == 'blob': + return True + return False + + def _update_param(self, argument_table, source_param, new_param): + argument_table[new_param] = ImageArgument( + new_param, source_param, + help_text=IMAGE_FILE_DOCSTRING, cli_type_name='blob') + argument_table[source_param].required = False + doc_addendum = IMAGE_DOCSTRING_ADDENDUM % new_param + argument_table[source_param].documentation += doc_addendum + + +class ImageArgument(CustomArgument): + def __init__(self, name, source_param, **kwargs): + super(ImageArgument, self).__init__(name, **kwargs) + self._parameter_to_overwrite = reverse_xform_name(source_param) + + def add_to_params(self, parameters, value): + if value is None: + return + image_file_param = {'Bytes': value} + if parameters.get(self._parameter_to_overwrite): + parameters[self._parameter_to_overwrite].update(image_file_param) + else: + parameters[self._parameter_to_overwrite] = image_file_param + + +def _upper(match): + return match.group(1).lstrip('-').upper() + + +def reverse_xform_name(name): + return re.sub(r'(^.|-.)', _upper, name) diff -Nru awscli-1.11.13/awscli/customizations/removals.py awscli-1.18.69/awscli/customizations/removals.py --- awscli-1.11.13/awscli/customizations/removals.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/removals.py 2020-05-28 19:25:48.000000000 +0000 @@ -40,6 +40,8 @@ 'list-instance-groups', 'set-termination-protection', 'set-visible-to-all-users']) + cmd_remover.remove(on_event='building-command-table.kinesis', + remove_commands=['subscribe-to-shard']) class CommandRemover(object): diff -Nru awscli-1.11.13/awscli/customizations/s3/filegenerator.py awscli-1.18.69/awscli/customizations/s3/filegenerator.py --- awscli-1.11.13/awscli/customizations/s3/filegenerator.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/s3/filegenerator.py 2020-05-28 19:25:48.000000000 +0000 @@ -31,7 +31,7 @@ """ This function checks to see if a special file. It checks if the file is a character special device, block special device, FIFO, or - socket. + socket. """ mode = os.stat(path).st_mode # Character special device. @@ -172,10 +172,9 @@ error, listdir = os.error, os.listdir if not self.should_ignore_file(path): if not dir_op: - size, last_update = get_file_stat(path) - last_update = self._validate_update_time(last_update, path) - yield path, {'Size': size, 'LastModified': last_update} - + stats = self._safely_get_file_stats(path) + if stats: + yield stats else: # We need to list files in byte order based on the full # expanded path of the key: 'test/1/2/3.txt' However, @@ -208,13 +207,18 @@ for x in self.list_files(file_path, dir_op): yield x else: - size, last_update = get_file_stat(file_path) - last_update = self._validate_update_time( - last_update, path) - yield ( - file_path, - {'Size': size, 'LastModified': last_update} - ) + stats = self._safely_get_file_stats(file_path) + if stats: + yield stats + + def _safely_get_file_stats(self, file_path): + try: + size, last_update = get_file_stat(file_path) + except (OSError, ValueError): + self.triggers_warning(file_path) + else: + last_update = self._validate_update_time(last_update, file_path) + return file_path, {'Size': size, 'LastModified': last_update} def _validate_update_time(self, update_time, path): # If the update time is None we know we ran into an invalid tiemstamp. @@ -314,8 +318,10 @@ yield self._list_single_object(s3_path) else: lister = BucketLister(self._client) + extra_args = self.request_parameters.get('ListObjectsV2', {}) for key in lister.list_objects(bucket=bucket, prefix=prefix, - page_size=self.page_size): + page_size=self.page_size, + extra_args=extra_args): source_path, response_data = key if response_data['Size'] == 0 and source_path.endswith('/'): if self.operation_name == 'delete': @@ -336,6 +342,12 @@ # a ListObjects operation (which causes concern for anyone setting # IAM policies with the smallest set of permissions needed) and # instead use a HeadObject request. + if self.operation_name == 'delete': + # If the operation is just a single remote delete, there is + # no need to run HeadObject on the S3 object as none of the + # information gained from HeadObject is required to delete the + # object. + return s3_path, {'Size': None, 'LastModified': None} bucket, key = find_bucket_key(s3_path) try: params = {'Bucket': bucket, 'Key': key} diff -Nru awscli-1.11.13/awscli/customizations/s3/fileinfo.py awscli-1.18.69/awscli/customizations/s3/fileinfo.py --- awscli-1.11.13/awscli/customizations/s3/fileinfo.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/s3/fileinfo.py 2020-05-28 19:26:18.000000000 +0000 @@ -80,9 +80,10 @@ return True def _is_glacier_object(self, response_data): + glacier_storage_classes = ['GLACIER', 'DEEP_ARCHIVE'] if response_data: - if response_data.get('StorageClass') == 'GLACIER' and \ - not self._is_restored(response_data): + if response_data.get('StorageClass') in glacier_storage_classes \ + and not self._is_restored(response_data): return True return False diff -Nru awscli-1.11.13/awscli/customizations/s3/filters.py awscli-1.18.69/awscli/customizations/s3/filters.py --- awscli-1.11.13/awscli/customizations/s3/filters.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/s3/filters.py 2020-05-28 19:25:48.000000000 +0000 @@ -149,5 +149,5 @@ file_path, path_pattern) else: LOG.debug("%s did not match %s filter: %s", - file_path, pattern_type[2:], path_pattern) + file_path, pattern_type, path_pattern) return file_status diff -Nru awscli-1.11.13/awscli/customizations/s3/results.py awscli-1.18.69/awscli/customizations/s3/results.py --- awscli-1.11.13/awscli/customizations/s3/results.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/s3/results.py 2020-05-28 19:25:48.000000000 +0000 @@ -10,9 +10,11 @@ # 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. +from __future__ import division import logging import sys import threading +import time from collections import namedtuple from collections import defaultdict @@ -20,10 +22,10 @@ from s3transfer.exceptions import FatalError from s3transfer.subscribers import BaseSubscriber -from awscli.compat import queue +from awscli.compat import queue, ensure_text_type from awscli.customizations.s3.utils import relative_path from awscli.customizations.s3.utils import human_readable_size -from awscli.customizations.s3.utils import uni_print +from awscli.customizations.utils import uni_print from awscli.customizations.s3.utils import WarningResult from awscli.customizations.s3.utils import OnDoneFilteredSubscriber @@ -50,7 +52,8 @@ QueuedResult = _create_new_result_cls('QueuedResult', ['total_transfer_size']) ProgressResult = _create_new_result_cls( - 'ProgressResult', ['bytes_transferred', 'total_transfer_size']) + 'ProgressResult', ['bytes_transferred', 'total_transfer_size', + 'timestamp']) SuccessResult = _create_new_result_cls('SuccessResult') @@ -97,7 +100,8 @@ def on_progress(self, future, bytes_transferred, **kwargs): result_kwargs = self._result_kwargs_cache[future.meta.transfer_id] progress_result = ProgressResult( - bytes_transferred=bytes_transferred, **result_kwargs) + bytes_transferred=bytes_transferred, timestamp=time.time(), + **result_kwargs) self._result_queue.put(progress_result) def _on_success(self, future): @@ -208,6 +212,9 @@ self.expected_files_transferred = 0 self.final_expected_files_transferred = None + self.start_time = None + self.bytes_transfer_speed = 0 + self._ongoing_progress = defaultdict(int) self._ongoing_total_sizes = {} @@ -239,8 +246,11 @@ 'Any result using _get_ongoing_dict_key must subclass from ' 'BaseResult. Provided result is of type: %s' % type(result) ) - return ':'.join( - str(el) for el in [result.transfer_type, result.src, result.dest]) + key_parts = [] + for result_property in [result.transfer_type, result.src, result.dest]: + if result_property is not None: + key_parts.append(ensure_text_type(result_property)) + return u':'.join(key_parts) def _pop_result_from_ongoing_dicts(self, result): ongoing_key = self._get_ongoing_dict_key(result) @@ -253,6 +263,8 @@ pass def _record_queued_result(self, result, **kwargs): + if self.start_time is None: + self.start_time = time.time() total_transfer_size = result.total_transfer_size self._ongoing_total_sizes[ self._get_ongoing_dict_key(result)] = total_transfer_size @@ -268,6 +280,16 @@ self._ongoing_progress[ self._get_ongoing_dict_key(result)] += bytes_transferred self.bytes_transferred += bytes_transferred + # Since the start time is captured in the result recorder and + # capture timestamps in the subscriber, there is a chance that if + # a progress result gets created right after the queued result + # gets created that the timestamp on the progress result is less + # than the timestamp of when the result processor actually + # processes that initial queued result. So this will avoid + # negative progress being displayed or zero divison occuring. + if result.timestamp > self.start_time: + self.bytes_transfer_speed = self.bytes_transferred / ( + result.timestamp - self.start_time) def _update_ongoing_transfer_size_if_unknown(self, result): # This is a special case when the transfer size was previous not @@ -327,31 +349,31 @@ _ESTIMATED_EXPECTED_TOTAL = "~{expected_total}" _STILL_CALCULATING_TOTALS = " (calculating...)" BYTE_PROGRESS_FORMAT = ( - 'Completed {bytes_completed}/{expected_bytes_completed} with ' - + _FILES_REMAINING + 'Completed {bytes_completed}/{expected_bytes_completed} ' + '({transfer_speed}) with ' + _FILES_REMAINING ) FILE_PROGRESS_FORMAT = ( 'Completed {files_completed} file(s) with ' + _FILES_REMAINING ) SUCCESS_FORMAT = ( - '{transfer_type}: {transfer_location}' + u'{transfer_type}: {transfer_location}' ) - DRY_RUN_FORMAT = '(dryrun) ' + SUCCESS_FORMAT + DRY_RUN_FORMAT = u'(dryrun) ' + SUCCESS_FORMAT FAILURE_FORMAT = ( - '{transfer_type} failed: {transfer_location} {exception}' + u'{transfer_type} failed: {transfer_location} {exception}' ) # TODO: Add "warning: " prefix once all commands are converted to using # result printer and remove "warning: " prefix from ``create_warning``. WARNING_FORMAT = ( - '{message}' + u'{message}' ) ERROR_FORMAT = ( - 'fatal error: {exception}' + u'fatal error: {exception}' ) CTRL_C_MSG = 'cancelled: ctrl-c received' - SRC_DEST_TRANSFER_LOCATION_FORMAT = '{src} to {dest}' - SRC_TRANSFER_LOCATION_FORMAT = '{src}' + SRC_DEST_TRANSFER_LOCATION_FORMAT = u'{src} to {dest}' + SRC_TRANSFER_LOCATION_FORMAT = u'{src}' def __init__(self, result_recorder, out_file=None, error_file=None): """Prints status of ongoing transfer @@ -474,9 +496,12 @@ human_readable_size( self._result_recorder.expected_bytes_transferred)) + transfer_speed = human_readable_size( + self._result_recorder.bytes_transfer_speed) + '/s' progress_statement = self.BYTE_PROGRESS_FORMAT.format( bytes_completed=bytes_completed, expected_bytes_completed=expected_bytes_completed, + transfer_speed=transfer_speed, remaining_files=remaining_files ) else: @@ -529,6 +554,12 @@ uni_print(self._adjust_statement_padding(''), self._out_file) +class NoProgressResultPrinter(ResultPrinter): + """A result printer that doesn't print progress""" + def _print_progress(self, **kwargs): + pass + + class OnlyShowErrorsResultPrinter(ResultPrinter): """A result printer that only prints out errors""" def _print_progress(self, **kwargs): diff -Nru awscli-1.11.13/awscli/customizations/s3/s3handler.py awscli-1.18.69/awscli/customizations/s3/s3handler.py --- awscli-1.11.13/awscli/customizations/s3/s3handler.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/s3/s3handler.py 2020-05-28 19:25:48.000000000 +0000 @@ -33,6 +33,7 @@ from awscli.customizations.s3.results import ResultRecorder from awscli.customizations.s3.results import ResultPrinter from awscli.customizations.s3.results import OnlyShowErrorsResultPrinter +from awscli.customizations.s3.results import NoProgressResultPrinter from awscli.customizations.s3.results import ResultProcessor from awscli.customizations.s3.results import CommandResultRecorder from awscli.customizations.s3.utils import RequestParamsMapper @@ -45,7 +46,7 @@ from awscli.customizations.s3.utils import DeleteSourceFileSubscriber from awscli.customizations.s3.utils import DeleteSourceObjectSubscriber from awscli.customizations.s3.utils import DeleteCopySourceObjectSubscriber -from awscli.compat import binary_stdin +from awscli.compat import get_binary_stdin LOGGER = logging.getLogger(__name__) @@ -110,6 +111,8 @@ result_printer = OnlyShowErrorsResultPrinter(result_recorder) elif self._cli_params.get('is_stream'): result_printer = OnlyShowErrorsResultPrinter(result_recorder) + elif not self._cli_params.get('progress'): + result_printer = NoProgressResultPrinter(result_recorder) else: result_printer = ResultPrinter(result_recorder) result_processor_handlers.append(result_printer) @@ -303,14 +306,29 @@ 's3://'+fileinfo.src, 'Object is of storage class GLACIER. Unable to ' 'perform %s operations on GLACIER objects. You must ' - 'restore the object to be able to the perform ' - 'operation.' % - fileinfo.operation_name + 'restore the object to be able to perform the ' + 'operation. See aws s3 %s help for additional ' + 'parameter options to ignore or force these ' + 'transfers.' % + (fileinfo.operation_name, fileinfo.operation_name) ) self._result_queue.put(warning) return True return False + def _warn_parent_reference(self, fileinfo): + # normpath() will use the OS path separator so we + # need to take that into account when checking for a parent prefix. + parent_prefix = '..' + os.path.sep + escapes_cwd = os.path.normpath(fileinfo.compare_key).startswith( + parent_prefix) + if escapes_cwd: + warning = create_warning( + fileinfo.compare_key, "File references a parent directory.") + self._result_queue.put(warning) + return True + return False + def _format_src_dest(self, fileinfo): """Returns formatted versions of a fileinfos source and destination.""" raise NotImplementedError('_format_src_dest') @@ -396,7 +414,7 @@ return fileinfo.dest def _get_warning_handlers(self): - return [self._warn_glacier] + return [self._warn_glacier, self._warn_parent_reference] def _format_src_dest(self, fileinfo): src = self._format_s3_path(fileinfo.src) @@ -453,6 +471,7 @@ subscribers.append(ProvideSizeSubscriber(int(expected_size))) def _get_filein(self, fileinfo): + binary_stdin = get_binary_stdin() return NonSeekableStream(binary_stdin) def _format_local_path(self, path): @@ -479,7 +498,7 @@ class DeleteRequestSubmitter(BaseTransferRequestSubmitter): - REQUEST_MAPPER_METHOD = None + REQUEST_MAPPER_METHOD = RequestParamsMapper.map_delete_object_params RESULT_SUBSCRIBER_CLASS = DeleteResultSubscriber def can_submit(self, fileinfo): @@ -513,7 +532,7 @@ # the burden of this functionality should live in the CLI. # The main downsides in doing this is that delete and the result - # creation happens in the main thread as opposed to a seperate thread + # creation happens in the main thread as opposed to a separate thread # in s3transfer. However, this is not too big of a downside because # deleting a local file only happens for sync --delete downloads and # is very fast compared to all of the other types of transfers. diff -Nru awscli-1.11.13/awscli/customizations/s3/subcommands.py awscli-1.18.69/awscli/customizations/s3/subcommands.py --- awscli-1.11.13/awscli/customizations/s3/subcommands.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/s3/subcommands.py 2020-05-28 19:25:48.000000000 +0000 @@ -28,9 +28,10 @@ from awscli.customizations.s3.fileinfo import FileInfo from awscli.customizations.s3.filters import create_filter from awscli.customizations.s3.s3handler import S3TransferHandlerFactory -from awscli.customizations.s3.utils import find_bucket_key, uni_print, \ - AppendFilter, find_dest_path_comp_key, human_readable_size, \ +from awscli.customizations.s3.utils import find_bucket_key, AppendFilter, \ + find_dest_path_comp_key, human_readable_size, \ RequestParamsMapper, split_s3_bucket_key +from awscli.customizations.utils import uni_print from awscli.customizations.s3.syncstrategy.base import MissingFileSync, \ SizeAndLastModifiedSync, NeverSync from awscli.customizations.s3 import transferconfig @@ -85,7 +86,7 @@ "Note that S3 does not support symbolic links, so the " "contents of the link target are uploaded under the " "name of the link. When neither ``--follow-symlinks`` " - "nor ``--no-follow-symlinks`` is specifed, the default " + "nor ``--no-follow-symlinks`` is specified, the default " "is to follow symlinks.")} @@ -157,14 +158,13 @@ 'the granted permissions, and can be set to read, readacl, ' 'writeacl, or full.
  • Grantee_Type - ' 'Specifies how the grantee is to be identified, and can be set ' - 'to uri, emailaddress, or id.
  • Grantee_ID - ' + 'to uri or id.
  • Grantee_ID - ' 'Specifies the grantee based on Grantee_Type. The ' 'Grantee_ID value can be one of:
    • uri ' '- The group\'s URI. For more information, see ' '' 'Who Is a Grantee?
      • ' - '
    • emailaddress - The account\'s email address.
      • ' '
    • id - The account\'s canonical ID
    ' '
    • ' 'For more information on Amazon S3 access control, see ' @@ -190,17 +190,17 @@ 'of the the object in S3. ``AES256`` is the only valid value. ' 'If the parameter is specified but no value is provided, ' '``AES256`` is used. If you provide this value, ``--sse-c-key`` ' - 'must be specfied as well.' + 'must be specified as well.' ) } SSE_C_KEY = { - 'name': 'sse-c-key', + 'name': 'sse-c-key', 'cli_type_name': 'blob', 'help_text': ( 'The customer-provided encryption key to use to server-side ' 'encrypt the object in S3. If you provide this value, ' - '``--sse-c`` must be specfied as well. The key provided should ' + '``--sse-c`` must be specified as well. The key provided should ' '**not** be base64 encoded.' ) } @@ -209,10 +209,10 @@ SSE_KMS_KEY_ID = { 'name': 'sse-kms-key-id', 'help_text': ( - 'The AWS KMS key ID that should be used to server-side ' - 'encrypt the object in S3. Note that you should only ' - 'provide this parameter if KMS key ID is different the ' - 'default S3 master KMS key.' + 'The customer-managed AWS Key Management Service (KMS) key ID that ' + 'should be used to server-side encrypt the object in S3. You should ' + 'only provide this parameter if you are using a customer managed ' + 'customer master key (CMK) and not the AWS managed KMS CMK.' ) } @@ -227,31 +227,34 @@ 'object. ``AES256`` is the only valid ' 'value. If the parameter is specified but no value is provided, ' '``AES256`` is used. If you provide this value, ' - '``--sse-c-copy-source-key`` must be specfied as well. ' + '``--sse-c-copy-source-key`` must be specified as well. ' ) } SSE_C_COPY_SOURCE_KEY = { - 'name': 'sse-c-copy-source-key', + 'name': 'sse-c-copy-source-key', 'cli_type_name': 'blob', 'help_text': ( 'This parameter should only be specified when copying an S3 object ' 'that was encrypted server-side with a customer-provided ' 'key. Specifies the customer-provided encryption key for Amazon S3 ' 'to use to decrypt the source object. The encryption key provided ' 'must be one that was used when the source object was created. ' - 'If you provide this value, ``--sse-c-copy-source`` be specfied as ' + 'If you provide this value, ``--sse-c-copy-source`` be specified as ' 'well. The key provided should **not** be base64 encoded.' ) } STORAGE_CLASS = {'name': 'storage-class', - 'choices': ['STANDARD', 'REDUCED_REDUNDANCY', 'STANDARD_IA'], + 'choices': ['STANDARD', 'REDUCED_REDUNDANCY', 'STANDARD_IA', + 'ONEZONE_IA', 'INTELLIGENT_TIERING', 'GLACIER', + 'DEEP_ARCHIVE'], 'help_text': ( "The type of storage to use for the object. " "Valid choices are: STANDARD | REDUCED_REDUNDANCY " - "| STANDARD_IA. " + "| STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING " + "| GLACIER | DEEP_ARCHIVE. " "Defaults to 'STANDARD'")} @@ -368,12 +371,21 @@ 'output is suppressed.')} +NO_PROGRESS = {'name': 'no-progress', + 'action': 'store_false', + 'dest': 'progress', + 'help_text': ( + 'File transfer progress is not displayed. This flag ' + 'is only applied when the quiet and only-show-errors ' + 'flags are not provided.')} + + EXPECTED_SIZE = {'name': 'expected-size', 'help_text': ( 'This argument specifies the expected size of a stream ' 'in terms of bytes. Note that this argument is needed ' 'only when a stream is being uploaded to s3 and the size ' - 'is larger than 5GB. Failure to include this argument ' + 'is larger than 50GB. Failure to include this argument ' 'under these conditions may result in a failed upload ' 'due to too many parts in upload.')} @@ -423,8 +435,9 @@ SSE_C_COPY_SOURCE_KEY, STORAGE_CLASS, GRANTS, WEBSITE_REDIRECT, CONTENT_TYPE, CACHE_CONTROL, CONTENT_DISPOSITION, CONTENT_ENCODING, CONTENT_LANGUAGE, - EXPIRES, SOURCE_REGION, ONLY_SHOW_ERRORS, - PAGE_SIZE, IGNORE_GLACIER_WARNINGS, FORCE_GLACIER_TRANSFER] + EXPIRES, SOURCE_REGION, ONLY_SHOW_ERRORS, NO_PROGRESS, + PAGE_SIZE, IGNORE_GLACIER_WARNINGS, FORCE_GLACIER_TRANSFER, + REQUEST_PAYER] def get_client(session, region, endpoint_url, verify, config=None): @@ -488,7 +501,7 @@ def _list_all_objects(self, bucket, key, page_size=None, request_payer=None): - paginator = self.client.get_paginator('list_objects') + paginator = self.client.get_paginator('list_objects_v2') paging_args = { 'Bucket': bucket, 'Prefix': key, 'Delimiter': '/', 'PaginationConfig': {'PageSize': page_size} @@ -536,7 +549,7 @@ def _list_all_objects_recursive(self, bucket, key, page_size=None, request_payer=None): - paginator = self.client.get_paginator('list_objects') + paginator = self.client.get_paginator('list_objects_v2') paging_args = { 'Bucket': bucket, 'Prefix': key, 'PaginationConfig': {'PageSize': page_size} @@ -633,9 +646,12 @@ class PresignCommand(S3Command): NAME = 'presign' - DESCRIPTION = ("Generate a pre-signed URL for an Amazon S3 object. " - "This allows anyone who receives the pre-signed URL " - "to retrieve the S3 object with an HTTP GET request.") + DESCRIPTION = ( + "Generate a pre-signed URL for an Amazon S3 object. This allows " + "anyone who receives the pre-signed URL to retrieve the S3 object " + "with an HTTP GET request. For sigv4 requests the region needs to be " + "configured explicitly." + ) USAGE = "" ARG_TABLE = [{'name': 'path', 'positional_arg': True, 'synopsis': USAGE}, @@ -730,8 +746,8 @@ DESCRIPTION = "Deletes an S3 object." USAGE = "" ARG_TABLE = [{'name': 'paths', 'nargs': 1, 'positional_arg': True, - 'synopsis': USAGE}, DRYRUN, QUIET, RECURSIVE, INCLUDE, - EXCLUDE, ONLY_SHOW_ERRORS, PAGE_SIZE] + 'synopsis': USAGE}, DRYRUN, QUIET, RECURSIVE, REQUEST_PAYER, + INCLUDE, EXCLUDE, ONLY_SHOW_ERRORS, PAGE_SIZE] class SyncCommand(S3TransferCommand): @@ -833,7 +849,7 @@ instructions identifies which type of components are required based on the name of the command and the parameters passed to the command line. After the instructions are generated the second step involves using the - lsit of instructions to wire together an assortment of generators to + list of instructions to wire together an assortment of generators to perform the command. """ def __init__(self, session, cmd, parameters, runtime_config=None): @@ -899,7 +915,7 @@ """Determines the sync strategy for the command. It defaults to the default sync strategies but a customizable sync - strategy can overide the default strategy if it returns the instance + strategy can override the default strategy if it returns the instance of its self when the event is emitted. """ sync_strategies = {} @@ -909,7 +925,7 @@ sync_strategies['file_not_at_dest_sync_strategy'] = MissingFileSync() sync_strategies['file_not_at_src_sync_strategy'] = NeverSync() - # Determine what strategies to overide if any. + # Determine what strategies to override if any. responses = self.session.emit( 'choosing-s3-sync-strategy', params=self.parameters) if responses is not None: @@ -972,26 +988,16 @@ 'result_queue': result_queue, } - fgen_request_parameters = {} - fgen_head_object_params = {} - fgen_request_parameters['HeadObject'] = fgen_head_object_params + fgen_request_parameters = \ + self._get_file_generator_request_parameters_skeleton() + self._map_request_payer_params(fgen_request_parameters) + self._map_sse_c_params(fgen_request_parameters, paths_type) fgen_kwargs['request_parameters'] = fgen_request_parameters - # SSE-C may be neaded for HeadObject for copies/downloads/deletes - # If the operation is s3 to s3, the FileGenerator should use the - # copy source key and algorithm. Otherwise, use the regular - # SSE-C key and algorithm. Note the reverse FileGenerator does - # not need any of these because it is used only for sync operations - # which only use ListObjects which does not require HeadObject. - RequestParamsMapper.map_head_object_params( - fgen_head_object_params, self.parameters) - if paths_type == 's3s3': - RequestParamsMapper.map_head_object_params( - fgen_head_object_params, { - 'sse_c': self.parameters.get('sse_c_copy_source'), - 'sse_c_key': self.parameters.get('sse_c_copy_source_key') - } - ) + rgen_request_parameters = \ + self._get_file_generator_request_parameters_skeleton() + self._map_request_payer_params(rgen_request_parameters) + rgen_kwargs['request_parameters'] = rgen_request_parameters file_generator = FileGenerator(**fgen_kwargs) rev_generator = FileGenerator(**rgen_kwargs) @@ -1069,10 +1075,46 @@ rc = 0 if files[0].num_tasks_failed > 0: rc = 1 - if files[0].num_tasks_warned > 0: + elif files[0].num_tasks_warned > 0: rc = 2 return rc + def _get_file_generator_request_parameters_skeleton(self): + return { + 'HeadObject': {}, + 'ListObjects': {}, + 'ListObjectsV2': {} + } + + def _map_request_payer_params(self, request_parameters): + RequestParamsMapper.map_head_object_params( + request_parameters['HeadObject'], { + 'request_payer': self.parameters.get('request_payer') + } + ) + RequestParamsMapper.map_list_objects_v2_params( + request_parameters['ListObjectsV2'], { + 'request_payer': self.parameters.get('request_payer') + } + ) + + def _map_sse_c_params(self, request_parameters, paths_type): + # SSE-C may be neaded for HeadObject for copies/downloads/deletes + # If the operation is s3 to s3, the FileGenerator should use the + # copy source key and algorithm. Otherwise, use the regular + # SSE-C key and algorithm. Note the reverse FileGenerator does + # not need any of these because it is used only for sync operations + # which only use ListObjects which does not require HeadObject. + RequestParamsMapper.map_head_object_params( + request_parameters['HeadObject'], self.parameters) + if paths_type == 's3s3': + RequestParamsMapper.map_head_object_params( + request_parameters['HeadObject'], { + 'sse_c': self.parameters.get('sse_c_copy_source'), + 'sse_c_key': self.parameters.get('sse_c_copy_source_key') + } + ) + class CommandParameters(object): """ diff -Nru awscli-1.11.13/awscli/customizations/s3/transferconfig.py awscli-1.18.69/awscli/customizations/s3/transferconfig.py --- awscli-1.11.13/awscli/customizations/s3/transferconfig.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/s3/transferconfig.py 2020-05-28 19:25:48.000000000 +0000 @@ -22,6 +22,7 @@ 'multipart_chunksize': 8 * (1024 ** 2), 'max_concurrent_requests': 10, 'max_queue_size': 1000, + 'max_bandwidth': None } @@ -32,8 +33,10 @@ class RuntimeConfig(object): POSITIVE_INTEGERS = ['multipart_chunksize', 'multipart_threshold', - 'max_concurrent_requests', 'max_queue_size'] + 'max_concurrent_requests', 'max_queue_size', + 'max_bandwidth'] HUMAN_READABLE_SIZES = ['multipart_chunksize', 'multipart_threshold'] + HUMAN_READABLE_RATES = ['max_bandwidth'] @staticmethod def defaults(): @@ -54,6 +57,7 @@ if kwargs: runtime_config.update(kwargs) self._convert_human_readable_sizes(runtime_config) + self._convert_human_readable_rates(runtime_config) self._validate_config(runtime_config) return runtime_config @@ -63,6 +67,17 @@ if value is not None and not isinstance(value, six.integer_types): runtime_config[attr] = human_readable_to_bytes(value) + def _convert_human_readable_rates(self, runtime_config): + for attr in self.HUMAN_READABLE_RATES: + value = runtime_config.get(attr) + if value is not None and not isinstance(value, six.integer_types): + if not value.endswith('B/s'): + raise InvalidConfigError( + 'Invalid rate: %s. The value must be expressed ' + 'as a rate in terms of bytes per seconds ' + '(e.g. 10MB/s or 800KB/s)' % value) + runtime_config[attr] = human_readable_to_bytes(value[:-2]) + def _validate_config(self, runtime_config): for attr in self.POSITIVE_INTEGERS: value = runtime_config.get(attr) @@ -94,6 +109,7 @@ 'max_queue_size': 'max_request_queue_size', 'multipart_threshold': 'multipart_threshold', 'multipart_chunksize': 'multipart_chunksize', + 'max_bandwidth': 'max_bandwidth', } kwargs = {} for key, value in runtime_config.items(): diff -Nru awscli-1.11.13/awscli/customizations/s3/utils.py awscli-1.18.69/awscli/customizations/s3/utils.py --- awscli-1.11.13/awscli/customizations/s3/utils.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/s3/utils.py 2020-05-28 19:26:18.000000000 +0000 @@ -16,7 +16,7 @@ import mimetypes import errno import os -import sys +import re import time from collections import namedtuple, deque @@ -43,10 +43,14 @@ 'gib': 1024 ** 3, 'tib': 1024 ** 4, } +_S3_ACCESSPOINT_TO_BUCKET_KEY_REGEX = re.compile( + r'^(?Parn:(aws).*:s3:[a-z\-0-9]+:[0-9]{12}:accesspoint[:/][^/]+)/?' + r'(?P.*)$' +) def human_readable_size(value): - """Convert an size in bytes into a human readable format. + """Convert a size in bytes into a human readable format. For example:: @@ -59,11 +63,10 @@ >>> human_readable_size(1024 * 1024) '1.0 MiB' - :param value: The size in bytes + :param value: The size in bytes. :return: The size in a human readable format based on base-2 units. """ - one_decimal_point = '%.1f' base = 1024 bytes_int = float(value) @@ -182,11 +185,14 @@ the form: bucket/key It will return the bucket and the key represented by the s3 path """ - s3_components = s3_path.split('/') + match = _S3_ACCESSPOINT_TO_BUCKET_KEY_REGEX.match(s3_path) + if match: + return match.group('bucket'), match.group('key') + s3_components = s3_path.split('/', 1) bucket = s3_components[0] - s3_key = "" + s3_key = '' if len(s3_components) > 1: - s3_key = '/'.join(s3_components[1:]) + s3_key = s3_components[1] return bucket, s3_key @@ -216,13 +222,13 @@ try: update_time = datetime.fromtimestamp(stats.st_mtime, tzlocal()) - except (ValueError, OSError): + except (ValueError, OSError, OverflowError): # Python's fromtimestamp raises value errors when the timestamp is out # of range of the platform's C localtime() function. This can cause - # issues when syncing from systems with a wide range of valid timestamps - # to systems with a lower range. Some systems support 64-bit timestamps, - # for instance, while others only support 32-bit. We don't want to fail - # in these cases, so instead we pass along none. + # issues when syncing from systems with a wide range of valid + # timestamps to systems with a lower range. Some systems support + # 64-bit timestamps, for instance, while others only support 32-bit. + # We don't want to fail in these cases, so instead we pass along none. update_time = None return stats.st_size, update_time @@ -269,49 +275,6 @@ return warning_message -def uni_print(statement, out_file=None): - """ - This function is used to properly write unicode to a file, usually - stdout or stdderr. It ensures that the proper encoding is used if the - statement is not a string type. - """ - if out_file is None: - out_file = sys.stdout - try: - # Otherwise we assume that out_file is a - # text writer type that accepts str/unicode instead - # of bytes. - out_file.write(statement) - except UnicodeEncodeError: - # Some file like objects like cStringIO will - # try to decode as ascii on python2. - # - # This can also fail if our encoding associated - # with the text writer cannot encode the unicode - # ``statement`` we've been given. This commonly - # happens on windows where we have some S3 key - # previously encoded with utf-8 that can't be - # encoded using whatever codepage the user has - # configured in their console. - # - # At this point we've already failed to do what's - # been requested. We now try to make a best effort - # attempt at printing the statement to the outfile. - # We're using 'ascii' as the default because if the - # stream doesn't give us any encoding information - # we want to pick an encoding that has the highest - # chance of printing successfully. - new_encoding = getattr(out_file, 'encoding', 'ascii') - # When the output of the aws command is being piped, - # ``sys.stdout.encoding`` is ``None``. - if new_encoding is None: - new_encoding = 'ascii' - new_statement = statement.encode( - new_encoding, 'replace').decode(new_encoding) - out_file.write(new_statement) - out_file.flush() - - class StdoutBytesWriter(object): """ This class acts as a file-like object that performs the bytes_print @@ -401,12 +364,15 @@ self._client = client self._date_parser = date_parser - def list_objects(self, bucket, prefix=None, page_size=None): + def list_objects(self, bucket, prefix=None, page_size=None, + extra_args=None): kwargs = {'Bucket': bucket, 'PaginationConfig': {'PageSize': page_size}} if prefix is not None: kwargs['Prefix'] = prefix + if extra_args is not None: + kwargs.update(extra_args) - paginator = self._client.get_paginator('list_objects') + paginator = self._client.get_paginator('list_objects_v2') pages = paginator.paginate(**kwargs) for page in pages: contents = page.get('Contents', []) @@ -468,11 +434,13 @@ cls._set_metadata_params(request_params, cli_params) cls._set_sse_request_params(request_params, cli_params) cls._set_sse_c_request_params(request_params, cli_params) + cls._set_request_payer_param(request_params, cli_params) @classmethod def map_get_object_params(cls, request_params, cli_params): """Map CLI params to GetObject request params""" cls._set_sse_c_request_params(request_params, cli_params) + cls._set_request_payer_param(request_params, cli_params) @classmethod def map_copy_object_params(cls, request_params, cli_params): @@ -484,11 +452,13 @@ cls._set_sse_request_params(request_params, cli_params) cls._set_sse_c_and_copy_source_request_params( request_params, cli_params) + cls._set_request_payer_param(request_params, cli_params) @classmethod def map_head_object_params(cls, request_params, cli_params): """Map CLI params to HeadObject request params""" cls._set_sse_c_request_params(request_params, cli_params) + cls._set_request_payer_param(request_params, cli_params) @classmethod def map_create_multipart_upload_params(cls, request_params, cli_params): @@ -497,21 +467,37 @@ cls._set_sse_request_params(request_params, cli_params) cls._set_sse_c_request_params(request_params, cli_params) cls._set_metadata_params(request_params, cli_params) + cls._set_request_payer_param(request_params, cli_params) @classmethod def map_upload_part_params(cls, request_params, cli_params): """Map CLI params to UploadPart request params""" cls._set_sse_c_request_params(request_params, cli_params) + cls._set_request_payer_param(request_params, cli_params) @classmethod def map_upload_part_copy_params(cls, request_params, cli_params): """Map CLI params to UploadPartCopy request params""" cls._set_sse_c_and_copy_source_request_params( request_params, cli_params) + cls._set_request_payer_param(request_params, cli_params) + + @classmethod + def map_delete_object_params(cls, request_params, cli_params): + cls._set_request_payer_param(request_params, cli_params) + + @classmethod + def map_list_objects_v2_params(cls, request_params, cli_params): + cls._set_request_payer_param(request_params, cli_params) + + @classmethod + def _set_request_payer_param(cls, request_params, cli_params): + if cli_params.get('request_payer'): + request_params['RequestPayer'] = cli_params['request_payer'] @classmethod def _set_general_object_params(cls, request_params, cli_params): - # Paramters set in this method should be applicable to the following + # Parameters set in this method should be applicable to the following # operations involving objects: PutObject, CopyObject, and # CreateMultipartUpload. general_param_translation = { @@ -666,10 +652,14 @@ def _delete_source(self, future): call_args = future.meta.call_args - self._client.delete_object( - Bucket=self._get_bucket(call_args), - Key=self._get_key(call_args) - ) + delete_object_kwargs = { + 'Bucket': self._get_bucket(call_args), + 'Key': self._get_key(call_args) + } + if call_args.extra_args.get('RequestPayer'): + delete_object_kwargs['RequestPayer'] = call_args.extra_args[ + 'RequestPayer'] + self._client.delete_object(**delete_object_kwargs) class DeleteCopySourceObjectSubscriber(DeleteSourceObjectSubscriber): diff -Nru awscli-1.11.13/awscli/customizations/s3endpoint.py awscli-1.18.69/awscli/customizations/s3endpoint.py --- awscli-1.11.13/awscli/customizations/s3endpoint.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/s3endpoint.py 1970-01-01 00:00:00.000000000 +0000 @@ -1,45 +0,0 @@ -# Copyright 2014 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. -"""Disable endpoint url customizations for s3. - -There's a customization in botocore such that for S3 operations -we try to fix the S3 endpoint url based on whether a bucket is -dns compatible. We also try to map the endpoint url to the -standard S3 region (s3.amazonaws.com). This normally happens -even if a user provides an --endpoint-url (if the bucket is -DNS compatible). - -This customization ensures that if a user specifies -an --endpoint-url, then we turn off the botocore customization -that messes with endpoint url. - -""" -from functools import partial - -from botocore.utils import fix_s3_host - - -def register_s3_endpoint(cli): - handler = partial(on_top_level_args_parsed, event_handler=cli) - cli.register('top-level-args-parsed', handler) - - -def on_top_level_args_parsed(parsed_args, event_handler, **kwargs): - # The fix_s3_host has logic to set the endpoint to the - # standard region endpoint for s3 (s3.amazonaws.com) under - # certain conditions. We're making sure that if - # the user provides an --endpoint-url, that entire handler - # is disabled. - if parsed_args.command in ['s3', 's3api'] and \ - parsed_args.endpoint_url is not None: - event_handler.unregister('before-sign.s3', fix_s3_host) diff -Nru awscli-1.11.13/awscli/customizations/s3events.py awscli-1.18.69/awscli/customizations/s3events.py --- awscli-1.11.13/awscli/customizations/s3events.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/s3events.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,91 @@ +# Copyright 2018 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. +"""Add S3 specific event streaming output arg.""" +from awscli.arguments import CustomArgument + + +STREAM_HELP_TEXT = 'Filename where the records will be saved' + + +class DocSectionNotFoundError(Exception): + pass + + +def register_event_stream_arg(event_handlers): + event_handlers.register( + 'building-argument-table.s3api.select-object-content', + add_event_stream_output_arg) + event_handlers.register_last( + 'doc-output.s3api.select-object-content', + replace_event_stream_docs + ) + + +def add_event_stream_output_arg(argument_table, operation_model, + session, **kwargs): + argument_table['outfile'] = S3SelectStreamOutputArgument( + name='outfile', help_text=STREAM_HELP_TEXT, + cli_type_name='string', positional_arg=True, + stream_key=operation_model.output_shape.serialization['payload'], + session=session) + + +def replace_event_stream_docs(help_command, **kwargs): + doc = help_command.doc + current = '' + while current != '======\nOutput\n======': + try: + current = doc.pop_write() + except IndexError: + # This should never happen, but in the rare case that it does + # we should be raising something with a helpful error message. + raise DocSectionNotFoundError( + 'Could not find the "output" section for the command: %s' + % help_command) + doc.write('======\nOutput\n======\n') + doc.write("This command generates no output. The selected " + "object content is written to the specified outfile.\n") + + +class S3SelectStreamOutputArgument(CustomArgument): + _DOCUMENT_AS_REQUIRED = True + + def __init__(self, stream_key, session, **kwargs): + super(S3SelectStreamOutputArgument, self).__init__(**kwargs) + # This is the key in the response body where we can find the + # streamed contents. + self._stream_key = stream_key + self._output_file = None + self._session = session + + def add_to_params(self, parameters, value): + self._output_file = value + self._session.register('after-call.s3.SelectObjectContent', + self.save_file) + + def save_file(self, parsed, **kwargs): + # This method is hooked into after-call which fires + # before the error checking happens in the client. + # Therefore if the stream_key is not in the parsed + # response we immediately return and let the default + # error handling happen. + if self._stream_key not in parsed: + return + event_stream = parsed[self._stream_key] + with open(self._output_file, 'wb') as fp: + for event in event_stream: + if 'Records' in event: + fp.write(event['Records']['Payload']) + # We don't want to include the streaming param in + # the returned response, it's not JSON serializable. + del parsed[self._stream_key] diff -Nru awscli-1.11.13/awscli/customizations/s3uploader.py awscli-1.18.69/awscli/customizations/s3uploader.py --- awscli-1.11.13/awscli/customizations/s3uploader.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/s3uploader.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,227 @@ +# Copyright 2012-2015 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 hashlib +import logging +import threading +import os +import sys + +import botocore +import botocore.exceptions +from s3transfer.manager import TransferManager +from s3transfer.subscribers import BaseSubscriber + +from awscli.compat import collections_abc + +LOG = logging.getLogger(__name__) + + +class NoSuchBucketError(Exception): + def __init__(self, **kwargs): + msg = self.fmt.format(**kwargs) + Exception.__init__(self, msg) + self.kwargs = kwargs + + + fmt = ("S3 Bucket does not exist. " + "Execute the command to create a new bucket" + "\n" + "aws s3 mb s3://{bucket_name}") + + +class S3Uploader(object): + """ + Class to upload objects to S3 bucket that use versioning. If bucket + does not already use versioning, this class will turn on versioning. + """ + + @property + def artifact_metadata(self): + """ + Metadata to attach to the object(s) uploaded by the uploader. + """ + return self._artifact_metadata + + @artifact_metadata.setter + def artifact_metadata(self, val): + if val is not None and not isinstance(val, collections_abc.Mapping): + raise TypeError("Artifact metadata should be in dict type") + self._artifact_metadata = val + + def __init__(self, s3_client, + bucket_name, + prefix=None, + kms_key_id=None, + force_upload=False, + transfer_manager=None): + self.bucket_name = bucket_name + self.prefix = prefix + self.kms_key_id = kms_key_id or None + self.force_upload = force_upload + self.s3 = s3_client + + self.transfer_manager = transfer_manager + if not transfer_manager: + self.transfer_manager = TransferManager(self.s3) + + self._artifact_metadata = None + + def upload(self, file_name, remote_path): + """ + Uploads given file to S3 + :param file_name: Path to the file that will be uploaded + :param remote_path: be uploaded + :return: VersionId of the latest upload + """ + + if self.prefix and len(self.prefix) > 0: + remote_path = "{0}/{1}".format(self.prefix, remote_path) + + # 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 already exists at {0}. " + "Skipping upload".format(remote_path)) + return self.make_url(remote_path) + + try: + + # Default to regular server-side encryption unless customer has + # specified their own KMS keys + additional_args = { + "ServerSideEncryption": "AES256" + } + + if self.kms_key_id: + additional_args["ServerSideEncryption"] = "aws:kms" + additional_args["SSEKMSKeyId"] = self.kms_key_id + + if self.artifact_metadata: + additional_args["Metadata"] = self.artifact_metadata + + print_progress_callback = \ + ProgressPercentage(file_name, remote_path) + future = self.transfer_manager.upload(file_name, + self.bucket_name, + remote_path, + additional_args, + [print_progress_callback]) + future.result() + + return self.make_url(remote_path) + + except botocore.exceptions.ClientError as ex: + error_code = ex.response["Error"]["Code"] + if error_code == "NoSuchBucket": + raise NoSuchBucketError(bucket_name=self.bucket_name) + raise ex + + def upload_with_dedup(self, file_name, extension=None): + """ + Makes and returns name of the S3 object based on the file's MD5 sum + + :param file_name: file to upload + :param extension: String of file extension to append to the object + :return: S3 URL of the uploaded object + """ + + # This construction of remote_path is critical to preventing duplicate + # uploads of same object. Uploader will check if the file exists in S3 + # and re-upload only if necessary. So the template points to same file + # in multiple places, this will upload only once + + filemd5 = self.file_checksum(file_name) + remote_path = filemd5 + if extension: + remote_path = remote_path + "." + extension + + return self.upload(file_name, remote_path) + + def file_exists(self, remote_path): + """ + Check if the file we are trying to upload already exists in S3 + + :param remote_path: + :return: True, if file exists. False, otherwise + """ + + try: + # Find the object that matches this ETag + self.s3.head_object( + Bucket=self.bucket_name, Key=remote_path) + return True + except botocore.exceptions.ClientError: + # Either File does not exist or we are unable to get + # this information. + return False + + def make_url(self, obj_path): + return "s3://{0}/{1}".format( + self.bucket_name, obj_path) + + def file_checksum(self, file_name): + + with open(file_name, "rb") as file_handle: + md5 = hashlib.md5() + # Read file in chunks of 4096 bytes + block_size = 4096 + + # Save current cursor position and reset cursor to start of file + curpos = file_handle.tell() + file_handle.seek(0) + + buf = file_handle.read(block_size) + while len(buf) > 0: + md5.update(buf) + buf = file_handle.read(block_size) + + # Restore file cursor's position + file_handle.seek(curpos) + + return md5.hexdigest() + + def to_path_style_s3_url(self, key, version=None): + """ + This link describes the format of Path Style URLs + http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro + """ + base = self.s3.meta.endpoint_url + result = "{0}/{1}/{2}".format(base, self.bucket_name, key) + if version: + result = "{0}?versionId={1}".format(result, version) + + return result + + +class ProgressPercentage(BaseSubscriber): + # This class was copied directly from S3Transfer docs + + def __init__(self, filename, remote_path): + self._filename = filename + self._remote_path = remote_path + self._size = float(os.path.getsize(filename)) + self._seen_so_far = 0 + self._lock = threading.Lock() + + def on_progress(self, future, bytes_transferred, **kwargs): + + # To simplify we'll assume this is hooked up + # to a single filename. + with self._lock: + self._seen_so_far += bytes_transferred + percentage = (self._seen_so_far / self._size) * 100 + sys.stdout.write( + "\rUploading to %s %s / %s (%.2f%%)" % + (self._remote_path, self._seen_so_far, + self._size, percentage)) + sys.stdout.flush() diff -Nru awscli-1.11.13/awscli/customizations/sagemaker.py awscli-1.18.69/awscli/customizations/sagemaker.py --- awscli-1.11.13/awscli/customizations/sagemaker.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/sagemaker.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,28 @@ +# Copyright 2017 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. +from awscli.customizations.utils import make_hidden_command_alias + + +def register_alias_sagemaker_runtime_command(event_emitter): + event_emitter.register( + 'building-command-table.main', + alias_sagemaker_runtime_command + ) + + +def alias_sagemaker_runtime_command(command_table, **kwargs): + make_hidden_command_alias( + command_table, + existing_name='sagemaker-runtime', + alias_name='runtime.sagemaker', + ) diff -Nru awscli-1.11.13/awscli/customizations/scalarparse.py awscli-1.18.69/awscli/customizations/scalarparse.py --- awscli-1.11.13/awscli/customizations/scalarparse.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/scalarparse.py 2020-05-28 19:25:48.000000000 +0000 @@ -27,6 +27,10 @@ in the future. """ +from botocore.utils import parse_timestamp +from botocore.exceptions import ProfileNotFound + + def register_scalar_parser(event_handlers): event_handlers.register_first( 'session-initialized', add_scalar_parsers) @@ -36,13 +40,40 @@ return x +def iso_format(value): + return parse_timestamp(value).isoformat() + + +def add_timestamp_parser(session): + factory = session.get_component('response_parser_factory') + try: + timestamp_format = session.get_scoped_config().get( + 'cli_timestamp_format', + 'none') + except ProfileNotFound: + # If a --profile is provided that does not exist, loading + # a value from get_scoped_config will crash the CLI. + # This function can be called as the first handler for + # the session-initialized event, which happens before a + # profile can be created, even if the command would have + # successfully created a profile. Instead of crashing here + # on a ProfileNotFound the CLI should just use 'none'. + timestamp_format = 'none' + if timestamp_format == 'none': + # For backwards compatibility reasons, we replace botocore's timestamp + # parser (which parses to a datetime.datetime object) with the + # identity function which prints the date exactly the same as it comes + # across the wire. + timestamp_parser = identity + elif timestamp_format == 'iso8601': + timestamp_parser = iso_format + else: + raise ValueError('Unknown cli_timestamp_format value: %s, valid values' + ' are "none" or "iso8601"' % timestamp_format) + factory.set_parser_defaults(timestamp_parser=timestamp_parser) + + def add_scalar_parsers(session, **kwargs): factory = session.get_component('response_parser_factory') - # For backwards compatibility reasons, we replace botocore's timestamp - # parser (which parsers to a datetime.datetime object) with the identity - # function which prints the date exactly the same as it comes across the - # wire. We will eventually add a config option that allows for a user to - # have normalized datetime representation, but we can't change the default. - factory.set_parser_defaults( - blob_parser=identity, - timestamp_parser=identity) + factory.set_parser_defaults(blob_parser=identity) + add_timestamp_parser(session) diff -Nru awscli-1.11.13/awscli/customizations/servicecatalog/exceptions.py awscli-1.18.69/awscli/customizations/servicecatalog/exceptions.py --- awscli-1.11.13/awscli/customizations/servicecatalog/exceptions.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/servicecatalog/exceptions.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,25 @@ +# Copyright 2012-2017 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. + + +class ServiceCatalogCommandError(Exception): + fmt = 'An unspecified error occurred' + + def __init__(self, **kwargs): + msg = self.fmt.format(**kwargs) + Exception.__init__(self, msg) + self.kwargs = kwargs + + +class InvalidParametersException(ServiceCatalogCommandError): + fmt = "An error occurred (InvalidParametersException) : {message}" diff -Nru awscli-1.11.13/awscli/customizations/servicecatalog/generatebase.py awscli-1.18.69/awscli/customizations/servicecatalog/generatebase.py --- awscli-1.11.13/awscli/customizations/servicecatalog/generatebase.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/servicecatalog/generatebase.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,53 @@ +# Copyright 2012-2017 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. + +from awscli.customizations.commands import BasicCommand +from awscli.customizations.servicecatalog.utils \ + import make_url, get_s3_path +from awscli.customizations.s3uploader import S3Uploader +from awscli.customizations.servicecatalog import exceptions + + +class GenerateBaseCommand(BasicCommand): + + def _run_main(self, parsed_args, parsed_globals): + self.region = self.get_and_validate_region(parsed_globals) + self.s3_client = self._session.create_client( + 's3', + region_name=self.region, + endpoint_url=parsed_globals.endpoint_url, + verify=parsed_globals.verify_ssl + ) + self.s3_uploader = S3Uploader(self.s3_client, + parsed_args.bucket_name, + force_upload=True) + try: + self.s3_uploader.upload(parsed_args.file_path, + get_s3_path(parsed_args.file_path)) + except OSError as ex: + raise RuntimeError("%s cannot be found" % parsed_args.file_path) + + def get_and_validate_region(self, parsed_globals): + region = parsed_globals.region + if region is None: + region = self._session.get_config_variable('region') + if region not in self._session.get_available_regions('servicecatalog'): + raise exceptions.InvalidParametersException( + message="Region {0} is not supported".format( + parsed_globals.region)) + return region + + def create_s3_url(self, bucket_name, file_path): + return make_url(self.region, + bucket_name, + get_s3_path(file_path)) diff -Nru awscli-1.11.13/awscli/customizations/servicecatalog/generateproduct.py awscli-1.18.69/awscli/customizations/servicecatalog/generateproduct.py --- awscli-1.11.13/awscli/customizations/servicecatalog/generateproduct.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/servicecatalog/generateproduct.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,165 @@ +# Copyright 2012-2017 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 sys + +from awscli.customizations.servicecatalog import helptext +from awscli.customizations.servicecatalog.generatebase \ + import GenerateBaseCommand +from botocore.compat import json + + +class GenerateProductCommand(GenerateBaseCommand): + NAME = "product" + DESCRIPTION = helptext.PRODUCT_COMMAND_DESCRIPTION + ARG_TABLE = [ + { + 'name': 'product-name', + 'required': True, + 'help_text': helptext.PRODUCT_NAME + }, + { + 'name': 'product-owner', + 'required': True, + 'help_text': helptext.OWNER + }, + { + 'name': 'product-type', + 'required': True, + 'help_text': helptext.PRODUCT_TYPE, + 'choices': ['CLOUD_FORMATION_TEMPLATE', 'MARKETPLACE'] + }, + { + 'name': 'product-description', + 'required': False, + 'help_text': helptext.PRODUCT_DESCRIPTION + }, + { + 'name': 'product-distributor', + 'required': False, + 'help_text': helptext.DISTRIBUTOR + }, + { + 'name': 'tags', + 'required': False, + 'schema': { + 'type': 'array', + 'items': { + 'type': 'string' + } + }, + 'default': [], + 'synopsis': '--tags Key=key1,Value=value1 Key=key2,Value=value2', + 'help_text': helptext.TAGS + }, + { + 'name': 'file-path', + 'required': True, + 'help_text': helptext.FILE_PATH + }, + { + 'name': 'bucket-name', + 'required': True, + 'help_text': helptext.BUCKET_NAME + }, + { + 'name': 'support-description', + 'required': False, + 'help_text': helptext.SUPPORT_DESCRIPTION + }, + { + 'name': 'support-email', + 'required': False, + 'help_text': helptext.SUPPORT_EMAIL + }, + { + 'name': 'provisioning-artifact-name', + 'required': True, + 'help_text': helptext.PA_NAME + }, + { + 'name': 'provisioning-artifact-description', + 'required': True, + 'help_text': helptext.PA_DESCRIPTION + }, + { + 'name': 'provisioning-artifact-type', + 'required': True, + 'help_text': helptext.PA_TYPE, + 'choices': [ + 'CLOUD_FORMATION_TEMPLATE', + 'MARKETPLACE_AMI', + 'MARKETPLACE_CAR' + ] + } + ] + + def _run_main(self, parsed_args, parsed_globals): + super(GenerateProductCommand, self)._run_main(parsed_args, + parsed_globals) + self.region = self.get_and_validate_region(parsed_globals) + + self.s3_url = self.create_s3_url(parsed_args.bucket_name, + parsed_args.file_path) + self.scs_client = self._session.create_client( + 'servicecatalog', region_name=self.region, + endpoint_url=parsed_globals.endpoint_url, + verify=parsed_globals.verify_ssl + ) + + response = self.create_product(self.build_args(parsed_args, + self.s3_url), + parsed_globals) + sys.stdout.write(json.dumps(response, indent=2, ensure_ascii=False)) + + return 0 + + def create_product(self, args, parsed_globals): + response = self.scs_client.create_product(**args) + if 'ResponseMetadata' in response: + del response['ResponseMetadata'] + return response + + def _extract_tags(self, args_tags): + tags = [] + for tag in args_tags: + tags.append(dict(t.split('=') for t in tag.split(','))) + return tags + + def build_args(self, parsed_args, s3_url): + args = { + "Name": parsed_args.product_name, + "Owner": parsed_args.product_owner, + "ProductType": parsed_args.product_type, + "Tags": self._extract_tags(parsed_args.tags), + "ProvisioningArtifactParameters": { + 'Name': parsed_args.provisioning_artifact_name, + 'Description': parsed_args.provisioning_artifact_description, + 'Info': { + 'LoadTemplateFromURL': s3_url + }, + 'Type': parsed_args.provisioning_artifact_type + } + } + + # Non-required args + if parsed_args.support_description: + args["SupportDescription"] = parsed_args.support_description + if parsed_args.product_description: + args["Description"] = parsed_args.product_description + if parsed_args.support_email: + args["SupportEmail"] = parsed_args.support_email + if parsed_args.product_distributor: + args["Distributor"] = parsed_args.product_distributor + + return args diff -Nru awscli-1.11.13/awscli/customizations/servicecatalog/generateprovisioningartifact.py awscli-1.18.69/awscli/customizations/servicecatalog/generateprovisioningartifact.py --- awscli-1.11.13/awscli/customizations/servicecatalog/generateprovisioningartifact.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/servicecatalog/generateprovisioningartifact.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,98 @@ +# Copyright 2012-2017 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 sys + +from awscli.customizations.servicecatalog import helptext +from awscli.customizations.servicecatalog.generatebase \ + import GenerateBaseCommand +from botocore.compat import json + + +class GenerateProvisioningArtifactCommand(GenerateBaseCommand): + NAME = 'provisioning-artifact' + DESCRIPTION = helptext.PA_COMMAND_DESCRIPTION + ARG_TABLE = [ + { + 'name': 'file-path', + 'required': True, + 'help_text': helptext.FILE_PATH + }, + { + 'name': 'bucket-name', + 'required': True, + 'help_text': helptext.BUCKET_NAME + }, + { + 'name': 'provisioning-artifact-name', + 'required': True, + 'help_text': helptext.PA_NAME + }, + { + 'name': 'provisioning-artifact-description', + 'required': True, + 'help_text': helptext.PA_DESCRIPTION + }, + { + 'name': 'provisioning-artifact-type', + 'required': True, + 'help_text': helptext.PA_TYPE, + 'choices': [ + 'CLOUD_FORMATION_TEMPLATE', + 'MARKETPLACE_AMI', + 'MARKETPLACE_CAR' + ] + }, + { + 'name': 'product-id', + 'required': True, + 'help_text': helptext.PRODUCT_ID + } + ] + + def _run_main(self, parsed_args, parsed_globals): + super(GenerateProvisioningArtifactCommand, self)._run_main( + parsed_args, parsed_globals) + self.region = self.get_and_validate_region(parsed_globals) + + self.s3_url = self.create_s3_url(parsed_args.bucket_name, + parsed_args.file_path) + self.scs_client = self._session.create_client( + 'servicecatalog', region_name=self.region, + endpoint_url=parsed_globals.endpoint_url, + verify=parsed_globals.verify_ssl + ) + + response = self.create_provisioning_artifact(parsed_args, + self.s3_url) + + sys.stdout.write(json.dumps(response, indent=2, ensure_ascii=False)) + + return 0 + + def create_provisioning_artifact(self, parsed_args, s3_url): + response = self.scs_client.create_provisioning_artifact( + ProductId=parsed_args.product_id, + Parameters={ + 'Name': parsed_args.provisioning_artifact_name, + 'Description': parsed_args.provisioning_artifact_description, + 'Info': { + 'LoadTemplateFromURL': s3_url + }, + 'Type': parsed_args.provisioning_artifact_type + } + ) + + if 'ResponseMetadata' in response: + del response['ResponseMetadata'] + return response diff -Nru awscli-1.11.13/awscli/customizations/servicecatalog/generate.py awscli-1.18.69/awscli/customizations/servicecatalog/generate.py --- awscli-1.11.13/awscli/customizations/servicecatalog/generate.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/servicecatalog/generate.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,35 @@ +# Copyright 2012-2017 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. + +from awscli.customizations.commands import BasicCommand +from awscli.customizations.servicecatalog import helptext +from awscli.customizations.servicecatalog.generateproduct \ + import GenerateProductCommand +from awscli.customizations.servicecatalog.generateprovisioningartifact \ + import GenerateProvisioningArtifactCommand + + +class GenerateCommand(BasicCommand): + NAME = "generate" + DESCRIPTION = helptext.GENERATE_COMMAND + SUBCOMMANDS = [ + {'name': 'product', + 'command_class': GenerateProductCommand}, + {'name': 'provisioning-artifact', + 'command_class': GenerateProvisioningArtifactCommand} + ] + + def _run_main(self, parsed_args, parsed_globals): + if parsed_args.subcommand is None: + raise ValueError("usage: aws [options] " + "[parameters]\naws: error: too few arguments") diff -Nru awscli-1.11.13/awscli/customizations/servicecatalog/helptext.py awscli-1.18.69/awscli/customizations/servicecatalog/helptext.py --- awscli-1.11.13/awscli/customizations/servicecatalog/helptext.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/servicecatalog/helptext.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,53 @@ +# Copyright 2012-2017 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. + + +TAGS = "Tags to associate with the new product." + +BUCKET_NAME = ("Name of the S3 bucket name where the CloudFormation " + "template will be uploaded to") + +SUPPORT_DESCRIPTION = "Support information about the product" + +SUPPORT_EMAIL = "Contact email for product support" + +PA_NAME = "The name assigned to the provisioning artifact" + +PA_DESCRIPTION = "The text description of the provisioning artifact" + +PA_TYPE = "The type of the provisioning artifact" + +DISTRIBUTOR = "The distributor of the product" + +PRODUCT_ID = "The product identifier" + +PRODUCT_NAME = "The name of the product" + +OWNER = "The owner of the product" + +PRODUCT_TYPE = "The type of the product to create" + +PRODUCT_DESCRIPTION = "The text description of the product" + +PRODUCT_COMMAND_DESCRIPTION = ("Create a new product using a CloudFormation " + "template specified as a local file path") + +PA_COMMAND_DESCRIPTION = ("Create a new provisioning artifact for the " + "specified product using a CloudFormation template " + "specified as a local file path") + +GENERATE_COMMAND = ("Generate a Service Catalog product or provisioning " + "artifact using a CloudFormation template specified " + "as a local file path") + +FILE_PATH = "A local file path that references the CloudFormation template" diff -Nru awscli-1.11.13/awscli/customizations/servicecatalog/__init__.py awscli-1.18.69/awscli/customizations/servicecatalog/__init__.py --- awscli-1.11.13/awscli/customizations/servicecatalog/__init__.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/servicecatalog/__init__.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,24 @@ +# Copyright 2012-2017 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. + +from awscli.customizations.servicecatalog.generate \ + import GenerateCommand + + +def register_servicecatalog_commands(event_emitter): + event_emitter.register('building-command-table.servicecatalog', + inject_commands) + + +def inject_commands(command_table, session, **kwargs): + command_table['generate'] = GenerateCommand(session) diff -Nru awscli-1.11.13/awscli/customizations/servicecatalog/utils.py awscli-1.18.69/awscli/customizations/servicecatalog/utils.py --- awscli-1.11.13/awscli/customizations/servicecatalog/utils.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/servicecatalog/utils.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,34 @@ +# Copyright 2012-2017 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 os + + +def make_url(region, bucket_name, obj_path, version=None): + """ + This link describes the format of Path Style URLs + http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro + """ + base = "https://s3.amazonaws.com" + if region and region != "us-east-1": + base = "https://s3-{0}.amazonaws.com".format(region) + + result = "{0}/{1}/{2}".format(base, bucket_name, obj_path) + if version: + result = "{0}?versionId={1}".format(result, version) + + return result + + +def get_s3_path(file_path): + return os.path.basename(file_path) diff -Nru awscli-1.11.13/awscli/customizations/sessionmanager.py awscli-1.18.69/awscli/customizations/sessionmanager.py --- awscli-1.11.13/awscli/customizations/sessionmanager.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/sessionmanager.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,102 @@ +# Copyright 2018 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 logging +import json +import errno + +from subprocess import check_call +from awscli.compat import ignore_user_entered_signals +from awscli.clidriver import ServiceOperation, CLIOperationCaller + +logger = logging.getLogger(__name__) + +ERROR_MESSAGE = ( + 'SessionManagerPlugin is not found. ', + 'Please refer to SessionManager Documentation here: ', + 'http://docs.aws.amazon.com/console/systems-manager/', + 'session-manager-plugin-not-found' +) + + +def register_ssm_session(event_handlers): + event_handlers.register('building-command-table.ssm', + add_custom_start_session) + + +def add_custom_start_session(session, command_table, **kwargs): + command_table['start-session'] = StartSessionCommand( + name='start-session', + parent_name='ssm', + session=session, + operation_model=session.get_service_model( + 'ssm').operation_model('StartSession'), + operation_caller=StartSessionCaller(session), + ) + + +class StartSessionCommand(ServiceOperation): + + def create_help_command(self): + help_command = super( + StartSessionCommand, self).create_help_command() + # Change the output shape because the command provides no output. + self._operation_model.output_shape = None + return help_command + + +class StartSessionCaller(CLIOperationCaller): + def invoke(self, service_name, operation_name, parameters, + parsed_globals): + client = self._session.create_client( + service_name, region_name=parsed_globals.region, + endpoint_url=parsed_globals.endpoint_url, + verify=parsed_globals.verify_ssl) + response = client.start_session(**parameters) + session_id = response['SessionId'] + region_name = client.meta.region_name + # profile_name is used to passed on to session manager plugin + # to fetch same profile credentials to make an api call in the plugin. + # If no profile is passed then pass on empty string + profile_name = self._session.profile \ + if self._session.profile is not None else '' + endpoint_url = client.meta.endpoint_url + + try: + # ignore_user_entered_signals ignores these signals + # because if signals which kills the process are not + # captured would kill the foreground process but not the + # background one. Capturing these would prevents process + # from getting killed and these signals are input to plugin + # and handling in there + with ignore_user_entered_signals(): + # call executable with necessary input + check_call(["session-manager-plugin", + json.dumps(response), + region_name, + "StartSession", + profile_name, + json.dumps(parameters), + endpoint_url]) + return 0 + except OSError as ex: + if ex.errno == errno.ENOENT: + logger.debug('SessionManagerPlugin is not present', + exc_info=True) + # start-session api call returns response and starts the + # session on ssm-agent and response is forwarded to + # session-manager-plugin. If plugin is not present, terminate + # is called so that service and ssm-agent terminates the + # session to avoid zombie session active on ssm-agent for + # default self terminate time + client.terminate_session(SessionId=session_id) + raise ValueError(''.join(ERROR_MESSAGE)) diff -Nru awscli-1.11.13/awscli/customizations/sms_voice.py awscli-1.18.69/awscli/customizations/sms_voice.py --- awscli-1.11.13/awscli/customizations/sms_voice.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/sms_voice.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +# Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"). You +# may not use this file except in compliance with the License. A copy of +# the License is located at +# +# http://aws.amazon.com/apache2.0/ +# +# or in the "license" file accompanying this file. This file is +# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF +# ANY KIND, either express or implied. See the License for the specific +# language governing permissions and limitations under the License. + + +def register_sms_voice_hide(event_emitter): + event_emitter.register('building-command-table.main', + hide_sms_voice) + + +def hide_sms_voice(command_table, session, **kwargs): + command_table['sms-voice']._UNDOCUMENTED = True diff -Nru awscli-1.11.13/awscli/customizations/streamingoutputarg.py awscli-1.18.69/awscli/customizations/streamingoutputarg.py --- awscli-1.11.13/awscli/customizations/streamingoutputarg.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/streamingoutputarg.py 2020-05-28 19:25:48.000000000 +0000 @@ -86,10 +86,10 @@ def add_to_params(self, parameters, value): self._output_file = value - service_name = self._operation_model.service_model.endpoint_prefix + service_id = self._operation_model.service_model.service_id.hyphenize() operation_name = self._operation_model.name self._session.register('after-call.%s.%s' % ( - service_name, operation_name), self.save_file) + service_id, operation_name), self.save_file) def save_file(self, parsed, **kwargs): if self._response_key not in parsed: diff -Nru awscli-1.11.13/awscli/customizations/translate.py awscli-1.18.69/awscli/customizations/translate.py --- awscli-1.11.13/awscli/customizations/translate.py 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/translate.py 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,67 @@ +# Copyright 2018 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 copy + +from awscli.arguments import CustomArgument, CLIArgument + +FILE_DOCSTRING = ('

    The path to the file of the code you are uploading. ' + 'Example: fileb://data.csv

    ') + + +def register_translate_import_terminology(cli): + cli.register('building-argument-table.translate.import-terminology', + _hoist_file_parameter) + + +def _hoist_file_parameter(session, argument_table, **kwargs): + argument_table['data-file'] = FileArgument( + 'data-file', help_text=FILE_DOCSTRING, cli_type_name='blob', + required=True) + file_argument = argument_table['terminology-data'] + file_model = copy.deepcopy(file_argument.argument_model) + del file_model.members['File'] + argument_table['terminology-data'] = TerminologyDataArgument( + name='terminology-data', + argument_model=file_model, + operation_model=file_argument._operation_model, + is_required=False, + event_emitter=session.get_component('event_emitter'), + serialized_name='TerminologyData' + ) + + +class FileArgument(CustomArgument): + def add_to_params(self, parameters, value): + if value is None: + return + file_param = {'File': value} + if parameters.get('TerminologyData'): + parameters['TerminologyData'].update(file_param) + else: + parameters['TerminologyData'] = file_param + + +class TerminologyDataArgument(CLIArgument): + def add_to_params(self, parameters, value): + if value is None: + return + unpacked = self._unpack_argument(value) + if 'File' in unpacked: + raise ValueError("File cannot be provided as part of the " + "'--terminology-data' argument. Please use the " + "'--data-file' option instead to specify a " + "file.") + if parameters.get('TerminologyData'): + parameters['TerminologyData'].update(unpacked) + else: + parameters['TerminologyData'] = unpacked diff -Nru awscli-1.11.13/awscli/customizations/utils.py awscli-1.18.69/awscli/customizations/utils.py --- awscli-1.11.13/awscli/customizations/utils.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/utils.py 2020-05-28 19:25:48.000000000 +0000 @@ -15,6 +15,7 @@ """ import copy +import sys from botocore.exceptions import ClientError @@ -26,6 +27,14 @@ del argument_table[existing_name] +def _copy_argument(argument_table, current_name, copy_name): + current = argument_table[current_name] + copy_arg = copy.copy(current) + copy_arg.name = copy_name + argument_table[copy_name] = copy_arg + return copy_arg + + def make_hidden_alias(argument_table, existing_name, alias_name): """Create a hidden alias for an existing argument. @@ -39,9 +48,8 @@ """ current = argument_table[existing_name] - copy_arg = copy.copy(current) + copy_arg = _copy_argument(argument_table, existing_name, alias_name) copy_arg._UNDOCUMENTED = True - copy_arg.name = alias_name if current.required: # If the current argument is required, then # we'll mark both as not required, but @@ -50,7 +58,6 @@ copy_arg.required = False current.required = False current._DOCUMENT_AS_REQUIRED = True - argument_table[alias_name] = copy_arg def rename_command(command_table, existing_name, new_name): @@ -60,6 +67,46 @@ del command_table[existing_name] +def alias_command(command_table, existing_name, new_name): + """Moves an argument to a new name, keeping the old as a hidden alias. + + :type command_table: dict + :param command_table: The full command table for the CLI or a service. + + :type existing_name: str + :param existing_name: The current name of the command. + + :type new_name: str + :param new_name: The new name for the command. + """ + current = command_table[existing_name] + _copy_argument(command_table, existing_name, new_name) + current._UNDOCUMENTED = True + + +def make_hidden_command_alias(command_table, existing_name, alias_name): + """Create a hidden alias for an exiting command. + + This will copy an existing command object in a command table and add a new + entry to the command table with a different name. The new command will + be undocumented. + + This is needed if you want to change an existing command, but you still + need the old name to work for backwards compatibility reasons. + + :type command_table: dict + :param command_table: The full command table for the CLI or a service. + + :type existing_name: str + :param existing_name: The current name of the command. + + :type alias_name: str + :param alias_name: The new name for the command. + """ + new = _copy_argument(command_table, existing_name, alias_name) + new._UNDOCUMENTED = True + + def validate_mutually_exclusive_handler(*groups): def _handler(parsed_args, **kwargs): return validate_mutually_exclusive(parsed_args, *groups) @@ -126,3 +173,57 @@ if overrides: client_args.update(overrides) return session.create_client(service_name, **client_args) + + +def uni_print(statement, out_file=None): + """ + This function is used to properly write unicode to a file, usually + stdout or stdderr. It ensures that the proper encoding is used if the + statement is not a string type. + """ + if out_file is None: + out_file = sys.stdout + try: + # Otherwise we assume that out_file is a + # text writer type that accepts str/unicode instead + # of bytes. + out_file.write(statement) + except UnicodeEncodeError: + # Some file like objects like cStringIO will + # try to decode as ascii on python2. + # + # This can also fail if our encoding associated + # with the text writer cannot encode the unicode + # ``statement`` we've been given. This commonly + # happens on windows where we have some S3 key + # previously encoded with utf-8 that can't be + # encoded using whatever codepage the user has + # configured in their console. + # + # At this point we've already failed to do what's + # been requested. We now try to make a best effort + # attempt at printing the statement to the outfile. + # We're using 'ascii' as the default because if the + # stream doesn't give us any encoding information + # we want to pick an encoding that has the highest + # chance of printing successfully. + new_encoding = getattr(out_file, 'encoding', 'ascii') + # When the output of the aws command is being piped, + # ``sys.stdout.encoding`` is ``None``. + if new_encoding is None: + new_encoding = 'ascii' + new_statement = statement.encode( + new_encoding, 'replace').decode(new_encoding) + out_file.write(new_statement) + out_file.flush() + + +def get_policy_arn_suffix(region): + """Method to return region value as expected by policy arn""" + region_string = region.lower() + if region_string.startswith("cn-"): + return "aws-cn" + elif region_string.startswith("us-gov"): + return "aws-us-gov" + else: + return "aws" diff -Nru awscli-1.11.13/awscli/customizations/waiters.py awscli-1.18.69/awscli/customizations/waiters.py --- awscli-1.11.13/awscli/customizations/waiters.py 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/customizations/waiters.py 2020-05-28 19:25:48.000000000 +0000 @@ -51,7 +51,9 @@ class WaitCommand(BasicCommand): NAME = 'wait' - DESCRIPTION = 'Wait until a particular condition is satisfied.' + DESCRIPTION = ('Wait until a particular condition is satisfied. Each ' + 'subcommand polls an API until the listed requirement ' + 'is met.') def __init__(self, session, waiter_model, service_model): self._model = waiter_model diff -Nru awscli-1.11.13/awscli/examples/acm/list-certificates.rst awscli-1.18.69/awscli/examples/acm/list-certificates.rst --- awscli-1.11.13/awscli/examples/acm/list-certificates.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/acm/list-certificates.rst 2020-05-28 19:25:48.000000000 +0000 @@ -4,7 +4,7 @@ aws acm list-certificates -The preceding command produces the following output:: +The preceding command produces output similar to the following:: { "CertificateSummaryList": [ @@ -19,30 +19,40 @@ ] } -You can also filter your output by using the "certificate-statuses" argument. The following command displays certificates that have a PENDING_VALIDATION status:: - - aws acm list-certificates --certificate-statuses PENDING_VALIDATION - -Finally, you can decide how many certificates you want to display each time you call ``list-certificates``. For example, to display no more than two certificates at a time, set the ``max-items`` argument to 2 as in the following example:: +You can decide how many certificates you want to display each time you call ``list-certificates``. For example, if you have four certificates and you want to display no more than two at a time, set the ``max-items`` argument to 2 as in the following example:: aws acm list-certificates --max-items 2 Two certificate ARNs and a ``NextToken`` value will be displayed:: - { - "CertificateSummaryList": [ - { - "CertificateArn": "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012", - "DomainName": "www.example.com" - }, - { - "CertificateArn": "arn:aws:acm:us-east-1:493619779192:certificate/87654321-4321-4321-4321-210987654321", - "DomainName": "www.example.net" - } - ], + "CertificateSummaryList": [ + { + "CertificateArn": "arn:aws:acm:us-east-1:123456789012: \ + certificate/12345678-1234-1234-1234-123456789012", + "DomainName": "www.example.com" + }, + { + "CertificateArn": "arn:aws:acm:us-east-1:123456789012: \ + certificate/87654321-4321-4321-4321-210987654321", + "DomainName": "www.example.net" + } + ], "NextToken": "9f4d9f69-275a-41fe-b58e-2b837bd9ba48" - } - + To display the next two certificates in your account, set this ``NextToken`` value in your next call:: aws acm list-certificates --max-items 2 --next-token 9f4d9f69-275a-41fe-b58e-2b837bd9ba48 + + +You can filter your output by using the ``certificate-statuses`` argument. The following command displays certificates that have a PENDING_VALIDATION status:: + + aws acm list-certificates --certificate-statuses PENDING_VALIDATION + +You can also filter your output by using the ``includes`` argument. The following command displays certificates filtered on the following properties. The certificates to be displayed:: + + - Specify that the RSA algorithm and a 2048 bit key are used to generate key pairs. + - Contain a Key Usage extension that specifies that the certificates can be used to create digital signatures. + - Contain an Extended Key Usage extension that specifies that the certificates can be used for code signing. + + aws acm list-certificates --max-items 10 --includes extendedKeyUsage=CODE_SIGNING,keyUsage=DIGITAL_SIGNATURE,keyTypes=RSA_2048 + diff -Nru awscli-1.11.13/awscli/examples/acm/request-certificate.rst awscli-1.18.69/awscli/examples/acm/request-certificate.rst --- awscli-1.11.13/awscli/examples/acm/request-certificate.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/acm/request-certificate.rst 2020-05-28 19:26:18.000000000 +0000 @@ -1,21 +1,33 @@ **To request a new ACM certificate** -The following ``request-certificate`` command requests a new certificate for the www.example.com domain:: +The following ``request-certificate`` command requests a new certificate for the www.example.com domain using DNS validation:: - aws acm request-certificate --domain-name www.example.com + aws acm request-certificate --domain-name www.example.com --validation-method DNS You can enter an idempotency token to distinguish between calls to ``request-certificate``:: - aws acm request-certificate --domain-name www.example.com --idempotency-token 91adc45q + aws acm request-certificate --domain-name www.example.com --validation-method DNS --idempotency-token 91adc45q -You can enter an alternative name that can be used to reach your website:: +You can enter one or more subject alternative names to request a certificate that will protect more than one apex domain:: - aws acm request-certificate --domain-name www.example.com --idempotency-token 91adc45q --subject-alternative-names www.example.net + aws acm request-certificate --domain-name example.com --validation-method DNS --idempotency-token 91adc45q --subject-alternative-names www.example.net + +You can enter an alternative name that can also be used to reach your website:: + + aws acm request-certificate --domain-name example.com --validation-method DNS --idempotency-token 91adc45q --subject-alternative-names www.example.com + +You can use an asterisk (*) as a wildcard to create a certificate for several subdomains in the same domain:: + + aws acm request-certificate --domain-name example.com --validation-method DNS --idempotency-token 91adc45q --subject-alternative-names *.example.com You can also enter multiple alternative names:: - aws acm request-certificate --domain-name a.example.com --subject-alternative-names b.example.com c.example.com d.example.com *.e.example.com *.f.example.com + aws acm request-certificate --domain-name example.com --validation-method DNS --subject-alternative-names b.example.com c.example.com d.example.com + +If you are using email for validation, you can enter domain validation options to specify the domain to which the validation email will be sent:: -You can also enter domain validation options to specify the domain to which validation email will be sent:: + aws acm request-certificate --domain-name example.com --validation-method EMAIL --subject-alternative-names www.example.com --domain-validation-options DomainName=example.com,ValidationDomain=example.com + +The following command opts out of certificate transparency logging when you request a new certificate:: - aws acm request-certificate --domain-name example.com --subject-alternative-names www.example.com --domain-validation-options DomainName=www.example.com,ValidationDomain=example.com + aws acm request-certificate --domain-name www.example.com --validation-method DNS --certificate-options CertificateTransparencyLoggingPreference=DISABLED --idempotency-token 184627 diff -Nru awscli-1.11.13/awscli/examples/acm/update-certificate-options.rst awscli-1.18.69/awscli/examples/acm/update-certificate-options.rst --- awscli-1.11.13/awscli/examples/acm/update-certificate-options.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/acm/update-certificate-options.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,6 @@ +**To update the certificate options** + +The following ``update-certificate-options`` command opts out of certificate transparency logging:: + + aws acm update-certificate-options --certificate-arn arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012 --options CertificateTransparencyLoggingPreference=DISABLED + diff -Nru awscli-1.11.13/awscli/examples/acm-pca/create-certificate-authority-audit-report.rst awscli-1.18.69/awscli/examples/acm-pca/create-certificate-authority-audit-report.rst --- awscli-1.11.13/awscli/examples/acm-pca/create-certificate-authority-audit-report.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/acm-pca/create-certificate-authority-audit-report.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,5 @@ +**To create a certificate authority audit report** + +The following ``create-certificate-authority-audit-report`` command creates an audit report for the private CA identified by the ARN. :: + + aws acm-pca create-certificate-authority-audit-report --certificate-authority-arn arn:aws:acm-pca:us-east-1:accountid:certificate-authority/12345678-1234-1234-1234-123456789012 --s3-bucket-name your-bucket-name --audit-report-response-format JSON \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/acm-pca/create-certificate-authority.rst awscli-1.18.69/awscli/examples/acm-pca/create-certificate-authority.rst --- awscli-1.11.13/awscli/examples/acm-pca/create-certificate-authority.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/acm-pca/create-certificate-authority.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,5 @@ +**To create a private certificate authority** + +The following ``create-certificate-authority`` command creates a private certificate authority in your AWS account. :: + + aws acm-pca create-certificate-authority --certificate-authority-configuration file://C:\ca_config.txt --revocation-configuration file://C:\revoke_config.txt --certificate-authority-type "SUBORDINATE" --idempotency-token 98256344 \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/acm-pca/delete-certificate-authority.rst awscli-1.18.69/awscli/examples/acm-pca/delete-certificate-authority.rst --- awscli-1.11.13/awscli/examples/acm-pca/delete-certificate-authority.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/acm-pca/delete-certificate-authority.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,5 @@ +**To delete a private certificate authority** + +The following ``delete-certificate-authority`` command deletes the certificate authority identified by the ARN. :: + + aws acm-pca delete-certificate-authority --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012 \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/acm-pca/describe-certificate-authority-audit-report.rst awscli-1.18.69/awscli/examples/acm-pca/describe-certificate-authority-audit-report.rst --- awscli-1.11.13/awscli/examples/acm-pca/describe-certificate-authority-audit-report.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/acm-pca/describe-certificate-authority-audit-report.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,5 @@ +**To describe an audit report for a certificate authority** + +The following ``describe-certificate-authority-audit-report`` command lists information about the specified audit report for the CA identified by the ARN. :: + + aws acm-pca describe-certificate-authority-audit-report --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/99999999-8888-7777-6666-555555555555 --audit-report-id 11111111-2222-3333-4444-555555555555 \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/acm-pca/describe-certificate-authority.rst awscli-1.18.69/awscli/examples/acm-pca/describe-certificate-authority.rst --- awscli-1.11.13/awscli/examples/acm-pca/describe-certificate-authority.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/acm-pca/describe-certificate-authority.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,5 @@ +**To describe a private certificate authority** + +The following ``describe-certificate-authority`` command lists information about the private CA identified by the ARN. :: + + aws acm-pca describe-certificate-authority --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012 \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/acm-pca/get-certificate-authority-certificate.rst awscli-1.18.69/awscli/examples/acm-pca/get-certificate-authority-certificate.rst --- awscli-1.11.13/awscli/examples/acm-pca/get-certificate-authority-certificate.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/acm-pca/get-certificate-authority-certificate.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,5 @@ +**To retrieve a certificate authority (CA) certificate** + +The following ``get-certificate-authority-certificate`` command retrieves the certificate and certificate chain for the private CA specified by the ARN. :: + + aws acm-pca get-certificate-authority-certificate --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012 --output text \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/acm-pca/get-certificate-authority-csr.rst awscli-1.18.69/awscli/examples/acm-pca/get-certificate-authority-csr.rst --- awscli-1.11.13/awscli/examples/acm-pca/get-certificate-authority-csr.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/acm-pca/get-certificate-authority-csr.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,5 @@ +**To retrieve the certificate signing request for a certificate authority** + +The following ``get-certificate-authority-csr`` command retrieves the CSR for the private CA specified by the ARN. :: + + aws acm-pca get-certificate-authority-csr --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012 --output text \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/acm-pca/get-certificate.rst awscli-1.18.69/awscli/examples/acm-pca/get-certificate.rst --- awscli-1.11.13/awscli/examples/acm-pca/get-certificate.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/acm-pca/get-certificate.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,28 @@ +**To retrieve an issued certificate** + +The following ``get-certificate`` example retrieves a certificate from the specified private CA. :: + + aws acm-pca get-certificate \ + --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012 \ + --certificate-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/6707447683a9b7f4055627ffd55cebcc \ + --output text + +Output: + +The first part of the output is the certificate itself. The second part is the certificate chain that chains to the root CA certificate. Note that when you use the ``--output text`` option, a ``TAB`` character is inserted between the two certificate pieces (that is the cause of the indented text). If you intend to take this output and parse the certificates with other tools, you might need to remove the ``TAB`` character so it is processed correctly. :: + + -----BEGIN CERTIFICATE----- + MIIEDzCCAvegAwIBAgIRAJuJ8f6ZVYL7gG/rS3qvrZMwDQYJKoZIhvcNAQELBQAw + cTELMAkGA1UEBhMCVVMxEzARBgNVBAgMCldhc2hpbmd0b24xEDAOBgNVBAcMB1Nl + ....certificate body truncated for brevity.... + tKCSglgZZrd4FdLw1EkGm+UVXnodwMtJEQyy3oTfZjURPIyyaqskTu/KSS7YDjK0 + KQNy73D6LtmdOEbAyq10XiDxqY41lvKHJ1eZrPaBmYNABxU= + -----END CERTIFICATE----- + -----BEGIN CERTIFICATE----- + MIIDrzCCApegAwIBAgIRAOskdzLvcj1eShkoyEE693AwDQYJKoZIhvcNAQELBQAw + cTELMAkGA1UEBhMCVVMxEzARBgNVBAgMCldhc2hpbmd0b24xEDAOBgNVBAcMB1Nl + ...certificate body truncated for brevity.... + kdRGB6P2hpxstDOUIwAoCbhoaWwfA4ybJznf+jOQhAziNlRdKQRR8nODWpKt7H9w + dJ5nxsTk/fniJz86Ddtp6n8s82wYdkN3cVffeK72A9aTCOU= + -----END CERTIFICATE----- + diff -Nru awscli-1.11.13/awscli/examples/acm-pca/import-certificate-authority-certificate.rst awscli-1.18.69/awscli/examples/acm-pca/import-certificate-authority-certificate.rst --- awscli-1.11.13/awscli/examples/acm-pca/import-certificate-authority-certificate.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/acm-pca/import-certificate-authority-certificate.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,5 @@ +**To import your certificate authority certificate into ACM PCA** + +The following ``import-certificate-authority-certificate`` command imports the signed private CA certificate for the CA specified by the ARN into ACM PCA. :: + + aws acm-pca import-certificate-authority-certificate --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012 --certificate file://C:\ca_cert.pem --certificate-chain file://C:\ca_cert_chain.pem \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/acm-pca/issue-certificate.rst awscli-1.18.69/awscli/examples/acm-pca/issue-certificate.rst --- awscli-1.11.13/awscli/examples/acm-pca/issue-certificate.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/acm-pca/issue-certificate.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,5 @@ +**To issue a private certificate** + +The following ``issue-certificate`` command uses the private CA specified by the ARN to issue a private certificate. :: + + aws acm-pca issue-certificate --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012 --csr file://C:\cert_1.csr --signing-algorithm "SHA256WITHRSA" --validity Value=365,Type="DAYS" --idempotency-token 1234 \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/acm-pca/list-certificate-authorities.rst awscli-1.18.69/awscli/examples/acm-pca/list-certificate-authorities.rst --- awscli-1.11.13/awscli/examples/acm-pca/list-certificate-authorities.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/acm-pca/list-certificate-authorities.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,5 @@ +**To list your private certificate authorities** + +The following ``list-certificate-authorities`` command lists information about all of the private CAs in your account. :: + + aws acm-pca list-certificate-authorities --max-results 10 \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/acm-pca/list-tags.rst awscli-1.18.69/awscli/examples/acm-pca/list-tags.rst --- awscli-1.11.13/awscli/examples/acm-pca/list-tags.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/acm-pca/list-tags.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,5 @@ +**To list the tags for your certificate authority** + +The following ``list-tags`` command lists the tags associated with the private CA specified by the ARN. :: + + aws acm-pca list-tags --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/123455678-1234-1234-1234-123456789012 --max-results 10 \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/acm-pca/revoke-certificate.rst awscli-1.18.69/awscli/examples/acm-pca/revoke-certificate.rst --- awscli-1.11.13/awscli/examples/acm-pca/revoke-certificate.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/acm-pca/revoke-certificate.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,5 @@ +**To revoke a private certificate** + +The following ``revoke-certificate`` command revokes a private certificate from the CA identified by the ARN. :: + + aws acm-pca revoke-certificate --certificate-authority-arn arn:aws:acm-pca:us-west-2:1234567890:certificate-authority/12345678-1234-1234-1234-123456789012 --certificate-serial 67:07:44:76:83:a9:b7:f4:05:56:27:ff:d5:5c:eb:cc --revocation-reason "KEY_COMPROMISE" \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/acm-pca/tag-certificate-authority.rst awscli-1.18.69/awscli/examples/acm-pca/tag-certificate-authority.rst --- awscli-1.11.13/awscli/examples/acm-pca/tag-certificate-authority.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/acm-pca/tag-certificate-authority.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,5 @@ +**To attach tags to a private certificate authority** + +The following ``tag-certificate-authority`` command attaches one or more tags to your private CA. :: + + aws acm-pca tag-certificate-authority --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012 --tags Key=Admin,Value=Alice \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/acm-pca/untag-certificate-authority.rst awscli-1.18.69/awscli/examples/acm-pca/untag-certificate-authority.rst --- awscli-1.11.13/awscli/examples/acm-pca/untag-certificate-authority.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/acm-pca/untag-certificate-authority.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,5 @@ +**To remove one or more tags from your private certificate authority** + +The following ``untag-certificate-authority`` command removes tags from the private CA identified by the ARN. :: + + aws acm-pca untag-certificate-authority --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012 --tags Key=Purpose,Value=Website \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/acm-pca/update-certificate-authority.rst awscli-1.18.69/awscli/examples/acm-pca/update-certificate-authority.rst --- awscli-1.11.13/awscli/examples/acm-pca/update-certificate-authority.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/acm-pca/update-certificate-authority.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,5 @@ +**To update the configuration of your private certificate authority** + +The following ``update-certificate-authority`` command updates the status and configuration of the private CA identified by the ARN. :: + + aws acm-pca update-certificate-authority --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-1232456789012 --revocation-configuration file://C:\revoke_config.txt --status "DISABLED" \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/alexaforbusiness/create-network-profile.rst awscli-1.18.69/awscli/examples/alexaforbusiness/create-network-profile.rst --- awscli-1.11.13/awscli/examples/alexaforbusiness/create-network-profile.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/alexaforbusiness/create-network-profile.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/alexaforbusiness/delete-network-profile.rst awscli-1.18.69/awscli/examples/alexaforbusiness/delete-network-profile.rst --- awscli-1.11.13/awscli/examples/alexaforbusiness/delete-network-profile.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/alexaforbusiness/delete-network-profile.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/alexaforbusiness/get-network-profile.rst awscli-1.18.69/awscli/examples/alexaforbusiness/get-network-profile.rst --- awscli-1.11.13/awscli/examples/alexaforbusiness/get-network-profile.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/alexaforbusiness/get-network-profile.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/alexaforbusiness/search-network-profiles.rst awscli-1.18.69/awscli/examples/alexaforbusiness/search-network-profiles.rst --- awscli-1.11.13/awscli/examples/alexaforbusiness/search-network-profiles.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/alexaforbusiness/search-network-profiles.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/alexaforbusiness/update-network-profile.rst awscli-1.18.69/awscli/examples/alexaforbusiness/update-network-profile.rst --- awscli-1.11.13/awscli/examples/alexaforbusiness/update-network-profile.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/alexaforbusiness/update-network-profile.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/apigateway/create-api-key.rst awscli-1.18.69/awscli/examples/apigateway/create-api-key.rst --- awscli-1.11.13/awscli/examples/apigateway/create-api-key.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/create-api-key.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,6 +1,5 @@ -**To create an API key that is enabled for an existing API and Stage in the specified region** +**To create an API key that is enabled for an existing API and Stage** Command:: - aws apigateway create-api-key --name 'Dev API Key' --description 'Used for development' --enabled --stage-keys restApiId='a1b2c3d4e5',stageName='dev' --region us-west-2 - + aws apigateway create-api-key --name 'Dev API Key' --description 'Used for development' --enabled --stage-keys restApiId='a1b2c3d4e5',stageName='dev' diff -Nru awscli-1.11.13/awscli/examples/apigateway/create-authorizer.rst awscli-1.18.69/awscli/examples/apigateway/create-authorizer.rst --- awscli-1.11.13/awscli/examples/apigateway/create-authorizer.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/create-authorizer.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,8 +1,8 @@ -**To create a token based API Gateway Custom Authorizer for the API in the specified region** +**To create a token based API Gateway Custom Authorizer for the API** Command:: - aws apigateway create-authorizer --rest-api-id 1234123412 --name 'First_Token_Custom_Authorizer' --type TOKEN --authorizer-uri 'arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:customAuthFunction/invocations' --identity-source 'method.request.header.Authorization' --authorizer-result-ttl-in-seconds 300 --region us-west-2 + aws apigateway create-authorizer --rest-api-id 1234123412 --name 'First_Token_Custom_Authorizer' --type TOKEN --authorizer-uri 'arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:customAuthFunction/invocations' --identity-source 'method.request.header.Authorization' --authorizer-result-ttl-in-seconds 300 Output:: @@ -16,11 +16,11 @@ "id": "z40xj0" } -**To create a Cognito User Pools based API Gateway Custom Authorizer for the API in the specified region** +**To create a Cognito User Pools based API Gateway Custom Authorizer for the API** Command:: - aws apigateway create-authorizer --rest-api-id 1234123412 --name 'First_Cognito_Custom_Authorizer' --type COGNITO_USER_POOLS --provider-arns 'arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_aWcZeQbuD' --identity-source 'method.request.header.Authorization' --region us-west-2 + aws apigateway create-authorizer --rest-api-id 1234123412 --name 'First_Cognito_Custom_Authorizer' --type COGNITO_USER_POOLS --provider-arns 'arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_aWcZeQbuD' --identity-source 'method.request.header.Authorization' Output:: @@ -34,4 +34,3 @@ "type": "COGNITO_USER_POOLS", "id": "5yid1t" } - diff -Nru awscli-1.11.13/awscli/examples/apigateway/create-base-path-mapping.rst awscli-1.18.69/awscli/examples/apigateway/create-base-path-mapping.rst --- awscli-1.11.13/awscli/examples/apigateway/create-base-path-mapping.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/create-base-path-mapping.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,6 +1,5 @@ -**To create the per-region base path mapping for a custom domain name** +**To create the base path mapping for a custom domain name** Command:: - aws apigateway create-base-path-mapping --domain-name subdomain.domain.tld --rest-api-id 1234123412 --stage prod --base-path v1 --region us-west-2 - + aws apigateway create-base-path-mapping --domain-name subdomain.domain.tld --rest-api-id 1234123412 --stage prod --base-path v1 diff -Nru awscli-1.11.13/awscli/examples/apigateway/create-domain-name.rst awscli-1.18.69/awscli/examples/apigateway/create-domain-name.rst --- awscli-1.11.13/awscli/examples/apigateway/create-domain-name.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/create-domain-name.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,6 +1,5 @@ -**To create the per-region custom domain name** +**To create the custom domain name** Command:: - aws apigateway create-domain-name --domain-name 'my.domain.tld' --certificate-name 'my.domain.tld cert' --certificate-body '' --certificate-private-key '' --certificate-chain '' --region us-west-2 - + aws apigateway create-domain-name --domain-name 'my.domain.tld' --certificate-name 'my.domain.tld cert' --certificate-arn 'arn:aws:acm:us-east-1:012345678910:certificate/fb1b9770-a305-495d-aefb-27e5e101ff3' diff -Nru awscli-1.11.13/awscli/examples/apigateway/create-model.rst awscli-1.18.69/awscli/examples/apigateway/create-model.rst --- awscli-1.11.13/awscli/examples/apigateway/create-model.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/create-model.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,8 +1,8 @@ -**To create a model for an API in the specified region** +**To create a model for an API** Command:: - aws apigateway create-model --rest-api-id 1234123412 --name 'firstModel' --description 'The First Model' --content-type 'application/json' --schema '{ "$schema": "http://json-schema.org/draft-04/schema#", "title": "firstModel", "type": "object", "properties": { "firstProperty" : { "type": "object", "properties": { "key": { "type": "string" } } } } }' --region us-west-2 + aws apigateway create-model --rest-api-id 1234123412 --name 'firstModel' --description 'The First Model' --content-type 'application/json' --schema '{ "$schema": "http://json-schema.org/draft-04/schema#", "title": "firstModel", "type": "object", "properties": { "firstProperty" : { "type": "object", "properties": { "key": { "type": "string" } } } } }' Output:: @@ -13,4 +13,3 @@ "id": "2rzg0l", "schema": "{ \"$schema\": \"http://json-schema.org/draft-04/schema#\", \"title\": \"firstModel\", \"type\": \"object\", \"properties\": { \"firstProperty\" : { \"type\": \"object\", \"properties\": { \"key\": { \"type\": \"string\" } } } } }" } - diff -Nru awscli-1.11.13/awscli/examples/apigateway/create-resource.rst awscli-1.18.69/awscli/examples/apigateway/create-resource.rst --- awscli-1.11.13/awscli/examples/apigateway/create-resource.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/create-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,6 +1,5 @@ -**To create a resource in an API for the specified region** +**To create a resource in an API** Command:: - aws apigateway create-resource --rest-api-id 1234123412 --parent-id a1b2c3 --path-part 'new-resource' --region us-west-2 - + aws apigateway create-resource --rest-api-id 1234123412 --parent-id a1b2c3 --path-part 'new-resource' diff -Nru awscli-1.11.13/awscli/examples/apigateway/create-rest-api.rst awscli-1.18.69/awscli/examples/apigateway/create-rest-api.rst --- awscli-1.11.13/awscli/examples/apigateway/create-rest-api.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/create-rest-api.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,12 +1,11 @@ -**To create an API in the specified region** +**To create an API** Command:: - aws apigateway create-rest-api --name 'My First API' --description 'This is my first API' --region us-west-2 + aws apigateway create-rest-api --name 'My First API' --description 'This is my first API' -**To create a duplicate API in the specified region from an existing API in the same region** +**To create a duplicate API from an existing API** Command:: - aws apigateway create-rest-api --name 'Copy of My First API' --description 'This is a copy of my first API' --clone-from 1234123412 --region us-west-2 - + aws apigateway create-rest-api --name 'Copy of My First API' --description 'This is a copy of my first API' --clone-from 1234123412 diff -Nru awscli-1.11.13/awscli/examples/apigateway/create-stage.rst awscli-1.18.69/awscli/examples/apigateway/create-stage.rst --- awscli-1.11.13/awscli/examples/apigateway/create-stage.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/create-stage.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,12 +1,11 @@ -**To create a stage in an API which will contain an existing deployment in the specified region** +**To create a stage in an API which will contain an existing deployment** Command:: - aws apigateway create-stage --rest-api-id 1234123412 --stage-name 'dev' --description 'Development stage' --deployment-id a1b2c3 --region us-west-2 + aws apigateway create-stage --rest-api-id 1234123412 --stage-name 'dev' --description 'Development stage' --deployment-id a1b2c3 -**To create a stage in an API which will contain an existing deployment and custom Stage Variables in the specified region** +**To create a stage in an API which will contain an existing deployment and custom Stage Variables** Command:: - aws apigateway create-stage --rest-api-id 1234123412 --stage-name 'dev' --description 'Development stage' --deployment-id a1b2c3 --variables key='value',otherKey='otherValue' --region us-west-2 - + aws apigateway create-stage --rest-api-id 1234123412 --stage-name 'dev' --description 'Development stage' --deployment-id a1b2c3 --variables key='value',otherKey='otherValue' diff -Nru awscli-1.11.13/awscli/examples/apigateway/create-usage-plan-key.rst awscli-1.18.69/awscli/examples/apigateway/create-usage-plan-key.rst --- awscli-1.11.13/awscli/examples/apigateway/create-usage-plan-key.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/create-usage-plan-key.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,5 +2,4 @@ Command:: - aws apigateway create-usage-plan-key --usage-plan-id a1b2c3 --key-type "API_KEY" --key-id 1NbjQzMReAkeEQPNAW8r3dXsU2rDD7fc7f2Sipnu --region us-west-2 - + aws apigateway create-usage-plan-key --usage-plan-id a1b2c3 --key-type "API_KEY" --key-id 4vq3yryqm5 diff -Nru awscli-1.11.13/awscli/examples/apigateway/create-usage-plan.rst awscli-1.18.69/awscli/examples/apigateway/create-usage-plan.rst --- awscli-1.11.13/awscli/examples/apigateway/create-usage-plan.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/create-usage-plan.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,5 +2,4 @@ Command:: - aws apigateway create-usage-plan --name "New Usage Plan" --description "A new usage plan" --throttle burstLimit=10,rateLimit=5 --quota limit=500,offset=0,period=MONTH --region us-west-2 - + aws apigateway create-usage-plan --name "New Usage Plan" --description "A new usage plan" --throttle burstLimit=10,rateLimit=5 --quota limit=500,offset=0,period=MONTH diff -Nru awscli-1.11.13/awscli/examples/apigateway/delete-api-key.rst awscli-1.18.69/awscli/examples/apigateway/delete-api-key.rst --- awscli-1.11.13/awscli/examples/apigateway/delete-api-key.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/delete-api-key.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,6 +1,5 @@ -**To delete an API key in the specified region** +**To delete an API key** Command:: - aws apigateway delete-api-key --api-key 8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk --region us-west-2 - + aws apigateway delete-api-key --api-key 8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk diff -Nru awscli-1.11.13/awscli/examples/apigateway/delete-authorizer.rst awscli-1.18.69/awscli/examples/apigateway/delete-authorizer.rst --- awscli-1.11.13/awscli/examples/apigateway/delete-authorizer.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/delete-authorizer.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,6 +1,5 @@ -**To delete a Custom Authorizer in an API within the specified region** +**To delete a Custom Authorizer in an API** Command:: - aws apigateway delete-authorizer --rest-api-id 1234123412 --authorizer-id 7gkfbo --region us-west-2 - + aws apigateway delete-authorizer --rest-api-id 1234123412 --authorizer-id 7gkfbo diff -Nru awscli-1.11.13/awscli/examples/apigateway/delete-base-path-mapping.rst awscli-1.18.69/awscli/examples/apigateway/delete-base-path-mapping.rst --- awscli-1.11.13/awscli/examples/apigateway/delete-base-path-mapping.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/delete-base-path-mapping.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,6 +1,5 @@ -**To delete a base path mapping for a custom domain name in the specified region** +**To delete a base path mapping for a custom domain name** Command:: - aws apigateway delete-base-path-mapping --domain-name 'api.domain.tld' --base-path 'dev' --region us-west-2 - + aws apigateway delete-base-path-mapping --domain-name 'api.domain.tld' --base-path 'dev' diff -Nru awscli-1.11.13/awscli/examples/apigateway/delete-client-certificate.rst awscli-1.18.69/awscli/examples/apigateway/delete-client-certificate.rst --- awscli-1.11.13/awscli/examples/apigateway/delete-client-certificate.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/delete-client-certificate.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,6 +1,5 @@ -**To delete a client certificate in the specified region** +**To delete a client certificate** Command:: - aws apigateway delete-client-certificate --client-certificate-id a1b2c3 --region us-west-2 - + aws apigateway delete-client-certificate --client-certificate-id a1b2c3 diff -Nru awscli-1.11.13/awscli/examples/apigateway/delete-deployment.rst awscli-1.18.69/awscli/examples/apigateway/delete-deployment.rst --- awscli-1.11.13/awscli/examples/apigateway/delete-deployment.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/delete-deployment.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,6 +1,5 @@ -**To delete a deployment in an API within the specified region** +**To delete a deployment in an API** Command:: - aws apigateway delete-deployment --rest-api-id 1234123412 --deployment-id a1b2c3 --region us-west-2 - + aws apigateway delete-deployment --rest-api-id 1234123412 --deployment-id a1b2c3 diff -Nru awscli-1.11.13/awscli/examples/apigateway/delete-domain-name.rst awscli-1.18.69/awscli/examples/apigateway/delete-domain-name.rst --- awscli-1.11.13/awscli/examples/apigateway/delete-domain-name.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/delete-domain-name.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,6 +1,5 @@ -**To delete a custom domain name in the specified region** +**To delete a custom domain name** Command:: - aws apigateway delete-domain-name --domain-name 'api.domain.tld' --region us-west-2 - + aws apigateway delete-domain-name --domain-name 'api.domain.tld' diff -Nru awscli-1.11.13/awscli/examples/apigateway/delete-integration-response.rst awscli-1.18.69/awscli/examples/apigateway/delete-integration-response.rst --- awscli-1.11.13/awscli/examples/apigateway/delete-integration-response.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/delete-integration-response.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,6 +1,5 @@ -**To delete an integration response for a given resource, method, and status code in an API within the specified region** +**To delete an integration response for a given resource, method, and status code in an API** Command:: - aws apigateway delete-integration-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 --region us-west-2 - + aws apigateway delete-integration-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 diff -Nru awscli-1.11.13/awscli/examples/apigateway/delete-integration.rst awscli-1.18.69/awscli/examples/apigateway/delete-integration.rst --- awscli-1.11.13/awscli/examples/apigateway/delete-integration.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/delete-integration.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,6 +1,5 @@ -**To delete an integration for a given resource and method in an API within the specified region** +**To delete an integration for a given resource and method in an API** Command:: - aws apigateway delete-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --region us-west-2 - + aws apigateway delete-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET diff -Nru awscli-1.11.13/awscli/examples/apigateway/delete-method-response.rst awscli-1.18.69/awscli/examples/apigateway/delete-method-response.rst --- awscli-1.11.13/awscli/examples/apigateway/delete-method-response.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/delete-method-response.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,6 +1,5 @@ -**To delete a method response for the given resource, method, and status code in an API within the specified region** +**To delete a method response for the given resource, method, and status code in an API** Command:: - aws apigateway delete-method-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 --region us-west-2 - + aws apigateway delete-method-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 diff -Nru awscli-1.11.13/awscli/examples/apigateway/delete-method.rst awscli-1.18.69/awscli/examples/apigateway/delete-method.rst --- awscli-1.11.13/awscli/examples/apigateway/delete-method.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/delete-method.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,6 +1,5 @@ -**To delete a method for the given resource in an API within the specified region** +**To delete a method for the given resource in an API** Command:: - aws apigateway delete-method --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --region us-west-2 - + aws apigateway delete-method --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET diff -Nru awscli-1.11.13/awscli/examples/apigateway/delete-model.rst awscli-1.18.69/awscli/examples/apigateway/delete-model.rst --- awscli-1.11.13/awscli/examples/apigateway/delete-model.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/delete-model.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,6 +1,5 @@ -**To delete a model in the given API within the specified region** +**To delete a model in the given API** Command:: - aws apigateway delete-model --rest-api-id 1234123412 --model-name 'customModel' --region us-west-2 - + aws apigateway delete-model --rest-api-id 1234123412 --model-name 'customModel' diff -Nru awscli-1.11.13/awscli/examples/apigateway/delete-resource.rst awscli-1.18.69/awscli/examples/apigateway/delete-resource.rst --- awscli-1.11.13/awscli/examples/apigateway/delete-resource.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/delete-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,6 +1,5 @@ -**To delete a resource in an API within the specified region** +**To delete a resource in an API** Command:: - aws apigateway delete-resource --rest-api-id 1234123412 --resource-id a1b2c3 --region us-west-2 - + aws apigateway delete-resource --rest-api-id 1234123412 --resource-id a1b2c3 diff -Nru awscli-1.11.13/awscli/examples/apigateway/delete-rest-api.rst awscli-1.18.69/awscli/examples/apigateway/delete-rest-api.rst --- awscli-1.11.13/awscli/examples/apigateway/delete-rest-api.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/delete-rest-api.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,6 +1,5 @@ -**To delete an API within the specified region** +**To delete an API** Command:: - aws apigateway delete-rest-api --rest-api-id 1234123412 --region us-west-2 - + aws apigateway delete-rest-api --rest-api-id 1234123412 diff -Nru awscli-1.11.13/awscli/examples/apigateway/delete-stage.rst awscli-1.18.69/awscli/examples/apigateway/delete-stage.rst --- awscli-1.11.13/awscli/examples/apigateway/delete-stage.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/delete-stage.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,6 +1,5 @@ -**To delete a stage in an API within the given region** +**To delete a stage in an API** Command:: - aws apigateway delete-stage --rest-api-id 1234123412 --stage-name 'dev' --region us-west-2 - + aws apigateway delete-stage --rest-api-id 1234123412 --stage-name 'dev' diff -Nru awscli-1.11.13/awscli/examples/apigateway/delete-usage-plan-key.rst awscli-1.18.69/awscli/examples/apigateway/delete-usage-plan-key.rst --- awscli-1.11.13/awscli/examples/apigateway/delete-usage-plan-key.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/delete-usage-plan-key.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,5 +2,4 @@ Command:: - aws apigateway delete-usage-plan-key --usage-plan-id a1b2c3 --key-id 1NbjQzMReAkeEQPNAW8r3dXsU2rDD7fc7f2Sipnu --region us-west-2 - + aws apigateway delete-usage-plan-key --usage-plan-id a1b2c3 --key-id 1NbjQzMReAkeEQPNAW8r3dXsU2rDD7fc7f2Sipnu diff -Nru awscli-1.11.13/awscli/examples/apigateway/delete-usage-plan.rst awscli-1.18.69/awscli/examples/apigateway/delete-usage-plan.rst --- awscli-1.11.13/awscli/examples/apigateway/delete-usage-plan.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/delete-usage-plan.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,5 +2,4 @@ Command:: - aws apigateway delete-usage-plan --usage-plan-id a1b2c3 --region us-west-2 - + aws apigateway delete-usage-plan --usage-plan-id a1b2c3 diff -Nru awscli-1.11.13/awscli/examples/apigateway/flush-stage-authorizers-cache.rst awscli-1.18.69/awscli/examples/apigateway/flush-stage-authorizers-cache.rst --- awscli-1.11.13/awscli/examples/apigateway/flush-stage-authorizers-cache.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/flush-stage-authorizers-cache.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,5 +2,4 @@ Command:: - aws apigateway flush-stage-authorizers-cache --rest-api-id 1234123412 --stage-name dev --region us-west-2 - + aws apigateway flush-stage-authorizers-cache --rest-api-id 1234123412 --stage-name dev diff -Nru awscli-1.11.13/awscli/examples/apigateway/flush-stage-cache.rst awscli-1.18.69/awscli/examples/apigateway/flush-stage-cache.rst --- awscli-1.11.13/awscli/examples/apigateway/flush-stage-cache.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/flush-stage-cache.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,5 +2,4 @@ Command:: - aws apigateway flush-stage-cache --rest-api-id 1234123412 --stage-name dev --region us-west-2 - + aws apigateway flush-stage-cache --rest-api-id 1234123412 --stage-name dev diff -Nru awscli-1.11.13/awscli/examples/apigateway/generate-client-certificate.rst awscli-1.18.69/awscli/examples/apigateway/generate-client-certificate.rst --- awscli-1.11.13/awscli/examples/apigateway/generate-client-certificate.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/generate-client-certificate.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,6 +1,5 @@ -**To create a Client-Side SSL Certificate in the specified region** +**To create a Client-Side SSL Certificate** Command:: - aws apigateway generate-client-certificate --description 'My First Client Certificate' --region us-west-2 - + aws apigateway generate-client-certificate --description 'My First Client Certificate' diff -Nru awscli-1.11.13/awscli/examples/apigateway/get-account.rst awscli-1.18.69/awscli/examples/apigateway/get-account.rst --- awscli-1.11.13/awscli/examples/apigateway/get-account.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/get-account.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,8 +1,8 @@ -**To get the API Gateway per-region account settings** +**To get API Gateway account settings** Command:: - aws apigateway get-account --region us-west-2 + aws apigateway get-account Output:: @@ -13,4 +13,3 @@ "burstLimit": 1000 } } - diff -Nru awscli-1.11.13/awscli/examples/apigateway/get-api-key.rst awscli-1.18.69/awscli/examples/apigateway/get-api-key.rst --- awscli-1.11.13/awscli/examples/apigateway/get-api-key.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/get-api-key.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,8 +1,8 @@ -**To get the per-region information about a specific API key** +**To get the information about a specific API key** Command:: - aws apigateway get-api-key --api-key 8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk --region us-west-2 + aws apigateway get-api-key --api-key 8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk Output:: @@ -18,4 +18,3 @@ "id": "8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk", "name": "My key" } - diff -Nru awscli-1.11.13/awscli/examples/apigateway/get-api-keys.rst awscli-1.18.69/awscli/examples/apigateway/get-api-keys.rst --- awscli-1.11.13/awscli/examples/apigateway/get-api-keys.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/get-api-keys.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,8 +1,8 @@ -**To get the per-region list of API keys** +**To get the list of API keys** Command:: - aws apigateway get-api-keys --region us-west-2 + aws apigateway get-api-keys Output:: @@ -22,4 +22,3 @@ } ] } - diff -Nru awscli-1.11.13/awscli/examples/apigateway/get-authorizer.rst awscli-1.18.69/awscli/examples/apigateway/get-authorizer.rst --- awscli-1.11.13/awscli/examples/apigateway/get-authorizer.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/get-authorizer.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,7 +2,7 @@ Command:: - aws apigateway get-authorizer --rest-api-id 1234123412 --authorizer-id gfi4n3 --region us-west-2 + aws apigateway get-authorizer --rest-api-id 1234123412 --authorizer-id gfi4n3 Output:: @@ -14,4 +14,3 @@ "authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:authorizer_function/invocations", "id": "gfi4n3" } - diff -Nru awscli-1.11.13/awscli/examples/apigateway/get-authorizers.rst awscli-1.18.69/awscli/examples/apigateway/get-authorizers.rst --- awscli-1.11.13/awscli/examples/apigateway/get-authorizers.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/get-authorizers.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,8 +1,8 @@ -**To get the per-region list of authorizers for a REST API** +**To get the list of authorizers for a REST API** Command:: - aws apigateway get-authorizers --rest-api-id 1234123412 --region us-west-2 + aws apigateway get-authorizers --rest-api-id 1234123412 Output:: @@ -18,4 +18,3 @@ } ] } - diff -Nru awscli-1.11.13/awscli/examples/apigateway/get-base-path-mapping.rst awscli-1.18.69/awscli/examples/apigateway/get-base-path-mapping.rst --- awscli-1.11.13/awscli/examples/apigateway/get-base-path-mapping.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/get-base-path-mapping.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,8 +1,8 @@ -**To get the per-region base path mapping for a custom domain name** +**To get the base path mapping for a custom domain name** Command:: - aws apigateway get-base-path-mapping --domain-name subdomain.domain.tld --base-path v1 --region us-west-2 + aws apigateway get-base-path-mapping --domain-name subdomain.domain.tld --base-path v1 Output:: @@ -11,4 +11,3 @@ "restApiId": "1234w4321e", "stage": "api" } - diff -Nru awscli-1.11.13/awscli/examples/apigateway/get-base-path-mappings.rst awscli-1.18.69/awscli/examples/apigateway/get-base-path-mappings.rst --- awscli-1.11.13/awscli/examples/apigateway/get-base-path-mappings.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/get-base-path-mappings.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,8 +1,8 @@ -**To get the per-region base path mappings for a custom domain name** +**To get the base path mappings for a custom domain name** Command:: - aws apigateway get-base-path-mappings --domain-name subdomain.domain.tld --region us-west-2 + aws apigateway get-base-path-mappings --domain-name subdomain.domain.tld Output:: @@ -20,4 +20,3 @@ } ] } - diff -Nru awscli-1.11.13/awscli/examples/apigateway/get-client-certificate.rst awscli-1.18.69/awscli/examples/apigateway/get-client-certificate.rst --- awscli-1.11.13/awscli/examples/apigateway/get-client-certificate.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/get-client-certificate.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,6 +1,5 @@ -**To get a client certificate in the specified region** +**To get a client certificate** Command:: - aws apigateway get-client-certificate --client-certificate-id a1b2c3 --region us-west-2 - + aws apigateway get-client-certificate --client-certificate-id a1b2c3 diff -Nru awscli-1.11.13/awscli/examples/apigateway/get-client-certificates.rst awscli-1.18.69/awscli/examples/apigateway/get-client-certificates.rst --- awscli-1.11.13/awscli/examples/apigateway/get-client-certificates.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/get-client-certificates.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,8 +1,8 @@ -**To get the per-region list of client certificates** +**To get a list of client certificates** Command:: - aws apigateway get-client-certificates --region us-west-2 + aws apigateway get-client-certificates Output:: diff -Nru awscli-1.11.13/awscli/examples/apigateway/get-deployment.rst awscli-1.18.69/awscli/examples/apigateway/get-deployment.rst --- awscli-1.11.13/awscli/examples/apigateway/get-deployment.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/get-deployment.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,7 +2,7 @@ Command:: - aws apigateway get-deployment --rest-api-id 1234123412 --deployment-id ztt4m2 --region us-west-2 + aws apigateway get-deployment --rest-api-id 1234123412 --deployment-id ztt4m2 Output:: @@ -11,4 +11,3 @@ "id": "ztt4m2", "createdDate": 1455218022 } - diff -Nru awscli-1.11.13/awscli/examples/apigateway/get-deployments.rst awscli-1.18.69/awscli/examples/apigateway/get-deployments.rst --- awscli-1.11.13/awscli/examples/apigateway/get-deployments.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/get-deployments.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,8 +1,8 @@ -**To get the per-region list of deployments for a REST API** +**To get a list of deployments for a REST API** Command:: - aws apigateway get-deployments --rest-api-id 1234123412 --region us-west-2 + aws apigateway get-deployments --rest-api-id 1234123412 Output:: diff -Nru awscli-1.11.13/awscli/examples/apigateway/get-domain-name.rst awscli-1.18.69/awscli/examples/apigateway/get-domain-name.rst --- awscli-1.11.13/awscli/examples/apigateway/get-domain-name.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/get-domain-name.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,7 +2,7 @@ Command:: - aws apigateway get-domain-name --domain-name api.domain.tld --region us-west-2 + aws apigateway get-domain-name --domain-name api.domain.tld Output:: @@ -12,4 +12,3 @@ "certificateName": "uploadedCertificate", "certificateUploadDate": 1462565487 } - diff -Nru awscli-1.11.13/awscli/examples/apigateway/get-domain-names.rst awscli-1.18.69/awscli/examples/apigateway/get-domain-names.rst --- awscli-1.11.13/awscli/examples/apigateway/get-domain-names.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/get-domain-names.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,8 +1,8 @@ -**To get the per-region list of custom domain names** +**To get a list of custom domain names** Command:: - aws apigateway get-domain-names --region us-west-2 + aws apigateway get-domain-names Output:: @@ -16,4 +16,3 @@ } ] } - diff -Nru awscli-1.11.13/awscli/examples/apigateway/get-models.rst awscli-1.18.69/awscli/examples/apigateway/get-models.rst --- awscli-1.11.13/awscli/examples/apigateway/get-models.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/get-models.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,8 +1,8 @@ -**To get the per-region list of models for a REST API** +**To get a list of models for a REST API** Command:: - aws apigateway get-models --rest-api-id 1234123412 --region us-west-2 + aws apigateway get-models --rest-api-id 1234123412 Output:: @@ -24,4 +24,3 @@ } ] } - diff -Nru awscli-1.11.13/awscli/examples/apigateway/get-resource.rst awscli-1.18.69/awscli/examples/apigateway/get-resource.rst --- awscli-1.11.13/awscli/examples/apigateway/get-resource.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/get-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,7 +2,7 @@ Command:: - aws apigateway get-resource --rest-api-id 1234123412 --resource-id zwo0y3 --region us-west-2 + aws apigateway get-resource --rest-api-id 1234123412 --resource-id zwo0y3 Output:: @@ -12,4 +12,3 @@ "id": "zwo0y3", "parentId": "uyokt6ij2g" } - diff -Nru awscli-1.11.13/awscli/examples/apigateway/get-resources.rst awscli-1.18.69/awscli/examples/apigateway/get-resources.rst --- awscli-1.11.13/awscli/examples/apigateway/get-resources.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/get-resources.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,8 +1,8 @@ -**To get the per-region list of resources for a REST API** +**To get a list of resources for a REST API** Command:: - aws apigateway get-resources --rest-api-id 1234123412 --region us-west-2 + aws apigateway get-resources --rest-api-id 1234123412 Output:: @@ -19,4 +19,3 @@ } ] } - diff -Nru awscli-1.11.13/awscli/examples/apigateway/get-rest-api.rst awscli-1.18.69/awscli/examples/apigateway/get-rest-api.rst --- awscli-1.11.13/awscli/examples/apigateway/get-rest-api.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/get-rest-api.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,7 +2,7 @@ Command:: - aws apigateway get-rest-api --rest-api-id 1234123412 --region us-west-2 + aws apigateway get-rest-api --rest-api-id 1234123412 Output:: @@ -11,4 +11,3 @@ "id": "o1y243m4f5", "createdDate": 1453416433 } - diff -Nru awscli-1.11.13/awscli/examples/apigateway/get-rest-apis.rst awscli-1.18.69/awscli/examples/apigateway/get-rest-apis.rst --- awscli-1.11.13/awscli/examples/apigateway/get-rest-apis.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/get-rest-apis.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,8 +1,8 @@ -**To get the per-region list of REST APIs** +**To get a list of REST APIs** Command:: - aws apigateway get-rest-apis --region us-west-2 + aws apigateway get-rest-apis Output:: @@ -15,4 +15,3 @@ } ] } - diff -Nru awscli-1.11.13/awscli/examples/apigateway/get-stage.rst awscli-1.18.69/awscli/examples/apigateway/get-stage.rst --- awscli-1.11.13/awscli/examples/apigateway/get-stage.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/get-stage.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,7 +2,7 @@ Command:: - aws apigateway get-stage --rest-api-id 1234123412 --stage-name dev --region us-west-2 + aws apigateway get-stage --rest-api-id 1234123412 --stage-name dev Output:: @@ -41,4 +41,3 @@ } } } - diff -Nru awscli-1.11.13/awscli/examples/apigateway/get-stages.rst awscli-1.18.69/awscli/examples/apigateway/get-stages.rst --- awscli-1.11.13/awscli/examples/apigateway/get-stages.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/get-stages.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,8 +1,8 @@ -**To get the per-region list of stages for a REST API** +**To get the list of stages for a REST API** Command:: - aws apigateway get-stages --rest-api-id 1234123412 --region us-west-2 + aws apigateway get-stages --rest-api-id 1234123412 Output:: @@ -31,4 +31,3 @@ } ] } - diff -Nru awscli-1.11.13/awscli/examples/apigateway/get-usage-plan-key.rst awscli-1.18.69/awscli/examples/apigateway/get-usage-plan-key.rst --- awscli-1.11.13/awscli/examples/apigateway/get-usage-plan-key.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/get-usage-plan-key.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,5 +2,4 @@ Command:: - aws apigateway get-usage-plan-key --usage-plan-id a1b2c3 --key-id 1NbjQzMReAkeEQPNAW8r3dXsU2rDD7fc7f2Sipnu --region us-west-2 - + aws apigateway get-usage-plan-key --usage-plan-id a1b2c3 --key-id 1NbjQzMReAkeEQPNAW8r3dXsU2rDD7fc7f2Sipnu diff -Nru awscli-1.11.13/awscli/examples/apigateway/get-usage-plan-keys.rst awscli-1.18.69/awscli/examples/apigateway/get-usage-plan-keys.rst --- awscli-1.11.13/awscli/examples/apigateway/get-usage-plan-keys.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/get-usage-plan-keys.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,5 +2,4 @@ Command:: - aws apigateway get-usage-plan-keys --usage-plan-id a1b2c3 --region us-west-2 - + aws apigateway get-usage-plan-keys --usage-plan-id a1b2c3 diff -Nru awscli-1.11.13/awscli/examples/apigateway/get-usage-plan.rst awscli-1.18.69/awscli/examples/apigateway/get-usage-plan.rst --- awscli-1.11.13/awscli/examples/apigateway/get-usage-plan.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/get-usage-plan.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,5 +2,4 @@ Command:: - aws apigateway get-usage-plan --usage-plan-id a1b2c3 --region us-west-2 - + aws apigateway get-usage-plan --usage-plan-id a1b2c3 diff -Nru awscli-1.11.13/awscli/examples/apigateway/get-usage-plans.rst awscli-1.18.69/awscli/examples/apigateway/get-usage-plans.rst --- awscli-1.11.13/awscli/examples/apigateway/get-usage-plans.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/get-usage-plans.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,6 +1,5 @@ -**To get the details of all Usage Plans in a region** +**To get the details of all Usage Plans** Command:: - aws apigateway get-usage-plans --region us-west-2 - + aws apigateway get-usage-plans diff -Nru awscli-1.11.13/awscli/examples/apigateway/get-usage.rst awscli-1.18.69/awscli/examples/apigateway/get-usage.rst --- awscli-1.11.13/awscli/examples/apigateway/get-usage.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/get-usage.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,5 +2,4 @@ Command:: - aws apigateway get-usage --usage-plan-id a1b2c3 --start-date "2016-08-16" --end-date "2016-08-17" --region us-west-2 - + aws apigateway get-usage --usage-plan-id a1b2c3 --start-date "2016-08-16" --end-date "2016-08-17" diff -Nru awscli-1.11.13/awscli/examples/apigateway/import-rest-api.rst awscli-1.18.69/awscli/examples/apigateway/import-rest-api.rst --- awscli-1.11.13/awscli/examples/apigateway/import-rest-api.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/import-rest-api.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,6 +1,5 @@ -**To import a Swagger template and create an API in the specified region** +**To import a Swagger template and create an API** Command:: - aws apigateway import-rest-api --body 'file:///path/to/API_Swagger_template.json' --region us-west-2 - + aws apigateway import-rest-api --body 'file:///path/to/API_Swagger_template.json' diff -Nru awscli-1.11.13/awscli/examples/apigateway/put-integration-response.rst awscli-1.18.69/awscli/examples/apigateway/put-integration-response.rst --- awscli-1.11.13/awscli/examples/apigateway/put-integration-response.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/put-integration-response.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,11 +2,10 @@ Command:: - aws apigateway put-integration-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 --selection-pattern "" --response-templates '{"application/json": "{\"json\": \"template\"}"}' --region us-west-2 + aws apigateway put-integration-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 --selection-pattern "" --response-templates '{"application/json": "{\"json\": \"template\"}"}' **To create an integration response with a regex of 400 and a statically defined header value** Command:: - aws apigateway put-integration-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 400 --selection-pattern 400 --response-parameters '{"method.response.header.custom-header": "'"'"'custom-value'"'"'"}' --region us-west-2 - + aws apigateway put-integration-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 400 --selection-pattern 400 --response-parameters '{"method.response.header.custom-header": "'"'"'custom-value'"'"'"}' diff -Nru awscli-1.11.13/awscli/examples/apigateway/put-integration.rst awscli-1.18.69/awscli/examples/apigateway/put-integration.rst --- awscli-1.11.13/awscli/examples/apigateway/put-integration.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/put-integration.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,17 +2,16 @@ Command:: - aws apigateway put-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --type MOCK --request-templates '{ "application/json": "{\"statusCode\": 200}" }' --region us-west-2 + aws apigateway put-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --type MOCK --request-templates '{ "application/json": "{\"statusCode\": 200}" }' **To create a HTTP integration request** Command:: - aws apigateway put-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --type HTTP --integration-http-method GET --uri 'https://domain.tld/path' --region us-west-2 + aws apigateway put-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --type HTTP --integration-http-method GET --uri 'https://domain.tld/path' **To create an AWS integration request with a Lambda Function endpoint** Command:: - aws apigateway put-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --type AWS --integration-http-method POST --uri 'arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:function_name/invocations' --region us-west-2 - + aws apigateway put-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --type AWS --integration-http-method POST --uri 'arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:function_name/invocations' diff -Nru awscli-1.11.13/awscli/examples/apigateway/put-method-response.rst awscli-1.18.69/awscli/examples/apigateway/put-method-response.rst --- awscli-1.11.13/awscli/examples/apigateway/put-method-response.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/put-method-response.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,5 +2,4 @@ Command:: - aws apigateway put-method-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 400 --response-parameters "method.response.header.custom-header=false" --region us-west-2 - + aws apigateway put-method-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 400 --response-parameters "method.response.header.custom-header=false" diff -Nru awscli-1.11.13/awscli/examples/apigateway/put-method.rst awscli-1.18.69/awscli/examples/apigateway/put-method.rst --- awscli-1.11.13/awscli/examples/apigateway/put-method.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/put-method.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,5 +2,4 @@ Command:: - aws apigateway put-method --rest-api-id 1234123412 --resource-id a1b2c3 --http-method PUT --authorization-type "NONE" --no-api-key-required --request-parameters "method.request.header.custom-header=false" --region us-west-2 - + aws apigateway put-method --rest-api-id 1234123412 --resource-id a1b2c3 --http-method PUT --authorization-type "NONE" --no-api-key-required --request-parameters "method.request.header.custom-header=false" diff -Nru awscli-1.11.13/awscli/examples/apigateway/put-rest-api.rst awscli-1.18.69/awscli/examples/apigateway/put-rest-api.rst --- awscli-1.11.13/awscli/examples/apigateway/put-rest-api.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/put-rest-api.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,12 +1,11 @@ -**To overwrite an existing API in the specified region using a Swagger template** +**To overwrite an existing API using a Swagger template** Command:: - aws apigateway put-rest-api --rest-api-id 1234123412 --mode overwrite --body 'file:///path/to/API_Swagger_template.json' --region us-west-2 + aws apigateway put-rest-api --rest-api-id 1234123412 --mode overwrite --body 'file:///path/to/API_Swagger_template.json' -**To merge a Swagger template into an existing API in the specified region** +**To merge a Swagger template into an existing API** Command:: - aws apigateway put-rest-api --rest-api-id 1234123412 --mode merge --body 'file:///path/to/API_Swagger_template.json' --region us-west-2 - + aws apigateway put-rest-api --rest-api-id 1234123412 --mode merge --body 'file:///path/to/API_Swagger_template.json' diff -Nru awscli-1.11.13/awscli/examples/apigateway/test-invoke-authorizer.rst awscli-1.18.69/awscli/examples/apigateway/test-invoke-authorizer.rst --- awscli-1.11.13/awscli/examples/apigateway/test-invoke-authorizer.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/test-invoke-authorizer.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,5 +2,4 @@ Command:: - aws apigateway test-invoke-authorizer --rest-api-id 1234123412 --authorizer-id 5yid1t --headers Authorization='Value' --region us-west-2 - + aws apigateway test-invoke-authorizer --rest-api-id 1234123412 --authorizer-id 5yid1t --headers Authorization='Value' diff -Nru awscli-1.11.13/awscli/examples/apigateway/test-invoke-method.rst awscli-1.18.69/awscli/examples/apigateway/test-invoke-method.rst --- awscli-1.11.13/awscli/examples/apigateway/test-invoke-method.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/test-invoke-method.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,11 +2,10 @@ Command:: - aws apigateway test-invoke-method --rest-api-id 1234123412 --resource-id avl5sg8fw8 --http-method GET --path-with-query-string '/' --region us-west-2 + aws apigateway test-invoke-method --rest-api-id 1234123412 --resource-id avl5sg8fw8 --http-method GET --path-with-query-string '/' **To test invoke a sub-resource in an API by making a GET request with a path parameter value specified** Command:: - aws apigateway test-invoke-method --rest-api-id 1234123412 --resource-id 3gapai --http-method GET --path-with-query-string '/pets/1' --region us-west-2 - + aws apigateway test-invoke-method --rest-api-id 1234123412 --resource-id 3gapai --http-method GET --path-with-query-string '/pets/1' diff -Nru awscli-1.11.13/awscli/examples/apigateway/update-account.rst awscli-1.18.69/awscli/examples/apigateway/update-account.rst --- awscli-1.11.13/awscli/examples/apigateway/update-account.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/update-account.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,8 +1,8 @@ -**To change the IAM Role ARN for logging to CloudWatch Logs for a region** +**To change the IAM Role ARN for logging to CloudWatch Logs** Command:: - aws apigateway update-account --patch-operations op='replace',path='/cloudwatchRoleArn',value='arn:aws:iam::123412341234:role/APIGatewayToCloudWatchLogs' --region us-west-2 + aws apigateway update-account --patch-operations op='replace',path='/cloudwatchRoleArn',value='arn:aws:iam::123412341234:role/APIGatewayToCloudWatchLogs' Output:: @@ -13,4 +13,3 @@ "burstLimit": 2000 } } - diff -Nru awscli-1.11.13/awscli/examples/apigateway/update-api-key.rst awscli-1.18.69/awscli/examples/apigateway/update-api-key.rst --- awscli-1.11.13/awscli/examples/apigateway/update-api-key.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/update-api-key.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,7 +2,7 @@ Command:: - aws apigateway update-api-key --api-key sNvjQDMReA1eEQPNAW8r37XsU2rDD7fc7m2SiMnu --patch-operations op='replace',path='/description',value='newName' --region us-west-2 + aws apigateway update-api-key --api-key sNvjQDMReA1eEQPNAW8r37XsU2rDD7fc7m2SiMnu --patch-operations op='replace',path='/description',value='newName' Output:: @@ -22,7 +22,7 @@ Command:: - aws apigateway update-api-key --api-key sNvjQDMReA1eEQPNAW8r37XsU2rDD7fc7m2SiMnu --patch-operations op='replace',path='/enabled',value='false' --region us-west-2 + aws apigateway update-api-key --api-key sNvjQDMReA1eEQPNAW8r37XsU2rDD7fc7m2SiMnu --patch-operations op='replace',path='/enabled',value='false' Output:: @@ -37,4 +37,3 @@ "id": "sNvjQDMReA1vEQPNzW8r3dXsU2rrD7fcjm2SiMnu", "name": "newName" } - diff -Nru awscli-1.11.13/awscli/examples/apigateway/update-authorizer.rst awscli-1.18.69/awscli/examples/apigateway/update-authorizer.rst --- awscli-1.11.13/awscli/examples/apigateway/update-authorizer.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/update-authorizer.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,7 +2,7 @@ Command:: - aws apigateway update-authorizer --rest-api-id 1234123412 --authorizer-id gfi4n3 --patch-operations op='replace',path='/name',value='testAuthorizer' --region us-west-2 + aws apigateway update-authorizer --rest-api-id 1234123412 --authorizer-id gfi4n3 --patch-operations op='replace',path='/name',value='testAuthorizer' Output:: @@ -20,7 +20,7 @@ Command:: - aws apigateway update-authorizer --rest-api-id 1234123412 --authorizer-id gfi4n3 --patch-operations op='replace',path='/authorizerUri',value='arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:newAuthorizer/invocations' --region us-west-2 + aws apigateway update-authorizer --rest-api-id 1234123412 --authorizer-id gfi4n3 --patch-operations op='replace',path='/authorizerUri',value='arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:newAuthorizer/invocations' Output:: @@ -33,4 +33,3 @@ "type": "TOKEN", "id": "gfi4n3" } - diff -Nru awscli-1.11.13/awscli/examples/apigateway/update-base-path-mapping.rst awscli-1.18.69/awscli/examples/apigateway/update-base-path-mapping.rst --- awscli-1.11.13/awscli/examples/apigateway/update-base-path-mapping.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/update-base-path-mapping.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,7 +2,7 @@ Command:: - aws apigateway update-base-path-mapping --domain-name api.domain.tld --base-path prod --patch-operations op='replace',path='/basePath',value='v1' --region us-west-2 + aws apigateway update-base-path-mapping --domain-name api.domain.tld --base-path prod --patch-operations op='replace',path='/basePath',value='v1' Output:: @@ -11,4 +11,3 @@ "restApiId": "1234123412", "stage": "api" } - diff -Nru awscli-1.11.13/awscli/examples/apigateway/update-client-certificate.rst awscli-1.18.69/awscli/examples/apigateway/update-client-certificate.rst --- awscli-1.11.13/awscli/examples/apigateway/update-client-certificate.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/update-client-certificate.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,6 +1,5 @@ -**To update the description of a client certificate in the specified region** +**To update the description of a client certificate** Command:: - aws apigateway update-client-certificate --client-certificate-id a1b2c3 --patch-operations op='replace',path='/description',value='My new description' --region us-west-2 - + aws apigateway update-client-certificate --client-certificate-id a1b2c3 --patch-operations op='replace',path='/description',value='My new description' diff -Nru awscli-1.11.13/awscli/examples/apigateway/update-domain-name.rst awscli-1.18.69/awscli/examples/apigateway/update-domain-name.rst --- awscli-1.11.13/awscli/examples/apigateway/update-domain-name.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/update-domain-name.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,15 +1,18 @@ **To change the certificate name for a custom domain name** -Command:: +The following ``update-domain-name`` example changes the certificate name for a custom domain. :: - aws apigateway update-domain-name --domain-name api.domain.tld --patch-operations op='replace',path='/certificateName',value='newDomainCertName' + aws apigateway update-domain-name \ + --domain-name api.domain.tld \ + --patch-operations op='replace',path='/certificateArn',value='arn:aws:acm:us-west-2:111122223333:certificate/CERTEXAMPLE123EXAMPLE' Output:: - { - "domainName": "api.domain.tld", - "distributionDomainName": "d123456789012.cloudfront.net", - "certificateName": "newDomainCertName", - "certificateUploadDate": 1462565487 - } + { + "domainName": "api.domain.tld", + "distributionDomainName": "d123456789012.cloudfront.net", + "certificateArn": "arn:aws:acm:us-west-2:111122223333:certificate/CERTEXAMPLE123EXAMPLE", + "certificateUploadDate": 1462565487 + } +For more information, see `Set up Custom Domain Name for an API in API Gateway `_ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigateway/update-integration.rst awscli-1.18.69/awscli/examples/apigateway/update-integration.rst --- awscli-1.11.13/awscli/examples/apigateway/update-integration.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/update-integration.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/apigateway/update-method-response.rst awscli-1.18.69/awscli/examples/apigateway/update-method-response.rst --- awscli-1.11.13/awscli/examples/apigateway/update-method-response.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/update-method-response.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,11 +2,10 @@ Command:: - aws apigateway update-method-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 --patch-operations op="add",path="/responseParameters/method.response.header.custom-header",value="false" --region us-west-2 + aws apigateway update-method-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 --patch-operations op="add",path="/responseParameters/method.response.header.custom-header",value="false" **To delete a response model for the 200 response in a method** Command:: - aws apigateway update-method-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 --patch-operations op="remove",path="/responseModels/application~1json" --region us-west-2 - + aws apigateway update-method-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 --patch-operations op="remove",path="/responseModels/application~1json" diff -Nru awscli-1.11.13/awscli/examples/apigateway/update-method.rst awscli-1.18.69/awscli/examples/apigateway/update-method.rst --- awscli-1.11.13/awscli/examples/apigateway/update-method.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/update-method.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,11 +2,10 @@ Command:: - aws apigateway update-method --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --patch-operations op="replace",path="/apiKeyRequired",value="true" --region us-west-2 + aws apigateway update-method --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --patch-operations op="replace",path="/apiKeyRequired",value="true" **To modify a method to require IAM Authorization** Command:: - aws apigateway update-method --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --patch-operations op="replace",path="/authorizationType",value="AWS_IAM" --region us-west-2 - + aws apigateway update-method --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --patch-operations op="replace",path="/authorizationType",value="AWS_IAM" diff -Nru awscli-1.11.13/awscli/examples/apigateway/update-model.rst awscli-1.18.69/awscli/examples/apigateway/update-model.rst --- awscli-1.11.13/awscli/examples/apigateway/update-model.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/update-model.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,12 +1,11 @@ -**To change the description of a model in an API within the specified region** +**To change the description of a model in an API** Command:: - aws apigateway update-model --rest-api-id 1234123412 --model-name 'Empty' --patch-operations op=replace,path=/description,value='New Description' --region us-west-2 + aws apigateway update-model --rest-api-id 1234123412 --model-name 'Empty' --patch-operations op=replace,path=/description,value='New Description' -**To change the schema of a model in an API within the specified region** +**To change the schema of a model in an API** Command:: - aws apigateway update-model --rest-api-id 1234123412 --model-name 'Empty' --patch-operations op=replace,path=/schema,value='"{ \"$schema\": \"http://json-schema.org/draft-04/schema#\", \"title\" : \"Empty Schema\", \"type\" : \"object\" }"' --region us-west-2 - + aws apigateway update-model --rest-api-id 1234123412 --model-name 'Empty' --patch-operations op=replace,path=/schema,value='"{ \"$schema\": \"http://json-schema.org/draft-04/schema#\", \"title\" : \"Empty Schema\", \"type\" : \"object\" }"' diff -Nru awscli-1.11.13/awscli/examples/apigateway/update-resource.rst awscli-1.18.69/awscli/examples/apigateway/update-resource.rst --- awscli-1.11.13/awscli/examples/apigateway/update-resource.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/update-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,4 +1,4 @@ -**To move a resource and place it under a different parent resource in an API within the specified region** +**To move a resource and place it under a different parent resource in an API** Command:: @@ -13,7 +13,7 @@ "parentId": "3c2b1a" } -**To rename a resource (pathPart) in an API within the specified region** +**To rename a resource (pathPart) in an API** Command:: @@ -27,4 +27,3 @@ "id": "1a2b3c", "parentId": "3c2b1a" } - diff -Nru awscli-1.11.13/awscli/examples/apigateway/update-rest-api.rst awscli-1.18.69/awscli/examples/apigateway/update-rest-api.rst --- awscli-1.11.13/awscli/examples/apigateway/update-rest-api.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/update-rest-api.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,12 +1,11 @@ -**To change the name of an API in the specified region** +**To change the name of an API** Command:: - aws apigateway update-rest-api --rest-api-id 1234123412 --patch-operations op=replace,path=/name,value='New Name' --region us-west-2 + aws apigateway update-rest-api --rest-api-id 1234123412 --patch-operations op=replace,path=/name,value='New Name' -**To change the description of an API in the specified region** +**To change the description of an API** Command:: aws apigateway update-rest-api --rest-api-id 1234123412 --patch-operations op=replace,path=/description,value='New Description' - diff -Nru awscli-1.11.13/awscli/examples/apigateway/update-stage.rst awscli-1.18.69/awscli/examples/apigateway/update-stage.rst --- awscli-1.11.13/awscli/examples/apigateway/update-stage.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/update-stage.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,12 +1,11 @@ -**To override the stage settings and disable full request/response logging for a specific resource and method in an API's stage within the specified region** +**To override the stage settings and disable full request/response logging for a specific resource and method in an API's stage** Command:: - aws apigateway update-stage --rest-api-id 1234123412 --stage-name 'dev' --patch-operations op=replace,path=/~1resourceName/GET/logging/dataTrace,value=false --region us-west-2 + aws apigateway update-stage --rest-api-id 1234123412 --stage-name 'dev' --patch-operations op=replace,path=/~1resourceName/GET/logging/dataTrace,value=false -**To enable full request/response logging for all resources/methods in an API's stage within the specified region** +**To enable full request/response logging for all resources/methods in an API's stage** Command:: - aws apigateway update-stage --rest-api-id 1234123412 --stage-name 'dev' --patch-operations op=replace,path=/*/*/logging/dataTrace,value=true --region us-west-2 - + aws apigateway update-stage --rest-api-id 1234123412 --stage-name 'dev' --patch-operations op=replace,path=/*/*/logging/dataTrace,value=true diff -Nru awscli-1.11.13/awscli/examples/apigateway/update-usage-plan.rst awscli-1.18.69/awscli/examples/apigateway/update-usage-plan.rst --- awscli-1.11.13/awscli/examples/apigateway/update-usage-plan.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/update-usage-plan.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,23 +2,22 @@ Command:: - aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/quota/period",value="MONTH" --region us-west-2 + aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/quota/period",value="MONTH" **To change the quota limit defined in a Usage Plan** Command:: - aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/quota/limit",value="500" --region us-west-2 + aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/quota/limit",value="500" **To change the throttle rate limit defined in a Usage Plan** Command:: - aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/throttle/rateLimit",value="10" --region us-west-2 + aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/throttle/rateLimit",value="10" **To change the throttle burst limit defined in a Usage Plan** Command:: - aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/throttle/burstLimit",value="20" --region us-west-2 - + aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/throttle/burstLimit",value="20" diff -Nru awscli-1.11.13/awscli/examples/apigateway/update-usage.rst awscli-1.18.69/awscli/examples/apigateway/update-usage.rst --- awscli-1.11.13/awscli/examples/apigateway/update-usage.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigateway/update-usage.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,5 +2,4 @@ Command:: - aws apigateway update-usage --usage-plan-id a1b2c3 --key-id 1NbjQzMReAkeEQPNAW8r3dXsU2rDD7fc7f2Sipnu --patch-operations op="replace",path="/remaining",value="50" --region us-west-2 - + aws apigateway update-usage --usage-plan-id a1b2c3 --key-id 1NbjQzMReAkeEQPNAW8r3dXsU2rDD7fc7f2Sipnu --patch-operations op="replace",path="/remaining",value="50" diff -Nru awscli-1.11.13/awscli/examples/apigatewaymanagementapi/delete-connection.rst awscli-1.18.69/awscli/examples/apigatewaymanagementapi/delete-connection.rst --- awscli-1.11.13/awscli/examples/apigatewaymanagementapi/delete-connection.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewaymanagementapi/delete-connection.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,11 @@ +**To delete a WebSocket connection** + +The following ``delete-connection`` example disconnects a client from the specified WebSocket API. :: + + aws apigatewaymanagementapi delete-connection \ + --connection-id L0SM9cOFvHcCIhw= \ + --endpoint-url https://aabbccddee.execute-api.us-west-2.amazonaws.com/prod + +This command produces no output. + +For more information, see `Use @connections commands in your backend service `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewaymanagementapi/get-connection.rst awscli-1.18.69/awscli/examples/apigatewaymanagementapi/get-connection.rst --- awscli-1.11.13/awscli/examples/apigatewaymanagementapi/get-connection.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewaymanagementapi/get-connection.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,19 @@ +**To get information about a WebSocket connection** + +The following ``get-connection`` example describes a connection to the specified WebSocket API. :: + + aws apigatewaymanagementapi get-connection \ + --connection-id L0SM9cOFvHcCIhw= \ + --endpoint-url https://aabbccddee.execute-api.us-west-2.amazonaws.com/prod + +Output:: + + { + "ConnectedAt": "2020-04-30T20:10:33.236Z", + "Identity": { + "SourceIp": "192.0.2.1" + }, + "LastActiveAt": "2020-04-30T20:10:42.997Z" + } + +For more information, see `Use @connections commands in your backend service `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewaymanagementapi/post-to-connection.rst awscli-1.18.69/awscli/examples/apigatewaymanagementapi/post-to-connection.rst --- awscli-1.11.13/awscli/examples/apigatewaymanagementapi/post-to-connection.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewaymanagementapi/post-to-connection.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,12 @@ +**To send data to a WebSocket connection** + +The following ``post-to-connection`` example sends a message to a client that's connected to the specified WebSocket API. :: + + aws apigatewaymanagementapi post-to-connection \ + --connection-id L0SM9cOFvHcCIhw= \ + --data "Hello from API Gateway!" \ + --endpoint-url https://aabbccddee.execute-api.us-west-2.amazonaws.com/prod + +This command produces no output. + +For more information, see `Use @connections commands in your backend service `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/create-api-mapping.rst awscli-1.18.69/awscli/examples/apigatewayv2/create-api-mapping.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/create-api-mapping.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/create-api-mapping.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,20 @@ +**To create an API mapping for an API** + +The following ``create-api-mapping`` example maps the ``test`` stage of an API to the ``/myApi`` path of the ``regional.example.com`` custom domain name. :: + + aws apigatewayv2 create-api-mapping \ + --domain-name regional.example.com \ + --api-mapping-key myApi \ + --api-id a1b2c3d4 \ + --stage test + +Output:: + + { + "ApiId": "a1b2c3d4", + "ApiMappingId": "0qzs2sy7bh", + "ApiMappingKey": "myApi" + "Stage": "test" + } + +For more information, see `Setting up a regional custom domain name in API Gateway `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/create-api.rst awscli-1.18.69/awscli/examples/apigatewayv2/create-api.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/create-api.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/create-api.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,44 @@ +**To create an HTTP API** + +The following ``create-api`` example creates an HTTP API by using quick create. You can use quick create to create an API with an AWS Lambda or HTTP integration, a default catch-all route, and a default stage that is configured to automatically deploy changes. The following command uses quick create to create an HTTP API that integrates with a Lambda function. :: + + aws apigatewayv2 create-api \ + --name my-http-api \ + --protocol-type HTTP \ + --target arn:aws:lambda:us-west-2:123456789012:function:my-lambda-function + +Output:: + + { + "ApiEndpoint": "https://a1b2c3d4.execute-api.us-west-2.amazonaws.com", + "ApiId": "a1b2c3d4", + "ApiKeySelectionExpression": "$request.header.x-api-key", + "CreatedDate": "2020-04-08T19:05:45+00:00", + "Name": "my-http-api", + "ProtocolType": "HTTP", + "RouteSelectionExpression": "$request.method $request.path" + } + +For more information, see `Developing an HTTP API in API Gateway `__ in the *Amazon API Gateway Developer Guide*. + +**To create a WebSocket API** + +The following ``create-api`` example creates a WebSocket API with the specified name. :: + + aws apigatewayv2 create-api \ + --name "myWebSocketApi" \ + --protocol-type WEBSOCKET \ + --route-selection-expression '$request.body.action' + +Output:: + + { + "ApiKeySelectionExpression": "$request.header.x-api-key", + "Name": "myWebSocketApi", + "CreatedDate": "2018-11-15T06:23:51Z", + "ProtocolType": "WEBSOCKET", + "RouteSelectionExpression": "'$request.body.action'", + "ApiId": "aabbccddee" + } + +For more information, see `Create a WebSocket API in API Gateway `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/create-authorizer.rst awscli-1.18.69/awscli/examples/apigatewayv2/create-authorizer.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/create-authorizer.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/create-authorizer.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,29 @@ +**To create a JWT authorizer for an HTTP API** + +The following ``create-authorizer`` example creates a JWT authorizer that uses Amazon Cognito as an identity provider. :: + + aws apigatewayv2 create-authorizer \ + --name my-jwt-authorizer \ + --api-id a1b2c3d4 \ + --authorizer-type JWT \ + --identity-source '$request.header.Authorization' \ + --jwt-configuration Audience=123456abc,Issuer=https://cognito-idp.us-west-2.amazonaws.com/us-west-2_abc123 + +Output:: + + { + "AuthorizerId": "a1b2c3", + "AuthorizerType": "JWT", + "IdentitySource": [ + "$request.header.Authorization" + ], + "JwtConfiguration": { + "Audience": [ + "123456abc" + ], + "Issuer": "https://cognito-idp.us-west-2.amazonaws.com/us-west-2_abc123" + }, + "Name": "my-jwt-authorizer" + } + +For more information, see `Controlling access to HTTP APIs with JWT authorizers `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/create-deployment.rst awscli-1.18.69/awscli/examples/apigatewayv2/create-deployment.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/create-deployment.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/create-deployment.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,18 @@ +**To create a deployment for an API** + +The following ``create-deployment`` example creates a deployment for an API and associates that deployment with the ``dev`` stage of the API. :: + + aws apigatewayv2 create-deployment \ + --api-id a1b2c3d4 \ + --stage-name dev + +Output:: + + { + "AutoDeployed": false, + "CreatedDate": "2020-04-06T23:38:08Z", + "DeploymentId": "53lz9l", + "DeploymentStatus": "DEPLOYED" + } + +For more information, see `API deployment `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/create-domain-name.rst awscli-1.18.69/awscli/examples/apigatewayv2/create-domain-name.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/create-domain-name.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/create-domain-name.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,26 @@ +**To create a custom domain name** + +The following ``create-domain-name`` example creates a regional custom domain name for an API. :: + + aws apigatewayv2 create-domain-name \ + --domain-name regional.example.com \ + --domain-name-configurations CertificateArn=arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678 + +Output:: + + { + "ApiMappingSelectionExpression": "$request.basepath", + "DomainName": "regional.example.com", + "DomainNameConfigurations": [ + { + "ApiGatewayDomainName": "d-id.execute-api.us-west-2.amazonaws.com", + "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678", + "EndpointType": "REGIONAL", + "HostedZoneId": "123456789111", + "SecurityPolicy": "TLS_1_2", + "DomainNameStatus": "AVAILABLE" + } + ] + } + +For more information, see `Setting up a regional custom domain name in API Gateway `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/create-integration.rst awscli-1.18.69/awscli/examples/apigatewayv2/create-integration.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/create-integration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/create-integration.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,48 @@ +**To create a WebSocket API integration** + +The following ``create-integration`` example creates a mock integration for a WebSocket API. :: + + aws apigatewayv2 create-integration \ + --api-id aabbccddee \ + --passthrough-behavior WHEN_NO_MATCH \ + --timeout-in-millis 29000 \ + --connection-type INTERNET \ + --integration-type MOCK + +Output:: + + { + "ConnectionType": "INTERNET", + "IntegrationId": "0abcdef", + "IntegrationResponseSelectionExpression": "${integration.response.statuscode}", + "IntegrationType": "MOCK", + "PassthroughBehavior": "WHEN_NO_MATCH", + "PayloadFormatVersion": "1.0", + "TimeoutInMillis": 29000 + } + +For more information, see `Set up a WebSocket API integration request in API Gateway `__ in the *Amazon API Gateway Developer Guide*. + +**To create an HTTP API integration** + +The following ``create-integration`` example creates an AWS Lambda integration for an HTTP API. :: + + aws apigatewayv2 create-integration \ + --api-id a1b2c3d4 \ + --integration-type AWS_PROXY \ + --integration-uri arn:aws:lambda:us-west-2:123456789012:function:my-function \ + --payload-format-version 2.0 + +Output:: + + { + "ConnectionType": "INTERNET", + "IntegrationId": "0abcdef", + "IntegrationMethod": "POST", + "IntegrationType": "AWS_PROXY", + "IntegrationUri": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "PayloadFormatVersion": "2.0", + "TimeoutInMillis": 30000 + } + +For more information, see `Configuring integrations for HTTP APIs `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/create-route.rst awscli-1.18.69/awscli/examples/apigatewayv2/create-route.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/create-route.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/create-route.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,37 @@ +**To create a $default route for a WebSocket or HTTP API** + +The following ``create-route`` example creates a ``$default`` route for a WebSocket or HTTP API. :: + + aws apigatewayv2 create-route \ + --api-id aabbccddee \ + --route-key '$default' + +Output:: + + { + "ApiKeyRequired": false, + "AuthorizationType": "NONE", + "RouteKey": "$default", + "RouteId": "1122334" + } + +For more information, see `Working with routes for WebSocket APIs `__ in the *Amazon API Gateway Developer Guide* + +**To create a route for an HTTP API** + +The following ``create-route`` example creates a route named ``signup`` that accepts POST requests. :: + + aws apigatewayv2 create-route \ + --api-id aabbccddee \ + --route-key 'POST /signup' + +Output:: + + { + "ApiKeyRequired": false, + "AuthorizationType": "NONE", + "RouteKey": "POST /signup", + "RouteId": "1122334" + } + +For more information, see `Working with routes for HTTP APIs `__ in the *Amazon API Gateway Developer Guide* diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/create-stage.rst awscli-1.18.69/awscli/examples/apigatewayv2/create-stage.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/create-stage.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/create-stage.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,23 @@ +**To create a stage** + +The following ``create-stage`` example creates a stage named `dev` for an API. :: + + aws apigatewayv2 create-stage \ + --api-id a1b2c3d4 \ + --stage-name dev + +Output:: + + { + "CreatedDate": "2020-04-06T23:23:46Z", + "DefaultRouteSettings": { + "DetailedMetricsEnabled": false + }, + "LastUpdatedDate": "2020-04-06T23:23:46Z", + "RouteSettings": {}, + "StageName": "dev", + "StageVariables": {}, + "Tags": {} + } + +For more information, see `Working with stages for HTTP APIs `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/create-vpc-link.rst awscli-1.18.69/awscli/examples/apigatewayv2/create-vpc-link.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/create-vpc-link.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/create-vpc-link.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,30 @@ +**To create a VPC link for an HTTP API** + +The following ``create-vpc-link`` example creates a VPC link for HTTP APIs. :: + + aws apigatewayv2 create-vpc-link \ + --name MyVpcLink \ + --subnet-ids subnet-aaaa subnet-bbbb \ + --security-group-ids sg1234 sg5678 + +Output:: + + { + "CreatedDate": "2020-04-07T00:11:46Z", + "Name": "MyVpcLink", + "SecurityGroupIds": [ + "sg1234", + "sg5678" + ], + "SubnetIds": [ + "subnet-aaaa", + "subnet-bbbb" + ], + "Tags": {}, + "VpcLinkId": "abcd123", + "VpcLinkStatus": "PENDING", + "VpcLinkStatusMessage": "VPC link is provisioning ENIs", + "VpcLinkVersion": "V2" + } + +For more information, see `Working with VPC links for HTTP APIs `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/delete-access-log-settings.rst awscli-1.18.69/awscli/examples/apigatewayv2/delete-access-log-settings.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/delete-access-log-settings.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/delete-access-log-settings.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,11 @@ +**To disable access logging for an API** + +The following ``delete-access-log-settings`` example deletes the access log settings for the ``$default`` stage of an API. To disable access logging for a stage, delete its access log settings. :: + + aws apigatewayv2 delete-access-log-settings \ + --api-id a1b2c3d4 \ + --stage-name '$default' + +This command produces no output. + +For more information, see `Configuring logging for an HTTP API `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/delete-api-mapping.rst awscli-1.18.69/awscli/examples/apigatewayv2/delete-api-mapping.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/delete-api-mapping.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/delete-api-mapping.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,11 @@ +**To delete an API mapping** + +The following ``delete-api-mapping`` example deletes an API mapping for the ``api.example.com`` custom domain name. :: + + aws apigatewayv2 delete-api-mapping \ + --api-mapping-id a1b2c3 \ + --domain-name api.example.com + +This command produces no output. + +For more information, see `Setting up a regional custom domain name in API Gateway `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/delete-api.rst awscli-1.18.69/awscli/examples/apigatewayv2/delete-api.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/delete-api.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/delete-api.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete an API** + +The following ``delete-api`` example deletes an API. :: + + aws apigatewayv2 delete-api \ + --api-id a1b2c3d4 + +This command produces no output. + +For more information, see `Working with HTTP APIs `__ and `Working with WebSocket APIs `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/delete-authorizer.rst awscli-1.18.69/awscli/examples/apigatewayv2/delete-authorizer.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/delete-authorizer.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/delete-authorizer.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,11 @@ +**To delete an authorizer** + +The following ``delete-authorizer`` example deletes an authorizer. :: + + aws apigatewayv2 delete-authorizer \ + --api-id a1b2c3d4 \ + --authorizer-id a1b2c3 + +This command produces no output. + +For more information, see `Controlling access to HTTP APIs with JWT authorizers `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/delete-cors-configuration.rst awscli-1.18.69/awscli/examples/apigatewayv2/delete-cors-configuration.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/delete-cors-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/delete-cors-configuration.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete the CORS configuration for an HTTP API** + +The following ``delete-cors-configuration`` example disables CORS for an HTTP API by deleting its CORS configuration. :: + + aws apigatewayv2 delete-cors-configuration \ + --api-id a1b2c3d4 + +This command produces no output. + +For more information, see `Configuring CORS for an HTTP API `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/delete-deployment.rst awscli-1.18.69/awscli/examples/apigatewayv2/delete-deployment.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/delete-deployment.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/delete-deployment.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,11 @@ +**To delete a deployment** + +The following ``delete-deployment`` example deletes a deployment of an API. :: + + aws apigatewayv2 delete-deployment \ + --api-id a1b2c3d4 \ + --deployment-id a1b2c3 + +This command produces no output. + +For more information, see `API deployment `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/delete-domain-name.rst awscli-1.18.69/awscli/examples/apigatewayv2/delete-domain-name.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/delete-domain-name.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/delete-domain-name.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a custom domain name** + +The following ``delete-domain-name`` example deletes a custom domain name. :: + + aws apigatewayv2 delete-domain-name \ + --domain-name api.example.com + +This command produces no output. + +For more information, see `Setting up a regional custom domain name in API Gateway `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/delete-integration.rst awscli-1.18.69/awscli/examples/apigatewayv2/delete-integration.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/delete-integration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/delete-integration.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,11 @@ +**To delete an integration** + +The following ``delete-integration`` example deletes an API integration. :: + + aws apigatewayv2 delete-integration \ + --api-id a1b2c3d4 \ + --integration-id a1b2c3 + +This command produces no output. + +For more information, see `Configuring integrations for HTTP APIs `__ and `Setting up WebSocket API integrations `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/delete-route.rst awscli-1.18.69/awscli/examples/apigatewayv2/delete-route.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/delete-route.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/delete-route.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,11 @@ +**To delete a route** + +The following ``delete-route`` example deletes an API route. :: + + aws apigatewayv2 delete-route \ + --api-id a1b2c3d4 \ + --route-id a1b2c3 + +This command produces no output. + +For more information, see `Working with routes for HTTP APIs `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/delete-route-settings.rst awscli-1.18.69/awscli/examples/apigatewayv2/delete-route-settings.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/delete-route-settings.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/delete-route-settings.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,12 @@ +**To delete route settings** + +The following ``delete-route-settings`` example deletes the route settings for the specified route. :: + + aws apigatewayv2 delete-route-settings \ + --api-id a1b2c3d4 \ + --stage-name dev \ + --route-key 'GET /pets' + +This command produces no output. + +For more information, see `Working with routes for HTTP APIs `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/delete-stage.rst awscli-1.18.69/awscli/examples/apigatewayv2/delete-stage.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/delete-stage.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/delete-stage.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,11 @@ +**To delete a stage** + +The following ``delete-stage`` example deletes the ``test`` stage of an API. :: + + aws apigatewayv2 delete-stage \ + --api-id a1b2c3d4 \ + --stage-name test + +This command produces no output. + +For more information, see `Working with stages for HTTP APIs `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/delete-vpc-link.rst awscli-1.18.69/awscli/examples/apigatewayv2/delete-vpc-link.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/delete-vpc-link.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/delete-vpc-link.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a VPC link for an HTTP API** + +The following ``delete-vpc-link`` example deletes a VPC link. :: + + aws apigatewayv2 delete-vpc-link \ + --vpc-link-id abcd123 + +This command produces no output. + +For more information, see `Working with VPC links for HTTP APIs `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/export-api.rst awscli-1.18.69/awscli/examples/apigatewayv2/export-api.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/export-api.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/export-api.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,14 @@ +**To export an OpenAPI definition of an HTTP API** + +The following ``export-api`` example exports an OpenAPI 3.0 definition of an API stage named ``prod`` to a YAML file named ``stage-definition.yaml``. The exported definition file includes API Gateway extensions by default. :: + + aws apigatewayv2 export-api \ + --api-id a1b2c3d4 \ + --output-type YAML \ + --specification OAS30 \ + --stage-name prod \ + stage-definition.yaml + +This command produces no output. + +For more information, see `Exporting an HTTP API from API Gateway `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/get-api-mapping.rst awscli-1.18.69/awscli/examples/apigatewayv2/get-api-mapping.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/get-api-mapping.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/get-api-mapping.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,18 @@ +**To get information about an API mapping for a custom domain name** + +The following ``get-api-mapping`` example displays infomation about an API mapping for the ``api.example.com`` custom domain name. :: + + aws apigatewayv2 get-api-mapping \ + --api-mapping-id a1b2c3 \ + --domain-name api.example.com + +Output:: + + { + "ApiId": "a1b2c3d4", + "ApiMappingId": "a1b2c3d5", + "ApiMappingKey": "myTestApi" + "Stage": "test" + } + +For more information, see `Setting up a regional custom domain name in API Gateway `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/get-api-mappings.rst awscli-1.18.69/awscli/examples/apigatewayv2/get-api-mappings.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/get-api-mappings.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/get-api-mappings.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,27 @@ +**To get API mappings for a custom domain name** + +The following ``get-api-mappings`` example displays a list of all of the API mappings for the ``api.example.com`` custom domain name. :: + + aws apigatewayv2 get-api-mappings \ + --domain-name api.example.com + +Output:: + + { + "Items": [ + { + "ApiId": "a1b2c3d4", + "ApiMappingId": "a1b2c3d5", + "ApiMappingKey": "myTestApi" + "Stage": "test" + }, + { + "ApiId": "a5b6c7d8", + "ApiMappingId": "a1b2c3d6", + "ApiMappingKey": "myDevApi" + "Stage": "dev" + }, + ] + } + +For more information, see `Setting up a regional custom domain name in API Gateway `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/get-api.rst awscli-1.18.69/awscli/examples/apigatewayv2/get-api.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/get-api.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/get-api.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,21 @@ +**To retrieve information about an API** + +The following ``get-api`` example displays information about an API. :: + + aws apigatewayv2 get-api \ + --api-id a1b2c3d4 + +Output:: + + { + "ApiEndpoint": "https://a1b2c3d4.execute-api.us-west-2.amazonaws.com", + "ApiId": "a1b2c3d4", + "ApiKeySelectionExpression": "$request.header.x-api-key", + "CreatedDate": "2020-03-28T00:32:37Z", + "Name": "my-api", + "ProtocolType": "HTTP", + "RouteSelectionExpression": "$request.method $request.path", + "Tags": { + "department": "finance" + } + } diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/get-apis.rst awscli-1.18.69/awscli/examples/apigatewayv2/get-apis.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/get-apis.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/get-apis.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,34 @@ +**To retrieve a list of APIs** + +The following ``get-apis`` example lists all of the APIs for the current user. :: + + aws apigatewayv2 get-apis + +Output:: + + { + "Items": [ + { + "ApiEndpoint": "wss://a1b2c3d4.execute-api.us-west-2.amazonaws.com", + "ApiId": "a1b2c3d4", + "ApiKeySelectionExpression": "$request.header.x-api-key", + "CreatedDate": "2020-04-07T20:21:59Z", + "Name": "my-websocket-api", + "ProtocolType": "WEBSOCKET", + "RouteSelectionExpression": "$request.body.message", + "Tags": {} + }, + { + "ApiEndpoint": "https://a1b2c3d5.execute-api.us-west-2.amazonaws.com", + "ApiId": "a1b2c3d5", + "ApiKeySelectionExpression": "$request.header.x-api-key", + "CreatedDate": "2020-04-07T20:23:50Z", + "Name": "my-http-api", + "ProtocolType": "HTTP", + "RouteSelectionExpression": "$request.method $request.path", + "Tags": {} + } + ] + } + +For more information, see `Working with HTTP APIs `__ and `Working with WebSocket APIs `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/get-authorizer.rst awscli-1.18.69/awscli/examples/apigatewayv2/get-authorizer.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/get-authorizer.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/get-authorizer.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,26 @@ +**To retrieve information about an authorizer** + +The following ``get-authorizer`` example displays information about an authorizer. :: + + aws apigatewayv2 get-authorizer \ + --api-id a1b2c3d4 \ + --authorizer-id a1b2c3 + +Output:: + + { + "AuthorizerId": "a1b2c3", + "AuthorizerType": "JWT", + "IdentitySource": [ + "$request.header.Authorization" + ], + "JwtConfiguration": { + "Audience": [ + "123456abc" + ], + "Issuer": "https://cognito-idp.us-west-2.amazonaws.com/us-west-2_abc123" + }, + "Name": "my-jwt-authorizer" + } + +For more information, see `Controlling access to HTTP APIs with JWT authorizers `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/get-authorizers.rst awscli-1.18.69/awscli/examples/apigatewayv2/get-authorizers.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/get-authorizers.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/get-authorizers.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,43 @@ +**To retrieve a list of authorizers for an API** + +The following ``get-authorizers`` example displays a list of all of the authorizers for an API. :: + + aws apigatewayv2 get-authorizers \ + --api-id a1b2c3d4 + +Output:: + + { + "Items": [ + { + "AuthorizerId": "a1b2c3", + "AuthorizerType": "JWT", + "IdentitySource": [ + "$request.header.Authorization" + ], + "JwtConfiguration": { + "Audience": [ + "123456abc" + ], + "Issuer": "https://cognito-idp.us-west-2.amazonaws.com/us-west-2_abc123" + }, + "Name": "my-jwt-authorizer" + }, + { + "AuthorizerId": "a1b2c4", + "AuthorizerType": "JWT", + "IdentitySource": [ + "$request.header.Authorization" + ], + "JwtConfiguration": { + "Audience": [ + "6789abcde" + ], + "Issuer": "https://cognito-idp.us-west-2.amazonaws.com/us-west-2_abc234" + }, + "Name": "new-jwt-authorizer" + } + ] + } + +For more information, see `Controlling access to HTTP APIs with JWT authorizers `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/get-deployment.rst awscli-1.18.69/awscli/examples/apigatewayv2/get-deployment.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/get-deployment.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/get-deployment.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,19 @@ +**To retrieve information about a deployment** + +The following ``get-deployment`` example displays information about a deployment. :: + + aws apigatewayv2 get-deployment \ + --api-id a1b2c3d4 \ + --deployment-id abcdef + +Output:: + + { + "AutoDeployed": true, + "CreatedDate": "2020-04-07T23:58:40Z", + "DeploymentId": "abcdef", + "DeploymentStatus": "DEPLOYED", + "Description": "Automatic deployment triggered by changes to the Api configuration" + } + +For more information, see `API deployment `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/get-deployments.rst awscli-1.18.69/awscli/examples/apigatewayv2/get-deployments.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/get-deployments.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/get-deployments.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,29 @@ +**To retrieve a list of deployments** + +The following ``get-deployments`` example displays a list of all of an API's deployments. :: + + aws apigatewayv2 get-deployments \ + --api-id a1b2c3d4 + +Output:: + + { + "Items": [ + { + "AutoDeployed": true, + "CreatedDate": "2020-04-07T23:58:40Z", + "DeploymentId": "abcdef", + "DeploymentStatus": "DEPLOYED", + "Description": "Automatic deployment triggered by changes to the Api configuration" + }, + { + "AutoDeployed": true, + "CreatedDate": "2020-04-06T00:33:00Z", + "DeploymentId": "bcdefg", + "DeploymentStatus": "DEPLOYED", + "Description": "Automatic deployment triggered by changes to the Api configuration" + } + ] + } + +For more information, see `API deployment `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/get-domain-name.rst awscli-1.18.69/awscli/examples/apigatewayv2/get-domain-name.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/get-domain-name.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/get-domain-name.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,26 @@ +**To retrieve information about a custom domain name** + +The following ``get-domain-name`` example displays information about a custom domain name. :: + + aws apigatewayv2 get-domain-name \ + --domain-name api.example.com + +Output:: + + { + "ApiMappingSelectionExpression": "$request.basepath", + "DomainName": "api.example.com", + "DomainNameConfigurations": [ + { + "ApiGatewayDomainName": "d-1234.execute-api.us-west-2.amazonaws.com", + "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678", + "EndpointType": "REGIONAL", + "HostedZoneId": "123456789111", + "SecurityPolicy": "TLS_1_2", + "DomainNameStatus": "AVAILABLE" + } + ], + "Tags": {} + } + +For more information, see `Setting up a regional custom domain name in API Gateway `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/get-domain-names.rst awscli-1.18.69/awscli/examples/apigatewayv2/get-domain-names.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/get-domain-names.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/get-domain-names.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,42 @@ +**To retrieve a list of custom domain names** + +The following ``get-domain-names`` example displays a list of all of the custom domain names for the current user. :: + + aws apigatewayv2 get-domain-names + +Output:: + + { + "Items": [ + { + "ApiMappingSelectionExpression": "$request.basepath", + "DomainName": "api.example.com", + "DomainNameConfigurations": [ + { + "ApiGatewayDomainName": "d-1234.execute-api.us-west-2.amazonaws.com", + "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678", + "EndpointType": "REGIONAL", + "HostedZoneId": "123456789111", + "SecurityPolicy": "TLS_1_2", + "DomainNameStatus": "AVAILABLE" + } + ] + }, + { + "ApiMappingSelectionExpression": "$request.basepath", + "DomainName": "newApi.example.com", + "DomainNameConfigurations": [ + { + "ApiGatewayDomainName": "d-5678.execute-api.us-west-2.amazonaws.com", + "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678", + "EndpointType": "REGIONAL", + "HostedZoneId": "123456789222", + "SecurityPolicy": "TLS_1_2", + "DomainNameStatus": "AVAILABLE" + } + ] + } + ] + } + +For more information, see `Setting up a regional custom domain name in API Gateway `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/get-integration.rst awscli-1.18.69/awscli/examples/apigatewayv2/get-integration.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/get-integration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/get-integration.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,22 @@ +**To retrieve information about an integration** + +The following ``get-integration`` example displays information about an integration. :: + + aws apigatewayv2 get-integration \ + --api-id a1b2c3d4 \ + --integration-id a1b2c3 + +Output:: + + { + "ApiGatewayManaged": true, + "ConnectionType": "INTERNET", + "IntegrationId": "a1b2c3", + "IntegrationMethod": "POST", + "IntegrationType": "AWS_PROXY", + "IntegrationUri": "arn:aws:lambda:us-west-2:12356789012:function:hello12", + "PayloadFormatVersion": "2.0", + "TimeoutInMillis": 30000 + } + +For more information, see `Configuring integrations for HTTP APIs `__ and `Setting up WebSocket API integrations `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/get-integrations.rst awscli-1.18.69/awscli/examples/apigatewayv2/get-integrations.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/get-integrations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/get-integrations.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,34 @@ +**To retrieve a list of integrations** + +The following ``get-integrations`` example displays a list of all of an API's integrations. :: + + aws apigatewayv2 get-integrations \ + --api-id a1b2c3d4 + +Output:: + + { + "Items": [ + { + "ApiGatewayManaged": true, + "ConnectionType": "INTERNET", + "IntegrationId": "a1b2c3", + "IntegrationMethod": "POST", + "IntegrationType": "AWS_PROXY", + "IntegrationUri": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "PayloadFormatVersion": "2.0", + "TimeoutInMillis": 30000 + }, + { + "ConnectionType": "INTERNET", + "IntegrationId": "a1b2c4", + "IntegrationMethod": "ANY", + "IntegrationType": "HTTP_PROXY", + "IntegrationUri": "https://www.example.com", + "PayloadFormatVersion": "1.0", + "TimeoutInMillis": 30000 + } + ] + } + +For more information, see `Configuring integrations for HTTP APIs `__ and `Setting up WebSocket API integrations `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/get-route.rst awscli-1.18.69/awscli/examples/apigatewayv2/get-route.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/get-route.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/get-route.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,19 @@ +**To retrieve information about a route** + +The following ``get-route`` example displays information about a route. :: + + aws apigatewayv2 get-route \ + --api-id a1b2c3d4 \ + --route-id 72jz1wk + +Output:: + + { + "ApiKeyRequired": false, + "AuthorizationType": "NONE", + "RouteId": "72jz1wk", + "RouteKey": "ANY /pets", + "Target": "integrations/a1b2c3" + } + +For more information, see `Working with routes for HTTP APIs `__ in the *Amazon API Gateway Developer Guide* diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/get-routes.rst awscli-1.18.69/awscli/examples/apigatewayv2/get-routes.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/get-routes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/get-routes.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,30 @@ +**To retrieve a list of routes** + +The following ``get-routes`` example displays a list of all of an API's routes. :: + + aws apigatewayv2 get-routes \ + --api-id a1b2c3d4 + +Output:: + + { + "Items": [ + { + "ApiKeyRequired": false, + "AuthorizationType": "NONE", + "RouteId": "72jz1wk", + "RouteKey": "ANY /admin", + "Target": "integrations/a1b2c3" + }, + { + "ApiGatewayManaged": true, + "ApiKeyRequired": false, + "AuthorizationType": "NONE", + "RouteId": "go65gqi", + "RouteKey": "$default", + "Target": "integrations/a1b2c4" + } + ] + } + +For more information, see `Working with routes for HTTP APIs `__ in the *Amazon API Gateway Developer Guide* diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/get-stage.rst awscli-1.18.69/awscli/examples/apigatewayv2/get-stage.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/get-stage.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/get-stage.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,26 @@ +**To retrieve information about a stage** + +The following ``get-stage`` example displays information about the ``prod`` stage of an API. :: + + aws apigatewayv2 get-stage \ + --api-id a1b2c3d4 \ + --stage-name prod + +Output:: + + { + "CreatedDate": "2020-04-08T00:36:05Z", + "DefaultRouteSettings": { + "DetailedMetricsEnabled": false + }, + "DeploymentId": "x1zwyv", + "LastUpdatedDate": "2020-04-08T00:36:13Z", + "RouteSettings": {}, + "StageName": "prod", + "StageVariables": { + "function": "my-prod-function" + }, + "Tags": {} + } + +For more information, see `Working with stages for HTTP APIs `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/get-stages.rst awscli-1.18.69/awscli/examples/apigatewayv2/get-stages.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/get-stages.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/get-stages.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,58 @@ +**To retrieve a list of stages** + +The following ``get-stages`` example lists all of an API's stages. :: + + aws apigatewayv2 get-stages \ + --api-id a1b2c3d4 + +Output:: + + { + "Items": [ + { + "ApiGatewayManaged": true, + "AutoDeploy": true, + "CreatedDate": "2020-04-08T00:08:44Z", + "DefaultRouteSettings": { + "DetailedMetricsEnabled": false + }, + "DeploymentId": "dty748", + "LastDeploymentStatusMessage": "Successfully deployed stage with deployment ID 'dty748'", + "LastUpdatedDate": "2020-04-08T00:09:49Z", + "RouteSettings": {}, + "StageName": "$default", + "StageVariables": {}, + "Tags": {} + }, + { + "AutoDeploy": true, + "CreatedDate": "2020-04-08T00:35:06Z", + "DefaultRouteSettings": { + "DetailedMetricsEnabled": false + }, + "LastUpdatedDate": "2020-04-08T00:35:48Z", + "RouteSettings": {}, + "StageName": "dev", + "StageVariables": { + "function": "my-dev-function" + }, + "Tags": {} + }, + { + "CreatedDate": "2020-04-08T00:36:05Z", + "DefaultRouteSettings": { + "DetailedMetricsEnabled": false + }, + "DeploymentId": "x1zwyv", + "LastUpdatedDate": "2020-04-08T00:36:13Z", + "RouteSettings": {}, + "StageName": "prod", + "StageVariables": { + "function": "my-prod-function" + }, + "Tags": {} + } + ] + } + +For more information, see `Working with stages for HTTP APIs `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/get-tags.rst awscli-1.18.69/awscli/examples/apigatewayv2/get-tags.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/get-tags.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/get-tags.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,17 @@ +**To retrieve a list of tags for a resource** + +The following ``get-tags`` example lists all of an API's tags. :: + + aws apigatewayv2 get-tags \ + --resource-arn arn:aws:apigateway:us-west-2::/apis/a1b2c3d4 + +Output:: + + { + "Tags": { + "owner": "dev-team", + "environment": "prod" + } + } + +For more information, see `Tagging your API Gateway resources `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/get-vpc-link.rst awscli-1.18.69/awscli/examples/apigatewayv2/get-vpc-link.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/get-vpc-link.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/get-vpc-link.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,28 @@ +**To retrieve information about a VPC link** + +The following ``get-vpc-link`` example displays information about a VPC link. :: + + aws apigatewayv2 get-vpc-link \ + --vpc-link-id abcd123 + +Output:: + + { + "CreatedDate": "2020-04-07T00:27:47Z", + "Name": "MyVpcLink", + "SecurityGroupIds": [ + "sg1234", + "sg5678" + ], + "SubnetIds": [ + "subnet-aaaa", + "subnet-bbbb" + ], + "Tags": {}, + "VpcLinkId": "abcd123", + "VpcLinkStatus": "AVAILABLE", + "VpcLinkStatusMessage": "VPC link is ready to route traffic", + "VpcLinkVersion": "V2" + } + +For more information, see `Working with VPC links for HTTP APIs `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/get-vpc-links.rst awscli-1.18.69/awscli/examples/apigatewayv2/get-vpc-links.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/get-vpc-links.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/get-vpc-links.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,48 @@ +**To retrieve a list of VPC links** + +The following ``get-vpc-links`` example displays a list of all of the VPC links for the current user. :: + + aws apigatewayv2 get-vpc-links + +Output:: + + { + "Items": [ + { + "CreatedDate": "2020-04-07T00:27:47Z", + "Name": "MyVpcLink", + "SecurityGroupIds": [ + "sg1234", + "sg5678" + ], + "SubnetIds": [ + "subnet-aaaa", + "subnet-bbbb" + ], + "Tags": {}, + "VpcLinkId": "abcd123", + "VpcLinkStatus": "AVAILABLE", + "VpcLinkStatusMessage": "VPC link is ready to route traffic", + "VpcLinkVersion": "V2" + } + { + "CreatedDate": "2020-04-07T00:27:47Z", + "Name": "MyOtherVpcLink", + "SecurityGroupIds": [ + "sg1234", + "sg5678" + ], + "SubnetIds": [ + "subnet-aaaa", + "subnet-bbbb" + ], + "Tags": {}, + "VpcLinkId": "abcd456", + "VpcLinkStatus": "AVAILABLE", + "VpcLinkStatusMessage": "VPC link is ready to route traffic", + "VpcLinkVersion": "V2" + } + ] + } + +For more information, see `Working with VPC links for HTTP APIs `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/import-api.rst awscli-1.18.69/awscli/examples/apigatewayv2/import-api.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/import-api.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/import-api.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,38 @@ +**To import an HTTP API** + +The following ``import-api`` example creates an HTTP API from an OpenAPI 3.0 definition file named ``api-definition.yaml``. :: + + aws apigatewayv2 import-api \ + --body file://api-definition.yaml + +Contents of ``api-definition.yaml``:: + + openapi: 3.0.1 + info: + title: My Lambda API + version: v1.0 + paths: + /hello: + x-amazon-apigateway-any-method: + x-amazon-apigateway-integration: + payloadFormatVersion: 2.0 + type: aws_proxy + httpMethod: POST + uri: arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:hello/invocations + connectionType: INTERNET + +Output:: + + { + "ApiEndpoint": "https://a1b2c3d4.execute-api.us-west-2.amazonaws.com", + "ApiId": "a1b2c3d4", + "ApiKeySelectionExpression": "$request.header.x-api-key", + "CreatedDate": "2020-04-08T17:19:38+00:00", + "Name": "My Lambda API", + "ProtocolType": "HTTP", + "RouteSelectionExpression": "$request.method $request.path", + "Tags": {}, + "Version": "v1.0" + } + +For more information, see `Working with OpenAPI definitions for HTTP APIs `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/reimport-api.rst awscli-1.18.69/awscli/examples/apigatewayv2/reimport-api.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/reimport-api.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/reimport-api.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,39 @@ +**To reimport an HTTP API** + +The following ``reimport-api`` example updates an existing HTTP API to use the OpenAPI 3.0 definition specified in ``api-definition.yaml``. :: + + aws apigatewayv2 reimport-api \ + --body file://api-definition.yaml \ + --api-id a1b2c3d4 + +Contents of ``api-definition.yaml``:: + + openapi: 3.0.1 + info: + title: My Lambda API + version: v1.0 + paths: + /hello: + x-amazon-apigateway-any-method: + x-amazon-apigateway-integration: + payloadFormatVersion: 2.0 + type: aws_proxy + httpMethod: POST + uri: arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:12356789012:function:hello/invocations + connectionType: INTERNET + +Output:: + + { + "ApiEndpoint": "https://a1b2c3d4.execute-api.us-west-2.amazonaws.com", + "ApiId": "a1b2c3d4", + "ApiKeySelectionExpression": "$request.header.x-api-key", + "CreatedDate": "2020-04-08T17:19:38+00:00", + "Name": "My Lambda API", + "ProtocolType": "HTTP", + "RouteSelectionExpression": "$request.method $request.path", + "Tags": {}, + "Version": "v1.0" + } + +For more information, see `Working with OpenAPI definitions for HTTP APIs `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/tag-resource.rst awscli-1.18.69/awscli/examples/apigatewayv2/tag-resource.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/tag-resource.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,11 @@ +**To tag a resource** + +The following ``tag-resource`` example adds a tag with the key name ``Department`` and a value of ``Accounting`` to the specified API. :: + + aws apigatewayv2 tag-resource \ + --resource-arn arn:aws:apigateway:us-west-2::/apis/a1b2c3d4 \ + --tags Department=Accounting + +This command produces no output. + +For more information, see `Tagging your API Gateway resources `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/untag-resource.rst awscli-1.18.69/awscli/examples/apigatewayv2/untag-resource.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/untag-resource.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,11 @@ +**To remove tags from a resource** + +The following ``untag-resource`` example removes tags with the key names ``Project`` and ``Owner`` from the specified API. :: + + aws apigatewayv2 untag-resource \ + --resource-arn arn:aws:apigateway:us-west-2::/apis/a1b2c3d4 \ + --tag-keys Project Owner + +This command produces no output. + +For more information, see `Tagging your API Gateway resources `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/update-api-mapping.rst awscli-1.18.69/awscli/examples/apigatewayv2/update-api-mapping.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/update-api-mapping.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/update-api-mapping.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,21 @@ +**To update an API mapping** + +The following ``update-api-mapping`` example changes an API mapping for a custom domain name. As a result, the base URL using the custom domain name for the specified API and stage becomes ``https://api.example.com/dev``. :: + + aws apigatewayv2 update-api-mapping \ + --api-id a1b2c3d4 \ + --stage dev \ + --domain-name api.example.com \ + --api-mapping-id 0qzs2sy7bh \ + --api-mapping-key dev + +Output:: + + { + "ApiId": "a1b2c3d4", + "ApiMappingId": "0qzs2sy7bh", + "ApiMappingKey": "dev" + "Stage": "dev" + } + +For more information, see `Setting up a regional custom domain name in API Gateway `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/update-api.rst awscli-1.18.69/awscli/examples/apigatewayv2/update-api.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/update-api.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/update-api.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,37 @@ +**To enable CORS for an HTTP API** + +The following ``update-api`` example updates the specified API's CORS configuration to allow requests from ``https://www.example.com``. :: + + aws apigatewayv2 update-api \ + --api-id a1b2c3d4 \ + --cors-configuration AllowOrigins=https://www.example.com + +Output:: + + { + "ApiEndpoint": "https://a1b2c3d4.execute-api.us-west-2.amazonaws.com", + "ApiId": "a1b2c3d4", + "ApiKeySelectionExpression": "$request.header.x-api-key", + "CorsConfiguration": { + "AllowCredentials": false, + "AllowHeaders": [ + "header1", + "header2" + ], + "AllowMethods": [ + "GET", + "OPTIONS" + ], + "AllowOrigins": [ + "https://www.example.com" + ] + }, + "CreatedDate": "2020-04-08T18:39:37+00:00", + "Name": "my-http-api", + "ProtocolType": "HTTP", + "RouteSelectionExpression": "$request.method $request.path", + "Tags": {}, + "Version": "v1.0" + } + +For more information, see `Configuring CORS for an HTTP API `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/update-authorizer.rst awscli-1.18.69/awscli/examples/apigatewayv2/update-authorizer.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/update-authorizer.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/update-authorizer.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,27 @@ +**To update an authorizer** + +The following ``update-authorizer`` example changes a JWT authorizer's identity source to a header named ``Authorization``. :: + + aws apigatewayv2 update-authorizer \ + --api-id a1b2c3d4 \ + --authorizer-id a1b2c3 \ + --identity-source '$request.header.Authorization' + +Output:: + + { + "AuthorizerId": "a1b2c3", + "AuthorizerType": "JWT", + "IdentitySource": [ + "$request.header.Authorization" + ], + "JwtConfiguration": { + "Audience": [ + "123456abc" + ], + "Issuer": "https://cognito-idp.us-west-2.amazonaws.com/us-west-2_abc123" + }, + "Name": "my-jwt-authorizer" + } + +For more information, see `Controlling access to HTTP APIs with JWT authorizers `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/update-deployment.rst awscli-1.18.69/awscli/examples/apigatewayv2/update-deployment.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/update-deployment.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/update-deployment.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,20 @@ +**To change a deployment's description** + +The following ``update-deployment`` example updates a deployment's description. :: + + aws apigatewayv2 update-deployment \ + --api-id a1b2c3d4 \ + --deployment-id abcdef \ + --description 'Manual deployment to fix integration test failures.' + +Output:: + + { + "AutoDeployed": false, + "CreatedDate": "2020-02-05T16:21:48+00:00", + "DeploymentId": "abcdef", + "DeploymentStatus": "DEPLOYED", + "Description": "Manual deployment to fix integration test failures." + } + +For more information, see `Developing an HTTP API in API Gateway `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/update-domain-name.rst awscli-1.18.69/awscli/examples/apigatewayv2/update-domain-name.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/update-domain-name.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/update-domain-name.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,26 @@ +**To update a custom domain name** + +The following ``update-domain-name`` example specifies a new ACM certificate for the ``api.example.com`` custom domain name. :: + + aws apigatewayv2 update-domain-name \ + --domain-name api.example.com \ + --domain-name-configurations CertificateArn=arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678 + +Output:: + + { + "ApiMappingSelectionExpression": "$request.basepath", + "DomainName": "regional.example.com", + "DomainNameConfigurations": [ + { + "ApiGatewayDomainName": "d-id.execute-api.us-west-2.amazonaws.com", + "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678", + "EndpointType": "REGIONAL", + "HostedZoneId": "123456789111", + "SecurityPolicy": "TLS_1_2", + "DomainNameStatus": "AVAILABLE" + } + ] + } + +For more information, see `Setting up a regional custom domain name in API Gateway `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/update-integration.rst awscli-1.18.69/awscli/examples/apigatewayv2/update-integration.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/update-integration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/update-integration.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,22 @@ +**To update a Lambda integration** + +The following ``update-integration`` example updates an existing AWS Lambda integration to use the specified Lambda function. :: + + aws apigatewayv2 update-integration \ + --api-id a1b2c3d4 \ + --integration-id a1b2c3 \ + --integration-uri arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:my-new-function/invocations + +Output:: + + { + "ConnectionType": "INTERNET", + "IntegrationId": "a1b2c3", + "IntegrationMethod": "POST", + "IntegrationType": "AWS_PROXY", + "IntegrationUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:my-new-function/invocations", + "PayloadFormatVersion": "2.0", + "TimeoutInMillis": 5000 + } + +For more information, see `Configuring integrations for HTTP APIs `__ and `Setting up WebSocket API integrations `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/update-route.rst awscli-1.18.69/awscli/examples/apigatewayv2/update-route.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/update-route.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/update-route.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,29 @@ +**To add an authorizer to a route** + +The following ``update-route`` example updates the specified route to use a JWT authorizer. :: + + aws apigatewayv2 update-route \ + --api-id a1b2c3d4 \ + --route-id a1b2c3 \ + --authorization-type JWT \ + --authorizer-id a1b2c5 \ + --authorization-scopes user.id user.email + +Output:: + + { + "ApiKeyRequired": false, + "AuthorizationScopes": [ + "user.id", + "user.email" + ], + "AuthorizationType": "JWT", + "AuthorizerId": "a1b2c5", + "OperationName": "GET HTTP", + "RequestParameters": {}, + "RouteId": "a1b2c3", + "RouteKey": "GET /pets", + "Target": "integrations/a1b2c6" + } + +For more information, see `Controlling access to HTTP APIs with JWT authorizers `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/update-stage.rst awscli-1.18.69/awscli/examples/apigatewayv2/update-stage.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/update-stage.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/update-stage.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,30 @@ +**To configure custom throttling** + +The following ``update-stage`` example configures custom throttling for the specified stage and route of an API. :: + + aws apigatewayv2 update-stage \ + --api-id a1b2c3d4 \ + --stage-name dev \ + --route-settings '{"GET /pets":{"ThrottlingBurstLimit":100,"ThrottlingRateLimit":2000}}' + +Output:: + + { + "CreatedDate": "2020-04-05T16:21:16+00:00", + "DefaultRouteSettings": { + "DetailedMetricsEnabled": false + }, + "DeploymentId": "shktxb", + "LastUpdatedDate": "2020-04-08T22:23:17+00:00", + "RouteSettings": { + "GET /pets": { + "ThrottlingBurstLimit": 100, + "ThrottlingRateLimit": 2000.0 + } + }, + "StageName": "dev", + "StageVariables": {}, + "Tags": {} + } + +For more information, see `Protecting your HTTP API `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/apigatewayv2/update-vpc-link.rst awscli-1.18.69/awscli/examples/apigatewayv2/update-vpc-link.rst --- awscli-1.11.13/awscli/examples/apigatewayv2/update-vpc-link.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/apigatewayv2/update-vpc-link.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,29 @@ +**To update a VPC link** + +The following ``update-vpc-link`` example updates the name of a VPC link. After you've created a VPC link, you can't change its security groups or subnets. :: + + aws apigatewayv2 update-vpc-link \ + --vpc-link-id abcd123 \ + --name MyUpdatedVpcLink + +Output:: + + { + "CreatedDate": "2020-04-07T00:27:47Z", + "Name": "MyUpdatedVpcLink", + "SecurityGroupIds": [ + "sg1234", + "sg5678" + ], + "SubnetIds": [ + "subnet-aaaa", + "subnet-bbbb" + ], + "Tags": {}, + "VpcLinkId": "abcd123", + "VpcLinkStatus": "AVAILABLE", + "VpcLinkStatusMessage": "VPC link is ready to route traffic", + "VpcLinkVersion": "V2" + } + +For more information, see `Working with VPC links for HTTP APIs `__ in the *Amazon API Gateway Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/appconfig/get-configuration.rst awscli-1.18.69/awscli/examples/appconfig/get-configuration.rst --- awscli-1.11.13/awscli/examples/appconfig/get-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/appconfig/get-configuration.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To list the AppConfig applications in your AWS account** + +This ``get-configuration`` example lists the applications in your account in the current Region. :: + + aws appconfig get-configuration \ + --application abc1234 \ + --environment 9x8y7z6 \ + --configuration 9sd1ukd \ + --client-id any-id \ + outfile > my-file-name + +Output:: + + { + "ConfigurationVersion": "2", + "ContentType": "application/octet-stream" + } + +For more information, see `Retrieving the Configuration `__ in the *AWS Systems Manager User Guide*. diff -Nru awscli-1.11.13/awscli/examples/appconfig/list-applications.rst awscli-1.18.69/awscli/examples/appconfig/list-applications.rst --- awscli-1.11.13/awscli/examples/appconfig/list-applications.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/appconfig/list-applications.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To list the AppConfig applications in your AWS account** + +This ``list-applications`` example lists the applications in your account in the current Region. :: + + aws appconfig list-applications + +Output:: + + { + "Items": [ + { + "Description": "My first AppConfig application", + "Id": "abc1234", + "Name": "MyTestApp" + } + ] + } + +For more information, see `Create an AppConfig Application `__ in the *AWS Systems Manager User Guide*. diff -Nru awscli-1.11.13/awscli/examples/appconfig/list-configuration-profiles.rst awscli-1.18.69/awscli/examples/appconfig/list-configuration-profiles.rst --- awscli-1.11.13/awscli/examples/appconfig/list-configuration-profiles.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/appconfig/list-configuration-profiles.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,33 @@ +**To list the configuration profiles for an AppConfig application** + +This ``list-configuration-profiles`` example lists the configuration profiles for an application. :: + + aws appconfig list-configuration-profiles \ + --application-id abc1234 + +Output:: + + { + "Items": [ + { + "ValidatorTypes": [ + "JSON_SCHEMA" + ], + "ApplicationId": "abc1234", + "Id": "9x8y7z6", + "LocationUri": "ssm-parameter:///blogapp/featureX_switch", + "Name": "TestConfigurationProfile" + }, + { + "ValidatorTypes": [ + "JSON_SCHEMA" + ], + "ApplicationId": "abc1234", + "Id": "hijklmn", + "LocationUri": "ssm-parameter:///testapp/featureX_switch", + "Name": "TestAppConfigurationProfile" + } + ] + } + +For more information, see `Create a Configuration and a Configuration Profile `__ in the *AWS Systems Manager User Guide*. diff -Nru awscli-1.11.13/awscli/examples/appconfig/list-environments.rst awscli-1.18.69/awscli/examples/appconfig/list-environments.rst --- awscli-1.11.13/awscli/examples/appconfig/list-environments.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/appconfig/list-environments.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,23 @@ +**To list environments for an AppConfig application** + +This ``list-environments`` example lists the environments that exist for an application. :: + + aws appconfig list-environments \ + --application-id abc1234 + +Output:: + + { + "Items": [ + { + "Description": "My AppConfig environment", + "Id": "2d4e6f8", + "State": "ReadyForDeployment", + "ApplicationId": "abc1234", + "Monitors": [], + "Name": "TestEnvironment" + } + ] + } + +For more information, see `Create an Environment `__ in the *AWS Systems Manager User Guide*. diff -Nru awscli-1.11.13/awscli/examples/application-autoscaling/delete-scheduled-action.rst awscli-1.18.69/awscli/examples/application-autoscaling/delete-scheduled-action.rst --- awscli-1.11.13/awscli/examples/application-autoscaling/delete-scheduled-action.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/application-autoscaling/delete-scheduled-action.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,13 @@ +**To delete a scheduled action** + +The follwing ``delete-scheduled-action`` example deletes the specified scheduled action from the specified Amazon AppStream 2.0 fleet:: + + aws application-autoscaling delete-scheduled-action \ + --service-namespace appstream \ + --scalable-dimension appstream:fleet:DesiredCapacity \ + --resource-id fleet/sample-fleet \ + --scheduled-action-name my-recurring-action + +This command produces no output. + +For more information, see `Scheduled Scaling `__ in the *Application Auto Scaling User Guide*. diff -Nru awscli-1.11.13/awscli/examples/application-autoscaling/deregister-scalable-target.rst awscli-1.18.69/awscli/examples/application-autoscaling/deregister-scalable-target.rst --- awscli-1.11.13/awscli/examples/application-autoscaling/deregister-scalable-target.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/application-autoscaling/deregister-scalable-target.rst 2020-05-28 19:25:48.000000000 +0000 @@ -5,3 +5,13 @@ Command:: aws application-autoscaling deregister-scalable-target --service-namespace ecs --scalable-dimension ecs:service:DesiredCount --resource-id service/default/web-app + +This example deregisters a scalable target for a custom resource. The custom-resource-id.txt file contains a string that identifies the Resource ID, which, for a custom resource, is the path to the custom resource through your Amazon API Gateway endpoint. + +Command:: + + aws application-autoscaling deregister-scalable-target --service-namespace custom-resource --scalable-dimension custom-resource:ResourceType:Property --resource-id file://~/custom-resource-id.txt + +Contents of custom-resource-id.txt file:: + + https://example.execute-api.us-west-2.amazonaws.com/prod/scalableTargetDimensions/1-23456789 diff -Nru awscli-1.11.13/awscli/examples/application-autoscaling/describe-scalable-targets.rst awscli-1.18.69/awscli/examples/application-autoscaling/describe-scalable-targets.rst --- awscli-1.11.13/awscli/examples/application-autoscaling/describe-scalable-targets.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/application-autoscaling/describe-scalable-targets.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,23 +1,29 @@ **To describe scalable targets** -This example command describes the scalable targets for the `ecs` service namespace. +The following ``describe-scalable-targets`` example command displays details for the the scalable targets for the ``ecs`` service namespace:: -Command:: - - aws application-autoscaling describe-scalable-targets --service-namespace ecs + aws application-autoscaling describe-scalable-targets \ + --service-namespace ecs Output:: - { - "ScalableTargets": [ - { - "ScalableDimension": "ecs:service:DesiredCount", - "ResourceId": "service/default/web-app", - "RoleARN": "arn:aws:iam::012345678910:role/ApplicationAutoscalingECSRole", - "CreationTime": 1462558906.199, - "MinCapacity": 1, - "ServiceNamespace": "ecs", - "MaxCapacity": 10 - } - ] - } + { + "ScalableTargets": [ + { + "ScalableDimension": "ecs:service:DesiredCount", + "ResourceId": "service/default/web-app", + "RoleARN": "arn:aws:iam::123456789012:role/ApplicationAutoscalingECSRole", + "SuspendedState": { + "DynamicScalingOutSuspended": false, + "ScheduledScalingSuspended": false, + "DynamicScalingInSuspended": false + }, + "CreationTime": 1462558906.199, + "MinCapacity": 1, + "ServiceNamespace": "ecs", + "MaxCapacity": 10 + } + ] + } + +For more information, see `What Is Application Auto Scaling? `__ in the *Application Auto Scaling User Guide*. diff -Nru awscli-1.11.13/awscli/examples/application-autoscaling/describe-scaling-activities.rst awscli-1.18.69/awscli/examples/application-autoscaling/describe-scaling-activities.rst --- awscli-1.11.13/awscli/examples/application-autoscaling/describe-scaling-activities.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/application-autoscaling/describe-scaling-activities.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,26 +1,91 @@ -**To describe scaling activities for a scalable target** +**Example 1: To describe scaling activities for a scalable target** -This example describes the scaling activities for an Amazon ECS service called `web-app` that is running in the `default` cluster. +The following ``describe-scaling-activities`` example displays details for th the scaling activities for an Amazon ECS service called `web-app` that is running in the `default` cluster. :: -Command:: + aws application-autoscaling describe-scaling-activities \ + --service-namespace ecs \ + --scalable-dimension ecs:service:DesiredCount \ + --resource-id service/default/web-app - aws application-autoscaling describe-scaling-activities --service-namespace ecs --scalable-dimension ecs:service:DesiredCount --resource-id service/default/web-app +Output:: + + { + "ScalingActivities": [ + { + "ScalableDimension": "ecs:service:DesiredCount", + "Description": "Setting desired count to 1.", + "ResourceId": "service/default/web-app", + "ActivityId": "e6c5f7d1-dbbb-4a3f-89b2-51f33e766399", + "StartTime": 1462575838.171, + "ServiceNamespace": "ecs", + "EndTime": 1462575872.111, + "Cause": "monitor alarm web-app-cpu-lt-25 in state ALARM triggered policy web-app-cpu-lt-25", + "StatusMessage": "Successfully set desired count to 1. Change successfully fulfilled by ecs.", + "StatusCode": "Successful" + } + ] + } + +**Example 2: To describe scaling activities triggered by scheduled actions** + +The following ``describe-scaling-activities`` example describes the scaling activities for the specified DynamoDB table. The output shows scaling activities triggered by two different scheduled actions:: + + aws application-autoscaling describe-scaling-activities \ + --service-namespace dynamodb \ + --scalable-dimension dynamodb:table:WriteCapacityUnits \ + --resource-id table/my-table Output:: - { - "ScalingActivities": [ - { - "ScalableDimension": "ecs:service:DesiredCount", - "Description": "Setting desired count to 1.", - "ResourceId": "service/default/web-app", - "ActivityId": "e6c5f7d1-dbbb-4a3f-89b2-51f33e766399", - "StartTime": 1462575838.171, - "ServiceNamespace": "ecs", - "EndTime": 1462575872.111, - "Cause": "monitor alarm web-app-cpu-lt-25 in state ALARM triggered policy web-app-cpu-lt-25", - "StatusMessage": "Successfully set desired count to 1. Change successfully fulfilled by ecs.", - "StatusCode": "Successful" - } - ] - } \ No newline at end of file + { + "ScalingActivities": [ + { + "ScalableDimension": "dynamodb:table:WriteCapacityUnits", + "Description": "Setting write capacity units to 10.", + "ResourceId": "table/my-table", + "ActivityId": "4d1308c0-bbcf-4514-a673-b0220ae38547", + "StartTime": 1561574415.086, + "ServiceNamespace": "dynamodb", + "EndTime": 1561574449.51, + "Cause": "maximum capacity was set to 10", + "StatusMessage": "Successfully set write capacity units to 10. Change successfully fulfilled by dynamodb.", + "StatusCode": "Successful" + }, + { + "ScalableDimension": "dynamodb:table:WriteCapacityUnits", + "Description": "Setting min capacity to 5 and max capacity to 10", + "ResourceId": "table/my-table", + "ActivityId": "f2b7847b-721d-4e01-8ef0-0c8d3bacc1c7", + "StartTime": 1561574414.644, + "ServiceNamespace": "dynamodb", + "Cause": "scheduled action name my-second-scheduled-action was triggered", + "StatusMessage": "Successfully set min capacity to 5 and max capacity to 10", + "StatusCode": "Successful" + }, + { + "ScalableDimension": "dynamodb:table:WriteCapacityUnits", + "Description": "Setting write capacity units to 15.", + "ResourceId": "table/my-table", + "ActivityId": "d8ea4de6-9eaa-499f-b466-2cc5e681ba8b", + "StartTime": 1561574108.904, + "ServiceNamespace": "dynamodb", + "EndTime": 1561574140.255, + "Cause": "minimum capacity was set to 15", + "StatusMessage": "Successfully set write capacity units to 15. Change successfully fulfilled by dynamodb.", + "StatusCode": "Successful" + }, + { + "ScalableDimension": "dynamodb:table:WriteCapacityUnits", + "Description": "Setting min capacity to 15 and max capacity to 20", + "ResourceId": "table/my-table", + "ActivityId": "3250fd06-6940-4e8e-bb1f-d494db7554d2", + "StartTime": 1561574108.512, + "ServiceNamespace": "dynamodb", + "Cause": "scheduled action name my-first-scheduled-action was triggered", + "StatusMessage": "Successfully set min capacity to 15 and max capacity to 20", + "StatusCode": "Successful" + } + ] + } + +For more information, see `Scheduled Scaling `__ in the *Application Auto Scaling User Guide*. diff -Nru awscli-1.11.13/awscli/examples/application-autoscaling/describe-scheduled-actions.rst awscli-1.18.69/awscli/examples/application-autoscaling/describe-scheduled-actions.rst --- awscli-1.11.13/awscli/examples/application-autoscaling/describe-scheduled-actions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/application-autoscaling/describe-scheduled-actions.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,41 @@ +**To describe scheduled actions** + +The following ``describe-scheduled-actions`` example displays details for the scheduled actions for the specified service namespace:: + + aws application-autoscaling describe-scheduled-actions \ + --service-namespace dynamodb + +Output:: + + { + "ScheduledActions": [ + { + "ScalableDimension": "dynamodb:table:WriteCapacityUnits", + "Schedule": "at(2019-05-20T18:35:00)", + "ResourceId": "table/my-table", + "CreationTime": 1561571888.361, + "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledAction:2d36aa3b-cdf9-4565-b290-81db519b227d:resource/dynamodb/table/my-table:scheduledActionName/my-first-scheduled-action", + "ScalableTargetAction": { + "MinCapacity": 15, + "MaxCapacity": 20 + }, + "ScheduledActionName": "my-first-scheduled-action", + "ServiceNamespace": "dynamodb" + }, + { + "ScalableDimension": "dynamodb:table:WriteCapacityUnits", + "Schedule": "at(2019-05-20T18:40:00)", + "ResourceId": "table/my-table", + "CreationTime": 1561571946.021, + "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledAction:2d36aa3b-cdf9-4565-b290-81db519b227d:resource/dynamodb/table/my-table:scheduledActionName/my-second-scheduled-action", + "ScalableTargetAction": { + "MinCapacity": 5, + "MaxCapacity": 10 + }, + "ScheduledActionName": "my-second-scheduled-action", + "ServiceNamespace": "dynamodb" + } + ] + } + +For more information, see `Scheduled Scaling `__ in the *Application Auto Scaling User Guide*. diff -Nru awscli-1.11.13/awscli/examples/application-autoscaling/put-scaling-policy.rst awscli-1.18.69/awscli/examples/application-autoscaling/put-scaling-policy.rst --- awscli-1.11.13/awscli/examples/application-autoscaling/put-scaling-policy.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/application-autoscaling/put-scaling-policy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,33 +1,122 @@ -**To apply a scaling policy to an Amazon ECS service** +**Example 1: To apply a target tracking scaling policy with a predefined metric specification** -This example command applies a scaling policy to an Amazon ECS service called `web-app` in the `default` cluster. The policy increases the desired count of the service by 200%, with a cool down period of 60 seconds. +The following ``put-scaling-policy`` example applies a target tracking scaling policy with a predefined metric specification to an Amazon ECS service called web-app in the default cluster. The policy keeps the average CPU utilization of the service at 75 percent, with scale-out and scale-in cooldown periods of 60 seconds. The output contains the ARNs and names of the two CloudWatch alarms created on your behalf. :: -Command:: + aws application-autoscaling put-scaling-policy --service-namespace ecs \ + --scalable-dimension ecs:service:DesiredCount \ + --resource-id service/default/web-app \ + --policy-name cpu75-target-tracking-scaling-policy --policy-type TargetTrackingScaling \ + --target-tracking-scaling-policy-configuration file://config.json + +This example assumes that you have a `config.json` file in the current directory with the following contents:: + + { + "TargetValue": 75.0, + "PredefinedMetricSpecification": { + "PredefinedMetricType": "ECSServiceAverageCPUUtilization" + }, + "ScaleOutCooldown": 60, + "ScaleInCooldown": 60 + } - aws application-autoscaling put-scaling-policy --cli-input-json file://scale-out.json +Output:: -Contents of `scale-out.json` file:: - - { - "PolicyName": "web-app-cpu-gt-75", - "ServiceNamespace": "ecs", - "ResourceId": "service/default/web-app", - "ScalableDimension": "ecs:service:DesiredCount", - "PolicyType": "StepScaling", - "StepScalingPolicyConfiguration": { - "AdjustmentType": "PercentChangeInCapacity", - "StepAdjustments": [ - { - "MetricIntervalLowerBound": 0, - "ScalingAdjustment": 200 - } - ], - "Cooldown": 60 - } - } + { + "PolicyARN": "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/cpu75-target-tracking-scaling-policy", + "Alarms": [ + { + "AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:TargetTracking-service/default/web-app-AlarmHigh-d4f0770c-b46e-434a-a60f-3b36d653feca", + "AlarmName": "TargetTracking-service/default/web-app-AlarmHigh-d4f0770c-b46e-434a-a60f-3b36d653feca" + }, + { + "AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:TargetTracking-service/default/web-app-AlarmLow-1b437334-d19b-4a63-a812-6c67aaf2910d", + "AlarmName": "TargetTracking-service/default/web-app-AlarmLow-1b437334-d19b-4a63-a812-6c67aaf2910d" + } + ] + } + +**Example 2: To apply a target tracking scaling policy with a customized metric specification** + +The following ``put-scaling-policy`` example applies a target tracking scaling policy with a customized metric specification to an Amazon ECS service called web-app in the default cluster. The policy keeps the average utilization of the service at 75 percent, with scale-out and scale-in cooldown periods of 60 seconds. The output contains the ARNs and names of the two CloudWatch alarms created on your behalf. :: + + aws application-autoscaling put-scaling-policy --service-namespace ecs \ + --scalable-dimension ecs:service:DesiredCount \ + --resource-id service/default/web-app \ + --policy-name cms75-target-tracking-scaling-policy + --policy-type TargetTrackingScaling \ + --target-tracking-scaling-policy-configuration file://config.json + +This example assumes that you have a `config.json` file in the current directory with the following contents:: + + { + "TargetValue":75.0, + "CustomizedMetricSpecification":{ + "MetricName":"MyUtilizationMetric", + "Namespace":"MyNamespace", + "Dimensions": [ + { + "Name":"MyOptionalMetricDimensionName", + "Value":"MyOptionalMetricDimensionValue" + } + ], + "Statistic":"Average", + "Unit":"Percent" + }, + "ScaleOutCooldown": 60, + "ScaleInCooldown": 60 + } Output:: - { - "PolicyARN": "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/web-app-cpu-gt-75" - } + { + "PolicyARN": "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy: 8784a896-b2ba-47a1-b08c-27301cc499a1:resource/ecs/service/default/web-app:policyName/cms75-target-tracking-scaling-policy", + "Alarms": [ + { + "AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:TargetTracking-service/default/web-app-AlarmHigh-9bc77b56-0571-4276-ba0f-d4178882e0a0", + "AlarmName": "TargetTracking-service/default/web-app-AlarmHigh-9bc77b56-0571-4276-ba0f-d4178882e0a0" + }, + { + "AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:TargetTracking-service/default/web-app-AlarmLow-9b6ad934-6d37-438e-9e05-02836ddcbdc4", + "AlarmName": "TargetTracking-service/default/web-app-AlarmLow-9b6ad934-6d37-438e-9e05-02836ddcbdc4" + } + ] + } + +**Example 3: To apply a target tracking scaling policy for scale out only** + +The following ``put-scaling-policy`` example applies a target tracking scaling policy to an Amazon ECS service called ``web-app`` in the default cluster. The policy is used to scale out the ECS service when the ``RequestCountPerTarget`` metric from the Application Load Balancer exceeds the threshold. The output contains the ARN and name of the CloudWatch alarm created on your behalf. :: + + aws application-autoscaling put-scaling-policy \ + --service-namespace ecs \ + --scalable-dimension ecs:service:DesiredCount \ + --resource-id service/default/web-app \ + --policy-name alb-scale-out-target-tracking-scaling-policy \ + --policy-type TargetTrackingScaling \ + --target-tracking-scaling-policy-configuration file://config.json + +Contents of ``config.json``:: + + { + "TargetValue": 1000.0, + "PredefinedMetricSpecification": { + "PredefinedMetricType": "ALBRequestCountPerTarget", + "ResourceLabel": "app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d" + }, + "ScaleOutCooldown": 60, + "ScaleInCooldown": 60, + "DisableScaleIn": true + } + +Output:: + + { + "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/alb-scale-out-target-tracking-scaling-policy", + "Alarms": [ + { + "AlarmName": "TargetTracking-service/default/web-app-AlarmHigh-d4f0770c-b46e-434a-a60f-3b36d653feca", + "AlarmARN": "arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-service/default/web-app-AlarmHigh-d4f0770c-b46e-434a-a60f-3b36d653feca" + } + ] + } + +For more information, see `Target Tracking Scaling Policies for Application Auto Scaling `_ in the *AWS Application Auto Scaling User Guide*. diff -Nru awscli-1.11.13/awscli/examples/application-autoscaling/put-scheduled-action.rst awscli-1.18.69/awscli/examples/application-autoscaling/put-scheduled-action.rst --- awscli-1.11.13/awscli/examples/application-autoscaling/put-scheduled-action.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/application-autoscaling/put-scheduled-action.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To add a scheduled action to a DynamoDB table** + +This example adds a scheduled action to a DynamoDB table called `TestTable` to scale out on a recurring schedule. On the specified schedule (every day at 12:15pm UTC), if the current capacity is below the value specified for MinCapacity, Application Auto Scaling scales out to the value specified by MinCapacity. + +Command:: + + aws application-autoscaling put-scheduled-action --service-namespace dynamodb --scheduled-action-name my-recurring-action --schedule "cron(15 12 * * ? *)" --resource-id table/TestTable --scalable-dimension dynamodb:table:WriteCapacityUnits --scalable-target-action MinCapacity=6 + +For more information, see `Scheduled Scaling`_ in the *Application Auto Scaling User Guide*. + +.. _`Scheduled Scaling`: https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scheduled-scaling.html diff -Nru awscli-1.11.13/awscli/examples/application-autoscaling/register-scalable-target.rst awscli-1.18.69/awscli/examples/application-autoscaling/register-scalable-target.rst --- awscli-1.11.13/awscli/examples/application-autoscaling/register-scalable-target.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/application-autoscaling/register-scalable-target.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,21 +1,115 @@ -**To register a new scalable target** +**Example 1: To register a new scalable target for Amazon ECS** -This example command registers a scalable target from an Amazon ECS service called `web-app` that is running on the `default` cluster, with a minimum desired count of 1 task and a maximum desired count of 10 tasks. +The following ``register-scalable-target`` example registers a scalable target for an Amazon ECS service called web-app, running on the default cluster, with a minimum desired count of 1 task and a maximum desired count of 10 tasks. :: -Command:: + aws application-autoscaling register-scalable-target \ + --service-namespace ecs \ + --scalable-dimension ecs:service:DesiredCount \ + --resource-id service/default/web-app \ + --min-capacity 1 \ + --max-capacity 10 - aws application-autoscaling register-scalable-target --resource-id service/default/web-app --service-namespace ecs --scalable-dimension ecs:service:DesiredCount --min-capacity 1 --max-capacity 10 --role-arn arn:aws:iam::012345678910:role/ApplicationAutoscalingECSRole +**Example 2: To register a new scalable target for a Spot Fleet** -Output:: - - { - "cluster": { - "status": "ACTIVE", - "clusterName": "my_cluster", - "registeredContainerInstancesCount": 0, - "pendingTasksCount": 0, - "runningTasksCount": 0, - "activeServicesCount": 0, - "clusterArn": "arn:aws:ecs:::cluster/my_cluster" - } - } +The following ``register-scalable-target`` example registers the target capacity of an Amazon EC2 Spot Fleet request using its request ID, with a minimum capacity of 2 instances and a maximum capacity of 10 instances. :: + + aws application-autoscaling register-scalable-target \ + --service-namespace ec2 \ + --scalable-dimension ec2:spot-fleet-request:TargetCapacity \ + --resource-id spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE \ + --min-capacity 2 \ + --max-capacity 10 + +**Example 3: To register a new scalable target for AppStream 2.0** + +The following ``register-scalable-target`` example registers the desired capacity of an AppStream 2.0 fleet called sample-fleet, with a minimum capacity of 1 fleet instance and a maximum capacity of 5 fleet instances. :: + + aws application-autoscaling register-scalable-target \ + --service-namespace appstream \ + --scalable-dimension appstream:fleet:DesiredCapacity \ + --resource-id fleet/sample-fleet \ + --min-capacity 1 \ + --max-capacity 5 + +**Example 4: To register a new scalable target for a DynamoDB table** + +The following ``register-scalable-target`` example registers the provisioned write capacity of a DynamoDB table called my-table, with a minimum capacity of 5 write capacity units and a maximum capacity of 10 write capacity units. :: + + aws application-autoscaling register-scalable-target \ + --service-namespace dynamodb \ + --scalable-dimension dynamodb:table:WriteCapacityUnits \ + --resource-id table/my-table \ + --min-capacity 5 \ + --max-capacity 10 + +**Example 5: To register a new scalable target for a DynamoDB global secondary index** + +The following ``register-scalable-target`` example registers the provisioned write capacity of a DynamoDB global secondary index called my-table-index, with a minimum capacity of 5 write capacity units and a maximum capacity of 10 write capacity units. :: + + aws application-autoscaling register-scalable-target \ + --service-namespace dynamodb \ + --scalable-dimension dynamodb:index:WriteCapacityUnits \ + --resource-id table/my-table/index/my-table-index \ + --min-capacity 5 \ + --max-capacity 10 + +**Example 6: To register a new scalable target for Aurora DB** + +The following ``register-scalable-target`` example registers the count of Aurora Replicas in an Aurora DB cluster called my-db-cluster, with a minimum capacity of 1 Aurora Replica and a maximum capacity of 8 Aurora Replicas. :: + + aws application-autoscaling register-scalable-target \ + --service-namespace rds \ + --scalable-dimension rds:cluster:ReadReplicaCount \ + --resource-id cluster:my-db-cluster \ + --min-capacity 1 \ + --max-capacity 8 + +**Example 7: To register a new scalable target for Amazon Sagemaker** + +The following ``register-scalable-target`` example registers the desired EC2 instance count for an Amazon Sagemaker product variant called my-variant, running on the my-endpoint endpoint, with a minimum capacity of 1 instance and a maximum capacity of 8 instances. :: + + aws application-autoscaling register-scalable-target \ + --service-namespace sagemaker \ + --scalable-dimension sagemaker:variant:DesiredInstanceCount \ + --resource-id endpoint/my-endpoint/variant/my-variant \ + --min-capacity 1 \ + --max-capacity 8 + +**Example 8: To register a new scalable target for a custom resource** + +The following ``register-scalable-target`` example registers a custom resource as a scalable target, with a minimum desired count of 1 capacity unit and a maximum desired count of 10 capacity units. The ``custom-resource-id.txt`` file contains a string that identifies the Resource ID, which for a custom resource is the path to the custom resource through your Amazon API Gateway endpoint. :: + + aws application-autoscaling register-scalable-target \ + --service-namespace custom-resource \ + --scalable-dimension custom-resource:ResourceType:Property \ + --resource-id file://~/custom-resource-id.txt \ + --min-capacity 1 \ + --max-capacity 10 + +Contents of ``custom-resource-id.txt``:: + + 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.11.13/awscli/examples/appmesh/create-mesh.rst awscli-1.18.69/awscli/examples/appmesh/create-mesh.rst --- awscli-1.11.13/awscli/examples/appmesh/create-mesh.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/appmesh/create-mesh.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,54 @@ +**Example 1: To create a new service mesh** + +The following ``create-mesh`` example creates a service mesh. :: + + aws appmesh create-mesh \ + --mesh-name app1 + +Output:: + + { + "mesh":{ + "meshName":"app1", + "metadata":{ + "arn":"arn:aws:appmesh:us-east-1:123456789012:mesh/app1", + "createdAt":1563809909.282, + "lastUpdatedAt":1563809909.282, + "uid":"a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version":1 + }, + "spec":{}, + "status":{ + "status":"ACTIVE" + } + } + } + +**Example 2: To create a new service mesh with multiple tags** + +The following ``create-mesh`` example creates a service mesh with multiple tags. :: + + aws appmesh create-mesh \ + --mesh-name app2 \ + --tags key=key1,value=value1 key=key2,value=value2 key=key3,value=value3 + +Output:: + + { + "mesh":{ + "meshName":"app2", + "metadata":{ + "arn":"arn:aws:appmesh:us-east-1:123456789012:mesh/app2", + "createdAt":1563822121.877, + "lastUpdatedAt":1563822121.877, + "uid":"a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version":1 + }, + "spec":{}, + "status":{ + "status":"ACTIVE" + } + } + } + +For more information, see `Service Meshes `__ in the *AWS App Mesh User Guide*. diff -Nru awscli-1.11.13/awscli/examples/appmesh/create-route.rst awscli-1.18.69/awscli/examples/appmesh/create-route.rst --- awscli-1.11.13/awscli/examples/appmesh/create-route.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/appmesh/create-route.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,301 @@ +**To create a new gRPC route** + +The following ``create-route`` example uses a JSON input file to create a gRPC route. GRPC traffic that has metadata that starts with 123 is routed to a virtual node named serviceBgrpc. If there are specific gRPC, HTTP, or TCP failures when attempting to communicate with the target of the route, the route is retried three times. There is a 15 second delay between each retry attempt. :: + + aws appmesh create-route \ + --cli-input-json file://create-route-grpc.json + +Contents of ``create-route-grpc.json``:: + + { + "meshName" : "apps", + "routeName" : "grpcRoute", + "spec" : { + "grpcRoute" : { + "action" : { + "weightedTargets" : [ + { + "virtualNode" : "serviceBgrpc", + "weight" : 100 + } + ] + }, + "match" : { + "metadata" : [ + { + "invert" : false, + "match" : { + "prefix" : "123" + }, + "name" : "myMetadata" + } + ], + "methodName" : "GetColor", + "serviceName" : "com.amazonaws.services.ColorService" + }, + "retryPolicy" : { + "grpcRetryEvents" : [ "deadline-exceeded" ], + "httpRetryEvents" : [ "server-error", "gateway-error" ], + "maxRetries" : 3, + "perRetryTimeout" : { + "unit" : "s", + "value" : 15 + }, + "tcpRetryEvents" : [ "connection-error" ] + } + }, + "priority" : 100 + }, + "virtualRouterName" : "serviceBgrpc" + } + +Output:: + + { + "route": { + "meshName": "apps", + "metadata": { + "arn": "arn:aws:appmesh:us-west-2:123456789012:mesh/apps/virtualRouter/serviceBgrpc/route/grpcRoute", + "createdAt": 1572010806.008, + "lastUpdatedAt": 1572010806.008, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 1 + }, + "routeName": "grpcRoute", + "spec": { + "grpcRoute": { + "action": { + "weightedTargets": [ + { + "virtualNode": "serviceBgrpc", + "weight": 100 + } + ] + }, + "match": { + "metadata": [ + { + "invert": false, + "match": { + "prefix": "123" + }, + "name": "mymetadata" + } + ], + "methodName": "GetColor", + "serviceName": "com.amazonaws.services.ColorService" + }, + "retryPolicy": { + "grpcRetryEvents": [ + "deadline-exceeded" + ], + "httpRetryEvents": [ + "server-error", + "gateway-error" + ], + "maxRetries": 3, + "perRetryTimeout": { + "unit": "s", + "value": 15 + }, + "tcpRetryEvents": [ + "connection-error" + ] + } + }, + "priority": 100 + }, + "status": { + "status": "ACTIVE" + }, + "virtualRouterName": "serviceBgrpc" + } + } + +**To create a new HTTP or HTTP/2 route** + +The following ``create-route`` example uses a JSON input file to create an HTTP/2 route. To create an HTTP route, replace http2Route with httpRoute under spec. All HTTP/2 traffic addressed to any URL prefix that has a header value that starts with 123 is routed to a virtual node named serviceBhttp2. If there are specific HTTP or TCP failures when attempting to communicate with the target of the route, the route is retried three times. There is a 15 second delay between each retry attempt. :: + + aws appmesh create-route \ + --cli-input-json file://create-route-http2.json + +Contents of ``create-route-http2.json``:: + + { + "meshName": "apps", + "routeName": "http2Route", + "spec": { + "http2Route": { + "action": { + "weightedTargets": [ + { + "virtualNode": "serviceBhttp2", + "weight": 100 + } + ] + }, + "match": { + "headers": [ + { + "invert": false, + "match": { + "prefix": "123" + }, + "name": "clientRequestId" + } + ], + "method": "POST", + "prefix": "/", + "scheme": "http" + }, + "retryPolicy": { + "httpRetryEvents": [ + "server-error", + "gateway-error" + ], + "maxRetries": 3, + "perRetryTimeout": { + "unit": "s", + "value": 15 + }, + "tcpRetryEvents": [ + "connection-error" + ] + } + }, + "priority": 200 + }, + "virtualRouterName": "serviceBhttp2" + } + +Output:: + + { + "route": { + "meshName": "apps", + "metadata": { + "arn": "arn:aws:appmesh:us-west-2:123456789012:mesh/apps/virtualRouter/serviceBhttp2/route/http2Route", + "createdAt": 1572011008.352, + "lastUpdatedAt": 1572011008.352, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 1 + }, + "routeName": "http2Route", + "spec": { + "http2Route": { + "action": { + "weightedTargets": [ + { + "virtualNode": "serviceBhttp2", + "weight": 100 + } + ] + }, + "match": { + "headers": [ + { + "invert": false, + "match": { + "prefix": "123" + }, + "name": "clientRequestId" + } + ], + "method": "POST", + "prefix": "/", + "scheme": "http" + }, + "retryPolicy": { + "httpRetryEvents": [ + "server-error", + "gateway-error" + ], + "maxRetries": 3, + "perRetryTimeout": { + "unit": "s", + "value": 15 + }, + "tcpRetryEvents": [ + "connection-error" + ] + } + }, + "priority": 200 + }, + "status": { + "status": "ACTIVE" + }, + "virtualRouterName": "serviceBhttp2" + } + } + +**To create a new TCP route** + +The following ``create-route`` example uses a JSON input file to create a TCP route. 75 percent of traffic is routed to a virtual node named serviceBtcp, and 25 percent of traffic is routed to a virtual node named serviceBv2tcp. Specifying different weightings for different targets is an effective way to do a deployment of a new version of an application. You can adjust the weights so that eventually, 100 percent of all traffic is routed to a target that has the new version of an application. :: + + aws appmesh create-route \ + --cli-input-json file://create-route-tcp.json + +Contents of create-route-tcp.json:: + + { + "meshName": "apps", + "routeName": "tcpRoute", + "spec": { + "priority": 300, + "tcpRoute": { + "action": { + "weightedTargets": [ + { + "virtualNode": "serviceBtcp", + "weight": 75 + }, + { + "virtualNode": "serviceBv2tcp", + "weight": 25 + } + ] + } + } + }, + "virtualRouterName": "serviceBtcp" + } + +Output:: + + { + "route": { + "meshName": "apps", + "metadata": { + "arn": "arn:aws:appmesh:us-west-2:123456789012:mesh/apps/virtualRouter/serviceBtcp/route/tcpRoute", + "createdAt": 1572011436.26, + "lastUpdatedAt": 1572011436.26, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 1 + }, + "routeName": "tcpRoute", + "spec": { + "priority": 300, + "tcpRoute": { + "action": { + "weightedTargets": [ + { + "virtualNode": "serviceBtcp", + "weight": 75 + }, + { + "virtualNode": "serviceBv2tcp", + "weight": 25 + } + ] + } + } + }, + "status": { + "status": "ACTIVE" + }, + "virtualRouterName": "serviceBtcp" + } + } + +For more information, see `Routes `__ in the *AWS App Mesh User Guide*. diff -Nru awscli-1.11.13/awscli/examples/appmesh/create-virtual-node.rst awscli-1.18.69/awscli/examples/appmesh/create-virtual-node.rst --- awscli-1.11.13/awscli/examples/appmesh/create-virtual-node.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/appmesh/create-virtual-node.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,155 @@ +**Example 1: To create a new virtual node that uses DNS for discovery** + +The following ``create-virtual-node`` example uses a JSON input file to create a virtual node that uses DNS for service discovery. :: + + aws appmesh create-virtual-node \ + --cli-input-json file://create-virtual-node-dns.json + +Contents of ``create-virtual-node-dns.json``:: + + { + "meshName": "app1", + "spec": { + "listeners": [ + { + "portMapping": { + "port": 80, + "protocol": "http" + } + } + ], + "serviceDiscovery": { + "dns": { + "hostname": "serviceBv1.svc.cluster.local" + } + } + }, + "virtualNodeName": "vnServiceBv1" + } + +Output:: + + { + "virtualNode": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualNode/vnServiceBv1", + "createdAt": 1563810019.874, + "lastUpdatedAt": 1563810019.874, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 1 + }, + "spec": { + "listeners": [ + { + "portMapping": { + "port": 80, + "protocol": "http" + } + } + ], + "serviceDiscovery": { + "dns": { + "hostname": "serviceBv1.svc.cluster.local" + } + } + }, + "status": { + "status": "ACTIVE" + }, + "virtualNodeName": "vnServiceBv1" + } + } + +**Example 2: To create a new virtual node that uses AWS Cloud Map for discovery** + +The following ``create-virtual-node`` example uses a JSON input file to create a virtual node that uses AWS Cloud Map for service discovery. :: + + aws appmesh create-virtual-node \ + --cli-input-json file://create-virtual-node-cloud-map.json + +Contents of ``create-virtual-node-cloud-map.json``:: + + { + "meshName": "app1", + "spec": { + "backends": [ + { + "virtualService": { + "virtualServiceName": "serviceA.svc.cluster.local" + } + } + ], + "listeners": [ + { + "portMapping": { + "port": 80, + "protocol": "http" + } + } + ], + "serviceDiscovery": { + "awsCloudMap": { + "attributes": [ + { + "key": "Environment", + "value": "Testing" + } + ], + "namespaceName": "namespace1", + "serviceName": "serviceA" + } + } + }, + "virtualNodeName": "vnServiceA" + } + +Output:: + + { + "virtualNode": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualNode/vnServiceA", + "createdAt": 1563810859.465, + "lastUpdatedAt": 1563810859.465, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 1 + }, + "spec": { + "backends": [ + { + "virtualService": { + "virtualServiceName": "serviceA.svc.cluster.local" + } + } + ], + "listeners": [ + { + "portMapping": { + "port": 80, + "protocol": "http" + } + } + ], + "serviceDiscovery": { + "awsCloudMap": { + "attributes": [ + { + "key": "Environment", + "value": "Testing" + } + ], + "namespaceName": "namespace1", + "serviceName": "serviceA" + } + } + }, + "status": { + "status": "ACTIVE" + }, + "virtualNodeName": "vnServiceA" + } + } + +For more information, see `Virtual Nodes `__ in the *AWS App Mesh User Guide*. diff -Nru awscli-1.11.13/awscli/examples/appmesh/create-virtual-router.rst awscli-1.18.69/awscli/examples/appmesh/create-virtual-router.rst --- awscli-1.11.13/awscli/examples/appmesh/create-virtual-router.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/appmesh/create-virtual-router.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,54 @@ +**To create a new virtual router** + +The following ``create-virtual-router`` example uses a JSON input file to create a virtual router with a listener for HTTP using port 80. :: + + aws appmesh create-virtual-router \ + --cli-input-json file://create-virtual-router.json + +Contents of ``create-virtual-router.json``:: + + { + "meshName": "app1", + "spec": { + "listeners": [ + { + "portMapping": { + "port": 80, + "protocol": "http" + } + } + ] + }, + "virtualRouterName": "vrServiceB" + } + +Output:: + + { + "virtualRouter": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB", + "createdAt": 1563810546.59, + "lastUpdatedAt": 1563810546.59, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 1 + }, + "spec": { + "listeners": [ + { + "portMapping": { + "port": 80, + "protocol": "http" + } + } + ] + }, + "status": { + "status": "ACTIVE" + }, + "virtualRouterName": "vrServiceB" + } + } + +For more information, see `Virtual Routers `__ in the *AWS App Mesh User Guide*. diff -Nru awscli-1.11.13/awscli/examples/appmesh/create-virtual-service.rst awscli-1.18.69/awscli/examples/appmesh/create-virtual-service.rst --- awscli-1.11.13/awscli/examples/appmesh/create-virtual-service.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/appmesh/create-virtual-service.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,97 @@ +**Example 1: To create a new virtual service with a virtual node provider** + +The following ``create-virtual-service`` example uses a JSON input file to create a virtual service with a virtual node provider. :: + + aws appmesh create-virtual-service \ + --cli-input-json file://create-virtual-service-virtual-node.json + +Contents of ``create-virtual-service-virtual-node.json``:: + + { + "meshName": "app1", + "spec": { + "provider": { + "virtualNode": { + "virtualNodeName": "vnServiceA" + } + } + }, + "virtualServiceName": "serviceA.svc.cluster.local" + } + +Output:: + + { + "virtualService": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualService/serviceA.svc.cluster.local", + "createdAt": 1563810859.474, + "lastUpdatedAt": 1563810967.179, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 2 + }, + "spec": { + "provider": { + "virtualNode": { + "virtualNodeName": "vnServiceA" + } + } + }, + "status": { + "status": "ACTIVE" + }, + "virtualServiceName": "serviceA.svc.cluster.local" + } + } + +For more information, see `Virtual Node `__ in the *AWS App Mesh User Guide*. + +**Example 2: To create a new virtual service with a virtual router provider** + +The following ``create-virtual-service`` example uses a JSON input file to create a virtual service with a virtual router provider. :: + + aws appmesh create-virtual-service \ + --cli-input-json file://create-virtual-service-virtual-router.json + +Contents of ``create-virtual-service-virtual-router.json``:: + + { + "meshName": "app1", + "spec": { + "provider": { + "virtualRouter": { + "virtualRouterName": "vrServiceB" + } + } + }, + "virtualServiceName": "serviceB.svc.cluster.local" + } + +Output:: + + { + "virtualService": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualService/serviceB.svc.cluster.local", + "createdAt": 1563908363.999, + "lastUpdatedAt": 1563908363.999, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 1 + }, + "spec": { + "provider": { + "virtualRouter": { + "virtualRouterName": "vrServiceB" + } + } + }, + "status": { + "status": "ACTIVE" + }, + "virtualServiceName": "serviceB.svc.cluster.local" + } + } + +For more information, see `Virtual Services`__ in the *AWS App Mesh User Guide* \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/appmesh/delete-mesh.rst awscli-1.18.69/awscli/examples/appmesh/delete-mesh.rst --- awscli-1.11.13/awscli/examples/appmesh/delete-mesh.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/appmesh/delete-mesh.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,31 @@ +**To delete a service mesh** + +The following ``delete-mesh`` example deletes the specified service mesh. :: + + aws appmesh delete-mesh \ + --mesh-name app1 + +Output:: + + { + "mesh": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1", + "createdAt": 1563809909.282, + "lastUpdatedAt": 1563824981.248, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 2 + }, + "spec": { + "egressFilter": { + "type": "ALLOW_ALL" + } + }, + "status": { + "status": "DELETED" + } + } + } + +For more information, see `Service Meshes `__ in the *AWS App Mesh User Guide*. diff -Nru awscli-1.11.13/awscli/examples/appmesh/delete-route.rst awscli-1.18.69/awscli/examples/appmesh/delete-route.rst --- awscli-1.11.13/awscli/examples/appmesh/delete-route.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/appmesh/delete-route.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,49 @@ +**To delete a route** + +The following ``delete-route`` example deletes the specified route. :: + + aws appmesh delete-route \ + --mesh-name app1 \ + --virtual-router-name vrServiceB \ + --route-name toVnServiceB-weighted + +Output:: + + { + "route": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB/route/toVnServiceB-weighted", + "createdAt": 1563811384.015, + "lastUpdatedAt": 1563823915.936, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 3 + }, + "routeName": "toVnServiceB-weighted", + "spec": { + "httpRoute": { + "action": { + "weightedTargets": [ + { + "virtualNode": "vnServiceBv1", + "weight": 80 + }, + { + "virtualNode": "vnServiceBv2", + "weight": 20 + } + ] + }, + "match": { + "prefix": "/" + } + } + }, + "status": { + "status": "DELETED" + }, + "virtualRouterName": "vrServiceB" + } + } + +For more information, see `Routes `__ in the *AWS App Mesh User Guide*. diff -Nru awscli-1.11.13/awscli/examples/appmesh/delete-virtual-node.rst awscli-1.18.69/awscli/examples/appmesh/delete-virtual-node.rst --- awscli-1.11.13/awscli/examples/appmesh/delete-virtual-node.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/appmesh/delete-virtual-node.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,44 @@ +**To delete a virtual node** + +The following ``delete-virtual-node`` example deletes the specified virtual node. :: + + aws appmesh delete-virtual-node \ + --mesh-name app1 \ + --virtual-node-name vnServiceBv2 + +Output:: + + { + "virtualNode": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualNode/vnServiceBv2", + "createdAt": 1563810117.297, + "lastUpdatedAt": 1563824700.678, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 2 + }, + "spec": { + "backends": [], + "listeners": [ + { + "portMapping": { + "port": 80, + "protocol": "http" + } + } + ], + "serviceDiscovery": { + "dns": { + "hostname": "serviceBv2.svc.cluster.local" + } + } + }, + "status": { + "status": "DELETED" + }, + "virtualNodeName": "vnServiceBv2" + } + } + +For more information, see `Virtual Nodes `__ in the *AWS App Mesh User Guide*. diff -Nru awscli-1.11.13/awscli/examples/appmesh/delete-virtual-router.rst awscli-1.18.69/awscli/examples/appmesh/delete-virtual-router.rst --- awscli-1.11.13/awscli/examples/appmesh/delete-virtual-router.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/appmesh/delete-virtual-router.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,38 @@ +**To delete a virtual router** + +The following ``delete-virtual-router`` example deletes the specified virtual router. :: + + aws appmesh delete-virtual-router \ + --mesh-name app1 \ + --virtual-router-name vrServiceB + +Output:: + + { + "virtualRouter": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB", + "createdAt": 1563810546.59, + "lastUpdatedAt": 1563824253.467, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 3 + }, + "spec": { + "listeners": [ + { + "portMapping": { + "port": 80, + "protocol": "http" + } + } + ] + }, + "status": { + "status": "DELETED" + }, + "virtualRouterName": "vrServiceB" + } + } + +For more information, see `Virtual Routers `__ in the *AWS App Mesh User Guide*. diff -Nru awscli-1.11.13/awscli/examples/appmesh/delete-virtual-service.rst awscli-1.18.69/awscli/examples/appmesh/delete-virtual-service.rst --- awscli-1.11.13/awscli/examples/appmesh/delete-virtual-service.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/appmesh/delete-virtual-service.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,29 @@ +**To delete a virtual service** + +The following ``delete-virtual-service`` example deletes the specified virtual service. :: + + aws appmesh delete-virtual-service \ + --mesh-name app1 \ + --virtual-service-name serviceB.svc.cluster.local + +Output:: + + { + "virtualService": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualService/serviceB.svc.cluster.local", + "createdAt": 1563908363.999, + "lastUpdatedAt": 1563913940.866, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 3 + }, + "spec": {}, + "status": { + "status": "DELETED" + }, + "virtualServiceName": "serviceB.svc.cluster.local" + } + } + +For more information, see `Virtual Service `__ in the *AWS App Mesh User Guide*. diff -Nru awscli-1.11.13/awscli/examples/appmesh/describe-mesh.rst awscli-1.18.69/awscli/examples/appmesh/describe-mesh.rst --- awscli-1.11.13/awscli/examples/appmesh/describe-mesh.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/appmesh/describe-mesh.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,27 @@ +**To describe a service mesh** + +The following ``describe-mesh`` example returns details about the specified service mesh. :: + + aws appmesh describe-mesh \ + --mesh-name app1 + +Output:: + + { + "mesh": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1", + "createdAt": 1563809909.282, + "lastUpdatedAt": 1563809909.282, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 1 + }, + "spec": {}, + "status": { + "status": "ACTIVE" + } + } + } + +For more information, see `Service Meshes `__ in the *AWS App Mesh User Guide*. diff -Nru awscli-1.11.13/awscli/examples/appmesh/describe-route.rst awscli-1.18.69/awscli/examples/appmesh/describe-route.rst --- awscli-1.11.13/awscli/examples/appmesh/describe-route.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/appmesh/describe-route.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,49 @@ +**To describe a route** + +The following ``describe-route`` example returns details about the specified route. :: + + aws appmesh describe-route \ + --mesh-name app1 \ + --virtual-router-name vrServiceB \ + --route-name toVnServiceB-weighted + +Output:: + + { + "route": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB/route/toVnServiceB-weighted", + "createdAt": 1563811384.015, + "lastUpdatedAt": 1563811384.015, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 1 + }, + "routeName": "toVnServiceB-weighted", + "spec": { + "httpRoute": { + "action": { + "weightedTargets": [ + { + "virtualNode": "vnServiceBv1", + "weight": 90 + }, + { + "virtualNode": "vnServiceBv2", + "weight": 10 + } + ] + }, + "match": { + "prefix": "/" + } + } + }, + "status": { + "status": "ACTIVE" + }, + "virtualRouterName": "vrServiceB" + } + } + +For more information, see `Routes `__ in the *AWS App Mesh User Guide*. diff -Nru awscli-1.11.13/awscli/examples/appmesh/describe-virtual-node.rst awscli-1.18.69/awscli/examples/appmesh/describe-virtual-node.rst --- awscli-1.11.13/awscli/examples/appmesh/describe-virtual-node.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/appmesh/describe-virtual-node.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,44 @@ +**To describe a virtual node** + +The following ``describe-virtual-node`` example returns details about the specified virtual node. :: + + aws appmesh describe-virtual-node \ + --mesh-name app1 \ + --virtual-node-name vnServiceBv1 + +Output:: + + { + "virtualNode": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualNode/vnServiceBv1", + "createdAt": 1563810019.874, + "lastUpdatedAt": 1563810019.874, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 1 + }, + "spec": { + "backends": [], + "listeners": [ + { + "portMapping": { + "port": 80, + "protocol": "http" + } + } + ], + "serviceDiscovery": { + "dns": { + "hostname": "serviceBv1.svc.cluster.local" + } + } + }, + "status": { + "status": "ACTIVE" + }, + "virtualNodeName": "vnServiceBv1" + } + } + +For more information, see `Virtual Nodes `__ in the *AWS App Mesh User Guide*. diff -Nru awscli-1.11.13/awscli/examples/appmesh/describe-virtual-router.rst awscli-1.18.69/awscli/examples/appmesh/describe-virtual-router.rst --- awscli-1.11.13/awscli/examples/appmesh/describe-virtual-router.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/appmesh/describe-virtual-router.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,38 @@ +**To describe a virtual router** + +The following ``describe-virtual-router`` example returns details about the specified virtual router. :: + + aws appmesh describe-virtual-router \ + --mesh-name app1 \ + --virtual-router-name vrServiceB + +Output:: + + { + "virtualRouter": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB", + "createdAt": 1563810546.59, + "lastUpdatedAt": 1563810546.59, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 1 + }, + "spec": { + "listeners": [ + { + "portMapping": { + "port": 80, + "protocol": "http" + } + } + ] + }, + "status": { + "status": "ACTIVE" + }, + "virtualRouterName": "vrServiceB" + } + } + +For more information, see `Virtual Routers `__ in the *AWS App Mesh User Guide*. diff -Nru awscli-1.11.13/awscli/examples/appmesh/describe-virtual-service.rst awscli-1.18.69/awscli/examples/appmesh/describe-virtual-service.rst --- awscli-1.11.13/awscli/examples/appmesh/describe-virtual-service.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/appmesh/describe-virtual-service.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,35 @@ +**To describe a virtual service** + +The following ``describe-virtual-service`` example returns details about the specified virtual service. :: + + aws appmesh describe-virtual-service \ + --mesh-name app1 \ + --virtual-service-name serviceB.svc.cluster.local + +Output:: + + { + "virtualService": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualService/serviceB.svc.cluster.local", + "createdAt": 1563908363.999, + "lastUpdatedAt": 1563908363.999, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 1 + }, + "spec": { + "provider": { + "virtualRouter": { + "virtualRouterName": "vrServiceB" + } + } + }, + "status": { + "status": "ACTIVE" + }, + "virtualServiceName": "serviceB.svc.cluster.local" + } + } + +For more information, see `Virtual Services `__ in the *AWS App Mesh User Guide*. diff -Nru awscli-1.11.13/awscli/examples/appmesh/list-meshes.rst awscli-1.18.69/awscli/examples/appmesh/list-meshes.rst --- awscli-1.11.13/awscli/examples/appmesh/list-meshes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/appmesh/list-meshes.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To list service meshes** + +The following ``list-meshes`` example lists all of the service meshes in the current AWS Region. :: + + aws appmesh list-meshes + +Output:: + + { + "meshes": [ + { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1", + "meshName": "app1" + } + ] + } + +For more information, see `Service Meshes `__ in the *AWS App Mesh User Guide*. diff -Nru awscli-1.11.13/awscli/examples/appmesh/list-routes.rst awscli-1.18.69/awscli/examples/appmesh/list-routes.rst --- awscli-1.11.13/awscli/examples/appmesh/list-routes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/appmesh/list-routes.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,22 @@ +**To list routes** + +The following ``list-routes`` example lists all of the routes for the specified virtual router. :: + + aws appmesh list-routes \ + --mesh-name app1 \ + --virtual-router-name vrServiceB + +Output:: + + { + "routes": [ + { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB/route/toVnServiceB", + "meshName": "app1", + "routeName": "toVnServiceB-weighted", + "virtualRouterName": "vrServiceB" + } + ] + } + +For more information, see `Routes `__ in the *AWS App Mesh User Guide*. diff -Nru awscli-1.11.13/awscli/examples/appmesh/list-tags-for-resource.rst awscli-1.18.69/awscli/examples/appmesh/list-tags-for-resource.rst --- awscli-1.11.13/awscli/examples/appmesh/list-tags-for-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/appmesh/list-tags-for-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,25 @@ +**To list tags for a resource** + +The following ``list-tags-for-resource`` example lists all of the tags assigned to the specified resource. :: + + aws appmesh list-tags-for-resource \ + --resource-arn arn:aws:appmesh:us-east-1:123456789012:mesh/app1 + +Output:: + + { + "tags": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value2" + }, + { + "key": "key3", + "value": "value3" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/appmesh/list-virtual-nodes.rst awscli-1.18.69/awscli/examples/appmesh/list-virtual-nodes.rst --- awscli-1.11.13/awscli/examples/appmesh/list-virtual-nodes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/appmesh/list-virtual-nodes.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,25 @@ +**To list virtual nodes** + +The following ``list-virtual-nodes`` example lists all of the virtual nodes in the specified service mesh. :: + + aws appmesh list-virtual-nodes \ + --mesh-name app1 + +Output:: + + { + "virtualNodes": [ + { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualNode/vnServiceBv1", + "meshName": "app1", + "virtualNodeName": "vnServiceBv1" + }, + { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualNode/vnServiceBv2", + "meshName": "app1", + "virtualNodeName": "vnServiceBv2" + } + ] + } + +For more information, see `Virtual Nodes `__ in the *AWS App Mesh User Guide*. diff -Nru awscli-1.11.13/awscli/examples/appmesh/list-virtual-routers.rst awscli-1.18.69/awscli/examples/appmesh/list-virtual-routers.rst --- awscli-1.11.13/awscli/examples/appmesh/list-virtual-routers.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/appmesh/list-virtual-routers.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,20 @@ +**To list virtual routers** + +The following ``list-virtual-routers`` example lists all of the virtual routers in the specified service mesh. :: + + aws appmesh list-virtual-routers \ + --mesh-name app1 + +Output:: + + { + "virtualRouters": [ + { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB", + "meshName": "app1", + "virtualRouterName": "vrServiceB" + } + ] + } + +For more information, see `Virtual Routers `__ in the *AWS App Mesh User Guide*. diff -Nru awscli-1.11.13/awscli/examples/appmesh/list-virtual-services.rst awscli-1.18.69/awscli/examples/appmesh/list-virtual-services.rst --- awscli-1.11.13/awscli/examples/appmesh/list-virtual-services.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/appmesh/list-virtual-services.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,25 @@ +**To list virtual services** + +The following ``list-virtual-services`` example lists all of the virtual services in the specified service mesh. :: + + aws appmesh list-virtual-services \ + --mesh-name app1 + +Output:: + + { + "virtualServices": [ + { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualService/serviceA.svc.cluster.local", + "meshName": "app1", + "virtualServiceName": "serviceA.svc.cluster.local" + }, + { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualService/serviceB.svc.cluster.local", + "meshName": "app1", + "virtualServiceName": "serviceB.svc.cluster.local" + } + ] + } + +For more information, see `Virtual Services `__ in the *AWS App Mesh User Guide*. diff -Nru awscli-1.11.13/awscli/examples/appmesh/tag-resource.rst awscli-1.18.69/awscli/examples/appmesh/tag-resource.rst --- awscli-1.11.13/awscli/examples/appmesh/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/appmesh/tag-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To tag a resource** + +The following ``tag-resource`` example adds the tag ``key1`` with the value ``value1`` to the specified resource. :: + + aws appmesh tag-resource \ + --resource-arn arn:aws:appmesh:us-east-1:123456789012:mesh/app1 \ + --tags key=key1,value=value1 + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/appmesh/untag-resource.rst awscli-1.18.69/awscli/examples/appmesh/untag-resource.rst --- awscli-1.11.13/awscli/examples/appmesh/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/appmesh/untag-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To untag a resource** + +The following ``untag-resource`` example removes a tag with the key ``key1`` from the specified resource. :: + + aws appmesh untag-resource \ + --resource-arn arn:aws:appmesh:us-east-1:123456789012:mesh/app1 \ + --tag-keys key1 + +This command produces no output. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/appmesh/update-mesh.rst awscli-1.18.69/awscli/examples/appmesh/update-mesh.rst --- awscli-1.11.13/awscli/examples/appmesh/update-mesh.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/appmesh/update-mesh.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,42 @@ +**To update a service mesh** + +The following ``update-mesh`` example uses a JSON input file to update a service mesh to allow all external egress traffic to be forwarded through the Envoy proxy untouched. :: + + aws appmesh update-mesh \ + --cli-input-json file://update-mesh.json + +Contents of ``update-mesh.json``:: + + { + "meshName": "app1", + "spec": { + "egressFilter": { + "type": "ALLOW_ALL" + } + } + } + +Output:: + + { + "mesh": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1", + "createdAt": 1563809909.282, + "lastUpdatedAt": 1563812829.687, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 2 + }, + "spec": { + "egressFilter": { + "type": "ALLOW_ALL" + } + }, + "status": { + "status": "ACTIVE" + } + } + } + +For more information, see `Service Meshes `__ in the *AWS App Mesh User Guide*. diff -Nru awscli-1.11.13/awscli/examples/appmesh/update-route.rst awscli-1.18.69/awscli/examples/appmesh/update-route.rst --- awscli-1.11.13/awscli/examples/appmesh/update-route.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/appmesh/update-route.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,74 @@ +**To update a route** + +The following ``update-route`` example uses a JSON input file to update the weights for a route. :: + + aws appmesh update-route \ + --cli-input-json file://update-route-weighted.json + +Contents of ``update-route-weighted.json``:: + + { + "meshName": "app1", + "routeName": "toVnServiceB-weighted", + "spec": { + "httpRoute": { + "action": { + "weightedTargets": [ + { + "virtualNode": "vnServiceBv1", + "weight": 80 + }, + { + "virtualNode": "vnServiceBv2", + "weight": 20 + } + ] + }, + "match": { + "prefix": "/" + } + } + }, + "virtualRouterName": "vrServiceB" + } + +Output:: + + { + "route": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB/route/toVnServiceB-weighted", + "createdAt": 1563811384.015, + "lastUpdatedAt": 1563819600.022, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 2 + }, + "routeName": "toVnServiceB-weighted", + "spec": { + "httpRoute": { + "action": { + "weightedTargets": [ + { + "virtualNode": "vnServiceBv1", + "weight": 80 + }, + { + "virtualNode": "vnServiceBv2", + "weight": 20 + } + ] + }, + "match": { + "prefix": "/" + } + } + }, + "status": { + "status": "ACTIVE" + }, + "virtualRouterName": "vrServiceB" + } + } + +For more information, see `Routes `__ in the *AWS App Mesh User Guide*. diff -Nru awscli-1.11.13/awscli/examples/appmesh/update-virtual-node.rst awscli-1.18.69/awscli/examples/appmesh/update-virtual-node.rst --- awscli-1.11.13/awscli/examples/appmesh/update-virtual-node.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/appmesh/update-virtual-node.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,83 @@ +**To update a virtual node** + +The following ``update-virtual-node`` example uses a JSON input file to add a health check to a virtual node. :: + + aws appmesh update-virtual-node \ + --cli-input-json file://update-virtual-node.json + +Contents of ``update-virtual-node.json``:: + + { + "clientToken": "500", + "meshName": "app1", + "spec": { + "listeners": [ + { + "healthCheck": { + "healthyThreshold": 5, + "intervalMillis": 10000, + "path": "/", + "port": 80, + "protocol": "http", + "timeoutMillis": 3000, + "unhealthyThreshold": 3 + }, + "portMapping": { + "port": 80, + "protocol": "http" + } + } + ], + "serviceDiscovery": { + "dns": { + "hostname": "serviceBv1.svc.cluster.local" + } + } + }, + "virtualNodeName": "vnServiceBv1" + } + +Output:: + + { + "virtualNode": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualNode/vnServiceBv1", + "createdAt": 1563810019.874, + "lastUpdatedAt": 1563819234.825, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 2 + }, + "spec": { + "listeners": [ + { + "healthCheck": { + "healthyThreshold": 5, + "intervalMillis": 10000, + "path": "/", + "port": 80, + "protocol": "http", + "timeoutMillis": 3000, + "unhealthyThreshold": 3 + }, + "portMapping": { + "port": 80, + "protocol": "http" + } + } + ], + "serviceDiscovery": { + "dns": { + "hostname": "serviceBv1.svc.cluster.local" + } + } + }, + "status": { + "status": "ACTIVE" + }, + "virtualNodeName": "vnServiceBv1" + } + } + +For more information, see `Virtual Nodes `__ in the *AWS App Mesh User Guide*. diff -Nru awscli-1.11.13/awscli/examples/appmesh/update-virtual-router.rst awscli-1.18.69/awscli/examples/appmesh/update-virtual-router.rst --- awscli-1.11.13/awscli/examples/appmesh/update-virtual-router.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/appmesh/update-virtual-router.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,54 @@ +**To update a virtual router** + +The following ``update-virtual-router`` example uses a JSON input file to update a virtual router listener port. :: + + aws appmesh update-virtual-router \ + --cli-input-json file://update-virtual-router.json + +Contents of ``update-virtual-router.json``:: + + { + "meshName": "app1", + "spec": { + "listeners": [ + { + "portMapping": { + "port": 8080, + "protocol": "http" + } + } + ] + }, + "virtualRouterName": "vrServiceB" + } + +Output:: + + { + "virtualRouter": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB", + "createdAt": 1563810546.59, + "lastUpdatedAt": 1563819431.352, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 2 + }, + "spec": { + "listeners": [ + { + "portMapping": { + "port": 8080, + "protocol": "http" + } + } + ] + }, + "status": { + "status": "ACTIVE" + }, + "virtualRouterName": "vrServiceB" + } + } + +For more information, see `Virtual Routers `__ in the *AWS App Mesh User Guide*. diff -Nru awscli-1.11.13/awscli/examples/appmesh/update-virtual-service.rst awscli-1.18.69/awscli/examples/appmesh/update-virtual-service.rst --- awscli-1.11.13/awscli/examples/appmesh/update-virtual-service.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/appmesh/update-virtual-service.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,48 @@ +**To update a virtual service** + +The following ``update-virtual-service`` example uses a JSON input file to update a virtual service to use a virtual router provider. :: + + aws appmesh update-virtual-service \ + --cli-input-json file://update-virtual-service.json + +Contents of ``update-virtual-service.json``:: + + { + "meshName": "app1", + "spec": { + "provider": { + "virtualRouter": { + "virtualRouterName": "vrServiceA" + } + } + }, + "virtualServiceName": "serviceA.svc.cluster.local" + } + +Output:: + + { + "virtualService": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualService/serviceA.svc.cluster.local", + "createdAt": 1563810859.474, + "lastUpdatedAt": 1563820257.411, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 3 + }, + "spec": { + "provider": { + "virtualRouter": { + "virtualRouterName": "vrServiceA" + } + } + }, + "status": { + "status": "ACTIVE" + }, + "virtualServiceName": "serviceA.svc.cluster.local" + } + } + +For more information, see `Virtual Services `__ in the *AWS App Mesh User Guide*. diff -Nru awscli-1.11.13/awscli/examples/autoscaling/create-auto-scaling-group.rst awscli-1.18.69/awscli/examples/autoscaling/create-auto-scaling-group.rst --- awscli-1.11.13/awscli/examples/autoscaling/create-auto-scaling-group.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/autoscaling/create-auto-scaling-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,17 +1,68 @@ -**To create an Auto Scaling group** +**To create an Auto Scaling group using a launch configuration** -This example creates an Auto Scaling group in a VPC:: +This example creates an Auto Scaling group in a VPC using a launch configuration to specify the type of EC2 instance that Amazon EC2 Auto Scaling creates:: - aws autoscaling create-auto-scaling-group --auto-scaling-group-name my-auto-scaling-group --launch-configuration-name my-launch-config --min-size 1 --max-size 3 --vpc-zone-identifier subnet-41767929c + aws autoscaling create-auto-scaling-group --auto-scaling-group-name my-asg --launch-configuration-name my-launch-config --min-size 1 --max-size 3 --vpc-zone-identifier "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782" This example creates an Auto Scaling group and configures it to use an Elastic Load Balancing load balancer:: - aws autoscaling create-auto-scaling-group --auto-scaling-group-name my-auto-scaling-group --launch-configuration-name my-launch-config --load-balancer-names my-load-balancer --health-check-type ELB --health-check-grace-period 120 + aws autoscaling create-auto-scaling-group --auto-scaling-group-name my-asg --launch-configuration-name my-launch-config --load-balancer-names my-load-balancer --health-check-type ELB --health-check-grace-period 120 --min-size 1 --max-size 3 --vpc-zone-identifier "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782" -This example creates an Auto Scaling group. It specifies Availability Zones instead of subnets. It also launches instances into a placement group and sets the termination policy to terminate the oldest instances first:: +This example specifies a desired capacity as well as a minimum and maximum capacity. It also launches instances into a placement group and sets the termination policy to terminate the oldest instances first:: - aws autoscaling create-auto-scaling-group --auto-scaling-group-name my-auto-scaling-group --launch-configuration-name my-launch-config --min-size 1 --max-size 3 --desired-capacity 2 --default-cooldown 600 --placement-group my-placement-group --termination-policies "OldestInstance" --availability-zones us-west-2c + aws autoscaling create-auto-scaling-group --auto-scaling-group-name my-asg --launch-configuration-name my-launch-config --min-size 1 --max-size 3 --desired-capacity 1 --placement-group my-placement-group --termination-policies "OldestInstance" --availability-zones us-west-2c + +**To create an Auto Scaling group using an EC2 instance** This example creates an Auto Scaling group from the specified EC2 instance and assigns a tag to instances in the group:: - aws autoscaling create-auto-scaling-group --auto-scaling-group-name my-auto-scaling-group --instance-id i-22c99e2a --min-size 1 --max-size 3 --vpc-zone-identifier subnet-41767929 --tags ResourceId=my-auto-scaling-group,ResourceType=auto-scaling-group,Key=Role,Value=WebServer + aws autoscaling create-auto-scaling-group --auto-scaling-group-name my-asg --instance-id i-22c99e2a --min-size 1 --max-size 3 --vpc-zone-identifier "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782" --tags "ResourceId=my-asg,ResourceType=auto-scaling-group,Key=Role,Value=WebServer,PropagateAtLaunch=true" + +**To create an Auto Scaling group using a launch template** + +This example creates an Auto Scaling group in a VPC using a launch template to specify the type of EC2 instance that Amazon EC2 Auto Scaling creates:: + + aws autoscaling create-auto-scaling-group --auto-scaling-group-name my-asg --launch-template "LaunchTemplateName=my-template-for-auto-scaling,Version=1" --min-size 1 --max-size 3 --vpc-zone-identifier "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782" + +This example uses the default version of the specified launch template. It specifies Availability Zones and subnets and enables the instance protection setting:: + + aws autoscaling create-auto-scaling-group --auto-scaling-group-name my-asg --launch-template LaunchTemplateId=lt-0a4872e2c396d941c --min-size 1 --max-size 3 --desired-capacity 2 --availability-zones us-west-2a us-west-2b us-west-2c --vpc-zone-identifier "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782" --new-instances-protected-from-scale-in + +This example creates an Auto Scaling group that launches a single instance using a launch template to optionally specify the ID of an existing network interface (ENI ID) to use. It specifies an Availability Zone that matches the specified network interface:: + + aws autoscaling create-auto-scaling-group --auto-scaling-group-name my-asg-single-instance --launch-template "LaunchTemplateName=my-single-instance-asg-template,Version=2" --min-size 1 --max-size 1 --availability-zones us-west-2a + +This example creates an Auto Scaling group with a lifecycle hook that supports a custom action at instance termination:: + + aws autoscaling create-auto-scaling-group --cli-input-json file://~/config.json + +Contents of config.json file:: + + { + "AutoScalingGroupName": "my-asg", + "LaunchTemplate": { + "LaunchTemplateId": "lt-0a4872e2c396d941c" + }, + "LifecycleHookSpecificationList": [{ + "LifecycleHookName": "my-hook", + "LifecycleTransition": "autoscaling:EC2_INSTANCE_TERMINATING", + "NotificationTargetARN": "arn:aws:sqs:us-west-2:123456789012:my-sqs-queue", + "RoleARN": "arn:aws:iam::123456789012:role/my-notification-role", + "HeartbeatTimeout": 300, + "DefaultResult": "CONTINUE" + }], + "MinSize": 1, + "MaxSize": 5, + "VPCZoneIdentifier": "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782", + "Tags": [{ + "ResourceType": "auto-scaling-group", + "ResourceId": "my-asg", + "PropagateAtLaunch": true, + "Value": "test", + "Key": "environment" + }] + } + +For more information, see the `Amazon EC2 Auto Scaling User Guide`_. + +.. _`Amazon EC2 Auto Scaling User Guide`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html diff -Nru awscli-1.11.13/awscli/examples/autoscaling/create-launch-configuration.rst awscli-1.18.69/awscli/examples/autoscaling/create-launch-configuration.rst --- awscli-1.11.13/awscli/examples/autoscaling/create-launch-configuration.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/autoscaling/create-launch-configuration.rst 2020-05-28 19:25:48.000000000 +0000 @@ -4,10 +4,6 @@ aws autoscaling create-launch-configuration --launch-configuration-name my-launch-config --image-id ami-c6169af6 --instance-type m1.medium -This example creates a launch configuration that uses Spot Instances:: - - aws autoscaling create-launch-configuration --launch-configuration-name my-launch-config --image-id ami-c6169af6 --instance-type m1.medium --spot-price "0.50" - This example creates a launch configuration with a key pair and a bootstrapping script:: aws autoscaling create-launch-configuration --launch-configuration-name my-launch-config --key-name my-key-pair --image-id ami-c6169af6 --instance-type m1.small --user-data file://myuserdata.txt @@ -33,3 +29,15 @@ Parameter:: --block-device-mappings "[{\"DeviceName\": \"/dev/sdf\",\"NoDevice\":\"\"}]" + +For more information about quoting JSON-formatted parameters, see `Quoting Strings`_ in the *AWS Command Line Interface User Guide*. + +This example creates a launch configuration that uses Spot Instances:: + + aws autoscaling create-launch-configuration --launch-configuration-name my-launch-config --image-id ami-01e24be29428c15b2 --instance-type c5.large --spot-price "0.50" + +For more information, see `Launching Spot Instances in Your Auto Scaling Group`_ in the *Amazon EC2 Auto Scaling User Guide*. + +.. _`Quoting Strings`: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html#quoting-strings + +.. _`Launching Spot Instances in Your Auto Scaling Group`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-launch-spot-instances.html diff -Nru awscli-1.11.13/awscli/examples/autoscaling/delete-auto-scaling-group.rst awscli-1.18.69/awscli/examples/autoscaling/delete-auto-scaling-group.rst --- awscli-1.11.13/awscli/examples/autoscaling/delete-auto-scaling-group.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/autoscaling/delete-auto-scaling-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -8,6 +8,6 @@ aws autoscaling delete-auto-scaling-group --auto-scaling-group-name my-auto-scaling-group --force-delete -For more information, see `Shut Down Auto Scaling Processes`_ in the *Auto Scaling Developer Guide*. +For more information, see `Deleting Your Auto Scaling Infrastructure`_ in the *Amazon EC2 Auto Scaling User Guide*. -.. _`Shut Down Auto Scaling Processes`: http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/as-process-shutdown.html +.. _`Deleting Your Auto Scaling Infrastructure`: http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/as-process-shutdown.html diff -Nru awscli-1.11.13/awscli/examples/autoscaling/delete-launch-configuration.rst awscli-1.18.69/awscli/examples/autoscaling/delete-launch-configuration.rst --- awscli-1.11.13/awscli/examples/autoscaling/delete-launch-configuration.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/autoscaling/delete-launch-configuration.rst 2020-05-28 19:25:48.000000000 +0000 @@ -4,6 +4,6 @@ aws autoscaling delete-launch-configuration --launch-configuration-name my-launch-config -For more information, see `Shut Down Auto Scaling Processes`_ in the *Auto Scaling Developer Guide*. +For more information, see `Deleting Your Auto Scaling Infrastructure`_ in the *Amazon EC2 Auto Scaling User Guide*. -.. _`Shut Down Auto Scaling Processes`: http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/as-process-shutdown.html +.. _`Deleting Your Auto Scaling Infrastructure`: http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/as-process-shutdown.html diff -Nru awscli-1.11.13/awscli/examples/autoscaling/delete-notification-configuration.rst awscli-1.18.69/awscli/examples/autoscaling/delete-notification-configuration.rst --- awscli-1.11.13/awscli/examples/autoscaling/delete-notification-configuration.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/autoscaling/delete-notification-configuration.rst 2020-05-28 19:25:48.000000000 +0000 @@ -4,6 +4,6 @@ aws autoscaling delete-notification-configuration --auto-scaling-group-name my-auto-scaling-group --topic-arn arn:aws:sns:us-west-2:123456789012:my-sns-topic -For more information, see `Delete the Notification Configuration`_ in the *Auto Scaling Developer Guide*. +For more information, see `Delete the Notification Configuration`_ in the *Amazon EC2 Auto Scaling User Guide*. -.. _`Delete the Notification Configuration`: http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/ASGettingNotifications.html#delete-settingupnotifications +.. _`Delete the Notification Configuration`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html#delete-settingupnotifications diff -Nru awscli-1.11.13/awscli/examples/autoscaling/delete-tags.rst awscli-1.18.69/awscli/examples/autoscaling/delete-tags.rst --- awscli-1.11.13/awscli/examples/autoscaling/delete-tags.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/autoscaling/delete-tags.rst 2020-05-28 19:25:48.000000000 +0000 @@ -4,6 +4,6 @@ aws autoscaling delete-tags --tags ResourceId=my-auto-scaling-group,ResourceType=auto-scaling-group,Key=Dept,Value=Research -For more information, see `Tagging Auto Scaling Groups and Instances`_ in the *Auto Scaling Developer Guide*. +For more information, see `Tagging Auto Scaling Groups and Instances`_ in the *Amazon EC2 Auto Scaling User Guide*. -.. _`Tagging Auto Scaling Groups and Instances`: http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/ASTagging.html +.. _`Tagging Auto Scaling Groups and Instances`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html diff -Nru awscli-1.11.13/awscli/examples/autoscaling/describe-account-limits.rst awscli-1.18.69/awscli/examples/autoscaling/describe-account-limits.rst --- awscli-1.11.13/awscli/examples/autoscaling/describe-account-limits.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/autoscaling/describe-account-limits.rst 2020-05-28 19:25:48.000000000 +0000 @@ -13,6 +13,6 @@ "MaxNumberOfAutoScalingGroups": 20 } -For more information, see `Auto Scaling Limits`_ in the *Auto Scaling Developer Guide*. +For more information, see `Amazon EC2 Auto Scaling Limits`_ in the *Amazon EC2 Auto Scaling User Guide*. -.. _`Auto Scaling Limits`: http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/as-account-limits.html +.. _`Amazon EC2 Auto Scaling Limits`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html diff -Nru awscli-1.11.13/awscli/examples/autoscaling/describe-adjustment-types.rst awscli-1.18.69/awscli/examples/autoscaling/describe-adjustment-types.rst --- awscli-1.11.13/awscli/examples/autoscaling/describe-adjustment-types.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/autoscaling/describe-adjustment-types.rst 2020-05-28 19:25:48.000000000 +0000 @@ -20,6 +20,6 @@ ] } -For more information, see `Scaling Adjustment Types`_ in the *Auto Scaling Developer Guide*. +For more information, see `Scaling Adjustment Types`_ in the *Amazon EC2 Auto Scaling User Guide*. -.. _`Scaling Adjustment Types`: http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/as-scale-based-on-demand.html#as-scaling-adjustment +.. _`Scaling Adjustment Types`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment diff -Nru awscli-1.11.13/awscli/examples/autoscaling/describe-auto-scaling-groups.rst awscli-1.18.69/awscli/examples/autoscaling/describe-auto-scaling-groups.rst --- awscli-1.11.13/awscli/examples/autoscaling/describe-auto-scaling-groups.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/autoscaling/describe-auto-scaling-groups.rst 2020-05-28 19:25:48.000000000 +0000 @@ -4,6 +4,14 @@ aws autoscaling describe-auto-scaling-groups --auto-scaling-group-name my-auto-scaling-group +This example describes the specified Auto Scaling groups. It allows you to specify up to 100 group names:: + + aws autoscaling describe-auto-scaling-groups --max-items 100 --auto-scaling-group-name "group1" "group2" "group3" "group4" + +This example describes the Auto Scaling groups in the specified region, up to a maximum of 75 groups:: + + aws autoscaling describe-auto-scaling-groups --max-items 75 --region us-east-1 + The following is example output:: { diff -Nru awscli-1.11.13/awscli/examples/autoscaling/describe-auto-scaling-notification-types.rst awscli-1.18.69/awscli/examples/autoscaling/describe-auto-scaling-notification-types.rst --- awscli-1.11.13/awscli/examples/autoscaling/describe-auto-scaling-notification-types.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/autoscaling/describe-auto-scaling-notification-types.rst 2020-05-28 19:25:48.000000000 +0000 @@ -16,6 +16,6 @@ ] } -For more information, see `Configure Your Auto Scaling Group to Send Notifications`_ in the *Auto Scaling Developer Guide*. +For more information, see `Getting Amazon SNS Notifications When Your Auto Scaling Group Scales`_ in the *Amazon EC2 Auto Scaling User Guide*. -.. _`Configure Your Auto Scaling Group to Send Notifications`: http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/ASGettingNotifications.html#as-configure-asg-for-sns +.. _`Getting Amazon SNS Notifications When Your Auto Scaling Group Scales`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html diff -Nru awscli-1.11.13/awscli/examples/autoscaling/describe-metric-collection-types.rst awscli-1.18.69/awscli/examples/autoscaling/describe-metric-collection-types.rst --- awscli-1.11.13/awscli/examples/autoscaling/describe-metric-collection-types.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/autoscaling/describe-metric-collection-types.rst 2020-05-28 19:25:48.000000000 +0000 @@ -40,6 +40,6 @@ ] } -For more information, see `Enable Auto Scaling Group Metrics`_ in the *Auto Scaling Developer Guide*. +For more information, see `Auto Scaling Group Metrics`_ in the *Amazon EC2 Auto Scaling User Guide*. -.. _`Enable Auto Scaling Group Metrics`: http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/as-instance-monitoring.html#as-group-metrics +.. _`Auto Scaling Group Metrics`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-monitoring.html#as-group-metrics diff -Nru awscli-1.11.13/awscli/examples/autoscaling/describe-notification-configurations.rst awscli-1.18.69/awscli/examples/autoscaling/describe-notification-configurations.rst --- awscli-1.11.13/awscli/examples/autoscaling/describe-notification-configurations.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/autoscaling/describe-notification-configurations.rst 2020-05-28 19:25:48.000000000 +0000 @@ -42,6 +42,6 @@ aws autoscaling describe-notification-configurations --auto-scaling-group-name my-auto-scaling-group --starting-token Z3M3LMPEXAMPLE -For more information, see `Getting Notifications When Your Auto Scaling Group Changes`_ in the *Auto Scaling Developer Guide*. +For more information, see `Getting Amazon SNS Notifications When Your Auto Scaling Group Scales`_ in the *Amazon EC2 Auto Scaling User Guide*. -.. _`Getting Notifications When Your Auto Scaling Group Changes`: http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/ASGettingNotifications.html +.. _`Getting Amazon SNS Notifications When Your Auto Scaling Group Scales`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html diff -Nru awscli-1.11.13/awscli/examples/autoscaling/describe-policies.rst awscli-1.18.69/awscli/examples/autoscaling/describe-policies.rst --- awscli-1.11.13/awscli/examples/autoscaling/describe-policies.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/autoscaling/describe-policies.rst 2020-05-28 19:25:48.000000000 +0000 @@ -57,6 +57,6 @@ aws autoscaling describe-policies --auto-scaling-group-name my-auto-scaling-group --starting-token Z3M3LMPEXAMPLE -For more information, see `Dynamic Scaling`_ in the *Auto Scaling Developer Guide*. +For more information, see `Dynamic Scaling`_ in the *Amazon EC2 Auto Scaling User Guide*. -.. _`Dynamic Scaling`: http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/as-scale-based-on-demand.html +.. _`Dynamic Scaling`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html diff -Nru awscli-1.11.13/awscli/examples/autoscaling/describe-scaling-process-types.rst awscli-1.18.69/awscli/examples/autoscaling/describe-scaling-process-types.rst --- awscli-1.11.13/awscli/examples/autoscaling/describe-scaling-process-types.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/autoscaling/describe-scaling-process-types.rst 2020-05-28 19:25:48.000000000 +0000 @@ -35,6 +35,6 @@ ] } -For more information, see `Suspend and Resume Auto Scaling Processes`_ in the *Auto Scaling Developer Guide*. +For more information, see `Suspending and Resuming Scaling Processes`_ in the *Amazon EC2 Auto Scaling User Guide*. -.. _`Suspend and Resume Auto Scaling Processes`: http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US_SuspendResume.html +.. _`Suspending and Resuming Scaling Processes`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html diff -Nru awscli-1.11.13/awscli/examples/autoscaling/describe-scheduled-actions.rst awscli-1.18.69/awscli/examples/autoscaling/describe-scheduled-actions.rst --- awscli-1.11.13/awscli/examples/autoscaling/describe-scheduled-actions.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/autoscaling/describe-scheduled-actions.rst 2020-05-28 19:25:48.000000000 +0000 @@ -13,7 +13,7 @@ "DesiredCapacity": 4, "AutoScalingGroupName": "my-auto-scaling-group", "MaxSize": 6, - "Recurrence": "30 0 1 12 0", + "Recurrence": "30 0 1 12 *", "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-auto-scaling-group:scheduledActionName/my-scheduled-action", "ScheduledActionName": "my-scheduled-action", "StartTime": "2019-12-01T00:30:00Z", @@ -52,7 +52,7 @@ "DesiredCapacity": 4, "AutoScalingGroupName": "my-auto-scaling-group", "MaxSize": 6, - "Recurrence": "30 0 1 12 0", + "Recurrence": "30 0 1 12 *", "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-auto-scaling-group:scheduledActionName/my-scheduled-action", "ScheduledActionName": "my-scheduled-action", "StartTime": "2019-12-01T00:30:00Z", @@ -65,6 +65,6 @@ aws autoscaling describe-scheduled-actions --auto-scaling-group-name my-auto-scaling-group --starting-token Z3M3LMPEXAMPLE -For more information, see `Scheduled Scaling`_ in the *Auto Scaling Developer Guide*. +For more information, see `Scheduled Scaling`_ in the *Amazon EC2 Auto Scaling User Guide*. -.. _`Scheduled Scaling`: http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/schedule_time.html +.. _`Scheduled Scaling`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/schedule_time.html diff -Nru awscli-1.11.13/awscli/examples/autoscaling/describe-tags.rst awscli-1.18.69/awscli/examples/autoscaling/describe-tags.rst --- awscli-1.11.13/awscli/examples/autoscaling/describe-tags.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/autoscaling/describe-tags.rst 2020-05-28 19:25:48.000000000 +0000 @@ -52,6 +52,6 @@ aws autoscaling describe-tags --filters Name=auto-scaling-group,Values=my-auto-scaling-group --starting-token Z3M3LMPEXAMPLE -For more information, see `Tagging Auto Scaling Groups and Instances`_ in the *Auto Scaling Developer Guide*. +For more information, see `Tagging Auto Scaling Groups and Instances`_ in the *Amazon EC2 Auto Scaling User Guide*. -.. _`Tagging Auto Scaling Groups and Instances`: http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/ASTagging.html +.. _`Tagging Auto Scaling Groups and Instances`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html diff -Nru awscli-1.11.13/awscli/examples/autoscaling/describe-termination-policy-types.rst awscli-1.18.69/awscli/examples/autoscaling/describe-termination-policy-types.rst --- awscli-1.11.13/awscli/examples/autoscaling/describe-termination-policy-types.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/autoscaling/describe-termination-policy-types.rst 2020-05-28 19:25:48.000000000 +0000 @@ -8,14 +8,16 @@ { "TerminationPolicyTypes": [ + "AllocationStrategy", "ClosestToNextInstanceHour", "Default", "NewestInstance", "OldestInstance", - "OldestLaunchConfiguration" + "OldestLaunchConfiguration", + "OldestLaunchTemplate" ] } -For more information, see `Controlling Which Instances Auto Scaling Terminates During Scale In`_ in the *Auto Scaling Developer Guide*. +For more information, see `Controlling Which Instances Auto Scaling Terminates During Scale In`_ in the *Amazon EC2 Auto Scaling User Guide*. -.. _`Controlling Which Instances Auto Scaling Terminates During Scale In`: http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingBehavior.InstanceTermination.html#your-termination-policy +.. _`Controlling Which Instances Auto Scaling Terminates During Scale In`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html diff -Nru awscli-1.11.13/awscli/examples/autoscaling/disable-metrics-collection.rst awscli-1.18.69/awscli/examples/autoscaling/disable-metrics-collection.rst --- awscli-1.11.13/awscli/examples/autoscaling/disable-metrics-collection.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/autoscaling/disable-metrics-collection.rst 2020-05-28 19:25:48.000000000 +0000 @@ -4,6 +4,6 @@ aws autoscaling disable-metrics-collection --auto-scaling-group-name my-auto-scaling-group --metrics GroupDesiredCapacity -For more information, see `Monitoring Your Auto Scaling Instances and Groups`_ in the *Auto Scaling Developer Guide*. +For more information, see `Monitoring Your Auto Scaling Groups and Instances Using Amazon CloudWatch`_ in the *Amazon EC2 Auto Scaling User Guide*. -.. _`Monitoring Your Auto Scaling Instances and Groups`: http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/as-instance-monitoring.html +.. _`Monitoring Your Auto Scaling Groups and Instances Using Amazon CloudWatch`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-monitoring.html diff -Nru awscli-1.11.13/awscli/examples/autoscaling/enable-metrics-collection.rst awscli-1.18.69/awscli/examples/autoscaling/enable-metrics-collection.rst --- awscli-1.11.13/awscli/examples/autoscaling/enable-metrics-collection.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/autoscaling/enable-metrics-collection.rst 2020-05-28 19:25:48.000000000 +0000 @@ -8,6 +8,6 @@ aws autoscaling enable-metrics-collection --auto-scaling-group-name my-auto-scaling-group --metrics GroupDesiredCapacity --granularity "1Minute" -For more information, see `Monitoring Your Auto Scaling Instances and Groups`_ in the *Auto Scaling Developer Guide*. +For more information, see `Monitoring Your Auto Scaling Groups and Instances Using Amazon CloudWatch`_ in the *Amazon EC2 Auto Scaling User Guide*. -.. _`Monitoring Your Auto Scaling Instances and Groups`: http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/as-instance-monitoring.html +.. _`Monitoring Your Auto Scaling Groups and Instances Using Amazon CloudWatch`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-monitoring.html diff -Nru awscli-1.11.13/awscli/examples/autoscaling/execute-policy.rst awscli-1.18.69/awscli/examples/autoscaling/execute-policy.rst --- awscli-1.11.13/awscli/examples/autoscaling/execute-policy.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/autoscaling/execute-policy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -4,6 +4,6 @@ aws autoscaling execute-policy --auto-scaling-group-name my-auto-scaling-group --policy-name ScaleIn --honor-cooldown -For more information, see `Dynamic Scaling`_ in the *Auto Scaling Developer Guide*. +For more information, see `Dynamic Scaling`_ in the *Amazon EC2 Auto Scaling User Guide*. -.. _`Dynamic Scaling`: http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/as-scale-based-on-demand.html +.. _`Dynamic Scaling`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html diff -Nru awscli-1.11.13/awscli/examples/autoscaling/put-lifecycle-hook.rst awscli-1.18.69/awscli/examples/autoscaling/put-lifecycle-hook.rst --- awscli-1.11.13/awscli/examples/autoscaling/put-lifecycle-hook.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/autoscaling/put-lifecycle-hook.rst 2020-05-28 19:25:48.000000000 +0000 @@ -4,6 +4,6 @@ aws autoscaling put-lifecycle-hook --lifecycle-hook-name my-lifecycle-hook --auto-scaling-group-name my-auto-scaling-group --lifecycle-transition autoscaling:EC2_INSTANCE_LAUNCHING --notification-target-arn arn:aws:sns:us-west-2:123456789012:my-sns-topic --role-arn arn:aws:iam::123456789012:role/my-auto-scaling-role -For more information, see `Adding Lifecycle Hooks`_ in the *Auto Scaling Developer Guide*. +For more information, see `Add Lifecycle Hooks`_ in the *Amazon EC2 Auto Scaling User Guide*. -.. _`Adding Lifecycle Hooks`: http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/adding-lifecycle-hooks.html +.. _`Add Lifecycle Hooks`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html#adding-lifecycle-hooks diff -Nru awscli-1.11.13/awscli/examples/autoscaling/put-notification-configuration.rst awscli-1.18.69/awscli/examples/autoscaling/put-notification-configuration.rst --- awscli-1.11.13/awscli/examples/autoscaling/put-notification-configuration.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/autoscaling/put-notification-configuration.rst 2020-05-28 19:25:48.000000000 +0000 @@ -4,6 +4,6 @@ aws autoscaling put-notification-configuration --auto-scaling-group-name my-auto-scaling-group --topic-arn arn:aws:sns:us-west-2:123456789012:my-sns-topic --notification-type autoscaling:TEST_NOTIFICATION -For more information, see `Configure Your Auto Scaling Group to Send Notifications`_ in the *Auto Scaling Developer Guide*. +For more information, see `Getting Amazon SNS Notifications When Your Auto Scaling Group Scales`_ in the *Amazon EC2 Auto Scaling User Guide*. -.. _`Configure Your Auto Scaling Group to Send Notifications`: http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/ASGettingNotifications.html#as-configure-asg-for-sns +.. _`Getting Amazon SNS Notifications When Your Auto Scaling Group Scales`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html#as-configure-asg-for-sns diff -Nru awscli-1.11.13/awscli/examples/autoscaling/put-scaling-policy.rst awscli-1.18.69/awscli/examples/autoscaling/put-scaling-policy.rst --- awscli-1.11.13/awscli/examples/autoscaling/put-scaling-policy.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/autoscaling/put-scaling-policy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,6 +1,6 @@ **To add a scaling policy to an Auto Scaling group** -This example adds the specified policy to the specified Auto Scaling group:: +This example adds a simple scaling policy to the specified Auto Scaling group:: aws autoscaling put-scaling-policy --auto-scaling-group-name my-auto-scaling-group --policy-name ScaleIn --scaling-adjustment -1 --adjustment-type ChangeInCapacity @@ -15,6 +15,6 @@ "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2233f3d7-6290-403b-b632-93c553560106:autoScalingGroupName/my-auto-scaling-group:policyName/ScaleIn" } -For more information, see `Dynamic Scaling`_ in the *Auto Scaling Developer Guide*. +For more information, see `Dynamic Scaling`_ in the *Amazon EC2 Auto Scaling User Guide*. -.. _`Dynamic Scaling`: http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/as-scale-based-on-demand.html +.. _`Dynamic Scaling`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html diff -Nru awscli-1.11.13/awscli/examples/autoscaling/put-scheduled-update-group-action.rst awscli-1.18.69/awscli/examples/autoscaling/put-scheduled-update-group-action.rst --- awscli-1.11.13/awscli/examples/autoscaling/put-scheduled-update-group-action.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/autoscaling/put-scheduled-update-group-action.rst 2020-05-28 19:25:48.000000000 +0000 @@ -6,8 +6,8 @@ This example creates a scheduled action to scale on a recurring schedule that is scheduled to execute at 00:30 hours on the first of January, June, and December every year:: - aws autoscaling put-scheduled-update-group-action --auto-scaling-group-name my-auto-scaling-group --scheduled-action-name my-scheduled-action --recurrence "30 0 1 1,6,12 0" --min-size 2 --max-size 6 --desired-capacity 4 + aws autoscaling put-scheduled-update-group-action --auto-scaling-group-name my-auto-scaling-group --scheduled-action-name my-scheduled-action --recurrence "30 0 1 1,6,12 *" --min-size 2 --max-size 6 --desired-capacity 4 -For more information, see `Scheduled Scaling`__ in the *Auto Scaling Developer Guide*. +For more information, see `Scheduled Scaling`__ in the *Amazon EC2 Auto Scaling User Guide*. -.. __: http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/schedule_time.html +.. __: https://docs.aws.amazon.com/autoscaling/ec2/userguide/schedule_time.html \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/autoscaling/resume-processes.rst awscli-1.18.69/awscli/examples/autoscaling/resume-processes.rst --- awscli-1.11.13/awscli/examples/autoscaling/resume-processes.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/autoscaling/resume-processes.rst 2020-05-28 19:25:48.000000000 +0000 @@ -4,6 +4,6 @@ aws autoscaling resume-processes --auto-scaling-group-name my-auto-scaling-group --scaling-processes AlarmNotification -For more information, see `Suspend and Resume Auto Scaling Processes`_ in the *Auto Scaling Developer Guide*. +For more information, see `Suspending and Resuming Scaling Processes`_ in the *Amazon EC2 Auto Scaling User Guide*. -.. _`Suspend and Resume Auto Scaling Processes`: http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US_SuspendResume.html +.. _`Suspending and Resuming Scaling Processes`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html diff -Nru awscli-1.11.13/awscli/examples/autoscaling/suspend-processes.rst awscli-1.18.69/awscli/examples/autoscaling/suspend-processes.rst --- awscli-1.11.13/awscli/examples/autoscaling/suspend-processes.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/autoscaling/suspend-processes.rst 2020-05-28 19:25:48.000000000 +0000 @@ -4,6 +4,6 @@ aws autoscaling suspend-processes --auto-scaling-group-name my-auto-scaling-group --scaling-processes AlarmNotification -For more information, see `Suspend and Resume Auto Scaling Processes`_ in the *Auto Scaling Developer Guide*. +For more information, see `Suspending and Resuming Scaling Processes`_ in the *Amazon EC2 Auto Scaling User Guide*. -.. _`Suspend and Resume Auto Scaling Processes`: http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US_SuspendResume.html +.. _`Suspending and Resuming Scaling Processes`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html diff -Nru awscli-1.11.13/awscli/examples/autoscaling-plans/create-scaling-plan.rst awscli-1.18.69/awscli/examples/autoscaling-plans/create-scaling-plan.rst --- awscli-1.11.13/awscli/examples/autoscaling-plans/create-scaling-plan.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/autoscaling-plans/create-scaling-plan.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,54 @@ +**To create a scaling plan** + +The following ``create-scaling-plan`` example creates a scaling plan named ``my-scaling-plan`` using an already-created JSON file (named config.json). The structure of the scaling plan includes a scaling instruction for an Auto Scaling group named ``my-asg``. It specifies the ``TagFilters`` property as the application source and enables predictive scaling and dynamic scaling. :: + + aws autoscaling-plans create-scaling-plan \ + --scaling-plan-name my-scaling-plan \ + --cli-input-json file://~/config.json + +Contents of ``config.json`` file:: + + { + "ApplicationSource": { + "TagFilters": [ + { + "Key": "purpose", + "Values": [ + "my-application" + ] + } + ] + }, + "ScalingInstructions": [ + { + "ServiceNamespace": "autoscaling", + "ResourceId": "autoScalingGroup/my-asg", + "ScalableDimension": "autoscaling:autoScalingGroup:DesiredCapacity", + "ScheduledActionBufferTime": 300, + "PredictiveScalingMaxCapacityBehavior": "SetForecastCapacityToMaxCapacity", + "PredictiveScalingMode": "ForecastAndScale", + "PredefinedLoadMetricSpecification": { + "PredefinedLoadMetricType": "ASGTotalCPUUtilization" + }, + "ScalingPolicyUpdateBehavior": "ReplaceExternalPolicies", + "MinCapacity": 1, + "MaxCapacity": 4, + "TargetTrackingConfigurations": [ + { + "PredefinedScalingMetricSpecification": { + "PredefinedScalingMetricType": "ASGAverageCPUUtilization" + }, + "TargetValue": 50 + } + ] + } + ] + } + +Output:: + + { + "ScalingPlanVersion": 1 + } + +For more information, see the `AWS Auto Scaling User Guide `__. diff -Nru awscli-1.11.13/awscli/examples/autoscaling-plans/delete-scaling-plan.rst awscli-1.18.69/awscli/examples/autoscaling-plans/delete-scaling-plan.rst --- awscli-1.11.13/awscli/examples/autoscaling-plans/delete-scaling-plan.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/autoscaling-plans/delete-scaling-plan.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To delete a scaling plan** + +The following ``delete-scaling-plan`` example deletes the specified scaling plan. :: + + aws autoscaling-plans delete-scaling-plan \ + --scaling-plan-name my-scaling-plan \ + --scaling-plan-version 1 + +This command produces no output. + +For more information, see the `AWS Auto Scaling User Guide `__. diff -Nru awscli-1.11.13/awscli/examples/autoscaling-plans/describe-scaling-plan-resources.rst awscli-1.18.69/awscli/examples/autoscaling-plans/describe-scaling-plan-resources.rst --- awscli-1.11.13/awscli/examples/autoscaling-plans/describe-scaling-plan-resources.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/autoscaling-plans/describe-scaling-plan-resources.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,38 @@ +**To describe the scalable resources for a scaling plan** + +The following ``describe-scaling-plan-resources`` example displays details about the single scalable resource (an Auto Scaling group) that is associated with the specified scaling plan. :: + + aws autoscaling-plans describe-scaling-plan-resources \ + --scaling-plan-name my-scaling-plan \ + --scaling-plan-version 1 + +Output:: + + { + "ScalingPlanResources": [ + { + "ScalableDimension": "autoscaling:autoScalingGroup:DesiredCapacity", + "ScalingPlanVersion": 1, + "ResourceId": "autoScalingGroup/my-asg", + "ScalingStatusCode": "Active", + "ScalingStatusMessage": "Target tracking scaling policies have been applied to the resource.", + "ScalingPolicies": [ + { + "PolicyName": "AutoScaling-my-asg-b1ab65ae-4be3-4634-bd64-c7471662b251", + "PolicyType": "TargetTrackingScaling", + "TargetTrackingConfiguration": { + "PredefinedScalingMetricSpecification": { + "PredefinedScalingMetricType": "ALBRequestCountPerTarget", + "ResourceLabel": "app/my-alb/f37c06a68c1748aa/targetgroup/my-target-group/6d4ea56ca2d6a18d" + }, + "TargetValue": 40.0 + } + } + ], + "ServiceNamespace": "autoscaling", + "ScalingPlanName": "my-scaling-plan" + } + ] + } + +For more information, see `What Is AWS Auto Scaling? `__ in the *AWS Auto Scaling User Guide*. diff -Nru awscli-1.11.13/awscli/examples/autoscaling-plans/describe-scaling-plans.rst awscli-1.18.69/awscli/examples/autoscaling-plans/describe-scaling-plans.rst --- awscli-1.11.13/awscli/examples/autoscaling-plans/describe-scaling-plans.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/autoscaling-plans/describe-scaling-plans.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,95 @@ +**To describe a scaling plan** + +The following ``describe-scaling-plans`` example displays the details of the specified scaling plan. :: + + aws autoscaling-plans describe-scaling-plans \ + --scaling-plan-names scaling-plan-with-asg-and-ddb + +Output:: + + { + "ScalingPlans": [ + { + "LastMutatingRequestTime": 1565388443.963, + "ScalingPlanVersion": 1, + "CreationTime": 1565388443.963, + "ScalingInstructions": [ + { + "ScalingPolicyUpdateBehavior": "ReplaceExternalPolicies", + "ScalableDimension": "autoscaling:autoScalingGroup:DesiredCapacity", + "TargetTrackingConfigurations": [ + { + "PredefinedScalingMetricSpecification": { + "PredefinedScalingMetricType": "ASGAverageCPUUtilization" + }, + "TargetValue": 50.0, + "EstimatedInstanceWarmup": 300, + "DisableScaleIn": false + } + ], + "ResourceId": "autoScalingGroup/my-asg", + "DisableDynamicScaling": false, + "MinCapacity": 1, + "ServiceNamespace": "autoscaling", + "MaxCapacity": 10 + }, + { + "ScalingPolicyUpdateBehavior": "ReplaceExternalPolicies", + "ScalableDimension": "dynamodb:table:ReadCapacityUnits", + "TargetTrackingConfigurations": [ + { + "PredefinedScalingMetricSpecification": { + "PredefinedScalingMetricType": "DynamoDBReadCapacityUtilization" + }, + "TargetValue": 50.0, + "ScaleInCooldown": 60, + "DisableScaleIn": false, + "ScaleOutCooldown": 60 + } + ], + "ResourceId": "table/my-table", + "DisableDynamicScaling": false, + "MinCapacity": 5, + "ServiceNamespace": "dynamodb", + "MaxCapacity": 10000 + }, + { + "ScalingPolicyUpdateBehavior": "ReplaceExternalPolicies", + "ScalableDimension": "dynamodb:table:WriteCapacityUnits", + "TargetTrackingConfigurations": [ + { + "PredefinedScalingMetricSpecification": { + "PredefinedScalingMetricType": "DynamoDBWriteCapacityUtilization" + }, + "TargetValue": 50.0, + "ScaleInCooldown": 60, + "DisableScaleIn": false, + "ScaleOutCooldown": 60 + } + ], + "ResourceId": "table/my-table", + "DisableDynamicScaling": false, + "MinCapacity": 5, + "ServiceNamespace": "dynamodb", + "MaxCapacity": 10000 + } + ], + "ApplicationSource": { + "TagFilters": [ + { + "Values": [ + "my-application-id" + ], + "Key": "application" + } + ] + }, + "StatusStartTime": 1565388455.836, + "ScalingPlanName": "scaling-plan-with-asg-and-ddb", + "StatusMessage": "Scaling plan has been created and applied to all resources.", + "StatusCode": "Active" + } + ] + } + +For more information, see `What Is AWS Auto Scaling? `__ in the *AWS Auto Scaling User Guide*. diff -Nru awscli-1.11.13/awscli/examples/autoscaling-plans/get-scaling-plan-resource-forecast-data.rst awscli-1.18.69/awscli/examples/autoscaling-plans/get-scaling-plan-resource-forecast-data.rst --- awscli-1.11.13/awscli/examples/autoscaling-plans/get-scaling-plan-resource-forecast-data.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/autoscaling-plans/get-scaling-plan-resource-forecast-data.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To retrieve load forecast data** + +This example retrieves load forecast data for a scalable resource (an Auto Scaling group) that is associated with the specified scaling plan. :: + + aws autoscaling-plans get-scaling-plan-resource-forecast-data \ + --scaling-plan-name my-scaling-plan \ + --scaling-plan-version 1 \ + --service-namespace "autoscaling" \ + --resource-id autoScalingGroup/my-asg \ + --scalable-dimension "autoscaling:autoScalingGroup:DesiredCapacity" \ + --forecast-data-type "LoadForecast" \ + --start-time "2019-08-30T00:00:00Z" \ + --end-time "2019-09-06T00:00:00Z" + +Output:: + + { + "Datapoints": [...] + } + +For more information, see `What Is AWS Auto Scaling `__ in the *AWS Auto Scaling User Guide*. diff -Nru awscli-1.11.13/awscli/examples/autoscaling-plans/update-scaling-plan.rst awscli-1.18.69/awscli/examples/autoscaling-plans/update-scaling-plan.rst --- awscli-1.11.13/awscli/examples/autoscaling-plans/update-scaling-plan.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/autoscaling-plans/update-scaling-plan.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,12 @@ +**To update a scaling plan** + +The following ``update-scaling-plan`` example modifies the scaling metric for an Auto Scaling group in the specified scaling plan. :: + + aws autoscaling-plans update-scaling-plan \ + --scaling-plan-name my-scaling-plan \ + --scaling-plan-version 1 \ + --scaling-instructions '{"ScalableDimension":"autoscaling:autoScalingGroup:DesiredCapacity","ResourceId":"autoScalingGroup/my-asg","ServiceNamespace":"autoscaling","TargetTrackingConfigurations":[{"PredefinedScalingMetricSpecification": {"PredefinedScalingMetricType":"ALBRequestCountPerTarget","ResourceLabel":"app/my-alb/f37c06a68c1748aa/targetgroup/my-target-group/6d4ea56ca2d6a18d"},"TargetValue":40.0}],"MinCapacity": 1,"MaxCapacity": 10}' + +This command produces no output. + +For more information, see `What Is AWS Auto Scaling? `__ in the *AWS Auto Scaling User Guide*. diff -Nru awscli-1.11.13/awscli/examples/backup/create-backup-plan.rst awscli-1.18.69/awscli/examples/backup/create-backup-plan.rst --- awscli-1.11.13/awscli/examples/backup/create-backup-plan.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/backup/create-backup-plan.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To create a backup plan** + +The following ``create-backup-plan`` example creates the specified backup plan with a 35 day retention. :: + + aws backup create-backup-plan \ + --backup-plan "{\"BackupPlanName\":\"Example-Backup-Plan\",\"Rules\":[{\"RuleName\":\"DailyBackups\",\"ScheduleExpression\":\"cron(0 5 ? * * *)\",\"StartWindowMinutes\":480,\"TargetBackupVaultName\":\"Default\",\"Lifecycle\":{\"DeleteAfterDays\":35}}]}" + +Output:: + + { + "BackupPlanId": "1fa3895c-a7f5-484a-a371-2dd6a1a9f729", + "BackupPlanArn": "arn:aws:backup:us-west-2:123456789012:backup-plan:1fa3895c-a7f5-484a-a371-2dd6a1a9f729", + "CreationDate": 1568928754.747, + "VersionId": "ZjQ2ZTI5YWQtZDg5Yi00MzYzLWJmZTAtMDI1MzhlMDhjYjEz" + } + +For more information, see `Creating a Backup Plan `__ in the *AWS Backup Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/backup/create-backup-vault.rst awscli-1.18.69/awscli/examples/backup/create-backup-vault.rst --- awscli-1.11.13/awscli/examples/backup/create-backup-vault.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/backup/create-backup-vault.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To create a backup vault** + +The following ``create-backup-vault`` example creates a backup vault with the specified name. :: + + aws backup create-backup-vault + --backup-vault-name sample-vault + +This command produces no output. +Output:: + + { + "BackupVaultName": "sample-vault", + "BackupVaultArn": "arn:aws:backup:us-west-2:123456789012:backup-vault:sample-vault", + "CreationDate": 1568928338.385 + } + +For more information, see `Creating a Backup Vault `__ in the *AWS Backup Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/backup/get-backup-plan-from-template.rst awscli-1.18.69/awscli/examples/backup/get-backup-plan-from-template.rst --- awscli-1.11.13/awscli/examples/backup/get-backup-plan-from-template.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/backup/get-backup-plan-from-template.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,25 @@ +**To get an existing backup plan from a template** + +The following ``get-backup-plan-from-template`` example gets an existing backup plan from a template that specifies a daily backup with a 35 day retention. :: + + aws backup get-backup-plan-from-template \ + --backup-plan-template-id "87c0c1ef-254d-4180-8fef-2e76a2c38aaa" + +Output:: + + { + "BackupPlanDocument": { + "Rules": [ + { + "RuleName": "DailyBackups", + "ScheduleExpression": "cron(0 5 ? * * *)", + "StartWindowMinutes": 480, + "Lifecycle": { + "DeleteAfterDays": 35 + } + } + ] + } + } + +For more information, see `Creating a Backup Plan `__ in the *AWS Backup Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/backup/get-backup-plan.rst awscli-1.18.69/awscli/examples/backup/get-backup-plan.rst --- awscli-1.11.13/awscli/examples/backup/get-backup-plan.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/backup/get-backup-plan.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,33 @@ +**To get the details of a backup plan** + +The following ``get-backup-plan`` example displays the details of the specified backup plan. :: + + aws backup get-backup-plan \ + --backup-plan-id "fcbf5d8f-bd77-4f3a-9c97-f24fb3d373a5" + +Output:: + + { + "BackupPlan": { + "BackupPlanName": "Example-Backup-Plan", + "Rules": [ + { + "RuleName": "DailyBackups", + "TargetBackupVaultName": "Default", + "ScheduleExpression": "cron(0 5 ? * * *)", + "StartWindowMinutes": 480, + "CompletionWindowMinutes": 10080, + "Lifecycle": { + "DeleteAfterDays": 35 + }, + "RuleId": "70e0ccdc-e9df-4e83-82ad-c1e5a9471cc3" + } + ] + }, + "BackupPlanId": "fcbf5d8f-bd77-4f3a-9c97-f24fb3d373a5", + "BackupPlanArn": "arn:aws:backup:us-west-2:123456789012:backup-plan:fcbf5d8f-bd77-4f3a-9c97-f24fb3d373a5", + "VersionId": "NjQ2ZTZkODktMGVhNy00MmQ0LWE4YjktZTkwNTQ3OTkyYTcw", + "CreationDate": 1568926091.57 + } + +For more information, see `Creating a Backup Plan `__ in the *AWS Backup Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/batch/cancel-job.rst awscli-1.18.69/awscli/examples/batch/cancel-job.rst --- awscli-1.11.13/awscli/examples/batch/cancel-job.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/batch/cancel-job.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,7 @@ +**To cancel a job** + +This example cancels a job with the specified job ID. + +Command:: + + aws batch cancel-job --job-id bcf0b186-a532-4122-842e-2ccab8d54efb --reason "Cancelling job." diff -Nru awscli-1.11.13/awscli/examples/batch/create-compute-environment.rst awscli-1.18.69/awscli/examples/batch/create-compute-environment.rst --- awscli-1.11.13/awscli/examples/batch/create-compute-environment.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/batch/create-compute-environment.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,97 @@ +**To create a managed compute environment with On-Demand instances** + +This example creates a managed compute environment with specific C4 instance types that are launched on demand. The compute environment is called `C4OnDemand`. + +Command:: + + aws batch create-compute-environment --cli-input-json file:///C4OnDemand.json + +JSON file format:: + + { + "computeEnvironmentName": "C4OnDemand", + "type": "MANAGED", + "state": "ENABLED", + "computeResources": { + "type": "EC2", + "minvCpus": 0, + "maxvCpus": 128, + "desiredvCpus": 48, + "instanceTypes": [ + "c4.large", + "c4.xlarge", + "c4.2xlarge", + "c4.4xlarge", + "c4.8xlarge" + ], + "subnets": [ + "subnet-220c0e0a", + "subnet-1a95556d", + "subnet-978f6dce" + ], + "securityGroupIds": [ + "sg-cf5093b2" + ], + "ec2KeyPair": "id_rsa", + "instanceRole": "ecsInstanceRole", + "tags": { + "Name": "Batch Instance - C4OnDemand" + } + }, + "serviceRole": "arn:aws:iam::012345678910:role/AWSBatchServiceRole" + } + +Output:: + + { + "computeEnvironmentName": "C4OnDemand", + "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/C4OnDemand" + } + +**To create a managed compute environment with Spot Instances** + +This example creates a managed compute environment with the M4 instance type that is launched when the Spot bid price is at or below 20% of the On-Demand price for the instance type. The compute environment is called `M4Spot`. + +Command:: + + aws batch create-compute-environment --cli-input-json file:///M4Spot.json + +JSON file format:: + + { + "computeEnvironmentName": "M4Spot", + "type": "MANAGED", + "state": "ENABLED", + "computeResources": { + "type": "SPOT", + "spotIamFleetRole": "arn:aws:iam::012345678910:role/aws-ec2-spot-fleet-role", + "minvCpus": 0, + "maxvCpus": 128, + "desiredvCpus": 4, + "instanceTypes": [ + "m4" + ], + "bidPercentage": 20, + "subnets": [ + "subnet-220c0e0a", + "subnet-1a95556d", + "subnet-978f6dce" + ], + "securityGroupIds": [ + "sg-cf5093b2" + ], + "ec2KeyPair": "id_rsa", + "instanceRole": "ecsInstanceRole", + "tags": { + "Name": "Batch Instance - M4Spot" + } + }, + "serviceRole": "arn:aws:iam::012345678910:role/AWSBatchServiceRole" + } + +Output:: + + { + "computeEnvironmentName": "M4Spot", + "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/M4Spot" + } diff -Nru awscli-1.11.13/awscli/examples/batch/create-job-queue.rst awscli-1.18.69/awscli/examples/batch/create-job-queue.rst --- awscli-1.11.13/awscli/examples/batch/create-job-queue.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/batch/create-job-queue.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,61 @@ +**To create a low priority job queue with a single compute environment** + +This example creates a job queue called `LowPriority` that uses the `M4Spot` compute environment. + +Command:: + + aws batch create-job-queue --cli-input-json file:///LowPriority.json + +JSON file format:: + + { + "jobQueueName": "LowPriority", + "state": "ENABLED", + "priority": 10, + "computeEnvironmentOrder": [ + { + "order": 1, + "computeEnvironment": "M4Spot" + } + ] + } + +Output:: + + { + "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/LowPriority", + "jobQueueName": "LowPriority" + } + +**To create a high priority job queue with two compute environments** + +This example creates a job queue called `HighPriority` that uses the `C4OnDemand` compute environment with an order of 1 and the `M4Spot` compute environment with an order of 2. The scheduler will attempt to place jobs on the `C4OnDemand` compute environment first. + +Command:: + + aws batch create-job-queue --cli-input-json file:///HighPriority.json + +JSON file format:: + + { + "jobQueueName": "HighPriority", + "state": "ENABLED", + "priority": 1, + "computeEnvironmentOrder": [ + { + "order": 1, + "computeEnvironment": "C4OnDemand" + }, + { + "order": 2, + "computeEnvironment": "M4Spot" + } + ] + } + +Output:: + + { + "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority", + "jobQueueName": "HighPriority" + } diff -Nru awscli-1.11.13/awscli/examples/batch/delete-compute-environment.rst awscli-1.18.69/awscli/examples/batch/delete-compute-environment.rst --- awscli-1.11.13/awscli/examples/batch/delete-compute-environment.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/batch/delete-compute-environment.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,7 @@ +**To delete a compute environment** + +This example deletes the `P2OnDemand` compute environment. + +Command:: + + aws batch delete-compute-environment --compute-environment P2OnDemand diff -Nru awscli-1.11.13/awscli/examples/batch/delete-job-queue.rst awscli-1.18.69/awscli/examples/batch/delete-job-queue.rst --- awscli-1.11.13/awscli/examples/batch/delete-job-queue.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/batch/delete-job-queue.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,7 @@ +**To delete a job queue** + +This example deletes the GPGPU job queue. + +Command:: + + aws batch delete-job-queue --job-queue GPGPU diff -Nru awscli-1.11.13/awscli/examples/batch/deregister-job-definition.rst awscli-1.18.69/awscli/examples/batch/deregister-job-definition.rst --- awscli-1.11.13/awscli/examples/batch/deregister-job-definition.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/batch/deregister-job-definition.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To deregister a job definition** + +This example deregisters a job definition called sleep10. + +Command:: + + aws batch deregister-job-definition --job-definition sleep10 + diff -Nru awscli-1.11.13/awscli/examples/batch/describe-compute-environments.rst awscli-1.18.69/awscli/examples/batch/describe-compute-environments.rst --- awscli-1.11.13/awscli/examples/batch/describe-compute-environments.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/batch/describe-compute-environments.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,46 @@ +**To describe a compute environment** + +This example describes the `P2OnDemand` compute environment. + +Command:: + + aws batch describe-compute-environments --compute-environments P2OnDemand + +Output:: + + { + "computeEnvironments": [ + { + "status": "VALID", + "serviceRole": "arn:aws:iam::012345678910:role/AWSBatchServiceRole", + "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/P2OnDemand", + "computeResources": { + "subnets": [ + "subnet-220c0e0a", + "subnet-1a95556d", + "subnet-978f6dce" + ], + "tags": { + "Name": "Batch Instance - P2OnDemand" + }, + "desiredvCpus": 48, + "minvCpus": 0, + "instanceTypes": [ + "p2" + ], + "securityGroupIds": [ + "sg-cf5093b2" + ], + "instanceRole": "ecsInstanceRole", + "maxvCpus": 128, + "type": "EC2", + "ec2KeyPair": "id_rsa" + }, + "statusReason": "ComputeEnvironment Healthy", + "ecsClusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/P2OnDemand_Batch_2c06f29d-d1fe-3a49-879d-42394c86effc", + "state": "ENABLED", + "computeEnvironmentName": "P2OnDemand", + "type": "MANAGED" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/batch/describe-job-definitions.rst awscli-1.18.69/awscli/examples/batch/describe-job-definitions.rst --- awscli-1.11.13/awscli/examples/batch/describe-job-definitions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/batch/describe-job-definitions.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,35 @@ +**To describe active job definitions** + +This example describes all of your active job definitions. + +Command:: + + aws batch describe-job-definitions --status ACTIVE + +Output:: + + { + "jobDefinitions": [ + { + "status": "ACTIVE", + "jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep60:1", + "containerProperties": { + "mountPoints": [], + "parameters": {}, + "image": "busybox", + "environment": {}, + "vcpus": 1, + "command": [ + "sleep", + "60" + ], + "volumes": [], + "memory": 128, + "ulimits": [] + }, + "type": "container", + "jobDefinitionName": "sleep60", + "revision": 1 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/batch/describe-job-queues.rst awscli-1.18.69/awscli/examples/batch/describe-job-queues.rst --- awscli-1.11.13/awscli/examples/batch/describe-job-queues.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/batch/describe-job-queues.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,28 @@ +**To describe a job queue** + +This example describes the `HighPriority` job queue. + +Command:: + + aws batch describe-job-queues --job-queues HighPriority + +Output:: + + { + "jobQueues": [ + { + "status": "VALID", + "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority", + "computeEnvironmentOrder": [ + { + "computeEnvironment": "arn:aws:batch:us-east-1:012345678910:compute-environment/C4OnDemand", + "order": 1 + } + ], + "statusReason": "JobQueue Healthy", + "priority": 1, + "state": "ENABLED", + "jobQueueName": "HighPriority" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/batch/describe-jobs.rst awscli-1.18.69/awscli/examples/batch/describe-jobs.rst --- awscli-1.11.13/awscli/examples/batch/describe-jobs.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/batch/describe-jobs.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,37 @@ +**To describe a job** + +This example describes a job with the specified job ID. + +Command:: + + aws batch describe-jobs --jobs bcf0b186-a532-4122-842e-2ccab8d54efb + +Output:: + + { + "jobs": [ + { + "status": "SUBMITTED", + "container": { + "mountPoints": [], + "image": "busybox", + "environment": [], + "vcpus": 1, + "command": [ + "sleep", + "60" + ], + "volumes": [], + "memory": 128, + "ulimits": [] + }, + "parameters": {}, + "jobDefinition": "sleep60", + "jobQueue": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority", + "jobId": "bcf0b186-a532-4122-842e-2ccab8d54efb", + "dependsOn": [], + "jobName": "example", + "createdAt": 1480483387803 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/batch/list-jobs.rst awscli-1.18.69/awscli/examples/batch/list-jobs.rst --- awscli-1.11.13/awscli/examples/batch/list-jobs.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/batch/list-jobs.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,39 @@ +**To list running jobs** + +This example lists the running jobs in the `HighPriority` job queue. + +Command:: + + aws batch list-jobs --job-queue HighPriority + +Output:: + + { + "jobSummaryList": [ + { + "jobName": "example", + "jobId": "e66ff5fd-a1ff-4640-b1a2-0b0a142f49bb" + } + ] + } + + +**To list submitted jobs** + +This example lists jobs in the `HighPriority` job queue that are in the `SUBMITTED` job status. + +Command:: + + aws batch list-jobs --job-queue HighPriority --job-status SUBMITTED + +Output:: + + { + "jobSummaryList": [ + { + "jobName": "example", + "jobId": "68f0c163-fbd4-44e6-9fd1-25b14a434786" + } + ] + } + \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/batch/register-job-definition.rst awscli-1.18.69/awscli/examples/batch/register-job-definition.rst --- awscli-1.11.13/awscli/examples/batch/register-job-definition.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/batch/register-job-definition.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,15 @@ +**To register a job definition** + +This example registers a job definition for a simple container job. + +Command:: + + aws batch register-job-definition --job-definition-name sleep30 --type container --container-properties '{ "image": "busybox", "vcpus": 1, "memory": 128, "command": [ "sleep", "30"]}' + +Output:: + + { + "jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep30:1", + "jobDefinitionName": "sleep30", + "revision": 1 + } diff -Nru awscli-1.11.13/awscli/examples/batch/submit-job.rst awscli-1.18.69/awscli/examples/batch/submit-job.rst --- awscli-1.11.13/awscli/examples/batch/submit-job.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/batch/submit-job.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,14 @@ +**To submit a job** + +This example submits a simple container job called `example` to the `HighPriority` job queue. + +Command:: + + aws batch submit-job --job-name example --job-queue HighPriority --job-definition sleep60 + +Output:: + + { + "jobName": "example", + "jobId": "876da822-4198-45f2-a252-6cea32512ea8" + } diff -Nru awscli-1.11.13/awscli/examples/batch/terminate-job.rst awscli-1.18.69/awscli/examples/batch/terminate-job.rst --- awscli-1.11.13/awscli/examples/batch/terminate-job.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/batch/terminate-job.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,7 @@ +**To terminate a job** + +This example terminates a job with the specified job ID. + +Command:: + + aws batch terminate-job --job-id 61e743ed-35e4-48da-b2de-5c8333821c84 --reason "Terminating job." diff -Nru awscli-1.11.13/awscli/examples/batch/update-compute-environment.rst awscli-1.18.69/awscli/examples/batch/update-compute-environment.rst --- awscli-1.11.13/awscli/examples/batch/update-compute-environment.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/batch/update-compute-environment.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,14 @@ +**To update a compute environment** + +This example disables the `P2OnDemand` compute environment so it can be deleted. + +Command:: + + aws batch update-compute-environment --compute-environment P2OnDemand --state DISABLED + +Output:: + + { + "computeEnvironmentName": "P2OnDemand", + "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/P2OnDemand" + } diff -Nru awscli-1.11.13/awscli/examples/batch/update-job-queue.rst awscli-1.18.69/awscli/examples/batch/update-job-queue.rst --- awscli-1.11.13/awscli/examples/batch/update-job-queue.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/batch/update-job-queue.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,14 @@ +**To update a job queue** + +This example disables a job queue so that it can be deleted. + +Command:: + + aws batch update-job-queue --job-queue GPGPU --state DISABLED + +Output:: + + { + "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/GPGPU", + "jobQueueName": "GPGPU" + } diff -Nru awscli-1.11.13/awscli/examples/budgets/create-budget.rst awscli-1.18.69/awscli/examples/budgets/create-budget.rst --- awscli-1.11.13/awscli/examples/budgets/create-budget.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/budgets/create-budget.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,61 @@ +**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.11.13/awscli/examples/budgets/create-notification.rst awscli-1.18.69/awscli/examples/budgets/create-notification.rst --- awscli-1.11.13/awscli/examples/budgets/create-notification.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/budgets/create-notification.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To create a notification for the specified Cost and Usage budget** + +This example creates a notification for the specified Cost and Usage budget. + +Command:: + + aws budgets create-notification --account-id 111122223333 --budget-name "Example Budget" --notification NotificationType=ACTUAL,ComparisonOperator=GREATER_THAN,Threshold=80,ThresholdType=PERCENTAGE --subscriber SubscriptionType=EMAIL,Address=example@example.com + diff -Nru awscli-1.11.13/awscli/examples/budgets/create-subscriber.rst awscli-1.18.69/awscli/examples/budgets/create-subscriber.rst --- awscli-1.11.13/awscli/examples/budgets/create-subscriber.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/budgets/create-subscriber.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To create a subscriber for a notification associated with a Cost and Usage budget** + +This example creates a subscriber for the specified notification. + +Command:: + + aws budgets create-subscriber --account-id 111122223333 --budget-name "Example Budget" --notification NotificationType=ACTUAL,ComparisonOperator=GREATER_THAN,Threshold=80,ThresholdType=PERCENTAGE --subscriber SubscriptionType=EMAIL,Address=example@example.com + diff -Nru awscli-1.11.13/awscli/examples/budgets/delete-budget.rst awscli-1.18.69/awscli/examples/budgets/delete-budget.rst --- awscli-1.11.13/awscli/examples/budgets/delete-budget.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/budgets/delete-budget.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To delete a Cost and Usage budget** + +This example deletes the specified Cost and Usage budget. + +Command:: + + aws budgets delete-budget --account-id 111122223333 --budget-name "Example Budget" + diff -Nru awscli-1.11.13/awscli/examples/budgets/delete-notification.rst awscli-1.18.69/awscli/examples/budgets/delete-notification.rst --- awscli-1.11.13/awscli/examples/budgets/delete-notification.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/budgets/delete-notification.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To delete a notification from a budget** + +This example deletes the specified notification from the specified budget. + +Command:: + + aws budgets delete-notification --account-id 111122223333 --budget-name "Example Budget" --notification NotificationType=ACTUAL,ComparisonOperator=GREATER_THAN,Threshold=80,ThresholdType=PERCENTAGE + diff -Nru awscli-1.11.13/awscli/examples/budgets/delete-subscriber.rst awscli-1.18.69/awscli/examples/budgets/delete-subscriber.rst --- awscli-1.11.13/awscli/examples/budgets/delete-subscriber.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/budgets/delete-subscriber.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To delete a subscriber from a notification** + +This example deletes the specified subscriber from the specified notification. + +Command:: + + aws budgets delete-subscriber --account-id 111122223333 --budget-name "Example Budget" --notification NotificationType=ACTUAL,ComparisonOperator=GREATER_THAN,Threshold=80,ThresholdType=PERCENTAGE --subscriber SubscriptionType=EMAIL,Address=example@example.com + diff -Nru awscli-1.11.13/awscli/examples/budgets/describe-budget.rst awscli-1.18.69/awscli/examples/budgets/describe-budget.rst --- awscli-1.11.13/awscli/examples/budgets/describe-budget.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/budgets/describe-budget.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,54 @@ +**To retrieve a budget associated with an account** + +This example retrieves the specified Cost and Usage budget. + +Command:: + + aws budgets describe-budget --account-id 111122223333 --budget-name "Example Budget" + +Output:: + + { + "Budget": { + "CalculatedSpend": { + "ForecastedSpend": { + "Amount": "2641.54800000000022919266484677791595458984375", + "Unit": "USD" + }, + "ActualSpend": { + "Amount": "604.4560000000000172803993336856365203857421875", + "Unit": "USD" + } + }, + "BudgetType": "COST", + "BudgetLimit": { + "Amount": "100", + "Unit": "USD" + }, + "BudgetName": "Example Budget", + "CostTypes": { + "IncludeOtherSubscription": true, + "IncludeUpfront": true, + "IncludeRefund": true, + "UseBlended": false, + "IncludeDiscount": true, + "UseAmortized": false, + "IncludeTax": true, + "IncludeCredit": true, + "IncludeSupport": true, + "IncludeRecurring": true, + "IncludeSubscription": true + }, + "TimeUnit": "MONTHLY", + "TimePeriod": { + "Start": 1477958399.0, + "End": 3706473600.0 + }, + "CostFilters": { + "AZ": [ + "us-east-1" + ] + } + } + } + diff -Nru awscli-1.11.13/awscli/examples/budgets/describe-budgets.rst awscli-1.18.69/awscli/examples/budgets/describe-budgets.rst --- awscli-1.11.13/awscli/examples/budgets/describe-budgets.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/budgets/describe-budgets.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,56 @@ +**To retrieve the budgets associated with an account** + +This example retrieves the Cost and Usage budgets for an account. + +Command:: + + aws budgets describe-budgets --account-id 111122223333 --max-results 20 + +Output:: + + { + "Budgets": [ + { + "CalculatedSpend": { + "ForecastedSpend": { + "Amount": "2641.54800000000022919266484677791595458984375", + "Unit": "USD" + }, + "ActualSpend": { + "Amount": "604.4560000000000172803993336856365203857421875", + "Unit": "USD" + } + }, + "BudgetType": "COST", + "BudgetLimit": { + "Amount": "100", + "Unit": "USD" + }, + "BudgetName": "Example Budget", + "CostTypes": { + "IncludeOtherSubscription": true, + "IncludeUpfront": true, + "IncludeRefund": true, + "UseBlended": false, + "IncludeDiscount": true, + "UseAmortized": false, + "IncludeTax": true, + "IncludeCredit": true, + "IncludeSupport": true, + "IncludeRecurring": true, + "IncludeSubscription": true + }, + "TimeUnit": "MONTHLY", + "TimePeriod": { + "Start": 1477958399.0, + "End": 3706473600.0 + }, + "CostFilters": { + "AZ": [ + "us-east-1" + ] + } + } + ] + } + diff -Nru awscli-1.11.13/awscli/examples/budgets/describe-notifications-for-budget.rst awscli-1.18.69/awscli/examples/budgets/describe-notifications-for-budget.rst --- awscli-1.11.13/awscli/examples/budgets/describe-notifications-for-budget.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/budgets/describe-notifications-for-budget.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To retrieve the notifications for a budget** + +This example retrieves the notifications for a Cost and Usage budget. + +Command:: + + aws budgets describe-notifications-for-budget --account-id 111122223333 --budget-name "Example Budget" --max-results 5 + +Output:: + + { + "Notifications": [ + { + "Threshold": 80.0, + "ComparisonOperator": "GREATER_THAN", + "NotificationType": "ACTUAL" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/budgets/describe-subscribers-for-notification.rst awscli-1.18.69/awscli/examples/budgets/describe-subscribers-for-notification.rst --- awscli-1.11.13/awscli/examples/budgets/describe-subscribers-for-notification.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/budgets/describe-subscribers-for-notification.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,22 @@ +**To retrieve the subscribers for a budget notification** + +This example retrieves the subscribers for a Cost and Usage budget notification. + +Command:: + + aws budgets describe-subscribers-for-notification --account-id 111122223333 --budget-name "Example Budget" --notification NotificationType=ACTUAL,ComparisonOperator=GREATER_THAN,Threshold=80,ThresholdType=PERCENTAGE --max-results 5 + +Output:: + + { + "Subscribers": [ + { + "SubscriptionType": "EMAIL", + "Address": "example2@example.com" + }, + { + "SubscriptionType": "EMAIL", + "Address": "example@example.com" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/budgets/update-budget.rst awscli-1.18.69/awscli/examples/budgets/update-budget.rst --- awscli-1.11.13/awscli/examples/budgets/update-budget.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/budgets/update-budget.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,40 @@ +**To replace a budget for a Cost and Usage budget** + +This example replaces a Cost and Usage budget with a new budget. + +Command:: + + aws budgets update-budget --account-id 111122223333 --new-budget file://new-budget.json + +new-budget.json:: + + { + "BudgetLimit": { + "Amount": "100", + "Unit": "USD" + }, + "BudgetName": "Example Budget", + "BudgetType": "COST", + "CostFilters": { + "AZ" : [ "us-east-1" ] + }, + "CostTypes": { + "IncludeCredit": false, + "IncludeDiscount": true, + "IncludeOtherSubscription": true, + "IncludeRecurring": true, + "IncludeRefund": true, + "IncludeSubscription": true, + "IncludeSupport": true, + "IncludeTax": true, + "IncludeUpfront": true, + "UseBlended": false, + "UseAmortized": true + }, + "TimePeriod": { + "Start": 1477958399, + "End": 3706473600 + }, + "TimeUnit": "MONTHLY" + } + diff -Nru awscli-1.11.13/awscli/examples/budgets/update-notification.rst awscli-1.18.69/awscli/examples/budgets/update-notification.rst --- awscli-1.11.13/awscli/examples/budgets/update-notification.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/budgets/update-notification.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To replace a notification for a Cost and Usage budget** + +This example replaces an 80% notification for a Cost and Usage budget with a 90% notification. + +Command:: + + aws budgets update-notification --account-id 111122223333 --budget-name "Example Budget" --old-notification NotificationType=ACTUAL,ComparisonOperator=GREATER_THAN,Threshold=80,ThresholdType=PERCENTAGE --new-notification NotificationType=ACTUAL,ComparisonOperator=GREATER_THAN,Threshold=90,ThresholdType=PERCENTAGE + diff -Nru awscli-1.11.13/awscli/examples/budgets/update-subscriber.rst awscli-1.18.69/awscli/examples/budgets/update-subscriber.rst --- awscli-1.11.13/awscli/examples/budgets/update-subscriber.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/budgets/update-subscriber.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,7 @@ +**To replace a subscriber for a Cost and Usage budget** + +This example replaces the subscriber for a Cost and Usage budget. + +Command:: + + aws budgets update-subscriber --account-id 111122223333 --budget-name "Example Budget" --notification NotificationType=ACTUAL,ComparisonOperator=GREATER_THAN,Threshold=80,ThresholdType=PERCENTAGE --old-subscriber SubscriptionType=EMAIL,Address=example@example.com --new-subscriber SubscriptionType=EMAIL,Address=example2@example.com diff -Nru awscli-1.11.13/awscli/examples/ce/get-cost-and-usage.rst awscli-1.18.69/awscli/examples/ce/get-cost-and-usage.rst --- awscli-1.11.13/awscli/examples/ce/get-cost-and-usage.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ce/get-cost-and-usage.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,88 @@ +**To retrieve the S3 usage of an account for the month of September 2017** + +The following ``get-cost-and-usage`` example retrieves the S3 usage of an account for the month of September 2017. :: + + aws ce get-cost-and-usage \ + --time-period Start=2017-09-01,End=2017-10-01 \ + --granularity MONTHLY \ + --metrics "BlendedCost" "UnblendedCost" "UsageQuantity" \ + --group-by Type=DIMENSION,Key=SERVICE Type=TAG,Key=Environment \ + --filter file://filters.json + +Contents of ``filters.json``:: + + { + "Dimensions": { + "Key": "SERVICE", + "Values": [ + "Amazon Simple Storage Service" + ] + } + } + +Output:: + + { + "GroupDefinitions": [ + { + "Type": "DIMENSION", + "Key": "SERVICE" + }, + { + "Type": "TAG", + "Key": "Environment" + } + ], + "ResultsByTime": [ + { + "Estimated": false, + "TimePeriod": { + "Start": "2017-09-01", + "End": "2017-10-01" + }, + "Total": {}, + "Groups": [ + { + "Keys": [ + "Amazon Simple Storage Service", + "Environment$" + ], + "Metrics": { + "BlendedCost": { + "Amount": "40.3527508453", + "Unit": "USD" + }, + "UnblendedCost": { + "Amount": "40.3543773134", + "Unit": "USD" + }, + "UsageQuantity": { + "Amount": "9312771.098461578", + "Unit": "N/A" + } + } + }, + { + "Keys": [ + "Amazon Simple Storage Service", + "Environment$Dev" + ], + "Metrics": { + "BlendedCost": { + "Amount": "0.2682364644", + "Unit": "USD" + }, + "UnblendedCost": { + "Amount": "0.2682364644", + "Unit": "USD" + }, + "UsageQuantity": { + "Amount": "22403.4395271182", + "Unit": "N/A" + } + } + } + ] + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/ce/get-dimension-values.rst awscli-1.18.69/awscli/examples/ce/get-dimension-values.rst --- awscli-1.11.13/awscli/examples/ce/get-dimension-values.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ce/get-dimension-values.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,40 @@ +**To retrieve the tags for the dimension SERVICE, with a value of "Elastic"** + +This example retrieves the tags for the dimension SERVICE, with a value of "Elastic" for January 01 2017 through May 18 2017. + +Command:: + + aws ce get-dimension-values --search-string Elastic --time-period Start=2017-01-01,End=2017-05-18 --dimension SERVICE + +Output:: + + { + "TotalSize": 6, + "DimensionValues": [ + { + "Attributes": {}, + "Value": "Amazon ElastiCache" + }, + { + "Attributes": {}, + "Value": "EC2 - Other" + }, + { + "Attributes": {}, + "Value": "Amazon Elastic Compute Cloud - Compute" + }, + { + "Attributes": {}, + "Value": "Amazon Elastic Load Balancing" + }, + { + "Attributes": {}, + "Value": "Amazon Elastic MapReduce" + }, + { + "Attributes": {}, + "Value": "Amazon Elasticsearch Service" + } + ], + "ReturnSize": 6 + } diff -Nru awscli-1.11.13/awscli/examples/ce/get-reservation-coverage.rst awscli-1.18.69/awscli/examples/ce/get-reservation-coverage.rst --- awscli-1.11.13/awscli/examples/ce/get-reservation-coverage.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ce/get-reservation-coverage.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,62 @@ +**To retrieve the reservation coverage for EC2 t2.nano instances in the us-east-1 region** + +This example retrieves the reservation coverage for EC2 t2.nano instances in the us-east-1 region for July-September of 2017. + +Command:: + + aws ce get-reservation-coverage --time-period Start=2017-07-01,End=2017-10-01 --group-by Type=Dimension,Key=REGION --filter file://filters.json + +filters.json:: + + { + "And": [ + { + "Dimensions": { + "Key": "INSTANCE_TYPE", + "Values": [ + "t2.nano" + ] + }, + "Dimensions": { + "Key": "REGION", + "Values": [ + "us-east-1" + ] + } + } + ] + } + +Output:: + + { + "TotalSize": 6, + "DimensionValues": [ + { + "Attributes": {}, + "Value": "Amazon ElastiCache" + }, + { + "Attributes": {}, + "Value": "EC2 - Other" + }, + { + "Attributes": {}, + "Value": "Amazon Elastic Compute Cloud - Compute" + }, + { + "Attributes": {}, + "Value": "Amazon Elastic Load Balancing" + }, + { + "Attributes": {}, + "Value": "Amazon Elastic MapReduce" + }, + { + "Attributes": {}, + "Value": "Amazon Elasticsearch Service" + } + ], + "ReturnSize": 6 + } + diff -Nru awscli-1.11.13/awscli/examples/ce/get-reservation-purchase-recommendation.rst awscli-1.18.69/awscli/examples/ce/get-reservation-purchase-recommendation.rst --- awscli-1.11.13/awscli/examples/ce/get-reservation-purchase-recommendation.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ce/get-reservation-purchase-recommendation.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To retrieve the reservation recommendations for Partial Upfront EC2 RIs with a three year term** + +The following ``get-reservation-purchase-recommendation`` example retrieves recommendations for Partial Upfront EC2 instances with a three-year term, based on the last 60 days of EC2 usage. :: + + aws ce get-reservation-purchase-recommendation \ + --service "Amazon Redshift" \ + --lookback-period-in-days SIXTY_DAYS \ + --term-in-years THREE_YEARS \ + --payment-option PARTIAL_UPFRONT + +Output:: + + { + "Recommendations": [], + "Metadata": { + "GenerationTimestamp": "2018-08-08T15:20:57Z", + "RecommendationId": "00d59dde-a1ad-473f-8ff2-iexample3330b" + } + } diff -Nru awscli-1.11.13/awscli/examples/ce/get-reservation-utilization.rst awscli-1.18.69/awscli/examples/ce/get-reservation-utilization.rst --- awscli-1.11.13/awscli/examples/ce/get-reservation-utilization.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ce/get-reservation-utilization.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,36 @@ +**To retrieve the reservation utilization for your account** + +The following ``get-reservation-utilization`` example retrieves the RI utilization for all t2.nano instance types from 2018-03-01 to 2018-08-01 for the account. :: + + aws ce get-reservation-utilization \ + --time-period Start=2018-03-01,End=2018-08-01 \ + --filter file://filters.json + +Contents of ``filters.json``:: + + { + "Dimensions": { + "Key": "INSTANCE_TYPE", + "Values": [ + "t2.nano" + ] + } + } + +Output:: + + { + "Total": { + "TotalAmortizedFee": "0", + "UtilizationPercentage": "0", + "PurchasedHours": "0", + "NetRISavings": "0", + "TotalActualHours": "0", + "AmortizedRecurringFee": "0", + "UnusedHours": "0", + "TotalPotentialRISavings": "0", + "OnDemandCostOfRIHoursUsed": "0", + "AmortizedUpfrontFee": "0" + }, + "UtilizationsByTime": [] + } diff -Nru awscli-1.11.13/awscli/examples/ce/get-tags.rst awscli-1.18.69/awscli/examples/ce/get-tags.rst --- awscli-1.11.13/awscli/examples/ce/get-tags.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ce/get-tags.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To retrieve keys and values for a cost allocation tag** + +This example retrieves all cost allocation tags with a key of "Project" and a value that contains "secretProject". + +Command:: + + aws ce get-tags --search-string secretProject --time-period Start=2017-01-01,End=2017-05-18 --tag-key Project + +Output:: + + { + "ReturnSize": 2, + "Tags": [ + "secretProject1", + "secretProject2" + ], + "TotalSize": 2 + } diff -Nru awscli-1.11.13/awscli/examples/chime/associate-phone-numbers-with-voice-connector-group.rst awscli-1.18.69/awscli/examples/chime/associate-phone-numbers-with-voice-connector-group.rst --- awscli-1.11.13/awscli/examples/chime/associate-phone-numbers-with-voice-connector-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/associate-phone-numbers-with-voice-connector-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,16 @@ +**To associate phone numbers with an Amazon Chime Voice Connector group** + +The following ``associate-phone-numbers-with-voice-connector-group`` example associates the specified phone numbers with an Amazon Chime Voice Connector group. :: + + aws chime associate-phone-numbers-with-voice-connector-group \ + --voice-connector-group-id 123a456b-c7d8-90e1-fg23-4h567jkl8901 \ + --e164-phone-numbers "+12065550100" "+12065550101" \ + --force-associate + +Output:: + + { + "PhoneNumberErrors": [] + } + +For more information, see `Working with Amazon Chime Voice Connector groups `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/associate-phone-numbers-with-voice-connector.rst awscli-1.18.69/awscli/examples/chime/associate-phone-numbers-with-voice-connector.rst --- awscli-1.11.13/awscli/examples/chime/associate-phone-numbers-with-voice-connector.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/associate-phone-numbers-with-voice-connector.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,16 @@ +**To associate phone numbers with an Amazon Chime Voice Connector** + +The following ``associate-phone-numbers-with-voice-connector`` example associates the specified phone numbers with an Amazon Chime Voice Connector. :: + + aws chime associate-phone-numbers-with-voice-connector \ + --voice-connector-id abcdef1ghij2klmno3pqr4 \ + --e164-phone-numbers "+12065550100" "+12065550101" + --force-associate + +Output:: + + { + "PhoneNumberErrors": [] + } + +For more information, see `Working with Amazon Chime Voice Connectors `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/associate-phone-number-with-user.rst awscli-1.18.69/awscli/examples/chime/associate-phone-number-with-user.rst --- awscli-1.11.13/awscli/examples/chime/associate-phone-number-with-user.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/associate-phone-number-with-user.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,12 @@ +**To associate a phone number with a user** + +The following ``associate-phone-number-with-user`` example associates the specified phone number with a user. :: + + aws chime associate-phone-number-with-user \ + --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ + --user-id 1ab2345c-67de-8901-f23g-45h678901j2k \ + --e164-phone-number "+12065550100" + +This command produces no output. + +For more information, see `Managing User Phone Numbers `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/associate-signin-delegate-groups-with-account.rst awscli-1.18.69/awscli/examples/chime/associate-signin-delegate-groups-with-account.rst --- awscli-1.11.13/awscli/examples/chime/associate-signin-delegate-groups-with-account.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/associate-signin-delegate-groups-with-account.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/chime/batch-create-room-membership.rst awscli-1.18.69/awscli/examples/chime/batch-create-room-membership.rst --- awscli-1.11.13/awscli/examples/chime/batch-create-room-membership.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/batch-create-room-membership.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,28 @@ +**To create multiple room memberships** + +The following ``batch-create-room-membership`` example adds multiple users to a chat room as chat room members. It also assigns administrator and member roles to the users. :: + + aws chime batch-create-room-membership \ + --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ + --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j \ + --membership-item-list "MemberId=1ab2345c-67de-8901-f23g-45h678901j2k,Role=Administrator" "MemberId=2ab2345c-67de-8901-f23g-45h678901j2k,Role=Member" + +Output:: + + { + "ResponseMetadata": { + "RequestId": "169ba401-d886-475f-8b3f-e01eac6fadfb", + "HTTPStatusCode": 201, + "HTTPHeaders": { + "x-amzn-requestid": "169ba401-d886-475f-8b3f-e01eac6fadfb", + "content-type": "application/json", + "content-length": "13", + "date": "Mon, 02 Dec 2019 22:46:58 GMT", + "connection": "keep-alive" + }, + "RetryAttempts": 0 + }, + "Errors": [] + } + +For more information, see `Creating a Chat Room `__ in the *Amazon Chime User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/chime/batch-delete-phone-number.rst awscli-1.18.69/awscli/examples/chime/batch-delete-phone-number.rst --- awscli-1.11.13/awscli/examples/chime/batch-delete-phone-number.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/batch-delete-phone-number.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,15 @@ +**To delete multiple phone numbers** + +The following ``batch-delete-phone-number`` example deletes all of the specified phone numbers. :: + + aws chime batch-delete-phone-number \ + --phone-number-ids "%2B12065550100" "%2B12065550101" + +This command produces no output. +Output:: + + { + "PhoneNumberErrors": [] + } + +For more information, see `Working with Phone Numbers `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/batch-suspend-user.rst awscli-1.18.69/awscli/examples/chime/batch-suspend-user.rst --- awscli-1.11.13/awscli/examples/chime/batch-suspend-user.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/batch-suspend-user.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,13 @@ +**To suspend multiple users** + +The following ``batch-suspend-user`` example suspends the listed users from the specified Amazon Chime account. :: + + aws chime batch-suspend-user \ + --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ + --user-id-list "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE" "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE" "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE" + +Output:: + + { + "UserErrors": [] + } diff -Nru awscli-1.11.13/awscli/examples/chime/batch-unsuspend-user.rst awscli-1.18.69/awscli/examples/chime/batch-unsuspend-user.rst --- awscli-1.11.13/awscli/examples/chime/batch-unsuspend-user.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/batch-unsuspend-user.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,14 @@ +**To unsuspend multiple users** + +The following ``batch-unsuspend-user`` example removes any previous suspension for the listed users on the specified Amazon Chime account. :: + + aws chime batch-unsuspend-user \ + --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ + --user-id-list "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE" "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE" "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE" + +Output:: + + { + "UserErrors": [] + } + diff -Nru awscli-1.11.13/awscli/examples/chime/batch-update-phone-number.rst awscli-1.18.69/awscli/examples/chime/batch-update-phone-number.rst --- awscli-1.11.13/awscli/examples/chime/batch-update-phone-number.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/batch-update-phone-number.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,28 @@ +**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. :: + + aws chime batch-update-phone-number \ + --update-phone-number-request-items PhoneNumberId=%2B12065550100,ProductType=BusinessCalling PhoneNumberId=%2B12065550101,ProductType=BusinessCalling + +Output:: + + { + "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.11.13/awscli/examples/chime/batch-update-user.rst awscli-1.18.69/awscli/examples/chime/batch-update-user.rst --- awscli-1.11.13/awscli/examples/chime/batch-update-user.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/batch-update-user.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,13 @@ +**To update multiple users in a single command** + +The following ``batch-update-user`` example updates the ``LicenseType`` for each of the listed users in the specified Amazon Chime account. :: + + aws chime batch-update-user \ + --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE + --update-user-request-items "UserId=a1b2c3d4-5678-90ab-cdef-22222EXAMPLE,LicenseType=Basic" "UserId=a1b2c3d4-5678-90ab-cdef-33333EXAMPLE,LicenseType=Basic" + +Output:: + + { + "UserErrors": [] + } diff -Nru awscli-1.11.13/awscli/examples/chime/create-account.rst awscli-1.18.69/awscli/examples/chime/create-account.rst --- awscli-1.11.13/awscli/examples/chime/create-account.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/create-account.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,30 @@ +**To create an account** + +The following ``create-account`` example creates an Amazon Chime account under the administrator's AWS account. :: + + aws chime create-account \ + --name MyChimeAccount + +Output:: + + { + "Account": { + "AwsAccountId": "111122223333", + "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "Name": "MyChimeAccount", + "AccountType": "Team", + "CreatedTimestamp": "2019-01-04T17:11:22.003Z", + "DefaultLicense": "Pro", + "SupportedLicenses": [ + "Basic", + "Pro" + ], + "SigninDelegateGroups": [ + { + "GroupName": "myGroup" + }, + ] + } + } + +For more information, see `Getting Started `_ in the *Amazon Chime Administration Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/chime/create-bot.rst awscli-1.18.69/awscli/examples/chime/create-bot.rst --- awscli-1.11.13/awscli/examples/chime/create-bot.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/create-bot.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,26 @@ +**To create an Amazon Chime bot** + +The following ``create-bot`` example creates a bot for the specified Amazon Chime Enterprise account. :: + + aws chime create-bot \ + --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ + --display-name "myBot" \ + --domain "example.com" + +Output:: + + { + "Bot": { + "BotId": "123abcd4-5ef6-789g-0h12-34j56789012k", + "UserId": "123abcd4-5ef6-789g-0h12-34j56789012k", + "DisplayName": "myBot (Bot)", + "BotType": "ChatBot", + "Disabled": false, + "CreatedTimestamp": "2019-09-09T18:05:56.749Z", + "UpdatedTimestamp": "2019-09-09T18:05:56.749Z", + "BotEmail": "myBot-chimebot@example.com", + "SecurityToken": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" + } + } + +For more information, see `Integrate a Chat Bot with Amazon Chime `__ in the *Amazon Chime Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/create-phone-number-order.rst awscli-1.18.69/awscli/examples/chime/create-phone-number-order.rst --- awscli-1.11.13/awscli/examples/chime/create-phone-number-order.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/create-phone-number-order.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,35 @@ +**To create a phone number order** + +The following ``create-phone-number-order`` example creates a phone number order for the specified phone numbers. :: + + aws chime create-phone-number-order \ + --product-type VoiceConnector \ + --e164-phone-numbers "+12065550100" "+12065550101" "+12065550102" + +Output:: + + { + "PhoneNumberOrder": { + "PhoneNumberOrderId": "abc12345-de67-89f0-123g-h45i678j9012", + "ProductType": "VoiceConnector", + "Status": "Processing", + "OrderedPhoneNumbers": [ + { + "E164PhoneNumber": "+12065550100", + "Status": "Processing" + }, + { + "E164PhoneNumber": "+12065550101", + "Status": "Processing" + }, + { + "E164PhoneNumber": "+12065550102", + "Status": "Processing" + } + ], + "CreatedTimestamp": "2019-08-09T21:35:21.427Z", + "UpdatedTimestamp": "2019-08-09T21:35:22.408Z" + } + } + +For more information, see `Working with Phone Numbers `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/create-proxy-session.rst awscli-1.18.69/awscli/examples/chime/create-proxy-session.rst --- awscli-1.11.13/awscli/examples/chime/create-proxy-session.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/create-proxy-session.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,37 @@ +**To create a proxy session** + +The following ``create-proxy-session`` example creates a proxy session with voice and SMS capabilities. :: + + aws chime create-proxy-session \ + --voice-connector-id abcdef1ghij2klmno3pqr4 \ + --participant-phone-numbers "+14015550101" "+12065550100" \ + --capabilities "Voice" "SMS" + +Output:: + + { + "ProxySession": { + "VoiceConnectorId": "abcdef1ghij2klmno3pqr4", + "ProxySessionId": "123a4bc5-67d8-901e-2f3g-h4ghjk56789l", + "Status": "Open", + "ExpiryMinutes": 60, + "Capabilities": [ + "SMS", + "Voice" + ], + "CreatedTimestamp": "2020-04-15T16:10:10.288Z", + "UpdatedTimestamp": "2020-04-15T16:10:10.288Z", + "Participants": [ + { + "PhoneNumber": "+12065550100", + "ProxyPhoneNumber": "+19135550199" + }, + { + "PhoneNumber": "+14015550101", + "ProxyPhoneNumber": "+19135550199" + } + ] + } + } + +For more information, see `Proxy Phone Sessions `__ in the *Amazon Chime Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/create-room-membership.rst awscli-1.18.69/awscli/examples/chime/create-room-membership.rst --- awscli-1.11.13/awscli/examples/chime/create-room-membership.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/create-room-membership.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,28 @@ +**To create a room membership** + +The following ``create-room-membership`` example adds the specified user to the chat room as a chat room member. :: + + aws chime create-room-membership \ + --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ + --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j \ + --member-id 1ab2345c-67de-8901-f23g-45h678901j2k + +Output:: + + { + "RoomMembership": { + "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j", + "Member": { + "MemberId": "1ab2345c-67de-8901-f23g-45h678901j2k", + "MemberType": "User", + "Email": "janed@example.com", + "FullName": "Jane Doe", + "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45" + }, + "Role": "Member", + "InvitedBy": "arn:aws:iam::111122223333:user/alejandro", + "UpdatedTimestamp": "2019-12-02T22:36:41.969Z" + } + } + +For more information, see `Creating a Chat Room `__ in the *Amazon Chime User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/chime/create-room.rst awscli-1.18.69/awscli/examples/chime/create-room.rst --- awscli-1.11.13/awscli/examples/chime/create-room.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/create-room.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,22 @@ +**To create a chat room** + +The following ``create-room`` example creates a chat room for the specified Amazon Chime account. :: + + aws chime create-room \ + --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ + --name chatRoom + +Output:: + + { + "Room": { + "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j", + "Name": "chatRoom", + "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45", + "CreatedBy": "arn:aws:iam::111122223333:user/alejandro", + "CreatedTimestamp": "2019-12-02T22:29:31.549Z", + "UpdatedTimestamp": "2019-12-02T22:29:31.549Z" + } + } + +For more information, see `Creating a Chat Room `__ in the *Amazon Chime User Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/create-user.rst awscli-1.18.69/awscli/examples/chime/create-user.rst --- awscli-1.11.13/awscli/examples/chime/create-user.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/create-user.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/chime/create-voice-connector-group.rst awscli-1.18.69/awscli/examples/chime/create-voice-connector-group.rst --- awscli-1.11.13/awscli/examples/chime/create-voice-connector-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/create-voice-connector-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To create an Amazon Chime Voice Connector group** + +The following ``create-voice-connector-group`` example creates an Amazon Chime Voice Connector group that includes the specified Amazon Chime Voice Connector. :: + + aws chime create-voice-connector-group \ + --name myGroup \ + --voice-connector-items VoiceConnectorId=abcdef1ghij2klmno3pqr4,Priority=2 + +Output:: + + { + "VoiceConnectorGroup": { + "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.11.13/awscli/examples/chime/create-voice-connector.rst awscli-1.18.69/awscli/examples/chime/create-voice-connector.rst --- awscli-1.11.13/awscli/examples/chime/create-voice-connector.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/create-voice-connector.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,24 @@ +**To create an Amazon Chime Voice Connector** + +The following ``create-voice-connector`` example creates an Amazon Chime Voice Connector in the specified AWS Region, with encryption enabled. :: + + aws chime create-voice-connector \ + --name newVoiceConnector \ + --aws-region us-west-2 \ + --require-encryption + +Output:: + + { + "VoiceConnector": { + "VoiceConnectorId": "abcdef1ghij2klmno3pqr4", + "AwsRegion": "us-west-2", + "Name": "newVoiceConnector", + "OutboundHostName": "abcdef1ghij2klmno3pqr4.voiceconnector.chime.aws", + "RequireEncryption": true, + "CreatedTimestamp": "2019-09-18T20:34:01.352Z", + "UpdatedTimestamp": "2019-09-18T20:34:01.352Z" + } + } + +For more information, see `Working with Amazon Chime Voice Connectors `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/delete-account.rst awscli-1.18.69/awscli/examples/chime/delete-account.rst --- awscli-1.11.13/awscli/examples/chime/delete-account.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/delete-account.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To delete an account** + +The following ``delete-account`` example deletes the specified account. :: + + aws chime delete-account --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE + +This command produces no output. + +For more information, see `Deleting Your Account `_ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/delete-phone-number.rst awscli-1.18.69/awscli/examples/chime/delete-phone-number.rst --- awscli-1.11.13/awscli/examples/chime/delete-phone-number.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/delete-phone-number.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a phone number** + +The following ``delete-phone-number`` example moves the specified phone number into the deletion queue. :: + + aws chime delete-phone-number \ + --phone-number-id "+12065550100" + +This command produces no output. + +For more information, see `Working with Phone Numbers `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/delete-proxy-session.rst awscli-1.18.69/awscli/examples/chime/delete-proxy-session.rst --- awscli-1.11.13/awscli/examples/chime/delete-proxy-session.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/delete-proxy-session.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,11 @@ +**To delete a proxy session** + +The following ``delete-proxy-session`` example deletes the specified proxy session. :: + + aws chime delete-proxy-session \ + --voice-connector-id abcdef1ghij2klmno3pqr4 \ + --proxy-session-id 123a4bc5-67d8-901e-2f3g-h4ghjk56789l + +This command produces no output. + +For more information, see `Proxy Phone Sessions `__ in the *Amazon Chime Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/delete-room-membership.rst awscli-1.18.69/awscli/examples/chime/delete-room-membership.rst --- awscli-1.11.13/awscli/examples/chime/delete-room-membership.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/delete-room-membership.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,12 @@ +**To remove a user as a member of a chat room** + +The following ``delete-room-membership`` example removes the specified member from the specified chat room. :: + + aws chime delete-room-membership \ + --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ + --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j \ + --member-id 1ab2345c-67de-8901-f23g-45h678901j2k + +This command produces no output. + +For more information, see `Creating a Chat Room `__ in the *Amazon Chime User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/chime/delete-room.rst awscli-1.18.69/awscli/examples/chime/delete-room.rst --- awscli-1.11.13/awscli/examples/chime/delete-room.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/delete-room.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To delete a chat room** + +The following ``delete-room`` example deletes the specified chat room and removes the chat room memberships. :: + + aws chime delete-room \ + --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ + --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j + +This command produces no output. + +For more information, see `Creating a Chat Room `__ in the *Amazon Chime User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/chime/delete-voice-connector-group.rst awscli-1.18.69/awscli/examples/chime/delete-voice-connector-group.rst --- awscli-1.11.13/awscli/examples/chime/delete-voice-connector-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/delete-voice-connector-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,10 @@ +**title** + +The following ``delete-voice-connector-group`` example deletes the specified Amazon Chime Voice Connector group. :: + + aws chime delete-voice-connector-group \ + --voice-connector-group-id 123a456b-c7d8-90e1-fg23-4h567jkl8901 + +This command produces no output. + +For more information, see `Working with Amazon Chime Voice Connector Groups `__ in the *Amazon Chime Administration Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/chime/delete-voice-connector-origination.rst awscli-1.18.69/awscli/examples/chime/delete-voice-connector-origination.rst --- awscli-1.11.13/awscli/examples/chime/delete-voice-connector-origination.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/delete-voice-connector-origination.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete origination settings** + +The following ``delete-voice-connector-origination`` example deletes the origination host, port, protocol, priority, and weight from the specified Amazon Chime Voice Connector. :: + + aws chime delete-voice-connector-origination \ + --voice-connector-id abcdef1ghij2klmno3pqr4 + +This command produces no output. + +For more information, see `Working with Amazon Chime Voice Connectors `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/delete-voice-connector-proxy.rst awscli-1.18.69/awscli/examples/chime/delete-voice-connector-proxy.rst --- awscli-1.11.13/awscli/examples/chime/delete-voice-connector-proxy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/delete-voice-connector-proxy.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a proxy configuration** + +The following ``delete-voice-connector-proxy`` example deletes the proxy configuration from your Amazon Chime Voice Connector. :: + + aws chime delete-voice-connector-proxy \ + --voice-connector-id abcdef1ghij2klmno3pqr4 + +This command produces no output. + +For more information, see `Proxy Phone Sessions `__ in the *Amazon Chime Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/delete-voice-connector.rst awscli-1.18.69/awscli/examples/chime/delete-voice-connector.rst --- awscli-1.11.13/awscli/examples/chime/delete-voice-connector.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/delete-voice-connector.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete an Amazon Chime Voice Connector** + +The following ``delete-voice-connector`` example doesthis :: + + aws chime delete-voice-connector \ + --voice-connector-id abcdef1ghij2klmno3pqr4 + +This command produces no output. + +For more information, see `Working with Amazon Chime Voice Connectors `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/delete-voice-connector-streaming-configuration.rst awscli-1.18.69/awscli/examples/chime/delete-voice-connector-streaming-configuration.rst --- awscli-1.11.13/awscli/examples/chime/delete-voice-connector-streaming-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/delete-voice-connector-streaming-configuration.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a streaming configuration** + +The following ``delete-voice-connector-streaming-configuration`` example deletes the streaming configuration for the specified Amazon Chime Voice Connector. :: + + aws chime delete-voice-connector-streaming-configuration \ + --voice-connector-id abcdef1ghij2klmno3pqr4 + +This command produces no output. + +For more information, see `Streaming Amazon Chime Voice Connector Data to Kinesis `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/delete-voice-connector-termination-credentials.rst awscli-1.18.69/awscli/examples/chime/delete-voice-connector-termination-credentials.rst --- awscli-1.11.13/awscli/examples/chime/delete-voice-connector-termination-credentials.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/delete-voice-connector-termination-credentials.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To delete termination credentials** + +The following ``delete-voice-connector-termination-credentials`` example deletes the termination credentials for the specified user name and Amazon Chime Voice Connector. :: + + aws chime delete-voice-connector-termination-credentials \ + --voice-connector-id abcdef1ghij2klmno3pqr4 \ + --usernames "jdoe" + +This command produces no output. + +For more information, see `Working with Amazon Chime Voice Connectors `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/delete-voice-connector-termination.rst awscli-1.18.69/awscli/examples/chime/delete-voice-connector-termination.rst --- awscli-1.11.13/awscli/examples/chime/delete-voice-connector-termination.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/delete-voice-connector-termination.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete termination settings** + +The following ``delete-voice-connector-termination`` example deletes the termination settings for the specified Amazon Chime Voice Connector. :: + + aws chime delete-voice-connector-termination \ + --voice-connector-id abcdef1ghij2klmno3pqr4 + +This command produces no output. + +For more information, see `Working with Amazon Chime Voice Connectors `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/disassociate-phone-number-from-user.rst awscli-1.18.69/awscli/examples/chime/disassociate-phone-number-from-user.rst --- awscli-1.11.13/awscli/examples/chime/disassociate-phone-number-from-user.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/disassociate-phone-number-from-user.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To disassociate a phone number from a user** + +The following ``disassociate-phone-number-from-user`` example disassociates a phone number from the specified user. :: + + aws chime disassociate-phone-number-from-user \ + --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ + --user-id 1ab2345c-67de-8901-f23g-45h678901j2k + +This command produces no output. + +For more information, see `Managing User Phone Numbers `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/disassociate-phone-numbers-from-voice-connector-group.rst awscli-1.18.69/awscli/examples/chime/disassociate-phone-numbers-from-voice-connector-group.rst --- awscli-1.11.13/awscli/examples/chime/disassociate-phone-numbers-from-voice-connector-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/disassociate-phone-numbers-from-voice-connector-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,15 @@ +**To disassociate phone numbers from an Amazon Chime Voice Connector group** + +The following ``disassociate-phone-numbers-from-voice-connector-group`` example disassociates the specified phone numbers from an Amazon Chime Voice Connector group. :: + + aws chime disassociate-phone-numbers-from-voice-connector-group \ + --voice-connector-group-id 123a456b-c7d8-90e1-fg23-4h567jkl8901 \ + --e164-phone-numbers "+12065550100" "+12065550101" + +Output:: + + { + "PhoneNumberErrors": [] + } + +For more information, see `Working with Amazon Chime Voice Connector Groups `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/disassociate-phone-numbers-from-voice-connector.rst awscli-1.18.69/awscli/examples/chime/disassociate-phone-numbers-from-voice-connector.rst --- awscli-1.11.13/awscli/examples/chime/disassociate-phone-numbers-from-voice-connector.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/disassociate-phone-numbers-from-voice-connector.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,15 @@ +**To disassociate phone numbers from an Amazon Chime Voice Connector** + +The following ``disassociate-phone-numbers-from-voice-connector`` example disassociates the specified phone numbers from an Amazon Chime Voice Connector. :: + + aws chime disassociate-phone-numbers-from-voice-connector \ + --voice-connector-id abcdef1ghij2klmno3pqr4 \ + --e164-phone-numbers "+12065550100" "+12065550101" + +Output:: + + { + "PhoneNumberErrors": [] + } + +For more information, see `Working with Amazon Chime Voice Connectors `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/disassociate-signin-delegate-groups-from-account.rst awscli-1.18.69/awscli/examples/chime/disassociate-signin-delegate-groups-from-account.rst --- awscli-1.11.13/awscli/examples/chime/disassociate-signin-delegate-groups-from-account.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/disassociate-signin-delegate-groups-from-account.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/chime/get-account.rst awscli-1.18.69/awscli/examples/chime/get-account.rst --- awscli-1.11.13/awscli/examples/chime/get-account.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/get-account.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,30 @@ +**To retrieve the details for an account** + +The following ``get-account`` example retrieves the details for the specified Amazon Chime account. :: + + aws chime get-account \ + --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE + +Output:: + + { + "Account": { + "AwsAccountId": "111122223333", + "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "Name": "EnterpriseDirectory", + "AccountType": "EnterpriseDirectory", + "CreatedTimestamp": "2018-12-20T18:38:02.181Z", + "DefaultLicense": "Pro", + "SupportedLicenses": [ + "Basic", + "Pro" + ], + "SigninDelegateGroups": [ + { + "GroupName": "myGroup" + }, + ] + } + } + +For more information, see `Managing Your Amazon Chime Accounts `_ in the *Amazon Chime Administration Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/chime/get-account-settings.rst awscli-1.18.69/awscli/examples/chime/get-account-settings.rst --- awscli-1.11.13/awscli/examples/chime/get-account-settings.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/get-account-settings.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,16 @@ +**To retrieve settings for an account** + +The following ``get-account-settings`` example retrieves the account settings for the specified account. :: + + aws chime get-account-settings --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE + +Output:: + + { + "AccountSettings": { + "DisableRemoteControl": false, + "EnableDialOut": false + } + } + +For more information, see `Managing Your Amazon Chime Accounts `_ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/get-bot.rst awscli-1.18.69/awscli/examples/chime/get-bot.rst --- awscli-1.11.13/awscli/examples/chime/get-bot.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/get-bot.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,25 @@ +**To retrieve details about a bot** + +The following ``get-bot`` example displays the details for the specified bot. :: + + aws chime get-bot \ + --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ + --bot-id 123abcd4-5ef6-789g-0h12-34j56789012k + +Output:: + + { + "Bot": { + "BotId": "123abcd4-5ef6-789g-0h12-34j56789012k", + "UserId": "123abcd4-5ef6-789g-0h12-34j56789012k", + "DisplayName": "myBot (Bot)", + "BotType": "ChatBot", + "Disabled": false, + "CreatedTimestamp": "2019-09-09T18:05:56.749Z", + "UpdatedTimestamp": "2019-09-09T18:05:56.749Z", + "BotEmail": "myBot-chimebot@example.com", + "SecurityToken": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" + } + } + +For more information, see `Update Chat Bots `__ in the *Amazon Chime Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/get-global-settings.rst awscli-1.18.69/awscli/examples/chime/get-global-settings.rst --- awscli-1.11.13/awscli/examples/chime/get-global-settings.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/get-global-settings.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To get global settings** + +The following ``get-global-settings`` example retrieves the S3 bucket names used to store call detail records for Amazon Chime Business Calling and Amazon Chime Voice Connectors associated with the administrator's AWS account. :: + + aws chime get-global-settings + +Output:: + + { + "BusinessCalling": { + "CdrBucket": "s3bucket" + }, + "VoiceConnector": { + "CdrBucket": "s3bucket" + } + } + +For more information, see `Managing Global Settings `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/get-phone-number-order.rst awscli-1.18.69/awscli/examples/chime/get-phone-number-order.rst --- awscli-1.11.13/awscli/examples/chime/get-phone-number-order.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/get-phone-number-order.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,34 @@ +**To get details for a phone number order** + +The following ``get-phone-number-order`` example displays the details of the specified phone number order. :: + + aws chime get-phone-number-order \ + --phone-number-order-id abc12345-de67-89f0-123g-h45i678j9012 + +Output:: + + { + "PhoneNumberOrder": { + "PhoneNumberOrderId": "abc12345-de67-89f0-123g-h45i678j9012", + "ProductType": "VoiceConnector", + "Status": "Partial", + "OrderedPhoneNumbers": [ + { + "E164PhoneNumber": "+12065550100", + "Status": "Acquired" + }, + { + "E164PhoneNumber": "+12065550101", + "Status": "Acquired" + }, + { + "E164PhoneNumber": "+12065550102", + "Status": "Failed" + } + ], + "CreatedTimestamp": "2019-08-09T21:35:21.427Z", + "UpdatedTimestamp": "2019-08-09T21:35:31.926Z" + } + } + +For more information, see `Working with Phone Numbers `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/get-phone-number.rst awscli-1.18.69/awscli/examples/chime/get-phone-number.rst --- awscli-1.11.13/awscli/examples/chime/get-phone-number.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/get-phone-number.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,38 @@ +**To get phone number details** + +The following ``get-phone-number`` example displays the details of the specified phone number. :: + + aws chime get-phone-number \ + --phone-number-id +12065550100 + +Output:: + + { + "PhoneNumber": { + "PhoneNumberId": "%2B12065550100", + "E164PhoneNumber": "+12065550100", + "Type": "Local", + "ProductType": "VoiceConnector", + "Status": "Unassigned", + "Capabilities": { + "InboundCall": true, + "OutboundCall": true, + "InboundSMS": true, + "OutboundSMS": true, + "InboundMMS": true, + "OutboundMMS": true + }, + "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" + } + } + +For more information, see `Working with Phone Numbers `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/get-phone-number-settings.rst awscli-1.18.69/awscli/examples/chime/get-phone-number-settings.rst --- awscli-1.11.13/awscli/examples/chime/get-phone-number-settings.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/get-phone-number-settings.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,16 @@ +**To retrieve an outbound calling name** + +The following ``get-phone-number-settings`` example retrieves the default outbound calling name for the calling user's AWS account. :: + + aws chime get-phone-number-settings + +This command produces no output. +Output:: + + { + "CallingName": "myName", + "CallingNameUpdatedTimestamp": "2019-10-28T18:56:42.911Z" + } + + +For more information, see `Working with Phone Numbers `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/get-proxy-session.rst awscli-1.18.69/awscli/examples/chime/get-proxy-session.rst --- awscli-1.11.13/awscli/examples/chime/get-proxy-session.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/get-proxy-session.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,36 @@ +**To get proxy session details** + +The following ``get-proxy-session`` example lists the details of the specified proxy session. :: + + aws chime get-proxy-session \ + --voice-connector-id abcdef1ghij2klmno3pqr4 \ + --proxy-session-id 123a4bc5-67d8-901e-2f3g-h4ghjk56789l + +Output:: + + { + "ProxySession": { + "VoiceConnectorId": "abcdef1ghij2klmno3pqr4", + "ProxySessionId": "123a4bc5-67d8-901e-2f3g-h4ghjk56789l", + "Status": "Open", + "ExpiryMinutes": 60, + "Capabilities": [ + "SMS", + "Voice" + ], + "CreatedTimestamp": "2020-04-15T16:10:10.288Z", + "UpdatedTimestamp": "2020-04-15T16:10:10.288Z", + "Participants": [ + { + "PhoneNumber": "+12065550100", + "ProxyPhoneNumber": "+19135550199" + }, + { + "PhoneNumber": "+14015550101", + "ProxyPhoneNumber": "+19135550199" + } + ] + } + } + +For more information, see `Proxy Phone Sessions `__ in the *Amazon Chime Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/get-room.rst awscli-1.18.69/awscli/examples/chime/get-room.rst --- awscli-1.11.13/awscli/examples/chime/get-room.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/get-room.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,22 @@ +**To get the details about a chat room** + +The following ``get-room`` example displays details about the specified chat room. :: + + aws chime get-room \ + --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ + --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j + +Output:: + + { + "Room": { + "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j", + "Name": "chatRoom", + "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45", + "CreatedBy": "arn:aws:iam::111122223333:user/alejandro", + "CreatedTimestamp": "2019-12-02T22:29:31.549Z", + "UpdatedTimestamp": "2019-12-02T22:29:31.549Z" + } + } + +For more information, see `Creating a Chat Room `__ in the *Amazon Chime User Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/get-user.rst awscli-1.18.69/awscli/examples/chime/get-user.rst --- awscli-1.11.13/awscli/examples/chime/get-user.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/get-user.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,29 @@ +**To get details about a user** + +The following ``get-user`` example retrieves the details for the specified user. :: + + aws chime get-user \ + --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ + --user-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE + +Output:: + + { + "User": { + "UserId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", + "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "PrimaryEmail": "marthar@example.com", + "DisplayName": "Martha Rivera", + "LicenseType": "Pro", + "UserRegistrationStatus": "Registered", + "RegisteredOn": "2018-12-20T18:45:25.231Z", + "InvitedOn": "2018-12-20T18:45:25.231Z", + "AlexaForBusinessMetadata": { + "IsAlexaForBusinessEnabled": False, + "AlexaForBusinessRoomArn": "null" + }, + "PersonalPIN": "XXXXXXXXXX" + } + } + +For more information, see `Managing Users `_ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/get-user-settings.rst awscli-1.18.69/awscli/examples/chime/get-user-settings.rst --- awscli-1.11.13/awscli/examples/chime/get-user-settings.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/get-user-settings.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To retrieve user settings** + +The following ``get-user-settings`` example displays the specified user settings. :: + + aws chime get-user-settings \ + --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ + --user-id 1ab2345c-67de-8901-f23g-45h678901j2k + +Output:: + + { + "UserSettings": { + "Telephony": { + "InboundCalling": true, + "OutboundCalling": true, + "SMS": true + } + } + } + +For more information, see `Managing User Phone Numbers `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/get-voice-connector-group.rst awscli-1.18.69/awscli/examples/chime/get-voice-connector-group.rst --- awscli-1.11.13/awscli/examples/chime/get-voice-connector-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/get-voice-connector-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,20 @@ +**To get details for an Amazon Chime Voice Connector group** + +The following ``get-voice-connector-group`` example displays details for the specified Amazon Chime Voice Connector group. :: + + aws chime get-voice-connector-group \ + --voice-connector-group-id 123a456b-c7d8-90e1-fg23-4h567jkl8901 + +Output:: + + { + "VoiceConnectorGroup": { + "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.11.13/awscli/examples/chime/get-voice-connector-logging-configuration.rst awscli-1.18.69/awscli/examples/chime/get-voice-connector-logging-configuration.rst --- awscli-1.11.13/awscli/examples/chime/get-voice-connector-logging-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/get-voice-connector-logging-configuration.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To get logging configuration details** + +The following ``get-voice-connector-logging-configuration`` example retreives the logging configuration details for the specified Amazon Chime Voice Connector. :: + + aws chime get-voice-connector-logging-configuration \ + --voice-connector-id abcdef1ghij2klmno3pqr4 + +Output:: + + { + "LoggingConfiguration": { + "EnableSIPLogs": true + } + } + + +For more information, see `Streaming Amazon Chime Voice Connector Media to Kinesis `__ in the *Amazon Chime Administration Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/chime/get-voice-connector-origination.rst awscli-1.18.69/awscli/examples/chime/get-voice-connector-origination.rst --- awscli-1.11.13/awscli/examples/chime/get-voice-connector-origination.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/get-voice-connector-origination.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,25 @@ +**To retrieve origination settings** + +The following ``get-voice-connector-origination`` example retrieves the origination host, port, protocol, priority, and weight for the specified Amazon Chime Voice Connector. :: + + aws chime get-voice-connector-origination \ + --voice-connector-id abcdef1ghij2klmno3pqr4 + +Output:: + + { + "Origination": { + "Routes": [ + { + "Host": "10.24.34.0", + "Port": 1234, + "Protocol": "TCP", + "Priority": 1, + "Weight": 5 + } + ], + "Disabled": false + } + } + +For more information, see `Working with Amazon Chime Voice Connectors `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/get-voice-connector-proxy.rst awscli-1.18.69/awscli/examples/chime/get-voice-connector-proxy.rst --- awscli-1.11.13/awscli/examples/chime/get-voice-connector-proxy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/get-voice-connector-proxy.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,20 @@ +**To get proxy configuration details** + +The following ``get-voice-connector-proxy`` example gets the proxy configuration details for your Amazon Chime Voice Connector. :: + + aws chime get-voice-connector-proxy \ + --voice-connector-id abcdef1ghij2klmno3pqr4 + +Output:: + + { + "Proxy": { + "DefaultSessionExpiryMinutes": 60, + "Disabled": false, + "PhoneNumberCountries": [ + "US" + ] + } + } + +For more information, see `Proxy Phone Sessions `__ in the *Amazon Chime Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/get-voice-connector.rst awscli-1.18.69/awscli/examples/chime/get-voice-connector.rst --- awscli-1.11.13/awscli/examples/chime/get-voice-connector.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/get-voice-connector.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,22 @@ +**To get details for an Amazon Chime Voice Connector** + +The following ``get-voice-connector`` example displays the details of the specified Amazon Chime Voice Connector. :: + + aws chime get-voice-connector \ + --voice-connector-id abcdef1ghij2klmno3pqr4 + +Output:: + + { + "VoiceConnector": { + "VoiceConnectorId": "abcdef1ghij2klmno3pqr4", + "AwsRegion": "us-west-2", + "Name": "newVoiceConnector", + "OutboundHostName": "abcdef1ghij2klmno3pqr4.voiceconnector.chime.aws", + "RequireEncryption": true, + "CreatedTimestamp": "2019-09-18T20:34:01.352Z", + "UpdatedTimestamp": "2019-09-18T20:34:01.352Z" + } + } + +For more information, see `Working with Amazon Chime Voice Connectors `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/get-voice-connector-streaming-configuration.rst awscli-1.18.69/awscli/examples/chime/get-voice-connector-streaming-configuration.rst --- awscli-1.11.13/awscli/examples/chime/get-voice-connector-streaming-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/get-voice-connector-streaming-configuration.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To get streaming configuration details** + +The following ``get-voice-connector-streaming-configuration`` example gets the streaming configuration details for the specified Amazon Chime Voice Connector. :: + + aws chime get-voice-connector-streaming-configuration \ + --voice-connector-id abcdef1ghij2klmno3pqr4 + +Output:: + + { + "StreamingConfiguration": { + "DataRetentionInHours": 24, + "Disabled": false + } + } + +For more information, see `Streaming Amazon Chime Voice Connector Data to Kinesis `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/get-voice-connector-termination-health.rst awscli-1.18.69/awscli/examples/chime/get-voice-connector-termination-health.rst --- awscli-1.11.13/awscli/examples/chime/get-voice-connector-termination-health.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/get-voice-connector-termination-health.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To retrieve termination health details** + +The following ``get-voice-connector-termination-health`` example retrieves the termination health details for the specified Amazon Chime Voice Connector. :: + + aws chime get-voice-connector-termination-health \ + --voice-connector-id abcdef1ghij2klmno3pqr4 + +Output:: + + { + "TerminationHealth": { + "Timestamp": "Fri Aug 23 16:45:55 UTC 2019", + "Source": "10.24.34.0" + } + } + +For more information, see `Working with Amazon Chime Voice Connectors `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/get-voice-connector-termination.rst awscli-1.18.69/awscli/examples/chime/get-voice-connector-termination.rst --- awscli-1.11.13/awscli/examples/chime/get-voice-connector-termination.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/get-voice-connector-termination.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,25 @@ +**To retrieve termination settings** + +The following ``get-voice-connector-termination`` example retrieves the termination settings for the specified Amazon Chime Voice Connector. :: + + aws chime get-voice-connector-termination \ + --voice-connector-id abcdef1ghij2klmno3pqr4 + +This command produces no output. +Output:: + + { + "Termination": { + "CpsLimit": 1, + "DefaultPhoneNumber": "+12065550100", + "CallingRegions": [ + "US" + ], + "CidrAllowedList": [ + "10.24.34.0/23" + ], + "Disabled": false + } + } + +For more information, see `Working with Amazon Chime Voice Connectors `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/invite-users.rst awscli-1.18.69/awscli/examples/chime/invite-users.rst --- awscli-1.11.13/awscli/examples/chime/invite-users.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/invite-users.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,28 @@ +**To invite users to join Amazon Chime** + +The following ``invite-users`` example sends an email to invite a user to the specified Amazon Chime account. :: + + aws chime invite-users \ + --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ + --user-email-list "alejandror@example.com" "janed@example.com" + +Output:: + + { + "Invites": [ + { + "InviteId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", + "Status": "Pending", + "EmailAddress": "alejandror@example.com", + "EmailStatus": "Sent" + } + { + "InviteId": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE", + "Status": "Pending", + "EmailAddress": "janed@example.com", + "EmailStatus": "Sent" + } + ] + } + +For more information, see `Inviting and Suspending Users `_ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/list-accounts.rst awscli-1.18.69/awscli/examples/chime/list-accounts.rst --- awscli-1.11.13/awscli/examples/chime/list-accounts.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/list-accounts.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,48 @@ +**To get a list of accounts** + +The following ``list-accounts`` example retrieves a list of the Amazon Chime accounts in the administrator's AWS account. :: + + aws chime list-accounts + +Output:: + + { + "Accounts": [ + { + "AwsAccountId": "111122223333", + "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "Name": "First Chime Account", + "AccountType": "EnterpriseDirectory", + "CreatedTimestamp": "2018-12-20T18:38:02.181Z", + "DefaultLicense": "Pro", + "SupportedLicenses": [ + "Basic", + "Pro" + ], + "SigninDelegateGroups": [ + { + "GroupName": "myGroup" + }, + ] + }, + { + "AwsAccountId": "111122223333", + "AccountId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", + "Name": "Second Chime Account", + "AccountType": "Team", + "CreatedTimestamp": "2018-09-04T21:44:22.292Z", + "DefaultLicense": "Pro", + "SupportedLicenses": [ + "Basic", + "Pro" + ], + "SigninDelegateGroups": [ + { + "GroupName": "myGroup" + }, + ] + } + ] + } + +For more information, see `Managing Your Amazon Chime Accounts `_ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/list-bots.rst awscli-1.18.69/awscli/examples/chime/list-bots.rst --- awscli-1.11.13/awscli/examples/chime/list-bots.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/list-bots.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,24 @@ +**To retrieve a list of bots** + +The following ``list-bots`` example lists the bots associated with the specified Amazon Chime Enterprise account. :: + + aws chime list-bots \ + --account-id 12a3456b-7c89-012d-3456-78901e23fg45 + +Output:: + + { + "Bot": { + "BotId": "123abcd4-5ef6-789g-0h12-34j56789012k", + "UserId": "123abcd4-5ef6-789g-0h12-34j56789012k", + "DisplayName": "myBot (Bot)", + "BotType": "ChatBot", + "Disabled": false, + "CreatedTimestamp": "2019-09-09T18:05:56.749Z", + "UpdatedTimestamp": "2019-09-09T18:05:56.749Z", + "BotEmail": "myBot-chimebot@example.com", + "SecurityToken": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" + } + } + +For more information, see `Use Chat Bots with Amazon Chime `__ in the *Amazon Chime Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/list-phone-number-orders.rst awscli-1.18.69/awscli/examples/chime/list-phone-number-orders.rst --- awscli-1.11.13/awscli/examples/chime/list-phone-number-orders.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/list-phone-number-orders.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,56 @@ +**To list phone number orders** + +The following ``list-phone-number-orders`` example lists the phone number orders associated with the Amazon Chime administrator's account. :: + + aws chime list-phone-number-orders + +Output:: + + { + "PhoneNumberOrders": [ + { + "PhoneNumberOrderId": "abc12345-de67-89f0-123g-h45i678j9012", + "ProductType": "VoiceConnector", + "Status": "Partial", + "OrderedPhoneNumbers": [ + { + "E164PhoneNumber": "+12065550100", + "Status": "Acquired" + }, + { + "E164PhoneNumber": "+12065550101", + "Status": "Acquired" + }, + { + "E164PhoneNumber": "+12065550102", + "Status": "Failed" + } + ], + "CreatedTimestamp": "2019-08-09T21:35:21.427Z", + "UpdatedTimestamp": "2019-08-09T21:35:31.926Z" + } + { + "PhoneNumberOrderId": "cba54321-ed76-09f5-321g-h54i876j2109", + "ProductType": "BusinessCalling", + "Status": "Partial", + "OrderedPhoneNumbers": [ + { + "E164PhoneNumber": "+12065550103", + "Status": "Acquired" + }, + { + "E164PhoneNumber": "+12065550104", + "Status": "Acquired" + }, + { + "E164PhoneNumber": "+12065550105", + "Status": "Failed" + } + ], + "CreatedTimestamp": "2019-08-09T21:35:21.427Z", + "UpdatedTimestamp": "2019-08-09T21:35:31.926Z" + } + ] + } + +For more information, see `Working with Phone Numbers `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/list-phone-numbers.rst awscli-1.18.69/awscli/examples/chime/list-phone-numbers.rst --- awscli-1.11.13/awscli/examples/chime/list-phone-numbers.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/list-phone-numbers.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,65 @@ +**To list phone numbers for an Amazon Chime account** + +The following ``list-phone-numbers`` example lists the phone numbers associated with the administrator's Amazon Chime account. :: + + aws chime list-phone-numbers + +This command produces no output. +Output:: + + { + "PhoneNumbers": [ + { + "PhoneNumberId": "%2B12065550100", + "E164PhoneNumber": "+12065550100", + "Type": "Local", + "ProductType": "VoiceConnector", + "Status": "Assigned", + "Capabilities": { + "InboundCall": true, + "OutboundCall": true, + "InboundSMS": true, + "OutboundSMS": true, + "InboundMMS": true, + "OutboundMMS": true + }, + "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": "Assigned", + "Capabilities": { + "InboundCall": true, + "OutboundCall": true, + "InboundSMS": true, + "OutboundSMS": true, + "InboundMMS": true, + "OutboundMMS": true + }, + "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" + } + ] + } + +For more information, see `Working with Phone Numbers `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/list-proxy-sessions.rst awscli-1.18.69/awscli/examples/chime/list-proxy-sessions.rst --- awscli-1.11.13/awscli/examples/chime/list-proxy-sessions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/list-proxy-sessions.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,35 @@ +**To list proxy sessions** + +The following ``list-proxy-sessions`` example lists the proxy sessions for your Amazon Chime Voice Connector. :: + + aws chime list-proxy-sessions \ + --voice-connector-id abcdef1ghij2klmno3pqr4 + +Output:: + + { + "ProxySession": { + "VoiceConnectorId": "abcdef1ghij2klmno3pqr4", + "ProxySessionId": "123a4bc5-67d8-901e-2f3g-h4ghjk56789l", + "Status": "Open", + "ExpiryMinutes": 60, + "Capabilities": [ + "SMS", + "Voice" + ], + "CreatedTimestamp": "2020-04-15T16:10:10.288Z", + "UpdatedTimestamp": "2020-04-15T16:10:10.288Z", + "Participants": [ + { + "PhoneNumber": "+12065550100", + "ProxyPhoneNumber": "+19135550199" + }, + { + "PhoneNumber": "+14015550101", + "ProxyPhoneNumber": "+19135550199" + } + ] + } + } + +For more information, see `Proxy Phone Sessions `__ in the *Amazon Chime Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/list-room-memberships.rst awscli-1.18.69/awscli/examples/chime/list-room-memberships.rst --- awscli-1.11.13/awscli/examples/chime/list-room-memberships.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/list-room-memberships.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,42 @@ +**To list room memberships** + +The following ``list-room-memberships`` example displays a list of the membership details for the specified chat room. :: + + aws chime list-room-memberships \ + --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ + --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j + +Output:: + + { + "RoomMemberships": [ + { + "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j", + "Member": { + "MemberId": "2ab2345c-67de-8901-f23g-45h678901j2k", + "MemberType": "User", + "Email": "zhangw@example.com", + "FullName": "Zhang Wei", + "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45" + }, + "Role": "Member", + "InvitedBy": "arn:aws:iam::111122223333:user/alejandro", + "UpdatedTimestamp": "2019-12-02T22:46:58.532Z" + }, + { + "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j", + "Member": { + "MemberId": "1ab2345c-67de-8901-f23g-45h678901j2k", + "MemberType": "User", + "Email": "janed@example.com", + "FullName": "Jane Doe", + "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45" + }, + "Role": "Administrator", + "InvitedBy": "arn:aws:iam::111122223333:user/alejandro", + "UpdatedTimestamp": "2019-12-02T22:46:58.532Z" + } + ] + } + +For more information, see `Creating a Chat Room `__ in the *Amazon Chime User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/chime/list-rooms.rst awscli-1.18.69/awscli/examples/chime/list-rooms.rst --- awscli-1.11.13/awscli/examples/chime/list-rooms.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/list-rooms.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,22 @@ +**To list chat rooms** + +The following ``list-rooms`` example displays a list of chat rooms in the specified account. The list is filtered to only those chat rooms that the specified member belongs to. :: + + aws chime list-rooms \ + --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ + --member-id 1ab2345c-67de-8901-f23g-45h678901j2k + +Output:: + + { + "Room": { + "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j", + "Name": "teamRoom", + "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45", + "CreatedBy": "arn:aws:iam::111122223333:user/alejandro", + "CreatedTimestamp": "2019-12-02T22:29:31.549Z", + "UpdatedTimestamp": "2019-12-02T22:33:19.310Z" + } + } + +For more information, see `Creating a Chat Room `__ in the *Amazon Chime User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/chime/list-users.rst awscli-1.18.69/awscli/examples/chime/list-users.rst --- awscli-1.11.13/awscli/examples/chime/list-users.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/list-users.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,66 @@ +**To list the users in an account** + +The following ``list-users`` example lists the users for the specified Amazon Chime account. :: + + aws chime list-users --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE + +Output:: + + { + "Users": [ + { + "UserId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", + "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "PrimaryEmail": "mariag@example.com", + "DisplayName": "Maria Garcia", + "LicenseType": "Pro", + "UserType": "PrivateUser", + "UserRegistrationStatus": "Registered", + "RegisteredOn": "2018-12-20T18:45:25.231Z" + "AlexaForBusinessMetadata": { + "IsAlexaForBusinessEnabled": false + } + }, + { + "UserId": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE", + "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "PrimaryEmail": "richardr@example.com", + "DisplayName": "Richard Roe", + "LicenseType": "Pro", + "UserType": "PrivateUser", + "UserRegistrationStatus": "Registered", + "RegisteredOn": "2018-12-20T18:45:45.415Z" + "AlexaForBusinessMetadata": { + "IsAlexaForBusinessEnabled": false + } + }, + { + "UserId": "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE", + "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "PrimaryEmail": "saanvis@example.com", + "DisplayName": "Saanvi Sarkar", + "LicenseType": "Basic", + "UserType": "PrivateUser", + "UserRegistrationStatus": "Registered", + "RegisteredOn": "2018-12-20T18:46:57.747Z" + "AlexaForBusinessMetadata": { + "IsAlexaForBusinessEnabled": false + } + }, + { + "UserId": "a1b2c3d4-5678-90ab-cdef-55555EXAMPLE", + "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "PrimaryEmail": "wxiulan@example.com", + "DisplayName": "Wang Xiulan", + "LicenseType": "Basic", + "UserType": "PrivateUser", + "UserRegistrationStatus": "Registered", + "RegisteredOn": "2018-12-20T18:47:15.390Z" + "AlexaForBusinessMetadata": { + "IsAlexaForBusinessEnabled": false + } + } + ] + } + +For more information, see `Managing Users `_ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/list-voice-connector-groups.rst awscli-1.18.69/awscli/examples/chime/list-voice-connector-groups.rst --- awscli-1.11.13/awscli/examples/chime/list-voice-connector-groups.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/list-voice-connector-groups.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/chime/list-voice-connectors.rst awscli-1.18.69/awscli/examples/chime/list-voice-connectors.rst --- awscli-1.11.13/awscli/examples/chime/list-voice-connectors.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/list-voice-connectors.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,32 @@ +**To list Amazon Chime Voice Connectors for an account** + +The following ``list-voice-connectors`` example lists the Amazon Chime Voice Connectors associated with the caller's account. :: + + aws chime list-voice-connectors + +Output:: + + { + "VoiceConnectors": [ + { + "VoiceConnectorId": "abcdef1ghij2klmno3pqr4", + "AwsRegion": "us-east-1", + "Name": "MyVoiceConnector", + "OutboundHostName": "abcdef1ghij2klmno3pqr4.voiceconnector.chime.aws", + "RequireEncryption": true, + "CreatedTimestamp": "2019-06-04T18:46:56.508Z", + "UpdatedTimestamp": "2019-09-18T16:33:00.806Z" + }, + { + "VoiceConnectorId": "cbadef1ghij2klmno3pqr5", + "AwsRegion": "us-west-2", + "Name": "newVoiceConnector", + "OutboundHostName": "cbadef1ghij2klmno3pqr5.voiceconnector.chime.aws", + "RequireEncryption": true, + "CreatedTimestamp": "2019-09-18T20:34:01.352Z", + "UpdatedTimestamp": "2019-09-18T20:34:01.352Z" + } + ] + } + +For more information, see `Working with Amazon Chime Voice Connectors `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/list-voice-connector-termination-credentials.rst awscli-1.18.69/awscli/examples/chime/list-voice-connector-termination-credentials.rst --- awscli-1.11.13/awscli/examples/chime/list-voice-connector-termination-credentials.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/list-voice-connector-termination-credentials.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To retrieve a list of termination credentials** + +The following ``list-voice-connector-termination-credentials`` example retrieves a list of the termination credentials for the specified Amazon Chime Voice Connector. :: + + aws chime list-voice-connector-termination-credentials \ + --voice-connector-id abcdef1ghij2klmno3pqr4 + +This command produces no output. +Output:: + + { + "Usernames": [ + "jdoe" + ] + } + +For more information, see `Working with Amazon Chime Voice Connectors `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/logout-user.rst awscli-1.18.69/awscli/examples/chime/logout-user.rst --- awscli-1.11.13/awscli/examples/chime/logout-user.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/logout-user.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To log out a user** + +The following ``logout-user`` example logs out the specified user. :: + + aws chime logout-user \ + --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ + --user-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/chime/put-voice-connector-logging-configuration.rst awscli-1.18.69/awscli/examples/chime/put-voice-connector-logging-configuration.rst --- awscli-1.11.13/awscli/examples/chime/put-voice-connector-logging-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/put-voice-connector-logging-configuration.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To add a logging configuration for an Amazon Chime Voice Connector** + +The following ``put-voice-connector-logging-configuration`` example turns on the SIP logging configuration for the specified Amazon Chime Voice Connector. :: + + aws chime put-voice-connector-logging-configuration \ + --voice-connector-id abcdef1ghij2klmno3pqr4 \ + --logging-configuration EnableSIPLogs=true + +Output:: + + { + "LoggingConfiguration": { + "EnableSIPLogs": true + } + } + +For more information, see `Streaming Amazon Chime Voice Connector Media to Kinesis `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/put-voice-connector-origination.rst awscli-1.18.69/awscli/examples/chime/put-voice-connector-origination.rst --- awscli-1.11.13/awscli/examples/chime/put-voice-connector-origination.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/put-voice-connector-origination.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,26 @@ +**To set up origination settings** + +The following ``put-voice-connector-origination`` example sets up the origination host, port, protocol, priority, and weight for the specified Amazon Chime Voice Connector. :: + + aws chime put-voice-connector-origination \ + --voice-connector-id abcdef1ghij2klmno3pqr4 \ + --origination Routes=[{Host="10.24.34.0",Port=1234,Protocol="TCP",Priority=1,Weight=5}],Disabled=false + +Output:: + + { + "Origination": { + "Routes": [ + { + "Host": "10.24.34.0", + "Port": 1234, + "Protocol": "TCP", + "Priority": 1, + "Weight": 5 + } + ], + "Disabled": false + } + } + +For more information, see `Working with Amazon Chime Voice Connectors `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/put-voice-connector-proxy.rst awscli-1.18.69/awscli/examples/chime/put-voice-connector-proxy.rst --- awscli-1.11.13/awscli/examples/chime/put-voice-connector-proxy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/put-voice-connector-proxy.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,22 @@ +**To put a proxy configuration** + +The following ``put-voice-connector-proxy`` example sets a proxy configuration to your Amazon Chime Voice Connector. :: + + aws chime put-voice-connector-proxy \ + --voice-connector-id abcdef1ghij2klmno3pqr4 \ + --default-session-expiry-minutes 60 \ + --phone-number-pool-countries "US" + +Output:: + + { + "Proxy": { + "DefaultSessionExpiryMinutes": 60, + "Disabled": false, + "PhoneNumberCountries": [ + "US" + ] + } + } + +For more information, see `Proxy Phone Sessions `__ in the *Amazon Chime Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/put-voice-connector-streaming-configuration.rst awscli-1.18.69/awscli/examples/chime/put-voice-connector-streaming-configuration.rst --- awscli-1.11.13/awscli/examples/chime/put-voice-connector-streaming-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/put-voice-connector-streaming-configuration.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To create a streaming configuration** + +The following ``put-voice-connector-streaming-configuration`` example creates a streaming configuration for the specified Amazon Chime Voice Connector. It enables media streaming from the Amazon Chime Voice Connector to Amazon Kinesis, and sets the data retention period to 24 hours. :: + + aws chime put-voice-connector-streaming-configuration \ + --voice-connector-id abcdef1ghij2klmno3pqr4 \ + --streaming-configuration DataRetentionInHours=24,Disabled=false + +Output:: + + { + "StreamingConfiguration": { + "DataRetentionInHours": 24, + "Disabled": false + } + } + +For more information, see `Streaming Amazon Chime Voice Connector Data to Kinesis `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/put-voice-connector-termination-credentials.rst awscli-1.18.69/awscli/examples/chime/put-voice-connector-termination-credentials.rst --- awscli-1.11.13/awscli/examples/chime/put-voice-connector-termination-credentials.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/put-voice-connector-termination-credentials.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To set up termination credentials** + +The following ``put-voice-connector-termination-credentials`` example sets termination credentials for the specified Amazon Chime Voice Connector. :: + + aws chime put-voice-connector-termination-credentials \ + --voice-connector-id abcdef1ghij2klmno3pqr4 \ + --credentials Username="jdoe",Password="XXXXXXXX" + +This command produces no output. + +For more information, see `Working with Amazon Chime Voice Connectors `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/put-voice-connector-termination.rst awscli-1.18.69/awscli/examples/chime/put-voice-connector-termination.rst --- awscli-1.11.13/awscli/examples/chime/put-voice-connector-termination.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/put-voice-connector-termination.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,24 @@ +**To set up termination settings** + +The following ``put-voice-connector-termination`` example sets the calling regions and allowed IP host termination settings for the specified Amazon Chime Voice Connector. :: + + aws chime put-voice-connector-termination \ + --voice-connector-id abcdef1ghij2klmno3pqr4 \ + --termination CallingRegions="US",CidrAllowedList="10.24.34.0/23",Disabled=false + +Output:: + + { + "Termination": { + "CpsLimit": 0, + "CallingRegions": [ + "US" + ], + "CidrAllowedList": [ + "10.24.34.0/23" + ], + "Disabled": false + } + } + +For more information, see `Working with Amazon Chime Voice Connectors `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/regenerate-security-token.rst awscli-1.18.69/awscli/examples/chime/regenerate-security-token.rst --- awscli-1.11.13/awscli/examples/chime/regenerate-security-token.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/regenerate-security-token.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,26 @@ +**To regenerate a security token** + +The following ``regenerate-security-token`` example regenerates the security token for the specified bot. :: + + aws chime regenerate-security-token \ + --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ + --bot-id 123abcd4-5ef6-789g-0h12-34j56789012k + +Output:: + + { + "Bot": { + "BotId": "123abcd4-5ef6-789g-0h12-34j56789012k", + "UserId": "123abcd4-5ef6-789g-0h12-34j56789012k", + "DisplayName": "myBot (Bot)", + "BotType": "ChatBot", + "Disabled": false, + "CreatedTimestamp": "2019-09-09T18:05:56.749Z", + "UpdatedTimestamp": "2019-09-09T18:05:56.749Z", + "BotEmail": "myBot-chimebot@example.com", + "SecurityToken": "je7MtGbClwBF/2Zp9Utk/h3yCo8nvbEXAMPLEKEY" + } + } + + +For more information, see `Authenticate Chat Bot Requests `__ in the *Amazon Chime Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/reset-personal-pin.rst awscli-1.18.69/awscli/examples/chime/reset-personal-pin.rst --- awscli-1.11.13/awscli/examples/chime/reset-personal-pin.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/reset-personal-pin.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,29 @@ +**To reset a user's personal meeting PIN** + +The following ``reset-personal-pin`` example resets the specified user's personal meeting PIN. :: + + aws chime reset-personal-pin \ + --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE + --user-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE + +Output:: + + { + "User": { + "UserId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", + "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "PrimaryEmail": "mateo@example.com", + "DisplayName": "Mateo Jackson", + "LicenseType": "Pro", + "UserType": "PrivateUser", + "UserRegistrationStatus": "Registered", + "RegisteredOn": "2018-12-20T18:45:25.231Z", + "AlexaForBusinessMetadata": { + "IsAlexaForBusinessEnabled": False, + "AlexaForBusinessRoomArn": "null" + }, + "PersonalPIN": "XXXXXXXXXX" + } + } + +For more information, see `Changing Personal Meeting PINs `_ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/restore-phone-number.rst awscli-1.18.69/awscli/examples/chime/restore-phone-number.rst --- awscli-1.11.13/awscli/examples/chime/restore-phone-number.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/restore-phone-number.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,31 @@ +**To restore a phone number** + +The following ``restore-phone-number`` example restores the specified phone number from the deletion queue. :: + + aws chime restore-phone-number \ + --phone-number-id "+12065550100" + +Output:: + + { + "PhoneNumber": { + "PhoneNumberId": "%2B12065550100", + "E164PhoneNumber": "+12065550100", + "Type": "Local", + "ProductType": "BusinessCalling", + "Status": "Unassigned", + "Capabilities": { + "InboundCall": true, + "OutboundCall": true, + "InboundSMS": true, + "OutboundSMS": true, + "InboundMMS": true, + "OutboundMMS": true + }, + "Associations": [], + "CreatedTimestamp": "2019-08-09T21:35:21.445Z", + "UpdatedTimestamp": "2019-08-12T22:06:36.355Z" + } + } + +For more information, see `Working with Phone Numbers `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/search-available-phone-numbers.rst awscli-1.18.69/awscli/examples/chime/search-available-phone-numbers.rst --- awscli-1.11.13/awscli/examples/chime/search-available-phone-numbers.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/search-available-phone-numbers.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,25 @@ +**To search available phone numbers** + +The following ``search-available-phone-numbers`` example searches available phone numbers by area code. :: + + aws chime search-available-phone-numbers \ + --area-code "206" + +Output:: + + { + "E164PhoneNumbers": [ + "+12065550100", + "+12065550101", + "+12065550102", + "+12065550103", + "+12065550104", + "+12065550105", + "+12065550106", + "+12065550107", + "+12065550108", + "+12065550109", + ] + } + +For more information, see `Working with Phone Numbers `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/update-account.rst awscli-1.18.69/awscli/examples/chime/update-account.rst --- awscli-1.11.13/awscli/examples/chime/update-account.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/update-account.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,31 @@ +**To update an account** + +The following ``update-account`` example updates the specified account name. :: + + aws chime update-account \ + --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ + --name MyAccountName + +Output:: + + { + "Account": { + "AwsAccountId": "111122223333", + "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "Name": "MyAccountName", + "AccountType": "Team", + "CreatedTimestamp": "2018-09-04T21:44:22.292Z", + "DefaultLicense": "Pro", + "SupportedLicenses": [ + "Basic", + "Pro" + ], + "SigninDelegateGroups": [ + { + "GroupName": "myGroup" + }, + ] + } + } + +For more information, see `Renaming Your Account `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/update-account-settings.rst awscli-1.18.69/awscli/examples/chime/update-account-settings.rst --- awscli-1.11.13/awscli/examples/chime/update-account-settings.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/update-account-settings.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To update the settings for your account** + +The following ``update-account-settings`` example disables the remote control of shared screens for the specified Amazon Chime account. :: + + aws chime update-account-settings \ + --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ + --account-settings DisableRemoteControl=true + +This command produces no output. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/chime/update-bot.rst awscli-1.18.69/awscli/examples/chime/update-bot.rst --- awscli-1.11.13/awscli/examples/chime/update-bot.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/update-bot.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,26 @@ +**To update a bot** + +The following ``update-bot`` example updates the status of the specified bot to stop it from running. :: + + aws chime update-bot \ + --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ + --bot-id 123abcd4-5ef6-789g-0h12-34j56789012k \ + --disabled + +Output:: + + { + "Bot": { + "BotId": "123abcd4-5ef6-789g-0h12-34j56789012k", + "UserId": "123abcd4-5ef6-789g-0h12-34j56789012k", + "DisplayName": "myBot (Bot)", + "BotType": "ChatBot", + "Disabled": true, + "CreatedTimestamp": "2019-09-09T18:05:56.749Z", + "UpdatedTimestamp": "2019-09-09T18:05:56.749Z", + "BotEmail": "myBot-chimebot@example.com", + "SecurityToken": "je7MtGbClwBF/2Zp9Utk/h3yCo8nvbEXAMPLEKEY" + } + } + +For more information, see `Update Chat Bots `__ in the *Amazon Chime Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/update-global-settings.rst awscli-1.18.69/awscli/examples/chime/update-global-settings.rst --- awscli-1.11.13/awscli/examples/chime/update-global-settings.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/update-global-settings.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To update global settings** + +The following ``update-global-settings`` example updates the S3 bucket used to store call detail records for Amazon Chime Business Calling and Amazon Chime Voice Connectors associated with the administrator's AWS account. :: + + aws chime update-global-settings \ + --business-calling CdrBucket="s3bucket" \ + --voice-connector CdrBucket="s3bucket" + +This command produces no output. + +For more information, see `Managing Global Settings `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/update-phone-number.rst awscli-1.18.69/awscli/examples/chime/update-phone-number.rst --- awscli-1.11.13/awscli/examples/chime/update-phone-number.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/update-phone-number.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,65 @@ +**Example 1: To update the product type for a phone number** + +The following ``update-phone-number`` example updates the specified phone number's product type. :: + + aws chime update-phone-number \ + --phone-number-id "+12065550100" \ + --product-type "BusinessCalling" + +Output:: + + { + "PhoneNumber": { + "PhoneNumberId": "%2B12065550100", + "E164PhoneNumber": "+12065550100", + "Type": "Local", + "ProductType": "BusinessCalling", + "Status": "Unassigned", + "Capabilities": { + "InboundCall": true, + "OutboundCall": true, + "InboundSMS": true, + "OutboundSMS": true, + "InboundMMS": true, + "OutboundMMS": true + }, + "Associations": [], + "CallingName": "phonenumber1", + "CreatedTimestamp": "2019-08-09T21:35:21.445Z", + "UpdatedTimestamp": "2019-08-12T21:44:07.591Z" + } + } + +**Example 2: To update the outbound calling name for a phone number** + +The following ``update-phone-number`` example updates the outbound calling name for the specified phone number. + + aws chime update-phone-number \ + --phone-number-id "+12065550100" \ + --calling-name "phonenumber2" + +Output:: + + { + "PhoneNumber": { + "PhoneNumberId": "%2B12065550100", + "E164PhoneNumber": "+12065550100", + "Type": "Local", + "ProductType": "BusinessCalling", + "Status": "Unassigned", + "Capabilities": { + "InboundCall": true, + "OutboundCall": true, + "InboundSMS": true, + "OutboundSMS": true, + "InboundMMS": true, + "OutboundMMS": true + }, + "Associations": [], + "CallingName": "phonenumber2", + "CreatedTimestamp": "2019-08-09T21:35:21.445Z", + "UpdatedTimestamp": "2019-08-12T21:44:07.591Z" + } + } + +For more information, see `Working with Phone Numbers `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/update-phone-number-settings.rst awscli-1.18.69/awscli/examples/chime/update-phone-number-settings.rst --- awscli-1.11.13/awscli/examples/chime/update-phone-number-settings.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/update-phone-number-settings.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,10 @@ +**To update an outbound calling name** + +The following ``update-phone-number-settings`` example updates the default outbound calling name for the administrator's AWS account. :: + + aws chime update-phone-number-settings \ + --calling-name "myName" + +This command produces no output. + +For more information, see `Working with Phone Numbers `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/update-proxy-session.rst awscli-1.18.69/awscli/examples/chime/update-proxy-session.rst --- awscli-1.11.13/awscli/examples/chime/update-proxy-session.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/update-proxy-session.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,36 @@ +**To update a proxy session** + +The following ``update-proxy-session`` example updates the proxy session capabilities. :: + + aws chime update-proxy-session \ + --voice-connector-id abcdef1ghij2klmno3pqr4 \ + --proxy-session-id 123a4bc5-67d8-901e-2f3g-h4ghjk56789l \ + --capabilities "Voice" + +Output:: + + { + "ProxySession": { + "VoiceConnectorId": "abcdef1ghij2klmno3pqr4", + "ProxySessionId": "123a4bc5-67d8-901e-2f3g-h4ghjk56789l", + "Status": "Open", + "ExpiryMinutes": 60, + "Capabilities": [ + "Voice" + ], + "CreatedTimestamp": "2020-04-15T16:10:10.288Z", + "UpdatedTimestamp": "2020-04-15T16:10:10.288Z", + "Participants": [ + { + "PhoneNumber": "+12065550100", + "ProxyPhoneNumber": "+19135550199" + }, + { + "PhoneNumber": "+14015550101", + "ProxyPhoneNumber": "+19135550199" + } + ] + } + } + +For more information, see `Proxy Phone Sessions `__ in the *Amazon Chime Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/update-room-membership.rst awscli-1.18.69/awscli/examples/chime/update-room-membership.rst --- awscli-1.11.13/awscli/examples/chime/update-room-membership.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/update-room-membership.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,29 @@ +**To update a room membership** + +The following ``update-room-membership`` example modifies the role of the specified chat room member to ``Administrator``. :: + + aws chime update-room-membership \ + --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ + --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j \ + --member-id 1ab2345c-67de-8901-f23g-45h678901j2k \ + --role Administrator + +Output:: + + { + "RoomMembership": { + "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j", + "Member": { + "MemberId": "1ab2345c-67de-8901-f23g-45h678901j2k", + "MemberType": "User", + "Email": "sofiamartinez@example.com", + "FullName": "Sofia Martinez", + "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45" + }, + "Role": "Administrator", + "InvitedBy": "arn:aws:iam::111122223333:user/admin", + "UpdatedTimestamp": "2019-12-02T22:40:22.931Z" + } + } + +For more information, see `Creating a Chat Room `__ in the *Amazon Chime User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/chime/update-room.rst awscli-1.18.69/awscli/examples/chime/update-room.rst --- awscli-1.11.13/awscli/examples/chime/update-room.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/update-room.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,23 @@ +**To update a chat room** + +The following ``update-room`` example modifies the name of the specified chat room. :: + + aws chime update-room \ + --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ + --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j \ + --name teamRoom + +Output:: + + { + "Room": { + "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j", + "Name": "teamRoom", + "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45", + "CreatedBy": "arn:aws:iam::111122223333:user/alejandro", + "CreatedTimestamp": "2019-12-02T22:29:31.549Z", + "UpdatedTimestamp": "2019-12-02T22:33:19.310Z" + } + } + +For more information, see `Creating a Chat Room `__ in the *Amazon Chime User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/chime/update-user.rst awscli-1.18.69/awscli/examples/chime/update-user.rst --- awscli-1.11.13/awscli/examples/chime/update-user.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/update-user.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To update user details** + +This example updates the specified details for the specified user. + +Command:: + + aws chime update-user \ + --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ + --user-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE \ + --license-type "Basic" + +Output:: + + { + "User": { + "UserId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE" + } + } diff -Nru awscli-1.11.13/awscli/examples/chime/update-user-settings.rst awscli-1.18.69/awscli/examples/chime/update-user-settings.rst --- awscli-1.11.13/awscli/examples/chime/update-user-settings.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/update-user-settings.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,12 @@ +**To update user settings** + +The following ``update-user-settings`` example enables the specified user to make inbound and outbound calls and send and receive SMS messages. :: + + aws chime update-user-settings \ + --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ + --user-id 1ab2345c-67de-8901-f23g-45h678901j2k \ + --user-settings "Telephony={InboundCalling=true,OutboundCalling=true,SMS=true}" + +This command produces no output. + +For more information, see `Managing User Phone Numbers `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/update-voice-connector-group.rst awscli-1.18.69/awscli/examples/chime/update-voice-connector-group.rst --- awscli-1.11.13/awscli/examples/chime/update-voice-connector-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/update-voice-connector-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,27 @@ +**To update the details for an Amazon Chime Voice Connector group** + +The following ``update-voice-connector-group`` example updates the details of the specified Amazon Chime Voice Connector group. :: + + aws chime update-voice-connector-group \ + --voice-connector-group-id 123a456b-c7d8-90e1-fg23-4h567jkl8901 \ + --name "newGroupName" \ + --voice-connector-items VoiceConnectorId=abcdef1ghij2klmno3pqr4,Priority=1 + +Output:: + + { + "VoiceConnectorGroup": { + "VoiceConnectorGroupId": "123a456b-c7d8-90e1-fg23-4h567jkl8901", + "Name": "newGroupName", + "VoiceConnectorItems": [ + { + "VoiceConnectorId": "abcdef1ghij2klmno3pqr4", + "Priority": 1 + } + ], + "CreatedTimestamp": "2019-09-18T16:38:34.734Z", + "UpdatedTimestamp": "2019-10-28T19:00:57.081Z" + } + } + +For more information, see `Working with Amazon Chime Voice Connector Groups `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/chime/update-voice-connector.rst awscli-1.18.69/awscli/examples/chime/update-voice-connector.rst --- awscli-1.11.13/awscli/examples/chime/update-voice-connector.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/chime/update-voice-connector.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,24 @@ +**To update the details for an Amazon Chime Voice Connector** + +The following ``update-voice-connector`` example updates the name of the specified Amazon Chime Voice Connector. :: + + aws chime update-voice-connector \ + --voice-connector-id abcdef1ghij2klmno3pqr4 \ + --name newName \ + --require-encryption + +Output:: + + { + "VoiceConnector": { + "VoiceConnectorId": "abcdef1ghij2klmno3pqr4", + "AwsRegion": "us-west-2", + "Name": "newName", + "OutboundHostName": "abcdef1ghij2klmno3pqr4.voiceconnector.chime.aws", + "RequireEncryption": true, + "CreatedTimestamp": "2019-09-18T20:34:01.352Z", + "UpdatedTimestamp": "2019-09-18T20:40:52.895Z" + } + } + +For more information, see `Working with Amazon Chime Voice Connectors `__ in the *Amazon Chime Administration Guide*. diff -Nru awscli-1.11.13/awscli/examples/cloud9/create-environment-ec2.rst awscli-1.18.69/awscli/examples/cloud9/create-environment-ec2.rst --- awscli-1.11.13/awscli/examples/cloud9/create-environment-ec2.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloud9/create-environment-ec2.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,13 @@ +**To create an AWS Cloud9 EC2 development environment** + +This example creates an AWS Cloud9 development environment with the specified settings, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then connects from the instance to the environment. + +Command:: + + aws cloud9 create-environment-ec2 --name my-demo-env --description "My demonstration development environment." --instance-type t2.micro --subnet-id subnet-1fab8aEX --automatic-stop-time-minutes 60 --owner-arn arn:aws:iam::123456789012:user/MyDemoUser + +Output:: + + { + "environmentId": "8a34f51ce1e04a08882f1e811bd706EX" + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cloud9/create-environment-membership.rst awscli-1.18.69/awscli/examples/cloud9/create-environment-membership.rst --- awscli-1.11.13/awscli/examples/cloud9/create-environment-membership.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloud9/create-environment-membership.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To add an environment member to an AWS Cloud9 development environment** + +This example adds the specified environment member to the specified AWS Cloud9 development environment. + +Command:: + + aws cloud9 create-environment-membership --environment-id 8a34f51ce1e04a08882f1e811bd706EX --user-arn arn:aws:iam::123456789012:user/AnotherDemoUser --permissions read-write + +Output:: + + { + "membership": { + "environmentId": "8a34f51ce1e04a08882f1e811bd706EX", + "userId": "AIDAJ3LOROMOUXTBSU6EX", + "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser", + "permissions": "read-write" + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cloud9/delete-environment-membership.rst awscli-1.18.69/awscli/examples/cloud9/delete-environment-membership.rst --- awscli-1.11.13/awscli/examples/cloud9/delete-environment-membership.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloud9/delete-environment-membership.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To delete an environment member from an AWS Cloud9 development environment** + +This example deletes the specified environment member from the specified AWS Cloud9 development environment. + +Command:: + + aws cloud9 delete-environment-membership --environment-id 8a34f51ce1e04a08882f1e811bd706EX --user-arn arn:aws:iam::123456789012:user/AnotherDemoUser + +Output:: + + None. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cloud9/delete-environment.rst awscli-1.18.69/awscli/examples/cloud9/delete-environment.rst --- awscli-1.11.13/awscli/examples/cloud9/delete-environment.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloud9/delete-environment.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To delete an AWS Cloud9 development environment** + +This example deletes the specified AWS Cloud9 development environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance. + +Command:: + + aws cloud9 delete-environment --environment-id 8a34f51ce1e04a08882f1e811bd706EX + +Output:: + + None. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cloud9/describe-environment-memberships.rst awscli-1.18.69/awscli/examples/cloud9/describe-environment-memberships.rst --- awscli-1.11.13/awscli/examples/cloud9/describe-environment-memberships.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloud9/describe-environment-memberships.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,76 @@ +**To gets information about environment members for an AWS Cloud9 development environment** + +This example gets information about environment members for the specified AWS Cloud9 development environment. + +Command:: + + aws cloud9 describe-environment-memberships --environment-id 8a34f51ce1e04a08882f1e811bd706EX + +Output:: + + { + "memberships": [ + { + "environmentId": "8a34f51ce1e04a08882f1e811bd706EX", + "userId": "AIDAJ3LOROMOUXTBSU6EX", + "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser", + "permissions": "read-write" + }, + { + "environmentId": "8a34f51ce1e04a08882f1e811bd706EX", + "userId": "AIDAJNUEDQAQWFELJDLEX", + "userArn": "arn:aws:iam::123456789012:user/MyDemoUser", + "permissions": "owner" + } + ] + } + +**To get information about the owner of an AWS Cloud9 development environment** + +This example gets information about the owner of the specified AWS Cloud9 development environment. + +Command:: + + aws cloud9 describe-environment-memberships --environment-id 8a34f51ce1e04a08882f1e811bd706EX --permissions owner + +Output:: + + { + "memberships": [ + { + "environmentId": "8a34f51ce1e04a08882f1e811bd706EX", + "userId": "AIDAJNUEDQAQWFELJDLEX", + "userArn": "arn:aws:iam::123456789012:user/MyDemoUser", + "permissions": "owner" + } + ] + } + +**To get information about an environment member for multiple AWS Cloud9 development environments** + +This example gets information about the specified environment member for multiple AWS Cloud9 development environments. + +Command:: + + aws cloud9 describe-environment-memberships --user-arn arn:aws:iam::123456789012:user/MyDemoUser + +Output:: + + { + "memberships": [ + { + "environmentId": "10a75714bd494714929e7f5ec4125aEX", + "lastAccess": 1516213427.0, + "userId": "AIDAJNUEDQAQWFELJDLEX", + "userArn": "arn:aws:iam::123456789012:user/MyDemoUser", + "permissions": "owner" + }, + { + "environmentId": "1980b80e5f584920801c09086667f0EX", + "lastAccess": 1516144884.0, + "userId": "AIDAJNUEDQAQWFELJDLEX", + "userArn": "arn:aws:iam::123456789012:user/MyDemoUser", + "permissions": "owner" + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cloud9/describe-environments.rst awscli-1.18.69/awscli/examples/cloud9/describe-environments.rst --- awscli-1.11.13/awscli/examples/cloud9/describe-environments.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloud9/describe-environments.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,36 @@ +**To get information about AWS Cloud9 development environments** + +This example gets information about the specified AWS Cloud9 development environments. + +Command:: + + aws cloud9 describe-environments --environment-ids 685f892f431b45c2b28cb69eadcdb0EX 349c86d4579e4e7298d500ff57a6b2EX + +Output:: + + { + "environments": [ + { + "id": "685f892f431b45c2b28cb69eadcdb0EX", + "name": "my-demo-ec2-env", + "description": "Created from CodeStar.", + "type": "ec2", + "arn": "arn:aws:cloud9:us-east-1:123456789012:environment:685f892f431b45c2b28cb69eadcdb0EX", + "ownerArn": "arn:aws:iam::123456789012:user/MyDemoUser", + "lifecycle": { + "status": "CREATED" + } + }, + { + "id": "349c86d4579e4e7298d500ff57a6b2EX", + "name": my-demo-ssh-env", + "description": "", + "type": "ssh", + "arn": "arn:aws:cloud9:us-east-1:123456789012:environment:349c86d4579e4e7298d500ff57a6b2EX", + "ownerArn": "arn:aws:iam::123456789012:user/MyDemoUser", + "lifecycle": { + "status": "CREATED" + } + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cloud9/describe-environment-status.rst awscli-1.18.69/awscli/examples/cloud9/describe-environment-status.rst --- awscli-1.11.13/awscli/examples/cloud9/describe-environment-status.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloud9/describe-environment-status.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,14 @@ +**To get status information for an AWS Cloud9 development environment** + +This example gets status information for the specified AWS Cloud9 development environment. + +Command:: + + aws cloud9 describe-environment-status --environment-id 685f892f431b45c2b28cb69eadcdb0EX + +Output:: + + { + "status": "ready", + "message": "Environment is ready to use" + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cloud9/list-environments.rst awscli-1.18.69/awscli/examples/cloud9/list-environments.rst --- awscli-1.11.13/awscli/examples/cloud9/list-environments.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloud9/list-environments.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,16 @@ +**To get a list of available AWS Cloud9 development environment identifiers** + +This example gets a list of available AWS Cloud9 development environment identifiers. + +Command:: + + aws cloud9 list-environments + +Output:: + + { + "environmentIds": [ + "685f892f431b45c2b28cb69eadcdb0EX", + "1980b80e5f584920801c09086667f0EX" + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cloud9/update-environment-membership.rst awscli-1.18.69/awscli/examples/cloud9/update-environment-membership.rst --- awscli-1.11.13/awscli/examples/cloud9/update-environment-membership.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloud9/update-environment-membership.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To change the settings of an existing environment member for an AWS Cloud9 development environment** + +This example changes the settings of the specified existing environment member for the specified AWS Cloud9 development environment. + +Command:: + + aws cloud9 update-environment-membership --environment-id 8a34f51ce1e04a08882f1e811bd706EX --user-arn arn:aws:iam::123456789012:user/AnotherDemoUser --permissions read-only + +Output:: + + { + "membership": { + "environmentId": "8a34f51ce1e04a08882f1e811bd706EX", + "userId": "AIDAJ3LOROMOUXTBSU6EX", + "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser", + "permissions": "read-only" + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cloud9/update-environment.rst awscli-1.18.69/awscli/examples/cloud9/update-environment.rst --- awscli-1.11.13/awscli/examples/cloud9/update-environment.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloud9/update-environment.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To change the settings of an existing AWS Cloud9 development environment** + +This example changes the specified settings of the specified existing AWS Cloud9 development environment. + +Command:: + + aws cloud9 update-environment --environment-id 8a34f51ce1e04a08882f1e811bd706EX --name my-changed-demo-env --description "My changed demonstration development environment." + +Output:: + + None. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cloudformation/continue-update-rollback.rst awscli-1.18.69/awscli/examples/cloudformation/continue-update-rollback.rst --- awscli-1.11.13/awscli/examples/cloudformation/continue-update-rollback.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/continue-update-rollback.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To retry an update rollback** + +The following ``continue-update-rollback`` example resumes a rollback operation from a previously failed stack update. :: + + aws cloudformation continue-update-rollback \ + --stack-name my-stack + +This command produces no output. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cloudformation/create-change-set.rst awscli-1.18.69/awscli/examples/cloudformation/create-change-set.rst --- awscli-1.11.13/awscli/examples/cloudformation/create-change-set.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/create-change-set.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,16 @@ +**To create a change set** + +The following ``create-change-set`` example creates a change set with the ``CAPABILITY_IAM`` capability. The file ``template.yaml`` is an AWS CloudFormation template in the current folder that defines a stack that includes IAM resources. :: + + aws cloudformation create-change-set \ + --stack-name my-application \ + --change-set-name my-change-set \ + --template-body file://template.yaml \ + --capabilities CAPABILITY_IAM + +Output:: + + { + "Id": "arn:aws:cloudformation:us-west-2:123456789012:changeSet/my-change-set/bc9555ba-a949-xmpl-bfb8-f41d04ec5784", + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-application/d0a825a0-e4cd-xmpl-b9fb-061c69e99204" + } diff -Nru awscli-1.11.13/awscli/examples/cloudformation/create-stack-instances.rst awscli-1.18.69/awscli/examples/cloudformation/create-stack-instances.rst --- awscli-1.11.13/awscli/examples/cloudformation/create-stack-instances.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/create-stack-instances.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To create stack instances** + +The following ``create-stack-instances`` example creates instances of a stack set in two accounts and in four regions. The fault tolerance setting ensures that the update is attempted in all accounts and regions, even if some stacks cannot be created. :: + + aws cloudformation create-stack-instances \ + --stack-set-name my-stack-set \ + --accounts 123456789012 223456789012 \ + --regions us-east-1 us-east-2 us-west-1 us-west-2 \ + --operation-preferences FailureToleranceCount=7 + +Output:: + + { + "OperationId": "d7995c31-83c2-xmpl-a3d4-e9ca2811563f" + } + +To create a stack set, use the ``create-stack-set`` command. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cloudformation/create-stack.rst awscli-1.18.69/awscli/examples/cloudformation/create-stack.rst --- awscli-1.11.13/awscli/examples/cloudformation/create-stack.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/create-stack.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,30 +2,13 @@ The following ``create-stacks`` command creates a stack with the name ``myteststack`` using the ``sampletemplate.json`` template:: - aws cloudformation create-stack --stack-name myteststack --template-body file:////home//local//test//sampletemplate.json + aws cloudformation create-stack --stack-name myteststack --template-body file://sampletemplate.json --parameters ParameterKey=KeyPairName,ParameterValue=TestKey ParameterKey=SubnetIDs,ParameterValue=SubnetID1\\,SubnetID2 Output:: - [ - { - "StackId": "arn:aws:cloudformation:us-east-1:123456789012:stack/myteststack/466df9e0-0dff-08e3-8e2f-5088487c4896", - "Description": "AWS CloudFormation Sample Template S3_Bucket: Sample template showing how to create a publicly accessible S3 bucket. **WARNING** This template creates an S3 bucket. You will be billed for the AWS resources used if you create a stack from this template.", - "Tags": [], - "Outputs": [ - { - "Description": "Name of S3 bucket to hold website content", - "OutputKey": "BucketName", - "OutputValue": "myteststack-s3bucket-jssofi1zie2w" - } - ], - "StackStatusReason": null, - "CreationTime": "2013-08-23T01:02:15.422Z", - "Capabilities": [], - "StackName": "myteststack", - "StackStatus": "CREATE_COMPLETE", - "DisableRollback": false - } - ] + { + "StackId": "arn:aws:cloudformation:us-east-1:123456789012:stack/myteststack/466df9e0-0dff-08e3-8e2f-5088487c4896" + } For more information, see `Stacks`_ in the *AWS CloudFormation User Guide*. diff -Nru awscli-1.11.13/awscli/examples/cloudformation/create-stack-set.rst awscli-1.18.69/awscli/examples/cloudformation/create-stack-set.rst --- awscli-1.11.13/awscli/examples/cloudformation/create-stack-set.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/create-stack-set.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,16 @@ +**To create a stack set** + +The following ``create-stack-set`` example creates a stack set using the specified YAML file temlplate. ``template.yaml`` is an AWS CloudFormation template in the current folder that defines a stack. :: + + aws cloudformation create-stack-set \ + --stack-set-name my-stack-set \ + --template-body file://template.yaml \ + --description "SNS topic" + +Output:: + + { + "StackSetId": "my-stack-set:8d0f160b-d157-xmpl-a8e6-c0ce8e5d8cc1" + } + +To add stack instances to the stack set, use the ``create-stack-instances`` command. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cloudformation/delete-change-set.rst awscli-1.18.69/awscli/examples/cloudformation/delete-change-set.rst --- awscli-1.11.13/awscli/examples/cloudformation/delete-change-set.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/delete-change-set.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,16 @@ +**To delete a change set** + +The following ``delete-change-set`` example deletes a change set by specifying the change set name and stack name. :: + + aws cloudformation delete-change-set \ + --stack-name my-stack \ + --change-set-name my-change-set + +This command produces no output. + +The following ``delete-change-set`` example deletes a change set by specifying the full ARN of the change set. :: + + aws cloudformation delete-change-set \ + --change-set-name arn:aws:cloudformation:us-east-2:123456789012:changeSet/my-change-set/4eca1a01-e285-xmpl-8026-9a1967bfb4b0 + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/cloudformation/delete-stack-instances.rst awscli-1.18.69/awscli/examples/cloudformation/delete-stack-instances.rst --- awscli-1.11.13/awscli/examples/cloudformation/delete-stack-instances.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/delete-stack-instances.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To delete stack instances** + +The following ``delete-stack-instances`` example deletes instances of a stack set in two accounts in two regions and terminates the stacks. :: + + aws cloudformation delete-stack-instances \ + --stack-set-name my-stack-set \ + --accounts 123456789012 567890123456 \ + --regions us-east-1 us-west-1 \ + --no-retain-stacks + +Output:: + + { + "OperationId": "ad49f10c-fd1d-413f-a20a-8de6e2fa8f27" + } + +To delete an empty stack set, use the ``delete-stack-set`` command. diff -Nru awscli-1.11.13/awscli/examples/cloudformation/delete-stack.rst awscli-1.18.69/awscli/examples/cloudformation/delete-stack.rst --- awscli-1.11.13/awscli/examples/cloudformation/delete-stack.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/delete-stack.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To delete a stack** + +The following ``delete-stack`` example deletes the specified stack. :: + + aws cloudformation delete-stack \ + --stack-name my-stack + +This command produces no output. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cloudformation/delete-stack-set.rst awscli-1.18.69/awscli/examples/cloudformation/delete-stack-set.rst --- awscli-1.11.13/awscli/examples/cloudformation/delete-stack-set.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/delete-stack-set.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a stack set** + +The following command deletes the specified empty stack set. The stack set must be empty. :: + + aws cloudformation delete-stack-set \ + --stack-set-name my-stack-set + +This command produces no output. + +To delete instances from the stack set, use the ``delete-stack-instances`` command. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cloudformation/_deploy_description.rst awscli-1.18.69/awscli/examples/cloudformation/_deploy_description.rst --- awscli-1.11.13/awscli/examples/cloudformation/_deploy_description.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/_deploy_description.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +Deploys the specified AWS CloudFormation template by creating and then executing +a change set. The command terminates after AWS CloudFormation executes the +change set. If you want to view the change set before AWS CloudFormation +executes it, use the ``--no-execute-changeset`` flag. + +To update a stack, specify the name of an existing stack. To create a new stack, +specify a new stack name. + diff -Nru awscli-1.11.13/awscli/examples/cloudformation/deploy.rst awscli-1.18.69/awscli/examples/cloudformation/deploy.rst --- awscli-1.11.13/awscli/examples/cloudformation/deploy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/deploy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,6 @@ +Following command deploys template named ``template.json`` to a stack named +``my-new-stack``:: + + + aws cloudformation deploy --template-file /path_to_template/template.json --stack-name my-new-stack --parameter-overrides Key1=Value1 Key2=Value2 --tags Key1=Value1 Key2=Value2 + diff -Nru awscli-1.11.13/awscli/examples/cloudformation/deregister-type.rst awscli-1.18.69/awscli/examples/cloudformation/deregister-type.rst --- awscli-1.11.13/awscli/examples/cloudformation/deregister-type.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/deregister-type.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudformation/describe-account-limits.rst awscli-1.18.69/awscli/examples/cloudformation/describe-account-limits.rst --- awscli-1.11.13/awscli/examples/cloudformation/describe-account-limits.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/describe-account-limits.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,24 @@ +**To get information about your account limits** + +The following command retrieves a list of regional limits for the current account. :: + + aws cloudformation describe-account-limits + +Output:: + + { + "AccountLimits": [ + { + "Name": "StackLimit", + "Value": 200 + }, + { + "Name": "StackOutputsLimit", + "Value": 60 + }, + { + "Name": "ConcurrentResourcesLimit", + "Value": 2500 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/cloudformation/describe-change-set.rst awscli-1.18.69/awscli/examples/cloudformation/describe-change-set.rst --- awscli-1.11.13/awscli/examples/cloudformation/describe-change-set.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/describe-change-set.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,59 @@ +**To get information about a change set** + +The following ``describe-change-set`` example displays the details of the change set specified by change set name and stack name. :: + + aws cloudformation describe-change-set \ + --change-set-name my-change-set \ + --stack-name my-stack + +The following ``describe-change-set`` example displays the details of the change set specified by the full ARN of the change set:: + + aws cloudformation describe-change-set \ + --change-set-name arn:aws:cloudformation:us-west-2:123456789012:changeSet/my-change-set/bc9555ba-a949-xmpl-bfb8-f41d04ec5784 + +Output:: + + { + "Changes": [ + { + "Type": "Resource", + "ResourceChange": { + "Action": "Modify", + "LogicalResourceId": "function", + "PhysicalResourceId": "my-function-SEZV4XMPL4S5", + "ResourceType": "AWS::Lambda::Function", + "Replacement": "False", + "Scope": [ + "Properties" + ], + "Details": [ + { + "Target": { + "Attribute": "Properties", + "Name": "Timeout", + "RequiresRecreation": "Never" + }, + "Evaluation": "Static", + "ChangeSource": "DirectModification" + } + ] + } + } + ], + "ChangeSetName": "my-change-set", + "ChangeSetId": "arn:aws:cloudformation:us-west-2:123456789012:changeSet/my-change-set/4eca1a01-e285-xmpl-8026-9a1967bfb4b0", + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", + "StackName": "my-stack", + "Description": null, + "Parameters": null, + "CreationTime": "2019-10-02T05:20:56.651Z", + "ExecutionStatus": "AVAILABLE", + "Status": "CREATE_COMPLETE", + "StatusReason": null, + "NotificationARNs": [], + "RollbackConfiguration": {}, + "Capabilities": [ + "CAPABILITY_IAM" + ], + "Tags": null + } diff -Nru awscli-1.11.13/awscli/examples/cloudformation/describe-stack-drift-detection-status.rst awscli-1.18.69/awscli/examples/cloudformation/describe-stack-drift-detection-status.rst --- awscli-1.11.13/awscli/examples/cloudformation/describe-stack-drift-detection-status.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/describe-stack-drift-detection-status.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To check a drift detection operation's status** + +The following ``describe-stack-drift-detection-status`` example displays the status of a drift detection operation. Get the by ID running the ``detect-stack-drift`` command. :: + + aws cloudformation describe-stack-drift-detection-status \ + --stack-drift-detection-id 1a229160-e4d9-xmpl-ab67-0a4f93df83d4 + +Output:: + + { + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", + "StackDriftDetectionId": "1a229160-e4d9-xmpl-ab67-0a4f93df83d4", + "StackDriftStatus": "DRIFTED", + "DetectionStatus": "DETECTION_COMPLETE", + "DriftedStackResourceCount": 1, + "Timestamp": "2019-10-02T05:54:30.902Z" + } diff -Nru awscli-1.11.13/awscli/examples/cloudformation/describe-stack-events.rst awscli-1.18.69/awscli/examples/cloudformation/describe-stack-events.rst --- awscli-1.11.13/awscli/examples/cloudformation/describe-stack-events.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/describe-stack-events.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,33 @@ +**To describe stack events** + +The following ``describe-stack-events`` example displays the 2 most recent events for the specified stack. :: + + aws cloudformation describe-stack-events \ + --stack-name my-stack \ + --max-items 2 + + { + "StackEvents": [ + { + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", + "EventId": "4e1516d0-e4d6-xmpl-b94f-0a51958a168c", + "StackName": "my-stack", + "LogicalResourceId": "my-stack", + "PhysicalResourceId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", + "ResourceType": "AWS::CloudFormation::Stack", + "Timestamp": "2019-10-02T05:34:29.556Z", + "ResourceStatus": "UPDATE_COMPLETE" + }, + { + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", + "EventId": "4dd3c810-e4d6-xmpl-bade-0aaf8b31ab7a", + "StackName": "my-stack", + "LogicalResourceId": "my-stack", + "PhysicalResourceId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", + "ResourceType": "AWS::CloudFormation::Stack", + "Timestamp": "2019-10-02T05:34:29.127Z", + "ResourceStatus": "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS" + } + ], + "NextToken": "eyJOZXh0VG9XMPLiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ==" + } diff -Nru awscli-1.11.13/awscli/examples/cloudformation/describe-stack-instance.rst awscli-1.18.69/awscli/examples/cloudformation/describe-stack-instance.rst --- awscli-1.11.13/awscli/examples/cloudformation/describe-stack-instance.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/describe-stack-instance.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,22 @@ +**To describe a stack instance** + +The following command describes an instance of the specified stack set in the specified account and Region. The stack set is in the current region and account, and the instance is in the ``us-west-2`` region in account ``123456789012``.:: + + aws cloudformation describe-stack-instance \ + --stack-set-name my-stack-set \ + --stack-instance-account 123456789012 \ + --stack-instance-region us-west-2 + +Output:: + + { + "StackInstance": { + "StackSetId": "enable-config:296a3360-xmpl-40af-be78-9341e95bf743", + "Region": "us-west-2", + "Account": "123456789012", + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/StackSet-enable-config-e6cac20f-xmpl-46e9-8314-53e0d4591532/4287f9a0-e615-xmpl-894a-12b31d3117be", + "ParameterOverrides": [], + "Status": "OUTDATED", + "StatusReason": "ResourceLogicalId:ConfigBucket, ResourceType:AWS::S3::Bucket, ResourceStatusReason:You have attempted to create more buckets than allowed (Service: Amazon S3; Status Code: 400; Error Code: TooManyBuckets; Request ID: F7F21CXMPL580224; S3 Extended Request ID: egd/Fdt89BXMPLyiqbMNljVk55Yqqvi3NYW2nKLUVWhUGEhNfCmZdyj967lhriaG/dWMobSO40o=)." + } + } diff -Nru awscli-1.11.13/awscli/examples/cloudformation/describe-stack-resource-drifts.rst awscli-1.18.69/awscli/examples/cloudformation/describe-stack-resource-drifts.rst --- awscli-1.11.13/awscli/examples/cloudformation/describe-stack-resource-drifts.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/describe-stack-resource-drifts.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,37 @@ +**To get information about resources that drifted from the stack definition** + +The following command displays information about drifted resources for the specified stack. To initiate drift detection, use the ``detect-stack-drift`` command.:: + + aws cloudformation describe-stack-resource-drifts \ + --stack-name my-stack + +The output shows an AWS Lambda function that was modified out-of-band:: + + { + "StackResourceDrifts": [ + { + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", + "LogicalResourceId": "function", + "PhysicalResourceId": "my-function-SEZV4XMPL4S5", + "ResourceType": "AWS::Lambda::Function", + "ExpectedProperties": "{\"Description\":\"Write a file to S3.\",\"Environment\":{\"Variables\":{\"bucket\":\"my-stack-bucket-1vc62xmplgguf\"}},\"Handler\":\"index.handler\",\"MemorySize\":128,\"Role\":\"arn:aws:iam::123456789012:role/my-functionRole-HIZXMPLEOM9E\",\"Runtime\":\"nodejs10.x\",\"Tags\":[{\"Key\":\"lambda:createdBy\",\"Value\":\"SAM\"}],\"Timeout\":900,\"TracingConfig\":{\"Mode\":\"Active\"}}", + "ActualProperties": "{\"Description\":\"Write a file to S3.\",\"Environment\":{\"Variables\":{\"bucket\":\"my-stack-bucket-1vc62xmplgguf\"}},\"Handler\":\"index.handler\",\"MemorySize\":256,\"Role\":\"arn:aws:iam::123456789012:role/my-functionRole-HIZXMPLEOM9E\",\"Runtime\":\"nodejs10.x\",\"Tags\":[{\"Key\":\"lambda:createdBy\",\"Value\":\"SAM\"}],\"Timeout\":22,\"TracingConfig\":{\"Mode\":\"Active\"}}", + "PropertyDifferences": [ + { + "PropertyPath": "/MemorySize", + "ExpectedValue": "128", + "ActualValue": "256", + "DifferenceType": "NOT_EQUAL" + }, + { + "PropertyPath": "/Timeout", + "ExpectedValue": "900", + "ActualValue": "22", + "DifferenceType": "NOT_EQUAL" + } + ], + "StackResourceDriftStatus": "MODIFIED", + "Timestamp": "2019-10-02T05:54:44.064Z" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/cloudformation/describe-stack-resource.rst awscli-1.18.69/awscli/examples/cloudformation/describe-stack-resource.rst --- awscli-1.11.13/awscli/examples/cloudformation/describe-stack-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/describe-stack-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,25 @@ +**To get information about a stack resource** + +The following ``describe-stack-resource`` example displays details for the resource named ``MyFunction`` in the specified stack. :: + + aws cloudformation describe-stack-resource \ + --stack-name MyStack \ + --logical-resource-id MyFunction + +Output:: + + { + "StackResourceDetail": { + "StackName": "MyStack", + "StackId": "arn:aws:cloudformation:us-east-2:123456789012:stack/MyStack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", + "LogicalResourceId": "MyFunction", + "PhysicalResourceId": "my-function-SEZV4XMPL4S5", + "ResourceType": "AWS::Lambda::Function", + "LastUpdatedTimestamp": "2019-10-02T05:34:27.989Z", + "ResourceStatus": "UPDATE_COMPLETE", + "Metadata": "{}", + "DriftInformation": { + "StackResourceDriftStatus": "IN_SYNC" + } + } + } diff -Nru awscli-1.11.13/awscli/examples/cloudformation/describe-stack-resources.rst awscli-1.18.69/awscli/examples/cloudformation/describe-stack-resources.rst --- awscli-1.11.13/awscli/examples/cloudformation/describe-stack-resources.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/describe-stack-resources.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,49 @@ +**To get information about a stack resource** + +The following ``describe-stack-resources`` example displays details for the resources in the specified stack. :: + + aws cloudformation describe-stack-resources \ + --stack-name my-stack + +Output:: + + { + "StackResources": [ + { + "StackName": "my-stack", + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", + "LogicalResourceId": "bucket", + "PhysicalResourceId": "my-stack-bucket-1vc62xmplgguf", + "ResourceType": "AWS::S3::Bucket", + "Timestamp": "2019-10-02T04:34:11.345Z", + "ResourceStatus": "CREATE_COMPLETE", + "DriftInformation": { + "StackResourceDriftStatus": "IN_SYNC" + } + }, + { + "StackName": "my-stack", + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", + "LogicalResourceId": "function", + "PhysicalResourceId": "my-function-SEZV4XMPL4S5", + "ResourceType": "AWS::Lambda::Function", + "Timestamp": "2019-10-02T05:34:27.989Z", + "ResourceStatus": "UPDATE_COMPLETE", + "DriftInformation": { + "StackResourceDriftStatus": "IN_SYNC" + } + }, + { + "StackName": "my-stack", + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", + "LogicalResourceId": "functionRole", + "PhysicalResourceId": "my-functionRole-HIZXMPLEOM9E", + "ResourceType": "AWS::IAM::Role", + "Timestamp": "2019-10-02T04:34:06.350Z", + "ResourceStatus": "CREATE_COMPLETE", + "DriftInformation": { + "StackResourceDriftStatus": "IN_SYNC" + } + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/cloudformation/describe-stack-set-operation.rst awscli-1.18.69/awscli/examples/cloudformation/describe-stack-set-operation.rst --- awscli-1.11.13/awscli/examples/cloudformation/describe-stack-set-operation.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/describe-stack-set-operation.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,32 @@ +**To get information about a stack set operation** + +The following `describe-stack-set-operation`` example displays details for an update operation on the specified stack set. :: + + aws cloudformation describe-stack-set-operation \ + --stack-set-name enable-config \ + --operation-id 35d45ebc-ed88-xmpl-ab59-0197a1fc83a0 + +Output:: + + { + "StackSetOperation": { + "OperationId": "35d45ebc-ed88-xmpl-ab59-0197a1fc83a0", + "StackSetId": "enable-config:296a3360-xmpl-40af-be78-9341e95bf743", + "Action": "UPDATE", + "Status": "SUCCEEDED", + "OperationPreferences": { + "RegionOrder": [ + "us-east-1", + "us-west-2", + "eu-west-1", + "us-west-1" + ], + "FailureToleranceCount": 7, + "MaxConcurrentCount": 2 + }, + "AdministrationRoleARN": "arn:aws:iam::123456789012:role/AWSCloudFormationStackSetAdministrationRole", + "ExecutionRoleName": "AWSCloudFormationStackSetExecutionRole", + "CreationTimestamp": "2019-10-03T16:28:44.377Z", + "EndTimestamp": "2019-10-03T16:42:08.607Z" + } + } diff -Nru awscli-1.11.13/awscli/examples/cloudformation/describe-stack-set.rst awscli-1.18.69/awscli/examples/cloudformation/describe-stack-set.rst --- awscli-1.11.13/awscli/examples/cloudformation/describe-stack-set.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/describe-stack-set.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,24 @@ +**To get information about a stack set** + +The following `describe-stack-set`` example displays details about the specified stack set. :: + + aws cloudformation describe-stack-set \ + --stack-set-name my-stack-set + +Output:: + + { + "StackSet": { + "StackSetName": "my-stack-set", + "StackSetId": "my-stack-set:296a3360-xmpl-40af-be78-9341e95bf743", + "Description": "Create an Amazon SNS topic", + "Status": "ACTIVE", + "TemplateBody": "AWSTemplateFormatVersion: '2010-09-09'\nDescription: An AWS SNS topic\nResources:\n topic:\n Type: AWS::SNS::Topic", + "Parameters": [], + "Capabilities": [], + "Tags": [], + "StackSetARN": "arn:aws:cloudformation:us-west-2:123456789012:stackset/enable-config:296a3360-xmpl-40af-be78-9341e95bf743", + "AdministrationRoleARN": "arn:aws:iam::123456789012:role/AWSCloudFormationStackSetAdministrationRole", + "ExecutionRoleName": "AWSCloudFormationStackSetExecutionRole" + } + } diff -Nru awscli-1.11.13/awscli/examples/cloudformation/describe-type-registration.rst awscli-1.18.69/awscli/examples/cloudformation/describe-type-registration.rst --- awscli-1.11.13/awscli/examples/cloudformation/describe-type-registration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/describe-type-registration.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudformation/describe-type.rst awscli-1.18.69/awscli/examples/cloudformation/describe-type.rst --- awscli-1.11.13/awscli/examples/cloudformation/describe-type.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/describe-type.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudformation/detect-stack-drift.rst awscli-1.18.69/awscli/examples/cloudformation/detect-stack-drift.rst --- awscli-1.11.13/awscli/examples/cloudformation/detect-stack-drift.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/detect-stack-drift.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,14 @@ +**To detect drifted resources** + +The following ``detect-stack-drift`` example initiates drift detection for the specified stack. :: + + aws cloudformation detect-stack-drift \ + --stack-name my-stack + +Output:: + + { + "StackDriftDetectionId": "1a229160-e4d9-xmpl-ab67-0a4f93df83d4" + } + +You can then use this ID with the ``describe-stack-resource-drifts`` command to describe drifted resources. diff -Nru awscli-1.11.13/awscli/examples/cloudformation/detect-stack-resource-drift.rst awscli-1.18.69/awscli/examples/cloudformation/detect-stack-resource-drift.rst --- awscli-1.11.13/awscli/examples/cloudformation/detect-stack-resource-drift.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/detect-stack-resource-drift.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,36 @@ +**To detect drift for a resource** + +The following ``detect-stack-resource-drift`` example checks a resource named ``MyFunction`` in a stack named ``MyStack`` for drift:: + + aws cloudformation detect-stack-resource-drift \ + --stack-name MyStack \ + --logical-resource-id MyFunction + +The output shows an AWS Lambda function that was modified out-of-band:: + + { + "StackResourceDrift": { + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/MyStack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", + "LogicalResourceId": "MyFunction", + "PhysicalResourceId": "my-function-SEZV4XMPL4S5", + "ResourceType": "AWS::Lambda::Function", + "ExpectedProperties": "{\"Description\":\"Write a file to S3.\",\"Environment\":{\"Variables\":{\"bucket\":\"my-stack-bucket-1vc62xmplgguf\"}},\"Handler\":\"index.handler\",\"MemorySize\":128,\"Role\":\"arn:aws:iam::123456789012:role/my-functionRole-HIZXMPLEOM9E\",\"Runtime\":\"nodejs10.x\",\"Tags\":[{\"Key\":\"lambda:createdBy\",\"Value\":\"SAM\"}],\"Timeout\":900,\"TracingConfig\":{\"Mode\":\"Active\"}}", + "ActualProperties": "{\"Description\":\"Write a file to S3.\",\"Environment\":{\"Variables\":{\"bucket\":\"my-stack-bucket-1vc62xmplgguf\"}},\"Handler\":\"index.handler\",\"MemorySize\":256,\"Role\":\"arn:aws:iam::123456789012:role/my-functionRole-HIZXMPLEOM9E\",\"Runtime\":\"nodejs10.x\",\"Tags\":[{\"Key\":\"lambda:createdBy\",\"Value\":\"SAM\"}],\"Timeout\":22,\"TracingConfig\":{\"Mode\":\"Active\"}}", + "PropertyDifferences": [ + { + "PropertyPath": "/MemorySize", + "ExpectedValue": "128", + "ActualValue": "256", + "DifferenceType": "NOT_EQUAL" + }, + { + "PropertyPath": "/Timeout", + "ExpectedValue": "900", + "ActualValue": "22", + "DifferenceType": "NOT_EQUAL" + } + ], + "StackResourceDriftStatus": "MODIFIED", + "Timestamp": "2019-10-02T05:58:47.433Z" + } + } diff -Nru awscli-1.11.13/awscli/examples/cloudformation/detect-stack-set-drift.rst awscli-1.18.69/awscli/examples/cloudformation/detect-stack-set-drift.rst --- awscli-1.11.13/awscli/examples/cloudformation/detect-stack-set-drift.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/detect-stack-set-drift.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudformation/estimate-template-cost.rst awscli-1.18.69/awscli/examples/cloudformation/estimate-template-cost.rst --- awscli-1.11.13/awscli/examples/cloudformation/estimate-template-cost.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/estimate-template-cost.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,12 @@ +**To estimate template cost** + +The following ``estimate-template-cost`` example generates a cost estimate for a template named ``template.yaml`` in the current folder. :: + + aws cloudformation estimate-template-cost \ + --template-body file://template.yaml + +Output:: + + { + "Url": "http://calculator.s3.amazonaws.com/calc5.html?key=cloudformation/7870825a-xmpl-4def-92e7-c4f8dd360cca" + } diff -Nru awscli-1.11.13/awscli/examples/cloudformation/execute-change-set.rst awscli-1.18.69/awscli/examples/cloudformation/execute-change-set.rst --- awscli-1.11.13/awscli/examples/cloudformation/execute-change-set.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/execute-change-set.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,12 @@ +**To execute a change set** + +The following ``execute-change-set`` example executes a change set specified by change set name and stack name. :: + + aws cloudformation execute-change-set \ + --change-set-name my-change-set \ + --stack-name my-stack + +The following ``execute-change-set`` example executes a change set specified by the full ARN of the change set. :: + + aws cloudformation execute-change-set \ + --change-set-name arn:aws:cloudformation:us-west-2:123456789012:changeSet/my-change-set/bc9555ba-a949-xmpl-bfb8-f41d04ec5784 diff -Nru awscli-1.11.13/awscli/examples/cloudformation/get-stack-policy.rst awscli-1.18.69/awscli/examples/cloudformation/get-stack-policy.rst --- awscli-1.11.13/awscli/examples/cloudformation/get-stack-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/get-stack-policy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,12 @@ +**To view a stack policy** + +The following ``get-stack-policy`` example displays the stack policy for the specified stack. To attach a policy to a stack, use the ``set-stack-policy`` command. :: + + aws cloudformation get-stack-policy \ + --stack-name my-stack + +Output:: + + { + "StackPolicyBody": "{\n \"Statement\" : [\n {\n \"Effect\" : \"Allow\",\n \"Action\" : \"Update:*\",\n \"Principal\": \"*\",\n \"Resource\" : \"*\"\n },\n {\n \"Effect\" : \"Deny\",\n \"Action\" : \"Update:*\",\n \"Principal\": \"*\",\n \"Resource\" : \"LogicalResourceId/bucket\"\n }\n ]\n}\n" + } diff -Nru awscli-1.11.13/awscli/examples/cloudformation/get-template-summary.rst awscli-1.18.69/awscli/examples/cloudformation/get-template-summary.rst --- awscli-1.11.13/awscli/examples/cloudformation/get-template-summary.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/get-template-summary.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,24 @@ +**To display a template summary** + +The following command displays summary information about the resources and metadata for the specified template file. :: + + aws cloudformation get-template-summary \ + --template-body file://template.yaml + +Output:: + + { + "Parameters": [], + "Description": "A VPC and subnets.", + "ResourceTypes": [ + "AWS::EC2::VPC", + "AWS::EC2::Subnet", + "AWS::EC2::Subnet", + "AWS::EC2::RouteTable", + "AWS::EC2::VPCEndpoint", + "AWS::EC2::SubnetRouteTableAssociation", + "AWS::EC2::SubnetRouteTableAssociation", + "AWS::EC2::VPCEndpoint" + ], + "Version": "2010-09-09" + } diff -Nru awscli-1.11.13/awscli/examples/cloudformation/list-change-sets.rst awscli-1.18.69/awscli/examples/cloudformation/list-change-sets.rst --- awscli-1.11.13/awscli/examples/cloudformation/list-change-sets.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/list-change-sets.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,22 @@ +**To list change sets** + +The following ``list-change-sets`` example displays a list of the pending change sets for the specified stack. :: + + aws cloudformation list-change-sets \ + --stack-name my-stack + +Output:: + + { + "Summaries": [ + { + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", + "StackName": "my-stack", + "ChangeSetId": "arn:aws:cloudformation:us-west-2:123456789012:changeSet/my-change-set/70160340-7914-xmpl-bcbf-128a1fa78b5d", + "ChangeSetName": "my-change-set", + "ExecutionStatus": "AVAILABLE", + "Status": "CREATE_COMPLETE", + "CreationTime": "2019-10-02T05:38:54.297Z" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/cloudformation/list-exports.rst awscli-1.18.69/awscli/examples/cloudformation/list-exports.rst --- awscli-1.11.13/awscli/examples/cloudformation/list-exports.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/list-exports.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,27 @@ +**To list exports** + +The following ``list-exports`` example displays a list of the exports from stacks in the current region. :: + + aws cloudformation list-exports + +Output:: + + { + "Exports": [ + { + "ExportingStackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/private-vpc/99764070-b56c-xmpl-bee8-062a88d1d800", + "Name": "private-vpc-subnet-a", + "Value": "subnet-07b410xmplddcfa03" + }, + { + "ExportingStackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/private-vpc/99764070-b56c-xmpl-bee8-062a88d1d800", + "Name": "private-vpc-subnet-b", + "Value": "subnet-075ed3xmplebd2fb1" + }, + { + "ExportingStackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/private-vpc/99764070-b56c-xmpl-bee8-062a88d1d800", + "Name": "private-vpc-vpcid", + "Value": "vpc-011d7xmpl100e9841" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/cloudformation/list-imports.rst awscli-1.18.69/awscli/examples/cloudformation/list-imports.rst --- awscli-1.11.13/awscli/examples/cloudformation/list-imports.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/list-imports.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,14 @@ +**To list imports** + +The following ``list-imports`` example lists the stacks that import the specified export. To get the list of available exports, use the ``list-exports`` command. :: + + aws cloudformation list-imports \ + --export-name private-vpc-vpcid + +Output:: + + { + "Imports": [ + "my-database-stack" + ] + } diff -Nru awscli-1.11.13/awscli/examples/cloudformation/list-stack-instances.rst awscli-1.18.69/awscli/examples/cloudformation/list-stack-instances.rst --- awscli-1.11.13/awscli/examples/cloudformation/list-stack-instances.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/list-stack-instances.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,28 @@ +**To list instances for a stack** + +The following ``list-stack-instances`` example lists the instances created from the specified stack set. :: + + aws cloudformation list-stack-instances \ + --stack-set-name enable-config + +The example output includes details about a stack that failed to update due to an error:: + + { + "Summaries": [ + { + "StackSetId": "enable-config:296a3360-xmpl-40af-be78-9341e95bf743", + "Region": "us-west-2", + "Account": "123456789012", + "StackId": "arn:aws:cloudformation:ap-northeast-1:123456789012:stack/StackSet-enable-config-35a6ac50-d9f8-4084-86e4-7da34d5de4c4/a1631cd0-e5fb-xmpl-b474-0aa20f14f06e", + "Status": "CURRENT" + }, + { + "StackSetId": "enable-config:296a3360-xmpl-40af-be78-9341e95bf743", + "Region": "us-west-2", + "Account": "123456789012", + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/StackSet-enable-config-e6cac20f-xmpl-46e9-8314-53e0d4591532/eab53680-e5fa-xmpl-ba14-0a522351f81e", + "Status": "OUTDATED", + "StatusReason": "ResourceLogicalId:ConfigDeliveryChannel, ResourceType:AWS::Config::DeliveryChannel, ResourceStatusReason:Failed to put delivery channel 'StackSet-enable-config-e6cac20f-xmpl-46e9-8314-53e0d4591532-ConfigDeliveryChannel-1OJWJ7XD59WR0' because the maximum number of delivery channels: 1 is reached. (Service: AmazonConfig; Status Code: 400; Error Code: MaxNumberOfDeliveryChannelsExceededException; Request ID: d14b34a0-ef7c-xmpl-acf8-8a864370ae56)." + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/cloudformation/list-stack-resources.rst awscli-1.18.69/awscli/examples/cloudformation/list-stack-resources.rst --- awscli-1.11.13/awscli/examples/cloudformation/list-stack-resources.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/list-stack-resources.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,43 @@ +**To list resources in a stack** + +The following command displays the list of resources in the specified stack. :: + + aws cloudformation list-stack-resources \ + --stack-name my-stack + +Output:: + + { + "StackResourceSummaries": [ + { + "LogicalResourceId": "bucket", + "PhysicalResourceId": "my-stack-bucket-1vc62xmplgguf", + "ResourceType": "AWS::S3::Bucket", + "LastUpdatedTimestamp": "2019-10-02T04:34:11.345Z", + "ResourceStatus": "CREATE_COMPLETE", + "DriftInformation": { + "StackResourceDriftStatus": "IN_SYNC" + } + }, + { + "LogicalResourceId": "function", + "PhysicalResourceId": "my-function-SEZV4XMPL4S5", + "ResourceType": "AWS::Lambda::Function", + "LastUpdatedTimestamp": "2019-10-02T05:34:27.989Z", + "ResourceStatus": "UPDATE_COMPLETE", + "DriftInformation": { + "StackResourceDriftStatus": "IN_SYNC" + } + }, + { + "LogicalResourceId": "functionRole", + "PhysicalResourceId": "my-functionRole-HIZXMPLEOM9E", + "ResourceType": "AWS::IAM::Role", + "LastUpdatedTimestamp": "2019-10-02T04:34:06.350Z", + "ResourceStatus": "CREATE_COMPLETE", + "DriftInformation": { + "StackResourceDriftStatus": "IN_SYNC" + } + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/cloudformation/list-stack-set-operation-results.rst awscli-1.18.69/awscli/examples/cloudformation/list-stack-set-operation-results.rst --- awscli-1.11.13/awscli/examples/cloudformation/list-stack-set-operation-results.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/list-stack-set-operation-results.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,31 @@ +**To list stack set operation results** + +The following command displays the results of an update operation on instances in the specified stack set. :: + + aws cloudformation list-stack-set-operation-results \ + --stack-set-name enable-config \ + --operation-id 35d45ebc-ed88-xmpl-ab59-0197a1fc83a0 + +Output:: + + { + "Summaries": [ + { + "Account": "223456789012", + "Region": "us-west-2", + "Status": "SUCCEEDED", + "AccountGateResult": { + "Status": "SKIPPED", + "StatusReason": "Function not found: arn:aws:lambda:eu-west-1:223456789012:function:AWSCloudFormationStackSetAccountGate" + } + }, + { + "Account": "223456789012", + "Region": "ap-south-1", + "Status": "CANCELLED", + "StatusReason": "Cancelled since failure tolerance has exceeded" + } + ] + } + +**Note:** The ``SKIPPED`` status for ``AccountGateResult`` is expected for successful operations unless you create an account gate function. diff -Nru awscli-1.11.13/awscli/examples/cloudformation/list-stack-set-operations.rst awscli-1.18.69/awscli/examples/cloudformation/list-stack-set-operations.rst --- awscli-1.11.13/awscli/examples/cloudformation/list-stack-set-operations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/list-stack-set-operations.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,27 @@ +**To list stack set operations** + +The following ``list-stack-set-operations`` example displays the list of the most recent operations on the specified stack set. :: + + aws cloudformation list-stack-set-operations \ + --stack-set-name my-stack-set + +Output:: + + { + "Summaries": [ + { + "OperationId": "35d45ebc-ed88-xmpl-ab59-0197a1fc83a0", + "Action": "UPDATE", + "Status": "SUCCEEDED", + "CreationTimestamp": "2019-10-03T16:28:44.377Z", + "EndTimestamp": "2019-10-03T16:42:08.607Z" + }, + { + "OperationId": "891aa98f-7118-xmpl-00b2-00954d1dd0d6", + "Action": "UPDATE", + "Status": "FAILED", + "CreationTimestamp": "2019-10-03T15:43:53.916Z", + "EndTimestamp": "2019-10-03T15:45:58.925Z" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/cloudformation/list-stack-sets.rst awscli-1.18.69/awscli/examples/cloudformation/list-stack-sets.rst --- awscli-1.11.13/awscli/examples/cloudformation/list-stack-sets.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/list-stack-sets.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To list stack sets** + +The following ``list-stack-sets`` example displays the list of stack sets in the current region and account. :: + + aws cloudformation list-stack-sets + +Output:: + + { + "Summaries": [ + { + "StackSetName": "enable-config", + "StackSetId": "enable-config:296a3360-xmpl-40af-be78-9341e95bf743", + "Description": "Enable AWS Config", + "Status": "ACTIVE" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/cloudformation/list-type-registrations.rst awscli-1.18.69/awscli/examples/cloudformation/list-type-registrations.rst --- awscli-1.11.13/awscli/examples/cloudformation/list-type-registrations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/list-type-registrations.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudformation/list-types.rst awscli-1.18.69/awscli/examples/cloudformation/list-types.rst --- awscli-1.11.13/awscli/examples/cloudformation/list-types.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/list-types.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudformation/list-type-versions.rst awscli-1.18.69/awscli/examples/cloudformation/list-type-versions.rst --- awscli-1.11.13/awscli/examples/cloudformation/list-type-versions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/list-type-versions.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudformation/_package_description.rst awscli-1.18.69/awscli/examples/cloudformation/_package_description.rst --- awscli-1.11.13/awscli/examples/cloudformation/_package_description.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/_package_description.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,48 @@ +Packages the local artifacts (local paths) that your AWS CloudFormation template +references. The command uploads local artifacts, such as source code for an AWS +Lambda function or a Swagger file for an AWS API Gateway REST API, to an S3 +bucket. The command returns a copy of your template, replacing references to +local artifacts with the S3 location where the command uploaded the artifacts. + +Use this command to quickly upload local artifacts that might be required by +your template. After you package your template's artifacts, run the deploy +command to ``deploy`` the returned template. + +This command can upload local artifacts referenced in the following places: + + + - ``BodyS3Location`` property for the ``AWS::ApiGateway::RestApi`` resource + - ``Code`` property for the ``AWS::Lambda::Function`` resource + - ``CodeUri`` property for the ``AWS::Serverless::Function`` resource + - ``DefinitionS3Location`` property for the ``AWS::AppSync::GraphQLSchema`` resource + - ``RequestMappingTemplateS3Location`` property for the ``AWS::AppSync::Resolver`` resource + - ``ResponseMappingTemplateS3Location`` property for the ``AWS::AppSync::Resolver`` resource + - ``DefinitionUri`` property for the ``AWS::Serverless::Api`` resource + - ``Location`` parameter for the ``AWS::Include`` transform + - ``SourceBundle`` property for the ``AWS::ElasticBeanstalk::ApplicationVersion`` resource + - ``TemplateURL`` property for the ``AWS::CloudFormation::Stack`` resource + - ``Command.ScriptLocation`` property for the ``AWS::Glue::Job`` resource + + +To specify a local artifact in your template, specify a path to a local file or folder, +as either an absolute or relative path. The relative path is a location +that is relative to your template's location. + +For example, if your AWS Lambda function source code is in the +``/home/user/code/lambdafunction/`` folder, specify +``CodeUri: /home/user/code/lambdafunction`` for the +``AWS::Serverless::Function`` resource. The command returns a template and replaces +the local path with the S3 location: ``CodeUri: s3://mybucket/lambdafunction.zip``. + +If you specify a file, the command directly uploads it to the S3 bucket. If you +specify a folder, the command zips the folder and then uploads the .zip file. +For most resources, if you don't specify a path, the command zips and uploads the +current working directory. The exception is ``AWS::ApiGateway::RestApi``; +if you don't specify a ``BodyS3Location``, this command will not upload an artifact to S3. + +Before the command uploads artifacts, it checks if the artifacts are already +present in the S3 bucket to prevent unnecessary uploads. The command uses MD5 +checksums to compare files. If the values match, the command doesn't upload the +artifacts. Use the ``--force flag`` to skip this check and always upload the +artifacts. + diff -Nru awscli-1.11.13/awscli/examples/cloudformation/package.rst awscli-1.18.69/awscli/examples/cloudformation/package.rst --- awscli-1.11.13/awscli/examples/cloudformation/package.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/package.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,6 @@ +Following command exports a template named ``template.json`` by uploading local +artifacts to S3 bucket ``bucket-name`` and writes the exported template to +``packaged-template.json``:: + + aws cloudformation package --template-file /path_to_template/template.json --s3-bucket bucket-name --output-template-file packaged-template.json + diff -Nru awscli-1.11.13/awscli/examples/cloudformation/register-type.rst awscli-1.18.69/awscli/examples/cloudformation/register-type.rst --- awscli-1.11.13/awscli/examples/cloudformation/register-type.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/register-type.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,16 @@ +**To register a resource type** + +The following ``register-type`` example registers the specified resource type as a private resource type in the user's account. :: + + aws cloudformation register-type \ + --type-name My::Organization::ResourceName \ + --schema-handler-package s3://bucket_name/my-organization-resource_name.zip \ + --type RESOURCE + +Output:: + + { + "RegistrationToken": "f5525280-104e-4d35-bef5-8f1f1example" + } + +For more information, see `Registering Resource Providers `__ in the *CloudFormation Command Line Interface User Guide for Type Development*. diff -Nru awscli-1.11.13/awscli/examples/cloudformation/set-stack-policy.rst awscli-1.18.69/awscli/examples/cloudformation/set-stack-policy.rst --- awscli-1.11.13/awscli/examples/cloudformation/set-stack-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/set-stack-policy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,26 @@ +**To apply a stack policy** + +The following ``set-stack-policy`` example disables updates for the specified resource in the specified stack. ``stack-policy.json`` is a JSON document that defines the operations allowed on resources in the stack. :: + + aws cloudformation set-stack-policy \ + --stack-name my-stack \ + --stack-policy-body file://stack-policy.json + +Output:: + + { + "Statement" : [ + { + "Effect" : "Allow", + "Action" : "Update:*", + "Principal": "*", + "Resource" : "*" + }, + { + "Effect" : "Deny", + "Action" : "Update:*", + "Principal": "*", + "Resource" : "LogicalResourceId/bucket" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/cloudformation/set-type-default-version.rst awscli-1.18.69/awscli/examples/cloudformation/set-type-default-version.rst --- awscli-1.11.13/awscli/examples/cloudformation/set-type-default-version.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/set-type-default-version.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudformation/signal-resource.rst awscli-1.18.69/awscli/examples/cloudformation/signal-resource.rst --- awscli-1.11.13/awscli/examples/cloudformation/signal-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/signal-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To signal a resource** + +The following ``signal-resource`` example signals ``success`` to fulfill the wait condition named ``MyWaitCondition`` in the stack named ``my-stack``. :: + + aws cloudformation signal-resource \ + --stack-name my-stack \ + --logical-resource-id MyWaitCondition \ + --unique-id 1234 \ + --status SUCCESS + +This command produces no output. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cloudformation/stop-stack-set-operation.rst awscli-1.18.69/awscli/examples/cloudformation/stop-stack-set-operation.rst --- awscli-1.11.13/awscli/examples/cloudformation/stop-stack-set-operation.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/stop-stack-set-operation.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To stop a stack set operation** + +The following ``stop-stack-set-operation`` example stops an in-progess update operation on the specified stack set. :: + + aws cloudformation stop-stack-set-operation \ + --stack-set-name my-stack-set \ + --operation-id 1261cd27-490b-xmpl-ab42-793a896c69e6 + +This command produces no output. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cloudformation/update-stack-instances.rst awscli-1.18.69/awscli/examples/cloudformation/update-stack-instances.rst --- awscli-1.11.13/awscli/examples/cloudformation/update-stack-instances.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/update-stack-instances.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,15 @@ +**To update stack instances** + +The following ``update-stack-instances`` example retries an update on stack instances in two accounts in two regions with the most recent settings. The specified fault tolerance setting ensures that the update is attempted in all accounts and regions, even if some stacks cannot be updated. :: + + aws cloudformation update-stack-instances \ + --stack-set-name my-stack-set \ + --accounts 123456789012 567890123456 \ + --regions us-east-1 us-west-2 \ + --operation-preferences FailureToleranceCount=3 + +Output:: + + { + "OperationId": "103ebdf2-21ea-xmpl-8892-de5e30733132" + } diff -Nru awscli-1.11.13/awscli/examples/cloudformation/update-stack-set.rst awscli-1.18.69/awscli/examples/cloudformation/update-stack-set.rst --- awscli-1.11.13/awscli/examples/cloudformation/update-stack-set.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/update-stack-set.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,14 @@ +**To update a stack set** + +The following ``update-stack-set`` example adds a tag with the key name ``Owner`` and a value of ``IT`` to the stack instances in the specified stack set. :: + + aws cloudformation update-stack-set \ + --stack-set-name my-stack-set \ + --use-previous-template \ + --tags Key=Owner,Value=IT + +Output:: + + { + "OperationId": "e2b60321-6cab-xmpl-bde7-530c6f47950e" + } diff -Nru awscli-1.11.13/awscli/examples/cloudformation/update-termination-protection.rst awscli-1.18.69/awscli/examples/cloudformation/update-termination-protection.rst --- awscli-1.11.13/awscli/examples/cloudformation/update-termination-protection.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/update-termination-protection.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,13 @@ +**To enable termination protection** + +The following ``update-termination-protection`` example enables termination protection on the specified stack. :: + + aws cloudformation update-termination-protection \ + --stack-name my-stack \ + --enable-termination-protection + +Output:: + + { + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204" + } diff -Nru awscli-1.11.13/awscli/examples/cloudformation/validate-template.rst awscli-1.18.69/awscli/examples/cloudformation/validate-template.rst --- awscli-1.11.13/awscli/examples/cloudformation/validate-template.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/validate-template.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,7 +2,7 @@ The following ``validate-template`` command validates the ``sampletemplate.json`` template:: - aws cloudformation validate-template --template-body file:////home//local//test//sampletemplate.json + aws cloudformation validate-template --template-body file://sampletemplate.json Output:: diff -Nru awscli-1.11.13/awscli/examples/cloudformation/wait/change-set-create-complete.rst awscli-1.18.69/awscli/examples/cloudformation/wait/change-set-create-complete.rst --- awscli-1.11.13/awscli/examples/cloudformation/wait/change-set-create-complete.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/wait/change-set-create-complete.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To wait for a change set to finish creating** + +The following ``wait change-set-create-complete`` example pauses and resumes only after it can confirm that the specified change set in the specified stack is ready to run. :: + + aws cloudformation wait change-set-create-complete \ + --stack-name my-stack \ + --change-set-name my-change-set + +This command produces no output. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cloudformation/wait/stack-create-complete.rst awscli-1.18.69/awscli/examples/cloudformation/wait/stack-create-complete.rst --- awscli-1.11.13/awscli/examples/cloudformation/wait/stack-create-complete.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/wait/stack-create-complete.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,8 @@ +**To wait for CloudFormation to finish creating a stack** + +The following ``wait stack-create-complete`` example pauses and resumes only after it can confirm that CloudFormation has successfully created the specified stack. :: + + aws cloudformation wait stack-create-complete \ + --stack-name "arn:aws:cloudformation:uus-west-2:123456789012:stack/my-stack-1234/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" + +This command produces no output. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cloudformation/wait/stack-delete-complete.rst awscli-1.18.69/awscli/examples/cloudformation/wait/stack-delete-complete.rst --- awscli-1.11.13/awscli/examples/cloudformation/wait/stack-delete-complete.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/wait/stack-delete-complete.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,8 @@ +**To wait for CloudFormation to finish deleting a stack** + +The following ``wait stack-delete-complete`` example pauses and resumes only after it can confirm that CloudFormation has deleted the specified stack. :: + + aws cloudformation wait stack-delete-complete \ + --stack-name "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack-1234/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" + +This command produces no output. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cloudformation/wait/stack-exists.rst awscli-1.18.69/awscli/examples/cloudformation/wait/stack-exists.rst --- awscli-1.11.13/awscli/examples/cloudformation/wait/stack-exists.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/wait/stack-exists.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,8 @@ +**To wait for confirmation that a stack exists** + +The following ``wait stack-exists`` example pauses and resumes only after it can confirm that the specified stack actually exists. :: + + aws cloudformation wait stack-exists \ + --stack-name "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack-1234/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" + +This command produces no output. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cloudformation/wait/stack-import-complete.rst awscli-1.18.69/awscli/examples/cloudformation/wait/stack-import-complete.rst --- awscli-1.11.13/awscli/examples/cloudformation/wait/stack-import-complete.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/wait/stack-import-complete.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,8 @@ +**To wait for confirmation that resources have been imported into a stack** + +The following ``wait stack-import-complete`` example pauses and resumes only after it can confirm that the import operation successfully completed for all resources in the stack that support resource import. :: + + aws cloudformation wait stack-import-complete \ + --stack-name "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack-1234/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" + +This command produces no output. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cloudformation/wait/stack-rollback-complete.rst awscli-1.18.69/awscli/examples/cloudformation/wait/stack-rollback-complete.rst --- awscli-1.11.13/awscli/examples/cloudformation/wait/stack-rollback-complete.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/wait/stack-rollback-complete.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,8 @@ +**To wait for CloudFormation to finish rolling back a stack** + +The following ``wait stack-rollback-complete`` example pauses and resumes only after it can confirm that CloudFormation has completed a rollback operation on the specified stack. :: + + aws cloudformation wait stack-rollback-complete \ + --stack-name "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack-1234/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" + +This command produces no output. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cloudformation/wait/stack-update-complete.rst awscli-1.18.69/awscli/examples/cloudformation/wait/stack-update-complete.rst --- awscli-1.11.13/awscli/examples/cloudformation/wait/stack-update-complete.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/wait/stack-update-complete.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,8 @@ +**To wait for CloudFormation to finish updating a stack** + +The following ``wait stack-update-complete`` example pauses and resumes only after it can confirm that CloudFormation has updated the specified stack. :: + + aws cloudformation wait stack-update-complete \ + --stack-name "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack-1234/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" + +This command produces no output. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cloudformation/wait/type-registration-complete.rst awscli-1.18.69/awscli/examples/cloudformation/wait/type-registration-complete.rst --- awscli-1.11.13/awscli/examples/cloudformation/wait/type-registration-complete.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudformation/wait/type-registration-complete.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,8 @@ +**To wait for CloudFormation to register a resource type** + +The following ``wait type-registration-complete`` example pauses and resumes only after it can confirm that CloudFormation has registered the specified resource type. :: + + aws cloudformation wait type-registration-complete \ + --registration-token "f5525280-104e-4d35-bef5-8f1f1example" + +This command produces no output. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cloudfront/create-cloud-front-origin-access-identity.rst awscli-1.18.69/awscli/examples/cloudfront/create-cloud-front-origin-access-identity.rst --- awscli-1.11.13/awscli/examples/cloudfront/create-cloud-front-origin-access-identity.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/create-cloud-front-origin-access-identity.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudfront/create-distribution.rst awscli-1.18.69/awscli/examples/cloudfront/create-distribution.rst --- awscli-1.11.13/awscli/examples/cloudfront/create-distribution.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/create-distribution.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,161 +1,235 @@ -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": "" - } - } - ] - }, - "DefaultCacheBehavior": { - "TargetOriginId": "my-origin", - "ForwardedValues": { - "QueryString": true, - "Cookies": { - "Forward": "none" +**To create a CloudFront distribution** + +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 + } } - }, - "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.11.13/awscli/examples/cloudfront/create-distribution-with-tags.rst awscli-1.18.69/awscli/examples/cloudfront/create-distribution-with-tags.rst --- awscli-1.11.13/awscli/examples/cloudfront/create-distribution-with-tags.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/create-distribution-with-tags.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudfront/create-field-level-encryption-config.rst awscli-1.18.69/awscli/examples/cloudfront/create-field-level-encryption-config.rst --- awscli-1.11.13/awscli/examples/cloudfront/create-field-level-encryption-config.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/create-field-level-encryption-config.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudfront/create-field-level-encryption-profile.rst awscli-1.18.69/awscli/examples/cloudfront/create-field-level-encryption-profile.rst --- awscli-1.11.13/awscli/examples/cloudfront/create-field-level-encryption-profile.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/create-field-level-encryption-profile.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudfront/create-invalidation.rst awscli-1.18.69/awscli/examples/cloudfront/create-invalidation.rst --- awscli-1.11.13/awscli/examples/cloudfront/create-invalidation.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/create-invalidation.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,43 +1,68 @@ -The following command creates an invalidation for a CloudFront distribution with the ID ``S11A16G5KZMEQD``:: +**To create an invalidation for a CloudFront distribution** - aws cloudfront create-invalidation --distribution-id S11A16G5KZMEQD \ - --paths /index.html /error.html +The following ``create-invalidation`` example creates an invalidation for the specified files in the specified CloudFront distribution:: -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" - } \ No newline at end of file + aws cloudfront create-invalidation \ + --distribution-id EDFDVBD6EXAMPLE \ + --paths "/example-path/example-file.jpg" "/example-path/example-file2.png" + +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": 2, + "Items": [ + "/example-path/example-file2.png", + "/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 + +Contents of ``inv-batch.json``:: + + { + "Paths": { + "Quantity": 2, + "Items": [ + "/example-path/example-file.jpg", + "/example-path/example-file2.png" + ] + }, + "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-file2.png" + ] + }, + "CallerReference": "cli-example" + } + } + } diff -Nru awscli-1.11.13/awscli/examples/cloudfront/create-public-key.rst awscli-1.18.69/awscli/examples/cloudfront/create-public-key.rst --- awscli-1.11.13/awscli/examples/cloudfront/create-public-key.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/create-public-key.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudfront/delete-cloud-front-origin-access-identity.rst awscli-1.18.69/awscli/examples/cloudfront/delete-cloud-front-origin-access-identity.rst --- awscli-1.11.13/awscli/examples/cloudfront/delete-cloud-front-origin-access-identity.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/delete-cloud-front-origin-access-identity.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudfront/delete-distribution.rst awscli-1.18.69/awscli/examples/cloudfront/delete-distribution.rst --- awscli-1.11.13/awscli/examples/cloudfront/delete-distribution.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/delete-distribution.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,5 +1,20 @@ -The following command deletes a CloudFront distribution with the ID ``S11A16G5KZMEQD``:: +**To delete a CloudFront distribution** - aws cloudfront delete-distribution --id S11A16G5KZMEQD --if-match 8UBQECEJX24ST +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 `_. -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``. \ No newline at end of file +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. + +:: + + aws cloudfront delete-distribution \ + --id EDFDVBD6EXAMPLE \ + --if-match E2QWRUHEXAMPLE + +When successful, this command has no output. diff -Nru awscli-1.11.13/awscli/examples/cloudfront/delete-field-level-encryption-config.rst awscli-1.18.69/awscli/examples/cloudfront/delete-field-level-encryption-config.rst --- awscli-1.11.13/awscli/examples/cloudfront/delete-field-level-encryption-config.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/delete-field-level-encryption-config.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudfront/delete-field-level-encryption-profile.rst awscli-1.18.69/awscli/examples/cloudfront/delete-field-level-encryption-profile.rst --- awscli-1.11.13/awscli/examples/cloudfront/delete-field-level-encryption-profile.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/delete-field-level-encryption-profile.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudfront/delete-public-key.rst awscli-1.18.69/awscli/examples/cloudfront/delete-public-key.rst --- awscli-1.11.13/awscli/examples/cloudfront/delete-public-key.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/delete-public-key.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudfront/get-cloud-front-origin-access-identity-config.rst awscli-1.18.69/awscli/examples/cloudfront/get-cloud-front-origin-access-identity-config.rst --- awscli-1.11.13/awscli/examples/cloudfront/get-cloud-front-origin-access-identity-config.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/get-cloud-front-origin-access-identity-config.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudfront/get-cloud-front-origin-access-identity.rst awscli-1.18.69/awscli/examples/cloudfront/get-cloud-front-origin-access-identity.rst --- awscli-1.11.13/awscli/examples/cloudfront/get-cloud-front-origin-access-identity.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/get-cloud-front-origin-access-identity.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudfront/get-distribution-config.rst awscli-1.18.69/awscli/examples/cloudfront/get-distribution-config.rst --- awscli-1.11.13/awscli/examples/cloudfront/get-distribution-config.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/get-distribution-config.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,91 +1,114 @@ -The following command gets a distribution config for a CloudFront distribution with the ID ``S11A16G5KZMEQD``:: +**To get a CloudFront distribution configuration** - aws cloudfront get-distribution-config --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. -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 - } - } - } \ No newline at end of file + { + "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.11.13/awscli/examples/cloudfront/get-distribution.rst awscli-1.18.69/awscli/examples/cloudfront/get-distribution.rst --- awscli-1.11.13/awscli/examples/cloudfront/get-distribution.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/get-distribution.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,102 +1,126 @@ -The following command gets a distribution with the ID ``S11A16G5KZMEQD``:: +**To get a CloudFront distribution** - aws cloudfront get-distribution --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. -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.11.13/awscli/examples/cloudfront/get-field-level-encryption-config.rst awscli-1.18.69/awscli/examples/cloudfront/get-field-level-encryption-config.rst --- awscli-1.11.13/awscli/examples/cloudfront/get-field-level-encryption-config.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/get-field-level-encryption-config.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudfront/get-field-level-encryption-profile-config.rst awscli-1.18.69/awscli/examples/cloudfront/get-field-level-encryption-profile-config.rst --- awscli-1.11.13/awscli/examples/cloudfront/get-field-level-encryption-profile-config.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/get-field-level-encryption-profile-config.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudfront/get-field-level-encryption-profile.rst awscli-1.18.69/awscli/examples/cloudfront/get-field-level-encryption-profile.rst --- awscli-1.11.13/awscli/examples/cloudfront/get-field-level-encryption-profile.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/get-field-level-encryption-profile.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudfront/get-field-level-encryption.rst awscli-1.18.69/awscli/examples/cloudfront/get-field-level-encryption.rst --- awscli-1.11.13/awscli/examples/cloudfront/get-field-level-encryption.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/get-field-level-encryption.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudfront/get-invalidation.rst awscli-1.18.69/awscli/examples/cloudfront/get-invalidation.rst --- awscli-1.11.13/awscli/examples/cloudfront/get-invalidation.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/get-invalidation.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,25 +1,26 @@ -The following command retrieves an invalidation with the ID ``YNY2LI2BVJ4NJU`` for a CloudFront web distribution with the ID ``S11A16G5KZMEQD``:: +**To get a CloudFront invalidation** - aws cloudfront get-invalidation --id YNY2LI2BVJ4NJU --distribution-id S11A16G5KZMEQD +The following example gets the invalidation with the ID ``I2J0I21PCUYOIK`` for +the CloudFront distribution with the ID ``EDFDVBD6EXAMPLE``:: -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.11.13/awscli/examples/cloudfront/get-public-key-config.rst awscli-1.18.69/awscli/examples/cloudfront/get-public-key-config.rst --- awscli-1.11.13/awscli/examples/cloudfront/get-public-key-config.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/get-public-key-config.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudfront/get-public-key.rst awscli-1.18.69/awscli/examples/cloudfront/get-public-key.rst --- awscli-1.11.13/awscli/examples/cloudfront/get-public-key.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/get-public-key.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudfront/list-cloud-front-origin-access-identities.rst awscli-1.18.69/awscli/examples/cloudfront/list-cloud-front-origin-access-identities.rst --- awscli-1.11.13/awscli/examples/cloudfront/list-cloud-front-origin-access-identities.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/list-cloud-front-origin-access-identities.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudfront/list-distributions.rst awscli-1.18.69/awscli/examples/cloudfront/list-distributions.rst --- awscli-1.11.13/awscli/examples/cloudfront/list-distributions.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/list-distributions.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,92 +1,330 @@ -The following command retrieves a list of distributions:: +**To list CloudFront distributions** - aws cloudfront list-distributions +The following example gets a list of the CloudFront distributions in your AWS +account:: + + aws cloudfront list-distributions Output:: - { - "DistributionList": { - "Marker": "", - "Items": [ - { - "Status": "Deployed", - "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 - } - } \ No newline at end of file + { + "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.11.13/awscli/examples/cloudfront/list-field-level-encryption-configs.rst awscli-1.18.69/awscli/examples/cloudfront/list-field-level-encryption-configs.rst --- awscli-1.11.13/awscli/examples/cloudfront/list-field-level-encryption-configs.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/list-field-level-encryption-configs.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudfront/list-field-level-encryption-profiles.rst awscli-1.18.69/awscli/examples/cloudfront/list-field-level-encryption-profiles.rst --- awscli-1.11.13/awscli/examples/cloudfront/list-field-level-encryption-profiles.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/list-field-level-encryption-profiles.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudfront/list-invalidations.rst awscli-1.18.69/awscli/examples/cloudfront/list-invalidations.rst --- awscli-1.11.13/awscli/examples/cloudfront/list-invalidations.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/list-invalidations.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,23 +1,24 @@ -The following command retrieves a list of invalidations for a CloudFront web distribution with the ID ``S11A16G5KZMEQD``:: +**To list CloudFront invalidations** - aws cloudfront list-invalidations --distribution-id S11A16G5KZMEQD +The following example gets a list of the invalidations for the CloudFront +distribution with the ID ``EDFDVBD6EXAMPLE``:: -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.11.13/awscli/examples/cloudfront/list-public-keys.rst awscli-1.18.69/awscli/examples/cloudfront/list-public-keys.rst --- awscli-1.11.13/awscli/examples/cloudfront/list-public-keys.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/list-public-keys.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudfront/list-tags-for-resource.rst awscli-1.18.69/awscli/examples/cloudfront/list-tags-for-resource.rst --- awscli-1.11.13/awscli/examples/cloudfront/list-tags-for-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/list-tags-for-resource.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudfront/sign.rst awscli-1.18.69/awscli/examples/cloudfront/sign.rst --- awscli-1.11.13/awscli/examples/cloudfront/sign.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/sign.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudfront/tag-resource.rst awscli-1.18.69/awscli/examples/cloudfront/tag-resource.rst --- awscli-1.11.13/awscli/examples/cloudfront/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/tag-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,30 @@ +**To tag a CloudFront distribution** + +The following ``tag-resource`` example adds two tags to the specified CloudFront distribution. :: + + 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 + +Contents of ``tags.json``:: + + { + "Items": [ + { + "Key": "Name", + "Value": "Example name" + }, + { + "Key": "Project", + "Value": "Example project" + } + ] + } + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/cloudfront/untag-resource.rst awscli-1.18.69/awscli/examples/cloudfront/untag-resource.rst --- awscli-1.11.13/awscli/examples/cloudfront/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/untag-resource.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudfront/update-cloud-front-origin-access-identity.rst awscli-1.18.69/awscli/examples/cloudfront/update-cloud-front-origin-access-identity.rst --- awscli-1.11.13/awscli/examples/cloudfront/update-cloud-front-origin-access-identity.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/update-cloud-front-origin-access-identity.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudfront/update-distribution.rst awscli-1.18.69/awscli/examples/cloudfront/update-distribution.rst --- awscli-1.11.13/awscli/examples/cloudfront/update-distribution.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/update-distribution.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,193 +1,375 @@ -The following command updates the Default Root Object to "index.html" -for a CloudFront distribution with the ID ``S11A16G5KZMEQD``:: +**To update a CloudFront distribution's default root object** - aws cloudfront update-distribution --id S11A16G5KZMEQD \ - --default-root-object index.html +The following example updates the default root object to ``index.html`` for the +CloudFront distribution with the ID ``EDFDVBD6EXAMPLE``:: -The following command disables a CloudFront distribution with the ID ``S11A16G5KZMEQD``:: + aws cloudfront update-distribution --id EDFDVBD6EXAMPLE \ + --default-root-object index.html - aws cloudfront update-distribution --id S11A16G5KZMEQD --distribution-config file://distconfig-disabled.json --if-match E37HOT42DHPVYH +Output:: -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``. - -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 output of ``get-distribution-config`` and changing the ``Enabled`` key's value to ``false``:: - - { - "Comment": "", - "CacheBehaviors": { - "Quantity": 0 - }, - "Logging": { - "Bucket": "", - "Prefix": "", - "Enabled": false, - "IncludeCookies": false - }, - "Origins": { - "Items": [ - { - "OriginPath": "", - "S3OriginConfig": { - "OriginAccessIdentity": "" + { + "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": "" }, - "Id": "my-origin", - "DomainName": "my-bucket.s3.amazonaws.com" + "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 } - ], - "Quantity": 1 - }, - "DefaultRootObject": "", - "PriceClass": "PriceClass_All", - "Enabled": false, - "DefaultCacheBehavior": { - "TrustedSigners": { - "Enabled": false, + } + } + +**To update a CloudFront distribution** + +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. + +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" - } \ No newline at end of file + { + "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.11.13/awscli/examples/cloudfront/update-field-level-encryption-config.rst awscli-1.18.69/awscli/examples/cloudfront/update-field-level-encryption-config.rst --- awscli-1.11.13/awscli/examples/cloudfront/update-field-level-encryption-config.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/update-field-level-encryption-config.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudfront/update-field-level-encryption-profile.rst awscli-1.18.69/awscli/examples/cloudfront/update-field-level-encryption-profile.rst --- awscli-1.11.13/awscli/examples/cloudfront/update-field-level-encryption-profile.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudfront/update-field-level-encryption-profile.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudsearchdomain/upload-documents.rst awscli-1.18.69/awscli/examples/cloudsearchdomain/upload-documents.rst --- awscli-1.11.13/awscli/examples/cloudsearchdomain/upload-documents.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudsearchdomain/upload-documents.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +The following ``upload-documents`` command uploads a batch of JSON documents to an Amazon CloudSearch domain:: + + aws cloudsearchdomain upload-documents --endpoint-url https://doc-my-domain.us-west-1.cloudsearch.amazonaws.com --content-type application/json --documents document-batch.json + +Output:: + + { + "status": "success", + "adds": 5000, + "deletes": 0 + } diff -Nru awscli-1.11.13/awscli/examples/cloudtrail/get-event-selectors.rst awscli-1.18.69/awscli/examples/cloudtrail/get-event-selectors.rst --- awscli-1.11.13/awscli/examples/cloudtrail/get-event-selectors.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudtrail/get-event-selectors.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To view the event selector settings for a trail** + +The following ``get-event-selectors`` command returns the settings for ``Trail1``:: + + aws cloudtrail get-event-selectors --trail-name Trail1 + +Output:: + + { + "EventSelectors": [ + { + "IncludeManagementEvents": true, + "DataResources": [], + "ReadWriteType": "All" + } + ], + "TrailARN": "arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail1" + } diff -Nru awscli-1.11.13/awscli/examples/cloudtrail/put-event-selectors.rst awscli-1.18.69/awscli/examples/cloudtrail/put-event-selectors.rst --- awscli-1.11.13/awscli/examples/cloudtrail/put-event-selectors.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudtrail/put-event-selectors.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,70 @@ +**To configure event selectors for a trail** + +To create an event selector, run the ''put-event-selectors'' command. When an event occurs in your account, CloudTrail evaluates +the configuration for your trails. If the event matches any event selector for a trail, the trail processes and logs the event. +You can configure up to 5 event selectors for a trail and up to 250 data resources for a trail. + +The following example creates an event selector for a trail named ''TrailName'' to include read-only and write-only management events, +data events for two Amazon S3 bucket/prefix combinations, and data events for a single AWS Lambda function named ''hello-world-python-function'':: + + + + aws cloudtrail put-event-selectors --trail-name TrailName --event-selectors '[{"ReadWriteType": "All","IncludeManagementEvents": true,"DataResources": [{"Type":"AWS::S3::Object", "Values": ["arn:aws:s3:::mybucket/prefix","arn:aws:s3:::mybucket2/prefix2"]},{"Type": "AWS::Lambda::Function","Values": ["arn:aws:lambda:us-west-2:999999999999:function:hello-world-python-function"]}]}]' + +Output:: + + { + "EventSelectors": [ + { + "IncludeManagementEvents": true, + "DataResources": [ + { + "Values": [ + "arn:aws:s3:::mybucket/prefix", + "arn:aws:s3:::mybucket2/prefix2" + ], + "Type": "AWS::S3::Object" + }, + { + "Values": [ + "arn:aws:lambda:us-west-2:123456789012:function:hello-world-python-function" + ], + "Type": "AWS::Lambda::Function" + }, + ], + "ReadWriteType": "All" + } + ], + "TrailARN": "arn:aws:cloudtrail:us-east-2:123456789012:trail/TrailName" + } + +The following example creates an event selector for a trail named ''TrailName2'' that includes all events, including read-only and write-only management events, and all data events for all Amazon S3 buckets and AWS Lambda functions in the AWS account:: + + aws cloudtrail put-event-selectors --trail-name TrailName2 --event-selectors '[{"ReadWriteType": "All","IncludeManagementEvents": true,"DataResources": [{"Type":"AWS::S3::Object", "Values": ["arn:aws:s3:::"]},{"Type": "AWS::Lambda::Function","Values": ["arn:aws:lambda"]}]}]' + +Output:: + + { + "EventSelectors": [ + { + "IncludeManagementEvents": true, + "DataResources": [ + { + "Values": [ + "arn:aws:s3:::" + ], + "Type": "AWS::S3::Object" + }, + { + "Values": [ + "arn:aws:lambda" + ], + "Type": "AWS::Lambda::Function" + }, + ], + "ReadWriteType": "All" + } + ], + "TrailARN": "arn:aws:cloudtrail:us-east-2:123456789012:trail/TrailName2" + } + \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cloudwatch/delete-alarms.rst awscli-1.18.69/awscli/examples/cloudwatch/delete-alarms.rst --- awscli-1.11.13/awscli/examples/cloudwatch/delete-alarms.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudwatch/delete-alarms.rst 2020-05-28 19:25:48.000000000 +0000 @@ -3,7 +3,7 @@ The following example uses the ``delete-alarms`` command to delete the Amazon CloudWatch alarm named "myalarm":: - aws cloudwatch delete-alarms --alarm-name myalarm + aws cloudwatch delete-alarms --alarm-names myalarm Output:: diff -Nru awscli-1.11.13/awscli/examples/cloudwatch/get-metric-statistics.rst awscli-1.18.69/awscli/examples/cloudwatch/get-metric-statistics.rst --- awscli-1.11.13/awscli/examples/cloudwatch/get-metric-statistics.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudwatch/get-metric-statistics.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,13 +1,13 @@ **To get the CPU utilization per EC2 instance** The following example uses the ``get-metric-statistics`` command to get the CPU utilization for an EC2 -instance with the ID i-abcdef. For more examples using the ``get-metric-statistics`` command, see `Get Statistics for a Metric`__ in the *Amazon CloudWatch Developer Guide*. +instance with the ID i-abcdef. .. __: http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/US_GetStatistics.html :: - aws cloudwatch get-metric-statistics --metric-name CPUUtilization --start-time 2014-04-08T23:18:00 --end-time 2014-04-09T23:18:00 --period 3600 --namespace AWS/EC2 --statistics Maximum --dimensions Name=InstanceId,Value=i-abcdef + aws cloudwatch get-metric-statistics --metric-name CPUUtilization --start-time 2014-04-08T23:18:00Z --end-time 2014-04-09T23:18:00Z --period 3600 --namespace AWS/EC2 --statistics Maximum --dimensions Name=InstanceId,Value=i-abcdef Output:: @@ -132,3 +132,14 @@ "Label": "CPUUtilization" } +**Specifying multiple dimensions** + +The following example illustrates how to specify multiple dimensions. Each dimension is specified as a Name/Value pair, with a comma between the name and the value. Multiple dimensions are separated by a space. If a single metric includes multiple dimensions, you must specify a value for every defined dimension. + +For more examples using the ``get-metric-statistics`` command, see `Get Statistics for a Metric`__ in the *Amazon CloudWatch Developer Guide*. + +.. __: http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/US_GetStatistics.html + +:: + + aws cloudwatch get-metric-statistics --metric-name Buffers --namespace MyNameSpace --dimensions Name=InstanceID,Value=i-abcdef Name=InstanceType,Value=m1.small --start-time 2016-10-15T04:00:00Z --end-time 2016-10-19T07:00:00Z --statistics Average --period 60 diff -Nru awscli-1.11.13/awscli/examples/cloudwatch/list-metrics.rst awscli-1.18.69/awscli/examples/cloudwatch/list-metrics.rst --- awscli-1.11.13/awscli/examples/cloudwatch/list-metrics.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudwatch/list-metrics.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cloudwatch/put-metric-alarm.rst awscli-1.18.69/awscli/examples/cloudwatch/put-metric-alarm.rst --- awscli-1.11.13/awscli/examples/cloudwatch/put-metric-alarm.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudwatch/put-metric-alarm.rst 2020-05-28 19:25:48.000000000 +0000 @@ -5,3 +5,9 @@ aws cloudwatch put-metric-alarm --alarm-name cpu-mon --alarm-description "Alarm when CPU exceeds 70 percent" --metric-name CPUUtilization --namespace AWS/EC2 --statistic Average --period 300 --threshold 70 --comparison-operator GreaterThanThreshold --dimensions "Name=InstanceId,Value=i-12345678" --evaluation-periods 2 --alarm-actions arn:aws:sns:us-east-1:111122223333:MyTopic --unit Percent This command returns to the prompt if successful. If an alarm with the same name already exists, it will be overwritten by the new alarm. + +**To specify multiple dimensions** + +The following example illustrates how to specify multiple dimensions. Each dimension is specified as a Name/Value pair, with a comma between the name and the value. Multiple dimensions are separated by a space:: + + aws cloudwatch put-metric-alarm --alarm-name "Default_Test_Alarm3" --alarm-description "The default example alarm" --namespace "CW EXAMPLE METRICS" --metric-name Default_Test --statistic Average --period 60 --evaluation-periods 3 --threshold 50 --comparison-operator GreaterThanOrEqualToThreshold --dimensions Name=key1,Value=value1 Name=key2,Value=value2 diff -Nru awscli-1.11.13/awscli/examples/cloudwatch/put-metric-data.rst awscli-1.18.69/awscli/examples/cloudwatch/put-metric-data.rst --- awscli-1.11.13/awscli/examples/cloudwatch/put-metric-data.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cloudwatch/put-metric-data.rst 2020-05-28 19:25:48.000000000 +0000 @@ -21,4 +21,8 @@ .. _`Publishing Custom Metrics`: http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/publishingMetrics.html +**To specify multiple dimensions** +The following example illustrates how to specify multiple dimensions. Each dimension is specified as a Name=Value pair. Multiple dimensions are separated by a comma.:: + + aws cloudwatch put-metric-data --metric-name Buffers --namespace MyNameSpace --unit Bytes --value 231434333 --dimensions InstanceID=1-23456789,InstanceType=m1.small diff -Nru awscli-1.11.13/awscli/examples/codebuild/batch-delete-builds.rst awscli-1.18.69/awscli/examples/codebuild/batch-delete-builds.rst --- awscli-1.11.13/awscli/examples/codebuild/batch-delete-builds.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codebuild/batch-delete-builds.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,22 @@ +**To delete builds in AWS CodeBuild.** + +The following ``batch-delete-builds`` example deletes builds in CodeBuild with the specified IDs. :: + + aws codebuild batch-delete-builds --ids my-build-project-one:a1b2c3d4-5678-9012-abcd-11111EXAMPLE my-build-project-two:a1b2c3d4-5678-9012-abcd-22222EXAMPLE + +Output:: + + { + "buildsNotDeleted": [ + { + "id": "arn:aws:codebuild:us-west-2:123456789012:build/my-build-project-one:a1b2c3d4-5678-9012-abcd-11111EXAMPLE", + "statusCode": "BUILD_IN_PROGRESS" + } + ], + "buildsDeleted": [ + "arn:aws:codebuild:us-west-2:123456789012:build/my-build-project-two:a1b2c3d4-5678-9012-abcd-22222EXAMPLE" + ] + } + +For more information, see `Delete Builds (AWS CLI) `_ in the *AWS CodeBuild User Guide*. + diff -Nru awscli-1.11.13/awscli/examples/codebuild/batch-get-builds.rst awscli-1.18.69/awscli/examples/codebuild/batch-get-builds.rst --- awscli-1.11.13/awscli/examples/codebuild/batch-get-builds.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codebuild/batch-get-builds.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,369 @@ +**To view details of builds in AWS CodeBuild.** + +The following ``batch-get-builds`` example gets information about builds in CodeBuild with the specified IDs. :: + + aws codebuild batch-get-builds --ids codebuild-demo-project:e9c4f4df-3f43-41d2-ab3a-60fe2EXAMPLE codebuild-demo-project:815e755f-bade-4a7e-80f0-efe51EXAMPLE + +Output:: + + { + "buildsNotFound": [], + "builds": [ + { + "artifacts": { + "md5sum": "0e95edf915048a0c22efe6d139fff837", + "location": "arn:aws:s3:::codepipeline-us-west-2-820783811474/CodeBuild-Python-Pip/BuildArtif/6DJsqQa", + "encryptionDisabled": false, + "sha256sum": "cfa0df33a090966a737f64ae4fe498969fdc842a0c9aec540bf93c37ac0d05a2" + }, + "logs": { + "cloudWatchLogs": { + "status": "ENABLED" + }, + "s3Logs": { + "status": "DISABLED" + }, + "streamName": "46472baf-8f6b-43c2-9255-b3b963af2732", + "groupName": "/aws/codebuild/codebuild-demo-project", + "deepLink": "https://console.aws.amazon.com/cloudwatch/home?region=us-west-2#logEvent:group=/aws/codebuild/codebuild-demo-project;stream=46472baf-8f6b-43c2-9255-b3b963af2732" + }, + "timeoutInMinutes": 60, + "environment": { + "privilegedMode": false, + "computeType": "BUILD_GENERAL1_MEDIUM", + "image": "aws/codebuild/windows-base:1.0", + "environmentVariables": [], + "type": "WINDOWS_CONTAINER" + }, + "projectName": "codebuild-demo-project", + "buildComplete": true, + "source": { + "gitCloneDepth": 1, + "insecureSsl": false, + "type": "CODEPIPELINE" + }, + "buildStatus": "SUCCEEDED", + "secondaryArtifacts": [], + "phases": [ + { + "durationInSeconds": 0, + "startTime": 1548717462.122, + "phaseType": "SUBMITTED", + "endTime": 1548717462.484, + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 0, + "startTime": 1548717462.484, + "phaseType": "QUEUED", + "endTime": 1548717462.775, + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 34, + "endTime": 1548717496.909, + "contexts": [ + { + "statusCode": "", + "message": "" + } + ], + "startTime": 1548717462.775, + "phaseType": "PROVISIONING", + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 15, + "endTime": 1548717512.555, + "contexts": [ + { + "statusCode": "", + "message": "" + } + ], + "startTime": 1548717496.909, + "phaseType": "DOWNLOAD_SOURCE", + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 0, + "endTime": 1548717512.734, + "contexts": [ + { + "statusCode": "", + "message": "" + } + ], + "startTime": 1548717512.555, + "phaseType": "INSTALL", + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 0, + "endTime": 1548717512.924, + "contexts": [ + { + "statusCode": "", + "message": "" + } + ], + "startTime": 1548717512.734, + "phaseType": "PRE_BUILD", + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 9, + "endTime": 1548717522.254, + "contexts": [ + { + "statusCode": "", + "message": "" + } + ], + "startTime": 1548717512.924, + "phaseType": "BUILD", + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 3, + "endTime": 1548717525.498, + "contexts": [ + { + "statusCode": "", + "message": "" + } + ], + "startTime": 1548717522.254, + "phaseType": "POST_BUILD", + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 9, + "endTime": 1548717534.646, + "contexts": [ + { + "statusCode": "", + "message": "" + } + ], + "startTime": 1548717525.498, + "phaseType": "UPLOAD_ARTIFACTS", + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 2, + "endTime": 1548717536.846, + "contexts": [ + { + "statusCode": "", + "message": "" + } + ], + "startTime": 1548717534.646, + "phaseType": "FINALIZING", + "phaseStatus": "SUCCEEDED" + }, + { + "startTime": 1548717536.846, + "phaseType": "COMPLETED" + } + ], + "startTime": 1548717462.122, + "encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3", + "initiator": "codepipeline/CodeBuild-Pipeline", + "secondarySources": [], + "serviceRole": "arn:aws:iam::123456789012:role/service-role/my-codebuild-service-role", + "currentPhase": "COMPLETED", + "id": "codebuild-demo-project:e9c4f4df-3f43-41d2-ab3a-60fe2EXAMPLE", + "cache": { + "type": "NO_CACHE" + }, + "sourceVersion": "arn:aws:s3:::codepipeline-us-west-2-820783811474/CodeBuild-Python-Pip/SourceArti/1TspnN3.zip", + "endTime": 1548717536.846, + "arn": "arn:aws:codebuild:us-west-2:123456789012:build/codebuild-demo-project:e9c4f4df-3f43-41d2-ab3a-60fe2EXAMPLE", + "queuedTimeoutInMinutes": 480, + "resolvedSourceVersion": "f2194c1757bbdcb0f8f229254a4b3c8b27d43e0b" + }, + { + "artifacts": { + "md5sum": "", + "overrideArtifactName": false, + "location": "arn:aws:s3:::my-artifacts/codebuild-demo-project", + "encryptionDisabled": false, + "sha256sum": "" + }, + "logs": { + "cloudWatchLogs": { + "status": "ENABLED" + }, + "s3Logs": { + "status": "DISABLED" + }, + "streamName": "4dea3ca4-20ec-4898-b22a-a9eb9292775d", + "groupName": "/aws/codebuild/codebuild-demo-project", + "deepLink": "https://console.aws.amazon.com/cloudwatch/home?region=us-west-2#logEvent:group=/aws/codebuild/codebuild-demo-project;stream=4dea3ca4-20ec-4898-b22a-a9eb9292775d" + }, + "timeoutInMinutes": 60, + "environment": { + "privilegedMode": false, + "computeType": "BUILD_GENERAL1_MEDIUM", + "image": "aws/codebuild/windows-base:1.0", + "environmentVariables": [], + "type": "WINDOWS_CONTAINER" + }, + "projectName": "codebuild-demo-project", + "buildComplete": true, + "source": { + "gitCloneDepth": 1, + "location": "https://github.com/my-repo/codebuild-demo-project.git", + "insecureSsl": false, + "reportBuildStatus": false, + "type": "GITHUB" + }, + "buildStatus": "SUCCEEDED", + "secondaryArtifacts": [], + "phases": [ + { + "durationInSeconds": 0, + "startTime": 1548716241.89, + "phaseType": "SUBMITTED", + "endTime": 1548716242.241, + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 0, + "startTime": 1548716242.241, + "phaseType": "QUEUED", + "endTime": 1548716242.536, + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 33, + "endTime": 1548716276.171, + "contexts": [ + { + "statusCode": "", + "message": "" + } + ], + "startTime": 1548716242.536, + "phaseType": "PROVISIONING", + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 15, + "endTime": 1548716291.809, + "contexts": [ + { + "statusCode": "", + "message": "" + } + ], + "startTime": 1548716276.171, + "phaseType": "DOWNLOAD_SOURCE", + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 0, + "endTime": 1548716291.993, + "contexts": [ + { + "statusCode": "", + "message": "" + } + ], + "startTime": 1548716291.809, + "phaseType": "INSTALL", + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 0, + "endTime": 1548716292.191, + "contexts": [ + { + "statusCode": "", + "message": "" + } + ], + "startTime": 1548716291.993, + "phaseType": "PRE_BUILD", + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 9, + "endTime": 1548716301.622, + "contexts": [ + { + "statusCode": "", + "message": "" + } + ], + "startTime": 1548716292.191, + "phaseType": "BUILD", + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 3, + "endTime": 1548716304.783, + "contexts": [ + { + "statusCode": "", + "message": "" + } + ], + "startTime": 1548716301.622, + "phaseType": "POST_BUILD", + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 8, + "endTime": 1548716313.775, + "contexts": [ + { + "statusCode": "", + "message": "" + } + ], + "startTime": 1548716304.783, + "phaseType": "UPLOAD_ARTIFACTS", + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 2, + "endTime": 1548716315.935, + "contexts": [ + { + "statusCode": "", + "message": "" + } + ], + "startTime": 1548716313.775, + "phaseType": "FINALIZING", + "phaseStatus": "SUCCEEDED" + }, + { + "startTime": 1548716315.935, + "phaseType": "COMPLETED" + } + ], + "startTime": 1548716241.89, + "secondarySourceVersions": [], + "initiator": "my-codebuild-project", + "arn": "arn:aws:codebuild:us-west-2:123456789012:build/codebuild-demo-project:815e755f-bade-4a7e-80f0-efe51EXAMPLE", + "encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3", + "serviceRole": "arn:aws:iam::123456789012:role/service-role/my-codebuild-service-role", + "currentPhase": "COMPLETED", + "id": "codebuild-demo-project:815e755f-bade-4a7e-80f0-efe51EXAMPLE", + "cache": { + "type": "NO_CACHE" + }, + "endTime": 1548716315.935, + "secondarySources": [], + "queuedTimeoutInMinutes": 480, + "resolvedSourceVersion": "f2194c1757bbdcb0f8f229254a4b3c8b27d43e0b" + } + ] + } + +For more information, see `View Build Details (AWS CLI) `_ in the *AWS CodeBuild User Guide*. + diff -Nru awscli-1.11.13/awscli/examples/codebuild/batch-get-projects.rst awscli-1.18.69/awscli/examples/codebuild/batch-get-projects.rst --- awscli-1.11.13/awscli/examples/codebuild/batch-get-projects.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codebuild/batch-get-projects.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,89 @@ +**To get a list of AWS CodeBuild build project names.** + +The following ``batch-get-projects`` example gets a list of CodeBuild build projects specified by name. :: + + aws codebuild batch-get-projects --names codebuild-demo-project codebuild-demo-project2 my-other-demo-project + +In the following output, the ``projectsNotFound`` array lists any build project names that were specified, but not found. The ``projects`` array lists details for each build project where information was found. :: + + { + "projectsNotFound": [], + "projects": [ + { + "encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3", + "name": "codebuild-demo-project2", + "queuedTimeoutInMinutes": 480, + "timeoutInMinutes": 60, + "source": { + "buildspec": "version: 0.2\n\n#env:\n #variables:\n # key: \"value\"\n # key: \"value\"\n #parameter-store:\n # key: \"value\"\n # key:\"value\"\n\nphases:\n #install:\n #commands:\n # - command\n # - command\n #pre_build:\n #commands:\n # - command\n # - command\n build:\n commands:\n # - command\n # - command\n #post_build:\n #commands:\n # - command\n # - command\n#artifacts:\n #files:\n # - location\n # - location\n #name: $(date +%Y-%m-%d)\n #discard-paths: yes\n #base-directory: location\n#cache:\n #paths:\n # - paths", + "type": "NO_SOURCE", + "insecureSsl": false, + "gitCloneDepth": 1 + }, + "artifacts": { + "type": "NO_ARTIFACTS" + }, + "badge": { + "badgeEnabled": false + }, + "lastModified": 1540588091.108, + "created": 1540588091.108, + "arn": "arn:aws:codebuild:us-west-2:123456789012:project/test-for-sample", + "secondarySources": [], + "secondaryArtifacts": [], + "cache": { + "type": "NO_CACHE" + }, + "serviceRole": "arn:aws:iam::123456789012:role/service-role/my-test-role", + "environment": { + "image": "aws/codebuild/java:openjdk-8", + "privilegedMode": true, + "type": "LINUX_CONTAINER", + "computeType": "BUILD_GENERAL1_SMALL", + "environmentVariables": [] + }, + "tags": [] + }, + { + "encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3", + "name": "my-other-demo-project", + "queuedTimeoutInMinutes": 480, + "timeoutInMinutes": 60, + "source": { + "location": "https://github.com/iversonic/codedeploy-sample.git", + "reportBuildStatus": false, + "buildspec": "buildspec.yml", + "insecureSsl": false, + "gitCloneDepth": 1, + "type": "GITHUB", + "auth": { + "type": "OAUTH" + } + }, + "artifacts": { + "type": "NO_ARTIFACTS" + }, + "badge": { + "badgeEnabled": false + }, + "lastModified": 1523401711.73, + "created": 1523401711.73, + "arn": "arn:aws:codebuild:us-west-2:123456789012:project/Project2", + "cache": { + "type": "NO_CACHE" + }, + "serviceRole": "arn:aws:iam::123456789012:role/service-role/codebuild-Project2-service-role", + "environment": { + "image": "aws/codebuild/nodejs:4.4.7", + "privilegedMode": false, + "type": "LINUX_CONTAINER", + "computeType": "BUILD_GENERAL1_SMALL", + "environmentVariables": [] + }, + "tags": [] + } + ] + } + +For more information, see `View a Build Project's Details (AWS CLI) `_ in the *AWS CodeBuild User Guide*. + diff -Nru awscli-1.11.13/awscli/examples/codebuild/create-project.rst awscli-1.18.69/awscli/examples/codebuild/create-project.rst --- awscli-1.11.13/awscli/examples/codebuild/create-project.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codebuild/create-project.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,112 @@ +**Example 1: To create an AWS CodeBuild build project** + +The following ``create-project`` example creates a CodeBuild build project using source files from an S3 bucket :: + + aws codebuild create-project \ + --name "my-demo-project" \ + --source "{\"type\": \"S3\",\"location\": \"codebuild-us-west-2-123456789012-input-bucket/my-source.zip\"}" \ + --artifacts {"\"type\": \"S3\",\"location\": \"codebuild-us-west-2-123456789012-output-bucket\""} \ + --environment "{\"type\": \"LINUX_CONTAINER\",\"image\": \"aws/codebuild/standard:1.0\",\"computeType\": \"BUILD_GENERAL1_SMALL\"}" \ + --service-role "arn:aws:iam::123456789012:role/service-role/my-codebuild-service-role" + +Output:: + + { + "project": { + "arn": "arn:aws:codebuild:us-west-2:123456789012:project/my-demo-project", + "name": "my-cli-demo-project", + "encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3", + "serviceRole": "arn:aws:iam::123456789012:role/service-role/my-codebuild-service-role", + "lastModified": 1556839783.274, + "badge": { + "badgeEnabled": false + }, + "queuedTimeoutInMinutes": 480, + "environment": { + "image": "aws/codebuild/standard:1.0", + "computeType": "BUILD_GENERAL1_SMALL", + "type": "LINUX_CONTAINER", + "imagePullCredentialsType": "CODEBUILD", + "privilegedMode": false, + "environmentVariables": [] + }, + "artifacts": { + "location": "codebuild-us-west-2-123456789012-output-bucket", + "name": "my-cli-demo-project", + "namespaceType": "NONE", + "type": "S3", + "packaging": "NONE", + "encryptionDisabled": false + }, + "source": { + "type": "S3", + "location": "codebuild-us-west-2-123456789012-input-bucket/my-source.zip", + "insecureSsl": false + }, + "timeoutInMinutes": 60, + "cache": { + "type": "NO_CACHE" + }, + "created": 1556839783.274 + } + } + +**Example 2: To create an AWS CodeBuild build project using a JSON input file for the parameters** + +The following ``create-project`` example creates a CodeBuild build project by passing all of the required parameters in a JSON input file. Create the input file template by running the command with only the ``--generate-cli-skeleton parameter``. :: + + aws codebuild create-project --cli-input-json file://create-project.json + +The input JSON file ``create-project.json`` contains the following content:: + + { + "name": "codebuild-demo-project", + "source": { + "type": "S3", + "location": "codebuild-region-ID-account-ID-input-bucket/MessageUtil.zip" + }, + "artifacts": { + "type": "S3", + "location": "codebuild-region-ID-account-ID-output-bucket" + }, + "environment": { + "type": "LINUX_CONTAINER", + "image": "aws/codebuild/standard:1.0", + "computeType": "BUILD_GENERAL1_SMALL" + }, + "serviceRole": "serviceIAMRole" + } + +Output:: + + { + "project": { + "name": "codebuild-demo-project", + "serviceRole": "serviceIAMRole", + "tags": [], + "artifacts": { + "packaging": "NONE", + "type": "S3", + "location": "codebuild-region-ID-account-ID-output-bucket", + "name": "message-util.zip" + }, + "lastModified": 1472661575.244, + "timeoutInMinutes": 60, + "created": 1472661575.244, + "environment": { + "computeType": "BUILD_GENERAL1_SMALL", + "image": "aws/codebuild/standard:1.0", + "type": "LINUX_CONTAINER", + "environmentVariables": [] + }, + "source": { + "type": "S3", + "location": "codebuild-region-ID-account-ID-input-bucket/MessageUtil.zip" + }, + "encryptionKey": "arn:aws:kms:region-ID:account-ID:alias/aws/s3", + "arn": "arn:aws:codebuild:region-ID:account-ID:project/codebuild-demo-project" + } + } + +For more information, see `Create a Build Project (AWS CLI) `_ in the *AWS CodeBuild User Guide*. + diff -Nru awscli-1.11.13/awscli/examples/codebuild/create-webhook.rst awscli-1.18.69/awscli/examples/codebuild/create-webhook.rst --- awscli-1.11.13/awscli/examples/codebuild/create-webhook.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codebuild/create-webhook.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,50 @@ +**To create webhook filters for an AWS CodeBuild project** + +The following ``create-webhook`` example creates a webhook for a CodeBuild project named ``my-project`` that has two filter groups. The first filter group specifies pull requests that are created, updated, or reopened on branches with Git reference names that match the regular expression ``^refs/heads/master$`` and head references that match ``^refs/heads/myBranch$``. The second filter group specifies push requests on branches with Git reference names that do not match the regular expression ``^refs/heads/myBranch$``. :: + + aws codebuild create-webhook \ + --project-name my-project \ + --filter-groups "[[{\"type\":\"EVENT\",\"pattern\":\"PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED\"},{\"type\":\"HEAD_REF\",\"pattern\":\"^refs/heads/myBranch$\",\"excludeMatchedPattern\":true},{\"type\":\"BASE_REF\",\"pattern\":\"^refs/heads/master$\",\"excludeMatchedPattern\":true}],[{\"type\":\"EVENT\",\"pattern\":\"PUSH\"},{\"type\":\"HEAD_REF\",\"pattern\":\"^refs/heads/myBranch$\",\"excludeMatchedPattern\":true}]]" + +Output:: + + { + "webhook": { + "payloadUrl": "https://codebuild.us-west-2.amazonaws.com/webhooks?t=eyJlbmNyeXB0ZWREYXRhIjoiVVl5MGtoeGRwSzZFRXl2Wnh4bld1Z0tKZ291TVpQNEtFamQ3RDlDYWpRaGIreVFrdm9EQktIVk1NeHJEWEpmUDUrVUNOMUIyRHJRc1VxcHJ6QlNDSnljPSIsIml2UGFyYW1ldGVyU3BlYyI6InN4Tm1SeUt5MUhaUVRWbGciLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&v=1", + "url": "https://api.github.com/repos/iversonic/codedeploy-sample/hooks/105190656", + "lastModifiedSecret": 1556311319.069, + "filterGroups": [ + [ + { + "type": "EVENT", + "pattern": "PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED", + "excludeMatchedPattern": false + }, + { + "type": "HEAD_REF", + "pattern": "refs/heads/myBranch$", + "excludeMatchedPattern": true + }, + { + "type": "BASE_REF", + "pattern": "refs/heads/master$", + "excludeMatchedPattern": true + } + ], + [ + { + "type": "EVENT", + "pattern": "PUSH", + "excludeMatchedPattern": false + }, + { + "type": "HEAD_REF", + "pattern": "refs/heads/myBranch$", + "excludeMatchedPattern": true + } + ] + ] + } + } + +For more information, see `Filter GitHub Webhook Events (SDK) `_ in the *AWS CodeBuild User Guide*. diff -Nru awscli-1.11.13/awscli/examples/codebuild/delete-project.rst awscli-1.18.69/awscli/examples/codebuild/delete-project.rst --- awscli-1.11.13/awscli/examples/codebuild/delete-project.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codebuild/delete-project.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To delete an AWS CodeBuild build project** + +The following ``delete-project`` example deletes the specified CodeBuild build project. :: + + aws codebuild delete-project --name my-project + +This command produces no output. + +For more information, see `Delete a Build Project (AWS CLI) `_ in the *AWS CodeBuild User Guide*. diff -Nru awscli-1.11.13/awscli/examples/codebuild/delete-source-credentials.rst awscli-1.18.69/awscli/examples/codebuild/delete-source-credentials.rst --- awscli-1.11.13/awscli/examples/codebuild/delete-source-credentials.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codebuild/delete-source-credentials.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,13 @@ +**To disconnect from a source provider and remove its access tokens.** + +The following ``delete-source-credentials`` example disconnects from a source provider and removes its tokens. The ARN of source credentials used to connect to the source provider determines which source credentials. :: + + aws codebuild delete-source-credentials --arn arn-of-your-credentials + +Output:: + + { + "arn": "arn:aws:codebuild:your-region:your-account-id:token/your-server-type" + } + +For more information, see `Connect Source Providers with Access Tokens (CLI) `_ in the *AWS CodeBuild User Guide*. diff -Nru awscli-1.11.13/awscli/examples/codebuild/delete-webhook.rst awscli-1.18.69/awscli/examples/codebuild/delete-webhook.rst --- awscli-1.11.13/awscli/examples/codebuild/delete-webhook.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codebuild/delete-webhook.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To delete a webhook filter from an AWS CodeBuild project** + +The following ``delete-webhook`` example deletes a webhook from the specified CodeBuild project. :: + + aws codebuild delete-webhook --project-name my-project + +This command produces no output. + +For more information, see `Stop Running Builds Automatically (AWS CLI) `_ in the *AWS CodeBuild User Guide*. diff -Nru awscli-1.11.13/awscli/examples/codebuild/import-source-credentials.rst awscli-1.18.69/awscli/examples/codebuild/import-source-credentials.rst --- awscli-1.11.13/awscli/examples/codebuild/import-source-credentials.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codebuild/import-source-credentials.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,13 @@ +**Connect an AWS CodeBuild user to a source provider by importing credentials for the source provider.** + +The following ``import-source-credentials`` example imports a token for a Bitbucket repository that uses BASIC_AUTH for its authentication type. :: + + aws codebuild import-source-credentials --server-type BITBUCKET --auth-type BASIC_AUTH --token my-Bitbucket-password --username my-Bitbucket-username + +Output:: + + { + "arn": "arn:aws:codebuild:us-west-2:123456789012:token/bitbucket" + } + +For more information, see `Connect Source Providers with Access Tokens (CLI) `_ in the *AWS CodeBuild User Guide*. diff -Nru awscli-1.11.13/awscli/examples/codebuild/invalidate-project-cache.rst awscli-1.18.69/awscli/examples/codebuild/invalidate-project-cache.rst --- awscli-1.11.13/awscli/examples/codebuild/invalidate-project-cache.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codebuild/invalidate-project-cache.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To reset the cache for an AWS CodeBuild build project.** + +The following ``invalidate-project-cache`` example resets the cache for the specified CodeBuild project. :: + + aws codebuild invalidate-project-cache --project-name my-project + +This command produces no output. + +For more information, see `Build Caching in CodeBuild `_ in the *AWS CodeBuild User Guide*. diff -Nru awscli-1.11.13/awscli/examples/codebuild/list-builds-for-project.rst awscli-1.18.69/awscli/examples/codebuild/list-builds-for-project.rst --- awscli-1.11.13/awscli/examples/codebuild/list-builds-for-project.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codebuild/list-builds-for-project.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To view a list of builds for an AWS CodeBuild build project.** + +The following ``list-builds-for-project`` example lists the build IDs in descending order for the specified CodeBuild build project. :: + + aws codebuild list-builds-for-project --project-name codebuild-demo-project --sort-order DESCENDING + +Output:: + + { + "ids": [ + "codebuild-demo-project:1a2b3c4d-5678-90ab-cdef-11111example", + "codebuild-demo-project:1a2b3c4d-5678-90ab-cdef-22222example", + "codebuild-demo-project:1a2b3c4d-5678-90ab-cdef-33333example", + "codebuild-demo-project:1a2b3c4d-5678-90ab-cdef-44444example", + "codebuild-demo-project:1a2b3c4d-5678-90ab-cdef-55555example" + ] + } + +For more information, see `View a List of Build IDs for a Build Project (AWS CLI) `_ in the *AWS CodeBuild User Guide* diff -Nru awscli-1.11.13/awscli/examples/codebuild/list-builds.rst awscli-1.18.69/awscli/examples/codebuild/list-builds.rst --- awscli-1.11.13/awscli/examples/codebuild/list-builds.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codebuild/list-builds.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,35 @@ +**To get a list of AWS CodeBuild builds IDs.** + +The following ``list-builds`` example gets a list of CodeBuild IDs sorted in ascending order. :: + + aws codebuild list-builds --sort-order ASCENDING + +The output includes a ``nextToken`` value which indicates that there is more output available. :: + + { + "nextToken": "4AEA6u7J...The full token has been omitted for brevity...MzY2OA==", + "ids": [ + "codebuild-demo-project:815e755f-bade-4a7e-80f0-efe51EXAMPLE" + "codebuild-demo-project:84a7f3d1-d40e-4956-b4cf-7a9d4EXAMPLE" + ... The full list of build IDs has been omitted for brevity ... + "codebuild-demo-project:931d0b72-bf6f-4040-a472-5c707EXAMPLE" + ] + } + +Run this command again and provide the ``nextToken`` value in the previous response as a parameter to get the next part of the output. Repeat until you don't receive a ``nextToken`` value in the response. :: + + aws codebuild list-builds --sort-order ASCENDING --next-token 4AEA6u7J...The full token has been omitted for brevity...MzY2OA== + +Next part of the output:: + + { + "ids": [ + "codebuild-demo-project:49015049-21cf-4b50-9708-df115EXAMPLE", + "codebuild-demo-project:543e7206-68a3-46d6-a4da-759abEXAMPLE", + ... The full list of build IDs has been omitted for brevity ... + "codebuild-demo-project:c282f198-4582-4b38-bdc0-26f96EXAMPLE" + ] + } + +For more information, see `View a List of Build IDs (AWS CLI) `_ in the *AWS CodeBuild User Guide* + diff -Nru awscli-1.11.13/awscli/examples/codebuild/list-curated-environment-images.rst awscli-1.18.69/awscli/examples/codebuild/list-curated-environment-images.rst --- awscli-1.11.13/awscli/examples/codebuild/list-curated-environment-images.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codebuild/list-curated-environment-images.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,40 @@ +**To get a list of Docker images managed by AWS CodeBuild that you can use for your builds.** + +The following ``list-curated-environment-images`` example lists the Docker images managed by CodeBuild that can be used for builds.:: + + aws codebuild list-curated-environment-images + +Output:: + + { + "platforms": [ + { + "platform": "AMAZON_LINUX", + "languages": [ + { + "language": "JAVA", + "images": [ + { + "description": "AWS ElasticBeanstalk - Java 7 Running on Amazon Linux 64bit v2.1.3", + "name": "aws/codebuild/eb-java-7-amazonlinux-64:2.1.3", + "versions": [ + "aws/codebuild/eb-java-7-amazonlinux-64:2.1.3-1.0.0" + ] + }, + { + "description": "AWS ElasticBeanstalk - Java 8 Running on Amazon Linux 64bit v2.1.3", + "name": "aws/codebuild/eb-java-8-amazonlinux-64:2.1.3", + "versions": [ + "aws/codebuild/eb-java-8-amazonlinux-64:2.1.3-1.0.0" + ] + }, + ... LIST TRUNCATED FOR BREVITY ... + ] + } + ] + } + ] + } + + +For more information, see `Docker Images Provided by CodeBuild `_ in the *AWS CodeBuild User Guide* diff -Nru awscli-1.11.13/awscli/examples/codebuild/list-projects.rst awscli-1.18.69/awscli/examples/codebuild/list-projects.rst --- awscli-1.11.13/awscli/examples/codebuild/list-projects.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codebuild/list-projects.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,33 @@ +**To get a list of AWS CodeBuild build project names.** + +The following ``list-projects`` example gets a list of CodeBuild build projects sorted by name in ascending order. :: + + aws codebuild list-projects --sort-by NAME --sort-order ASCENDING + +The output includes a ``nextToken`` value which indicates that there is more output available. :: + + { + "nextToken": "Ci33ACF6...The full token has been omitted for brevity...U+AkMx8=", + "projects": [ + "codebuild-demo-project", + "codebuild-demo-project2", + ... The full list of build project names has been omitted for brevity ... + "codebuild-demo-project99" + ] + } + +Run this command again and provide the ``nextToken`` value from the previous response as a parameter to get the next part of the output. Repeat until you don't receive a ``nextToken`` value in the response. :: + + aws codebuild list-projects --sort-by NAME --sort-order ASCENDING --next-token Ci33ACF6...The full token has been omitted for brevity...U+AkMx8= + + { + "projects": [ + "codebuild-demo-project100", + "codebuild-demo-project101", + ... The full list of build project names has been omitted for brevity ... + "codebuild-demo-project122" + ] + } + +For more information, see `View a List of Build Project Names (AWS CLI) `_ in the *AWS CodeBuild User Guide*. + diff -Nru awscli-1.11.13/awscli/examples/codebuild/list-source-credentials.rst awscli-1.18.69/awscli/examples/codebuild/list-source-credentials.rst --- awscli-1.11.13/awscli/examples/codebuild/list-source-credentials.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codebuild/list-source-credentials.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,24 @@ +**To view a list of sourceCredentialsObjects** + +The following ``list-source-credentials`` example lists tokens for an AWS account connected to one Bitbucket account and one GitHub account. Each ``sourceCredentialsInfos`` object in the response contains connected source credentials information. :: + + aws codebuild list-source-credentials + +Output:: + + { + "sourceCredentialsInfos": [ + { + "serverType": "BITBUCKET", + "arn": "arn:aws:codebuild:us-west-2:123456789012:token/bitbucket", + "authType": "BASIC_AUTH" + }, + { + "serverType": "GITHUB", + "arn": "arn:aws:codebuild:us-west-2:123456789012:token/github", + "authType": "OAUTH" + } + ] + } + +For more information, see `Connect Source Providers with Access Tokens (CLI) `_ in the *AWS CodeBuild User Guide*. diff -Nru awscli-1.11.13/awscli/examples/codebuild/start-build.rst awscli-1.18.69/awscli/examples/codebuild/start-build.rst --- awscli-1.11.13/awscli/examples/codebuild/start-build.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codebuild/start-build.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,66 @@ +**To start running a build of an AWS CodeBuild build project.** + +The following ``start-build`` example starts a build for the specified CodeBuild project. The build overrides both the project's setting for the number of minutes the build is allowed to be queued before it times out and the project's artifact settings. :: + + aws codebuild start-build \ + --project-name "my-demo-project" \ + --queued-timeout-in-minutes-override 5 \ + --artifacts-override {"\"type\": \"S3\",\"location\": \"arn:aws:s3:::artifacts-override\",\"overrideArtifactName\":true"} + +Output:: + + { + "build": { + "serviceRole": "arn:aws:iam::123456789012:role/service-role/my-codebuild-service-role", + "buildStatus": "IN_PROGRESS", + "buildComplete": false, + "projectName": "my-demo-project", + "timeoutInMinutes": 60, + "source": { + "insecureSsl": false, + "type": "S3", + "location": "codebuild-us-west-2-123456789012-input-bucket/my-source.zip" + }, + "queuedTimeoutInMinutes": 5, + "encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3", + "currentPhase": "QUEUED", + "startTime": 1556905683.568, + "environment": { + "computeType": "BUILD_GENERAL1_MEDIUM", + "environmentVariables": [], + "type": "LINUX_CONTAINER", + "privilegedMode": false, + "image": "aws/codebuild/standard:1.0", + "imagePullCredentialsType": "CODEBUILD" + }, + "phases": [ + { + "phaseStatus": "SUCCEEDED", + "startTime": 1556905683.568, + "phaseType": "SUBMITTED", + "durationInSeconds": 0, + "endTime": 1556905684.524 + }, + { + "startTime": 1556905684.524, + "phaseType": "QUEUED" + } + ], + "logs": { + "deepLink": "https://console.aws.amazon.com/cloudwatch/home?region=us-west-2#logEvent:group=null;stream=null" + }, + "artifacts": { + "encryptionDisabled": false, + "location": "arn:aws:s3:::artifacts-override/my-demo-project", + "overrideArtifactName": true + }, + "cache": { + "type": "NO_CACHE" + }, + "id": "my-demo-project::12345678-a1b2-c3d4-e5f6-11111EXAMPLE", + "initiator": "my-aws-account-name", + "arn": "arn:aws:codebuild:us-west-2:123456789012:build/my-demo-project::12345678-a1b2-c3d4-e5f6-11111EXAMPLE" + } + } + +For more information, see `Run a Build (AWS CLI) `_ in the *AWS CodeBuild User Guide*. diff -Nru awscli-1.11.13/awscli/examples/codebuild/stop-build.rst awscli-1.18.69/awscli/examples/codebuild/stop-build.rst --- awscli-1.11.13/awscli/examples/codebuild/stop-build.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codebuild/stop-build.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,132 @@ +**To stop a build of an AWS CodeBuild build project.** + +The following ``stop-build`` example stops the specified CodeBuild build. :: + + aws codebuild stop-build --id my-demo-project:12345678-a1b2-c3d4-e5f6-11111EXAMPLE + +Output:: + + { + "build": { + "startTime": 1556906956.318, + "initiator": "my-aws-account-name", + "projectName": "my-demo-project", + "currentPhase": "COMPLETED", + "cache": { + "type": "NO_CACHE" + }, + "source": { + "insecureSsl": false, + "location": "codebuild-us-west-2-123456789012-input-bucket/my-source.zip", + "type": "S3" + }, + "id": "my-demo-project:1a2b3c4d-5678-90ab-cdef-11111EXAMPLE", + "endTime": 1556906974.781, + "phases": [ + { + "durationInSeconds": 0, + "phaseType": "SUBMITTED", + "endTime": 1556906956.935, + "phaseStatus": "SUCCEEDED", + "startTime": 1556906956.318 + }, + { + "durationInSeconds": 1, + "phaseType": "QUEUED", + "endTime": 1556906958.272, + "phaseStatus": "SUCCEEDED", + "startTime": 1556906956.935 + }, + { + "phaseType": "PROVISIONING", + "phaseStatus": "SUCCEEDED", + "durationInSeconds": 14, + "contexts": [ + { + "message": "", + "statusCode": "" + } + ], + "endTime": 1556906972.847, + "startTime": 1556906958.272 + }, + { + "phaseType": "DOWNLOAD_SOURCE", + "phaseStatus": "SUCCEEDED", + "durationInSeconds": 0, + "contexts": [ + { + "message": "", + "statusCode": "" + } + ], + "endTime": 1556906973.552, + "startTime": 1556906972.847 + }, + { + "phaseType": "INSTALL", + "phaseStatus": "SUCCEEDED", + "durationInSeconds": 0, + "contexts": [ + { + "message": "", + "statusCode": "" + } + ], + "endTime": 1556906973.75, + "startTime": 1556906973.552 + }, + { + "phaseType": "PRE_BUILD", + "phaseStatus": "SUCCEEDED", + "durationInSeconds": 0, + "contexts": [ + { + "message": "", + "statusCode": "" + } + ], + "endTime": 1556906973.937, + "startTime": 1556906973.75 + }, + { + "durationInSeconds": 0, + "phaseType": "BUILD", + "endTime": 1556906974.781, + "phaseStatus": "STOPPED", + "startTime": 1556906973.937 + }, + { + "phaseType": "COMPLETED", + "startTime": 1556906974.781 + } + ], + "artifacts": { + "location": "arn:aws:s3:::artifacts-override/my-demo-project", + "encryptionDisabled": false, + "overrideArtifactName": true + }, + "buildComplete": true, + "buildStatus": "STOPPED", + "encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3", + "serviceRole": "arn:aws:iam::123456789012:role/service-role/my-codebuild-service-role", + "queuedTimeoutInMinutes": 5, + "timeoutInMinutes": 60, + "environment": { + "type": "LINUX_CONTAINER", + "environmentVariables": [], + "computeType": "BUILD_GENERAL1_MEDIUM", + "privilegedMode": false, + "image": "aws/codebuild/standard:1.0", + "imagePullCredentialsType": "CODEBUILD" + }, + "logs": { + "streamName": "1a2b3c4d-5678-90ab-cdef-11111EXAMPLE", + "deepLink": "https://console.aws.amazon.com/cloudwatch/home?region=us-west-2#logEvent:group=/aws/codebuild/my-demo-project;stream=1a2b3c4d-5678-90ab-cdef-11111EXAMPLE", + "groupName": "/aws/codebuild/my-demo-project" + }, + "arn": "arn:aws:codebuild:us-west-2:123456789012:build/my-demo-project:1a2b3c4d-5678-90ab-cdef-11111EXAMPLE" + } + } + +For more information, see `Stop a Build (AWS CLI) `_ in the *AWS CodeBuild User Guide*. diff -Nru awscli-1.11.13/awscli/examples/codebuild/update-project.rst awscli-1.18.69/awscli/examples/codebuild/update-project.rst --- awscli-1.11.13/awscli/examples/codebuild/update-project.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codebuild/update-project.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,56 @@ +**To change an AWS CodeBuild build project's settings.** + +The following ``update-project`` example changes the settings of the specified CodeBuild build project named my-demo-project. :: + + aws codebuild update-project --name "my-demo-project" \ + --description "This project is updated" \ + --source "{\"type\": \"S3\",\"location\": \"codebuild-us-west-2-123456789012-input-bucket/my-source-2.zip\"}" \ + --artifacts {"\"type\": \"S3\",\"location\": \"codebuild-us-west-2-123456789012-output-bucket-2\""} \ + --environment "{\"type\": \"LINUX_CONTAINER\",\"image\": \"aws/codebuild/standard:1.0\",\"computeType\": \"BUILD_GENERAL1_MEDIUM\"}" \ + --service-role "arn:aws:iam::123456789012:role/service-role/my-codebuild-service-role" + +The output displays the updated settings. :: + + { + "project": { + "arn": "arn:aws:codebuild:us-west-2:123456789012:project/my-demo-project", + "environment": { + "privilegedMode": false, + "environmentVariables": [], + "type": "LINUX_CONTAINER", + "image": "aws/codebuild/standard:1.0", + "computeType": "BUILD_GENERAL1_MEDIUM", + "imagePullCredentialsType": "CODEBUILD" + }, + "queuedTimeoutInMinutes": 480, + "description": "This project is updated", + "artifacts": { + "packaging": "NONE", + "name": "my-demo-project", + "type": "S3", + "namespaceType": "NONE", + "encryptionDisabled": false, + "location": "codebuild-us-west-2-123456789012-output-bucket-2" + }, + "encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3", + "badge": { + "badgeEnabled": false + }, + "serviceRole": "arn:aws:iam::123456789012:role/service-role/my-codebuild-service-role", + "lastModified": 1556840545.967, + "tags": [], + "timeoutInMinutes": 60, + "created": 1556839783.274, + "name": "my-demo-project", + "cache": { + "type": "NO_CACHE" + }, + "source": { + "type": "S3", + "insecureSsl": false, + "location": "codebuild-us-west-2-123456789012-input-bucket/my-source-2.zip" + } + } + } + +For more information, see `Change a Build Project's Settings (AWS CLI) `_ in the *AWS CodeBuild User Guide* diff -Nru awscli-1.11.13/awscli/examples/codebuild/update-webhook.rst awscli-1.18.69/awscli/examples/codebuild/update-webhook.rst --- awscli-1.11.13/awscli/examples/codebuild/update-webhook.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codebuild/update-webhook.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,47 @@ +**To update the webhook for an AWS CodeBuild project** + +The following ``update-webhook`` example updates a webhook for the specified CodeBuild project with two filter groups. The ``--rotate-secret`` parameter specifies that GitHub rotate the project's secret key every time a code change triggers a build. The first filter group specifies pull requests that are created, updated, or reopened on branches with Git reference names that match the regular expression ``^refs/heads/master$`` and head references that match ``^refs/heads/myBranch$``. The second filter group specifies push requests on branches with Git reference names that do not match the regular expression ``^refs/heads/myBranch$``. :: + + aws codebuild update-webhook \ + --project-name Project2 \ + --rotate-secret \ + --filter-groups "[[{\"type\":\"EVENT\",\"pattern\":\"PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED\"},{\"type\":\"HEAD_REF\",\"pattern\":\"^refs/heads/myBranch$\",\"excludeMatchedPattern\":true},{\"type\":\"BASE_REF\",\"pattern\":\"^refs/heads/master$\",\"excludeMatchedPattern\":true}],[{\"type\":\"EVENT\",\"pattern\":\"PUSH\"},{\"type\":\"HEAD_REF\",\"pattern\":\"^refs/heads/myBranch$\",\"excludeMatchedPattern\":true}]]" + +Output:: + + { + "webhook": { + "filterGroups": [ + [ + { + "pattern": "PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED", + "type": "EVENT" + }, + { + "excludeMatchedPattern": true, + "pattern": "refs/heads/myBranch$", + "type": "HEAD_REF" + }, + { + "excludeMatchedPattern": true, + "pattern": "refs/heads/master$", + "type": "BASE_REF" + } + ], + [ + { + "pattern": "PUSH", + "type": "EVENT" + }, + { + "excludeMatchedPattern": true, + "pattern": "refs/heads/myBranch$", + "type": "HEAD_REF" + } + ] + ], + "lastModifiedSecret": 1556312220.133 + } + } + +For more information, see `Change a Build Project's Settings (AWS CLI) `_ in the *AWS CodeBuild User Guide* diff -Nru awscli-1.11.13/awscli/examples/codecommit/associate-approval-rule-template-with-repository.rst awscli-1.18.69/awscli/examples/codecommit/associate-approval-rule-template-with-repository.rst --- awscli-1.11.13/awscli/examples/codecommit/associate-approval-rule-template-with-repository.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/associate-approval-rule-template-with-repository.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/codecommit/batch-associate-approval-rule-template-with-repositories.rst awscli-1.18.69/awscli/examples/codecommit/batch-associate-approval-rule-template-with-repositories.rst --- awscli-1.11.13/awscli/examples/codecommit/batch-associate-approval-rule-template-with-repositories.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/batch-associate-approval-rule-template-with-repositories.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/codecommit/batch-describe-merge-conflicts.rst awscli-1.18.69/awscli/examples/codecommit/batch-describe-merge-conflicts.rst --- awscli-1.11.13/awscli/examples/codecommit/batch-describe-merge-conflicts.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/batch-describe-merge-conflicts.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,71 @@ +**To get information about merge conflicts in all files or a subset of files in a merge between two commit specifiers** + +The following ``batch-describe-merge-conflicts`` example determines the merge conflicts for merging a source branch named ``feature-randomizationfeature`` with a destination branch named ``master`` using the ``THREE_WAY_MERGE`` strategy in a repository named ``MyDemoRepo``. :: + + aws codecommit batch-describe-merge-conflicts \ + --source-commit-specifier feature-randomizationfeature \ + --destination-commit-specifier master \ + --merge-option THREE_WAY_MERGE \ + --repository-name MyDemoRepo + +Output:: + + { + "conflicts": [ + { + "conflictMetadata": { + "filePath": "readme.md", + "fileSizes": { + "source": 139, + "destination": 230, + "base": 85 + }, + "fileModes": { + "source": "NORMAL", + "destination": "NORMAL", + "base": "NORMAL" + }, + "objectTypes": { + "source": "FILE", + "destination": "FILE", + "base": "FILE" + }, + "numberOfConflicts": 1, + "isBinaryFile": { + "source": false, + "destination": false, + "base": false + }, + "contentConflict": true, + "fileModeConflict": false, + "objectTypeConflict": false, + "mergeOperations": { + "source": "M", + "destination": "M" + } + }, + "mergeHunks": [ + { + "isConflict": true, + "source": { + "startLine": 0, + "endLine": 3, + "hunkContent": "VGhpcyBpEXAMPLE==" + }, + "destination": { + "startLine": 0, + "endLine": 1, + "hunkContent": "VXNlIHRoEXAMPLE=" + } + } + ] + } + ], + "errors": [], + "destinationCommitId": "86958e0aEXAMPLE", + "sourceCommitId": "6ccd57fdEXAMPLE", + "baseCommitId": "767b6958EXAMPLE" + } + + +For more information, see `Resolve Conflicts in a Pull Request `__ in the *AWS CodeCommit User Guide*. diff -Nru awscli-1.11.13/awscli/examples/codecommit/batch-disassociate-approval-rule-template-from-repositories.rst awscli-1.18.69/awscli/examples/codecommit/batch-disassociate-approval-rule-template-from-repositories.rst --- awscli-1.11.13/awscli/examples/codecommit/batch-disassociate-approval-rule-template-from-repositories.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/batch-disassociate-approval-rule-template-from-repositories.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/codecommit/batch-get-commits.rst awscli-1.18.69/awscli/examples/codecommit/batch-get-commits.rst --- awscli-1.11.13/awscli/examples/codecommit/batch-get-commits.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/batch-get-commits.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,54 @@ +**To view information about multiple commits** + +The following ``batch-get-commits`` example displays details about the specified commits. :: + + aws codecommit batch-get-commits \ + --repository-name MyDemoRepo \ + --commit-ids 317f8570EXAMPLE 4c925148EXAMPLE + +Output:: + + { + "commits": [ + { + "additionalData": "", + "committer": { + "date": "1508280564 -0800", + "name": "Mary Major", + "email": "mary_major@example.com" + }, + "author": { + "date": "1508280564 -0800", + "name": "Mary Major", + "email": "mary_major@example.com" + }, + "commitId": "317f8570EXAMPLE", + "treeId": "1f330709EXAMPLE", + "parents": [ + "6e147360EXAMPLE" + ], + "message": "Change variable name and add new response element" + }, + { + "additionalData": "", + "committer": { + "date": "1508280542 -0800", + "name": "Li Juan", + "email": "li_juan@example.com" + }, + "author": { + "date": "1508280542 -0800", + "name": "Li Juan", + "email": "li_juan@example.com" + }, + "commitId": "4c925148EXAMPLE", + "treeId": "1f330709EXAMPLE", + "parents": [ + "317f8570EXAMPLE" + ], + "message": "Added new class" + } + } + + +For more information, see `View Commit Details `__ in the *AWS CodeCommit User Guide*. diff -Nru awscli-1.11.13/awscli/examples/codecommit/create-approval-rule-template.rst awscli-1.18.69/awscli/examples/codecommit/create-approval-rule-template.rst --- awscli-1.11.13/awscli/examples/codecommit/create-approval-rule-template.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/create-approval-rule-template.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/codecommit/create-branch.rst awscli-1.18.69/awscli/examples/codecommit/create-branch.rst --- awscli-1.11.13/awscli/examples/codecommit/create-branch.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/create-branch.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,6 +1,6 @@ **To create a branch** -This example creates a branch in an AWS CoceCommit repository. This command produces output only if there are errors. +This example creates a branch in an AWS CodeCommit repository. This command produces output only if there are errors. Command:: @@ -8,4 +8,4 @@ Output:: - None. \ No newline at end of file + None. diff -Nru awscli-1.11.13/awscli/examples/codecommit/create-commit.rst awscli-1.18.69/awscli/examples/codecommit/create-commit.rst --- awscli-1.11.13/awscli/examples/codecommit/create-commit.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/create-commit.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,25 @@ +**To create a commit** + +The following ``create-commit`` example demonstrates how to create an initial commit for a repository that adds a ``readme.md`` file to a repository named ``MyDemoRepo`` in the ``master`` branch. :: + + aws codecommit create-commit --repository-name MyDemoRepo --branch-name master --put-files "filePath=readme.md,fileContent='Welcome to our team repository.'" + +Output:: + + { + "filesAdded": [ + { + "blobId": "5e1c309d-EXAMPLE", + "absolutePath": "readme.md", + "fileMode": "NORMAL" + } + ], + "commitId": "4df8b524-EXAMPLE", + "treeId": "55b57003-EXAMPLE", + "filesDeleted": [], + "filesUpdated": [] + } + +For more information, see `Create a Commit in AWS CodeCommit`_ in the *AWS CodeCommit User Guide*. + +.. _`Create a Commit in AWS CodeCommit`: https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-create-commit.html#how-to-create-commit-cli \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/codecommit/create-pull-request-approval-rule.rst awscli-1.18.69/awscli/examples/codecommit/create-pull-request-approval-rule.rst --- awscli-1.11.13/awscli/examples/codecommit/create-pull-request-approval-rule.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/create-pull-request-approval-rule.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/codecommit/create-pull-request.rst awscli-1.18.69/awscli/examples/codecommit/create-pull-request.rst --- awscli-1.11.13/awscli/examples/codecommit/create-pull-request.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/create-pull-request.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,36 @@ +**To create a pull request** + +The following ``create-pull-request`` example creates a pull request named 'My Pull Request' with a description of 'Please review these changes by Tuesday' that targets the 'MyNewBranch' source branch and is to be merged to the default branch 'master' in an AWS CodeCommit repository named 'MyDemoRepo'. :: + + aws codecommit create-pull-request \ + --title "My Pull Request" \ + --description "Please review these changes by Tuesday" \ + --client-request-token 123Example \ + --targets repositoryName=MyDemoRepo,sourceReference=MyNewBranch + +Output:: + + { + "pullRequest": { + "authorArn": "arn:aws:iam::111111111111:user/Jane_Doe", + "clientRequestToken": "123Example", + "creationDate": 1508962823.285, + "description": "Please review these changes by Tuesday", + "lastActivityDate": 1508962823.285, + "pullRequestId": "42", + "pullRequestStatus": "OPEN", + "pullRequestTargets": [ + { + "destinationCommit": "5d036259EXAMPLE", + "destinationReference": "refs/heads/master", + "mergeMetadata": { + "isMerged": false, + }, + "repositoryName": "MyDemoRepo", + "sourceCommit": "317f8570EXAMPLE", + "sourceReference": "refs/heads/MyNewBranch" + } + ], + "title": "My Pull Request" + } + } diff -Nru awscli-1.11.13/awscli/examples/codecommit/create-unreferenced-merge-commit.rst awscli-1.18.69/awscli/examples/codecommit/create-unreferenced-merge-commit.rst --- awscli-1.11.13/awscli/examples/codecommit/create-unreferenced-merge-commit.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/create-unreferenced-merge-commit.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To create an unreferenced commit that represents the result of merging two commit specifiers** + +The following ``create-unreferenced-merge-commit`` example creates a commit that represents the results of a merge between a source branch named ``bugfix-1234`` with a destination branch named ``master`` using the THREE_WAY_MERGE strategy in a repository named ``MyDemoRepo``. :: + + aws codecommit create-unreferenced-merge-commit \ + --source-commit-specifier bugfix-1234 \ + --destination-commit-specifier master \ + --merge-option THREE_WAY_MERGE \ + --repository-name MyDemoRepo \ + --name "Maria Garcia" \ + --email "maria_garcia@example.com" \ + --commit-message "Testing the results of this merge." + +Output:: + + { + "commitId": "4f178133EXAMPLE", + "treeId": "389765daEXAMPLE" + } + +For more information, see `Resolve Conflicts in a Pull Request `__ in the *AWS CodeCommit User Guide*. diff -Nru awscli-1.11.13/awscli/examples/codecommit/credential-helper.rst awscli-1.18.69/awscli/examples/codecommit/credential-helper.rst --- awscli-1.11.13/awscli/examples/codecommit/credential-helper.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/credential-helper.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To set up the credential helper included in the AWS CLI with AWS CodeCommit** + +The ``credential-helper`` utility is not designed to be called directly from the AWS CLI. Instead it is intended to be used as a parameter with the ``git config`` command to set up your local computer. It enables Git to use HTTPS and a cryptographically signed version of your IAM user credentials or Amazon EC2 instance role whenever Git needs to authenticate with AWS to interact with CodeCommit repositories. :: + + git config --global credential.helper '!aws codecommit credential-helper $@' + git config --global credential.UseHttpPath true + +Output:: + + [credential] + helper = !aws codecommit credential-helper $@ + UseHttpPath = true + +For more information, see `Setting up for AWS CodeCommit Using Other Methods`_ in the *AWS CodeCommit User Guide*. Review the content carefully, and then follow the procedures in one of the following topics: `For HTTPS Connections on Linux, macOS, or Unix`_ or `For HTTPS Connections on Windows`_ in the *AWS CodeCommit User Guide*. + +.. _`Setting up for AWS CodeCommit Using Other Methods`: https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up.html?shortFooter=true#setting-up-other +.. _`For HTTPS Connections on Linux, macOS, or Unix`: https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-https-unixes.html +.. _`For HTTPS Connections on Windows`: https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-https-windows.html \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/codecommit/delete-approval-rule-template.rst awscli-1.18.69/awscli/examples/codecommit/delete-approval-rule-template.rst --- awscli-1.11.13/awscli/examples/codecommit/delete-approval-rule-template.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/delete-approval-rule-template.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/codecommit/delete-comment-content.rst awscli-1.18.69/awscli/examples/codecommit/delete-comment-content.rst --- awscli-1.11.13/awscli/examples/codecommit/delete-comment-content.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/delete-comment-content.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To delete the content of a comment** + +You can only delete the content of a comment if you created the comment. This example demonstrates how to delete the content of a comment with the system-generated ID of 'ff30b348EXAMPLEb9aa670f':: + + aws codecommit delete-comment-content --comment-id ff30b348EXAMPLEb9aa670f + +Output:: + + { + "comment": { + "creationDate": 1508369768.142, + "deleted": true, + "lastModifiedDate": 1508369842.278, + "clientRequestToken": "123Example", + "commentId": "ff30b348EXAMPLEb9aa670f", + "authorArn": "arn:aws:iam::111111111111:user/Li_Juan" + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/codecommit/delete-file.rst awscli-1.18.69/awscli/examples/codecommit/delete-file.rst --- awscli-1.11.13/awscli/examples/codecommit/delete-file.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/delete-file.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To delete a file** + +The following ``delete-file`` example demonstrates how to delete a file named ``README.md`` from a branch named ``master`` with a most recent commit ID of ``c5709475EXAMPLE`` in a repository named ``MyDemoRepo``. :: + + aws codecommit delete-file --repository-name MyDemoRepo --branch-name master --file-path README.md --parent-commit-id c5709475EXAMPLE + +Output:: + + { + "blobId":"559b44fEXAMPLE", + "commitId":"353cf655EXAMPLE", + "filePath":"README.md", + "treeId":"6bc824cEXAMPLE" + } + +For more information, see `Edit or Delete a File in AWS CodeCommit`_ in the *AWS CodeCommit API Reference* guide. + +.. _`Edit or Delete a File in AWS CodeCommit`: https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-edit-file.html?shortFooter=true#how-to-edit-file-cli \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/codecommit/delete-pull-request-approval-rule.rst awscli-1.18.69/awscli/examples/codecommit/delete-pull-request-approval-rule.rst --- awscli-1.11.13/awscli/examples/codecommit/delete-pull-request-approval-rule.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/delete-pull-request-approval-rule.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/codecommit/describe-merge-conflicts.rst awscli-1.18.69/awscli/examples/codecommit/describe-merge-conflicts.rst --- awscli-1.11.13/awscli/examples/codecommit/describe-merge-conflicts.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/describe-merge-conflicts.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,66 @@ +**To get detailed information about merge conflicts** + +The following ``describe-merge-conflicts`` example determines the merge conflicts for a file named ``readme.md`` in the specified source branch and destination branch using the THREE_WAY_MERGE strategy. :: + + aws codecommit describe-merge-conflicts \ + --source-commit-specifier feature-randomizationfeature \ + --destination-commit-specifier master \ + --merge-option THREE_WAY_MERGE \ + --file-path readme.md \ + --repository-name MyDemoRepo + +Output:: + + { + "conflictMetadata": { + "filePath": "readme.md", + "fileSizes": { + "source": 139, + "destination": 230, + "base": 85 + }, + "fileModes": { + "source": "NORMAL", + "destination": "NORMAL", + "base": "NORMAL" + }, + "objectTypes": { + "source": "FILE", + "destination": "FILE", + "base": "FILE" + }, + "numberOfConflicts": 1, + "isBinaryFile": { + "source": false, + "destination": false, + "base": false + }, + "contentConflict": true, + "fileModeConflict": false, + "objectTypeConflict": false, + "mergeOperations": { + "source": "M", + "destination": "M" + } + }, + "mergeHunks": [ + { + "isConflict": true, + "source": { + "startLine": 0, + "endLine": 3, + "hunkContent": "VGhpcyBpEXAMPLE=" + }, + "destination": { + "startLine": 0, + "endLine": 1, + "hunkContent": "VXNlIHRoEXAMPLE=" + } + } + ], + "destinationCommitId": "86958e0aEXAMPLE", + "sourceCommitId": "6ccd57fdEXAMPLE", + "baseCommitId": "767b69580EXAMPLE" + } + +For more information, see `Resolve Conflicts in a Pull Request `__ in the *AWS CodeCommit User Guide*. diff -Nru awscli-1.11.13/awscli/examples/codecommit/describe-pull-request-events.rst awscli-1.18.69/awscli/examples/codecommit/describe-pull-request-events.rst --- awscli-1.11.13/awscli/examples/codecommit/describe-pull-request-events.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/describe-pull-request-events.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,27 @@ +**To view events in a pull request** + +The following ``describe-pull-request-events`` example retrieves the events for a pull request with the ID of '8'. :: + + aws codecommit describe-pull-request-events --pull-request-id 8 + +Output:: + + { + "pullRequestEvents": [ + { + "pullRequestId": "8", + "pullRequestEventType": "PULL_REQUEST_CREATED", + "eventDate": 1510341779.53, + "actor": "arn:aws:iam::111111111111:user/Zhang_Wei" + }, + { + "pullRequestStatusChangedEventMetadata": { + "pullRequestStatus": "CLOSED" + }, + "pullRequestId": "8", + "pullRequestEventType": "PULL_REQUEST_STATUS_CHANGED", + "eventDate": 1510341930.72, + "actor": "arn:aws:iam::111111111111:user/Jane_Doe" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/codecommit/disassociate-approval-rule-template-from-repository.rst awscli-1.18.69/awscli/examples/codecommit/disassociate-approval-rule-template-from-repository.rst --- awscli-1.11.13/awscli/examples/codecommit/disassociate-approval-rule-template-from-repository.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/disassociate-approval-rule-template-from-repository.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/codecommit/evaluate-pull-request-approval-rules.rst awscli-1.18.69/awscli/examples/codecommit/evaluate-pull-request-approval-rules.rst --- awscli-1.11.13/awscli/examples/codecommit/evaluate-pull-request-approval-rules.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/evaluate-pull-request-approval-rules.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/codecommit/get-approval-rule-template.rst awscli-1.18.69/awscli/examples/codecommit/get-approval-rule-template.rst --- awscli-1.11.13/awscli/examples/codecommit/get-approval-rule-template.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/get-approval-rule-template.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/codecommit/get-blob.rst awscli-1.18.69/awscli/examples/codecommit/get-blob.rst --- awscli-1.11.13/awscli/examples/codecommit/get-blob.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/get-blob.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To view information about a Git blob object** + +The following ``get-blob`` example retrieves information about a Git blob with the ID of '2eb4af3bEXAMPLE' in an AWS CodeCommit repository named 'MyDemoRepo'. :: + + aws codecommit get-blob --repository-name MyDemoRepo --blob-id 2eb4af3bEXAMPLE + +Output:: + + { + "content": "QSBCaW5hcnkgTGFyToEXAMPLE=" + } diff -Nru awscli-1.11.13/awscli/examples/codecommit/get-branch.rst awscli-1.18.69/awscli/examples/codecommit/get-branch.rst --- awscli-1.11.13/awscli/examples/codecommit/get-branch.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/get-branch.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,6 +1,6 @@ **To get information about a branch** -This example gets information about a branch in an AWS CoceCommit repository. +This example gets information about a branch in an AWS CodeCommit repository. Command:: @@ -13,4 +13,4 @@ "commitID": "317f8570EXAMPLE", "branchName": "MyNewBranch" } - } \ No newline at end of file + } diff -Nru awscli-1.11.13/awscli/examples/codecommit/get-comment.rst awscli-1.18.69/awscli/examples/codecommit/get-comment.rst --- awscli-1.11.13/awscli/examples/codecommit/get-comment.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/get-comment.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,20 @@ +**To view details of a comment** + +This example demonstrates how to view details of a comment with the system-generated comment ID of 'ff30b348EXAMPLEb9aa670f':: + + aws codecommit get-comment --comment-id ff30b348EXAMPLEb9aa670f + +Output:: + + { + "comment": { + "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", + "clientRequestToken": "123Example", + "commentId": "ff30b348EXAMPLEb9aa670f", + "content": "Whoops - I meant to add this comment to the line, but I don't see how to delete it.", + "creationDate": 1508369768.142, + "deleted": false, + "commentId": "", + "lastModifiedDate": 1508369842.278 + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/codecommit/get-comments-for-compared-commit.rst awscli-1.18.69/awscli/examples/codecommit/get-comments-for-compared-commit.rst --- awscli-1.11.13/awscli/examples/codecommit/get-comments-for-compared-commit.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/get-comments-for-compared-commit.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,47 @@ +**To view comments on a commit** + +This example demonstrates how to view view comments made on the comparison between two commits in a repository named 'MyDemoRepo':: + + aws codecommit get-comments-for-compared-commit --repository-name MyDemoRepo --before-commit-ID 6e147360EXAMPLE --after-commit-id 317f8570EXAMPLE + +Output:: + + { + "commentsForComparedCommitData": [ + { + "afterBlobId": "1f330709EXAMPLE", + "afterCommitId": "317f8570EXAMPLE", + "beforeBlobId": "80906a4cEXAMPLE", + "beforeCommitId": "6e147360EXAMPLE", + "comments": [ + { + "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", + "clientRequestToken": "123Example", + "commentId": "ff30b348EXAMPLEb9aa670f", + "content": "Whoops - I meant to add this comment to the line, not the file, but I don't see how to delete it.", + "creationDate": 1508369768.142, + "deleted": false, + "CommentId": "123abc-EXAMPLE", + "lastModifiedDate": 1508369842.278 + }, + { + "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", + "clientRequestToken": "123Example", + "commentId": "553b509bEXAMPLE56198325", + "content": "Can you add a test case for this?", + "creationDate": 1508369612.240, + "deleted": false, + "commentId": "456def-EXAMPLE", + "lastModifiedDate": 1508369612.240 + } + ], + "location": { + "filePath": "cl_sample.js", + "filePosition": 1232, + "relativeFileVersion": "after" + }, + "repositoryName": "MyDemoRepo" + } + ], + "nextToken": "exampleToken" + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/codecommit/get-comments-for-pull-request.rst awscli-1.18.69/awscli/examples/codecommit/get-comments-for-pull-request.rst --- awscli-1.11.13/awscli/examples/codecommit/get-comments-for-pull-request.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/get-comments-for-pull-request.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,50 @@ +**To view comments for a pull request** + +This example demonstrates how to view comments for a pull request in a repository named 'MyDemoRepo'. :: + + aws codecommit get-comments-for-pull-request \ + --repository-name MyDemoRepo \ + --before-commit-ID 317f8570EXAMPLE \ + --after-commit-id 5d036259EXAMPLE + +Output:: + + { + "commentsForPullRequestData": [ + { + "afterBlobId": "1f330709EXAMPLE", + "afterCommitId": "5d036259EXAMPLE", + "beforeBlobId": "80906a4cEXAMPLE", + "beforeCommitId": "317f8570EXAMPLE", + "comments": [ + { + "authorArn": "arn:aws:iam::111111111111:user/Saanvi_Sarkar", + "clientRequestToken": "", + "commentId": "abcd1234EXAMPLEb5678efgh", + "content": "These don't appear to be used anywhere. Can we remove them?", + "creationDate": 1508369622.123, + "deleted": false, + "lastModifiedDate": 1508369622.123 + }, + { + "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", + "clientRequestToken": "", + "commentId": "442b498bEXAMPLE5756813", + "content": "Good catch. I'll remove them.", + "creationDate": 1508369829.104, + "deleted": false, + "commentId": "abcd1234EXAMPLEb5678efgh", + "lastModifiedDate": 150836912.273 + } + ], + "location": { + "filePath": "ahs_count.py", + "filePosition": 367, + "relativeFileVersion": "AFTER" + }, + "repositoryName": "MyDemoRepo", + "pullRequestId": "42" + } + ], + "nextToken": "exampleToken" + } diff -Nru awscli-1.11.13/awscli/examples/codecommit/get-commit.rst awscli-1.18.69/awscli/examples/codecommit/get-commit.rst --- awscli-1.11.13/awscli/examples/codecommit/get-commit.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/get-commit.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,30 @@ +**To view information about a commit in a repository** + +This example shows details about a commit with the system-generated ID of '7e9fd3091thisisanexamplethisisanexample1' in an AWS CodeCommit repository named 'MyDemoRepo'. + +Command:: + + aws codecommit get-commit --repository-name MyDemoRepo --commit-id 7e9fd3091thisisanexamplethisisanexample1 + +Output:: + + { + "commit": { + "additionalData": "", + "committer": { + "date": "1484167798 -0800", + "name": "Mary Major", + "email": "mary_major@example.com" + }, + "author": { + "date": "1484167798 -0800", + "name": "Mary Major", + "email": "mary_major@example.com" + }, + "treeId": "347a3408thisisanexampletreeidexample", + "parents": [ + "7aa87a031thisisanexamplethisisanexample1" + ], + "message": "Fix incorrect variable name" + } + } diff -Nru awscli-1.11.13/awscli/examples/codecommit/get-differences.rst awscli-1.18.69/awscli/examples/codecommit/get-differences.rst --- awscli-1.11.13/awscli/examples/codecommit/get-differences.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/get-differences.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,27 @@ +**To get information about differences for a commit specifier in a repository** + +This example shows view metadata information about changes between two commit specifiers (branch, tag, HEAD, or other fully qualified references, such as commit IDs) in a renamed folder in AWS CodeCommit repository named MyDemoRepo. The example includes several options that are not required, including --before-commit-specifier, --before-path, and --after-path, in order to more fully illustrate how you can use these options to limit the results. The response includes file mode permissions. + +Command:: + + aws codecommit get-differences --repository-name MyDemoRepo --before-commit-specifier 955bba12thisisanexamplethisisanexample --after-commit-specifier 14a95463thisisanexamplethisisanexample --before-path tmp/example-folder --after-path tmp/renamed-folder + +Output:: + + { + "differences": [ + { + "afterBlob": { + "path": "blob.txt", + "blobId": "2eb4af3b1thisisanexamplethisisanexample1", + "mode": "100644" + }, + "changeType": "M", + "beforeBlob": { + "path": "blob.txt", + "blobId": "bf7fcf281thisisanexamplethisisanexample1", + "mode": "100644" + } + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/codecommit/get-file.rst awscli-1.18.69/awscli/examples/codecommit/get-file.rst --- awscli-1.11.13/awscli/examples/codecommit/get-file.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/get-file.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,20 @@ +**To get the base-64 encoded contents of a file in an AWS CodeCommit repository** + +The following ``get-file`` example demonstrates how to get the base-64 encoded contents of a file named ``README.md`` from a branch named ``master`` in a repository named ``MyDemoRepo``. :: + + aws codecommit get-file --repository-name MyDemoRepo --commit-specifier master --file-path README.md + +Output:: + + { + "blobId":"559b44fEXAMPLE", + "commitId":"c5709475EXAMPLE", + "fileContent":"IyBQaHVzEXAMPLE", + "filePath":"README.md", + "fileMode":"NORMAL", + "fileSize":1563 + } + +For more information, see `GetFile`_ in the *AWS CodeCommit API Reference* guide. + +.. _`GetFile`: https://docs.aws.amazon.com/codecommit/latest/APIReference/API_GetFile.html diff -Nru awscli-1.11.13/awscli/examples/codecommit/get-folder.rst awscli-1.18.69/awscli/examples/codecommit/get-folder.rst --- awscli-1.11.13/awscli/examples/codecommit/get-folder.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/get-folder.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,63 @@ +**To get the contents of a folder in an AWS CodeCommit repository** + +The following ``get-folder`` example demonstrates how to get the contents of a top-level folder from a repository named ``MyDemoRepo``. :: + + aws codecommit get-folder --repository-name MyDemoRepo --folder-path "" + +Output:: + + { + "commitId":"c5709475EXAMPLE", + "files":[ + { + "absolutePath":".gitignore", + "blobId":"74094e8bEXAMPLE", + "fileMode":"NORMAL", + "relativePath":".gitignore" + }, + { + "absolutePath":"Gemfile", + "blobId":"9ceb72f6EXAMPLE", + "fileMode":"NORMAL", + "relativePath":"Gemfile" + }, + { + "absolutePath":"Gemfile.lock", + "blobId":"795c4a2aEXAMPLE", + "fileMode":"NORMAL", + "relativePath":"Gemfile.lock" + }, + { + "absolutePath":"LICENSE.txt", + "blobId":"0c7932c8EXAMPLE", + "fileMode":"NORMAL", + "relativePath":"LICENSE.txt" + }, + { + "absolutePath":"README.md", + "blobId":"559b44feEXAMPLE", + "fileMode":"NORMAL", + "relativePath":"README.md" + } + ], + "folderPath":"", + "subFolders":[ + { + "absolutePath":"public", + "relativePath":"public", + "treeId":"d5e92ae3aEXAMPLE" + }, + { + "absolutePath":"tmp", + "relativePath":"tmp", + "treeId":"d564d0bcEXAMPLE" + } + ], + "subModules":[], + "symbolicLinks":[], + "treeId":"7b3c4dadEXAMPLE" + } + +For more information, see `GetFolder`_ in the *AWS CodeCommit API Reference* guide. + +.. _`GetFolder`: https://docs.aws.amazon.com/codecommit/latest/APIReference/API_GetFolder.html diff -Nru awscli-1.11.13/awscli/examples/codecommit/get-merge-commit.rst awscli-1.18.69/awscli/examples/codecommit/get-merge-commit.rst --- awscli-1.11.13/awscli/examples/codecommit/get-merge-commit.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/get-merge-commit.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,20 @@ +**To get detailed information about a merge commit** + +The following ``get-merge-commit`` example displays details about a merge commit for the source branch named ``bugfix-bug1234`` with a destination branch named ``master`` using the THREE_WAY_MERGE strategy in a repository named ``MyDemoRepo``. :: + + aws codecommit get-merge-commit \ + --source-commit-specifier bugfix-bug1234 \ + --destination-commit-specifier master \ + --merge-option THREE_WAY_MERGE \ + --repository-name MyDemoRepo + +Output:: + + { + "sourceCommitId": "c5709475EXAMPLE", + "destinationCommitId": "317f8570EXAMPLE", + "baseCommitId": "fb12a539EXAMPLE", + "mergeCommitId": "ffc4d608eEXAMPLE" + } + +For more information, see `View Commit Details `__ in the *AWS CodeCommit User Guide*. diff -Nru awscli-1.11.13/awscli/examples/codecommit/get-merge-conflicts.rst awscli-1.18.69/awscli/examples/codecommit/get-merge-conflicts.rst --- awscli-1.11.13/awscli/examples/codecommit/get-merge-conflicts.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/get-merge-conflicts.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To view whether there are any merge conflicts for a pull request** + +The following ``get-merge-conflicts`` example displays whether there are any merge conflicts between the tip of a source branch named 'my-feature-branch' and a destination branch named 'master' in a repository named 'MyDemoRepo'. :: + + aws codecommit get-merge-conflicts \ + --repository-name MyDemoRepo \ + --source-commit-specifier my-feature-branch \ + --destination-commit-specifier master \ + --merge-option FAST_FORWARD_MERGE + +Output:: + + { + "destinationCommitId": "fac04518EXAMPLE", + "mergeable": false, + "sourceCommitId": "16d097f03EXAMPLE" + } diff -Nru awscli-1.11.13/awscli/examples/codecommit/get-merge-options.rst awscli-1.18.69/awscli/examples/codecommit/get-merge-options.rst --- awscli-1.11.13/awscli/examples/codecommit/get-merge-options.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/get-merge-options.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,24 @@ +**To get information about the merge options available for merging two specified branches** + +The following ``get-merge-options`` example determines the merge options available for merging a source branch named ``bugfix-bug1234`` with a destination branch named ``master`` in a repository named ``MyDemoRepo``. :: + + aws codecommit get-merge-options \ + --source-commit-specifier bugfix-bug1234 \ + --destination-commit-specifier master \ + --repository-name MyDemoRepo + +Output:: + + { + "mergeOptions": [ + "FAST_FORWARD_MERGE", + "SQUASH_MERGE", + "THREE_WAY_MERGE" + ], + "sourceCommitId": "18059494EXAMPLE", + "destinationCommitId": "ffd3311dEXAMPLE", + "baseCommitId": "ffd3311dEXAMPLE" + } + + +For more information, see `Resolve Conflicts in a Pull Request `__ in the *AWS CodeCommit User Guide*. diff -Nru awscli-1.11.13/awscli/examples/codecommit/get-pull-request-approval-states.rst awscli-1.18.69/awscli/examples/codecommit/get-pull-request-approval-states.rst --- awscli-1.11.13/awscli/examples/codecommit/get-pull-request-approval-states.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/get-pull-request-approval-states.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/codecommit/get-pull-request-override-state.rst awscli-1.18.69/awscli/examples/codecommit/get-pull-request-override-state.rst --- awscli-1.11.13/awscli/examples/codecommit/get-pull-request-override-state.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/get-pull-request-override-state.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/codecommit/get-pull-request.rst awscli-1.18.69/awscli/examples/codecommit/get-pull-request.rst --- awscli-1.11.13/awscli/examples/codecommit/get-pull-request.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/get-pull-request.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,32 @@ +**To view details of a pull request** + +This example demonstrates how to view information about a pull request with the ID of '42':: + + aws codecommit get-pull-request --pull-request-id 42 + +Output:: + + { + "pullRequest": { + "authorArn": "arn:aws:iam::111111111111:user/Jane_Doe", + "title": "Pronunciation difficulty analyzer" + "pullRequestTargets": [ + { + "destinationReference": "refs/heads/master", + "destinationCommit": "5d036259EXAMPLE", + "sourceReference": "refs/heads/jane-branch" + "sourceCommit": "317f8570EXAMPLE", + "repositoryName": "MyDemoRepo", + "mergeMetadata": { + "isMerged": false, + }, + } + ], + "lastActivityDate": 1508442444, + "pullRequestId": "42", + "clientRequestToken": "123Example", + "pullRequestStatus": "OPEN", + "creationDate": 1508962823, + "description": "A code review of the new feature I just added to the service.", + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/codecommit/get-repository.rst awscli-1.18.69/awscli/examples/codecommit/get-repository.rst --- awscli-1.11.13/awscli/examples/codecommit/get-repository.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/get-repository.rst 2020-05-28 19:25:48.000000000 +0000 @@ -13,7 +13,7 @@ "creationDate": 1429203623.625, "defaultBranch": "master", "repositoryName": "MyDemoRepo", - "cloneUrlSsh": "ssh://ssh://git-codecommit.us-east-1.amazonaws.com/v1/repos//v1/repos/MyDemoRepo", + "cloneUrlSsh": "ssh://git-codecommit.us-east-1.amazonaws.com/v1/repos/v1/repos/MyDemoRepo", "lastModifiedDate": 1430783812.0869999, "repositoryDescription": "My demonstration repository", "cloneUrlHttp": "https://codecommit.us-east-1.amazonaws.com/v1/repos/MyDemoRepo", @@ -21,4 +21,4 @@ "Arn": "arn:aws:codecommit:us-east-1:80398EXAMPLE:MyDemoRepo "accountId": "111111111111" } - } \ No newline at end of file + } diff -Nru awscli-1.11.13/awscli/examples/codecommit/get-repository-triggers.rst awscli-1.18.69/awscli/examples/codecommit/get-repository-triggers.rst --- awscli-1.11.13/awscli/examples/codecommit/get-repository-triggers.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/get-repository-triggers.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,36 @@ +**To get information about triggers in a repository** + +This example shows details about triggers configured for an AWS CodeCommit repository named 'MyDemoRepo'. + +Command:: + + aws codecommit get-repository-triggers --repository-name MyDemoRepo + +Output:: + + { + "configurationId": "f7579e13-b83e-4027-aaef-650c0EXAMPLE", + "triggers": [ + { + "destinationArn": "arn:aws:sns:us-east-1:111111111111:MyCodeCommitTopic", + "branches": [ + "mainline", + "preprod" + ], + "name": "MyFirstTrigger", + "customData": "", + "events": [ + "all" + ] + }, + { + "destinationArn": "arn:aws:lambda:us-east-1:111111111111:function:MyCodeCommitPythonFunction", + "branches": [], + "name": "MySecondTrigger", + "customData": "EXAMPLE", + "events": [ + "all" + ] + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/codecommit/list-approval-rule-templates.rst awscli-1.18.69/awscli/examples/codecommit/list-approval-rule-templates.rst --- awscli-1.11.13/awscli/examples/codecommit/list-approval-rule-templates.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/list-approval-rule-templates.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/codecommit/list-associated-approval-rule-templates-for-repository.rst awscli-1.18.69/awscli/examples/codecommit/list-associated-approval-rule-templates-for-repository.rst --- awscli-1.11.13/awscli/examples/codecommit/list-associated-approval-rule-templates-for-repository.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/list-associated-approval-rule-templates-for-repository.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/codecommit/list-branches.rst awscli-1.18.69/awscli/examples/codecommit/list-branches.rst --- awscli-1.11.13/awscli/examples/codecommit/list-branches.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/list-branches.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,6 +1,6 @@ **To view a list of branch names** -This example lists all branch names in an AWS CoceCommit repository. +This example lists all branch names in an AWS CodeCommit repository. Command:: @@ -13,4 +13,4 @@ "MyNewBranch", "master" ] - } \ No newline at end of file + } diff -Nru awscli-1.11.13/awscli/examples/codecommit/list-pull-requests.rst awscli-1.18.69/awscli/examples/codecommit/list-pull-requests.rst --- awscli-1.11.13/awscli/examples/codecommit/list-pull-requests.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/list-pull-requests.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,12 @@ +**To view a list of pull requests in a repository** + +This example demonstrates how to list pull requests created by an IAM user with the ARN 'arn:aws:iam::111111111111:user/Li_Juan' and the status of 'CLOSED' in an AWS CodeCommit repository named 'MyDemoRepo':: + + aws codecommit list-pull-requests --author-arn arn:aws:iam::111111111111:user/Li_Juan --pull-request-status CLOSED --repository-name MyDemoRepo + +Output:: + + { + "nextToken": "", + "pullRequestIds": ["2","12","16","22","23","35","30","39","47"] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/codecommit/list-repositories-for-approval-rule-template.rst awscli-1.18.69/awscli/examples/codecommit/list-repositories-for-approval-rule-template.rst --- awscli-1.11.13/awscli/examples/codecommit/list-repositories-for-approval-rule-template.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/list-repositories-for-approval-rule-template.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/codecommit/list-tags-for-resource.rst awscli-1.18.69/awscli/examples/codecommit/list-tags-for-resource.rst --- awscli-1.11.13/awscli/examples/codecommit/list-tags-for-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/list-tags-for-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To view the AWS tags for a repository** + +The following ``list-tags-for-resource`` example lists tag keys and tag values for the specified repository. :: + + aws codecommit list-tags-for-resource \ + --resource-arn arn:aws:codecommit:us-west-2:111111111111:MyDemoRepo + +Output:: + + { + "tags": { + "Status": "Secret", + "Team": "Saanvi" + } + } + + +For more information, see `View Tags for a Repository `__ in the *AWS CodeCommit User Guide*. diff -Nru awscli-1.11.13/awscli/examples/codecommit/merge-branches-by-fast-forward.rst awscli-1.18.69/awscli/examples/codecommit/merge-branches-by-fast-forward.rst --- awscli-1.11.13/awscli/examples/codecommit/merge-branches-by-fast-forward.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/merge-branches-by-fast-forward.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To merge two branches using the fast-forward merge strategy** + +The following ``merge-branches-by-fast-forward`` example merges the specified source branch with the specified destination branch in a repository named ``MyDemoRepo``. :: + + aws codecommit merge-branches-by-fast-forward \ + --source-commit-specifier bugfix-bug1234 \ + --destination-commit-specifier bugfix-bug1233 \ + --repository-name MyDemoRepo + +Output:: + + { + "commitId": "4f178133EXAMPLE", + "treeId": "389765daEXAMPLE" + } + +For more information, see `Compare and Merge Branches `__ in the *AWS CodeCommit User Guide*. diff -Nru awscli-1.11.13/awscli/examples/codecommit/merge-branches-by-squash.rst awscli-1.18.69/awscli/examples/codecommit/merge-branches-by-squash.rst --- awscli-1.11.13/awscli/examples/codecommit/merge-branches-by-squash.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/merge-branches-by-squash.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To merge two branches using the squash merge strategy** + +The following ``merge-branches-by-squash`` example merges the specified source branch with the specified destination branch in a repository named ``MyDemoRepo``. :: + + aws codecommit merge-branches-by-squash \ + --source-commit-specifier bugfix-bug1234 \ + --destination-commit-specifier bugfix-bug1233 \ + --author-name "Maria Garcia" \ + --email "maria_garcia@example.com" \ + --commit-message "Merging two fix branches to prepare for a general patch." \ + --repository-name MyDemoRepo + +Output:: + + { + "commitId": "4f178133EXAMPLE", + "treeId": "389765daEXAMPLE" + } + + +For more information, see `Compare and Merge Branches `__ in the *AWS CodeCommit User Guide*. diff -Nru awscli-1.11.13/awscli/examples/codecommit/merge-branches-by-three-way.rst awscli-1.18.69/awscli/examples/codecommit/merge-branches-by-three-way.rst --- awscli-1.11.13/awscli/examples/codecommit/merge-branches-by-three-way.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/merge-branches-by-three-way.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To merge two branches using the three-way merge strategy** + +The following ``merge-branches-by-three-way`` example merges the specified source branch with the specified destination branch in a repository named ``MyDemoRepo``. :: + + aws codecommit merge-branches-by-three-way \ + --source-commit-specifier master \ + --destination-commit-specifier bugfix-bug1234 \ + --author-name "Jorge Souza" --email "jorge_souza@example.com" \ + --commit-message "Merging changes from master to bugfix branch before additional testing." \ + --repository-name MyDemoRepo + +Output:: + + { + "commitId": "4f178133EXAMPLE", + "treeId": "389765daEXAMPLE" + } + +For more information, see `Compare and Merge Branches `__ in the *AWS CodeCommit User Guide*. diff -Nru awscli-1.11.13/awscli/examples/codecommit/merge-pull-request-by-fast-forward.rst awscli-1.18.69/awscli/examples/codecommit/merge-pull-request-by-fast-forward.rst --- awscli-1.11.13/awscli/examples/codecommit/merge-pull-request-by-fast-forward.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/merge-pull-request-by-fast-forward.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,33 @@ +**To merge and close a pull request** + +This example demonstrates how to merge and close a pull request with the ID of '47' and a source commit ID of '99132ab0EXAMPLE' in a repository named 'MyDemoRepo':: + + aws codecommit merge-pull-request-by-fast-forward --pull-request-id 47 --source-commit-id 99132ab0EXAMPLE --repository-name MyDemoRepo + +Output:: + + { + "pullRequest": { + "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", + "clientRequestToken": "", + "creationDate": 1508530823.142, + "description": "Review the latest changes and updates to the global variables", + "lastActivityDate": 1508887223.155, + "pullRequestId": "47", + "pullRequestStatus": "CLOSED", + "pullRequestTargets": [ + { + "destinationCommit": "9f31c968EXAMPLE", + "destinationReference": "refs/heads/master", + "mergeMetadata": { + "isMerged": true, + "mergedBy": "arn:aws:iam::111111111111:user/Mary_Major" + }, + "repositoryName": "MyDemoRepo", + "sourceCommit": "99132ab0EXAMPLE", + "sourceReference": "refs/heads/variables-branch" + } + ], + "title": "Consolidation of global variables" + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/codecommit/merge-pull-request-by-squash.rst awscli-1.18.69/awscli/examples/codecommit/merge-pull-request-by-squash.rst --- awscli-1.11.13/awscli/examples/codecommit/merge-pull-request-by-squash.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/merge-pull-request-by-squash.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,42 @@ +**To merge a pull request using the squash merge strategy** + +The following ``merge-pull-request-by-squash`` example merges and closes the specified pull request using the conflict resolution strategy of ACCEPT_SOURCE in a repository named ``MyDemoRepo``. :: + + aws codecommit merge-pull-request-by-squash \ + --pull-request-id 47 \ + --source-commit-id 99132ab0EXAMPLE \ + --repository-name MyDemoRepo \ + --conflict-detail-level LINE_LEVEL \ + --conflict-resolution-strategy ACCEPT_SOURCE \ + --name "Jorge Souza" --email "jorge_souza@example.com" \ + --commit-message "Merging pull request 47 by squash and accepting source in merge conflicts" + +Output:: + + { + "pullRequest": { + "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", + "clientRequestToken": "", + "creationDate": 1508530823.142, + "description": "Review the latest changes and updates to the global variables", + "lastActivityDate": 1508887223.155, + "pullRequestId": "47", + "pullRequestStatus": "CLOSED", + "pullRequestTargets": [ + { + "destinationCommit": "9f31c968EXAMPLE", + "destinationReference": "refs/heads/master", + "mergeMetadata": { + "isMerged": true, + "mergedBy": "arn:aws:iam::111111111111:user/Jorge_Souza" + }, + "repositoryName": "MyDemoRepo", + "sourceCommit": "99132ab0EXAMPLE", + "sourceReference": "refs/heads/variables-branch" + } + ], + "title": "Consolidation of global variables" + } + } + +For more information, see `Merge a Pull Request `__ in the *AWS CodeCommit User Guide*. diff -Nru awscli-1.11.13/awscli/examples/codecommit/merge-pull-request-by-three-way.rst awscli-1.18.69/awscli/examples/codecommit/merge-pull-request-by-three-way.rst --- awscli-1.11.13/awscli/examples/codecommit/merge-pull-request-by-three-way.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/merge-pull-request-by-three-way.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,41 @@ +**To merge a pull request using the three-way merge strategy** + +The following ``merge-pull-request-by-three-way`` example merges and closes the specified pull request using the default options for conflict detail and conflict resolution strategy in a repository named ``MyDemoRepo``. :: + + aws codecommit merge-pull-request-by-three-way \ + --pull-request-id 47 \ + --source-commit-id 99132ab0EXAMPLE \ + --repository-name MyDemoRepo \ + --name "Maria Garcia" \ + --email "maria_garcia@example.com" \ + --commit-message "Merging pull request 47 by three-way with default options" + +Output:: + + { + "pullRequest": { + "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", + "clientRequestToken": "", + "creationDate": 1508530823.142, + "description": "Review the latest changes and updates to the global variables", + "lastActivityDate": 1508887223.155, + "pullRequestId": "47", + "pullRequestStatus": "CLOSED", + "pullRequestTargets": [ + { + "destinationCommit": "9f31c968EXAMPLE", + "destinationReference": "refs/heads/master", + "mergeMetadata": { + "isMerged": true, + "mergedBy": "arn:aws:iam::111111111111:user/Maria_Garcia" + }, + "repositoryName": "MyDemoRepo", + "sourceCommit": "99132ab0EXAMPLE", + "sourceReference": "refs/heads/variables-branch" + } + ], + "title": "Consolidation of global variables" + } + } + +For more information, see `Merge a Pull Request `__ in the *AWS CodeCommit User Guide*. diff -Nru awscli-1.11.13/awscli/examples/codecommit/override-pull-request-approval-rules.rst awscli-1.18.69/awscli/examples/codecommit/override-pull-request-approval-rules.rst --- awscli-1.11.13/awscli/examples/codecommit/override-pull-request-approval-rules.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/override-pull-request-approval-rules.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/codecommit/post-comment-for-compared-commit.rst awscli-1.18.69/awscli/examples/codecommit/post-comment-for-compared-commit.rst --- awscli-1.11.13/awscli/examples/codecommit/post-comment-for-compared-commit.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/post-comment-for-compared-commit.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,30 @@ +**To create a comment on a commit** + +This example demonstrates how to add the comment '"Can you add a test case for this?"' on the change to the 'cl_sample.js' file in the comparison between two commits in a repository named 'MyDemoRepo':: + + aws codecommit post-comment-for-compared-commit --repository-name MyDemoRepo --before-commit-id 317f8570EXAMPLE --after-commit-id 5d036259EXAMPLE --client-request-token 123Example --content "Can you add a test case for this?" --location filePath=cl_sample.js,filePosition=1232,relativeFileVersion=AFTER + +Output:: + + { + "afterBlobId": "1f330709EXAMPLE", + "afterCommitId": "317f8570EXAMPLE", + "beforeBlobId": "80906a4cEXAMPLE", + "beforeCommitId": "6e147360EXAMPLE", + "comment": { + "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", + "clientRequestToken": "", + "commentId": "553b509bEXAMPLE56198325", + "content": "Can you add a test case for this?", + "creationDate": 1508369612.203, + "deleted": false, + "commentId": "abc123-EXAMPLE", + "lastModifiedDate": 1508369612.203 + }, + "location": { + "filePath": "cl_sample.js", + "filePosition": 1232, + "relativeFileVersion": "AFTER" + }, + "repositoryName": "MyDemoRepo" + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/codecommit/post-comment-for-pull-request.rst awscli-1.18.69/awscli/examples/codecommit/post-comment-for-pull-request.rst --- awscli-1.11.13/awscli/examples/codecommit/post-comment-for-pull-request.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/post-comment-for-pull-request.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,38 @@ +**To add a comment to a pull request** + +The following ``post-comment-for-pull-request`` example adds the comment "These don't appear to be used anywhere. Can we remove them?" on the change to the ``ahs_count.py`` file in a pull request with the ID of '47' in a repository named 'MyDemoRepo'. :: + + aws codecommit post-comment-for-pull-request \ + --pull-request-id "47" \ + --repository-name MyDemoRepo \ + --before-commit-id 317f8570EXAMPLE \ + --after-commit-id 5d036259EXAMPLE \ + --client-request-token 123Example \ + --content "These don't appear to be used anywhere. Can we remove them?" \ + --location filePath=ahs_count.py,filePosition=367,relativeFileVersion=AFTER + +Output:: + + { + "afterBlobId": "1f330709EXAMPLE", + "afterCommitId": "5d036259EXAMPLE", + "beforeBlobId": "80906a4cEXAMPLE", + "beforeCommitId": "317f8570EXAMPLE", + "comment": { + "authorArn": "arn:aws:iam::111111111111:user/Saanvi_Sarkar", + "clientRequestToken": "123Example", + "commentId": "abcd1234EXAMPLEb5678efgh", + "content": "These don't appear to be used anywhere. Can we remove them?", + "creationDate": 1508369622.123, + "deleted": false, + "CommentId": "", + "lastModifiedDate": 1508369622.123 + }, + "location": { + "filePath": "ahs_count.py", + "filePosition": 367, + "relativeFileVersion": "AFTER" + }, + "repositoryName": "MyDemoRepo", + "pullRequestId": "47" + } diff -Nru awscli-1.11.13/awscli/examples/codecommit/post-comment-reply.rst awscli-1.18.69/awscli/examples/codecommit/post-comment-reply.rst --- awscli-1.11.13/awscli/examples/codecommit/post-comment-reply.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/post-comment-reply.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,20 @@ +**To reply to a comment on a commit or in a pull request** + +This example demonstrates how to add the reply '"Good catch. I'll remove them."' to the comment with the system-generated ID of 'abcd1234EXAMPLEb5678efgh':: + + aws codecommit post-comment-reply --in-reply-to abcd1234EXAMPLEb5678efgh --content "Good catch. I'll remove them." --client-request-token 123Example + +Output:: + + { + "comment": { + "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", + "clientRequestToken": "123Example", + "commentId": "442b498bEXAMPLE5756813", + "content": "Good catch. I'll remove them.", + "creationDate": 1508369829.136, + "deleted": false, + "CommentId": "abcd1234EXAMPLEb5678efgh", + "lastModifiedDate": 150836912.221 + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/codecommit/put-file.rst awscli-1.18.69/awscli/examples/codecommit/put-file.rst --- awscli-1.11.13/awscli/examples/codecommit/put-file.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/put-file.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To add a file to a repository** + +The following ``put-file`` example adds a file named 'ExampleSolution.py' to a repository named 'MyDemoRepo' to a branch named 'feature-randomizationfeature' whose most recent commit has an ID of '4c925148EXAMPLE'. :: + + aws codecommit put-file \ + --repository-name MyDemoRepo \ + --branch-name feature-randomizationfeature \ + --file-content file://MyDirectory/ExampleSolution.py \ + --file-path /solutions/ExampleSolution.py \ + --parent-commit-id 4c925148EXAMPLE \ + --name "Maria Garcia" \ + --email "maria_garcia@example.com" \ + --commit-message "I added a third randomization routine." + +Output:: + + { + "blobId": "2eb4af3bEXAMPLE", + "commitId": "317f8570EXAMPLE", + "treeId": "347a3408EXAMPLE" + } diff -Nru awscli-1.11.13/awscli/examples/codecommit/put-repository-triggers.rst awscli-1.18.69/awscli/examples/codecommit/put-repository-triggers.rst --- awscli-1.11.13/awscli/examples/codecommit/put-repository-triggers.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/put-repository-triggers.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,42 @@ +**To add or update a trigger in a repository** + +This example demonstrates how to update triggers named 'MyFirstTrigger' and 'MySecondTrigger' using an already-created JSON file (here named MyTriggers.json) that contains the structure of all the triggers for a repository named MyDemoRepo. To learn how to get the JSON for existing triggers, see the get-repository-triggers command. + + +Command:: + + aws codecommit put-repository-triggers --repository-name MyDemoRepo file://MyTriggers.json + + JSON file sample contents: + { + "repositoryName": "MyDemoRepo", + "triggers": [ + { + "destinationArn": "arn:aws:sns:us-east-1:80398EXAMPLE:MyCodeCommitTopic", + "branches": [ + "master", + "preprod" + ], + "name": "MyFirstTrigger", + "customData": "", + "events": [ + "all" + ] + }, + { + "destinationArn": "arn:aws:lambda:us-east-1:111111111111:function:MyCodeCommitPythonFunction", + "branches": [], + "name": "MySecondTrigger", + "customData": "EXAMPLE", + "events": [ + "all" + ] + } + ] + } + +Output:: + + { + "configurationId": "6fa51cd8-35c1-EXAMPLE" + } diff -Nru awscli-1.11.13/awscli/examples/codecommit/tag-resource.rst awscli-1.18.69/awscli/examples/codecommit/tag-resource.rst --- awscli-1.11.13/awscli/examples/codecommit/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/tag-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To add AWS tags to an existing repository** + +The following ``tag-resource`` example tags the specified repository with two tags. :: + + aws codecommit tag-resource \ + --resource-arn arn:aws:codecommit:us-west-2:111111111111:MyDemoRepo \ + --tags Status=Secret,Team=Saanvi + +This command produces no output. + +For more information, see `Add a Tag to a Repository `__ in the *AWS CodeCommit User Guide*. diff -Nru awscli-1.11.13/awscli/examples/codecommit/test-repository-triggers.rst awscli-1.18.69/awscli/examples/codecommit/test-repository-triggers.rst --- awscli-1.11.13/awscli/examples/codecommit/test-repository-triggers.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/test-repository-triggers.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To test triggers in a repository** + +This example demonstrates how to test a trigger named 'MyFirstTrigger' in an AWS CodeCommit repository named MyDemoRepo. In this example, events in the repository trigger notifications +from an Amazon Simple Notification Service (Amazon SNS) topic. + + +Command:: + + aws codecommit test-repository-triggers --repository-name MyDemoRepo --triggers name=MyFirstTrigger,destinationArn=arn:aws:sns:us-east-1:111111111111:MyCodeCommitTopic,branches=mainline,preprod,events=all + +Output:: + + { + "successfulExecutions": [ + "MyFirstTrigger" + ], + "failedExecutions": [] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/codecommit/untag-resource.rst awscli-1.18.69/awscli/examples/codecommit/untag-resource.rst --- awscli-1.11.13/awscli/examples/codecommit/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/untag-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To remove AWS tags from a repository** + +The following ``untag-resource`` example removes the tag with the specified key from the repository named ``MyDemoRepo``. :: + + aws codecommit untag-resource \ + --resource-arn arn:aws:codecommit:us-west-2:111111111111:MyDemoRepo \ + --tag-keys Status + +This command produces no output. + +For more information, see `Remove a Tag from a Repository `__ in the *AWS CodeCommit User Guide*. diff -Nru awscli-1.11.13/awscli/examples/codecommit/update-approval-rule-template-content.rst awscli-1.18.69/awscli/examples/codecommit/update-approval-rule-template-content.rst --- awscli-1.11.13/awscli/examples/codecommit/update-approval-rule-template-content.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/update-approval-rule-template-content.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/codecommit/update-approval-rule-template-description.rst awscli-1.18.69/awscli/examples/codecommit/update-approval-rule-template-description.rst --- awscli-1.11.13/awscli/examples/codecommit/update-approval-rule-template-description.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/update-approval-rule-template-description.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/codecommit/update-approval-rule-template-name.rst awscli-1.18.69/awscli/examples/codecommit/update-approval-rule-template-name.rst --- awscli-1.11.13/awscli/examples/codecommit/update-approval-rule-template-name.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/update-approval-rule-template-name.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/codecommit/update-comment.rst awscli-1.18.69/awscli/examples/codecommit/update-comment.rst --- awscli-1.11.13/awscli/examples/codecommit/update-comment.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/update-comment.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To update a comment on a commit** + +This example demonstrates how to add the content '"Fixed as requested. I'll update the pull request."' to a comment with an ID of '442b498bEXAMPLE5756813':: + + aws codecommit update-comment --comment-id 442b498bEXAMPLE5756813 --content "Fixed as requested. I'll update the pull request." + +Output:: + + { + "comment": { + "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", + "clientRequestToken": "", + "commentId": "442b498bEXAMPLE5756813", + "content": "Fixed as requested. I'll update the pull request.", + "creationDate": 1508369929.783, + "deleted": false, + "lastModifiedDate": 1508369929.287 + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/codecommit/update-pull-request-approval-rule-content.rst awscli-1.18.69/awscli/examples/codecommit/update-pull-request-approval-rule-content.rst --- awscli-1.11.13/awscli/examples/codecommit/update-pull-request-approval-rule-content.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/update-pull-request-approval-rule-content.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/codecommit/update-pull-request-approval-state.rst awscli-1.18.69/awscli/examples/codecommit/update-pull-request-approval-state.rst --- awscli-1.11.13/awscli/examples/codecommit/update-pull-request-approval-state.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/update-pull-request-approval-state.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/codecommit/update-pull-request-description.rst awscli-1.18.69/awscli/examples/codecommit/update-pull-request-description.rst --- awscli-1.11.13/awscli/examples/codecommit/update-pull-request-description.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/update-pull-request-description.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,32 @@ +**To change the description of a pull request** + +This example demonstrates how to change the description of a pull request with the ID of '47':: + + aws codecommit update-pull-request-description --pull-request-id 47 --description "Updated the pull request to remove unused global variable." + +Output:: + + { + "pullRequest": { + "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", + "clientRequestToken": "", + "creationDate": 1508530823.155, + "description": "Updated the pull request to remove unused global variable.", + "lastActivityDate": 1508372423.204, + "pullRequestId": "47", + "pullRequestStatus": "OPEN", + "pullRequestTargets": [ + { + "destinationCommit": "9f31c968EXAMPLE", + "destinationReference": "refs/heads/master", + "mergeMetadata": { + "isMerged": false, + }, + "repositoryName": "MyDemoRepo", + "sourceCommit": "99132ab0EXAMPLE", + "sourceReference": "refs/heads/variables-branch" + } + ], + "title": "Consolidation of global variables" + } + } diff -Nru awscli-1.11.13/awscli/examples/codecommit/update-pull-request-status.rst awscli-1.18.69/awscli/examples/codecommit/update-pull-request-status.rst --- awscli-1.11.13/awscli/examples/codecommit/update-pull-request-status.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/update-pull-request-status.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,32 @@ +**To change the status of a pull request** + +This example demonstrates how to to change the status of a pull request with the ID of '42' to a status of 'CLOSED' in an AWS CodeCommit repository named 'MyDemoRepo':: + + aws codecommit update-pull-request-status --pull-request-id 42 --pull-request-status CLOSED + +Output:: + + { + "pullRequest": { + "authorArn": "arn:aws:iam::111111111111:user/Jane_Doe", + "clientRequestToken": "123Example", + "creationDate": 1508962823.165, + "description": "A code review of the new feature I just added to the service.", + "lastActivityDate": 1508442444.12, + "pullRequestId": "42", + "pullRequestStatus": "CLOSED", + "pullRequestTargets": [ + { + "destinationCommit": "5d036259EXAMPLE", + "destinationReference": "refs/heads/master", + "mergeMetadata": { + "isMerged": false, + }, + "repositoryName": "MyDemoRepo", + "sourceCommit": "317f8570EXAMPLE", + "sourceReference": "refs/heads/jane-branch" + } + ], + "title": "Pronunciation difficulty analyzer" + } + } diff -Nru awscli-1.11.13/awscli/examples/codecommit/update-pull-request-title.rst awscli-1.18.69/awscli/examples/codecommit/update-pull-request-title.rst --- awscli-1.11.13/awscli/examples/codecommit/update-pull-request-title.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codecommit/update-pull-request-title.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,32 @@ +**To change the title of a pull request** + +This example demonstrates how to change the title of a pull request with the ID of '47':: + + aws codecommit update-pull-request-title --pull-request-id 47 --title "Consolidation of global variables - updated review" + +Output:: + + { + "pullRequest": { + "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", + "clientRequestToken": "", + "creationDate": 1508530823.12, + "description": "Review the latest changes and updates to the global variables. I have updated this request with some changes, including removing some unused variables.", + "lastActivityDate": 1508372657.188, + "pullRequestId": "47", + "pullRequestStatus": "OPEN", + "pullRequestTargets": [ + { + "destinationCommit": "9f31c968EXAMPLE", + "destinationReference": "refs/heads/master", + "mergeMetadata": { + "isMerged": false, + }, + "repositoryName": "MyDemoRepo", + "sourceCommit": "99132ab0EXAMPLE", + "sourceReference": "refs/heads/variables-branch" + } + ], + "title": "Consolidation of global variables - updated review" + } + } diff -Nru awscli-1.11.13/awscli/examples/codepipeline/acknowledge-job.rst awscli-1.18.69/awscli/examples/codepipeline/acknowledge-job.rst --- awscli-1.11.13/awscli/examples/codepipeline/acknowledge-job.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codepipeline/acknowledge-job.rst 2020-05-28 19:25:48.000000000 +0000 @@ -4,7 +4,7 @@ Command:: - aws codecommit acknowledge-job --job-id f4f4ff82-2d11-EXAMPLE --nonce 3 + aws codepipeline acknowledge-job --job-id f4f4ff82-2d11-EXAMPLE --nonce 3 Output:: diff -Nru awscli-1.11.13/awscli/examples/codepipeline/create-custom-action-type.rst awscli-1.18.69/awscli/examples/codepipeline/create-custom-action-type.rst --- awscli-1.11.13/awscli/examples/codepipeline/create-custom-action-type.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codepipeline/create-custom-action-type.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,47 +1,38 @@ **To create a custom action** -This example creates a custom action for AWS CodePipeline using an already-created JSON file (here named MyCustomAction.json) that contains the structure of the custom action. For more information about the requirements for creating a custom action, including the structure of the file, see the AWS CodePipeline User Guide. +This example creates a custom action for AWS CodePipeline using an already-created JSON file (here named MyCustomAction.json) that contains the structure of the custom action. For more information about the requirements for creating a custom action, including the structure of the file, see the AWS CodePipeline User Guide. :: -Command:: - - aws codepipeline create-custom-action-type --cli-input-json file://MyCustomAction.json - -JSON file sample contents:: + aws codepipeline create-custom-action-type --cli-input-json file://MyCustomAction.json - { - "actionType": { - "actionConfigurationProperties": [ - { - "description": "The name of the build project must be provided when this action is added to the pipeline.", - "key": true, - "name": "MyJenkinsExampleBuildProject", - "queryable": false, - "required": true, - "secret": false - } - ], - "id": { - "__type": "ActionTypeId", - "category": "Build", - "owner": "Custom", - "provider": "MyJenkinsProviderName", - "version": "1" - }, - "inputArtifactDetails": { - "maximumCount": 1, - "minimumCount": 0 - }, - "outputArtifactDetails": { - "maximumCount": 1, - "minimumCount": 0 - }, - "settings": { - "entityUrlTemplate": "https://192.0.2.4/job/{Config:ProjectName}/", - "executionUrlTemplate": "https://192.0.2.4/job/{Config:ProjectName}/lastSuccessfulBuild/{ExternalExecutionId}/" - } - } - } +Contents of JSON file ``MyCustomAction.json``:: -Output:: + { + "category": "Build", + "provider": "MyJenkinsProviderName", + "version": "1", + "settings": { + "entityUrlTemplate": "https://192.0.2.4/job/{Config:ProjectName}/", + "executionUrlTemplate": "https://192.0.2.4/job/{Config:ProjectName}/lastSuccessfulBuild/{ExternalExecutionId}/" + }, + "configurationProperties": [ + { + "name": "MyJenkinsExampleBuildProject", + "required": true, + "key": true, + "secret": false, + "queryable": false, + "description": "The name of the build project must be provided when this action is added to the pipeline.", + "type": "String" + } + ], + "inputArtifactDetails": { + "maximumCount": 1, + "minimumCount": 0 + }, + "outputArtifactDetails": { + "maximumCount": 1, + "minimumCount": 0 + } + } - This command returns the structure of the custom action. \ No newline at end of file +This command returns the structure of the custom action. diff -Nru awscli-1.11.13/awscli/examples/codepipeline/update-pipeline.rst awscli-1.18.69/awscli/examples/codepipeline/update-pipeline.rst --- awscli-1.11.13/awscli/examples/codepipeline/update-pipeline.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codepipeline/update-pipeline.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,6 +1,11 @@ **To update the structure of a pipeline** -This example updates the structure of a pipeline by using a pre-defined JSON file (MyFirstPipeline.json) to supply the new structure. +This example uses the update-pipeline command with the --cli-input-json argument. This example uses a pre-defined JSON file (MyFirstPipeline.json) to update the structure of a pipeline. AWS CodePipeline recognizes the pipeline name contained in the JSON file, and then applies any changes from modified fields in the pipeline structure to update the pipeline. + +Use the following guidelines when creating the pre-defined JSON file: + +- If you are working with a pipeline structure retrieved using the get-pipeline command, you must remove the metadata section from the pipeline structure in the JSON file (the "metadata": { } lines and the "created," "pipelineARN," and "updated" fields within). +- The pipeline name cannot be changed. Command:: diff -Nru awscli-1.11.13/awscli/examples/codestar/associate-team-member.rst awscli-1.18.69/awscli/examples/codestar/associate-team-member.rst --- awscli-1.11.13/awscli/examples/codestar/associate-team-member.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codestar/associate-team-member.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,10 @@ +**To add a team member to a project** + +The following ``associate-team-member`` example makes the ``intern`` user a viewer on the project with the specified ID. :: + + aws codestar associate-team-member \ + --project-id my-project \ + --user-arn arn:aws:iam::123456789012:user/intern \ + --project-role Viewer + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/codestar/create-project.rst awscli-1.18.69/awscli/examples/codestar/create-project.rst --- awscli-1.11.13/awscli/examples/codestar/create-project.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codestar/create-project.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,49 @@ +**To create a project** + +The following ``create-project`` example uses a JSON input file to create a CodeStar project. :: + + aws codestar create-project \ + --cli-input-json file://create-project.json + +Contents of ``create-project.json``:: + + { + "name": "Custom Project", + "id": "custom-project", + "sourceCode": [ + { + "source": { + "s3": { + "bucketName": "codestar-artifacts", + "bucketKey": "nodejs-function.zip" + } + }, + "destination": { + "codeCommit": { + "name": "codestar-custom-project" + } + } + } + ], + "toolchain": { + "source": { + "s3": { + "bucketName": "codestar-artifacts", + "bucketKey": "toolchain.yml" + } + }, + "roleArn": "arn:aws:iam::123456789012:role/service-role/aws-codestar-service-role", + "stackParameters": { + "ProjectId": "custom-project" + } + } + } + +Output:: + + { + "id": "my-project", + "arn": "arn:aws:codestar:us-east-2:123456789012:project/custom-project" + } + +For a tutorial that includes sample code and templates for a custom project, see `Create a Project in AWS CodeStar with the AWS CLI`__ in the *AWS CodeStar User Guide*. diff -Nru awscli-1.11.13/awscli/examples/codestar/create-user-profile.rst awscli-1.18.69/awscli/examples/codestar/create-user-profile.rst --- awscli-1.11.13/awscli/examples/codestar/create-user-profile.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codestar/create-user-profile.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To create a user profile** + +The following ``create-user-profile`` example creates a user profile for the IAM user with the specified ARN. :: + + aws codestar create-user-profile \ + --user-arn arn:aws:iam::123456789012:user/intern \ + --display-name Intern \ + --email-address intern@example.com + +Output:: + + { + "userArn": "arn:aws:iam::123456789012:user/intern", + "displayName": "Intern", + "emailAddress": "intern@example.com", + "sshPublicKey": "", + "createdTimestamp": 1572552308.607, + "lastModifiedTimestamp": 1572552308.607 + } diff -Nru awscli-1.11.13/awscli/examples/codestar/delete-project.rst awscli-1.18.69/awscli/examples/codestar/delete-project.rst --- awscli-1.11.13/awscli/examples/codestar/delete-project.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codestar/delete-project.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,12 @@ +**To delete a project** + +The following ``delete-project`` example deletes the specified project. :: + + aws codestar delete-project \ + --project-id my-project + +Output:: + + { + "projectArn": "arn:aws:codestar:us-east-2:123456789012:project/my-project" + } diff -Nru awscli-1.11.13/awscli/examples/codestar/delete-user-profile.rst awscli-1.18.69/awscli/examples/codestar/delete-user-profile.rst --- awscli-1.11.13/awscli/examples/codestar/delete-user-profile.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codestar/delete-user-profile.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,12 @@ +**To delete a user profile** + +The following ``delete-user-profile`` example deletes the user profile for the user with the specified ARN. :: + + aws codestar delete-user-profile \ + --user-arn arn:aws:iam::123456789012:user/intern + +Output:: + + { + "userArn": "arn:aws:iam::123456789012:user/intern" + } diff -Nru awscli-1.11.13/awscli/examples/codestar/describe-project.rst awscli-1.18.69/awscli/examples/codestar/describe-project.rst --- awscli-1.11.13/awscli/examples/codestar/describe-project.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codestar/describe-project.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To view a project** + +The following ``describe-project`` example retrieves details about the specified project. :: + + aws codestar describe-project \ + --id my-project + +Output:: + + { + "name": "my project", + "id": "my-project", + "arn": "arn:aws:codestar:us-west-2:123456789012:project/my-project", + "description": "My first CodeStar project.", + "createdTimeStamp": 1572547510.128, + "status": { + "state": "CreateComplete" + } + } diff -Nru awscli-1.11.13/awscli/examples/codestar/describe-user-profile.rst awscli-1.18.69/awscli/examples/codestar/describe-user-profile.rst --- awscli-1.11.13/awscli/examples/codestar/describe-user-profile.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codestar/describe-user-profile.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To view a user profile** + +The following ``describe-user-profile`` example retrieves details about the user profile for the user with the specified ARN. :: + + aws codestar describe-user-profile \ + --user-arn arn:aws:iam::123456789012:user/intern + +Output:: + + { + "userArn": "arn:aws:iam::123456789012:user/intern", + "displayName": "Intern", + "emailAddress": "intern@example.com", + "sshPublicKey": "intern", + "createdTimestamp": 1572552308.607, + "lastModifiedTimestamp": 1572553495.47 + } diff -Nru awscli-1.11.13/awscli/examples/codestar/disassociate-team-member.rst awscli-1.18.69/awscli/examples/codestar/disassociate-team-member.rst --- awscli-1.11.13/awscli/examples/codestar/disassociate-team-member.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codestar/disassociate-team-member.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To remove a team member** + +The following ``disassociate-team-member`` example removes the user with the specified ARN from the project ``my-project``. :: + + aws codestar disassociate-team-member \ + --project-id my-project \ + --user-arn arn:aws:iam::123456789012:user/intern + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/codestar/list-projects.rst awscli-1.18.69/awscli/examples/codestar/list-projects.rst --- awscli-1.11.13/awscli/examples/codestar/list-projects.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codestar/list-projects.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,20 @@ +**To view projects** + +The following ``list-projects`` example retrieves a list of projects in the current Region. :: + + aws codestar list-projects + +Output:: + + { + "projects": [ + { + "projectId": "intern-projects", + "projectArn": "arn:aws:codestar:us-west-2:123456789012:project/intern-projects" + }, + { + "projectId": "my-project", + "projectArn": "arn:aws:codestar:us-west-2:123456789012:project/my-project" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/codestar/list-resources.rst awscli-1.18.69/awscli/examples/codestar/list-resources.rst --- awscli-1.11.13/awscli/examples/codestar/list-resources.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codestar/list-resources.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,61 @@ +**To view resources** + +The following ``list-resources`` example retrieves a list of resources for the specified project. :: + + aws codestar list-resources \ + --id my-project + +Output:: + + { + "resources": [ + { + "id": "arn:aws:execute-api:us-east-2:123456789012:r3wxmplbv8" + }, + { + "id": "arn:aws:codedeploy:us-east-2:123456789012:application:awscodestar-my-project-lambda-ServerlessDeploymentApplication-PF0LXMPL1KA0" + }, + { + "id": "arn:aws:s3:::aws-codestar-us-east-2-123456789012-my-project-pipe" + }, + { + "id": "arn:aws:lambda:us-east-2:123456789012:function:awscodestar-my-project-lambda-GetHelloWorld-16W3LVXMPLNNS" + }, + { + "id": "arn:aws:cloudformation:us-east-2:123456789012:stack/awscodestar-my-project-lambda/b4904ea0-fc20-xmpl-bec6-029123b1cc42" + }, + { + "id": "arn:aws:cloudformation:us-east-2:123456789012:stack/awscodestar-my-project/1b133f30-fc20-xmpl-a93a-0688c4290cb8" + }, + { + "id": "arn:aws:iam::123456789012:role/CodeStarWorker-my-project-ToolChain" + }, + { + "id": "arn:aws:iam::123456789012:policy/CodeStar_my-project_PermissionsBoundary" + }, + { + "id": "arn:aws:s3:::aws-codestar-us-east-2-123456789012-my-project-app" + }, + { + "id": "arn:aws:codepipeline:us-east-2:123456789012:my-project-Pipeline" + }, + { + "id": "arn:aws:codedeploy:us-east-2:123456789012:deploymentgroup:my-project/awscodestar-my-project-lambda-GetHelloWorldDeploymentGroup-P7YWXMPLT0QB" + }, + { + "id": "arn:aws:iam::123456789012:role/CodeStar-my-project-Execution" + }, + { + "id": "arn:aws:iam::123456789012:role/CodeStarWorker-my-project-CodeDeploy" + }, + { + "id": "arn:aws:codebuild:us-east-2:123456789012:project/my-project" + }, + { + "id": "arn:aws:iam::123456789012:role/CodeStarWorker-my-project-CloudFormation" + }, + { + "id": "arn:aws:codecommit:us-east-2:123456789012:Go-project" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/codestar/list-tags-for-project.rst awscli-1.18.69/awscli/examples/codestar/list-tags-for-project.rst --- awscli-1.11.13/awscli/examples/codestar/list-tags-for-project.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codestar/list-tags-for-project.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,15 @@ +**To view tags for a project** + +The following ``list-tags-for-project`` example retrieves the tags attached to the specified project. :: + + aws codestar list-tags-for-project \ + --id my-project + +Output:: + + { + "tags": { + "Department": "Marketing", + "Team": "Website" + } + } diff -Nru awscli-1.11.13/awscli/examples/codestar/list-team-members.rst awscli-1.18.69/awscli/examples/codestar/list-team-members.rst --- awscli-1.11.13/awscli/examples/codestar/list-team-members.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codestar/list-team-members.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,23 @@ +**To view a list of team members** + +The following ``list-team-members`` example retrieves a list of users associated with the specified project. :: + + aws codestar list-team-members \ + --project-id my-project + +Output:: + + { + "teamMembers": [ + { + "userArn": "arn:aws:iam::123456789012:user/admin", + "projectRole": "Owner", + "remoteAccessAllowed": false + }, + { + "userArn": "arn:aws:iam::123456789012:user/intern", + "projectRole": "Contributor", + "remoteAccessAllowed": false + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/codestar/list-user-profiles.rst awscli-1.18.69/awscli/examples/codestar/list-user-profiles.rst --- awscli-1.11.13/awscli/examples/codestar/list-user-profiles.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codestar/list-user-profiles.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,24 @@ +**To view a list of user profiles** + +The following ``list-user-profiles`` example retrieves a list of all user profiles in the current Region. :: + + aws codestar list-user-profiles + +Output:: + + { + "userProfiles": [ + { + "userArn": "arn:aws:iam::123456789012:user/admin", + "displayName": "me", + "emailAddress": "me@example.com", + "sshPublicKey": "" + }, + { + "userArn": "arn:aws:iam::123456789012:user/intern", + "displayName": "Intern", + "emailAddress": "intern@example.com", + "sshPublicKey": "intern" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/codestar/tag-project.rst awscli-1.18.69/awscli/examples/codestar/tag-project.rst --- awscli-1.11.13/awscli/examples/codestar/tag-project.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codestar/tag-project.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,15 @@ +**To attach a tag to a project** + +The following ``tag-project`` example adds a tag named ``Department`` and a value of ``Marketing`` to the specified project. :: + + aws codestar tag-project \ + --id my-project \ + --tags Department=Marketing + +Output:: + + { + "tags": { + "Department": "Marketing" + } + } diff -Nru awscli-1.11.13/awscli/examples/codestar/untag-project.rst awscli-1.18.69/awscli/examples/codestar/untag-project.rst --- awscli-1.11.13/awscli/examples/codestar/untag-project.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codestar/untag-project.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To remove a tag from a project** + +The following ``untag-project`` example removes any tag with a key name of ``Team`` from the specifiec project. :: + + aws codestar untag-project \ + --id my-project \ + --tags Team + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/codestar/update-project.rst awscli-1.18.69/awscli/examples/codestar/update-project.rst --- awscli-1.11.13/awscli/examples/codestar/update-project.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codestar/update-project.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To update a project** + +The following ``update-project`` example adds a description to the specified project. :: + + aws codestar update-project \ + --id my-project \ + --description "My first CodeStar project" + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/codestar/update-team-member.rst awscli-1.18.69/awscli/examples/codestar/update-team-member.rst --- awscli-1.11.13/awscli/examples/codestar/update-team-member.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codestar/update-team-member.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To modify a team member** + +The following ``update-team-member`` example makes the specified user a contributor on a project and grants them remote access to project resources. :: + + aws codestar update-team-member \ + --project-id my-project \ + --user-arn arn:aws:iam::123456789012:user/intern \ + --project-role Contributor -\ + --remote-access-allowed + +Output:: + + { + "userArn": "arn:aws:iam::123456789012:user/intern", + "projectRole": "Contributor", + "remoteAccessAllowed": true + } diff -Nru awscli-1.11.13/awscli/examples/codestar/update-user-profile.rst awscli-1.18.69/awscli/examples/codestar/update-user-profile.rst --- awscli-1.11.13/awscli/examples/codestar/update-user-profile.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codestar/update-user-profile.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To modify a user profile** + +The following ``update-user-profile`` example adds the specified SHH key to the specified user. :: + + aws codestar update-user-profile \ + --ssh-public-key intern \ + --user-arn arn:aws:iam::123456789012:user/intern + +Output:: + + { + "userArn": "arn:aws:iam::123456789012:user/intern", + "displayName": "Intern", + "emailAddress": "intern@example.com", + "sshPublicKey": "intern", + "createdTimestamp": 1572552308.607, + "lastModifiedTimestamp": 1572553495.47 + } diff -Nru awscli-1.11.13/awscli/examples/codestar-notifications/create-notification-rule.rst awscli-1.18.69/awscli/examples/codestar-notifications/create-notification-rule.rst --- awscli-1.11.13/awscli/examples/codestar-notifications/create-notification-rule.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codestar-notifications/create-notification-rule.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,32 @@ +**To create a notification rule** + +The following ``create-notification-rule`` example uses a JSON file named ``rule.json`` to create a notification rule named ``MyNotificationRule`` for a repository named ``MyDemoRepo`` in the specified AWS acccount. Notifications with the ``FULL`` detail type are sent to the specified target Amazon SNS topic when branches and tags are created. :: + + aws codestar-notifications create-notification-rule \ + --cli-input-json file://rule.json + +Contents of ``rule.json``:: + + { + "Name": "MyNotificationRule", + "EventTypeIds": [ + "codecommit-repository-branches-and-tags-created" + ], + "Resource": "arn:aws:codecommit:us-east-1:123456789012:MyDemoRepo", + "Targets": [ + { + "TargetType": "SNS", + "TargetAddress": "arn:aws:sns:us-east-1:123456789012:MyNotificationTopic" + } + ], + "Status": "ENABLED", + "DetailType": "FULL" + } + +Output:: + + { + "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE" + } + +For more information, see `Create a Notification rule `__ in the *AWS Developer Tools Console User Guide*. diff -Nru awscli-1.11.13/awscli/examples/codestar-notifications/delete-notification-rule.rst awscli-1.18.69/awscli/examples/codestar-notifications/delete-notification-rule.rst --- awscli-1.11.13/awscli/examples/codestar-notifications/delete-notification-rule.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codestar-notifications/delete-notification-rule.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,14 @@ +**To delete a notification rule** + +The following ``delete-notification-rule`` example deletes the specified notification rule. :: + + aws codestar-notifications delete-notification-rule \ + --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE + +Output:: + + { + "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE" + } + +For more information, see `Delete a Notification Rule `__ in the *AWS Developer Tools Console User Guide*. diff -Nru awscli-1.11.13/awscli/examples/codestar-notifications/delete-target.rst awscli-1.18.69/awscli/examples/codestar-notifications/delete-target.rst --- awscli-1.11.13/awscli/examples/codestar-notifications/delete-target.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codestar-notifications/delete-target.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To delete a notification rule target** + +The following ``delete-target`` example removes the specified target from all notification rules configured to use it as a target, and then deletes the target. :: + + aws codestar-notifications delete-target \ + --target-address arn:aws:sns:us-east-1:123456789012:MyNotificationTopic \ + --force-unsubscribe-all + +This command produces no output. + +For more information, see `Delete a Notification Rule Target `__ in the *AWS Developer Tools Console User Guide*. diff -Nru awscli-1.11.13/awscli/examples/codestar-notifications/describe-notification-rule.rst awscli-1.18.69/awscli/examples/codestar-notifications/describe-notification-rule.rst --- awscli-1.11.13/awscli/examples/codestar-notifications/describe-notification-rule.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codestar-notifications/describe-notification-rule.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,36 @@ +**To retrieve details of a notification rule** + +The following ``describe-notification-rule`` example retrieves the details of the specified notification rule. :: + + aws codestar-notifications describe-notification-rule \ + --arn arn:aws:codestar-notifications:us-west-2:123456789012:notificationrule/dc82df7a-EXAMPLE + +Output:: + + { + "LastModifiedTimestamp": 1569199844.857, + "EventTypes": [ + { + "ServiceName": "CodeCommit", + "EventTypeName": "Branches and tags: Created", + "ResourceType": "Repository", + "EventTypeId": "codecommit-repository-branches-and-tags-created" + } + ], + "Status": "ENABLED", + "DetailType": "FULL", + "Resource": "arn:aws:codecommit:us-west-2:123456789012:MyDemoRepo", + "Arn": "arn:aws:codestar-notifications:us-west-w:123456789012:notificationrule/dc82df7a-EXAMPLE", + "Targets": [ + { + "TargetStatus": "ACTIVE", + "TargetAddress": "arn:aws:sns:us-west-2:123456789012:MyNotificationTopic", + "TargetType": "SNS" + } + ], + "Name": "MyNotificationRule", + "CreatedTimestamp": 1569199844.857, + "CreatedBy": "arn:aws:iam::123456789012:user/Mary_Major" + } + +For more information, see `View Notification Rules `__ in the *AWS Developer Tools Console User Guide*. diff -Nru awscli-1.11.13/awscli/examples/codestar-notifications/list-event-types.rst awscli-1.18.69/awscli/examples/codestar-notifications/list-event-types.rst --- awscli-1.11.13/awscli/examples/codestar-notifications/list-event-types.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codestar-notifications/list-event-types.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,33 @@ +**To get a list of event types for a notification rule** + +The following ``list-event-types`` example retrieves a filtered list of all available notification event types for CodeDeploy applications. If instead you use no filter, the command returns all notification event types for all resource types. :: + + aws codestar-notifications list-event-types \ + --filters Name=SERVICE_NAME,Value=CodeDeploy + +Output:: + + { + "EventTypes": [ + { + "EventTypeId": "codedeploy-application-deployment-succeeded", + "ServiceName": "CodeDeploy", + "EventTypeName": "Deployment: Succeeded", + "ResourceType": "Application" + }, + { + "EventTypeId": "codedeploy-application-deployment-failed", + "ServiceName": "CodeDeploy", + "EventTypeName": "Deployment: Failed", + "ResourceType": "Application" + }, + { + "EventTypeId": "codedeploy-application-deployment-started", + "ServiceName": "CodeDeploy", + "EventTypeName": "Deployment: Started", + "ResourceType": "Application" + } + ] + } + +For more information, see `Create a Notification Rule `__ in the *AWS Developer Tools Console User Guide*. diff -Nru awscli-1.11.13/awscli/examples/codestar-notifications/list-notification-rules.rst awscli-1.18.69/awscli/examples/codestar-notifications/list-notification-rules.rst --- awscli-1.11.13/awscli/examples/codestar-notifications/list-notification-rules.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codestar-notifications/list-notification-rules.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,22 @@ +**To retrieve a list of notification rules** + +The following ``list-notification-rules`` example retrieves a list of all notification rules in the specified AWS Region. :: + + aws codestar-notifications list-notification-rules --region us-east-1 + +Output:: + + { + "NotificationRules": [ + { + "Id": "dc82df7a-EXAMPLE", + "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE" + }, + { + "Id": "8d1f0983-EXAMPLE", + "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/8d1f0983-EXAMPLE" + } + ] + } + +For more information, see `View Notification Rules `__ in the *AWS Developer Tools Console User Guide*. diff -Nru awscli-1.11.13/awscli/examples/codestar-notifications/list-tags-for-resource.rst awscli-1.18.69/awscli/examples/codestar-notifications/list-tags-for-resource.rst --- awscli-1.11.13/awscli/examples/codestar-notifications/list-tags-for-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codestar-notifications/list-tags-for-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,14 @@ +**To get a list of tags attached to a notification rule** + +The following ``list-tags-for-resource`` example retrieves a list of all tags attached to the specified notification rule. In this example, the notification rule currently has no tags associated with it. :: + + aws codestar-notifications list-tags-for-resource \ + --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/fe1efd35-EXAMPLE + +Output:: + + { + "Tags": {} + } + +For more information, see `Create a Notification Rule `__ in the *AWS Developer Tools Console User Guide*. diff -Nru awscli-1.11.13/awscli/examples/codestar-notifications/list-targets.rst awscli-1.18.69/awscli/examples/codestar-notifications/list-targets.rst --- awscli-1.11.13/awscli/examples/codestar-notifications/list-targets.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codestar-notifications/list-targets.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,25 @@ +**To retrieve a list of notification rule targets** + +The following ``list-targets`` example retrieves a list of all notification rule targets in the specified AWS Region. :: + + aws codestar-notifications list-targets \ + --region us-east-1 + +Output:: + + { + "Targets": [ + { + "TargetAddress": "arn:aws:sns:us-east-1:123456789012:MySNSTopicForNotificationRules", + "TargetType": "SNS", + "TargetStatus": "ACTIVE" + }, + { + "TargetAddress": "arn:aws:sns:us-east-1:123456789012:MySNSTopicForNotificationsAboutMyDemoRepo", + "TargetType": "SNS", + "TargetStatus": "ACTIVE" + } + ] + } + +For more information, see `View Notification Rule Targets `__ in the *AWS Developer Tools Console User Guide*. diff -Nru awscli-1.11.13/awscli/examples/codestar-notifications/subscribe.rst awscli-1.18.69/awscli/examples/codestar-notifications/subscribe.rst --- awscli-1.11.13/awscli/examples/codestar-notifications/subscribe.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codestar-notifications/subscribe.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,15 @@ +**To add a target to a notification rule** + +The following ``subscribe`` example adds an Amazon SNS topic as a target for the specified notification rule. :: + + aws codestar-notifications subscribe \ + --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE \ + --target TargetType=SNS,TargetAddress=arn:aws:sns:us-east-1:123456789012:MyNotificationTopic + +Output:: + + { + "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE" + } + +For more information, see `Add or Remove an Amazon SNS Topic as a Target for a Notification Rule `__ in the *AWS Developer Tools Console User Guide*. diff -Nru awscli-1.11.13/awscli/examples/codestar-notifications/tag-resource.rst awscli-1.18.69/awscli/examples/codestar-notifications/tag-resource.rst --- awscli-1.11.13/awscli/examples/codestar-notifications/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codestar-notifications/tag-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To add a tag to a notification rule** + +The following ``tag-resource`` example adds a tag with the key name of ``Team`` and the value of ``Li_Juan`` to the specified notification rule. :: + + aws codestar-notifications tag-resource \ + --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/fe1efd35-EXAMPLE \ + --tags Team=Li_Juan + +Output:: + + { + "Tags": { + "Team": "Li_Juan" + } + } + +For more information, see `Create a Notification Rule `__ in the *AWS Developer Tools Console User Guide*. diff -Nru awscli-1.11.13/awscli/examples/codestar-notifications/unsubscribe.rst awscli-1.18.69/awscli/examples/codestar-notifications/unsubscribe.rst --- awscli-1.11.13/awscli/examples/codestar-notifications/unsubscribe.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codestar-notifications/unsubscribe.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,16 @@ +**To remove a target from a notification rule** + +The following ``unsubscribe`` example removes an Amazon SNS topic as a target from the specified notification rule. :: + + aws codestar-notifications unsubscribe \ + --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE \ + --target TargetType=SNS,TargetAddress=arn:aws:sns:us-east-1:123456789012:MyNotificationTopic + +Output:: + + { + "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE" + "TargetAddress": "arn:aws:sns:us-east-1:123456789012:MyNotificationTopic" + } + +For more information, see `Add or Remove an Amazon SNS Topic as a Target for a Notification Rule `__ in the *AWS Developer Tools Console User Guide*. diff -Nru awscli-1.11.13/awscli/examples/codestar-notifications/untag-resource.rst awscli-1.18.69/awscli/examples/codestar-notifications/untag-resource.rst --- awscli-1.11.13/awscli/examples/codestar-notifications/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/codestar-notifications/untag-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To remove a tag from a notification rule** + +The following ``untag-resource`` example removes the tag with the key name ``Team`` from the specified notification rule. :: + + aws codestar-notifications untag-resource \ + --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/fe1efd35-EXAMPLE \ + --tag-keys Team + +This command produces no output. + +For more information, see `Edit a Notification Rule `__ in the *AWS Developer Tools Console User Guide*. diff -Nru awscli-1.11.13/awscli/examples/cognito-identity/create-identity-pool.rst awscli-1.18.69/awscli/examples/cognito-identity/create-identity-pool.rst --- awscli-1.11.13/awscli/examples/cognito-identity/create-identity-pool.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-identity/create-identity-pool.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,24 @@ +**To create an identity pool with Cognito identity pool provider** + +This example creates an identity pool named MyIdentityPool. It has a Cognito identity pool provider. +Unauthenticated identities are not allowed. + +Command:: + + aws cognito-identity create-identity-pool --identity-pool-name MyIdentityPool --no-allow-unauthenticated-identities --cognito-identity-providers ProviderName="cognito-idp.us-west-2.amazonaws.com/us-west-2_aaaaaaaaa",ClientId="3n4b5urk1ft4fl3mg5e62d9ado",ServerSideTokenCheck=false + +Output:: + + { + "IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111", + "IdentityPoolName": "MyIdentityPool", + "AllowUnauthenticatedIdentities": false, + "CognitoIdentityProviders": [ + { + "ProviderName": "cognito-idp.us-west-2.amazonaws.com/us-west-2_111111111", + "ClientId": "3n4b5urk1ft4fl3mg5e62d9ado", + "ServerSideTokenCheck": false + } + ] + } + diff -Nru awscli-1.11.13/awscli/examples/cognito-identity/delete-identities.rst awscli-1.18.69/awscli/examples/cognito-identity/delete-identities.rst --- awscli-1.11.13/awscli/examples/cognito-identity/delete-identities.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-identity/delete-identities.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,13 @@ +**To delete identity pool** + +This example deletes an identity ppol. + +Command:: + + aws cognito-identity delete-identity-pool --identity-ids-to-delete "us-west-2:11111111-1111-1111-1111-111111111111" + +Output:: + + { + "UnprocessedIdentityIds": [] + } diff -Nru awscli-1.11.13/awscli/examples/cognito-identity/delete-identity-pool.rst awscli-1.18.69/awscli/examples/cognito-identity/delete-identity-pool.rst --- awscli-1.11.13/awscli/examples/cognito-identity/delete-identity-pool.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-identity/delete-identity-pool.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete identity pool** + +The following ``delete-identity-pool`` example deletes the specified identity pool. + +Command:: + + aws cognito-identity delete-identity-pool \ + --identity-pool-id "us-west-2:11111111-1111-1111-1111-111111111111" + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/cognito-identity/describe-identity-pool.rst awscli-1.18.69/awscli/examples/cognito-identity/describe-identity-pool.rst --- awscli-1.11.13/awscli/examples/cognito-identity/describe-identity-pool.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-identity/describe-identity-pool.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,22 @@ +**To describe an identity pool** + +This example describes an identity pool. + +Command:: + + aws cognito-identity describe-identity-pool --identity-pool-id "us-west-2:11111111-1111-1111-1111-111111111111" + +Output:: + + { + "IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111", + "IdentityPoolName": "MyIdentityPool", + "AllowUnauthenticatedIdentities": false, + "CognitoIdentityProviders": [ + { + "ProviderName": "cognito-idp.us-west-2.amazonaws.com/us-west-2_111111111", + "ClientId": "3n4b5urk1ft4fl3mg5e62d9ado", + "ServerSideTokenCheck": false + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/cognito-identity/get-identity-pool-roles.rst awscli-1.18.69/awscli/examples/cognito-identity/get-identity-pool-roles.rst --- awscli-1.11.13/awscli/examples/cognito-identity/get-identity-pool-roles.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-identity/get-identity-pool-roles.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To get identity pool roles** + +This example gets identity pool roles. + +Command:: + + aws cognito-identity get-identity-pool-roles --identity-pool-id "us-west-2:11111111-1111-1111-1111-111111111111" + +Output:: + + { + "IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111", + "Roles": { + "authenticated": "arn:aws:iam::111111111111:role/Cognito_MyIdentityPoolAuth_Role", + "unauthenticated": "arn:aws:iam::111111111111:role/Cognito_MyIdentityPoolUnauth_Role" + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cognito-identity/list-identity-pools.rst awscli-1.18.69/awscli/examples/cognito-identity/list-identity-pools.rst --- awscli-1.11.13/awscli/examples/cognito-identity/list-identity-pools.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-identity/list-identity-pools.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,26 @@ +**To list identity pools** + +This example lists identity pools. There s a maximum of 20 identities listed. + +Command:: + + aws cognito-identity list-identity-pools --max-results 20 + +Output:: + + { + "IdentityPools": [ + { + "IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111", + "IdentityPoolName": "MyIdentityPool" + }, + { + "IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111", + "IdentityPoolName": "AnotherIdentityPool" + }, + { + "IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111", + "IdentityPoolName": "IdentityPoolRegionA" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/cognito-identity/set-identity-pool-roles.rst awscli-1.18.69/awscli/examples/cognito-identity/set-identity-pool-roles.rst --- awscli-1.11.13/awscli/examples/cognito-identity/set-identity-pool-roles.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-identity/set-identity-pool-roles.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,7 @@ +**To get identity pool roles** + +The following ``set-identity-pool-roles`` example sets an identity pool role. :: + + aws cognito-identity set-identity-pool-roles \ + --identity-pool-id "us-west-2:11111111-1111-1111-1111-111111111111" \ + --roles authenticated="arn:aws:iam::111111111111:role/Cognito_MyIdentityPoolAuth_Role" diff -Nru awscli-1.11.13/awscli/examples/cognito-identity/update-identity-pool.rst awscli-1.18.69/awscli/examples/cognito-identity/update-identity-pool.rst --- awscli-1.11.13/awscli/examples/cognito-identity/update-identity-pool.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-identity/update-identity-pool.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,23 @@ +**To update an identity pool** + +This example updates an identity pool. It sets the name to MyIdentityPool. It adds Cognito as an identity provider. +It disallows unauthenticated identities. + +Command:: + + aws cognito-identity update-identity-pool --identity-pool-id "us-west-2:11111111-1111-1111-1111-111111111111" --identity-pool-name "MyIdentityPool" --no-allow-unauthenticated-identities --cognito-identity-providers ProviderName="cognito-idp.us-west-2.amazonaws.com/us-west-2_111111111",ClientId="3n4b5urk1ft4fl3mg5e62d9ado",ServerSideTokenCheck=false + +Output:: + + { + "IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111", + "IdentityPoolName": "MyIdentityPool", + "AllowUnauthenticatedIdentities": false, + "CognitoIdentityProviders": [ + { + "ProviderName": "cognito-idp.us-west-2.amazonaws.com/us-west-2_111111111", + "ClientId": "3n4b5urk1ft4fl3mg5e62d9ado", + "ServerSideTokenCheck": false + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/add-custom-attributes.rst awscli-1.18.69/awscli/examples/cognito-idp/add-custom-attributes.rst --- awscli-1.11.13/awscli/examples/cognito-idp/add-custom-attributes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/add-custom-attributes.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To add a custom attribute** + +This example adds a custom attribute CustomAttr1 to a user pool. It is a String type, +and requires a minimum of 1 character and a maximum of 15. It is not required. + +Command:: + + aws cognito-idp add-custom-attributes --user-pool-id us-west-2_aaaaaaaaa --custom-attributes Name="CustomAttr1",AttributeDataType="String",DeveloperOnlyAttribute=false,Required=false,StringAttributeConstraints="{MinLength=1,MaxLength=15}" diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/admim-disable-user.rst awscli-1.18.69/awscli/examples/cognito-idp/admim-disable-user.rst --- awscli-1.11.13/awscli/examples/cognito-idp/admim-disable-user.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/admim-disable-user.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To disable a user** + +This example disables user jane@example.com. + +Command:: + + aws cognito-idp admin-disable-user --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com + diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/admim-enable-user.rst awscli-1.18.69/awscli/examples/cognito-idp/admim-enable-user.rst --- awscli-1.11.13/awscli/examples/cognito-idp/admim-enable-user.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/admim-enable-user.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To enable a user** + +This example enables username jane@example.com. + +Command:: + + aws cognito-idp admin-enable-user --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com + diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/admin-add-user-to-group.rst awscli-1.18.69/awscli/examples/cognito-idp/admin-add-user-to-group.rst --- awscli-1.11.13/awscli/examples/cognito-idp/admin-add-user-to-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/admin-add-user-to-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To add a user to a group** + +This example adds user Jane to group MyGroup. + +Command:: + + aws cognito-idp admin-add-user-to-group --user-pool-id us-west-2_aaaaaaaaa --username Jane --group-name MyGroup + diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/admin-confirm-sign-up.rst awscli-1.18.69/awscli/examples/cognito-idp/admin-confirm-sign-up.rst --- awscli-1.11.13/awscli/examples/cognito-idp/admin-confirm-sign-up.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/admin-confirm-sign-up.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To confirm user registration** + +This example confirms user jane@example.com. + +Command:: + + aws cognito-idp admin-confirm-sign-up --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com + diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/admin-create-user.rst awscli-1.18.69/awscli/examples/cognito-idp/admin-create-user.rst --- awscli-1.11.13/awscli/examples/cognito-idp/admin-create-user.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/admin-create-user.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,35 @@ +**To create a user** + +The following ``admin-create-user`` example creates a user with the specified settings email address and phone number. :: + + 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" + } + ] + } + } diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/admin-delete-user-attributes.rst awscli-1.18.69/awscli/examples/cognito-idp/admin-delete-user-attributes.rst --- awscli-1.11.13/awscli/examples/cognito-idp/admin-delete-user-attributes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/admin-delete-user-attributes.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To delete a user attribute** + +This example deletes a custom attribute CustomAttr1 for user diego@example.com. + +Command:: + + aws cognito-idp admin-delete-user-attributes --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --user-attribute-names "custom:CustomAttr1" + diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/admin-delete-user.rst awscli-1.18.69/awscli/examples/cognito-idp/admin-delete-user.rst --- awscli-1.11.13/awscli/examples/cognito-idp/admin-delete-user.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/admin-delete-user.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To delete a user** + +This example deletes a user. + +Command:: + + aws cognito-idp admin-delete-user --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com + diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/admin-forget-device.rst awscli-1.18.69/awscli/examples/cognito-idp/admin-forget-device.rst --- awscli-1.11.13/awscli/examples/cognito-idp/admin-forget-device.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/admin-forget-device.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To forget a device** + +This example forgets device for username jane@example.com + +Command:: + + aws cognito-idp admin-forget-device --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com --device-key us-west-2_abcd_1234-5678 + diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/admin-get-device.rst awscli-1.18.69/awscli/examples/cognito-idp/admin-get-device.rst --- awscli-1.11.13/awscli/examples/cognito-idp/admin-get-device.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/admin-get-device.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To get a device** + +This example gets a device for username jane@example.com + +Command:: + + aws cognito-idp admin-get-device --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com --device-key us-west-2_abcd_1234-5678 + diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/admin-get-user.rst awscli-1.18.69/awscli/examples/cognito-idp/admin-get-user.rst --- awscli-1.11.13/awscli/examples/cognito-idp/admin-get-user.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/admin-get-user.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,39 @@ +**To get a user** + +This example gets information about username jane@example.com. + +Command:: + + aws cognito-idp admin-get-user --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com + +Output:: + + { + "Username": "4320de44-2322-4620-999b-5e2e1c8df013", + "Enabled": true, + "UserStatus": "FORCE_CHANGE_PASSWORD", + "UserCreateDate": 1548108509.537, + "UserAttributes": [ + { + "Name": "sub", + "Value": "4320de44-2322-4620-999b-5e2e1c8df013" + }, + { + "Name": "email_verified", + "Value": "true" + }, + { + "Name": "phone_number_verified", + "Value": "true" + }, + { + "Name": "phone_number", + "Value": "+01115551212" + }, + { + "Name": "email", + "Value": "jane@example.com" + } + ], + "UserLastModifiedDate": 1548108509.537 + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/admin-initiate-auth.rst awscli-1.18.69/awscli/examples/cognito-idp/admin-initiate-auth.rst --- awscli-1.11.13/awscli/examples/cognito-idp/admin-initiate-auth.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/admin-initiate-auth.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,25 @@ +**To initiate authorization** + +This example initiates authorization using the ADMIN_NO_SRP_AUTH flow for username jane@example.com + +The client must have sign-in API for server-based authentication (ADMIN_NO_SRP_AUTH) enabled. + +Use the session information in the return value to call `admin-respond-to-auth-challenge`_. + +Command:: + + aws cognito-idp admin-initiate-auth --user-pool-id us-west-2_aaaaaaaaa --client-id 3n4b5urk1ft4fl3mg5e62d9ado --auth-flow ADMIN_NO_SRP_AUTH --auth-parameters USERNAME=jane@example.com,PASSWORD=password + +Output:: + + { + "ChallengeName": "NEW_PASSWORD_REQUIRED", + "Session": "SESSION", + "ChallengeParameters": { + "USER_ID_FOR_SRP": "84514837-dcbc-4af1-abff-f3c109334894", + "requiredAttributes": "[]", + "userAttributes": "{\"email_verified\":\"true\",\"phone_number_verified\":\"true\",\"phone_number\":\"+01xxx5550100\",\"email\":\"jane@example.com\"}" + } + } + +.. _`admin-respond-to-auth-challenge`: https://docs.aws.amazon.com/cli/latest/reference/cognito-idp/admin-respond-to-auth-challenge.html \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/admin-list-devices.rst awscli-1.18.69/awscli/examples/cognito-idp/admin-list-devices.rst --- awscli-1.11.13/awscli/examples/cognito-idp/admin-list-devices.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/admin-list-devices.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,7 @@ +**To list devices for a user** + +This example lists devices for username jane@example.com. + +Command:: + + aws cognito-idp admin-list-devices --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/admin-list-groups-for-user.rst awscli-1.18.69/awscli/examples/cognito-idp/admin-list-groups-for-user.rst --- awscli-1.11.13/awscli/examples/cognito-idp/admin-list-groups-for-user.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/admin-list-groups-for-user.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,23 @@ +**To list groups for a user** + +This example lists groups for username jane@example.com. + +Command:: + + aws cognito-idp admin-list-groups-for-user --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com + +Output:: + + { + "Groups": [ + { + "Description": "Sample group", + "Precedence": 1, + "LastModifiedDate": 1548097827.125, + "RoleArn": "arn:aws:iam::111111111111:role/SampleRole", + "GroupName": "SampleGroup", + "UserPoolId": "us-west-2_aaaaaaaaa", + "CreationDate": 1548097827.125 + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/admin-list-user-auth-events.rst awscli-1.18.69/awscli/examples/cognito-idp/admin-list-user-auth-events.rst --- awscli-1.11.13/awscli/examples/cognito-idp/admin-list-user-auth-events.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/admin-list-user-auth-events.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To list authorization events for a user** + +This example lists authorization events for username diego@example.com. + +Command:: + + aws cognito-idp admin-list-user-auth-events --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com + diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/admin-remove-user-from-group.rst awscli-1.18.69/awscli/examples/cognito-idp/admin-remove-user-from-group.rst --- awscli-1.11.13/awscli/examples/cognito-idp/admin-remove-user-from-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/admin-remove-user-from-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,7 @@ +**To remove a user from a group** + +This example removes jane@example.com from SampleGroup. + +Command:: + + aws cognito-idp admin-remove-user-from-group --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com --group-name SampleGroup diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/admin-reset-user-password.rst awscli-1.18.69/awscli/examples/cognito-idp/admin-reset-user-password.rst --- awscli-1.11.13/awscli/examples/cognito-idp/admin-reset-user-password.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/admin-reset-user-password.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,7 @@ +**To reset a user password** + +This example resets the password for diego@example.com. + +Command:: + + aws cognito-idp admin-reset-user-password --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/admin-set-user-mfa-preference.rst awscli-1.18.69/awscli/examples/cognito-idp/admin-set-user-mfa-preference.rst --- awscli-1.11.13/awscli/examples/cognito-idp/admin-set-user-mfa-preference.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/admin-set-user-mfa-preference.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To set the user MFA preference** + +This example sets the SMS MFA preference for username diego@example.com. + +Command:: + + aws cognito-idp admin-set-user-mfa-preference --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --sms-mfa-settings Enabled=false,PreferredMfa=false + diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/admin-set-user-settings.rst awscli-1.18.69/awscli/examples/cognito-idp/admin-set-user-settings.rst --- awscli-1.11.13/awscli/examples/cognito-idp/admin-set-user-settings.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/admin-set-user-settings.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To set user settings** + +This example sets the MFA delivery preference for username diego@example.com to EMAIL. + +Command:: + + aws cognito-idp admin-set-user-settings --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --mfa-options DeliveryMedium=EMAIL + diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/admin-update-auth-event-feedback.rst awscli-1.18.69/awscli/examples/cognito-idp/admin-update-auth-event-feedback.rst --- awscli-1.11.13/awscli/examples/cognito-idp/admin-update-auth-event-feedback.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/admin-update-auth-event-feedback.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To provide feedback for an authorization event** + +This example sets the feedback value for an authorization event identified by event-id to Valid. + +Command:: + + aws cognito-idp admin-update-auth-event-feedback --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --event-id c2c2cf89-c0d3-482d-aba6-99d78a5b0bfe --feedback-value Valid + diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/admin-update-device-status.rst awscli-1.18.69/awscli/examples/cognito-idp/admin-update-device-status.rst --- awscli-1.11.13/awscli/examples/cognito-idp/admin-update-device-status.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/admin-update-device-status.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To update device status** + +This example sets the device remembered status for the device identified by device-key to not_remembered. + +Command:: + + aws cognito-idp admin-update-device-status --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --device-key xxxx --device-remembered-status not_remembered + diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/admin-update-user-attributes.rst awscli-1.18.69/awscli/examples/cognito-idp/admin-update-user-attributes.rst --- awscli-1.11.13/awscli/examples/cognito-idp/admin-update-user-attributes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/admin-update-user-attributes.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To update user attributes** + +This example updates a custom user attribute CustomAttr1 for user diego@example.com. + +Command:: + + aws cognito-idp admin-update-user-attributes --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --user-attributes Name="custom:CustomAttr1",Value="Purple" + diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/change-password.rst awscli-1.18.69/awscli/examples/cognito-idp/change-password.rst --- awscli-1.11.13/awscli/examples/cognito-idp/change-password.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/change-password.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,7 @@ +**To change a password** + +This example changes a password. + +Command:: + + aws cognito-idp change-password --previous-password OldPassword --proposed-password NewPassword --access-token ACCESS_TOKEN diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/confirm-forgot-password.rst awscli-1.18.69/awscli/examples/cognito-idp/confirm-forgot-password.rst --- awscli-1.11.13/awscli/examples/cognito-idp/confirm-forgot-password.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/confirm-forgot-password.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To confirm a forgotten password** + +This example confirms a forgotten password for username diego@example.com. + +Command:: + + aws cognito-idp confirm-forgot-password --client-id 3n4b5urk1ft4fl3mg5e62d9ado --username=diego@example.com --password PASSWORD --confirmation-code CONF_CODE + diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/confirm-sign-up.rst awscli-1.18.69/awscli/examples/cognito-idp/confirm-sign-up.rst --- awscli-1.11.13/awscli/examples/cognito-idp/confirm-sign-up.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/confirm-sign-up.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To confirm sign-up** + +This example confirms sign-up for username diego@example.com. + +Command:: + + aws cognito-idp confirm-sign-up --client-id 3n4b5urk1ft4fl3mg5e62d9ado --username=diego@example.com --confirmation-code CONF_CODE + \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/create-group.rst awscli-1.18.69/awscli/examples/cognito-idp/create-group.rst --- awscli-1.11.13/awscli/examples/cognito-idp/create-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/create-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,41 @@ +**To create a group** + +This example creates a group with a description. + +Command:: + + aws cognito-idp create-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyNewGroup --description "New group." + +Output:: + + { + "Group": { + "GroupName": "MyNewGroup", + "UserPoolId": "us-west-2_aaaaaaaaa", + "Description": "New group.", + "LastModifiedDate": 1548270073.795, + "CreationDate": 1548270073.795 + } + } + +**To create a group with a role and precedence** + +This example creates a group with a description. It also includes a role and precedence. + +Command:: + + aws cognito-idp create-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyNewGroupWithRole --description "New group with a role." --role-arn arn:aws:iam::111111111111:role/MyNewGroupRole --precedence 2 + +Output:: + + { + "Group": { + "GroupName": "MyNewGroupWithRole", + "UserPoolId": "us-west-2_aaaaaaaaa", + "Description": "New group with a role.", + "RoleArn": "arn:aws:iam::111111111111:role/MyNewGroupRole", + "Precedence": 2, + "LastModifiedDate": 1548270211.761, + "CreationDate": 1548270211.761 + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/create-user-import-job.rst awscli-1.18.69/awscli/examples/cognito-idp/create-user-import-job.rst --- awscli-1.11.13/awscli/examples/cognito-idp/create-user-import-job.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/create-user-import-job.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,35 @@ +**To create a user import job** + +This example creates a user import job named MyImportJob. + +For more information about importing users, see `Importing Users into User Pools From a CSV File`_. + +Command:: + + aws cognito-idp create-user-import-job --user-pool-id us-west-2_aaaaaaaaa --job-name MyImportJob --cloud-watch-logs-role-arn arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole + +Output:: + + { + "UserImportJob": { + "JobName": "MyImportJob", + "JobId": "import-qQ0DCt2fRh", + "UserPoolId": "us-west-2_aaaaaaaaa", + "PreSignedUrl": "PRE_SIGNED_URL", + "CreationDate": 1548271795.471, + "Status": "Created", + "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole", + "ImportedUsers": 0, + "SkippedUsers": 0, + "FailedUsers": 0 + } + } + +Upload the .csv file with curl using the pre-signed URL: + +Command:: + + curl -v -T "PATH_TO_CSV_FILE" -H "x-amz-server-side-encryption:aws:kms" "PRE_SIGNED_URL" + + +.. _`Importing Users into User Pools From a CSV File`: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/create-user-pool-client.rst awscli-1.18.69/awscli/examples/cognito-idp/create-user-pool-client.rst --- awscli-1.11.13/awscli/examples/cognito-idp/create-user-pool-client.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/create-user-pool-client.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,26 @@ +**To create a user pool client** + +This example creates a new user pool client with two explicit authorization flows: USER_PASSWORD_AUTH and ADMIN_NO_SRP_AUTH. + +Command:: + + aws cognito-idp create-user-pool-client --user-pool-id us-west-2_aaaaaaaaa --client-name MyNewClient --no-generate-secret --explicit-auth-flows "USER_PASSWORD_AUTH" "ADMIN_NO_SRP_AUTH" + +Output:: + + { + "UserPoolClient": { + "UserPoolId": "us-west-2_aaaaaaaaa", + "ClientName": "MyNewClient", + "ClientId": "6p3bs000no6a4ue1idruvd05ad", + "LastModifiedDate": 1548697449.497, + "CreationDate": 1548697449.497, + "RefreshTokenValidity": 30, + "ExplicitAuthFlows": [ + "USER_PASSWORD_AUTH", + "ADMIN_NO_SRP_AUTH" + ], + "AllowedOAuthFlowsUserPoolClient": false + } + } + diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/create-user-pool-domain.rst awscli-1.18.69/awscli/examples/cognito-idp/create-user-pool-domain.rst --- awscli-1.11.13/awscli/examples/cognito-idp/create-user-pool-domain.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/create-user-pool-domain.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To create a user pool domain** + +This example creates a new user pool domain. with two explicit authorization flows: USER_PASSWORD_AUTH and ADMIN_NO_SRP_AUTH. + +Command:: + + aws cognito-idp create-user-pool-domain --user-pool-id us-west-2_aaaaaaaaa --domain my-new-domain + diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/create-user-pool.rst awscli-1.18.69/awscli/examples/cognito-idp/create-user-pool.rst --- awscli-1.11.13/awscli/examples/cognito-idp/create-user-pool.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/create-user-pool.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,506 @@ +**To create a minimally configured user pool** + +This example creates a user pool named MyUserPool using default values. There are no required attributes +and no application clients. MFA and advanced security is disabled. + +Command:: + + aws cognito-idp create-user-pool --pool-name MyUserPool + +Output:: + + { + "UserPool": { + "SchemaAttributes": [ + { + "Name": "sub", + "StringAttributeConstraints": { + "MinLength": "1", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": true, + "AttributeDataType": "String", + "Mutable": false + }, + { + "Name": "name", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "given_name", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "family_name", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "middle_name", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "nickname", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "preferred_username", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "profile", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "picture", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "website", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "email", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "AttributeDataType": "Boolean", + "DeveloperOnlyAttribute": false, + "Required": false, + "Name": "email_verified", + "Mutable": true + }, + { + "Name": "gender", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "birthdate", + "StringAttributeConstraints": { + "MinLength": "10", + "MaxLength": "10" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "zoneinfo", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "locale", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "phone_number", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "AttributeDataType": "Boolean", + "DeveloperOnlyAttribute": false, + "Required": false, + "Name": "phone_number_verified", + "Mutable": true + }, + { + "Name": "address", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "updated_at", + "NumberAttributeConstraints": { + "MinValue": "0" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "Number", + "Mutable": true + } + ], + "MfaConfiguration": "OFF", + "Name": "MyUserPool", + "LastModifiedDate": 1547833345.777, + "AdminCreateUserConfig": { + "UnusedAccountValidityDays": 7, + "AllowAdminCreateUserOnly": false + }, + "EmailConfiguration": {}, + "Policies": { + "PasswordPolicy": { + "RequireLowercase": true, + "RequireSymbols": true, + "RequireNumbers": true, + "MinimumLength": 8, + "RequireUppercase": true + } + }, + "CreationDate": 1547833345.777, + "EstimatedNumberOfUsers": 0, + "Id": "us-west-2_aaaaaaaaa", + "LambdaConfig": {} + } + } + +**To create a user pool with two required attributes** + +This example creates a user pool MyUserPool. The pool is configured to accept +email as a username attribute. It also sets the email source address to a +validated address using Amazon Simple Email Service. + +Command:: + + aws cognito-idp create-user-pool --pool-name MyUserPool --username-attributes "email" --email-configuration=SourceArn="arn:aws:ses:us-east-1:111111111111:identity/jane@example.com",ReplyToEmailAddress="jane@example.com" + +Output:: + + { + "UserPool": { + "SchemaAttributes": [ + { + "Name": "sub", + "StringAttributeConstraints": { + "MinLength": "1", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": true, + "AttributeDataType": "String", + "Mutable": false + }, + { + "Name": "name", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "given_name", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "family_name", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "middle_name", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "nickname", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "preferred_username", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "profile", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "picture", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "website", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "email", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "AttributeDataType": "Boolean", + "DeveloperOnlyAttribute": false, + "Required": false, + "Name": "email_verified", + "Mutable": true + }, + { + "Name": "gender", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "birthdate", + "StringAttributeConstraints": { + "MinLength": "10", + "MaxLength": "10" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "zoneinfo", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "locale", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "phone_number", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "AttributeDataType": "Boolean", + "DeveloperOnlyAttribute": false, + "Required": false, + "Name": "phone_number_verified", + "Mutable": true + }, + { + "Name": "address", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "updated_at", + "NumberAttributeConstraints": { + "MinValue": "0" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "Number", + "Mutable": true + } + ], + "MfaConfiguration": "OFF", + "Name": "MyUserPool", + "LastModifiedDate": 1547837788.189, + "AdminCreateUserConfig": { + "UnusedAccountValidityDays": 7, + "AllowAdminCreateUserOnly": false + }, + "EmailConfiguration": { + "ReplyToEmailAddress": "jane@example.com", + "SourceArn": "arn:aws:ses:us-east-1:111111111111:identity/jane@example.com" + }, + "Policies": { + "PasswordPolicy": { + "RequireLowercase": true, + "RequireSymbols": true, + "RequireNumbers": true, + "MinimumLength": 8, + "RequireUppercase": true + } + }, + "UsernameAttributes": [ + "email" + ], + "CreationDate": 1547837788.189, + "EstimatedNumberOfUsers": 0, + "Id": "us-west-2_aaaaaaaaa", + "LambdaConfig": {} + } + } diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/delete-group.rst awscli-1.18.69/awscli/examples/cognito-idp/delete-group.rst --- awscli-1.11.13/awscli/examples/cognito-idp/delete-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/delete-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To delete a group** + +This example deletes a group. + +Command:: + + aws cognito-idp delete-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyGroupName + diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/delete-identity-provider.rst awscli-1.18.69/awscli/examples/cognito-idp/delete-identity-provider.rst --- awscli-1.11.13/awscli/examples/cognito-idp/delete-identity-provider.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/delete-identity-provider.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To delete an identity provider** + +This example deletes an identity provider. + +Command:: + + aws cognito-idp delete-identity-provider --user-pool-id us-west-2_aaaaaaaaa --provider-name Facebook + diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/delete-resource-server.rst awscli-1.18.69/awscli/examples/cognito-idp/delete-resource-server.rst --- awscli-1.11.13/awscli/examples/cognito-idp/delete-resource-server.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/delete-resource-server.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To delete a resource server** + +This example deletes a resource server named weather.example.com. + +Command:: + + aws cognito-idp delete-resource-server --user-pool-id us-west-2_aaaaaaaaa --identifier weather.example.com + diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/delete-user-attributes.rst awscli-1.18.69/awscli/examples/cognito-idp/delete-user-attributes.rst --- awscli-1.11.13/awscli/examples/cognito-idp/delete-user-attributes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/delete-user-attributes.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To delete user attributes** + +This example deletes the user attribute "FAVORITE_ANIMAL". + +Command:: + + aws cognito-idp delete-user-attributes --access-token ACCESS_TOKEN --user-attribute-names "FAVORITE_ANIMAL" + diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/delete-user-pool-client.rst awscli-1.18.69/awscli/examples/cognito-idp/delete-user-pool-client.rst --- awscli-1.11.13/awscli/examples/cognito-idp/delete-user-pool-client.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/delete-user-pool-client.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To delete a user pool client** + +This example deletes a user pool client. + +Command:: + + aws cognito-idp delete-user-pool-client --user-pool-id us-west-2_aaaaaaaaa --client-id 38fjsnc484p94kpqsnet7mpld0 + diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/delete-user-pool-domain.rst awscli-1.18.69/awscli/examples/cognito-idp/delete-user-pool-domain.rst --- awscli-1.11.13/awscli/examples/cognito-idp/delete-user-pool-domain.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/delete-user-pool-domain.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,7 @@ +**To delete a user pool domain** + +The following ``delete-user-pool-domain`` example deletes a user pool domain named ``my-domain`` :: + + aws cognito-idp delete-user-pool-domain \ + --user-pool-id us-west-2_aaaaaaaaa \ + --domain my-domain diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/delete-user-pool.rst awscli-1.18.69/awscli/examples/cognito-idp/delete-user-pool.rst --- awscli-1.11.13/awscli/examples/cognito-idp/delete-user-pool.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/delete-user-pool.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To delete a user pool** + +This example deletes a user pool using the user pool id, us-west-2_aaaaaaaaa. + +Command:: + + aws cognito-idp delete-user-pool --user-pool-id us-west-2_aaaaaaaaa + diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/delete-user.rst awscli-1.18.69/awscli/examples/cognito-idp/delete-user.rst --- awscli-1.11.13/awscli/examples/cognito-idp/delete-user.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/delete-user.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To delete a user** + +This example deletes a user. + +Command:: + + aws cognito-idp delete-user --access-token ACCESS_TOKEN + diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/describe-identity-provider.rst awscli-1.18.69/awscli/examples/cognito-idp/describe-identity-provider.rst --- awscli-1.11.13/awscli/examples/cognito-idp/describe-identity-provider.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/describe-identity-provider.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,33 @@ +**To describe an identity provider** + +This example describes an identity provider named Facebook. + +Command:: + + aws cognito-idp describe-identity-provider --user-pool-id us-west-2_aaaaaaaaa --provider-name Facebook + +Output:: + + { + "IdentityProvider": { + "UserPoolId": "us-west-2_aaaaaaaaa", + "ProviderName": "Facebook", + "ProviderType": "Facebook", + "ProviderDetails": { + "attributes_url": "https://graph.facebook.com/me?fields=", + "attributes_url_add_attributes": "true", + "authorize_scopes": myscope", + "authorize_url": "https://www.facebook.com/v2.9/dialog/oauth", + "client_id": "11111", + "client_secret": "11111", + "token_request_method": "GET", + "token_url": "https://graph.facebook.com/v2.9/oauth/access_token" + }, + "AttributeMapping": { + "username": "id" + }, + "IdpIdentifiers": [], + "LastModifiedDate": 1548105901.736, + "CreationDate": 1548105901.736 + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/describe-resource-server.rst awscli-1.18.69/awscli/examples/cognito-idp/describe-resource-server.rst --- awscli-1.11.13/awscli/examples/cognito-idp/describe-resource-server.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/describe-resource-server.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,32 @@ +**To describe a resource server** + +This example describes the resource server weather.example.com. + +Command:: + + aws cognito-idp describe-resource-server --user-pool-id us-west-2_aaaaaaaaa --identifier weather.example.com + +Output:: + + { + "ResourceServer": { + "UserPoolId": "us-west-2_aaaaaaaaa", + "Identifier": "weather.example.com", + "Name": "Weather", + "Scopes": [ + { + "ScopeName": "weather.update", + "ScopeDescription": "Update weather forecast" + }, + { + "ScopeName": "weather.read", + "ScopeDescription": "Read weather forecasts" + }, + { + "ScopeName": "weather.delete", + "ScopeDescription": "Delete a weather forecast" + } + ] + } + } + diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/describe-risk-configuration.rst awscli-1.18.69/awscli/examples/cognito-idp/describe-risk-configuration.rst --- awscli-1.11.13/awscli/examples/cognito-idp/describe-risk-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/describe-risk-configuration.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,61 @@ +**To describe a risk configuration** + +This example describes the risk configuration associated with pool us-west-2_aaaaaaaaa. + +Command:: + + aws cognito-idp describe-risk-configuration --user-pool-id us-west-2_aaaaaaaaa + +Output:: + + { + "RiskConfiguration": { + "UserPoolId": "us-west-2_aaaaaaaaa", + "CompromisedCredentialsRiskConfiguration": { + "EventFilter": [ + "SIGN_IN", + "SIGN_UP", + "PASSWORD_CHANGE" + ], + "Actions": { + "EventAction": "BLOCK" + } + }, + "AccountTakeoverRiskConfiguration": { + "NotifyConfiguration": { + "From": "diego@example.com", + "ReplyTo": "diego@example.com", + "SourceArn": "arn:aws:ses:us-east-1:111111111111:identity/diego@example.com", + "BlockEmail": { + "Subject": "Blocked sign-in attempt", + "HtmlBody": "\n\n\n\tHTML email context\n\t\n\n\n
    We blocked an unrecognized sign-in to your account with this information:\n
      \n
    • Time: {login-time}
      • \n
    • Device: {device-name}
      • \n
    • Location: {city}, {country}
      • \n
    \nIf this sign-in was not by you, you should change your password and notify us by clicking on this link\nIf this sign-in was by you, you can follow this link to let us know
    \n\n", + "TextBody": "We blocked an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" + }, + "NoActionEmail": { + "Subject": "New sign-in attempt", + "HtmlBody": "\n\n\n\tHTML email context\n\t\n\n\n
    We observed an unrecognized sign-in to your account with this information:\n
      \n
    • Time: {login-time}
      • \n
    • Device: {device-name}
      • \n
    • Location: {city}, {country}
      • \n
    \nIf this sign-in was not by you, you should change your password and notify us by clicking on this link\nIf this sign-in was by you, you can follow this link to let us know
    \n\n", + "TextBody": "We observed an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" + }, + "MfaEmail": { + "Subject": "New sign-in attempt", + "HtmlBody": "\n\n\n\tHTML email context\n\t\n\n\n
    We required you to use multi-factor authentication for the following sign-in attempt:\n
      \n
    • Time: {login-time}
      • \n
    • Device: {device-name}
      • \n
    • Location: {city}, {country}
      • \n
    \nIf this sign-in was not by you, you should change your password and notify us by clicking on this link\nIf this sign-in was by you, you can follow this link to let us know
    \n\n", + "TextBody": "We required you to use multi-factor authentication for the following sign-in attempt:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" + } + }, + "Actions": { + "LowAction": { + "Notify": true, + "EventAction": "NO_ACTION" + }, + "MediumAction": { + "Notify": true, + "EventAction": "MFA_IF_CONFIGURED" + }, + "HighAction": { + "Notify": true, + "EventAction": "MFA_IF_CONFIGURED" + } + } + } + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/describe-user-import-job.rst awscli-1.18.69/awscli/examples/cognito-idp/describe-user-import-job.rst --- awscli-1.11.13/awscli/examples/cognito-idp/describe-user-import-job.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/describe-user-import-job.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,28 @@ +**To describe a user import job** + +This example describes a user input job. + +For more information about importing users, see `Importing Users into User Pools From a CSV File`_. + +Command:: + + aws cognito-idp describe-user-import-job --user-pool-id us-west-2_aaaaaaaaa --job-id import-TZqNQvDRnW + +Output:: + + { + "UserImportJob": { + "JobName": "import-Test1", + "JobId": "import-TZqNQvDRnW", + "UserPoolId": "us-west-2_aaaaaaaaa", + "PreSignedUrl": "PRE_SIGNED URL", + "CreationDate": 1548271708.512, + "Status": "Created", + "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole", + "ImportedUsers": 0, + "SkippedUsers": 0, + "FailedUsers": 0 + } + } + +.. _`Importing Users into User Pools From a CSV File`: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/describe-user-pool-client.rst awscli-1.18.69/awscli/examples/cognito-idp/describe-user-pool-client.rst --- awscli-1.11.13/awscli/examples/cognito-idp/describe-user-pool-client.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/describe-user-pool-client.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,70 @@ +**To describe a user pool client** + +This example describes a user pool client. + +Command:: + + aws cognito-idp describe-user-pool-client --user-pool-id us-west-2_aaaaaaaaa --client-id 38fjsnc484p94kpqsnet7mpld0 + +Output:: + + { + "UserPoolClient": { + "UserPoolId": "us-west-2_aaaaaaaaa", + "ClientName": "MyApp", + "ClientId": "38fjsnc484p94kpqsnet7mpld0", + "ClientSecret": "CLIENT_SECRET", + "LastModifiedDate": 1548108676.163, + "CreationDate": 1548108676.163, + "RefreshTokenValidity": 30, + "ReadAttributes": [ + "address", + "birthdate", + "custom:CustomAttr1", + "custom:CustomAttr2", + "email", + "email_verified", + "family_name", + "gender", + "given_name", + "locale", + "middle_name", + "name", + "nickname", + "phone_number", + "phone_number_verified", + "picture", + "preferred_username", + "profile", + "updated_at", + "website", + "zoneinfo" + ], + "WriteAttributes": [ + "address", + "birthdate", + "custom:CustomAttr1", + "custom:CustomAttr2", + "email", + "family_name", + "gender", + "given_name", + "locale", + "middle_name", + "name", + "nickname", + "phone_number", + "picture", + "preferred_username", + "profile", + "updated_at", + "website", + "zoneinfo" + ], + "ExplicitAuthFlows": [ + "ADMIN_NO_SRP_AUTH", + "USER_PASSWORD_AUTH" + ], + "AllowedOAuthFlowsUserPoolClient": false + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/describe-user-pool-domain.rst awscli-1.18.69/awscli/examples/cognito-idp/describe-user-pool-domain.rst --- awscli-1.11.13/awscli/examples/cognito-idp/describe-user-pool-domain.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/describe-user-pool-domain.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,22 @@ +**To describe a user pool client** + +This example describes a user pool domain named my-domain. + +Command:: + + aws cognito-idp describe-user-pool-domain --domain my-domain + +Output:: + + { + "DomainDescription": { + "UserPoolId": "us-west-2_aaaaaaaaa", + "AWSAccountId": "111111111111", + "Domain": "my-domain", + "S3Bucket": "aws-cognito-prod-pdx-assets", + "CloudFrontDistribution": "aaaaaaaaaaaaa.cloudfront.net", + "Version": "20190128175402", + "Status": "ACTIVE", + "CustomDomainConfig": {} + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/describe-user-pool.rst awscli-1.18.69/awscli/examples/cognito-idp/describe-user-pool.rst --- awscli-1.11.13/awscli/examples/cognito-idp/describe-user-pool.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/describe-user-pool.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,267 @@ +**To describe a user pool** + +This example describes a user pool with the user pool id us-west-2_aaaaaaaaa. + +Command:: + + aws cognito-idp describe-user-pool --user-pool-id us-west-2_aaaaaaaaa + +Output:: + + { + "UserPool": { + "SmsVerificationMessage": "Your verification code is {####}. ", + "SchemaAttributes": [ + { + "Name": "sub", + "StringAttributeConstraints": { + "MinLength": "1", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": true, + "AttributeDataType": "String", + "Mutable": false + }, + { + "Name": "name", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "given_name", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "family_name", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "middle_name", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "nickname", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "preferred_username", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "profile", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "picture", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "website", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "email", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": true, + "AttributeDataType": "String", + "Mutable": true + }, + { + "AttributeDataType": "Boolean", + "DeveloperOnlyAttribute": false, + "Required": false, + "Name": "email_verified", + "Mutable": true + }, + { + "Name": "gender", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "birthdate", + "StringAttributeConstraints": { + "MinLength": "10", + "MaxLength": "10" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "zoneinfo", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "locale", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "phone_number", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "AttributeDataType": "Boolean", + "DeveloperOnlyAttribute": false, + "Required": false, + "Name": "phone_number_verified", + "Mutable": true + }, + { + "Name": "address", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "updated_at", + "NumberAttributeConstraints": { + "MinValue": "0" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "Number", + "Mutable": true + } + ], + "EmailVerificationSubject": "Your verification code", + "MfaConfiguration": "OFF", + "Name": "MyUserPool", + "EmailVerificationMessage": "Your verification code is {####}. ", + "SmsAuthenticationMessage": "Your authentication code is {####}. ", + "LastModifiedDate": 1547763720.822, + "AdminCreateUserConfig": { + "InviteMessageTemplate": { + "EmailMessage": "Your username is {username} and temporary password is {####}. ", + "EmailSubject": "Your temporary password", + "SMSMessage": "Your username is {username} and temporary password is {####}. " + }, + "UnusedAccountValidityDays": 7, + "AllowAdminCreateUserOnly": false + }, + "EmailConfiguration": { + "ReplyToEmailAddress": "myemail@mydomain.com" + "SourceArn": "arn:aws:ses:us-east-1:000000000000:identity/myemail@mydomain.com" + }, + "AutoVerifiedAttributes": [ + "email" + ], + "Policies": { + "PasswordPolicy": { + "RequireLowercase": true, + "RequireSymbols": true, + "RequireNumbers": true, + "MinimumLength": 8, + "RequireUppercase": true + } + }, + "UserPoolTags": {}, + "UsernameAttributes": [ + "email" + ], + "CreationDate": 1547763720.822, + "EstimatedNumberOfUsers": 1, + "Id": "us-west-2_aaaaaaaaa", + "LambdaConfig": {} + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/forget-device.rst awscli-1.18.69/awscli/examples/cognito-idp/forget-device.rst --- awscli-1.11.13/awscli/examples/cognito-idp/forget-device.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/forget-device.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To forget a device** + +This example forgets device a device. + +Command:: + + aws cognito-idp forget-device --device-key us-west-2_abcd_1234-5678 + diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/forgot-password.rst awscli-1.18.69/awscli/examples/cognito-idp/forgot-password.rst --- awscli-1.11.13/awscli/examples/cognito-idp/forgot-password.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/forgot-password.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,15 @@ +**To force a password change** + +The following ``forgot-password`` example sends a message to jane@example.com to change their password. :: + + aws cognito-idp forgot-password --client-id 38fjsnc484p94kpqsnet7mpld0 --username jane@example.com + +Output:: + + { + "CodeDeliveryDetails": { + "Destination": "j***@e***.com", + "DeliveryMedium": "EMAIL", + "AttributeName": "email" + } + } diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/get-csv-header.rst awscli-1.18.69/awscli/examples/cognito-idp/get-csv-header.rst --- awscli-1.11.13/awscli/examples/cognito-idp/get-csv-header.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/get-csv-header.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,40 @@ +**To create a csv header** + +This example creates a csv header. + +For more information about importing users, see `Importing Users into User Pools From a CSV File`_. + +Command:: + + aws cognito-idp get-csv-header --user-pool-id us-west-2_aaaaaaaaa + +Output:: + + { + "UserPoolId": "us-west-2_aaaaaaaaa", + "CSVHeader": [ + "name", + "given_name", + "family_name", + "middle_name", + "nickname", + "preferred_username", + "profile", + "picture", + "website", + "email", + "email_verified", + "gender", + "birthdate", + "zoneinfo", + "locale", + "phone_number", + "phone_number_verified", + "address", + "updated_at", + "cognito:mfa_enabled", + "cognito:username" + ] + } + +... _`Importing Users into User Pools From a CSV File`: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/get-group.rst awscli-1.18.69/awscli/examples/cognito-idp/get-group.rst --- awscli-1.11.13/awscli/examples/cognito-idp/get-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/get-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To get information about a group** + +This example gets information about a group named MyGroup. + +Command:: + + aws cognito-idp get-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyGroup + +Output:: + + { + "Group": { + "GroupName": "MyGroup", + "UserPoolId": "us-west-2_aaaaaaaaa", + "Description": "A sample group.", + "LastModifiedDate": 1548270073.795, + "CreationDate": 1548270073.795 + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/get-signing-certificate.rst awscli-1.18.69/awscli/examples/cognito-idp/get-signing-certificate.rst --- awscli-1.11.13/awscli/examples/cognito-idp/get-signing-certificate.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/get-signing-certificate.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,13 @@ +**To get a signing certificate** + +This example gets a signing certificate for a user pool. + +Command:: + + aws cognito-idp get-signing-certificate --user-pool-id us-west-2_aaaaaaaaa + +Output:: + + { + "Certificate": "CERTIFICATE_DATA" + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/get-ui-customization.rst awscli-1.18.69/awscli/examples/cognito-idp/get-ui-customization.rst --- awscli-1.11.13/awscli/examples/cognito-idp/get-ui-customization.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/get-ui-customization.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To get UI customization information** + +This example gets UI customization information for a user pool. + +Command:: + + aws cognito-idp get-ui-customization --user-pool-id us-west-2_aaaaaaaaa + +Output:: + + { + "UICustomization": { + "UserPoolId": "us-west-2_aaaaaaaaa", + "ClientId": "ALL", + "ImageUrl": "https://aaaaaaaaaaaaa.cloudfront.net/us-west-2_aaaaaaaaa/ALL/20190128231240/assets/images/image.jpg", + "CSS": ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 10px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 300;\n}\n.textDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.idpDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.legalText-customizable {\n\tcolor: #747474;\n\tfont-size: 11px;\n}\n.submitButton-customizable {\n\tfont-size: 14px;\n\tfont-weight: bold;\n\tmargin: 20px 0px 10px 0px;\n\theight: 40px;\n\twidth: 100%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\n}\n.submitButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #286090;\n}\n.errorMessage-customizable {\n\tpadding: 5px;\n\tfont-size: 14px;\n\twidth: 100%;\n\tbackground: #F5F5F5;\n\tborder: 2px solid #D64958;\n\tcolor: #D64958;\n}\n.inputField-customizable {\n\twidth: 100%;\n\theight: 34px;\n\tcolor: #555;\n\tbackground-color: #fff;\n\tborder: 1px solid #ccc;\n}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\n\twidth: 100%;\n\ttext-align: center;\n\tmargin-bottom: 15px;\n\tcolor: #fff;\n\tbackground-color: #5bc0de;\n\tborder-color: #46b8da;\n}\n.idpButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #31b0d5;\n}\n.socialButton-customizable {\n\theight: 40px;\n\ttext-align: left;\n\twidth: 100%;\n\tmargin-bottom: 15px;\n}\n.redirect-customizable {\n\ttext-align: center;\n}\n.passwordCheck-notValid-customizable {\n\tcolor: #DF3312;\n}\n.passwordCheck-valid-customizable {\n\tcolor: #19BF00;\n}\n.background-customizable {\n\tbackground-color: #faf;\n}\n", + "CSSVersion": "20190128231240" + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/list-user-import-jobs.rst awscli-1.18.69/awscli/examples/cognito-idp/list-user-import-jobs.rst --- awscli-1.11.13/awscli/examples/cognito-idp/list-user-import-jobs.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/list-user-import-jobs.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,57 @@ +**To list user import jobs** + +This example lists user import jobs. + +For more information about importing users, see `Importing Users into User Pools From a CSV File`_. + +Command:: + + aws cognito-idp list-user-import-jobs --user-pool-id us-west-2_aaaaaaaaa --max-results 20 + +Output:: + + { + "UserImportJobs": [ + { + "JobName": "Test2", + "JobId": "import-d0OnwGA3mV", + "UserPoolId": "us-west-2_aaaaaaaaa", + "PreSignedUrl": "PRE_SIGNED_URL", + "CreationDate": 1548272793.069, + "Status": "Created", + "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole", + "ImportedUsers": 0, + "SkippedUsers": 0, + "FailedUsers": 0 + }, + { + "JobName": "Test1", + "JobId": "import-qQ0DCt2fRh", + "UserPoolId": "us-west-2_aaaaaaaaa", + "PreSignedUrl": "PRE_SIGNED_URL", + "CreationDate": 1548271795.471, + "Status": "Created", + "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole", + "ImportedUsers": 0, + "SkippedUsers": 0, + "FailedUsers": 0 + }, + { + "JobName": "import-Test1", + "JobId": "import-TZqNQvDRnW", + "UserPoolId": "us-west-2_aaaaaaaaa", + "PreSignedUrl": "PRE_SIGNED_URL", + "CreationDate": 1548271708.512, + "StartDate": 1548277247.962, + "CompletionDate": 1548277248.912, + "Status": "Failed", + "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole", + "ImportedUsers": 0, + "SkippedUsers": 0, + "FailedUsers": 1, + "CompletionMessage": "Too many users have failed or been skipped during the import." + } + ] + } + +.. _`Importing Users into User Pools From a CSV File`: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/list-user-pools.rst awscli-1.18.69/awscli/examples/cognito-idp/list-user-pools.rst --- awscli-1.11.13/awscli/examples/cognito-idp/list-user-pools.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/list-user-pools.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,22 @@ +**To list user pools** + +This example lists up to 20 user pools. + +Command:: + + aws cognito-idp list-user-pools --max-results 20 + +Output:: + + { + "UserPools": [ + { + "CreationDate": 1547763720.822, + "LastModifiedDate": 1547763720.822, + "LambdaConfig": {}, + "Id": "us-west-2_aaaaaaaaa", + "Name": "MyUserPool" + } + ] + } + diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/list-users-in-group.rst awscli-1.18.69/awscli/examples/cognito-idp/list-users-in-group.rst --- awscli-1.11.13/awscli/examples/cognito-idp/list-users-in-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/list-users-in-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,56 @@ +**To list users in a group** + +This example lists users in group MyGroup. + +Command:: + + aws cognito-idp list-users-in-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyGroup + +Output:: + + { + "Users": [ + { + "Username": "acf10624-80bb-401a-ac61-607bee2110ec", + "Attributes": [ + { + "Name": "sub", + "Value": "acf10624-80bb-401a-ac61-607bee2110ec" + }, + { + "Name": "custom:CustomAttr1", + "Value": "New Value!" + }, + { + "Name": "email", + "Value": "jane@example.com" + } + ], + "UserCreateDate": 1548102770.284, + "UserLastModifiedDate": 1548103204.893, + "Enabled": true, + "UserStatus": "CONFIRMED" + }, + { + "Username": "22704aa3-fc10-479a-97eb-2af5806bd327", + "Attributes": [ + { + "Name": "sub", + "Value": "22704aa3-fc10-479a-97eb-2af5806bd327" + }, + { + "Name": "email_verified", + "Value": "true" + }, + { + "Name": "email", + "Value": "diego@example.com" + } + ], + "UserCreateDate": 1548089817.683, + "UserLastModifiedDate": 1548089817.683, + "Enabled": true, + "UserStatus": "FORCE_CHANGE_PASSWORD" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/list-users.rst awscli-1.18.69/awscli/examples/cognito-idp/list-users.rst --- awscli-1.11.13/awscli/examples/cognito-idp/list-users.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/list-users.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,35 @@ +**To list users** + +This example lists up to 20 users. + +Command:: + + aws cognito-idp list-users --user-pool-id us-west-2_aaaaaaaaa --limit 20 + +Output:: + + { + "Users": [ + { + "Username": "22704aa3-fc10-479a-97eb-2af5806bd327", + "Enabled": true, + "UserStatus": "FORCE_CHANGE_PASSWORD", + "UserCreateDate": 1548089817.683, + "UserLastModifiedDate": 1548089817.683, + "Attributes": [ + { + "Name": "sub", + "Value": "22704aa3-fc10-479a-97eb-2af5806bd327" + }, + { + "Name": "email_verified", + "Value": "true" + }, + { + "Name": "email", + "Value": "mary@example.com" + } + ] + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/resend-confirmation-code.rst awscli-1.18.69/awscli/examples/cognito-idp/resend-confirmation-code.rst --- awscli-1.11.13/awscli/examples/cognito-idp/resend-confirmation-code.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/resend-confirmation-code.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To force a password change** + +This example sends a message to jane@example.com to change their password. + +Command:: + + aws cognito-idp forget-device --client-id 38fjsnc484p94kpqsnet7mpld0 --username jane@example.com + +Output:: + + { + "CodeDeliveryDetails": { + "Destination": "j***@e***.com", + "DeliveryMedium": "EMAIL", + "AttributeName": "email" + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/respond-to-auth-challenge.rst awscli-1.18.69/awscli/examples/cognito-idp/respond-to-auth-challenge.rst --- awscli-1.11.13/awscli/examples/cognito-idp/respond-to-auth-challenge.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/respond-to-auth-challenge.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,27 @@ +**To respond to an authorization challenge** + +This example responds to an authorization challenge initiated with `initiate-auth`_. It is a response to the NEW_PASSWORD_REQUIRED challenge. +It sets a password for user jane@example.com. + +Command:: + + aws cognito-idp respond-to-auth-challenge --client-id 3n4b5urk1ft4fl3mg5e62d9ado --challenge-name NEW_PASSWORD_REQUIRED --challenge-responses USERNAME=jane@example.com,NEW_PASSWORD="password" --session "SESSION_TOKEN" + +Output:: + + { + "ChallengeParameters": {}, + "AuthenticationResult": { + "AccessToken": "ACCESS_TOKEN", + "ExpiresIn": 3600, + "TokenType": "Bearer", + "RefreshToken": "REFRESH_TOKEN", + "IdToken": "ID_TOKEN", + "NewDeviceMetadata": { + "DeviceKey": "us-west-2_fec070d2-fa88-424a-8ec8-b26d7198eb23", + "DeviceGroupKey": "-wt2ha1Zd" + } + } + } + +.. _`initiate-auth`: https://docs.aws.amazon.com/cli/latest/reference/cognito-idp/initiate-auth.html \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/set-risk-configuration.rst awscli-1.18.69/awscli/examples/cognito-idp/set-risk-configuration.rst --- awscli-1.11.13/awscli/examples/cognito-idp/set-risk-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/set-risk-configuration.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,23 @@ +**To set risk configuration** + +This example sets the risk configuration for a user pool. It sets the sign-up event action to NO_ACTION. + +Command:: + + aws cognito-idp set-risk-configuration --user-pool-id us-west-2_aaaaaaaaa --compromised-credentials-risk-configuration EventFilter=SIGN_UP,Actions={EventAction=NO_ACTION} + +Output:: + + { + "RiskConfiguration": { + "UserPoolId": "us-west-2_aaaaaaaaa", + "CompromisedCredentialsRiskConfiguration": { + "EventFilter": [ + "SIGN_UP" + ], + "Actions": { + "EventAction": "NO_ACTION" + } + } + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/set-ui-customization.rst awscli-1.18.69/awscli/examples/cognito-idp/set-ui-customization.rst --- awscli-1.11.13/awscli/examples/cognito-idp/set-ui-customization.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/set-ui-customization.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To set UI customization** + +This example customizes the CSS setting for a user pool. + +Command:: + + aws cognito-idp set-ui-customization --user-pool-id us-west-2_aaaaaaaaa --css ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 10px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 300;\n}\n.textDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.idpDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.legalText-customizable {\n\tcolor: #747474;\n\tfont-size: 11px;\n}\n.submitButton-customizable {\n\tfont-size: 14px;\n\tfont-weight: bold;\n\tmargin: 20px 0px 10px 0px;\n\theight: 40px;\n\twidth: 100%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\n}\n.submitButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #286090;\n}\n.errorMessage-customizable {\n\tpadding: 5px;\n\tfont-size: 14px;\n\twidth: 100%;\n\tbackground: #F5F5F5;\n\tborder: 2px solid #D64958;\n\tcolor: #D64958;\n}\n.inputField-customizable {\n\twidth: 100%;\n\theight: 34px;\n\tcolor: #555;\n\tbackground-color: #fff;\n\tborder: 1px solid #ccc;\n}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\n\twidth: 100%;\n\ttext-align: center;\n\tmargin-bottom: 15px;\n\tcolor: #fff;\n\tbackground-color: #5bc0de;\n\tborder-color: #46b8da;\n}\n.idpButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #31b0d5;\n}\n.socialButton-customizable {\n\theight: 40px;\n\ttext-align: left;\n\twidth: 100%;\n\tmargin-bottom: 15px;\n}\n.redirect-customizable {\n\ttext-align: center;\n}\n.passwordCheck-notValid-customizable {\n\tcolor: #DF3312;\n}\n.passwordCheck-valid-customizable {\n\tcolor: #19BF00;\n}\n.background-customizable {\n\tbackground-color: #faf;\n}\n" + +Output:: + + { + "UICustomization": { + "UserPoolId": "us-west-2_aaaaaaaaa", + "ClientId": "ALL", + "CSS": ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 10px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 300;\n}\n.textDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.idpDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.legalText-customizable {\n\tcolor: #747474;\n\tfont-size: 11px;\n}\n.submitButton-customizable {\n\tfont-size: 14px;\n\tfont-weight: bold;\n\tmargin: 20px 0px 10px 0px;\n\theight: 40px;\n\twidth: 100%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\n}\n.submitButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #286090;\n}\n.errorMessage-customizable {\n\tpadding: 5px;\n\tfont-size: 14px;\n\twidth: 100%;\n\tbackground: #F5F5F5;\n\tborder: 2px solid #D64958;\n\tcolor: #D64958;\n}\n.inputField-customizable {\n\twidth: 100%;\n\theight: 34px;\n\tcolor: #555;\n\tbackground-color: #fff;\n\tborder: 1px solid #ccc;\n}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\n\twidth: 100%;\n\ttext-align: center;\n\tmargin-bottom: 15px;\n\tcolor: #fff;\n\tbackground-color: #5bc0de;\n\tborder-color: #46b8da;\n}\n.idpButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #31b0d5;\n}\n.socialButton-customizable {\n\theight: 40px;\n\ttext-align: left;\n\twidth: 100%;\n\tmargin-bottom: 15px;\n}\n.redirect-customizable {\n\ttext-align: center;\n}\n.passwordCheck-notValid-customizable {\n\tcolor: #DF3312;\n}\n.passwordCheck-valid-customizable {\n\tcolor: #19BF00;\n}\n.background-customizable {\n\tbackground-color: #faf;\n}\n", + "CSSVersion": "20190129172214" + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/set-user-mfa-preference.rst awscli-1.18.69/awscli/examples/cognito-idp/set-user-mfa-preference.rst --- awscli-1.11.13/awscli/examples/cognito-idp/set-user-mfa-preference.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/set-user-mfa-preference.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To set user MFA settings** + +This example modifies the MFA delivery options. It changes the MFA delivery medium to SMS. + +Command:: + + aws cognito-idp set-user-mfa-preference --access-token ACCESS_TOKEN --mfa-options DeliveryMedium="SMS",AttributeName="phone_number" + diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/set-user-settings.rst awscli-1.18.69/awscli/examples/cognito-idp/set-user-settings.rst --- awscli-1.11.13/awscli/examples/cognito-idp/set-user-settings.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/set-user-settings.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To set user settings** + +This example sets the MFA delivery preference to EMAIL. + +Command:: + + aws cognito-idp set-user-settings --access-token ACCESS_TOKEN --mfa-options DeliveryMedium=EMAIL + diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/sign-up.rst awscli-1.18.69/awscli/examples/cognito-idp/sign-up.rst --- awscli-1.11.13/awscli/examples/cognito-idp/sign-up.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/sign-up.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,14 @@ +**To sign up a user** + +This example signs up jane@example.com. + +Command:: + + aws cognito-idp sign-up --client-id 3n4b5urk1ft4fl3mg5e62d9ado --username jane@example.com --password PASSWORD --user-attributes Name="email",Value="jane@example.com" Name="name",Value="Jane" + +Output:: + + { + "UserConfirmed": false, + "UserSub": "e04d60a6-45dc-441c-a40b-e25a787d4862" + } diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/start-user-import-job.rst awscli-1.18.69/awscli/examples/cognito-idp/start-user-import-job.rst --- awscli-1.11.13/awscli/examples/cognito-idp/start-user-import-job.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/start-user-import-job.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,29 @@ +**To start a user import job** + +This example starts a user input job. + +For more information about importing users, see `Importing Users into User Pools From a CSV File`_. + +Command:: + + aws cognito-idp start-user-import-job --user-pool-id us-west-2_aaaaaaaaa --job-id import-TZqNQvDRnW + +Output:: + + { + "UserImportJob": { + "JobName": "import-Test10", + "JobId": "import-lmpxSOuIzH", + "UserPoolId": "us-west-2_aaaaaaaaa", + "PreSignedUrl": "PRE_SIGNED_URL", + "CreationDate": 1548278378.928, + "StartDate": 1548278397.334, + "Status": "Pending", + "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole", + "ImportedUsers": 0, + "SkippedUsers": 0, + "FailedUsers": 0 + } + } + +.. _`Importing Users into User Pools From a CSV File`: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/stop-user-import-job.rst awscli-1.18.69/awscli/examples/cognito-idp/stop-user-import-job.rst --- awscli-1.11.13/awscli/examples/cognito-idp/stop-user-import-job.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/stop-user-import-job.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,31 @@ +**To stop a user import job** + +This example stops a user input job. + +For more information about importing users, see `Importing Users into User Pools From a CSV File`_. + +Command:: + + aws cognito-idp stop-user-import-job --user-pool-id us-west-2_aaaaaaaaa --job-id import-TZqNQvDRnW + +Output:: + + { + "UserImportJob": { + "JobName": "import-Test5", + "JobId": "import-Fx0kARISFL", + "UserPoolId": "us-west-2_aaaaaaaaa", + "PreSignedUrl": "PRE_SIGNED_URL", + "CreationDate": 1548278576.259, + "StartDate": 1548278623.366, + "CompletionDate": 1548278626.741, + "Status": "Stopped", + "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole", + "ImportedUsers": 0, + "SkippedUsers": 0, + "FailedUsers": 0, + "CompletionMessage": "The Import Job was stopped by the developer." + } + } + +.. _`Importing Users into User Pools From a CSV File`: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/update-auth-event-feedback.rst awscli-1.18.69/awscli/examples/cognito-idp/update-auth-event-feedback.rst --- awscli-1.11.13/awscli/examples/cognito-idp/update-auth-event-feedback.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/update-auth-event-feedback.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,7 @@ +**To update auth event feedback** + +This example updates authorization event feedback. It marks the event "Valid". + +Command:: + + aws cognito-idp update-auth-event-feedback --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --event-id EVENT_ID --feedback-token FEEDBACK_TOKEN --feedback-value "Valid" diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/update-device-status.rst awscli-1.18.69/awscli/examples/cognito-idp/update-device-status.rst --- awscli-1.11.13/awscli/examples/cognito-idp/update-device-status.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/update-device-status.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,7 @@ +**To update device status** + +This example updates the status for a device to "not_remembered". + +Command:: + + aws cognito-idp update-device-status --access-token ACCESS_TOKEN --device-key DEVICE_KEY --device-remembered-status "not_remembered" diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/update-group.rst awscli-1.18.69/awscli/examples/cognito-idp/update-group.rst --- awscli-1.11.13/awscli/examples/cognito-idp/update-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/update-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To update a group** + +This example updates the description and precedence for MyGroup. + +Command:: + + aws cognito-idp update-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyGroup --description "New description" --precedence 2 + +Output:: + + { + "Group": { + "GroupName": "MyGroup", + "UserPoolId": "us-west-2_aaaaaaaaa", + "Description": "New description", + "RoleArn": "arn:aws:iam::111111111111:role/MyRole", + "Precedence": 2, + "LastModifiedDate": 1548800862.812, + "CreationDate": 1548097827.125 + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/update-resource-server.rst awscli-1.18.69/awscli/examples/cognito-idp/update-resource-server.rst --- awscli-1.11.13/awscli/examples/cognito-idp/update-resource-server.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/update-resource-server.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,23 @@ +**To update a resource server** + +This example updates the the resource server Weather. It adds a new scope. + +Command:: + + aws cognito-idp update-resource-server --user-pool-id us-west-2_aaaaaaaaa --identifier weather.example.com --name Weather --scopes ScopeName=NewScope,ScopeDescription="New scope description" + +Output:: + + { + "ResourceServer": { + "UserPoolId": "us-west-2_aaaaaaaaa", + "Identifier": "weather.example.com", + "Name": "Happy", + "Scopes": [ + { + "ScopeName": "NewScope", + "ScopeDescription": "New scope description" + } + ] + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/update-user-attributes.rst awscli-1.18.69/awscli/examples/cognito-idp/update-user-attributes.rst --- awscli-1.11.13/awscli/examples/cognito-idp/update-user-attributes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/update-user-attributes.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,7 @@ +**To update user attributes** + +This example updates the user attribute "nickname". + +Command:: + + aws cognito-idp update-user-attributes --access-token ACCESS_TOKEN --user-attributes Name="nickname",Value="Dan" diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/update-user-pool-client.rst awscli-1.18.69/awscli/examples/cognito-idp/update-user-pool-client.rst --- awscli-1.11.13/awscli/examples/cognito-idp/update-user-pool-client.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/update-user-pool-client.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,24 @@ +**To update a user pool client** + +This example updates the name of a user pool client. It also adds a writeable attribute "nickname". + +Command:: + + aws cognito-idp update-user-pool-client --user-pool-id us-west-2_aaaaaaaaa --client-id 3n4b5urk1ft4fl3mg5e62d9ado --client-name "NewClientName" --write-attributes "nickname" + +Output:: + + { + "UserPoolClient": { + "UserPoolId": "us-west-2_aaaaaaaaa", + "ClientName": "NewClientName", + "ClientId": "3n4b5urk1ft4fl3mg5e62d9ado", + "LastModifiedDate": 1548802761.334, + "CreationDate": 1548178931.258, + "RefreshTokenValidity": 30, + "WriteAttributes": [ + "nickname" + ], + "AllowedOAuthFlowsUserPoolClient": false + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/cognito-idp/update-user-pool.rst awscli-1.18.69/awscli/examples/cognito-idp/update-user-pool.rst --- awscli-1.11.13/awscli/examples/cognito-idp/update-user-pool.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cognito-idp/update-user-pool.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,7 @@ +**To update a user pool** + +This example adds tags to a user pool. + +Command:: + + aws cognito-idp update-user-pool --user-pool-id us-west-2_aaaaaaaaa --user-pool-tags Team=Blue,Area=West diff -Nru awscli-1.11.13/awscli/examples/comprehendmedical/describe-entities-detection-v2-job.rst awscli-1.18.69/awscli/examples/comprehendmedical/describe-entities-detection-v2-job.rst --- awscli-1.11.13/awscli/examples/comprehendmedical/describe-entities-detection-v2-job.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/comprehendmedical/describe-entities-detection-v2-job.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,31 @@ +**To describe an entities detection job** + +The following ``describe-entities-detection-v2-job`` example displays the properties associated with an asynchronous entity detection job. :: + + aws comprehendmedical describe-entities-detection-v2-job \ + --job-id "ab9887877365fe70299089371c043b96" + +Output:: + + { + "ComprehendMedicalAsyncJobProperties": { + "JobId": "ab9887877365fe70299089371c043b96", + "JobStatus": "COMPLETED", + "SubmitTime": "2020-03-18T21:20:15.614000+00:00", + "EndTime": "2020-03-18T21:27:07.350000+00:00", + "ExpirationTime": "2020-07-16T21:20:15+00:00", + "InputDataConfig": { + "S3Bucket": "comp-med-input", + "S3Key": "" + }, + "OutputDataConfig": { + "S3Bucket": "comp-med-output", + "S3Key": "867139942017-EntitiesDetection-ab9887877365fe70299089371c043b96/" + }, + "LanguageCode": "en", + "DataAccessRoleArn": "arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole", + "ModelVersion": "DetectEntitiesModelV20190930" + } + } + +For more information, see `Batch APIs `__ in the *Amazon Comprehend Medical Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/comprehendmedical/describe-phi-detection-job.rst awscli-1.18.69/awscli/examples/comprehendmedical/describe-phi-detection-job.rst --- awscli-1.11.13/awscli/examples/comprehendmedical/describe-phi-detection-job.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/comprehendmedical/describe-phi-detection-job.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,31 @@ +**To describe a PHI detection job** + +The following ``describe-phi-detection-job`` example displays the properties associated with an asynchronous protected health information (PHI) detection job. :: + + aws comprehendmedical describe-phi-detection-job \ + --job-id "4750034166536cdb52ffa3295a1b00a3" + +Output:: + + { + "ComprehendMedicalAsyncJobProperties": { + "JobId": "4750034166536cdb52ffa3295a1b00a3", + "JobStatus": "COMPLETED", + "SubmitTime": "2020-03-19T20:38:37.594000+00:00", + "EndTime": "2020-03-19T20:45:07.894000+00:00", + "ExpirationTime": "2020-07-17T20:38:37+00:00", + "InputDataConfig": { + "S3Bucket": "comp-med-input", + "S3Key": "" + }, + "OutputDataConfig": { + "S3Bucket": "comp-med-output", + "S3Key": "867139942017-PHIDetection-4750034166536cdb52ffa3295a1b00a3/" + }, + "LanguageCode": "en", + "DataAccessRoleArn": "arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole", + "ModelVersion": "PHIModelV20190903" + } + } + +For more information, see `Batch APIs `__ in the *Amazon Comprehend Medical Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/comprehendmedical/detect-entities-v2.rst awscli-1.18.69/awscli/examples/comprehendmedical/detect-entities-v2.rst --- awscli-1.11.13/awscli/examples/comprehendmedical/detect-entities-v2.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/comprehendmedical/detect-entities-v2.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,49 @@ +**Example 1: To detect entities directly from text** + +The following ``detect-entities-v2`` example shows the detected entities and labels them according to type, directly from input text. :: + + aws comprehendmedical detect-entities-v2 \ + --text "Sleeping trouble on present dosage of Clonidine. Severe rash on face and leg, slightly itchy." + +Output:: + + { + "Id": 0, + "BeginOffset": 38, + "EndOffset": 47, + "Score": 0.9942955374717712, + "Text": "Clonidine", + "Category": "MEDICATION", + "Type": "GENERIC_NAME", + "Traits": [] + }, + +For more information, see `Detect Entities Version 2 `__ in the *Amazon Comprehend Medical Developer Guide*. + +**Example 2: To detect entities from a file path** + +The following ``detect-entities-v2`` example shows the detected entities and labels them according to type from a file path. :: + + aws comprehendmedical detect-entities-v2 \ + --text file://medical_entities.txt + +Contents of ``medical_entities.txt``:: + + { + "Sleeping trouble on present dosage of Clonidine. Severe rash on face and leg, slightly itchy." + } + +Output:: + + { + "Id": 0, + "BeginOffset": 38, + "EndOffset": 47, + "Score": 0.9942955374717712, + "Text": "Clonidine", + "Category": "MEDICATION", + "Type": "GENERIC_NAME", + "Traits": [] + }, + +For more information, see `Detect Entities Version 2 `__ in the *Amazon Comprehend Medical Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/comprehendmedical/detect-phi.rst awscli-1.18.69/awscli/examples/comprehendmedical/detect-phi.rst --- awscli-1.11.13/awscli/examples/comprehendmedical/detect-phi.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/comprehendmedical/detect-phi.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,97 @@ +**Example 1: To detect protected health information (PHI) directly from text** + +The following ``detect-phi`` example displays the detected protected health information (PHI) entities directly from input text. :: + + aws comprehendmedical detect-phi \ + --text "Patient Carlos Salazar presented with rash on his upper extremities and dry cough. He lives at 100 Main Street, Anytown, USA where he works from his home as a carpenter." + +Output:: + + { + "Entities": [ + { + "Id": 0, + "BeginOffset": 8, + "EndOffset": 21, + "Score": 0.9914507269859314, + "Text": "Carlos Salazar", + "Category": "PROTECTED_HEALTH_INFORMATION", + "Type": "NAME", + "Traits": [] + }, + { + "Id": 1, + "BeginOffset": 94, + "EndOffset": 109, + "Score": 0.871849775314331, + "Text": "100 Main Street, Anytown, USA", + "Category": "PROTECTED_HEALTH_INFORMATION", + "Type": "ADDRESS", + "Traits": [] + }, + { + "Id": 2, + "BeginOffset": 145, + "EndOffset": 154, + "Score": 0.8302185535430908, + "Text": "carpenter", + "Category": "PROTECTED_HEALTH_INFORMATION", + "Type": "PROFESSION", + "Traits": [] + } + ], + "ModelVersion": "0.0.0" + } + +For more information, see `Detect PHI `__ in the *Amazon Comprehend Medical Developer Guide*. + +**Example 2: To detect protect health information (PHI) directly from a file path** + +The following ``detect-phi`` example shows the detected protected health information (PHI) entities from a file path. :: + + aws comprehendmedical detect-phi \ + --text file://phi.txt + +Contents of ``phi.txt``:: + + "Patient Carlos Salazar presented with a rash on his upper extremities and a dry cough. He lives at 100 Main Street, Anytown, USA, where he works from his home as a carpenter." + +Output:: + + { + "Entities": [ + { + "Id": 0, + "BeginOffset": 8, + "EndOffset": 21, + "Score": 0.9914507269859314, + "Text": "Carlos Salazar", + "Category": "PROTECTED_HEALTH_INFORMATION", + "Type": "NAME", + "Traits": [] + }, + { + "Id": 1, + "BeginOffset": 94, + "EndOffset": 109, + "Score": 0.871849775314331, + "Text": "100 Main Street, Anytown, USA", + "Category": "PROTECTED_HEALTH_INFORMATION", + "Type": "ADDRESS", + "Traits": [] + }, + { + "Id": 2, + "BeginOffset": 145, + "EndOffset": 154, + "Score": 0.8302185535430908, + "Text": "carpenter", + "Category": "PROTECTED_HEALTH_INFORMATION", + "Type": "PROFESSION", + "Traits": [] + } + ], + "ModelVersion": "0.0.0" + } + +For more information, see `Detect PHI `__ in the *Amazon Comprehend Medical Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/comprehendmedical/infer-icd10-cm.rst awscli-1.18.69/awscli/examples/comprehendmedical/infer-icd10-cm.rst --- awscli-1.11.13/awscli/examples/comprehendmedical/infer-icd10-cm.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/comprehendmedical/infer-icd10-cm.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,211 @@ +**Example 1: To detect medical condition entities and link to the ICD-10-CM Ontology directly from text** + +The following ``infer-icd10-cm`` example labels the detected medical condition entities and links those entities with codes in the 2019 edition of the International Classification of Diseases Clinical Modification (ICD-10-CM). :: + + aws comprehendmedical infer-icd10-cm \ + --text "The patient complains of abdominal pain, has a long-standing history of diabetes treated with Micronase daily." + +Output:: + + { + "Entities": [ + { + "Id": 0, + "Text": "abdominal pain", + "Category": "MEDICAL_CONDITION", + "Type": "DX_NAME", + "Score": 0.9475538730621338, + "BeginOffset": 28, + "EndOffset": 42, + "Attributes": [], + "Traits": [ + { + "Name": "SYMPTOM", + "Score": 0.6724207401275635 + } + ], + "ICD10CMConcepts": [ + { + "Description": "Unspecified abdominal pain", + "Code": "R10.9", + "Score": 0.6904221177101135 + }, + { + "Description": "Epigastric pain", + "Code": "R10.13", + "Score": 0.1364113688468933 + }, + { + "Description": "Generalized abdominal pain", + "Code": "R10.84", + "Score": 0.12508003413677216 + }, + { + "Description": "Left lower quadrant pain", + "Code": "R10.32", + "Score": 0.10063883662223816 + }, + { + "Description": "Lower abdominal pain, unspecified", + "Code": "R10.30", + "Score": 0.09933677315711975 + } + ] + }, + { + "Id": 1, + "Text": "diabetes", + "Category": "MEDICAL_CONDITION", + "Type": "DX_NAME", + "Score": 0.9899052977561951, + "BeginOffset": 75, + "EndOffset": 83, + "Attributes": [], + "Traits": [ + { + "Name": "DIAGNOSIS", + "Score": 0.9258432388305664 + } + ], + "ICD10CMConcepts": [ + { + "Description": "Type 2 diabetes mellitus without complications", + "Code": "E11.9", + "Score": 0.7158446311950684 + }, + { + "Description": "Family history of diabetes mellitus", + "Code": "Z83.3", + "Score": 0.5704703330993652 + }, + { + "Description": "Family history of other endocrine, nutritional and metabolic diseases", + "Code": "Z83.49", + "Score": 0.19856023788452148 + }, + { + "Description": "Type 1 diabetes mellitus with ketoacidosis without coma", + "Code": "E10.10", + "Score": 0.13285516202449799 + }, + { + "Description": "Type 2 diabetes mellitus with hyperglycemia", + "Code": "E11.65", + "Score": 0.0993388369679451 + } + ] + } + ], + "ModelVersion": "0.1.0" + } + +For more information, see `Infer ICD10-CM `__ in the *Amazon Comprehend Medical Developer Guide*. + +**Example 2: To detect medical condition entities and link to the ICD-10-CM Ontology from a file pathway** + +The following ``infer-icd-10-cm`` example labels the detected medical condition entities and links those entities with codes in the 2019 edition of the International Classification of Diseases Clinical Modification (ICD-10-CM). :: + + aws comprehendmedical infer-icd10-cm \ + --text file://icd10cm.txt + +Contents of ``icd10cm.txt``:: + + { + "The patient complains of abdominal pain, has a long-standing history of diabetes treated with Micronase daily." + } + +Output:: + + { + "Entities": [ + { + "Id": 0, + "Text": "abdominal pain", + "Category": "MEDICAL_CONDITION", + "Type": "DX_NAME", + "Score": 0.9475538730621338, + "BeginOffset": 28, + "EndOffset": 42, + "Attributes": [], + "Traits": [ + { + "Name": "SYMPTOM", + "Score": 0.6724207401275635 + } + ], + "ICD10CMConcepts": [ + { + "Description": "Unspecified abdominal pain", + "Code": "R10.9", + "Score": 0.6904221177101135 + }, + { + "Description": "Epigastric pain", + "Code": "R10.13", + "Score": 0.1364113688468933 + }, + { + "Description": "Generalized abdominal pain", + "Code": "R10.84", + "Score": 0.12508003413677216 + }, + { + "Description": "Left lower quadrant pain", + "Code": "R10.32", + "Score": 0.10063883662223816 + }, + { + "Description": "Lower abdominal pain, unspecified", + "Code": "R10.30", + "Score": 0.09933677315711975 + } + ] + }, + { + "Id": 1, + "Text": "diabetes", + "Category": "MEDICAL_CONDITION", + "Type": "DX_NAME", + "Score": 0.9899052977561951, + "BeginOffset": 75, + "EndOffset": 83, + "Attributes": [], + "Traits": [ + { + "Name": "DIAGNOSIS", + "Score": 0.9258432388305664 + } + ], + "ICD10CMConcepts": [ + { + "Description": "Type 2 diabetes mellitus without complications", + "Code": "E11.9", + "Score": 0.7158446311950684 + }, + { + "Description": "Family history of diabetes mellitus", + "Code": "Z83.3", + "Score": 0.5704703330993652 + }, + { + "Description": "Family history of other endocrine, nutritional and metabolic diseases", + "Code": "Z83.49", + "Score": 0.19856023788452148 + }, + { + "Description": "Type 1 diabetes mellitus with ketoacidosis without coma", + "Code": "E10.10", + "Score": 0.13285516202449799 + }, + { + "Description": "Type 2 diabetes mellitus with hyperglycemia", + "Code": "E11.65", + "Score": 0.0993388369679451 + } + ] + } + ], + "ModelVersion": "0.1.0" + } + +For more information, see `Infer-ICD10-CM `__ in the *Amazon Comprehend Medical Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/comprehendmedical/infer-rx-norm.rst awscli-1.18.69/awscli/examples/comprehendmedical/infer-rx-norm.rst --- awscli-1.11.13/awscli/examples/comprehendmedical/infer-rx-norm.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/comprehendmedical/infer-rx-norm.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,263 @@ +**Example 1: To detect medication entities and link to RxNorm directly from text** + +The following ``infer-rx-norm`` example shows and labels the detected medication entities and links those entities to concept identifiers (RxCUI) from the National Library of Medicine RxNorm database. :: + + aws comprehendmedical infer-rx-norm \ + --text "Patient reports taking Levothyroxine 125 micrograms p.o. once daily, but denies taking Synthroid." + +Output:: + + { + "Entities": [ + { + "Id": 0, + "Text": "Levothyroxine", + "Category": "MEDICATION", + "Type": "GENERIC_NAME", + "Score": 0.9996285438537598, + "BeginOffset": 23, + "EndOffset": 36, + "Attributes": [ + { + "Type": "DOSAGE", + "Score": 0.9892290830612183, + "RelationshipScore": 0.9997978806495667, + "Id": 1, + "BeginOffset": 37, + "EndOffset": 51, + "Text": "125 micrograms", + "Traits": [] + }, + { + "Type": "ROUTE_OR_MODE", + "Score": 0.9988924860954285, + "RelationshipScore": 0.998291552066803, + "Id": 2, + "BeginOffset": 52, + "EndOffset": 56, + "Text": "p.o.", + "Traits": [] + }, + { + "Type": "FREQUENCY", + "Score": 0.9953463673591614, + "RelationshipScore": 0.9999889135360718, + "Id": 3, + "BeginOffset": 57, + "EndOffset": 67, + "Text": "once daily", + "Traits": [] + } + ], + "Traits": [], + "RxNormConcepts": [ + { + "Description": "Levothyroxine Sodium 0.125 MG Oral Tablet", + "Code": "966224", + "Score": 0.9912070631980896 + }, + { + "Description": "Levothyroxine Sodium 0.125 MG Oral Capsule", + "Code": "966405", + "Score": 0.8698278665542603 + }, + { + "Description": "Levothyroxine Sodium 0.125 MG Oral Tablet [Synthroid]", + "Code": "966191", + "Score": 0.7448257803916931 + }, + { + "Description": "levothyroxine", + "Code": "10582", + "Score": 0.7050482630729675 + }, + { + "Description": "Levothyroxine Sodium 0.125 MG Oral Tablet [Levoxyl]", + "Code": "966190", + "Score": 0.6921631693840027 + } + ] + }, + { + "Id": 4, + "Text": "Synthroid", + "Category": "MEDICATION", + "Type": "BRAND_NAME", + "Score": 0.9946461319923401, + "BeginOffset": 86, + "EndOffset": 95, + "Attributes": [], + "Traits": [ + { + "Name": "NEGATION", + "Score": 0.5167351961135864 + } + ], + "RxNormConcepts": [ + { + "Description": "Synthroid", + "Code": "224920", + "Score": 0.9462039470672607 + }, + { + "Description": "Levothyroxine Sodium 0.088 MG Oral Tablet [Synthroid]", + "Code": "966282", + "Score": 0.8309829235076904 + }, + { + "Description": "Levothyroxine Sodium 0.125 MG Oral Tablet [Synthroid]", + "Code": "966191", + "Score": 0.4945160448551178 + }, + { + "Description": "Levothyroxine Sodium 0.05 MG Oral Tablet [Synthroid]", + "Code": "966247", + "Score": 0.3674522042274475 + }, + { + "Description": "Levothyroxine Sodium 0.025 MG Oral Tablet [Synthroid]", + "Code": "966158", + "Score": 0.2588822841644287 + } + ] + } + ], + "ModelVersion": "0.0.0" + } + +For more information, see `Infer RxNorm `__ in the *Amazon Comprehend Medical Developer Guide*. + +**Example 2: To detect medication entities and link to RxNorm from a file path.** + +The following ``infer-rx-norm`` example shows and labels the detected medication entities and links those entities to concept identifiers (RxCUI) from the National Library of Medicine RxNorm database. :: + + aws comprehendmedical infer-rx-norm \ + --text file://rxnorm.txt + +Contents of ``rxnorm.txt``:: + + { + "Patient reports taking Levothyroxine 125 micrograms p.o. once daily, but denies taking Synthroid." + } + +Output:: + + { + "Entities": [ + { + "Id": 0, + "Text": "Levothyroxine", + "Category": "MEDICATION", + "Type": "GENERIC_NAME", + "Score": 0.9996285438537598, + "BeginOffset": 23, + "EndOffset": 36, + "Attributes": [ + { + "Type": "DOSAGE", + "Score": 0.9892290830612183, + "RelationshipScore": 0.9997978806495667, + "Id": 1, + "BeginOffset": 37, + "EndOffset": 51, + "Text": "125 micrograms", + "Traits": [] + }, + { + "Type": "ROUTE_OR_MODE", + "Score": 0.9988924860954285, + "RelationshipScore": 0.998291552066803, + "Id": 2, + "BeginOffset": 52, + "EndOffset": 56, + "Text": "p.o.", + "Traits": [] + }, + { + "Type": "FREQUENCY", + "Score": 0.9953463673591614, + "RelationshipScore": 0.9999889135360718, + "Id": 3, + "BeginOffset": 57, + "EndOffset": 67, + "Text": "once daily", + "Traits": [] + } + ], + "Traits": [], + "RxNormConcepts": [ + { + "Description": "Levothyroxine Sodium 0.125 MG Oral Tablet", + "Code": "966224", + "Score": 0.9912070631980896 + }, + { + "Description": "Levothyroxine Sodium 0.125 MG Oral Capsule", + "Code": "966405", + "Score": 0.8698278665542603 + }, + { + "Description": "Levothyroxine Sodium 0.125 MG Oral Tablet [Synthroid]", + "Code": "966191", + "Score": 0.7448257803916931 + }, + { + "Description": "levothyroxine", + "Code": "10582", + "Score": 0.7050482630729675 + }, + { + "Description": "Levothyroxine Sodium 0.125 MG Oral Tablet [Levoxyl]", + "Code": "966190", + "Score": 0.6921631693840027 + } + ] + }, + { + "Id": 4, + "Text": "Synthroid", + "Category": "MEDICATION", + "Type": "BRAND_NAME", + "Score": 0.9946461319923401, + "BeginOffset": 86, + "EndOffset": 95, + "Attributes": [], + "Traits": [ + { + "Name": "NEGATION", + "Score": 0.5167351961135864 + } + ], + "RxNormConcepts": [ + { + "Description": "Synthroid", + "Code": "224920", + "Score": 0.9462039470672607 + }, + { + "Description": "Levothyroxine Sodium 0.088 MG Oral Tablet [Synthroid]", + "Code": "966282", + "Score": 0.8309829235076904 + }, + { + "Description": "Levothyroxine Sodium 0.125 MG Oral Tablet [Synthroid]", + "Code": "966191", + "Score": 0.4945160448551178 + }, + { + "Description": "Levothyroxine Sodium 0.05 MG Oral Tablet [Synthroid]", + "Code": "966247", + "Score": 0.3674522042274475 + }, + { + "Description": "Levothyroxine Sodium 0.025 MG Oral Tablet [Synthroid]", + "Code": "966158", + "Score": 0.2588822841644287 + } + ] + } + ], + "ModelVersion": "0.0.0" + } + +For more information, see `Infer RxNorm `__ in the *Amazon Comprehend Medical Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/comprehendmedical/list-entities-detection-v2-jobs.rst awscli-1.18.69/awscli/examples/comprehendmedical/list-entities-detection-v2-jobs.rst --- awscli-1.11.13/awscli/examples/comprehendmedical/list-entities-detection-v2-jobs.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/comprehendmedical/list-entities-detection-v2-jobs.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,32 @@ +**To list entities detection jobs** + +The following ``list-entities-detection-v2-jobs`` example lists current asynchronous detection jobs. :: + + aws comprehendmedical list-entities-detection-v2-jobs + +Output:: + + { + "ComprehendMedicalAsyncJobPropertiesList": [ + { + "JobId": "ab9887877365fe70299089371c043b96", + "JobStatus": "COMPLETED", + "SubmitTime": "2020-03-19T20:38:37.594000+00:00", + "EndTime": "2020-03-19T20:45:07.894000+00:00", + "ExpirationTime": "2020-07-17T20:38:37+00:00", + "InputDataConfig": { + "S3Bucket": "comp-med-input", + "S3Key": "" + }, + "OutputDataConfig": { + "S3Bucket": "comp-med-output", + "S3Key": "867139942017-EntitiesDetection-ab9887877365fe70299089371c043b96/" + }, + "LanguageCode": "en", + "DataAccessRoleArn": "arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole", + "ModelVersion": "DetectEntitiesModelV20190930" + } + ] + } + +For more information, see `Batch APIs `__ in the *Amazon Comprehend Medical Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/comprehendmedical/list-phi-detection-jobs.rst awscli-1.18.69/awscli/examples/comprehendmedical/list-phi-detection-jobs.rst --- awscli-1.11.13/awscli/examples/comprehendmedical/list-phi-detection-jobs.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/comprehendmedical/list-phi-detection-jobs.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,32 @@ +**To list protected health information (PHI) detection jobs** + +The following ``list-phi-detection-jobs`` example lists current protected health information (PHI) detection jobs :: + + aws comprehendmedical list-phi-detection-jobs + +Output:: + + { + "ComprehendMedicalAsyncJobPropertiesList": [ + { + "JobId": "4750034166536cdb52ffa3295a1b00a3", + "JobStatus": "COMPLETED", + "SubmitTime": "2020-03-19T20:38:37.594000+00:00", + "EndTime": "2020-03-19T20:45:07.894000+00:00", + "ExpirationTime": "2020-07-17T20:38:37+00:00", + "InputDataConfig": { + "S3Bucket": "comp-med-input", + "S3Key": "" + }, + "OutputDataConfig": { + "S3Bucket": "comp-med-output", + "S3Key": "867139942017-PHIDetection-4750034166536cdb52ffa3295a1b00a3/" + }, + "LanguageCode": "en", + "DataAccessRoleArn": "arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole", + "ModelVersion": "PHIModelV20190903" + } + ] + } + +For more information, see `Batch APIs `__ in the *Amazon Comprehend Medical Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/comprehendmedical/start-entities-detection-v2-job.rst awscli-1.18.69/awscli/examples/comprehendmedical/start-entities-detection-v2-job.rst --- awscli-1.11.13/awscli/examples/comprehendmedical/start-entities-detection-v2-job.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/comprehendmedical/start-entities-detection-v2-job.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To start an entities detection job** + +The following ``start-entities-detection-v2-job`` example starts an asynchronous entity detection job. :: + + aws comprehendmedical start-entities-detection-v2-job \ + --input-data-config "S3Bucket=comp-med-input" \ + --output-data-config "S3Bucket=comp-med-output" \ + --data-access-role-arn arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole \ + --language-code en + +Output:: + + { + "JobId": "ab9887877365fe70299089371c043b96" + } + +For more information, see `Batch APIs `__ in the *Amazon Comprehend Medical Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/comprehendmedical/start-phi-detection-job.rst awscli-1.18.69/awscli/examples/comprehendmedical/start-phi-detection-job.rst --- awscli-1.11.13/awscli/examples/comprehendmedical/start-phi-detection-job.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/comprehendmedical/start-phi-detection-job.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To start a PHI detection job** + +The following ``start-phi-detection-job`` example starts an asynchronous PHI entity detection job. :: + + aws comprehendmedical start-phi-detection-job \ + --input-data-config "S3Bucket=comp-med-input" \ + --output-data-config "S3Bucket=comp-med-output" \ + --data-access-role-arn arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole \ + --language-code en + +Output:: + + { + "JobId": "ab9887877365fe70299089371c043b96" + } + +For more information, see `Batch APIs `__ in the *Amazon Comprehend Medical Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/comprehendmedical/stop-entities-detection-v2-job.rst awscli-1.18.69/awscli/examples/comprehendmedical/stop-entities-detection-v2-job.rst --- awscli-1.11.13/awscli/examples/comprehendmedical/stop-entities-detection-v2-job.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/comprehendmedical/stop-entities-detection-v2-job.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,14 @@ +**To stop an entity detection job** + +The following ``stop-entities-detection-v2-job`` example stops an asynchronous entity detection job. :: + + aws comprehendmedical stop-entities-detection-v2-job \ + --job-id "ab9887877365fe70299089371c043b96" + +Output:: + + { + "JobId": "ab9887877365fe70299089371c043b96" + } + +For more information, see `Batch APIs `__ in the *Amazon Comprehend Medical Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/comprehendmedical/stop-phi-detection-job.rst awscli-1.18.69/awscli/examples/comprehendmedical/stop-phi-detection-job.rst --- awscli-1.11.13/awscli/examples/comprehendmedical/stop-phi-detection-job.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/comprehendmedical/stop-phi-detection-job.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,14 @@ +**To stop a protected health information (PHI) detection job** + +The following ``stop-phi-detection-job`` example stops an asynchronous protected health information (PHI) detection job. :: + + aws comprehendmedical stop-phi-detection-job \ + --job-id "4750034166536cdb52ffa3295a1b00a3" + +Output:: + + { + "JobId": "ab9887877365fe70299089371c043b96" + } + +For more information, see `Batch APIs `__ in the *Amazon Comprehend Medical Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/configservice/delete-config-rule.rst awscli-1.18.69/awscli/examples/configservice/delete-config-rule.rst --- awscli-1.11.13/awscli/examples/configservice/delete-config-rule.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/configservice/delete-config-rule.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,5 +1,5 @@ -**To delete an AWS Config rule** - -The following command deletes an AWS Config rule named ``MyConfigRule``:: - +**To delete an AWS Config rule** + +The following command deletes an AWS Config rule named ``MyConfigRule``:: + aws configservice delete-config-rule --config-rule-name MyConfigRule \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/configservice/delete-delivery-channel.rst awscli-1.18.69/awscli/examples/configservice/delete-delivery-channel.rst --- awscli-1.11.13/awscli/examples/configservice/delete-delivery-channel.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/configservice/delete-delivery-channel.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,5 +1,5 @@ -**To delete a delivery channel** - -The following command deletes the default delivery channel:: - +**To delete a delivery channel** + +The following command deletes the default delivery channel:: + aws configservice delete-delivery-channel --delivery-channel-name default \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/configservice/delete-evaluation-results.rst awscli-1.18.69/awscli/examples/configservice/delete-evaluation-results.rst --- awscli-1.11.13/awscli/examples/configservice/delete-evaluation-results.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/configservice/delete-evaluation-results.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,5 @@ +**To manually delete evaluation results** + +The following command deletes the current evaluation results for the AWS managed rule s3-bucket-versioning-enabled:: + + aws configservice delete-evaluation-results --config-rule-name s3-bucket-versioning-enabled \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/configservice/deliver-config-snapshot.rst awscli-1.18.69/awscli/examples/configservice/deliver-config-snapshot.rst --- awscli-1.11.13/awscli/examples/configservice/deliver-config-snapshot.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/configservice/deliver-config-snapshot.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,11 +1,11 @@ -**To deliver a configuration snapshot** - -The following command delivers a configuration snapshot to the Amazon S3 bucket that belongs to the default delivery channel:: - - aws configservice deliver-config-snapshot --delivery-channel-name default - -Output:: - - { - "configSnapshotId": "d0333b00-a683-44af-921e-examplefb794" +**To deliver a configuration snapshot** + +The following command delivers a configuration snapshot to the Amazon S3 bucket that belongs to the default delivery channel:: + + aws configservice deliver-config-snapshot --delivery-channel-name default + +Output:: + + { + "configSnapshotId": "d0333b00-a683-44af-921e-examplefb794" } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/configservice/describe-compliance-by-config-rule.rst awscli-1.18.69/awscli/examples/configservice/describe-compliance-by-config-rule.rst --- awscli-1.11.13/awscli/examples/configservice/describe-compliance-by-config-rule.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/configservice/describe-compliance-by-config-rule.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,34 +1,34 @@ -**To get compliance information for your AWS Config rules** - -The following command returns compliance information for each AWS Config rule that is violated by one or more AWS resources:: - - aws configservice describe-compliance-by-config-rule --compliance-types NON_COMPLIANT - -In the output, the value for each ``CappedCount`` attribute indicates how many resources do not comply with the related rule. For example, the following output indicates that 3 resources do not comply with the rule named ``InstanceTypesAreT2micro``. - -Output:: - - { - "ComplianceByConfigRules": [ - { - "Compliance": { - "ComplianceContributorCount": { - "CappedCount": 3, - "CapExceeded": false - }, - "ComplianceType": "NON_COMPLIANT" - }, - "ConfigRuleName": "InstanceTypesAreT2micro" - }, - { - "Compliance": { - "ComplianceContributorCount": { - "CappedCount": 10, - "CapExceeded": false - }, - "ComplianceType": "NON_COMPLIANT" - }, - "ConfigRuleName": "RequiredTagsForVolumes" - } - ] +**To get compliance information for your AWS Config rules** + +The following command returns compliance information for each AWS Config rule that is violated by one or more AWS resources:: + + aws configservice describe-compliance-by-config-rule --compliance-types NON_COMPLIANT + +In the output, the value for each ``CappedCount`` attribute indicates how many resources do not comply with the related rule. For example, the following output indicates that 3 resources do not comply with the rule named ``InstanceTypesAreT2micro``. + +Output:: + + { + "ComplianceByConfigRules": [ + { + "Compliance": { + "ComplianceContributorCount": { + "CappedCount": 3, + "CapExceeded": false + }, + "ComplianceType": "NON_COMPLIANT" + }, + "ConfigRuleName": "InstanceTypesAreT2micro" + }, + { + "Compliance": { + "ComplianceContributorCount": { + "CappedCount": 10, + "CapExceeded": false + }, + "ComplianceType": "NON_COMPLIANT" + }, + "ConfigRuleName": "RequiredTagsForVolumes" + } + ] } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/configservice/describe-compliance-by-resource.rst awscli-1.18.69/awscli/examples/configservice/describe-compliance-by-resource.rst --- awscli-1.11.13/awscli/examples/configservice/describe-compliance-by-resource.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/configservice/describe-compliance-by-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,36 +1,36 @@ -**To get compliance information for your AWS resources** - -The following command returns compliance information for each EC2 instance that is recorded by AWS Config and that violates one or more rules:: - - aws configservice describe-compliance-by-resource --resource-type AWS::EC2::Instance --compliance-types NON_COMPLIANT - -In the output, the value for each ``CappedCount`` attribute indicates how many rules the resource violates. For example, the following output indicates that instance ``i-1a2b3c4d`` violates 2 rules. - -Output:: - - { - "ComplianceByResources": [ - { - "ResourceType": "AWS::EC2::Instance", - "ResourceId": "i-1a2b3c4d", - "Compliance": { - "ComplianceContributorCount": { - "CappedCount": 2, - "CapExceeded": false - }, - "ComplianceType": "NON_COMPLIANT" - } - }, - { - "ResourceType": "AWS::EC2::Instance", - "ResourceId": "i-2a2b3c4d ", - "Compliance": { - "ComplianceContributorCount": { - "CappedCount": 3, - "CapExceeded": false - }, - "ComplianceType": "NON_COMPLIANT" - } - } - ] +**To get compliance information for your AWS resources** + +The following command returns compliance information for each EC2 instance that is recorded by AWS Config and that violates one or more rules:: + + aws configservice describe-compliance-by-resource --resource-type AWS::EC2::Instance --compliance-types NON_COMPLIANT + +In the output, the value for each ``CappedCount`` attribute indicates how many rules the resource violates. For example, the following output indicates that instance ``i-1a2b3c4d`` violates 2 rules. + +Output:: + + { + "ComplianceByResources": [ + { + "ResourceType": "AWS::EC2::Instance", + "ResourceId": "i-1a2b3c4d", + "Compliance": { + "ComplianceContributorCount": { + "CappedCount": 2, + "CapExceeded": false + }, + "ComplianceType": "NON_COMPLIANT" + } + }, + { + "ResourceType": "AWS::EC2::Instance", + "ResourceId": "i-2a2b3c4d ", + "Compliance": { + "ComplianceContributorCount": { + "CappedCount": 3, + "CapExceeded": false + }, + "ComplianceType": "NON_COMPLIANT" + } + } + ] } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/configservice/describe-config-rule-evaluation-status.rst awscli-1.18.69/awscli/examples/configservice/describe-config-rule-evaluation-status.rst --- awscli-1.11.13/awscli/examples/configservice/describe-config-rule-evaluation-status.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/configservice/describe-config-rule-evaluation-status.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,19 +1,19 @@ -**To get status information for an AWS Config rule** - -The following command returns the status information for an AWS Config rule named ``MyConfigRule``:: - - aws configservice describe-config-rule-evaluation-status --config-rule-names MyConfigRule - -Output:: - - { - "ConfigRulesEvaluationStatus": [ - { - "ConfigRuleArn": "arn:aws:config:us-east-1:123456789012:config-rule/config-rule-abcdef", - "FirstActivatedTime": 1450311703.844, - "ConfigRuleId": "config-rule-abcdef", - "LastSuccessfulInvocationTime": 1450314643.156, - "ConfigRuleName": "MyConfigRule" - } - ] +**To get status information for an AWS Config rule** + +The following command returns the status information for an AWS Config rule named ``MyConfigRule``:: + + aws configservice describe-config-rule-evaluation-status --config-rule-names MyConfigRule + +Output:: + + { + "ConfigRulesEvaluationStatus": [ + { + "ConfigRuleArn": "arn:aws:config:us-east-1:123456789012:config-rule/config-rule-abcdef", + "FirstActivatedTime": 1450311703.844, + "ConfigRuleId": "config-rule-abcdef", + "LastSuccessfulInvocationTime": 1450314643.156, + "ConfigRuleName": "MyConfigRule" + } + ] } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/configservice/describe-config-rules.rst awscli-1.18.69/awscli/examples/configservice/describe-config-rules.rst --- awscli-1.11.13/awscli/examples/configservice/describe-config-rules.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/configservice/describe-config-rules.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,35 +1,35 @@ -**To get details for an AWS Config rule** - -The following command returns details for an AWS Config rule named ``InstanceTypesAreT2micro``:: - - aws configservice describe-config-rules --config-rule-names InstanceTypesAreT2micro - -Output:: - - { - "ConfigRules": [ - { - "ConfigRuleState": "ACTIVE", - "Description": "Evaluates whether EC2 instances are the t2.micro type.", - "ConfigRuleName": "InstanceTypesAreT2micro", - "ConfigRuleArn": "arn:aws:config:us-east-1:123456789012:config-rule/config-rule-abcdef", - "Source": { - "Owner": "CUSTOM_LAMBDA", - "SourceIdentifier": "arn:aws:lambda:us-east-1:123456789012:function:InstanceTypeCheck", - "SourceDetails": [ - { - "EventSource": "aws.config", - "MessageType": "ConfigurationItemChangeNotification" - } - ] - }, - "InputParameters": "{\"desiredInstanceType\":\"t2.micro\"}", - "Scope": { - "ComplianceResourceTypes": [ - "AWS::EC2::Instance" - ] - }, - "ConfigRuleId": "config-rule-abcdef" - } - ] +**To get details for an AWS Config rule** + +The following command returns details for an AWS Config rule named ``InstanceTypesAreT2micro``:: + + aws configservice describe-config-rules --config-rule-names InstanceTypesAreT2micro + +Output:: + + { + "ConfigRules": [ + { + "ConfigRuleState": "ACTIVE", + "Description": "Evaluates whether EC2 instances are the t2.micro type.", + "ConfigRuleName": "InstanceTypesAreT2micro", + "ConfigRuleArn": "arn:aws:config:us-east-1:123456789012:config-rule/config-rule-abcdef", + "Source": { + "Owner": "CUSTOM_LAMBDA", + "SourceIdentifier": "arn:aws:lambda:us-east-1:123456789012:function:InstanceTypeCheck", + "SourceDetails": [ + { + "EventSource": "aws.config", + "MessageType": "ConfigurationItemChangeNotification" + } + ] + }, + "InputParameters": "{\"desiredInstanceType\":\"t2.micro\"}", + "Scope": { + "ComplianceResourceTypes": [ + "AWS::EC2::Instance" + ] + }, + "ConfigRuleId": "config-rule-abcdef" + } + ] } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/configservice/describe-configuration-recorders.rst awscli-1.18.69/awscli/examples/configservice/describe-configuration-recorders.rst --- awscli-1.11.13/awscli/examples/configservice/describe-configuration-recorders.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/configservice/describe-configuration-recorders.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,21 +1,21 @@ -**To get details about the configuration recorder** - -The following command returns details about the default configuration recorder:: - - aws configservice describe-configuration-recorders - -Output:: - - { - "ConfigurationRecorders": [ - { - "recordingGroup": { - "allSupported": true, - "resourceTypes": [], - "includeGlobalResourceTypes": true - }, - "roleARN": "arn:aws:iam::123456789012:role/config-ConfigRole-A1B2C3D4E5F6", - "name": "default" - } - ] +**To get details about the configuration recorder** + +The following command returns details about the default configuration recorder:: + + aws configservice describe-configuration-recorders + +Output:: + + { + "ConfigurationRecorders": [ + { + "recordingGroup": { + "allSupported": true, + "resourceTypes": [], + "includeGlobalResourceTypes": true + }, + "roleARN": "arn:aws:iam::123456789012:role/config-ConfigRole-A1B2C3D4E5F6", + "name": "default" + } + ] } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/configservice/describe-configuration-recorder-status.rst awscli-1.18.69/awscli/examples/configservice/describe-configuration-recorder-status.rst --- awscli-1.11.13/awscli/examples/configservice/describe-configuration-recorder-status.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/configservice/describe-configuration-recorder-status.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,20 +1,20 @@ -**To get status information for the configuration recorder** - -The following command returns the status of the default configuration recorder:: - - aws configservice describe-configuration-recorder-status - -Output:: - - { - "ConfigurationRecordersStatus": [ - { - "name": "default", - "lastStatus": "SUCCESS", - "recording": true, - "lastStatusChangeTime": 1452193834.344, - "lastStartTime": 1441039997.819, - "lastStopTime": 1441039992.835 - } - ] +**To get status information for the configuration recorder** + +The following command returns the status of the default configuration recorder:: + + aws configservice describe-configuration-recorder-status + +Output:: + + { + "ConfigurationRecordersStatus": [ + { + "name": "default", + "lastStatus": "SUCCESS", + "recording": true, + "lastStatusChangeTime": 1452193834.344, + "lastStartTime": 1441039997.819, + "lastStopTime": 1441039992.835 + } + ] } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/configservice/describe-delivery-channels.rst awscli-1.18.69/awscli/examples/configservice/describe-delivery-channels.rst --- awscli-1.11.13/awscli/examples/configservice/describe-delivery-channels.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/configservice/describe-delivery-channels.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,17 +1,17 @@ -**To get details about the delivery channel** - -The following command returns details about the delivery channel:: - - aws configservice describe-delivery-channels - -Output:: - - { - "DeliveryChannels": [ - { - "snsTopicARN": "arn:aws:sns:us-east-1:123456789012:config-topic", - "name": "default", - "s3BucketName": "config-bucket-123456789012" - } - ] +**To get details about the delivery channel** + +The following command returns details about the delivery channel:: + + aws configservice describe-delivery-channels + +Output:: + + { + "DeliveryChannels": [ + { + "snsTopicARN": "arn:aws:sns:us-east-1:123456789012:config-topic", + "name": "default", + "s3BucketName": "config-bucket-123456789012" + } + ] } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/configservice/describe-delivery-channel-status.rst awscli-1.18.69/awscli/examples/configservice/describe-delivery-channel-status.rst --- awscli-1.11.13/awscli/examples/configservice/describe-delivery-channel-status.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/configservice/describe-delivery-channel-status.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,29 +1,29 @@ -**To get status information for the delivery channel** - -The following command returns the status of the delivery channel:: - - aws configservice describe-delivery-channel-status - -Output:: - - { - "DeliveryChannelsStatus": [ - { - "configStreamDeliveryInfo": { - "lastStatusChangeTime": 1452193834.381, - "lastStatus": "SUCCESS" - }, - "configHistoryDeliveryInfo": { - "lastSuccessfulTime": 1450317838.412, - "lastStatus": "SUCCESS", - "lastAttemptTime": 1450317838.412 - }, - "configSnapshotDeliveryInfo": { - "lastSuccessfulTime": 1452185597.094, - "lastStatus": "SUCCESS", - "lastAttemptTime": 1452185597.094 - }, - "name": "default" - } - ] +**To get status information for the delivery channel** + +The following command returns the status of the delivery channel:: + + aws configservice describe-delivery-channel-status + +Output:: + + { + "DeliveryChannelsStatus": [ + { + "configStreamDeliveryInfo": { + "lastStatusChangeTime": 1452193834.381, + "lastStatus": "SUCCESS" + }, + "configHistoryDeliveryInfo": { + "lastSuccessfulTime": 1450317838.412, + "lastStatus": "SUCCESS", + "lastAttemptTime": 1450317838.412 + }, + "configSnapshotDeliveryInfo": { + "lastSuccessfulTime": 1452185597.094, + "lastStatus": "SUCCESS", + "lastAttemptTime": 1452185597.094 + }, + "name": "default" + } + ] } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/configservice/get-compliance-details-by-config-rule.rst awscli-1.18.69/awscli/examples/configservice/get-compliance-details-by-config-rule.rst --- awscli-1.11.13/awscli/examples/configservice/get-compliance-details-by-config-rule.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/configservice/get-compliance-details-by-config-rule.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,51 +1,51 @@ -**To get the evaluation results for an AWS Config rule** - -The following command returns the evaluation results for all of the resources that don't comply with an AWS Config rule named ``InstanceTypesAreT2micro``:: - - aws configservice get-compliance-details-by-config-rule --config-rule-name InstanceTypesAreT2micro --compliance-types NON_COMPLIANT - -Output:: - - { - "EvaluationResults": [ - { - "EvaluationResultIdentifier": { - "OrderingTimestamp": 1450314635.065, - "EvaluationResultQualifier": { - "ResourceType": "AWS::EC2::Instance", - "ResourceId": "i-1a2b3c4d", - "ConfigRuleName": "InstanceTypesAreT2micro" - } - }, - "ResultRecordedTime": 1450314645.261, - "ConfigRuleInvokedTime": 1450314642.948, - "ComplianceType": "NON_COMPLIANT" - }, - { - "EvaluationResultIdentifier": { - "OrderingTimestamp": 1450314635.065, - "EvaluationResultQualifier": { - "ResourceType": "AWS::EC2::Instance", - "ResourceId": "i-2a2b3c4d", - "ConfigRuleName": "InstanceTypesAreT2micro" - } - }, - "ResultRecordedTime": 1450314645.18, - "ConfigRuleInvokedTime": 1450314642.902, - "ComplianceType": "NON_COMPLIANT" - }, - { - "EvaluationResultIdentifier": { - "OrderingTimestamp": 1450314635.065, - "EvaluationResultQualifier": { - "ResourceType": "AWS::EC2::Instance", - "ResourceId": "i-3a2b3c4d", - "ConfigRuleName": "InstanceTypesAreT2micro" - } - }, - "ResultRecordedTime": 1450314643.346, - "ConfigRuleInvokedTime": 1450314643.124, - "ComplianceType": "NON_COMPLIANT" - } - ] +**To get the evaluation results for an AWS Config rule** + +The following command returns the evaluation results for all of the resources that don't comply with an AWS Config rule named ``InstanceTypesAreT2micro``:: + + aws configservice get-compliance-details-by-config-rule --config-rule-name InstanceTypesAreT2micro --compliance-types NON_COMPLIANT + +Output:: + + { + "EvaluationResults": [ + { + "EvaluationResultIdentifier": { + "OrderingTimestamp": 1450314635.065, + "EvaluationResultQualifier": { + "ResourceType": "AWS::EC2::Instance", + "ResourceId": "i-1a2b3c4d", + "ConfigRuleName": "InstanceTypesAreT2micro" + } + }, + "ResultRecordedTime": 1450314645.261, + "ConfigRuleInvokedTime": 1450314642.948, + "ComplianceType": "NON_COMPLIANT" + }, + { + "EvaluationResultIdentifier": { + "OrderingTimestamp": 1450314635.065, + "EvaluationResultQualifier": { + "ResourceType": "AWS::EC2::Instance", + "ResourceId": "i-2a2b3c4d", + "ConfigRuleName": "InstanceTypesAreT2micro" + } + }, + "ResultRecordedTime": 1450314645.18, + "ConfigRuleInvokedTime": 1450314642.902, + "ComplianceType": "NON_COMPLIANT" + }, + { + "EvaluationResultIdentifier": { + "OrderingTimestamp": 1450314635.065, + "EvaluationResultQualifier": { + "ResourceType": "AWS::EC2::Instance", + "ResourceId": "i-3a2b3c4d", + "ConfigRuleName": "InstanceTypesAreT2micro" + } + }, + "ResultRecordedTime": 1450314643.346, + "ConfigRuleInvokedTime": 1450314643.124, + "ComplianceType": "NON_COMPLIANT" + } + ] } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/configservice/get-compliance-details-by-resource.rst awscli-1.18.69/awscli/examples/configservice/get-compliance-details-by-resource.rst --- awscli-1.11.13/awscli/examples/configservice/get-compliance-details-by-resource.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/configservice/get-compliance-details-by-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,38 +1,38 @@ -**To get the evaluation results for an AWS resource** - -The following command returns the evaluation results for each rule with which the EC2 instance ``i-1a2b3c4d`` does not comply:: - - aws configservice get-compliance-details-by-resource --resource-type AWS::EC2::Instance --resource-id i-1a2b3c4d --compliance-types NON_COMPLIANT - -Output:: - - { - "EvaluationResults": [ - { - "EvaluationResultIdentifier": { - "OrderingTimestamp": 1450314635.065, - "EvaluationResultQualifier": { - "ResourceType": "AWS::EC2::Instance", - "ResourceId": "i-1a2b3c4d", - "ConfigRuleName": "InstanceTypesAreT2micro" - } - }, - "ResultRecordedTime": 1450314643.288, - "ConfigRuleInvokedTime": 1450314643.034, - "ComplianceType": "NON_COMPLIANT" - }, - { - "EvaluationResultIdentifier": { - "OrderingTimestamp": 1450314635.065, - "EvaluationResultQualifier": { - "ResourceType": "AWS::EC2::Instance", - "ResourceId": "i-1a2b3c4d", - "ConfigRuleName": "RequiredTagForEC2Instances" - } - }, - "ResultRecordedTime": 1450314645.261, - "ConfigRuleInvokedTime": 1450314642.948, - "ComplianceType": "NON_COMPLIANT" - } - ] +**To get the evaluation results for an AWS resource** + +The following command returns the evaluation results for each rule with which the EC2 instance ``i-1a2b3c4d`` does not comply:: + + aws configservice get-compliance-details-by-resource --resource-type AWS::EC2::Instance --resource-id i-1a2b3c4d --compliance-types NON_COMPLIANT + +Output:: + + { + "EvaluationResults": [ + { + "EvaluationResultIdentifier": { + "OrderingTimestamp": 1450314635.065, + "EvaluationResultQualifier": { + "ResourceType": "AWS::EC2::Instance", + "ResourceId": "i-1a2b3c4d", + "ConfigRuleName": "InstanceTypesAreT2micro" + } + }, + "ResultRecordedTime": 1450314643.288, + "ConfigRuleInvokedTime": 1450314643.034, + "ComplianceType": "NON_COMPLIANT" + }, + { + "EvaluationResultIdentifier": { + "OrderingTimestamp": 1450314635.065, + "EvaluationResultQualifier": { + "ResourceType": "AWS::EC2::Instance", + "ResourceId": "i-1a2b3c4d", + "ConfigRuleName": "RequiredTagForEC2Instances" + } + }, + "ResultRecordedTime": 1450314645.261, + "ConfigRuleInvokedTime": 1450314642.948, + "ComplianceType": "NON_COMPLIANT" + } + ] } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/configservice/get-compliance-summary-by-config-rule.rst awscli-1.18.69/awscli/examples/configservice/get-compliance-summary-by-config-rule.rst --- awscli-1.11.13/awscli/examples/configservice/get-compliance-summary-by-config-rule.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/configservice/get-compliance-summary-by-config-rule.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,23 +1,23 @@ -**To get the compliance summary for your AWS Config rules** - -The following command returns the number of rules that are compliant and the number that are noncompliant:: - - aws configservice get-compliance-summary-by-config-rule - -In the output, the value for each ``CappedCount`` attribute indicates how many rules are compliant or noncompliant. - -Output:: - - { - "ComplianceSummary": { - "NonCompliantResourceCount": { - "CappedCount": 3, - "CapExceeded": false - }, - "ComplianceSummaryTimestamp": 1452204131.493, - "CompliantResourceCount": { - "CappedCount": 2, - "CapExceeded": false - } - } +**To get the compliance summary for your AWS Config rules** + +The following command returns the number of rules that are compliant and the number that are noncompliant:: + + aws configservice get-compliance-summary-by-config-rule + +In the output, the value for each ``CappedCount`` attribute indicates how many rules are compliant or noncompliant. + +Output:: + + { + "ComplianceSummary": { + "NonCompliantResourceCount": { + "CappedCount": 3, + "CapExceeded": false + }, + "ComplianceSummaryTimestamp": 1452204131.493, + "CompliantResourceCount": { + "CappedCount": 2, + "CapExceeded": false + } + } } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/configservice/get-compliance-summary-by-resource-type.rst awscli-1.18.69/awscli/examples/configservice/get-compliance-summary-by-resource-type.rst --- awscli-1.11.13/awscli/examples/configservice/get-compliance-summary-by-resource-type.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/configservice/get-compliance-summary-by-resource-type.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,56 +1,56 @@ -**To get the compliance summary for all resource types** - -The following command returns the number of AWS resources that are noncompliant and the number that are compliant:: - - aws configservice get-compliance-summary-by-resource-type - -In the output, the value for each ``CappedCount`` attribute indicates how many resources are compliant or noncompliant. - -Output:: - - { - "ComplianceSummariesByResourceType": [ - { - "ComplianceSummary": { - "NonCompliantResourceCount": { - "CappedCount": 16, - "CapExceeded": false - }, - "ComplianceSummaryTimestamp": 1453237464.543, - "CompliantResourceCount": { - "CappedCount": 10, - "CapExceeded": false - } - } - } - ] - } - -**To get the compliance summary for a specific resource type** - -The following command returns the number of EC2 instances that are noncompliant and the number that are compliant:: - - aws configservice get-compliance-summary-by-resource-type --resource-types AWS::EC2::Instance - -In the output, the value for each ``CappedCount`` attribute indicates how many resources are compliant or noncompliant. - -Output:: - - { - "ComplianceSummariesByResourceType": [ - { - "ResourceType": "AWS::EC2::Instance", - "ComplianceSummary": { - "NonCompliantResourceCount": { - "CappedCount": 3, - "CapExceeded": false - }, - "ComplianceSummaryTimestamp": 1452204923.518, - "CompliantResourceCount": { - "CappedCount": 7, - "CapExceeded": false - } - } - } - ] +**To get the compliance summary for all resource types** + +The following command returns the number of AWS resources that are noncompliant and the number that are compliant:: + + aws configservice get-compliance-summary-by-resource-type + +In the output, the value for each ``CappedCount`` attribute indicates how many resources are compliant or noncompliant. + +Output:: + + { + "ComplianceSummariesByResourceType": [ + { + "ComplianceSummary": { + "NonCompliantResourceCount": { + "CappedCount": 16, + "CapExceeded": false + }, + "ComplianceSummaryTimestamp": 1453237464.543, + "CompliantResourceCount": { + "CappedCount": 10, + "CapExceeded": false + } + } + } + ] + } + +**To get the compliance summary for a specific resource type** + +The following command returns the number of EC2 instances that are noncompliant and the number that are compliant:: + + aws configservice get-compliance-summary-by-resource-type --resource-types AWS::EC2::Instance + +In the output, the value for each ``CappedCount`` attribute indicates how many resources are compliant or noncompliant. + +Output:: + + { + "ComplianceSummariesByResourceType": [ + { + "ResourceType": "AWS::EC2::Instance", + "ComplianceSummary": { + "NonCompliantResourceCount": { + "CappedCount": 3, + "CapExceeded": false + }, + "ComplianceSummaryTimestamp": 1452204923.518, + "CompliantResourceCount": { + "CappedCount": 7, + "CapExceeded": false + } + } + } + ] } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/configservice/get-resource-config-history.rst awscli-1.18.69/awscli/examples/configservice/get-resource-config-history.rst --- awscli-1.11.13/awscli/examples/configservice/get-resource-config-history.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/configservice/get-resource-config-history.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,5 +1,5 @@ -**To get the configuration history of an AWS resource** - -The following command returns a list of configuration items for an EC2 instance with an ID of ``i-1a2b3c4d``:: - +**To get the configuration history of an AWS resource** + +The following command returns a list of configuration items for an EC2 instance with an ID of ``i-1a2b3c4d``:: + aws configservice get-resource-config-history --resource-type AWS::EC2::Instance --resource-id i-1a2b3c4d \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/configservice/get-status.rst awscli-1.18.69/awscli/examples/configservice/get-status.rst --- awscli-1.11.13/awscli/examples/configservice/get-status.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/configservice/get-status.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,20 +1,20 @@ -**To get the status for AWS Config** - -The following command returns the status of the delivery channel and configuration recorder:: - - aws configservice get-status - -Output:: - - Configuration Recorders: - - name: default - recorder: ON - last status: SUCCESS - - Delivery Channels: - - name: default - last stream delivery status: SUCCESS - last history delivery status: SUCCESS +**To get the status for AWS Config** + +The following command returns the status of the delivery channel and configuration recorder:: + + aws configservice get-status + +Output:: + + Configuration Recorders: + + name: default + recorder: ON + last status: SUCCESS + + Delivery Channels: + + name: default + last stream delivery status: SUCCESS + last history delivery status: SUCCESS last snapshot delivery status: SUCCESS \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/configservice/list-discovered-resources.rst awscli-1.18.69/awscli/examples/configservice/list-discovered-resources.rst --- awscli-1.11.13/awscli/examples/configservice/list-discovered-resources.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/configservice/list-discovered-resources.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,24 +1,24 @@ -**To list resources that AWS Config has discovered** - -The following command lists the EC2 instances that AWS Config has discovered:: - - aws configservice list-discovered-resources --resource-type AWS::EC2::Instance - -Output:: - - { - "resourceIdentifiers": [ - { - "resourceType": "AWS::EC2::Instance", - "resourceId": "i-1a2b3c4d" - }, - { - "resourceType": "AWS::EC2::Instance", - "resourceId": "i-2a2b3c4d" - }, - { - "resourceType": "AWS::EC2::Instance", - "resourceId": "i-3a2b3c4d" - } - ] +**To list resources that AWS Config has discovered** + +The following command lists the EC2 instances that AWS Config has discovered:: + + aws configservice list-discovered-resources --resource-type AWS::EC2::Instance + +Output:: + + { + "resourceIdentifiers": [ + { + "resourceType": "AWS::EC2::Instance", + "resourceId": "i-1a2b3c4d" + }, + { + "resourceType": "AWS::EC2::Instance", + "resourceId": "i-2a2b3c4d" + }, + { + "resourceType": "AWS::EC2::Instance", + "resourceId": "i-3a2b3c4d" + } + ] } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/configservice/put-config-rule.rst awscli-1.18.69/awscli/examples/configservice/put-config-rule.rst --- awscli-1.11.13/awscli/examples/configservice/put-config-rule.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/configservice/put-config-rule.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,64 +1,64 @@ -**To add an AWS managed Config rule** - -The following command provides JSON code to add an AWS managed Config rule:: - - aws configservice put-config-rule --config-rule file://RequiredTagsForEC2Instances.json - -``RequiredTagsForEC2Instances.json`` is a JSON file that contains the rule configuration:: - - { - "ConfigRuleName": "RequiredTagsForEC2Instances", - "Description": "Checks whether the CostCenter and Owner tags are applied to EC2 instances.", - "Scope": { - "ComplianceResourceTypes": [ - "AWS::EC2::Instance" - ] - }, - "Source": { - "Owner": "AWS", - "SourceIdentifier": "REQUIRED_TAGS" - }, - "InputParameters": "{\"tag1Key\":\"CostCenter\",\"tag2Key\":\"Owner\"}" - } - -For the ``ComplianceResourceTypes`` attribute, this JSON code limits the scope to resources of the ``AWS::EC2::Instance`` type, so AWS Config will evaluate only EC2 instances against the rule. Because the rule is a managed rule, the ``Owner`` attribute is set to ``AWS``, and the ``SourceIdentifier`` attribute is set to the rule identifier, ``REQUIRED_TAGS``. For the ``InputParameters`` attribute, the tag keys that the rule requires, ``CostCenter`` and ``Owner``, are specified. - -If the command succeeds, AWS Config returns no output. To verify the rule configuration, run the `describe-config-rules`__ command, and specify the rule name. - -.. __: http://docs.aws.amazon.com/cli/latest/reference/configservice/describe-config-rules.html - -**To add a customer managed Config rule** - -The following command provides JSON code to add a customer managed Config rule:: - - aws configservice put-config-rule --config-rule file://InstanceTypesAreT2micro.json - -``InstanceTypesAreT2micro.json`` is a JSON file that contains the rule configuration:: - - { - "ConfigRuleName": "InstanceTypesAreT2micro", - "Description": "Evaluates whether EC2 instances are the t2.micro type.", - "Scope": { - "ComplianceResourceTypes": [ - "AWS::EC2::Instance" - ] - }, - "Source": { - "Owner": "CUSTOM_LAMBDA", - "SourceIdentifier": "arn:aws:lambda:us-east-1:123456789012:function:InstanceTypeCheck", - "SourceDetails": [ - { - "EventSource": "aws.config", - "MessageType": "ConfigurationItemChangeNotification" - } - ] - }, - "InputParameters": "{\"desiredInstanceType\":\"t2.micro\"}" - } - -For the ``ComplianceResourceTypes`` attribute, this JSON code limits the scope to resources of the ``AWS::EC2::Instance`` type, so AWS Config will evaluate only EC2 instances against the rule. Because this rule is a customer managed rule, the ``Owner`` attribute is set to ``CUSTOM_LAMBDA``, and the ``SourceIdentifier`` attribute is set to the ARN of the AWS Lambda function. The ``SourceDetails`` object is required. The parameters that are specified for the ``InputParameters`` attribute are passed to the AWS Lambda function when AWS Config invokes it to evaluate resources against the rule. - -If the command succeeds, AWS Config returns no output. To verify the rule configuration, run the `describe-config-rules`__ command, and specify the rule name. - -.. __: http://docs.aws.amazon.com/cli/latest/reference/configservice/describe-config-rules.html - +**To add an AWS managed Config rule** + +The following command provides JSON code to add an AWS managed Config rule:: + + aws configservice put-config-rule --config-rule file://RequiredTagsForEC2Instances.json + +``RequiredTagsForEC2Instances.json`` is a JSON file that contains the rule configuration:: + + { + "ConfigRuleName": "RequiredTagsForEC2Instances", + "Description": "Checks whether the CostCenter and Owner tags are applied to EC2 instances.", + "Scope": { + "ComplianceResourceTypes": [ + "AWS::EC2::Instance" + ] + }, + "Source": { + "Owner": "AWS", + "SourceIdentifier": "REQUIRED_TAGS" + }, + "InputParameters": "{\"tag1Key\":\"CostCenter\",\"tag2Key\":\"Owner\"}" + } + +For the ``ComplianceResourceTypes`` attribute, this JSON code limits the scope to resources of the ``AWS::EC2::Instance`` type, so AWS Config will evaluate only EC2 instances against the rule. Because the rule is a managed rule, the ``Owner`` attribute is set to ``AWS``, and the ``SourceIdentifier`` attribute is set to the rule identifier, ``REQUIRED_TAGS``. For the ``InputParameters`` attribute, the tag keys that the rule requires, ``CostCenter`` and ``Owner``, are specified. + +If the command succeeds, AWS Config returns no output. To verify the rule configuration, run the `describe-config-rules`__ command, and specify the rule name. + +.. __: http://docs.aws.amazon.com/cli/latest/reference/configservice/describe-config-rules.html + +**To add a customer managed Config rule** + +The following command provides JSON code to add a customer managed Config rule:: + + aws configservice put-config-rule --config-rule file://InstanceTypesAreT2micro.json + +``InstanceTypesAreT2micro.json`` is a JSON file that contains the rule configuration:: + + { + "ConfigRuleName": "InstanceTypesAreT2micro", + "Description": "Evaluates whether EC2 instances are the t2.micro type.", + "Scope": { + "ComplianceResourceTypes": [ + "AWS::EC2::Instance" + ] + }, + "Source": { + "Owner": "CUSTOM_LAMBDA", + "SourceIdentifier": "arn:aws:lambda:us-east-1:123456789012:function:InstanceTypeCheck", + "SourceDetails": [ + { + "EventSource": "aws.config", + "MessageType": "ConfigurationItemChangeNotification" + } + ] + }, + "InputParameters": "{\"desiredInstanceType\":\"t2.micro\"}" + } + +For the ``ComplianceResourceTypes`` attribute, this JSON code limits the scope to resources of the ``AWS::EC2::Instance`` type, so AWS Config will evaluate only EC2 instances against the rule. Because this rule is a customer managed rule, the ``Owner`` attribute is set to ``CUSTOM_LAMBDA``, and the ``SourceIdentifier`` attribute is set to the ARN of the AWS Lambda function. The ``SourceDetails`` object is required. The parameters that are specified for the ``InputParameters`` attribute are passed to the AWS Lambda function when AWS Config invokes it to evaluate resources against the rule. + +If the command succeeds, AWS Config returns no output. To verify the rule configuration, run the `describe-config-rules`__ command, and specify the rule name. + +.. __: http://docs.aws.amazon.com/cli/latest/reference/configservice/describe-config-rules.html + diff -Nru awscli-1.11.13/awscli/examples/configservice/put-configuration-recorder.rst awscli-1.18.69/awscli/examples/configservice/put-configuration-recorder.rst --- awscli-1.11.13/awscli/examples/configservice/put-configuration-recorder.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/configservice/put-configuration-recorder.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,35 +1,35 @@ -**To record all supported resources** - -The following command creates a configuration recorder that tracks changes to all supported resource types, including global resource types:: - - aws configservice put-configuration-recorder --configuration-recorder name=default,roleARN=arn:aws:iam::123456789012:role/config-role --recording-group allSupported=true,includeGlobalResourceTypes=true - -**To record specific types of resources** - -The following command creates a configuration recorder that tracks changes to only those types of resources that are specified in the JSON file for the `--recording-group` option:: - - aws configservice put-configuration-recorder --configuration-recorder name=default,roleARN=arn:aws:iam::123456789012:role/config-role --recording-group file://recordingGroup.json - -`recordingGroup.json` is a JSON file that specifies the types of resources that AWS Config will record:: - - { - "allSupported": false, - "includeGlobalResourceTypes": false, - "resourceTypes": [ - "AWS::EC2::EIP", - "AWS::EC2::Instance", - "AWS::EC2::NetworkAcl", - "AWS::EC2::SecurityGroup", - "AWS::CloudTrail::Trail", - "AWS::EC2::Volume", - "AWS::EC2::VPC", - "AWS::IAM::User", - "AWS::IAM::Policy" - ] - } - -Before you can specify resource types for the `resourceTypes` key, you must set the `allSupported` and `includeGlobalResourceTypes` options to false or omit them. - -If the command succeeds, AWS Config returns no output. To verify the settings of your configuration recorder, run the `describe-configuration-recorders`__ command. - +**To record all supported resources** + +The following command creates a configuration recorder that tracks changes to all supported resource types, including global resource types:: + + aws configservice put-configuration-recorder --configuration-recorder name=default,roleARN=arn:aws:iam::123456789012:role/config-role --recording-group allSupported=true,includeGlobalResourceTypes=true + +**To record specific types of resources** + +The following command creates a configuration recorder that tracks changes to only those types of resources that are specified in the JSON file for the `--recording-group` option:: + + aws configservice put-configuration-recorder --configuration-recorder name=default,roleARN=arn:aws:iam::123456789012:role/config-role --recording-group file://recordingGroup.json + +`recordingGroup.json` is a JSON file that specifies the types of resources that AWS Config will record:: + + { + "allSupported": false, + "includeGlobalResourceTypes": false, + "resourceTypes": [ + "AWS::EC2::EIP", + "AWS::EC2::Instance", + "AWS::EC2::NetworkAcl", + "AWS::EC2::SecurityGroup", + "AWS::CloudTrail::Trail", + "AWS::EC2::Volume", + "AWS::EC2::VPC", + "AWS::IAM::User", + "AWS::IAM::Policy" + ] + } + +Before you can specify resource types for the `resourceTypes` key, you must set the `allSupported` and `includeGlobalResourceTypes` options to false or omit them. + +If the command succeeds, AWS Config returns no output. To verify the settings of your configuration recorder, run the `describe-configuration-recorders`__ command. + .. __: http://docs.aws.amazon.com/cli/latest/reference/configservice/describe-configuration-recorders.html \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/configservice/put-delivery-channel.rst awscli-1.18.69/awscli/examples/configservice/put-delivery-channel.rst --- awscli-1.11.13/awscli/examples/configservice/put-delivery-channel.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/configservice/put-delivery-channel.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,42 +1,42 @@ -**To create a delivery channel** - -The following command provides the settings for the delivery channel as JSON code:: - - aws configservice put-delivery-channel --delivery-channel file://deliveryChannel.json - -The ``deliveryChannel.json`` file specifies the delivery channel attributes:: - - { - "name": "default", - "s3BucketName": "config-bucket-123456789012", - "snsTopicARN": "arn:aws:sns:us-east-1:123456789012:config-topic", - "configSnapshotDeliveryProperties": { - "deliveryFrequency": "Twelve_Hours" - }, - } - -This example sets the following attributes: - -- ``name`` - The name of the delivery channel. By default, AWS Config assigns the name ``default`` to a new delivery channel. - - You cannot update the delivery channel name with the ``put-delivery-channel`` command. For the steps to change the name, see `Renaming the Delivery Channel`__. - - .. __: http://docs.aws.amazon.com/config/latest/developerguide/update-dc.html#update-dc-rename - -- ``s3BucketName`` - The name of the Amazon S3 bucket to which AWS Config delivers configuration snapshots and configuration history files. - - If you specify a bucket that belongs to another AWS account, that bucket must have policies that grant access permissions to AWS Config. For more information, see `Permissions for the Amazon S3 Bucket`__. - -.. __: http://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-policy.html - -- ``snsTopicARN`` - The Amazon Resource Name (ARN) of the Amazon SNS topic to which AWS Config sends notifications about configuration changes. - - If you choose a topic from another account, the topic must have policies that grant access permissions to AWS Config. For more information, see `Permissions for the Amazon SNS Topic`__. - -.. __: http://docs.aws.amazon.com/config/latest/developerguide/sns-topic-policy.html - -- ``configSnapshotDeliveryProperties`` - Contains the ``deliveryFrequency`` attribute, which sets how often AWS Config delivers configuration snapshots and how often it invokes evaluations for periodic Config rules. - -If the command succeeds, AWS Config returns no output. To verify the settings of your delivery channel, run the `describe-delivery-channels`__ command. - +**To create a delivery channel** + +The following command provides the settings for the delivery channel as JSON code:: + + aws configservice put-delivery-channel --delivery-channel file://deliveryChannel.json + +The ``deliveryChannel.json`` file specifies the delivery channel attributes:: + + { + "name": "default", + "s3BucketName": "config-bucket-123456789012", + "snsTopicARN": "arn:aws:sns:us-east-1:123456789012:config-topic", + "configSnapshotDeliveryProperties": { + "deliveryFrequency": "Twelve_Hours" + } + } + +This example sets the following attributes: + +- ``name`` - The name of the delivery channel. By default, AWS Config assigns the name ``default`` to a new delivery channel. + + You cannot update the delivery channel name with the ``put-delivery-channel`` command. For the steps to change the name, see `Renaming the Delivery Channel`__. + + .. __: http://docs.aws.amazon.com/config/latest/developerguide/update-dc.html#update-dc-rename + +- ``s3BucketName`` - The name of the Amazon S3 bucket to which AWS Config delivers configuration snapshots and configuration history files. + + If you specify a bucket that belongs to another AWS account, that bucket must have policies that grant access permissions to AWS Config. For more information, see `Permissions for the Amazon S3 Bucket`__. + +.. __: http://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-policy.html + +- ``snsTopicARN`` - The Amazon Resource Name (ARN) of the Amazon SNS topic to which AWS Config sends notifications about configuration changes. + + If you choose a topic from another account, the topic must have policies that grant access permissions to AWS Config. For more information, see `Permissions for the Amazon SNS Topic`__. + +.. __: http://docs.aws.amazon.com/config/latest/developerguide/sns-topic-policy.html + +- ``configSnapshotDeliveryProperties`` - Contains the ``deliveryFrequency`` attribute, which sets how often AWS Config delivers configuration snapshots and how often it invokes evaluations for periodic Config rules. + +If the command succeeds, AWS Config returns no output. To verify the settings of your delivery channel, run the `describe-delivery-channels`__ command. + .. __: http://docs.aws.amazon.com/cli/latest/reference/configservice/describe-delivery-channels.html \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/configservice/start-config-rules-evaluation.rst awscli-1.18.69/awscli/examples/configservice/start-config-rules-evaluation.rst --- awscli-1.11.13/awscli/examples/configservice/start-config-rules-evaluation.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/configservice/start-config-rules-evaluation.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,5 @@ +**To run an on-demand evaluation for AWS Config rules** + +The following command starts an evaluation for two AWS managed rules:: + + aws configservice start-config-rules-evaluation --config-rule-names s3-bucket-versioning-enabled cloudtrail-enabled \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/configservice/start-configuration-recorder.rst awscli-1.18.69/awscli/examples/configservice/start-configuration-recorder.rst --- awscli-1.11.13/awscli/examples/configservice/start-configuration-recorder.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/configservice/start-configuration-recorder.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,9 +1,9 @@ -**To start the configuration recorder** - -The following command starts the default configuration recorder:: - - aws configservice start-configuration-recorder --configuration-recorder-name default - -If the command succeeds, AWS Config returns no output. To verify that AWS Config is recording your resources, run the `get-status`__ command. - -.. __: http://docs.aws.amazon.com/cli/latest/reference/configservice/get-status.html \ No newline at end of file +**To start the configuration recorder** + +The following command starts the default configuration recorder:: + + aws configservice start-configuration-recorder --configuration-recorder-name default + +If the command succeeds, AWS Config returns no output. To verify that AWS Config is recording your resources, run the `get-status`__ command. + +.. __: http://docs.aws.amazon.com/cli/latest/reference/configservice/get-status.html diff -Nru awscli-1.11.13/awscli/examples/configservice/stop-configuration-recorder.rst awscli-1.18.69/awscli/examples/configservice/stop-configuration-recorder.rst --- awscli-1.11.13/awscli/examples/configservice/stop-configuration-recorder.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/configservice/stop-configuration-recorder.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,9 +1,9 @@ -**To stop the configuration recorder** - -The following command stops the default configuration recorder:: - - aws configservice stop-configuration-recorder --configuration-recorder-name default - -If the command succeeds, AWS Config returns no output. To verify that AWS Config is not recording your resources, run the `get-status`__ command. - +**To stop the configuration recorder** + +The following command stops the default configuration recorder:: + + aws configservice stop-configuration-recorder --configuration-recorder-name default + +If the command succeeds, AWS Config returns no output. To verify that AWS Config is not recording your resources, run the `get-status`__ command. + .. __: http://docs.aws.amazon.com/cli/latest/reference/configservice/get-status.html \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/configservice/subscribe.rst awscli-1.18.69/awscli/examples/configservice/subscribe.rst --- awscli-1.11.13/awscli/examples/configservice/subscribe.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/configservice/subscribe.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,31 +1,31 @@ -**To subscribe to AWS Config** - -The following command creates the default delivery channel and configuration recorder. The command also specifies the Amazon S3 bucket and Amazon SNS topic to which AWS Config will deliver configuration information:: - - aws configservice subscribe --s3-bucket config-bucket-123456789012 --sns-topic arn:aws:sns:us-east-1:123456789012:config-topic --iam-role arn:aws:iam::123456789012:role/ConfigRole-A1B2C3D4E5F6 - -Output:: - - Using existing S3 bucket: config-bucket-123456789012 - Using existing SNS topic: arn:aws:sns:us-east-1:123456789012:config-topic - Subscribe succeeded: - - Configuration Recorders: [ - { - "recordingGroup": { - "allSupported": true, - "resourceTypes": [], - "includeGlobalResourceTypes": false - }, - "roleARN": "arn:aws:iam::123456789012:role/ConfigRole-A1B2C3D4E5F6", - "name": "default" - } - ] - - Delivery Channels: [ - { - "snsTopicARN": "arn:aws:sns:us-east-1:123456789012:config-topic", - "name": "default", - "s3BucketName": "config-bucket-123456789012" - } +**To subscribe to AWS Config** + +The following command creates the default delivery channel and configuration recorder. The command also specifies the Amazon S3 bucket and Amazon SNS topic to which AWS Config will deliver configuration information:: + + aws configservice subscribe --s3-bucket config-bucket-123456789012 --sns-topic arn:aws:sns:us-east-1:123456789012:config-topic --iam-role arn:aws:iam::123456789012:role/ConfigRole-A1B2C3D4E5F6 + +Output:: + + Using existing S3 bucket: config-bucket-123456789012 + Using existing SNS topic: arn:aws:sns:us-east-1:123456789012:config-topic + Subscribe succeeded: + + Configuration Recorders: [ + { + "recordingGroup": { + "allSupported": true, + "resourceTypes": [], + "includeGlobalResourceTypes": false + }, + "roleARN": "arn:aws:iam::123456789012:role/ConfigRole-A1B2C3D4E5F6", + "name": "default" + } + ] + + Delivery Channels: [ + { + "snsTopicARN": "arn:aws:sns:us-east-1:123456789012:config-topic", + "name": "default", + "s3BucketName": "config-bucket-123456789012" + } ] \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/configure/add-model.rst awscli-1.18.69/awscli/examples/configure/add-model.rst --- awscli-1.11.13/awscli/examples/configure/add-model.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/configure/add-model.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**Add a model** + +The following command adds a service model from a file named ``service.json``:: + + aws configure add-model --service-model file://service.json + +Adding a model replaces existing commands for the service defined in the model. To leave existing commands as-is, specify a different service name to use for the new commands:: + + aws configure add-model --service-model file://service.json --service-name service2 diff -Nru awscli-1.11.13/awscli/examples/configure/_description.rst awscli-1.18.69/awscli/examples/configure/_description.rst --- awscli-1.11.13/awscli/examples/configure/_description.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/configure/_description.rst 2020-05-28 19:25:48.000000000 +0000 @@ -6,7 +6,7 @@ for you. To keep an existing value, hit enter when prompted for the value. When you are prompted for information, the current value will be displayed in ``[brackets]``. If the config item has no value, it be displayed as -``[None]``. Note that the ``configure`` command only work with values from the +``[None]``. Note that the ``configure`` command only works with values from the config file. It does not use any configuration values from environment variables or the IAM role. diff -Nru awscli-1.11.13/awscli/examples/configure/get/_examples.rst awscli-1.18.69/awscli/examples/configure/get/_examples.rst --- awscli-1.11.13/awscli/examples/configure/get/_examples.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/configure/get/_examples.rst 2020-05-28 19:25:48.000000000 +0000 @@ -24,7 +24,7 @@ testing_access_key $ aws configure get profile.testing.aws_access_key_id - default_access_key + testing_access_key $ aws configure get preview.cloudsearch true diff -Nru awscli-1.11.13/awscli/examples/connect/create-user.rst awscli-1.18.69/awscli/examples/connect/create-user.rst --- awscli-1.11.13/awscli/examples/connect/create-user.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/connect/create-user.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/connect/delete-user.rst awscli-1.18.69/awscli/examples/connect/delete-user.rst --- awscli-1.11.13/awscli/examples/connect/delete-user.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/connect/delete-user.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/connect/describe-user-hierarchy-group.rst awscli-1.18.69/awscli/examples/connect/describe-user-hierarchy-group.rst --- awscli-1.11.13/awscli/examples/connect/describe-user-hierarchy-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/connect/describe-user-hierarchy-group.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/connect/describe-user-hierarchy-structure.rst awscli-1.18.69/awscli/examples/connect/describe-user-hierarchy-structure.rst --- awscli-1.11.13/awscli/examples/connect/describe-user-hierarchy-structure.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/connect/describe-user-hierarchy-structure.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/connect/describe-user.rst awscli-1.18.69/awscli/examples/connect/describe-user.rst --- awscli-1.11.13/awscli/examples/connect/describe-user.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/connect/describe-user.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/connect/get-contact-attributes.rst awscli-1.18.69/awscli/examples/connect/get-contact-attributes.rst --- awscli-1.11.13/awscli/examples/connect/get-contact-attributes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/connect/get-contact-attributes.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/connect/list-contact-flows.rst awscli-1.18.69/awscli/examples/connect/list-contact-flows.rst --- awscli-1.11.13/awscli/examples/connect/list-contact-flows.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/connect/list-contact-flows.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/connect/list-hours-of-operations.rst awscli-1.18.69/awscli/examples/connect/list-hours-of-operations.rst --- awscli-1.11.13/awscli/examples/connect/list-hours-of-operations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/connect/list-hours-of-operations.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/connect/list-phone-numbers.rst awscli-1.18.69/awscli/examples/connect/list-phone-numbers.rst --- awscli-1.11.13/awscli/examples/connect/list-phone-numbers.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/connect/list-phone-numbers.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/connect/list-queues.rst awscli-1.18.69/awscli/examples/connect/list-queues.rst --- awscli-1.11.13/awscli/examples/connect/list-queues.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/connect/list-queues.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/connect/list-routing-profiles.rst awscli-1.18.69/awscli/examples/connect/list-routing-profiles.rst --- awscli-1.11.13/awscli/examples/connect/list-routing-profiles.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/connect/list-routing-profiles.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/connect/list-security-profiles.rst awscli-1.18.69/awscli/examples/connect/list-security-profiles.rst --- awscli-1.11.13/awscli/examples/connect/list-security-profiles.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/connect/list-security-profiles.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/connect/list-user-hierarchy-groups.rst awscli-1.18.69/awscli/examples/connect/list-user-hierarchy-groups.rst --- awscli-1.11.13/awscli/examples/connect/list-user-hierarchy-groups.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/connect/list-user-hierarchy-groups.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/connect/list-users.rst awscli-1.18.69/awscli/examples/connect/list-users.rst --- awscli-1.11.13/awscli/examples/connect/list-users.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/connect/list-users.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/connect/update-contact-attributes.rst awscli-1.18.69/awscli/examples/connect/update-contact-attributes.rst --- awscli-1.11.13/awscli/examples/connect/update-contact-attributes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/connect/update-contact-attributes.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/connect/update-user-hierarchy.rst awscli-1.18.69/awscli/examples/connect/update-user-hierarchy.rst --- awscli-1.11.13/awscli/examples/connect/update-user-hierarchy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/connect/update-user-hierarchy.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/connect/update-user-identity-info.rst awscli-1.18.69/awscli/examples/connect/update-user-identity-info.rst --- awscli-1.11.13/awscli/examples/connect/update-user-identity-info.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/connect/update-user-identity-info.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/connect/update-user-phone-config.rst awscli-1.18.69/awscli/examples/connect/update-user-phone-config.rst --- awscli-1.11.13/awscli/examples/connect/update-user-phone-config.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/connect/update-user-phone-config.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/connect/update-user-routing-profile.rst awscli-1.18.69/awscli/examples/connect/update-user-routing-profile.rst --- awscli-1.11.13/awscli/examples/connect/update-user-routing-profile.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/connect/update-user-routing-profile.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/connect/update-user-security-profiles.rst awscli-1.18.69/awscli/examples/connect/update-user-security-profiles.rst --- awscli-1.11.13/awscli/examples/connect/update-user-security-profiles.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/connect/update-user-security-profiles.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/cur/delete-report-definition.rst awscli-1.18.69/awscli/examples/cur/delete-report-definition.rst --- awscli-1.11.13/awscli/examples/cur/delete-report-definition.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cur/delete-report-definition.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,7 @@ +**To delete an AWS Cost and Usage Report** + +This example deletes an AWS Cost and Usage Report. + +Command:: + + aws cur --region us-east-1 delete-report-definition --report-name "ExampleReport" diff -Nru awscli-1.11.13/awscli/examples/cur/describe-report-definitions.rst awscli-1.18.69/awscli/examples/cur/describe-report-definitions.rst --- awscli-1.11.13/awscli/examples/cur/describe-report-definitions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cur/describe-report-definitions.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,30 @@ +**To retrieve a list of AWS Cost and Usage Reports** + +This example describes a list of AWS Cost and Usage Reports owned by an account. + +Command:: + + aws cur --region us-east-1 describe-report-definitions --max-items 5 + +Output:: + + { + "ReportDefinitions": [ + { + "ReportName": "ExampleReport", + "Compression": "ZIP", + "S3Region": "us-east-1", + "Format": "textORcsv", + "S3Prefix": "exampleprefix", + "S3Bucket": "example-s3-bucket", + "TimeUnit": "DAILY", + "AdditionalArtifacts": [ + "REDSHIFT", + "QUICKSIGHT" + ], + "AdditionalSchemaElements": [ + "RESOURCES" + ] + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/cur/put-report-definition.rst awscli-1.18.69/awscli/examples/cur/put-report-definition.rst --- awscli-1.11.13/awscli/examples/cur/put-report-definition.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/cur/put-report-definition.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,25 @@ +**To create an AWS Cost and Usage Reports** + +The following ``put-report-definition`` example creates a daily AWS Cost and Usage Report that you can upload into Amazon Redshift or Amazon QuickSight. :: + + aws cur put-report-definition --report-definition file://report-definition.json + +Contents of ``report-definition.json``:: + + { + "ReportName": "ExampleReport", + "TimeUnit": "DAILY", + "Format": "textORcsv", + "Compression": "ZIP", + "AdditionalSchemaElements": [ + "RESOURCES" + ], + "S3Bucket": "example-s3-bucket", + "S3Prefix": "exampleprefix", + "S3Region": "us-east-1", + "AdditionalArtifacts": [ + "REDSHIFT", + "QUICKSIGHT" + ] + } + diff -Nru awscli-1.11.13/awscli/examples/datapipeline/list-runs.rst awscli-1.18.69/awscli/examples/datapipeline/list-runs.rst --- awscli-1.11.13/awscli/examples/datapipeline/list-runs.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/datapipeline/list-runs.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,17 +1,20 @@ -**To list your pipeline runs** +**Example 1: To list your pipeline runs** -This example lists the runs for the specified pipeline:: +The following ``list-runs`` example lists the runs for the specified pipeline. :: - aws datapipeline list-runs --pipeline-id df-00627471SOVYZEXAMPLE - -The following is example output:: + aws datapipeline list-runs --pipeline-id df-00627471SOVYZEXAMPLE - Name Scheduled Start Status ID Started Ended - ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- - 1. EC2ResourceObj 2015-04-12T17:33:02 CREATING @EC2ResourceObj_2015-04-12T17:33:02 2015-04-12T17:33:10 +Output:: - 2. S3InputLocation 2015-04-12T17:33:02 FINISHED @S3InputLocation_2015-04-12T17:33:02 2015-04-12T17:33:09 2015-04-12T17:33:09 + Name Scheduled Start Status ID Started Ended + ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + 1. EC2ResourceObj 2015-04-12T17:33:02 CREATING @EC2ResourceObj_2015-04-12T17:33:02 2015-04-12T17:33:10 + 2. S3InputLocation 2015-04-12T17:33:02 FINISHED @S3InputLocation_2015-04-12T17:33:02 2015-04-12T17:33:09 2015-04-12T17:33:09 + 3. S3OutputLocation 2015-04-12T17:33:02 WAITING_ON_DEPENDENCIES @S3OutputLocation_2015-04-12T17:33:02 2015-04-12T17:33:09 + 4. ShellCommandActivityObj 2015-04-12T17:33:02 WAITING_FOR_RUNNER @ShellCommandActivityObj_2015-04-12T17:33:02 2015-04-12T17:33:09 - 3. S3OutputLocation 2015-04-12T17:33:02 WAITING_ON_DEPENDENCIES @S3OutputLocation_2015-04-12T17:33:02 2015-04-12T17:33:09 +**Example 2: To list the pipeline runs between the specified dates** - 4. ShellCommandActivityObj 2015-04-12T17:33:02 WAITING_FOR_RUNNER @ShellCommandActivityObj_2015-04-12T17:33:02 2015-04-12T17:33:09 +The following ``list-runs`` example uses the ``--start-interval`` to specify the dates to include in the output. :: + + aws datapipeline list-runs --pipeline-id df-01434553B58A2SHZUKO5 --start-interval 2017-10-07T00:00:00,2017-10-08T00:00:00 diff -Nru awscli-1.11.13/awscli/examples/dax/create-cluster.rst awscli-1.18.69/awscli/examples/dax/create-cluster.rst --- awscli-1.11.13/awscli/examples/dax/create-cluster.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dax/create-cluster.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dax/create-parameter-group.rst awscli-1.18.69/awscli/examples/dax/create-parameter-group.rst --- awscli-1.11.13/awscli/examples/dax/create-parameter-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dax/create-parameter-group.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dax/create-subnet-group.rst awscli-1.18.69/awscli/examples/dax/create-subnet-group.rst --- awscli-1.11.13/awscli/examples/dax/create-subnet-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dax/create-subnet-group.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dax/decrease-replication-factor.rst awscli-1.18.69/awscli/examples/dax/decrease-replication-factor.rst --- awscli-1.11.13/awscli/examples/dax/decrease-replication-factor.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dax/decrease-replication-factor.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dax/delete-cluster.rst awscli-1.18.69/awscli/examples/dax/delete-cluster.rst --- awscli-1.11.13/awscli/examples/dax/delete-cluster.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dax/delete-cluster.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dax/delete-parameter-group.rst awscli-1.18.69/awscli/examples/dax/delete-parameter-group.rst --- awscli-1.11.13/awscli/examples/dax/delete-parameter-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dax/delete-parameter-group.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dax/delete-subnet-group.rst awscli-1.18.69/awscli/examples/dax/delete-subnet-group.rst --- awscli-1.11.13/awscli/examples/dax/delete-subnet-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dax/delete-subnet-group.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dax/describe-clusters.rst awscli-1.18.69/awscli/examples/dax/describe-clusters.rst --- awscli-1.11.13/awscli/examples/dax/describe-clusters.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dax/describe-clusters.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dax/describe-default-parameters.rst awscli-1.18.69/awscli/examples/dax/describe-default-parameters.rst --- awscli-1.11.13/awscli/examples/dax/describe-default-parameters.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dax/describe-default-parameters.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dax/describe-events.rst awscli-1.18.69/awscli/examples/dax/describe-events.rst --- awscli-1.11.13/awscli/examples/dax/describe-events.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dax/describe-events.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dax/describe-parameter-groups.rst awscli-1.18.69/awscli/examples/dax/describe-parameter-groups.rst --- awscli-1.11.13/awscli/examples/dax/describe-parameter-groups.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dax/describe-parameter-groups.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dax/describe-parameters.rst awscli-1.18.69/awscli/examples/dax/describe-parameters.rst --- awscli-1.11.13/awscli/examples/dax/describe-parameters.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dax/describe-parameters.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dax/describe-subnet-groups.rst awscli-1.18.69/awscli/examples/dax/describe-subnet-groups.rst --- awscli-1.11.13/awscli/examples/dax/describe-subnet-groups.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dax/describe-subnet-groups.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dax/increase-replication-factor.rst awscli-1.18.69/awscli/examples/dax/increase-replication-factor.rst --- awscli-1.11.13/awscli/examples/dax/increase-replication-factor.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dax/increase-replication-factor.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dax/list-tags.rst awscli-1.18.69/awscli/examples/dax/list-tags.rst --- awscli-1.11.13/awscli/examples/dax/list-tags.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dax/list-tags.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dax/tag-resource.rst awscli-1.18.69/awscli/examples/dax/tag-resource.rst --- awscli-1.11.13/awscli/examples/dax/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dax/tag-resource.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dax/untag-resource.rst awscli-1.18.69/awscli/examples/dax/untag-resource.rst --- awscli-1.11.13/awscli/examples/dax/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dax/untag-resource.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/deploy/add-tags-to-on-premises-instances.rst awscli-1.18.69/awscli/examples/deploy/add-tags-to-on-premises-instances.rst --- awscli-1.11.13/awscli/examples/deploy/add-tags-to-on-premises-instances.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/add-tags-to-on-premises-instances.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,11 +1,9 @@ **To add tags to on-premises instances** -This example associates in AWS CodeDeploy the same on-premises instance tag to two on-premises instances. It does not register the on-premises instances with AWS CodeDeploy. +The follwoing ``add-tags-to-on-premises-instances`` example associates in AWS CodeDeploy the same on-premises instance tag to two on-premises instances. It does not register the on-premises instances with AWS CodeDeploy. :: -Command:: + aws deploy add-tags-to-on-premises-instances \ + --instance-names AssetTag12010298EX AssetTag23121309EX \ + --tags Key=Name,Value=CodeDeployDemo-OnPrem - aws deploy add-tags-to-on-premises-instances --instance-names AssetTag12010298EX AssetTag23121309EX --tags Key=Name,Value=CodeDeployDemo-OnPrem - -Output:: - - This command produces no output. \ No newline at end of file +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/deploy/batch-get-application-revisions.rst awscli-1.18.69/awscli/examples/deploy/batch-get-application-revisions.rst --- awscli-1.11.13/awscli/examples/deploy/batch-get-application-revisions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/batch-get-application-revisions.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,34 @@ +**To retrieve information about application revisions** + +The following ``batch-get-application-revisions`` example retrieves information about the specified revision stored in a GitHub repository. :: + + aws deploy batch-get-application-revisions \ + --application-name my-codedeploy-application \ + --revisions "[{\"gitHubLocation\": {\"commitId\": \"fa85936EXAMPLEa31736c051f10d77297EXAMPLE\",\"repository\": \"my-github-token/my-repository\"},\"revisionType\": \"GitHub\"}]" + +Output:: + + { + "revisions": [ + { + "genericRevisionInfo": { + "description": "Application revision registered by Deployment ID: d-A1B2C3111", + "lastUsedTime": 1556912355.884, + "registerTime": 1556912355.884, + "firstUsedTime": 1556912355.884, + "deploymentGroups": [] + }, + "revisionLocation": { + "revisionType": "GitHub", + "gitHubLocation": { + "commitId": "fa85936EXAMPLEa31736c051f10d77297EXAMPLE", + "repository": "my-github-token/my-repository" + } + } + } + ], + "applicationName": "my-codedeploy-application", + "errorMessage": "" + } + +For more information, see `BatchGetApplicationRevisions `_ in the *AWS CodeDeploy API Reference*. diff -Nru awscli-1.11.13/awscli/examples/deploy/batch-get-applications.rst awscli-1.18.69/awscli/examples/deploy/batch-get-applications.rst --- awscli-1.11.13/awscli/examples/deploy/batch-get-applications.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/batch-get-applications.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,26 +1,24 @@ **To get information about multiple applications** -This example displays information about multiple applications that are associated with the user's AWS account. +The following ``batch-get-applications`` example displays information about multiple applications that are associated with the user's AWS account. :: -Command:: - - aws deploy batch-get-applications --application-names WordPress_App MyOther_App + aws deploy batch-get-applications --application-names WordPress_App MyOther_App Output:: - { - "applicationsInfo": [ - { - "applicationName": "WordPress_App", - "applicationId": "d9dd6993-f171-44fa-a811-211e4EXAMPLE", - "createTime": 1407878168.078, - "linkedToGitHub": false - }, - { - "applicationName": "MyOther_App", - "applicationId": "8ca57519-31da-42b2-9194-8bb16EXAMPLE", - "createTime": 1407453571.63, - "linkedToGitHub": false - } - ] - } \ No newline at end of file + { + "applicationsInfo": [ + { + "applicationName": "WordPress_App", + "applicationId": "d9dd6993-f171-44fa-a811-211e4EXAMPLE", + "createTime": 1407878168.078, + "linkedToGitHub": false + }, + { + "applicationName": "MyOther_App", + "applicationId": "8ca57519-31da-42b2-9194-8bb16EXAMPLE", + "createTime": 1407453571.63, + "linkedToGitHub": false + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/deploy/batch-get-deployment-groups.rst awscli-1.18.69/awscli/examples/deploy/batch-get-deployment-groups.rst --- awscli-1.11.13/awscli/examples/deploy/batch-get-deployment-groups.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/batch-get-deployment-groups.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,86 @@ +**To retrieve information about one or more deployment groups** + +The following ``batch-get-deployment-groups`` example retrieves information about two of the deployment groups that are associated with the specified CodeDeploy application. :: + + aws deploy batch-get-deployment-groups \ + --application-name my-codedeploy-application \ + --deployment-group-names "[\"my-deployment-group-1\",\"my-deployment-group-2\"]" + +Output:: + + { + "deploymentGroupsInfo": [ + { + "deploymentStyle": { + "deploymentOption": "WITHOUT_TRAFFIC_CONTROL", + "deploymentType": "IN_PLACE" + }, + "autoRollbackConfiguration": { + "enabled": false + }, + "onPremisesTagSet": { + "onPremisesTagSetList": [] + }, + "serviceRoleArn": "arn:aws:iam::123456789012:role/CodeDeloyServiceRole", + "lastAttemptedDeployment": { + "endTime": 1556912366.415, + "status": "Failed", + "createTime": 1556912355.884, + "deploymentId": "d-A1B2C3111" + }, + "autoScalingGroups": [], + "deploymentGroupName": "my-deployment-group-1", + "ec2TagSet": { + "ec2TagSetList": [ + [ + { + "Type": "KEY_AND_VALUE", + "Value": "my-EC2-instance", + "Key": "Name" + } + ] + ] + }, + "deploymentGroupId": "a1b2c3d4-5678-90ab-cdef-11111example", + "triggerConfigurations": [], + "applicationName": "my-codedeploy-application", + "computePlatform": "Server", + "deploymentConfigName": "CodeDeployDefault.AllAtOnce" + }, + { + "deploymentStyle": { + "deploymentOption": "WITHOUT_TRAFFIC_CONTROL", + "deploymentType": "IN_PLACE" + }, + "autoRollbackConfiguration": { + "enabled": false + }, + "onPremisesTagSet": { + "onPremisesTagSetList": [] + }, + "serviceRoleArn": "arn:aws:iam::123456789012:role/CodeDeloyServiceRole", + "autoScalingGroups": [], + "deploymentGroupName": "my-deployment-group-2", + "ec2TagSet": { + "ec2TagSetList": [ + [ + { + "Type": "KEY_AND_VALUE", + "Value": "my-EC2-instance", + "Key": "Name" + } + ] + ] + }, + "deploymentGroupId": "a1b2c3d4-5678-90ab-cdef-22222example", + "triggerConfigurations": [], + "applicationName": "my-codedeploy-application", + "computePlatform": "Server", + "deploymentConfigName": "CodeDeployDefault.AllAtOnce" + } + ], + "errorMessage": "" + } + +For more information, see `BatchGetDeploymentGroups `_ in the *AWS CodeDeploy API Reference*. + \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/deploy/batch-get-deployments.rst awscli-1.18.69/awscli/examples/deploy/batch-get-deployments.rst --- awscli-1.11.13/awscli/examples/deploy/batch-get-deployments.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/batch-get-deployments.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,70 +1,68 @@ **To get information about multiple deployments** -This example displays information about multiple deployments that are associated with the user's AWS account. +The following ``batch-get-deployments`` example displays information about multiple deployments that are associated with the user's AWS account. :: -Command:: - - aws deploy batch-get-deployments --deployment-ids d-USUAELQEX d-QA4G4F9EX + aws deploy batch-get-deployments --deployment-ids d-A1B2C3111 d-A1B2C3222 Output:: - { - "deploymentsInfo": [ - { - "applicationName": "WordPress_App", - "status": "Failed", - "deploymentOverview": { - "Failed": 0, - "InProgress": 0, - "Skipped": 0, - "Succeeded": 1, - "Pending": 0 - }, - "deploymentConfigName": "CodeDeployDefault.OneAtATime", - "creator": "user", - "deploymentGroupName": "WordPress_DG", - "revision": { - "revisionType": "S3", - "s3Location": { - "bundleType": "zip", - "version": "uTecLusvCB_JqHFXtfUcyfV8bEXAMPLE", - "bucket": "CodeDeployDemoBucket", - "key": "WordPressApp.zip" - } - }, - "deploymentId": "d-QA4G4F9EX", - "createTime": 1408480721.9, - "completeTime": 1408480741.822 - }, - { - "applicationName": "MyOther_App", - "status": "Failed", - "deploymentOverview": { - "Failed": 1, - "InProgress": 0, - "Skipped": 0, - "Succeeded": 0, - "Pending": 0 - }, - "deploymentConfigName": "CodeDeployDefault.OneAtATime", - "creator": "user", - "errorInformation": { - "message": "Deployment failed: Constraint default violated: No hosts succeeded.", - "code": "HEALTH_CONSTRAINTS" - }, - "deploymentGroupName": "MyOther_DG", - "revision": { - "revisionType": "S3", - "s3Location": { - "bundleType": "zip", - "eTag": "\"dd56cfd59d434b8e768f9d77fEXAMPLE\"", - "bucket": "CodeDeployDemoBucket", - "key": "MyOtherApp.zip" - } - }, - "deploymentId": "d-USUAELQEX", - "createTime": 1409764576.589, - "completeTime": 1409764596.101 - } - ] - } + { + "deploymentsInfo": [ + { + "applicationName": "WordPress_App", + "status": "Failed", + "deploymentOverview": { + "Failed": 0, + "InProgress": 0, + "Skipped": 0, + "Succeeded": 1, + "Pending": 0 + }, + "deploymentConfigName": "CodeDeployDefault.OneAtATime", + "creator": "user", + "deploymentGroupName": "WordPress_DG", + "revision": { + "revisionType": "S3", + "s3Location": { + "bundleType": "zip", + "version": "uTecLusEXAMPLEFXtfUcyfV8bEXAMPLE", + "bucket": "CodeDeployDemoBucket", + "key": "WordPressApp.zip" + } + }, + "deploymentId": "d-A1B2C3111", + "createTime": 1408480721.9, + "completeTime": 1408480741.822 + }, + { + "applicationName": "MyOther_App", + "status": "Failed", + "deploymentOverview": { + "Failed": 1, + "InProgress": 0, + "Skipped": 0, + "Succeeded": 0, + "Pending": 0 + }, + "deploymentConfigName": "CodeDeployDefault.OneAtATime", + "creator": "user", + "errorInformation": { + "message": "Deployment failed: Constraint default violated: No hosts succeeded.", + "code": "HEALTH_CONSTRAINTS" + }, + "deploymentGroupName": "MyOther_DG", + "revision": { + "revisionType": "S3", + "s3Location": { + "bundleType": "zip", + "eTag": "\"dd56cfdEXAMPLE8e768f9d77fEXAMPLE\"", + "bucket": "CodeDeployDemoBucket", + "key": "MyOtherApp.zip" + } + }, + "deploymentId": "d-A1B2C3222", + "createTime": 1409764576.589, + "completeTime": 1409764596.101 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/deploy/batch-get-deployment-targets.rst awscli-1.18.69/awscli/examples/deploy/batch-get-deployment-targets.rst --- awscli-1.11.13/awscli/examples/deploy/batch-get-deployment-targets.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/batch-get-deployment-targets.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,64 @@ +**To retrieve the targets associated with a deployment** + +The following ``batch-get-deployment-targets`` example returns information about one of the targets associated with the specified deployment. :: + + aws deploy batch-get-deployment-targets \ + --deployment-id "d-1A2B3C4D5" \ + --target-ids "i-01a2b3c4d5e6f1111" + +Output:: + + { + "deploymentTargets": [ + { + "deploymentTargetType": "InstanceTarget", + "instanceTarget": { + "lifecycleEvents": [ + { + "startTime": 1556918592.162, + "lifecycleEventName": "ApplicationStop", + "status": "Succeeded", + "endTime": 1556918592.247, + "diagnostics": { + "scriptName": "", + "errorCode": "Success", + "logTail": "", + "message": "Succeeded" + } + }, + { + "startTime": 1556918593.193, + "lifecycleEventName": "DownloadBundle", + "status": "Succeeded", + "endTime": 1556918593.981, + "diagnostics": { + "scriptName": "", + "errorCode": "Success", + "logTail": "", + "message": "Succeeded" + } + }, + { + "startTime": 1556918594.805, + "lifecycleEventName": "BeforeInstall", + "status": "Succeeded", + "endTime": 1556918681.807, + "diagnostics": { + "scriptName": "", + "errorCode": "Success", + "logTail": "", + "message": "Succeeded" + } + } + ], + "targetArn": "arn:aws:ec2:us-west-2:123456789012:instance/i-01a2b3c4d5e6f1111", + "deploymentId": "d-1A2B3C4D5", + "lastUpdatedAt": 1556918687.504, + "targetId": "i-01a2b3c4d5e6f1111", + "status": "Succeeded" + } + } + ] + } + +For more information, see `BatchGetDeploymentTargets `_ in the *AWS CodeDeploy API Reference*. diff -Nru awscli-1.11.13/awscli/examples/deploy/batch-get-on-premises-instances.rst awscli-1.18.69/awscli/examples/deploy/batch-get-on-premises-instances.rst --- awscli-1.11.13/awscli/examples/deploy/batch-get-on-premises-instances.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/batch-get-on-premises-instances.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,38 +1,36 @@ **To get information about one or more on-premises instances** -This example gets information about two on-premises instances. +The follwoing ``batch-get-on-premises-instances`` example gets information about two on-premises instances. :: -Command:: - - aws deploy batch-get-on-premises-instances --instance-names AssetTag12010298EX AssetTag23121309EX + aws deploy batch-get-on-premises-instances --instance-names AssetTag12010298EX AssetTag23121309EX Output:: - { - "instanceInfos": [ - { - "iamUserArn": "arn:aws:iam::80398EXAMPLE:user/AWS/CodeDeploy/AssetTag12010298EX", - "tags": [ - { - "Value": "CodeDeployDemo-OnPrem", - "Key": "Name" - } - ], - "instanceName": "AssetTag12010298EX", - "registerTime": 1425579465.228, - "instanceArn": "arn:aws:codedeploy:us-west-2:80398EXAMPLE:instance/AssetTag12010298EX_4IwLNI2Alh" - }, - { - "iamUserArn": "arn:aws:iam::80398EXAMPLE:user/AWS/CodeDeploy/AssetTag23121309EX", - "tags": [ - { - "Value": "CodeDeployDemo-OnPrem", - "Key": "Name" - } - ], - "instanceName": "AssetTag23121309EX", - "registerTime": 1425595585.988, - "instanceArn": "arn:aws:codedeploy:us-west-2:80398EXAMPLE:instance/AssetTag23121309EX_PomUy64Was" - } - ] - } \ No newline at end of file + { + "instanceInfos": [ + { + "iamUserArn": "arn:aws:iam::123456789012:user/AWS/CodeDeploy/AssetTag12010298EX", + "tags": [ + { + "Value": "CodeDeployDemo-OnPrem", + "Key": "Name" + } + ], + "instanceName": "AssetTag12010298EX", + "registerTime": 1425579465.228, + "instanceArn": "arn:aws:codedeploy:us-west-2:123456789012:instance/AssetTag12010298EX_4IwLNI2Alh" + }, + { + "iamUserArn": "arn:aws:iam::123456789012:user/AWS/CodeDeploy/AssetTag23121309EX", + "tags": [ + { + "Value": "CodeDeployDemo-OnPrem", + "Key": "Name" + } + ], + "instanceName": "AssetTag23121309EX", + "registerTime": 1425595585.988, + "instanceArn": "arn:aws:codedeploy:us-west-2:80398EXAMPLE:instance/AssetTag23121309EX_PomUy64Was" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/deploy/continue-deployment.rst awscli-1.18.69/awscli/examples/deploy/continue-deployment.rst --- awscli-1.11.13/awscli/examples/deploy/continue-deployment.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/continue-deployment.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To start rerouting traffic without waiting for a specified wait time to elapse.** + +The following ``continue-deployment`` example starts rerouting traffic from instances in the original environment that are ready to start shifting traffic to instances in the replacement environment. :: + + aws deploy continue-deployment \ + --deployment-d "d-A1B2C3111" \ + --deployment-wait-type "READY_WAIT" + +This command produces no output. + +For more information, see `ContinueDeployment `_ in the *AWS CodeDeploy API Reference*. diff -Nru awscli-1.11.13/awscli/examples/deploy/create-application.rst awscli-1.18.69/awscli/examples/deploy/create-application.rst --- awscli-1.11.13/awscli/examples/deploy/create-application.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/create-application.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,13 +1,11 @@ **To create an application** -This example creates an application and associates it with the user's AWS account. +The following ``create-application`` example creates an application and associates it with the user's AWS account. :: -Command:: + aws deploy create-application --application-name MyOther_App - aws deploy create-application --application-name MyOther_App - Output:: - { - "applicationId": "cfd3e1f1-5744-4aee-9251-eaa25EXAMPLE" - } \ No newline at end of file + { + "applicationId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" + } diff -Nru awscli-1.11.13/awscli/examples/deploy/create-deployment-config.rst awscli-1.18.69/awscli/examples/deploy/create-deployment-config.rst --- awscli-1.11.13/awscli/examples/deploy/create-deployment-config.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/create-deployment-config.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,13 +1,13 @@ **To create a custom deployment configuration** -This example creates a custom deployment configuration and associates it with the user's AWS account. +The following ``create-deployment-config`` example creates a custom deployment configuration and associates it with the user's AWS account. :: -Command:: - - aws deploy create-deployment-config --deployment-config-name ThreeQuartersHealthy --minimum-healthy-hosts type=FLEET_PERCENT,value=75 + aws deploy create-deployment-config \ + --deployment-config-name ThreeQuartersHealthy \ + --minimum-healthy-hosts type=FLEET_PERCENT,value=75 Output:: - { - "deploymentConfigId": "bf6b390b-61d3-4f24-8911-a1664EXAMPLE" - } \ No newline at end of file + { + "deploymentConfigId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/deploy/create-deployment-group.rst awscli-1.18.69/awscli/examples/deploy/create-deployment-group.rst --- awscli-1.11.13/awscli/examples/deploy/create-deployment-group.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/create-deployment-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,13 +1,17 @@ **To create a deployment group** -This example creates a deployment group and associates it with the specified application and the user's AWS account. +The following ``create-deployment-group`` example creates a deployment group and associates it with the specified application and the user's AWS account. :: -Command:: - - aws deploy create-deployment-group --application-name WordPress_App --auto-scaling-groups CodeDeployDemo-ASG --deployment-config-name CodeDeployDefault.OneAtATime --deployment-group-name WordPress_DG --ec2-tag-filters Key=Name,Value=CodeDeployDemo,Type=KEY_AND_VALUE --service-role-arn arn:aws:iam::80398EXAMPLE:role/CodeDeployDemoRole + aws deploy create-deployment-group \ + --application-name WordPress_App \ + --auto-scaling-groups CodeDeployDemo-ASG \ + --deployment-config-name CodeDeployDefault.OneAtATime \ + --deployment-group-name WordPress_DG \ + --ec2-tag-filters Key=Name,Value=CodeDeployDemo,Type=KEY_AND_VALUE \ + --service-role-arn arn:aws:iam::123456789012:role/CodeDeployDemoRole Output:: - { - "deploymentGroupId": "cdac3220-0e64-4d63-bb50-e68faEXAMPLE" - } \ No newline at end of file + { + "deploymentGroupId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" + } diff -Nru awscli-1.11.13/awscli/examples/deploy/create-deployment.rst awscli-1.18.69/awscli/examples/deploy/create-deployment.rst --- awscli-1.11.13/awscli/examples/deploy/create-deployment.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/create-deployment.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,13 +1,62 @@ -**To create a deployment** +**Example 1: To create a CodeDeploy deployment using the EC2/On-premises compute platform** -This example creates a deployment and associates it with the user's AWS account. +The following ``create-deployment`` example creates a deployment and associates it with the user's AWS account. :: + + aws deploy create-deployment \ + --application-name WordPress_App \ + --deployment-config-name CodeDeployDefault.OneAtATime \ + --deployment-group-name WordPress_DG \ + --description "My demo deployment" \ + --s3-location bucket=CodeDeployDemoBucket,bundleType=zip,eTag=dd56cfdEXAMPLE8e768f9d77fEXAMPLE,key=WordPressApp.zip + +Output:: + + { + "deploymentId": "d-A1B2C3111" + } + +**Example 2: To create a CodeDeploy deployment using the Amazon ECS compute platform** + +The following ``create-deployment`` example uses the following two files to deploy an Amazon ECS service. + +Contents of ``create-deployment.json`` file:: + + { + "applicationName": "ecs-deployment", + "deploymentGroupName": "ecs-deployment-dg", + "revision": { + "revisionType": "S3", + "s3Location": { + "bucket": "ecs-deployment-bucket", + "key": "appspec.yaml", + "bundleType": "YAML" + } + } + } + +That file, in turn, retrieves the following file ``appspec.yaml`` from an S3 bucket called ``ecs-deployment-bucket``. :: + + version: 0.0 + Resources: + - TargetService: + Type: AWS::ECS::Service + Properties: + TaskDefinition: "arn:aws:ecs:region:123456789012:task-definition/ecs-task-def:2" + LoadBalancerInfo: + ContainerName: "sample-app" + ContainerPort: 80 + PlatformVersion: "LATEST" Command:: - aws deploy create-deployment --application-name WordPress_App --deployment-config-name CodeDeployDefault.OneAtATime --deployment-group-name WordPress_DG --description "My demo deployment" --s3-location bucket=CodeDeployDemoBucket,bundleType=zip,eTag=dd56cfd59d434b8e768f9d77fEXAMPLE,key=WordPressApp.zip + aws deploy create-deployment \ + --cli-input-json file://create-deployment.json \ + --region us-east-1 Output:: - { - "deploymentId": "d-N65YI7Gex" - } \ No newline at end of file + { + "deploymentId": "d-1234ABCDE" + } + +For more information, see `CreateDeployment `__ in the *AWS CodeDeploy API Reference*. diff -Nru awscli-1.11.13/awscli/examples/deploy/delete-application.rst awscli-1.18.69/awscli/examples/deploy/delete-application.rst --- awscli-1.11.13/awscli/examples/deploy/delete-application.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/delete-application.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,11 +1,7 @@ **To delete an application** -This example deletes an application that is associated with the user's AWS account. +The following ``delete-application`` example deletes the specified application that is associated with the user's AWS account. :: -Command:: + aws deploy delete-application --application-name WordPress_App - aws deploy delete-application --application-name WordPress_App - -Output:: - - None. \ No newline at end of file +This command produces no output. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/deploy/delete-deployment-config.rst awscli-1.18.69/awscli/examples/deploy/delete-deployment-config.rst --- awscli-1.11.13/awscli/examples/deploy/delete-deployment-config.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/delete-deployment-config.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,11 +1,7 @@ **To delete a deployment configuration** -This example deletes a custom deployment configuration that is associated with the user's AWS account. +The following ``delete-deployment-config`` example deletes a custom deployment configuration that is associated with the user's AWS account. :: -Command:: + aws deploy delete-deployment-config --deployment-config-name ThreeQuartersHealthy - aws deploy delete-deployment-config --deployment-config-name ThreeQuartersHealthy - -Output:: - - None. \ No newline at end of file +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/deploy/delete-deployment-group.rst awscli-1.18.69/awscli/examples/deploy/delete-deployment-group.rst --- awscli-1.11.13/awscli/examples/deploy/delete-deployment-group.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/delete-deployment-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,13 +1,13 @@ **To delete a deployment group** -This example deletes a deployment group that is associated with the specified application. +The following ``delete-deployment-group`` example deletes a deployment group that is associated with the specified application. :: -Command:: - - aws deploy delete-deployment-group --application-name WordPress_App --deployment-group-name WordPress_DG + aws deploy delete-deployment-group \ + --application-name WordPress_App \ + --deployment-group-name WordPress_DG Output:: - { - "hooksNotCleanedUp": [] - } \ No newline at end of file + { + "hooksNotCleanedUp": [] + } diff -Nru awscli-1.11.13/awscli/examples/deploy/delete-git-hub-account-token.rst awscli-1.18.69/awscli/examples/deploy/delete-git-hub-account-token.rst --- awscli-1.11.13/awscli/examples/deploy/delete-git-hub-account-token.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/delete-git-hub-account-token.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,13 @@ +**To deletes a GitHub account connection** + +The following ``delete-git-hub-account-token`` example deletes the connection of the specified GitHub account. :: + + aws deploy delete-git-hub-account-token --token-name my-github-account + +Output:: + + { + "tokenName": "my-github-account" + } + +For more information, see `DeleteGitHubAccountToken `_ in the *AWS CodeDeploy API Reference*. diff -Nru awscli-1.11.13/awscli/examples/deploy/deregister-on-premises-instance.rst awscli-1.18.69/awscli/examples/deploy/deregister-on-premises-instance.rst --- awscli-1.11.13/awscli/examples/deploy/deregister-on-premises-instance.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/deregister-on-premises-instance.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,11 +1,7 @@ **To deregister an on-premises instance** -This example deregisters an on-premises instance with AWS CodeDeploy, but it does not delete the IAM user associated with the instance, nor does it disassociate in AWS CodeDeploy the on-premises instance tags from the instance. It also does not uninstall the AWS CodeDeploy Agent from the instance nor remove the on-premises configuration file from the instance. +The following ``deregister-on-premises-instance`` example deregisters an on-premises instance with AWS CodeDeploy, but it does not delete the IAM user associated with the instance, nor does it disassociate in AWS CodeDeploy the on-premises instance tags from the instance. It also does not uninstall the AWS CodeDeploy Agent from the instance nor remove the on-premises configuration file from the instance. :: -Command:: + aws deploy deregister-on-premises-instance --instance-name AssetTag12010298EX - aws deploy deregister-on-premises-instance --instance-name AssetTag12010298EX - -Output:: - - This command produces no output. \ No newline at end of file +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/deploy/deregister.rst awscli-1.18.69/awscli/examples/deploy/deregister.rst --- awscli-1.11.13/awscli/examples/deploy/deregister.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/deregister.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,17 +1,18 @@ **To deregister an on-premises instance** -This example deregisters an on-premises instance with AWS CodeDeploy. It does not delete the IAM user that is associated with the instance. It disassociates in AWS CodeDeploy the on-premises tags from the instance. It does not uninstall the AWS CodeDeploy Agent from the instance nor remove the on-premises configuration file from the instance. +The following ``deregister`` example deregisters an on-premises instance with AWS CodeDeploy. It does not delete the IAM user that is associated with the instance. It disassociates in AWS CodeDeploy the on-premises tags from the instance. It does not uninstall the AWS CodeDeploy Agent from the instance nor remove the on-premises configuration file from the instance. :: -Command:: - - aws deploy deregister --instance-name AssetTag12010298EX --no-delete-iam-user --region us-west-2 + aws deploy deregister \ + --instance-name AssetTag12010298EX \ + --no-delete-iam-user \ + --region us-west-2 Output:: - Retrieving on-premises instance information... DONE - IamUserArn: arn:aws:iam::80398EXAMPLE:user/AWS/CodeDeploy/AssetTag12010298EX - Tags: Key=Name,Value=CodeDeployDemo-OnPrem - Removing tags from the on-premises instance... DONE - Deregistering the on-premises instance... DONE - Run the following command on the on-premises instance to uninstall the codedeploy-agent: - aws deploy uninstall \ No newline at end of file + Retrieving on-premises instance information... DONE + IamUserArn: arn:aws:iam::80398EXAMPLE:user/AWS/CodeDeploy/AssetTag12010298EX + Tags: Key=Name,Value=CodeDeployDemo-OnPrem + Removing tags from the on-premises instance... DONE + Deregistering the on-premises instance... DONE + Run the following command on the on-premises instance to uninstall the codedeploy-agent: + aws deploy uninstall diff -Nru awscli-1.11.13/awscli/examples/deploy/get-application-revision.rst awscli-1.18.69/awscli/examples/deploy/get-application-revision.rst --- awscli-1.11.13/awscli/examples/deploy/get-application-revision.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/get-application-revision.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,29 +1,29 @@ **To get information about an application revision** -This example displays information about an application revision that is associated with the specified application. +The following ``get-application-revision`` example displays information about an application revision that is associated with the specified application. :: -Command:: - - aws deploy get-application-revision --application-name WordPress_App --s3-location bucket=CodeDeployDemoBucket,bundleType=zip,eTag=dd56cfd59d434b8e768f9d77fEXAMPLE,key=WordPressApp.zip + aws deploy get-application-revision \ + --application-name WordPress_App \ + --s3-location bucket=CodeDeployDemoBucket,bundleType=zip,eTag=dd56cfdEXAMPLE8e768f9d77fEXAMPLE,key=WordPressApp.zip Output:: - { - "applicationName": "WordPress_App", - "revisionInfo": { - "description": "Application revision registered by Deployment ID: d-N65I7GEX", - "registerTime": 1411076520.009, - "deploymentGroups": "WordPress_DG", - "lastUsedTime": 1411076520.009, - "firstUsedTime": 1411076520.009 - }, - "revision": { - "revisionType": "S3", - "s3Location": { - "bundleType": "zip", - "eTag": "dd56cfd59d434b8e768f9d77fEXAMPLE", - "bucket": "CodeDeployDemoBucket", - "key": "WordPressApp.zip" - } - } - } \ No newline at end of file + { + "applicationName": "WordPress_App", + "revisionInfo": { + "description": "Application revision registered by Deployment ID: d-A1B2C3111", + "registerTime": 1411076520.009, + "deploymentGroups": "WordPress_DG", + "lastUsedTime": 1411076520.009, + "firstUsedTime": 1411076520.009 + }, + "revision": { + "revisionType": "S3", + "s3Location": { + "bundleType": "zip", + "eTag": "dd56cfdEXAMPLE8e768f9d77fEXAMPLE", + "bucket": "CodeDeployDemoBucket", + "key": "WordPressApp.zip" + } + } + } diff -Nru awscli-1.11.13/awscli/examples/deploy/get-application.rst awscli-1.18.69/awscli/examples/deploy/get-application.rst --- awscli-1.11.13/awscli/examples/deploy/get-application.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/get-application.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,18 +1,16 @@ **To get information about an application** -This example displays information about an application that is associated with the user's AWS account. +The following ``get-application`` example displays information about an application that is associated with the user's AWS account. :: -Command:: - - aws deploy get-application --application-name WordPress_App + aws deploy get-application --application-name WordPress_App Output:: - { - "application": { - "applicationName": "WordPress_App", - "applicationId": "d9dd6993-f171-44fa-a811-211e4EXAMPLE", - "createTime": 1407878168.078, - "linkedToGitHub": false - } - } \ No newline at end of file + { + "application": { + "applicationName": "WordPress_App", + "applicationId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "createTime": 1407878168.078, + "linkedToGitHub": false + } + } diff -Nru awscli-1.11.13/awscli/examples/deploy/get-deployment-config.rst awscli-1.18.69/awscli/examples/deploy/get-deployment-config.rst --- awscli-1.11.13/awscli/examples/deploy/get-deployment-config.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/get-deployment-config.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,21 +1,19 @@ **To get information about a deployment configuration** -This example displays information about a deployment configuration that is associated with the user's AWS account. +The following ``get-deployment-config`` example displays information about a deployment configuration that is associated with the user's AWS account. :: -Command:: - - aws deploy get-deployment-config --deployment-config-name ThreeQuartersHealthy + aws deploy get-deployment-config --deployment-config-name ThreeQuartersHealthy Output:: - { - "deploymentConfigInfo": { - "deploymentConfigId": "bf6b390b-61d3-4f24-8911-a1664EXAMPLE", - "minimumHealthyHosts": { - "type": "FLEET_PERCENT", - "value": 75 - }, - "createTime": 1411081164.379, - "deploymentConfigName": "ThreeQuartersHealthy" - } - } \ No newline at end of file + { + "deploymentConfigInfo": { + "deploymentConfigId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "minimumHealthyHosts": { + "type": "FLEET_PERCENT", + "value": 75 + }, + "createTime": 1411081164.379, + "deploymentConfigName": "ThreeQuartersHealthy" + } + } diff -Nru awscli-1.11.13/awscli/examples/deploy/get-deployment-group.rst awscli-1.18.69/awscli/examples/deploy/get-deployment-group.rst --- awscli-1.11.13/awscli/examples/deploy/get-deployment-group.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/get-deployment-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,29 +1,29 @@ **To view information about a deployment group** -This example displays information about a deployment group that is associated with the specified application. +The following ``get-deployment-group`` example displays information about a deployment group that is associated with the specified application. :: -Command:: - - aws deploy get-deployment-group --application-name WordPress_App --deployment-group-name WordPress_DG + aws deploy get-deployment-group \ + --application-name WordPress_App \ + --deployment-group-name WordPress_DG Output:: - { - "deploymentGroupInfo": { - "applicationName": "WordPress_App", - "autoScalingGroups": [ - "CodeDeployDemo-ASG" - ], - "deploymentConfigName": "CodeDeployDefault.OneAtATime", - "ec2TagFilters": [ - { - "Type": "KEY_AND_VALUE", - "Value": "CodeDeployDemo", - "Key": "Name" - } - ], - "deploymentGroupId": "cdac3220-0e64-4d63-bb50-e68faEXAMPLE", - "serviceRoleArn": "arn:aws:iam::80398EXAMPLE:role/CodeDeployDemoRole", - "deploymentGroupName": "WordPress_DG" - } - } \ No newline at end of file + { + "deploymentGroupInfo": { + "applicationName": "WordPress_App", + "autoScalingGroups": [ + "CodeDeployDemo-ASG" + ], + "deploymentConfigName": "CodeDeployDefault.OneAtATime", + "ec2TagFilters": [ + { + "Type": "KEY_AND_VALUE", + "Value": "CodeDeployDemo", + "Key": "Name" + } + ], + "deploymentGroupId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "serviceRoleArn": "arn:aws:iam::123456789012:role/CodeDeployDemoRole", + "deploymentGroupName": "WordPress_DG" + } + } diff -Nru awscli-1.11.13/awscli/examples/deploy/get-deployment-instance.rst awscli-1.18.69/awscli/examples/deploy/get-deployment-instance.rst --- awscli-1.11.13/awscli/examples/deploy/get-deployment-instance.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/get-deployment-instance.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,60 +1,58 @@ **To get information about a deployment instance** -This example displays information about a deployment instance that is associated with the specified deployment. +The following ``get-deployment-instance`` example displays information about a deployment instance that is associated with the specified deployment. :: -Command:: - - aws deploy get-deployment-instance --deployment-id d-QA4G4F9EX --instance-id i-902e9fEX + aws deploy get-deployment-instance --deployment-id d-QA4G4F9EX --instance-id i-902e9fEX Output:: - { - "instanceSummary": { - "instanceId": "arn:aws:ec2:us-east-1:80398EXAMPLE:instance/i-902e9fEX", - "lifecycleEvents": [ - { - "status": "Succeeded", - "endTime": 1408480726.569, - "startTime": 1408480726.437, - "lifecycleEventName": "ApplicationStop" - }, - { - "status": "Succeeded", - "endTime": 1408480728.016, - "startTime": 1408480727.665, - "lifecycleEventName": "DownloadBundle" - }, - { - "status": "Succeeded", - "endTime": 1408480729.744, - "startTime": 1408480729.125, - "lifecycleEventName": "BeforeInstall" - }, - { - "status": "Succeeded", - "endTime": 1408480730.979, - "startTime": 1408480730.844, - "lifecycleEventName": "Install" - }, - { - "status": "Failed", - "endTime": 1408480732.603, - "startTime": 1408480732.1, - "lifecycleEventName": "AfterInstall" - }, - { - "status": "Skipped", - "endTime": 1408480732.606, - "lifecycleEventName": "ApplicationStart" - }, - { - "status": "Skipped", - "endTime": 1408480732.606, - "lifecycleEventName": "ValidateService" - } - ], - "deploymentId": "d-QA4G4F9EX", - "lastUpdatedAt": 1408480733.152, - "status": "Failed" - } - } \ No newline at end of file + { + "instanceSummary": { + "instanceId": "arn:aws:ec2:us-east-1:80398EXAMPLE:instance/i-902e9fEX", + "lifecycleEvents": [ + { + "status": "Succeeded", + "endTime": 1408480726.569, + "startTime": 1408480726.437, + "lifecycleEventName": "ApplicationStop" + }, + { + "status": "Succeeded", + "endTime": 1408480728.016, + "startTime": 1408480727.665, + "lifecycleEventName": "DownloadBundle" + }, + { + "status": "Succeeded", + "endTime": 1408480729.744, + "startTime": 1408480729.125, + "lifecycleEventName": "BeforeInstall" + }, + { + "status": "Succeeded", + "endTime": 1408480730.979, + "startTime": 1408480730.844, + "lifecycleEventName": "Install" + }, + { + "status": "Failed", + "endTime": 1408480732.603, + "startTime": 1408480732.1, + "lifecycleEventName": "AfterInstall" + }, + { + "status": "Skipped", + "endTime": 1408480732.606, + "lifecycleEventName": "ApplicationStart" + }, + { + "status": "Skipped", + "endTime": 1408480732.606, + "lifecycleEventName": "ValidateService" + } + ], + "deploymentId": "d-QA4G4F9EX", + "lastUpdatedAt": 1408480733.152, + "status": "Failed" + } + } diff -Nru awscli-1.11.13/awscli/examples/deploy/get-deployment.rst awscli-1.18.69/awscli/examples/deploy/get-deployment.rst --- awscli-1.11.13/awscli/examples/deploy/get-deployment.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/get-deployment.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,40 +1,38 @@ **To get information about a deployment** -This example displays information about a deployment that is associated with the user's AWS account. +The following ``get-deployment`` example displays information about a deployment that is associated with the user's AWS account. :: -Command:: - - aws deploy get-deployment --deployment-id d-USUAELQEX + aws deploy get-deployment --deployment-id d-A1B2C3123 Output:: - { - "deploymentInfo": { - "applicationName": "WordPress_App", - "status": "Succeeded", - "deploymentOverview": { - "Failed": 0, - "InProgress": 0, - "Skipped": 0, - "Succeeded": 1, - "Pending": 0 - }, - "deploymentConfigName": "CodeDeployDefault.OneAtATime", - "creator": "user", - "description": "My WordPress app deployment", - "revision": { - "revisionType": "S3", - "s3Location": { - "bundleType": "zip", - "eTag": "\"dd56cfd59d434b8e768f9d77fEXAMPLE\"", - "bucket": "CodeDeployDemoBucket", - "key": "WordPressApp.zip" - } - }, - "deploymentId": "d-USUAELQEX", - "deploymentGroupName": "WordPress_DG", - "createTime": 1409764576.589, - "completeTime": 1409764596.101, - "ignoreApplicationStopFailures": false - } - } \ No newline at end of file + { + "deploymentInfo": { + "applicationName": "WordPress_App", + "status": "Succeeded", + "deploymentOverview": { + "Failed": 0, + "InProgress": 0, + "Skipped": 0, + "Succeeded": 1, + "Pending": 0 + }, + "deploymentConfigName": "CodeDeployDefault.OneAtATime", + "creator": "user", + "description": "My WordPress app deployment", + "revision": { + "revisionType": "S3", + "s3Location": { + "bundleType": "zip", + "eTag": "\"dd56cfdEXAMPLE8e768f9d77fEXAMPLE\"", + "bucket": "CodeDeployDemoBucket", + "key": "WordPressApp.zip" + } + }, + "deploymentId": "d-A1B2C3123", + "deploymentGroupName": "WordPress_DG", + "createTime": 1409764576.589, + "completeTime": 1409764596.101, + "ignoreApplicationStopFailures": false + } + } diff -Nru awscli-1.11.13/awscli/examples/deploy/get-deployment-target.rst awscli-1.18.69/awscli/examples/deploy/get-deployment-target.rst --- awscli-1.11.13/awscli/examples/deploy/get-deployment-target.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/get-deployment-target.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,110 @@ +**To return information about a deployment target** + +The following ``get-deployment-target`` example returns information about a deployment target that is associated with the specified deployment. :: + + aws deploy get-deployment-target \ + --deployment-id "d-A1B2C3111" \ + --target-id "i-a1b2c3d4e5f611111" + +Output:: + + { + "deploymentTarget": { + "deploymentTargetType": "InstanceTarget", + "instanceTarget": { + "lastUpdatedAt": 1556918687.504, + "targetId": "i-a1b2c3d4e5f611111", + "targetArn": "arn:aws:ec2:us-west-2:123456789012:instance/i-a1b2c3d4e5f611111", + "status": "Succeeded", + "lifecycleEvents": [ + { + "status": "Succeeded", + "diagnostics": { + "errorCode": "Success", + "message": "Succeeded", + "logTail": "", + "scriptName": "" + }, + "lifecycleEventName": "ApplicationStop", + "startTime": 1556918592.162, + "endTime": 1556918592.247 + }, + { + "status": "Succeeded", + "diagnostics": { + "errorCode": "Success", + "message": "Succeeded", + "logTail": "", + "scriptName": "" + }, + "lifecycleEventName": "DownloadBundle", + "startTime": 1556918593.193, + "endTime": 1556918593.981 + }, + { + "status": "Succeeded", + "diagnostics": { + "errorCode": "Success", + "message": "Succeeded", + "logTail": "", + "scriptName": "" + }, + "lifecycleEventName": "BeforeInstall", + "startTime": 1556918594.805, + "endTime": 1556918681.807 + }, + { + "status": "Succeeded", + "diagnostics": { + "errorCode": "Success", + "message": "Succeeded", + "logTail": "", + "scriptName": "" + }, + "lifecycleEventName": "Install", + "startTime": 1556918682.696, + "endTime": 1556918683.005 + }, + { + "status": "Succeeded", + "diagnostics": { + "errorCode": "Success", + "message": "Succeeded", + "logTail": "", + "scriptName": "" + }, + "lifecycleEventName": "AfterInstall", + "startTime": 1556918684.135, + "endTime": 1556918684.216 + }, + { + "status": "Succeeded", + "diagnostics": { + "errorCode": "Success", + "message": "Succeeded", + "logTail": "", + "scriptName": "" + }, + "lifecycleEventName": "ApplicationStart", + "startTime": 1556918685.211, + "endTime": 1556918685.295 + }, + { + "status": "Succeeded", + "diagnostics": { + "errorCode": "Success", + "message": "Succeeded", + "logTail": "", + "scriptName": "" + }, + "lifecycleEventName": "ValidateService", + "startTime": 1556918686.65, + "endTime": 1556918686.747 + } + ], + "deploymentId": "d-A1B2C3111" + } + } + } + +For more information, see `GetDeploymentTarget `_ in the *AWS CodeDeploy API Reference*. diff -Nru awscli-1.11.13/awscli/examples/deploy/get-on-premises-instance.rst awscli-1.18.69/awscli/examples/deploy/get-on-premises-instance.rst --- awscli-1.11.13/awscli/examples/deploy/get-on-premises-instance.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/get-on-premises-instance.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,24 +1,22 @@ **To get information about an on-premises instance** -This example gets information about an on-premises instance. +The following ``get-on-premises-instance`` example retrieves information about the specified on-premises instance. :: -Command:: - - aws deploy get-on-premises-instance --instance-name AssetTag12010298EX + aws deploy get-on-premises-instance --instance-name AssetTag12010298EX Output:: - { - "instanceInfo": { - "iamUserArn": "arn:aws:iam::80398EXAMPLE:user/AWS/CodeDeploy/AssetTag12010298EX", - "tags": [ - { - "Value": "CodeDeployDemo-OnPrem", - "Key": "Name" - } - ], - "instanceName": "AssetTag12010298EX", - "registerTime": 1425579465.228, - "instanceArn": "arn:aws:codedeploy:us-east-1:80398EXAMPLE:instance/AssetTag12010298EX_4IwLNI2Alh" - } - } \ No newline at end of file + { + "instanceInfo": { + "iamUserArn": "arn:aws:iam::123456789012:user/AWS/CodeDeploy/AssetTag12010298EX", + "tags": [ + { + "Value": "CodeDeployDemo-OnPrem", + "Key": "Name" + } + ], + "instanceName": "AssetTag12010298EX", + "registerTime": 1425579465.228, + "instanceArn": "arn:aws:codedeploy:us-east-1:123456789012:instance/AssetTag12010298EX_4IwLNI2Alh" + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/deploy/install.rst awscli-1.18.69/awscli/examples/deploy/install.rst --- awscli-1.11.13/awscli/examples/deploy/install.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/install.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,13 +1,14 @@ **To install an on-premises instance** -This example copies the on-premises configuration file from the specified location on the instance to the location on the instance that the AWS CodeDeploy Agent expects to find it. It also installs the AWS CodeDeploy Agent on the instance. It does not create any IAM user, nor register the on-premises instance with AWS CodeDeploy, nor associate any on-premises instance tags in AWS CodeDeploy for the instance. - -Command:: - - aws deploy install --override-config --config-file C:\temp\codedeploy.onpremises.yml --region us-west-2 --agent-installer s3://aws-codedeploy-us-west-2/latest/codedeploy-agent.msi +The following ``install`` example copies the on-premises configuration file from the specified location on the instance to the location on the instance that the AWS CodeDeploy Agent expects to find it. It also installs the AWS CodeDeploy Agent on the instance. It does not create any IAM user, nor register the on-premises instance with AWS CodeDeploy, nor associate any on-premises instance tags in AWS CodeDeploy for the instance. :: + aws deploy install \ + --override-config \ + --config-file C:\temp\codedeploy.onpremises.yml \ + --region us-west-2 \ + --agent-installer s3://aws-codedeploy-us-west-2/latest/codedeploy-agent.msi Output:: - Creating the on-premises instance configuration file... DONE - Installing the AWS CodeDeploy Agent... DONE \ No newline at end of file + Creating the on-premises instance configuration file... DONE + Installing the AWS CodeDeploy Agent... DONE diff -Nru awscli-1.11.13/awscli/examples/deploy/list-application-revisions.rst awscli-1.18.69/awscli/examples/deploy/list-application-revisions.rst --- awscli-1.11.13/awscli/examples/deploy/list-application-revisions.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/list-application-revisions.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,32 +1,36 @@ **To get information about application revisions** -This example displays information about all application revisions that are associated with the specified application. +The following ``list-application-revisions`` example displays information about all application revisions that are associated with the specified application. :: -Command:: - - aws deploy list-application-revisions --application-name WordPress_App --s-3-bucket CodeDeployDemoBucket --deployed exclude --s-3-key-prefix WordPress_ --sort-by lastUsedTime --sort-order descending + aws deploy list-application-revisions \ + --application-name WordPress_App \ + --s-3-bucket CodeDeployDemoBucket \ + --deployed exclude \ + --s-3-key-prefix WordPress_ \ + --sort-by lastUsedTime \ + --sort-order descending Output:: - { - "revisions": [ - { - "revisionType": "S3", - "s3Location": { - "version": "uTecLusvCB_JqHFXtfUcyfV8bEXAMPLE", - "bucket": "CodeDeployDemoBucket", - "key": "WordPress_App.zip", - "bundleType": "zip" - } - }, - { - "revisionType": "S3", - "s3Location": { - "version": "tMk.UxgDpMEVb7V187ZM6wVAWEXAMPLE", - "bucket": "CodeDeployDemoBucket", - "key": "WordPress_App_2-0.zip", - "bundleType": "zip" - } - } - ] - } + { + "revisions": [ + { + "revisionType": "S3", + "s3Location": { + "version": "uTecLusvCB_JqHFXtfUcyfV8bEXAMPLE", + "bucket": "CodeDeployDemoBucket", + "key": "WordPress_App.zip", + "bundleType": "zip" + } + }, + { + "revisionType": "S3", + "s3Location": { + "version": "tMk.UxgDpMEVb7V187ZM6wVAWEXAMPLE", + "bucket": "CodeDeployDemoBucket", + "key": "WordPress_App_2-0.zip", + "bundleType": "zip" + } + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/deploy/list-applications.rst awscli-1.18.69/awscli/examples/deploy/list-applications.rst --- awscli-1.11.13/awscli/examples/deploy/list-applications.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/list-applications.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,16 +1,14 @@ **To get information about applications** -This example displays information about all applications that are associated with the user's AWS account. +The following ``list-applications`` example displays information about all applications that are associated with the user's AWS account. :: -Command:: - - aws deploy list-applications + aws deploy list-applications Output:: - { - "applications": [ - "WordPress_App", - "MyOther_App" - ] - } \ No newline at end of file + { + "applications": [ + "WordPress_App", + "MyOther_App" + ] + } diff -Nru awscli-1.11.13/awscli/examples/deploy/list-deployment-configs.rst awscli-1.18.69/awscli/examples/deploy/list-deployment-configs.rst --- awscli-1.11.13/awscli/examples/deploy/list-deployment-configs.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/list-deployment-configs.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,18 +1,16 @@ **To get information about deployment configurations** -This example displays information about all deployment configurations that are associated with the user's AWS account. +The following ``list-deployment-configs`` example displays information about all deployment configurations that are associated with the user's AWS account. :: -Command:: - - aws deploy list-deployment-configs + aws deploy list-deployment-configs Output:: - { - "deploymentConfigsList": [ - "ThreeQuartersHealthy", - "CodeDeployDefault.AllAtOnce", - "CodeDeployDefault.HalfAtATime", - "CodeDeployDefault.OneAtATime" - ] - } \ No newline at end of file + { + "deploymentConfigsList": [ + "ThreeQuartersHealthy", + "CodeDeployDefault.AllAtOnce", + "CodeDeployDefault.HalfAtATime", + "CodeDeployDefault.OneAtATime" + ] + } diff -Nru awscli-1.11.13/awscli/examples/deploy/list-deployment-groups.rst awscli-1.18.69/awscli/examples/deploy/list-deployment-groups.rst --- awscli-1.11.13/awscli/examples/deploy/list-deployment-groups.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/list-deployment-groups.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,17 +1,15 @@ **To get information about deployment groups** -This example displays information about all deployment groups that are associated with the specified application. +The following ``list-deployment-groups`` example displays information about all deployment groups that are associated with the specified application. :: -Command:: - - aws deploy list-deployment-groups --application-name WordPress_App + aws deploy list-deployment-groups --application-name WordPress_App Output:: - { - "applicationName": "WordPress_App", - "deploymentGroups": [ - "WordPress_DG", - "WordPress_Beta_DG" - ] - } \ No newline at end of file + { + "applicationName": "WordPress_App", + "deploymentGroups": [ + "WordPress_DG", + "WordPress_Beta_DG" + ] + } diff -Nru awscli-1.11.13/awscli/examples/deploy/list-deployment-instances.rst awscli-1.18.69/awscli/examples/deploy/list-deployment-instances.rst --- awscli-1.11.13/awscli/examples/deploy/list-deployment-instances.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/list-deployment-instances.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,16 +1,16 @@ **To get information about deployment instances** -This example displays information about all deployment instances that are associated with the specified deployment. +The following ``list-deployment-instances`` example displays information about all deployment instances that are associated with the specified deployment. :: -Command:: - - aws deploy list-deployment-instances --deployment-id d-9DI6I4EX --instance-status-filter Succeeded + aws deploy list-deployment-instances \ + --deployment-id d-A1B2C3111 \ + --instance-status-filter Succeeded Output:: - { - "instancesList": [ - "i-8c4490EX", - "i-7d5389EX" - ] - } \ No newline at end of file + { + "instancesList": [ + "i-EXAMPLE11", + "i-EXAMPLE22" + ] + } diff -Nru awscli-1.11.13/awscli/examples/deploy/list-deployments.rst awscli-1.18.69/awscli/examples/deploy/list-deployments.rst --- awscli-1.11.13/awscli/examples/deploy/list-deployments.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/list-deployments.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,17 +1,19 @@ **To get information about deployments** -This example displays information about all deployments that are associated with the specified application and deployment group. +The follwoing ``list-deployments`` example displays information about all deployments that are associated with the specified application and deployment group. :: -Command:: - - aws deploy list-deployments --application-name WordPress_App --create-time-range start=2014-08-19T00:00:00,end=2014-08-20T00:00:00 --deployment-group-name WordPress_DG --include-only-statuses Failed + aws deploy list-deployments \ + --application-name WordPress_App \ + --create-time-range start=2014-08-19T00:00:00,end=2014-08-20T00:00:00 \ + --deployment-group-name WordPress_DG \ + --include-only-statuses Failed Output:: - { - "deployments": [ - "d-QA4G4F9EX", - "d-1MVNYOEEX", - "d-WEWRE8BEX" - ] - } \ No newline at end of file + { + "deployments": [ + "d-EXAMPLE11", + "d-EXAMPLE22", + "d-EXAMPLE33" + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/deploy/list-deployment-targets.rst awscli-1.18.69/awscli/examples/deploy/list-deployment-targets.rst --- awscli-1.11.13/awscli/examples/deploy/list-deployment-targets.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/list-deployment-targets.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To retrieve a list of target IDs that are associated with a deployment** + +The following ``list-deployment-targets`` example retrieves a list of target IDs associated with deployments that have a status of "Failed" or "InProgress." :: + + aws deploy list-deployment-targets \ + --deployment-id "d-A1B2C3111" \ + --target-filters "{\"TargetStatus\":[\"Failed\",\"InProgress\"]}" + +Output:: + + { + "targetIds": [ + "i-0f1558aaf90e5f1f9" + ] + } + +For more information, see `ListDeploymentTargets `_ in the *AWS CodeDeploy API Reference*. diff -Nru awscli-1.11.13/awscli/examples/deploy/list-git-hub-account-token-names.rst awscli-1.18.69/awscli/examples/deploy/list-git-hub-account-token-names.rst --- awscli-1.11.13/awscli/examples/deploy/list-git-hub-account-token-names.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/list-git-hub-account-token-names.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To lists the names of stored connections to GitHub accounts** + +The following ``list-git-hub-account-token-names`` example lists the names of the stored connections to GitHub accounts for the current AWS user. :: + + aws deploy list-git-hub-account-token-names + +Output:: + + { + "tokenNameList": [ + "my-first-token", + "my-second-token", + "my-third-token" + ] + } + +For more information, see `ListGitHubAccountTokenNames `_ in the *AWS CodeDeploy API Reference*. diff -Nru awscli-1.11.13/awscli/examples/deploy/list-on-premises-instances.rst awscli-1.18.69/awscli/examples/deploy/list-on-premises-instances.rst --- awscli-1.11.13/awscli/examples/deploy/list-on-premises-instances.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/list-on-premises-instances.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,15 +1,15 @@ **To get information about one or more on-premises instances** -This example gets a list of available on-premises instance names for instances that are registered in AWS CodeDeploy and also have the specified on-premises instance tag associated in AWS CodeDeploy with the instance. +The following ``list-on-premises-instances`` example retrieves a list of available on-premises instance names for instances that are registered in AWS CodeDeploy and also have the specified on-premises instance tag associated in AWS CodeDeploy with the instance. :: -Command:: - - aws deploy list-on-premises-instances --registration-status Registered --tag-filters Key=Name,Value=CodeDeployDemo-OnPrem,Type=KEY_AND_VALUE + aws deploy list-on-premises-instances \ + --registration-status Registered \ + --tag-filters Key=Name,Value=CodeDeployDemo-OnPrem,Type=KEY_AND_VALUE Output:: - { - "instanceNames": [ - "AssetTag12010298EX" - ] - } \ No newline at end of file + { + "instanceNames": [ + "AssetTag12010298EX" + ] + } diff -Nru awscli-1.11.13/awscli/examples/deploy/push.rst awscli-1.18.69/awscli/examples/deploy/push.rst --- awscli-1.11.13/awscli/examples/deploy/push.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/push.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,14 +1,15 @@ **To bundle and deploy an AWS CodeDeploy compatible application revision to Amazon S3** -This example bundles and deploys an application revision to Amazon S3 and then associates the application revision with the specified application. +The following ``push`` example bundles and deploys an application revision to Amazon S3 and then associates the application revision with the specified application. :: -Use the output of the push command to create a deployment that uses the uploaded application revision. + aws deploy push \ + --application-name WordPress_App \ + --description "This is my deployment" \ + --ignore-hidden-files \ + --s3-location s3://CodeDeployDemoBucket/WordPressApp.zip \ + --source /tmp/MyLocalDeploymentFolder/ -Command:: +The output describes how to use the ``create-deployment`` command to create a deployment that uses the uploaded application revision. :: - aws deploy push --application-name WordPress_App --description "This is my deployment" --ignore-hidden-files --s3-location s3://CodeDeployDemoBucket/WordPressApp.zip --source /tmp/MyLocalDeploymentFolder/ - -Output:: - - To deploy with this revision, run: - aws deploy create-deployment --application-name WordPress_App --deployment-config-name --deployment-group-name --s3-location bucket=CodeDeployDemoBucket,key=WordPressApp.zip,bundleType=zip,eTag="cecc9b8a08eac650a6e71fdb88EXAMPLE",version=LFsJAUd_2J4VWXfvKtvi79L8EXAMPLE \ No newline at end of file + To deploy with this revision, run: + aws deploy create-deployment --application-name WordPress_App --deployment-config-name --deployment-group-name --s3-location bucket=CodeDeployDemoBucket,key=WordPressApp.zip,bundleType=zip,eTag="cecc9b8EXAMPLE50a6e71fdb88EXAMPLE",version=LFsJAUdEXAMPLEfvKtvi79L8EXAMPLE \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/deploy/register-application-revision.rst awscli-1.18.69/awscli/examples/deploy/register-application-revision.rst --- awscli-1.11.13/awscli/examples/deploy/register-application-revision.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/register-application-revision.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,11 +1,10 @@ **To register information about an already-uploaded application revision** -This example registers information about an already-uploaded application revision in Amazon S3 with AWS CodeDeploy. +The following ``register-application-revision`` example registers information about an already-uploaded application revision stored in Amazon S3 with AWS CodeDeploy. :: -Command:: + aws deploy register-application-revision \ + --application-name WordPress_App \ + --description "Revised WordPress application" \ + --s3-location bucket=CodeDeployDemoBucket,key=RevisedWordPressApp.zip,bundleType=zip,eTag=cecc9b8a08eac650a6e71fdb88EXAMPLE - aws deploy register-application-revision --application-name WordPress_App --description "Revised WordPress application" --s3-location bucket=CodeDeployDemoBucket,key=RevisedWordPressApp.zip,bundleType=zip,eTag=cecc9b8a08eac650a6e71fdb88EXAMPLE - -Output:: - - None. \ No newline at end of file +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/deploy/register-on-premises-instance.rst awscli-1.18.69/awscli/examples/deploy/register-on-premises-instance.rst --- awscli-1.11.13/awscli/examples/deploy/register-on-premises-instance.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/register-on-premises-instance.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,11 +1,9 @@ **To register an on-premises instance** -This example registers an on-premises instance with AWS CodeDeploy. It does not create the specified IAM user, nor does it associate in AWS CodeDeploy any on-premises instances tags with the registered instance. +The following ``register-on-premises-instance`` example registers an on-premises instance with AWS CodeDeploy. It does not create the specified IAM user, nor does it associate in AWS CodeDeploy any on-premises instances tags with the registered instance. :: -Command:: + aws deploy register-on-premises-instance \ + --instance-name AssetTag12010298EX \ + --iam-user-arn arn:aws:iam::80398EXAMPLE:user/CodeDeployDemoUser-OnPrem - aws deploy register-on-premises-instance --instance-name AssetTag12010298EX --iam-user-arn arn:aws:iam::80398EXAMPLE:user/CodeDeployDemoUser-OnPrem - -Output:: - - This command produces no output. \ No newline at end of file +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/deploy/register.rst awscli-1.18.69/awscli/examples/deploy/register.rst --- awscli-1.11.13/awscli/examples/deploy/register.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/register.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,14 +1,16 @@ **To register an on-premises instance** -This example registers an on-premises instance with AWS CodeDeploy, associates in AWS CodeDeploy the specified on-premises instance tag with the registered instance, and creates an on-premises configuration file that can be copied to the instance. It does not create the IAM user, nor does it install the AWS CodeDeploy Agent on the instance. +The following ``register`` example registers an on-premises instance with AWS CodeDeploy, associates in AWS CodeDeploy the specified on-premises instance tag with the registered instance, and creates an on-premises configuration file that can be copied to the instance. It does not create the IAM user, nor does it install the AWS CodeDeploy Agent on the instance. :: -Command:: - - aws deploy register --instance-name AssetTag12010298EX --iam-user-arn arn:aws:iam::80398EXAMPLE:user/CodeDeployUser-OnPrem --tags Key=Name,Value=CodeDeployDemo-OnPrem --region us-west-2 + aws deploy register \ + --instance-name AssetTag12010298EX \ + --iam-user-arn arn:aws:iam::80398EXAMPLE:user/CodeDeployUser-OnPrem \ + --tags Key=Name,Value=CodeDeployDemo-OnPrem \ + --region us-west-2 Output:: - Registering the on-premises instance... DONE - Adding tags to the on-premises instance... DONE - Copy the on-premises configuration file named codedeploy.onpremises.yml to the on-premises instance, and run the following command on the on-premises instance to install and configure the AWS CodeDeploy Agent: - aws deploy install --config-file codedeploy.onpremises.yml \ No newline at end of file + Registering the on-premises instance... DONE + Adding tags to the on-premises instance... DONE + Copy the on-premises configuration file named codedeploy.onpremises.yml to the on-premises instance, and run the following command on the on-premises instance to install and configure the AWS CodeDeploy Agent: + aws deploy install --config-file codedeploy.onpremises.yml diff -Nru awscli-1.11.13/awscli/examples/deploy/remove-tags-from-on-premises-instances.rst awscli-1.18.69/awscli/examples/deploy/remove-tags-from-on-premises-instances.rst --- awscli-1.11.13/awscli/examples/deploy/remove-tags-from-on-premises-instances.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/remove-tags-from-on-premises-instances.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,11 +1,9 @@ **To remove tags from one or more on-premises instances** -This example disassociates the same on-premises tag in AWS CodeDeploy from the two specified on-premises instances. It does not deregister the on-premises instances in AWS CodeDeploy, nor uninstall the AWS CodeDeploy Agent from the instance, nor remove the on-premises configuration file from the instances, nor delete the IAM users that are associated with the instances. +The following ``remove-tags-from-on-premises-instances`` example disassociates the specified on-premises tags in AWS CodeDeploy from on-premises instances. It does not deregister the on-premises instances in AWS CodeDeploy, nor uninstall the AWS CodeDeploy Agent from the instance, nor remove the on-premises configuration file from the instances, nor delete the IAM users that are associated with the instances. :: -Command:: + aws deploy remove-tags-from-on-premises-instances \ + --instance-names AssetTag12010298EX AssetTag23121309EX \ + --tags Key=Name,Value=CodeDeployDemo-OnPrem - aws deploy remove-tags-from-on-premises-instances --instance-names AssetTag12010298EX AssetTag23121309EX --tags Key=Name,Value=CodeDeployDemo-OnPrem - -Output:: - - This command produces no output. \ No newline at end of file +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/deploy/stop-deployment.rst awscli-1.18.69/awscli/examples/deploy/stop-deployment.rst --- awscli-1.11.13/awscli/examples/deploy/stop-deployment.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/stop-deployment.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,14 +1,12 @@ **To attempt to stop a deployment** -This example attempts to stop an in-progress deployment that is associated with the user's AWS account. +The following ``stop-deployment`` example attempts to stop an in-progress deployment that is associated with the user's AWS account. -Command:: - - aws deploy stop-deployment --deployment-id d-8365D4OEX + aws deploy stop-deployment --deployment-id d-A1B2C3111 Output:: - { - "status": "Succeeded", - "statusMessage": "No more commands will be scheduled for execution in the deployment instances" - } \ No newline at end of file + { + "status": "Succeeded", + "statusMessage": "No more commands will be scheduled for execution in the deployment instances" + } diff -Nru awscli-1.11.13/awscli/examples/deploy/uninstall.rst awscli-1.18.69/awscli/examples/deploy/uninstall.rst --- awscli-1.11.13/awscli/examples/deploy/uninstall.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/uninstall.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,11 +1,7 @@ **To uninstall an on-premises instance** -This example uninstalls the AWS CodeDeploy Agent from the on-premises instance, and it removes the on-premises configuration file from the instance. It does not deregister the instance in AWS CodeDeploy, nor disassociate any on-premises instance tags in AWS CodeDeploy from the instance, nor delete the IAM user that is associated with the instance. +The following ``uninstall`` example uninstalls the AWS CodeDeploy Agent from the on-premises instance and removes the on-premises configuration file from the instance. It doesn't deregister the instance in AWS CodeDeploy, nor disassociate any on-premises instance tags in AWS CodeDeploy from the instance, nor delete the IAM user that is associated with the instance. :: -Command:: + aws deploy uninstall - aws deploy uninstall - -Output:: - - This command produces no output. \ No newline at end of file +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/deploy/update-application.rst awscli-1.18.69/awscli/examples/deploy/update-application.rst --- awscli-1.11.13/awscli/examples/deploy/update-application.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/update-application.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,11 +1,9 @@ -**To change information about an application** +**To change details of an application** -This example changes the name of an application that is associated with the user's AWS account. +The following ``update-application`` example changes the name of an application that is associated with the user's AWS account. :: -Command:: + aws deploy update-application \ + --application-name WordPress_App \ + --new-application-name My_WordPress_App - aws deploy update-application --application-name WordPress_App --new-application-name My_WordPress_App - -Output:: - - None. \ No newline at end of file +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/deploy/update-deployment-group.rst awscli-1.18.69/awscli/examples/deploy/update-deployment-group.rst --- awscli-1.11.13/awscli/examples/deploy/update-deployment-group.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/update-deployment-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,11 +1,14 @@ **To change information about a deployment group** -This example changes the settings of a deployment group that is associated with the specified application. +The following ``update-deployment-group`` example changes the settings of a deployment group that is associated with the specified application. :: -Command:: + aws deploy update-deployment-group \ + --application-name WordPress_App \ + --auto-scaling-groups My_CodeDeployDemo_ASG \ + --current-deployment-group-name WordPress_DG \ + --deployment-config-name CodeDeployDefault.AllAtOnce \ + --ec2-tag-filters Key=Name,Type=KEY_AND_VALUE,Value=My_CodeDeployDemo \ + --new-deployment-group-name My_WordPress_DepGroup \ + --service-role-arn arn:aws:iam::80398EXAMPLE:role/CodeDeployDemo-2 - aws deploy update-deployment-group --application-name WordPress_App --auto-scaling-groups My_CodeDeployDemo_ASG --current-deployment-group-name WordPress_DG --deployment-config-name CodeDeployDefault.AllAtOnce --ec2-tag-filters Key=Name,Type=KEY_AND_VALUE,Value=My_CodeDeployDemo --new-deployment-group-name My_WordPress_DepGroup --service-role-arn arn:aws:iam::80398EXAMPLE:role/CodeDeployDemo-2 - -Output:: - - None. \ No newline at end of file +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/deploy/wait/deployment-successful.rst awscli-1.18.69/awscli/examples/deploy/wait/deployment-successful.rst --- awscli-1.11.13/awscli/examples/deploy/wait/deployment-successful.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/deploy/wait/deployment-successful.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,7 @@ +**To pause script operations until a deployment is flagged as successful** + +The following ``wait deployment-successful`` example pauses until the specified deployment completes successfully. :: + + aws deploy wait deployment-successful --deployment-id d-A1B2C3111 + +This command produces no output, but pauses operation until the condition is met. It generates an error if the condition is not met after 120 checks that are 15 seconds apart. diff -Nru awscli-1.11.13/awscli/examples/detective/accept-invitation.rst awscli-1.18.69/awscli/examples/detective/accept-invitation.rst --- awscli-1.11.13/awscli/examples/detective/accept-invitation.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/detective/accept-invitation.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/detective/create-graph.rst awscli-1.18.69/awscli/examples/detective/create-graph.rst --- awscli-1.11.13/awscli/examples/detective/create-graph.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/detective/create-graph.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/detective/create-members.rst awscli-1.18.69/awscli/examples/detective/create-members.rst --- awscli-1.11.13/awscli/examples/detective/create-members.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/detective/create-members.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/detective/delete-graph.rst awscli-1.18.69/awscli/examples/detective/delete-graph.rst --- awscli-1.11.13/awscli/examples/detective/delete-graph.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/detective/delete-graph.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/detective/delete-members.rst awscli-1.18.69/awscli/examples/detective/delete-members.rst --- awscli-1.11.13/awscli/examples/detective/delete-members.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/detective/delete-members.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/detective/disassociate-membership.rst awscli-1.18.69/awscli/examples/detective/disassociate-membership.rst --- awscli-1.11.13/awscli/examples/detective/disassociate-membership.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/detective/disassociate-membership.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/detective/get-members.rst awscli-1.18.69/awscli/examples/detective/get-members.rst --- awscli-1.11.13/awscli/examples/detective/get-members.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/detective/get-members.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/detective/list-graphs.rst awscli-1.18.69/awscli/examples/detective/list-graphs.rst --- awscli-1.11.13/awscli/examples/detective/list-graphs.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/detective/list-graphs.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/detective/list-invitations.rst awscli-1.18.69/awscli/examples/detective/list-invitations.rst --- awscli-1.11.13/awscli/examples/detective/list-invitations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/detective/list-invitations.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/detective/list-members.rst awscli-1.18.69/awscli/examples/detective/list-members.rst --- awscli-1.11.13/awscli/examples/detective/list-members.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/detective/list-members.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/detective/reject-invitation.rst awscli-1.18.69/awscli/examples/detective/reject-invitation.rst --- awscli-1.11.13/awscli/examples/detective/reject-invitation.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/detective/reject-invitation.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/devicefarm/create-device-pool.rst awscli-1.18.69/awscli/examples/devicefarm/create-device-pool.rst --- awscli-1.11.13/awscli/examples/devicefarm/create-device-pool.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/devicefarm/create-device-pool.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,32 @@ +**To create a device pool** + +The following command creates an Android device pool for a project:: + + aws devicefarm create-device-pool --name pool1 --rules file://device-pool-rules.json --project-arn "arn:aws:devicefarm:us-west-2:123456789012:project:070fc3ca-7ec1-4741-9c1f-d3e044efc506" + +You can get the project ARN from the output of ``create-project`` or ``list-projects``. The file ``device-pool-rules.json`` is a JSON document in the current folder that specifies the device platform:: + + [ + { + "attribute": "PLATFORM", + "operator": "EQUALS", + "value": "\"ANDROID\"" + } + ] + +Output:: + + { + "devicePool": { + "rules": [ + { + "operator": "EQUALS", + "attribute": "PLATFORM", + "value": "\"ANDROID\"" + } + ], + "type": "PRIVATE", + "name": "pool1", + "arn": "arn:aws:devicefarm:us-west-2:123456789012:devicepool:070fc3ca-7ec1-4741-9c1f-d3e044efc506/2aa8d2a9-5e73-47ca-b929-659cb34b7dcd" + } + } diff -Nru awscli-1.11.13/awscli/examples/devicefarm/create-project.rst awscli-1.18.69/awscli/examples/devicefarm/create-project.rst --- awscli-1.11.13/awscli/examples/devicefarm/create-project.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/devicefarm/create-project.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,15 @@ +**To create a project** + +The following command creates a new project named ``my-project``:: + + aws devicefarm create-project --name my-project + +Output:: + + { + "project": { + "name": "myproject", + "arn": "arn:aws:devicefarm:us-west-2:123456789012:project:070fc3ca-7ec1-4741-9c1f-d3e044efc506", + "created": 1503612890.057 + } + } diff -Nru awscli-1.11.13/awscli/examples/devicefarm/create-upload.rst awscli-1.18.69/awscli/examples/devicefarm/create-upload.rst --- awscli-1.11.13/awscli/examples/devicefarm/create-upload.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/devicefarm/create-upload.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,24 @@ +**To create an upload** + +The following command creates an upload for an Android app:: + + aws devicefarm create-upload --project-arn "arn:aws:devicefarm:us-west-2:123456789012:project:070fc3ca-7ec1-4741-9c1f-d3e044efc506" --name app.apk --type ANDROID_APP + +You can get the project ARN from the output of `create-project` or `list-projects`. + +Output:: + + { + "upload": { + "status": "INITIALIZED", + "name": "app.apk", + "created": 1503614408.769, + "url": "https://prod-us-west-2-uploads.s3-us-west-2.amazonaws.com/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A123456789012%3Aproject%3A070fc3ca-c7e1-4471-91cf-d3e4efc50604/uploads/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A123456789012%3Aupload%3A070fc3ca-7ec1-4741-9c1f-d3e044efc506/dd72723a-ae9e-4087-09e6-f4cea3599514/app.apk?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20170824T224008Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=AKIAEXAMPLEPBUMBC3GA%2F20170824%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=05050370c38894ef5bd09f5d009f36fc8f96fa4bb04e1bba9aca71b8dbe49a0f", + "type": "ANDROID_APP", + "arn": "arn:aws:devicefarm:us-west-2:123456789012:upload:070fc3ca-7ec1-4741-9c1f-d3e044efc506/dd72723a-ae9e-4087-09e6-f4cea3599514" + } + } + +Use the signed URL in the output to upload a file to Device Farm:: + + curl -T app.apk "https://prod-us-west-2-uploads.s3-us-west-2.amazonaws.com/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A123456789012%3Aproject%3A070fc3ca-c7e1-4471-91cf-d3e4efc50604/uploads/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A123456789012%3Aupload%3A070fc3ca-7ec1-4741-9c1f-d3e044efc506/dd72723a-ae9e-4087-09e6-f4cea3599514/app.apk?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20170824T224008Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=AKIAEXAMPLEPBUMBC3GA%2F20170824%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=05050370c38894ef5bd09f5d009f36fc8f96fa4bb04e1bba9aca71b8dbe49a0f" diff -Nru awscli-1.11.13/awscli/examples/devicefarm/get-upload.rst awscli-1.18.69/awscli/examples/devicefarm/get-upload.rst --- awscli-1.11.13/awscli/examples/devicefarm/get-upload.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/devicefarm/get-upload.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To view an upload** + +The following command retrieves information about an upload:: + + aws devicefarm get-upload --arn "arn:aws:devicefarm:us-west-2:123456789012:upload:070fc3ca-7ec1-4741-9c1f-d3e044efc506/dd72723a-ae9e-4087-09e6-f4cea3599514" + +You can get the upload ARN from the output of ``create-upload``. + +Output:: + + { + "upload": { + "status": "SUCCEEDED", + "name": "app.apk", + "created": 1505262773.186, + "type": "ANDROID_APP", + "arn": "arn:aws:devicefarm:us-west-2:123456789012:upload:070fc3ca-7ec1-4741-9c1f-d3e044efc506/dd72723a-ae9e-4087-09e6-f4cea3599514", + "metadata": "{\"device_admin\":false,\"activity_name\":\"ccom.example.client.LauncherActivity\",\"version_name\":\"1.0.2.94\",\"screens\":[\"small\",\"normal\",\"large\",\"xlarge\"],\"error_type\":null,\"sdk_version\":\"16\",\"package_name\":\"com.example.client\",\"version_code\":\"20994\",\"native_code\":[\"armeabi-v7a\"],\"target_sdk_version\":\"25\"}" + } + } + diff -Nru awscli-1.11.13/awscli/examples/devicefarm/list-projects.rst awscli-1.18.69/awscli/examples/devicefarm/list-projects.rst --- awscli-1.11.13/awscli/examples/devicefarm/list-projects.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/devicefarm/list-projects.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,22 @@ +**To list projects** + +The following retrieves a list of projects:: + + aws devicefarm list-projects + +Output:: + + { + "projects": [ + { + "name": "myproject", + "arn": "arn:aws:devicefarm:us-west-2:123456789012:project:070fc3ca-7ec1-4741-9c1f-d3e044efc506", + "created": 1503612890.057 + }, + { + "name": "otherproject", + "arn": "arn:aws:devicefarm:us-west-2:123456789012:project:a5f5b752-8098-49d1-86bf-5f7682c1c77e", + "created": 1505257519.337 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/directconnect/accept-direct-connect-gateway-association-proposal.rst awscli-1.18.69/awscli/examples/directconnect/accept-direct-connect-gateway-association-proposal.rst --- awscli-1.11.13/awscli/examples/directconnect/accept-direct-connect-gateway-association-proposal.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/directconnect/accept-direct-connect-gateway-association-proposal.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,30 @@ +**To accept a gateway association proposal** + +The following ``accept-direct-connect-gateway-association-proposal`` accepts the specified proposal. :: + + aws directconnect accept-direct-connect-gateway-association-proposal \ + --direct-connect-gateway-id 11460968-4ac1-4fd3-bdb2-00599EXAMPLE \ + --proposal-id cb7f41cb-8128-43a5-93b1-dcaedEXAMPLE \ + --associated-gateway-owner-account 111122223333 + + { + "directConnectGatewayAssociation": { + "directConnectGatewayId": "11460968-4ac1-4fd3-bdb2-00599EXAMPLE", + "directConnectGatewayOwnerAccount": "111122223333", + "associationState": "associating", + "associatedGateway": { + "id": "tgw-02f776b1a7EXAMPLE", + "type": "transitGateway", + "ownerAccount": "111122223333", + "region": "us-east-1" + }, + "associationId": "6441f8bf-5917-4279-ade1-9708bEXAMPLE", + "allowedPrefixesToDirectConnectGateway": [ + { + "cidr": "192.168.1.0/30" + } + ] + } + } + +For more information, see `Accepting or Rejecting a Transit Gateway Association Proposal `__ in the *AWS Direct Connect User Guide*. diff -Nru awscli-1.11.13/awscli/examples/directconnect/allocate-hosted-connection.rst awscli-1.18.69/awscli/examples/directconnect/allocate-hosted-connection.rst --- awscli-1.11.13/awscli/examples/directconnect/allocate-hosted-connection.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/directconnect/allocate-hosted-connection.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,24 @@ +**To create a hosted connection on an interconnect** + +The following ``allocate-hosted-connection`` example creates a hosted connection on the specified interconnect. :: + + aws directconnect allocate-hosted-connection \ + --bandwidth 500Mbps \ + --connection-name mydcinterconnect \ + --owner-account 123456789012 + -connection-id dxcon-fgktov66 + -vlan 101 + +Output:: + + { + "partnerName": "TIVIT", + "vlan": 101, + "ownerAccount": "123456789012", + "connectionId": "dxcon-ffzc51m1", + "connectionState": "ordering", + "bandwidth": "500Mbps", + "location": "TIVIT", + "connectionName": "mydcinterconnect", + "region": "sa-east-1" + } diff -Nru awscli-1.11.13/awscli/examples/directconnect/allocate-transit-virtual-interface.rst awscli-1.18.69/awscli/examples/directconnect/allocate-transit-virtual-interface.rst --- awscli-1.11.13/awscli/examples/directconnect/allocate-transit-virtual-interface.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/directconnect/allocate-transit-virtual-interface.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,58 @@ +**To provision a transit virtual interface to be owned by the specified AWS account** + +The following ``allocate-transit-virtual-interface`` example provisions a transit virtual interface for the specified account. :: + + aws directconnect allocate-transit-virtual-interface \ + --connection-id dxlag-fEXAMPLE \ + --owner-account 123456789012 \ + --new-transit-virtual-interface-allocation "virtualInterfaceName=Example Transit Virtual Interface,vlan=126,asn=65110,mtu=1500,authKey=0xzxgA9YoW9h58u8SEXAMPLE,amazonAddress=192.168.1.1/30,customerAddress=192.168.1.2/30,addressFamily=ipv4,tags=[{key=Tag,value=Example}]" + +Output:: + + { + "virtualInterface": { + "ownerAccount": "123456789012", + "virtualInterfaceId": "dxvif-fEXAMPLE", + "location": "loc1", + "connectionId": "dxlag-fEXAMPLE", + "virtualInterfaceType": "transit", + "virtualInterfaceName": "Example Transit Virtual Interface", + "vlan": 126, + "asn": 65110, + "amazonSideAsn": 7224, + "authKey": "0xzxgA9YoW9h58u8SEXAMPLE", + "amazonAddress": "192.168.1.1/30", + "customerAddress": "192.168.1.2/30", + "addressFamily": "ipv4", + "virtualInterfaceState": "confirming", + "customerRouterConfig": "\n\n 126\n 192.168.1.2/30\n 192.168.1.1/30\n 65110\n 0xzxgA9YoW9h58u8SEXAMPLE\n 7224\n transit\n\n", + "mtu": 1500, + "jumboFrameCapable": true, + "virtualGatewayId": "", + "directConnectGatewayId": "", + "routeFilterPrefixes": [], + "bgpPeers": [ + { + "bgpPeerId": "dxpeer-fEXAMPLE", + "asn": 65110, + "authKey": "0xzxgA9YoW9h58u8EXAMPLE", + "addressFamily": "ipv4", + "amazonAddress": "192.168.1.1/30", + "customerAddress": "192.168.1.2/30", + "bgpPeerState": "pending", + "bgpStatus": "down", + "awsDeviceV2": "loc1-26wz6vEXAMPLE" + } + ], + "region": "sa-east-1", + "awsDeviceV2": "loc1-26wz6vEXAMPLE", + "tags": [ + { + "key": "Tag", + "value": "Example" + } + ] + } + } + +For more information, see `Creating a Hosted Transit Virtual Interface `__ in the *AWS Direct Connect User Guide*. diff -Nru awscli-1.11.13/awscli/examples/directconnect/associate-connection-with-lag.rst awscli-1.18.69/awscli/examples/directconnect/associate-connection-with-lag.rst --- awscli-1.11.13/awscli/examples/directconnect/associate-connection-with-lag.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/directconnect/associate-connection-with-lag.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,20 @@ +**To associate a connection with a LAG** + +The following example associates the specified connection with the specified LAG. + +Command:: + + aws directconnect associate-connection-with-lag --lag-id dxlag-fhccu14t --connection-id dxcon-fg9607vm + +Output:: + + { + "ownerAccount": "123456789012", + "connectionId": "dxcon-fg9607vm", + "lagId": "dxlag-fhccu14t", + "connectionState": "requested", + "bandwidth": "1Gbps", + "location": "EqDC2", + "connectionName": "Con2ForLag", + "region": "us-east-1" + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/directconnect/associate-hosted-connection.rst awscli-1.18.69/awscli/examples/directconnect/associate-hosted-connection.rst --- awscli-1.11.13/awscli/examples/directconnect/associate-hosted-connection.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/directconnect/associate-hosted-connection.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,22 @@ +**To associate a hosted connection with a LAG** + +The following example associates the specified hosted connection with the specified LAG. + +Command:: + + aws directconnect associate-hosted-connection --parent-connection-id dxlag-fhccu14t --connection-id dxcon-fg9607vm + +Output:: + + { + "partnerName": "TIVIT", + "vlan": 101, + "ownerAccount": "123456789012", + "connectionId": "dxcon-fg9607vm", + "lagId": "dxlag-fhccu14t", + "connectionState": "ordering", + "bandwidth": "500Mbps", + "location": "TIVIT", + "connectionName": "mydcinterconnect", + "region": "sa-east-1" + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/directconnect/associate-virtual-interface.rst awscli-1.18.69/awscli/examples/directconnect/associate-virtual-interface.rst --- awscli-1.11.13/awscli/examples/directconnect/associate-virtual-interface.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/directconnect/associate-virtual-interface.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,48 @@ +**To associate a virtual interface with a connection** + +The following example associates the specified virtual interface with the specified LAG. Alternatively, to associate the virtual interface with a connection, specify the ID of an AWS Direct Connect connection for ``--connection-id``; for example, ``dxcon-ffnikghc``. + +Command:: + + aws directconnect associate-virtual-interface --connection-id dxlag-ffjhj9lx --virtual-interface-id dxvif-fgputw0j + +Output:: + + { + "virtualInterfaceState": "pending", + "asn": 65000, + "vlan": 123, + "customerAddress": "169.254.255.2/30", + "ownerAccount": "123456789012", + "connectionId": "dxlag-ffjhj9lx", + "addressFamily": "ipv4", + "virtualGatewayId": "vgw-38e90b51", + "virtualInterfaceId": "dxvif-fgputw0j", + "authKey": "0x123pK5_VBqv.UQ3kJ4123_", + "routeFilterPrefixes": [], + "location": "CSVA1", + "bgpPeers": [ + { + "bgpStatus": "down", + "customerAddress": "169.254.255.2/30", + "addressFamily": "ipv4", + "authKey": "0x123pK5_VBqv.UQ3kJ4123_", + "bgpPeerState": "deleting", + "amazonAddress": "169.254.255.1/30", + "asn": 65000 + }, + { + "bgpStatus": "down", + "customerAddress": "169.254.255.2/30", + "addressFamily": "ipv4", + "authKey": "0x123pK5_VBqv.UQ3kJ4123_", + "bgpPeerState": "pending", + "amazonAddress": "169.254.255.1/30", + "asn": 65000 + } + ], + "customerRouterConfig": "\n\n 123\n 169.254.255.2/30\n 169.254.255.1/30\n 65000\n 0x123pK5_VBqv.UQ3kJ4123_\n 7224\n private\n\n", + "amazonAddress": "169.254.255.1/30", + "virtualInterfaceType": "private", + "virtualInterfaceName": "VIF1A" + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/directconnect/confirm-transit-virtual-interface.rst awscli-1.18.69/awscli/examples/directconnect/confirm-transit-virtual-interface.rst --- awscli-1.11.13/awscli/examples/directconnect/confirm-transit-virtual-interface.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/directconnect/confirm-transit-virtual-interface.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,15 @@ +**To accept ownership of a transit virtual interface** + +The following ``confirm-transit-virtual-interface`` accepts ownership of a transit virtual interface created by another customer. :: + + aws directconnect confirm-transit-virtual-interface \ + --virtual-interface-id dxvif-fEXAMPLE \ + --direct-connect-gateway-id 4112ccf9-25e9-4111-8237-b6c5dEXAMPLE + +Output:: + + { + "virtualInterfaceState": "pending" + } + +For more information, see `Accepting a Hosted Virtual Interface `__ in the *AWS Direct Connect User Guide*. diff -Nru awscli-1.11.13/awscli/examples/directconnect/create-bgp-peer.rst awscli-1.18.69/awscli/examples/directconnect/create-bgp-peer.rst --- awscli-1.11.13/awscli/examples/directconnect/create-bgp-peer.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/directconnect/create-bgp-peer.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,50 @@ +**To create an IPv6 BGP peering session** + +The following example creates an IPv6 BGP peering session on private virtual interface ``dxvif-fg1vuj3d``. The peer IPv6 addresses are automatically allocated by Amazon. + +Command:: + + aws directconnect create-bgp-peer --virtual-interface-id dxvif-fg1vuj3d --new-bgp-peer asn=64600,addressFamily=ipv6 + +Output:: + + { + "virtualInterface": { + "virtualInterfaceState": "available", + "asn": 65000, + "vlan": 125, + "customerAddress": "169.254.255.2/30", + "ownerAccount": "123456789012", + "connectionId": "dxcon-fguhmqlc", + "addressFamily": "ipv4", + "virtualGatewayId": "vgw-f9eb0c90", + "virtualInterfaceId": "dxvif-fg1vuj3d", + "authKey": "0xC_ukbCerl6EYA0example", + "routeFilterPrefixes": [], + "location": "EqDC2", + "bgpPeers": [ + { + "bgpStatus": "down", + "customerAddress": "169.254.255.2/30", + "addressFamily": "ipv4", + "authKey": "0xC_ukbCerl6EYA0uexample", + "bgpPeerState": "available", + "amazonAddress": "169.254.255.1/30", + "asn": 65000 + }, + { + "bgpStatus": "down", + "customerAddress": "2001:db8:1100:2f0:0:1:9cb4:4216/125", + "addressFamily": "ipv6", + "authKey": "0xS27kAIU_VHPjjAexample", + "bgpPeerState": "pending", + "amazonAddress": "2001:db8:1100:2f0:0:1:9cb4:4211/125", + "asn": 64600 + } + ], + "customerRouterConfig": "\n\n 125\n 169.254.255.2/30\n 169.254.255.1/30\n 65000\n 0xC_ukbCerl6EYA0uexample\n 2001:db8:1100:2f0:0:1:9cb4:4216/125\n 2001:db8:1100:2f0:0:1:9cb4:4211/125\n 64600\n 0xS27kAIU_VHPjjAexample\n 7224\n private\n\n", + "amazonAddress": "169.254.255.1/30", + "virtualInterfaceType": "private", + "virtualInterfaceName": "Test" + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/directconnect/create-direct-connect-gateway-association-proposal.rst awscli-1.18.69/awscli/examples/directconnect/create-direct-connect-gateway-association-proposal.rst --- awscli-1.11.13/awscli/examples/directconnect/create-direct-connect-gateway-association-proposal.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/directconnect/create-direct-connect-gateway-association-proposal.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,33 @@ +**To create a proposal to associate the specified transit gateway with the specified Direct Connect gateway** + +The following ``create-direct-connect-gateway-association-proposal`` example creates a proposal that associates the specified transit gateway with the specified Direct Connect gateway. :: + + aws directconnect create-direct-connect-gateway-association-proposal \ + --direct-connect-gateway-id 11460968-4ac1-4fd3-bdb2-00599EXAMPLE \ + --direct-connect-gateway-owner-account 111122223333 \ + --gateway-id tgw-02f776b1a7EXAMPLE \ + --add-allowed-prefixes-to-direct-connect-gateway cidr=192.168.1.0/30 + +Output:: + + { + "directConnectGatewayAssociationProposal": { + "proposalId": "cb7f41cb-8128-43a5-93b1-dcaedEXAMPLE", + "directConnectGatewayId": "11460968-4ac1-4fd3-bdb2-00599EXAMPLE", + "directConnectGatewayOwnerAccount": "111122223333", + "proposalState": "requested", + "associatedGateway": { + "id": "tgw-02f776b1a7EXAMPLE", + "type": "transitGateway", + "ownerAccount": "111122223333", + "region": "us-east-1" + }, + "requestedAllowedPrefixesToDirectConnectGateway": [ + { + "cidr": "192.168.1.0/30" + } + ] + } + } + +For more information, see `Creating a Transit Gateway Association Proposal `__ in the *AWS Direct Connect User Guide*. diff -Nru awscli-1.11.13/awscli/examples/directconnect/create-direct-connect-gateway-association.rst awscli-1.18.69/awscli/examples/directconnect/create-direct-connect-gateway-association.rst --- awscli-1.11.13/awscli/examples/directconnect/create-direct-connect-gateway-association.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/directconnect/create-direct-connect-gateway-association.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To associate a virtual private gateway with a Direct Connect gateway** + +The following example associates virtual private gateway ``vgw-6efe725e`` with Direct Connect gateway ``5f294f92-bafb-4011-916d-9b0bexample``. You must run the command in the region in which the virtual private gateway is located. + +Command:: + + aws directconnect create-direct-connect-gateway-association --direct-connect-gateway-id 5f294f92-bafb-4011-916d-9b0bexample --virtual-gateway-id vgw-6efe725e + +Output:: + + { + "directConnectGatewayAssociation": { + "associationState": "associating", + "virtualGatewayOwnerAccount": "123456789012", + "directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bexample", + "virtualGatewayId": "vgw-6efe725e", + "virtualGatewayRegion": "us-east-2" + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/directconnect/create-direct-connect-gateway.rst awscli-1.18.69/awscli/examples/directconnect/create-direct-connect-gateway.rst --- awscli-1.11.13/awscli/examples/directconnect/create-direct-connect-gateway.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/directconnect/create-direct-connect-gateway.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To create a Direct Connect gateway** + +The following example creates a Direct Connect gateway with the name ``DxGateway1``. + +Command:: + + aws directconnect create-direct-connect-gateway --direct-connect-gateway-name "DxGateway1" + +Output:: + + { + "directConnectGateway": { + "amazonSideAsn": 64512, + "directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bdexample", + "ownerAccount": "123456789012", + "directConnectGatewayName": "DxGateway1", + "directConnectGatewayState": "available" + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/directconnect/create-lag.rst awscli-1.18.69/awscli/examples/directconnect/create-lag.rst --- awscli-1.11.13/awscli/examples/directconnect/create-lag.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/directconnect/create-lag.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,89 @@ +**To create a LAG with new connections** + +The following example creates a LAG and requests two new AWS Direct Connect connections for the LAG with a bandwidth of 1 Gbps. + +Command:: + + aws directconnect create-lag --location CSVA1 --number-of-connections 2 --connections-bandwidth 1Gbps --lag-name 1GBLag + +Output:: + + { + "awsDevice": "CSVA1-23u8tlpaz8iks", + "numberOfConnections": 2, + "lagState": "pending", + "ownerAccount": "123456789012", + "lagName": "1GBLag", + "connections": [ + { + "ownerAccount": "123456789012", + "connectionId": "dxcon-ffqr6x5q", + "lagId": "dxlag-ffjhj9lx", + "connectionState": "requested", + "bandwidth": "1Gbps", + "location": "CSVA1", + "connectionName": "Requested Connection 1 for Lag dxlag-ffjhj9lx", + "region": "us-east-1" + }, + { + "ownerAccount": "123456789012", + "connectionId": "dxcon-fflqyj95", + "lagId": "dxlag-ffjhj9lx", + "connectionState": "requested", + "bandwidth": "1Gbps", + "location": "CSVA1", + "connectionName": "Requested Connection 2 for Lag dxlag-ffjhj9lx", + "region": "us-east-1" + } + ], + "lagId": "dxlag-ffjhj9lx", + "minimumLinks": 0, + "connectionsBandwidth": "1Gbps", + "region": "us-east-1", + "location": "CSVA1" + } + +**To create a LAG using an existing connection** + +The following example creates a LAG from an existing connection in your account, and requests a second new connection for the LAG with the same bandwidth and location as the existing connection. + +Command:: + + aws directconnect create-lag --location EqDC2 --number-of-connections 2 --connections-bandwidth 1Gbps --lag-name 2ConnLAG --connection-id dxcon-fgk145dr + +Output:: + + { + "awsDevice": "EqDC2-4h6ce2r1bes6", + "numberOfConnections": 2, + "lagState": "pending", + "ownerAccount": "123456789012", + "lagName": "2ConnLAG", + "connections": [ + { + "ownerAccount": "123456789012", + "connectionId": "dxcon-fh6ljcvo", + "lagId": "dxlag-fhccu14t", + "connectionState": "requested", + "bandwidth": "1Gbps", + "location": "EqDC2", + "connectionName": "Requested Connection 1 for Lag dxlag-fhccu14t", + "region": "us-east-1" + }, + { + "ownerAccount": "123456789012", + "connectionId": "dxcon-fgk145dr", + "lagId": "dxlag-fhccu14t", + "connectionState": "down", + "bandwidth": "1Gbps", + "location": "EqDC2", + "connectionName": "VAConn1", + "region": "us-east-1" + } + ], + "lagId": "dxlag-fhccu14t", + "minimumLinks": 0, + "connectionsBandwidth": "1Gbps", + "region": "us-east-1", + "location": "EqDC2" + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/directconnect/create-transit-virtual-interface.rst awscli-1.18.69/awscli/examples/directconnect/create-transit-virtual-interface.rst --- awscli-1.11.13/awscli/examples/directconnect/create-transit-virtual-interface.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/directconnect/create-transit-virtual-interface.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,57 @@ +**To create a transit virtual interface** + +The following ``create-transit-virtual-interface`` example creates a transit virtual interface for the specified connection. :: + + ws directconnect create-transit-virtual-interface \ + --connection-id dxlag-fEXAMPLE \ + --new-transit-virtual-interface "virtualInterfaceName=Example Transit Virtual Interface,vlan=126,asn=65110,mtu=1500,authKey=0xzxgA9YoW9h58u8SvEXAMPLE,amazonAddress=192.168.1.1/30,customerAddress=192.168.1.2/30,addressFamily=ipv4,directConnectGatewayId=8384da05-13ce-4a91-aada-5a1baEXAMPLE,tags=[{key=Tag,value=Example}]" + +Output:: + + { + "virtualInterface": { + "ownerAccount": "1111222233333", + "virtualInterfaceId": "dxvif-fEXAMPLE", + "location": "loc1", + "connectionId": "dxlag-fEXAMPLE", + "virtualInterfaceType": "transit", + "virtualInterfaceName": "Example Transit Virtual Interface", + "vlan": 126, + "asn": 65110, + "amazonSideAsn": 4200000000, + "authKey": "0xzxgA9YoW9h58u8SEXAMPLE", + "amazonAddress": "192.168.1.1/30", + "customerAddress": "192.168.1.2/30", + "addressFamily": "ipv4", + "virtualInterfaceState": "pending", + "customerRouterConfig": "\n\n 126\n 192.168.1.2/30\n 192.168.1.1/30\n 65110\n 0xzxgA9YoW9h58u8SvOmXRTw\n 4200000000\n transit\n\n", + "mtu": 1500, + "jumboFrameCapable": true, + "virtualGatewayId": "", + "directConnectGatewayId": "8384da05-13ce-4a91-aada-5a1baEXAMPLE", + "routeFilterPrefixes": [], + "bgpPeers": [ + { + "bgpPeerId": "dxpeer-EXAMPLE", + "asn": 65110, + "authKey": "0xzxgA9YoW9h58u8SEXAMPLE", + "addressFamily": "ipv4", + "amazonAddress": "192.168.1.1/30", + "customerAddress": "192.168.1.2/30", + "bgpPeerState": "pending", + "bgpStatus": "down", + "awsDeviceV2": "loc1-26wz6vEXAMPLE" + } + ], + "region": "sa-east-1", + "awsDeviceV2": "loc1-26wz6vEXAMPLE", + "tags": [ + { + "key": "Tag", + "value": "Example" + } + ] + } + } + +For more information, see `Creating a Transit Virtual Interface to the Direct Connect Gateway `__ in the *AWS Direct Connect User Guide*. diff -Nru awscli-1.11.13/awscli/examples/directconnect/delete-bgp-peer.rst awscli-1.18.69/awscli/examples/directconnect/delete-bgp-peer.rst --- awscli-1.11.13/awscli/examples/directconnect/delete-bgp-peer.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/directconnect/delete-bgp-peer.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,50 @@ +**To delete a BGP peer from a virtual interface** + +The following example deletes the IPv6 BGP peer from virtual interface ``dxvif-fg1vuj3d``. + +Command:: + + aws directconnect delete-bgp-peer --virtual-interface-id dxvif-fg1vuj3d --asn 64600 --customer-address 2001:db8:1100:2f0:0:1:9cb4:4216/125 + +Output:: + + { + "virtualInterface": { + "virtualInterfaceState": "available", + "asn": 65000, + "vlan": 125, + "customerAddress": "169.254.255.2/30", + "ownerAccount": "123456789012", + "connectionId": "dxcon-fguhmqlc", + "addressFamily": "ipv4", + "virtualGatewayId": "vgw-f9eb0c90", + "virtualInterfaceId": "dxvif-fg1vuj3d", + "authKey": "0xC_ukbCerl6EYA0example", + "routeFilterPrefixes": [], + "location": "EqDC2", + "bgpPeers": [ + { + "bgpStatus": "down", + "customerAddress": "169.254.255.2/30", + "addressFamily": "ipv4", + "authKey": "0xC_ukbCerl6EYA0uexample", + "bgpPeerState": "available", + "amazonAddress": "169.254.255.1/30", + "asn": 65000 + }, + { + "bgpStatus": "down", + "customerAddress": "2001:db8:1100:2f0:0:1:9cb4:4216/125", + "addressFamily": "ipv6", + "authKey": "0xS27kAIU_VHPjjAexample", + "bgpPeerState": "deleting", + "amazonAddress": "2001:db8:1100:2f0:0:1:9cb4:4211/125", + "asn": 64600 + } + ], + "customerRouterConfig": "\n\n 125\n 169.254.255.2/30\n 169.254.255.1/30\n 65000\n 0xC_ukbCerl6EYA0example\n 7224\n private\n\n", + "amazonAddress": "169.254.255.1/30", + "virtualInterfaceType": "private", + "virtualInterfaceName": "Test" + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/directconnect/delete-direct-connect-gateway-association.rst awscli-1.18.69/awscli/examples/directconnect/delete-direct-connect-gateway-association.rst --- awscli-1.11.13/awscli/examples/directconnect/delete-direct-connect-gateway-association.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/directconnect/delete-direct-connect-gateway-association.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,29 @@ +**To delete a Direct Connect gateway association** + +The following ``delete-direct-connect-gateway-association`` example deletes the Direct Connect gateway association with a transit gateway that has the specified association ID. :: + + aws directconnect delete-direct-connect-gateway-association --association-id be85116d-46eb-4b43-a27a-da0c2ad648de + +Output:: + + { + "directConnectGatewayAssociation": { + "directConnectGatewayId": "11460968-4ac1-4fd3-bdb2-00599EXAMPlE", + "directConnectGatewayOwnerAccount": "123456789012", + "associationState": "disassociating", + "associatedGateway": { + "id": "tgw-095b3b0b54EXAMPLE", + "type": "transitGateway", + "ownerAccount": "123456789012", + "region": "us-east-1" + }, + "associationId": " be85116d-46eb-4b43-a27a-da0c2ad648deEXAMPLE ", + "allowedPrefixesToDirectConnectGateway": [ + { + "cidr": "192.0.1.0/28" + } + ] + } + } + +For more information, see `Associating and Disassociating Transit Gateways `_ in the *AWS Direct Connect User Guide*. diff -Nru awscli-1.11.13/awscli/examples/directconnect/delete-direct-connect-gateway.rst awscli-1.18.69/awscli/examples/directconnect/delete-direct-connect-gateway.rst --- awscli-1.11.13/awscli/examples/directconnect/delete-direct-connect-gateway.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/directconnect/delete-direct-connect-gateway.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To delete a Direct Connect gateway** + +The following example deletes Direct Connect gateway ``5f294f92-bafb-4011-916d-9b0bexample``. + +Command:: + + aws directconnect delete-direct-connect-gateway --direct-connect-gateway-id 5f294f92-bafb-4011-916d-9b0bexample + +Output:: + + { + "directConnectGateway": { + "amazonSideAsn": 64512, + "directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bexample", + "ownerAccount": "123456789012", + "directConnectGatewayName": "DxGateway1", + "directConnectGatewayState": "deleting" + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/directconnect/delete-lag.rst awscli-1.18.69/awscli/examples/directconnect/delete-lag.rst --- awscli-1.11.13/awscli/examples/directconnect/delete-lag.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/directconnect/delete-lag.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,23 @@ +**To delete a LAG** + +The following example deletes the specified LAG. + +Command:: + + aws directconnect delete-lag --lag-id dxlag-ffrhowd9 + +Output:: + + { + "awsDevice": "EqDC2-4h6ce2r1bes6", + "numberOfConnections": 0, + "lagState": "deleted", + "ownerAccount": "123456789012", + "lagName": "TestLAG", + "connections": [], + "lagId": "dxlag-ffrhowd9", + "minimumLinks": 0, + "connectionsBandwidth": "1Gbps", + "region": "us-east-1", + "location": "EqDC2" + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/directconnect/describe-connections.rst awscli-1.18.69/awscli/examples/directconnect/describe-connections.rst --- awscli-1.11.13/awscli/examples/directconnect/describe-connections.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/directconnect/describe-connections.rst 2020-05-28 19:25:48.000000000 +0000 @@ -7,15 +7,18 @@ Output:: { - "connections": [ - { - "ownerAccount": "123456789012", - "connectionId": "dxcon-fg31dyv6", - "connectionState": "requested", - "bandwidth": "1Gbps", - "location": "TIVIT", - "connectionName": "Connection to AWS", - "region": "sa-east-1" - } - ] - } \ No newline at end of file + "connections": [ + { + "awsDevice": "EqDC2-123h49s71dabc", + "ownerAccount": "123456789012", + "connectionId": "dxcon-fguhmqlc", + "lagId": "dxlag-ffrz71kw", + "connectionState": "down", + "bandwidth": "1Gbps", + "location": "EqDC2", + "connectionName": "My_Connection", + "loaIssueTime": 1491568964.0, + "region": "us-east-1" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/directconnect/describe-direct-connect-gateway-association-proposals.rst awscli-1.18.69/awscli/examples/directconnect/describe-direct-connect-gateway-association-proposals.rst --- awscli-1.11.13/awscli/examples/directconnect/describe-direct-connect-gateway-association-proposals.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/directconnect/describe-direct-connect-gateway-association-proposals.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,64 @@ +**To describe your Direct Connect gateway association proposals** + +The following ``describe-direct-connect-gateway-association-proposals`` example displays details about your Direct Connect gateway association proposals. :: + + aws directconnect describe-direct-connect-gateway-association-proposals + +Output:: + + { + "directConnectGatewayAssociationProposals": [ + { + "proposalId": "c2ede9b4-bbc6-4d33-923c-bc4feEXAMPLE", + "directConnectGatewayId": "11460968-4ac1-4fd3-bdb2-00599EXAMPLE", + "directConnectGatewayOwnerAccount": "111122223333", + "proposalState": "requested", + "associatedGateway": { + "id": "tgw-02f776b1a7EXAMPLE", + "type": "transitGateway", + "ownerAccount": "111122223333", + "region": "us-east-1" + }, + "existingAllowedPrefixesToDirectConnectGateway": [ + { + "cidr": "192.168.2.0/30" + }, + { + "cidr": "192.168.1.0/30" + } + ], + "requestedAllowedPrefixesToDirectConnectGateway": [ + { + "cidr": "192.168.1.0/30" + } + ] + }, + { + "proposalId": "cb7f41cb-8128-43a5-93b1-dcaedEXAMPLE", + "directConnectGatewayId": "11560968-4ac1-4fd3-bcb2-00599EXAMPLE", + "directConnectGatewayOwnerAccount": "111122223333", + "proposalState": "accepted", + "associatedGateway": { + "id": "tgw-045776b1a7EXAMPLE", + "type": "transitGateway", + "ownerAccount": "111122223333", + "region": "us-east-1" + }, + "existingAllowedPrefixesToDirectConnectGateway": [ + { + "cidr": "192.168.4.0/30" + }, + { + "cidr": "192.168.5.0/30" + } + ], + "requestedAllowedPrefixesToDirectConnectGateway": [ + { + "cidr": "192.168.5.0/30" + } + ] + } + ] + } + +For more information, see `Associating and Disassociating Transit Gateways `__ in the *AWS Direct Connect User Guide*. diff -Nru awscli-1.11.13/awscli/examples/directconnect/describe-direct-connect-gateway-associations.rst awscli-1.18.69/awscli/examples/directconnect/describe-direct-connect-gateway-associations.rst --- awscli-1.11.13/awscli/examples/directconnect/describe-direct-connect-gateway-associations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/directconnect/describe-direct-connect-gateway-associations.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,29 @@ +**To describe Direct Connect gateway associations** + +The following example describes all the associations with Direct Connect gateway ``5f294f92-bafb-4011-916d-9b0bexample``. + +Command:: + + aws directconnect describe-direct-connect-gateway-associations --direct-connect-gateway-id 5f294f92-bafb-4011-916d-9b0bexample + +Output:: + + { + "nextToken": "eyJ2IjoxLCJzIjoxLCJpIjoiOU83OTFodzdycnZCbkN4MExHeHVwQT09IiwiYyI6InIxTEN0UEVHV0I1UFlkaWFnNlUxanJkRWF6eW1iOElHM0FRVW1MdHRJK0dxcnN1RWtvcFBKWFE2ZjRNRGdGTkhCa0tDZmVINEtZOEYwZ0dEYWZpbmU0ZnZMYVhKRjdXRVdENmdQZ1Y4d2w0PSJ9", + "directConnectGatewayAssociations": [ + { + "associationState": "associating", + "virtualGatewayOwnerAccount": "123456789012", + "directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bexample", + "virtualGatewayId": "vgw-6efe725e", + "virtualGatewayRegion": "us-east-2" + }, + { + "associationState": "disassociating", + "virtualGatewayOwnerAccount": "123456789012", + "directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bexample", + "virtualGatewayId": "vgw-ebaa27db", + "virtualGatewayRegion": "us-east-2" + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/directconnect/describe-direct-connect-gateway-attachments.rst awscli-1.18.69/awscli/examples/directconnect/describe-direct-connect-gateway-attachments.rst --- awscli-1.11.13/awscli/examples/directconnect/describe-direct-connect-gateway-attachments.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/directconnect/describe-direct-connect-gateway-attachments.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,22 @@ +**To describe Direct Connect gateway attachments** + +The following example describes the virtual interfaces that are attached to Direct Connect gateway ``5f294f92-bafb-4011-916d-9b0bexample``. + +Command:: + + aws directconnect describe-direct-connect-gateway-attachments --direct-connect-gateway-id 5f294f92-bafb-4011-916d-9b0bexample + +Output:: + + { + "directConnectGatewayAttachments": [ + { + "virtualInterfaceOwnerAccount": "123456789012", + "directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bexample", + "virtualInterfaceRegion": "us-east-2", + "attachmentState": "attaching", + "virtualInterfaceId": "dxvif-fg9zyabc" + } + ], + "nextToken": "eyJ2IjoxLCJzIjoxLCJpIjoibEhXdlNpUXF5RzhoL1JyUW52SlV2QT09IiwiYyI6Im5wQjFHQ0RyQUdRS3puNnNXcUlINCtkTTA4dTk3KzBiU0xtb05JQmlaczZ6NXRIYmk3c3VESUxFTTd6a2FzVHM0VTFwaGJkZGNxTytqWmQ3QzMzOGRQaTVrTThrOG1zelRsV3gyMWV3VTNFPSJ9" + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/directconnect/describe-direct-connect-gateways.rst awscli-1.18.69/awscli/examples/directconnect/describe-direct-connect-gateways.rst --- awscli-1.11.13/awscli/examples/directconnect/describe-direct-connect-gateways.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/directconnect/describe-direct-connect-gateways.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,28 @@ +**To describe your Direct Connect gateways** + +The following example describe all of your Direct Connect gateways. + +Command:: + + aws directconnect describe-direct-connect-gateways + +Output:: + + { + "directConnectGateways": [ + { + "amazonSideAsn": 64512, + "directConnectGatewayId": "cf68415c-f4ae-48f2-87a7-3b52cexample", + "ownerAccount": "123456789012", + "directConnectGatewayName": "DxGateway2", + "directConnectGatewayState": "available" + }, + { + "amazonSideAsn": 64512, + "directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bdexample", + "ownerAccount": "123456789012", + "directConnectGatewayName": "DxGateway1", + "directConnectGatewayState": "available" + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/directconnect/describe-hosted-connections.rst awscli-1.18.69/awscli/examples/directconnect/describe-hosted-connections.rst --- awscli-1.11.13/awscli/examples/directconnect/describe-hosted-connections.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/directconnect/describe-hosted-connections.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,25 @@ +**To list connections on an interconnect** + +The following example lists connections that have been provisioned on the given interconnect. + +Command:: + + aws directconnect describe-hosted-connections --connection-id dxcon-fgktov66 + +Output:: + + { + "connections": [ + { + "partnerName": "TIVIT", + "vlan": 101, + "ownerAccount": "123456789012", + "connectionId": "dxcon-ffzc51m1", + "connectionState": "ordering", + "bandwidth": "500Mbps", + "location": "TIVIT", + "connectionName": "mydcinterconnect", + "region": "sa-east-1" + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/directconnect/describe-lags.rst awscli-1.18.69/awscli/examples/directconnect/describe-lags.rst --- awscli-1.11.13/awscli/examples/directconnect/describe-lags.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/directconnect/describe-lags.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,48 @@ +**To describe your LAGs** + +The following command describes all of your LAGs for the current region. + +Command:: + + aws directconnect describe-lags + +Output:: + + { + "lags": [ + { + "awsDevice": "EqDC2-19y7z3m17xpuz", + "numberOfConnections": 2, + "lagState": "down", + "ownerAccount": "123456789012", + "lagName": "DA-LAG", + "connections": [ + { + "ownerAccount": "123456789012", + "connectionId": "dxcon-ffnikghc", + "lagId": "dxlag-fgsu9erb", + "connectionState": "requested", + "bandwidth": "10Gbps", + "location": "EqDC2", + "connectionName": "Requested Connection 1 for Lag dxlag-fgsu9erb", + "region": "us-east-1" + }, + { + "ownerAccount": "123456789012", + "connectionId": "dxcon-fglgbdea", + "lagId": "dxlag-fgsu9erb", + "connectionState": "requested", + "bandwidth": "10Gbps", + "location": "EqDC2", + "connectionName": "Requested Connection 2 for Lag dxlag-fgsu9erb", + "region": "us-east-1" + } + ], + "lagId": "dxlag-fgsu9erb", + "minimumLinks": 0, + "connectionsBandwidth": "10Gbps", + "region": "us-east-1", + "location": "EqDC2" + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/directconnect/describe-loa.rst awscli-1.18.69/awscli/examples/directconnect/describe-loa.rst --- awscli-1.11.13/awscli/examples/directconnect/describe-loa.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/directconnect/describe-loa.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To describe your LOA-CFA for a connection using Linux or Mac OS X** + +The following example describes your LOA-CFA for connection ``dxcon-fh6ayh1d``. The contents of the LOA-CFA are base64-encoded. This command uses the ``--output`` and ``--query`` parameters to control the output and extract the contents of the ``loaContent`` structure. The final part of the command decodes the content using the ``base64`` utility, and sends the output to a PDF file. + +.. code:: + + aws directconnect describe-loa --connection-id dxcon-fh6ayh1d --output text --query loa.loaContent|base64 --decode > myLoaCfa.pdf + +**To describe your LOA-CFA for a connection using Windows** + +The previous example requires the use of the ``base64`` utility to decode the output. On a Windows computer, you can use ``certutil`` instead. In the following example, the first command describes your LOA-CFA for connection ``dxcon-fh6ayh1d`` and uses the ``--output`` and ``--query`` parameters to control the output and extract the contents of the ``loaContent`` structure to a file called ``myLoaCfa.base64``. The second command uses the ``certutil`` utility to decode the file and send the output to a PDF file. + +.. code:: + + aws directconnect describe-loa --connection-id dxcon-fh6ayh1d --output text --query loa.loaContent > myLoaCfa.base64 + +.. code:: + + certutil -decode myLoaCfa.base64 myLoaCfa.pdf + +For more information about controlling AWS CLI output, see `Controlling Command Output from the AWS Command Line Interface `_ in the *AWS Command Line Interface User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/directconnect/describe-tags.rst awscli-1.18.69/awscli/examples/directconnect/describe-tags.rst --- awscli-1.11.13/awscli/examples/directconnect/describe-tags.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/directconnect/describe-tags.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,23 @@ +**To describe tags for your AWS Direct Connect resources** + +The following command describes the tags for the connection ``dxcon-abcabc12``. + +Command:: + + aws directconnect describe-tags --resource-arns arn:aws:directconnect:us-east-1:123456789012:dxcon/dxcon-abcabc12 + +Output:: + + { + "resourceTags": [ + { + "resourceArn": "arn:aws:directconnect:us-east-1:123456789012:dxcon/dxcon-abcabc12", + "tags": [ + { + "value": "VAConnection", + "key": "Name" + } + ] + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/directconnect/disassociate-connection-from-lag.rst awscli-1.18.69/awscli/examples/directconnect/disassociate-connection-from-lag.rst --- awscli-1.11.13/awscli/examples/directconnect/disassociate-connection-from-lag.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/directconnect/disassociate-connection-from-lag.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To disassociate a connection from a LAG** + +The following example disassociates the specified connection from the specified LAG. + +Command:: + + aws directconnect disassociate-connection-from-lag --lag-id dxlag-fhccu14t --connection-id dxcon-fg9607vm + +Output:: + + { + "ownerAccount": "123456789012", + "connectionId": "dxcon-fg9607vm", + "connectionState": "requested", + "bandwidth": "1Gbps", + "location": "EqDC2", + "connectionName": "Con2ForLag", + "region": "us-east-1" + } diff -Nru awscli-1.11.13/awscli/examples/directconnect/tag-resource.rst awscli-1.18.69/awscli/examples/directconnect/tag-resource.rst --- awscli-1.11.13/awscli/examples/directconnect/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/directconnect/tag-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To add a tag to an AWS Direct Connect resource** + +The following command adds a tag with a key of ``Name`` and a value of ``VAConnection`` to the connection ``dxcon-abcabc12``. If the command succeeds, no output is returned. + +Command:: + + aws directconnect tag-resource --resource-arn arn:aws:directconnect:us-east-1:123456789012:dxcon/dxcon-abcabc12 --tags "key=Name,value=VAConnection" + diff -Nru awscli-1.11.13/awscli/examples/directconnect/untag-resource.rst awscli-1.18.69/awscli/examples/directconnect/untag-resource.rst --- awscli-1.11.13/awscli/examples/directconnect/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/directconnect/untag-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To remove a tag from an AWS Direct Connect resource** + +The following command removes the tag with the key ``Name`` from connection ``dxcon-abcabc12``. If the command succeeds, no output is returned. + +Command:: + + aws directconnect untag-resource --resource-arn arn:aws:directconnect:us-east-1:123456789012:dxcon/dxcon-abcabc12 --tag-keys Name + diff -Nru awscli-1.11.13/awscli/examples/directconnect/update-direct-connect-gateway-association.rst awscli-1.18.69/awscli/examples/directconnect/update-direct-connect-gateway-association.rst --- awscli-1.11.13/awscli/examples/directconnect/update-direct-connect-gateway-association.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/directconnect/update-direct-connect-gateway-association.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,34 @@ +**To update the specified attributes of the Direct Connect gateway association** + +The following ``update-direct-connect-gateway-association`` example adds the specified CIDR block to a Direct Connect gateway association. :: + + aws directconnect update-direct-connect-gateway-association \ + --association-id 820a6e4f-5374-4004-8317-3f64bEXAMPLE \ + --add-allowed-prefixes-to-direct-connect-gateway cidr=192.168.2.0/30 + +Output:: + + { + "directConnectGatewayAssociation": { + "directConnectGatewayId": "11460968-4ac1-4fd3-bdb2-00599EXAMPLE", + "directConnectGatewayOwnerAccount": "111122223333", + "associationState": "updating", + "associatedGateway": { + "id": "tgw-02f776b1a7EXAMPLE", + "type": "transitGateway", + "ownerAccount": "111122223333", + "region": "us-east-1" + }, + "associationId": "820a6e4f-5374-4004-8317-3f64bEXAMPLE", + "allowedPrefixesToDirectConnectGateway": [ + { + "cidr": "192.168.2.0/30" + }, + { + "cidr": "192.168.1.0/30" + } + ] + } + } + +For more information, see `Working with Direct Connect Gateways `__ in the *AWS Direct Connect User Guide*. diff -Nru awscli-1.11.13/awscli/examples/directconnect/update-lag.rst awscli-1.18.69/awscli/examples/directconnect/update-lag.rst --- awscli-1.11.13/awscli/examples/directconnect/update-lag.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/directconnect/update-lag.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,44 @@ +**To update a LAG** + +The following example changes the name of the specified LAG. + +Command:: + + aws directconnect update-lag --lag-id dxlag-ffjhj9lx --lag-name 2ConnLag + +Output:: + + { + "awsDevice": "CSVA1-23u8tlpaz8iks", + "numberOfConnections": 2, + "lagState": "down", + "ownerAccount": "123456789012", + "lagName": "2ConnLag", + "connections": [ + { + "ownerAccount": "123456789012", + "connectionId": "dxcon-fflqyj95", + "lagId": "dxlag-ffjhj9lx", + "connectionState": "requested", + "bandwidth": "1Gbps", + "location": "CSVA1", + "connectionName": "Requested Connection 2 for Lag dxlag-ffjhj9lx", + "region": "us-east-1" + }, + { + "ownerAccount": "123456789012", + "connectionId": "dxcon-ffqr6x5q", + "lagId": "dxlag-ffjhj9lx", + "connectionState": "requested", + "bandwidth": "1Gbps", + "location": "CSVA1", + "connectionName": "Requested Connection 1 for Lag dxlag-ffjhj9lx", + "region": "us-east-1" + } + ], + "lagId": "dxlag-ffjhj9lx", + "minimumLinks": 0, + "connectionsBandwidth": "1Gbps", + "region": "us-east-1", + "location": "CSVA1" + } diff -Nru awscli-1.11.13/awscli/examples/directconnect/update-virtual-interface-attributes.rst awscli-1.18.69/awscli/examples/directconnect/update-virtual-interface-attributes.rst --- awscli-1.11.13/awscli/examples/directconnect/update-virtual-interface-attributes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/directconnect/update-virtual-interface-attributes.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,51 @@ +**To update the MTU of a virtual interface** + +The following ``update-virtual-interface-attributes`` example updates the MTU of the specified virtual interface. :: + + aws directconnect update-virtual-interface-attributes \ + --virtual-interface-id dxvif-fEXAMPLE \ + --mtu 1500 + +Output:: + + { + "ownerAccount": "1111222233333", + "virtualInterfaceId": "dxvif-fEXAMPLE", + "location": "loc1", + "connectionId": "dxlag-fEXAMPLE", + "virtualInterfaceType": "transit", + "virtualInterfaceName": "example trasit virtual interface", + "vlan": 125, + "asn": 650001, + "amazonSideAsn": 64512, + "authKey": "0xzxgA9YoW9h58u8SEXAMPLE", + "amazonAddress": "169.254.248.1/30", + "customerAddress": "169.254.248.2/30", + "addressFamily": "ipv4", + "virtualInterfaceState": "down", + "customerRouterConfig": "\n\n 125\n 169.254.248.2/30\n 169.254.248.1/30\n 650001\n 0xzxgA9YoW9h58u8SEXAMPLE\n 64512\n transit\n\n", + "mtu": 1500, + "jumboFrameCapable": true, + "virtualGatewayId": "", + "directConnectGatewayId": "879b76a1-403d-4700-8b53-4a56ed85436e", + "routeFilterPrefixes": [], + "bgpPeers": [ + { + "bgpPeerId": "dxpeer-fEXAMPLE", + "asn": 650001, + "authKey": "0xzxgA9YoW9h58u8SEXAMPLE", + "addressFamily": "ipv4", + "amazonAddress": "169.254.248.1/30", + "customerAddress": "169.254.248.2/30", + "bgpPeerState": "available", + "bgpStatus": "down", + "awsDeviceV2": "loc1-26wz6vEXAMPLE" + } + ], + "region": "sa-east-1", + "awsDeviceV2": "loc1-26wz6vEXAMPLE", + "tags": [] + } + + +For more information, see `Setting Network MTU for Private Virtual Interfaces or Transit Virtual Interfaces `__ in the *AWS Direct Connect User Guide*. diff -Nru awscli-1.11.13/awscli/examples/discovery/describe-agents.rst awscli-1.18.69/awscli/examples/discovery/describe-agents.rst --- awscli-1.11.13/awscli/examples/discovery/describe-agents.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/discovery/describe-agents.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,46 @@ +**Describe agents with specified collectionStatus states** + +This example command describes collection agents with collection status of "STARTED" or "STOPPED". + +Command:: + + aws discovery describe-agents --filters name="collectionStatus",values="STARTED","STOPPED",condition="EQUALS" --max-results 3 + +Output:: + + { + "Snapshots": [ + { + "version": "1.0.40.0", + "agentType": "EC2", + "hostName": "ip-172-31-40-234", + "collectionStatus": "STOPPED", + "agentNetworkInfoList": [ + { + "macAddress": "06:b5:97:14:fc:0d", + "ipAddress": "172.31.40.234" + } + ], + "health": "UNKNOWN", + "agentId": "i-003305c02a776e883", + "registeredTime": "2016-12-09T19:05:06Z", + "lastHealthPingTime": "2016-12-09T19:05:10Z" + }, + { + "version": "1.0.40.0", + "agentType": "EC2", + "hostName": "ip-172-31-39-64", + "collectionStatus": "STARTED", + "agentNetworkInfoList": [ + { + "macAddress": "06:a1:0e:c7:b2:73", + "ipAddress": "172.31.39.64" + } + ], + "health": "SHUTDOWN", + "agentId": "i-003a5e5e2b36cf8bd", + "registeredTime": "2016-11-16T16:36:25Z", + "lastHealthPingTime": "2016-11-16T16:47:37Z" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/discovery/describe-configurations.rst awscli-1.18.69/awscli/examples/discovery/describe-configurations.rst --- awscli-1.11.13/awscli/examples/discovery/describe-configurations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/discovery/describe-configurations.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,122 @@ +**Describe selected asset configurations** + +This example command describes the configurations of two specified servers. The action detects the type of asset from the configuration ID. Only one type of asset is allowed per command. + +Command:: + + aws discovery describe-configurations --configuration-ids "d-server-099385097ef9fbcfb" "d-server-0c4f2dd1fee22c6c1" + +Output:: + + { + "configurations": [ + { + "server.performance.maxCpuUsagePct": "0.0", + "server.performance.maxDiskReadIOPS": "0.0", + "server.performance.avgCpuUsagePct": "0.0", + "server.type": "EC2", + "server.performance.maxNetworkReadsPerSecondInKB": "0.19140625", + "server.hostName": "ip-172-31-35-152", + "server.configurationId": "d-server-0c4f2dd1fee22c6c1", + "server.tags.hasMoreValues": "false", + "server.performance.minFreeRAMInKB": "1543496.0", + "server.osVersion": "3.14.48-33.39.amzn1.x86_64", + "server.performance.maxDiskReadsPerSecondInKB": "0.0", + "server.applications": "[]", + "server.performance.numDisks": "1", + "server.performance.numCpus": "1", + "server.performance.numCores": "1", + "server.performance.maxDiskWriteIOPS": "0.0", + "server.performance.maxNetworkWritesPerSecondInKB": "0.82421875", + "server.performance.avgDiskWritesPerSecondInKB": "0.0", + "server.networkInterfaceInfo": "[{\"name\":\"eth0\",\"macAddress\":\"06:A7:7D:3F:54:57\",\"ipAddress\":\"172.31.35.152\",\"netMask\":\"255.255.240.0\"},{\"name\":\"lo\",\"macAddress\":\"00:00:00:00:00:00\",\"ipAddress\":\"127.0.0.1\",\"netMask\":\"255.0.0.0\"},{\"name\":\"eth0\",\"macAddress\":\"06:A7:7D:3F:54:57\",\"ipAddress\":\"fe80::4a7:7dff:fe3f:5457\"},{\"name\":\"lo\",\"macAddress\":\"00:00:00:00:00:00\",\"ipAddress\":\"::1\"}]", + "server.performance.avgNetworkReadsPerSecondInKB": "0.04915364583333333", + "server.tags": "[]", + "server.applications.hasMoreValues": "false", + "server.timeOfCreation": "2016-10-28 23:44:00.0", + "server.agentId": "i-4447bc1b", + "server.performance.maxDiskWritesPerSecondInKB": "0.0", + "server.performance.avgDiskReadIOPS": "0.0", + "server.performance.avgFreeRAMInKB": "1547210.1333333333", + "server.performance.avgDiskReadsPerSecondInKB": "0.0", + "server.performance.avgDiskWriteIOPS": "0.0", + "server.performance.numNetworkCards": "2", + "server.hypervisor": "xen", + "server.networkInterfaceInfo.hasMoreValues": "false", + "server.performance.avgNetworkWritesPerSecondInKB": "0.1380859375", + "server.osName": "Linux - Amazon Linux AMI release 2015.03", + "server.performance.totalRAMInKB": "1694732.0", + "server.cpuType": "x64" + }, + { + "server.performance.maxCpuUsagePct": "100.0", + "server.performance.maxDiskReadIOPS": "0.0", + "server.performance.avgCpuUsagePct": "14.733333333333338", + "server.type": "EC2", + "server.performance.maxNetworkReadsPerSecondInKB": "13.400390625", + "server.hostName": "ip-172-31-42-208", + "server.configurationId": "d-server-099385097ef9fbcfb", + "server.tags.hasMoreValues": "false", + "server.performance.minFreeRAMInKB": "1531104.0", + "server.osVersion": "3.14.48-33.39.amzn1.x86_64", + "server.performance.maxDiskReadsPerSecondInKB": "0.0", + "server.applications": "[]", + "server.performance.numDisks": "1", + "server.performance.numCpus": "1", + "server.performance.numCores": "1", + "server.performance.maxDiskWriteIOPS": "1.0", + "server.performance.maxNetworkWritesPerSecondInKB": "12.271484375", + "server.performance.avgDiskWritesPerSecondInKB": "0.5333333333333334", + "server.networkInterfaceInfo": "[{\"name\":\"eth0\",\"macAddress\":\"06:4A:79:60:75:61\",\"ipAddress\":\"172.31.42.208\",\"netMask\":\"255.255.240.0\"},{\"name\":\"eth0\",\"macAddress\":\"06:4A:79:60:75:61\",\"ipAddress\":\"fe80::44a:79ff:fe60:7561\"},{\"name\":\"lo\",\"macAddress\":\"00:00:00:00:00:00\",\"ipAddress\":\"::1\"},{\"name\":\"lo\",\"macAddress\":\"00:00:00:00:00:00\",\"ipAddress\":\"127.0.0.1\",\"netMask\":\"255.0.0.0\"}]", + "server.performance.avgNetworkReadsPerSecondInKB": "2.8720052083333334", + "server.tags": "[]", + "server.applications.hasMoreValues": "false", + "server.timeOfCreation": "2016-10-28 23:44:30.0", + "server.agentId": "i-c142b99e", + "server.performance.maxDiskWritesPerSecondInKB": "4.0", + "server.performance.avgDiskReadIOPS": "0.0", + "server.performance.avgFreeRAMInKB": "1534946.4", + "server.performance.avgDiskReadsPerSecondInKB": "0.0", + "server.performance.avgDiskWriteIOPS": "0.13333333333333336", + "server.performance.numNetworkCards": "2", + "server.hypervisor": "xen", + "server.networkInterfaceInfo.hasMoreValues": "false", + "server.performance.avgNetworkWritesPerSecondInKB": "1.7977864583333332", + "server.osName": "Linux - Amazon Linux AMI release 2015.03", + "server.performance.totalRAMInKB": "1694732.0", + "server.cpuType": "x64" + } + ] + } + + +**Describe selected asset configurations** + +This example command describes the configurations of two specified applications. The action detects the type of asset from the configuration ID. Only one type of asset is allowed per command. + +Command:: + + aws discovery describe-configurations --configuration-ids "d-application-0ac39bc0e4fad0e42" "d-application-02444a45288013764q" + +Output:: + + { + "configurations": [ + { + "application.serverCount": "0", + "application.name": "Application-12345", + "application.lastModifiedTime": "2016-12-13 23:53:27.0", + "application.description": "", + "application.timeOfCreation": "2016-12-13 23:53:27.0", + "application.configurationId": "d-application-0ac39bc0e4fad0e42" + }, + { + "application.serverCount": "0", + "application.name": "Application-67890", + "application.lastModifiedTime": "2016-12-13 23:53:33.0", + "application.description": "", + "application.timeOfCreation": "2016-12-13 23:53:33.0", + "application.configurationId": "d-application-02444a45288013764" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/discovery/list-configurations.rst awscli-1.18.69/awscli/examples/discovery/list-configurations.rst --- awscli-1.11.13/awscli/examples/discovery/list-configurations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/discovery/list-configurations.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,32 @@ +**To list all of the discovered servers meeting a set of filter conditions** + +This example command lists discovered servers matching either of two hostname patterns and not running Ubuntu. + +Command:: + + aws discovery list-configurations --configuration-type SERVER --filters name="server.hostName",values="172-31-35","172-31-42",condition="CONTAINS" name="server.osName",values="Ubuntu",condition="NOT_CONTAINS" + +Output:: + + { + "configurations": [ + { + "server.osVersion": "3.14.48-33.39.amzn1.x86_64", + "server.type": "EC2", + "server.hostName": "ip-172-31-42-208", + "server.timeOfCreation": "2016-10-28 23:44:30.0", + "server.configurationId": "d-server-099385097ef9fbcfb", + "server.osName": "Linux - Amazon Linux AMI release 2015.03", + "server.agentId": "i-c142b99e" + }, + { + "server.osVersion": "3.14.48-33.39.amzn1.x86_64", + "server.type": "EC2", + "server.hostName": "ip-172-31-35-152", + "server.timeOfCreation": "2016-10-28 23:44:00.0", + "server.configurationId": "d-server-0c4f2dd1fee22c6c1", + "server.osName": "Linux - Amazon Linux AMI release 2015.03", + "server.agentId": "i-4447bc1b" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/dlm/create-default-role.rst awscli-1.18.69/awscli/examples/dlm/create-default-role.rst --- awscli-1.11.13/awscli/examples/dlm/create-default-role.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dlm/create-default-role.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,54 @@ +**To create the required IAM role for Amazon DLM** + +Amazon DLM creates the **AWSDataLifecycleManagerDefaultRole** role the first time that you create a lifecycle policy using the AWS Management Console. If you are not using the console, you can use the following command to create this role. :: + + aws dlm create-default-role + +Output:: + + { + "RolePolicy": { + "Version": "2012-10-17", + "Statement": [ + { + "Effect": "Allow", + "Action": [ + "ec2:CreateSnapshot", + "ec2:CreateSnapshots", + "ec2:DeleteSnapshot", + "ec2:DescribeInstances", + "ec2:DescribeVolumes", + "ec2:DescribeSnapshots" + ], + "Resource": "*" + }, + { + "Effect": "Allow", + "Action": [ + "ec2:CreateTags" + ], + "Resource": "arn:aws:ec2:*::snapshot/*" + } + ] + }, + "Role": { + "Path": "/", + "RoleName": "AWSDataLifecycleManagerDefaultRole", + "RoleId": "AROA012345678901EXAMPLE", + "Arn": "arn:aws:iam::123456789012:role/AWSDataLifecycleManagerDefaultRole", + "CreateDate": "2019-05-29T17:47:18Z", + "AssumeRolePolicyDocument": { + "Version": "2012-10-17", + "Statement": [ + { + "Sid": "", + "Effect": "Allow", + "Principal": { + "Service": "dlm.amazonaws.com" + }, + "Action": "sts:AssumeRole" + } + ] + } + } + } diff -Nru awscli-1.11.13/awscli/examples/dlm/create-lifecycle-policy.rst awscli-1.18.69/awscli/examples/dlm/create-lifecycle-policy.rst --- awscli-1.11.13/awscli/examples/dlm/create-lifecycle-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dlm/create-lifecycle-policy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,51 @@ +**To create a lifecycle policy** + +The following ``create-lifecycle-policy`` example creates a lifecycle policy that creates a daily snapshot of volumes at the specified time. The specified tags are added to the snapshots, and tags are also copied from the volume and added to the snapshots. If creating a new snapshot exceeds the specified maximum count, the oldest snapshot is deleted. :: + + aws dlm create-lifecycle-policy \ + --description "My first policy" \ + --state ENABLED \ + --execution-role-arn arn:aws:iam::12345678910:role/AWSDataLifecycleManagerDefaultRole \ + --policy-details file://policyDetails.json + +Contents of ``policyDetails.json``:: + + { + "ResourceTypes": [ + "VOLUME" + ], + "TargetTags": [ + { + "Key": "costCenter", + "Value": "115" + } + ], + "Schedules":[ + { + "Name": "DailySnapshots", + "CopyTags": true, + "TagsToAdd": [ + { + "Key": "type", + "Value": "myDailySnapshot" + } + ], + "CreateRule": { + "Interval": 24, + "IntervalUnit": "HOURS", + "Times": [ + "03:00" + ] + }, + "RetainRule": { + "Count":5 + } + } + ] + } + +Output:: + + { + "PolicyId": "policy-0123456789abcdef0" + } diff -Nru awscli-1.11.13/awscli/examples/dlm/delete-lifecycle-policy.rst awscli-1.18.69/awscli/examples/dlm/delete-lifecycle-policy.rst --- awscli-1.11.13/awscli/examples/dlm/delete-lifecycle-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dlm/delete-lifecycle-policy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,5 @@ +**To delete a lifecycle policy** + +The following example deletes the specified lifecycle policy.:: + + aws dlm delete-lifecycle-policy --policy-id policy-0123456789abcdef0 diff -Nru awscli-1.11.13/awscli/examples/dlm/get-lifecycle-policies.rst awscli-1.18.69/awscli/examples/dlm/get-lifecycle-policies.rst --- awscli-1.11.13/awscli/examples/dlm/get-lifecycle-policies.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dlm/get-lifecycle-policies.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To get a summary of your lifecycle policies** + +The following ``get-lifecycle-policies`` example lists all of your lifecycle policies. :: + + aws dlm get-lifecycle-policies + +Output:: + + { + "Policies": [ + { + "PolicyId": "policy-0123456789abcdef0", + "Description": "My first policy", + "State": "ENABLED" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/dlm/get-lifecycle-policy.rst awscli-1.18.69/awscli/examples/dlm/get-lifecycle-policy.rst --- awscli-1.11.13/awscli/examples/dlm/get-lifecycle-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dlm/get-lifecycle-policy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,53 @@ +**To describe a lifecycle policy** + +The following ``get-lifecycle-policy`` example displays details for the specified lifecycle policy. :: + + aws dlm get-lifecycle-policy \ + --policy-id policy-0123456789abcdef0 + +Output:: + + { + "Policy": { + "PolicyId": "policy-0123456789abcdef0", + "Description": "My policy", + "State": "ENABLED", + "ExecutionRoleArn": "arn:aws:iam::123456789012:role/AWSDataLifecycleManagerDefaultRole", + "DateCreated": "2019-08-08T17:45:42Z", + "DateModified": "2019-08-08T17:45:42Z", + "PolicyDetails": { + "PolicyType": "EBS_SNAPSHOT_MANAGEMENT", + "ResourceTypes": [ + "VOLUME" + ], + "TargetTags": [ + { + "Key": "costCenter", + "Value": "115" + } + ], + "Schedules": [ + { + "Name": "DailySnapshots", + "CopyTags": true, + "TagsToAdd": [ + { + "Key": "type", + "Value": "myDailySnapshot" + } + ], + "CreateRule": { + "Interval": 24, + "IntervalUnit": "HOURS", + "Times": [ + "03:00" + ] + }, + "RetainRule": { + "Count": 5 + } + } + ] + } + } + } diff -Nru awscli-1.11.13/awscli/examples/dlm/update-lifecycle-policy.rst awscli-1.18.69/awscli/examples/dlm/update-lifecycle-policy.rst --- awscli-1.11.13/awscli/examples/dlm/update-lifecycle-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dlm/update-lifecycle-policy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,38 @@ +**Example 1: To enable a lifecycle policy** + +The following ``update-lifecycle-policy`` example enables the specified lifecycle policy. :: + + aws dlm update-lifecycle-policy \ + --policy-id policy-0123456789abcdef0 \ + --state ENABLED + +**Example 2: To disable a lifecycle policy** + +The following ``update-lifecycle-policy`` example disables the specified lifecycle policy. :: + + aws dlm update-lifecycle-policy \ + --policy-id policy-0123456789abcdef0 \ + --state DISABLED + +**Example 3: To update the details for lifecycle policy** + +The following ``update-lifecycle-policy`` example updates the target tags for the specified lifecycle policy. :: + + aws dlm update-lifecycle-policy \ + --policy-id policy-0123456789abcdef0 + --policy-details file://policyDetails.json + +Contents of ``policyDetails.json``. Other details not referenced in this file are not changed by the command. :: + + { + "TargetTags": [ + { + "Key": "costCenter", + "Value": "120" + }, + { + "Key": "project", + "Value": "lima" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/docdb/add-tags-to-resource.rst awscli-1.18.69/awscli/examples/docdb/add-tags-to-resource.rst --- awscli-1.11.13/awscli/examples/docdb/add-tags-to-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/add-tags-to-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To add one or more tags to a specified resource** + +The following ``add-tags-to-resource`` example adds three tags to ``sample-cluster``. One tag (``CropB``) has a key name but no value. :: + + aws docdb add-tags-to-resource \ + --resource-name arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster \ + --tags Key="CropA",Value="Apple" Key="CropB" Key="CropC",Value="Corn" + +This command produces no output. + +For more information, see `Tagging Amazon DocumentDB Resources `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/apply-pending-maintenance-action.rst awscli-1.18.69/awscli/examples/docdb/apply-pending-maintenance-action.rst --- awscli-1.11.13/awscli/examples/docdb/apply-pending-maintenance-action.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/apply-pending-maintenance-action.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,12 @@ +**To have pending maintenance actions take place during the next maintenance window** + +The following ``apply-pending-maintenance-action`` example causes all system-update actions to be performed during the next scheduled maintenance window. :: + + aws docdb apply-pending-maintenance-action \ + --resource-identifier arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster \ + --apply-action system-update \ + --opt-in-type next-maintenance + +This command produces no output. + +For more information, see `Applying Amazon DocumentDB Updates `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/copy-db-cluster-parameter-group.rst awscli-1.18.69/awscli/examples/docdb/copy-db-cluster-parameter-group.rst --- awscli-1.11.13/awscli/examples/docdb/copy-db-cluster-parameter-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/copy-db-cluster-parameter-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,22 @@ +**To duplicate an existing DB cluster parameter group** + +The following ``copy-db-cluster-parameter-group`` example makes a copy of the parameter group ``custom-docdb3-6`` named ``custom-docdb3-6-copy``. When making the copy it adds tags to the new parameter group. :: + + aws docdb copy-db-cluster-parameter-group \ + --source-db-cluster-parameter-group-identifier custom-docdb3-6 \ + --target-db-cluster-parameter-group-identifier custom-docdb3-6-copy \ + --target-db-cluster-parameter-group-description "Copy of custom-docdb3-6" \ + --tags Key="CopyNumber",Value="1" Key="Modifiable",Value="Yes" + +Output:: + + { + "DBClusterParameterGroup": { + "DBParameterGroupFamily": "docdb3.6", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:12345678901:cluster-pg:custom-docdb3-6-copy", + "DBClusterParameterGroupName": "custom-docdb3-6-copy", + "Description": "Copy of custom-docdb3-6" + } + } + +For more information, see `Copying an Amazon DocumentDB Cluster Parameter Group `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/copy-db-cluster-snapshot.rst awscli-1.18.69/awscli/examples/docdb/copy-db-cluster-snapshot.rst --- awscli-1.11.13/awscli/examples/docdb/copy-db-cluster-snapshot.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/copy-db-cluster-snapshot.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,13 @@ +**To create a copy of a snapshot** + +The following ``copy-db-cluster-snapshot`` example makes a copy of ``sample-cluster-snapshot`` named ``sample-cluster-snapshot-copy``. The copy has all the tags of the original plus a new tag with the key name ``CopyNumber``. :: + + aws docdb copy-db-cluster-snapshot \ + --source-db-cluster-snapshot-identifier sample-cluster-snapshot \ + --target-db-cluster-snapshot-identifier sample-cluster-snapshot-copy \ + --copy-tags \ + --tags Key="CopyNumber",Value="1" + +This command produces no output. + +For more information, see `Copying a Cluster Snapshot `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/create-db-cluster-parameter-group.rst awscli-1.18.69/awscli/examples/docdb/create-db-cluster-parameter-group.rst --- awscli-1.11.13/awscli/examples/docdb/create-db-cluster-parameter-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/create-db-cluster-parameter-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To create an Amazon DocumentDB cluster parameter group** + +The following ``create-db-cluster-parameter-group`` example creates the DB cluster parameter group ``sample-parameter-group`` using the ``docdb3.6`` family. :: + + aws docdb create-db-cluster-parameter-group \ + --db-cluster-parameter-group-name sample-parameter-group \ + --db-parameter-group-family docdb3.6 \ + --description "Sample parameter group based on docdb3.6" + +Output:: + + { + "DBClusterParameterGroup": { + "Description": "Sample parameter group based on docdb3.6", + "DBParameterGroupFamily": "docdb3.6", + "DBClusterParameterGroupArn": "arn:aws:rds:us-west-2:123456789012:cluster-pg:sample-parameter-group", + "DBClusterParameterGroupName": "sample-parameter-group" + } + } + +For more information, see `Creating an Amazon DocumentDB Cluster Parameter Group `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/create-db-cluster.rst awscli-1.18.69/awscli/examples/docdb/create-db-cluster.rst --- awscli-1.11.13/awscli/examples/docdb/create-db-cluster.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/create-db-cluster.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,52 @@ +**To create an Amazon DocumentDB cluster** + +The following ``create-db-cluster`` example creates an Amazon DocumentDB cluster named ``sample-cluster`` with the preferred maintenance window on Sundays between 20:30 and 11:00. :: + + aws docdb create-db-cluster \ + --db-cluster-identifier sample-cluster \ + --engine docdb \ + --master-username master-user \ + --master-user-password password \ + --preferred-maintenance-window Sun:20:30-Sun:21:00 + +Output:: + + { + "DBCluster": { + "DBClusterParameterGroup": "default.docdb3.6", + "AssociatedRoles": [], + "DBSubnetGroup": "default", + "ClusterCreateTime": "2019-03-18T18:06:34.616Z", + "Status": "creating", + "Port": 27017, + "PreferredMaintenanceWindow": "sun:20:30-sun:21:00", + "HostedZoneId": "ZNKXH85TT8WVW", + "DBClusterMembers": [], + "Engine": "docdb", + "DBClusterIdentifier": "sample-cluster", + "PreferredBackupWindow": "10:12-10:42", + "AvailabilityZones": [ + "us-west-2d", + "us-west-2f", + "us-west-2e" + ], + "MasterUsername": "master-user", + "BackupRetentionPeriod": 1, + "ReaderEndpoint": "sample-cluster.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-77186e0d", + "Status": "active" + } + ], + "StorageEncrypted": false, + "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster", + "DbClusterResourceId": "cluster-L3R4YRSBUYDP4GLMTJ2WF5GH5Q", + "MultiAZ": false, + "Endpoint": "sample-cluster.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "EngineVersion": "3.6.0" + } + } + + +For more information, see `Creating an Amazon DocumentDB Cluster `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/create-db-cluster-snapshot.rst awscli-1.18.69/awscli/examples/docdb/create-db-cluster-snapshot.rst --- awscli-1.11.13/awscli/examples/docdb/create-db-cluster-snapshot.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/create-db-cluster-snapshot.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,38 @@ +**To create a manual Amazon DocumentDB cluster snapshot** + +The following ``create-db-cluster-snapshot`` example creates an Amazon DB cluster snapshot named sample-cluster-snapshot. :: + + aws docdb create-db-cluster-snapshot \ + --db-cluster-identifier sample-cluster \ + --db-cluster-snapshot-identifier sample-cluster-snapshot + +Output:: + + { + "DBClusterSnapshot": { + "MasterUsername": "master-user", + "SnapshotCreateTime": "2019-03-18T18:27:14.794Z", + "AvailabilityZones": [ + "us-west-2a", + "us-west-2b", + "us-west-2c", + "us-west-2d", + "us-west-2e", + "us-west-2f" + ], + "SnapshotType": "manual", + "DBClusterSnapshotArn": "arn:aws:rds:us-west-2:123456789012:cluster-snapshot:sample-cluster-snapshot", + "EngineVersion": "3.6.0", + "PercentProgress": 0, + "DBClusterSnapshotIdentifier": "sample-cluster-snapshot", + "Engine": "docdb", + "DBClusterIdentifier": "sample-cluster", + "Status": "creating", + "ClusterCreateTime": "2019-03-15T20:29:58.836Z", + "Port": 0, + "StorageEncrypted": false, + "VpcId": "vpc-91280df6" + } + } + +For more information, see `Creating a Manual Cluster Snapshot `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/create-db-instance.rst awscli-1.18.69/awscli/examples/docdb/create-db-instance.rst --- awscli-1.11.13/awscli/examples/docdb/create-db-instance.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/create-db-instance.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,83 @@ +**To create an Amazon DocumentDB cluster instance** + +The following ``create-db-instance`` example code creates the instance ``sample-cluster-instance-2`` in the Amazon DocumentDB cluster ``sample-cluster``. :: + + aws docdb create-db-instance \ + --db-cluster-identifier sample-cluster \ + --db-instance-class db.r4.xlarge \ + --db-instance-identifier sample-cluster-instance-2 \ + --engine docdb + +Output:: + + { + "DBInstance": { + "DBInstanceStatus": "creating", + "PendingModifiedValues": { + "PendingCloudwatchLogsExports": { + "LogTypesToEnable": [ + "audit" + ] + } + }, + "PubliclyAccessible": false, + "PreferredBackupWindow": "00:00-00:30", + "PromotionTier": 1, + "EngineVersion": "3.6.0", + "BackupRetentionPeriod": 3, + "DBInstanceIdentifier": "sample-cluster-instance-2", + "PreferredMaintenanceWindow": "tue:10:28-tue:10:58", + "StorageEncrypted": false, + "Engine": "docdb", + "DBClusterIdentifier": "sample-cluster", + "DBSubnetGroup": { + "Subnets": [ + { + "SubnetAvailabilityZone": { + "Name": "us-west-2a" + }, + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-4e26d263" + }, + { + "SubnetAvailabilityZone": { + "Name": "us-west-2c" + }, + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-afc329f4" + }, + { + "SubnetAvailabilityZone": { + "Name": "us-west-2d" + }, + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-53ab3636" + }, + { + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + }, + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-991cb8d0" + } + ], + "DBSubnetGroupDescription": "default", + "SubnetGroupStatus": "Complete", + "VpcId": "vpc-91280df6", + "DBSubnetGroupName": "default" + }, + "DBInstanceClass": "db.r4.xlarge", + "VpcSecurityGroups": [ + { + "Status": "active", + "VpcSecurityGroupId": "sg-77186e0d" + } + ], + "AutoMinorVersionUpgrade": true, + "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster-instance-2", + "DbiResourceId": "db-XEKJLEMGRV5ZKCARUVA4HO3ITE" + } + } + + +For more information, see `Adding an Amazon DocumentDB Instance to a Cluster `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/create-db-subnet-group.rst awscli-1.18.69/awscli/examples/docdb/create-db-subnet-group.rst --- awscli-1.11.13/awscli/examples/docdb/create-db-subnet-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/create-db-subnet-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,46 @@ +**To create an Amazon DocumentDB subnet group** + +The following ``create-db-subnet-group`` example creates an Amazon DocumentDB subnet group named ``sample-subnet-group``. :: + + aws docdb create-db-subnet-group \ + --db-subnet-group-description "a sample subnet group" \ + --db-subnet-group-name sample-subnet-group \ + --subnet-ids "subnet-29ab1025" "subnet-991cb8d0" "subnet-53ab3636" + +Output:: + + { + "DBSubnetGroup": { + "SubnetGroupStatus": "Complete", + "DBSubnetGroupName": "sample-subnet-group", + "DBSubnetGroupDescription": "a sample subnet group", + "VpcId": "vpc-91280df6", + "DBSubnetGroupArn": "arn:aws:rds:us-west-2:123456789012:subgrp:sample-subnet-group", + "Subnets": [ + { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-53ab3636", + "SubnetAvailabilityZone": { + "Name": "us-west-2d" + } + }, + { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-991cb8d0", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + } + }, + { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-29ab1025", + "SubnetAvailabilityZone": { + "Name": "us-west-2c" + } + } + ] + } + } + + +For more information, see `Creating an Amazon DocumentDB Subnet Group `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/delete-db-cluster-parameter-group.rst awscli-1.18.69/awscli/examples/docdb/delete-db-cluster-parameter-group.rst --- awscli-1.11.13/awscli/examples/docdb/delete-db-cluster-parameter-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/delete-db-cluster-parameter-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete an Amazon DocumentDB cluster parameter group** + +The following ``delete-db-cluster-parameter-group`` example deletes the Amazon DocumentDB parameter group ``sample-parameter-group``. :: + + aws docdb delete-db-cluster-parameter-group \ + --db-cluster-parameter-group-name sample-parameter-group + +This command produces no output. + +For more information, see `Deleting an Amazon DocumentDB Cluster Parameter Group `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/delete-db-cluster.rst awscli-1.18.69/awscli/examples/docdb/delete-db-cluster.rst --- awscli-1.11.13/awscli/examples/docdb/delete-db-cluster.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/delete-db-cluster.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,51 @@ +**To delete an Amazon DocumentDB cluster** + +The following ``delete-db-cluster`` example deletes the Amazon DocumentDB cluster ``sample-cluster``. No backup of the cluster is made prior to deleting it. NOTE: You must delete all instances associated with the cluster before you can delete it. :: + + aws docdb delete-db-cluster \ + --db-cluster-identifier sample-cluster \ + --skip-final-snapshot + +Output:: + + { + "DBCluster": { + "DBClusterIdentifier": "sample-cluster", + "DBSubnetGroup": "default", + "EngineVersion": "3.6.0", + "Engine": "docdb", + "LatestRestorableTime": "2019-03-18T18:07:24.610Z", + "PreferredMaintenanceWindow": "sun:20:30-sun:21:00", + "StorageEncrypted": false, + "EarliestRestorableTime": "2019-03-18T18:07:24.610Z", + "Port": 27017, + "VpcSecurityGroups": [ + { + "Status": "active", + "VpcSecurityGroupId": "sg-77186e0d" + } + ], + "MultiAZ": false, + "MasterUsername": "master-user", + "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster", + "Status": "available", + "PreferredBackupWindow": "10:12-10:42", + "ReaderEndpoint": "sample-cluster.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "AvailabilityZones": [ + "us-west-2c", + "us-west-2b", + "us-west-2a" + ], + "Endpoint": "sample-cluster.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "DbClusterResourceId": "cluster-L3R4YRSBUYDP4GLMTJ2WF5GH5Q", + "ClusterCreateTime": "2019-03-18T18:06:34.616Z", + "AssociatedRoles": [], + "DBClusterParameterGroup": "default.docdb3.6", + "HostedZoneId": "ZNKXH85TT8WVW", + "BackupRetentionPeriod": 1, + "DBClusterMembers": [] + } + } + + +For more information, see `Deleting an Amazon DocumentDB Cluster `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/delete-db-cluster-snapshot.rst awscli-1.18.69/awscli/examples/docdb/delete-db-cluster-snapshot.rst --- awscli-1.11.13/awscli/examples/docdb/delete-db-cluster-snapshot.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/delete-db-cluster-snapshot.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,36 @@ +**To delete an Amazon DocumentDB cluster snapshot** + +The following ``delete-db-cluster-snapshot`` example deletes the Amazon DocumentDB cluster snapshot ``sample-cluster-snapshot``. :: + + aws docdb delete-db-cluster-snapshot \ + --db-cluster-snapshot-identifier sample-cluster-snapshot + +Output:: + + { + "DBClusterSnapshot": { + "DBClusterIdentifier": "sample-cluster", + "AvailabilityZones": [ + "us-west-2a", + "us-west-2b", + "us-west-2c", + "us-west-2d" + ], + "DBClusterSnapshotIdentifier": "sample-cluster-snapshot", + "VpcId": "vpc-91280df6", + "DBClusterSnapshotArn": "arn:aws:rds:us-west-2:123456789012:cluster-snapshot:sample-cluster-snapshot", + "EngineVersion": "3.6.0", + "Engine": "docdb", + "SnapshotCreateTime": "2019-03-18T18:27:14.794Z", + "Status": "available", + "MasterUsername": "master-user", + "ClusterCreateTime": "2019-03-15T20:29:58.836Z", + "PercentProgress": 100, + "StorageEncrypted": false, + "SnapshotType": "manual", + "Port": 0 + } + } + + +For more information, see `Deleting a Cluster Snapshot `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/delete-db-instance.rst awscli-1.18.69/awscli/examples/docdb/delete-db-instance.rst --- awscli-1.11.13/awscli/examples/docdb/delete-db-instance.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/delete-db-instance.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,83 @@ +**To delete an Amazon DocumentDB instance** + +The following ``delete-db-instance`` example deletes the Amazon DocumentDB instance ``sample-cluster-instance-2``. :: + + aws docdb delete-db-instance \ + --db-instance-identifier sample-cluster-instance-2 + +Output:: + + { + "DBInstance": { + "DBSubnetGroup": { + "Subnets": [ + { + "SubnetAvailabilityZone": { + "Name": "us-west-2a" + }, + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-4e26d263" + }, + { + "SubnetAvailabilityZone": { + "Name": "us-west-2c" + }, + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-afc329f4" + }, + { + "SubnetAvailabilityZone": { + "Name": "us-west-2d" + }, + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-53ab3636" + }, + { + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + }, + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-991cb8d0" + } + ], + "DBSubnetGroupName": "default", + "DBSubnetGroupDescription": "default", + "VpcId": "vpc-91280df6", + "SubnetGroupStatus": "Complete" + }, + "PreferredBackupWindow": "00:00-00:30", + "InstanceCreateTime": "2019-03-18T18:37:33.709Z", + "DBInstanceClass": "db.r4.xlarge", + "DbiResourceId": "db-XEKJLEMGRV5ZKCARUVA4HO3ITE", + "BackupRetentionPeriod": 3, + "Engine": "docdb", + "VpcSecurityGroups": [ + { + "Status": "active", + "VpcSecurityGroupId": "sg-77186e0d" + } + ], + "AutoMinorVersionUpgrade": true, + "PromotionTier": 1, + "EngineVersion": "3.6.0", + "Endpoint": { + "Address": "sample-cluster-instance-2.corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "HostedZoneId": "ZNKXH85TT8WVW", + "Port": 27017 + }, + "DBInstanceIdentifier": "sample-cluster-instance-2", + "PreferredMaintenanceWindow": "tue:10:28-tue:10:58", + "EnabledCloudwatchLogsExports": [ + "audit" + ], + "PendingModifiedValues": {}, + "DBInstanceStatus": "deleting", + "PubliclyAccessible": false, + "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster-instance-2", + "DBClusterIdentifier": "sample-cluster", + "AvailabilityZone": "us-west-2c", + "StorageEncrypted": false + } + } + +For more information, see `Deleting an Amazon DocumentDB Instance `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/delete-db-subnet-group.rst awscli-1.18.69/awscli/examples/docdb/delete-db-subnet-group.rst --- awscli-1.11.13/awscli/examples/docdb/delete-db-subnet-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/delete-db-subnet-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete an Amazon DocumentDB subnet group** + +The following ``delete-db-subnet-group`` example deletes the Amazon DocumentDB subnet group ``sample-subnet-group``. :: + + aws docdb delete-db-subnet-group \ + --db-subnet-group-name sample-subnet-group + +This command produces no output. + +For more information, see `Deleting an Amazon DocumentDB Subnet Group `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/describe-db-cluster-parameter-groups.rst awscli-1.18.69/awscli/examples/docdb/describe-db-cluster-parameter-groups.rst --- awscli-1.11.13/awscli/examples/docdb/describe-db-cluster-parameter-groups.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/describe-db-cluster-parameter-groups.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To see the details of one or more Amazon DocumentDB cluster parameter groups** + +The following ``describe-db-cluster-parameter-groups`` example displays details for the Amazon DocumentDB cluster parameter group ``custom3-6-param-grp``. :: + + aws docdb describe-db-cluster-parameter-groups \ + --db-cluster-parameter-group-name custom3-6-param-grp + +Output:: + + { + "DBClusterParameterGroups": [ + { + "DBParameterGroupFamily": "docdb3.6", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:custom3-6-param-grp", + "Description": "Custom docdb3.6 parameter group", + "DBClusterParameterGroupName": "custom3-6-param-grp" + } + ] + } + +For more information, see `Viewing Amazon DocumentDB Cluster Parameter Groups `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/describe-db-cluster-parameters.rst awscli-1.18.69/awscli/examples/docdb/describe-db-cluster-parameters.rst --- awscli-1.11.13/awscli/examples/docdb/describe-db-cluster-parameters.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/describe-db-cluster-parameters.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,48 @@ +**To view the detailed parameter list for an Amazon DocumentDB cluster parameter group.** + +The following ``describe-db-cluster-parameters`` example lists the parameters for the Amazon DocumentDB parameter group custom3-6-param-grp. :: + + aws docdb describe-db-cluster-parameters \ + --db-cluster-parameter-group-name custom3-6-param-grp + +Output:: + + { + "Parameters": [ + { + "DataType": "string", + "ParameterName": "audit_logs", + "IsModifiable": true, + "ApplyMethod": "pending-reboot", + "Source": "system", + "ApplyType": "dynamic", + "AllowedValues": "enabled,disabled", + "Description": "Enables auditing on cluster.", + "ParameterValue": "disabled" + }, + { + "DataType": "string", + "ParameterName": "tls", + "IsModifiable": true, + "ApplyMethod": "pending-reboot", + "Source": "system", + "ApplyType": "static", + "AllowedValues": "disabled,enabled", + "Description": "Config to enable/disable TLS", + "ParameterValue": "enabled" + }, + { + "DataType": "string", + "ParameterName": "ttl_monitor", + "IsModifiable": true, + "ApplyMethod": "pending-reboot", + "Source": "user", + "ApplyType": "dynamic", + "AllowedValues": "disabled,enabled", + "Description": "Enables TTL Monitoring", + "ParameterValue": "enabled" + } + ] + } + +For more information, see `Viewing Amazon DocumentDB Cluster Parameters `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/describe-db-cluster-snapshot-attributes.rst awscli-1.18.69/awscli/examples/docdb/describe-db-cluster-snapshot-attributes.rst --- awscli-1.11.13/awscli/examples/docdb/describe-db-cluster-snapshot-attributes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/describe-db-cluster-snapshot-attributes.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,22 @@ +**To list an Amazon DocumentDB snapshot attribute names and values** + +The following ``describe-db-cluster-snapshot-attributes`` example lists the attribute names and values for the Amazon DocumentDB snapshot ``sample-cluster-snapshot``. :: + + aws docdb describe-db-cluster-snapshot-attributes \ + --db-cluster-snapshot-identifier sample-cluster-snapshot + +Output:: + + { + "DBClusterSnapshotAttributesResult": { + "DBClusterSnapshotAttributes": [ + { + "AttributeName": "restore", + "AttributeValues": [] + } + ], + "DBClusterSnapshotIdentifier": "sample-cluster-snapshot" + } + } + +For more information, see `DescribeDBClusterSnapshotAttributes `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/describe-db-cluster-snapshots.rst awscli-1.18.69/awscli/examples/docdb/describe-db-cluster-snapshots.rst --- awscli-1.11.13/awscli/examples/docdb/describe-db-cluster-snapshots.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/describe-db-cluster-snapshots.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,37 @@ +**To describe Amazon DocumentDB snapshots** + +The following ``describe-db-cluster-snapshots`` example displays details for the Amazon DocumentDB snapshot ``sample-cluster-snapshot``. :: + + aws docdb describe-db-cluster-snapshots \ + --db-cluster-snapshot-identifier sample-cluster-snapshot + +Output:: + + { + "DBClusterSnapshots": [ + { + "AvailabilityZones": [ + "us-west-2a", + "us-west-2b", + "us-west-2c", + "us-west-2d" + ], + "Status": "available", + "DBClusterSnapshotArn": "arn:aws:rds:us-west-2:123456789012:cluster-snapshot:sample-cluster-snapshot", + "SnapshotCreateTime": "2019-03-15T20:41:26.515Z", + "SnapshotType": "manual", + "DBClusterSnapshotIdentifier": "sample-cluster-snapshot", + "DBClusterIdentifier": "sample-cluster", + "MasterUsername": "master-user", + "StorageEncrypted": false, + "VpcId": "vpc-91280df6", + "EngineVersion": "3.6.0", + "PercentProgress": 100, + "Port": 0, + "Engine": "docdb", + "ClusterCreateTime": "2019-03-15T20:29:58.836Z" + } + ] + } + +For more information, see `DescribeDBClusterSnapshots `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/describe-db-clusters.rst awscli-1.18.69/awscli/examples/docdb/describe-db-clusters.rst --- awscli-1.11.13/awscli/examples/docdb/describe-db-clusters.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/describe-db-clusters.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,67 @@ +**To get detailed information about one or more Amazon DocumentDB clusters.** + +The following ``describe-db-clusters`` example displays details for the Amazon DocumentDB cluster ``sample-cluster``. By omitting the ``--db-cluster-identifier`` parameter you can get information of up to 100 clusters. :: + + aws docdb describe-db-clusters + --db-cluster-identifier sample-cluster + +Output:: + + { + "DBClusters": [ + { + "DBClusterParameterGroup": "default.docdb3.6", + "Endpoint": "sample-cluster.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "PreferredBackupWindow": "00:00-00:30", + "DBClusterIdentifier": "sample-cluster", + "ClusterCreateTime": "2019-03-15T20:29:58.836Z", + "LatestRestorableTime": "2019-03-18T20:28:03.239Z", + "MasterUsername": "master-user", + "DBClusterMembers": [ + { + "PromotionTier": 1, + "DBClusterParameterGroupStatus": "in-sync", + "IsClusterWriter": false, + "DBInstanceIdentifier": "sample-cluster" + }, + { + "PromotionTier": 1, + "DBClusterParameterGroupStatus": "in-sync", + "IsClusterWriter": true, + "DBInstanceIdentifier": "sample-cluster2" + } + ], + "PreferredMaintenanceWindow": "sat:04:30-sat:05:00", + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-77186e0d", + "Status": "active" + } + ], + "Engine": "docdb", + "ReaderEndpoint": "sample-cluster.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "DBSubnetGroup": "default", + "MultiAZ": true, + "AvailabilityZones": [ + "us-west-2a", + "us-west-2c", + "us-west-2b" + ], + "EarliestRestorableTime": "2019-03-15T20:30:47.020Z", + "DbClusterResourceId": "cluster-UP4EF2PVDDFVHHDJQTYDAIGHLE", + "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster", + "BackupRetentionPeriod": 3, + "HostedZoneId": "ZNKXH85TT8WVW", + "StorageEncrypted": false, + "EnabledCloudwatchLogsExports": [ + "audit" + ], + "AssociatedRoles": [], + "EngineVersion": "3.6.0", + "Port": 27017, + "Status": "available" + } + ] + } + +For more information, see `Describing Amazon DocumentDB Clusters `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/describe-db-engine-versions.rst awscli-1.18.69/awscli/examples/docdb/describe-db-engine-versions.rst --- awscli-1.11.13/awscli/examples/docdb/describe-db-engine-versions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/describe-db-engine-versions.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,28 @@ +**To list available Amazon DocumentDB engine versions** + +The following ``describe-db-engine-versions`` example lists all available Amazon DocumentDB engine versions. :: + + aws docdb describe-db-engine-versions \ + --engine docdb + +Output:: + + { + "DBEngineVersions": [ + { + "DBEngineVersionDescription": "DocDB version 1.0.200837", + "DBParameterGroupFamily": "docdb3.6", + "EngineVersion": "3.6.0", + "ValidUpgradeTarget": [], + "DBEngineDescription": "Amazon DocumentDB (with MongoDB compatibility)", + "SupportsLogExportsToCloudwatchLogs": true, + "Engine": "docdb", + "ExportableLogTypes": [ + "audit" + ] + } + ] + } + + +For more information, see `DescribeDBEngineVersions `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/describe-db-instances.rst awscli-1.18.69/awscli/examples/docdb/describe-db-instances.rst --- awscli-1.11.13/awscli/examples/docdb/describe-db-instances.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/describe-db-instances.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,85 @@ +**To find information about provisioned Amazon DocumentDB instances** + +The following ``describe-db-instances`` example displays details for about the Amazon DocumentDB instance ``sample-cluster-instance``. By omitting the ``--db-instance-identifier`` parameter you get information on up to 100 instances. :: + + aws docdb describe-db-instances \ + --db-instance-identifier sample-cluster-instance + +Output:: + + { + "DBInstances": [ + { + "Endpoint": { + "HostedZoneId": "ZNKXH85TT8WVW", + "Address": "sample-cluster-instance.corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "Port": 27017 + }, + "PreferredBackupWindow": "00:00-00:30", + "DBInstanceStatus": "available", + "DBInstanceClass": "db.r4.large", + "EnabledCloudwatchLogsExports": [ + "audit" + ], + "DBInstanceIdentifier": "sample-cluster-instance", + "DBSubnetGroup": { + "Subnets": [ + { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-4e26d263", + "SubnetAvailabilityZone": { + "Name": "us-west-2a" + } + }, + { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-afc329f4", + "SubnetAvailabilityZone": { + "Name": "us-west-2c" + } + }, + { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-53ab3636", + "SubnetAvailabilityZone": { + "Name": "us-west-2d" + } + }, + { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-991cb8d0", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + } + } + ], + "DBSubnetGroupName": "default", + "SubnetGroupStatus": "Complete", + "DBSubnetGroupDescription": "default", + "VpcId": "vpc-91280df6" + }, + "InstanceCreateTime": "2019-03-15T20:36:06.338Z", + "Engine": "docdb", + "StorageEncrypted": false, + "AutoMinorVersionUpgrade": true, + "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster-instance", + "PreferredMaintenanceWindow": "tue:08:39-tue:09:09", + "VpcSecurityGroups": [ + { + "Status": "active", + "VpcSecurityGroupId": "sg-77186e0d" + } + ], + "DBClusterIdentifier": "sample-cluster", + "PendingModifiedValues": {}, + "BackupRetentionPeriod": 3, + "PubliclyAccessible": false, + "EngineVersion": "3.6.0", + "PromotionTier": 1, + "AvailabilityZone": "us-west-2c", + "DbiResourceId": "db-A2GIKUV6KPOHITGGKI2NHVISZA" + } + ] + } + +For more information, see `Describing Amazon DocumentDB Instances `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/describe-db-subnet-groups.rst awscli-1.18.69/awscli/examples/docdb/describe-db-subnet-groups.rst --- awscli-1.11.13/awscli/examples/docdb/describe-db-subnet-groups.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/describe-db-subnet-groups.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,53 @@ +**To retrieve a list of Amazon DocumentDB subnet descriptions** + +The following ``describe-db-subnet-groups`` example describes details for the Amazon DocumentDB subnet named ``default``. :: + + aws docdb describe-db-subnet-groups \ + --db-subnet-group-name default + +Output:: + + { + "DBSubnetGroups": [ + { + "VpcId": "vpc-91280df6", + "DBSubnetGroupArn": "arn:aws:rds:us-west-2:123456789012:subgrp:default", + "Subnets": [ + { + "SubnetIdentifier": "subnet-4e26d263", + "SubnetStatus": "Active", + "SubnetAvailabilityZone": { + "Name": "us-west-2a" + } + }, + { + "SubnetIdentifier": "subnet-afc329f4", + "SubnetStatus": "Active", + "SubnetAvailabilityZone": { + "Name": "us-west-2c" + } + }, + { + "SubnetIdentifier": "subnet-53ab3636", + "SubnetStatus": "Active", + "SubnetAvailabilityZone": { + "Name": "us-west-2d" + } + }, + { + "SubnetIdentifier": "subnet-991cb8d0", + "SubnetStatus": "Active", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + } + } + ], + "DBSubnetGroupName": "default", + "SubnetGroupStatus": "Complete", + "DBSubnetGroupDescription": "default" + } + ] + } + + +For more information, see `Describing Subnet Groups `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/describe-engine-default-cluster-parameters.rst awscli-1.18.69/awscli/examples/docdb/describe-engine-default-cluster-parameters.rst --- awscli-1.11.13/awscli/examples/docdb/describe-engine-default-cluster-parameters.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/describe-engine-default-cluster-parameters.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,51 @@ +**To describe the default engine and system parameter information for Amazon DocumentDB** + +The following ``describe-engine-default-cluster-parameters`` example displays details for the default engine and system parameter information for the Amazon DocumentDB parameter group ``docdb3.6``. :: + + aws docdb describe-engine-default-cluster-parameters \ + --db-parameter-group-family docdb3.6 + +Output:: + + { + "EngineDefaults": { + "DBParameterGroupFamily": "docdb3.6", + "Parameters": [ + { + "ApplyType": "dynamic", + "ParameterValue": "disabled", + "Description": "Enables auditing on cluster.", + "Source": "system", + "DataType": "string", + "MinimumEngineVersion": "3.6.0", + "AllowedValues": "enabled,disabled", + "ParameterName": "audit_logs", + "IsModifiable": true + }, + { + "ApplyType": "static", + "ParameterValue": "enabled", + "Description": "Config to enable/disable TLS", + "Source": "system", + "DataType": "string", + "MinimumEngineVersion": "3.6.0", + "AllowedValues": "disabled,enabled", + "ParameterName": "tls", + "IsModifiable": true + }, + { + "ApplyType": "dynamic", + "ParameterValue": "enabled", + "Description": "Enables TTL Monitoring", + "Source": "system", + "DataType": "string", + "MinimumEngineVersion": "3.6.0", + "AllowedValues": "disabled,enabled", + "ParameterName": "ttl_monitor", + "IsModifiable": true + } + ] + } + } + +For more information, see `DescribeEngineDefaultClusterParameters `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/describe-event-categories.rst awscli-1.18.69/awscli/examples/docdb/describe-event-categories.rst --- awscli-1.11.13/awscli/examples/docdb/describe-event-categories.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/describe-event-categories.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,24 @@ +**To describe all Amazon DocumentDB event categories** + +The following ``describe-event-categories`` example lists all categories for the Amazon DocumentDB event source type ``db-instance``. :: + + aws docdb describe-event-categories \ + --source-type db-cluster + +Output:: + + { + "EventCategoriesMapList": [ + { + "SourceType": "db-cluster", + "EventCategories": [ + "failover", + "maintenance", + "notification", + "failure" + ] + } + ] + } + +For more information, see `Viewing Event Categories `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/describe-events.rst awscli-1.18.69/awscli/examples/docdb/describe-events.rst --- awscli-1.11.13/awscli/examples/docdb/describe-events.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/describe-events.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,151 @@ +**To list Amazon DocumentDB events** + +The following ``describe-events`` example list all the Amazon DocumentDB events for the last 24 hours (1440 minutes). :: + + aws docdb describe-events \ + --duration 1440 + +This command produces no output. +Output:: + + { + "Events": [ + { + "EventCategories": [ + "failover" + ], + "Message": "Started cross AZ failover to DB instance: sample-cluster", + "Date": "2019-03-18T21:36:29.807Z", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster", + "SourceIdentifier": "sample-cluster", + "SourceType": "db-cluster" + }, + { + "EventCategories": [ + "availability" + ], + "Message": "DB instance restarted", + "Date": "2019-03-18T21:36:40.793Z", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster", + "SourceIdentifier": "sample-cluster", + "SourceType": "db-instance" + }, + { + "EventCategories": [], + "Message": "A new writer was promoted. Restarting database as a reader.", + "Date": "2019-03-18T21:36:43.873Z", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2", + "SourceIdentifier": "sample-cluster2", + "SourceType": "db-instance" + }, + { + "EventCategories": [ + "availability" + ], + "Message": "DB instance restarted", + "Date": "2019-03-18T21:36:51.257Z", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2", + "SourceIdentifier": "sample-cluster2", + "SourceType": "db-instance" + }, + { + "EventCategories": [ + "failover" + ], + "Message": "Completed failover to DB instance: sample-cluster", + "Date": "2019-03-18T21:36:53.462Z", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster", + "SourceIdentifier": "sample-cluster", + "SourceType": "db-cluster" + }, + { + "Date": "2019-03-19T16:51:48.847Z", + "EventCategories": [ + "configuration change" + ], + "Message": "Updated parameter audit_logs to enabled with apply method pending-reboot", + "SourceIdentifier": "custom3-6-param-grp", + "SourceType": "db-parameter-group" + }, + { + "EventCategories": [ + "configuration change" + ], + "Message": "Applying modification to database instance class", + "Date": "2019-03-19T17:55:20.095Z", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2", + "SourceIdentifier": "sample-cluster2", + "SourceType": "db-instance" + }, + { + "EventCategories": [ + "availability" + ], + "Message": "DB instance shutdown", + "Date": "2019-03-19T17:56:31.127Z", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2", + "SourceIdentifier": "sample-cluster2", + "SourceType": "db-instance" + }, + { + "EventCategories": [ + "configuration change" + ], + "Message": "Finished applying modification to DB instance class", + "Date": "2019-03-19T18:00:45.822Z", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2", + "SourceIdentifier": "sample-cluster2", + "SourceType": "db-instance" + }, + { + "EventCategories": [ + "availability" + ], + "Message": "DB instance restarted", + "Date": "2019-03-19T18:00:53.397Z", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2", + "SourceIdentifier": "sample-cluster2", + "SourceType": "db-instance" + }, + { + "EventCategories": [ + "availability" + ], + "Message": "DB instance shutdown", + "Date": "2019-03-19T18:23:36.045Z", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2", + "SourceIdentifier": "sample-cluster2", + "SourceType": "db-instance" + }, + { + "EventCategories": [ + "availability" + ], + "Message": "DB instance restarted", + "Date": "2019-03-19T18:23:46.209Z", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2", + "SourceIdentifier": "sample-cluster2", + "SourceType": "db-instance" + }, + { + "Date": "2019-03-19T18:39:05.822Z", + "EventCategories": [ + "configuration change" + ], + "Message": "Updated parameter ttl_monitor to enabled with apply method immediate", + "SourceIdentifier": "custom3-6-param-grp", + "SourceType": "db-parameter-group" + }, + { + "Date": "2019-03-19T18:39:48.067Z", + "EventCategories": [ + "configuration change" + ], + "Message": "Updated parameter audit_logs to disabled with apply method immediate", + "SourceIdentifier": "custom3-6-param-grp", + "SourceType": "db-parameter-group" + } + ] + } + +For more information, see `Viewing Amazon DocumentDB Events `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/describe-orderable-db-instance-options.rst awscli-1.18.69/awscli/examples/docdb/describe-orderable-db-instance-options.rst --- awscli-1.11.13/awscli/examples/docdb/describe-orderable-db-instance-options.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/describe-orderable-db-instance-options.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,144 @@ +**To find the Amazon DocumentDB instance options you can order** + +The following ``describe-orderable-db-instance-options`` example lists all instance options for Amazon DocumentDB for a region. :: + + aws docdb describe-orderable-db-instance-options \ + --engine docdb \ + --region us-east-1 + +Output:: + + { + "OrderableDBInstanceOptions": [ + { + "Vpc": true, + "AvailabilityZones": [ + { + "Name": "us-east-1a" + }, + { + "Name": "us-east-1b" + }, + { + "Name": "us-east-1c" + }, + { + "Name": "us-east-1d" + } + ], + "EngineVersion": "3.6.0", + "DBInstanceClass": "db.r4.16xlarge", + "LicenseModel": "na", + "Engine": "docdb" + }, + { + "Vpc": true, + "AvailabilityZones": [ + { + "Name": "us-east-1a" + }, + { + "Name": "us-east-1b" + }, + { + "Name": "us-east-1c" + }, + { + "Name": "us-east-1d" + } + } + ], + "EngineVersion": "3.6.0", + "DBInstanceClass": "db.r4.2xlarge", + "LicenseModel": "na", + "Engine": "docdb" + }, + { + "Vpc": true, + "AvailabilityZones": [ + { + "Name": "us-east-1a" + }, + { + "Name": "us-east-1b" + }, + { + "Name": "us-east-1c" + }, + { + "Name": "us-east-1d" + } + ], + "EngineVersion": "3.6.0", + "DBInstanceClass": "db.r4.4xlarge", + "LicenseModel": "na", + "Engine": "docdb" + }, + { + "Vpc": true, + "AvailabilityZones": [ + { + "Name": "us-east-1a" + }, + { + "Name": "us-east-1b" + }, + { + "Name": "us-east-1c" + }, + { + "Name": "us-east-1d" + } + ], + "EngineVersion": "3.6.0", + "DBInstanceClass": "db.r4.8xlarge", + "LicenseModel": "na", + "Engine": "docdb" + }, + { + "Vpc": true, + "AvailabilityZones": [ + { + "Name": "us-east-1a" + }, + { + "Name": "us-east-1b" + }, + { + "Name": "us-east-1c" + }, + { + "Name": "us-east-1d" + } + ], + "EngineVersion": "3.6.0", + "DBInstanceClass": "db.r4.large", + "LicenseModel": "na", + "Engine": "docdb" + }, + { + "Vpc": true, + "AvailabilityZones": [ + { + "Name": "us-east-1a" + }, + { + "Name": "us-east-1b" + }, + { + "Name": "us-east-1c" + }, + { + "Name": "us-east-1d" + } + ], + "EngineVersion": "3.6.0", + "DBInstanceClass": "db.r4.xlarge", + "LicenseModel": "na", + "Engine": "docdb" + } + ] + } + + +For more information, see `Adding an Amazon DocumentDB Instance to a Cluster `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/describe-pending-maintenance-actions.rst awscli-1.18.69/awscli/examples/docdb/describe-pending-maintenance-actions.rst --- awscli-1.11.13/awscli/examples/docdb/describe-pending-maintenance-actions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/describe-pending-maintenance-actions.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,13 @@ +**To list your pending Amazon DocumentDB maintenance actions** + +The following ``describe-pending-maintenance-actions`` example lists all your pending Amazon DocumentDB maintenance actions. :: + + aws docdb describe-pending-maintenance-actions + +Output:: + + { + "PendingMaintenanceActions": [] + } + +For more information, see `Maintaining Amazon DocumentDB `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/failover-db-cluster.rst awscli-1.18.69/awscli/examples/docdb/failover-db-cluster.rst --- awscli-1.11.13/awscli/examples/docdb/failover-db-cluster.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/failover-db-cluster.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,65 @@ +**To force an Amazon DocumentDB cluster to failover to a replica** + +The following ``failover-db-cluster`` example causes the primary instance in the Amazon DocumentDB cluster sample-cluster to failover to a replica. :: + + aws docdb failover-db-cluster \ + --db-cluster-identifier sample-cluster + +Output:: + + { + "DBCluster": { + "AssociatedRoles": [], + "DBClusterIdentifier": "sample-cluster", + "EngineVersion": "3.6.0", + "DBSubnetGroup": "default", + "MasterUsername": "master-user", + "EarliestRestorableTime": "2019-03-15T20:30:47.020Z", + "Endpoint": "sample-cluster.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "AvailabilityZones": [ + "us-west-2a", + "us-west-2c", + "us-west-2b" + ], + "LatestRestorableTime": "2019-03-18T21:35:23.548Z", + "PreferredMaintenanceWindow": "sat:04:30-sat:05:00", + "PreferredBackupWindow": "00:00-00:30", + "Port": 27017, + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-77186e0d", + "Status": "active" + } + ], + "StorageEncrypted": false, + "ClusterCreateTime": "2019-03-15T20:29:58.836Z", + "MultiAZ": true, + "Status": "available", + "DBClusterMembers": [ + { + "DBClusterParameterGroupStatus": "in-sync", + "IsClusterWriter": false, + "DBInstanceIdentifier": "sample-cluster", + "PromotionTier": 1 + }, + { + "DBClusterParameterGroupStatus": "in-sync", + "IsClusterWriter": true, + "DBInstanceIdentifier": "sample-cluster2", + "PromotionTier": 2 + } + ], + "EnabledCloudwatchLogsExports": [ + "audit" + ], + "DBClusterParameterGroup": "default.docdb3.6", + "HostedZoneId": "ZNKXH85TT8WVW", + "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster", + "BackupRetentionPeriod": 3, + "DbClusterResourceId": "cluster-UP4EF2PVDDFVHHDJQTYDAIGHLE", + "ReaderEndpoint": "sample-cluster.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "Engine": "docdb" + } + } + +For more information, see `Amazon DocumentDB Failover `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/list-tags-for-resource.rst awscli-1.18.69/awscli/examples/docdb/list-tags-for-resource.rst --- awscli-1.11.13/awscli/examples/docdb/list-tags-for-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/list-tags-for-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,27 @@ +**To list all the tags on an Amazon DocumentDB resource** + +The following ``list-tags-for-resource`` example lists all tags on the Amazon DocumentDB cluster ``sample-cluster``. :: + + aws docdb list-tags-for-resource \ + --resource-name arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster + +Output:: + + { + "TagList": [ + { + "Key": "A", + "Value": "ALPHA" + }, + { + "Key": "B", + "Value": "" + }, + { + "Key": "C", + "Value": "CHARLIE" + } + ] + } + +For more information, see `Listing Tags on an Amazon DocumentDB Resource `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/modify-db-cluster-parameter-group.rst awscli-1.18.69/awscli/examples/docdb/modify-db-cluster-parameter-group.rst --- awscli-1.11.13/awscli/examples/docdb/modify-db-cluster-parameter-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/modify-db-cluster-parameter-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,16 @@ +**To modify an Amazon DocumentDB DB cluster parameter group** + +The following ``modify-db-cluster-parameter-group`` example modifies the Amazon DocumentDB cluster parameter group ``custom3-6-param-grp`` by setting the two parameters ``audit_logs`` and ``ttl_monitor`` to enabled. The changes are applied at the next reboot. :: + + aws docdb modify-db-cluster-parameter-group \ + --db-cluster-parameter-group-name custom3-6-param-grp \ + --parameters ParameterName=audit_logs,ParameterValue=enabled,ApplyMethod=pending-reboot \ + ParameterName=ttl_monitor,ParameterValue=enabled,ApplyMethod=pending-reboot + +Output:: + + { + "DBClusterParameterGroupName": "custom3-6-param-grp" + } + +For more information, see `Modifying an Amazon DocumentDB Cluster Parameter Group `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/modify-db-cluster.rst awscli-1.18.69/awscli/examples/docdb/modify-db-cluster.rst --- awscli-1.11.13/awscli/examples/docdb/modify-db-cluster.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/modify-db-cluster.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,69 @@ +**To modify an Amazon DocumentDB cluster** + +The following ``modify-db-cluster`` example modifies the Amazon DocumentDB cluster ``sample-cluster`` by making the retention period for automatic backups 7 days, and changing the preferred windows for both backups and maintenance. All changes are applied at the next maintenance window. :: + + aws docdb modify-db-cluster \ + --db-cluster-identifier sample-cluster \ + --no-apply-immediately \ + --backup-retention-period 7 \ + --preferred-backup-window 18:00-18:30 \ + --preferred-maintenance-window sun:20:00-sun:20:30 + +Output:: + + { + "DBCluster": { + "Endpoint": "sample-cluster.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "DBClusterMembers": [ + { + "DBClusterParameterGroupStatus": "in-sync", + "DBInstanceIdentifier": "sample-cluster", + "IsClusterWriter": true, + "PromotionTier": 1 + }, + { + "DBClusterParameterGroupStatus": "in-sync", + "DBInstanceIdentifier": "sample-cluster2", + "IsClusterWriter": false, + "PromotionTier": 2 + } + ], + "HostedZoneId": "ZNKXH85TT8WVW", + "StorageEncrypted": false, + "PreferredBackupWindow": "18:00-18:30", + "MultiAZ": true, + "EngineVersion": "3.6.0", + "MasterUsername": "master-user", + "ReaderEndpoint": "sample-cluster.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "DBSubnetGroup": "default", + "LatestRestorableTime": "2019-03-18T22:08:13.408Z", + "EarliestRestorableTime": "2019-03-15T20:30:47.020Z", + "PreferredMaintenanceWindow": "sun:20:00-sun:20:30", + "AssociatedRoles": [], + "EnabledCloudwatchLogsExports": [ + "audit" + ], + "Engine": "docdb", + "DBClusterParameterGroup": "default.docdb3.6", + "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster", + "BackupRetentionPeriod": 7, + "DBClusterIdentifier": "sample-cluster", + "AvailabilityZones": [ + "us-west-2a", + "us-west-2c", + "us-west-2b" + ], + "Status": "available", + "DbClusterResourceId": "cluster-UP4EF2PVDDFVHHDJQTYDAIGHLE", + "ClusterCreateTime": "2019-03-15T20:29:58.836Z", + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-77186e0d", + "Status": "active" + } + ], + "Port": 27017 + } + } + +For more information, see `Modifying an Amazon DocumentDB Cluster `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/modify-db-cluster-snapshot-attribute.rst awscli-1.18.69/awscli/examples/docdb/modify-db-cluster-snapshot-attribute.rst --- awscli-1.11.13/awscli/examples/docdb/modify-db-cluster-snapshot-attribute.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/modify-db-cluster-snapshot-attribute.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,55 @@ +**Example 1: To add an attribute to an Amazon DocumentDB snapshot** + +The following ``modify-db-cluster-snapshot-attribute`` example adds four attribute values to an Amazon DocumentDB cluster snapshot. :: + + aws docdb modify-db-cluster-snapshot-attribute \ + --db-cluster-snapshot-identifier sample-cluster-snapshot \ + --attribute-name restore \ + --values-to-add all 123456789011 123456789012 123456789013 + +Output:: + + { + "DBClusterSnapshotAttributesResult": { + "DBClusterSnapshotAttributes": [ + { + "AttributeName": "restore", + "AttributeValues": [ + "all", + "123456789011", + "123456789012", + "123456789013" + ] + } + ], + "DBClusterSnapshotIdentifier": "sample-cluster-snapshot" + } + } + +**Example 2: To remove attributes from an Amazon DocumentDB snapshot** + +The following ``modify-db-cluster-snapshot-attribute`` example removes two attribute values from an Amazon DocumentDB cluster snapshot. :: + + aws docdb modify-db-cluster-snapshot-attribute \ + --db-cluster-snapshot-identifier sample-cluster-snapshot \ + --attribute-name restore \ + --values-to-remove 123456789012 all + +Output:: + + { + "DBClusterSnapshotAttributesResult": { + "DBClusterSnapshotAttributes": [ + { + "AttributeName": "restore", + "AttributeValues": [ + "123456789011", + "123456789013" + ] + } + ], + "DBClusterSnapshotIdentifier": "sample-cluster-snapshot" + } + } + +For more information, see `ModifyDBClusterSnapshotAttribute `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/modify-db-instance.rst awscli-1.18.69/awscli/examples/docdb/modify-db-instance.rst --- awscli-1.11.13/awscli/examples/docdb/modify-db-instance.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/modify-db-instance.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,88 @@ +**To modify an Amazon DocumentDB instance** + +The following ``modify-db-instance`` example modifies the Amazon DocumentDB instance ``sample-cluster2`` by changing its instance class to ``db.r4.4xlarge`` and its promotion tier to ``5``. The changes are applied immediately but can only be seen after the instances status is available. :: + + aws docdb modify-db-instance \ + --db-instance-identifier sample-cluster2 \ + --apply-immediately \ + --db-instance-class db.r4.4xlarge \ + --promotion-tier 5 + +Output:: + + { + "DBInstance": { + "EngineVersion": "3.6.0", + "StorageEncrypted": false, + "DBInstanceClass": "db.r4.large", + "PreferredMaintenanceWindow": "mon:08:39-mon:09:09", + "AutoMinorVersionUpgrade": true, + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-77186e0d", + "Status": "active" + } + ], + "PreferredBackupWindow": "18:00-18:30", + "EnabledCloudwatchLogsExports": [ + "audit" + ], + "AvailabilityZone": "us-west-2f", + "DBInstanceIdentifier": "sample-cluster2", + "InstanceCreateTime": "2019-03-15T20:36:06.338Z", + "Engine": "docdb", + "BackupRetentionPeriod": 7, + "DBSubnetGroup": { + "DBSubnetGroupName": "default", + "DBSubnetGroupDescription": "default", + "SubnetGroupStatus": "Complete", + "Subnets": [ + { + "SubnetIdentifier": "subnet-4e26d263", + "SubnetAvailabilityZone": { + "Name": "us-west-2a" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-afc329f4", + "SubnetAvailabilityZone": { + "Name": "us-west-2c" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-53ab3636", + "SubnetAvailabilityZone": { + "Name": "us-west-2d" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-991cb8d0", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + }, + "SubnetStatus": "Active" + } + ], + "VpcId": "vpc-91280df6" + }, + "PromotionTier": 2, + "Endpoint": { + "Address": "sample-cluster2.corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "HostedZoneId": "ZNKXH85TT8WVW", + "Port": 27017 + }, + "DbiResourceId": "db-A2GIKUV6KPOHITGGKI2NHVISZA", + "DBClusterIdentifier": "sample-cluster", + "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2", + "PendingModifiedValues": { + "DBInstanceClass": "db.r4.4xlarge" + }, + "PubliclyAccessible": false, + "DBInstanceStatus": "available" + } + } + +For more information, see `Modifying an Amazon DocumentDB Instance `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/modify-db-subnet-group.rst awscli-1.18.69/awscli/examples/docdb/modify-db-subnet-group.rst --- awscli-1.11.13/awscli/examples/docdb/modify-db-subnet-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/modify-db-subnet-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,45 @@ +**To modify an Amazon DocumentDB subnet group** + +The following ``modify-db-subnet-group`` example modifies the subnet group ``sample-subnet-group`` by adding the specified subnets and a new description. :: + + aws docdb modify-db-subnet-group \ + --db-subnet-group-name sample-subnet-group \ + --subnet-ids subnet-b3806e8f subnet-53ab3636 subnet-991cb8d0 \ + --db-subnet-group-description "New subnet description" + +Output:: + + { + "DBSubnetGroup": { + "DBSubnetGroupName": "sample-subnet-group", + "SubnetGroupStatus": "Complete", + "DBSubnetGroupArn": "arn:aws:rds:us-west-2:123456789012:subgrp:sample-subnet-group", + "VpcId": "vpc-91280df6", + "DBSubnetGroupDescription": "New subnet description", + "Subnets": [ + { + "SubnetIdentifier": "subnet-b3806e8f", + "SubnetStatus": "Active", + "SubnetAvailabilityZone": { + "Name": "us-west-2a" + } + }, + { + "SubnetIdentifier": "subnet-53ab3636", + "SubnetStatus": "Active", + "SubnetAvailabilityZone": { + "Name": "us-west-2c" + } + }, + { + "SubnetIdentifier": "subnet-991cb8d0", + "SubnetStatus": "Active", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + } + } + ] + } + } + +For more information, see `Modifying an Amazon DocumentDB Subnet Group `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/reboot-db-instance.rst awscli-1.18.69/awscli/examples/docdb/reboot-db-instance.rst --- awscli-1.11.13/awscli/examples/docdb/reboot-db-instance.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/reboot-db-instance.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,84 @@ +**To reboot an Amazon DocumentDB instance** + +The following ``reboot-db-instance`` example reboots the Amazon DocumentDB instance ``sample-cluster2``. :: + + aws docdb reboot-db-instance \ + --db-instance-identifier sample-cluster2 + +This command produces no output. +Output:: + + { + "DBInstance": { + "PreferredBackupWindow": "18:00-18:30", + "DBInstanceIdentifier": "sample-cluster2", + "VpcSecurityGroups": [ + { + "Status": "active", + "VpcSecurityGroupId": "sg-77186e0d" + } + ], + "DBSubnetGroup": { + "VpcId": "vpc-91280df6", + "Subnets": [ + { + "SubnetStatus": "Active", + "SubnetAvailabilityZone": { + "Name": "us-west-2a" + }, + "SubnetIdentifier": "subnet-4e26d263" + }, + { + "SubnetStatus": "Active", + "SubnetAvailabilityZone": { + "Name": "us-west-2c" + }, + "SubnetIdentifier": "subnet-afc329f4" + }, + { + "SubnetStatus": "Active", + "SubnetAvailabilityZone": { + "Name": "us-west-2d" + }, + "SubnetIdentifier": "subnet-53ab3636" + }, + { + "SubnetStatus": "Active", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + }, + "SubnetIdentifier": "subnet-991cb8d0" + } + ], + "SubnetGroupStatus": "Complete", + "DBSubnetGroupName": "default", + "DBSubnetGroupDescription": "default" + }, + "PendingModifiedValues": {}, + "Endpoint": { + "Address": "sample-cluster2.corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "HostedZoneId": "ZNKXH85TT8WVW", + "Port": 27017 + }, + "EnabledCloudwatchLogsExports": [ + "audit" + ], + "StorageEncrypted": false, + "DbiResourceId": "db-A2GIKUV6KPOHITGGKI2NHVISZA", + "AutoMinorVersionUpgrade": true, + "Engine": "docdb", + "InstanceCreateTime": "2019-03-15T20:36:06.338Z", + "EngineVersion": "3.6.0", + "PromotionTier": 5, + "BackupRetentionPeriod": 7, + "DBClusterIdentifier": "sample-cluster", + "PreferredMaintenanceWindow": "mon:08:39-mon:09:09", + "PubliclyAccessible": false, + "DBInstanceClass": "db.r4.4xlarge", + "AvailabilityZone": "us-west-2d", + "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2", + "DBInstanceStatus": "rebooting" + } + } + +For more information, see `Rebooting an Amazon DocumentDB ILnstance `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/remove-tags-from-resource.rst awscli-1.18.69/awscli/examples/docdb/remove-tags-from-resource.rst --- awscli-1.11.13/awscli/examples/docdb/remove-tags-from-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/remove-tags-from-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To remove tags from an Amazon DocumentDB resource** + +The following ``remove-tags-from-resource`` example removes the tag with the key named ``B`` from the Amazon DocumentDB cluster ``sample-cluster``. :: + + aws docdb remove-tags-from-resource \ + --resource-name arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster \ + --tag-keys B + +This command produces no output. + +For more information, see `Removing Tags from an Amazon DocumentDBResource `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/reset-db-cluster-parameter-group.rst awscli-1.18.69/awscli/examples/docdb/reset-db-cluster-parameter-group.rst --- awscli-1.11.13/awscli/examples/docdb/reset-db-cluster-parameter-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/reset-db-cluster-parameter-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,31 @@ +**To reset the specified parameter value to its defaults in an Amazon DocumentDB parameter group** + +The following ``reset-db-cluster-parameter-group`` example resets the parameter ``ttl_monitor`` in the Amazon DocumentDB parameter group ``custom3-6-param-grp`` to its default value. :: + + aws docdb reset-db-cluster-parameter-group \ + --db-cluster-parameter-group-name custom3-6-param-grp \ + --parameters ParameterName=ttl_monitor,ApplyMethod=immediate + +Output:: + + { + "DBClusterParameterGroupName": "custom3-6-param-grp" + } + +For more information, see `title `__ in the *Amazon DocumentDB Developer Guide*. + +**To reset specified or all parameter values to their defaults in an Amazon DocumentDB parameter group** + +The following ``reset-db-cluster-parameter-group`` example resets all parameters in the Amazon DocumentDB parameter group ``custom3-6-param-grp`` to their default value. :: + + aws docdb reset-db-cluster-parameter-group \ + --db-cluster-parameter-group-name custom3-6-param-grp \ + --reset-all-parameters + +Output:: + + { + "DBClusterParameterGroupName": "custom3-6-param-grp" + } + +For more information, see `Resetting an Amazon DocumentDB Cluster Parameter Group `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/restore-db-cluster-from-snapshot.rst awscli-1.18.69/awscli/examples/docdb/restore-db-cluster-from-snapshot.rst --- awscli-1.11.13/awscli/examples/docdb/restore-db-cluster-from-snapshot.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/restore-db-cluster-from-snapshot.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,50 @@ +**To restore an Amazon DocumentDB cluster from an automatic or manual snapshot** + +The following ``restore-db-cluster-from-snapshot`` example creates a new Amazon DocumentDB cluster named ``sample-cluster-2019-03-16-00-01-restored`` from the snapshot ``rds:sample-cluster-2019-03-16-00-01``. :: + + aws docdb restore-db-cluster-from-snapshot \ + --db-cluster-identifier sample-cluster-2019-03-16-00-01-restored \ + --engine docdb \ + --snapshot-identifier rds:sample-cluster-2019-03-16-00-01 + +Output:: + + { + "DBCluster": { + "ClusterCreateTime": "2019-03-19T18:45:01.857Z", + "HostedZoneId": "ZNKXH85TT8WVW", + "Engine": "docdb", + "DBClusterMembers": [], + "MultiAZ": false, + "AvailabilityZones": [ + "us-west-2a", + "us-west-2c", + "us-west-2b" + ], + "StorageEncrypted": false, + "ReaderEndpoint": "sample-cluster-2019-03-16-00-01-restored.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "Endpoint": "sample-cluster-2019-03-16-00-01-restored.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "Port": 27017, + "PreferredBackupWindow": "00:00-00:30", + "DBSubnetGroup": "default", + "DBClusterIdentifier": "sample-cluster-2019-03-16-00-01-restored", + "PreferredMaintenanceWindow": "sat:04:30-sat:05:00", + "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster-2019-03-16-00-01-restored", + "DBClusterParameterGroup": "default.docdb3.6", + "DbClusterResourceId": "cluster-XOO46Q3RH4LWSYNH3NMZKXPISU", + "MasterUsername": "master-user", + "EngineVersion": "3.6.0", + "BackupRetentionPeriod": 3, + "AssociatedRoles": [], + "Status": "creating", + "VpcSecurityGroups": [ + { + "Status": "active", + "VpcSecurityGroupId": "sg-77186e0d" + } + ] + } + } + + +For more information, see `Restoring from a Cluster Snapshot `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/restore-db-cluster-to-point-in-time.rst awscli-1.18.69/awscli/examples/docdb/restore-db-cluster-to-point-in-time.rst --- awscli-1.11.13/awscli/examples/docdb/restore-db-cluster-to-point-in-time.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/restore-db-cluster-to-point-in-time.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,49 @@ +**To restore an Amazon DocumentDB cluster to a point-in-time from a manual snapshot** + +The following ``restore-db-cluster-to-point-in-time`` example uses the ``sample-cluster-snapshot`` to create a new Amazon DocumentDB cluster, ``sample-cluster-pit``, using the latest restorable time. :: + + aws docdb restore-db-cluster-to-point-in-time \ + --db-cluster-identifier sample-cluster-pit \ + --source-db-cluster-identifier arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster \ + --use-latest-restorable-time + +Output:: + + { + "DBCluster": { + "StorageEncrypted": false, + "BackupRetentionPeriod": 3, + "MasterUsername": "master-user", + "HostedZoneId": "ZNKXH85TT8WVW", + "PreferredBackupWindow": "00:00-00:30", + "MultiAZ": false, + "DBClusterIdentifier": "sample-cluster-pit", + "DBSubnetGroup": "default", + "ClusterCreateTime": "2019-04-03T15:55:21.320Z", + "AssociatedRoles": [], + "DBClusterParameterGroup": "default.docdb3.6", + "DBClusterMembers": [], + "Status": "creating", + "AvailabilityZones": [ + "us-west-2a", + "us-west-2d", + "us-west-2b" + ], + "ReaderEndpoint": "sample-cluster-pit.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "Port": 27017, + "Engine": "docdb", + "EngineVersion": "3.6.0", + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-77186e0d", + "Status": "active" + } + ], + "PreferredMaintenanceWindow": "sat:04:30-sat:05:00", + "Endpoint": "sample-cluster-pit.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "DbClusterResourceId": "cluster-NLCABBXOSE2QPQ4GOLZIFWEPLM", + "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster-pit" + } + } + +For more information, see `Restoring a Snapshot to a Point in Time `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/start-db-cluster.rst awscli-1.18.69/awscli/examples/docdb/start-db-cluster.rst --- awscli-1.11.13/awscli/examples/docdb/start-db-cluster.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/start-db-cluster.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,47 @@ +**To start a stopped Amazon DocumentDB cluster** + +The following ``start-db-cluster`` example starts the specified Amazon DocumentDB cluster. :: + + aws docdb start-db-cluster \ + --db-cluster-identifier sample-cluster + +Output:: + + { + "DBCluster": { + "ClusterCreateTime": "2019-03-19T18:45:01.857Z", + "HostedZoneId": "ZNKXH85TT8WVW", + "Engine": "docdb", + "DBClusterMembers": [], + "MultiAZ": false, + "AvailabilityZones": [ + "us-east-1a", + "us-east-1c", + "us-east-1f" + ], + "StorageEncrypted": false, + "ReaderEndpoint": "sample-cluster-2019-03-16-00-01-restored.cluster-ro-corcjozrlsfc.us-east-1.docdb.amazonaws.com", + "Endpoint": "sample-cluster-2019-03-16-00-01-restored.cluster-corcjozrlsfc.us-east-1.docdb.amazonaws.com", + "Port": 27017, + "PreferredBackupWindow": "00:00-00:30", + "DBSubnetGroup": "default", + "DBClusterIdentifier": "sample-cluster-2019-03-16-00-01-restored", + "PreferredMaintenanceWindow": "sat:04:30-sat:05:00", + "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster-2019-03-16-00-01-restored", + "DBClusterParameterGroup": "default.docdb3.6", + "DbClusterResourceId": "cluster-XOO46Q3RH4LWSYNH3NMZKXPISU", + "MasterUsername": "master-user", + "EngineVersion": "3.6.0", + "BackupRetentionPeriod": 3, + "AssociatedRoles": [], + "Status": "creating", + "VpcSecurityGroups": [ + { + "Status": "active", + "VpcSecurityGroupId": "sg-77186e0d" + } + ] + } + } + +For more information, see `Stopping and Starting an Amazon DocumentDB Cluster `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/stop-db-cluster.rst awscli-1.18.69/awscli/examples/docdb/stop-db-cluster.rst --- awscli-1.11.13/awscli/examples/docdb/stop-db-cluster.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/stop-db-cluster.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,47 @@ +**To stop a running Amazon DocumentDB cluster** + +The following ``stop-db-cluster`` example stops the specified Amazon DocumentDB cluster. :: + + aws docdb stop-db-cluster \ + --db-cluster-identifier sample-cluster + +Output:: + + { + "DBCluster": { + "ClusterCreateTime": "2019-03-19T18:45:01.857Z", + "HostedZoneId": "ZNKXH85TT8WVW", + "Engine": "docdb", + "DBClusterMembers": [], + "MultiAZ": false, + "AvailabilityZones": [ + "us-east-1a", + "us-east-1c", + "us-east-1f" + ], + "StorageEncrypted": false, + "ReaderEndpoint": "sample-cluster-2019-03-16-00-01-restored.cluster-ro-corcjozrlsfc.us-east-1.docdb.amazonaws.com", + "Endpoint": "sample-cluster-2019-03-16-00-01-restored.cluster-corcjozrlsfc.us-east-1.docdb.amazonaws.com", + "Port": 27017, + "PreferredBackupWindow": "00:00-00:30", + "DBSubnetGroup": "default", + "DBClusterIdentifier": "sample-cluster-2019-03-16-00-01-restored", + "PreferredMaintenanceWindow": "sat:04:30-sat:05:00", + "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster-2019-03-16-00-01-restored", + "DBClusterParameterGroup": "default.docdb3.6", + "DbClusterResourceId": "cluster-XOO46Q3RH4LWSYNH3NMZKXPISU", + "MasterUsername": "master-user", + "EngineVersion": "3.6.0", + "BackupRetentionPeriod": 3, + "AssociatedRoles": [], + "Status": "creating", + "VpcSecurityGroups": [ + { + "Status": "active", + "VpcSecurityGroupId": "sg-77186e0d" + } + ] + } + } + +For more information, see `Stopping and Starting an Amazon DocumentDB Cluster `__ in the *Amazon DocumentDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/docdb/wait/db-instance-available.rst awscli-1.18.69/awscli/examples/docdb/wait/db-instance-available.rst --- awscli-1.11.13/awscli/examples/docdb/wait/db-instance-available.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/wait/db-instance-available.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To pause running until the specified instance is available** + +The following ``wait role-exists`` command pauses and continues only after it can confirm that the specified database cluster instance exists. :: + + aws docdb wait db-instance-available \ + --db-instance-identifier "sample-instance" + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/docdb/wait/db-instance-deleted.rst awscli-1.18.69/awscli/examples/docdb/wait/db-instance-deleted.rst --- awscli-1.11.13/awscli/examples/docdb/wait/db-instance-deleted.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/docdb/wait/db-instance-deleted.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To pause running until the specified cluster instance is deleted** + +The following ``wait db-instance-deleted`` command pauses and continues only after it can confirm that the specified database cluster instance is deleted. :: + + aws docdb wait db-instance-deleted \ + --db-instance-identifier "sample-instance" + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/ds/describe-directories.rst awscli-1.18.69/awscli/examples/ds/describe-directories.rst --- awscli-1.11.13/awscli/examples/ds/describe-directories.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ds/describe-directories.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,50 @@ +**To get details about your directories** + +The following ``describe-directories`` example displays details about the specified directory. :: + + aws ds describe-directories \ + --directory-id d-a1b2c3d4e5 + +Output:: + + { + "DirectoryDescriptions": [ + { + "DirectoryId": "d-a1b2c3d4e5", + "Name": "mydirectory.example.com", + "ShortName": "mydirectory", + "Size": "Small", + "Edition": "Standard", + "Alias": "d-a1b2c3d4e5", + "AccessUrl": "d-a1b2c3d4e5.awsapps.com", + "Stage": "Active", + "ShareStatus": "Shared", + "ShareMethod": "HANDSHAKE", + "ShareNotes": "These are my share notes", + "LaunchTime": "2019-07-08T15:33:46.327000-07:00", + "StageLastUpdatedDateTime": "2019-07-08T15:59:12.307000-07:00", + "Type": "SharedMicrosoftAD", + "SsoEnabled": false, + "DesiredNumberOfDomainControllers": 0, + "OwnerDirectoryDescription": { + "DirectoryId": "d-b2c3d4e5f6", + "AccountId": "123456789111", + "DnsIpAddrs": [ + "203.113.0.248", + "203.113.0.253" + ], + "VpcSettings": { + "VpcId": "vpc-a1b2c3d4", + "SubnetIds": [ + "subnet-a1b2c3d4", + "subnet-d4c3b2a1" + ], + "AvailabilityZones": [ + "us-west-2a", + "us-west-2c" + ] + } + } + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ds/describe-trusts.rst awscli-1.18.69/awscli/examples/ds/describe-trusts.rst --- awscli-1.11.13/awscli/examples/ds/describe-trusts.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ds/describe-trusts.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,25 @@ +**To get details about your trust relationships** + +The following ``describe-trusts`` example displays details about the trust relationships for the specified directory. :: + + aws ds describe-trusts \ + --directory-id d-a1b2c3d4e5 + +Output:: + + { + "Trusts": [ + { + "DirectoryId": "d-a1b2c3d4e5", + "TrustId": "t-9a8b7c6d5e", + "RemoteDomainName": "other.example.com", + "TrustType": "Forest", + "TrustDirection": "Two-Way", + "TrustState": "Verified", + "CreatedDateTime": "2017-06-20T18:08:45.614000-07:00", + "LastUpdatedDateTime": "2019-06-04T10:52:12.410000-07:00", + "StateLastUpdatedDateTime": "2019-06-04T10:52:12.410000-07:00", + "SelectiveAuth": "Disabled" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/dynamodb/batch-get-item.rst awscli-1.18.69/awscli/examples/dynamodb/batch-get-item.rst --- awscli-1.11.13/awscli/examples/dynamodb/batch-get-item.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/batch-get-item.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/batch-write-item.rst awscli-1.18.69/awscli/examples/dynamodb/batch-write-item.rst --- awscli-1.11.13/awscli/examples/dynamodb/batch-write-item.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/batch-write-item.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/create-backup.rst awscli-1.18.69/awscli/examples/dynamodb/create-backup.rst --- awscli-1.11.13/awscli/examples/dynamodb/create-backup.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/create-backup.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/create-global-table.rst awscli-1.18.69/awscli/examples/dynamodb/create-global-table.rst --- awscli-1.11.13/awscli/examples/dynamodb/create-global-table.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/create-global-table.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/create-table.rst awscli-1.18.69/awscli/examples/dynamodb/create-table.rst --- awscli-1.11.13/awscli/examples/dynamodb/create-table.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/create-table.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/delete-backup.rst awscli-1.18.69/awscli/examples/dynamodb/delete-backup.rst --- awscli-1.11.13/awscli/examples/dynamodb/delete-backup.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/delete-backup.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/delete-item.rst awscli-1.18.69/awscli/examples/dynamodb/delete-item.rst --- awscli-1.11.13/awscli/examples/dynamodb/delete-item.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/delete-item.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/delete-table.rst awscli-1.18.69/awscli/examples/dynamodb/delete-table.rst --- awscli-1.11.13/awscli/examples/dynamodb/delete-table.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/delete-table.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/describe-backup.rst awscli-1.18.69/awscli/examples/dynamodb/describe-backup.rst --- awscli-1.11.13/awscli/examples/dynamodb/describe-backup.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/describe-backup.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/describe-continuous-backups.rst awscli-1.18.69/awscli/examples/dynamodb/describe-continuous-backups.rst --- awscli-1.11.13/awscli/examples/dynamodb/describe-continuous-backups.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/describe-continuous-backups.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/describe-contributor-insights.rst awscli-1.18.69/awscli/examples/dynamodb/describe-contributor-insights.rst --- awscli-1.11.13/awscli/examples/dynamodb/describe-contributor-insights.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/describe-contributor-insights.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/describe-endpoints.rst awscli-1.18.69/awscli/examples/dynamodb/describe-endpoints.rst --- awscli-1.11.13/awscli/examples/dynamodb/describe-endpoints.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/describe-endpoints.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/describe-global-table.rst awscli-1.18.69/awscli/examples/dynamodb/describe-global-table.rst --- awscli-1.11.13/awscli/examples/dynamodb/describe-global-table.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/describe-global-table.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/describe-global-table-settings.rst awscli-1.18.69/awscli/examples/dynamodb/describe-global-table-settings.rst --- awscli-1.11.13/awscli/examples/dynamodb/describe-global-table-settings.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/describe-global-table-settings.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/describe-limits.rst awscli-1.18.69/awscli/examples/dynamodb/describe-limits.rst --- awscli-1.11.13/awscli/examples/dynamodb/describe-limits.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/describe-limits.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/describe-table-replica-auto-scaling.rst awscli-1.18.69/awscli/examples/dynamodb/describe-table-replica-auto-scaling.rst --- awscli-1.11.13/awscli/examples/dynamodb/describe-table-replica-auto-scaling.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/describe-table-replica-auto-scaling.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/describe-table.rst awscli-1.18.69/awscli/examples/dynamodb/describe-table.rst --- awscli-1.11.13/awscli/examples/dynamodb/describe-table.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/describe-table.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/describe-time-to-live.rst awscli-1.18.69/awscli/examples/dynamodb/describe-time-to-live.rst --- awscli-1.11.13/awscli/examples/dynamodb/describe-time-to-live.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/describe-time-to-live.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/get-item.rst awscli-1.18.69/awscli/examples/dynamodb/get-item.rst --- awscli-1.11.13/awscli/examples/dynamodb/get-item.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/get-item.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/list-backups.rst awscli-1.18.69/awscli/examples/dynamodb/list-backups.rst --- awscli-1.11.13/awscli/examples/dynamodb/list-backups.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/list-backups.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/list-contributor-insights.rst awscli-1.18.69/awscli/examples/dynamodb/list-contributor-insights.rst --- awscli-1.11.13/awscli/examples/dynamodb/list-contributor-insights.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/list-contributor-insights.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/list-global-tables.rst awscli-1.18.69/awscli/examples/dynamodb/list-global-tables.rst --- awscli-1.11.13/awscli/examples/dynamodb/list-global-tables.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/list-global-tables.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/list-tables.rst awscli-1.18.69/awscli/examples/dynamodb/list-tables.rst --- awscli-1.11.13/awscli/examples/dynamodb/list-tables.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/list-tables.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/list-tags-of-resource.rst awscli-1.18.69/awscli/examples/dynamodb/list-tags-of-resource.rst --- awscli-1.11.13/awscli/examples/dynamodb/list-tags-of-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/list-tags-of-resource.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/put-item.rst awscli-1.18.69/awscli/examples/dynamodb/put-item.rst --- awscli-1.11.13/awscli/examples/dynamodb/put-item.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/put-item.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/query.rst awscli-1.18.69/awscli/examples/dynamodb/query.rst --- awscli-1.11.13/awscli/examples/dynamodb/query.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/query.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/restore-table-from-backup.rst awscli-1.18.69/awscli/examples/dynamodb/restore-table-from-backup.rst --- awscli-1.11.13/awscli/examples/dynamodb/restore-table-from-backup.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/restore-table-from-backup.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/restore-table-to-point-in-time.rst awscli-1.18.69/awscli/examples/dynamodb/restore-table-to-point-in-time.rst --- awscli-1.11.13/awscli/examples/dynamodb/restore-table-to-point-in-time.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/restore-table-to-point-in-time.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/scan.rst awscli-1.18.69/awscli/examples/dynamodb/scan.rst --- awscli-1.11.13/awscli/examples/dynamodb/scan.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/scan.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/tag-resource.rst awscli-1.18.69/awscli/examples/dynamodb/tag-resource.rst --- awscli-1.11.13/awscli/examples/dynamodb/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/tag-resource.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/transact-get-items.rst awscli-1.18.69/awscli/examples/dynamodb/transact-get-items.rst --- awscli-1.11.13/awscli/examples/dynamodb/transact-get-items.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/transact-get-items.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/transact-write-items.rst awscli-1.18.69/awscli/examples/dynamodb/transact-write-items.rst --- awscli-1.11.13/awscli/examples/dynamodb/transact-write-items.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/transact-write-items.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/untag-resource.rst awscli-1.18.69/awscli/examples/dynamodb/untag-resource.rst --- awscli-1.11.13/awscli/examples/dynamodb/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/untag-resource.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/update-continuous-backups.rst awscli-1.18.69/awscli/examples/dynamodb/update-continuous-backups.rst --- awscli-1.11.13/awscli/examples/dynamodb/update-continuous-backups.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/update-continuous-backups.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/update-contributor-insights.rst awscli-1.18.69/awscli/examples/dynamodb/update-contributor-insights.rst --- awscli-1.11.13/awscli/examples/dynamodb/update-contributor-insights.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/update-contributor-insights.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/update-global-table.rst awscli-1.18.69/awscli/examples/dynamodb/update-global-table.rst --- awscli-1.11.13/awscli/examples/dynamodb/update-global-table.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/update-global-table.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/update-global-table-settings.rst awscli-1.18.69/awscli/examples/dynamodb/update-global-table-settings.rst --- awscli-1.11.13/awscli/examples/dynamodb/update-global-table-settings.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/update-global-table-settings.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/update-item.rst awscli-1.18.69/awscli/examples/dynamodb/update-item.rst --- awscli-1.11.13/awscli/examples/dynamodb/update-item.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/update-item.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/update-table-replica-auto-scaling.rst awscli-1.18.69/awscli/examples/dynamodb/update-table-replica-auto-scaling.rst --- awscli-1.11.13/awscli/examples/dynamodb/update-table-replica-auto-scaling.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/update-table-replica-auto-scaling.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/update-table.rst awscli-1.18.69/awscli/examples/dynamodb/update-table.rst --- awscli-1.11.13/awscli/examples/dynamodb/update-table.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/update-table.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/update-time-to-live.rst awscli-1.18.69/awscli/examples/dynamodb/update-time-to-live.rst --- awscli-1.11.13/awscli/examples/dynamodb/update-time-to-live.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/update-time-to-live.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodb/wait/table-exists.rst awscli-1.18.69/awscli/examples/dynamodb/wait/table-exists.rst --- awscli-1.11.13/awscli/examples/dynamodb/wait/table-exists.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodb/wait/table-exists.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodbstreams/describe-stream.rst awscli-1.18.69/awscli/examples/dynamodbstreams/describe-stream.rst --- awscli-1.11.13/awscli/examples/dynamodbstreams/describe-stream.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodbstreams/describe-stream.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodbstreams/get-records.rst awscli-1.18.69/awscli/examples/dynamodbstreams/get-records.rst --- awscli-1.11.13/awscli/examples/dynamodbstreams/get-records.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodbstreams/get-records.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodbstreams/get-shard-iterator.rst awscli-1.18.69/awscli/examples/dynamodbstreams/get-shard-iterator.rst --- awscli-1.11.13/awscli/examples/dynamodbstreams/get-shard-iterator.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodbstreams/get-shard-iterator.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/dynamodbstreams/list-streams.rst awscli-1.18.69/awscli/examples/dynamodbstreams/list-streams.rst --- awscli-1.11.13/awscli/examples/dynamodbstreams/list-streams.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/dynamodbstreams/list-streams.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/accept-reserved-instances-exchange-quote.rst awscli-1.18.69/awscli/examples/ec2/accept-reserved-instances-exchange-quote.rst --- awscli-1.11.13/awscli/examples/ec2/accept-reserved-instances-exchange-quote.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/accept-reserved-instances-exchange-quote.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,13 @@ +**To perform a Convertible Reserved Instance exchange** + +This example performs an exchange of the specified Convertible Reserved Instances. + +Command:: + + aws ec2 accept-reserved-instances-exchange-quote --reserved-instance-ids 7b8750c3-397e-4da4-bbcb-a45ebexample --target-configurations OfferingId=b747b472-423c-48f3-8cee-679bcexample + +Output:: + + { + "ExchangeId": "riex-e68ed3c1-8bc8-4c17-af77-811afexample" + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/accept-transit-gateway-peering-attachment.rst awscli-1.18.69/awscli/examples/ec2/accept-transit-gateway-peering-attachment.rst --- awscli-1.11.13/awscli/examples/ec2/accept-transit-gateway-peering-attachment.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/accept-transit-gateway-peering-attachment.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/accept-transit-gateway-vpc-attachment.rst awscli-1.18.69/awscli/examples/ec2/accept-transit-gateway-vpc-attachment.rst --- awscli-1.11.13/awscli/examples/ec2/accept-transit-gateway-vpc-attachment.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/accept-transit-gateway-vpc-attachment.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,28 @@ +**To accept a request to attach a VPC to a transit gateway.** + +The following ``accept-transit-gateway-vpc-attachment`` example accepts the request forte specified attachment. :: + + accept-transit-gateway-vpc-attachment \ + --transit-gateway-attachment-id tgw-attach-0a34fe6b4fEXAMPLE + +Output:: + + { + "TransitGatewayVpcAttachment": { + "TransitGatewayAttachmentId": "tgw-attach-0a34fe6b4fEXAMPLE", + "TransitGatewayId": "tgw-0262a0e521EXAMPLE", + "VpcId": "vpc-07e8ffd50fEXAMPLE", + "VpcOwnerId": "123456789012", + "State": "pending", + "SubnetIds": [ + "subnet-0752213d59EXAMPLE" + ], + "CreationTime": "2019-07-10T17:33:46.000Z", + "Options": { + "DnsSupport": "enable", + "Ipv6Support": "disable" + } + } + } + +For more information, see `Transit Gateway Attachments to a VPC`__ in the *AWS Transit Gateways Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/accept-vpc-endpoint-connections.rst awscli-1.18.69/awscli/examples/ec2/accept-vpc-endpoint-connections.rst --- awscli-1.11.13/awscli/examples/ec2/accept-vpc-endpoint-connections.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/accept-vpc-endpoint-connections.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,13 @@ +**To accept an interface endpoint connection request** + +This example accepts the specified endpoint connection request for the specified endpoint service. + +Command:: + + aws ec2 accept-vpc-endpoint-connections --service-id vpce-svc-03d5ebb7d9579a2b3 --vpc-endpoint-ids vpce-0c1308d7312217abc + +Output:: + + { + "Unsuccessful": [] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/advertise-byoip-cidr.rst awscli-1.18.69/awscli/examples/ec2/advertise-byoip-cidr.rst --- awscli-1.11.13/awscli/examples/ec2/advertise-byoip-cidr.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/advertise-byoip-cidr.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,16 @@ +**To advertise an address range** + +The following ``advertise-byoip-cidr`` example advertises the specified public IPv4 address range. :: + + aws ec2 advertise-byoip-cidr \ + --cidr 203.0.113.25/24 + +Output:: + + { + "ByoipCidr": { + "Cidr": "203.0.113.25/24", + "StatusMessage": "ipv4pool-ec2-1234567890abcdef0", + "State": "provisioned" + } + } diff -Nru awscli-1.11.13/awscli/examples/ec2/allocate-address.rst awscli-1.18.69/awscli/examples/ec2/allocate-address.rst --- awscli-1.11.13/awscli/examples/ec2/allocate-address.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/allocate-address.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,31 +1,31 @@ -**To allocate an Elastic IP address for EC2-Classic** +**Example 1: To allocate an Elastic IP address for EC2-Classic** -This example allocates an Elastic IP address to use with an instance in EC2-Classic. +The following ``allocate-address`` example allocates an Elastic IP address to use with an instance in EC2-Classic. :: -Command:: - - aws ec2 allocate-address + aws ec2 allocate-address Output:: - { - "PublicIp": "198.51.100.0", - "Domain": "standard" - } - -**To allocate an Elastic IP address for EC2-VPC** - -This example allocates an Elastic IP address to use with an instance in a VPC. - -Command:: - - aws ec2 allocate-address --domain vpc + { + "PublicIp": "198.51.100.0", + "PublicIpv4Pool": "amazon", + "Domain": "standard" + } + +**Example 2: To allocate an Elastic IP address for EC2-VPC** + +The following ``allocate-address`` example allocates an Elastic IP address to use with an instance in a VPC. :: + + aws ec2 allocate-address \ + --domain vpc \ + --network-border-group us-west-2-lax-1 Output:: - { - "PublicIp": "203.0.113.0", - "Domain": "vpc", - "AllocationId": "eipalloc-64d5890a" - } - + { + "PublicIp": "70.224.234.241", + "AllocationId": "eipalloc-02463d08ceEXAMPLE", + "PublicIpv4Pool": "amazon", + "NetworkBorderGroup": "us-west-2-lax-1", + "Domain": "vpc" + } diff -Nru awscli-1.11.13/awscli/examples/ec2/allocate-hosts.rst awscli-1.18.69/awscli/examples/ec2/allocate-hosts.rst --- awscli-1.11.13/awscli/examples/ec2/allocate-hosts.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/allocate-hosts.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,17 +1,55 @@ -**To allocate a Dedicated host to your account** +**Example 1: To allocate a Dedicated Host** -This example allocates a single Dedicated host in a specific Availability Zone, onto which you can launch m3.medium instances, to your account. +The following ``allocate-hosts`` example allocates a single Dedicated Host in the ``eu-west-1a`` Availability Zone, onto which you can launch ``m5.large`` instances. By default, the Dedicated Host accepts only target instance launches, and does not support host recovery. :: -Command:: + aws ec2 allocate-hosts \ + --instance-type m5.large \ + --availability-zone eu-west-1a \ + --quantity 1 - aws ec2 allocate-hosts --instance-type m3.medium --availability-zone us-east-1b --quantity 1 +Output:: + + { + "HostIds": [ + "h-07879acf49EXAMPLE" + ] + } + +**Example 2: To allocate a Dedicated Host with auto-placement and host recovery enabled** + +The following ``allocate-hosts`` example allocates a single Dedicated Host in the ``eu-west-1a`` Availability Zone with auto-placement and host recovery enabled. :: + + aws ec2 allocate-hosts \ + --instance-type m5.large \ + --availability-zone eu-west-1a \ + --auto-placement on \ + --host-recovery on \ + --quantity 1 Output:: - { - "HostIds": [ - "h-029e7409a337631f" - ] - } + { + "HostIds": [ + "h-07879acf49EXAMPLE" + ] + } + +**Example 3: To allocate a Dedicated Host with tags** + +The following ``allocate-hosts`` example allocates a single Dedicated Host and applies a tag with a key named ``purpose`` and a value of ``production``. :: + + aws ec2 allocate-hosts \ + --instance-type m5.large \ + --availability-zone eu-west-1a \ + --quantity 1 \ + --tag-specifications 'ResourceType=dedicated-host,Tags={Key=purpose,Value=production}' + +Output:: + { + "HostIds": [ + "h-07879acf49EXAMPLE" + ] + } +For more information, see `Allocating Dedicated Hosts `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. diff -Nru awscli-1.11.13/awscli/examples/ec2/apply-security-groups-to-client-vpn-target-network.rst awscli-1.18.69/awscli/examples/ec2/apply-security-groups-to-client-vpn-target-network.rst --- awscli-1.11.13/awscli/examples/ec2/apply-security-groups-to-client-vpn-target-network.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/apply-security-groups-to-client-vpn-target-network.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To apply security groups to a target network for a Client VPN endpoint** + +The following ``apply-security-groups-to-client-vpn-target-network`` example applies security group ``sg-01f6e627a89f4db32`` to the association between the specified target network and Client VPN endpoint. :: + + aws ec2 apply-security-groups-to-client-vpn-target-network \ + --security-group-ids sg-01f6e627a89f4db32 \ + --vpc-id vpc-0e2110c2f324332e0 \ + --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde + +Output:: + + { + "SecurityGroupIds": [ + "sg-01f6e627a89f4db32" + ] + } + +For more information, see `Target Networks `__ in the *AWS Client VPN Administrator Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/assign-ipv6-addresses.rst awscli-1.18.69/awscli/examples/ec2/assign-ipv6-addresses.rst --- awscli-1.11.13/awscli/examples/ec2/assign-ipv6-addresses.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/assign-ipv6-addresses.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,35 @@ +**To assign specific IPv6 addresses to a network interface** + +This example assigns the specified IPv6 addresses to the specified network interface. + +Command:: + + aws ec2 assign-ipv6-addresses --network-interface-id eni-38664473 --ipv6-addresses 2001:db8:1234:1a00:3304:8879:34cf:4071 2001:db8:1234:1a00:9691:9503:25ad:1761 + +Output:: + + { + "AssignedIpv6Addresses": [ + "2001:db8:1234:1a00:3304:8879:34cf:4071", + "2001:db8:1234:1a00:9691:9503:25ad:1761" + ], + "NetworkInterfaceId": "eni-38664473" + } + +**To assign IPv6 addresses that Amazon selects to a network interface** + +This example assigns two IPv6 addresses to the specified network interface. Amazon automatically assigns these IPv6 addresses from the available IPv6 addresses in the IPv6 CIDR block range of the subnet. + +Command:: + + aws ec2 assign-ipv6-addresses --network-interface-id eni-38664473 --ipv6-address-count 2 + +Output:: + + { + "AssignedIpv6Addresses": [ + "2001:db8:1234:1a00:3304:8879:34cf:4071", + "2001:db8:1234:1a00:9691:9503:25ad:1761" + ], + "NetworkInterfaceId": "eni-38664473" + } diff -Nru awscli-1.11.13/awscli/examples/ec2/associate-client-vpn-target-network.rst awscli-1.18.69/awscli/examples/ec2/associate-client-vpn-target-network.rst --- awscli-1.11.13/awscli/examples/ec2/associate-client-vpn-target-network.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/associate-client-vpn-target-network.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To associate a target network with a Client VPN endpoint** + +The following ``associate-client-vpn-target-network`` example associates a subnet with the specified Client VPN endpoint. :: + + aws ec2 associate-client-vpn-target-network \ + --subnet-id subnet-0123456789abcabca \ + --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde + +Output:: + + { + "AssociationId": "cvpn-assoc-12312312312312312", + "Status": { + "Code": "associating" + } + } + +For more information, see `Target Networks `__ in the *AWS Client VPN Administrator Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/associate-iam-instance-profile.rst awscli-1.18.69/awscli/examples/ec2/associate-iam-instance-profile.rst --- awscli-1.11.13/awscli/examples/ec2/associate-iam-instance-profile.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/associate-iam-instance-profile.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To associate an IAM instance profile with an instance** + +This example associates an IAM instance profile named ``admin-role`` with instance ``i-123456789abcde123``. + +Command:: + + aws ec2 associate-iam-instance-profile --instance-id i-123456789abcde123 --iam-instance-profile Name=admin-role + +Output:: + + { + "IamInstanceProfileAssociation": { + "InstanceId": "i-123456789abcde123", + "State": "associating", + "AssociationId": "iip-assoc-0e7736511a163c209", + "IamInstanceProfile": { + "Id": "AIPAJBLK7RKJKWDXVHIEC", + "Arn": "arn:aws:iam::123456789012:instance-profile/admin-role" + } + } + } diff -Nru awscli-1.11.13/awscli/examples/ec2/associate-subnet-cidr-block.rst awscli-1.18.69/awscli/examples/ec2/associate-subnet-cidr-block.rst --- awscli-1.11.13/awscli/examples/ec2/associate-subnet-cidr-block.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/associate-subnet-cidr-block.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,20 @@ +**To associate an IPv6 CIDR block with a subnet** + +This example associates an IPv6 CIDR block with the specified subnet. + +Command:: + + aws ec2 associate-subnet-cidr-block --subnet-id subnet-5f46ec3b --ipv6-cidr-block 2001:db8:1234:1a00::/64 + +Output:: + + { + "SubnetId": "subnet-5f46ec3b", + "Ipv6CidrBlockAssociation": { + "Ipv6CidrBlock": "2001:db8:1234:1a00::/64", + "AssociationId": "subnet-cidr-assoc-3aa54053", + "Ipv6CidrBlockState": { + "State": "associating" + } + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/associate-transit-gateway-multicast-domain.rst awscli-1.18.69/awscli/examples/ec2/associate-transit-gateway-multicast-domain.rst --- awscli-1.11.13/awscli/examples/ec2/associate-transit-gateway-multicast-domain.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/associate-transit-gateway-multicast-domain.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/associate-transit-gateway-route-table.rst awscli-1.18.69/awscli/examples/ec2/associate-transit-gateway-route-table.rst --- awscli-1.11.13/awscli/examples/ec2/associate-transit-gateway-route-table.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/associate-transit-gateway-route-table.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To associate a transit gateway route table with a transit gateway attachment** + +The following example associates the specified transit gateway route table with the specified VPC attachment. :: + + aws ec2 associate-transit-gateway-route-table \ + --transit-gateway-route-table-id tgw-rtb-002573ed1eEXAMPLE \ + --transit-gateway-attachment-id tgw-attach-0b5968d3b6EXAMPLE + +Output:: + + { + "Association": { + "TransitGatewayRouteTableId": "tgw-rtb-002573ed1eEXAMPLE", + "TransitGatewayAttachmentId": "tgw-attach-0b5968d3b6EXAMPLE", + "ResourceId": "vpc-0065acced4EXAMPLE", + "ResourceType": "vpc", + "State": "associating" + } + } + +For more information, see `Associate a Transit Gateway Route Table `__ in the *AWS Transit Gateways Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/associate-vpc-cidr-block.rst awscli-1.18.69/awscli/examples/ec2/associate-vpc-cidr-block.rst --- awscli-1.11.13/awscli/examples/ec2/associate-vpc-cidr-block.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/associate-vpc-cidr-block.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,42 @@ +**Example 1: To associate an Amazon-provided IPv6 CIDR block with a VPC** + +The following ``associate-vpc-cidr-block`` example associates an IPv6 CIDR block with the specified VPC.:: + + 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": { + "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-2EXAMPLE", + "CidrBlock": "10.2.0.0/16", + "CidrBlockState": { + "State": "associating" + } + }, + "VpcId": "vpc-1EXAMPLE" + } diff -Nru awscli-1.11.13/awscli/examples/ec2/authorize-client-vpn-ingress.rst awscli-1.18.69/awscli/examples/ec2/authorize-client-vpn-ingress.rst --- awscli-1.11.13/awscli/examples/ec2/authorize-client-vpn-ingress.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/authorize-client-vpn-ingress.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To add an authorization rule for a Client VPN endpoint** + +The following ``authorize-client-vpn-ingress`` example adds an ingress authorization rule that permits all clients to access the internet (``0.0.0.0/0``). :: + + aws ec2 authorize-client-vpn-ingress \ + --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde \ + --target-network-cidr 0.0.0.0/0 \ + --authorize-all-groups + +Output:: + + { + "Status": { + "Code": "authorizing" + } + } + +For more information, see `Authorization Rules `__ in the *AWS Client VPN Administrator Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/authorize-security-group-egress.rst awscli-1.18.69/awscli/examples/ec2/authorize-security-group-egress.rst --- awscli-1.11.13/awscli/examples/ec2/authorize-security-group-egress.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/authorize-security-group-egress.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,14 +2,22 @@ This example command adds a rule that grants access to the specified address ranges on TCP port 80. -Command:: +Command (Linux):: - aws ec2 authorize-security-group-egress --group-id sg-1a2b3c4d --ip-permissions '[{"IpProtocol": "tcp", "FromPort": 80, "ToPort": 80, "IpRanges": [{"CidrIp": "10.0.0.0/16"}]}]' + aws ec2 authorize-security-group-egress --group-id sg-1a2b3c4d --ip-permissions IpProtocol=tcp,FromPort=80,ToPort=80,IpRanges='[{CidrIp=10.0.0.0/16}]' + +Command (Windows):: + + aws ec2 authorize-security-group-egress --group-id sg-1a2b3c4d --ip-permissions IpProtocol=tcp,FromPort=80,ToPort=80,IpRanges=[{CidrIp=10.0.0.0/16}] **To add a rule that allows outbound traffic to a specific security group** This example command adds a rule that grants access to the specified security group on TCP port 80. -Command:: +Command (Linux):: + + aws ec2 authorize-security-group-egress --group-id sg-1a2b3c4d --ip-permissions IpProtocol=tcp,FromPort=80,ToPort=80,UserIdGroupPairs='[{GroupId=sg-4b51a32f}]' + +Command (Windows):: - aws ec2 authorize-security-group-egress --group-id sg-1a2b3c4d --ip-permissions '[{"IpProtocol": "tcp", "FromPort": 80, "ToPort": 80, "UserIdGroupPairs": [{"GroupId": "sg-4b51a32f"}]}]' + aws ec2 authorize-security-group-egress --group-id sg-1a2b3c4d --ip-permissions IpProtocol=tcp,FromPort=80,ToPort=80,UserIdGroupPairs=[{GroupId=sg-4b51a32f}] diff -Nru awscli-1.11.13/awscli/examples/ec2/authorize-security-group-ingress.rst awscli-1.18.69/awscli/examples/ec2/authorize-security-group-ingress.rst --- awscli-1.11.13/awscli/examples/ec2/authorize-security-group-ingress.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/authorize-security-group-ingress.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,52 +1,139 @@ **[EC2-Classic] To add a rule that allows inbound SSH traffic** -This example enables inbound traffic on TCP port 22 (SSH). If the command succeeds, no output is returned. +The following example enables inbound traffic on TCP port 22 (SSH). If the command succeeds, no output is returned. :: -Command:: + aws ec2 authorize-security-group-ingress \\ + --group-name MySecurityGroup \ + --protocol tcp \ + --port 22 \ + --cidr 203.0.113.0/24 - aws ec2 authorize-security-group-ingress --group-name MySecurityGroup --protocol tcp --port 22 --cidr 203.0.113.0/24 +This command produces no output. **[EC2-Classic] To add a rule that allows inbound HTTP traffic from a security group in another account** -This example enables inbound traffic on TCP port 80 from a source security group (otheraccountgroup) in a different AWS account (123456789012). If the command succeeds, no output is returned. +The following example enables inbound traffic on TCP port 80 from a source security group (``otheraccountgroup``) in a different AWS account (123456789012). Incoming traffic is allowed based on the private IP addresses of instances that are associated with the source security group (not the public IP or Elastic IP addresses). :: -Command:: + aws ec2 authorize-security-group-ingress \ + --group-name MySecurityGroup \ + --protocol tcp \ + --port 80 \ + --source-group otheraccountgroup \ + --group-owner 123456789012 - aws ec2 authorize-security-group-ingress --group-name MySecurityGroup --protocol tcp --port 80 --source-group otheraccountgroup --group-owner 123456789012 +This command produces no output. **[EC2-Classic] To add a rule that allows inbound HTTPS traffic from an ELB** -This example enables inbound traffic on TCP port 443 from an ELB. If the command succeeds, no output is returned. +The following example enables inbound traffic on TCP port 443 from an ELB. :: -Command:: - - aws ec2 authorize-security-group-ingress --group-name MySecurityGroup --protocol tcp --port 443 --source-group amazon-elb-sg --group-owner amazon-elb + aws ec2 authorize-security-group-ingress \ + --group-name MySecurityGroup \ + --protocol tcp \ + --port 443 \ + --source-group amazon-elb-sg \ + --group-owner amazon-elb **[EC2-VPC] To add a rule that allows inbound SSH traffic** -This example enables inbound traffic on TCP port 22 (SSH). Note that you can't reference a security group for EC2-VPC by name. If the command succeeds, no output is returned. +The following example enables inbound traffic on TCP port 22 (SSH). Note that you can't reference a security group for EC2-VPC by name. :: -Command:: + aws ec2 authorize-security-group-ingress \ + --group-id sg-1234567890abcdef0 \ + --protocol tcp \ + --port 22 \ + --cidr 203.0.113.0/24 - aws ec2 authorize-security-group-ingress --group-id sg-903004f8 --protocol tcp --port 22 --cidr 203.0.113.0/24 +This command produces no output. **[EC2-VPC] To add a rule that allows inbound HTTP traffic from another security group** -This example enables inbound access on TCP port 80 from the source security group sg-1a2b3c4d. Note that for EC2-VPC, the source group must be in the same VPC or in a peer VPC (requires a VPC peering connection). If the command succeeds, no output is returned. +The following example enables inbound access on TCP port 80 from the source security group ``sg-1a2b3c4d``. Note that for EC2-VPC, the source group must be in the same VPC or in a peer VPC (requires a VPC peering connection). Incoming traffic is allowed based on the private IP addresses of instances that are associated with the source security group (not the public IP or Elastic IP addresses). :: + + aws ec2 authorize-security-group-ingress \ + --group-id sg-1234567890abcdef0 \ + --protocol tcp \ + --port 80 \ + --source-group sg-1a2b3c4d + +This command produces no output. + +**[EC2-VPC] To add one rule for RDP and another rule for ping/ICMP** + +The following example uses the ``ip-permissions`` parameter to add two rules, one that enables inbound access on TCP port 3389 (RDP) and the other that enables ping/ICMP. + +(Windows):: + + aws ec2 authorize-security-group-ingress ^ + --group-id sg-1234567890abcdef0 ^ + --ip-permissions IpProtocol=tcp,FromPort=3389,ToPort=3389,IpRanges=[{CidrIp=172.31.0.0/16}] IpProtocol=icmp,FromPort=-1,ToPort=-1,IpRanges=[{CidrIp=172.31.0.0/16}] + +**[EC2-VPC] To add a rule for ICMP traffic** + +The following example uses the ``ip-permissions`` parameter to add an inbound rule that allows the ICMP message ``Destination Unreachable: Fragmentation Needed and Don't Fragment was Set`` (Type 3, Code 4) from anywhere. + +(Linux):: + + aws ec2 authorize-security-group-ingress \ + --group-id sg-1234567890abcdef0 \ + --ip-permissions IpProtocol=icmp,FromPort=3,ToPort=4,IpRanges='[{CidrIp=0.0.0.0/0}]' + +(Windows):: + + aws ec2 authorize-security-group-ingress ^ + --group-id sg-1234567890abcdef0 ^ + --ip-permissions IpProtocol=icmp,FromPort=3,ToPort=4,IpRanges=[{CidrIp=0.0.0.0/0}] + +This command produces no output. + +**[EC2-VPC] To add a rule for IPv6 traffic** + +The following example grants SSH access (port 22) from the IPv6 range ``2001:db8:1234:1a00::/64``. + +(Linux):: + + aws ec2 authorize-security-group-ingress \ + --group-id sg-1234567890abcdef0 \ + --ip-permissions IpProtocol=tcp,FromPort=22,ToPort=22,Ipv6Ranges='[{CidrIpv6=2001:db8:1234:1a00::/64}]' + +(Windows):: + + aws ec2 authorize-security-group-ingress ^ + --group-id sg-1234567890abcdef0 ^ + --ip-permissions IpProtocol=tcp,FromPort=22,ToPort=22,Ipv6Ranges=[{CidrIpv6=2001:db8:1234:1a00::/64}] + +**[EC2-VPC] To add a rule for ICMPv6 traffic** + +The following example uses the ``ip-permissions`` parameter to add an inbound rule that allows ICMPv6 traffic from anywhere. + +(Linux):: + + aws ec2 authorize-security-group-ingress \ + --group-id sg-1234567890abcdef0 \ + --ip-permissions IpProtocol=icmpv6,Ipv6Ranges='[{CidrIpv6=::/0}]' + +(Windows):: -Command:: + aws ec2 authorize-security-group-ingress ^ + --group-id sg-1234567890abcdef0 ^ + --ip-permissions IpProtocol=icmpv6,Ipv6Ranges=[{CidrIpv6=::/0}] - aws ec2 authorize-security-group-ingress --group-id sg-111aaa22 --protocol tcp --port 80 --source-group sg-1a2b3c4d +**Add a rule with a description** -**[EC2-VPC] To add a custom ICMP rule** +The following example uses the ``ip-permissions`` parameter to add an inbound rule that allows RDP traffic from a specific IPv4 address range. The rule includes a description to help you identify it later. -This example uses the ``ip-permissions`` parameter to add an inbound rule that allows the ICMP message ``Destination Unreachable: Fragmentation Needed and Don't Fragment was Set`` (Type 3, Code 4) from anywhere. If the command succeeds, no output is returned. For more information about quoting JSON-formatted parameters, see `Quoting Strings`_. +(Linux):: -Command:: + aws ec2 authorize-security-group-ingress \ + --group-id sg-1234567890abcdef0 \ + --ip-permissions IpProtocol=tcp,FromPort=3389,ToPort=3389,IpRanges='[{CidrIp=203.0.113.0/24,Description="RDP access from NY office"}]' + +(Windows):: - aws ec2 authorize-security-group-ingress --group-id sg-123abc12 --ip-permissions '[{"IpProtocol": "icmp", "FromPort": 3, "ToPort": 4, "IpRanges": [{"CidrIp": "0.0.0.0/0"}]}]' + aws ec2 authorize-security-group-ingress ^ + --group-id sg-1234567890abcdef0 ^ + --ip-permissions IpProtocol=tcp,FromPort=3389,ToPort=3389,IpRanges=[{CidrIp=203.0.113.0/24,Description="RDP access from NY office"}] For more information, see `Using Security Groups`_ in the *AWS Command Line Interface User Guide*. -.. _`Using Security Groups`: http://docs.aws.amazon.com/cli/latest/userguide/cli-ec2-sg.html -.. _`Quoting Strings`: http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#quoting-strings +.. _`Using Security Groups`: http://docs.aws.amazon.com/cli/latest/userguide/cli-ec2-sg.html \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/cancel-capacity-reservation.rst awscli-1.18.69/awscli/examples/ec2/cancel-capacity-reservation.rst --- awscli-1.11.13/awscli/examples/ec2/cancel-capacity-reservation.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/cancel-capacity-reservation.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,14 @@ +**To cancel a capacity reservation** + +The following ``cancel-capacity-reservation`` example cancels the specified capacity reservation. :: + + aws ec2 cancel-capacity-reservation \ + --capacity-reservation-id cr-1234abcd56EXAMPLE + +Output:: + + { + "Return": true + } + +For more information, see `Canceling a Capacity Reservation `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. diff -Nru awscli-1.11.13/awscli/examples/ec2/cancel-import-task.rst awscli-1.18.69/awscli/examples/ec2/cancel-import-task.rst --- awscli-1.11.13/awscli/examples/ec2/cancel-import-task.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/cancel-import-task.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,14 @@ +**To cancel an import task** + +The following ``cancel-import-task`` example cancels the specified import image task. :: + + aws ec2 cancel-import-task \ + --import-task-id import-ami-1234567890abcdef0 + +Output:: + + { + "ImportTaskId": "import-ami-1234567890abcdef0", + "PreviousState": "active", + "State": "deleting" + } diff -Nru awscli-1.11.13/awscli/examples/ec2/cancel-reserved-instances-listing.rst awscli-1.18.69/awscli/examples/ec2/cancel-reserved-instances-listing.rst --- awscli-1.11.13/awscli/examples/ec2/cancel-reserved-instances-listing.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/cancel-reserved-instances-listing.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,6 @@ +**To cancel a Reserved Instance listing** + +The following ``cancel-reserved-instances-listing`` example cancels the specified Reserved Instance listing. :: + + aws ec2 cancel-reserved-instances-listing \ + --reserved-instances-listing-id 5ec28771-05ff-4b9b-aa31-9e57dexample diff -Nru awscli-1.11.13/awscli/examples/ec2/copy-fpga-image.rst awscli-1.18.69/awscli/examples/ec2/copy-fpga-image.rst --- awscli-1.11.13/awscli/examples/ec2/copy-fpga-image.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/copy-fpga-image.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,13 @@ +**To copy an Amazon FPGA image** + +This example copies the specified AFI from the ``us-east-1`` region to the current region (``eu-west-1``). + +Command:: + + aws ec2 copy-fpga-image --name copy-afi --source-fpga-image-id afi-0d123e123bfc85abc --source-region us-east-1 --region eu-west-1 + +Output:: + + { + "FpgaImageId": "afi-06b12350a123fbabc" + } diff -Nru awscli-1.11.13/awscli/examples/ec2/copy-snapshot.rst awscli-1.18.69/awscli/examples/ec2/copy-snapshot.rst --- awscli-1.11.13/awscli/examples/ec2/copy-snapshot.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/copy-snapshot.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,13 +1,25 @@ -**To copy a snapshot** +**Example 1: To copy a snapshot** -This example command copies a snapshot with the snapshot ID of ``snap-066877671789bd71b`` from the ``us-west-2`` region to the ``us-east-1`` region and adds a short description to identify the snapshot. +The following ``copy-snapshot`` example command copies the specified snapshot from the ``us-west-2`` Region to the ``us-east-1`` Region and adds a short description. :: -Command:: - - aws --region us-east-1 ec2 copy-snapshot --source-region us-west-2 --source-snapshot-id snap-066877671789bd71b --description "This is my copied snapshot." + aws ec2 copy-snapshot \ + --region us-east-1 \ + --source-region us-west-2 \ + --source-snapshot-id snap-066877671789bd71b \ + --description "This is my copied snapshot." Output:: - { - "SnapshotId": "snap-066877671789bd71b" - } \ No newline at end of file + { + "SnapshotId": "snap-066877671789bd71b" + } + +**Example 2: To copy an unencrypted snapshot and encrypt the new snapshot** + +The following ``copy-snapshot`` command copies the specified unencrypted snapshot from the ``us-west-2`` Region to the current Region and encrypts the new snapshot using the specified AWS KMS customer master key (CMK). :: + + aws ec2 copy-snapshot \ + --source-region us-west-2 \ + --source-snapshot-id snap-066877671789bd71b \ + --encrypted \ + --kmd-key-id alias/my-cmk diff -Nru awscli-1.11.13/awscli/examples/ec2/create-capacity-reservation.rst awscli-1.18.69/awscli/examples/ec2/create-capacity-reservation.rst --- awscli-1.11.13/awscli/examples/ec2/create-capacity-reservation.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-capacity-reservation.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,95 @@ +**Example 1: To create a Capacity Reservation** + +The following ``create-capacity-reservation`` example creates a capacity reservation in the ``eu-west-1a`` Availability Zone, into which you can launch three ``t2.medium`` instances running a Linux/Unix operating system. By default, the capacity reservation is created with open instance matching criteria and no support for ephemeral storage, and it remains active until you manually cancel it. :: + + aws ec2 create-capacity-reservation \ + --availability-zone eu-west-1a \ + --instance-type t2.medium \ + --instance-platform Linux/UNIX \ + --instance-count 3 + +Output:: + + { + "CapacityReservation": { + "CapacityReservationId": "cr-1234abcd56EXAMPLE ", + "EndDateType": "unlimited", + "AvailabilityZone": "eu-west-1a", + "InstanceMatchCriteria": "open", + "EphemeralStorage": false, + "CreateDate": "2019-08-16T09:27:35.000Z", + "AvailableInstanceCount": 3, + "InstancePlatform": "Linux/UNIX", + "TotalInstanceCount": 3, + "State": "active", + "Tenancy": "default", + "EbsOptimized": false, + "InstanceType": "t2.medium" + } + } + +**Example 2: To create a Capacity Reservation that automatically ends at a specified date/time** + +The following ``create-capacity-reservation`` example creates a capacity reservation in the ``eu-west-1a`` Availability Zone, into which you can launch three ``m5.large`` instances running a Linux/Unix operating system. This capacity reservation automatically ends on 08/31/2019 at 23:59:59. :: + + aws ec2 create-capacity-reservation \ + --availability-zone eu-west-1a \ + --instance-type m5.large \ + --instance-platform Linux/UNIX \ + --instance-count 3 \ + --end-date-type limited \ + --end-date 2019-08-31T23:59:59Z + +Output:: + + { + "CapacityReservation": { + "CapacityReservationId": "cr-1234abcd56EXAMPLE ", + "EndDateType": "limited", + "AvailabilityZone": "eu-west-1a", + "EndDate": "2019-08-31T23:59:59.000Z", + "InstanceMatchCriteria": "open", + "EphemeralStorage": false, + "CreateDate": "2019-08-16T10:15:53.000Z", + "AvailableInstanceCount": 3, + "InstancePlatform": "Linux/UNIX", + "TotalInstanceCount": 3, + "State": "active", + "Tenancy": "default", + "EbsOptimized": false, + "InstanceType": "m5.large" + } + } + +**Example 3: To create a Capacity Reservation that accepts only targeted instance launches** + +The following ``create-capacity-reservation`` example creates a capacity reservation that accepts only targeted instance launches. :: + + aws ec2 create-capacity-reservation \ + --availability-zone eu-west-1a \ + --instance-type m5.large \ + --instance-platform Linux/UNIX \ + --instance-count 3 \ + --instance-match-criteria targeted + +Output:: + + { + "CapacityReservation": { + "CapacityReservationId": "cr-1234abcd56EXAMPLE ", + "EndDateType": "unlimited", + "AvailabilityZone": "eu-west-1a", + "InstanceMatchCriteria": "targeted", + "EphemeralStorage": false, + "CreateDate": "2019-08-16T10:21:57.000Z", + "AvailableInstanceCount": 3, + "InstancePlatform": "Linux/UNIX", + "TotalInstanceCount": 3, + "State": "active", + "Tenancy": "default", + "EbsOptimized": false, + "InstanceType": "m5.large" + } + } + +For more information, see `Creating a Capacity Reservation `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. diff -Nru awscli-1.11.13/awscli/examples/ec2/create-client-vpn-endpoint.rst awscli-1.18.69/awscli/examples/ec2/create-client-vpn-endpoint.rst --- awscli-1.11.13/awscli/examples/ec2/create-client-vpn-endpoint.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-client-vpn-endpoint.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To create a Client VPN endpoint** + +The following ``create-client-vpn-endpoint`` example creates a Client VPN endpoint that uses mutual authentication and specifies a value for the client CIDR block. :: + + aws ec2 create-client-vpn-endpoint \ + --client-cidr-block "172.31.0.0/16" \ + --server-certificate-arn arn:aws:acm:ap-south-1:123456789012:certificate/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ + --authentication-options Type=certificate-authentication,MutualAuthentication={ClientRootCertificateChainArn=arn:aws:acm:ap-south-1:123456789012:certificate/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE} \ + --connection-log-options Enabled=false + +Output:: + + { + "ClientVpnEndpointId": "cvpn-endpoint-123456789123abcde", + "Status": { + "Code": "pending-associate" + }, + "DnsName": "cvpn-endpoint-123456789123abcde.prod.clientvpn.ap-south-1.amazonaws.com" + } + +For more information, see `Client VPN Endpoints `__ in the *AWS Client VPN Administrator Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/create-client-vpn-route.rst awscli-1.18.69/awscli/examples/ec2/create-client-vpn-route.rst --- awscli-1.11.13/awscli/examples/ec2/create-client-vpn-route.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-client-vpn-route.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To create a route for a Client VPN endpoint** + +The following ``create-client-vpn-route`` example adds a route to the internet (``0.0.0.0/0``) for the specified subnet of the Client VPN endpoint. :: + + aws ec2 create-client-vpn-route \ + --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde \ + --destination-cidr-block 0.0.0.0/0 \ + --target-vpc-subnet-id subnet-0123456789abcabca + +Output:: + + { + "Status": { + "Code": "creating" + } + } + +For more information, see `Routes `__ in the *AWS Client VPN Administrator Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/create-default-subnet.rst awscli-1.18.69/awscli/examples/ec2/create-default-subnet.rst --- awscli-1.11.13/awscli/examples/ec2/create-default-subnet.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-default-subnet.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,23 @@ +**To create a default subnet** + +This example creates a default subnet in Availability Zone ``us-east-2a``. + +Command:: + + aws ec2 create-default-subnet --availability-zone us-east-2a + + { + "Subnet": { + "AvailabilityZone": "us-east-2a", + "Tags": [], + "AvailableIpAddressCount": 4091, + "DefaultForAz": true, + "Ipv6CidrBlockAssociationSet": [], + "VpcId": "vpc-1a2b3c4d", + "State": "available", + "MapPublicIpOnLaunch": true, + "SubnetId": "subnet-1122aabb", + "CidrBlock": "172.31.32.0/20", + "AssignIpv6AddressOnCreation": false + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/create-default-vpc.rst awscli-1.18.69/awscli/examples/ec2/create-default-vpc.rst --- awscli-1.11.13/awscli/examples/ec2/create-default-vpc.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-default-vpc.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,22 @@ +**To create a default VPC** + +This example creates a default VPC. + +Command:: + + aws ec2 create-default-vpc + +Output:: + + { + "Vpc": { + "VpcId": "vpc-8eaae5ea", + "InstanceTenancy": "default", + "Tags": [], + "Ipv6CidrBlockAssociationSet": [], + "State": "pending", + "DhcpOptionsId": "dopt-af0c32c6", + "CidrBlock": "172.31.0.0/16", + "IsDefault": true + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/create-dhcp-options.rst awscli-1.18.69/awscli/examples/ec2/create-dhcp-options.rst --- awscli-1.11.13/awscli/examples/ec2/create-dhcp-options.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-dhcp-options.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,24 +1,46 @@ -**To create a DHCP options set** +**To create a set of DHCP options** -This example creates a DHCP options set. +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. :: -Command:: - - aws ec2 create-dhcp-options --dhcp-configuration "Key=domain-name-servers,Values=10.2.5.1,10.2.5.2" + 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" Output:: - { - "DhcpOptions": { - "DhcpConfigurations": [ - { - "Values": [ - "10.2.5.2", - "10.2.5.1" - ], - "Key": "domain-name-servers" - } - ], - "DhcpOptionsId": "dopt-d9070ebb" - } - } \ No newline at end of file + { + "DhcpOptions": { + "DhcpConfigurations": [ + { + "Key": "domain-name", + "Values": [ + { + "Value": "example.com" + } + ] + }, + { + "Key": "domain-name-servers", + "Values": [ + { + "Value": "10.2.5.1" + }, + { + "Value": "10.2.5.2" + } + ] + }, + { + "Key": "netbios-node-type", + "Values": [ + { + "Value": "2" + } + ] + } + ], + "DhcpOptionsId": "dopt-06d52773eff4c55f3" + } + } diff -Nru awscli-1.11.13/awscli/examples/ec2/create-egress-only-internet-gateway.rst awscli-1.18.69/awscli/examples/ec2/create-egress-only-internet-gateway.rst --- awscli-1.11.13/awscli/examples/ec2/create-egress-only-internet-gateway.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-egress-only-internet-gateway.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To create an egress-only Internet gateway** + +This example creates an egress-only Internet gateway for the specified VPC. + +Command:: + + aws ec2 create-egress-only-internet-gateway --vpc-id vpc-0c62a468 + +Output:: + + { + "EgressOnlyInternetGateway": { + "EgressOnlyInternetGatewayId": "eigw-015e0e244e24dfe8a", + "Attachments": [ + { + "State": "attached", + "VpcId": "vpc-0c62a468" + } + ] + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/create-fleet.rst awscli-1.18.69/awscli/examples/ec2/create-fleet.rst --- awscli-1.11.13/awscli/examples/ec2/create-fleet.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-fleet.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,156 @@ +**To create an EC2 Fleet that launches Spot Instances as the default purchasing model** + +This example creates an EC2 Fleet using the minimum parameters required to launch a fleet: a launch template, target capacity, and default purchasing model. The launch template is identified by its launch template ID and version number. The target capacity for the fleet is 2 instances, and the default purchasing model is ``spot``, which results in the fleet launching 2 Spot Instances. + +When you create an EC2 Fleet, use a JSON file to specify information about the instances to launch. + +Command:: + + aws ec2 create-fleet --cli-input-json file://file_name.json + +Output:: + + { + "FleetId": "fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE" + } + +Where file_name.json contains the following:: + + { + "LaunchTemplateConfigs": [ + { + "LaunchTemplateSpecification": { + "LaunchTemplateId": "lt-0e8c754449b27161c", + "Version": "1" + } + + } + ], + "TargetCapacitySpecification": { + "TotalTargetCapacity": 2, + "DefaultTargetCapacityType": "spot" + } + } + + +**To create an EC2 Fleet that launches On-Demand Instances as the default purchasing model** + +This example creates an EC2 Fleet using the minimum parameters required to launch a fleet: a launch template, target capacity, and default purchasing model. The launch template is identified by its launch template ID and version number. The target capacity for the fleet is 2 instances, and the default purchasing model is ``on-demand``, which results in the fleet launching 2 On-Demand Instances. + +When you create an EC2 Fleet, use a JSON file to specify information about the instances to launch. + +Command:: + + aws ec2 create-fleet --cli-input-json file://file_name.json + +Output:: + + { + "FleetId": "fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE" + } + +Where file_name.json contains the following:: + + { + "LaunchTemplateConfigs": [ + { + "LaunchTemplateSpecification": { + "LaunchTemplateId": "lt-0e8c754449b27161c", + "Version": "1" + } + + } + ], + "TargetCapacitySpecification": { + "TotalTargetCapacity": 2, + "DefaultTargetCapacityType": "on-demand" + } + } + + +**To create an EC2 Fleet that launches On-Demand Instances as the primary capacity** + +This example creates an EC2 Fleet that specifies the total target capacity of 2 instances for the fleet, and a target capacity of 1 On-Demand Instance. The default purchasing model is ``spot``. The fleet launches 1 On-Demand Instance as specified, but needs to launch one more instance to fulfil the total target capacity. The purchasing model for the difference is calculated as ``TotalTargetCapacity`` - ``OnDemandTargetCapacity`` = ``DefaultTargetCapacityType``, which results in the fleet launching 1 Spot Instance. + +When you create an EC2 Fleet, use a JSON file to specify information about the instances to launch. + +Command:: + + aws ec2 create-fleet --cli-input-json file://file_name.json + +Output:: + + { + "FleetId": "fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE" + } + +Where file_name.json contains the following:: + + { + "LaunchTemplateConfigs": [ + { + "LaunchTemplateSpecification": { + "LaunchTemplateId": "lt-0e8c754449b27161c", + "Version": "1" + } + + } + ], + "TargetCapacitySpecification": { + "TotalTargetCapacity": 2, + "OnDemandTargetCapacity":1, + "DefaultTargetCapacityType": "spot" + } + } + + +**To create an EC2 Fleet that launches Spot Instances using the lowest-price allocation strategy** + +If the allocation strategy for Spot Instances is not specified, the default allocation strategy, which is ``lowest-price``, is used. This example creates an EC2 Fleet using the ``lowest-price`` allocation strategy. The three launch specifications, which override the launch template, have different instance types but the same weighted capacity and subnet. The total target capacity is 2 instances and the default purchasing model is ``spot``. The EC2 Fleet launches 2 Spot Instances using the instance type of the launch specification with the lowest price. + +When you create an EC2 Fleet, use a JSON file to specify information about the instances to launch. + +Command:: + + aws ec2 create-fleet --cli-input-json file://file_name.json + +Output:: + + { + "FleetId": "fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE" + } + +Where file_name.json contains the following:: + + { + "LaunchTemplateConfigs": [ + { + "LaunchTemplateSpecification": { + "LaunchTemplateId": "lt-0e8c754449b27161c", + "Version": "1" + } + "Overrides": [ + { + "InstanceType": "c4.large", + "WeightedCapacity": 1, + "SubnetId": "subnet-a4f6c5d3" + }, + { + "InstanceType": "c3.large", + "WeightedCapacity": 1, + "SubnetId": "subnet-a4f6c5d3" + }, + { + "InstanceType": "c5.large", + "WeightedCapacity": 1, + "SubnetId": "subnet-a4f6c5d3" + } + ] + + } + ], + "TargetCapacitySpecification": { + "TotalTargetCapacity": 2, + "DefaultTargetCapacityType": "spot" + } + } diff -Nru awscli-1.11.13/awscli/examples/ec2/create-flow-logs.rst awscli-1.18.69/awscli/examples/ec2/create-flow-logs.rst --- awscli-1.11.13/awscli/examples/ec2/create-flow-logs.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-flow-logs.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,17 +1,46 @@ -**To create a flow log** +**Example 1: To create a flow log** -This example creates a flow log that captures all rejected traffic for network interface ``eni-aa22bb33``. The flow logs are delivered to a log group in CloudWatch Logs called ``my-flow-logs`` in account 123456789101, using the IAM role ``publishFlowLogs``. +The following ``create-flow-logs`` example creates a flow log that captures all rejected traffic for the specified network interface. The flow logs are delivered to a log group in CloudWatch Logs using the permissions in the specified IAM role. :: -Command:: - - aws ec2 create-flow-logs --resource-type NetworkInterface --resource-ids eni-aa22bb33 --traffic-type REJECT --log-group-name my-flow-logs --deliver-logs-permission-arn arn:aws:iam::123456789101:role/publishFlowLogs + aws ec2 create-flow-logs \ + --resource-type NetworkInterface \ + --resource-ids eni-11223344556677889 \ + --traffic-type REJECT \ + --log-group-name my-flow-logs \ + --deliver-logs-permission-arn arn:aws:iam::123456789101:role/publishFlowLogs Output:: - { - "Unsuccessful": [], - "FlowLogIds": [ - "fl-1a2b3c4d" - ], - "ClientToken": "lO+mDZGO+HCFEXAMPLEfWNO00bInKkBcLfrC" - } \ No newline at end of file + { + "ClientToken": "so0eNA2uSHUNlHI0S2cJ305GuIX1CezaRdGtexample", + "FlowLogIds": [ + "fl-12345678901234567" + ], + "Unsuccessful": [] + } + +**Example 2: To create a flow log with a custom format** + +The following ``create-flow-logs`` example creates a flow log that captures all traffic for the specified VPC and delivers the flow logs to an Amazon S3 bucket. The ``--log-format`` parameter specifies a custom format for the flow log records. :: + + aws ec2 create-flow-logs \ + --resource-type VPC \ + --resource-ids vpc-00112233344556677 \ + --traffic-type ALL \ + --log-destination-type s3 \ + --log-destination arn:aws:s3:::flow-log-bucket/my-custom-flow-logs/ \ + --log-format '${version} ${vpc-id} ${subnet-id} ${instance-id} ${srcaddr} ${dstaddr} ${srcport} ${dstport} ${protocol} ${tcp-flags} ${type} ${pkt-srcaddr} ${pkt-dstaddr}' + +**Example 3: To create a flow log with a one-minute maximum aggregation interval** + +The following ``create-flow-logs`` example creates a flow log that captures all traffic for the specified VPC and delivers the flow logs to an Amazon S3 bucket. The ``--max-aggregation-interval`` parameter specifies a maximum aggregation interval of 60 seconds (1 minute). :: + + aws ec2 create-flow-logs \ + --resource-type VPC \ + --resource-ids vpc-00112233344556677 \ + --traffic-type ALL \ + --log-destination-type s3 \ + --log-destination arn:aws:s3:::flow-log-bucket/my-custom-flow-logs/ \ + --max-aggregation-interval 60 + +For more information, see `VPC Flow Logs `__ in the *Amazon VPC User Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/create-fpga-image.rst awscli-1.18.69/awscli/examples/ec2/create-fpga-image.rst --- awscli-1.11.13/awscli/examples/ec2/create-fpga-image.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-fpga-image.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,14 @@ +**To create an Amazon FPGA image** + +This example creates an AFI from the specified tarball in the specified bucket. + +Command:: + + aws ec2 create-fpga-image --name my-afi --description test-afi --input-storage-location Bucket=my-fpga-bucket,Key=dcp/17_12_22-103226.Developer_CL.tar --logs-storage-location Bucket=my-fpga-bucket,Key=logs + +Output:: + + { + "FpgaImageId": "afi-0d123e123bfc85abc", + "FpgaImageGlobalId": "agfi-123cb27b5e84a0abc" + } diff -Nru awscli-1.11.13/awscli/examples/ec2/create-launch-template.rst awscli-1.18.69/awscli/examples/ec2/create-launch-template.rst --- awscli-1.11.13/awscli/examples/ec2/create-launch-template.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-launch-template.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,108 @@ +**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.11.13/awscli/examples/ec2/create-launch-template-version.rst awscli-1.18.69/awscli/examples/ec2/create-launch-template-version.rst --- awscli-1.11.13/awscli/examples/ec2/create-launch-template-version.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-launch-template-version.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,37 @@ +**To create a launch template version** + +This example creates a new launch template version based on version 1 of the launch template and specifies a different AMI ID. + +Command:: + + aws ec2 create-launch-template-version --launch-template-id lt-0abcd290751193123 --version-description WebVersion2 --source-version 1 --launch-template-data '{"ImageId":"ami-c998b6b2"}' + +Output:: + + { + "LaunchTemplateVersion": { + "VersionDescription": "WebVersion2", + "LaunchTemplateId": "lt-0abcd290751193123", + "LaunchTemplateName": "WebServers", + "VersionNumber": 2, + "CreatedBy": "arn:aws:iam::123456789012:root", + "LaunchTemplateData": { + "ImageId": "ami-c998b6b2", + "InstanceType": "t2.micro", + "NetworkInterfaces": [ + { + "Ipv6Addresses": [ + { + "Ipv6Address": "2001:db8:1234:1a00::123" + } + ], + "DeviceIndex": 0, + "SubnetId": "subnet-7b16de0c", + "AssociatePublicIpAddress": true + } + ] + }, + "DefaultVersion": false, + "CreateTime": "2017-12-01T13:35:46.000Z" + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/create-local-gateway-route.rst awscli-1.18.69/awscli/examples/ec2/create-local-gateway-route.rst --- awscli-1.11.13/awscli/examples/ec2/create-local-gateway-route.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-local-gateway-route.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/create-local-gateway-route-table-vpc-association.rst awscli-1.18.69/awscli/examples/ec2/create-local-gateway-route-table-vpc-association.rst --- awscli-1.11.13/awscli/examples/ec2/create-local-gateway-route-table-vpc-association.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-local-gateway-route-table-vpc-association.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/create-network-acl-entry.rst awscli-1.18.69/awscli/examples/ec2/create-network-acl-entry.rst --- awscli-1.11.13/awscli/examples/ec2/create-network-acl-entry.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-network-acl-entry.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,7 +1,14 @@ **To create a network ACL entry** -This example creates an entry for the specified network ACL. The rule allows ingress traffic from anywhere (0.0.0.0/0) on UDP port 53 (DNS) into any associated subnet. If the command succeeds, no output is returned. +This example creates an entry for the specified network ACL. The rule allows ingress traffic from any IPv4 address (0.0.0.0/0) on UDP port 53 (DNS) into any associated subnet. If the command succeeds, no output is returned. Command:: aws ec2 create-network-acl-entry --network-acl-id acl-5fb85d36 --ingress --rule-number 100 --protocol udp --port-range From=53,To=53 --cidr-block 0.0.0.0/0 --rule-action allow + + +This example creates a rule for the specified network ACL that allows ingress traffic from any IPv6 address (::/0) on TCP port 80 (HTTP). + +Command:: + + aws ec2 create-network-acl-entry --network-acl-id acl-5fb85d36 --ingress --rule-number 120 --protocol tcp --port-range From=80,To=80 --ipv6-cidr-block ::/0 --rule-action allow \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/create-network-interface-permission.rst awscli-1.18.69/awscli/examples/ec2/create-network-interface-permission.rst --- awscli-1.11.13/awscli/examples/ec2/create-network-interface-permission.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-network-interface-permission.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To create a network interface permission** + +This example grants permission to account ``123456789012`` to attach network interface ``eni-1a2b3c4d`` to an instance. + +Command:: + + aws ec2 create-network-interface-permission --network-interface-id eni-1a2b3c4d --aws-account-id 123456789012 --permission INSTANCE-ATTACH + +Output:: + + { + "InterfacePermission": { + "PermissionState": { + "State": "GRANTED" + }, + "NetworkInterfacePermissionId": "eni-perm-06fd19020ede149ea", + "NetworkInterfaceId": "eni-1a2b3c4d", + "Permission": "INSTANCE-ATTACH", + "AwsAccountId": "123456789012" + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/create-network-interface.rst awscli-1.18.69/awscli/examples/ec2/create-network-interface.rst --- awscli-1.11.13/awscli/examples/ec2/create-network-interface.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-network-interface.rst 2020-05-28 19:25:48.000000000 +0000 @@ -24,6 +24,7 @@ ], "RequesterManaged": false, "AvailabilityZone": "us-east-1d", + "Ipv6Addresses": [], "Groups": [ { "GroupName": "default", diff -Nru awscli-1.11.13/awscli/examples/ec2/create-placement-group.rst awscli-1.18.69/awscli/examples/ec2/create-placement-group.rst --- awscli-1.11.13/awscli/examples/ec2/create-placement-group.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-placement-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -5,3 +5,11 @@ Command:: aws ec2 create-placement-group --group-name my-cluster --strategy cluster + +**To create a partition placement group** + +This example command creates a partition placement group named ``HDFS-Group-A`` with five partitions. + +Command:: + + aws ec2 create-placement-group --group-name HDFS-Group-A --strategy partition --partition-count 5 diff -Nru awscli-1.11.13/awscli/examples/ec2/create-reserved-instances-listing.rst awscli-1.18.69/awscli/examples/ec2/create-reserved-instances-listing.rst --- awscli-1.11.13/awscli/examples/ec2/create-reserved-instances-listing.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-reserved-instances-listing.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To list a Reserved Instance in the Reserved Instance Marketplace** + +The following ``create-reserved-instances-listing`` example creates a listing for the specified Reserved Instance in the Reserved Instance Marketplace. :: + + aws ec2 create-reserved-instances-listing \ + --reserved-instances-id 5ec28771-05ff-4b9b-aa31-9e57dexample \ + --instance-count 3 \ + --price-schedules CurrencyCode=USD,Price=25.50 \ + --client-token 550e8400-e29b-41d4-a716-446655440000 diff -Nru awscli-1.11.13/awscli/examples/ec2/create-route.rst awscli-1.18.69/awscli/examples/ec2/create-route.rst --- awscli-1.11.13/awscli/examples/ec2/create-route.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-route.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,15 +1,21 @@ **To create a route** -This example creates a route for the specified route table. The route matches all traffic (``0.0.0.0/0``) and routes it to the specified Internet gateway. If the command succeeds, no output is returned. +This example creates a route for the specified route table. The route matches all IPv4 traffic (``0.0.0.0/0``) and routes it to the specified Internet gateway. If the command succeeds, no output is returned. Command:: aws ec2 create-route --route-table-id rtb-22574640 --destination-cidr-block 0.0.0.0/0 --gateway-id igw-c0a643a9 -This example command creates a route in route table rtb-g8ff4ea2. The route matches traffic for the CIDR block +This example command creates a route in route table rtb-g8ff4ea2. The route matches traffic for the IPv4 CIDR block 10.0.0.0/16 and routes it to VPC peering connection, pcx-111aaa22. This route enables traffic to be directed to the peer VPC in the VPC peering connection. If the command succeeds, no output is returned. Command:: aws ec2 create-route --route-table-id rtb-g8ff4ea2 --destination-cidr-block 10.0.0.0/16 --vpc-peering-connection-id pcx-1a2b3c4d + +This example creates a route in the specified route table that matches all IPv6 traffic (``::/0``) and routes it to the specified egress-only Internet gateway. + +Command:: + + aws ec2 create-route --route-table-id rtb-dce620b8 --destination-ipv6-cidr-block ::/0 --egress-only-internet-gateway-id eigw-01eadbd45ecd7943f diff -Nru awscli-1.11.13/awscli/examples/ec2/create-snapshot.rst awscli-1.18.69/awscli/examples/ec2/create-snapshot.rst --- awscli-1.11.13/awscli/examples/ec2/create-snapshot.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-snapshot.rst 2020-05-28 19:25:48.000000000 +0000 @@ -4,17 +4,51 @@ Command:: - aws ec2 create-snapshot --volume-id vol-1234567890abcdef0 --description "This is my root volume snapshot." + aws ec2 create-snapshot --volume-id vol-1234567890abcdef0 --description "This is my root volume snapshot" Output:: { - "Description": "This is my root volume snapshot.", + "Description": "This is my root volume snapshot", "Tags": [], + "Encrypted": false, "VolumeId": "vol-1234567890abcdef0", "State": "pending", "VolumeSize": 8, - "StartTime": "2014-02-28T21:06:01.000Z", + "StartTime": "2018-02-28T21:06:01.000Z", + "Progress": "", "OwnerId": "012345678910", "SnapshotId": "snap-066877671789bd71b" - } \ No newline at end of file + } + +**To create a snapshot with tags** + +This example command creates a snapshot and applies two tags: purpose=prod and costcenter=123. + +Command:: + + aws ec2 create-snapshot --volume-id vol-1234567890abcdef0 --description 'Prod backup' --tag-specifications 'ResourceType=snapshot,Tags=[{Key=purpose,Value=prod},{Key=costcenter,Value=123}]' + +Output:: + + { + "Description": "Prod backup", + "Tags": [ + { + "Value": "prod", + "Key": "purpose" + }, + { + "Value": "123", + "Key": "costcenter" + } + ], + "Encrypted": false, + "VolumeId": "vol-1234567890abcdef0", + "State": "pending", + "VolumeSize": 8, + "StartTime": "2018-02-28T21:06:06.000Z", + "Progress": "", + "OwnerId": "012345678910", + "SnapshotId": "snap-09ed24a70bc19bbe4" + } diff -Nru awscli-1.11.13/awscli/examples/ec2/create-snapshots.rst awscli-1.18.69/awscli/examples/ec2/create-snapshots.rst --- awscli-1.11.13/awscli/examples/ec2/create-snapshots.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-snapshots.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,88 @@ +**Example 1: To create a multi-volume snapshot** + +The following ``create-snapshots`` example creates snapshots of all volumes attached to the specified instance. :: + + aws ec2 create-snapshots \ + --instance-specification InstanceId=i-1234567890abcdef0 \ + --description "This is snapshot of a volume from my-instance" + +Output:: + + { + "Snapshots": [ + { + "Description": "This is a snapshot of a volume from my-instance", + "Tags": [], + "Encrypted": false, + "VolumeId": "vol-0a01d2d5a34697479", + "State": "pending", + "VolumeSize": 16, + "StartTime": "2019-08-05T16:58:19.000Z", + "Progress": "", + "OwnerId": "123456789012", + "SnapshotId": "snap-07f30e3909aa0045e" + }, + { + "Description": "This is a snapshot of a volume from my-instance", + "Tags": [], + "Encrypted": false, + "VolumeId": "vol-02d0d4947008cb1a2", + "State": "pending", + "VolumeSize": 20, + "StartTime": "2019-08-05T16:58:19.000Z", + "Progress": "", + "OwnerId": "123456789012", + "SnapshotId": "snap-0ec20b602264aad48" + }, + ... + ] + } + +**Example 2: To create a multi-volume snapshot with tags from the source volume** + +The following ``create-snapshots`` example creates snapshots of all volumes attached to the specified instance and copies the tags from each volume to its corresponding snapshot. :: + + aws ec2 create-snapshots \ + --instance-specification InstanceId=i-1234567890abcdef0 \ + --copy-tags-from-source volume \ + --description "This is snapshot of a volume from my-instance" + +Output:: + + { + "Snapshots": [ + { + "Description": "This is a snapshot of a volume from my-instance", + "Tags": [ + { + "Key": "Name", + "Value": "my-volume" + } + ], + "Encrypted": false, + "VolumeId": "vol-02d0d4947008cb1a2", + "State": "pending", + "VolumeSize": 20, + "StartTime": "2019-08-05T16:53:04.000Z", + "Progress": "", + "OwnerId": "123456789012", + "SnapshotId": "snap-053bfaeb821a458dd" + } + ... + ] + } + +**Example 3: To create a multi-volume snapshot not including the root volume** + +The following ``create-snapshots`` example creates a snapshot of all volumes attached to the specified instance except for the root volume. :: + + aws ec2 create-snapshots \ + --instance-specification InstanceId=i-1234567890abcdef0,ExcludeBootVolume=true + +**Example 4: To create a multi-volume snapshot and add tags** + +The following ``create-snapshots`` example creates snapshots of all volumes attached to the specified instance and adds two tags to each snapshot. :: + + aws ec2 create-snapshots \ + --instance-specification InstanceId=i-1234567890abcdef0 + --tag-specifications ResourceType=snapshot,Tags=[{Key=Name,Value=backup},{Key=costcenter,Value=123}] diff -Nru awscli-1.11.13/awscli/examples/ec2/create-subnet.rst awscli-1.18.69/awscli/examples/ec2/create-subnet.rst --- awscli-1.11.13/awscli/examples/ec2/create-subnet.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-subnet.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,20 +1,68 @@ -**To create a subnet** +**Example 1: To create a subnet with an IPv4 CIDR block** -This example creates a subnet in the specified VPC with the specified CIDR block. We recommend that you let us select an Availability Zone for you. Alternatively, you can use the ``--availability-zone`` option to specify the Availability Zone. +The following ``create-subnet`` example creates a subnet in the specified VPC with the specified IPv4 CIDR block. We recommend that you let us select an Availability Zone for you. Alternatively, you can use the ``--availability-zone`` option to specify the Availability Zone. :: -Command:: + aws ec2 create-subnet \ + --vpc-id vpc-081ec835f3EXAMPLE \ + --cidr-block 10.0.1.0/24 - aws ec2 create-subnet --vpc-id vpc-a01106c2 --cidr-block 10.0.1.0/24 +Output:: + + { + "Subnet": { + "AvailabilityZone": "us-east-2c", + "AvailabilityZoneId": "use2-az3", + "AvailableIpAddressCount": 251, + "CidrBlock": "10.0.1.0/24", + "DefaultForAz": false, + "MapPublicIpOnLaunch": false, + "State": "pending", + "SubnetId": "subnet-0e3f5cac72EXAMPLE", + "VpcId": "vpc-081ec835f3EXAMPLE", + "OwnerId": "111122223333", + "AssignIpv6AddressOnCreation": false, + "Ipv6CidrBlockAssociationSet": [], + "SubnetArn": "arn:aws:ec2:us-east-2:111122223333:subnet/subnet-0e3f5cac72375030d" + } + } + +For more information, see `Creating a Subnet in Your VPC `__ in the *AWS VPC User Guide* +**Example 2: To create a subnet with an IPv6 CIDR block** + +The following ``create-subnet`` example creates a subnet in the specified VPC with the specified IPv4 and IPv6 CIDR blocks (from the ranges of the VPC). :: + + aws ec2 create-subnet \ + --vpc-id vpc-07e8ffd50fEXAMPLE \ + --cidr-block 10.0.0.0/24 \ + --ipv6-cidr-block 2600:1f16:115:200::/64 + Output:: - { - "Subnet": { - "VpcId": "vpc-a01106c2", - "CidrBlock": "10.0.1.0/24", - "State": "pending", - "AvailabilityZone": "us-east-1c", - "SubnetId": "subnet-9d4a7b6c", - "AvailableIpAddressCount": 251 - } - } \ No newline at end of file + { + "Subnet": { + "AvailabilityZone": "us-east-2b", + "AvailabilityZoneId": "use2-az2", + "AvailableIpAddressCount": 251, + "CidrBlock": "10.0.0.0/24", + "DefaultForAz": false, + "MapPublicIpOnLaunch": false, + "State": "pending", + "SubnetId": "subnet-02bf4c428bEXAMPLE", + "VpcId": "vpc-07e8ffd50EXAMPLE", + "OwnerId": "1111222233333", + "AssignIpv6AddressOnCreation": false, + "Ipv6CidrBlockAssociationSet": [ + { + "AssociationId": "subnet-cidr-assoc-002afb9f3cEXAMPLE", + "Ipv6CidrBlock": "2600:1f16:115:200::/64", + "Ipv6CidrBlockState": { + "State": "associating" + } + } + ], + "SubnetArn": "arn:aws:ec2:us-east-2:111122223333:subnet/subnet-02bf4c428bEXAMPLE" + } + } + +For more information, see `Creating a Subnet in Your VPC `__ in the *AWS VPC User Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/create-tags.rst awscli-1.18.69/awscli/examples/ec2/create-tags.rst --- awscli-1.11.13/awscli/examples/ec2/create-tags.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-tags.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,36 +1,36 @@ **To add a tag to a resource** -This example adds the tag ``Stack=production`` to the specified image, or overwrites an existing tag for the AMI where the tag key is ``Stack``. If the command succeeds, no output is returned. +The following ``create-tags`` example adds the tag ``Stack=production`` to the specified image, or overwrites an existing tag for the AMI where the tag key is ``Stack``. :: -Command:: - - aws ec2 create-tags --resources ami-78a54011 --tags Key=Stack,Value=production + aws ec2 create-tags \ + --resources ami-1234567890abcdef0 --tags Key=Stack,Value=production **To add tags to multiple resources** -This example adds (or overwrites) two tags for an AMI and an instance. One of the tags contains just a key (``webserver``), with no value (we set the value to an empty string). The other tag consists of a key (``stack``) and value (``Production``). If the command succeeds, no output is returned. - -Command:: - - aws ec2 create-tags --resources ami-1a2b3c4d i-1234567890abcdef0 --tags Key=webserver,Value= Key=stack,Value=Production - -**To add tags with special characters** - -This example adds the tag ``[Group]=test`` for an instance. The square brackets ([ and ]) are special characters, and must be escaped. If you are using Windows, surround the value with (\"): +The following ``create-tags`` example adds (or overwrites) two tags for an AMI and an instance. One of the tags has a key (``webserver``) but no value (value is set to an empty string). The other tag has a key (``stack``) and a value (``Production``). :: -Command:: + aws ec2 create-tags \ + --resources ami-1a2b3c4d i-1234567890abcdef0 \ + --tags Key=webserver,Value= Key=stack,Value=Production - aws ec2 create-tags --resources i-1234567890abcdef0 --tags Key=\"[Group]\",Value=test +**To add tags containing special characters** -If you are using Windows PowerShell, break out the characters with a backslash (\\), surround them with double quotes ("), and then surround the entire key and value structure with single quotes ('): +The following ``create-tags`` example adds the tag ``[Group]=test`` for an instance. The square brackets ([ and ]) are special characters, and must be escaped. The following examples also use the line continuation character appropriate for each environment. -Command:: +If you are using Windows, surround the element that has special characters with double quotes ("), and then precede each double quote character with a backslash (\\) as follows:: - aws ec2 create-tags --resources i-1234567890abcdef0 --tags 'Key=\"[Group]\",Value=test' + aws ec2 create-tags ^ + --resources i-1234567890abcdef0 ^ + --tags Key=\"[Group]\",Value=test -If you are using Linux or OS X, enclose the entire key and value structure with single quotes ('), and then enclose the element with the special character with double quotes ("): +If you are using Windows PowerShell, element the value that has special characters with double quotes ("), precede each double quote character with a backslash (\\), and then surround the entire key and value structure with single quotes (') as follows:: -Command:: + aws ec2 create-tags ` + --resources i-1234567890abcdef0 ` + --tags 'Key=\"[Group]\",Value=test' - aws ec2 create-tags --resources i-1234567890abcdef0 --tags 'Key="[Group]",Value=test' +If you are using Linux or OS X, surround the element that has special characters with double quotes ("), and then surround the entire key and value structure with single quotes (') as follows:: + aws ec2 create-tags \ + --resources i-1234567890abcdef0 \ + --tags 'Key="[Group]",Value=test' diff -Nru awscli-1.11.13/awscli/examples/ec2/create-traffic-mirror-filter.rst awscli-1.18.69/awscli/examples/ec2/create-traffic-mirror-filter.rst --- awscli-1.11.13/awscli/examples/ec2/create-traffic-mirror-filter.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-traffic-mirror-filter.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,12 @@ +**To create a Traffic Mirror Filter** + +The following ``create-traffic-mirror-filter`` example creates a Traffic Mirror filter. After you create the filter, use ``create-traffic-mirror-filter-rule`` to add rules to the filter. :: + + aws ec2 create-traffic-mirror-filter \ + --description "TCP Filter" + +Output:: + + { "ClientToken": "28908518-100b-4987-8233-8c744EXAMPLE", "TrafficMirrorFilter": { "TrafficMirrorFilterId": "tmf-04812ff784EXAMPLE", "Description": "TCP Filter", "EgressFilterRules": [], "IngressFilterRules": [], "Tags": [], "NetworkServices": [] } } + +For more information, see `Create a Traffic Mirror Filter `__ in the *AWS Traffic Mirroring Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/create-traffic-mirror-filter-rule.rst awscli-1.18.69/awscli/examples/ec2/create-traffic-mirror-filter-rule.rst --- awscli-1.11.13/awscli/examples/ec2/create-traffic-mirror-filter-rule.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-traffic-mirror-filter-rule.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,32 @@ +**To create a filter rule for incoming TCP traffic** + +The following ``create-traffic-mirror-filter-rule`` example creates a rule that you can use to mirror all incoming TCP traffic. Before you run this command, use ``create-traffic-mirror-filter`` to create the the Traffic Mirror filter. :: + + aws ec2 create-traffic-mirror-filter-rule \ + --description "TCP Rule" \ + --destination-cidr-block 0.0.0.0/0 \ + --protocol 6 \ + --rule-action accept \ + --rule-number 1 \ + --source-cidr-block 0.0.0.0/0 \ + --traffic-direction ingress \ + --traffic-mirror-filter-id tmf-04812ff784b25ae67 + +Output:: + + { + "TrafficMirrorFilterRule": { + "DestinationCidrBlock": "0.0.0.0/0", + "TrafficMirrorFilterId": "tmf-04812ff784b25ae67", + "TrafficMirrorFilterRuleId": "tmfr-02d20d996673f3732", + "SourceCidrBlock": "0.0.0.0/0", + "TrafficDirection": "ingress", + "Description": "TCP Rule", + "RuleNumber": 1, + "RuleAction": "accept", + "Protocol": 6 + }, + "ClientToken": "4752b573-40a6-4eac-a8a4-a72058761219" + } + +For more information, see `Create a Traffic Mirror Filter `__ in the *AWS Traffic Mirroring Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/create-traffic-mirror-session.rst awscli-1.18.69/awscli/examples/ec2/create-traffic-mirror-session.rst --- awscli-1.11.13/awscli/examples/ec2/create-traffic-mirror-session.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-traffic-mirror-session.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,31 @@ +**To create a Traffic Mirror Session** + +The following ``create-traffic-mirror-session`` command creates a traffic mirror sessions for the specified source and target for 25 bytes of the packet. :: + + aws ec2 create-traffic-mirror-session \ + --description "example session" \ + --traffic-mirror-target-id tmt-07f75d8feeEXAMPLE \ + --network-interface-id eni-070203f901EXAMPLE \ + --session-number 1 \ + --packet-length 25 \ + --traffic-mirror-filter-id tmf-04812ff784EXAMPLE + +Output:: + + { + "TrafficMirrorSession": { + "TrafficMirrorSessionId": "tms-08a33b1214EXAMPLE", + "TrafficMirrorTargetId": "tmt-07f75d8feeEXAMPLE", + "TrafficMirrorFilterId": "tmf-04812ff784EXAMPLE", + "NetworkInterfaceId": "eni-070203f901EXAMPLE", + "OwnerId": "111122223333", + "PacketLength": 25, + "SessionNumber": 1, + "VirtualNetworkId": 7159709, + "Description": "example session", + "Tags": [] + }, + "ClientToken": "5236cffc-ee13-4a32-bb5b-388d9da09d96" + } + +For more information, see `Create a Traffic Mirror Session `__ in the *AWS Traffic Mirroring Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/create-traffic-mirror-target.rst awscli-1.18.69/awscli/examples/ec2/create-traffic-mirror-target.rst --- awscli-1.11.13/awscli/examples/ec2/create-traffic-mirror-target.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-traffic-mirror-target.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,35 @@ +**To create a a Network Load Balancer Traffic Mirror target** + +The following ``create-traffic-mirror-target`` example creates a Network Load Balancer Traffic Mirror target. :: + + aws ec2 create-traffic-mirror-target \ + --description "Example Network Load Balancer Target" \ + --network-load-balancer-arn arn:aws:elasticloadbalancing:us-east-1:111122223333:loadbalancer/net/NLB/7cdec873EXAMPLE + +Output:: + + { "TrafficMirrorTarget": { "Type": "network-load-balancer", "Tags": [], "Description": "Example Network Load Balancer Target", "OwnerId": "111122223333", "NetworkLoadBalancerArn": "arn:aws:elasticloadbalancing:us-east-1:724145273726:loadbalancer/net/NLB/7cdec873EXAMPLE", "TrafficMirrorTargetId": "tmt-0dabe9b0a6EXAMPLE" }, "ClientToken": "d5c090f5-8a0f-49c7-8281-72c796a21f72" } + +**To create a network Traffic Mirror target** + +The following ``create-traffic-mirror-target`` example creates a network interface Traffic Mirror target. + + aws ec2 create-traffic-mirror-target \ + --description "Network interface target" \ + --network-interface-id eni-eni-01f6f631eEXAMPLE + +Output:: + + { + "ClientToken": "5289a345-0358-4e62-93d5-47ef3061d65e", + "TrafficMirrorTarget": { + "Description": "Network interface target", + "NetworkInterfaceId": "eni-01f6f631eEXAMPLE", + "TrafficMirrorTargetId": "tmt-02dcdbe2abEXAMPLE", + "OwnerId": "111122223333", + "Type": "network-interface", + "Tags": [] + } + } + +For more information, see `Create a Traffic Mirror Target `__ in the *AWS Traffic Mirroring Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/create-transit-gateway-peering-attachment.rst awscli-1.18.69/awscli/examples/ec2/create-transit-gateway-peering-attachment.rst --- awscli-1.11.13/awscli/examples/ec2/create-transit-gateway-peering-attachment.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-transit-gateway-peering-attachment.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/create-transit-gateway-route.rst awscli-1.18.69/awscli/examples/ec2/create-transit-gateway-route.rst --- awscli-1.11.13/awscli/examples/ec2/create-transit-gateway-route.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-transit-gateway-route.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,27 @@ +**To create a Transit Gateway Route** + +The following ``create-transit-gateway-route`` example creates a route for the specified route table. :: + + aws ec2 create-transit-gateway-route \ + --destination-cidr-block 10.0.2.0/24 \ + --transit-gateway-route-table-id tgw-rtb-0b6f6aaa01EXAMPLE \ + --transit-gateway-attachment-id tgw-attach-0b5968d3b6EXAMPLE + +Output:: + + { + "Route": { + "DestinationCidrBlock": "10.0.2.0/24", + "TransitGatewayAttachments": [ + { + "ResourceId": "vpc-0065acced4EXAMPLE", + "TransitGatewayAttachmentId": "tgw-attach-0b5968d3b6EXAMPLE", + "ResourceType": "vpc" + } + ], + "Type": "static", + "State": "active" + } + } + +For more information, see `Create a Transit Gateway Route `__ in the *AWS Transit Gateways Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/create-transit-gateway-route-table.rst awscli-1.18.69/awscli/examples/ec2/create-transit-gateway-route-table.rst --- awscli-1.11.13/awscli/examples/ec2/create-transit-gateway-route-table.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-transit-gateway-route-table.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To create a Transit Gateway Route Table** + +The following ``create-transit-gateway-route-table`` example creates a route table for the specified transit gateway. :: + + aws ec2 create-transit-gateway-route-table \ + --transit-gateway-id tgw-0262a0e521EXAMPLE + +Output:: + + { + "TransitGatewayRouteTable": { + "TransitGatewayRouteTableId": "tgw-rtb-0960981be7EXAMPLE", + "TransitGatewayId": "tgw-0262a0e521EXAMPLE", + "State": "pending", + "DefaultAssociationRouteTable": false, + "DefaultPropagationRouteTable": false, + "CreationTime": "2019-07-10T19:01:46.000Z" + } + } + +For more information, see `Create a Transit Gateway Route Table `__ in the *AWS Transit Gateways Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/create-transit-gateway.rst awscli-1.18.69/awscli/examples/ec2/create-transit-gateway.rst --- awscli-1.11.13/awscli/examples/ec2/create-transit-gateway.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-transit-gateway.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,31 @@ +**To create a transit gateway** + +The following ``create-transit-gateway`` This example creates a transit gateway. :: + + aws ec2 create-transit-gateway --description MyTGW \ + --options=AmazonSideAsn=64516,AutoAcceptSharedAttachments=enable,DefaultRouteTableAssociation=enable,DefaultRouteTablePropagation=enable,VpnEcmpSupport=enable,DnsSupport=enable + +Output:: + + { + "TransitGateway": { + "TransitGatewayId": "tgw-0262a0e521EXAMPLE", + "TransitGatewayArn": "arn:aws:ec2:us-east-2:111122223333:transit-gateway/tgw-0262a0e521EXAMPLE", + "State": "pending", + "OwnerId": "111122223333", + "Description": "MyTGW", + "CreationTime": "2019-07-10T14:02:12.000Z", + "Options": { + "AmazonSideAsn": 64516, + "AutoAcceptSharedAttachments": "enable", + "DefaultRouteTableAssociation": "enable", + "AssociationDefaultRouteTableId": "tgw-rtb-018774adf3EXAMPLE", + "DefaultRouteTablePropagation": "enable", + "PropagationDefaultRouteTableId": "tgw-rtb-018774adf3EXAMPLE", + "VpnEcmpSupport": "enable", + "DnsSupport": "enable" + } + } + } + +For more information, see `Create a Transit Gateway `__ in the *AWS Transit Gateways Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/create-transit-gateway-vpc-attachment.rst awscli-1.18.69/awscli/examples/ec2/create-transit-gateway-vpc-attachment.rst --- awscli-1.11.13/awscli/examples/ec2/create-transit-gateway-vpc-attachment.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-transit-gateway-vpc-attachment.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,60 @@ +**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-0752213d59EXAMPLE + +Output:: + + { + "TransitGatewayVpcAttachment": { + "TransitGatewayAttachmentId": "tgw-attach-0a34fe6b4fEXAMPLE", + "TransitGatewayId": "tgw-0262a0e521EXAMPLE", + "VpcId": "vpc-07e8ffd50fEXAMPLE", + "VpcOwnerId": "111122223333", + "State": "pending", + "SubnetIds": [ + "subnet-0752213d59EXAMPLE" + ], + "CreationTime": "2019-07-10T17:33:46.000Z", + "Options": { + "DnsSupport": "enable", + "Ipv6Support": "disable" + } + } + } + +**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.11.13/awscli/examples/ec2/create-volume.rst awscli-1.18.69/awscli/examples/ec2/create-volume.rst --- awscli-1.11.13/awscli/examples/ec2/create-volume.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-volume.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,44 +1,103 @@ -**To create a new volume** +**To create an empty General Purpose SSD (gp2) volume** -This example command creates an 80 GiB General Purpose (SSD) volume in the Availability Zone ``us-east-1a``. +The following ``create-volume`` example creates an 80 GiB General Purpose SSD (gp2) volume in the specified Availability Zone. Note that the current Region must be ``us-east-1``, or you can add the ``--region`` parameter to specify the Region for the command. :: -Command:: - - aws ec2 create-volume --size 80 --region us-east-1 --availability-zone us-east-1a --volume-type gp2 + aws ec2 create-volume \ + --volume-type gp2 \ + --size 80 \ + --availability-zone us-east-1a Output:: - { - "AvailabilityZone": "us-east-1a", - "Attachments": [], - "Tags": [], - "VolumeType": "gp2", - "VolumeId": "vol-1234567890abcdef0", - "State": "creating", - "SnapshotId": null, - "CreateTime": "YYYY-MM-DDTHH:MM:SS.000Z", - "Size": 80 - } - -**To create a new Provisioned IOPS (SSD) volume from a snapshot** + { + "AvailabilityZone": "us-east-1a", + "Tags": [], + "Encrypted": false, + "VolumeType": "gp2", + "VolumeId": "vol-1234567890abcdef0", + "State": "creating", + "Iops": 240, + "SnapshotId": "", + "CreateTime": "YYYY-MM-DDTHH:MM:SS.000Z", + "Size": 80 + } + +If you do not specify a volume type, the default volume type is ``gp2``. :: + + aws ec2 create-volume \ + --size 80 \ + --availability-zone us-east-1a + +**Example 2: To create a Provisioned IOPS SSD (io1) volume from a snapshot** + +The following ``create-volume`` example creates a Provisioned IOPS SSD (io1) volume with 1000 provisioned IOPS in the specified Availability Zone using the specified snapshot. :: + + aws ec2 create-volume \ + --volume-type io1 \ + --iops 1000 \ + --snapshot-id snap-066877671789bd71b \ + --availability-zone us-east-1a -This example command creates a new Provisioned IOPS (SSD) volume with 1000 provisioned IOPS from a snapshot in the Availability Zone ``us-east-1a``. - -Command:: +Output:: - aws ec2 create-volume --region us-east-1 --availability-zone us-east-1a --snapshot-id snap-066877671789bd71b --volume-type io1 --iops 1000 + { + "AvailabilityZone": "us-east-1a", + "Tags": [], + "Encrypted": false, + "VolumeType": "io1", + "VolumeId": "vol-1234567890abcdef0", + "State": "creating", + "Iops": 1000, + "SnapshotId": "snap-066877671789bd71b", + "CreateTime": "YYYY-MM-DDTHH:MM:SS.000Z", + "Size": 500 + } + +**Example 3: To create an encrypted volume** + +The following ``create-volume`` example creates an encrypted volume using the default CMK for EBS encryption. If encryption by default is disabled, you must specify the ``--encrypted`` parameter as follows. :: + + aws ec2 create-volume \ + --size 80 \ + --encrypted \ + --availability-zone us-east-1a Output:: - { - "AvailabilityZone": "us-east-1a", - "Attachments": [], - "Tags": [], - "VolumeType": "io1", - "VolumeId": "vol-1234567890abcdef0", - "State": "creating", - "Iops": 1000, - "SnapshotId": "snap-066877671789bd71b", - "CreateTime": "YYYY-MM-DDTHH:MM:SS.000Z", - "Size": 500 - } + { + "AvailabilityZone": "us-east-1a", + "Tags": [], + "Encrypted": true, + "VolumeType": "gp2", + "VolumeId": "vol-1234567890abcdef0", + "State": "creating", + "Iops": 240, + "SnapshotId": "", + "CreateTime": "YYYY-MM-DDTHH:MM:SS.000Z", + "Size": 80 + } + +If encryption by default is enabled, the following example command creates an encrypted volume, even without the ``--encrypted`` parameter. :: + + aws ec2 create-volume \ + --size 80 \ + --availability-zone us-east-1a + +If you use the ``--kms-key-id`` parameter to specify a customer managed CMK, you must specify the ``--encrypted`` parameter even if encryption by default is enabled. :: + + aws ec2 create-volume \ + --volume-type gp2 \ + --size 80 \ + --encrypted \ + --kms-key-id 0ea3fef3-80a7-4778-9d8c-1c0c6EXAMPLE \ + --availability-zone us-east-1a + +**Example 4: To create a volume with tags** + +The following ``create-volume`` example creates a volume and adds two tags. :: + + aws ec2 create-volume \ + --availability-zone us-east-1a \ + --volume-type gp2 \ + --size 80 \ + --tag-specifications 'ResourceType=volume,Tags=[{Key=purpose,Value=production},{Key=cost-center,Value=cc123}]' diff -Nru awscli-1.11.13/awscli/examples/ec2/create-vpc-endpoint-connection-notification.rst awscli-1.18.69/awscli/examples/ec2/create-vpc-endpoint-connection-notification.rst --- awscli-1.11.13/awscli/examples/ec2/create-vpc-endpoint-connection-notification.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-vpc-endpoint-connection-notification.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,23 @@ +**To create an endpoint connection notification** + +This example creates a notification for a specific endpoint service that alerts you when interface endpoints have connected to your service and when endpoints have been accepted for your service. + +Command:: + + aws ec2 create-vpc-endpoint-connection-notification --connection-notification-arn arn:aws:sns:us-east-2:123456789012:VpceNotification --connection-events Connect Accept --service-id vpce-svc-1237881c0d25a3abc + +Output:: + + { + "ConnectionNotification": { + "ConnectionNotificationState": "Enabled", + "ConnectionNotificationType": "Topic", + "ServiceId": "vpce-svc-1237881c0d25a3abc", + "ConnectionEvents": [ + "Accept", + "Connect" + ], + "ConnectionNotificationId": "vpce-nfn-008776de7e03f5abc", + "ConnectionNotificationArn": "arn:aws:sns:us-east-2:123456789012:VpceNotification" + } + } diff -Nru awscli-1.11.13/awscli/examples/ec2/create-vpc-endpoint.rst awscli-1.18.69/awscli/examples/ec2/create-vpc-endpoint.rst --- awscli-1.11.13/awscli/examples/ec2/create-vpc-endpoint.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-vpc-endpoint.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,23 +1,82 @@ -**To create an endpoint** +**To create a gateway endpoint** -This example creates a VPC endpoint between VPC vpc-1a2b3c4d and Amazon S3 in the us-east-1 region, and associates route table rtb-11aa22bb with the endpoint. +The following ``create-vpc-endpoint`` example creates a gateway VPC endpoint between VPC ``vpc-1a2b3c4d`` and Amazon S3 in the ``us-east-1`` region, and associates route table ``rtb-11aa22bb`` with the endpoint. :: -Command:: + aws ec2 create-vpc-endpoint \ + --vpc-id vpc-1EXAMPLE \ + --service-name com.amazonaws.us-east-1.s3 \ + --route-table-ids rtb-1EXAMPLE - aws ec2 create-vpc-endpoint --vpc-id vpc-1a2b3c4d --service-name com.amazonaws.us-east-1.s3 --route-table-ids rtb-11aa22bb +Output:: + + { + "VpcEndpoint": { + "PolicyDocument": "{\"Version\":\"2008-10-17\",\"Statement\":[{\"Sid\":\"\",\"Effect\":\"Allow\",\"Principal\":\"\*\",\"Action\":\"\*\",\"Resource\":\"\*\"}]}", + "VpcId": "vpc-1EXAMPLE", + "State": "available", + "ServiceName": "com.amazonaws.us-east-1.s3", + "RouteTableIds": [ + "rtb-1EXAMPLE" + ], + "VpcEndpointId": "vpce-3EXAMPLE", + "CreationTimestamp": "2015-05-15T09:40:50Z" + } + } + +For more information, see `Creating a Gateway Endpoint `__ in the *AWS VPC User Guide*. + +**To create an interface endpoint** + +The following ``create-vpc-endpoint`` example creates an interface VPC endpoint between VPC ``vpc-1a2b3c4d`` and Elastic Load Balancing in the ``us-east-1`` region. The command creates the endpoint in subnet ``subnet-7b16de0c`` and associates it with security group ``sg-1a2b3c4d``. :: + + aws ec2 create-vpc-endpoint \ + --vpc-id vpc-1EXAMPLE \ + --vpc-endpoint-type Interface \ + --service-name com.amazonaws.us-east-1.elasticloadbalancing \ + --subnet-id subnet-7EXAMPLE \ + --security-group-id sg-1EXAMPLE Output:: - { - "VpcEndpoint": { - "PolicyDocument": "{\"Version\":\"2008-10-17\",\"Statement\":[{\"Sid\":\"\",\"Effect\":\"Allow\",\"Principal\":\"*\",\"Action\":\"*\",\"Resource\":\"*\"}]}", - "VpcId": "vpc-1a2b3c4d", - "State": "available", - "ServiceName": "com.amazonaws.us-east-1.s3", - "RouteTableIds": [ - "rtb-11aa22bb" - ], - "VpcEndpointId": "vpce-3ecf2a57", - "CreationTimestamp": "2015-05-15T09:40:50Z" + { + "VpcEndpoint": { + "PolicyDocument": "{\n \"Statement\": [\n {\n \"Action\": \"\*\", \n \"Effect\": \"Allow\", \n \"Principal\": \"\*\", \n \"Resource\": \"\*\"\n }\n ]\n}", + "VpcId": "vpc-1EXAMPLE", + "NetworkInterfaceIds": [ + "eni-bf8aa46b" + ], + "SubnetIds": [ + "subnet-7EXAMPLE" + ], + "PrivateDnsEnabled": true, + "State": "pending", + "ServiceName": "com.amazonaws.us-east-1.elasticloadbalancing", + "RouteTableIds": [], + "Groups": [ + { + "GroupName": "default", + "GroupId": "sg-1EXAMPLE" + } + ], + "VpcEndpointId": "vpce-088d25a4bbEXAMPLE", + "VpcEndpointType": "Interface", + "CreationTimestamp": "2017-09-05T20:14:41.240Z", + "DnsEntries": [ + { + "HostedZoneId": "Z7HUB22UULQXV", + "DnsName": "vpce-088d25a4bbf4a7e66-ks83awe7.elasticloadbalancing.us-east-1.vpce.amazonaws.com" + }, + { + "HostedZoneId": "Z7HUB22UULQXV", + "DnsName": "vpce-088d25a4bbf4a7e66-ks83awe7-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com" + }, + { + "HostedZoneId": "Z1K56Z6FNPJRR", + "DnsName": "elasticloadbalancing.us-east-1.amazonaws.com" + } + ], + "OwnerId": "123456789012" + } } - } \ No newline at end of file + +For more information, see `Creating an Interface Endpoint `__ in the *AWS VPC User Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/create-vpc-endpoint-service-configuration.rst awscli-1.18.69/awscli/examples/ec2/create-vpc-endpoint-service-configuration.rst --- awscli-1.11.13/awscli/examples/ec2/create-vpc-endpoint-service-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-vpc-endpoint-service-configuration.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,32 @@ +**To create an endpoint service configuration** + +This example creates a VPC endpoint service configuration using the load balancer ``nlb-vpce``. This example also specifies that requests to connect to the service through an interface endpoint must be accepted. + +Command:: + + aws ec2 create-vpc-endpoint-service-configuration --network-load-balancer-arns arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/net/nlb-vpce/e94221227f1ba532 --acceptance-required + +Output:: + + { + "ServiceConfiguration": { + "ServiceType": [ + { + "ServiceType": "Interface" + } + ], + "NetworkLoadBalancerArns": [ + "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/net/nlb-vpce/e94221227f1ba532" + ], + "ServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-03d5ebb7d9579a2b3", + "ServiceState": "Available", + "ServiceId": "vpce-svc-03d5ebb7d9579a2b3", + "AcceptanceRequired": true, + "AvailabilityZones": [ + "us-east-1d" + ], + "BaseEndpointDnsNames": [ + "vpce-svc-03d5ebb7d9579a2b3.us-east-1.vpce.amazonaws.com" + ] + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/create-vpc-peering-connection.rst awscli-1.18.69/awscli/examples/ec2/create-vpc-peering-connection.rst --- awscli-1.11.13/awscli/examples/ec2/create-vpc-peering-connection.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-vpc-peering-connection.rst 2020-05-28 19:25:48.000000000 +0000 @@ -31,9 +31,22 @@ **To create a VPC peering connection with a VPC in another account** -This example requests a peering connection between your VPC (vpc-1a2b3c4d), and a VPC (vpc-123abc45) that belongs AWS account 123456789012. +This example requests a peering connection between your VPC (vpc-1a2b3c4d), and a VPC (vpc-11122233) that belongs AWS account 123456789012. Command:: aws ec2 create-vpc-peering-connection --vpc-id vpc-1a2b3c4d --peer-vpc-id vpc-11122233 --peer-owner-id 123456789012 +**To create a VPC peering connection with a VPC in a different region** + +This example requests a peering connection between your VPC in the current region (vpc-1a2b3c4d), and a VPC (vpc-11122233) in your account in the ``us-west-2`` region. + +Command:: + + aws ec2 create-vpc-peering-connection --vpc-id vpc-1a2b3c4d --peer-vpc-id vpc-11122233 --peer-region us-west-2 + +This example requests a peering connection between your VPC in the current region (vpc-1a2b3c4d), and a VPC (vpc-11122233) that belongs AWS account 123456789012 that's in the ``us-west-2`` region. + +Command:: + + aws ec2 create-vpc-peering-connection --vpc-id vpc-1a2b3c4d --peer-vpc-id vpc-11122233 --peer-owner-id 123456789012 --peer-region us-west-2 \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/create-vpc.rst awscli-1.18.69/awscli/examples/ec2/create-vpc.rst --- awscli-1.11.13/awscli/examples/ec2/create-vpc.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-vpc.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,39 +1,111 @@ -**To create a VPC** +**Example 1: To create a VPC** -This example creates a VPC with the specified CIDR block. +The following ``create-vpc`` example creates a VPC with the specified IPv4 CIDR block. :: -Command:: - - aws ec2 create-vpc --cidr-block 10.0.0.0/16 + aws ec2 create-vpc \ + --ipv6-cidr-block-network-border-group us-west-2-lax-1 \ + --cidr-block 10.0.0.0/16 Output:: - { - "Vpc": { - "InstanceTenancy": "default", - "State": "pending", - "VpcId": "vpc-a01106c2", - "CidrBlock": "10.0.0.0/16", - "DhcpOptionsId": "dopt-7a8b9c2d" - } - } - -**To create a VPC with dedicated tenancy** - -This example creates a VPC with the specified CIDR block and ``dedicated`` tenancy. + { + "Vpc": { + "CidrBlock": "10.0.0.0/16", + "DhcpOptionsId": "dopt-5EXAMPLE", + "State": "pending", + "VpcId": "vpc-0a60eb65b4EXAMPLE", + "OwnerId": "123456789012", + "InstanceTenancy": "default", + "Ipv6CidrBlockAssociationSet": [], + "CidrBlockAssociationSet": [ + { + "AssociationId": "vpc-cidr-assoc-07501b79ecEXAMPLE", + "CidrBlock": "10.0.0.0/16", + "CidrBlockState": { + "State": "associated" + } + "NetworkBorderGroup": "us-west-2-lax-1" + } + ], + "IsDefault": false, + "Tags": [] + } + } + +**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. + + aws ec2 create-vpc \ + --cidr-block 10.0.0.0/16 \ + --instance-tenancy dedicated -Command:: +Output:: - aws ec2 create-vpc --cidr-block 10.0.0.0/16 --instance-tenancy dedicated + { + "Vpc": { + "CidrBlock": "10.0.0.0/16", + "DhcpOptionsId": "dopt-19edf471", + "State": "pending", + "VpcId": "vpc-0a53287fa4EXAMPLE", + "OwnerId": "111122223333", + "InstanceTenancy": "dedicated", + "Ipv6CidrBlockAssociationSet": [], + "CidrBlockAssociationSet": [ + { + "AssociationId": "vpc-cidr-assoc-00b24cc1c2EXAMPLE", + "CidrBlock": "10.0.0.0/16", + "CidrBlockState": { + "State": "associated" + } + } + ], + "IsDefault": false, + "Tags": [] + } + } + +**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. + + aws ec2 create-vpc \ + --cidr-block 10.0.0.0/16 \ + --amazon-provided-ipv6-cidr-block Output:: - { - "Vpc": { - "InstanceTenancy": "dedicated", - "State": "pending", - "VpcId": "vpc-a01106c2", - "CidrBlock": "10.0.0.0/16", - "DhcpOptionsId": "dopt-7a8b9c2d" - } - } \ No newline at end of file + { + "Vpc": { + "CidrBlock": "10.0.0.0/16", + "DhcpOptionsId": "dopt-dEXAMPLE", + "State": "pending", + "VpcId": "vpc-0fc5e3406bEXAMPLE", + "OwnerId": "123456789012", + "InstanceTenancy": "default", + "Ipv6CidrBlockAssociationSet": [ + { + "AssociationId": "vpc-cidr-assoc-068432c60bEXAMPLE", + "Ipv6CidrBlock": "", + "Ipv6CidrBlockState": { + "State": "associating" + }, + "Ipv6Pool": "Amazon", + "NetworkBorderGroup": "us-west-2" + } + ], + "CidrBlockAssociationSet": [ + { + "AssociationId": "vpc-cidr-assoc-0669f8f9f5EXAMPLE", + "CidrBlock": "10.0.0.0/16", + "CidrBlockState": { + "State": "associated" + } + } + ], + "IsDefault": false, + "Tags": [] + } + } + +For more information, see `Creating a VPC `__ in the *AWS VPC User Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/create-vpn-connection.rst awscli-1.18.69/awscli/examples/ec2/create-vpn-connection.rst --- awscli-1.11.13/awscli/examples/ec2/create-vpn-connection.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-vpn-connection.rst 2020-05-28 19:25:48.000000000 +0000 @@ -10,11 +10,11 @@ { "VpnConnection": { - "VpnConnectionId": "vpn-40f41529" + "VpnConnectionId": "vpn-1a2b3c4d" "CustomerGatewayConfiguration": "...configuration information...", "State": "available", - "VpnGatewayId": "vgw-f211f09b", - "CustomerGatewayId": "cgw-b4de3fdd" + "VpnGatewayId": "vgw-9a4cacf3", + "CustomerGatewayId": "cgw-0e11f167" } } @@ -24,19 +24,39 @@ Command:: - aws ec2 create-vpn-connection --type ipsec.1 --customer-gateway-id cgw-0e11f167 --vpn-gateway-id vgw-9a4cacf3 --options "{\"StaticRoutesOnly\":true}" + aws ec2 create-vpn-connection --type ipsec.1 --customer-gateway-id cgw-1a1a1a1a --vpn-gateway-id vgw-9a4cacf3 --options "{\"StaticRoutesOnly\":true}" Output:: { "VpnConnection": { - "VpnConnectionId": "vpn-40f41529" + "VpnConnectionId": "vpn-11aa33cc" "CustomerGatewayConfiguration": "...configuration information...", "State": "pending", - "VpnGatewayId": "vgw-f211f09b", - "CustomerGatewayId": "cgw-b4de3fdd", + "VpnGatewayId": "vgw-9a4cacf3", + "CustomerGatewayId": "cgw-1a1a1a1a", "Options": { "StaticRoutesOnly": true } } - } \ No newline at end of file + } + +**To create a VPN connection and specify your own inside CIDR and pre-shared key** + +This example creates a VPN connection and specifies the inside IP address CIDR block and a custom pre-shared key for each tunnel. The specified values are returned in the ``CustomerGatewayConfiguration`` information. + +Command:: + + aws ec2 create-vpn-connection --type ipsec.1 --customer-gateway-id cgw-b4de3fdd --vpn-gateway-id vgw-f211f09b --options "{"StaticRoutesOnly":false,"TunnelOptions":[{"TunnelInsideCidr":"169.254.12.0/30","PreSharedKey":"ExamplePreSharedKey1"},{"TunnelInsideCidr":"169.254.13.0/30","PreSharedKey":"ExamplePreSharedKey2"}]}" + +Output:: + + { + "VpnConnection": { + "VpnConnectionId": "vpn-40f41529" + "CustomerGatewayConfiguration": "...configuration information...", + "State": "pending", + "VpnGatewayId": "vgw-f211f09b", + "CustomerGatewayId": "cgw-b4de3fdd" + } + } diff -Nru awscli-1.11.13/awscli/examples/ec2/create-vpn-gateway.rst awscli-1.18.69/awscli/examples/ec2/create-vpn-gateway.rst --- awscli-1.11.13/awscli/examples/ec2/create-vpn-gateway.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/create-vpn-gateway.rst 2020-05-28 19:25:48.000000000 +0000 @@ -10,6 +10,27 @@ { "VpnGateway": { + "AmazonSideAsn": 64512, + "State": "available", + "Type": "ipsec.1", + "VpnGatewayId": "vgw-9a4cacf3", + "VpcAttachments": [] + } + } + +**To create a virtual private gateway with a specific Amazon-side ASN** + +This example creates a virtual private gateway and specifies the Autonomous System Number (ASN) for the Amazon side of the BGP session. + +Command:: + + aws ec2 create-vpn-gateway --type ipsec.1 --amazon-side-asn 65001 + +Output:: + + { + "VpnGateway": { + "AmazonSideAsn": 65001, "State": "available", "Type": "ipsec.1", "VpnGatewayId": "vgw-9a4cacf3", diff -Nru awscli-1.11.13/awscli/examples/ec2/delete-client-vpn-endpoint.rst awscli-1.18.69/awscli/examples/ec2/delete-client-vpn-endpoint.rst --- awscli-1.11.13/awscli/examples/ec2/delete-client-vpn-endpoint.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/delete-client-vpn-endpoint.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,16 @@ +**To delete a Client VPN endpoint** + +The following ``delete-client-vpn-endpoint`` example deletes the specified Client VPN endpoint. :: + + aws ec2 delete-client-vpn-endpoint \ + --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde + +Output:: + + { + "Status": { + "Code": "deleting" + } + } + +For more information, see `Client VPN Endpoints `__ in the *AWS Client VPN Administrator Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/delete-client-vpn-route.rst awscli-1.18.69/awscli/examples/ec2/delete-client-vpn-route.rst --- awscli-1.11.13/awscli/examples/ec2/delete-client-vpn-route.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/delete-client-vpn-route.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To delete a route for a Client VPN endpoint** + +The following ``delete-client-vpn-route`` example deletes the ``0.0.0.0/0`` route for the specified subnet of a Client VPN endpoint. :: + + aws ec2 delete-client-vpn-route \ + --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde \ + --destination-cidr-block 0.0.0.0/0 \ + --target-vpc-subnet-id subnet-0123456789abcabca + +Output:: + + { + "Status": { + "Code": "deleting" + } + } + +For more information, see `Routes `__ in the *AWS Client VPN Administrator Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/delete-egress-only-internet-gateway.rst awscli-1.18.69/awscli/examples/ec2/delete-egress-only-internet-gateway.rst --- awscli-1.11.13/awscli/examples/ec2/delete-egress-only-internet-gateway.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/delete-egress-only-internet-gateway.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,13 @@ +**To delete an egress-only Internet gateway** + +This example deletes the specified egress-only Internet gateway. + +Command:: + + aws ec2 delete-egress-only-internet-gateway --egress-only-internet-gateway-id eigw-01eadbd45ecd7943f + +Output:: + + { + "ReturnCode": true + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/delete-flow-logs.rst awscli-1.18.69/awscli/examples/ec2/delete-flow-logs.rst --- awscli-1.11.13/awscli/examples/ec2/delete-flow-logs.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/delete-flow-logs.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,13 +1,11 @@ **To delete a flow log** -This example deletes flow log ``fl-1a2b3c4d``. +The following ``delete-flow-logs`` example deletes the specified flow log. :: -Command:: - - aws ec2 delete-flow-logs --flow-log-id fl-1a2b3c4d + aws ec2 delete-flow-logs --flow-log-id fl-11223344556677889 Output:: - { - "Unsuccessful": [] - } \ No newline at end of file + { + "Unsuccessful": [] + } diff -Nru awscli-1.11.13/awscli/examples/ec2/delete-fpga-image.rst awscli-1.18.69/awscli/examples/ec2/delete-fpga-image.rst --- awscli-1.11.13/awscli/examples/ec2/delete-fpga-image.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/delete-fpga-image.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,13 @@ +**To delete an Amazon FPGA image** + +This example deletes the specified AFI. + +Command:: + + aws ec2 delete-fpga-image --fpga-image-id afi-06b12350a123fbabc + +Output:: + + { + "Return": true + } diff -Nru awscli-1.11.13/awscli/examples/ec2/delete-launch-template.rst awscli-1.18.69/awscli/examples/ec2/delete-launch-template.rst --- awscli-1.11.13/awscli/examples/ec2/delete-launch-template.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/delete-launch-template.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,20 @@ +**To delete a launch template** + +This example deletes the specified launch template. + +Command:: + + aws ec2 delete-launch-template --launch-template-id lt-0abcd290751193123 + +Output:: + + { + "LaunchTemplate": { + "LatestVersionNumber": 2, + "LaunchTemplateId": "lt-0abcd290751193123", + "LaunchTemplateName": "TestTemplate", + "DefaultVersionNumber": 2, + "CreatedBy": "arn:aws:iam::123456789012:root", + "CreateTime": "2017-11-23T16:46:25.000Z" + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/delete-launch-template-versions.rst awscli-1.18.69/awscli/examples/ec2/delete-launch-template-versions.rst --- awscli-1.11.13/awscli/examples/ec2/delete-launch-template-versions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/delete-launch-template-versions.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,20 @@ +**To delete a launch template version** + +This example deletes the specified launch template version. + +Command:: + + aws ec2 delete-launch-template-versions --launch-template-id lt-0abcd290751193123 --versions 1 + +Output:: + + { + "UnsuccessfullyDeletedLaunchTemplateVersions": [], + "SuccessfullyDeletedLaunchTemplateVersions": [ + { + "LaunchTemplateName": "TestVersion", + "VersionNumber": 1, + "LaunchTemplateId": "lt-0abcd290751193123" + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/delete-local-gateway-route.rst awscli-1.18.69/awscli/examples/ec2/delete-local-gateway-route.rst --- awscli-1.11.13/awscli/examples/ec2/delete-local-gateway-route.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/delete-local-gateway-route.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/delete-network-interface-permission.rst awscli-1.18.69/awscli/examples/ec2/delete-network-interface-permission.rst --- awscli-1.11.13/awscli/examples/ec2/delete-network-interface-permission.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/delete-network-interface-permission.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,13 @@ +**To delete a network interface permission** + +This example deletes the specified network interface permission. + +Command:: + + aws ec2 delete-network-interface-permission --network-interface-permission-id eni-perm-06fd19020ede149ea + +Output:: + + { + "Return": true + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/delete-queued-reserved-instances.rst awscli-1.18.69/awscli/examples/ec2/delete-queued-reserved-instances.rst --- awscli-1.11.13/awscli/examples/ec2/delete-queued-reserved-instances.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/delete-queued-reserved-instances.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To delete a queued purchase** + +The following ``delete-queued-reserved-instances`` example deletes the specified Reserved Instance, which was queued for purchase. :: + + aws ec2 delete-queued-reserved-instances \ + --reserved-instances-ids af9f760e-6f91-4559-85f7-4980eexample + +Output:: + + { + "SuccessfulQueuedPurchaseDeletions": [ + { + "ReservedInstancesId": "af9f760e-6f91-4559-85f7-4980eexample" + } + ], + "FailedQueuedPurchaseDeletions": [] + } diff -Nru awscli-1.11.13/awscli/examples/ec2/delete-tags.rst awscli-1.18.69/awscli/examples/ec2/delete-tags.rst --- awscli-1.11.13/awscli/examples/ec2/delete-tags.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/delete-tags.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,28 +1,27 @@ -**To delete a tag from a resource** +**Example 1: To delete a tag from a resource** -This example deletes the tag ``Stack=Test`` from the specified image. If the command succeeds, no output is returned. +The following ``delete-tags`` example deletes the tag ``Stack=Test`` from the specified image. When you specify both a value and a key name, the tag is deleted only if the tag's value matches the specified value. :: -Command:: + aws ec2 delete-tags \ + --resources ami-1234567890abcdef0 \ + --tags Key=Stack,Value=Test - aws ec2 delete-tags --resources ami-78a54011 --tags Key=Stack,Value=Test +It's optional to specify the value for a tag. The following ``delete-tags`` example deletes the tag with the key name ``purpose`` from the specified instance, regardless of the tag value for the tag. :: + aws ec2 delete-tags \ + --resources i-1234567890abcdef0 \ + --tags Key=purpose -It's optional to specify the value for any tag with a value. If you specify a value for the key, the tag is deleted only if the tag's value matches the one you specified. If you specify the empty string as the value, the tag is deleted only if the tag's value is the empty string. The following example specifies the empty string as the value for the tag to delete. +If you specify the empty string as the tag value, the tag is deleted only if the tag's value is the empty string. The following ``delete-tags`` example specifies the empty string as the tag value for the tag to delete. :: -Command:: - - aws ec2 delete-tags --resources i-1234567890abcdef0 --tags Key=Name,Value= - -This example deletes the tag with the ``purpose`` key from the specified instance, regardless of the tag's value. - -Command:: - - aws ec2 delete-tags --resources i-1234567890abcdef0 --tags Key=purpose + aws ec2 delete-tags \ + --resources i-1234567890abcdef0 \ + --tags Key=Name,Value= -**To delete a tag from multiple resources** +**Example 2: To delete a tag from multiple resources** -This example deletes the ``Purpose=Test`` tag from a specified instance and AMI. The tag's value can be omitted from the command. If the command succeeds, no output is returned. - -Command:: +The following ``delete-tags`` example deletes the tag``Purpose=Test`` from both an instance and an AMI. As shown in the previous example, you can omit the tag value from the command. :: - aws ec2 delete-tags --resources i-1234567890abcdef0 ami-78a54011 --tags Key=Purpose + aws ec2 delete-tags \ + --resources i-1234567890abcdef0 ami-1234567890abcdef0 \ + --tags Key=Purpose diff -Nru awscli-1.11.13/awscli/examples/ec2/delete-traffic-mirror-filter.rst awscli-1.18.69/awscli/examples/ec2/delete-traffic-mirror-filter.rst --- awscli-1.11.13/awscli/examples/ec2/delete-traffic-mirror-filter.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/delete-traffic-mirror-filter.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,14 @@ +**To delete a traffic mirror filter** + +The following ``delete-traffic-mirror-filter`` example deletes the specified traffic mirror filter. :: + + aws ec2 delete-traffic-mirror-filter \ + --traffic-mirror-filter-id tmf-0be0b25fcdEXAMPLE + +Output:: + + { + "TrafficMirrorFilterId": "tmf-0be0b25fcdEXAMPLE" + } + +For more information, see `Delete a Traffic Mirror Filter `__ in the *AWS Traffic Mirroring Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/delete-traffic-mirror-filter-rule.rst awscli-1.18.69/awscli/examples/ec2/delete-traffic-mirror-filter-rule.rst --- awscli-1.11.13/awscli/examples/ec2/delete-traffic-mirror-filter-rule.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/delete-traffic-mirror-filter-rule.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,14 @@ +**To delete a traffic mirror filter rule** + +The following ``delete-traffic-mirror-filter-rule`` example deletes the specified traffic mirror filter rule. :: + + aws ec2 delete-traffic-mirror-filter-rule \ + --traffic-mirror-filter-rule-id tmfr-081f71283bEXAMPLE + +Output:: + + { + "TrafficMirrorFilterRuleId": "tmfr-081f71283bEXAMPLE" + } + +For more information, see `Modify Your Traffic Mirror Filter Rules `__ in the *AWS Traffic Mirroring Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/delete-traffic-mirror-session.rst awscli-1.18.69/awscli/examples/ec2/delete-traffic-mirror-session.rst --- awscli-1.11.13/awscli/examples/ec2/delete-traffic-mirror-session.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/delete-traffic-mirror-session.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,14 @@ +**To delete a traffic mirror session** + +The following ``delete-traffic-mirror-session`` example deletes the specified traffic mirror-session. :: + + aws ec2 delete-traffic-mirror-session \ + --traffic-mirror-session-id tms-0af3141ce5EXAMPLE + +Output:: + + { + "TrafficMirrorSessionId": "tms-0af3141ce5EXAMPLE" + } + +For more information, see `Delete a Traffic Mirror Session `__ in the *AWS Traffic Mirroring Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/delete-traffic-mirror-target.rst awscli-1.18.69/awscli/examples/ec2/delete-traffic-mirror-target.rst --- awscli-1.11.13/awscli/examples/ec2/delete-traffic-mirror-target.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/delete-traffic-mirror-target.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,14 @@ +**To delete a traffic mirror target** + +The following ``delete-traffic-mirror-target`` example deletes the specified traffic mirror target. :: + + aws ec2 delete-traffic-mirror-target \ + --traffic-mirror-target-id tmt-060f48ce9EXAMPLE + +Output:: + + { + "TrafficMirrorTargetId": "tmt-060f48ce9EXAMPLE" + } + +For more information, see `Delete a Traffic Mirror Target `__ in the *AWS Traffic Mirroring Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/delete-transit-gateway-multicast-domain.rst awscli-1.18.69/awscli/examples/ec2/delete-transit-gateway-multicast-domain.rst --- awscli-1.11.13/awscli/examples/ec2/delete-transit-gateway-multicast-domain.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/delete-transit-gateway-multicast-domain.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/delete-transit-gateway-peering-attachment.rst awscli-1.18.69/awscli/examples/ec2/delete-transit-gateway-peering-attachment.rst --- awscli-1.11.13/awscli/examples/ec2/delete-transit-gateway-peering-attachment.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/delete-transit-gateway-peering-attachment.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/delete-transit-gateway-route.rst awscli-1.18.69/awscli/examples/ec2/delete-transit-gateway-route.rst --- awscli-1.11.13/awscli/examples/ec2/delete-transit-gateway-route.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/delete-transit-gateway-route.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,26 @@ +**To delete a CIDR block from a route table** + +The following command deletes the CIDR block from the specified transit gateway route table. :: + + aws ec2 delete-transit-gateway-route \ + --transit-gateway-route-table-id tgw-rtb-0b6f6aaa01EXAMPLE \ + --destination-cidr-block 10.0.2.0/24 + +Output:: + + { + "Route": { + "DestinationCidrBlock": "10.0.2.0/24", + "TransitGatewayAttachments": [ + { + "ResourceId": "vpc-0065acced4EXAMPLE", + "TransitGatewayAttachmentId": "tgw-attach-0b5968d3b6EXAMPLE", + "ResourceType": "vpc" + } + ], + "Type": "static", + "State": "deleted" + } + } + +For more information, see `Delete a Static Route `__ in the *AWS Transit Gateways*. diff -Nru awscli-1.11.13/awscli/examples/ec2/delete-transit-gateway-route-table.rst awscli-1.18.69/awscli/examples/ec2/delete-transit-gateway-route-table.rst --- awscli-1.11.13/awscli/examples/ec2/delete-transit-gateway-route-table.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/delete-transit-gateway-route-table.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To delete a transit gateway route table** + +The following ``delete-transit-gateway-route-table`` example deletes the specified transit gateway route table. :: + + aws ec2 delete-transit-gateway-route-table \ + --transit-gateway-route-table-id tgw-rtb-0b6f6aaa01EXAMPLE + +Output:: + + { + "TransitGatewayRouteTable": { + "TransitGatewayRouteTableId": "tgw-rtb-0b6f6aaa01EXAMPLE", + "TransitGatewayId": "tgw-02f776b1a7EXAMPLE", + "State": "deleting", + "DefaultAssociationRouteTable": false, + "DefaultPropagationRouteTable": false, + "CreationTime": "2019-07-17T20:27:26.000Z" + } + } + +For more information, see `Delete a Transit Gateway Route Table `__ in the *AWS Transit Gateways Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/delete-transit-gateway.rst awscli-1.18.69/awscli/examples/ec2/delete-transit-gateway.rst --- awscli-1.11.13/awscli/examples/ec2/delete-transit-gateway.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/delete-transit-gateway.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,29 @@ +**To delete a transit gateway** + +The following ``delete-transit-gateway`` example deletes the specified transit gateway. :: + + aws ec2 delete-transit-gateway --transit-gateway-id tgw-01f04542b2EXAMPLE + +Output:: + + { + "TransitGateway": { + "TransitGatewayId": "tgw-01f04542b2EXAMPLE", + "State": "deleting", + "OwnerId": "123456789012", + "Description": "Example Transit Gateway", + "CreationTime": "2019-08-27T15:04:35.000Z", + "Options": { + "AmazonSideAsn": 64515, + "AutoAcceptSharedAttachments": "disable", + "DefaultRouteTableAssociation": "enable", + "AssociationDefaultRouteTableId": "tgw-rtb-0ce7a6948fEXAMPLE", + "DefaultRouteTablePropagation": "enable", + "PropagationDefaultRouteTableId": "tgw-rtb-0ce7a6948fEXAMPLE", + "VpnEcmpSupport": "enable", + "DnsSupport": "enable" + } + } + } + +For more information, see `Delete a Transit Gateway`__ in the *AWS Transit Gateways Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/delete-transit-gateway-vpc-attachment.rst awscli-1.18.69/awscli/examples/ec2/delete-transit-gateway-vpc-attachment.rst --- awscli-1.11.13/awscli/examples/ec2/delete-transit-gateway-vpc-attachment.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/delete-transit-gateway-vpc-attachment.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,26 @@ +**To delete a transit gateway VPC attachment** + +The following ``delete-transit-gateway-vpc-attachment`` example deletes the specified transit gateway VPC attachment. :: + + aws ec2 delete-transit-gateway-vpc-attachment \ + --transit-gateway-attachment-id tgw-attach-0d2c54bdbEXAMPLE + +Output:: + + { + "TransitGatewayVpcAttachment": { + "TransitGatewayAttachmentId": "tgw-attach-0d2c54bdb3EXAMPLE", + "TransitGatewayId": "tgw-02f776b1a7EXAMPLE", + "VpcId": "vpc-0065acced4f61c651", + "VpcOwnerId": "111122223333", + "State": "deleting", + "CreationTime": "2019-07-17T16:04:27.000Z" + } + }{ + "Key": { + "Key": + "Value" + } + } + +For more information, see `Delete a VPC Attachment `__ in the *AWS Transit Gateways Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/delete-vpc-endpoint-connection-notifications.rst awscli-1.18.69/awscli/examples/ec2/delete-vpc-endpoint-connection-notifications.rst --- awscli-1.11.13/awscli/examples/ec2/delete-vpc-endpoint-connection-notifications.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/delete-vpc-endpoint-connection-notifications.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,13 @@ +**To delete an endpoint connection notification** + +This example deletes the specified endpoint connection notification. + +Command:: + + aws ec2 delete-vpc-endpoint-connection-notifications --connection-notification-ids vpce-nfn-008776de7e03f5abc + +Output:: + + { + "Unsuccessful": [] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/delete-vpc-endpoint-service-configurations.rst awscli-1.18.69/awscli/examples/ec2/delete-vpc-endpoint-service-configurations.rst --- awscli-1.11.13/awscli/examples/ec2/delete-vpc-endpoint-service-configurations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/delete-vpc-endpoint-service-configurations.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,13 @@ +**To delete an endpoint service configuration** + +This example deletes the specified endpoint service configuration. + +Command:: + + aws ec2 delete-vpc-endpoint-service-configurations --service-ids vpce-svc-03d5ebb7d9579a2b3 + +Output:: + + { + "Unsuccessful": [] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/deprovision-byoip-cidr.rst awscli-1.18.69/awscli/examples/ec2/deprovision-byoip-cidr.rst --- awscli-1.11.13/awscli/examples/ec2/deprovision-byoip-cidr.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/deprovision-byoip-cidr.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,15 @@ +**To remove an IP address range from use** + +The following example removes the specified address range from use with AWS. :: + + aws ec2 deprovision-byoip-cidr \ + --cidr 203.0.113.25/24 + +Output:: + + { + "ByoipCidr": { + "Cidr": "203.0.113.25/24", + "State": "pending-deprovision" + } + } diff -Nru awscli-1.11.13/awscli/examples/ec2/deregister-transit-gateway-multicast-group-members.rst awscli-1.18.69/awscli/examples/ec2/deregister-transit-gateway-multicast-group-members.rst --- awscli-1.11.13/awscli/examples/ec2/deregister-transit-gateway-multicast-group-members.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/deregister-transit-gateway-multicast-group-members.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/deregister-transit-gateway-multicast-group-source.rst awscli-1.18.69/awscli/examples/ec2/deregister-transit-gateway-multicast-group-source.rst --- awscli-1.11.13/awscli/examples/ec2/deregister-transit-gateway-multicast-group-source.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/deregister-transit-gateway-multicast-group-source.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/describe-addresses.rst awscli-1.18.69/awscli/examples/ec2/describe-addresses.rst --- awscli-1.11.13/awscli/examples/ec2/describe-addresses.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-addresses.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,63 +1,64 @@ -**To describe your Elastic IP addresses** +**Example 1: To retrieve details about all of your Elastic IP addresses** -This example describes your Elastic IP addresses. +The following ``describe addresses`` example displays details about your Elastic IP addresses. :: -Command:: - - aws ec2 describe-addresses + aws ec2 describe-addresses Output:: - { - "Addresses": [ - { - "InstanceId": "i-1234567890abcdef0", - "PublicIp": "198.51.100.0", - "Domain": "standard" - }, - { - "Domain": "vpc", - "InstanceId": "i-1234567890abcdef0", - "NetworkInterfaceId": "eni-12345678", - "AssociationId": "eipassoc-12345678", - "NetworkInterfaceOwnerId": "123456789012", - "PublicIp": "203.0.113.0", - "AllocationId": "eipalloc-12345678", - "PrivateIpAddress": "10.0.1.241" - } - ] - } - -**To describe your Elastic IP addresses for EC2-VPC** + { + "Addresses": [ + { + "InstanceId": "i-1234567890abcdef0", + "PublicIp": "198.51.100.0", + "PublicIpv4Pool": "amazon", + "Domain": "standard" + }, + { + "Domain": "vpc", + "PublicIpv4Pool": "amazon", + "InstanceId": "i-1234567890abcdef0", + "NetworkInterfaceId": "eni-12345678", + "AssociationId": "eipassoc-12345678", + "NetworkInterfaceOwnerId": "123456789012", + "PublicIp": "203.0.113.0", + "AllocationId": "eipalloc-12345678", + "PrivateIpAddress": "10.0.1.241" + } + ] + } -This example describes your Elastic IP addresses for use with instances in a VPC. +**Example 2: To retrieve details your Elastic IP addresses for EC2-VPC** -Command:: +The following ``describe-addresses`` example displays details about your Elastic IP addresses for use with instances in a VPC. :: - aws ec2 describe-addresses --filters "Name=domain,Values=vpc" + aws ec2 describe-addresses \ + --filters "Name=domain,Values=vpc" Output:: - { - "Addresses": [ - { - "Domain": "vpc", - "InstanceId": "i-1234567890abcdef0", - "NetworkInterfaceId": "eni-12345678", - "AssociationId": "eipassoc-12345678", - "NetworkInterfaceOwnerId": "123456789012", - "PublicIp": "203.0.113.0", - "AllocationId": "eipalloc-12345678", - "PrivateIpAddress": "10.0.1.241" - } - ] - } + { + "Addresses": [ + { + "Domain": "vpc", + "PublicIpv4Pool": "amazon", + "InstanceId": "i-1234567890abcdef0", + "NetworkInterfaceId": "eni-12345678", + "AssociationId": "eipassoc-12345678", + "NetworkInterfaceOwnerId": "123456789012", + "PublicIp": "203.0.113.0", + "AllocationId": "eipalloc-12345678", + "PrivateIpAddress": "10.0.1.241" + } + ] + } -This example describes the Elastic IP address with the allocation ID ``eipalloc-282d9641``, which is associated with an instance in EC2-VPC. +**Example 3: To retrieve details about an Elastic IP address specified by allocation ID** -Command:: +The following ``describe-addresses`` example displays details about the Elastic IP address with the specified allocation ID, which is associated with an instance in EC2-VPC. :: - aws ec2 describe-addresses --allocation-ids eipalloc-282d9641 + aws ec2 describe-addresses \ + --allocation-ids eipalloc-282d9641 Output:: @@ -65,6 +66,7 @@ "Addresses": [ { "Domain": "vpc", + "PublicIpv4Pool": "amazon", "InstanceId": "i-1234567890abcdef0", "NetworkInterfaceId": "eni-1a2b3c4d", "AssociationId": "eipassoc-123abc12", @@ -76,19 +78,19 @@ ] } -This example describes the Elastic IP address associated with a particular private IP address in EC2-VPC. - -Command:: +**Example 4: To retrieve details about an Elastic IP address specified by its VPC private IP address** - aws ec2 describe-addresses --filters "Name=private-ip-address,Values=10.251.50.12" +The following ``describe-addresses`` example displays details about the Elastic IP address associated with a particular private IP address in EC2-VPC. :: -**To describe your Elastic IP addresses in EC2-Classic** + aws ec2 describe-addresses \ + --filters "Name=private-ip-address,Values=10.251.50.12" -This example describes your Elastic IP addresses for use in EC2-Classic. +**Example 5: To retrieve details about Elastic IP addresses in EC2-Classic** -Command:: +TThe following ``describe-addresses`` example displays details about your Elastic IP addresses for use in EC2-Classic. :: - aws ec2 describe-addresses --filters "Name=domain,Values=standard" + aws ec2 describe-addresses \ + --filters "Name=domain,Values=standard" Output:: @@ -97,16 +99,18 @@ { "InstanceId": "i-1234567890abcdef0", "PublicIp": "203.0.110.25", + "PublicIpv4Pool": "amazon", "Domain": "standard" } ] } -This example describes the Elastic IP address with the value ``203.0.110.25``, which is associated with an instance in EC2-Classic. +**Example 6: To retrieve details about an Elastic IP addresses specified by its public IP address** -Command:: +The following ``describe-addresses`` example displays details about the Elastic IP address with the value ``203.0.110.25``, which is associated with an instance in EC2-Classic. :: - aws ec2 describe-addresses --public-ips 203.0.110.25 + aws ec2 describe-addresses \ + --public-ips 203.0.110.25 Output:: @@ -115,6 +119,7 @@ { "InstanceId": "i-1234567890abcdef0", "PublicIp": "203.0.110.25", + "PublicIpv4Pool": "amazon", "Domain": "standard" } ] diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-aggregate-id-format.rst awscli-1.18.69/awscli/examples/ec2/describe-aggregate-id-format.rst --- awscli-1.11.13/awscli/examples/ec2/describe-aggregate-id-format.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-aggregate-id-format.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,29 @@ +**To describe the longer ID format settings for all resource types in a Region** + +The following ``describe-aggregate-id-format`` example describes the overall long ID format status for the current Region. The ``Deadline`` value indicates that the deadlines for these resources to permanently switch from the short ID format to the long ID format expired. The ``UseLongIdsAggregated`` value indicates that all IAM users and IAM roles are configured to use long ID format for all resource types. :: + + aws ec2 describe-aggregate-id-format + +Output:: + + { + "UseLongIdsAggregated": true, + "Statuses": [ + { + "Deadline": "2018-08-13T02:00:00.000Z", + "Resource": "network-interface-attachment", + "UseLongIds": true + }, + { + "Deadline": "2016-12-13T02:00:00.000Z", + "Resource": "instance", + "UseLongIds": true + }, + { + "Deadline": "2018-08-13T02:00:00.000Z", + "Resource": "elastic-ip-association", + "UseLongIds": true + }, + ... + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-availability-zones.rst awscli-1.18.69/awscli/examples/ec2/describe-availability-zones.rst --- awscli-1.11.13/awscli/examples/ec2/describe-availability-zones.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-availability-zones.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,32 +1,62 @@ **To describe your Availability Zones** -This 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. :: -Command:: - - aws ec2 describe-availability-zones + aws ec2 describe-availability-zones Output:: - { - "AvailabilityZones": [ - { - "State": "available", - "RegionName": "us-east-1", - "Messages": [], - "ZoneName": "us-east-1b" - }, - { - "State": "available", - "RegionName": "us-east-1", - "Messages": [], - "ZoneName": "us-east-1c" - }, - { - "State": "available", - "RegionName": "us-east-1", - "Messages": [], - "ZoneName": "us-east-1d" - } - ] - } + { + "AvailabilityZones": [ + { + "State": "available", + "OptInStatus": "opt-in-not-required", + "Messages": [], + "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-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-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.11.13/awscli/examples/ec2/describe-byoip-cidrs.rst awscli-1.18.69/awscli/examples/ec2/describe-byoip-cidrs.rst --- awscli-1.11.13/awscli/examples/ec2/describe-byoip-cidrs.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-byoip-cidrs.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To describe your provisioned address ranges** + +The following ``describe-byoip-cidrs`` example displays details about the public IPv4 address ranges that you provisioned for use by AWS. :: + + aws ec2 describe-byoip-cidrs + +Output:: + + { + "ByoipCidrs": [ + { + "Cidr": "203.0.113.25/24", + "StatusMessage": "ipv4pool-ec2-1234567890abcdef0", + "State": "provisioned" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-capacity-reservations.rst awscli-1.18.69/awscli/examples/ec2/describe-capacity-reservations.rst --- awscli-1.11.13/awscli/examples/ec2/describe-capacity-reservations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-capacity-reservations.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,76 @@ +**Example 1: To describe one or more of your capacity reservations** + +The following ``describe-capacity-reservations`` example displays details about all of your capacity reservations in the current AWS Region. :: + + aws ec2 describe-capacity-reservations + +Output:: + + { + "CapacityReservations": [ + { + "CapacityReservationId": "cr-1234abcd56EXAMPLE ", + "EndDateType": "unlimited", + "AvailabilityZone": "eu-west-1a", + "InstanceMatchCriteria": "open", + "Tags": [], + "EphemeralStorage": false, + "CreateDate": "2019-08-16T09:03:18.000Z", + "AvailableInstanceCount": 1, + "InstancePlatform": "Linux/UNIX", + "TotalInstanceCount": 1, + "State": "active", + "Tenancy": "default", + "EbsOptimized": true, + "InstanceType": "a1.medium" + }, + { + "CapacityReservationId": "cr-abcdEXAMPLE9876ef ", + "EndDateType": "unlimited", + "AvailabilityZone": "eu-west-1a", + "InstanceMatchCriteria": "open", + "Tags": [], + "EphemeralStorage": false, + "CreateDate": "2019-08-07T11:34:19.000Z", + "AvailableInstanceCount": 3, + "InstancePlatform": "Linux/UNIX", + "TotalInstanceCount": 3, + "State": "cancelled", + "Tenancy": "default", + "EbsOptimized": true, + "InstanceType": "m5.large" + } + ] + } + +**Example 2: To describe one or more of your capacity reservations** + +The following ``describe-capacity-reservations`` example displays details about the specified capacity reservation. :: + + aws ec2 describe-capacity-reservations \ + --capacity-reserveration-id cr-1234abcd56EXAMPLE + +Output:: + + { + "CapacityReservations": [ + { + "CapacityReservationId": "cr-1234abcd56EXAMPLE", + "EndDateType": "unlimited", + "AvailabilityZone": "eu-west-1a", + "InstanceMatchCriteria": "open", + "Tags": [], + "EphemeralStorage": false, + "CreateDate": "2019-08-16T09:03:18.000Z", + "AvailableInstanceCount": 1, + "InstancePlatform": "Linux/UNIX", + "TotalInstanceCount": 1, + "State": "active", + "Tenancy": "default", + "EbsOptimized": true, + "InstanceType": "a1.medium" + } + ] + } + +For more information, see `Viewing a Capacity Reservation `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-client-vpn-authorization-rules.rst awscli-1.18.69/awscli/examples/ec2/describe-client-vpn-authorization-rules.rst --- awscli-1.11.13/awscli/examples/ec2/describe-client-vpn-authorization-rules.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-client-vpn-authorization-rules.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,24 @@ +**To describe the authorization rules for a Client VPN endpoint** + +The following ``describe-client-vpn-authorization-rules`` example displays details about the authorization rules for the specified Client VPN endpoint. :: + + aws ec2 describe-client-vpn-authorization-rules \ + --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde + +Output:: + + { + "AuthorizationRules": [ + { + "ClientVpnEndpointId": "cvpn-endpoint-123456789123abcde", + "GroupId": "", + "AccessAll": true, + "DestinationCidr": "0.0.0.0/0", + "Status": { + "Code": "active" + } + } + ] + } + +For more information, see `Authorization Rules `__ in the *AWS Client VPN Administrator Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-client-vpn-connections.rst awscli-1.18.69/awscli/examples/ec2/describe-client-vpn-connections.rst --- awscli-1.11.13/awscli/examples/ec2/describe-client-vpn-connections.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-client-vpn-connections.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,47 @@ +**To describe the connections to a Client VPN endpoint** + +The following ``describe-client-vpn-connections`` example displays details about the client connections to the specified Client VPN endpoint. :: + + aws ec2 describe-client-vpn-connections \ + --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde + +Output:: + + { + "Connections": [ + { + "ClientVpnEndpointId": "cvpn-endpoint-123456789123abcde", + "Timestamp": "2019-08-12 07:58:34", + "ConnectionId": "cvpn-connection-0e03eb24267165acd", + "ConnectionEstablishedTime": "2019-08-12 07:57:14", + "IngressBytes": "32302", + "EgressBytes": "5696", + "IngressPackets": "332", + "EgressPackets": "67", + "ClientIp": "172.31.0.225", + "CommonName": "client1.domain.tld", + "Status": { + "Code": "terminated" + }, + "ConnectionEndTime": "2019-08-12 07:58:34" + }, + { + "ClientVpnEndpointId": "cvpn-endpoint-123456789123abcde", + "Timestamp": "2019-08-12 08:02:54", + "ConnectionId": "cvpn-connection-00668867a40f18253", + "ConnectionEstablishedTime": "2019-08-12 08:02:53", + "IngressBytes": "2951", + "EgressBytes": "2611", + "IngressPackets": "9", + "EgressPackets": "6", + "ClientIp": "172.31.0.226", + "CommonName": "client1.domain.tld", + "Status": { + "Code": "active" + }, + "ConnectionEndTime": "-" + } + ] + } + +For more information, see `Client Connections `__ in the *AWS Client VPN Administrator Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-client-vpn-endpoints.rst awscli-1.18.69/awscli/examples/ec2/describe-client-vpn-endpoints.rst --- awscli-1.11.13/awscli/examples/ec2/describe-client-vpn-endpoints.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-client-vpn-endpoints.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,46 @@ +**To describe your Client VPN endpoints** + +The following example displays details about all of your Client VPN endpoints. :: + + aws ec2 describe-client-vpn-endpoints + +Output:: + + { + "ClientVpnEndpoints": [ + { + "ClientVpnEndpointId": "cvpn-endpoint-123456789123abcde", + "Description": "", + "Status": { + "Code": "available" + }, + "CreationTime": "2019-07-08T11:37:27", + "DnsName": "*.cvpn-endpoint-123456789123abcde.prod.clientvpn.ap-south-1.amazonaws.com", + "ClientCidrBlock": "172.31.0.0/16", + "DnsServers": [ + "8.8.8.8" + ], + "SplitTunnel": false, + "VpnProtocol": "openvpn", + "TransportProtocol": "udp", + "ServerCertificateArn": "arn:aws:acm:ap-south-1:123456789012:certificate/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "AuthenticationOptions": [ + { + "Type": "certificate-authentication", + "MutualAuthentication": { + "ClientRootCertificateChain": "arn:aws:acm:ap-south-1:123456789012:certificate/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE" + } + } + ], + "ConnectionLogOptions": { + "Enabled": false + }, + "Tags": [ + { + "Key": "Name", + "Value": "Client VPN" + } + ] + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-client-vpn-routes.rst awscli-1.18.69/awscli/examples/ec2/describe-client-vpn-routes.rst --- awscli-1.11.13/awscli/examples/ec2/describe-client-vpn-routes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-client-vpn-routes.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,36 @@ +**To describe the routes for a Client VPN endpoint** + +The following ``describe-client-vpn-routes`` example displays details about the routes for the specified Client VPN endpoint. :: + + aws ec2 describe-client-vpn-routes \ + --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde + +Output:: + + { + "Routes": [ + { + "ClientVpnEndpointId": "cvpn-endpoint-123456789123abcde", + "DestinationCidr": "10.0.0.0/16", + "TargetSubnet": "subnet-0123456789abcabca", + "Type": "Nat", + "Origin": "associate", + "Status": { + "Code": "active" + }, + "Description": "Default Route" + }, + { + "ClientVpnEndpointId": "cvpn-endpoint-123456789123abcde", + "DestinationCidr": "0.0.0.0/0", + "TargetSubnet": "subnet-0123456789abcabca", + "Type": "Nat", + "Origin": "add-route", + "Status": { + "Code": "active" + } + } + ] + } + +For more information, see `Routes `__ in the *AWS Client VPN Administrator Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-client-vpn-target-networks.rst awscli-1.18.69/awscli/examples/ec2/describe-client-vpn-target-networks.rst --- awscli-1.11.13/awscli/examples/ec2/describe-client-vpn-target-networks.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-client-vpn-target-networks.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,27 @@ +**To describe the target networks for a Client VPN endpoint** + +The following ``describe-client-vpn-target-networks`` example displays details about the target networks for the specified Client VPN endpoint. :: + + aws ec2 describe-client-vpn-target-networks \ + --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde + +Output:: + + { + "ClientVpnTargetNetworks": [ + { + "AssociationId": "cvpn-assoc-012e837060753dc3d", + "VpcId": "vpc-11111222222333333", + "TargetNetworkId": "subnet-0123456789abcabca", + "ClientVpnEndpointId": "cvpn-endpoint-123456789123abcde", + "Status": { + "Code": "associating" + }, + "SecurityGroups": [ + "sg-012345678910abcab" + ] + } + ] + } + +For more information, see `Target Networks `__ in the *AWS Client VPN Administrator Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-dhcp-options.rst awscli-1.18.69/awscli/examples/ec2/describe-dhcp-options.rst --- awscli-1.11.13/awscli/examples/ec2/describe-dhcp-options.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-dhcp-options.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,37 +1,58 @@ -**To describe your DHCP options sets** +**To describe your DHCP options** -This example describes your DHCP options sets. +The following ``describe-dhcp-options`` example retrieves details about your DHCP options. :: -Command:: - - aws ec2 describe-dhcp-options + aws ec2 describe-dhcp-options Output:: - { - "DhcpOptions": [ - { - "DhcpConfigurations": [ - { - "Values": [ - "10.2.5.2", - "10.2.5.1" - ], - "Key": "domain-name-servers" - } - ], - "DhcpOptionsId": "dopt-d9070ebb" - }, - { - "DhcpConfigurations": [ - { - "Values": [ - "AmazonProvidedDNS" - ], - "Key": "domain-name-servers" - } - ], - "DhcpOptionsId": "dopt-7a8b9c2d" - } - ] - } \ No newline at end of file + { + "DhcpOptions": [ + { + "DhcpConfigurations": [ + { + "Key": "domain-name", + "Values": [ + { + "Value": "us-east-2.compute.internal" + } + ] + }, + { + "Key": "domain-name-servers", + "Values": [ + { + "Value": "AmazonProvidedDNS" + } + ] + } + ], + "DhcpOptionsId": "dopt-19edf471", + "OwnerId": "111122223333" + }, + { + "DhcpConfigurations": [ + { + "Key": "domain-name", + "Values": [ + { + "Value": "us-east-2.compute.internal" + } + ] + }, + { + "Key": "domain-name-servers", + "Values": [ + { + "Value": "AmazonProvidedDNS" + } + ] + } + ], + "DhcpOptionsId": "dopt-fEXAMPLE", + "OwnerId": "111122223333" + } + ] + } + +For more information, see `Working with DHCP Option Sets `__ in the *AWS VPC User Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-egress-only-internet-gateways.rst awscli-1.18.69/awscli/examples/ec2/describe-egress-only-internet-gateways.rst --- awscli-1.11.13/awscli/examples/ec2/describe-egress-only-internet-gateways.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-egress-only-internet-gateways.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,23 @@ +**To describe your egress-only Internet gateways** + +This example describes your egress-only Internet gateways. + +Command:: + + aws ec2 describe-egress-only-internet-gateways + +Output:: + + { + "EgressOnlyInternetGateways": [ + { + "EgressOnlyInternetGatewayId": "eigw-015e0e244e24dfe8a", + "Attachments": [ + { + "State": "attached", + "VpcId": "vpc-0c62a468" + } + ] + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-elastic-gpus.rst awscli-1.18.69/awscli/examples/ec2/describe-elastic-gpus.rst --- awscli-1.11.13/awscli/examples/ec2/describe-elastic-gpus.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-elastic-gpus.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,5 @@ +**To describe an Elastic GPU** + +Command:: + + aws ec2 describe-elastic-gpus --elastic-gpu-ids egpu-12345678901234567890abcdefghijkl \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-export-image-tasks.rst awscli-1.18.69/awscli/examples/ec2/describe-export-image-tasks.rst --- awscli-1.11.13/awscli/examples/ec2/describe-export-image-tasks.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-export-image-tasks.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,38 @@ +**To monitor an export image task** + +The following ``describe-export-image-tasks`` example checks the status of the specified export image task. :: + + aws ec2 describe-export-image-tasks \ + --export-image-task-id export-ami-1234567890abcdef0 + +Output for an export image task that is in progress:: + + { + "ExportImageTasks": [ + { + "ExportImageTaskId": "export-ami-1234567890abcdef0" + "Progress": "21", + "S3ExportLocation": { + "S3Bucket": "my-export-bucket", + "S3Prefix": "exports/" + }, + "Status": "active", + "StatusMessage": "updating" + } + ] + } + +Output for an export image task that is completed. The resulting image file in Amazon S3 is ``my-export-bucket/exports/export-ami-1234567890abcdef0.vmdk``. :: + + { + "ExportImageTasks": [ + { + "ExportImageTaskId": "export-ami-1234567890abcdef0" + "S3ExportLocation": { + "S3Bucket": "my-export-bucket", + "S3Prefix": "exports/" + }, + "Status": "completed" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-fast-snapshot-restores.rst awscli-1.18.69/awscli/examples/ec2/describe-fast-snapshot-restores.rst --- awscli-1.11.13/awscli/examples/ec2/describe-fast-snapshot-restores.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-fast-snapshot-restores.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/describe-flow-logs.rst awscli-1.18.69/awscli/examples/ec2/describe-flow-logs.rst --- awscli-1.11.13/awscli/examples/ec2/describe-flow-logs.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-flow-logs.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,29 +1,44 @@ -**To describe flow logs** +**Example 1: To describe all of your flow logs** -This example describes all of your flow logs. +The following ``describe-flow-logs`` example displays details for all of your flow logs. :: -Command:: - - aws ec2 describe-flow-logs + aws ec2 describe-flow-logs Output:: - { - "FlowLogs": [ - { - "ResourceId": "eni-11aa22bb", - "CreationTime": "2015-06-12T14:41:15Z", - "LogGroupName": "MyFlowLogs", - "TrafficType": "ALL", - "FlowLogStatus": "ACTIVE", - "FlowLogId": "fl-1a2b3c4d", - "DeliverLogsPermissionArn": "arn:aws:iam::123456789101:role/flow-logs-role" - } - ] - } - -This example uses a filter to describe only flow logs that are in the log group ``MyFlowLogs`` in Amazon CloudWatch Logs. - -Command:: - - aws ec2 describe-flow-logs --filter "Name=log-group-name,Values=MyFlowLogs" \ No newline at end of file + { + "FlowLogs": [ + { + "CreationTime": "2018-02-21T13:22:12.644Z", + "DeliverLogsPermissionArn": "arn:aws:iam::123456789012:role/flow-logs-role", + "DeliverLogsStatus": "SUCCESS", + "FlowLogId": "fl-aabbccdd112233445", + "MaxAggregationInterval": 600, + "FlowLogStatus": "ACTIVE", + "LogGroupName": "FlowLogGroup", + "ResourceId": "subnet-12345678901234567", + "TrafficType": "ALL", + "LogDestinationType": "cloud-watch-logs", + "LogFormat": "${version} ${account-id} ${interface-id} ${srcaddr} ${dstaddr} ${srcport} ${dstport} ${protocol} ${packets} ${bytes} ${start} ${end} ${action} ${log-status}" + }, + { + "CreationTime": "2020-02-04T15:22:29.986Z", + "DeliverLogsStatus": "SUCCESS", + "FlowLogId": "fl-01234567890123456", + "MaxAggregationInterval": 60, + "FlowLogStatus": "ACTIVE", + "ResourceId": "vpc-00112233445566778", + "TrafficType": "ACCEPT", + "LogDestinationType": "s3", + "LogDestination": "arn:aws:s3:::my-flow-log-bucket/custom", + "LogFormat": "${version} ${vpc-id} ${subnet-id} ${instance-id} ${interface-id} ${account-id} ${type} ${srcaddr} ${dstaddr} ${srcport} ${dstport} ${pkt-srcaddr} ${pkt-dstaddr} ${protocol} ${bytes} ${packets} ${start} ${end} ${action} ${tcp-flags} ${log-status}" + } + ] + } + +**Example 2: To describe a subset of your flow logs** + +The following ``describe-flow-logs`` example uses a filter to display details for only those flow logs that are in the specified log group in Amazon CloudWatch Logs. :: + + aws ec2 describe-flow-logs \ + --filter "Name=log-group-name,Values=MyFlowLogs" diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-fpga-image-attribute.rst awscli-1.18.69/awscli/examples/ec2/describe-fpga-image-attribute.rst --- awscli-1.11.13/awscli/examples/ec2/describe-fpga-image-attribute.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-fpga-image-attribute.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,20 @@ +**To describe the attributes of an Amazon FPGA image** + +This example describes the load permissions for the specified AFI. + +Command:: + + aws ec2 describe-fpga-image-attribute --fpga-image-id afi-0d123e123bfc85abc --attribute loadPermission + +Output:: + + { + "FpgaImageAttribute": { + "FpgaImageId": "afi-0d123e123bfc85abc", + "LoadPermissions": [ + { + "UserId": "123456789012" + } + ] + } + } diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-fpga-images.rst awscli-1.18.69/awscli/examples/ec2/describe-fpga-images.rst --- awscli-1.11.13/awscli/examples/ec2/describe-fpga-images.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-fpga-images.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,34 @@ +**To describe Amazon FPGA images** + +This example describes AFIs that are owned by account ``123456789012``. + +Command:: + + aws ec2 describe-fpga-images --filters Name=owner-id,Values=123456789012 + +Output:: + + { + "FpgaImages": [ + { + "UpdateTime": "2017-12-22T12:09:14.000Z", + "Name": "my-afi", + "PciId": { + "SubsystemVendorId": "0xfedd", + "VendorId": "0x1d0f", + "DeviceId": "0xf000", + "SubsystemId": "0x1d51" + }, + "FpgaImageGlobalId": "agfi-123cb27b5e84a0abc", + "Public": false, + "State": { + "Code": "available" + }, + "ShellVersion": "0x071417d3", + "OwnerId": "123456789012", + "FpgaImageId": "afi-0d123e123bfc85abc", + "CreateTime": "2017-12-22T11:43:33.000Z", + "Description": "my-afi" + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-host-reservation-offerings.rst awscli-1.18.69/awscli/examples/ec2/describe-host-reservation-offerings.rst --- awscli-1.11.13/awscli/examples/ec2/describe-host-reservation-offerings.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-host-reservation-offerings.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,62 @@ +**To describe Dedicated Host Reservation offerings** + +This example describes the Dedicated Host Reservations for the M4 instance family that are available to purchase. + +Command:: + + aws ec2 describe-host-reservation-offerings --filter Name=instance-family,Values=m4 + +Output:: + + { + "OfferingSet": [ + { + "HourlyPrice": "1.499", + "OfferingId": "hro-03f707bf363b6b324", + "InstanceFamily": "m4", + "PaymentOption": "NoUpfront", + "UpfrontPrice": "0.000", + "Duration": 31536000 + }, + { + "HourlyPrice": "1.045", + "OfferingId": "hro-0ef9181cabdef7a02", + "InstanceFamily": "m4", + "PaymentOption": "NoUpfront", + "UpfrontPrice": "0.000", + "Duration": 94608000 + }, + { + "HourlyPrice": "0.714", + "OfferingId": "hro-04567a15500b92a51", + "InstanceFamily": "m4", + "PaymentOption": "PartialUpfront", + "UpfrontPrice": "6254.000", + "Duration": 31536000 + }, + { + "HourlyPrice": "0.484", + "OfferingId": "hro-0d5d7a9d23ed7fbfe", + "InstanceFamily": "m4", + "PaymentOption": "PartialUpfront", + "UpfrontPrice": "12720.000", + "Duration": 94608000 + }, + { + "HourlyPrice": "0.000", + "OfferingId": "hro-05da4108ca998c2e5", + "InstanceFamily": "m4", + "PaymentOption": "AllUpfront", + "UpfrontPrice": "23913.000", + "Duration": 94608000 + }, + { + "HourlyPrice": "0.000", + "OfferingId": "hro-0a9f9be3b95a3dc8f", + "InstanceFamily": "m4", + "PaymentOption": "AllUpfront", + "UpfrontPrice": "12257.000", + "Duration": 31536000 + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-host-reservations.rst awscli-1.18.69/awscli/examples/ec2/describe-host-reservations.rst --- awscli-1.11.13/awscli/examples/ec2/describe-host-reservations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-host-reservations.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,30 @@ +**To describe Dedicated Host Reservations in your account** + +This example describes the Dedicated Host Reservations in your account. + +Command:: + + aws ec2 describe-host-reservations + +Output:: + + { + "HostReservationSet": [ + { + "Count": 1, + "End": "2019-01-10T12:14:09Z", + "HourlyPrice": "1.499", + "InstanceFamily": "m4", + "OfferingId": "hro-03f707bf363b6b324", + "PaymentOption": "NoUpfront", + "State": "active", + "HostIdSet": [ + "h-013abcd2a00cbd123" + ], + "Start": "2018-01-10T12:14:09Z", + "HostReservationId": "hr-0d418a3a4ffc669ae", + "UpfrontPrice": "0.000", + "Duration": 31536000 + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-hosts.rst awscli-1.18.69/awscli/examples/ec2/describe-hosts.rst --- awscli-1.11.13/awscli/examples/ec2/describe-hosts.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-hosts.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,61 +1,45 @@ -**To describe Dedicated hosts in your account and generate a machine-readable list** +**To view details about Dedicated Hosts** -To output a list of Dedicated host IDs in JSON (comma separated). +The following ``describe-hosts`` example displays details for the ``available`` Dedicated Hosts in your AWS account. :: -Command:: - - aws ec2 describe-hosts --query 'Hosts[].HostId' --output json + aws ec2 describe-hosts --filter "Name=state,Values=available" Output:: - [ - "h-085664df5899941c", - "h-056c1b0724170dc38" - ] - -To output a list of Dedicated host IDs in plaintext (comma separated). - -Command:: - - aws ec2 describe-hosts --query 'Hosts[].HostId' --output text - -Output:: -h-085664df5899941c -h-056c1b0724170dc38 - -**To describe available Dedicated hosts in your account** - -Command:: - - aws ec2 describe-hosts --filter "Name=state,Values=available" - -Output:: + { + "Hosts": [ + { + "HostId": "h-07879acf49EXAMPLE", + "Tags": [ + { + "Value": "production", + "Key": "purpose" + } + ], + "HostProperties": { + "Cores": 48, + "TotalVCpus": 96, + "InstanceType": "m5.large", + "Sockets": 2 + }, + "Instances": [], + "State": "available", + "AvailabilityZone": "eu-west-1a", + "AvailableCapacity": { + "AvailableInstanceCapacity": [ + { + "AvailableCapacity": 48, + "InstanceType": "m5.large", + "TotalCapacity": 48 + } + ], + "AvailableVCpus": 96 + }, + "HostRecovery": "on", + "AllocationTime": "2019-08-19T08:57:44.000Z", + "AutoPlacement": "off" + } + ] + } - { - "Hosts": [ - { - "HostId": "h-085664df5899941c" - "HostProperties: { - "Cores": 20, - "Sockets": 2, - "InstanceType": "m3.medium". - "TotalVCpus": 32 - }, - "Instances": [], - "State": "available", - "AvailabilityZone": "us-east-1b", - "AvailableCapacity": { - "AvailableInstanceCapacity": [ - { - "AvailableCapacity": 32, - "InstanceType": "m3.medium", - "TotalCapacity": 32 - } - ], - "AvailableVCpus": 32 - }, - "AutoPlacement": "off" - } - ] - } - +For more information, see `Viewing Dedicated Hosts `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-iam-instance-profile-associations.rst awscli-1.18.69/awscli/examples/ec2/describe-iam-instance-profile-associations.rst --- awscli-1.11.13/awscli/examples/ec2/describe-iam-instance-profile-associations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-iam-instance-profile-associations.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,32 @@ +**To describe IAM instance profile associations** + +This example describes all of your IAM instance profile associations. + +Command:: + + aws ec2 describe-iam-instance-profile-associations + +Output:: + + { + "IamInstanceProfileAssociations": [ + { + "InstanceId": "i-09eb09efa73ec1dee", + "State": "associated", + "AssociationId": "iip-assoc-0db249b1f25fa24b8", + "IamInstanceProfile": { + "Id": "AIPAJVQN4F5WVLGCJDRGM", + "Arn": "arn:aws:iam::123456789012:instance-profile/admin-role" + } + }, + { + "InstanceId": "i-0402909a2f4dffd14", + "State": "associating", + "AssociationId": "iip-assoc-0d1ec06278d29f44a", + "IamInstanceProfile": { + "Id": "AGJAJVQN4F5WVLGCJABCM", + "Arn": "arn:aws:iam::123456789012:instance-profile/user1-role" + } + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-identity-id-format.rst awscli-1.18.69/awscli/examples/ec2/describe-identity-id-format.rst --- awscli-1.11.13/awscli/examples/ec2/describe-identity-id-format.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-identity-id-format.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,37 +1,39 @@ **To describe the ID format for an IAM role** -This example describes the ID format of the ``instance`` resource for the IAM role ``EC2Role`` in your AWS account. The output indicates that instances are enabled for longer IDs - instances created by this role receive longer IDs. +The following ``describe-identity-id-format`` example describes the ID format received by instances created by the IAM role ``EC2Role`` in your AWS account. :: -Command:: - - aws ec2 describe-identity-id-format --principal-arn arn:aws:iam::123456789012:role/EC2Role --resource instance - -Output:: - - { - "Statuses": [ - { - "UseLongIds": true, - "Resource": "instance" - } - ] - } + aws ec2 describe-identity-id-format \ + --principal-arn arn:aws:iam::123456789012:role/my-iam-role \ + --resource instance + +The following output indicates that instances created by this role receive IDs in long ID format. :: + + { + "Statuses": [ + { + "Deadline": "2016-12-15T00:00:00Z", + "Resource": "instance", + "UseLongIds": true + } + ] + } **To describe the ID format for an IAM user** -This example describes the ID format of the ``snapshot`` resource for the IAM user ``AdminUser`` in your AWS account. The output indicates that snapshots are enabled for longer IDs - snapshots created by this user receive longer IDs. - -Command:: - - aws ec2 describe-identity-id-format --principal-arn arn:aws:iam::123456789012:user/AdminUser --resource snapshot - -Output:: +The following ``describe-identity-id-format`` example describes the ID format received by snapshots created by the IAM user ``AdminUser`` in your AWS account. :: - { - "Statuses": [ - { - "UseLongIds": true, - "Resource": "snapshot" - } - ] - } \ No newline at end of file + aws ec2 describe-identity-id-format \ + --principal-arn arn:aws:iam::123456789012:user/AdminUser \ + --resource snapshot + +The output indicates that snapshots created by this user receive IDs in long ID format. :: + + { + "Statuses": [ + { + "Deadline": "2016-12-15T00:00:00Z", + "Resource": "snapshot", + "UseLongIds": true + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-id-format.rst awscli-1.18.69/awscli/examples/ec2/describe-id-format.rst --- awscli-1.11.13/awscli/examples/ec2/describe-id-format.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-id-format.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,34 +1,24 @@ -**To describe the ID format for your resources** +**Example 1: To describe the ID format of a resource** -This example describes the ID format for all resource types that support longer IDs. The output indicates that the ``instance``, ``reservation``, ``volume``, and ``snapshot`` resource types can be enabled or disabled for longer IDs. The ``reservation`` resource is already enabled. The ``Deadline`` field indicates the date (in UTC) at which you're automatically switched over to using longer IDs for that resource type. If a deadline is not yet available for the resource type, this value is not returned. +The following ``describe-id-format`` example describes the ID format for security groups. :: -Command:: + aws ec2 describe-id-format \ + --resource security-group - aws ec2 describe-id-format +In the following example output, the ``Deadline`` value indicates that the deadline for this resource type to permanently switch from the short ID format to the long ID format expired at 00:00 UTC on August 15, 2018. :: -Output:: - - { - "Statuses": [ - { - "Deadline": "2016-11-01T13:00:00.000Z", - "UseLongIds": false, - "Resource": "instance" - }, - { - "Deadline": "2016-11-01T13:00:00.000Z", - "UseLongIds": true, - "Resource": "reservation" - }, - { - "Deadline": "2016-11-01T13:00:00.000Z", - "UseLongIds": false, - "Resource": "volume" - }, - { - "Deadline": "2016-11-01T13:00:00.000Z", - "UseLongIds": false, - "Resource": "snapshot" - } - ] - } \ No newline at end of file + { + "Statuses": [ + { + "Deadline": "2018-08-15T00:00:00.000Z", + "Resource": "security-group", + "UseLongIds": true + } + ] + } + +**Example 2: To describe the ID format for all resources** + +The following ``describe-id-format`` example describes the ID format for all resource types. All resource types that supported the short ID format were switched to use the long ID format. :: + + aws ec2 describe-id-format diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-images.rst awscli-1.18.69/awscli/examples/ec2/describe-images.rst --- awscli-1.11.13/awscli/examples/ec2/describe-images.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-images.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,68 +1,75 @@ -**To describe a specific AMI** +**Example 1: To describe a specific AMI** -This example describes the specified AMI. +The following ``describe-images`` example describes the specified AMI. :: -Command:: - - aws ec2 describe-images --image-ids ami-5731123e + aws ec2 describe-images \ + --region us-east-1 \ + --image-ids ami-1234567890EXAMPLE Output:: - { - "Images": [ - { - "VirtualizationType": "paravirtual", - "Name": "My server", - "Hypervisor": "xen", - "ImageId": "ami-5731123e", - "RootDeviceType": "ebs", - "State": "available", - "BlockDeviceMappings": [ - { - "DeviceName": "/dev/sda1", - "Ebs": { - "DeleteOnTermination": true, - "SnapshotId": "snap-1234567890abcdef0", - "VolumeSize": 8, - "VolumeType": "standard" - } - } - ], - "Architecture": "x86_64", - "ImageLocation": "123456789012/My server", - "KernelId": "aki-88aa75e1", - "OwnerId": "123456789012", - "RootDeviceName": "/dev/sda1", - "Public": false, - "ImageType": "machine", - "Description": "An AMI for my server" - } - ] - } - -**To describe Windows AMIs from Amazon that are backed by Amazon EBS** - -This example describes Windows AMIs provided by Amazon that are backed by Amazon EBS. - -Command:: - - aws ec2 describe-images --owners amazon --filters "Name=platform,Values=windows" "Name=root-device-type,Values=ebs" - -**To describe tagged AMIs** - -This example describes all AMIs that have the tag ``Custom=Linux1`` or ``Custom=Ubuntu1``. The output is filtered to display only the AMI IDs. - -Command:: - - aws ec2 describe-images --filters Name=tag-key,Values=Custom Name=tag-value,Values=Linux1,Ubuntu1 --query 'Images[*].{ID:ImageId}' + { + "Images": [ + { + "VirtualizationType": "hvm", + "Description": "Provided by Red Hat, Inc.", + "PlatformDetails": "Red Hat Enterprise Linux", + "EnaSupport": true, + "Hypervisor": "xen", + "State": "available", + "SriovNetSupport": "simple", + "ImageId": "ami-1234567890EXAMPLE", + "UsageOperation": "RunInstances:0010", + "BlockDeviceMappings": [ + { + "DeviceName": "/dev/sda1", + "Ebs": { + "SnapshotId": "snap-111222333444aaabb", + "DeleteOnTermination": true, + "VolumeType": "gp2", + "VolumeSize": 10, + "Encrypted": false + } + } + ], + "Architecture": "x86_64", + "ImageLocation": "123456789012/RHEL-8.0.0_HVM-20190618-x86_64-1-Hourly2-GP2", + "RootDeviceType": "ebs", + "OwnerId": "123456789012", + "RootDeviceName": "/dev/sda1", + "CreationDate": "2019-05-10T13:17:12.000Z", + "Public": true, + "ImageType": "machine", + "Name": "RHEL-8.0.0_HVM-20190618-x86_64-1-Hourly2-GP2" + } + ] + } + +For more information, see `Amazon Machine Images (AMI) `__ in the *Amazon Elastic Compute Cloud User Guide*. + +**Example 2: To describe Windows AMIs from Amazon that are backed by Amazon EBS** + +The following ``describe-images`` example describes Windows AMIs provided by Amazon that are backed by Amazon EBS. :: + + aws ec2 describe-images \ + --owners amazon \ + --filters "Name=platform,Values=windows" "Name=root-device-type,Values=ebs" + +**Example 3: To describe tagged AMIs** + +The following ``describe-images`` example describes all AMIs that have the tag ``Custom=Linux1``. The output is filtered to display only the AMI IDs. :: + + aws ec2 describe-images \ + --filters "Name=tag:Custom,Values=Linux1" \ + --query 'Images[*].{ID:ImageId}' Output:: - [ - { - "ID": "ami-1a2b3c4d" - }, - { - "ID": "ami-ab12cd34" - } - ] + [ + { + "ID": "ami-1a2b3c4d" + }, + { + "ID": "ami-ab12cd34" + } + ] diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-import-image-tasks.rst awscli-1.18.69/awscli/examples/ec2/describe-import-image-tasks.rst --- awscli-1.11.13/awscli/examples/ec2/describe-import-image-tasks.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-import-image-tasks.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,54 @@ +**To monitor an import image task** + +The following ``describe-import-image-tasks`` example checks the status of the specified import image task. :: + + aws ec2 describe-import-image-tasks \ + --import-task-ids import-ami-1234567890abcdef0 + +Output for an import image task that is in progress. :: + + { + "ImportImageTasks": [ + { + "ImportTaskId": "import-ami-1234567890abcdef0", + "Progress": "28", + "SnapshotDetails": [ + { + "DiskImageSize": 705638400.0, + "Format": "ova", + "Status": "completed", + "UserBucket": { + "S3Bucket": "my-import-bucket", + "S3Key": "vms/my-server-vm.ova" + } + } + ], + "Status": "active", + "StatusMessage": "converting" + } + ] + } + +Output for an import image task that is completed. The ID of the resulting AMI is provided by ``ImageId``. :: + + { + "ImportImageTasks": [ + { + "ImportTaskId": "import-ami-1234567890abcdef0", + "ImageId": "ami-1234567890abcdef0", + "SnapshotDetails": [ + { + "DiskImageSize": 705638400.0, + "Format": "ova", + "SnapshotId": "snap-1234567890abcdef0" + "Status": "completed", + "UserBucket": { + "S3Bucket": "my-import-bucket", + "S3Key": "vms/my-server-vm.ova" + } + } + ], + "Status": "completed" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-import-snapshot-tasks.rst awscli-1.18.69/awscli/examples/ec2/describe-import-snapshot-tasks.rst --- awscli-1.11.13/awscli/examples/ec2/describe-import-snapshot-tasks.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-import-snapshot-tasks.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,51 @@ +**To monitor an import snapshot task** + +The following ``describe-import-snapshot-tasks`` example checks the status of the specified import snapshot task. :: + + aws ec2 describe-import-snapshot-tasks \ + --import-task-ids import-snap-1234567890abcdef0 + +Output for an import snapshot task that is in progress:: + + { + "ImportSnapshotTasks": [ + { + "Description": "My server VMDK", + "ImportTaskId": "import-snap-1234567890abcdef0", + "SnapshotTaskDetail": { + "Description": "My server VMDK", + "DiskImageSize": "705638400.0", + "Format": "VMDK", + "Progress": "42", + "Status": "active", + "StatusMessage": "downloading/converting", + "UserBucket": { + "S3Bucket": "my-import-bucket", + "S3Key": "vms/my-server-vm.vmdk" + } + } + } + ] + } + +Output for an import snapshot task that is completed. The ID of the resulting snapshot is provided by ``SnapshotId``. :: + + { + "ImportSnapshotTasks": [ + { + "Description": "My server VMDK", + "ImportTaskId": "import-snap-1234567890abcdef0", + "SnapshotTaskDetail": { + "Description": "My server VMDK", + "DiskImageSize": "705638400.0", + "Format": "VMDK", + "SnapshotId": "snap-1234567890abcdef0" + "Status": "completed", + "UserBucket": { + "S3Bucket": "my-import-bucket", + "S3Key": "vms/my-server-vm.vmdk" + } + } + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-instance-credit-specifications.rst awscli-1.18.69/awscli/examples/ec2/describe-instance-credit-specifications.rst --- awscli-1.11.13/awscli/examples/ec2/describe-instance-credit-specifications.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-instance-credit-specifications.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To describe the credit option for CPU usage of one or more instances** + +This example describes the current credit option for CPU usage of the specified instance. + +Command:: + + aws ec2 describe-instance-credit-specifications --instance-id i-1234567890abcdef0 + +Output:: + + { + "InstanceCreditSpecifications": [ + { + "InstanceId": "i-1234567890abcdef0", + "CpuCredits": "unlimited" + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-instances.rst awscli-1.18.69/awscli/examples/ec2/describe-instances.rst --- awscli-1.11.13/awscli/examples/ec2/describe-instances.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-instances.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,53 +1,171 @@ -**To describe an Amazon EC2 instance** - -Command:: - - aws ec2 describe-instances --instance-ids i-1234567890abcdef0 - -**To describe all instances with the instance type m1.small** - -Command:: - - aws ec2 describe-instances --filters "Name=instance-type,Values=m1.small" - -**To describe all instances with a Owner tag** - -Command:: - - aws ec2 describe-instances --filters "Name=tag-key,Values=Owner" - -**To describe all instances with a Purpose=test tag** - -Command:: - - aws ec2 describe-instances --filters "Name=tag:Purpose,Values=test" - -**To describe all EC2 instances that have an instance type of m1.small or m1.medium that are also in the us-west-2c Availability Zone** - -Command:: - - aws ec2 describe-instances --filters "Name=instance-type,Values=m1.small,m1.medium" "Name=availability-zone,Values=us-west-2c" - -The following JSON input performs the same filtering. - -Command:: - - aws ec2 describe-instances --filters file://filters.json - -filters.json:: - - [ - { - "Name": "instance-type", - "Values": ["m1.small", "m1.medium"] - }, - { - "Name": "availability-zone", - "Values": ["us-west-2c"] - } - ] - -For more information, see `Using Amazon EC2 Instances`_ in the *AWS Command Line Interface User Guide*. - -.. _`Using Amazon EC2 Instances`: http://docs.aws.amazon.com/cli/latest/userguide/cli-ec2-launch.html - +**Example 1: To describe an Amazon EC2 instance** + +The following ``describe-instances`` example displays details about the specified instance. :: + + 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 + +**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 tag key (Owner), regardless of the tag value. :: + + 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** + +The following ``describe-instances`` example displays details about all instances with the specified type that are also in the specified Availability Zone. :: + + aws ec2 describe-instances \ + --filters Name=instance-type,Values=t2.micro,t3.micro Name=availability-zone,Values=us-east-2c + +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 + +Contents of ``filters.json``:: + + [ + { + "Name": "instance-type", + "Values": ["t2.micro", "t3.micro"] + }, + { + "Name": "availability-zone", + "Values": ["us-east-2c"] + } + ] + +**Example 5: To restrict the results to only specified fields** + +The following ``describe-instances`` example uses the ``--query`` parameter to display only the AMI ID and tags for the specified instance. :: + + aws ec2 describe-instances \ + --instance-id i-1234567890abcdef0 \ + --query "Reservations[*].Instances[*].[ImageId,Tags[*]]" + +The following ``describe-instances`` example uses the ``--query`` parameter to display only the instance and subnet IDs for all instances. + +Linux Command:: + + aws ec2 describe-instances \ + --query 'Reservations[*].Instances[*].{Instance:InstanceId,Subnet:SubnetId}' \ + --output json + +Windows Command:: + + aws ec2 describe-instances ^ + --query "Reservations[*].Instances[*].{Instance:InstanceId,Subnet:SubnetId}" ^ + --output json + +Output:: + + [ + { + "Instance": "i-057750d42936e468a", + "Subnet": "subnet-069beee9b12030077" + }, + { + "Instance": "i-001efd250faaa6ffa", + "Subnet": "subnet-0b715c6b7db68927a" + }, + { + "Instance": "i-027552a73f021f3bd", + "Subnet": "subnet-0250c25a1f4e15235" + } + ] + +**Example 6: To describe instances with a specific tag and filter the results to specific fields** + +The following ``describe-instances`` example displays the instance ID, Availability Zone, and the value of the ``Name`` tag for instances that have a tag with the name ``tag-key``. + +Linux Command:: + + aws ec2 describe-instances \ + --filter Name=tag-key,Values=Name \ + --query 'Reservations[*].Instances[*].{Instance:InstanceId,AZ:Placement.AvailabilityZone,Name:Tags[?Key==`Name`]|[0].Value}' \ + --output table + + + +Windows Command:: + + aws ec2 describe-instances ^ + --filter Name=tag-key,Values=Name ^ + --query "Reservations[*].Instances[*].{Instance:InstanceId,AZ:Placement.AvailabilityZone,Name:Tags[?Key=='Name']|[0].Value}" ^ + --output table + +Output:: + + ------------------------------------------------------------- + | DescribeInstances | + +--------------+-----------------------+--------------------+ + | AZ | Instance | Name | + +--------------+-----------------------+--------------------+ + | us-east-2b | i-057750d42936e468a | my-prod-server | + | us-east-2a | i-001efd250faaa6ffa | test-server-1 | + | us-east-2a | i-027552a73f021f3bd | test-server-2 | + +--------------+-----------------------+--------------------+ + +**Example 7: To view the partition number for an instance in a partition placement group** + +The following ``describe-instances`` example displays details about the specified instance. The output includes the placement information for the instance, which contains the placement group name and the partition number for the instance. :: + + aws ec2 describe-instances \ + --instance-id i-0123a456700123456 + +The following output is truncated to show only the relevant information:: + + "Placement": { + "AvailabilityZone": "us-east-1c", + "GroupName": "HDFS-Group-A", + "PartitionNumber": 3, + "Tenancy": "default" + } + +For more information, see `Describing Instances in a Placement Group `__ in the *Amazon Elastic Compute Cloud Users Guide*. + +**Example 8: To filter instances for a specific partition placement group and partition number** + +The following ``describe-instances`` example filters the results to only those instances with the specified placement group and partition number. :: + + aws ec2 describe-instances \ + --filters "Name = placement-group-name, Values = HDFS-Group-A" "Name = placement-partition-number, Values = 7" + +The following output is truncated to show only the relevant pieces:: + + "Instances": [ + { + "InstanceId": "i-0123a456700123456", + "InstanceType": "r4.large", + "Placement": { + "AvailabilityZone": "us-east-1c", + "GroupName": "HDFS-Group-A", + "PartitionNumber": 7, + "Tenancy": "default" + } + }, + { + "InstanceId": "i-9876a543210987654", + "InstanceType": "r4.large", + "Placement": { + "AvailabilityZone": "us-east-1c", + "GroupName": "HDFS-Group-A", + "PartitionNumber": 7, + "Tenancy": "default" + } + ], + +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.11.13/awscli/examples/ec2/describe-instance-type-offerings.rst awscli-1.18.69/awscli/examples/ec2/describe-instance-type-offerings.rst --- awscli-1.11.13/awscli/examples/ec2/describe-instance-type-offerings.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-instance-type-offerings.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/describe-instance-types.rst awscli-1.18.69/awscli/examples/ec2/describe-instance-types.rst --- awscli-1.11.13/awscli/examples/ec2/describe-instance-types.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-instance-types.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/describe-internet-gateways.rst awscli-1.18.69/awscli/examples/ec2/describe-internet-gateways.rst --- awscli-1.11.13/awscli/examples/ec2/describe-internet-gateways.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-internet-gateways.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,54 +1,31 @@ -**To describe your Internet gateways** +**To describe your internet gateways** -This example describes your Internet gateways. +The following ``describe-internet-gateways`` example retrieves details about all of your internet gateways. :: -Command:: - - aws ec2 describe-internet-gateways + aws ec2 describe-internet-gateways Output:: - { - "InternetGateways": [ - { - "Tags": [], - "InternetGatewayId": "igw-c0a643a9", - "Attachments": [ - { - "State": "available", - "VpcId": "vpc-a01106c2" - } - ] - }, - { - "Tags": [], - "InternetGatewayId": "igw-046d7966", - "Attachments": [] - } - ] - } - -**To describe the Internet gateway for a specific VPC** - -This example describes the Internet gateway for the specified VPC. - -Command:: - - aws ec2 describe-internet-gateways --filters "Name=attachment.vpc-id,Values=vpc-a01106c2" - -Output:: + { + "InternetGateways": [ + { + "Attachments": [], + "InternetGatewayId": "igw-036dde5c85EXAMPLE", + "OwnerId": "111122223333", + "Tags": [] + }, + { + "Attachments": [ + { + "State": "available", + "VpcId": "vpc-cEXAMPLE" + } + ], + "InternetGatewayId": "igw-0EXAMPLE", + "OwnerId": "111122223333", + "Tags": [] + } + ] + } - { - "InternetGateways": [ - { - "Tags": [], - "InternetGatewayId": "igw-c0a643a9", - "Attachments": [ - { - "State": "available", - "VpcId": "vpc-a01106c2" - } - ] - } - ] - } +For more information, see `Internet Gateways `__ in the *AWS VPC User Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-ipv6-pools.rst awscli-1.18.69/awscli/examples/ec2/describe-ipv6-pools.rst --- awscli-1.11.13/awscli/examples/ec2/describe-ipv6-pools.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-ipv6-pools.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/describe-launch-templates.rst awscli-1.18.69/awscli/examples/ec2/describe-launch-templates.rst --- awscli-1.11.13/awscli/examples/ec2/describe-launch-templates.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-launch-templates.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,46 @@ +**To describe launch templates** + +This example describes your launch templates. + +Command:: + + aws ec2 describe-launch-templates + +Output:: + + { + "LaunchTemplates": [ + { + "LatestVersionNumber": 2, + "LaunchTemplateId": "lt-0e06d290751193123", + "LaunchTemplateName": "TemplateForWebServer", + "DefaultVersionNumber": 2, + "CreatedBy": "arn:aws:iam::123456789012:root", + "CreateTime": "2017-11-27T09:30:23.000Z" + }, + { + "LatestVersionNumber": 6, + "LaunchTemplateId": "lt-0c45b5e061ec98456", + "LaunchTemplateName": "DBServersTemplate", + "DefaultVersionNumber": 1, + "CreatedBy": "arn:aws:iam::123456789012:root", + "CreateTime": "2017-11-20T09:25:22.000Z" + }, + { + "LatestVersionNumber": 1, + "LaunchTemplateId": "lt-0d47d774e8e52dabc", + "LaunchTemplateName": "MyLaunchTemplate2", + "DefaultVersionNumber": 1, + "CreatedBy": "arn:aws:iam::123456789012:root", + "CreateTime": "2017-11-02T12:06:21.000Z" + }, + { + "LatestVersionNumber": 3, + "LaunchTemplateId": "lt-01e5f948eb4f589d6", + "LaunchTemplateName": "testingtemplate2", + "DefaultVersionNumber": 1, + "CreatedBy": "arn:aws:sts::123456789012:assumed-role/AdminRole/i-03ee35176e2e5aabc", + "CreateTime": "2017-12-01T08:19:48.000Z" + }, + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-launch-template-versions.rst awscli-1.18.69/awscli/examples/ec2/describe-launch-template-versions.rst --- awscli-1.11.13/awscli/examples/ec2/describe-launch-template-versions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-launch-template-versions.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,83 @@ +**To describe launch template versions** + +This example describes the versions of the specified launch template. + +Command:: + + aws ec2 describe-launch-template-versions --launch-template-id lt-068f72b72934aff71 + +Output:: + + { + "LaunchTemplateVersions": [ + { + "LaunchTemplateId": "lt-068f72b72934aff71", + "LaunchTemplateName": "Webservers", + "VersionNumber": 3, + "CreatedBy": "arn:aws:iam::123456789102:root", + "LaunchTemplateData": { + "KeyName": "kp-us-east", + "ImageId": "ami-6057e21a", + "InstanceType": "t2.small", + "NetworkInterfaces": [ + { + "SubnetId": "subnet-7b16de0c", + "DeviceIndex": 0, + "Groups": [ + "sg-7c227019" + ] + } + ] + }, + "DefaultVersion": false, + "CreateTime": "2017-11-20T13:19:54.000Z" + }, + { + "LaunchTemplateId": "lt-068f72b72934aff71", + "LaunchTemplateName": "Webservers", + "VersionNumber": 2, + "CreatedBy": "arn:aws:iam::123456789102:root", + "LaunchTemplateData": { + "KeyName": "kp-us-east", + "ImageId": "ami-6057e21a", + "InstanceType": "t2.medium", + "NetworkInterfaces": [ + { + "SubnetId": "subnet-1a2b3c4d", + "DeviceIndex": 0, + "Groups": [ + "sg-7c227019" + ] + } + ] + }, + "DefaultVersion": false, + "CreateTime": "2017-11-20T13:12:32.000Z" + }, + { + "LaunchTemplateId": "lt-068f72b72934aff71", + "LaunchTemplateName": "Webservers", + "VersionNumber": 1, + "CreatedBy": "arn:aws:iam::123456789102:root", + "LaunchTemplateData": { + "UserData": "", + "KeyName": "kp-us-east", + "ImageId": "ami-aabbcc11", + "InstanceType": "t2.medium", + "NetworkInterfaces": [ + { + "SubnetId": "subnet-7b16de0c", + "DeviceIndex": 0, + "DeleteOnTermination": false, + "Groups": [ + "sg-7c227019" + ], + "AssociatePublicIpAddress": true + } + ] + }, + "DefaultVersion": true, + "CreateTime": "2017-11-20T12:52:33.000Z" + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-local-gateway-route-tables.rst awscli-1.18.69/awscli/examples/ec2/describe-local-gateway-route-tables.rst --- awscli-1.11.13/awscli/examples/ec2/describe-local-gateway-route-tables.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-local-gateway-route-tables.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/describe-local-gateway-route-table-vpc-associations.rst awscli-1.18.69/awscli/examples/ec2/describe-local-gateway-route-table-vpc-associations.rst --- awscli-1.11.13/awscli/examples/ec2/describe-local-gateway-route-table-vpc-associations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-local-gateway-route-table-vpc-associations.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/describe-local-gateways.rst awscli-1.18.69/awscli/examples/ec2/describe-local-gateways.rst --- awscli-1.11.13/awscli/examples/ec2/describe-local-gateways.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-local-gateways.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/describe-nat-gateways.rst awscli-1.18.69/awscli/examples/ec2/describe-nat-gateways.rst --- awscli-1.11.13/awscli/examples/ec2/describe-nat-gateways.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-nat-gateways.rst 2020-05-28 19:25:48.000000000 +0000 @@ -20,6 +20,12 @@ } ], "VpcId": "vpc-1a2b3c4d", + "Tags": [ + { + "Value": "IT", + "Key": "Department" + } + ], "State": "available", "NatGatewayId": "nat-05dba92075d71c408", "SubnetId": "subnet-847e4dc2", @@ -34,11 +40,16 @@ "PrivateIp": "10.0.0.77" } ], - "VpcId": "vpc-11aa22bb", - "State": "deleting", + "VpcId": "vpc-11aa22bb", + "Tags": [ + { + "Value": "Finance", + "Key": "Department" + } + ], + "State": "available", "NatGatewayId": "nat-0a93acc57881d4199", - "SubnetId": "subnet-7f7e4d39", - "DeleteTime": "2015-12-17T12:26:14.564Z", + "SubnetId": "subnet-7f7e4d39", "CreateTime": "2015-12-01T12:09:22.040Z" } ] diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-network-acls.rst awscli-1.18.69/awscli/examples/ec2/describe-network-acls.rst --- awscli-1.11.13/awscli/examples/ec2/describe-network-acls.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-network-acls.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,122 +1,125 @@ **To describe your network ACLs** -This example describes your network ACLs. +The following ``describe-network-acls`` example retrieves details about your network ACLs. :: -Command:: - - aws ec2 describe-network-acls + aws ec2 describe-network-acls Output:: - { - "NetworkAcls": [ - { - "Associations": [], - "NetworkAclId": "acl-7aaabd18", - "VpcId": "vpc-a01106c2", - "Tags": [], - "Entries": [ - { - "CidrBlock": "0.0.0.0/0", - "RuleNumber": 100, - "Protocol": "-1", - "Egress": true, - "RuleAction": "allow" - }, - { - "CidrBlock": "0.0.0.0/0", - "RuleNumber": 32767, - "Protocol": "-1", - "Egress": true, - "RuleAction": "deny" - }, - { - "CidrBlock": "0.0.0.0/0", - "RuleNumber": 100, - "Protocol": "-1", - "Egress": false, - "RuleAction": "allow" - }, - { - "CidrBlock": "0.0.0.0/0", - "RuleNumber": 32767, - "Protocol": "-1", - "Egress": false, - "RuleAction": "deny" - } - ], - "IsDefault": true - }, - { - "Associations": [], - "NetworkAclId": "acl-5fb85d36", - "VpcId": "vpc-a01106c2", - "Tags": [], - "Entries": [ - { - "CidrBlock": "0.0.0.0/0", - "RuleNumber": 32767, - "Protocol": "-1", - "Egress": true, - "RuleAction": "deny" - }, - { - "CidrBlock": "0.0.0.0/0", - "RuleNumber": 32767, - "Protocol": "-1", - "Egress": false, - "RuleAction": "deny" - } - ], - "IsDefault": false - }, - { - "Associations": [ - { - "SubnetId": "subnet-6bea5f06", - "NetworkAclId": "acl-9aeb5ef7", - "NetworkAclAssociationId": "aclassoc-67ea5f0a" - }, - { - "SubnetId": "subnet-65ea5f08", - "NetworkAclId": "acl-9aeb5ef7", - "NetworkAclAssociationId": "aclassoc-66ea5f0b" - } - ], - "NetworkAclId": "acl-9aeb5ef7", - "VpcId": "vpc-98eb5ef5", - "Tags": [], - "Entries": [ - { - "CidrBlock": "0.0.0.0/0", - "RuleNumber": 100, - "Protocol": "-1", - "Egress": true, - "RuleAction": "allow" - }, - { - "CidrBlock": "0.0.0.0/0", - "RuleNumber": 32767, - "Protocol": "-1", - "Egress": true, - "RuleAction": "deny" - }, - { - "CidrBlock": "0.0.0.0/0", - "RuleNumber": 100, - "Protocol": "-1", - "Egress": false, - "RuleAction": "allow" - }, - { - "CidrBlock": "0.0.0.0/0", - "RuleNumber": 32767, - "Protocol": "-1", - "Egress": false, - "RuleAction": "deny" - } - ], - "IsDefault": true - } - ] - } \ No newline at end of file + { + "NetworkAcls": [ + { + "Associations": [ + { + "NetworkAclAssociationId": "aclassoc-0c1679dc41EXAMPLE", + "NetworkAclId": "acl-0ea1f54ca7EXAMPLE", + "SubnetId": "subnet-0931fc2fa5EXAMPLE" + } + ], + "Entries": [ + { + "CidrBlock": "0.0.0.0/0", + "Egress": true, + "Protocol": "-1", + "RuleAction": "allow", + "RuleNumber": 100 + }, + { + "CidrBlock": "0.0.0.0/0", + "Egress": true, + "Protocol": "-1", + "RuleAction": "deny", + "RuleNumber": 32767 + }, + { + "CidrBlock": "0.0.0.0/0", + "Egress": false, + "Protocol": "-1", + "RuleAction": "allow", + "RuleNumber": 100 + }, + { + "CidrBlock": "0.0.0.0/0", + "Egress": false, + "Protocol": "-1", + "RuleAction": "deny", + "RuleNumber": 32767 + } + ], + "IsDefault": true, + "NetworkAclId": "acl-0ea1f54ca7EXAMPLE", + "Tags": [], + "VpcId": "vpc-06e4ab6c6cEXAMPLE", + "OwnerId": "111122223333" + }, + { + "Associations": [], + "Entries": [ + { + "CidrBlock": "0.0.0.0/0", + "Egress": true, + "Protocol": "-1", + "RuleAction": "allow", + "RuleNumber": 100 + }, + { + "Egress": true, + "Ipv6CidrBlock": "::/0", + "Protocol": "-1", + "RuleAction": "allow", + "RuleNumber": 101 + }, + { + "CidrBlock": "0.0.0.0/0", + "Egress": true, + "Protocol": "-1", + "RuleAction": "deny", + "RuleNumber": 32767 + }, + { + "Egress": true, + "Ipv6CidrBlock": "::/0", + "Protocol": "-1", + "RuleAction": "deny", + "RuleNumber": 32768 + }, + { + "CidrBlock": "0.0.0.0/0", + "Egress": false, + "Protocol": "-1", + "RuleAction": "allow", + "RuleNumber": 100 + }, + { + "Egress": false, + "Ipv6CidrBlock": "::/0", + "Protocol": "-1", + "RuleAction": "allow", + "RuleNumber": 101 + }, + { + "CidrBlock": "0.0.0.0/0", + "Egress": false, + "Protocol": "-1", + "RuleAction": "deny", + "RuleNumber": 32767 + }, + { + "Egress": false, + "Ipv6CidrBlock": "::/0", + "Protocol": "-1", + "RuleAction": "deny", + "RuleNumber": 32768 + } + ], + "IsDefault": true, + "NetworkAclId": "acl-0e2a78e4e2EXAMPLE", + "Tags": [], + "VpcId": "vpc-03914afb3eEXAMPLE", + "OwnerId": "111122223333" + } + ] + } + + +For more information, see `Network ACLs `__ in the *AWS VPC User Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-network-interface-permissions.rst awscli-1.18.69/awscli/examples/ec2/describe-network-interface-permissions.rst --- awscli-1.11.13/awscli/examples/ec2/describe-network-interface-permissions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-network-interface-permissions.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,23 @@ +**To describe your network interface permissions** + +This example describes all of your network interface permissions. + +Command:: + + aws ec2 describe-network-interface-permissions + +Output:: + + { + "NetworkInterfacePermissions": [ + { + "PermissionState": { + "State": "GRANTED" + }, + "NetworkInterfacePermissionId": "eni-perm-06fd19020ede149ea", + "NetworkInterfaceId": "eni-b909511a", + "Permission": "INSTANCE-ATTACH", + "AwsAccountId": "123456789012" + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-network-interfaces.rst awscli-1.18.69/awscli/examples/ec2/describe-network-interfaces.rst --- awscli-1.11.13/awscli/examples/ec2/describe-network-interfaces.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-network-interfaces.rst 2020-05-28 19:25:48.000000000 +0000 @@ -37,6 +37,7 @@ } ], "RequesterManaged": false, + "Ipv6Addresses": [], "PrivateDnsName": "ip-10-0-1-17.ec2.internal", "AvailabilityZone": "us-east-1d", "Attachment": { @@ -81,6 +82,7 @@ } ], "RequesterManaged": false, + "Ipv6Addresses": [], "AvailabilityZone": "us-east-1d", "Attachment": { "Status": "attached", @@ -104,3 +106,56 @@ } ] } + + +This example describes network interfaces that have a tag with the key ``Purpose`` and the value ``Prod``. + +Command:: + + aws ec2 describe-network-interfaces --filters Name=tag:Purpose,Values=Prod + +Output:: + + { + "NetworkInterfaces": [ + { + "Status": "available", + "MacAddress": "12:2c:bd:f9:bf:17", + "SourceDestCheck": true, + "VpcId": "vpc-8941ebec", + "Description": "ProdENI", + "NetworkInterfaceId": "eni-b9a5ac93", + "PrivateIpAddresses": [ + { + "PrivateDnsName": "ip-10-0-1-55.ec2.internal", + "Primary": true, + "PrivateIpAddress": "10.0.1.55" + }, + { + "PrivateDnsName": "ip-10-0-1-117.ec2.internal", + "Primary": false, + "PrivateIpAddress": "10.0.1.117" + } + ], + "RequesterManaged": false, + "PrivateDnsName": "ip-10-0-1-55.ec2.internal", + "AvailabilityZone": "us-east-1d", + "Ipv6Addresses": [], + "Groups": [ + { + "GroupName": "MySG", + "GroupId": "sg-905002f5" + } + ], + "SubnetId": "subnet-31d6c219", + "OwnerId": "123456789012", + "TagSet": [ + { + "Value": "Prod", + "Key": "Purpose" + } + ], + "PrivateIpAddress": "10.0.1.55" + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-principal-id-format.rst awscli-1.18.69/awscli/examples/ec2/describe-principal-id-format.rst --- awscli-1.11.13/awscli/examples/ec2/describe-principal-id-format.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-principal-id-format.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,34 @@ +**To describe the ID format for IAM users and roles with long ID format enabled** + +The following ``describe-principal-id-format`` example describes the ID format for the root user, all IAM roles, and all IAM users with long ID format enabled. :: + + aws ec2 describe-principal-id-format \ + --resource instance + +Output:: + + { + "Principals": [ + { + "Arn": "arn:aws:iam::123456789012:root", + "Statuses": [ + { + "Deadline": "2016-12-15T00:00:00.000Z", + "Resource": "reservation", + "UseLongIds": true + }, + { + "Deadline": "2016-12-15T00:00:00.000Z", + "Resource": "instance", + "UseLongIds": true + }, + { + "Deadline": "2016-12-15T00:00:00.000Z", + "Resource": "volume", + "UseLongIds": true + }, + ] + }, + ... + ] + } diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-public-ipv4-pools.rst awscli-1.18.69/awscli/examples/ec2/describe-public-ipv4-pools.rst --- awscli-1.11.13/awscli/examples/ec2/describe-public-ipv4-pools.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-public-ipv4-pools.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,25 @@ +**To describe your public IPv4 address pools** + +The following ``describe-public-ipv4-pools`` example displays details about the address pools that were created when you provisioned public IPv4 address ranges using Bring Your Own IP Addresses (BYOIP). :: + + aws ec2 describe-public-ipv4-pools + +Output:: + + { + "PublicIpv4Pools": [ + { + "PoolId": "ipv4pool-ec2-1234567890abcdef0", + "PoolAddressRanges": [ + { + "FirstAddress": "203.0.113.0", + "LastAddress": "203.0.113.255", + "AddressCount": 256, + "AvailableAddressCount": 256 + } + ], + "TotalAddressCount": 256, + "TotalAvailableAddressCount": 256 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-regions.rst awscli-1.18.69/awscli/examples/ec2/describe-regions.rst --- awscli-1.11.13/awscli/examples/ec2/describe-regions.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-regions.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,107 +1,266 @@ -**To describe your regions** +**Example 1: To describe all of your enabled Regions** -This example describes all the regions that are available to you. +The following ``describe-regions`` example describes all of the Regions that are enabled for your account. :: -Command:: - - aws ec2 describe-regions + aws ec2 describe-regions Output:: - { - "Regions": [ - { - "Endpoint": "ec2.eu-west-1.amazonaws.com", - "RegionName": "eu-west-1" - }, - { - "Endpoint": "ec2.ap-south-1.amazonaws.com", - "RegionName": "ap-south-1" - }, - { - "Endpoint": "ec2.ap-southeast-1.amazonaws.com", - "RegionName": "ap-southeast-1" - }, - { - "Endpoint": "ec2.ap-southeast-2.amazonaws.com", - "RegionName": "ap-southeast-2" - }, - { - "Endpoint": "ec2.eu-central-1.amazonaws.com", - "RegionName": "eu-central-1" - }, - { - "Endpoint": "ec2.ap-northeast-2.amazonaws.com", - "RegionName": "ap-northeast-2" - }, - { - "Endpoint": "ec2.ap-northeast-1.amazonaws.com", - "RegionName": "ap-northeast-1" - }, - { - "Endpoint": "ec2.us-east-1.amazonaws.com", - "RegionName": "us-east-1" - }, - { - "Endpoint": "ec2.sa-east-1.amazonaws.com", - "RegionName": "sa-east-1" - }, - { - "Endpoint": "ec2.us-west-1.amazonaws.com", - "RegionName": "us-west-1" - }, - { - "Endpoint": "ec2.us-west-2.amazonaws.com", - "RegionName": "us-west-2" - } - ] - } - -**To describe the regions with an endpoint that has a specific string** + { + "Regions": [ + { + "Endpoint": "ec2.eu-north-1.amazonaws.com", + "RegionName": "eu-north-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.ap-south-1.amazonaws.com", + "RegionName": "ap-south-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.eu-west-3.amazonaws.com", + "RegionName": "eu-west-3", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.eu-west-2.amazonaws.com", + "RegionName": "eu-west-2", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.eu-west-1.amazonaws.com", + "RegionName": "eu-west-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.ap-northeast-3.amazonaws.com", + "RegionName": "ap-northeast-3", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.ap-northeast-2.amazonaws.com", + "RegionName": "ap-northeast-2", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.ap-northeast-1.amazonaws.com", + "RegionName": "ap-northeast-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.sa-east-1.amazonaws.com", + "RegionName": "sa-east-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.ca-central-1.amazonaws.com", + "RegionName": "ca-central-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.ap-southeast-1.amazonaws.com", + "RegionName": "ap-southeast-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.ap-southeast-2.amazonaws.com", + "RegionName": "ap-southeast-2", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.eu-central-1.amazonaws.com", + "RegionName": "eu-central-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.us-east-1.amazonaws.com", + "RegionName": "us-east-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.us-east-2.amazonaws.com", + "RegionName": "us-east-2", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.us-west-1.amazonaws.com", + "RegionName": "us-west-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.us-west-2.amazonaws.com", + "RegionName": "us-west-2", + "OptInStatus": "opt-in-not-required" + } + ] + } -This example describes all regions that are available to you that have the string "us" in the endpoint. +**Example 2: To describe enabled Regions with an endpoint whose name contains a specific string** -Command:: +The following ``describe-regions`` example describes all Regions that you have enabled that have the string "us" in the endpoint. :: - aws ec2 describe-regions --filters "Name=endpoint,Values=*us*" + aws ec2 describe-regions --filters "Name=endpoint,Values=*us*" Output:: - { - "Regions": [ - { - "Endpoint": "ec2.us-east-1.amazonaws.com", - "RegionName": "us-east-1" - }, - { - "Endpoint": "ec2.us-west-2.amazonaws.com", - "RegionName": "us-west-2" - }, - { - "Endpoint": "ec2.us-west-1.amazonaws.com", - "RegionName": "us-west-1" - }, - ] - } + { + "Regions": [ + { + "Endpoint": "ec2.us-east-1.amazonaws.com", + "RegionName": "us-east-1" + }, + { + "Endpoint": "ec2.us-east-2.amazonaws.com", + "RegionName": "us-east-2" + }, + { + "Endpoint": "ec2.us-west-1.amazonaws.com", + "RegionName": "us-west-1" + }, + { + "Endpoint": "ec2.us-west-2.amazonaws.com", + "RegionName": "us-west-2" + }, + ] + } + +**To describe all Regions** -**To describe region names only** +The following ``describe-regions`` example describes all available Regions, including opt-in Regions like HKG and BAH. For a description of opt-in Regions, see `Available Regions `__ in the *Amazon EC2 User Guide*. :: -This example uses the ``--query`` parameter to filter the output and return the names of the regions only. The output is returned as tab-delimited lines. + aws ec2 describe-regions \ + --all-regions + +Output:: -Command:: + { + "Regions": [ + { + "Endpoint": "ec2.eu-north-1.amazonaws.com", + "RegionName": "eu-north-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.ap-south-1.amazonaws.com", + "RegionName": "ap-south-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.eu-west-3.amazonaws.com", + "RegionName": "eu-west-3", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.eu-west-2.amazonaws.com", + "RegionName": "eu-west-2", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.eu-west-1.amazonaws.com", + "RegionName": "eu-west-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.ap-northeast-3.amazonaws.com", + "RegionName": "ap-northeast-3", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.me-south-1.amazonaws.com", + "RegionName": "me-south-1", + "OptInStatus": "not-opted-in" + }, + { + "Endpoint": "ec2.ap-northeast-2.amazonaws.com", + "RegionName": "ap-northeast-2", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.ap-northeast-1.amazonaws.com", + "RegionName": "ap-northeast-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.sa-east-1.amazonaws.com", + "RegionName": "sa-east-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.ca-central-1.amazonaws.com", + "RegionName": "ca-central-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.ap-east-1.amazonaws.com", + "RegionName": "ap-east-1", + "OptInStatus": "not-opted-in" + }, + { + "Endpoint": "ec2.ap-southeast-1.amazonaws.com", + "RegionName": "ap-southeast-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.ap-southeast-2.amazonaws.com", + "RegionName": "ap-southeast-2", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.eu-central-1.amazonaws.com", + "RegionName": "eu-central-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.us-east-1.amazonaws.com", + "RegionName": "us-east-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.us-east-2.amazonaws.com", + "RegionName": "us-east-2", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.us-west-1.amazonaws.com", + "RegionName": "us-west-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.us-west-2.amazonaws.com", + "RegionName": "us-west-2", + "OptInStatus": "opt-in-not-required" + } + ] + } + +**To list the Region names only** + +The following ``describe-regions`` example uses the ``--query`` parameter to filter the output and return only the names of the Regions as text. :: + + aws ec2 describe-regions \ + --all-regions \ + --query "Regions[].{Name:RegionName}" \ + --output text - aws ec2 describe-regions --query 'Regions[].{Name:RegionName}' --output text - Output:: - ap-south-1 - eu-west-1 - ap-southeast-1 - ap-southeast-2 - eu-central-1 - ap-northeast-2 - ap-northeast-1 - us-east-1 - sa-east-1 - us-west-1 - us-west-2 + eu-north-1 + ap-south-1 + eu-west-3 + eu-west-2 + eu-west-1 + ap-northeast-3 + ap-northeast-2 + me-south-1 + ap-northeast-1 + sa-east-1 + ca-central-1 + ap-east-1 + ap-southeast-1 + ap-southeast-2 + eu-central-1 + us-east-1 + us-east-2 + us-west-1 + us-west-2 diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-reserved-instances-listings.rst awscli-1.18.69/awscli/examples/ec2/describe-reserved-instances-listings.rst --- awscli-1.11.13/awscli/examples/ec2/describe-reserved-instances-listings.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-reserved-instances-listings.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To describe a Reserved Instance listing** + +The following ``describe-reserved-instances-listings`` example retrieves information about the specified Reserved Instance listing. :: + + aws ec2 describe-reserved-instances-listings \ + --reserved-instances-listing-id 5ec28771-05ff-4b9b-aa31-9e57dexample + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-route-tables.rst awscli-1.18.69/awscli/examples/ec2/describe-route-tables.rst --- awscli-1.11.13/awscli/examples/ec2/describe-route-tables.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-route-tables.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,63 +1,99 @@ **To describe your route tables** -This example describes your route tables. +The following ``describe-route-tables`` example retrieves the details about your route tables :: -Command:: - - aws ec2 describe-route-tables + aws ec2 describe-route-tables Output:: - { - "RouteTables": [ - { - "Associations": [ - { - "RouteTableAssociationId": "rtbassoc-d8ccddba", - "Main": true, - "RouteTableId": "rtb-1f382e7d" - } - ], - "RouteTableId": "rtb-1f382e7d", - "VpcId": "vpc-a01106c2", - "PropagatingVgws": [], - "Tags": [], - "Routes": [ - { - "GatewayId": "local", - "DestinationCidrBlock": "10.0.0.0/16", - "State": "active" - } - ] - }, - { - "Associations": [ - { - "SubnetId": "subnet-b61f49f0", - "RouteTableAssociationId": "rtbassoc-781d0d1a", - "RouteTableId": "rtb-22574640" - } - ], - "RouteTableId": "rtb-22574640", - "VpcId": "vpc-a01106c2", - "PropagatingVgws": [ - { - "GatewayId": "vgw-f211f09b" - } - ], - "Tags": [], - "Routes": [ - { - "GatewayId": "local", - "DestinationCidrBlock": "10.0.0.0/16", - "State": "active" - }, - { - "GatewayId": "igw-046d7966", - "DestinationCidrBlock": "0.0.0.0/0", - "State": "active" - } - ] - } - ] - } \ No newline at end of file + { + "RouteTables": [ + { + "Associations": [ + { + "Main": true, + "RouteTableAssociationId": "rtbassoc-0df3f54e06EXAMPLE", + "RouteTableId": "rtb-09ba434c1bEXAMPLE" + } + ], + "PropagatingVgws": [], + "RouteTableId": "rtb-09ba434c1bEXAMPLE", + "Routes": [ + { + "DestinationCidrBlock": "10.0.0.0/16", + "GatewayId": "local", + "Origin": "CreateRouteTable", + "State": "active" + }, + { + "DestinationCidrBlock": "0.0.0.0/0", + "NatGatewayId": "nat-06c018cbd8EXAMPLE", + "Origin": "CreateRoute", + "State": "blackhole" + } + ], + "Tags": [], + "VpcId": "vpc-0065acced4EXAMPLE", + "OwnerId": "111122223333" + }, + { + "Associations": [ + { + "Main": true, + "RouteTableAssociationId": "rtbassoc-9EXAMPLE", + "RouteTableId": "rtb-a1eec7de" + } + ], + "PropagatingVgws": [], + "RouteTableId": "rtb-a1eec7de", + "Routes": [ + { + "DestinationCidrBlock": "172.31.0.0/16", + "GatewayId": "local", + "Origin": "CreateRouteTable", + "State": "active" + }, + { + "DestinationCidrBlock": "0.0.0.0/0", + "GatewayId": "igw-fEXAMPLE", + "Origin": "CreateRoute", + "State": "active" + } + ], + "Tags": [], + "VpcId": "vpc-3EXAMPLE", + "OwnerId": "111122223333" + }, + { + "Associations": [ + { + "Main": false, + "RouteTableAssociationId": "rtbassoc-0b100c28b2EXAMPLE", + "RouteTableId": "rtb-07a98f76e5EXAMPLE", + "SubnetId": "subnet-0d3d002af8EXAMPLE" + } + ], + "PropagatingVgws": [], + "RouteTableId": "rtb-07a98f76e5EXAMPLE", + "Routes": [ + { + "DestinationCidrBlock": "10.0.0.0/16", + "GatewayId": "local", + "Origin": "CreateRouteTable", + "State": "active" + }, + { + "DestinationCidrBlock": "0.0.0.0/0", + "GatewayId": "igw-06cf664d80EXAMPLE", + "Origin": "CreateRoute", + "State": "active" + } + ], + "Tags": [], + "VpcId": "vpc-0065acced4EXAMPLE", + "OwnerId": "111122223333" + } + ] + } + +For more information, see `Working with Route Tables `__ in the *AWS VPC User Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-security-groups.rst awscli-1.18.69/awscli/examples/ec2/describe-security-groups.rst --- awscli-1.11.13/awscli/examples/ec2/describe-security-groups.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-security-groups.rst 2020-05-28 19:25:48.000000000 +0000 @@ -83,6 +83,7 @@ "FromPort": 22, "IpRanges": [ { + "Description": "Access from NY office", "CidrIp": "203.0.113.0/24" } ], @@ -105,7 +106,7 @@ Command:: - aws ec2 describe-security-groups --filters Name=ip-permission.from-port,Values=22 Name=ip-permission.to-port,Values=22 Name=ip-permission.cidr,Values='0.0.0.0/0' --query 'SecurityGroups[*].{Name:GroupName}' + aws ec2 describe-security-groups --filters Name=ip-permission.from-port,Values=22 Name=ip-permission.to-port,Values=22 Name=ip-permission.cidr,Values='0.0.0.0/0' --query "SecurityGroups[*].{Name:GroupName}" Output:: @@ -127,7 +128,7 @@ Command:: - aws ec2 describe-security-groups --filters Name=group-name,Values='*test*' Name=tag-key,Values=Test Name=tag-value,Values=To-delete --query 'SecurityGroups[*].{Name:GroupName,ID:GroupId}' + aws ec2 describe-security-groups --filters Name=group-name,Values=*test* Name=tag:Test,Values=To-delete --query "SecurityGroups[*].{Name:GroupName,ID:GroupId}" Output:: diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-snapshot-attribute.rst awscli-1.18.69/awscli/examples/ec2/describe-snapshot-attribute.rst --- awscli-1.11.13/awscli/examples/ec2/describe-snapshot-attribute.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-snapshot-attribute.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,14 +1,25 @@ -**To describe snapshot attributes** +**To describe the snapshot attributes for a snapshot** -This example command describes the ``createVolumePermission`` attribute on a snapshot with the snapshot ID of ``snap-066877671789bd71b``. +The following ``describe-snapshot`` example describes the ``createVolumePermission`` attribute for the specified snapshot. :: -Command:: + aws ec2 describe-snapshot-attribute \ + --snapshot-id snap-066877671789bd71b \ + --attribute createVolumePermission - aws ec2 describe-snapshot-attribute --snapshot-id snap-066877671789bd71b --attribute createVolumePermission +The output indicates that the specified user has volume permissions. :: -Output:: + { + "SnapshotId": "snap-066877671789bd71b", + "CreateVolumePermissions": [ + { + "UserId": "123456789012" + } + ] + } + +Output similar to the following indicates that there are no volume permissions. :: - { - "SnapshotId": "snap-066877671789bd71b", - "CreateVolumePermissions": [] - } \ No newline at end of file + { + "SnapshotId": "snap-066877671789bd71b", + "CreateVolumePermissions": [] + } diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-snapshots.rst awscli-1.18.69/awscli/examples/ec2/describe-snapshots.rst --- awscli-1.11.13/awscli/examples/ec2/describe-snapshots.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-snapshots.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,66 +1,67 @@ -**To describe a snapshot** +**Example 1: To describe a snapshot** -This example command describes a snapshot with the snapshot ID of ``snap-1234567890abcdef0``. +The following ``describe-snapshots`` example describes the specified snapshot. :: -Command:: - - aws ec2 describe-snapshots --snapshot-id snap-1234567890abcdef0 + aws ec2 describe-snapshots \ + --snapshot-ids snap-1234567890abcdef0 Output:: - { - "Snapshots": [ - { - "Description": "This is my snapshot.", - "VolumeId": "vol-049df61146c4d7901", - "State": "completed", - "VolumeSize": 8, - "Progress": "100%", - "StartTime": "2014-02-28T21:28:32.000Z", - "SnapshotId": "snap-1234567890abcdef0", - "OwnerId": "012345678910" - } - ] - } - -**To describe snapshots using filters** - -This example command describes all snapshots owned by the ID 012345678910 that are in the ``pending`` status. - -Command:: - - aws ec2 describe-snapshots --owner-ids 012345678910 --filters Name=status,Values=pending + { + "Snapshots": [ + { + "Description": "This is my snapshot", + "Encrypted": false, + "VolumeId": "vol-049df61146c4d7901", + "State": "completed", + "VolumeSize": 8, + "StartTime": "2014-02-28T21:28:32.000Z", + "Progress": "100%", + "OwnerId": "012345678910", + "SnapshotId": "snap-1234567890abcdef0" + } + ] + } + +**Example 2: To describe snapshots using filters** + +The following ``describe-snapshots`` example describes all snapshots owned by the specified AWS account that are in the ``pending`` state. :: + + aws ec2 describe-snapshots \ + --owner-ids 012345678910 \ + --filters Name=status,Values=pending Output:: - { - "Snapshots": [ - { - "Description": "This is my copied snapshot.", - "VolumeId": "vol-1234567890abcdef0", - "State": "pending", - "VolumeSize": 8, - "Progress": "87%", - "StartTime": "2014-02-28T21:37:27.000Z", - "SnapshotId": "snap-066877671789bd71b", - "OwnerId": "012345678910" - } - ] - } - -**To describe tagged snapshots and filter the output** - -This example command describes all snapshots that have the tag ``Group=Prod``. The output is filtered to display only the snapshot IDs and the time the snapshot was started. - -Command:: - - aws ec2 describe-snapshots --filters Name=tag-key,Values="Group" Name=tag-value,Values="Prod" --query 'Snapshots[*].{ID:SnapshotId,Time:StartTime}' + { + "Snapshots": [ + { + "Description": "This is my copied snapshot", + "Encrypted": true, + "VolumeId": "vol-1234567890abcdef0", + "State": "pending", + "VolumeSize": 8, + "StartTime": "2014-02-28T21:37:27.000Z", + "Progress": "87%", + "OwnerId": "012345678910", + "SnapshotId": "snap-066877671789bd71b" + } + ] + } + +**Example 3: To describe tagged snapshots and filter the output** + +The following ``describe-snapshots`` example describes all snapshots that have the tag ``Group=Prod``. The output is filtered to display only the snapshot IDs and the time the snapshot was started. :: + + aws ec2 describe-snapshots \ + --filters Name=tag:Group,Values=Prod \ + --query "Snapshots[*].{ID:SnapshotId,Time:StartTime}" Output:: - [ - { - "ID": "snap-1234567890abcdef0", - "Time": "2014-08-04T12:48:18.000Z" - } - ] \ No newline at end of file + [ + { + "ID": "snap-1234567890abcdef0", + "Time": "2014-08-04T12:48:18.000Z" + } + ] diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-stale-security-groups.rst awscli-1.18.69/awscli/examples/ec2/describe-stale-security-groups.rst --- awscli-1.11.13/awscli/examples/ec2/describe-stale-security-groups.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-stale-security-groups.rst 2020-05-28 19:25:48.000000000 +0000 @@ -43,7 +43,8 @@ "UserIdGroupPairs": [ { "VpcId": "vpc-7a20e51f", - "GroupId": "sg-279ab042", + "GroupId": "sg-279ab042", + "Description": "Access from pcx-b04deed9", "VpcPeeringConnectionId": "pcx-b04deed9", "PeeringStatus": "active" } diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-subnets.rst awscli-1.18.69/awscli/examples/ec2/describe-subnets.rst --- awscli-1.11.13/awscli/examples/ec2/describe-subnets.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-subnets.rst 2020-05-28 19:26:18.000000000 +0000 @@ -1,72 +1,105 @@ -**To describe your subnets** +**Example 1: To describe your subnets** -This example describes your subnets. +The following ``describe-subnets`` example displays the details of your subnets. :: -Command:: - - aws ec2 describe-subnets + aws ec2 describe-subnets Output:: - { - "Subnets": [ - { - "VpcId": "vpc-a01106c2", - "CidrBlock": "10.0.1.0/24", - "MapPublicIpOnLaunch": false, - "DefaultForAz": false, - "State": "available", - "AvailabilityZone": "us-east-1c", - "SubnetId": "subnet-9d4a7b6c", - "AvailableIpAddressCount": 251 - }, - { - "VpcId": "vpc-b61106d4", - "CidrBlock": "10.0.0.0/24", - "MapPublicIpOnLaunch": false, - "DefaultForAz": false, - "State": "available", - "AvailabilityZone": "us-east-1d", - "SubnetId": "subnet-65ea5f08", - "AvailableIpAddressCount": 251 - } - ] - } - -**To describe the subnets for a specific VPC** - -This example describes the subnets for the specified VPC. - -Command:: + { + "Subnets": [ + { + "AvailabilityZone": "us-east-1d", + "AvailabilityZoneId": "use1-az2", + "AvailableIpAddressCount": 4089, + "CidrBlock": "172.31.80.0/20", + "DefaultForAz": true, + "MapPublicIpOnLaunch": false, + "MapCustomerOwnedIpOnLaunch": true, + "State": "available", + "SubnetId": "subnet-0bb1c79de3EXAMPLE", + "VpcId": "vpc-0ee975135dEXAMPLE", + "OwnerId": "111122223333", + "AssignIpv6AddressOnCreation": false, + "Ipv6CidrBlockAssociationSet": [], + "CustomerOwnedIpv4Pool:": 'pool-2EXAMPLE', + "SubnetArn": "arn:aws:ec2:us-east-2:111122223333:subnet/subnet-0bb1c79de3EXAMPLE" + }, + { + "AvailabilityZone": "us-east-1d", + "AvailabilityZoneId": "use1-az2", + "AvailableIpAddressCount": 4089, + "CidrBlock": "172.31.80.0/20", + "DefaultForAz": true, + "MapPublicIpOnLaunch": true, + "MapCustomerOwnedIpOnLaunch": false, + "State": "available", + "SubnetId": "subnet-8EXAMPLE", + "VpcId": "vpc-3EXAMPLE", + "OwnerId": "1111222233333", + "AssignIpv6AddressOnCreation": false, + "Ipv6CidrBlockAssociationSet": [], + "Tags": [ + { + "Key": "Name", + "Value": "MySubnet" + } + ], + "SubnetArn": "arn:aws:ec2:us-east-1:111122223333:subnet/subnet-8EXAMPLE" + } + ] + } - aws ec2 describe-subnets --filters "Name=vpc-id,Values=vpc-a01106c2" +For more information, see `Working with VPCs and Subnets `__ in the *AWS VPC User Guide*. -Output:: +**Example 2: To describe a specificied VPCs subnets** - { - "Subnets": [ - { - "VpcId": "vpc-a01106c2", - "CidrBlock": "10.0.1.0/24", - "MapPublicIpOnLaunch": false, - "DefaultForAz": false, - "State": "available", - "AvailabilityZone": "us-east-1c", - "SubnetId": "subnet-9d4a7b6c", - "AvailableIpAddressCount": 251 - } - ] - } - -**To describe subnets with a specific tag** +The following ``describe-subnets`` example uses a filter to retrieve details for the subnets of the specified VPC. :: -This example lists subnets with the tag ``Name=MySubnet`` and returns the output in text format. + aws ec2 describe-subnets \ + --filters "Name=vpc-id,Values=vpc-3EXAMPLE" -Command:: +Output:: - aws ec2 describe-subnets --filters Name=tag:Name,Values=MySubnet --output text + { + "Subnets": [ + { + "AvailabilityZone": "us-east-1d", + "AvailabilityZoneId": "use1-az2", + "AvailableIpAddressCount": 4089, + "CidrBlock": "172.31.80.0/20", + "DefaultForAz": true, + "MapPublicIpOnLaunch": true, + "MapCustomerOwnedIpOnLaunch": false, + "State": "available", + "SubnetId": "subnet-8EXAMPLE", + "VpcId": "vpc-3EXAMPLE", + "OwnerId": "1111222233333", + "AssignIpv6AddressOnCreation": false, + "Ipv6CidrBlockAssociationSet": [], + "Tags": [ + { + "Key": "Name", + "Value": "MySubnet" + } + ], + "SubnetArn": "arn:aws:ec2:us-east-1:111122223333:subnet/subnet-8EXAMPLE" + } + ] + } + +For more information, see `Working with VPCs and Subnets `__ in the *AWS VPC User Guide*. + +**Example 3: To describe subnets with a specific tag** + +The following ``describe-subnets`` example uses a filter to retrieve the details of those subnets with the tag ``Name=MySubnet``. The command specifies that the output is a simple text string. :: + + aws ec2 describe-subnets \ + --filters Name=tag:Name,Values=MySubnet \ + --output text Output:: - SUBNETS us-east-1a 251 10.0.1.0/24 False False available subnet-1a2b3c4d vpc-11223344 - TAGS Name MySubnet \ No newline at end of file + SUBNETS False us-east-1c use1-az1 250 10.0.0.0/24 False False False 111122223333 available arn:aws:ec2:us-east-1:111122223333:subnet/subnet-0d3d002af8EXAMPLE subnet-0d3d002af8EXAMPLE vpc-0065acced4EXAMPLE TAGS Name MySubnet + +For more information, see `Working with VPCs and Subnets `__ in the *AWS VPC User Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-tags.rst awscli-1.18.69/awscli/examples/ec2/describe-tags.rst --- awscli-1.11.13/awscli/examples/ec2/describe-tags.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-tags.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,121 +1,93 @@ -**To describe your tags** +**Example 1: To describe all tags for a single resource** -This example describes the tags for all your resources. +The following ``describe-tags`` example describes the tags for the specified instance. :: -Command:: - - aws ec2 describe-tags + aws ec2 describe-tags \ + --filters "Name=resource-id,Values=i-1234567890abcdef8" Output:: - { - "Tags": [ - { - "ResourceType": "image", - "ResourceId": "ami-78a54011", - "Value": "Production", - "Key": "Stack" - }, - { - "ResourceType": "image", - "ResourceId": "ami-3ac33653", - "Value": "Test", - "Key": "Stack" - }, - { - "ResourceType": "instance", - "ResourceId": "i-1234567890abcdef0", - "Value": "Production", - "Key": "Stack" - }, - { - "ResourceType": "instance", - "ResourceId": "i-1234567890abcdef1", - "Value": "Test", - "Key": "Stack" - }, - { - "ResourceType": "instance", - "ResourceId": "i-1234567890abcdef5", - "Value": "Beta Server", - "Key": "Name" - }, - { - "ResourceType": "volume", - "ResourceId": "vol-049df61146c4d7901", - "Value": "Project1", - "Key": "Purpose" - }, - { - "ResourceType": "volume", - "ResourceId": "vol-1234567890abcdef0", - "Value": "Logs", - "Key": "Purpose" - } - ] - } - -**To describe the tags for a single resource** + { + "Tags": [ + { + "ResourceType": "instance", + "ResourceId": "i-1234567890abcdef8", + "Value": "Test", + "Key": "Stack" + }, + { + "ResourceType": "instance", + "ResourceId": "i-1234567890abcdef8", + "Value": "Beta Server", + "Key": "Name" + } + ] + } -This example describes the tags for the specified instance. +**Example 2: To describe all tags for a resource type** -Command:: +The following ``describe-tags`` example describes the tags for your volumes. :: - aws ec2 describe-tags --filters "Name=resource-id,Values=i-1234567890abcdef8" + aws ec2 describe-tags \ + --filters "Name=resource-type,Values=volume" Output:: - { - "Tags": [ - { - "ResourceType": "instance", - "ResourceId": "i-1234567890abcdef8", - "Value": "Test", - "Key": "Stack" - }, - { - "ResourceType": "instance", - "ResourceId": "i-1234567890abcdef8", - "Value": "Beta Server", - "Key": "Name" - } - ] - } + { + "Tags": [ + { + "ResourceType": "volume", + "ResourceId": "vol-1234567890abcdef0", + "Value": "Project1", + "Key": "Purpose" + }, + { + "ResourceType": "volume", + "ResourceId": "vol-049df61146c4d7901", + "Value": "Logs", + "Key": "Purpose" + } + ] + } -**To describe the tags for a type of resource** +**Example 3: To describe all your tags** -This example describes the tags for your volumes. +The following ``describe-tags`` example describes the tags for all your resources. :: -Command:: + aws ec2 describe-tags - aws ec2 describe-tags --filters "Name=resource-type,Values=volume" +**Example 4: To describe the tags for your resources based on a tag key** -Output:: +The following ``describe-tags`` example describes the tags for your resources that have a tag with the key ``Stack``. :: - { - "Tags": [ - { - "ResourceType": "volume", - "ResourceId": "vol-1234567890abcdef0", - "Value": "Project1", - "Key": "Purpose" - }, - { - "ResourceType": "volume", - "ResourceId": "vol-049df61146c4d7901", - "Value": "Logs", - "Key": "Purpose" - } - ] - } + aws ec2 describe-tags \ + --filters Name=key,Values=Stack + +Output:: -**To describe the tags for your resources based on a key and a value** + { + "Tags": [ + { + "ResourceType": "volume", + "ResourceId": "vol-027552a73f021f3b", + "Value": "Production", + "Key": "Stack" + }, + { + "ResourceType": "instance", + "ResourceId": "i-1234567890abcdef8", + "Value": "Test", + "Key": "Stack" + } + ] + } -This example describes the tags for your resources that have the key ``Stack`` and a value ``Test``. +**Example 5: To describe the tags for your resources based on a tag key and tag value** -Command:: +The following ``describe-tags`` example describes the tags for your resources that have the tag ``Stack=Test``. :: - aws ec2 describe-tags --filters "Name=key,Values=Stack" "Name=value,Values=Test" + aws ec2 describe-tags \ + --filters Name=key,Values=Stack Name=value,Values=Test Output:: @@ -123,7 +95,7 @@ "Tags": [ { "ResourceType": "image", - "ResourceId": "ami-3ac33653", + "ResourceId": "ami-3ac336533f021f3bd", "Value": "Test", "Key": "Stack" }, @@ -136,22 +108,25 @@ ] } -This example describes the tags for all your instances that have a tag with the key ``Purpose`` and no value. +The following ``describe-tags`` example uses alternate syntax to describe resources with the tag ``Stack=Test``. :: -Command:: + aws ec2 describe-tags \ + --filters "Name=tag:Stack,Values=Test" - aws ec2 describe-tags --filters "Name=resource-type,Values=instance" "Name=key,Values=Purpose" "Name=value,Values=" - -Output:: +The following ``describe-tags`` example describes the tags for all your instances that have a tag with the key ``Purpose`` and no value. :: - { - "Tags": [ - { - "ResourceType": "instance", - "ResourceId": "i-1234567890abcdef5", - "Value": null, - "Key": "Purpose" - } - ] - } + aws ec2 describe-tags \ + --filters "Name=resource-type,Values=instance" "Name=key,Values=Purpose" "Name=value,Values=" +Output:: + + { + "Tags": [ + { + "ResourceType": "instance", + "ResourceId": "i-1234567890abcdef5", + "Value": null, + "Key": "Purpose" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-traffic-mirror-filters.rst awscli-1.18.69/awscli/examples/ec2/describe-traffic-mirror-filters.rst --- awscli-1.11.13/awscli/examples/ec2/describe-traffic-mirror-filters.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-traffic-mirror-filters.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,34 @@ +**To view your traffic mirror filters** + +The following ``describe-traffic-mirror-filters`` example displays details for all of your traffic mirror filters. :: + + aws ec2 describe-traffic-mirror-filters + +Output:: + + { + "TrafficMirrorFilters": [ + { + "TrafficMirrorFilterId": "tmf-0293f26e86EXAMPLE", + "IngressFilterRules": [ + { + "TrafficMirrorFilterRuleId": "tmfr-0ca76e0e08EXAMPLE", + "TrafficMirrorFilterId": "tmf-0293f26e86EXAMPLE", + "TrafficDirection": "ingress", + "RuleNumber": 100, + "RuleAction": "accept", + "Protocol": 6, + "DestinationCidrBlock": "10.0.0.0/24", + "SourceCidrBlock": "10.0.0.0/24", + "Description": "TCP Rule" + } + ], + "EgressFilterRules": [], + "NetworkServices": [], + "Description": "Exanple Filter", + "Tags": [] + } + ] + } + +For more information, see `View Your Traffic Mirror Filters `__ in the *AWS Traffic Mirroring Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-traffic-mirror-sessions.rst awscli-1.18.69/awscli/examples/ec2/describe-traffic-mirror-sessions.rst --- awscli-1.11.13/awscli/examples/ec2/describe-traffic-mirror-sessions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-traffic-mirror-sessions.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,42 @@ +**To describe a Traffic Mirror Session** + +The following ``describe-traffic-mirror-sessions`` example displays details of the your Traffic Mirror sessions. :: + + aws ec2 describe-traffic-mirror-sessions + +Output:: + + { + "TrafficMirrorSessions": [ + { + "Tags": [], + "VirtualNetworkId": 42, + "OwnerId": "111122223333", + "Description": "TCP Session", + "NetworkInterfaceId": "eni-0a471a5cf3EXAMPLE", + "TrafficMirrorTargetId": "tmt-0dabe9b0a6EXAMPLE", + "TrafficMirrorFilterId": "tmf-083e18f985EXAMPLE", + "PacketLength": 20, + "SessionNumber": 1, + "TrafficMirrorSessionId": "tms-0567a4c684EXAMPLE" + }, + { + "Tags": [ + { + "Key": "Name", + "Value": "tag test" + } + ], + "VirtualNetworkId": 13314501, + "OwnerId": "111122223333", + "Description": "TCP Session", + "NetworkInterfaceId": "eni-0a471a5cf3EXAMPLE", + "TrafficMirrorTargetId": "tmt-03665551cbEXAMPLE", + "TrafficMirrorFilterId": "tmf-06c787846cEXAMPLE", + "SessionNumber": 2, + "TrafficMirrorSessionId": "tms-0060101cf8EXAMPLE" + } + ] + } + +For more information, see `View Traffic Mirror Session Details `__ in the *AWS Traffic Mirroring Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-traffic-mirror-targets.rst awscli-1.18.69/awscli/examples/ec2/describe-traffic-mirror-targets.rst --- awscli-1.11.13/awscli/examples/ec2/describe-traffic-mirror-targets.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-traffic-mirror-targets.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,23 @@ +**To describe a Traffic Mirror Target** + +The following ``describe-traffic-mirror-targets`` example displays details of the specified Traffic Mirror target. :: + + aws ec2 describe-traffic-mirror-targets \ + --traffic-mirror-target-id tmt-0dabe9b0a6EXAMPLE + +Output:: + + { + "TrafficMirrorTargets": [ + { + "TrafficMirrorTargetId": "tmt-0dabe9b0a6EXAMPLE", + "NetworkLoadBalancerArn": "arn:aws:elasticloadbalancing:us-east-1:111122223333:loadbalancer/net/NLB/7cdec873fEXAMPLE", + "Type": "network-load-balancer", + "Description": "Example Network Load Balancer Target", + "OwnerId": "111122223333", + "Tags": [] + } + ] + } + +For more information, see `View Traffic Mirror Target Details `__ in the *AWS Traffic Mirroring Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-transit-gateway-attachments.rst awscli-1.18.69/awscli/examples/ec2/describe-transit-gateway-attachments.rst --- awscli-1.11.13/awscli/examples/ec2/describe-transit-gateway-attachments.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-transit-gateway-attachments.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,79 @@ +**To view your transit gateway attachments** + + The following ``describe-transit-gateway-attachments`` example displays details for your transit gateway attachments. :: + + aws ec2 describe-transit-gateway-attachments + +Output:: + + { + "TransitGatewayAttachments": [ + { + "TransitGatewayAttachmentId": "tgw-attach-01f8100bc7EXAMPLE", + "TransitGatewayId": "tgw-02f776b1a7EXAMPLE", + "TransitGatewayOwnerId": "123456789012", + "ResourceOwnerId": "123456789012", + "ResourceType": "vpc", + "ResourceId": "vpc-3EXAMPLE", + "State": "available", + "Association": { + "TransitGatewayRouteTableId": "tgw-rtb-002573ed1eEXAMPLE", + "State": "associated" + }, + "CreationTime": "2019-08-26T14:59:25.000Z", + "Tags": [ + { + "Key": "Name", + "Value": "Example" + } + ] + }, + { + "TransitGatewayAttachmentId": "tgw-attach-0b5968d3b6EXAMPLE", + "TransitGatewayId": "tgw-02f776b1a7EXAMPLE", + "TransitGatewayOwnerId": "123456789012", + "ResourceOwnerId": "123456789012", + "ResourceType": "vpc", + "ResourceId": "vpc-0065acced4EXAMPLE", + "State": "available", + "Association": { + "TransitGatewayRouteTableId": "tgw-rtb-002573ed1eEXAMPLE", + "State": "associated" + }, + "CreationTime": "2019-08-07T17:03:07.000Z", + "Tags": [] + }, + { + "TransitGatewayAttachmentId": "tgw-attach-08e0bc912cEXAMPLE", + "TransitGatewayId": "tgw-02f776b1a7EXAMPLE", + "TransitGatewayOwnerId": "123456789012", + "ResourceOwnerId": "123456789012", + "ResourceType": "direct-connect-gateway", + "ResourceId": "11460968-4ac1-4fd3-bdb2-00599EXAMPLE", + "State": "available", + "Association": { + "TransitGatewayRouteTableId": "tgw-rtb-002573ed1eEXAMPLE", + "State": "associated" + }, + "CreationTime": "2019-08-14T20:27:44.000Z", + "Tags": [] + }, + { + "TransitGatewayAttachmentId": "tgw-attach-0a89069f57EXAMPLE", + "TransitGatewayId": "tgw-02f776b1a7EXAMPLE", + "TransitGatewayOwnerId": "123456789012", + "ResourceOwnerId": "123456789012", + "ResourceType": "direct-connect-gateway", + "ResourceId": "8384da05-13ce-4a91-aada-5a1baEXAMPLE", + "State": "available", + "Association": { + "TransitGatewayRouteTableId": "tgw-rtb-002573ed1eEXAMPLE", + "State": "associated" + }, + "CreationTime": "2019-08-14T20:33:02.000Z", + "Tags": [] + } + ] + } + +For more information, see `Working with Transit Gateways `__ in the *AWS Transit Gateways Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-transit-gateway-peering-attachments.rst awscli-1.18.69/awscli/examples/ec2/describe-transit-gateway-peering-attachments.rst --- awscli-1.11.13/awscli/examples/ec2/describe-transit-gateway-peering-attachments.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-transit-gateway-peering-attachments.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/describe-transit-gateway-route-tables.rst awscli-1.18.69/awscli/examples/ec2/describe-transit-gateway-route-tables.rst --- awscli-1.11.13/awscli/examples/ec2/describe-transit-gateway-route-tables.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-transit-gateway-route-tables.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,32 @@ +**To describe your transit gateway route tables** + +The following ``describe-transit-gateway-route-tables`` examples displays details for all of your transit gateway route tables. :: + + aws ec2 describe-transit-gateway-route-tables + +Output:: + + { + "TransitGatewayRouteTables": [ + { + "TransitGatewayRouteTableId": "tgw-rtb-0ca78a549EXAMPLE", + "TransitGatewayId": "tgw-0bc994abffEXAMPLE", + "State": "available", + "DefaultAssociationRouteTable": true, + "DefaultPropagationRouteTable": true, + "CreationTime": "2018-11-28T14:24:49.000Z", + "Tags": [] + }, + { + "TransitGatewayRouteTableId": "tgw-rtb-0e8f48f148EXAMPLE", + "TransitGatewayId": "tgw-0043d72bb4EXAMPLE", + "State": "available", + "DefaultAssociationRouteTable": true, + "DefaultPropagationRouteTable": true, + "CreationTime": "2018-11-28T14:24:00.000Z", + "Tags": [] + } + ] + } + +For more information, see `View Transit Gateway Route Tables `__ in the *AWS Transit Gateways Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-transit-gateways.rst awscli-1.18.69/awscli/examples/ec2/describe-transit-gateways.rst --- awscli-1.11.13/awscli/examples/ec2/describe-transit-gateways.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-transit-gateways.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,54 @@ +**To describe your transit gateways** + +The following ``describe-transit-gateways`` example retrieves details about your transit gateways. :: + + aws ec2 describe-transit-gateways + +Output:: + + { + "TransitGateways": [ + { + "TransitGatewayId": "tgw-0262a0e521EXAMPLE", + "TransitGatewayArn": "arn:aws:ec2:us-east-2:111122223333:transit-gateway/tgw-0262a0e521EXAMPLE", + "State": "available", + "OwnerId": "111122223333", + "Description": "MyTGW", + "CreationTime": "2019-07-10T14:02:12.000Z", + "Options": { + "AmazonSideAsn": 64516, + "AutoAcceptSharedAttachments": "enable", + "DefaultRouteTableAssociation": "enable", + "AssociationDefaultRouteTableId": "tgw-rtb-018774adf3EXAMPLE", + "DefaultRouteTablePropagation": "enable", + "PropagationDefaultRouteTableId": "tgw-rtb-018774adf3EXAMPLE", + "VpnEcmpSupport": "enable", + "DnsSupport": "enable" + }, + "Tags": [] + }, + { + "TransitGatewayId": "tgw-0fb8421e2dEXAMPLE", + "TransitGatewayArn": "arn:aws:ec2:us-east-2:111122223333:transit-gateway/tgw-0fb8421e2da853bf3", + "State": "available", + "OwnerId": "111122223333", + "CreationTime": "2019-03-15T22:57:33.000Z", + "Options": { + "AmazonSideAsn": 65412, + "AutoAcceptSharedAttachments": "disable", + "DefaultRouteTableAssociation": "enable", + "AssociationDefaultRouteTableId": "tgw-rtb-06a241a3d8EXAMPLE", + "DefaultRouteTablePropagation": "enable", + "PropagationDefaultRouteTableId": "tgw-rtb-06a241a3d8EXAMPLE", + "VpnEcmpSupport": "enable", + "DnsSupport": "enable" + }, + "Tags": [ + { + "Key": "Name", + "Value": "TGW1" + } + ] + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-transit-gateway-vpc-attachments.rst awscli-1.18.69/awscli/examples/ec2/describe-transit-gateway-vpc-attachments.rst --- awscli-1.11.13/awscli/examples/ec2/describe-transit-gateway-vpc-attachments.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-transit-gateway-vpc-attachments.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,36 @@ +**To describe your transit gateway VPC attachments** + +The following ``describe-transit-gateway-vpc-attachments`` example displays details for all of your transit gateway VPC attachments. :: + + aws ec2 describe-transit-gateway-vpc-attachments + +Output:: + + { + "TransitGatewayVpcAttachments": [ + { + "TransitGatewayAttachmentId": "tgw-attach-0a08e88308EXAMPLE", + "TransitGatewayId": "tgw-0043d72bb4EXAMPLE", + "VpcId": "vpc-0f501f7ee8EXAMPLE", + "VpcOwnerId": "111122223333", + "State": "available", + "SubnetIds": [ + "subnet-045d586432EXAMPLE", + "subnet-0a0ad478a6EXAMPLE" + ], + "CreationTime": "2019-02-13T11:04:02.000Z", + "Options": { + "DnsSupport": "enable", + "Ipv6Support": "disable" + }, + "Tags": [ + { + "Key": "Name", + "Value": "attachment name" + } + ] + } + ] + } + +For more information, see `View Your VPC Attachments `__ in the *AWS Transit Gateways* diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-volumes-modifications.rst awscli-1.18.69/awscli/examples/ec2/describe-volumes-modifications.rst --- awscli-1.11.13/awscli/examples/ec2/describe-volumes-modifications.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-volumes-modifications.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,23 @@ +**To describe the modification status for a volume** + +The following ``describe-volumes-modifications`` example describes the volume modification status of the specified volume. :: + + aws ec2 describe-volumes-modifications \ + --volume-ids vol-1234567890abcdef0 + +Output:: + + { + "VolumeModification": { + "TargetSize": 150, + "TargetVolumeType": "io1", + "ModificationState": "optimizing", + "VolumeId": " vol-1234567890abcdef0", + "TargetIops": 100, + "StartTime": "2019-05-17T11:27:19.000Z", + "Progress": 70, + "OriginalVolumeType": "io1", + "OriginalIops": 100, + "OriginalSize": 100 + } + } diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-volumes.rst awscli-1.18.69/awscli/examples/ec2/describe-volumes.rst --- awscli-1.11.13/awscli/examples/ec2/describe-volumes.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-volumes.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,110 +1,136 @@ -**To describe all volumes** +**Example 1: To describe all volumes** -This example command describes all of your volumes in the default region. - -Command:: +The following ``describe-volumes`` example describes all of your volumes in the current Region. :: aws ec2 describe-volumes Output:: - { - "Volumes": [ - { - "AvailabilityZone": "us-east-1a", - "Attachments": [ - { - "AttachTime": "2013-12-18T22:35:00.000Z", - "InstanceId": "i-1234567890abcdef0", - "VolumeId": "vol-049df61146c4d7901", - "State": "attached", - "DeleteOnTermination": true, - "Device": "/dev/sda1" - } - ], - "VolumeType": "standard", - "VolumeId": "vol-049df61146c4d7901", - "State": "in-use", - "SnapshotId": "snap-1234567890abcdef0", - "CreateTime": "2013-12-18T22:35:00.084Z", - "Size": 8 - }, - { - "AvailabilityZone": "us-east-1a", - "Attachments": [], - "VolumeType": "io1", - "VolumeId": "vol-1234567890abcdef0", - "State": "available", - "Iops": 1000, - "SnapshotId": null, - "CreateTime": "2014-02-27T00:02:41.791Z", - "Size": 100 - } - ] - } - -**To describe volumes that are attached to a specific instance** + { + "Volumes": [ + { + "AvailabilityZone": "us-east-1a", + "Attachments": [ + { + "AttachTime": "2013-12-18T22:35:00.000Z", + "InstanceId": "i-1234567890abcdef0", + "VolumeId": "vol-049df61146c4d7901", + "State": "attached", + "DeleteOnTermination": true, + "Device": "/dev/sda1" + } + ], + "Encrypted": false, + "VolumeType": "gp2", + "VolumeId": "vol-049df61146c4d7901", + "State": "in-use", + "SnapshotId": "snap-1234567890abcdef0", + "CreateTime": "2013-12-18T22:35:00.084Z", + "Size": 8 + }, + { + "AvailabilityZone": "us-east-1a", + "Attachments": [], + "Encrypted": false, + "VolumeType": "gp2", + "VolumeId": "vol-1234567890abcdef0", + "State": "available", + "Iops": 1000, + "SnapshotId": null, + "CreateTime": "2014-02-27T00:02:41.791Z", + "Size": 100 + } + ] + } -This example command describes all volumes that are both attached to the instance with the ID i-1234567890abcdef0 and set to delete when the instance terminates. +**Example 2: To describe volumes that are attached to a specific instance** -Command:: +The following ``describe-volumes`` example describes all volumes that are both attached to the specified instance and set to delete when the instance terminates. :: - aws ec2 describe-volumes --region us-east-1 --filters Name=attachment.instance-id,Values=i-1234567890abcdef0 Name=attachment.delete-on-termination,Values=true + aws ec2 describe-volumes \ + --region us-east-1 \ + --filters Name=attachment.instance-id,Values=i-1234567890abcdef0 Name=attachment.delete-on-termination,Values=true Output:: - { - "Volumes": [ - { - "AvailabilityZone": "us-east-1a", - "Attachments": [ - { - "AttachTime": "2013-12-18T22:35:00.000Z", - "InstanceId": "i-1234567890abcdef0", - "VolumeId": "vol-049df61146c4d7901", - "State": "attached", - "DeleteOnTermination": true, - "Device": "/dev/sda1" - } - ], - "VolumeType": "standard", - "VolumeId": "vol-049df61146c4d7901", - "State": "in-use", - "SnapshotId": "snap-1234567890abcdef0", - "CreateTime": "2013-12-18T22:35:00.084Z", - "Size": 8 - } - ] - } - -**To describe tagged volumes and filter the output** + { + "Volumes": [ + { + "AvailabilityZone": "us-east-1a", + "Attachments": [ + { + "AttachTime": "2013-12-18T22:35:00.000Z", + "InstanceId": "i-1234567890abcdef0", + "VolumeId": "vol-049df61146c4d7901", + "State": "attached", + "DeleteOnTermination": true, + "Device": "/dev/sda1" + } + ], + "Encrypted": false, + "VolumeType": "gp2", + "VolumeId": "vol-049df61146c4d7901", + "State": "in-use", + "SnapshotId": "snap-1234567890abcdef0", + "CreateTime": "2013-12-18T22:35:00.084Z", + "Size": 8 + } + ] + } -This example command describes all volumes that have the tag key ``Name`` and a value that begins with ``Test``. The output is filtered to display only the tags and IDs of the volumes. +**Example 3: To describe available volumes in a specific Availability Zone** -Command:: +The following ``describe-volumes`` example describes all volumes that have a status of ``available`` and are in the specified Availability Zone. :: - aws ec2 describe-volumes --filters Name=tag-key,Values="Name" Name=tag-value,Values="Test*" --query 'Volumes[*].{ID:VolumeId,Tag:Tags}' + aws ec2 describe-volumes \ + --filters Name=status,Values=available Name=availability-zone,Values=us-east-1a Output:: - [ - { - "Tag": [ - { - "Value": "Test2", - "Key": "Name" - } - ], - "ID": "vol-1234567890abcdef0" - }, { - "Tag": [ + "Volumes": [ { - "Value": "Test1", - "Key": "Name" + "AvailabilityZone": "us-east-1a", + "Attachments": [], + "Encrypted": false, + "VolumeType": "gp2", + "VolumeId": "vol-1234567890abcdef0", + "State": "available", + "Iops": 1000, + "SnapshotId": null, + "CreateTime": "2014-02-27T00:02:41.791Z", + "Size": 100 } - ], - "ID": "vol-049df61146c4d7901" - } - ] + ] + } + +**Example 4: To describe tagged volumes and filter the output** + +The following ``describe-volumes`` example describes all volumes that have the tag key ``Name`` and a value that begins with ``Test``. The output is then filtered with a query that displays only the tags and IDs of the volumes. :: + + aws ec2 describe-volumes \ + --filters Name=tag:Name,Values=Test* \ + --query "Volumes[*].{ID:VolumeId,Tag:Tags}" + +Output:: + [ + { + "Tag": [ + { + "Value": "Test2", + "Key": "Name" + } + ], + "ID": "vol-1234567890abcdef0" + }, + { + "Tag": [ + { + "Value": "Test1", + "Key": "Name" + } + ], + "ID": "vol-049df61146c4d7901" + } + ] diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-vpc-endpoint-connection-notifications.rst awscli-1.18.69/awscli/examples/ec2/describe-vpc-endpoint-connection-notifications.rst --- awscli-1.11.13/awscli/examples/ec2/describe-vpc-endpoint-connection-notifications.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-vpc-endpoint-connection-notifications.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,25 @@ +**To describe endpoint connection notifications** + +The following ``describe-vpc-endpoint-connection-notifications`` example describes all of your endpoint connection notifications. :: + + aws ec2 describe-vpc-endpoint-connection-notifications + +Output:: + + { + "ConnectionNotificationSet": [ + { + "ConnectionNotificationState": "Enabled", + "ConnectionNotificationType": "Topic", + "ConnectionEvents": [ + "Accept", + "Reject", + "Delete", + "Connect" + ], + "ConnectionNotificationId": "vpce-nfn-04bcb952bc8af7abc", + "ConnectionNotificationArn": "arn:aws:sns:us-east-1:123456789012:VpceNotification", + "VpcEndpointId": "vpce-0324151a02f327123" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-vpc-endpoint-connections.rst awscli-1.18.69/awscli/examples/ec2/describe-vpc-endpoint-connections.rst --- awscli-1.11.13/awscli/examples/ec2/describe-vpc-endpoint-connections.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-vpc-endpoint-connections.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To describe VPC endpoint connections** + +This example describes the interface endpoint connections to your endpoint service and filters the results to display endpoints that are ``PendingAcceptance``. + +Command:: + + aws ec2 describe-vpc-endpoint-connections --filters Name=vpc-endpoint-state,Values=pendingAcceptance + +Output:: + + { + "VpcEndpointConnections": [ + { + "VpcEndpointId": "vpce-0abed31004e618123", + "ServiceId": "vpce-svc-0abced088d20def56", + "CreationTimestamp": "2017-11-30T10:00:24.350Z", + "VpcEndpointState": "pendingAcceptance", + "VpcEndpointOwner": "123456789012" + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-vpc-endpoint-service-configurations.rst awscli-1.18.69/awscli/examples/ec2/describe-vpc-endpoint-service-configurations.rst --- awscli-1.11.13/awscli/examples/ec2/describe-vpc-endpoint-service-configurations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-vpc-endpoint-service-configurations.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,34 @@ +**To describe endpoint service configurations** + +This example describes your endpoint service configurations. + +Command:: + + aws ec2 describe-vpc-endpoint-service-configurations + +Output:: + + { + "ServiceConfigurations": [ + { + "ServiceType": [ + { + "ServiceType": "Interface" + } + ], + "NetworkLoadBalancerArns": [ + "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/net/NLBforService/8218753950b25648" + ], + "ServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-0e7555fb6441987e1", + "ServiceState": "Available", + "ServiceId": "vpce-svc-0e7555fb6441987e1", + "AcceptanceRequired": true, + "AvailabilityZones": [ + "us-east-1d" + ], + "BaseEndpointDnsNames": [ + "vpce-svc-0e7555fb6441987e1.us-east-1.vpce.amazonaws.com" + ] + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-vpc-endpoint-service-permissions.rst awscli-1.18.69/awscli/examples/ec2/describe-vpc-endpoint-service-permissions.rst --- awscli-1.11.13/awscli/examples/ec2/describe-vpc-endpoint-service-permissions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-vpc-endpoint-service-permissions.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To describe endpoint service permissions** + +This example describes the permissions for the specified endpoint service. + +Command:: + + aws ec2 describe-vpc-endpoint-service-permissions --service-id vpce-svc-03d5ebb7d9579a2b3 + +Output:: + + { + "AllowedPrincipals": [ + { + "PrincipalType": "Account", + "Principal": "arn:aws:iam::123456789012:root" + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-vpc-endpoint-services.rst awscli-1.18.69/awscli/examples/ec2/describe-vpc-endpoint-services.rst --- awscli-1.11.13/awscli/examples/ec2/describe-vpc-endpoint-services.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-vpc-endpoint-services.rst 2020-05-28 19:25:48.000000000 +0000 @@ -9,7 +9,173 @@ Output:: { + "ServiceDetails": [ + { + "ServiceType": [ + { + "ServiceType": "Gateway" + } + ], + "AcceptanceRequired": false, + "ServiceName": "com.amazonaws.us-east-1.dynamodb", + "VpcEndpointPolicySupported": true, + "Owner": "amazon", + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1c", + "us-east-1d", + "us-east-1e", + "us-east-1f" + ], + "BaseEndpointDnsNames": [ + "dynamodb.us-east-1.amazonaws.com" + ] + }, + { + "ServiceType": [ + { + "ServiceType": "Interface" + } + ], + "PrivateDnsName": "ec2.us-east-1.amazonaws.com", + "ServiceName": "com.amazonaws.us-east-1.ec2", + "VpcEndpointPolicySupported": false, + "Owner": "amazon", + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1c", + "us-east-1d", + "us-east-1e", + "us-east-1f" + ], + "AcceptanceRequired": false, + "BaseEndpointDnsNames": [ + "ec2.us-east-1.vpce.amazonaws.com" + ] + }, + { + "ServiceType": [ + { + "ServiceType": "Interface" + } + ], + "PrivateDnsName": "ec2messages.us-east-1.amazonaws.com", + "ServiceName": "com.amazonaws.us-east-1.ec2messages", + "VpcEndpointPolicySupported": false, + "Owner": "amazon", + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1c", + "us-east-1d", + "us-east-1e", + "us-east-1f" + ], + "AcceptanceRequired": false, + "BaseEndpointDnsNames": [ + "ec2messages.us-east-1.vpce.amazonaws.com" + ] + }, + { + "ServiceType": [ + { + "ServiceType": "Interface" + } + ], + "PrivateDnsName": "elasticloadbalancing.us-east-1.amazonaws.com", + "ServiceName": "com.amazonaws.us-east-1.elasticloadbalancing", + "VpcEndpointPolicySupported": false, + "Owner": "amazon", + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1c", + "us-east-1d", + "us-east-1e", + "us-east-1f" + ], + "AcceptanceRequired": false, + "BaseEndpointDnsNames": [ + "elasticloadbalancing.us-east-1.vpce.amazonaws.com" + ] + }, + { + "ServiceType": [ + { + "ServiceType": "Interface" + } + ], + "PrivateDnsName": "kinesis.us-east-1.amazonaws.com", + "ServiceName": "com.amazonaws.us-east-1.kinesis-streams", + "VpcEndpointPolicySupported": false, + "Owner": "amazon", + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1c", + "us-east-1d", + "us-east-1e", + "us-east-1f" + ], + "AcceptanceRequired": false, + "BaseEndpointDnsNames": [ + "kinesis.us-east-1.vpce.amazonaws.com" + ] + }, + { + "ServiceType": [ + { + "ServiceType": "Gateway" + } + ], + "AcceptanceRequired": false, + "ServiceName": "com.amazonaws.us-east-1.s3", + "VpcEndpointPolicySupported": true, + "Owner": "amazon", + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1c", + "us-east-1d", + "us-east-1e", + "us-east-1f" + ], + "BaseEndpointDnsNames": [ + "s3.us-east-1.amazonaws.com" + ] + }, + { + "ServiceType": [ + { + "ServiceType": "Interface" + } + ], + "PrivateDnsName": "ssm.us-east-1.amazonaws.com", + "ServiceName": "com.amazonaws.us-east-1.ssm", + "VpcEndpointPolicySupported": true, + "Owner": "amazon", + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1c", + "us-east-1d", + "us-east-1e" + ], + "AcceptanceRequired": false, + "BaseEndpointDnsNames": [ + "ssm.us-east-1.vpce.amazonaws.com" + ] + } + ], "ServiceNames": [ - "com.amazonaws.us-east-1.s3" + "com.amazonaws.us-east-1.dynamodb", + "com.amazonaws.us-east-1.ec2", + "com.amazonaws.us-east-1.ec2messages", + "com.amazonaws.us-east-1.elasticloadbalancing", + "com.amazonaws.us-east-1.kinesis-streams", + "com.amazonaws.us-east-1.s3", + "com.amazonaws.us-east-1.ssm" ] } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-vpc-endpoints.rst awscli-1.18.69/awscli/examples/ec2/describe-vpc-endpoints.rst --- awscli-1.11.13/awscli/examples/ec2/describe-vpc-endpoints.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-vpc-endpoints.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,25 +1,72 @@ -**To describe endpoints** +**To describe your VPC endpoints** -This example describes all of your endpoints. +The following ``describe-vpc-endpoints`` example displays details for all of your endpoints. :: -Command:: - - aws ec2 describe-vpc-endpoints + aws ec2 describe-vpc-endpoints Output:: - { - "VpcEndpoints": [ - { - "PolicyDocument": "{\"Version\":\"2008-10-17\",\"Statement\":[{\"Sid\":\"\",\"Effect\":\"Allow\",\"Principal\":\"*\",\"Action\":\"*\",\"Resource\":\"*\"}]}", - "VpcId": "vpc-ec43eb89", - "State": "available", - "ServiceName": "com.amazonaws.us-east-1.s3", - "RouteTableIds": [ - "rtb-4e5ef02b" - ], - "VpcEndpointId": "vpce-3ecf2a57", - "CreationTimestamp": "2015-05-15T09:40:50Z" - } - ] - } \ No newline at end of file + { + "VpcEndpoints": [ + { + "PolicyDocument": "{\"Version\":\"2008-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":\"*\",\"Action\":\"*\",\"Resource\":\"*\"}]}", + "VpcId": "vpc-aabb1122", + "NetworkInterfaceIds": [], + "SubnetIds": [], + "PrivateDnsEnabled": true, + "State": "available", + "ServiceName": "com.amazonaws.us-east-1.dynamodb", + "RouteTableIds": [ + "rtb-3d560345" + ], + "Groups": [], + "VpcEndpointId": "vpce-032a826a", + "VpcEndpointType": "Gateway", + "CreationTimestamp": "2017-09-05T20:41:28Z", + "DnsEntries": [], + "OwnerId": "123456789012" + }, + { + "PolicyDocument": "{\n \"Statement\": [\n {\n \"Action\": \"*\", \n \"Effect\": \"Allow\", \n \"Principal\": \"*\", \n \"Resource\": \"*\"\n }\n ]\n}", + "VpcId": "vpc-1a2b3c4d", + "NetworkInterfaceIds": [ + "eni-2ec2b084", + "eni-1b4a65cf" + ], + "SubnetIds": [ + "subnet-d6fcaa8d", + "subnet-7b16de0c" + ], + "PrivateDnsEnabled": false, + "State": "available", + "ServiceName": "com.amazonaws.us-east-1.elasticloadbalancing", + "RouteTableIds": [], + "Groups": [ + { + "GroupName": "default", + "GroupId": "sg-54e8bf31" + } + ], + "VpcEndpointId": "vpce-0f89a33420c1931d7", + "VpcEndpointType": "Interface", + "CreationTimestamp": "2017-09-05T17:55:27.583Z", + "DnsEntries": [ + { + "HostedZoneId": "Z7HUB22UULQXV", + "DnsName": "vpce-0f89a33420c1931d7-bluzidnv.elasticloadbalancing.us-east-1.vpce.amazonaws.com" + }, + { + "HostedZoneId": "Z7HUB22UULQXV", + "DnsName": "vpce-0f89a33420c1931d7-bluzidnv-us-east-1b.elasticloadbalancing.us-east-1.vpce.amazonaws.com" + }, + { + "HostedZoneId": "Z7HUB22UULQXV", + "DnsName": "vpce-0f89a33420c1931d7-bluzidnv-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com" + } + ], + "OwnerId": "123456789012" + } + ] + } + +For more information, see `Modifying a Gateway Endpoint `__ in the *AWS VPC User Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-vpc-peering-connections.rst awscli-1.18.69/awscli/examples/ec2/describe-vpc-peering-connections.rst --- awscli-1.11.13/awscli/examples/ec2/describe-vpc-peering-connections.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-vpc-peering-connections.rst 2020-05-28 19:25:48.000000000 +0000 @@ -72,11 +72,11 @@ aws ec2 describe-vpc-peering-connections --filters Name=status-code,Values=pending-acceptance -This example describes all of your VPC peering connections that have the tag Name=Finance or Name=Accounts. +This example describes all of your VPC peering connections that have the tag Owner=Finance. Command:: - aws ec2 describe-vpc-peering-connections --filters Name=tag-key,Values=Name Name=tag-value,Values=Finance,Accounts + aws ec2 describe-vpc-peering-connections --filters Name=tag:Owner,Values=Finance This example describes all of the VPC peering connections you requested for the specified VPC, vpc-1a2b3c4d. diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-vpcs.rst awscli-1.18.69/awscli/examples/ec2/describe-vpcs.rst --- awscli-1.11.13/awscli/examples/ec2/describe-vpcs.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-vpcs.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,65 +1,98 @@ -**To describe your VPCs** +**Example 1: To describe all of your VPCs** -This example describes your VPCs. +The following ``describe-vpcs`` example retrieves details about your VPCs. :: -Command:: - - aws ec2 describe-vpcs + aws ec2 describe-vpcs Output:: - { - "Vpcs": [ - { - "VpcId": "vpc-a01106c2", - "InstanceTenancy": "default", - "Tags": [ - { - "Value": "MyVPC", - "Key": "Name" - } - ], - "State": "available", - "DhcpOptionsId": "dopt-7a8b9c2d", - "CidrBlock": "10.0.0.0/16", - "IsDefault": false - }, - { - "VpcId": "vpc-b61106d4", - "InstanceTenancy": "dedicated", - "State": "available", - "DhcpOptionsId": "dopt-97eb5efa", - "CidrBlock": "10.50.0.0/16", - "IsDefault": false - } - ] - } - -**To describe a specific VPC** + { + "Vpcs": [ + { + "CidrBlock": "30.1.0.0/16", + "DhcpOptionsId": "dopt-19edf471", + "State": "available", + "VpcId": "vpc-0e9801d129EXAMPLE", + "OwnerId": "111122223333", + "InstanceTenancy": "default", + "CidrBlockAssociationSet": [ + { + "AssociationId": "vpc-cidr-assoc-062c64cfafEXAMPLE", + "CidrBlock": "30.1.0.0/16", + "CidrBlockState": { + "State": "associated" + } + } + ], + "IsDefault": false, + "Tags": [ + { + "Key": "Name", + "Value": "Not Shared" + } + ] + }, + { + "CidrBlock": "10.0.0.0/16", + "DhcpOptionsId": "dopt-19edf471", + "State": "available", + "VpcId": "vpc-06e4ab6c6cEXAMPLE", + "OwnerId": "222222222222", + "InstanceTenancy": "default", + "CidrBlockAssociationSet": [ + { + "AssociationId": "vpc-cidr-assoc-00b17b4eddEXAMPLE", + "CidrBlock": "10.0.0.0/16", + "CidrBlockState": { + "State": "associated" + } + } + ], + "IsDefault": false, + "Tags": [ + { + "Key": "Name", + "Value": "Shared VPC" + } + ] + } + ] + } -This example describes the specified VPC. +**Example 2: To describe a specified VPC** -Command:: +The following ``describe-vpcs`` example retrieves details for the specified VPC. :: - aws ec2 describe-vpcs --vpc-ids vpc-a01106c2 + aws ec2 describe-vpcs \ + --vpc-ids vpc-06e4ab6c6cEXAMPLE Output:: - { - "Vpcs": [ - { - "VpcId": "vpc-a01106c2", - "InstanceTenancy": "default", - "Tags": [ - { - "Value": "MyVPC", - "Key": "Name" - } - ], - "State": "available", - "DhcpOptionsId": "dopt-7a8b9c2d", - "CidrBlock": "10.0.0.0/16", - "IsDefault": false - } - ] - } \ No newline at end of file + { + "Vpcs": [ + { + "CidrBlock": "10.0.0.0/16", + "DhcpOptionsId": "dopt-19edf471", + "State": "available", + "VpcId": "vpc-06e4ab6c6cEXAMPLE", + "OwnerId": "111122223333", + "InstanceTenancy": "default", + "CidrBlockAssociationSet": [ + { + "AssociationId": "vpc-cidr-assoc-00b17b4eddEXAMPLE", + "CidrBlock": "10.0.0.0/16", + "CidrBlockState": { + "State": "associated" + } + } + ], + "IsDefault": false, + "Tags": [ + { + "Key": "Name", + "Value": "Shared VPC" + } + ] + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/ec2/describe-vpn-connections.rst awscli-1.18.69/awscli/examples/ec2/describe-vpn-connections.rst --- awscli-1.11.13/awscli/examples/ec2/describe-vpn-connections.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/describe-vpn-connections.rst 2020-05-28 19:25:48.000000000 +0000 @@ -8,32 +8,43 @@ Output:: - { - "VpnConnections": { - "VpnConnectionId": "vpn-40f41529" - "CustomerGatewayConfiguration": "...configuration information...", - "VgwTelemetry": [ - { - "Status": "DOWN", - "AcceptedRouteCount": 0, - "OutsideIpAddress": "72.21.209.192", - "LastStatusChange": "2013-02-04T20:19:34.000Z", - "StatusMessage": "IPSEC IS DOWN" + { + "VpnConnections": { + "VpnConnectionId": "vpn-40f41529", + "Tags": [ + { + "Value": "MyBGPVPN", + "Key": "Name" + } + ], + "CustomerGatewayConfiguration": "...configuration information...", + "Routes": [], + "State": "available", + "VpnGatewayId": "vgw-9a4cacf3", + "CustomerGatewayId": "cgw-0e11f167", + "Type": "ipsec.1", + "Options": { + "StaticRoutesOnly": false }, - { - "Status": "DOWN", - "AcceptedRouteCount": 0, - "OutsideIpAddress": "72.21.209.224", - "LastStatusChange": "2013-02-04T20:19:34.000Z", - "StatusMessage": "IPSEC IS DOWN" - } - ], - "State": "available", - "VpnGatewayId": "vgw-9a4cacf3", - "CustomerGatewayId": "cgw-0e11f167" - "Type": "ipsec.1" - } - } + "Category": "VPN", + "VgwTelemetry": [ + { + "Status": "DOWN", + "AcceptedRouteCount": 0, + "OutsideIpAddress": "72.21.209.192", + "LastStatusChange": "2013-02-04T20:19:34.000Z", + "StatusMessage": "IPSEC IS DOWN" + }, + { + "Status": "DOWN", + "AcceptedRouteCount": 0, + "OutsideIpAddress": "72.21.209.224", + "LastStatusChange": "2013-02-04T20:19:34.000Z", + "StatusMessage": "IPSEC IS DOWN" + } + ] + } + } **To describe your available VPN connections** diff -Nru awscli-1.11.13/awscli/examples/ec2/disable-ebs-encryption-by-default.rst awscli-1.18.69/awscli/examples/ec2/disable-ebs-encryption-by-default.rst --- awscli-1.11.13/awscli/examples/ec2/disable-ebs-encryption-by-default.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/disable-ebs-encryption-by-default.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To disable EBS encryption by default** + +The following ``disable-ebs-encryption-by-default`` example disables EBS encryption by default for your AWS account in the current Region. :: + + aws ec2 disable-ebs-encryption-by-default + +Output:: + + { + "EbsEncryptionByDefault": false + } diff -Nru awscli-1.11.13/awscli/examples/ec2/disable-fast-snapshot-restores.rst awscli-1.18.69/awscli/examples/ec2/disable-fast-snapshot-restores.rst --- awscli-1.11.13/awscli/examples/ec2/disable-fast-snapshot-restores.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/disable-fast-snapshot-restores.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/disable-transit-gateway-route-table-propagation.rst awscli-1.18.69/awscli/examples/ec2/disable-transit-gateway-route-table-propagation.rst --- awscli-1.11.13/awscli/examples/ec2/disable-transit-gateway-route-table-propagation.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/disable-transit-gateway-route-table-propagation.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To disable a transit gateway attachment to propagate routes to the specified propagation route table** + +The following ``disable-transit-gateway-route-table-propagation`` example disables the specified attachment to propagate routes to the specified propagation route table. :: + + aws ec2 disable-transit-gateway-route-table-propagation \ + --transit-gateway-route-table-id tgw-rtb-0a823edbdeEXAMPLE \ + --transit-gateway-attachment-id tgw-attach-09b52ccdb5EXAMPLE + +Output:: + + { + "Propagation": { + "TransitGatewayAttachmentId": "tgw-attach-09b52ccdb5EXAMPLE", + "ResourceId": "vpc-4d7de228", + "ResourceType": "vpc", + "TransitGatewayRouteTableId": "tgw-rtb-0a823edbdeEXAMPLE", + "State": "disabled" + } + } + +For more information, see `Disable Route Table Propagation `__ in the *AWS Transit Gateways Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/disassociate-client-vpn-target-network.rst awscli-1.18.69/awscli/examples/ec2/disassociate-client-vpn-target-network.rst --- awscli-1.11.13/awscli/examples/ec2/disassociate-client-vpn-target-network.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/disassociate-client-vpn-target-network.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To disassociate a network from a Client VPN endpoint** + +The following ``disassociate-client-vpn-target-network`` example disassociates the target network that's associated with the ``cvpn-assoc-12312312312312312`` association ID for the specified Client VPN endpoint. :: + + aws ec2 disassociate-client-vpn-target-network \ + --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde \ + --association-id cvpn-assoc-12312312312312312 + +Output:: + + { + "AssociationId": "cvpn-assoc-12312312312312312", + "Status": { + "Code": "disassociating" + } + } + +For more information, see `Target Networks `__ in the *AWS Client VPN Administrator Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/disassociate-iam-instance-profile.rst awscli-1.18.69/awscli/examples/ec2/disassociate-iam-instance-profile.rst --- awscli-1.11.13/awscli/examples/ec2/disassociate-iam-instance-profile.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/disassociate-iam-instance-profile.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To disassociate an IAM instance profile** + +This example disassociates an IAM instance profile with the association ID ``iip-assoc-05020b59952902f5f``. + +Command:: + + aws ec2 disassociate-iam-instance-profile --association-id iip-assoc-05020b59952902f5f + +Output:: + + { + "IamInstanceProfileAssociation": { + "InstanceId": "i-123456789abcde123", + "State": "disassociating", + "AssociationId": "iip-assoc-05020b59952902f5f", + "IamInstanceProfile": { + "Id": "AIPAI5IVIHMFFYY2DKV5Y", + "Arn": "arn:aws:iam::123456789012:instance-profile/admin-role" + } + } + } diff -Nru awscli-1.11.13/awscli/examples/ec2/disassociate-subnet-cidr-block.rst awscli-1.18.69/awscli/examples/ec2/disassociate-subnet-cidr-block.rst --- awscli-1.11.13/awscli/examples/ec2/disassociate-subnet-cidr-block.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/disassociate-subnet-cidr-block.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,20 @@ +**To disassociate an IPv6 CIDR block from a subnet** + +This example disassociates an IPv6 CIDR block from a subnet using the association ID for the CIDR block. + +Command:: + + aws ec2 disassociate-subnet-cidr-block --association-id subnet-cidr-assoc-3aa54053 + +Output:: + + { + "SubnetId": "subnet-5f46ec3b", + "Ipv6CidrBlockAssociation": { + "Ipv6CidrBlock": "2001:db8:1234:1a00::/64", + "AssociationId": "subnet-cidr-assoc-3aa54053", + "Ipv6CidrBlockState": { + "State": "disassociating" + } + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/disassociate-transit-gateway-multicast-domain.rst awscli-1.18.69/awscli/examples/ec2/disassociate-transit-gateway-multicast-domain.rst --- awscli-1.11.13/awscli/examples/ec2/disassociate-transit-gateway-multicast-domain.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/disassociate-transit-gateway-multicast-domain.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/disassociate-transit-gateway-route-table.rst awscli-1.18.69/awscli/examples/ec2/disassociate-transit-gateway-route-table.rst --- awscli-1.11.13/awscli/examples/ec2/disassociate-transit-gateway-route-table.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/disassociate-transit-gateway-route-table.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To disassociate a transit gateway route table from a resource attachment** + +The following ``disassociate-transit-gateway-route-table`` example disasssociates the transit gateway route table from the specified attachment. :: + + aws ec2 disassociate-transit-gateway-route-table \ + --transit-gateway-route-table-id tgw-rtb-002573ed1eEXAMPLE \ + --transit-gateway-attachment-id tgw-attach-08e0bc912cEXAMPLE + +Output:: + + { + "Association": { + "TransitGatewayRouteTableId": "tgw-rtb-002573ed1eEXAMPLE", + "TransitGatewayAttachmentId": "tgw-attach-08e0bc912cEXAMPLE", + "ResourceId": "11460968-4ac1-4fd3-bdb2-00599EXAMPLE", + "ResourceType": "direct-connect-gateway", + "State": "disassociating" + } + } + +For more information, see `Delete an Association for a Transit Gateway Route Table `__ in the *AWS Transit Gateways Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/disassociate-vpc-cidr-block.rst awscli-1.18.69/awscli/examples/ec2/disassociate-vpc-cidr-block.rst --- awscli-1.11.13/awscli/examples/ec2/disassociate-vpc-cidr-block.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/disassociate-vpc-cidr-block.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,41 @@ +**To disassociate an IPv6 CIDR block from a VPC** + +This example disassociates an IPv6 CIDR block from a VPC using the association ID for the CIDR block. + +Command:: + + aws ec2 disassociate-vpc-cidr-block --association-id vpc-cidr-assoc-eca54085 + +Output:: + + { + "Ipv6CidrBlockAssociation": { + "Ipv6CidrBlock": "2001:db8:1234:1a00::/56", + "AssociationId": "vpc-cidr-assoc-eca54085", + "Ipv6CidrBlockState": { + "State": "disassociating" + } + }, + "VpcId": "vpc-a034d6c4" + } + +**To disassociate an IPv4 CIDR block from a VPC** + +This example disassociates an IPv4 CIDR block from a VPC. + +Command:: + + aws ec2 disassociate-vpc-cidr-block --association-id vpc-cidr-assoc-0287ac6b + +Output:: + + { + "CidrBlockAssociation": { + "AssociationId": "vpc-cidr-assoc-0287ac6b", + "CidrBlock": "172.18.0.0/16", + "CidrBlockState": { + "State": "disassociating" + } + }, + "VpcId": "vpc-27621243" + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/enable-ebs-encryption-by-default.rst awscli-1.18.69/awscli/examples/ec2/enable-ebs-encryption-by-default.rst --- awscli-1.11.13/awscli/examples/ec2/enable-ebs-encryption-by-default.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/enable-ebs-encryption-by-default.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To enable EBS encryption by default** + +The following ``enable-ebs-encryption-by-default`` example enables EBS encryption by default for your AWS account in the current Region. :: + + aws ec2 enable-ebs-encryption-by-default + +Output:: + + { + "EbsEncryptionByDefault": true + } diff -Nru awscli-1.11.13/awscli/examples/ec2/enable-fast-snapshot-restores.rst awscli-1.18.69/awscli/examples/ec2/enable-fast-snapshot-restores.rst --- awscli-1.11.13/awscli/examples/ec2/enable-fast-snapshot-restores.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/enable-fast-snapshot-restores.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/enable-transit-gateway-route-table-propagation.rst awscli-1.18.69/awscli/examples/ec2/enable-transit-gateway-route-table-propagation.rst --- awscli-1.11.13/awscli/examples/ec2/enable-transit-gateway-route-table-propagation.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/enable-transit-gateway-route-table-propagation.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To enable a transit gateway attachment to propagate routes to the specified propagation route table** + +The following ``enable-transit-gateway-route-table-propagation`` example enables the specified attachment to propagate routes to the specified propagation route table. :: + + aws ec2 enable-transit-gateway-route-table-propagation \ + --transit-gateway-route-table-id tgw-rtb-0a823edbdeEXAMPLE \ + --transit-gateway-attachment-id tgw-attach-09b52ccdb5EXAMPLE + +Output:: + + { + "Propagation": { + "TransitGatewayAttachmentId": "tgw-attach-09b52ccdb5EXAMPLE", + "ResourceId": "vpc-4d7de228", + "ResourceType": "vpc", + "TransitGatewayRouteTableId": "tgw-rtb-0a823edbdeEXAMPLE", + "State": "disabled" + } + } + +For more information, see `Propagate a Route to a Transit Gateway Route Table `__ in the *AWS Transit Gateways Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/export-client-vpn-client-certificate-revocation-list.rst awscli-1.18.69/awscli/examples/ec2/export-client-vpn-client-certificate-revocation-list.rst --- awscli-1.11.13/awscli/examples/ec2/export-client-vpn-client-certificate-revocation-list.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/export-client-vpn-client-certificate-revocation-list.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,29 @@ +**To export a client certificate revocation list** + +The following ``export-client-vpn-client-certificate-revocation-list`` example exports the client certificate revocation list for the specified Client VPN endpoint. In this example, the output is returned in text format to make it easier to read. :: + + aws ec2 export-client-vpn-client-certificate-revocation-list \ + --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde \ + --output text + +Output:: + + -----BEGIN X509 CRL----- + MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC + VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 + b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd + BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN + MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD + VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z + b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt + YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ + 21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T + rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE + Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4 + nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb + FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb + NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE= + -----END X509 CRL----- + STATUS pending + +For more information, see `Client Certificate Revocation Lists `__ in the *AWS Client VPN Administrator Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/export-client-vpn-client-configuration.rst awscli-1.18.69/awscli/examples/ec2/export-client-vpn-client-configuration.rst --- awscli-1.11.13/awscli/examples/ec2/export-client-vpn-client-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/export-client-vpn-client-configuration.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,43 @@ +**To export the client configuration** + +The following ``export-client-vpn-client-configuration`` example exports the client configuration for the specified Client VPN endpoint. In this example, the output is returned in text format to make it easier to read. :: + + aws ec2 export-client-vpn-client-configuration \ + --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde \ + --output text + +Output:: + + client + dev tun + proto udp + remote cvpn-endpoint-123456789123abcde.prod.clientvpn.ap-south-1.amazonaws.com 443 + remote-random-hostname + resolv-retry infinite + nobind + persist-key + persist-tun + remote-cert-tls server + cipher AES-256-GCM + verb 3 + + -----BEGIN CERTIFICATE----- + MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC + VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 + b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd + BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN + MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD + VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z + b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt + YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ + 21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T + rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE + Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4 + nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb + FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb + NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE= + -----END CERTIFICATE----- + + reneg-sec 0 + +For more information, see `Client VPN Endpoints `__ in the *AWS Client VPN Administrator Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/export-image.rst awscli-1.18.69/awscli/examples/ec2/export-image.rst --- awscli-1.11.13/awscli/examples/ec2/export-image.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/export-image.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,24 @@ +**To export a VM from an AMI** + +The following ``export-image`` example exports the specified AMI to the specified bucket in the specified format. :: + + aws ec2 export-image \ + --image-id ami-1234567890abcdef0 \ + --disk-image-format VMDK \ + --s3-export-location S3Bucket=my-export-bucket,S3Prefix=exports/ + +Output:: + + { + "DiskImageFormat": "vmdk", + "ExportImageTaskId": "export-ami-1234567890abcdef0" + "ImageId": "ami-1234567890abcdef0", + "RoleName": "vmimport", + "Progress": "0", + "S3ExportLocation": { + "S3Bucket": "my-export-bucket", + "S3Prefix": "exports/" + }, + "Status": "active", + "StatusMessage": "validating" + } diff -Nru awscli-1.11.13/awscli/examples/ec2/get-associated-ipv6-pool-cidrs.rst awscli-1.18.69/awscli/examples/ec2/get-associated-ipv6-pool-cidrs.rst --- awscli-1.11.13/awscli/examples/ec2/get-associated-ipv6-pool-cidrs.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/get-associated-ipv6-pool-cidrs.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/get-capacity-reservation-usage.rst awscli-1.18.69/awscli/examples/ec2/get-capacity-reservation-usage.rst --- awscli-1.11.13/awscli/examples/ec2/get-capacity-reservation-usage.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/get-capacity-reservation-usage.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,24 @@ +**To view capacity reservation usage across AWS accounts** + +The following ``get-capacity-reservation-usage`` example displays usage information for the specified capacity reservation. :: + + aws ec2 get-capacity-reservation-usage \ + --capacity-reservation-id cr-1234abcd56EXAMPLE + +Output:: + + { + "CapacityReservationId": "cr-1234abcd56EXAMPLE ", + "InstanceUsages": [ + { + "UsedInstanceCount": 1, + "AccountId": "123456789012" + } + ], + "AvailableInstanceCount": 4, + "TotalInstanceCount": 5, + "State": "active", + "InstanceType": "t2.medium" + } + +For more information, see `Viewing Shared Capacity Reservation Usage `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. diff -Nru awscli-1.11.13/awscli/examples/ec2/get-console-output.rst awscli-1.18.69/awscli/examples/ec2/get-console-output.rst --- awscli-1.11.13/awscli/examples/ec2/get-console-output.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/get-console-output.rst 2020-05-28 19:25:48.000000000 +0000 @@ -14,3 +14,23 @@ "Output": "..." } +**To get the latest console output** + +This example gets the latest console output for the specified instance. + +Command:: + + aws ec2 get-console-output --instance-id i-1234567890abcdef0 --latest --output text + + +Output:: + + i-1234567890abcdef0 [ 0.000000] Command line: root=LABEL=/ console=tty1 console=ttyS0 selinux=0 nvme_core.io_timeout=4294967295 + [ 0.000000] x86/fpu: Supporting XSAVE feature 0x001: 'x87 floating point registers' + [ 0.000000] x86/fpu: Supporting XSAVE feature 0x002: 'SSE registers' + [ 0.000000] x86/fpu: Supporting XSAVE feature 0x004: 'AVX registers' + ... + Cloud-init v. 0.7.6 finished at Wed, 09 May 2018 19:01:13 +0000. Datasource DataSourceEc2. Up 21.50 seconds + Amazon Linux AMI release 2018.03 + Kernel 4.14.26-46.32.amzn1.x86_64 on an x86_64 + 2018-05-09T19:07:01.000Z \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/get-console-screenshot.rst awscli-1.18.69/awscli/examples/ec2/get-console-screenshot.rst --- awscli-1.11.13/awscli/examples/ec2/get-console-screenshot.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/get-console-screenshot.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,13 @@ +**To retrieve a screenshot of a running instance** + +The following ``get-console-screenshot`` example retrieves a screenshot of the specified instance in .jpg format. The screenshot is returned as a Base64-encoded string. :: + + aws ec2 get-console-screenshot \ + --instance-id i-1234567890abcdef0 + +Output:: + + { + "ImageData": "997987/8kgj49ikjhewkwwe0008084EXAMPLE", + "InstanceId": "i-1234567890abcdef0" + } diff -Nru awscli-1.11.13/awscli/examples/ec2/get-default-credit-specification.rst awscli-1.18.69/awscli/examples/ec2/get-default-credit-specification.rst --- awscli-1.11.13/awscli/examples/ec2/get-default-credit-specification.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/get-default-credit-specification.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/get-ebs-default-kms-key-id.rst awscli-1.18.69/awscli/examples/ec2/get-ebs-default-kms-key-id.rst --- awscli-1.11.13/awscli/examples/ec2/get-ebs-default-kms-key-id.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/get-ebs-default-kms-key-id.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To describe your default CMK for EBS encryption** + +The following ``get-ebs-default-kms-key-id`` example describes the default CMK for EBS encryption for your AWS account. :: + + aws ec2 get-ebs-default-kms-key-id + +The output shows the default CMK for EBS encryption, which is an AWS managed CMK with the alias ``alias/aws/ebs``. :: + + { + "KmsKeyId": "alias/aws/ebs" + } + +The following output shows a custom CMK for EBS encryption. :: + + { + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/0ea3fef3-80a7-4778-9d8c-1c0c6EXAMPLE" + } diff -Nru awscli-1.11.13/awscli/examples/ec2/get-ebs-encryption-by-default.rst awscli-1.18.69/awscli/examples/ec2/get-ebs-encryption-by-default.rst --- awscli-1.11.13/awscli/examples/ec2/get-ebs-encryption-by-default.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/get-ebs-encryption-by-default.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To describe whether EBS encryption by default is enabled** + +The following ``get-ebs-encryption-by-default`` example indicates whether EBS encryption by default is enabled for your AWS account in the current Region. :: + + aws ec2 get-ebs-encryption-by-default + +The following output indicates that EBS encryption by default is disabled. :: + + { + "EbsEncryptionByDefault": false + } + +The following output indicates that EBS encryption by default is enabled. :: + + { + "EbsEncryptionByDefault": true + } diff -Nru awscli-1.11.13/awscli/examples/ec2/get-host-reservation-purchase-preview.rst awscli-1.18.69/awscli/examples/ec2/get-host-reservation-purchase-preview.rst --- awscli-1.11.13/awscli/examples/ec2/get-host-reservation-purchase-preview.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/get-host-reservation-purchase-preview.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,26 @@ +**To get a purchase preview for a Dedicated Host Reservation** + +This example provides a preview of the costs for a specified Dedicated Host Reservation for the specified Dedicated Host in your account. + +Command:: + + aws ec2 get-host-reservation-purchase-preview --offering-id hro-03f707bf363b6b324 --host-id-set h-013abcd2a00cbd123 + +Output:: + + { + "TotalHourlyPrice": "1.499", + "Purchase": [ + { + "HourlyPrice": "1.499", + "InstanceFamily": "m4", + "PaymentOption": "NoUpfront", + "HostIdSet": [ + "h-013abcd2a00cbd123" + ], + "UpfrontPrice": "0.000", + "Duration": 31536000 + } + ], + "TotalUpfrontPrice": "0.000" + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/get-launch-template-data.rst awscli-1.18.69/awscli/examples/ec2/get-launch-template-data.rst --- awscli-1.11.13/awscli/examples/ec2/get-launch-template-data.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/get-launch-template-data.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,51 @@ +**To get instance data for a launch template** + +This example gets data about the specified instance and uses the ``--query`` option to return the contents in ``LaunchTemplateData``. You can use the output as a base to create a new launch template or launch template version. + +Command:: + + aws ec2 get-launch-template-data --instance-id i-0123d646e8048babc --query 'LaunchTemplateData' + +Output:: + + { + "Monitoring": {}, + "ImageId": "ami-8c1be5f6", + "BlockDeviceMappings": [ + { + "DeviceName": "/dev/xvda", + "Ebs": { + "DeleteOnTermination": true + } + } + ], + "EbsOptimized": false, + "Placement": { + "Tenancy": "default", + "GroupName": "", + "AvailabilityZone": "us-east-1a" + }, + "InstanceType": "t2.micro", + "NetworkInterfaces": [ + { + "Description": "", + "NetworkInterfaceId": "eni-35306abc", + "PrivateIpAddresses": [ + { + "Primary": true, + "PrivateIpAddress": "10.0.0.72" + } + ], + "SubnetId": "subnet-7b16de0c", + "Groups": [ + "sg-7c227019" + ], + "Ipv6Addresses": [ + { + "Ipv6Address": "2001:db8:1234:1a00::123" + } + ], + "PrivateIpAddress": "10.0.0.72" + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/get-reserved-instances-exchange-quote.rst awscli-1.18.69/awscli/examples/ec2/get-reserved-instances-exchange-quote.rst --- awscli-1.11.13/awscli/examples/ec2/get-reserved-instances-exchange-quote.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/get-reserved-instances-exchange-quote.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,49 @@ +**To get a quote for exchanging a Convertible Reserved Instance** + +This example gets the exchange information for the specified Convertible Reserved Instances. + +Command:: + + aws ec2 get-reserved-instances-exchange-quote --reserved-instance-ids 7b8750c3-397e-4da4-bbcb-a45ebexample --target-configurations OfferingId=6fea5434-b379-434c-b07b-a7abexample + +Output:: + + { + "CurrencyCode": "USD", + "ReservedInstanceValueSet": [ + { + "ReservedInstanceId": "7b8750c3-397e-4da4-bbcb-a45ebexample", + "ReservationValue": { + "RemainingUpfrontValue": "0.000000", + "HourlyPrice": "0.027800", + "RemainingTotalValue": "730.556200" + } + } + ], + "PaymentDue": "424.983828", + "TargetConfigurationValueSet": [ + { + "TargetConfiguration": { + "InstanceCount": 5, + "OfferingId": "6fea5434-b379-434c-b07b-a7abexample" + }, + "ReservationValue": { + "RemainingUpfrontValue": "424.983828", + "HourlyPrice": "0.016000", + "RemainingTotalValue": "845.447828" + } + } + ], + "IsValidExchange": true, + "OutputReservedInstancesWillExpireAt": "2020-10-01T13:03:39Z", + "ReservedInstanceValueRollup": { + "RemainingUpfrontValue": "0.000000", + "HourlyPrice": "0.027800", + "RemainingTotalValue": "730.556200" + }, + "TargetConfigurationValueRollup": { + "RemainingUpfrontValue": "424.983828", + "HourlyPrice": "0.016000", + "RemainingTotalValue": "845.447828" + } + } diff -Nru awscli-1.11.13/awscli/examples/ec2/get-transit-gateway-attachment-propagations.rst awscli-1.18.69/awscli/examples/ec2/get-transit-gateway-attachment-propagations.rst --- awscli-1.11.13/awscli/examples/ec2/get-transit-gateway-attachment-propagations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/get-transit-gateway-attachment-propagations.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To list the route tables to which the specified resource attachment propagates routes** + +The following ``get-transit-gateway-attachment-propagations`` example lists the route table to which the specified resource attachment propagates routes. :: + + aws ec2 get-transit-gateway-attachment-propagations \ + --transit-gateway-attachment-id tgw-attach-09fbd47ddfEXAMPLE + +Output:: + + { + "TransitGatewayAttachmentPropagations": [ + { + "TransitGatewayRouteTableId": "tgw-rtb-0882c61b97EXAMPLE", + "State": "enabled" + } + ] + } + +For more information, see `View Transit Gateway Route Tables `__ in the *AWS Transit Gateways Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/get-transit-gateway-multicast-domain-associations.rst awscli-1.18.69/awscli/examples/ec2/get-transit-gateway-multicast-domain-associations.rst --- awscli-1.11.13/awscli/examples/ec2/get-transit-gateway-multicast-domain-associations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/get-transit-gateway-multicast-domain-associations.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/get-transit-gateway-route-table-associations.rst awscli-1.18.69/awscli/examples/ec2/get-transit-gateway-route-table-associations.rst --- awscli-1.11.13/awscli/examples/ec2/get-transit-gateway-route-table-associations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/get-transit-gateway-route-table-associations.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To get information about the associations for the specified transit gateway route table** + +The following ``get-transit-gateway-route-table-associations`` example displays information about the associations for the specified transit gateway route table. :: + + aws ec2 get-transit-gateway-route-table-associations \ + --transit-gateway-route-table-id tgw-rtb-0a823edbdeEXAMPLE + +Output:: + + { + "Associations": [ + { + "TransitGatewayAttachmentId": "tgw-attach-09b52ccdb5EXAMPLE", + "ResourceId": "vpc-4d7de228", + "ResourceType": "vpc", + "State": "associating" + } + ] + } + +For more information, see `Associate a Transit Gateway Route Table `__ in the *AWS Transit Gateways Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/get-transit-gateway-route-table-propagations.rst awscli-1.18.69/awscli/examples/ec2/get-transit-gateway-route-table-propagations.rst --- awscli-1.11.13/awscli/examples/ec2/get-transit-gateway-route-table-propagations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/get-transit-gateway-route-table-propagations.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,33 @@ +**To display information about the route table propagations for the specified transit gateway route table** + + The following ``get-transit-gateway-route-table-propagations`` example returns the route table propagations for the specified route table. :: + + ec2 get-transit-gateway-route-table-propagations \ + --transit-gateway-route-table-id tgw-rtb-002573ed1eEXAMPLE + +Output:: + + { + "TransitGatewayRouteTablePropagations": [ + { + "TransitGatewayAttachmentId": "tgw-attach-01f8100bc7EXAMPLE", + "ResourceId": "vpc-3EXAMPLE", + "ResourceType": "vpc", + "State": "enabled" + }, + { + "TransitGatewayAttachmentId": "tgw-attach-08e0bc912cEXAMPLE", + "ResourceId": "11460968-4ac1-4fd3-bdb2-00599EXAMPLE", + "ResourceType": "direct-connect-gateway", + "State": "enabled" + }, + { + "TransitGatewayAttachmentId": "tgw-attach-0a89069f57EXAMPLE", + "ResourceId": "8384da05-13ce-4a91-aada-5a1baEXAMPLE", + "ResourceType": "direct-connect-gateway", + "State": "enabled" + } + ] + } + +For more information, see `View Transit Gateway Route Table Propagations`__ in the *AWS Transit Gateways Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/import-client-vpn-client-certificate-revocation-list.rst awscli-1.18.69/awscli/examples/ec2/import-client-vpn-client-certificate-revocation-list.rst --- awscli-1.11.13/awscli/examples/ec2/import-client-vpn-client-certificate-revocation-list.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/import-client-vpn-client-certificate-revocation-list.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,15 @@ +**To import a client certificate revocation list** + +The following ``import-client-vpn-client-certificate-revocation-list`` example imports a client certificate revocation list to the Client VPN endpoint by specifying the location of the file on the local computer. :: + + aws ec2 import-client-vpn-client-certificate-revocation-list \ + --certificate-revocation-list file:///path/to/crl.pem \ + --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde + +Output:: + + { + "Return": true + } + +For more information, see `Client Certificate Revocation Lists `__ in the *AWS Client VPN Administrator Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/import-image.rst awscli-1.18.69/awscli/examples/ec2/import-image.rst --- awscli-1.11.13/awscli/examples/ec2/import-image.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/import-image.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,25 @@ +**To import a VM image file as an AMI** + +The following ``import-image`` example imports the specified OVA. :: + + aws ec2 import-image \ + --disk-containers Format=ova,UserBucket="{S3Bucket=my-import-bucket,S3Key=vms/my-server-vm.ova}" + +Output:: + + { + "ImportTaskId": "import-ami-1234567890abcdef0", + "Progress": "2", + "SnapshotDetails": [ + { + "DiskImageSize": 0.0, + "Format": "ova", + "UserBucket": { + "S3Bucket": "my-import-bucket", + "S3Key": "vms/my-server-vm.ova" + } + } + ], + "Status": "active", + "StatusMessage": "pending" + } diff -Nru awscli-1.11.13/awscli/examples/ec2/import-key-pair.rst awscli-1.18.69/awscli/examples/ec2/import-key-pair.rst --- awscli-1.11.13/awscli/examples/ec2/import-key-pair.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/import-key-pair.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,26 +1,29 @@ **To import a public key** -First, generate a key pair with the tool of your choice. For example, use this OpenSSL command: +First, generate a key pair with the tool of your choice. For example, use this ssh-keygen command: Command:: - openssl genrsa -out my-key.pem 2048 - -Next, save the public key to a local file. For example, use this OpenSSL command: + ssh-keygen -t rsa -C "my-key" -f ~/.ssh/my-key -Command:: +Output:: - openssl rsa -in my-key.pem -pubout > my-key.pub - -Finally, this example command imports the specified public key. The public key is the text in the .pub file that is between ``-----BEGIN PUBLIC KEY-----`` and ``-----END PUBLIC KEY-----``. + Generating public/private rsa key pair. + Enter passphrase (empty for no passphrase): + Enter same passphrase again: + Your identification has been saved in /home/ec2-user/.ssh/my-key. + Your public key has been saved in /home/ec2-user/.ssh/my-key.pub. + ... + +This example command imports the specified public key. Command:: - aws ec2 import-key-pair --key-name my-key --public-key-material MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAuhrGNglwb2Zz/Qcz1zV+l12fJOnWmJxC2GMwQOjAX/L7p01o9vcLRoHXxOtcHBx0TmwMo+i85HWMUE7aJtYclVWPMOeepFmDqR1AxFhaIc9jDe88iLA07VK96wY4oNpp8+lICtgCFkuXyunsk4+KhuasN6kOpk7B2w5cUWveooVrhmJprR90FOHQB2Uhe9MkRkFjnbsA/hvZ/Ay0Cflc2CRZm/NG00lbLrV4l/SQnZmP63DJx194T6pI3vAev2+6UMWSwptNmtRZPMNADjmo50KiG2c3uiUIltiQtqdbSBMh9ztL/98AHtn88JG0s8u2uSRTNEHjG55tyuMbLD40QEXAMPLE + aws ec2 import-key-pair --key-name "my-key" --public-key-material file://~/.ssh/my-key.pub Output:: { "KeyName": "my-key", "KeyFingerprint": "1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca" - } \ No newline at end of file + } diff -Nru awscli-1.11.13/awscli/examples/ec2/import-snapshot.rst awscli-1.18.69/awscli/examples/ec2/import-snapshot.rst --- awscli-1.11.13/awscli/examples/ec2/import-snapshot.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/import-snapshot.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,26 @@ +**To import a snapshot** + +The following ``import-snapshot`` example imports the specified disk as a snapshot. :: + + aws ec2 import-snapshot \ + --description "My server VMDK" \ + --disk-container Format=VMDK,UserBucket={S3Bucket=my-import-bucket,S3Key=vms/my-server-vm.vmdk} + +Output:: + + { + "Description": "My server VMDK", + "ImportTaskId": "import-snap-1234567890abcdef0", + "SnapshotTaskDetail": { + "Description": "My server VMDK", + "DiskImageSize": "0.0", + "Format": "VMDK", + "Progress": "3", + "Status": "active", + "StatusMessage": "pending" + "UserBucket": { + "S3Bucket": "my-import-bucket", + "S3Key": "vms/my-server-vm.vmdk" + } + } + } diff -Nru awscli-1.11.13/awscli/examples/ec2/modify-capacity-reservation.rst awscli-1.18.69/awscli/examples/ec2/modify-capacity-reservation.rst --- awscli-1.11.13/awscli/examples/ec2/modify-capacity-reservation.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/modify-capacity-reservation.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,24 @@ +**Example 1: To change the number of instances reserved by an existing capacity reservation** + +The following ``modify-capacity-reservation`` example changes the number of instances for which the capacity reservation reserves capacity. :: + + aws ec2 modify-capacity-reservation \ + --capacity-reservation-id cr-1234abcd56EXAMPLE \ + --instance-count 5 + +Output:: + + { + "Return": true + } + +**Example 2: To change the end date and time for an existing capacity reservation** + +The following ``modify-capacity-reservation`` example modifies an existing capacity reservation to end at the specified date and time. :: + + aws ec2 modify-capacity-reservation \ + --capacity-reservation-id cr-1234abcd56EXAMPLE \ + --end-date-type limited \ + --end-date 2019-08-31T23:59:59Z + +For more information, see `Modifying a Capacity Reservation `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. diff -Nru awscli-1.11.13/awscli/examples/ec2/modify-client-vpn-endpoint.rst awscli-1.18.69/awscli/examples/ec2/modify-client-vpn-endpoint.rst --- awscli-1.11.13/awscli/examples/ec2/modify-client-vpn-endpoint.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/modify-client-vpn-endpoint.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,15 @@ +**To modify a Client VPN endpoint** + +The following ``modify-client-vpn-endpoint`` example enables client connection logging for the specified Client VPN endpoint. :: + + aws ec2 modify-client-vpn-endpoint \ + --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde \ + --connection-log-options Enabled=true,CloudwatchLogGroup=ClientVPNLogs + +Output:: + + { + "Return": true + } + +For more information, see `Client VPN Endpoints `__ in the *AWS Client VPN Administrator Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/modify-default-credit-specification.rst awscli-1.18.69/awscli/examples/ec2/modify-default-credit-specification.rst --- awscli-1.11.13/awscli/examples/ec2/modify-default-credit-specification.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/modify-default-credit-specification.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/modify-ebs-default-kms-key-id.rst awscli-1.18.69/awscli/examples/ec2/modify-ebs-default-kms-key-id.rst --- awscli-1.11.13/awscli/examples/ec2/modify-ebs-default-kms-key-id.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/modify-ebs-default-kms-key-id.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,12 @@ +**To set your default CMK for EBS encryption** + +The following ``modify-ebs-default-kms-key-id`` example sets the specified CMK as the default CMK for EBS encryption for your AWS account in the current Region. :: + + aws ec2 modify-ebs-default-kms-key-id \ + --kms-key-id alias/my-cmk + +Output:: + + { + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/0ea3fef3-80a7-4778-9d8c-1c0c6EXAMPLE" + } diff -Nru awscli-1.11.13/awscli/examples/ec2/modify-fpga-image-attribute.rst awscli-1.18.69/awscli/examples/ec2/modify-fpga-image-attribute.rst --- awscli-1.11.13/awscli/examples/ec2/modify-fpga-image-attribute.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/modify-fpga-image-attribute.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,20 @@ +**To modify the attributes of an Amazon FPGA image** + +This example adds load permissions for account ID ``123456789012`` for the specified AFI. + +Command:: + + aws ec2 modify-fpga-image-attribute --attribute loadPermission --fpga-image-id afi-0d123e123bfc85abc --load-permission Add=[{UserId=123456789012}] + +Output:: + + { + "FpgaImageAttribute": { + "FpgaImageId": "afi-0d123e123bfc85abc", + "LoadPermissions": [ + { + "UserId": "123456789012" + } + ] + } + } diff -Nru awscli-1.11.13/awscli/examples/ec2/modify-hosts.rst awscli-1.18.69/awscli/examples/ec2/modify-hosts.rst --- awscli-1.11.13/awscli/examples/ec2/modify-hosts.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/modify-hosts.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,61 +1,35 @@ -**To describe Dedicated hosts in your account and generate a machine-readable list** +**Example 1: To enable auto-placement for a Dedicated Host** -To output a list of Dedicated host IDs in JSON (comma separated). +The following ``modify-hosts`` example enables auto-placement for a Dedicated Host so that it accepts any untargeted instance launches that match its instance type configuration. :: -Command:: - - aws ec2 describe-hosts --query 'Hosts[].HostId' --output json + aws ec2 modify-hosts \ + --host-id h-06c2f189b4EXAMPLE \ + --auto-placement on Output:: - [ - "h-085664df5899941c", - "h-056c1b0724170dc38" - ] - -To output a list of Dedicated host IDs in plaintext (comma separated). - -Command:: - - aws ec2 describe-hosts --query 'Hosts[].HostId' --output text + { + "Successful": [ + "h-06c2f189b4EXAMPLE" + ], + "Unsuccessful": [] + } + +**Example 2: To enable host recovery for a Dedicated Host** + +The following ``modify-hosts`` example enables host recovery for the specified Dedicated Host. :: + + aws ec2 modify-hosts \ + --host-id h-06c2f189b4EXAMPLE \ + --host-recovery on Output:: -h-085664df5899941c -h-056c1b0724170dc38 -**To describe available Dedicated hosts in your account** - -Command:: - - aws ec2 describe-hosts --filter "Name=state,Values=available" - -Output:: + { + "Successful": [ + "h-06c2f189b4EXAMPLE" + ], + "Unsuccessful": [] + } - { - "Hosts": [ - { - "HostId": "h-085664df5899941c" - "HostProperties: { - "Cores": 20, - "Sockets": 2, - "InstanceType": "m3.medium". - "TotalVCpus": 32 - }, - "Instances": [], - "State": "available", - "AvailabilityZone": "us-east-1b", - "AvailableCapacity": { - "AvailableInstanceCapacity": [ - { - "AvailableCapacity": 32, - "InstanceType": "m3.medium", - "TotalCapacity": 32 - } - ], - "AvailableVCpus": 32 - }, - "AutoPlacement": "off" - } - ] - } - +For more information, see `Modifying Dedicated Host Auto-Placement `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. diff -Nru awscli-1.11.13/awscli/examples/ec2/modify-identity-id-format.rst awscli-1.18.69/awscli/examples/ec2/modify-identity-id-format.rst --- awscli-1.11.13/awscli/examples/ec2/modify-identity-id-format.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/modify-identity-id-format.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,15 +1,24 @@ **To enable an IAM role to use longer IDs for a resource** -This example enables the IAM role ``EC2Role`` in your AWS account to use the longer ID format for the ``instance`` resource type. If the request is successful, no output is returned. +The following ``modify-identity-id-format`` example enables the IAM role ``EC2Role`` in your AWS account to use long ID format for the ``instance`` resource type. :: -Command:: - - aws ec2 modify-identity-id-format --principal-arn arn:aws:iam::123456789012:role/EC2Role --resource instance --use-long-ids + aws ec2 modify-identity-id-format \ + --principal-arn arn:aws:iam::123456789012:role/EC2Role \ + --resource instance \ + --use-long-ids **To enable an IAM user to use longer IDs for a resource** -This example enables the IAM user ``AdminUser`` in your AWS account to use the longer ID format for the ``volume`` resource type. If the request is successful, no output is returned. - -Command:: +The following ``modify-identity-id-format`` example enables the IAM user ``AdminUser`` in your AWS account to use the longer ID format for the ``volume`` resource type. :: - aws ec2 modify-identity-id-format --principal-arn arn:aws:iam::123456789012:user/AdminUser --resource volume --use-long-ids \ No newline at end of file + aws ec2 modify-identity-id-format \ + --principal-arn arn:aws:iam::123456789012:user/AdminUser \ + --resource volume \ + --use-long-ids + +The following ``modify-identity-id-format`` example enables the IAM user ``AdminUser`` in your AWS account to use the longer ID format for all supported resource types that are within their opt-in period. :: + + aws ec2 modify-identity-id-format \ + --principal-arn arn:aws:iam::123456789012:user/AdminUser \ + --resource all-current \ + --use-long-ids diff -Nru awscli-1.11.13/awscli/examples/ec2/modify-id-format.rst awscli-1.18.69/awscli/examples/ec2/modify-id-format.rst --- awscli-1.11.13/awscli/examples/ec2/modify-id-format.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/modify-id-format.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,15 +1,21 @@ **To enable the longer ID format for a resource** -This example enables the longer ID format for the ``instance`` resource type. If the request is successful, no output is returned. +The following ``modify-id-format`` example enables the longer ID format for the ``instance`` resource type. :: -Command:: - - aws ec2 modify-id-format --resource instance --use-long-ids + aws ec2 modify-id-format \ + --resource instance \ + --use-long-ids **To disable the longer ID format for a resource** -This example disables the longer ID format for the ``instance`` resource type. +The following ``modify-id-format`` example disables the longer ID format for the ``instance`` resource type. :: + + aws ec2 modify-id-format \ + --resource instance \ + --no-use-long-ids -Command:: +The following ``modify-id-format`` example enables the longer ID format for all supported resource types that are within their opt-in period. :: - aws ec2 modify-id-format --resource instance --no-use-long-ids + aws ec2 modify-id-format \ + --resource all-current \ + --use-long-ids diff -Nru awscli-1.11.13/awscli/examples/ec2/modify-image-attribute.rst awscli-1.18.69/awscli/examples/ec2/modify-image-attribute.rst --- awscli-1.11.13/awscli/examples/ec2/modify-image-attribute.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/modify-image-attribute.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,31 +1,38 @@ -**To make an AMI public** +**Example 1: To make an AMI public** -This example makes the specified AMI public. If the command succeeds, no output is returned. +The following ``modify-instance-attribute`` example makes the specified AMI public. :: -Command:: + aws ec2 modify-image-attribute \ + --image-id ami-5731123e \ + --launch-permission "Add=[{Group=all}]" - aws ec2 modify-image-attribute --image-id ami-5731123e --launch-permission "{\"Add\": [{\"Group\":\"all\"}]}" +This command produces no output. -**To make an AMI private** +**Example 2: To make an AMI private** -This example makes the specified AMI private. If the command succeeds, no output is returned. +The following ``modify-instance-attribute`` example makes the specified AMI private. :: -Command:: + aws ec2 modify-image-attribute \ + --image-id ami-5731123e \ + --launch-permission "Remove=[{Group=all}]" - aws ec2 modify-image-attribute --image-id ami-5731123e --launch-permission "{\"Remove\": [{\"Group\":\"all\"}]}" +This command produces no output. -**To grant launch permission to an AWS account** +**Example 3: To grant launch permission to an AWS account** -This example grants launch permissions to the specified AWS account. If the command succeeds, no output is returned. +The following ``modify-instance-attribute`` example grants launch permissions to the specified AWS account. :: -Command:: + aws ec2 modify-image-attribute \ + --image-id ami-5731123e \ + --launch-permission "Add=[{UserId=123456789012}]" - aws ec2 modify-image-attribute --image-id ami-5731123e --launch-permission "{\"Add\": [{\"UserId\":\"123456789012\"}]}" +This command produces no output. -**To removes launch permission from an AWS account** +**Example 4: To remove launch permission from an AWS account** -This example removes launch permissions from the specified AWS account. If the command succeeds, no output is returned. +The following ``modify-instance-attribute`` example removes launch permissions from the specified AWS account. :: -Command:: + aws ec2 modify-image-attribute \ + --image-id ami-5731123e \ + --launch-permission "Remove=[{UserId=123456789012}]" - aws ec2 modify-image-attribute --image-id ami-5731123e --launch-permission "{\"Remove\": [{\"UserId\":\"123456789012\"}]}" diff -Nru awscli-1.11.13/awscli/examples/ec2/modify-instance-attribute.rst awscli-1.18.69/awscli/examples/ec2/modify-instance-attribute.rst --- awscli-1.11.13/awscli/examples/ec2/modify-instance-attribute.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/modify-instance-attribute.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,31 +1,78 @@ -**To modify the instance type** +**Example 1: To modify the instance type** -This example modifies the instance type of the specified instance. The instance must be in the ``stopped`` state. If the command succeeds, no output is returned. +The following ``modify-instance-attribute`` example modifies the instance type of the specified instance. The instance must be in the ``stopped`` state. :: -Command:: - - aws ec2 modify-instance-attribute --instance-id i-1234567890abcdef0 --instance-type "{\"Value\": \"m1.small\"}" + aws ec2 modify-instance-attribute \ + --instance-id i-1234567890abcdef0 \ + --instance-type "{\"Value\": \"m1.small\"}" -**To enable enhanced networking on an instance** +This command produces no output. -This example enables enhanced networking for the specified instance. The instance must be in the ``stopped`` state. If the command succeeds, no output is returned. +**Example 2: To enable enhanced networking on an instance** -Command:: +The following ``modify-instance-attribute`` example enables enhanced networking for the specified instance. The instance must be in the ``stopped`` state. :: - aws ec2 modify-instance-attribute --instance-id i-1234567890abcdef0 --sriov-net-support simple + aws ec2 modify-instance-attribute \ + --instance-id i-1234567890abcdef0 \ + --sriov-net-support simple -**To modify the sourceDestCheck attribute** +This command produces no output. -This example sets the ``sourceDestCheck`` attribute of the specified instance to ``true``. The instance must be in a VPC. If the command succeeds, no output is returned. +**Example 3: To modify the sourceDestCheck attribute** -Command:: +The following ``modify-instance-attribute`` example sets the ``sourceDestCheck`` attribute of the specified instance to ``true``. The instance must be in a VPC. :: aws ec2 modify-instance-attribute --instance-id i-1234567890abcdef0 --source-dest-check "{\"Value\": true}" -**To modify the deleteOnTermination attribute of the root volume** +This command produces no output. + +**Example 4: To modify the deleteOnTermination attribute of the root volume** -This example sets the ``deleteOnTermination`` attribute for the root volume of the specified Amazon EBS-backed instance to ``false``. By default, this attribute is ``true`` for the root volume. If the command succeeds, no output is returned. +The following ``modify-instance-attribute`` example sets the ``deleteOnTermination`` attribute for the root volume of the specified Amazon EBS-backed instance to ``false``. By default, this attribute is ``true`` for the root volume. Command:: - aws ec2 modify-instance-attribute --instance-id i-1234567890abcdef0 --block-device-mappings "[{\"DeviceName\": \"/dev/sda1\",\"Ebs\":{\"DeleteOnTermination\":false}}]" + aws ec2 modify-instance-attribute \ + --instance-id i-1234567890abcdef0 \ + --block-device-mappings "[{\"DeviceName\": \"/dev/sda1\",\"Ebs\":{\"DeleteOnTermination\":false}}]" + +This command produces no output. + +**Example 5: To modify the user data attached to an instance** + +The following ``modify-instance-attribute`` example adds the contents of the file ``UserData.txt`` as the UserData for the specified instance. + +Contents of original file ``UserData.txt``:: + + #!/bin/bash + yum update -y + service httpd start + chkconfig httpd on + +The contents of the file must be base64 encoded. The first command converts the text file to base64 and saves it as a new file. + +Linux/macOS version of the command:: + + base64 UserData.txt > UserData.base64.txt + +This command produces no output. + +Windows version of the command:: + + certutil -encode UserData.txt tmp.b64 && findstr /v /c:- tmp.b64 > UserData.base64.txt + +Output:: + + Input Length = 67 + Output Length = 152 + CertUtil: -encode command completed successfully. + +Now you can reference that file in the CLI command that follows:: + + aws ec2 modify-instance-attribute \ + --instance-id=i-09b5a14dbca622e76 \ + --attribute userData --value file://UserData.base64.txt + +This command produces no output. + +For more information, see `User Data and the AWS CLI `__ in the *EC2 User Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/modify-instance-capacity-reservation-attributes.rst awscli-1.18.69/awscli/examples/ec2/modify-instance-capacity-reservation-attributes.rst --- awscli-1.11.13/awscli/examples/ec2/modify-instance-capacity-reservation-attributes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/modify-instance-capacity-reservation-attributes.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,29 @@ +**Example 1: To modify an instance's capacity reservation targeting settings** + +The following ``modify-instance-capacity-reservation-attributes`` example modifies a stopped instance to target a specific capacity reservation. :: + + aws ec2 modify-instance-capacity-reservation-attributes \ + --instance-id i-EXAMPLE8765abcd4e \ + --capacity-reservation-specification 'CapacityReservationTarget={CapacityReservationId= cr-1234abcd56EXAMPLE }' + +Output:: + + { + "Return": true + } + +**Example 2: To modify an instance's capacity reservation targeting settings** + +The following ``modify-instance-capacity-reservation-attributes`` example modifies a stopped instance that targets the specified capacity reservation to launch in any capacity reservation that has matching attributes (instance type, platform, Availability Zone) and that has open instance matching criteria. :: + + aws ec2 modify-instance-capacity-reservation-attributes \ + --instance-id i-EXAMPLE8765abcd4e \ + --capacity-reservation-specification 'CapacityReservationPreference=open' + +Output:: + + { + "Return": true + } + +For more information, see `Modifying an Instance's Capacity Reservation Settings `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. diff -Nru awscli-1.11.13/awscli/examples/ec2/modify-instance-credit-specification.rst awscli-1.18.69/awscli/examples/ec2/modify-instance-credit-specification.rst --- awscli-1.11.13/awscli/examples/ec2/modify-instance-credit-specification.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/modify-instance-credit-specification.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To modify the credit option for CPU usage of an instance** + +This example modifies the credit option for CPU usage of the specified instance in the specified region to "unlimited". Valid credit options are "standard" and "unlimited". + +Command:: + + aws ec2 modify-instance-credit-specification --instance-credit-specification "InstanceId=i-1234567890abcdef0,CpuCredits=unlimited" + +Output:: + + { + "SuccessfulInstanceCreditSpecifications": [ + { + "InstanceId": "i-1234567890abcdef0" + } + ], + "UnsuccessfulInstanceCreditSpecifications": [] + } diff -Nru awscli-1.11.13/awscli/examples/ec2/modify-instance-event-start-time.rst awscli-1.18.69/awscli/examples/ec2/modify-instance-event-start-time.rst --- awscli-1.11.13/awscli/examples/ec2/modify-instance-event-start-time.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/modify-instance-event-start-time.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,20 @@ +**To modify the event start time for an instance** + +The following ``modify-instance-event-start-time`` command shows how to modify the event start time for the specified instance. Specify the event ID by using the ``--instance-event-id`` parameter. Specify the new date and time by using the ``--not-before`` parameter. :: + + aws ec2 modify-instance-event-start-time --instance-id i-1234567890abcdef0 --instance-event-id instance-event-0abcdef1234567890 --not-before 2019-03-25T10:00:00.000 + +Output:: + + "Event": { + "InstanceEventId": "instance-event-0abcdef1234567890", + "Code": "system-reboot", + "Description": "scheduled reboot", + "NotAfter": "2019-03-25T12:00:00.000Z", + "NotBefore": "2019-03-25T10:00:00.000Z", + "NotBeforeDeadline": "2019-04-22T21:00:00.000Z" + } + +For more information, see `Working with Instances Scheduled for Reboot`_ in the *Amazon Elastic Compute Cloud User Guide* + +.. _`Working with Instances Scheduled for Reboot`: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html#schedevents_actions_reboot diff -Nru awscli-1.11.13/awscli/examples/ec2/modify-instance-placement.rst awscli-1.18.69/awscli/examples/ec2/modify-instance-placement.rst --- awscli-1.11.13/awscli/examples/ec2/modify-instance-placement.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/modify-instance-placement.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,13 +1,62 @@ -**To set the instance affinity value for a specific stopped Dedicated Host** +**Example 1: To remove an instance's affinity with a Dedicated Host** -To modify the affinity of an instance so it always has affinity with the specified Dedicated Host . +The following ``modify-instance-placement`` example removes an instance's affinity with a Dedicated Host and enables it to launch on any available Dedicated Host in your account that supports its instance type. :: -Command:: + aws ec2 modify-instance-placement \ + --instance-id i-0e6ddf6187EXAMPLE \ + --affinity default - aws ec2 modify-instance-placement --instance-id=i-1234567890abcdef0 --host-id h-029e7409a3350a31f +Output:: + + { + "Return": true + } + +**Example 2: To establish affinity between an instance and the specified Dedicated Host** + +The following ``modify-instance-placement`` example establishes a launch relationship between an instance and a Dedicated Host. The instance is only able to run on the specified Dedicated Host. :: + + aws ec2 modify-instance-placement \ + --instance-id i-0e6ddf6187EXAMPLE \ + --affinity host \ + --host-id i-0e6ddf6187EXAMPLE Output:: - { - "Return": true - } + { + "Return": true + } + +For more information, see `Modifying Instance Tenancy and Affinity `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. + +**Example 3: To move an instance to a placement group** + +To move an instance to a placement group, stop the instance, modify the instance placement, and then restart the instance. :: + + aws ec2 stop-instances \ + --instance-ids i-0123a456700123456 + + aws ec2 modify-instance-placement \ + --instance-id i-0123a456700123456 \ + --group-name MySpreadGroup + + aws ec2 start-instances \ + --instance-ids i-0123a456700123456 + +For more information, see `Changing the Placement Group for an Instance `__ in the *Amazon Elastic Compute Cloud Users Guide*. + +**Example 4: To remove an instance from a placement group** + +To remove an instance from a placement group, stop the instance, modify the instance placement, and then restart the instance. The following example specifies an empty string (" ") for the placement group name to indicate that the instance is not to be located in a placement group. + + aws ec2 stop-instances \ + --instance-ids i-0123a456700123456 + + aws ec2 modify-instance-placement \ + --instance-id i-0123a456700123456 \ + --group-name " " + + aws ec2 start-instances \ + --instance-ids i-0123a456700123456 + +For more information, see `Modifying Instance Tenancy and Affinity `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. diff -Nru awscli-1.11.13/awscli/examples/ec2/modify-launch-template.rst awscli-1.18.69/awscli/examples/ec2/modify-launch-template.rst --- awscli-1.11.13/awscli/examples/ec2/modify-launch-template.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/modify-launch-template.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,20 @@ +**To change the default launch template version** + +This example specifies version 2 of the specified launch template as the default version. + +Command:: + + aws ec2 modify-launch-template --launch-template-id lt-0abcd290751193123 --default-version 2 + +Output:: + + { + "LaunchTemplate": { + "LatestVersionNumber": 2, + "LaunchTemplateId": "lt-0abcd290751193123", + "LaunchTemplateName": "WebServers", + "DefaultVersionNumber": 2, + "CreatedBy": "arn:aws:iam::123456789012:root", + "CreateTime": "2017-12-01T13:35:46.000Z" + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/modify-reserved-instances.rst awscli-1.18.69/awscli/examples/ec2/modify-reserved-instances.rst --- awscli-1.11.13/awscli/examples/ec2/modify-reserved-instances.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/modify-reserved-instances.rst 2020-05-28 19:25:48.000000000 +0000 @@ -29,7 +29,7 @@ For more information, see `Modifying Your Reserved Instances`_ in the *Amazon EC2 User Guide*. -**To modify the instance types of Reserved Instances** +**To modify the instance size of Reserved Instances** This example command modifies a Reserved Instance that has 10 m1.small Linux/UNIX instances in us-west-1c so that 8 m1.small instances become 2 m1.large instances, and the remaining 2 m1.small become 1 m1.medium instance in the same @@ -43,8 +43,8 @@ "ReservedInstancesModificationId": "rimod-acc5f240-080d-4717-b3e3-1c6b11fa00b6" } -For more information, see `Changing the Instance Type of Your Reservations`_ in the *Amazon EC2 User Guide*. +For more information, see `Modifying the Instance Size of Your Reservations`_ in the *Amazon EC2 User Guide*. -.. _`Changing the Instance Type of Your Reservations`: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modification-instancemove.html +.. _`Modifying the Instance Size of Your Reservations`: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modification-instancemove.html .. _`Modifying Your Reserved Instances`: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html diff -Nru awscli-1.11.13/awscli/examples/ec2/modify-snapshot-attribute.rst awscli-1.18.69/awscli/examples/ec2/modify-snapshot-attribute.rst --- awscli-1.11.13/awscli/examples/ec2/modify-snapshot-attribute.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/modify-snapshot-attribute.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,15 +1,19 @@ -**To modify a snapshot attribute** +**Example 1: To modify a snapshot attribute** -This example modifies snapshot ``snap-1234567890abcdef0`` to remove the create volume permission for a user with the account ID ``123456789012``. If the command succeeds, no output is returned. +The following ``modify-snapshot-attribute`` example updates the ``createVolumePermission`` attribute for the specified snapshot, removing volume permissions for the specified user. :: -Command:: + aws ec2 modify-snapshot-attribute \ + --snapshot-id snap-1234567890abcdef0 \ + --attribute createVolumePermission \ + --operation-type remove \ + --user-ids 123456789012 - aws ec2 modify-snapshot-attribute --snapshot-id snap-1234567890abcdef0 --attribute createVolumePermission --operation-type remove --user-ids 123456789012 +**Example 2: To make a snapshot public** -**To make a snapshot public** +The following ``modify-snapshot-attribute`` example makes the specified snapshot public. :: -This example makes the snapshot ``snap-1234567890abcdef0`` public. - -Command:: - - aws ec2 modify-snapshot-attribute --snapshot-id snap-1234567890abcdef0 --attribute createVolumePermission --operation-type add --group-names all \ No newline at end of file + aws ec2 modify-snapshot-attribute \ + --snapshot-id snap-1234567890abcdef0 \ + --attribute createVolumePermission \ + --operation-type add \ + --group-names all diff -Nru awscli-1.11.13/awscli/examples/ec2/modify-subnet-attribute.rst awscli-1.18.69/awscli/examples/ec2/modify-subnet-attribute.rst --- awscli-1.11.13/awscli/examples/ec2/modify-subnet-attribute.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/modify-subnet-attribute.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,11 +1,19 @@ -**To change a subnet's public IP addressing behavior** +**To change a subnet's public IPv4 addressing behavior** -This example modifies subnet-1a2b3c4d to specify that all instances launched into this subnet are assigned a public IP address. If the command succeeds, no output is returned. +This example modifies subnet-1a2b3c4d to specify that all instances launched into this subnet are assigned a public IPv4 address. If the command succeeds, no output is returned. Command:: aws ec2 modify-subnet-attribute --subnet-id subnet-1a2b3c4d --map-public-ip-on-launch +**To change a subnet's IPv6 addressing behavior** + +This example modifies subnet-1a2b3c4d to specify that all instances launched into this subnet are assigned an IPv6 address from the range of the subnet. + +Command:: + + aws ec2 modify-subnet-attribute --subnet-id subnet-1a2b3c4d --assign-ipv6-address-on-creation + For more information, see `IP Addressing in Your VPC`_ in the *AWS Virtual Private Cloud User Guide*. .. _`IP Addressing in Your VPC`: http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/vpc-ip-addressing.html \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/modify-traffic-mirror-filter-network-services.rst awscli-1.18.69/awscli/examples/ec2/modify-traffic-mirror-filter-network-services.rst --- awscli-1.11.13/awscli/examples/ec2/modify-traffic-mirror-filter-network-services.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/modify-traffic-mirror-filter-network-services.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,40 @@ +**To add network services to a Traffic Mirror filter** + +The following ``modify-traffic-mirror-filter-network-services`` example adds the Amazon DNS network services to the specified filter. :: + + aws ec2 modify-traffic-mirror-filter-network-services \ + --traffic-mirror-filter-id tmf-04812ff784EXAMPLE \ + --add-network-service amazon-dns + +Output:: + + { + "TrafficMirrorFilter": { + "Tags": [ + { + "Key": "Name", + "Value": "Production" + } + ], + "EgressFilterRules": [], + "NetworkServices": [ + "amazon-dns" + ], + "TrafficMirrorFilterId": "tmf-04812ff784EXAMPLE", + "IngressFilterRules": [ + { + "SourceCidrBlock": "0.0.0.0/0", + "RuleNumber": 1, + "DestinationCidrBlock": "0.0.0.0/0", + "Description": "TCP Rule", + "Protocol": 6, + "TrafficDirection": "ingress", + "TrafficMirrorFilterId": "tmf-04812ff784EXAMPLE", + "RuleAction": "accept", + "TrafficMirrorFilterRuleId": "tmf-04812ff784EXAMPLE" + } + ] + } + } + +For more information, see `Modify Traffic Mirror Filter Network Services `__ in the *AWS Traffic Mirroring Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/modify-traffic-mirror-filter-rule.rst awscli-1.18.69/awscli/examples/ec2/modify-traffic-mirror-filter-rule.rst --- awscli-1.11.13/awscli/examples/ec2/modify-traffic-mirror-filter-rule.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/modify-traffic-mirror-filter-rule.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,25 @@ +**To modify a traffic mirror filter rule** + +The following ``modify-traffic-mirror-filter-rule`` example modifies the description of the specified traffic mirror filter rule. :: + + aws ec2 modify-traffic-mirror-filter-rule \ + --traffic-mirror-filter-rule-id tmfr-0ca76e0e08EXAMPLE \ + --description "TCP Rule" + +Output:: + + { + "TrafficMirrorFilterRule": { + "TrafficMirrorFilterRuleId": "tmfr-0ca76e0e08EXAMPLE", + "TrafficMirrorFilterId": "tmf-0293f26e86EXAMPLE", + "TrafficDirection": "ingress", + "RuleNumber": 100, + "RuleAction": "accept", + "Protocol": 6, + "DestinationCidrBlock": "10.0.0.0/24", + "SourceCidrBlock": "10.0.0.0/24", + "Description": "TCP Rule" + } + } + +For more information, see `Modify Your Traffic Mirror Filter Rules `__ in the *AWS Traffic Mirroring Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/modify-traffic-mirror-session.rst awscli-1.18.69/awscli/examples/ec2/modify-traffic-mirror-session.rst --- awscli-1.11.13/awscli/examples/ec2/modify-traffic-mirror-session.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/modify-traffic-mirror-session.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,26 @@ +**To modify a Traffic Mirror Session** + +The following ``modify-traffic-mirror-session`` example changes the traffic mirror session description and the number of packets to mirror. :: + + aws ec2 modify-traffic-mirror-session \ + --description "Change packet length" \ + --traffic-mirror-session-id tms-08a33b1214EXAMPLE \ + --remove-fields "packet-length" + +Output:: + + { + "TrafficMirrorSession": { + "TrafficMirrorSessionId": "tms-08a33b1214EXAMPLE", + "TrafficMirrorTargetId": "tmt-07f75d8feeEXAMPLE", + "TrafficMirrorFilterId": "tmf-04812ff784EXAMPLE", + "NetworkInterfaceId": "eni-070203f901EXAMPLE", + "OwnerId": "111122223333", + "SessionNumber": 1, + "VirtualNetworkId": 7159709, + "Description": "Change packet length", + "Tags": [] + } + } + +For more information, see `Modify Your Traffic MIrror Session `__ in the *AWS Traffic Mirroring Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/modify-transit-gateway-vpc-attachment.rst awscli-1.18.69/awscli/examples/ec2/modify-transit-gateway-vpc-attachment.rst --- awscli-1.11.13/awscli/examples/ec2/modify-transit-gateway-vpc-attachment.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/modify-transit-gateway-vpc-attachment.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,30 @@ +**To modify a transit gateway VPC attachment** + +The following ``modify-transit-gateway-vpc-attachment`` example adds a subnet to the specified transit gateway VPC attachment. :: + + aws ec2 modify-transit-gateway-vpc-attachment \ + --transit-gateway-attachment-id tgw-attach-09fbd47ddfEXAMPLE \ + --add-subnet-ids subnet-0e51f45802EXAMPLE + +Output:: + + { + "TransitGatewayVpcAttachment": { + "TransitGatewayAttachmentId": "tgw-attach-09fbd47ddfEXAMPLE", + "TransitGatewayId": "tgw-0560315ccfEXAMPLE", + "VpcId": "vpc-5eccc927", + "VpcOwnerId": "111122223333", + "State": "modifying", + "SubnetIds": [ + "subnet-0e51f45802EXAMPLE", + "subnet-1EXAMPLE" + ], + "CreationTime": "2019-08-08T16:47:38.000Z", + "Options": { + "DnsSupport": "enable", + "Ipv6Support": "disable" + } + } + } + +For more information, see `Transit Gateway Attachments to a VPC `__ in the *AWS Transit Gateways Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/modify-volume.rst awscli-1.18.69/awscli/examples/ec2/modify-volume.rst --- awscli-1.11.13/awscli/examples/ec2/modify-volume.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/modify-volume.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,51 @@ +**Example 1: To modify a volume by changing its size** + +The following ``modify-volume`` example changes the size of the specified volume to 150GB. + +Command:: + + aws ec2 modify-volume --size 150 --volume-id vol-1234567890abcdef0 + +Output:: + + { + "VolumeModification": { + "TargetSize": 150, + "TargetVolumeType": "io1", + "ModificationState": "modifying", + "VolumeId": " vol-1234567890abcdef0", + "TargetIops": 100, + "StartTime": "2019-05-17T11:27:19.000Z", + "Progress": 0, + "OriginalVolumeType": "io1", + "OriginalIops": 100, + "OriginalSize": 100 + } + } + +**Example 2: To modify a volume by changing its type, size, and IOPS value** + +The following ``modify-volume`` example changes the volume type to Provisioned IOPS SSD, sets the target IOPS rate to 10000, and sets the volume size to 350GB. :: + + aws ec2 modify-volume \ + --volume-type io1 \ + --iops 10000 \ + --size 350 \ + --volume-id vol-1234567890abcdef0 + +Output:: + + { + "VolumeModification": { + "TargetSize": 350, + "TargetVolumeType": "io1", + "ModificationState": "modifying", + "VolumeId": "vol-0721c1a9d08c93bf6", + "TargetIops": 10000, + "StartTime": "2019-05-17T11:38:57.000Z", + "Progress": 0, + "OriginalVolumeType": "gp2", + "OriginalIops": 150, + "OriginalSize": 50 + } + } diff -Nru awscli-1.11.13/awscli/examples/ec2/modify-vpc-endpoint-connection-notification.rst awscli-1.18.69/awscli/examples/ec2/modify-vpc-endpoint-connection-notification.rst --- awscli-1.11.13/awscli/examples/ec2/modify-vpc-endpoint-connection-notification.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/modify-vpc-endpoint-connection-notification.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,13 @@ +**To modify an endpoint connection notification** + +This example changes the SNS topic for the specified endpoint connection notification. + +Command:: + + aws ec2 modify-vpc-endpoint-connection-notification --connection-notification-id vpce-nfn-008776de7e03f5abc --connection-events Accept Reject --connection-notification-arn arn:aws:sns:us-east-2:123456789012:mytopic + +Output:: + + { + "ReturnValue": true + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/modify-vpc-endpoint.rst awscli-1.18.69/awscli/examples/ec2/modify-vpc-endpoint.rst --- awscli-1.11.13/awscli/examples/ec2/modify-vpc-endpoint.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/modify-vpc-endpoint.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,6 +1,6 @@ -**To modify an endpoint** +**To modify a gateway endpoint** -This example modifies endpoint vpce-1a2b3c4d by associating route table rtb-aaa222bb with the endpoint, and resetting the policy document. +This example modifies gateway endpoint ``vpce-1a2b3c4d`` by associating route table ``rtb-aaa222bb`` with the endpoint, and resetting the policy document. Command:: @@ -8,6 +8,20 @@ Output:: + { + "Return": true + } + +**To modify an interface endpoint** + +This example modifies interface endpoint ``vpce-0fe5b17a0707d6fa5`` by adding subnet ``subnet-d6fcaa8d`` to the endpoint. + +Command:: + + aws ec2 modify-vpc-endpoint --vpc-endpoint-id vpce-0fe5b17a0707d6fa5 --add-subnet-id subnet-d6fcaa8d + +Output:: + { "Return": true } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/modify-vpc-endpoint-service-configuration.rst awscli-1.18.69/awscli/examples/ec2/modify-vpc-endpoint-service-configuration.rst --- awscli-1.11.13/awscli/examples/ec2/modify-vpc-endpoint-service-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/modify-vpc-endpoint-service-configuration.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,13 @@ +**To modify an endpoint service configuration** + +This example changes the acceptance requirement for the specified endpoint service. + +Command:: + + aws ec2 modify-vpc-endpoint-service-configuration --service-id vpce-svc-09222513e6e77dc86 --no-acceptance-required + +Output:: + + { + "ReturnValue": true + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/modify-vpc-endpoint-service-permissions.rst awscli-1.18.69/awscli/examples/ec2/modify-vpc-endpoint-service-permissions.rst --- awscli-1.11.13/awscli/examples/ec2/modify-vpc-endpoint-service-permissions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/modify-vpc-endpoint-service-permissions.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To modify endpoint service permissions** + +This example adds permission for an AWS account to connect to the specified endpoint service. + +Command:: + + aws ec2 modify-vpc-endpoint-service-permissions --service-id vpce-svc-03d5ebb7d9579a2b3 --add-allowed-principals '["arn:aws:iam::123456789012:root"]' + +Output:: + + { + "ReturnValue": true + } + +This example adds permission for a specific IAM user (``admin``) to connect to the specified endpoint service. + +Command:: + + aws ec2 modify-vpc-endpoint-service-permissions --service-id vpce-svc-03d5ebb7d9579a2b3 --add-allowed-principals '["arn:aws:iam::123456789012:user/admin"]' diff -Nru awscli-1.11.13/awscli/examples/ec2/modify-vpc-tenancy.rst awscli-1.18.69/awscli/examples/ec2/modify-vpc-tenancy.rst --- awscli-1.11.13/awscli/examples/ec2/modify-vpc-tenancy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/modify-vpc-tenancy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,13 @@ +**To modify the tenancy of a VPC** + +This example modifies the tenancy of VPC ``vpc-1a2b3c4d`` to ``default``. + +Command:: + + aws ec2 modify-vpc-tenancy --vpc-id vpc-1a2b3c4d --instance-tenancy default + +Output:: + + { + "Return": true + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/modify-vpn-connection.rst awscli-1.18.69/awscli/examples/ec2/modify-vpn-connection.rst --- awscli-1.11.13/awscli/examples/ec2/modify-vpn-connection.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/modify-vpn-connection.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,40 @@ +**To modify a VPN connection** + +The following ``modify-vpn-connection`` example changes the target gateway for VPN connection ``vpn-12345678901234567`` to virtual private gateway ``vgw-11223344556677889``:: + + aws ec2 modify-vpn-connection \ + --vpn-connection-id vpn-12345678901234567 \ + --vpn-gateway-id vgw-11223344556677889 + +Output:: + + { + "VpnConnection": { + "CustomerGatewayConfiguration": "...configuration information...", + "CustomerGatewayId": "cgw-aabbccddee1122334", + "Category": "VPN", + "State": "modifying", + "Type": "ipsec.1", + "VpnConnectionId": "vpn-12345678901234567", + "VpnGatewayId": "vgw-11223344556677889", + "Options": { + "StaticRoutesOnly": false + }, + "VgwTelemetry": [ + { + "AcceptedRouteCount": 0, + "LastStatusChange": "2019-07-17T07:34:00.000Z", + "OutsideIpAddress": "18.210.3.222", + "Status": "DOWN", + "StatusMessage": "IPSEC IS DOWN" + }, + { + "AcceptedRouteCount": 0, + "LastStatusChange": "2019-07-20T21:20:16.000Z", + "OutsideIpAddress": "34.193.129.33", + "Status": "DOWN", + "StatusMessage": "IPSEC IS DOWN" + } + ] + } + } diff -Nru awscli-1.11.13/awscli/examples/ec2/modify-vpn-tunnel-certificate.rst awscli-1.18.69/awscli/examples/ec2/modify-vpn-tunnel-certificate.rst --- awscli-1.11.13/awscli/examples/ec2/modify-vpn-tunnel-certificate.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/modify-vpn-tunnel-certificate.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,42 @@ +**To rotate a VPN tunnel certificate** + +The following ``modify-vpn-tunnel-certificate`` example rotates the certificate for the specified tunnel for a VPN connection :: + + aws ec2 modify-vpn-tunnel-certificate \ + --vpn-tunnel-outside-ip-address 203.0.113.17 \ + --vpn-connection-id vpn-12345678901234567 + +Output:: + + { + "VpnConnection": { + "CustomerGatewayConfiguration": ...configuration information..., + "CustomerGatewayId": "cgw-aabbccddee1122334", + "Category": "VPN", + "State": "modifying", + "Type": "ipsec.1", + "VpnConnectionId": "vpn-12345678901234567", + "VpnGatewayId": "vgw-11223344556677889", + "Options": { + "StaticRoutesOnly": false + }, + "VgwTelemetry": [ + { + "AcceptedRouteCount": 0, + "LastStatusChange": "2019-09-11T17:27:14.000Z", + "OutsideIpAddress": "203.0.113.17", + "Status": "DOWN", + "StatusMessage": "IPSEC IS DOWN", + "CertificateArn": "arn:aws:acm:us-east-1:123456789101:certificate/c544d8ce-20b8-4fff-98b0-example" + }, + { + "AcceptedRouteCount": 0, + "LastStatusChange": "2019-09-11T17:26:47.000Z", + "OutsideIpAddress": "203.0.114.18", + "Status": "DOWN", + "StatusMessage": "IPSEC IS DOWN", + "CertificateArn": "arn:aws:acm:us-east-1:123456789101:certificate/5ab64566-761b-4ad3-b259-example" + } + ] + } + } diff -Nru awscli-1.11.13/awscli/examples/ec2/modify-vpn-tunnel-options.rst awscli-1.18.69/awscli/examples/ec2/modify-vpn-tunnel-options.rst --- awscli-1.11.13/awscli/examples/ec2/modify-vpn-tunnel-options.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/modify-vpn-tunnel-options.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,83 @@ +**To modify the tunnel options for a VPN connection** + +The following ``modify-vpn-tunnel-options`` example updates the Diffie-Hellmann groups that are permitted for the specified tunnel and VPN connection. :: + + aws ec2 modify-vpn-tunnel-options \ + --vpn-connection-id vpn-12345678901234567 \ + --vpn-tunnel-outside-ip-address 203.0.113.17 \ + --tunnel-options Phase1DHGroupNumbers=[{Value=14},{Value=15},{Value=16},{Value=17},{Value=18}],Phase2DHGroupNumbers=[{Value=14},{Value=15},{Value=16},{Value=17},{Value=18}] + +Output:: + + { + "VpnConnection": { + "CustomerGatewayConfiguration": "...configuration information...", + "CustomerGatewayId": "cgw-aabbccddee1122334", + "Category": "VPN", + "State": "available", + "Type": "ipsec.1", + "VpnConnectionId": "vpn-12345678901234567", + "VpnGatewayId": "vgw-11223344556677889", + "Options": { + "StaticRoutesOnly": false, + "TunnelOptions": [ + { + "OutsideIpAddress": "203.0.113.17", + "Phase1DHGroupNumbers": [ + { + "Value": 14 + }, + { + "Value": 15 + }, + { + "Value": 16 + }, + { + "Value": 17 + }, + { + "Value": 18 + } + ], + "Phase2DHGroupNumbers": [ + { + "Value": 14 + }, + { + "Value": 15 + }, + { + "Value": 16 + }, + { + "Value": 17 + }, + { + "Value": 18 + } + ] + }, + { + "OutsideIpAddress": "203.0.114.19" + } + ] + }, + "VgwTelemetry": [ + { + "AcceptedRouteCount": 0, + "LastStatusChange": "2019-09-10T21:56:54.000Z", + "OutsideIpAddress": "203.0.113.17", + "Status": "DOWN", + "StatusMessage": "IPSEC IS DOWN" + }, + { + "AcceptedRouteCount": 0, + "LastStatusChange": "2019-09-10T21:56:43.000Z", + "OutsideIpAddress": "203.0.114.19", + "Status": "DOWN", + "StatusMessage": "IPSEC IS DOWN" + } + ] + } + } diff -Nru awscli-1.11.13/awscli/examples/ec2/provision-byoip-cidr.rst awscli-1.18.69/awscli/examples/ec2/provision-byoip-cidr.rst --- awscli-1.11.13/awscli/examples/ec2/provision-byoip-cidr.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/provision-byoip-cidr.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To provision an address range** + +The following ``provision-byoip-cidr`` example provisions a public IP address range for use with AWS. :: + + aws ec2 provision-byoip-cidr \ + --cidr 203.0.113.25/24 \ + --cidr-authorization-context Message="$text_message",Signature="$signed_message" + +Output:: + + { + "ByoipCidr": { + "Cidr": "203.0.113.25/24", + "State": "pending-provision" + } + } + +For more information about creating the messages strings for the authorization context, see `Bring Your Own IP Addresses `__ in the *Amazon EC2 User Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/purchase-host-reservation.rst awscli-1.18.69/awscli/examples/ec2/purchase-host-reservation.rst --- awscli-1.11.13/awscli/examples/ec2/purchase-host-reservation.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/purchase-host-reservation.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,27 @@ +**To purchase a Dedicated Host Reservation** + +This example purchases the specified Dedicated Host Reservation offering for the specified Dedicated Host in your account. + +Command:: + + aws ec2 purchase-host-reservation --offering-id hro-03f707bf363b6b324 --host-id-set h-013abcd2a00cbd123 + +Output:: + + { + "TotalHourlyPrice": "1.499", + "Purchase": [ + { + "HourlyPrice": "1.499", + "InstanceFamily": "m4", + "PaymentOption": "NoUpfront", + "HostIdSet": [ + "h-013abcd2a00cbd123" + ], + "HostReservationId": "hr-0d418a3a4ffc669ae", + "UpfrontPrice": "0.000", + "Duration": 31536000 + } + ], + "TotalUpfrontPrice": "0.000" + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/purchase-reserved-instance-offering.rst awscli-1.18.69/awscli/examples/ec2/purchase-reserved-instance-offering.rst --- awscli-1.11.13/awscli/examples/ec2/purchase-reserved-instance-offering.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/purchase-reserved-instance-offering.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To purchase a Reserved Instance offering** + +The following ``purchase-reserved-instances-offering`` example command purchases a Reserved Instances offering, specifying an offering ID and instance count. :: + + aws ec2 purchase-reserved-instances-offering \ + --reserved-instances-offering-id ec06327e-dd07-46ee-9398-75b5fexample \ + --instance-count 3 + +Output:: + + { + "ReservedInstancesId": "af9f760e-6f91-4559-85f7-4980eexample" + } + +By default, the purchase is completed immediately. Alternatively, to queue the purchase until a specified time, add the following parameter to the previous call. :: + + --purchase-time "2020-12-01T00:00:00Z" diff -Nru awscli-1.11.13/awscli/examples/ec2/register-transit-gateway-multicast-group-members.rst awscli-1.18.69/awscli/examples/ec2/register-transit-gateway-multicast-group-members.rst --- awscli-1.11.13/awscli/examples/ec2/register-transit-gateway-multicast-group-members.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/register-transit-gateway-multicast-group-members.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/register-transit-gateway-multicast-group-source.rst awscli-1.18.69/awscli/examples/ec2/register-transit-gateway-multicast-group-source.rst --- awscli-1.11.13/awscli/examples/ec2/register-transit-gateway-multicast-group-source.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/register-transit-gateway-multicast-group-source.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/reject-transit-gateway-peering-attachment.rst awscli-1.18.69/awscli/examples/ec2/reject-transit-gateway-peering-attachment.rst --- awscli-1.11.13/awscli/examples/ec2/reject-transit-gateway-peering-attachment.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/reject-transit-gateway-peering-attachment.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/reject-transit-gateway-vpc-attachments.rst awscli-1.18.69/awscli/examples/ec2/reject-transit-gateway-vpc-attachments.rst --- awscli-1.11.13/awscli/examples/ec2/reject-transit-gateway-vpc-attachments.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/reject-transit-gateway-vpc-attachments.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,28 @@ +**To reject a Transit Gateway VPC attachment** + +The following ``reject-transit-gateway-vpc-attachment`` example rejects the specified transit gateway VPC attachment. :: + + aws ec2 reject-transit-gateway-vpc-attachment \ + --transit-gateway-attachment-id tgw-attach-0a34fe6b4fEXAMPLE + +Output:: + + { + "TransitGatewayVpcAttachment": { + "TransitGatewayAttachmentId": "tgw-attach-0a34fe6b4fEXAMPLE", + "TransitGatewayId": "tgw-0262a0e521EXAMPLE", + "VpcId": "vpc-07e8ffd50fEXAMPLE", + "VpcOwnerId": "111122223333", + "State": "pending", + "SubnetIds": [ + "subnet-0752213d59EXAMPLE" + ], + "CreationTime": "2019-07-10T17:33:46.000Z", + "Options": { + "DnsSupport": "enable", + "Ipv6Support": "disable" + } + } + } + +For more information, see `Transit Gateway Attachments to a VPC `__ in the *AWS Transit Gateways User Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/reject-vpc-endpoint-connections.rst awscli-1.18.69/awscli/examples/ec2/reject-vpc-endpoint-connections.rst --- awscli-1.11.13/awscli/examples/ec2/reject-vpc-endpoint-connections.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/reject-vpc-endpoint-connections.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,13 @@ +**To reject an interface endpoint connection request** + +This example rejects the specified endpoint connection request for the specified endpoint service. + +Command:: + + aws ec2 reject-vpc-endpoint-connections --service-id vpce-svc-03d5ebb7d9579a2b3 --vpc-endpoint-ids vpce-0c1308d7312217abc + +Output:: + + { + "Unsuccessful": [] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ec2/replace-iam-instance-profile-association.rst awscli-1.18.69/awscli/examples/ec2/replace-iam-instance-profile-association.rst --- awscli-1.11.13/awscli/examples/ec2/replace-iam-instance-profile-association.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/replace-iam-instance-profile-association.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To replace an IAM instance profile for an instance** + +This example replaces the IAM instance profile represented by the association ``iip-assoc-060bae234aac2e7fa`` with the IAM instance profile named ``AdminRole``. :: + + aws ec2 replace-iam-instance-profile-association \ + --iam-instance-profile Name=AdminRole \ + --association-id iip-assoc-060bae234aac2e7fa + +Output:: + + { + "IamInstanceProfileAssociation": { + "InstanceId": "i-087711ddaf98f9489", + "State": "associating", + "AssociationId": "iip-assoc-0b215292fab192820", + "IamInstanceProfile": { + "Id": "AIPAJLNLDX3AMYZNWYYAY", + "Arn": "arn:aws:iam::123456789012:instance-profile/AdminRole" + } + } + } diff -Nru awscli-1.11.13/awscli/examples/ec2/replace-route.rst awscli-1.18.69/awscli/examples/ec2/replace-route.rst --- awscli-1.11.13/awscli/examples/ec2/replace-route.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/replace-route.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,6 +1,6 @@ **To replace a route** -This example replaces the specified route in the specified table table. The new route matches the specified CIDR and sends the traffic to the specified virtual private gateway. If the command succeeds, no output is returned. +This example replaces the specified route in the specified route table. The new route matches the specified CIDR and sends the traffic to the specified virtual private gateway. If the command succeeds, no output is returned. Command:: diff -Nru awscli-1.11.13/awscli/examples/ec2/replace-transit-gateway-route.rst awscli-1.18.69/awscli/examples/ec2/replace-transit-gateway-route.rst --- awscli-1.11.13/awscli/examples/ec2/replace-transit-gateway-route.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/replace-transit-gateway-route.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,27 @@ +**To replace the specified route in the specified transit gateway route table** + +The following ``replace-transit-gateway-route`` example replaces the route in the specified transit gateway route table. :: + + aws ec2 replace-transit-gateway-route \ + --destination-cidr-block 10.0.2.0/24 \ + --transit-gateway-attachment-id tgw-attach-09b52ccdb5EXAMPLE \ + --transit-gateway-route-table-id tgw-rtb-0a823edbdeEXAMPLE + +Output:: + + { + "Route": { + "DestinationCidrBlock": "10.0.2.0/24", + "TransitGatewayAttachments": [ + { + "ResourceId": "vpc-4EXAMPLE", + "TransitGatewayAttachmentId": "tgw-attach-09b52ccdb5EXAMPLE", + "ResourceType": "vpc" + } + ], + "Type": "static", + "State": "active" + } + } + +For more information, see `Transit Gateway Route Tables `__ in the *AWS Transit Gateways Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/reset-ebs-default-kms-key-id.rst awscli-1.18.69/awscli/examples/ec2/reset-ebs-default-kms-key-id.rst --- awscli-1.11.13/awscli/examples/ec2/reset-ebs-default-kms-key-id.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/reset-ebs-default-kms-key-id.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To reset your default CMK for EBS encryption** + +The following ``reset-ebs-default-kms-key-id`` example resets the default CMK for EBS encryption for your AWS account in the current Region. :: + + aws ec2 reset-ebs-default-kms-key-id + +Output:: + + { + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/8c5b2c63-b9bc-45a3-a87a-5513eEXAMPLE" + } diff -Nru awscli-1.11.13/awscli/examples/ec2/reset-fpga-image-attribute.rst awscli-1.18.69/awscli/examples/ec2/reset-fpga-image-attribute.rst --- awscli-1.11.13/awscli/examples/ec2/reset-fpga-image-attribute.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/reset-fpga-image-attribute.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,13 @@ +**To reset the attributes of an Amazon FPGA image** + +This example resets the load permissions for the specified AFI. + +Command:: + + aws ec2 reset-fpga-image-attribute --fpga-image-id afi-0d123e123bfc85abc --attribute loadPermission + +Output:: + + { + "Return": true + } diff -Nru awscli-1.11.13/awscli/examples/ec2/reset-network-interface-attribute.rst awscli-1.18.69/awscli/examples/ec2/reset-network-interface-attribute.rst --- awscli-1.11.13/awscli/examples/ec2/reset-network-interface-attribute.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/reset-network-interface-attribute.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To reset a network interface attribute** + +The following ``reset-network-interface-attribute`` example resets the value of the source/destination checking attribute to ``true``. :: + + aws ec2 reset-network-interface-attribute \ + --network-interface-id eni-686ea200 \ + --source-dest-check + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/ec2/revoke-client-vpn-ingress.rst awscli-1.18.69/awscli/examples/ec2/revoke-client-vpn-ingress.rst --- awscli-1.11.13/awscli/examples/ec2/revoke-client-vpn-ingress.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/revoke-client-vpn-ingress.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To revoke an authorization rule for a Client VPN endpoint** + +The following ``revoke-client-vpn-ingress`` example revokes a rule for internet access (``0.0.0.0/0``) for all groups. :: + + aws ec2 revoke-client-vpn-ingress \ + --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde \ + --target-network-cidr 0.0.0.0/0 --revoke-all-groups + +Output:: + + { + "Status": { + "Code": "revoking" + } + } + +For more information, see `Authorization Rules `__ in the *AWS Client VPN Administrator Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/run-instances.rst awscli-1.18.69/awscli/examples/ec2/run-instances.rst --- awscli-1.11.13/awscli/examples/ec2/run-instances.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/run-instances.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,285 +1,398 @@ -**To launch an instance in EC2-Classic** +**Example 1: To launch an instance in EC2-Classic** -This example launches a single instance of type ``t1.micro``. +The following ``run-instances`` example launches a single instance of type ``c3.large``. The key pair and security group must already exist. :: -The key pair and security group, named ``MyKeyPair`` and ``MySecurityGroup``, must exist. - -Command:: - - aws ec2 run-instances --image-id ami-1a2b3c4d --count 1 --instance-type t1.micro --key-name MyKeyPair --security-groups MySecurityGroup + aws ec2 run-instances \ + --image-id ami-1a2b3c4d \ + --count 1 \ + --instance-type c3.large \ + --key-name MyKeyPair \ + --security-groups MySecurityGroup Output:: - { - "OwnerId": "123456789012", - "ReservationId": "r-08626e73c547023b1", - "Groups": [ - { - "GroupName": "MySecurityGroup", - "GroupId": "sg-903004f8" - } - ], - "Instances": [ - { - "Monitoring": { - "State": "disabled" - }, - "PublicDnsName": null, - "RootDeviceType": "ebs", - "State": { - "Code": 0, - "Name": "pending" - }, - "EbsOptimized": false, - "LaunchTime": "2013-07-19T02:42:39.000Z", - "ProductCodes": [], - "StateTransitionReason": null, - "InstanceId": "i-1234567890abcdef0", - "ImageId": "ami-1a2b3c4d", - "PrivateDnsName": null, - "KeyName": "MyKeyPair", - "SecurityGroups": [ - { - "GroupName": "MySecurityGroup", - "GroupId": "sg-903004f8" - } - ], - "ClientToken": null, - "InstanceType": "t1.micro", - "NetworkInterfaces": [], - "Placement": { - "Tenancy": "default", - "GroupName": null, - "AvailabilityZone": "us-east-1b" - }, - "Hypervisor": "xen", - "BlockDeviceMappings": [], - "Architecture": "x86_64", - "StateReason": { - "Message": "pending", - "Code": "pending" - }, - "RootDeviceName": "/dev/sda1", - "VirtualizationType": "hvm", - "AmiLaunchIndex": 0 - } - ] - } - -**To launch an instance in EC2-VPC** - -This example launches a single instance of type ``t2.micro`` into the specified subnet. + { + "OwnerId": "123456789012", + "ReservationId": "r-08626e73c547023b1", + "Groups": [ + { + "GroupName": "MySecurityGroup", + "GroupId": "sg-903004f8" + } + ], + "Instances": [ + { + "Monitoring": { + "State": "disabled" + }, + "PublicDnsName": null, + "RootDeviceType": "ebs", + "State": { + "Code": 0, + "Name": "pending" + }, + "EbsOptimized": false, + "LaunchTime": "2018-05-10T08:03:30.000Z", + "ProductCodes": [], + "CpuOptions": { + "CoreCount": 1, + "ThreadsPerCore": 2 + }, + "StateTransitionReason": null, + "InstanceId": "i-1234567890abcdef0", + "ImageId": "ami-1a2b3c4d", + "PrivateDnsName": null, + "KeyName": "MyKeyPair", + "SecurityGroups": [ + { + "GroupName": "MySecurityGroup", + "GroupId": "sg-903004f8" + } + ], + "ClientToken": null, + "InstanceType": "c3.large", + "NetworkInterfaces": [], + "Placement": { + "Tenancy": "default", + "GroupName": null, + "AvailabilityZone": "us-east-1b" + }, + "Hypervisor": "xen", + "BlockDeviceMappings": [], + "Architecture": "x86_64", + "StateReason": { + "Message": "pending", + "Code": "pending" + }, + "RootDeviceName": "/dev/sda1", + "VirtualizationType": "hvm", + "AmiLaunchIndex": 0 + } + ] + } -The key pair named ``MyKeyPair`` and the security group sg-903004f8 must exist. +**Example 2: To launch an instance in EC2-VPC** -Command:: +The following ``run-instances`` example launches a single instance of type ``t2.micro`` into the specified subnet. The key pair and the security group must already exist. :: - aws ec2 run-instances --image-id ami-abc12345 --count 1 --instance-type t2.micro --key-name MyKeyPair --security-group-ids sg-903004f8 --subnet-id subnet-6e7f829e + aws ec2 run-instances \ + --image-id ami-abc12345 \ + --count 1 \ + --instance-type t2.micro \ + --key-name MyKeyPair \ + --security-group-ids sg-1a2b3c4d \ + --subnet-id subnet-6e7f829e Output:: - { - "OwnerId": "123456789012", - "ReservationId": "r-08626e73c547023b2", - "Groups": [], - "Instances": [ - { - "Monitoring": { - "State": "disabled" - }, - "PublicDnsName": null, - "RootDeviceType": "ebs", - "State": { - "Code": 0, - "Name": "pending" - }, - "EbsOptimized": false, - "LaunchTime": "2013-07-19T02:42:39.000Z", - "PrivateIpAddress": "10.0.1.114", - "ProductCodes": [], - "VpcId": "vpc-1a2b3c4d", - "InstanceId": "i-1234567890abcdef5", - "ImageId": "ami-abc12345", - "PrivateDnsName": "ip-10-0-1-114.ec2.internal", - "KeyName": "MyKeyPair", - "SecurityGroups": [ - { - "GroupName": "MySecurityGroup", - "GroupId": "sg-903004f8" - } - ], - "ClientToken": null, - "SubnetId": "subnet-6e7f829e", - "InstanceType": "t2.micro", - "NetworkInterfaces": [ - { - "Status": "in-use", - "MacAddress": "0e:ad:05:3b:60:52", - "SourceDestCheck": true, - "VpcId": "vpc-1a2b3c4d", - "Description": "null", - "NetworkInterfaceId": "eni-a7edb1c9", - "PrivateIpAddresses": [ - { - "PrivateDnsName": "ip-10-0-1-114.ec2.internal", - "Primary": true, - "PrivateIpAddress": "10.0.1.114" - } - ], - "PrivateDnsName": "ip-10-0-1-114.ec2.internal", - "Attachment": { - "Status": "attached", - "DeviceIndex": 0, - "DeleteOnTermination": true, - "AttachmentId": "eni-attach-52193138", - "AttachTime": "2013-07-19T02:42:39.000Z" - }, - "Groups": [ - { - "GroupName": "MySecurityGroup", - "GroupId": "sg-903004f8" - } - ], - "SubnetId": "subnet-6e7f829e", - "OwnerId": "123456789012", - "PrivateIpAddress": "10.0.1.114" - } - ], - "SourceDestCheck": true, - "Placement": { - "Tenancy": "default", - "GroupName": null, - "AvailabilityZone": "us-east-1b" - }, - "Hypervisor": "xen", - "BlockDeviceMappings": [], - "Architecture": "x86_64", - "StateReason": { - "Message": "pending", - "Code": "pending" - }, - "RootDeviceName": "/dev/sda1", - "VirtualizationType": "hvm", - "AmiLaunchIndex": 0 - } - ] - } - -The following example requests a public IP address for an instance that you're launching into a nondefault subnet: + { + "Instances": [ + { + "Monitoring": { + "State": "disabled" + }, + "PublicDnsName": "", + "StateReason": { + "Message": "pending", + "Code": "pending" + }, + "State": { + "Code": 0, + "Name": "pending" + }, + "EbsOptimized": false, + "LaunchTime": "2018-05-10T08:05:20.000Z", + "PrivateIpAddress": "10.0.0.157", + "ProductCodes": [], + "VpcId": "vpc-11223344", + "CpuOptions": { + "CoreCount": 1, + "ThreadsPerCore": 1 + }, + "StateTransitionReason": "", + "InstanceId": "i-1231231230abcdef0", + "ImageId": "ami-abc12345", + "PrivateDnsName": "ip-10-0-0-157.ec2.internal", + "SecurityGroups": [ + { + "GroupName": "MySecurityGroup", + "GroupId": "sg-1a2b3c4d" + } + ], + "ClientToken": "", + "SubnetId": "subnet-6e7f829e", + "InstanceType": "t2.micro", + "NetworkInterfaces": [ + { + "Status": "in-use", + "MacAddress": "0a:ab:58:e0:67:e2", + "SourceDestCheck": true, + "VpcId": "vpc-11223344", + "Description": "", + "NetworkInterfaceId": "eni-95c6390b", + "PrivateIpAddresses": [ + { + "PrivateDnsName": "ip-10-0-0-157.ec2.internal", + "Primary": true, + "PrivateIpAddress": "10.0.0.157" + } + ], + "PrivateDnsName": "ip-10-0-0-157.ec2.internal", + "Attachment": { + "Status": "attaching", + "DeviceIndex": 0, + "DeleteOnTermination": true, + "AttachmentId": "eni-attach-bf87ca1f", + "AttachTime": "2018-05-10T08:05:20.000Z" + }, + "Groups": [ + { + "GroupName": "MySecurityGroup", + "GroupId": "sg-1a2b3c4d" + } + ], + "Ipv6Addresses": [], + "OwnerId": "123456789012", + "SubnetId": "subnet-6e7f829e", + "PrivateIpAddress": "10.0.0.157" + } + ], + "SourceDestCheck": true, + "Placement": { + "Tenancy": "default", + "GroupName": "", + "AvailabilityZone": "us-east-1a" + }, + "Hypervisor": "xen", + "BlockDeviceMappings": [], + "Architecture": "x86_64", + "RootDeviceType": "ebs", + "RootDeviceName": "/dev/xvda", + "VirtualizationType": "hvm", + "AmiLaunchIndex": 0 + } + ], + "ReservationId": "r-02a3f596d91211712", + "Groups": [], + "OwnerId": "123456789012" + } -Command:: +**Example 3: To launch an instance into a non-default subnet and add a public IP address** - aws ec2 run-instances --image-id ami-c3b8d6aa --count 1 --instance-type t1.micro --key-name MyKeyPair --security-group-ids sg-903004f8 --subnet-id subnet-6e7f829e --associate-public-ip-address +The following ``run-instances`` example requests a public IP address for an instance that you're launching into a nondefault subnet. :: -**To launch an instance using a block device mapping** + aws ec2 run-instances \ + --image-id ami-c3b8d6aa \ + --count 1 \ + --instance-type t2.medium \ + --key-name MyKeyPair \ + --security-group-ids sg-903004f8 \ + --subnet-id subnet-6e7f829e \ + --associate-public-ip-address -Add the following parameter to your ``run-instances`` command to specify block devices:: +**Example 4: To launch an instance using a block device mapping** - --block-device-mappings file://mapping.json +Add the following parameter to your ``run-instances`` command to specify a file that defines block devices to attach to the new instance:: + + --block-device-mappings file://mapping.json To add an Amazon EBS volume with the device name ``/dev/sdh`` and a volume size of 100, specify the following in mapping.json:: - [ - { - "DeviceName": "/dev/sdh", - "Ebs": { - "VolumeSize": 100 - } - } - ] + [ + { + "DeviceName": "/dev/sdh", + "Ebs": { + "VolumeSize": 100 + } + } + ] To add ``ephemeral1`` as an instance store volume with the device name ``/dev/sdc``, specify the following in mapping.json:: - [ - { - "DeviceName": "/dev/sdc", - "VirtualName": "ephemeral1" - } - ] + [ + { + "DeviceName": "/dev/sdc", + "VirtualName": "ephemeral1" + } + ] To omit a device specified by the AMI used to launch the instance (for example, ``/dev/sdf``), specify the following in mapping.json:: - [ - { - "DeviceName": "/dev/sdf", - "NoDevice": "" - } - ] - -You can view only the Amazon EBS volumes in your block device mapping using the console or the ``describe-instances`` command. To view all volumes, including the instance store volumes, use the following command. + [ + { + "DeviceName": "/dev/sdf", + "NoDevice": "" + } + ] -Command:: +After you create an instance with block devices this way, you can view only the Amazon EBS volumes in your block device mapping by using the console or by running the ``describe-instances`` command. To view all volumes, including the instance store volumes, run the following command from within the instance:: - curl http://169.254.169.254/latest/meta-data/block-device-mapping/ + curl http://169.254.169.254/latest/meta-data/block-device-mapping/ Output:: ami ephemeral1 -Note that ``ami`` represents the root volume. To get details about the instance store volume ``ephemeral1``, use the following command. - -Command:: +Note that ``ami`` represents the root volume. To get details about the instance store volume ``ephemeral1``, run the following command from within the instance:: - curl http://169.254.169.254/latest/meta-data/block-device-mapping/ephemeral1 + curl http://169.254.169.254/latest/meta-data/block-device-mapping/ephemeral1 Output:: sdc -**To launch an instance with a modified block device mapping** +**Example 4: To launch an instance with a modified block device mapping** You can change individual characteristics of existing AMI block device mappings to suit your needs. Perhaps you want to use an existing AMI, but you want a larger root volume than the usual 8 GiB. Or, you would like to use a General Purpose (SSD) volume for an AMI that currently uses a Magnetic volume. -Use the ``describe-images`` command with the image ID of the AMI you want to use to find its existing block device mapping. You should see a block device mapping in the output:: - - { - "DeviceName": "/dev/sda1", - "Ebs": { - "DeleteOnTermination": true, - "SnapshotId": "snap-1234567890abcdef0", - "VolumeSize": 8, - "VolumeType": "standard", - "Encrypted": false - } - } - -You can modify the above mapping by changing the individual parameters. For example, to launch an instance with a modified block device mapping, add the following parameter to your ``run-instances`` command to change the above mapping's volume size and type:: - - --block-device-mappings file://mapping.json - -Where mapping.json contains the following:: +Start by running the ``describe-images`` command with the image ID of the AMI you want to use to find its existing block device mapping. You should see a block device mapping in the output similar to the following:: - [ { - "DeviceName": "/dev/sda1", - "Ebs": { - "DeleteOnTermination": true, - "SnapshotId": "snap-1234567890abcdef0", - "VolumeSize": 100, - "VolumeType": "gp2" - } + "DeviceName": "/dev/sda1", + "Ebs": { + "DeleteOnTermination": true, + "SnapshotId": "snap-1234567890abcdef0", + "VolumeSize": 8, + "VolumeType": "standard", + "Encrypted": false + } } - ] -**To launch an instance with user data** +You can modify the above mapping by including the modified individual parameters in a block device mapping file. For example, to launch an instance with a modified block device mapping, add the following parameter to your ``run-instances`` command to change the above mapping's volume size and type:: -You can launch an instance and specify user data that performs instance configuration, or that runs a script. The user data needs to be passed as normal string, base64 encoding is handled internally. The following example passes user data in a file called ``my_script.txt`` that contains a configuration script for your instance. The script runs at launch. - -Command:: - - aws ec2 run-instances --image-id ami-abc1234 --count 1 --instance-type m4.large --key-name keypair --user-data file://my_script.txt --subnet-id subnet-abcd1234 --security-group-ids sg-abcd1234 - -For more information about launching instances, see `Using Amazon EC2 Instances`_ in the *AWS Command Line Interface User Guide*. - -.. _`Using Amazon EC2 Instances`: http://docs.aws.amazon.com/cli/latest/userguide/cli-ec2-launch.html - -**To launch an instance with an instance profile** - -This example shows the use of the ``iam-instance-profile`` option to specify an `IAM instance profile`_ by name. + --block-device-mappings file://mapping.json -.. _`IAM instance profile`: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html +Where ``mapping.json`` contains the following (note the change in ``VolumeSize`` from ``8`` to ``100`` and the change in ``VolumeType`` from ``standard`` to ``gp2``):: -Command:: + [ + { + "DeviceName": "/dev/sda1", + "Ebs": { + "DeleteOnTermination": true, + "SnapshotId": "snap-1234567890abcdef0", + "VolumeSize": 100, + "VolumeType": "gp2" + } + } + ] + +**Example 5: To launch an instance that includes user data** + +You can launch an instance and specify user data that performs instance configuration, or that runs a script. The user data needs to be passed as normal string, base64 encoding is handled internally. The following example passes user data in a file called ``my_script.txt`` that contains a configuration script for your instance. The script runs at launch. :: + + aws ec2 run-instances \ + --image-id ami-abc1234 \ + --count 1 \ + --instance-type m4.large \ + --key-name keypair \ + --user-data file://my_script.txt \ + --subnet-id subnet-abcd1234 \ + --security-group-ids sg-abcd1234 + +For more information about launching instances, see `Using Amazon EC2 Instances `__ in the *AWS Command Line Interface User Guide*. + +**Example 6: To launch an instance with an instance profile** + +The following ``run-instances`` example shows the use of the ``iam-instance-profile`` option to specify an `IAM instance profile `__ by name. :: + + aws ec2 run-instances \ + --iam-instance-profile Name=MyInstanceProfile \ + --image-id ami-1a2b3c4d \ + --count 1 \ + --instance-type t2.micro \ + --key-name MyKeyPair \ + --security-groups MySecurityGroup + +**Example 7: To launch an instance with tags** + +You can launch an instance and specify tags for the instance, volumes, or both. The following example applies a tag with a key of ``webserver`` and value of ``production`` to the instance. The command also applies a tag with a key of ``cost-center`` and a value of ``cc123`` to any EBS volume that's created (in this case, the root volume). :: + + aws ec2 run-instances \ + --image-id ami-abc12345 \ + --count 1 \ + --instance-type t2.micro \ + --key-name MyKeyPair \ + --subnet-id subnet-6e7f829e \ + --tag-specifications 'ResourceType=instance,Tags=[{Key=webserver,Value=production}]' 'ResourceType=volume,Tags=[{Key=cost-center,Value=cc123}]' + +**Example 8: To launch an instance with the credit option for CPU usage of ``unlimited``** + +You can launch a burstable performance instance (T2 and T3) and specify the credit option for CPU usage for the instance. If you do not specify the credit option, a T2 instance launches with the default ``standard`` credit option and a T3 instance launches with the default ``unlimited`` credit option. The following example launches a t2.micro instance with the ``unlimited`` credit option. :: + + aws ec2 run-instances \ + --image-id ami-abc12345 \ + --count 1 \ + --instance-type t2.micro \ + --key-name MyKeyPair \ + --credit-specification CpuCredits=unlimited + +**Example 9: To launch an instance into a partition placement group** + +You can launch an instance into a partition placement group without specifying the partition. The following ``run-instances`` example launches the instance into the specified partition placement group. :: + + aws ec2 run-instances \ + --image-id ami-abc12345 \ + --count 1 \ + --instance-type t2.micro \ + --key-name MyKeyPair \ + --subnet-id subnet-6e7f829e \ + --placement "GroupName = HDFS-Group-A" + +**Example 10: To launch an instance into a specific partition of a partition placement group** + +You can launch an instance into a specific partition of a partition placement group by specifying the partition number. The following ``run-instances`` example launches the instance into the specified partition placement group and into partition number ``3``. :: + + aws ec2 run-instances \ + --image-id ami-abc12345 \ + --count 1 \ + --instance-type t2.micro \ + --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" - aws ec2 run-instances --iam-instance-profile Name=MyInstanceProfile --image-id ami-1a2b3c4d --count 1 --instance-type t2.micro --key-name MyKeyPair --security-groups MySecurityGroup +For more information, see `Configuring the Instance Metadata Service `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. diff -Nru awscli-1.11.13/awscli/examples/ec2/search-local-gateway-routes.rst awscli-1.18.69/awscli/examples/ec2/search-local-gateway-routes.rst --- awscli-1.11.13/awscli/examples/ec2/search-local-gateway-routes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/search-local-gateway-routes.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/search-transit-gateway-multicast-groups.rst awscli-1.18.69/awscli/examples/ec2/search-transit-gateway-multicast-groups.rst --- awscli-1.11.13/awscli/examples/ec2/search-transit-gateway-multicast-groups.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/search-transit-gateway-multicast-groups.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/search-transit-gateway-routes.rst awscli-1.18.69/awscli/examples/ec2/search-transit-gateway-routes.rst --- awscli-1.11.13/awscli/examples/ec2/search-transit-gateway-routes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/search-transit-gateway-routes.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,41 @@ +**To search for routes in the specified transit gateway route table** + +The following ``search-transit-gateway-routes`` example returns all the routes that are of type ``static`` in the specified route table. :: + + aws ec2 search-transit-gateway-routes \ + --transit-gateway-route-table-id tgw-rtb-0a823edbdeEXAMPLE \ + --filters "Name=type,Values=static" + +Output:: + + { + "Routes": [ + { + "DestinationCidrBlock": "10.0.2.0/24", + "TransitGatewayAttachments": [ + { + "ResourceId": "vpc-4EXAMPLE", + "TransitGatewayAttachmentId": "tgw-attach-09b52ccdb5EXAMPLE", + "ResourceType": "vpc" + } + ], + "Type": "static", + "State": "active" + }, + { + "DestinationCidrBlock": "10.1.0.0/24", + "TransitGatewayAttachments": [ + { + "ResourceId": "vpc-4EXAMPLE", + "TransitGatewayAttachmentId": "tgw-attach-09b52ccdb5EXAMPLE", + "ResourceType": "vpc" + } + ], + "Type": "static", + "State": "active" + } + ], + "AdditionalRoutesAvailable": false + } + +For more information, see `View Transit Gateway Route Tables `__ in the *AWS Transit Gateways Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/send-diagnostic-interrupt.rst awscli-1.18.69/awscli/examples/ec2/send-diagnostic-interrupt.rst --- awscli-1.11.13/awscli/examples/ec2/send-diagnostic-interrupt.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/send-diagnostic-interrupt.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To send a diagnostic interrupt** + +The following ``send-diagnostic-interrupt`` example sends a diagnostic interrupt to the specified instance. :: + + aws ec2 send-diagnostic-interrupt \ + --instance-id i-1234567890abcdef0 + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/ec2/terminate-client-vpn-connections.rst awscli-1.18.69/awscli/examples/ec2/terminate-client-vpn-connections.rst --- awscli-1.11.13/awscli/examples/ec2/terminate-client-vpn-connections.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/terminate-client-vpn-connections.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,26 @@ +**To terminate a connection to a Client VPN endpoint** + +The following ``terminate-client-vpn-connections`` example terminates the specified connection to the Client VPN endpoint. :: + + aws ec2 terminate-client-vpn-connections \ + --client-vpn-endpoint-id vpn-endpoint-123456789123abcde \ + --connection-id cvpn-connection-04edd76f5201e0cb8 + +Output:: + + { + "ClientVpnEndpointId": "vpn-endpoint-123456789123abcde", + "ConnectionStatuses": [ + { + "ConnectionId": "cvpn-connection-04edd76f5201e0cb8", + "PreviousStatus": { + "Code": "active" + }, + "CurrentStatus": { + "Code": "terminating" + } + } + ] + } + +For more information, see `Client Connections `__ in the *AWS Client VPN Administrator Guide*. diff -Nru awscli-1.11.13/awscli/examples/ec2/unassign-ipv6-addresses.rst awscli-1.18.69/awscli/examples/ec2/unassign-ipv6-addresses.rst --- awscli-1.11.13/awscli/examples/ec2/unassign-ipv6-addresses.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/unassign-ipv6-addresses.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,16 @@ +**To unassign an IPv6 address from a network interface** + +This example unassigns the specified IPv6 address from the specified network interface. + +Command:: + + aws ec2 unassign-ipv6-addresses --ipv6-addresses 2001:db8:1234:1a00:3304:8879:34cf:4071 --network-interface-id eni-23c49b68 + +Output:: + + { + "NetworkInterfaceId": "eni-23c49b68", + "UnassignedIpv6Addresses": [ + "2001:db8:1234:1a00:3304:8879:34cf:4071" + ] + } diff -Nru awscli-1.11.13/awscli/examples/ec2/update-security-group-rule-descriptions-egress.rst awscli-1.18.69/awscli/examples/ec2/update-security-group-rule-descriptions-egress.rst --- awscli-1.11.13/awscli/examples/ec2/update-security-group-rule-descriptions-egress.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/update-security-group-rule-descriptions-egress.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,7 @@ +**To update an outbound security group rule description** + +This example updates the description for the security group rule that allows outbound access over port 80 to the ``203.0.113.0/24`` IPv4 address range. The description '``Outbound HTTP access to server 2``' replaces any existing description for the rule. If the command succeeds, no output is returned. + +Command:: + + aws ec2 update-security-group-rule-descriptions-egress --group-id sg-123abc12 --ip-permissions '[{"IpProtocol": "tcp", "FromPort": 80, "ToPort": 80, "IpRanges": [{"CidrIp": "203.0.113.0/24", "Description": "Outbound HTTP access to server 2"}]}]' diff -Nru awscli-1.11.13/awscli/examples/ec2/update-security-group-rule-descriptions-ingress.rst awscli-1.18.69/awscli/examples/ec2/update-security-group-rule-descriptions-ingress.rst --- awscli-1.11.13/awscli/examples/ec2/update-security-group-rule-descriptions-ingress.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/update-security-group-rule-descriptions-ingress.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,7 @@ +**To update an inbound security group rule description** + +This example updates the description for the security group rule that allows inbound access over port 22 from the ``203.0.113.0/16`` IPv4 address range. The description '``SSH access from ABC office``' replaces any existing description for the rule. If the command succeeds, no output is returned. + +Command:: + + aws ec2 update-security-group-rule-descriptions-ingress --group-id sg-123abc12 --ip-permissions '[{"IpProtocol": "tcp", "FromPort": 22, "ToPort": 22, "IpRanges": [{"CidrIp": "203.0.113.0/16", "Description": "SSH access from ABC office"}]}]' diff -Nru awscli-1.11.13/awscli/examples/ec2/wait/bundle-task-complete.rst awscli-1.18.69/awscli/examples/ec2/wait/bundle-task-complete.rst --- awscli-1.11.13/awscli/examples/ec2/wait/bundle-task-complete.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/wait/bundle-task-complete.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/wait/conversion-task-cancelled.rst awscli-1.18.69/awscli/examples/ec2/wait/conversion-task-cancelled.rst --- awscli-1.11.13/awscli/examples/ec2/wait/conversion-task-cancelled.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/wait/conversion-task-cancelled.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/wait/conversion-task-completed.rst awscli-1.18.69/awscli/examples/ec2/wait/conversion-task-completed.rst --- awscli-1.11.13/awscli/examples/ec2/wait/conversion-task-completed.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/wait/conversion-task-completed.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/wait/conversion-task-deleted.rst awscli-1.18.69/awscli/examples/ec2/wait/conversion-task-deleted.rst --- awscli-1.11.13/awscli/examples/ec2/wait/conversion-task-deleted.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/wait/conversion-task-deleted.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/wait/customer-gateway-available.rst awscli-1.18.69/awscli/examples/ec2/wait/customer-gateway-available.rst --- awscli-1.11.13/awscli/examples/ec2/wait/customer-gateway-available.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/wait/customer-gateway-available.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,6 @@ +**To wait until a customer gateway is available** + +The following ``wait customer-gateway-available`` example pauses and resumes running only after it confirms that the specified customer gateway is available. It produces no output. :: + + aws ec2 wait customer-gateway-available \ + --customer-gateway-ids cgw-1234567890abcdef0 diff -Nru awscli-1.11.13/awscli/examples/ec2/wait/export-task-cancelled.rst awscli-1.18.69/awscli/examples/ec2/wait/export-task-cancelled.rst --- awscli-1.11.13/awscli/examples/ec2/wait/export-task-cancelled.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/wait/export-task-cancelled.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/wait/export-task-completed.rst awscli-1.18.69/awscli/examples/ec2/wait/export-task-completed.rst --- awscli-1.11.13/awscli/examples/ec2/wait/export-task-completed.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/wait/export-task-completed.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/wait/image-available.rst awscli-1.18.69/awscli/examples/ec2/wait/image-available.rst --- awscli-1.11.13/awscli/examples/ec2/wait/image-available.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/wait/image-available.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,6 @@ +**To wait until an image is available** + +The following ``wait image-available`` example pauses and resumes running only after it confirms that the specified Amazon Machine Image is available. It produces no output. :: + + aws ec2 wait image-available \ + --image-ids ami-0abcdef1234567890 diff -Nru awscli-1.11.13/awscli/examples/ec2/wait/image-exists.rst awscli-1.18.69/awscli/examples/ec2/wait/image-exists.rst --- awscli-1.11.13/awscli/examples/ec2/wait/image-exists.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/wait/image-exists.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,6 @@ +**To wait until an image exists** + +The following ``wait image-exists`` example pauses and resumes running only after it confirms that the specified Amazon Machine Image exists. It produces no output. :: + + aws ec2 wait image-exists \ + --image-ids ami-0abcdef1234567890 diff -Nru awscli-1.11.13/awscli/examples/ec2/wait/instance-exists.rst awscli-1.18.69/awscli/examples/ec2/wait/instance-exists.rst --- awscli-1.11.13/awscli/examples/ec2/wait/instance-exists.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/wait/instance-exists.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,6 @@ +**To wait until an instance exists** + +The following ``wait instance-exists`` example pauses and resumes running only after it confirms that the specified instance exists. It produces no output. :: + + aws ec2 wait instance-exists \ + --instance-ids i-1234567890abcdef0 diff -Nru awscli-1.11.13/awscli/examples/ec2/wait/instance-running.rst awscli-1.18.69/awscli/examples/ec2/wait/instance-running.rst --- awscli-1.11.13/awscli/examples/ec2/wait/instance-running.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/wait/instance-running.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,6 @@ +**To wait until an instance is running** + +The following ``wait instance-running`` example pauses and resumes running only after it confirms that the specified instance is running. It produces no output. :: + + aws ec2 wait instance-running \ + --instance-ids i-1234567890abcdef0 diff -Nru awscli-1.11.13/awscli/examples/ec2/wait/instance-status-ok.rst awscli-1.18.69/awscli/examples/ec2/wait/instance-status-ok.rst --- awscli-1.11.13/awscli/examples/ec2/wait/instance-status-ok.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/wait/instance-status-ok.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,6 @@ +**To wait until the status of an instance is OK** + +The following ``wait instance-status-ok`` example pauses and resumes running only after it confirms that the status of the specified instance is OK. It produces no output. :: + + aws ec2 wait instance-status-ok \ + --instance-ids i-1234567890abcdef0 diff -Nru awscli-1.11.13/awscli/examples/ec2/wait/instance-stopped.rst awscli-1.18.69/awscli/examples/ec2/wait/instance-stopped.rst --- awscli-1.11.13/awscli/examples/ec2/wait/instance-stopped.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/wait/instance-stopped.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,6 @@ +**To wait until an instance is stopped** + +The following ``wait instance-stopped`` example pauses and resumes running only after it confirms that the specified instance is stopped. It produces no output. :: + + aws ec2 wait instance-stopped \ + --instance-ids i-1234567890abcdef0 diff -Nru awscli-1.11.13/awscli/examples/ec2/wait/instance-terminated.rst awscli-1.18.69/awscli/examples/ec2/wait/instance-terminated.rst --- awscli-1.11.13/awscli/examples/ec2/wait/instance-terminated.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/wait/instance-terminated.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,6 @@ +**To wait until an instance terminates** + +The following ``wait instance-terminated`` example pauses and resumes running only after it confirms that the specified instance is terminated. It produces no output. :: + + aws ec2 wait instance-terminated \ + --instance-ids i-1234567890abcdef0 diff -Nru awscli-1.11.13/awscli/examples/ec2/wait/key-pair-exists.rst awscli-1.18.69/awscli/examples/ec2/wait/key-pair-exists.rst --- awscli-1.11.13/awscli/examples/ec2/wait/key-pair-exists.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/wait/key-pair-exists.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,6 @@ +**To wait until a key pair exists** + +The following ``wait key-pair-exists`` example pauses and resumes running only after it confirms that the specified key pair exists. It produces no output. :: + + aws ec2 wait key-pair-exists \ + --key-names my-key-pair diff -Nru awscli-1.11.13/awscli/examples/ec2/wait/nat-gateway-available.rst awscli-1.18.69/awscli/examples/ec2/wait/nat-gateway-available.rst --- awscli-1.11.13/awscli/examples/ec2/wait/nat-gateway-available.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/wait/nat-gateway-available.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,6 @@ +**To wait until a NAT gateway is available** + +The following ``wait nat-gateway-available`` example pauses and resumes running only after it confirms that the specified NAT gateway is available. It produces no output. :: + + aws ec2 wait nat-gateway-available \ + --nat-gateway-ids nat-1234567890abcdef0 diff -Nru awscli-1.11.13/awscli/examples/ec2/wait/network-interface-available.rst awscli-1.18.69/awscli/examples/ec2/wait/network-interface-available.rst --- awscli-1.11.13/awscli/examples/ec2/wait/network-interface-available.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/wait/network-interface-available.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,6 @@ +**To wait until a network interface is available** + +The following ``wait network-interface-available`` example pauses and resumes running only after it confirms that the specified network interface is available. It produces no output. :: + + aws ec2 wait network-interface-available \ + --network-interface-ids eni-1234567890abcdef0 diff -Nru awscli-1.11.13/awscli/examples/ec2/wait/password-data-available.rst awscli-1.18.69/awscli/examples/ec2/wait/password-data-available.rst --- awscli-1.11.13/awscli/examples/ec2/wait/password-data-available.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/wait/password-data-available.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,6 @@ +**To wait until the password data for a Windows instance is available** + +The following ``wait password-data-available`` example pauses and resumes running only after it confirms that the password data for the specified Windows instance is available. It produces no output. :: + + aws ec2 wait password-data-available \ + --instance-id i-1234567890abcdef0 diff -Nru awscli-1.11.13/awscli/examples/ec2/wait/security-group-exists.rst awscli-1.18.69/awscli/examples/ec2/wait/security-group-exists.rst --- awscli-1.11.13/awscli/examples/ec2/wait/security-group-exists.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/wait/security-group-exists.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ec2/wait/snapshot-completed.rst awscli-1.18.69/awscli/examples/ec2/wait/snapshot-completed.rst --- awscli-1.11.13/awscli/examples/ec2/wait/snapshot-completed.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/wait/snapshot-completed.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,6 @@ +**To wait until a snapshot is completed** + +The following ``wait snapshot-completed`` example pauses and resumes running only after it confirms that the specified snapshot is completed. It produces no output. :: + + aws ec2 wait snapshot-completed \ + --snapshot-ids snap-1234567890abcdef0 diff -Nru awscli-1.11.13/awscli/examples/ec2/wait/spot-instance-request-fulfilled.rst awscli-1.18.69/awscli/examples/ec2/wait/spot-instance-request-fulfilled.rst --- awscli-1.11.13/awscli/examples/ec2/wait/spot-instance-request-fulfilled.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/wait/spot-instance-request-fulfilled.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,6 @@ +**To wait until an Spot Instance request is fulfilled** + +The following ``wait spot-instance-request-fulfilled`` example pauses and resumes running only after it confirms that a Spot Instance request is fulfilled in the specified Availability Zone. It produces no output. :: + + aws ec2 wait spot-instance-request-fulfilled \ + --filters Name=launched-availability-zone,Values=us-east-1 diff -Nru awscli-1.11.13/awscli/examples/ec2/wait/subnet-available.rst awscli-1.18.69/awscli/examples/ec2/wait/subnet-available.rst --- awscli-1.11.13/awscli/examples/ec2/wait/subnet-available.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/wait/subnet-available.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,6 @@ +**To wait until a subnet is available** + +The following ``wait subnet-available`` example pauses and resumes running only after it confirms that the specified subnet is available. It produces no output. :: + + aws ec2 wait subnet-available \ + --subnet-ids subnet-1234567890abcdef0 diff -Nru awscli-1.11.13/awscli/examples/ec2/wait/system-status-ok.rst awscli-1.18.69/awscli/examples/ec2/wait/system-status-ok.rst --- awscli-1.11.13/awscli/examples/ec2/wait/system-status-ok.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/wait/system-status-ok.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,6 @@ +**To wait until the system status is OK** + +The following ``wait system-status-ok`` example command pauses and resumes running only after it confirms that the system status of the specified instance is OK. It produces no output. :: + + aws ec2 wait system-status-ok \ + --instance-ids i-1234567890abcdef0 diff -Nru awscli-1.11.13/awscli/examples/ec2/wait/volume-available.rst awscli-1.18.69/awscli/examples/ec2/wait/volume-available.rst --- awscli-1.11.13/awscli/examples/ec2/wait/volume-available.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/wait/volume-available.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,6 @@ +**To wait until a volume is available** + +The following ``wait volume-available`` example command pauses and resumes running only after it confirms that the specified volume is available. It produces no output. :: + + aws ec2 wait volume-available \ + --volume-ids vol-1234567890abcdef0 diff -Nru awscli-1.11.13/awscli/examples/ec2/wait/volume-deleted.rst awscli-1.18.69/awscli/examples/ec2/wait/volume-deleted.rst --- awscli-1.11.13/awscli/examples/ec2/wait/volume-deleted.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/wait/volume-deleted.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,6 @@ +**To wait until a volume is deleted** + +The following ``wait volume-deleted`` example command pauses and resumes running only after it confirms that the specified volume is deleted. It produces no output. :: + + aws ec2 wait volume-deleted \ + --volume-ids vol-1234567890abcdef0 diff -Nru awscli-1.11.13/awscli/examples/ec2/wait/volume-in-use.rst awscli-1.18.69/awscli/examples/ec2/wait/volume-in-use.rst --- awscli-1.11.13/awscli/examples/ec2/wait/volume-in-use.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/wait/volume-in-use.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,6 @@ +**To wait until a volume is in use** + +The following ``wait volume-in-use`` example pauses and resumes running only after it confirms that the specified volume is in use. It produces no output. :: + + aws ec2 wait volume-in-use \ + --volume-ids vol-1234567890abcdef0 diff -Nru awscli-1.11.13/awscli/examples/ec2/wait/vpc-available.rst awscli-1.18.69/awscli/examples/ec2/wait/vpc-available.rst --- awscli-1.11.13/awscli/examples/ec2/wait/vpc-available.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/wait/vpc-available.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,6 @@ +**To wait until a virtual private cloud (VPC) is available** + +The following ``wait vpc-available`` example pauses and resumes running only after it confirms that the specified VPC is available. It produces no output. :: + + aws ec2 wait vpc-available \ + --vpc-ids vpc-1234567890abcdef0 diff -Nru awscli-1.11.13/awscli/examples/ec2/wait/vpc-exists.rst awscli-1.18.69/awscli/examples/ec2/wait/vpc-exists.rst --- awscli-1.11.13/awscli/examples/ec2/wait/vpc-exists.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/wait/vpc-exists.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,6 @@ +**To wait until a virtual private cloud (VPC) exists** + +The following ``wait vpc-exists`` example command pauses and resumes running only after it confirms that the specified VPC exists. :: + + aws ec2 wait vpc-exists \ + --vpc-ids vpc-1234567890abcdef0 diff -Nru awscli-1.11.13/awscli/examples/ec2/wait/vpc-peering-connection-deleted.rst awscli-1.18.69/awscli/examples/ec2/wait/vpc-peering-connection-deleted.rst --- awscli-1.11.13/awscli/examples/ec2/wait/vpc-peering-connection-deleted.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/wait/vpc-peering-connection-deleted.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,6 @@ +**To wait until a VPC peering connection is deleted** + +The following ``wait vpc-peering-connection-deleted`` example pauses and resumes running only after it confirms that the specified VPC peering connection is deleted. It produces no output. :: + + aws ec2 wait vpc-peering-connection-deleted \ + --vpc-peering-connection-ids pcx-1234567890abcdef0 diff -Nru awscli-1.11.13/awscli/examples/ec2/wait/vpc-peering-connection-exists.rst awscli-1.18.69/awscli/examples/ec2/wait/vpc-peering-connection-exists.rst --- awscli-1.11.13/awscli/examples/ec2/wait/vpc-peering-connection-exists.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/wait/vpc-peering-connection-exists.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,6 @@ +**To wait until a VPC peering connection exists** + +The following ``wait vpc-peering-connection-exists`` example pauses and continues only when it can confirm that the specified VPC peering connection exists. :: + + aws ec2 wait vpc-peering-connection-exists \ + --vpc-peering-connection-ids pcx-1234567890abcdef0 diff -Nru awscli-1.11.13/awscli/examples/ec2/wait/vpn-connection-available.rst awscli-1.18.69/awscli/examples/ec2/wait/vpn-connection-available.rst --- awscli-1.11.13/awscli/examples/ec2/wait/vpn-connection-available.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/wait/vpn-connection-available.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,6 @@ +**To wait until a VPN connection is available** + +The following ``vpn-connection-available`` example pauses and resumes running only after it confirms that the specified VPN connection is available. It produces no output. :: + + aws ec2 wait vpn-connection-available \ + --vpn-connection-ids vpn-1234567890abcdef0 diff -Nru awscli-1.11.13/awscli/examples/ec2/wait/vpn-connection-deleted.rst awscli-1.18.69/awscli/examples/ec2/wait/vpn-connection-deleted.rst --- awscli-1.11.13/awscli/examples/ec2/wait/vpn-connection-deleted.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/wait/vpn-connection-deleted.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,6 @@ +**To wait until a VPN connection is deleted** + +The following ``waitt vpn-connection-deleted`` example command pauses and continues when it can confirm that the specified VPN connection is deleted. It produces no output. :: + + aws ec2 wait vpn-connection-deleted \ + --vpn-connection-ids vpn-1234567890abcdef0 diff -Nru awscli-1.11.13/awscli/examples/ec2/withdraw-byoip-cidr.rst awscli-1.18.69/awscli/examples/ec2/withdraw-byoip-cidr.rst --- awscli-1.11.13/awscli/examples/ec2/withdraw-byoip-cidr.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2/withdraw-byoip-cidr.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,16 @@ +**To stop advertising an address range** + +The following ``withdraw-byoip-cidr`` example stops advertising the specified address range. :: + + aws ec2 withdraw-byoip-cidr + --cidr 203.0.113.25/24 + +Output:: + + { + "ByoipCidr": { + "Cidr": "203.0.113.25/24", + "StatusMessage": "ipv4pool-ec2-1234567890abcdef0", + "State": "advertised" + } + } diff -Nru awscli-1.11.13/awscli/examples/ec2-instance-connect/send-ssh-public-key.rst awscli-1.18.69/awscli/examples/ec2-instance-connect/send-ssh-public-key.rst --- awscli-1.11.13/awscli/examples/ec2-instance-connect/send-ssh-public-key.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ec2-instance-connect/send-ssh-public-key.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To send a an SSH public key to an instance** + +The following ``send-ssh-public-key`` example sends the specified SSH public key to the specified instance. The key is used to authenticate the specified user. :: + + aws ec2-instance-connect send-ssh-public-key \ + --instance-id i-1234567890abcdef0 \ + --instance-os-user ec2-user \ + --availability-zone us-east-2b \ + --ssh-public-key file://path/my-rsa-key.pub + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/ecr/batch-check-layer-availability.rst awscli-1.18.69/awscli/examples/ecr/batch-check-layer-availability.rst --- awscli-1.11.13/awscli/examples/ecr/batch-check-layer-availability.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecr/batch-check-layer-availability.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To check the availability of a layer** + +The following ``batch-check-layer-availability`` example checks the availability of a layer with the digest ``sha256:6171c7451a50945f8ddd72f7732cc04d7a0d1f48138a426b2e64387fdeb834ed`` in the ``cluster-autoscaler`` repository. :: + + aws ecr batch-check-layer-availability \ + --repository-name cluster-autoscaler \ + --layer-digests sha256:6171c7451a50945f8ddd72f7732cc04d7a0d1f48138a426b2e64387fdeb834ed + +Output:: + + { + "layers": [ + { + "layerDigest": "sha256:6171c7451a50945f8ddd72f7732cc04d7a0d1f48138a426b2e64387fdeb834ed", + "layerAvailability": "AVAILABLE", + "layerSize": 2777, + "mediaType": "application/vnd.docker.container.image.v1+json" + } + ], + "failures": [] + } diff -Nru awscli-1.11.13/awscli/examples/ecr/batch-delete-image.rst awscli-1.18.69/awscli/examples/ecr/batch-delete-image.rst --- awscli-1.11.13/awscli/examples/ecr/batch-delete-image.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecr/batch-delete-image.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,20 +1,45 @@ -**To delete an image** +**Example 1: To delete an image** -This example deletes an image with the tag ``precise`` in a repository called -``ubuntu`` in the default registry for an account. +The following ``batch-delete-image`` example deletes an image with the tag ``precise`` in the specified repository in the default registry for an account. :: -Command:: + aws ecr batch-delete-image \ + --repository-name ubuntu \ + --image-ids imageTag=precise - aws ecr batch-delete-image --repository-name ubuntu --image-ids imageTag=precise +Output:: + + { + "failures": [], + "imageIds": [ + { + "imageTag": "precise", + "imageDigest": "sha256:19665f1e6d1e504117a1743c0a3d3753086354a38375961f2e665416ef4b1b2f" + } + ] + } + +**Example 2: To delete multiple images** + +The following ``batch-delete-image`` example deletes all images tagged with ``prod`` and ``team1`` in the specified repository. :: + + aws ecr batch-delete-image \ + --repository-name MyRepository \ + --image-ids imageTag=prod imageTag=team1 Output:: - { - "failures": [], - "imageIds": [ - { - "imageTag": "precise", - "imageDigest": "sha256:19665f1e6d1e504117a1743c0a3d3753086354a38375961f2e665416ef4b1b2f" - } - ] - } + { + "imageIds": [ + { + "imageDigest": "sha256:123456789012", + "imageTag": "prod" + }, + { + "imageDigest": "sha256:567890121234", + "imageTag": "team1" + } + ], + "failures": [] + } + +For more information, see `Deleting an Image `__ in the *Amazon ECR User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ecr/batch-get-image.rst awscli-1.18.69/awscli/examples/ecr/batch-get-image.rst --- awscli-1.11.13/awscli/examples/ecr/batch-get-image.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecr/batch-get-image.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,8 +1,61 @@ -**To describe an image** +**Example 1: To get an image** -This example describes an image with the tag ``precise`` in a repository called -``ubuntu`` in the default registry for an account. +The following ``batch-get-image`` example gets an image with the tag ``v1.13.6`` in a repository called +``cluster-autoscaler`` in the default registry for an account. :: -Command:: + aws ecr batch-get-image \ + --repository-name cluster-autoscaler \ + --image-ids imageTag=v1.13.6 + +Output:: - aws ecr batch-get-image --repository-name ubuntu --image-ids imageTag=precise + { + "images": [ + { + "registryId": "012345678910", + "repositoryName": "cluster-autoscaler", + "imageId": { + "imageDigest": "sha256:4a1c6567c38904384ebc64e35b7eeddd8451110c299e3368d2210066487d97e5", + "imageTag": "v1.13.6" + }, + "imageManifest": "{\n \"schemaVersion\": 2,\n \"mediaType\": \"application/vnd.docker.distribution.manifest.v2+json\",\n \"config\": {\n \"mediaType\": \"application/vnd.docker.container.image.v1+json\",\n \"size\": 2777,\n \"digest\": \"sha256:6171c7451a50945f8ddd72f7732cc04d7a0d1f48138a426b2e64387fdeb834ed\"\n },\n \"layers\": [\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 17743696,\n \"digest\": \"sha256:39fafc05754f195f134ca11ecdb1c9a691ab0848c697fffeb5a85f900caaf6e1\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 2565026,\n \"digest\": \"sha256:8c8a779d3a537b767ae1091fe6e00c2590afd16767aa6096d1b318d75494819f\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 28005981,\n \"digest\": \"sha256:c44ba47496991c9982ee493b47fd25c252caabf2b4ae7dd679c9a27b6a3c8fb7\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 775,\n \"digest\": \"sha256:e2c388b44226544363ca007be7b896bcce1baebea04da23cbd165eac30be650f\"\n }\n ]\n}" + } + ], + "failures": [] + } + +**Example 2: To get multiple images** + +The following ``batch-get-image`` example displays details of all images tagged with ``prod`` and ``team1`` in the specified repository. :: + + aws ecr batch-get-image \ + --repository-name MyRepository \ + --image-ids imageTag=prod imageTag=team1 + +Output:: + + { + "images": [ + { + "registryId": "123456789012", + "repositoryName": "MyRepository", + "imageId": { + "imageDigest": "sha256:123456789012", + "imageTag": "prod" + }, + "imageManifest": "manifestExample1" + }, + { + "registryId": "567890121234", + "repositoryName": "MyRepository", + "imageId": { + "imageDigest": "sha256:123456789012", + "imageTag": "team1" + }, + "imageManifest": "manifestExample2" + } + ], + "failures": [] + } + +For more information, see `Images `__ in the *Amazon ECR User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ecr/complete-layer-upload.rst awscli-1.18.69/awscli/examples/ecr/complete-layer-upload.rst --- awscli-1.11.13/awscli/examples/ecr/complete-layer-upload.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecr/complete-layer-upload.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To complete an image layer upload** + +The following ``complete-layer-upload`` example completes an image layer upload to the ``layer-test`` repository. :: + + aws ecr complete-layer-upload \ + --repository-name layer-test \ + --upload-id 6cb64b8a-9378-0e33-2ab1-b780fab8a9e9 \ + --layer-digests 6cb64b8a-9378-0e33-2ab1-b780fab8a9e9:48074e6d3a68b39aad8ccc002cdad912d4148c0f92b3729323e + +Output:: + + { + "uploadId": "6cb64b8a-9378-0e33-2ab1-b780fab8a9e9", + "layerDigest": "sha256:9a77f85878aa1906f2020a0ecdf7a7e962d57e882250acd773383224b3fe9a02", + "repositoryName": "layer-test", + "registryId": "130757420319" + } diff -Nru awscli-1.11.13/awscli/examples/ecr/create-repository.rst awscli-1.18.69/awscli/examples/ecr/create-repository.rst --- awscli-1.11.13/awscli/examples/ecr/create-repository.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecr/create-repository.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ecr/delete-lifecycle-policy.rst awscli-1.18.69/awscli/examples/ecr/delete-lifecycle-policy.rst --- awscli-1.11.13/awscli/examples/ecr/delete-lifecycle-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecr/delete-lifecycle-policy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,15 @@ +**To delete the lifecycle policy for a repository** + +The following ``delete-lifecycle-policy`` example deletes the lifecycle policy for the ``hello-world`` repository. :: + + aws ecr delete-lifecycle-policy \ + --repository-name hello-world + +Output:: + + { + "registryId": "012345678910", + "repositoryName": "hello-world", + "lifecyclePolicyText": "{\"rules\":[{\"rulePriority\":1,\"description\":\"Remove untagged images.\",\"selection\":{\"tagStatus\":\"untagged\",\"countType\":\"sinceImagePushed\",\"countUnit\":\"days\",\"countNumber\":10},\"action\":{\"type\":\"expire\"}}]}", + "lastEvaluatedAt": 0.0 + } diff -Nru awscli-1.11.13/awscli/examples/ecr/delete-repository-policy.rst awscli-1.18.69/awscli/examples/ecr/delete-repository-policy.rst --- awscli-1.11.13/awscli/examples/ecr/delete-repository-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecr/delete-repository-policy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,14 @@ +**To delete the repository policy for a repository** + +The following ``delete-repository-policy`` example deletes the repository policy for the ``cluster-autoscaler`` repository. :: + + aws ecr delete-repository-policy \ + --repository-name cluster-autoscaler + +Output:: + + { + "registryId": "012345678910", + "repositoryName": "cluster-autoscaler", + "policyText": "{\n \"Version\" : \"2008-10-17\",\n \"Statement\" : [ {\n \"Sid\" : \"allow public pull\",\n \"Effect\" : \"Allow\",\n \"Principal\" : \"*\",\n \"Action\" : [ \"ecr:BatchCheckLayerAvailability\", \"ecr:BatchGetImage\", \"ecr:GetDownloadUrlForLayer\" ]\n } ]\n}" + } diff -Nru awscli-1.11.13/awscli/examples/ecr/delete-repository.rst awscli-1.18.69/awscli/examples/ecr/delete-repository.rst --- awscli-1.11.13/awscli/examples/ecr/delete-repository.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecr/delete-repository.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ecr/describe-image-scan-findings.rst awscli-1.18.69/awscli/examples/ecr/describe-image-scan-findings.rst --- awscli-1.11.13/awscli/examples/ecr/describe-image-scan-findings.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecr/describe-image-scan-findings.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ecr/describe-images.rst awscli-1.18.69/awscli/examples/ecr/describe-images.rst --- awscli-1.11.13/awscli/examples/ecr/describe-images.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecr/describe-images.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,24 @@ +**To describe an image in a repository** + +The folowing ``describe-images`` example displays details about an image in the ``cluster-autoscaler`` repository with the tag ``v1.13.6``. :: + + aws ecr describe-images \ + --repository-name cluster-autoscaler \ + --image-ids imageTag=v1.13.6 + +Output:: + + { + "imageDetails": [ + { + "registryId": "012345678910", + "repositoryName": "cluster-autoscaler", + "imageDigest": "sha256:4a1c6567c38904384ebc64e35b7eeddd8451110c299e3368d2210066487d97e5", + "imageTags": [ + "v1.13.6" + ], + "imageSizeInBytes": 48318255, + "imagePushedAt": 1565128275.0 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/ecr/get-authorization-token.rst awscli-1.18.69/awscli/examples/ecr/get-authorization-token.rst --- awscli-1.11.13/awscli/examples/ecr/get-authorization-token.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecr/get-authorization-token.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ecr/get-download-url-for-layer.rst awscli-1.18.69/awscli/examples/ecr/get-download-url-for-layer.rst --- awscli-1.11.13/awscli/examples/ecr/get-download-url-for-layer.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecr/get-download-url-for-layer.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,14 @@ +**To get the download URL of a layer** + +The following ``get-download-url-for-layer`` example displays the download URL of a layer with the digest ``sha256:6171c7451a50945f8ddd72f7732cc04d7a0d1f48138a426b2e64387fdeb834ed`` in the ``cluster-autoscaler`` repository. :: + + aws ecr get-download-url-for-layer \ + --repository-name cluster-autoscaler \ + --layer-digest sha256:6171c7451a50945f8ddd72f7732cc04d7a0d1f48138a426b2e64387fdeb834ed + +Output:: + + { + "downloadUrl": "https://prod-us-west-2-starport-layer-bucket.s3.us-west-2.amazonaws.com/e501-012345678910-9cb60dc0-7284-5643-3987-da6dac0465f0/04620aac-66a5-4167-8232-55ee7ef6d565?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20190814T220617Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=AKIA32P3D2JDNMVAJLGF%2F20190814%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=9161345894947a1672467a0da7a1550f2f7157318312fe4941b59976239c3337", + "layerDigest": "sha256:6171c7451a50945f8ddd72f7732cc04d7a0d1f48138a426b2e64387fdeb834ed" + } diff -Nru awscli-1.11.13/awscli/examples/ecr/get-lifecycle-policy-preview.rst awscli-1.18.69/awscli/examples/ecr/get-lifecycle-policy-preview.rst --- awscli-1.11.13/awscli/examples/ecr/get-lifecycle-policy-preview.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecr/get-lifecycle-policy-preview.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,23 @@ +**To retrieve details for a lifecycle policy preview** + +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" + +Output:: + + { + "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", + "previewResults": [], + "summary": { + "expiringImageTotalCount": 0 + } + } + +For more information, see `Lifecycle Policies `__ in the *Amazon ECR User Guide*. diff -Nru awscli-1.11.13/awscli/examples/ecr/get-lifecycle-policy.rst awscli-1.18.69/awscli/examples/ecr/get-lifecycle-policy.rst --- awscli-1.11.13/awscli/examples/ecr/get-lifecycle-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecr/get-lifecycle-policy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To retrieve a lifecycle policy** + +The following ``get-lifecycle-policy`` example displays details of the lifecycle policy for the specified repository in the default registry for the account. :: + + aws ecr get-lifecycle-policy \ + --repository-name "project-a/amazon-ecs-sample" + +Output:: + + { + "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.11.13/awscli/examples/ecr/get-login_description.rst awscli-1.18.69/awscli/examples/ecr/get-login_description.rst --- awscli-1.11.13/awscli/examples/ecr/get-login_description.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecr/get-login_description.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,4 +1,6 @@ -Log in to an Amazon ECR registry. + **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 hours, and then it prints a ``docker login`` command with that authorization @@ -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.11.13/awscli/examples/ecr/get-login-password_description.rst awscli-1.18.69/awscli/examples/ecr/get-login-password_description.rst --- awscli-1.11.13/awscli/examples/ecr/get-login-password_description.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecr/get-login-password_description.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,5 @@ +**To log in to an Amazon ECR registry** + +This command retrieves and displays a password that you can use to authenticate to any Amazon ECR registry that your IAM principal has access to. The password is valid for 12 hours. You can pass the password to the login command of the container client of your preference, such as the Docker CLI. After you have authenticated 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. + +This command is supported using the latest version of AWS CLI version 2 or in v1.17.10 or later of AWS CLI version 1. For information on updating to the latest AWS CLI version, see `Installing the AWS CLI `__ in the *AWS Command Line Interface User Guide*. diff -Nru awscli-1.11.13/awscli/examples/ecr/get-login-password.rst awscli-1.18.69/awscli/examples/ecr/get-login-password.rst --- awscli-1.11.13/awscli/examples/ecr/get-login-password.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecr/get-login-password.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To retrieve a password to authenticate to a registry** + +The following ``get-login-password`` displays a password that you can use with a container client of your choice to authenticate to any Amazon ECR registry that your IAM principal has access to. :: + + aws ecr get-login-password + +Output:: + + + +To use with the Docker CLI, pipe the output of the ``get-login-password`` command to the ``docker login`` command. When retrieving the password, ensure that you specify the same Region that your Amazon ECR registry exists in. :: + + aws ecr get-login-password \ + --region \ + | docker login \ + --username AWS \ + --password-stdin .dkr.ecr..amazonaws.com + +For more information, see `Registry Authentication `__ in the *Amazon ECR User Guide*. diff -Nru awscli-1.11.13/awscli/examples/ecr/get-repository-policy.rst awscli-1.18.69/awscli/examples/ecr/get-repository-policy.rst --- awscli-1.11.13/awscli/examples/ecr/get-repository-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecr/get-repository-policy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,14 @@ +**To retrieve the repository policy for a repository** + +The following ``get-repository-policy`` example displays details about the repository policy for the ``cluster-autoscaler`` repository. :: + + aws ecr get-repository-policy \ + --repository-name cluster-autoscaler + +Output:: + + { + "registryId": "012345678910", + "repositoryName": "cluster-autoscaler", + "policyText": "{\n \"Version\" : \"2008-10-17\",\n \"Statement\" : [ {\n \"Sid\" : \"allow public pull\",\n \"Effect\" : \"Allow\",\n \"Principal\" : \"*\",\n \"Action\" : [ \"ecr:BatchCheckLayerAvailability\", \"ecr:BatchGetImage\", \"ecr:GetDownloadUrlForLayer\" ]\n } ]\n}" + } diff -Nru awscli-1.11.13/awscli/examples/ecr/initiate-layer-upload.rst awscli-1.18.69/awscli/examples/ecr/initiate-layer-upload.rst --- awscli-1.11.13/awscli/examples/ecr/initiate-layer-upload.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecr/initiate-layer-upload.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,13 @@ +**To initiate an image layer upload** + +The following ``initiate-layer-upload`` example initiates an image layer upload to the ``layer-test`` repository. :: + + aws ecr initiate-layer-upload \ + --repository-name layer-test + +Output:: + + { + "partSize": 10485760, + "uploadId": "6cb64b8a-9378-0e33-2ab1-b780fab8a9e9" + } diff -Nru awscli-1.11.13/awscli/examples/ecr/list-images.rst awscli-1.18.69/awscli/examples/ecr/list-images.rst --- awscli-1.11.13/awscli/examples/ecr/list-images.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecr/list-images.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,25 @@ +**To list the images in a repository** + +The following ``list-images`` example displays a list of the images in the ``cluster-autoscaler`` repository. :: + + aws ecr list-images \ + --repository-name cluster-autoscaler + +Output:: + + { + "imageIds": [ + { + "imageDigest": "sha256:99c6fb4377e9a420a1eb3b410a951c9f464eff3b7dbc76c65e434e39b94b6570", + "imageTag": "v1.13.8" + }, + { + "imageDigest": "sha256:99c6fb4377e9a420a1eb3b410a951c9f464eff3b7dbc76c65e434e39b94b6570", + "imageTag": "v1.13.7" + }, + { + "imageDigest": "sha256:4a1c6567c38904384ebc64e35b7eeddd8451110c299e3368d2210066487d97e5", + "imageTag": "v1.13.6" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/ecr/list-tags-for-resource.rst awscli-1.18.69/awscli/examples/ecr/list-tags-for-resource.rst --- awscli-1.11.13/awscli/examples/ecr/list-tags-for-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecr/list-tags-for-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To list the tags for repository** + +The following ``list-tags-for-resource`` example displays a list of the tags associated with the ``hello-world`` repository. :: + + aws ecr list-tags-for-resource \ + --resource-arn arn:aws:ecr:us-west-2:012345678910:repository/hello-world + +Output:: + + { + "tags": [ + { + "Key": "Stage", + "Value": "Integ" + } + ] + } + diff -Nru awscli-1.11.13/awscli/examples/ecr/put-image.rst awscli-1.18.69/awscli/examples/ecr/put-image.rst --- awscli-1.11.13/awscli/examples/ecr/put-image.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecr/put-image.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,91 @@ +**To retag an image with its manifest** + +The following ``put-image`` example creates a new tag in the ``hello-world`` repository with an existing image manifest. :: + + aws ecr put-image \ + --repository-name hello-world \ + --image-tag 2019.08 \ + --image-manifest file://hello-world.manifest.json + +Contents of ``hello-world.manifest.json``:: + + { + "schemaVersion": 2, + "mediaType": "application/vnd.docker.distribution.manifest.v2+json", + "config": { + "mediaType": "application/vnd.docker.container.image.v1+json", + "size": 5695, + "digest": "sha256:cea5fe7701b7db3dd1c372f3cea6f43cdda444fcc488f530829145e426d8b980" + }, + "layers": [ + { + "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip", + "size": 39096921, + "digest": "sha256:d8868e50ac4c7104d2200d42f432b661b2da8c1e417ccfae217e6a1e04bb9295" + }, + { + "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip", + "size": 57938, + "digest": "sha256:83251ac64627fc331584f6c498b3aba5badc01574e2c70b2499af3af16630eed" + }, + { + "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip", + "size": 423, + "digest": "sha256:589bba2f1b36ae56f0152c246e2541c5aa604b058febfcf2be32e9a304fec610" + }, + { + "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip", + "size": 680, + "digest": "sha256:d62ecaceda3964b735cdd2af613d6bb136a52c1da0838b2ff4b4dab4212bcb1c" + }, + { + "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip", + "size": 162, + "digest": "sha256:6d93b41cfc6bf0d2522b7cf61588de4cd045065b36c52bd3aec2ba0622b2b22b" + }, + { + "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip", + "size": 28268840, + "digest": "sha256:6986b4d4c07932c680b3587f2eac8b0e013568c003cc23b04044628a5c5e599f" + }, + { + "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip", + "size": 35369152, + "digest": "sha256:8c5ec60f10102dc8da0649d866c7c2f706e459d0bdc25c83ad2de86f4996c276" + }, + { + "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip", + "size": 155, + "digest": "sha256:cde50b1c594539c5f67cbede9aef95c9ae321ccfb857f7b251b45b84198adc85" + }, + { + "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip", + "size": 28737, + "digest": "sha256:2e102807ab72a73fc9abf53e8c50e421bdc337a0a8afcb242176edeec65977e4" + }, + { + "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip", + "size": 190, + "digest": "sha256:fc379bbd5ed37808772bef016553a297356c59b8f134659e6ee4ecb563c2f5a7" + }, + { + "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip", + "size": 28748, + "digest": "sha256:021db240dfccf5a1aff19507d17c0177e5888e518acf295b52204b1825e8b7ee" + } + ] + } + +Output:: + + { + "image": { + "registryId": "130757420319", + "repositoryName": "hello-world", + "imageId": { + "imageDigest": "sha256:8ece96b74f87652876199d83bd107d0435a196133af383ac54cb82b6cc5283ae", + "imageTag": "2019.08" + }, + "imageManifest": "{\n \"schemaVersion\": 2,\n \"mediaType\": \"application/vnd.docker.distribution.manifest.v2+json\",\n \"config\": {\n \"mediaType\": \"application/vnd.docker.container.image.v1+json\",\n \"size\": 5695,\n \"digest\": \"sha256:cea5fe7701b7db3dd1c372f3cea6f43cdda444fcc488f530829145e426d8b980\"\n },\n \"layers\": [\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 39096921,\n \"digest\": \"sha256:d8868e50ac4c7104d2200d42f432b661b2da8c1e417ccfae217e6a1e04bb9295\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 57938,\n \"digest\": \"sha256:83251ac64627fc331584f6c498b3aba5badc01574e2c70b2499af3af16630eed\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 423,\n \"digest\": \"sha256:589bba2f1b36ae56f0152c246e2541c5aa604b058febfcf2be32e9a304fec610\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 680,\n \"digest\": \"sha256:d62ecaceda3964b735cdd2af613d6bb136a52c1da0838b2ff4b4dab4212bcb1c\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 162,\n \"digest\": \"sha256:6d93b41cfc6bf0d2522b7cf61588de4cd045065b36c52bd3aec2ba0622b2b22b\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 28268840,\n \"digest\": \"sha256:6986b4d4c07932c680b3587f2eac8b0e013568c003cc23b04044628a5c5e599f\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 35369152,\n \"digest\": \"sha256:8c5ec60f10102dc8da0649d866c7c2f706e459d0bdc25c83ad2de86f4996c276\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 155,\n \"digest\": \"sha256:cde50b1c594539c5f67cbede9aef95c9ae321ccfb857f7b251b45b84198adc85\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 28737,\n \"digest\": \"sha256:2e102807ab72a73fc9abf53e8c50e421bdc337a0a8afcb242176edeec65977e4\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 190,\n \"digest\": \"sha256:fc379bbd5ed37808772bef016553a297356c59b8f134659e6ee4ecb563c2f5a7\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 28748,\n \"digest\": \"sha256:021db240dfccf5a1aff19507d17c0177e5888e518acf295b52204b1825e8b7ee\"\n }\n ]\n}\n" + } + } diff -Nru awscli-1.11.13/awscli/examples/ecr/put-image-scanning-configuration.rst awscli-1.18.69/awscli/examples/ecr/put-image-scanning-configuration.rst --- awscli-1.11.13/awscli/examples/ecr/put-image-scanning-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecr/put-image-scanning-configuration.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ecr/put-image-tag-mutability.rst awscli-1.18.69/awscli/examples/ecr/put-image-tag-mutability.rst --- awscli-1.11.13/awscli/examples/ecr/put-image-tag-mutability.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecr/put-image-tag-mutability.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To update the image tag mutability setting for a 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-repository \ + --image-tag-mutability IMMUTABLE + +Output:: + + { + "registryId": "012345678910", + "repositoryName": "sample-repo", + "imageTagMutability": "IMMUTABLE" + } + +For more information, see `Image Tag Mutability `__ in the *Amazon ECR User Guide*. diff -Nru awscli-1.11.13/awscli/examples/ecr/put-lifecycle-policy.rst awscli-1.18.69/awscli/examples/ecr/put-lifecycle-policy.rst --- awscli-1.11.13/awscli/examples/ecr/put-lifecycle-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecr/put-lifecycle-policy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,37 @@ +**To create a lifecycle policy** + +The following ``put-lifecycle-policy`` example creates a lifecycle policy for the specified repository in the default registry for an account. :: + + aws ecr put-lifecycle-policy \ + --repository-name "project-a/amazon-ecs-sample" \ + --lifecycle-policy-text "file://policy.json" + +Contents of ``policy.json``:: + + { + "rules": [ + { + "rulePriority": 1, + "description": "Expire images older than 14 days", + "selection": { + "tagStatus": "untagged", + "countType": "sinceImagePushed", + "countUnit": "days", + "countNumber": 14 + }, + "action": { + "type": "expire" + } + } + ] + } + +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\"}}]}" + } + +For more information, see `Lifecycle Policies `__ in the *Amazon ECR User Guide*. diff -Nru awscli-1.11.13/awscli/examples/ecr/set-repository-policy.rst awscli-1.18.69/awscli/examples/ecr/set-repository-policy.rst --- awscli-1.11.13/awscli/examples/ecr/set-repository-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecr/set-repository-policy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,33 @@ +**To set the repository policy for a repository** + +The following ``set-repository-polixy`` example attaches a repository policy contained in a file to the ``cluster-autoscaler`` repository. :: + + aws ecr set-repository-policy \ + --repository-name cluster-autoscaler \ + --policy-text file://my-policy.json + +Contents of ``my-policy.json``:: + + { + "Version" : "2008-10-17", + "Statement" : [ + { + "Sid" : "allow public pull", + "Effect" : "Allow", + "Principal" : "*", + "Action" : [ + "ecr:BatchCheckLayerAvailability", + "ecr:BatchGetImage", + "ecr:GetDownloadUrlForLayer" + ] + } + ] + } + +Output:: + + { + "registryId": "012345678910", + "repositoryName": "cluster-autoscaler", + "policyText": "{\n \"Version\" : \"2008-10-17\",\n \"Statement\" : [ {\n \"Sid\" : \"allow public pull\",\n \"Effect\" : \"Allow\",\n \"Principal\" : \"*\",\n \"Action\" : [ \"ecr:BatchCheckLayerAvailability\", \"ecr:BatchGetImage\", \"ecr:GetDownloadUrlForLayer\" ]\n } ]\n}" + } diff -Nru awscli-1.11.13/awscli/examples/ecr/start-image-scan.rst awscli-1.18.69/awscli/examples/ecr/start-image-scan.rst --- awscli-1.11.13/awscli/examples/ecr/start-image-scan.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecr/start-image-scan.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/ecr/start-lifecycle-policy-preview.rst awscli-1.18.69/awscli/examples/ecr/start-lifecycle-policy-preview.rst --- awscli-1.11.13/awscli/examples/ecr/start-lifecycle-policy-preview.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecr/start-lifecycle-policy-preview.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,36 @@ +**To create a lifecycle policy preview** + +The following ``start-lifecycle-policy-preview`` example creates a lifecycle policy preview defined by a JSON file for the specified repository. :: + + aws ecr start-lifecycle-policy-preview \ + --repository-name "project-a/amazon-ecs-sample" \ + --lifecycle-policy-text "file://policy.json" + +Contents of ``policy.json``:: + + { + "rules": [ + { + "rulePriority": 1, + "description": "Expire images older than 14 days", + "selection": { + "tagStatus": "untagged", + "countType": "sinceImagePushed", + "countUnit": "days", + "countNumber": 14 + }, + "action": { + "type": "expire" + } + } + ] + } + +Output:: + + { + "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.11.13/awscli/examples/ecr/tag-resource.rst awscli-1.18.69/awscli/examples/ecr/tag-resource.rst --- awscli-1.11.13/awscli/examples/ecr/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecr/tag-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To tag a repository** + +The following ``tag-resource`` example sets a tag with key ``Stage`` and value ``Integ`` on the ``hello-world`` repository. :: + + aws ecr tag-resource \ + --resource-arn arn:aws:ecr:us-west-2:012345678910:repository/hello-world \ + --tags Key=Stage,Value=Integ + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/ecr/untag-resource.rst awscli-1.18.69/awscli/examples/ecr/untag-resource.rst --- awscli-1.11.13/awscli/examples/ecr/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecr/untag-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To untag a repository** + +The following ``untag-resource`` example removes the tag with the key ``Stage`` from the ``hello-world`` repository. :: + + aws ecr untag-resource \ + --resource-arn arn:aws:ecr:us-west-2:012345678910:repository/hello-world \ + --tag-keys Stage + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/ecr/upload-layer-part.rst awscli-1.18.69/awscli/examples/ecr/upload-layer-part.rst --- awscli-1.11.13/awscli/examples/ecr/upload-layer-part.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecr/upload-layer-part.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To upload a layer part** + +This following ``upload-layer-part`` uploads an image layer part to the ``layer-test`` repository. :: + + aws ecr upload-layer-part \ + --repository-name layer-test \ + --upload-id 6cb64b8a-9378-0e33-2ab1-b780fab8a9e9 \ + --part-first-byte 0 \ + --part-last-byte 8323314 \ + --layer-part-blob file:///var/lib/docker/image/overlay2/layerdb/sha256/ff986b10a018b48074e6d3a68b39aad8ccc002cdad912d4148c0f92b3729323e/layer.b64 + +Output:: + + { + "uploadId": "6cb64b8a-9378-0e33-2ab1-b780fab8a9e9", + "registryId": "012345678910", + "lastByteReceived": 8323314, + "repositoryName": "layer-test" + } diff -Nru awscli-1.11.13/awscli/examples/ecs/create-cluster.rst awscli-1.18.69/awscli/examples/ecs/create-cluster.rst --- awscli-1.11.13/awscli/examples/ecs/create-cluster.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/create-cluster.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,21 +1,60 @@ -**To create a new cluster** +**Example 1: To create a new cluster** -This example command creates a cluster in your default region. +The following ``create-cluster`` example creates a cluster. :: -Command:: + aws ecs create-cluster --cluster-name MyCluster - aws ecs create-cluster --cluster-name "my_cluster" +Output:: + + { + "cluster": { + "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster", + "clusterName": "MyCluster", + "status": "ACTIVE", + "registeredContainerInstancesCount": 0, + "pendingTasksCount": 0, + "runningTasksCount": 0, + "activeServicesCount": 0, + "statistics": [], + "tags": [] + } + } + +**Example 2: To create a new cluster with multiple tags** + +The following ``create-cluster`` example creates a cluster with multiple tags. For more information about adding tags using shorthand syntax, see `Using Shorthand Syntax with the AWS Command Line Interface `_ in the *AWS CLI User Guide*. :: + + aws ecs create-cluster \ + --cluster-name MyCluster \ + --tags key=key1,value=value1 key=key2,value=value2 key=key3,value=value3 Output:: - { - "cluster": { - "status": "ACTIVE", - "clusterName": "my_cluster", - "registeredContainerInstancesCount": 0, - "pendingTasksCount": 0, - "runningTasksCount": 0, - "activeServicesCount": 0, - "clusterArn": "arn:aws:ecs:::cluster/my_cluster" - } - } + { + "cluster": { + "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster", + "clusterName": "MyCluster", + "status": "ACTIVE", + "registeredContainerInstancesCount": 0, + "pendingTasksCount": 0, + "runningTasksCount": 0, + "activeServicesCount": 0, + "statistics": [], + "tags": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value2" + }, + { + "key": "key3", + "value": "value3" + } + ] + } + } + +For more information, see `Creating a Cluster `_ in the *Amazon ECS Developer Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ecs/create-service.rst awscli-1.18.69/awscli/examples/ecs/create-service.rst --- awscli-1.11.13/awscli/examples/ecs/create-service.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/create-service.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,55 +1,204 @@ -**To create a new service** +**Example 1: To create a service with a Fargate task** -This example command creates a service in your default region called ``ecs-simple-service``. The service uses the ``ecs-demo`` task definition and it maintains 10 instantiations of that task. +The following ``create-service`` example shows how to create a service using a Fargate task. :: -Command:: + aws ecs create-service \ + --cluster MyCluster \ + --service-name MyService \ + --task-definition sample-fargate:1 \ + --desired-count 2 \ + --launch-type FARGATE \ + --platform-version LATEST \ + --network-configuration "awsvpcConfiguration={subnets=[subnet-12344321],securityGroups=[sg-12344321],assignPublicIp=ENABLED}" \ + --tags key=key1,value=value1 key=key2,value=value2 key=key3,value=value3 + +Output:: + + { + "service": { + "serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/MyCluster/MyService", + "serviceName": "MyService", + "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster", + "loadBalancers": [], + "serviceRegistries": [], + "status": "ACTIVE", + "desiredCount": 2, + "runningCount": 0, + "pendingCount": 0, + "launchType": "FARGATE", + "platformVersion": "LATEST", + "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sample-fargate:1", + "deploymentConfiguration": { + "maximumPercent": 200, + "minimumHealthyPercent": 100 + }, + "deployments": [ + { + "id": "ecs-svc/1234567890123456789", + "status": "PRIMARY", + "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sample-fargate:1", + "desiredCount": 2, + "pendingCount": 0, + "runningCount": 0, + "createdAt": 1557119253.821, + "updatedAt": 1557119253.821, + "launchType": "FARGATE", + "platformVersion": "1.3.0", + "networkConfiguration": { + "awsvpcConfiguration": { + "subnets": [ + "subnet-12344321" + ], + "securityGroups": [ + "sg-12344321" + ], + "assignPublicIp": "ENABLED" + } + } + } + ], + "roleArn": "arn:aws:iam::123456789012:role/aws-service-role/ecs.amazonaws.com/AWSServiceRoleForECS", + "events": [], + "createdAt": 1557119253.821, + "placementConstraints": [], + "placementStrategy": [], + "networkConfiguration": { + "awsvpcConfiguration": { + "subnets": [ + "subnet-12344321" + ], + "securityGroups": [ + "sg-12344321" + ], + "assignPublicIp": "ENABLED" + } + }, + "schedulingStrategy": "REPLICA", + "tags": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value2" + }, + { + "key": "key3", + "value": "value3" + } + ], + "enableECSManagedTags": false, + "propagateTags": "NONE" + } + } + +**Example 2: To create a service using the EC2 launch type** + +The following ``create-service`` example shows how to create a service called ``ecs-simple-service`` with a task that uses the EC2 launch type. The service uses the ``sleep360`` task definition and it maintains 1 instantiation of the task. :: - aws ecs create-service --service-name ecs-simple-service --task-definition ecs-demo --desired-count 10 + aws ecs create-service \ + --cluster MyCluster \ + --service-name ecs-simple-service \ + --task-definition sleep360:2 \ + --desired-count 1 Output:: - { - "service": { - "status": "ACTIVE", - "taskDefinition": "arn:aws:ecs:::task-definition/ecs-demo:1", - "pendingCount": 0, - "loadBalancers": [], - "desiredCount": 10, - "serviceName": "ecs-simple-service", - "clusterArn": "arn:aws:ecs:::cluster/default", - "serviceArn": "arn:aws:ecs:::service/ecs-simple-service", - "deployments": [ - { - "status": "PRIMARY", - "pendingCount": 0, - "createdAt": 1428096748.604, - "desiredCount": 10, - "taskDefinition": "arn:aws:ecs:::task-definition/ecs-demo:1", - "updatedAt": 1428096748.604, - "id": "ecs-svc/", - "runningCount": 0 - } - ], - "events": [], - "runningCount": 0 - } - } + { + "service": { + "serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/MyCluster/ecs-simple-service", + "serviceName": "ecs-simple-service", + "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster", + "loadBalancers": [], + "serviceRegistries": [], + "status": "ACTIVE", + "desiredCount": 1, + "runningCount": 0, + "pendingCount": 0, + "launchType": "EC2", + "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sleep360:2", + "deploymentConfiguration": { + "maximumPercent": 200, + "minimumHealthyPercent": 100 + }, + "deployments": [ + { + "id": "ecs-svc/1234567890123456789", + "status": "PRIMARY", + "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sleep360:2", + "desiredCount": 1, + "pendingCount": 0, + "runningCount": 0, + "createdAt": 1557206498.798, + "updatedAt": 1557206498.798, + "launchType": "EC2" + } + ], + "events": [], + "createdAt": 1557206498.798, + "placementConstraints": [], + "placementStrategy": [], + "schedulingStrategy": "REPLICA", + "enableECSManagedTags": false, + "propagateTags": "NONE" + } + } - -**To create a new service behind a load balancer** +**Example 3: To create a service that uses an external deployment controller** -This example command creates a service in your default region called ``ecs-simple-service-elb``. The service uses the ``ecs-demo`` task definition and it maintains 10 instantiations of that task. You must have a load balancer configured in the same region as your container instances. +The following ``create-service`` example creates a service that uses an external deployment controller. :: -This example uses the ``--cli-input-json`` option and a JSON input file called ``ecs-simple-service-elb.json`` with the below format. + aws ecs create-service \ + --cluster MyCluster \ + --service-name MyService \ + --deployment-controller type=EXTERNAL \ + --desired-count 1 -Input file:: +Output:: + + { + "service": { + "serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/MyCluster/MyService", + "serviceName": "MyService", + "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster", + "loadBalancers": [], + "serviceRegistries": [], + "status": "ACTIVE", + "desiredCount": 1, + "runningCount": 0, + "pendingCount": 0, + "launchType": "EC2", + "deploymentConfiguration": { + "maximumPercent": 200, + "minimumHealthyPercent": 100 + }, + "taskSets": [], + "deployments": [], + "roleArn": "arn:aws:iam::123456789012:role/aws-service-role/ecs.amazonaws.com/AWSServiceRoleForECS", + "events": [], + "createdAt": 1557128207.101, + "placementConstraints": [], + "placementStrategy": [], + "schedulingStrategy": "REPLICA", + "deploymentController": { + "type": "EXTERNAL" + }, + "enableECSManagedTags": false, + "propagateTags": "NONE" + } + } + +**Example 4: To create a new service behind a load balancer** + +The following ``create-service`` example shows how to create a service that is behind a load balancer. You must have a load balancer configured in the same Region as your container instance. This example uses the ``--cli-input-json`` option and a JSON input file called ``ecs-simple-service-elb.json`` with the following content:: { "serviceName": "ecs-simple-service-elb", "taskDefinition": "ecs-demo", "loadBalancers": [ { - "loadBalancerName": "EC2Contai-EcsElast-S06278JGSJCM", + "loadBalancerName": "EC2Contai-EcsElast-123456789012", "containerName": "simple-demo", "containerPort": 80 } @@ -60,40 +209,45 @@ Command:: - aws ecs create-service --service-name ecs-simple-service-elb --cli-input-json file://ecs-simple-service-elb.json + aws ecs create-service \ + --cluster MyCluster \ + --service-name ecs-simple-service-elb \ + --cli-input-json file://ecs-simple-service-elb.json Output:: - { - "service": { - "status": "ACTIVE", - "taskDefinition": "arn:aws:ecs:::task-definition/ecs-demo:1", - "pendingCount": 0, - "loadBalancers": [ - { - "containerName": "ecs-demo", - "containerPort": 80, - "loadBalancerName": "EC2Contai-EcsElast-S06278JGSJCM" - } - ], - "roleArn": "arn:aws:iam:::role/ecsServiceRole", - "desiredCount": 10, - "serviceName": "ecs-simple-service-elb", - "clusterArn": "arn:aws:ecs:::cluster/default", - "serviceArn": "arn:aws:ecs:::service/ecs-simple-service-elb", - "deployments": [ - { - "status": "PRIMARY", - "pendingCount": 0, - "createdAt": 1428100239.123, - "desiredCount": 10, - "taskDefinition": "arn:aws:ecs:::task-definition/ecs-demo:1", - "updatedAt": 1428100239.123, - "id": "ecs-svc/", - "runningCount": 0 - } - ], - "events": [], - "runningCount": 0 - } - } \ No newline at end of file + { + "service": { + "status": "ACTIVE", + "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/ecs-demo:1", + "pendingCount": 0, + "loadBalancers": [ + { + "containerName": "ecs-demo", + "containerPort": 80, + "loadBalancerName": "EC2Contai-EcsElast-123456789012" + } + ], + "roleArn": "arn:aws:iam::123456789012:role/ecsServiceRole", + "desiredCount": 10, + "serviceName": "ecs-simple-service-elb", + "clusterArn": "arn:aws:ecs:`_ in the *Amazon ECS Developer Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ecs/create-task-set.rst awscli-1.18.69/awscli/examples/ecs/create-task-set.rst --- awscli-1.11.13/awscli/examples/ecs/create-task-set.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/create-task-set.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,45 @@ +**To create a task set** + +The following ``create-task-set`` example creates a task set in a service that uses an external deployment controller. :: + + aws ecs create-task-set \ + --cluster MyCluster \ + --service MyService \ + --task-definition MyTaskDefinition:2 \ + --network-configuration "awsvpcConfiguration={subnets=[subnet-12344321],securityGroups=[sg-12344321]}" + +Output:: + + { + "taskSet": { + "id": "ecs-svc/1234567890123456789", + "taskSetArn": "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789", + "status": "ACTIVE", + "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/MyTaskDefinition:2", + "computedDesiredCount": 0, + "pendingCount": 0, + "runningCount": 0, + "createdAt": 1557128360.711, + "updatedAt": 1557128360.711, + "launchType": "EC2", + "networkConfiguration": { + "awsvpcConfiguration": { + "subnets": [ + "subnet-12344321" + ], + "securityGroups": [ + "sg-12344321" + ], + "assignPublicIp": "DISABLED" + } + }, + "loadBalancers": [], + "serviceRegistries": [], + "scale": { + "value": 0.0, + "unit": "PERCENT" + }, + "stabilityStatus": "STABILIZING", + "stabilityStatusAt": 1557128360.711 + } + } diff -Nru awscli-1.11.13/awscli/examples/ecs/delete-account-setting.rst awscli-1.18.69/awscli/examples/ecs/delete-account-setting.rst --- awscli-1.11.13/awscli/examples/ecs/delete-account-setting.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/delete-account-setting.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To delete the account settings for a specific IAM user or IAM role** + +The following example ``delete-account-setting`` deletes the account settings for the specific IAM user or IAM role. :: + + aws ecs delete-account-setting \ + --name serviceLongArnFormat \ + --principal-arn arn:aws:iam::123456789012:user/MyUser + +Output:: + + { + "setting": { + "name": "serviceLongArnFormat", + "value": "enabled", + "principalArn": "arn:aws:iam::123456789012:user/MyUser" + } + } + +For more information, see `Amazon Resource Names (ARNs) and IDs `_ in the *Amazon ECS Developer Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ecs/delete-attributes.rst awscli-1.18.69/awscli/examples/ecs/delete-attributes.rst --- awscli-1.11.13/awscli/examples/ecs/delete-attributes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/delete-attributes.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To delete one or more custom attributes from an Amazon ECS resource** + +The following ``delete-attributes`` deletes an attribute with the name ``stack`` from a container instance. :: + + aws ecs delete-attributes \ + --attributes name=stack,targetId=arn:aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34 + +Output:: + + { + "attributes": [ + { + "name": "stack", + "targetId": "arn:aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34", + "value": "production" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/ecs/delete-cluster.rst awscli-1.18.69/awscli/examples/ecs/delete-cluster.rst --- awscli-1.11.13/awscli/examples/ecs/delete-cluster.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/delete-cluster.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,21 +1,23 @@ **To delete an empty cluster** -This example command deletes an empty cluster in your default region. +The following ``delete-cluster`` example deletes the specified empty cluster. :: -Command:: - - aws ecs delete-cluster --cluster my_cluster + aws ecs delete-cluster --cluster MyCluster Output:: - { - "cluster": { - "status": "INACTIVE", - "clusterName": "my_cluster", - "registeredContainerInstancesCount": 0, - "pendingTasksCount": 0, - "runningTasksCount": 0, - "activeServicesCount": 0, - "clusterArn": "arn:aws:ecs:::cluster/my_cluster" - } - } + { + "cluster": { + "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster", + "status": "INACTIVE", + "clusterName": "MyCluster", + "registeredContainerInstancesCount": 0, + "pendingTasksCount": 0, + "runningTasksCount": 0, + "activeServicesCount": 0 + "statistics": [], + "tags": [] + } + } + +For more information, see `Deleting a Cluster `_ in the *Amazon ECS Developer Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ecs/delete-service.rst awscli-1.18.69/awscli/examples/ecs/delete-service.rst --- awscli-1.11.13/awscli/examples/ecs/delete-service.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/delete-service.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,8 +1,7 @@ **To delete a service** -This example command deletes the ``my-http-service`` service. The service must have a desired count and running count of 0 before you can delete it. +The following ``ecs delete-service`` example deletes the specified service from a cluster. You can include the ``--force`` parameter to delete a service even if it has not been scaled to zero tasks. :: -Command:: - - aws ecs delete-service --service my-http-service + aws ecs delete-service --cluster MyCluster --service MyService1 --force +For more information, see `Deleting a Service `_ in the *Amazon ECS Developer Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ecs/delete-task-set.rst awscli-1.18.69/awscli/examples/ecs/delete-task-set.rst --- awscli-1.11.13/awscli/examples/ecs/delete-task-set.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/delete-task-set.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,45 @@ +**To delete a task set** + +The following ``delete-task-set`` example shows how to delete a task set. You can include the ``--force`` parameter to delete a task set even if it has not been scaled to zero. :: + + aws ecs delete-task-set \ + --cluster MyCluster \ + --service MyService \ + --task-set arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789 \ + --force + +Output:: + + { + "taskSet": { + "id": "ecs-svc/1234567890123456789", + "taskSetArn": "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789", + "status": "DRAINING", + "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sample-fargate:2", + "computedDesiredCount": 0, + "pendingCount": 0, + "runningCount": 0, + "createdAt": 1557130260.276, + "updatedAt": 1557130290.707, + "launchType": "EC2", + "networkConfiguration": { + "awsvpcConfiguration": { + "subnets": [ + "subnet-12345678" + ], + "securityGroups": [ + "sg-12345678" + ], + "assignPublicIp": "DISABLED" + } + }, + "loadBalancers": [], + "serviceRegistries": [], + "scale": { + "value": 0.0, + "unit": "PERCENT" + }, + "stabilityStatus": "STABILIZING", + "stabilityStatusAt": 1557130290.707 + } + } diff -Nru awscli-1.11.13/awscli/examples/ecs/deregister-container-instance.rst awscli-1.18.69/awscli/examples/ecs/deregister-container-instance.rst --- awscli-1.11.13/awscli/examples/ecs/deregister-container-instance.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/deregister-container-instance.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,7 +1,262 @@ **To deregister a container instance from a cluster** -This example deregisters a container instance from the specified cluster in your default region. If there are still tasks running on the container instance, you must either stop those tasks before deregistering, or use the force option. +The following ``deregister-container-instance`` example deregisters a container instance from the specified cluster. If there are still tasks running in the container instance, you must either stop those tasks before deregistering, or use the ``--force`` option. :: -Command:: + aws ecs deregister-container-instance \ + --cluster arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster \ + --container-instance arn:aws:ecs:us-west-2:123456789012:container-instance/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ + --force - aws ecs deregister-container-instance --cluster default --container-instance --force \ No newline at end of file +Output:: + + { + "containerInstance": { + "remainingResources": [ + { + "integerValue": 1024, + "doubleValue": 0.0, + "type": "INTEGER", + "longValue": 0, + "name": "CPU" + }, + { + "integerValue": 985, + "doubleValue": 0.0, + "type": "INTEGER", + "longValue": 0, + "name": "MEMORY" + }, + { + "type": "STRINGSET", + "integerValue": 0, + "name": "PORTS", + "stringSetValue": [ + "22", + "2376", + "2375", + "51678", + "51679" + ], + "longValue": 0, + "doubleValue": 0.0 + }, + { + "type": "STRINGSET", + "integerValue": 0, + "name": "PORTS_UDP", + "stringSetValue": [], + "longValue": 0, + "doubleValue": 0.0 + } + ], + "agentConnected": true, + "attributes": [ + { + "name": "ecs.capability.secrets.asm.environment-variables" + }, + { + "name": "com.amazonaws.ecs.capability.logging-driver.syslog" + }, + { + "value": "ami-01a82c3fce2c3ba58", + "name": "ecs.ami-id" + }, + { + "name": "ecs.capability.secrets.asm.bootstrap.log-driver" + }, + { + "name": "com.amazonaws.ecs.capability.logging-driver.none" + }, + { + "name": "ecs.capability.ecr-endpoint" + }, + { + "name": "com.amazonaws.ecs.capability.logging-driver.json-file" + }, + { + "value": "vpc-1234567890123467", + "name": "ecs.vpc-id" + }, + { + "name": "ecs.capability.execution-role-awslogs" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.17" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.18" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.19" + }, + { + "name": "ecs.capability.docker-plugin.local" + }, + { + "name": "ecs.capability.task-eni" + }, + { + "name": "ecs.capability.task-cpu-mem-limit" + }, + { + "name": "ecs.capability.secrets.ssm.bootstrap.log-driver" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.30" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.31" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.32" + }, + { + "name": "ecs.capability.execution-role-ecr-pull" + }, + { + "name": "ecs.capability.container-health-check" + }, + { + "value": "subnet-1234567890123467", + "name": "ecs.subnet-id" + }, + { + "value": "us-west-2a", + "name": "ecs.availability-zone" + }, + { + "value": "t2.micro", + "name": "ecs.instance-type" + }, + { + "name": "com.amazonaws.ecs.capability.task-iam-role-network-host" + }, + { + "name": "ecs.capability.aws-appmesh" + }, + { + "name": "com.amazonaws.ecs.capability.logging-driver.awslogs" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.24" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.25" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.26" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.27" + }, + { + "name": "com.amazonaws.ecs.capability.privileged-container" + }, + { + "name": "ecs.capability.container-ordering" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.28" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.29" + }, + { + "value": "x86_64", + "name": "ecs.cpu-architecture" + }, + { + "value": "93f43776-2018.10.0", + "name": "ecs.capability.cni-plugin-version" + }, + { + "name": "ecs.capability.secrets.ssm.environment-variables" + }, + { + "name": "ecs.capability.pid-ipc-namespace-sharing" + }, + { + "name": "com.amazonaws.ecs.capability.ecr-auth" + }, + { + "value": "linux", + "name": "ecs.os-type" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.20" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.21" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.22" + }, + { + "name": "ecs.capability.task-eia" + }, + { + "name": "ecs.capability.private-registry-authentication.secretsmanager" + }, + { + "name": "com.amazonaws.ecs.capability.task-iam-role" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.23" + } + ], + "pendingTasksCount": 0, + "tags": [], + "containerInstanceArn": "arn:aws:ecs:us-west-2:123456789012:container-instance/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "registeredResources": [ + { + "integerValue": 1024, + "doubleValue": 0.0, + "type": "INTEGER", + "longValue": 0, + "name": "CPU" + }, + { + "integerValue": 985, + "doubleValue": 0.0, + "type": "INTEGER", + "longValue": 0, + "name": "MEMORY" + }, + { + "type": "STRINGSET", + "integerValue": 0, + "name": "PORTS", + "stringSetValue": [ + "22", + "2376", + "2375", + "51678", + "51679" + ], + "longValue": 0, + "doubleValue": 0.0 + }, + { + "type": "STRINGSET", + "integerValue": 0, + "name": "PORTS_UDP", + "stringSetValue": [], + "longValue": 0, + "doubleValue": 0.0 + } + ], + "status": "INACTIVE", + "registeredAt": 1557768075.681, + "version": 4, + "versionInfo": { + "agentVersion": "1.27.0", + "agentHash": "aabe65ee", + "dockerVersion": "DockerVersion: 18.06.1-ce" + }, + "attachments": [], + "runningTasksCount": 0, + "ec2InstanceId": "i-12345678901234678" + } + } + +For more information, see `Deregister a Container Instance `_ in the *ECS Developer Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ecs/deregister-task-definition.rst awscli-1.18.69/awscli/examples/ecs/deregister-task-definition.rst --- awscli-1.11.13/awscli/examples/ecs/deregister-task-definition.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/deregister-task-definition.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,36 +1,36 @@ **To deregister a task definition** -This example deregisters the first revision of the ``curler`` task definition in your default region. Note that in the resulting output, the task definition status becomes ``INACTIVE``. - -Command:: +The following ``deregister-task-definition`` example deregisters the first revision of the ``curler`` task definition in your default region. :: aws ecs deregister-task-definition --task-definition curler:1 -Output:: +Note that in the resulting output, the task definition status shows ``INACTIVE``:: + + { + "taskDefinition": { + "status": "INACTIVE", + "family": "curler", + "volumes": [], + "taskDefinitionArn": "arn:aws:ecs:us-west-2:123456789012:task-definition/curler:1", + "containerDefinitions": [ + { + "environment": [], + "name": "curler", + "mountPoints": [], + "image": "curl:latest", + "cpu": 100, + "portMappings": [], + "entryPoint": [], + "memory": 256, + "command": [ + "curl -v http://example.com/" + ], + "essential": true, + "volumesFrom": [] + } + ], + "revision": 1 + } + } - { - "taskDefinition": { - "status": "INACTIVE", - "family": "curler", - "volumes": [], - "taskDefinitionArn": "arn:aws:ecs:us-west-2::task-definition/curler:1", - "containerDefinitions": [ - { - "environment": [], - "name": "curler", - "mountPoints": [], - "image": "curl:latest", - "cpu": 100, - "portMappings": [], - "entryPoint": [], - "memory": 256, - "command": [ - "curl -v http://example.com/" - ], - "essential": true, - "volumesFrom": [] - } - ], - "revision": 1 - } - } \ No newline at end of file +For more information, see `Amazon ECS Task Definitions `_ in the *Amazon ECS Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/ecs/describe-clusters.rst awscli-1.18.69/awscli/examples/ecs/describe-clusters.rst --- awscli-1.11.13/awscli/examples/ecs/describe-clusters.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/describe-clusters.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,24 +1,24 @@ **To describe a cluster** -This example command provides a description of the specified cluster in your default region. +The following ``describe-clusters`` example retrieves details about the specified cluster. :: -Command:: - - aws ecs describe-clusters --cluster default + aws ecs describe-clusters --cluster default Output:: - { - "clusters": [ - { - "status": "ACTIVE", - "clusterName": "default", - "registeredContainerInstancesCount": 0, - "pendingTasksCount": 0, - "runningTasksCount": 0, - "activeServicesCount": 1, - "clusterArn": "arn:aws:ecs:us-west-2::cluster/default" - } - ], - "failures": [] - } + { + "clusters": [ + { + "status": "ACTIVE", + "clusterName": "default", + "registeredContainerInstancesCount": 0, + "pendingTasksCount": 0, + "runningTasksCount": 0, + "activeServicesCount": 1, + "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/default" + } + ], + "failures": [] + } + +For more information, see `Amazon ECS Clusters `_ in the *Amazon ECS Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/ecs/describe-container-instances.rst awscli-1.18.69/awscli/examples/ecs/describe-container-instances.rst --- awscli-1.11.13/awscli/examples/ecs/describe-container-instances.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/describe-container-instances.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,86 +1,88 @@ **To describe container instance** -This example command provides a description of the specified container instance in the ``update`` cluster, using the container instance UUID as an identifier. +The following ``describe-container-instances`` example retrieves details for a container instance in the ``update`` cluster, using the container instance UUID as an identifier. :: -Command:: - - aws ecs describe-container-instances --cluster update --container-instances 53ac7152-dcd1-4102-81f5-208962864132 + aws ecs describe-container-instances \ + --cluster update \ + --container-instances a1b2c3d4-5678-90ab-cdef-11111EXAMPLE Output:: - { - "failures": [], - "containerInstances": [ - { - "status": "ACTIVE", - "registeredResources": [ - { - "integerValue": 2048, - "longValue": 0, - "type": "INTEGER", - "name": "CPU", - "doubleValue": 0.0 - }, - { - "integerValue": 3955, - "longValue": 0, - "type": "INTEGER", - "name": "MEMORY", - "doubleValue": 0.0 - }, - { - "name": "PORTS", - "longValue": 0, - "doubleValue": 0.0, - "stringSetValue": [ - "22", - "2376", - "2375", - "51678" - ], - "type": "STRINGSET", - "integerValue": 0 - } - ], - "ec2InstanceId": "i-f3c1de3a", - "agentConnected": true, - "containerInstanceArn": "arn:aws:ecs:us-west-2::container-instance/53ac7152-dcd1-4102-81f5-208962864132", - "pendingTasksCount": 0, - "remainingResources": [ - { - "integerValue": 2048, - "longValue": 0, - "type": "INTEGER", - "name": "CPU", - "doubleValue": 0.0 - }, - { - "integerValue": 3955, - "longValue": 0, - "type": "INTEGER", - "name": "MEMORY", - "doubleValue": 0.0 - }, - { - "name": "PORTS", - "longValue": 0, - "doubleValue": 0.0, - "stringSetValue": [ - "22", - "2376", - "2375", - "51678" - ], - "type": "STRINGSET", - "integerValue": 0 - } - ], - "runningTasksCount": 0, - "versionInfo": { - "agentVersion": "1.0.0", - "agentHash": "4023248", - "dockerVersion": "DockerVersion: 1.5.0" - } - } - ] - } \ No newline at end of file + { + "failures": [], + "containerInstances": [ + { + "status": "ACTIVE", + "registeredResources": [ + { + "integerValue": 2048, + "longValue": 0, + "type": "INTEGER", + "name": "CPU", + "doubleValue": 0.0 + }, + { + "integerValue": 3955, + "longValue": 0, + "type": "INTEGER", + "name": "MEMORY", + "doubleValue": 0.0 + }, + { + "name": "PORTS", + "longValue": 0, + "doubleValue": 0.0, + "stringSetValue": [ + "22", + "2376", + "2375", + "51678" + ], + "type": "STRINGSET", + "integerValue": 0 + } + ], + "ec2InstanceId": "i-A1B2C3D4", + "agentConnected": true, + "containerInstanceArn": "arn:aws:ecs:us-west-2:123456789012:container-instance/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "pendingTasksCount": 0, + "remainingResources": [ + { + "integerValue": 2048, + "longValue": 0, + "type": "INTEGER", + "name": "CPU", + "doubleValue": 0.0 + }, + { + "integerValue": 3955, + "longValue": 0, + "type": "INTEGER", + "name": "MEMORY", + "doubleValue": 0.0 + }, + { + "name": "PORTS", + "longValue": 0, + "doubleValue": 0.0, + "stringSetValue": [ + "22", + "2376", + "2375", + "51678" + ], + "type": "STRINGSET", + "integerValue": 0 + } + ], + "runningTasksCount": 0, + "versionInfo": { + "agentVersion": "1.0.0", + "agentHash": "4023248", + "dockerVersion": "DockerVersion: 1.5.0" + } + } + ] + } + +For more information, see `Amazon ECS Container Instances `_ in the *Amazon ECS Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/ecs/describe-services.rst awscli-1.18.69/awscli/examples/ecs/describe-services.rst --- awscli-1.11.13/awscli/examples/ecs/describe-services.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/describe-services.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,46 +1,46 @@ **To describe a service** -This example command provides descriptive information about the ``my-http-service``. +The following ``describe-services`` example retrieves details for the ``my-http-service`` service in the default cluster. :: -Command:: - - aws ecs describe-services --service my-http-service + aws ecs describe-services --services my-http-service Output:: - { - "services": [ - { - "status": "ACTIVE", - "taskDefinition": "arn:aws:ecs:::task-definition/amazon-ecs-sample:1", - "pendingCount": 0, - "loadBalancers": [], - "desiredCount": 10, - "createdAt": 1466801808.595, - "serviceName": "my-http-service", - "clusterArn": "arn:aws:ecs:::cluster/default", - "serviceArn": "arn:aws:ecs:::service/my-http-service", - "deployments": [ - { - "status": "PRIMARY", - "pendingCount": 0, - "createdAt": 1466801808.595, - "desiredCount": 10, - "taskDefinition": "arn:aws:ecs:::task-definition/amazon-ecs-sample:1", - "updatedAt": 1428326312.703, - "id": "ecs-svc/9223370608528463088", - "runningCount": 10 - } - ], - "events": [ - { - "message": "(service my-http-service) has reached a steady state.", - "id": "97c8a8e0-16a5-4d30-80bd-9e5413f8951b", - "createdAt": 1466801812.435 - } - ], - "runningCount": 10 - } - ], - "failures": [] - } + { + "services": [ + { + "status": "ACTIVE", + "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/amazon-ecs-sample:1", + "pendingCount": 0, + "loadBalancers": [], + "desiredCount": 10, + "createdAt": 1466801808.595, + "serviceName": "my-http-service", + "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/default", + "serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/my-http-service", + "deployments": [ + { + "status": "PRIMARY", + "pendingCount": 0, + "createdAt": 1466801808.595, + "desiredCount": 10, + "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/amazon-ecs-sample:1", + "updatedAt": 1428326312.703, + "id": "ecs-svc/1234567890123456789", + "runningCount": 10 + } + ], + "events": [ + { + "message": "(service my-http-service) has reached a steady state.", + "id": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "createdAt": 1466801812.435 + } + ], + "runningCount": 10 + } + ], + "failures": [] + } + +For more information, see `Services `_ in the *Amazon ECS Developer Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ecs/describe-task-definition.rst awscli-1.18.69/awscli/examples/ecs/describe-task-definition.rst --- awscli-1.11.13/awscli/examples/ecs/describe-task-definition.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/describe-task-definition.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,55 +1,55 @@ **To describe a task definition** -This example command provides a description of the specified task definition. +The following ``describe-task-definition`` example retrieves the details of a task definition. :: -Command:: - - aws ecs describe-task-definition --task-definition hello_world:8 + aws ecs describe-task-definition --task-definition hello_world:8 Output:: - { - "taskDefinition": { - "volumes": [], - "taskDefinitionArn": "arn:aws:ecs:us-east-1::task-definition/hello_world:8", - "containerDefinitions": [ - { - "environment": [], - "name": "wordpress", - "links": [ - "mysql" - ], - "mountPoints": [], - "image": "wordpress", - "essential": true, - "portMappings": [ - { - "containerPort": 80, - "hostPort": 80 - } - ], - "memory": 500, - "cpu": 10, - "volumesFrom": [] - }, - { - "environment": [ - { - "name": "MYSQL_ROOT_PASSWORD", - "value": "password" - } - ], - "name": "mysql", - "mountPoints": [], - "image": "mysql", - "cpu": 10, - "portMappings": [], - "memory": 500, - "essential": true, - "volumesFrom": [] - } - ], - "family": "hello_world", - "revision": 8 - } - } + { + "taskDefinition": { + "volumes": [], + "taskDefinitionArn": "arn:aws:ecs:us-west-2:123456789012:task-definition/hello_world:8", + "containerDefinitions": [ + { + "environment": [], + "name": "wordpress", + "links": [ + "mysql" + ], + "mountPoints": [], + "image": "wordpress", + "essential": true, + "portMappings": [ + { + "containerPort": 80, + "hostPort": 80 + } + ], + "memory": 500, + "cpu": 10, + "volumesFrom": [] + }, + { + "environment": [ + { + "name": "MYSQL_ROOT_PASSWORD", + "value": "password" + } + ], + "name": "mysql", + "mountPoints": [], + "image": "mysql", + "cpu": 10, + "portMappings": [], + "memory": 500, + "essential": true, + "volumesFrom": [] + } + ], + "family": "hello_world", + "revision": 8 + } + } + +For more information, see `Amazon ECS Task Definitions `_ in the *Amazon ECS Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/ecs/describe-task-sets.rst awscli-1.18.69/awscli/examples/ecs/describe-task-sets.rst --- awscli-1.11.13/awscli/examples/ecs/describe-task-sets.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/describe-task-sets.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,48 @@ +**To describe a task set** + +The following ``describe-task-sets`` example describes a task set in a service that uses an external deployer. :: + + aws ecs describe-task-sets \ + --cluster MyCluster \ + --service MyService \ + --task-sets arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789 + +Output:: + + { + "taskSets": [ + { + "id": "ecs-svc/1234567890123456789", + "taskSetArn": "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789", + "status": "ACTIVE", + "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sample-fargate:2", + "computedDesiredCount": 0, + "pendingCount": 0, + "runningCount": 0, + "createdAt": 1557207715.195, + "updatedAt": 1557207740.014, + "launchType": "EC2", + "networkConfiguration": { + "awsvpcConfiguration": { + "subnets": [ + "subnet-12344321" + ], + "securityGroups": [ + "sg-1234431" + ], + "assignPublicIp": "DISABLED" + } + }, + "loadBalancers": [], + "serviceRegistries": [], + "scale": { + "value": 0.0, + "unit": "PERCENT" + }, + "stabilityStatus": "STEADY_STATE", + "stabilityStatusAt": 1557207740.014 + } + ], + "failures": [] + } + diff -Nru awscli-1.11.13/awscli/examples/ecs/describe-tasks.rst awscli-1.18.69/awscli/examples/ecs/describe-tasks.rst --- awscli-1.11.13/awscli/examples/ecs/describe-tasks.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/describe-tasks.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,46 +1,88 @@ **To describe a task** -This example command provides a description of the specified task, using the task UUID as an identifier. +The following ``describe-tasks`` example retrieves the details of a task. You can specify the task by using either the ID or full ARN of the task. :: -Command:: - - aws ecs describe-tasks --tasks c5cba4eb-5dad-405e-96db-71ef8eefe6a8 + aws ecs describe-tasks \ + --cluster MyCluster \ + --tasks arn:aws:ecs:us-west-2:123456789012:task/MyCluster/1234567890123456789 Output:: - { - "failures": [], - "tasks": [ - { - "taskArn": "arn:aws:ecs:::task/c5cba4eb-5dad-405e-96db-71ef8eefe6a8", - "overrides": { - "containerOverrides": [ - { - "name": "ecs-demo" - } - ] - }, - "lastStatus": "RUNNING", - "containerInstanceArn": "arn:aws:ecs:::container-instance/18f9eda5-27d7-4c19-b133-45adc516e8fb", - "clusterArn": "arn:aws:ecs:::cluster/default", - "desiredStatus": "RUNNING", - "taskDefinitionArn": "arn:aws:ecs:::task-definition/amazon-ecs-sample:1", - "startedBy": "ecs-svc/9223370608528463088", - "containers": [ - { - "containerArn": "arn:aws:ecs:::container/7c01765b-c588-45b3-8290-4ba38bd6c5a6", - "taskArn": "arn:aws:ecs:::task/c5cba4eb-5dad-405e-96db-71ef8eefe6a8", - "lastStatus": "RUNNING", - "name": "ecs-demo", - "networkBindings": [ - { - "bindIP": "0.0.0.0", - "containerPort": 80, - "hostPort": 80 - } - ] - } - ] - } - ] - } + { + "tasks": [ + { + "taskArn": "arn:aws:ecs:us-west-2:123456789012:task/MyCluster/1234567890123456789", + "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster", + "taskDefinitionArn": "arn:aws:ecs:us-west-2:123456789012:task-definition/sample-fargate:2", + "overrides": { + "containerOverrides": [ + { + "name": "fargate-app" + } + ] + }, + "lastStatus": "RUNNING", + "desiredStatus": "RUNNING", + "cpu": "256", + "memory": "512", + "containers": [ + { + "containerArn": "arn:aws:ecs:us-west-2:123456789012:container/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "taskArn": "arn:aws:ecs:us-west-2:123456789012:task/MyCluster/1234567890123456789", + "name": "fargate-app", + "lastStatus": "RUNNING", + "networkBindings": [], + "networkInterfaces": [ + { + "attachmentId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", + "privateIpv4Address": "10.0.0.4" + } + ], + "healthStatus": "UNKNOWN", + "cpu": "0" + } + ], + "startedBy": "ecs-svc/1234567890123456789", + "version": 3, + "connectivity": "CONNECTED", + "connectivityAt": 1557134016.971, + "pullStartedAt": 1557134025.379, + "pullStoppedAt": 1557134033.379, + "createdAt": 1557134011.644, + "startedAt": 1557134035.379, + "group": "service:fargate-service", + "launchType": "FARGATE", + "platformVersion": "1.3.0", + "attachments": [ + { + "id": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE", + "type": "ElasticNetworkInterface", + "status": "ATTACHED", + "details": [ + { + "name": "subnetId", + "value": "subnet-12344321" + }, + { + "name": "networkInterfaceId", + "value": "eni-12344321" + }, + { + "name": "macAddress", + "value": "0a:90:09:84:f9:14" + }, + { + "name": "privateIPv4Address", + "value": "10.0.0.4" + } + ] + } + ], + "healthStatus": "UNKNOWN", + "tags": [] + } + ], + "failures": [] + } + +For more information, see `Amazon ECS Task Definitions `_ in the *Amazon ECS Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/ecs/list-account-settings.rst awscli-1.18.69/awscli/examples/ecs/list-account-settings.rst --- awscli-1.11.13/awscli/examples/ecs/list-account-settings.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/list-account-settings.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,47 @@ +**Example 1: To view the account settings for an account** + +The following ``list-account-settings`` example displays the effective account settings for an account. :: + + aws ecs list-account-settings --effective-settings + +Output:: + + { + "settings": [ + { + "name": "containerInstanceLongArnFormat", + "value": "enabled", + "principalArn": "arn:aws:iam::123456789012:root" + }, + { + "name": "serviceLongArnFormat", + "value": "enabled", + "principalArn": "arn:aws:iam::123456789012:root" + }, + { + "name": "taskLongArnFormat", + "value": "enabled", + "principalArn": "arn:aws:iam::123456789012:root" + } + ] + } + +**Example 2: To view the account settings for a specific IAM user or IAM role** + +The following ``list-account-settings`` example displays the account settings for the specified IAM user or IAM role. :: + + aws ecs list-account-settings --principal-arn arn:aws:iam::123456789012:user/MyUser + +Output:: + + { + "settings": [ + { + "name": "serviceLongArnFormat", + "value": "enabled", + "principalArn": "arn:aws:iam::123456789012:user/MyUser" + } + ] + } + +For more information, see `Amazon Resource Names (ARNs) and IDs `_ in the *Amazon ECS Developer Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ecs/list-attributes.rst awscli-1.18.69/awscli/examples/ecs/list-attributes.rst --- awscli-1.11.13/awscli/examples/ecs/list-attributes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/list-attributes.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,23 @@ +**To list the container instances that contain a specific attribute** + +The following example lists the attributes for container instances that have the ``stack=production`` attribute in the default cluster. :: + + aws ecs list-attributes \ + --target-type container-instance \ + --attribute-name stack \ + --attribute-value production \ + --cluster default + +Output:: + + { + "attributes": [ + { + "name": "stack", + "targetId": "arn:aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34", + "value": "production" + } + ] + } + +For more information, see `Amazon ECS Container Agent Configuration `__ in the *Amazon ECS Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/ecs/list-clusters.rst awscli-1.18.69/awscli/examples/ecs/list-clusters.rst --- awscli-1.11.13/awscli/examples/ecs/list-clusters.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/list-clusters.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,16 +1,16 @@ **To list your available clusters** -This example command lists all of your available clusters in your default region. +The following ``list-clusters`` example lists all of the available clusters. :: -Command:: - - aws ecs list-clusters + aws ecs list-clusters Output:: - { - "clusterArns": [ - "arn:aws:ecs:us-east-1::cluster/test", - "arn:aws:ecs:us-east-1::cluster/default" - ] - } + { + "clusterArns": [ + "arn:aws:ecs:us-west-2:123456789012:cluster/MyECSCluster1", + "arn:aws:ecs:us-west-2:123456789012:cluster/AnotherECSCluster" + ] + } + +For more information, see `Amazon ECS Clusters `_ in the *Amazon ECS Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/ecs/list-container-instances.rst awscli-1.18.69/awscli/examples/ecs/list-container-instances.rst --- awscli-1.11.13/awscli/examples/ecs/list-container-instances.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/list-container-instances.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,16 +1,16 @@ -**To list your available container instances in a cluster** +**To list the container instances in a cluster** -This example command lists all of your available container instances in the specified cluster in your default region. +The following ``list-container-instances`` example lists all of the available container instances in a cluster. :: -Command:: - - aws ecs list-container-instances --cluster default + aws ecs list-container-instances --cluster MyCluster Output:: - { - "containerInstanceArns": [ - "arn:aws:ecs:us-east-1::container-instance/f6bbb147-5370-4ace-8c73-c7181ded911f", - "arn:aws:ecs:us-east-1::container-instance/ffe3d344-77e2-476c-a4d0-bf560ad50acb" - ] - } + { + "containerInstanceArns": [ + "arn:aws:ecs:us-west-2:123456789012:container-instance/MyCluster/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "arn:aws:ecs:us-west-2:123456789012:container-instance/MyCluster/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE" + ] + } + +For more information, see `Amazon ECS Container Instances `_ in the *Amazon ECS Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/ecs/list-services.rst awscli-1.18.69/awscli/examples/ecs/list-services.rst --- awscli-1.11.13/awscli/examples/ecs/list-services.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/list-services.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,15 +1,15 @@ **To list the services in a cluster** -This example command lists the services running in a cluster. +The following ``list-services`` example shows how to list the services running in a cluster. :: -Command:: - - aws ecs list-services + aws ecs list-services --cluster MyCluster Output:: - { - "serviceArns": [ - "arn:aws:ecs:::service/my-http-service" - ] - } + { + "serviceArns": [ + "arn:aws:ecs:us-west-2:123456789012:service/MyCluster/MyService" + ] + } + +For more information, see `Services `_ in the *Amazon ECS Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/ecs/list-tags-for-resource.rst awscli-1.18.69/awscli/examples/ecs/list-tags-for-resource.rst --- awscli-1.11.13/awscli/examples/ecs/list-tags-for-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/list-tags-for-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,25 @@ +**To list the tags for a resource** + +The following ``list-tags-for-resource`` example lists the tags for a specific cluster. :: + + aws ecs list-tags-for-resource \ + --resource-arn arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster + +Output:: + + { + "tags": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value2" + }, + { + "key": "key3", + "value": "value3" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/ecs/list-task-definition-families.rst awscli-1.18.69/awscli/examples/ecs/list-task-definition-families.rst --- awscli-1.11.13/awscli/examples/ecs/list-task-definition-families.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/list-task-definition-families.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,35 +1,33 @@ -**To list your registered task definition families** +**Example 1: To list the registered task definition families** -This example command lists all of your registered task definition families. +The following ``list-task-definition-families`` example lists all of the registered task definition families. :: -Command:: - - aws ecs list-task-definition-families + aws ecs list-task-definition-families Output:: - { - "families": [ - "node-js-app", - "web-timer", - "hpcc", - "hpcc-c4-8xlarge" - ] - } - -**To filter your registered task definition families** + { + "families": [ + "node-js-app", + "web-timer", + "hpcc", + "hpcc-c4-8xlarge" + ] + } -This example command lists the task definition revisions that start with "hpcc". +**Example 2: To filter the registered task definition families** -Command:: +The following ``list-task-definition-families`` example lists the task definition revisions that start with "hpcc". :: - aws ecs list-task-definition-families --family-prefix hpcc + aws ecs list-task-definition-families --family-prefix hpcc Output:: - { - "families": [ - "hpcc", - "hpcc-c4-8xlarge" - ] - } + { + "families": [ + "hpcc", + "hpcc-c4-8xlarge" + ] + } + +For more information, see `Task Definition Parameters `_ in the *Amazon ECS Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/ecs/list-task-definitions.rst awscli-1.18.69/awscli/examples/ecs/list-task-definitions.rst --- awscli-1.11.13/awscli/examples/ecs/list-task-definitions.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/list-task-definitions.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,39 +1,37 @@ -**To list your registered task definitions** +**Example 1: To list the registered task definitions** -This example command lists all of your registered task definitions. +The following ``list-task-definitions`` example lists all of the registered task definitions. :: -Command:: - - aws ecs list-task-definitions + aws ecs list-task-definitions Output:: - { - "taskDefinitionArns": [ - "arn:aws:ecs:us-east-1::task-definition/sleep300:2", - "arn:aws:ecs:us-east-1::task-definition/sleep360:1", - "arn:aws:ecs:us-east-1::task-definition/wordpress:3", - "arn:aws:ecs:us-east-1::task-definition/wordpress:4", - "arn:aws:ecs:us-east-1::task-definition/wordpress:5", - "arn:aws:ecs:us-east-1::task-definition/wordpress:6" - ] - } - -**To list the registered task definitions in a family** + { + "taskDefinitionArns": [ + "arn:aws:ecs:us-west-2:123456789012:task-definition/sleep300:2", + "arn:aws:ecs:us-west-2:123456789012:task-definition/sleep360:1", + "arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:3", + "arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:4", + "arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:5", + "arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:6" + ] + } -This example command lists the task definition revisions of a specified family. +**Example 2: To list the registered task definitions in a family** -Command:: +The following `list-task-definitions` example lists the task definition revisions of a specified family. :: - aws ecs list-task-definitions --family-prefix wordpress + aws ecs list-task-definitions --family-prefix wordpress Output:: - { - "taskDefinitionArns": [ - "arn:aws:ecs:us-east-1::task-definition/wordpress:3", - "arn:aws:ecs:us-east-1::task-definition/wordpress:4", - "arn:aws:ecs:us-east-1::task-definition/wordpress:5", - "arn:aws:ecs:us-east-1::task-definition/wordpress:6" - ] - } \ No newline at end of file + { + "taskDefinitionArns": [ + "arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:3", + "arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:4", + "arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:5", + "arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:6" + ] + } + +For more information, see `Amazon ECS Task Definitions `_ in the *Amazon ECS Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/ecs/list-tasks.rst awscli-1.18.69/awscli/examples/ecs/list-tasks.rst --- awscli-1.11.13/awscli/examples/ecs/list-tasks.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/list-tasks.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,32 +1,30 @@ -**To list the tasks in a cluster** +**Example 1: To list the tasks in a cluster** -This example command lists all of the tasks in a cluster. +The following ``list-tasks`` example lists all of the tasks in a cluster. :: -Command:: - - aws ecs list-tasks --cluster default + aws ecs list-tasks --cluster default Output:: - { - "taskArns": [ - "arn:aws:ecs:us-east-1::task/0cc43cdb-3bee-4407-9c26-c0e6ea5bee84", - "arn:aws:ecs:us-east-1::task/6b809ef6-c67e-4467-921f-ee261c15a0a1" - ] - } - -**To list the tasks on a particular container instance** + { + "taskArns": [ + "arn:aws:ecs:us-west-2:123456789012:task/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "arn:aws:ecs:us-west-2:123456789012:task/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE" + ] + } -This example command lists the tasks of a specified container instance, using the container instance UUID as a filter. +**Example 2: To list the tasks on a particular container instance** -Command:: +The following ``list-tasks`` example lists the tasks on a container instance, using the container instance UUID as a filter. :: - aws ecs list-tasks --cluster default --container-instance f6bbb147-5370-4ace-8c73-c7181ded911f + aws ecs list-tasks --cluster default --container-instance a1b2c3d4-5678-90ab-cdef-33333EXAMPLE Output:: - { - "taskArns": [ - "arn:aws:ecs:us-east-1::task/0cc43cdb-3bee-4407-9c26-c0e6ea5bee84" - ] - } \ No newline at end of file + { + "taskArns": [ + "arn:aws:ecs:us-west-2:123456789012:task/a1b2c3d4-5678-90ab-cdef-44444EXAMPLE" + ] + } + +For more information, see `Amazon ECS Task Definitions `_ in the *Amazon ECS Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/ecs/put-account-setting-default.rst awscli-1.18.69/awscli/examples/ecs/put-account-setting-default.rst --- awscli-1.11.13/awscli/examples/ecs/put-account-setting-default.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/put-account-setting-default.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To modify the default account settings** + +The following ``put-account-setting-default`` example modifies the default account setting for all IAM users or roles on your account. These changes apply to the entire AWS account unless an IAM user or role explicitly overrides these settings for themselves. :: + + aws ecs put-account-setting-default --name serviceLongArnFormat --value enabled + +Output:: + + { + "setting": { + "name": "serviceLongArnFormat", + "value": "enabled", + "principalArn": "arn:aws:iam::123456789012:root" + } + } + +For more information, see `Amazon Resource Names (ARNs) and IDs `_ in the *Amazon ECS Developer Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ecs/put-account-setting.rst awscli-1.18.69/awscli/examples/ecs/put-account-setting.rst --- awscli-1.11.13/awscli/examples/ecs/put-account-setting.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/put-account-setting.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To modify the account setting for your IAM user account** + +The following ``put-account-setting`` example enables the ``serviceLongArnFormat`` account setting for your IAM user account. :: + + aws ecs put-account-setting --name serviceLongArnFormat --value enabled + +Output:: + + { + "setting": { + "name": "serviceLongArnFormat", + "value": "enabled", + "principalArn": "arn:aws:iam::130757420319:user/your_username" + } + } + +For more information, see `Modifying Account Settings `__ in the *Amazon ECS Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/ecs/put-account-settings.rst awscli-1.18.69/awscli/examples/ecs/put-account-settings.rst --- awscli-1.11.13/awscli/examples/ecs/put-account-settings.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/put-account-settings.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To modify the account settings for an IAM user or IAM role** + +The following ``put-account-setting`` example modifies the account settings for the specified IAM user or IAM role. :: + + aws ecs put-account-setting \ + --name serviceLongArnFormat \ + --value enabled \ + --principal-arn arn:aws:iam::123456789012:user/MyUser + +Output:: + + { + "setting": { + "name": "serviceLongArnFormat", + "value": "enabled", + "principalArn": "arn:aws:iam::123456789012:user/MyUser" + } + } + diff -Nru awscli-1.11.13/awscli/examples/ecs/put-attributes.rst awscli-1.18.69/awscli/examples/ecs/put-attributes.rst --- awscli-1.11.13/awscli/examples/ecs/put-attributes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/put-attributes.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To create an attribute and associate it with an Amazon ECS resource** + +The following ``put-attributes`` applies an attribute with the name stack and the value production to a container instance. :: + + aws ecs put-attributes \ + --attributes name=stack,value=production,targetId=arn:aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34 + +Output:: + + { + "attributes": [ + { + "name": "stack", + "targetId": "arn:aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34", + "value": "production" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/ecs/register-task-definition.rst awscli-1.18.69/awscli/examples/ecs/register-task-definition.rst --- awscli-1.11.13/awscli/examples/ecs/register-task-definition.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/register-task-definition.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,108 +1,123 @@ -**To register a task definition with a JSON file** +**Example 1: To register a task definition with a JSON file** -This example registers a task definition to the specified family with container definitions that are saved in JSON format at the specified file location. +The following ``register-task-definition`` example registers a task definition to the specified family with container definitions that are saved in JSON format at the specified file location. :: -Command:: + aws ecs register-task-definition \ + --cli-input-json file:///sleep360.json - aws ecs register-task-definition --cli-input-json file:///sleep360.json +``sleep360.json`` file contents:: -JSON file format:: - - { - "containerDefinitions": [ - { - "name": "sleep", - "image": "busybox", - "cpu": 10, - "command": [ - "sleep", - "360" + { + "containerDefinitions": [ + { + "name": "sleep", + "image": "busybox", + "cpu": 10, + "command": [ + "sleep", + "360" + ], + "memory": 10, + "essential": true + } ], - "memory": 10, - "essential": true - } - ], - "family": "sleep360" - } + "family": "sleep360" + } Output:: - { - "taskDefinition": { - "volumes": [], - "taskDefinitionArn": "arn:aws:ecs:us-east-1::task-definition/sleep360:19", - "containerDefinitions": [ - { - "environment": [], - "name": "sleep", - "mountPoints": [], - "image": "busybox", - "cpu": 10, - "portMappings": [], - "command": [ - "sleep", - "360" - ], - "memory": 10, - "essential": true, - "volumesFrom": [] - } - ], - "family": "sleep360", - "revision": 1 - } - } - -**To register a task definition with a JSON string** - -This example registers a the same task definition from the previous example, but the container definitions are in a string format with the double quotes escaped. - -Command:: - - aws ecs register-task-definition --family sleep360 --container-definitions "[{\"name\":\"sleep\",\"image\":\"busybox\",\"cpu\":10,\"command\":[\"sleep\",\"360\"],\"memory\":10,\"essential\":true}]" - -**To use data volumes in a task definition** - -This example task definition creates a data volume called `webdata` that exists at `/ecs/webdata` on the container instance. The volume is mounted read-only as `/usr/share/nginx/html` on the `web` container, and read-write as `/nginx/` on the `timer` container. - -Task Definition:: - - { - "family": "web-timer", - "containerDefinitions": [ - { - "name": "web", - "image": "nginx", - "cpu": 99, - "memory": 100, - "portMappings": [{ - "containerPort": 80, - "hostPort": 80 - }], - "essential": true, - "mountPoints": [{ - "sourceVolume": "webdata", - "containerPath": "/usr/share/nginx/html", - "readOnly": true - }] - }, { - "name": "timer", - "image": "busybox", - "cpu": 10, - "memory": 20, - "entryPoint": ["sh", "-c"], - "command": ["while true; do date > /nginx/index.html; sleep 1; done"], - "mountPoints": [{ - "sourceVolume": "webdata", - "containerPath": "/nginx/" - }] - }], - "volumes": [{ - "name": "webdata", - "host": { - "sourcePath": "/ecs/webdata" - }} - ] - } + { + "taskDefinition": { + "taskDefinitionArn": "arn:aws:ecs:us-west-2:123456789012:task-definition/sleep360:2", + "containerDefinitions": [ + { + "name": "sleep", + "image": "busybox", + "cpu": 10, + "memory": 10, + "portMappings": [], + "essential": true, + "command": [ + "sleep", + "360" + ], + "environment": [], + "mountPoints": [], + "volumesFrom": [] + } + ], + "family": "sleep360", + "revision": 2, + "volumes": [], + "status": "ACTIVE", + "placementConstraints": [], + "compatibilities": [ + "EC2" + ] + } + } + +**Example 2: To register a task definition with a JSON string parameter** + +The following ``register-task-definition`` example registers the same task definition from the previous example, but the container definitions are provided as a string parameter with the double quotes escaped. :: + + aws ecs register-task-definition \ + --family sleep360 \ + --container-definitions "[{\"name\":\"sleep\",\"image\":\"busybox\",\"cpu\":10,\"command\":[\"sleep\",\"360\"],\"memory\":10,\"essential\":true}]" + +The output is identical to the previous example. + +**Example 3: To use data volumes in a task definition** + +This example task definition file creates a data volume called `webdata` that exists at `/ecs/webdata` on the container instance. The volume is mounted read-only as `/usr/share/nginx/html` on the `web` container, and read-write as `/nginx/` on the `timer` container. :: + + { + "family": "web-timer", + "containerDefinitions": [ + { + "name": "web", + "image": "nginx", + "cpu": 99, + "memory": 100, + "portMappings": [ + { + "containerPort": 80, + "hostPort": 80 + } + ], + "essential": true, + "mountPoints": [ + { + "sourceVolume": "webdata", + "containerPath": "/usr/share/nginx/html", + "readOnly": true + } + ] + }, + { + "name": "timer", + "image": "busybox", + "cpu": 10, + "memory": 20, + "entryPoint": ["sh", "-c"], + "command": ["while true; do date > /nginx/index.html; sleep 1; done"], + "mountPoints": [ + { + "sourceVolume": "webdata", + "containerPath": "/nginx/" + } + ] + } + ], + "volumes": [ + { + "name": "webdata", + "host": { + "sourcePath": "/ecs/webdata" + } + } + ] + } +For more information, see `Creating a Task Definition `_ in the *Amazon ECS Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/ecs/run-task.rst awscli-1.18.69/awscli/examples/ecs/run-task.rst --- awscli-1.11.13/awscli/examples/ecs/run-task.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/run-task.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,36 +1,37 @@ **To run a task on your default cluster** -This example command runs the specified task definition on your default cluster. +The following ``run-task`` example runs a task on the default cluster. :: -Command:: - - aws ecs run-task --cluster default --task-definition sleep360:1 + aws ecs run-task --cluster default --task-definition sleep360:1 Output:: - { - "tasks": [ - { - "taskArn": "arn:aws:ecs:us-east-1::task/a9f21ea7-c9f5-44b1-b8e6-b31f50ed33c0", - "overrides": { - "containerOverrides": [ - { - "name": "sleep" - } - ] - }, - "lastStatus": "PENDING", - "containerInstanceArn": "arn:aws:ecs:us-east-1::container-instance/ffe3d344-77e2-476c-a4d0-bf560ad50acb", - "desiredStatus": "RUNNING", - "taskDefinitionArn": "arn:aws:ecs:us-east-1::task-definition/sleep360:1", - "containers": [ - { - "containerArn": "arn:aws:ecs:us-east-1::container/58591c8e-be29-4ddf-95aa-ee459d4c59fd", - "taskArn": "arn:aws:ecs:us-east-1::task/a9f21ea7-c9f5-44b1-b8e6-b31f50ed33c0", - "lastStatus": "PENDING", - "name": "sleep" - } - ] - } - ] - } + { + "tasks": [ + { + "taskArn": "arn:aws:ecs:us-west-2:123456789012:task/a1b2c3d4-5678-90ab-ccdef-11111EXAMPLE", + "overrides": { + "containerOverrides": [ + { + "name": "sleep" + } + ] + }, + "lastStatus": "PENDING", + "containerInstanceArn": "arn:aws:ecs:us-west-2:123456789012:container-instance/a1b2c3d4-5678-90ab-ccdef-22222EXAMPLE", + "desiredStatus": "RUNNING", + "taskDefinitionArn": "arn:aws:ecs:us-west-2:123456789012:task-definition/sleep360:1", + "containers": [ + { + "containerArn": "arn:aws:ecs:us-west-2:123456789012:container/a1b2c3d4-5678-90ab-ccdef-33333EXAMPLE", + "taskArn": "arn:aws:ecs:us-west-2:123456789012:task/a1b2c3d4-5678-90ab-ccdef-11111EXAMPLE", + "lastStatus": "PENDING", + "name": "sleep" + } + ] + } + ] + } + + +For more information, see `Running Tasks `_ in the *Amazon ECS Developer Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ecs/start-task.rst awscli-1.18.69/awscli/examples/ecs/start-task.rst --- awscli-1.11.13/awscli/examples/ecs/start-task.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/start-task.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,49 @@ +**To start a new task** + +The following ``start-task`` starts a task using the latest revision of the ``sleep360`` task definition on the specified container instance in the default cluster. :: + + aws ecs start-task \ + --task-definition sleep360 \ + --container-instances 765936fadbdd46b5991a4bd70c2a43d4 + +Output:: + + { + "tasks": [ + { + "taskArn": "arn:aws:ecs:us-west-2:130757420319:task/default/666fdccc2e2d4b6894dd422f4eeee8f8", + "clusterArn": "arn:aws:ecs:us-west-2:130757420319:cluster/default", + "taskDefinitionArn": "arn:aws:ecs:us-west-2:130757420319:task-definition/sleep360:3", + "containerInstanceArn": "arn:aws:ecs:us-west-2:130757420319:container-instance/default/765936fadbdd46b5991a4bd70c2a43d4", + "overrides": { + "containerOverrides": [ + { + "name": "sleep" + } + ] + }, + "lastStatus": "PENDING", + "desiredStatus": "RUNNING", + "cpu": "128", + "memory": "128", + "containers": [ + { + "containerArn": "arn:aws:ecs:us-west-2:130757420319:container/75f11ed4-8a3d-4f26-a33b-ad1db9e02d41", + "taskArn": "arn:aws:ecs:us-west-2:130757420319:task/default/666fdccc2e2d4b6894dd422f4eeee8f8", + "name": "sleep", + "lastStatus": "PENDING", + "networkInterfaces": [], + "cpu": "10", + "memory": "10" + } + ], + "version": 1, + "createdAt": 1563421494.186, + "group": "family:sleep360", + "launchType": "EC2", + "attachments": [], + "tags": [] + } + ], + "failures": [] + } diff -Nru awscli-1.11.13/awscli/examples/ecs/stop-task.rst awscli-1.18.69/awscli/examples/ecs/stop-task.rst --- awscli-1.11.13/awscli/examples/ecs/stop-task.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/stop-task.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,40 @@ +**To stop a task** + +The following ``stop-task`` stops the specified task from running in the default cluster. :: + + aws ecs stop-task \ + --task 666fdccc2e2d4b6894dd422f4eeee8f8 + +Output:: + + { + "task": { + "taskArn": "arn:aws:ecs:us-west-2:130757420319:task/default/666fdccc2e2d4b6894dd422f4eeee8f8", + "clusterArn": "arn:aws:ecs:us-west-2:130757420319:cluster/default", + "taskDefinitionArn": "arn:aws:ecs:us-west-2:130757420319:task-definition/sleep360:3", + "containerInstanceArn": "arn:aws:ecs:us-west-2:130757420319:container-instance/default/765936fadbdd46b5991a4bd70c2a43d4", + "overrides": { + "containerOverrides": [] + }, + "lastStatus": "STOPPED", + "desiredStatus": "STOPPED", + "cpu": "128", + "memory": "128", + "containers": [], + "version": 2, + "stoppedReason": "Taskfailedtostart", + "stopCode": "TaskFailedToStart", + "connectivity": "CONNECTED", + "connectivityAt": 1563421494.186, + "pullStartedAt": 1563421494.252, + "pullStoppedAt": 1563421496.252, + "executionStoppedAt": 1563421497, + "createdAt": 1563421494.186, + "stoppingAt": 1563421497.252, + "stoppedAt": 1563421497.252, + "group": "family:sleep360", + "launchType": "EC2", + "attachments": [], + "tags": [] + } + } diff -Nru awscli-1.11.13/awscli/examples/ecs/tag-resource.rst awscli-1.18.69/awscli/examples/ecs/tag-resource.rst --- awscli-1.11.13/awscli/examples/ecs/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/tag-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To tag a resource** + +The following ``tag-resource`` example adds a single tag to the specified resource. :: + + aws ecs tag-resource \ + --resource-arn arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster + --tags key=key1,value=value1 + +This command produces no output. + +**To add multiple tags to a resource** + +The following ``tag-resource`` example adds multiple tags to the specified resource. :: + + aws ecs tag-resource \ + --resource-arn arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster \ + --tags key=key1,value=value1 key=key2,value=value2 key=key3,value=value3 + +This command produces no output. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ecs/untag-resource.rst awscli-1.18.69/awscli/examples/ecs/untag-resource.rst --- awscli-1.11.13/awscli/examples/ecs/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/untag-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,10 @@ +**To remove a tag from a resource** + +The following ``untag-resource`` example removes the listed tags from the specified resource. :: + + aws ecs untag-resource \ + --resource-arn arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster \ + --tag-keys key1,key2 + +This command produces no output. + diff -Nru awscli-1.11.13/awscli/examples/ecs/update-cluster-settings.rst awscli-1.18.69/awscli/examples/ecs/update-cluster-settings.rst --- awscli-1.11.13/awscli/examples/ecs/update-cluster-settings.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/update-cluster-settings.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,31 @@ +**To modify the settings for your cluster** + +The following ``update-cluster-settings`` example enables CloudWatch Container Insights for the ``default`` cluster. :: + + aws ecs update-cluster-settings \ + --cluster default \ + --settings name=containerInsights,value=enabled + +Output:: + + { + "cluster": { + "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster", + "clusterName": "default", + "status": "ACTIVE", + "registeredContainerInstancesCount": 0, + "runningTasksCount": 0, + "pendingTasksCount": 0, + "activeServicesCount": 0, + "statistics": [], + "tags": [], + "settings": [ + { + "name": "containerInsights", + "value": "enabled" + } + ] + } + } + +For more information, see `Modifying Account Settings `__ in the *Amazon ECS Developer Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ecs/update-container-agent.rst awscli-1.18.69/awscli/examples/ecs/update-container-agent.rst --- awscli-1.11.13/awscli/examples/ecs/update-container-agent.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/update-container-agent.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,22 +1,22 @@ **To update the container agent on an Amazon ECS container instance** -This example command updates the container agent on the container instance ``a3e98c65-2a40-4452-a63c-62beb4d9be9b`` in the default cluster. +The following ``update-container-agent`` example updates the container agent on the specified container instance in the default cluster. :: -Command:: - - aws ecs update-container-agent --cluster default --container-instance a3e98c65-2a40-4452-a63c-62beb4d9be9b + aws ecs update-container-agent --cluster default --container-instance a1b2c3d4-5678-90ab-cdef-11111EXAMPLE Output:: - { - "containerInstance": { - "status": "ACTIVE", - ... - "agentUpdateStatus": "PENDING", - "versionInfo": { - "agentVersion": "1.0.0", - "agentHash": "4023248", - "dockerVersion": "DockerVersion: 1.5.0" - } - } - } \ No newline at end of file + { + "containerInstance": { + "status": "ACTIVE", + ... + "agentUpdateStatus": "PENDING", + "versionInfo": { + "agentVersion": "1.0.0", + "agentHash": "4023248", + "dockerVersion": "DockerVersion: 1.5.0" + } + } + } + +For more information, see `Updating the Amazon ECS Container Agent `_ in the *Amazon ECS Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/ecs/update-container-instances-state.rst awscli-1.18.69/awscli/examples/ecs/update-container-instances-state.rst --- awscli-1.11.13/awscli/examples/ecs/update-container-instances-state.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/update-container-instances-state.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,269 @@ +**To update the state of a container instance** + +The following ``update-container-instances-state`` updates the state of the specified container instance to ``DRAINING`` which will remove it from the cluster is it registered to. :: + + aws ecs update-container-instances-state \ + --container-instances 765936fadbdd46b5991a4bd70c2a43d4 \ + --status DRAINING + +Output:: + + { + "containerInstances": [ + { + "containerInstanceArn": "arn:aws:ecs:us-west-2:130757420319:container-instance/default/765936fadbdd46b5991a4bd70c2a43d4", + "ec2InstanceId": "i-013d87ffbb4d513bf", + "version": 4390, + "versionInfo": { + "agentVersion": "1.29.0", + "agentHash": "a190a73f", + "dockerVersion": "DockerVersion:18.06.1-ce" + }, + "remainingResources": [ + { + "name": "CPU", + "type": "INTEGER", + "doubleValue": 0, + "longValue": 0, + "integerValue": 1536 + }, + { + "name": "MEMORY", + "type": "INTEGER", + "doubleValue": 0, + "longValue": 0, + "integerValue": 2681 + }, + { + "name": "PORTS", + "type": "STRINGSET", + "doubleValue": 0, + "longValue": 0, + "integerValue": 0, + "stringSetValue": [ + "22", + "2376", + "2375", + "51678", + "51679" + ] + }, + { + "name": "PORTS_UDP", + "type": "STRINGSET", + "doubleValue": 0, + "longValue": 0, + "integerValue": 0, + "stringSetValue": [] + } + ], + "registeredResources": [ + { + "name": "CPU", + "type": "INTEGER", + "doubleValue": 0, + "longValue": 0, + "integerValue": 2048 + }, + { + "name": "MEMORY", + "type": "INTEGER", + "doubleValue": 0, + "longValue": 0, + "integerValue": 3705 + }, + { + "name": "PORTS", + "type": "STRINGSET", + "doubleValue": 0, + "longValue": 0, + "integerValue": 0, + "stringSetValue": [ + "22", + "2376", + "2375", + "51678", + "51679" + ] + }, + { + "name": "PORTS_UDP", + "type": "STRINGSET", + "doubleValue": 0, + "longValue": 0, + "integerValue": 0, + "stringSetValue": [] + } + ], + "status": "DRAINING", + "agentConnected": true, + "runningTasksCount": 2, + "pendingTasksCount": 0, + "attributes": [ + { + "name": "ecs.capability.secrets.asm.environment-variables" + }, + { + "name": "ecs.capability.branch-cni-plugin-version", + "value": "e0703516-" + }, + { + "name": "ecs.ami-id", + "value": "ami-00e0090ac21971297" + }, + { + "name": "ecs.capability.secrets.asm.bootstrap.log-driver" + }, + { + "name": "com.amazonaws.ecs.capability.logging-driver.none" + }, + { + "name": "ecs.capability.ecr-endpoint" + }, + { + "name": "ecs.capability.docker-plugin.local" + }, + { + "name": "ecs.capability.task-cpu-mem-limit" + }, + { + "name": "ecs.capability.secrets.ssm.bootstrap.log-driver" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.30" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.31" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.32" + }, + { + "name": "ecs.availability-zone", + "value": "us-west-2c" + }, + { + "name": "ecs.capability.aws-appmesh" + }, + { + "name": "com.amazonaws.ecs.capability.logging-driver.awslogs" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.24" + }, + { + "name": "ecs.capability.task-eni-trunking" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.25" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.26" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.27" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.28" + }, + { + "name": "com.amazonaws.ecs.capability.privileged-container" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.29" + }, + { + "name": "ecs.cpu-architecture", + "value": "x86_64" + }, + { + "name": "com.amazonaws.ecs.capability.ecr-auth" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.20" + }, + { + "name": "ecs.os-type", + "value": "linux" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.21" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.22" + }, + { + "name": "ecs.capability.task-eia" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.23" + }, + { + "name": "ecs.capability.private-registry-authentication.secretsmanager" + }, + { + "name": "com.amazonaws.ecs.capability.logging-driver.syslog" + }, + { + "name": "com.amazonaws.ecs.capability.logging-driver.json-file" + }, + { + "name": "ecs.capability.execution-role-awslogs" + }, + { + "name": "ecs.vpc-id", + "value": "vpc-1234" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.17" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.18" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.19" + }, + { + "name": "ecs.capability.task-eni" + }, + { + "name": "ecs.capability.execution-role-ecr-pull" + }, + { + "name": "ecs.capability.container-health-check" + }, + { + "name": "ecs.subnet-id", + "value": "subnet-1234" + }, + { + "name": "ecs.instance-type", + "value": "c5.large" + }, + { + "name": "com.amazonaws.ecs.capability.task-iam-role-network-host" + }, + { + "name": "ecs.capability.container-ordering" + }, + { + "name": "ecs.capability.cni-plugin-version", + "value": "91ccefc8-2019.06.0" + }, + { + "name": "ecs.capability.pid-ipc-namespace-sharing" + }, + { + "name": "ecs.capability.secrets.ssm.environment-variables" + }, + { + "name": "com.amazonaws.ecs.capability.task-iam-role" + } + ], + "registeredAt": 1560788724.507, + "attachments": [], + "tags": [] + } + ], + "failures": [] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ecs/update-service-primary-task-set.rst awscli-1.18.69/awscli/examples/ecs/update-service-primary-task-set.rst --- awscli-1.11.13/awscli/examples/ecs/update-service-primary-task-set.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/update-service-primary-task-set.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,44 @@ +**To update the primary task set for a service** + +The following ``update-service-primary-task-set`` example updates the primary task set for the specified service. :: + + aws ecs update-service-primary-task-set \ + --cluster MyCluster \ + --service MyService \ + --primary-task-set arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789 + +Output:: + + { + "taskSet": { + "id": "ecs-svc/1234567890123456789", + "taskSetArn": "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789", + "status": "PRIMARY", + "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sample-fargate:2", + "computedDesiredCount": 1, + "pendingCount": 0, + "runningCount": 0, + "createdAt": 1557128360.711, + "updatedAt": 1557129412.653, + "launchType": "EC2", + "networkConfiguration": { + "awsvpcConfiguration": { + "subnets": [ + "subnet-12344321" + ], + "securityGroups": [ + "sg-12344312" + ], + "assignPublicIp": "DISABLED" + } + }, + "loadBalancers": [], + "serviceRegistries": [], + "scale": { + "value": 50.0, + "unit": "PERCENT" + }, + "stabilityStatus": "STABILIZING", + "stabilityStatusAt": 1557129279.914 + } + } diff -Nru awscli-1.11.13/awscli/examples/ecs/update-service.rst awscli-1.18.69/awscli/examples/ecs/update-service.rst --- awscli-1.11.13/awscli/examples/ecs/update-service.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/update-service.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,15 +1,13 @@ -**To change the task definition used in a service** +**Example 1: To change the task definition used in a service** -This example command updates the ``my-http-service`` service to use the ``amazon-ecs-sample`` task definition. +The following ``update-service`` example updates the ``my-http-service`` service to use the ``amazon-ecs-sample`` task definition. :: -Command:: + aws ecs update-service --service my-http-service --task-definition amazon-ecs-sample - aws ecs update-service --service my-http-service --task-definition amazon-ecs-sample +**Example 2: To change the number of tasks in a service** -**To change the number of tasks in a service** +The following ``update-service`` example updates the desired task count of the service ``my-http-service`` to 3. :: -This example command updates the desired count of the ``my-http-service`` service to 10. + aws ecs update-service --service my-http-service --desired-count 3 -Command:: - - aws ecs update-service --service my-http-service --desired-count 10 \ No newline at end of file +For more information, see `Updating a Service `_ in the *Amazon ECS Developer Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ecs/update-task-set.rst awscli-1.18.69/awscli/examples/ecs/update-task-set.rst --- awscli-1.11.13/awscli/examples/ecs/update-task-set.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/update-task-set.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,45 @@ +**To update a task set** + +The following ``update-task-set`` example updates a task set to adjust the scale. :: + + aws ecs update-task-set \ + --cluster MyCluster \ + --service MyService \ + --task-set arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789 \ + --scale value=50,unit=PERCENT + +Output:: + + { + "taskSet": { + "id": "ecs-svc/1234567890123456789", + "taskSetArn": "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789", + "status": "ACTIVE", + "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sample-fargate:2", + "computedDesiredCount": 0, + "pendingCount": 0, + "runningCount": 0, + "createdAt": 1557128360.711, + "updatedAt": 1557129279.914, + "launchType": "EC2", + "networkConfiguration": { + "awsvpcConfiguration": { + "subnets": [ + "subnet-12344321" + ], + "securityGroups": [ + "sg-12344321" + ], + "assignPublicIp": "DISABLED" + } + }, + "loadBalancers": [], + "serviceRegistries": [], + "scale": { + "value": 50.0, + "unit": "PERCENT" + }, + "stabilityStatus": "STABILIZING", + "stabilityStatusAt": 1557129279.914 + } + } diff -Nru awscli-1.11.13/awscli/examples/ecs/wait/services-stable.rst awscli-1.18.69/awscli/examples/ecs/wait/services-stable.rst --- awscli-1.11.13/awscli/examples/ecs/wait/services-stable.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ecs/wait/services-stable.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,15 @@ +**Example 1: To pause running until a service is confirmed to be stable** + +The following ``wait`` example pauses and continues only after it can confirm that the specified service running on the specified cluster is stable. There is no output. :: + + aws ecs wait services-stable \ + --cluster MyCluster \ + --services MyService + +**Example 2: To pause running until a task is confirmed to be running** + +The following ``wait`` example pauses and continues only after the specified task enters a ``RUNNING`` state. :: + + aws ecs wait services-stable \ + --cluster MyCluster \ + --tasks arn:aws:ecs:us-west-2:123456789012:task/a1b2c3d4-5678-90ab-cdef-44444EXAMPLE \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/eks/create-cluster.rst awscli-1.18.69/awscli/examples/eks/create-cluster.rst --- awscli-1.11.13/awscli/examples/eks/create-cluster.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/eks/create-cluster.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,89 @@ +**To create a new cluster** + +This example command creates a cluster named ``prod`` in your default region. + +Command:: + + aws eks create-cluster --name prod \ + --role-arn arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-J7ONKE3BQ4PI \ + --resources-vpc-config subnetIds=subnet-6782e71e,subnet-e7e761ac,securityGroupIds=sg-6979fe18 + +Output:: + + { + "cluster": { + "name": "prod", + "arn": "arn:aws:eks:us-west-2:012345678910:cluster/prod", + "createdAt": 1527808069.147, + "version": "1.10", + "roleArn": "arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-J7ONKE3BQ4PI", + "resourcesVpcConfig": { + "subnetIds": [ + "subnet-6782e71e", + "subnet-e7e761ac" + ], + "securityGroupIds": [ + "sg-6979fe18" + ], + "vpcId": "vpc-950809ec" + }, + "status": "CREATING", + "certificateAuthority": {} + } + } + +**To create a new cluster with private endpoint access and logging enabled** + +This example command creates a cluster named ``example`` in your default region with public endpoint access disabled, private endpoint access enabled, and all logging types enabled. + +Command:: + + aws eks create-cluster --name example --kubernetes-version 1.12 \ + --role-arn arn:aws:iam::012345678910:role/example-cluster-ServiceRole-1XWBQWYSFRE2Q \ + --resources-vpc-config subnetIds=subnet-0a188dccd2f9a632f,subnet-09290d93da4278664,subnet-0f21dd86e0e91134a,subnet-0173dead68481a583,subnet-051f70a57ed6fcab6,subnet-01322339c5c7de9b4,securityGroupIds=sg-0c5b580845a031c10,endpointPublicAccess=false,endpointPrivateAccess=true \ + --logging '{"clusterLogging":[{"types":["api","audit","authenticator","controllerManager","scheduler"],"enabled":true}]}' + +Output:: + + { + "cluster": { + "name": "example", + "arn": "arn:aws:eks:us-west-2:012345678910:cluster/example", + "createdAt": 1565804921.901, + "version": "1.12", + "roleArn": "arn:aws:iam::012345678910:role/example-cluster-ServiceRole-1XWBQWYSFRE2Q", + "resourcesVpcConfig": { + "subnetIds": [ + "subnet-0a188dccd2f9a632f", + "subnet-09290d93da4278664", + "subnet-0f21dd86e0e91134a", + "subnet-0173dead68481a583", + "subnet-051f70a57ed6fcab6", + "subnet-01322339c5c7de9b4" + ], + "securityGroupIds": [ + "sg-0c5b580845a031c10" + ], + "vpcId": "vpc-0f622c01f68d4afec", + "endpointPublicAccess": false, + "endpointPrivateAccess": true + }, + "logging": { + "clusterLogging": [ + { + "types": [ + "api", + "audit", + "authenticator", + "controllerManager", + "scheduler" + ], + "enabled": true + } + ] + }, + "status": "CREATING", + "certificateAuthority": {}, + "platformVersion": "eks.3" + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/eks/delete-cluster.rst awscli-1.18.69/awscli/examples/eks/delete-cluster.rst --- awscli-1.11.13/awscli/examples/eks/delete-cluster.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/eks/delete-cluster.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,7 @@ +**To delete a cluster** + +This example command deletes a cluster named ``devel`` in your default region. + +Command:: + + aws eks delete-cluster --name devel diff -Nru awscli-1.11.13/awscli/examples/eks/describe-cluster.rst awscli-1.18.69/awscli/examples/eks/describe-cluster.rst --- awscli-1.11.13/awscli/examples/eks/describe-cluster.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/eks/describe-cluster.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,34 @@ +**To describe a cluster** + +This example command provides a description of the specified cluster in your default region. + +Command:: + + aws eks describe-cluster --name devel + +Output:: + + { + "cluster": { + "name": "devel", + "arn": "arn:aws:eks:us-west-2:012345678910:cluster/devel", + "createdAt": 1527807879.988, + "version": "1.10", + "endpoint": "https://EXAMPLE0A04F01705DD065655C30CC3D.yl4.us-west-2.eks.amazonaws.com", + "roleArn": "arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-J7ONKE3BQ4PI", + "resourcesVpcConfig": { + "subnetIds": [ + "subnet-6782e71e", + "subnet-e7e761ac" + ], + "securityGroupIds": [ + "sg-6979fe18" + ], + "vpcId": "vpc-950809ec" + }, + "status": "ACTIVE", + "certificateAuthority": { + "data": "EXAMPLECRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUN5RENDQWJDZ0F3SUJBZ0lCQURBTkJna3Foa2lHOXcwQkFRc0ZBREFWTVJNd0VRWURWUVFERXdwcmRXSmwKY201bGRHVnpNQjRYRFRFNE1EVXpNVEl6TVRFek1Wb1hEVEk0TURVeU9ESXpNVEV6TVZvd0ZURVRNQkVHQTFVRQpBeE1LYTNWaVpYSnVaWFJsY3pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBTTZWCjVUaG4rdFcySm9Xa2hQMzRlVUZMNitaRXJOZGIvWVdrTmtDdWNGS2RaaXl2TjlMVmdvUmV2MjlFVFZlN1ZGbSsKUTJ3ZURyRXJiQyt0dVlibkFuN1ZLYmE3ay9hb1BHekZMdmVnb0t6b0M1N2NUdGVwZzRIazRlK2tIWHNaME10MApyb3NzcjhFM1ROeExETnNJTThGL1cwdjhsTGNCbWRPcjQyV2VuTjFHZXJnaDNSZ2wzR3JIazBnNTU0SjFWenJZCm9hTi8zODFUczlOTFF2QTBXb0xIcjBFRlZpTFdSZEoyZ3lXaC9ybDVyOFNDOHZaQXg1YW1BU0hVd01aTFpWRC8KTDBpOW4wRVM0MkpVdzQyQmxHOEdpd3NhTkJWV3lUTHZKclNhRXlDSHFtVVZaUTFDZkFXUjl0L3JleVVOVXM3TApWV1FqM3BFbk9RMitMSWJrc0RzQ0F3RUFBYU1qTUNFd0RnWURWUjBQQVFIL0JBUURBZ0trTUE4R0ExVWRFd0VCCi93UUZNQU1CQWY4d0RRWUpLb1pJaHZjTkFRRUxCUUFEZ2dFQkFNZ3RsQ1dIQ2U2YzVHMXl2YlFTS0Q4K2hUalkKSm1NSG56L2EvRGt0WG9YUjFVQzIrZUgzT1BZWmVjRVZZZHVaSlZCckNNQ2VWR0ZkeWdBYlNLc1FxWDg0S2RXbAp1MU5QaERDSmEyRHliN2pVMUV6VThTQjFGZUZ5ZFE3a0hNS1E1blpBRVFQOTY4S01hSGUrSm0yQ2x1UFJWbEJVCjF4WlhTS1gzTVZ0K1Q0SU1EV2d6c3JRSjVuQkRjdEtLcUZtM3pKdVVubHo5ZEpVckdscEltMjVJWXJDckxYUFgKWkUwRUtRNWEzMHhkVWNrTHRGQkQrOEtBdFdqSS9yZUZPNzM1YnBMdVoyOTBaNm42QlF3elRrS0p4cnhVc3QvOAppNGsxcnlsaUdWMm5SSjBUYjNORkczNHgrYWdzYTRoSTFPbU90TFM0TmgvRXJxT3lIUXNDc2hEQUtKUT0KLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQo=" + } + } + } diff -Nru awscli-1.11.13/awscli/examples/eks/describe-update.rst awscli-1.18.69/awscli/examples/eks/describe-update.rst --- awscli-1.11.13/awscli/examples/eks/describe-update.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/eks/describe-update.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,30 @@ +**To describe an update for a cluster** + +This example command describes an update for a cluster named ``example`` in your default region. + +Command:: + + aws eks describe-update --name example \ + --update-id 10bddb13-a71b-425a-b0a6-71cd03e59161 + +Output:: + + { + "update": { + "id": "10bddb13-a71b-425a-b0a6-71cd03e59161", + "status": "Successful", + "type": "EndpointAccessUpdate", + "params": [ + { + "type": "EndpointPublicAccess", + "value": "true" + }, + { + "type": "EndpointPrivateAccess", + "value": "false" + } + ], + "createdAt": 1565806691.149, + "errors": [] + } + } diff -Nru awscli-1.11.13/awscli/examples/eks/get-token.rst awscli-1.18.69/awscli/examples/eks/get-token.rst --- awscli-1.11.13/awscli/examples/eks/get-token.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/eks/get-token.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To get a cluster authentication token** + +This example command gets an authentication token for a cluster named ``example``. + +Command:: + + aws eks get-token --cluster-name example + +Output:: + + { + "kind": "ExecCredential", + "apiVersion": "client.authentication.k8s.io/v1alpha1", + "spec": {}, + "status": { + "expirationTimestamp": "2019-08-14T18:44:27Z", + "token": "k8s-aws-v1EXAMPLE_TOKEN_DATA_STRING..." + } + } diff -Nru awscli-1.11.13/awscli/examples/eks/list-clusters.rst awscli-1.18.69/awscli/examples/eks/list-clusters.rst --- awscli-1.11.13/awscli/examples/eks/list-clusters.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/eks/list-clusters.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,16 @@ +**To list your available clusters** + +This example command lists all of your available clusters in your default region. + +Command:: + + aws eks list-clusters + +Output:: + + { + "clusters": [ + "devel", + "prod" + ] + } diff -Nru awscli-1.11.13/awscli/examples/eks/list-updates.rst awscli-1.18.69/awscli/examples/eks/list-updates.rst --- awscli-1.11.13/awscli/examples/eks/list-updates.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/eks/list-updates.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,15 @@ +**To list the updates for a cluster** + +This example command lists the current updates for a cluster named ``example`` in your default region. + +Command:: + + aws eks list-updates --name example + +Output:: + + { + "updateIds": [ + "10bddb13-a71b-425a-b0a6-71cd03e59161" + ] + } diff -Nru awscli-1.11.13/awscli/examples/eks/update-cluster-config.rst awscli-1.18.69/awscli/examples/eks/update-cluster-config.rst --- awscli-1.11.13/awscli/examples/eks/update-cluster-config.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/eks/update-cluster-config.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,57 @@ +**To update cluster endpoint access** + +This example command updates a cluster to disable endpoint public access and enable private endpoint access. + +Command:: + + aws eks update-cluster-config --name example \ + --resources-vpc-config endpointPublicAccess=false,endpointPrivateAccess=true + +Output:: + + { + "update": { + "id": "ec883c93-2e9e-407c-a22f-8f6fa6e67d4f", + "status": "InProgress", + "type": "EndpointAccessUpdate", + "params": [ + { + "type": "EndpointPublicAccess", + "value": "false" + }, + { + "type": "EndpointPrivateAccess", + "value": "true" + } + ], + "createdAt": 1565806986.506, + "errors": [] + } + } + +**To enable logging for a cluster** + +This example command enables all cluster control plane logging types for a cluster named ``example``. + +Command:: + + aws eks update-cluster-config --name example \ + --logging '{"clusterLogging":[{"types":["api","audit","authenticator","controllerManager","scheduler"],"enabled":true}]}' + +Output:: + + { + "update": { + "id": "7551c64b-1d27-4b1e-9f8e-c45f056eb6fd", + "status": "InProgress", + "type": "LoggingUpdate", + "params": [ + { + "type": "ClusterLogging", + "value": "{\"clusterLogging\":[{\"types\":[\"api\",\"audit\",\"authenticator\",\"controllerManager\",\"scheduler\"],\"enabled\":true}]}" + } + ], + "createdAt": 1565807210.37, + "errors": [] + } + } diff -Nru awscli-1.11.13/awscli/examples/eks/update-cluster-version.rst awscli-1.18.69/awscli/examples/eks/update-cluster-version.rst --- awscli-1.11.13/awscli/examples/eks/update-cluster-version.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/eks/update-cluster-version.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,29 @@ +**To update a cluster Kubernetes version** + +This example command updates a cluster named ``example`` from Kubernetes 1.12 to 1.13. + +Command:: + + aws eks update-cluster-version --name example --kubernetes-version 1.13 + +Output:: + + { + "update": { + "id": "161a74d1-7e8c-4224-825d-b32af149f23a", + "status": "InProgress", + "type": "VersionUpdate", + "params": [ + { + "type": "Version", + "value": "1.13" + }, + { + "type": "PlatformVersion", + "value": "eks.2" + } + ], + "createdAt": 1565807633.514, + "errors": [] + } + } diff -Nru awscli-1.11.13/awscli/examples/eks/update-kubeconfig/_description.rst awscli-1.18.69/awscli/examples/eks/update-kubeconfig/_description.rst --- awscli-1.11.13/awscli/examples/eks/update-kubeconfig/_description.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/eks/update-kubeconfig/_description.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +Configures kubectl so that you can connect to an Amazon EKS cluster. + +Note: + To use the resulting configuration, you must have kubectl installed and in your PATH environment variable. + +This command constructs a configuration with prepopulated server and certificate authority data values for a specified cluster. +You can specify an IAM role ARN with the --role-arn option to use for authentication when you issue kubectl commands. +Otherwise, the IAM entity in your default AWS CLI or SDK credential chain is used. +You can view your default AWS CLI or SDK identity by running the ``aws sts get-caller-identity`` command. + +The resulting kubeconfig is created as a new file or merged with an existing kubeconfig file using the following logic: + +* If you specify a path with the --kubeconfig option, then the resulting configuration file is created there or merged with an existing kubeconfig at that location. +* Or, if you have the KUBECONFIG environment variable set, then the resulting configuration file is created at the first entry in that variable or merged with an existing kubeconfig at that location. +* Otherwise, by default, the resulting configuration file is created at the default kubeconfig path (.kube/config) in your home directory or merged with an existing kubeconfig at that location. +* If a previous cluster configuration exists for an Amazon EKS cluster with the same name at the specified path, the existing configuration is overwritten with the new configuration. +* When update-kubeconfig writes a configuration to a kubeconfig file, the current-context of the kubeconfig file is set to that configuration. + +You can use the --dry-run option to print the resulting configuration to stdout instead of writing it to the specified location. diff -Nru awscli-1.11.13/awscli/examples/eks/update-kubeconfig.rst awscli-1.18.69/awscli/examples/eks/update-kubeconfig.rst --- awscli-1.11.13/awscli/examples/eks/update-kubeconfig.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/eks/update-kubeconfig.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To update a kubeconfig for your cluster** + +This example command updates the default kubeconfig file to use your cluster as the current context. + +Command:: + + aws eks update-kubeconfig --name example + +Output:: + + Added new context arn:aws:eks:us-west-2:012345678910:cluster/example to /Users/ericn/.kube/config \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/eks/wait.rst awscli-1.18.69/awscli/examples/eks/wait.rst --- awscli-1.11.13/awscli/examples/eks/wait.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/eks/wait.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,16 @@ +**To wait for a cluster to become active** + +This example command waits for a cluster named ``example`` to become active. + +Command:: + + aws eks wait cluster-active --name example + +**To wait for a cluster to be deleted** + +This example command waits for a cluster named ``example`` to be deleted. + +Command:: + + aws eks wait cluster-deleted --name example + diff -Nru awscli-1.11.13/awscli/examples/elasticache/add-tags-to-resource.rst awscli-1.18.69/awscli/examples/elasticache/add-tags-to-resource.rst --- awscli-1.11.13/awscli/examples/elasticache/add-tags-to-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/elasticache/add-tags-to-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,24 @@ +**To add tags to a resource** + +The following ``add-tags-to-resource`` example adds up to 10 tags, key-value pairs, to a cluster or snapshot resource. :: + + aws elasticache add-tags-to-resource \ + -- resource name "arn:aws:elasticache:us-east-1:1234567890:cluster:my-mem-cluster" \ + -- tags -- '{"20150202":15, "ElastiCache":"Service"}' + +Output:: + + { + "TagList": [ + { + "Value": "20150202", + "Key": "APIVersion" + }, + { + "Value": "ElastiCache", + "Key": "Service" + } + ] + } + +For more information, see `Monitoring Costs with Cost Allocation Tags `__ in the *Elasticache User Guide*. diff -Nru awscli-1.11.13/awscli/examples/elasticache/authorize-cache-security-group-ingress.rst awscli-1.18.69/awscli/examples/elasticache/authorize-cache-security-group-ingress.rst --- awscli-1.11.13/awscli/examples/elasticache/authorize-cache-security-group-ingress.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/elasticache/authorize-cache-security-group-ingress.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,12 @@ +**To authorize cache security group ingress** + +The following ''authorize-cache-security-group-ingress'' example allows network ingress to a cache security group. :: + + aws elasticache authorize-cache-security-group-ingress \ + --cache-security-group-name "my-sec-grp" \ + --ec2-security-group-name "my-ec2-sec-grp" \ + --ec2-security-group-owner-id "1234567890" + +This command produces no output. + +For more information, see 'Self-Service Updates in Amazon ElastiCache '__ in the *Elasticache User Guide*. diff -Nru awscli-1.11.13/awscli/examples/elasticache/copy-snapshot.rst awscli-1.18.69/awscli/examples/elasticache/copy-snapshot.rst --- awscli-1.11.13/awscli/examples/elasticache/copy-snapshot.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/elasticache/copy-snapshot.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,42 @@ +**To copy a snapshot** + +The following ``copy-snapshot`` example makes a copy of an existing snapshot. :: + + aws elasticache copy-snapshot \ + --source-snapshot-name "my-snapshot" \ + --target-snapshot-name "my-snapshot-copy" + +Output:: + + { + "Snapshot":{ + "Engine": "redis", + "CacheParameterGroupName": "default.redis3.2", + "VpcId": "vpc-3820329f3", + "CacheClusterId": "my-redis4", + "SnapshotRetentionLimit": 7, + "NumCacheNodes": 1, + "SnapshotName": "my-snapshot-copy", + "CacheClusterCreateTime": "2016-12-21T22:24:04.955Z", + "AutoMinorVersionUpgrade": true, + "PreferredAvailabilityZone": "us-east-1c", + "SnapshotStatus": "creating", + "SnapshotSource": "manual", + "SnapshotWindow": "07:00-08:00", + "EngineVersion": "3.2.4", + "NodeSnapshots": [ + { + "CacheSize": "3 MB", + "SnapshotCreateTime": "2016-12-28T07:00:52Z", + "CacheNodeId": "0001", + "CacheNodeCreateTime": "2016-12-21T22:24:04.955Z" + } + ], + "CacheSubnetGroupName": "default", + "Port": 6379, + "PreferredMaintenanceWindow": "tue:09:30-tue:10:30", + "CacheNodeType": "cache.m3.large" + } + } + +For more information, see `Exporting a Backup `__ in the *Elasticache User Guide*. diff -Nru awscli-1.11.13/awscli/examples/elasticache/create-cache-cluster.rst awscli-1.18.69/awscli/examples/elasticache/create-cache-cluster.rst --- awscli-1.11.13/awscli/examples/elasticache/create-cache-cluster.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/elasticache/create-cache-cluster.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,39 @@ +**To create a cache cluster** + +The following ``create-cache-cluster`` example creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached or Redis. :: + + aws elasticache create-cache-cluster \ + --cache-cluster-id my-redis-cluster \ + --engine "redis" \ + --cache-node-type cache.m5.large \ + --num-cache-nodes 1 + +Output:: + + { + "CacheCluster": { + "CacheClusterId": "my-memcached-cluster", + "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", + "CacheNodeType": "cache.m5.large", + "Engine": "redis", + "EngineVersion": "5.0.5", + "CacheClusterStatus": "creating", + "NumCacheNodes": 1, + "PreferredMaintenanceWindow": "sat:10:00-sat:11:00", + "PendingModifiedValues": {}, + "CacheSecurityGroups": [], + "CacheParameterGroup": { + "CacheParameterGroupName": "default.redis5.0", + "ParameterApplyStatus": "in-sync", + "CacheNodeIdsToReboot": [] + }, + "CacheSubnetGroupName": "default", + "AutoMinorVersionUpgrade": true, + "SnapshotRetentionLimit": 0, + "SnapshotWindow": "07:00-08:00", + "TransitEncryptionEnabled": false, + "AtRestEncryptionEnabled": false + } + } + +For more information, see `Creating a Cluster `__ in the *Elasticache User Guide*. diff -Nru awscli-1.11.13/awscli/examples/elasticache/create-cache-parameter-group.rst awscli-1.18.69/awscli/examples/elasticache/create-cache-parameter-group.rst --- awscli-1.11.13/awscli/examples/elasticache/create-cache-parameter-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/elasticache/create-cache-parameter-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,20 @@ +**To create a cache parameter group** + +The following ``create-cache-parameter-group`` example creates a new Amazon ElastiCache cache parameter group. :: + + aws elasticache create-cache-parameter-group \ + --cache-parameter-group-family "redis5.0" \ + --cache-parameter-group-name "mygroup" \ + --description "mygroup" + +Output:: + + { + "CacheParameterGroup": { + "CacheParameterGroupName": "mygroup", + "CacheParameterGroupFamily": "redis5.0", + "Description": "my group" + } + } + +For more information, see `Creating a Parameter Group `__ in the *Elasticache User Guide*. diff -Nru awscli-1.11.13/awscli/examples/elasticache/create-cache-subnet-group.rst awscli-1.18.69/awscli/examples/elasticache/create-cache-subnet-group.rst --- awscli-1.11.13/awscli/examples/elasticache/create-cache-subnet-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/elasticache/create-cache-subnet-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,28 @@ +**To create a cache subnet group** + +The following ``create-cache-subnet-group`` example creates a new cache subnet group. :: + + aws elasticache create-cache-subnet-group \ + --cache-subnet-group-name "mygroup" \ + --cache-subnet-group-description "my subnet group" \ + --subnet-ids "subnet-xxxxec4f" + +Output:: + + { + "CacheSubnetGroup": { + "CacheSubnetGroupName": "mygroup", + "CacheSubnetGroupDescription": "my subnet group", + "VpcId": "vpc-a3e97cdb", + "Subnets": [ + { + "SubnetIdentifier": "subnet-xxxxec4f", + "SubnetAvailabilityZone": { + "Name": "us-west-2d" + } + } + ] + } + } + +For more information, see `Creating a Cache Subnet Group `__ in the *Elasticache User Guide*. diff -Nru awscli-1.11.13/awscli/examples/elasticache/create-replication-group.rst awscli-1.18.69/awscli/examples/elasticache/create-replication-group.rst --- awscli-1.11.13/awscli/examples/elasticache/create-replication-group.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/elasticache/create-replication-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,16 +1,32 @@ -**To create an Amazon ElastiCache Replication Group** - -The following ``create-replication-group`` command launches a new Amazon ElastiCache Redis replication group:: - - aws elasticache create-replication-group --replication-group-id myRedis \ - --replication-group-description "desc of myRedis" \ - --automatic-failover-enabled --num-cache-clusters 3 \ - --cache-node-type cache.m3.medium \ - --engine redis --engine-version 2.8.24 \ - --cache-parameter-group-name default.redis2.8 \ - --cache-subnet-group-name default --security-group-ids sg-12345678 - -In the preceding example, the replication group is created with 3 clusters(primary plus 2 replicas) and has a cache node class of cach3.m3.medium. -With `--automatic-failover-enabled` option, Multi-AZ and automatic failover are enabled. - -This command output a JSON block that indicates that the replication group was created. +**To create a replication group** + +The following ``create-replication-group`` example creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group. This operation is valid for Redis only. :: + + aws elasticache create-replication-group \ + --replication-group-id "mygroup" \ + --replication-group-description "my group" \ + --engine "redis" \ + --cache-node-type "cache.m5.large" + +Output:: + + { + "ReplicationGroup": { + "ReplicationGroupId": "mygroup", + "Description": "my group", + "Status": "creating", + "PendingModifiedValues": {}, + "MemberClusters": [ + "mygroup-001" + ], + "AutomaticFailover": "disabled", + "SnapshotRetentionLimit": 0, + "SnapshotWindow": "06:00-07:00", + "ClusterEnabled": false, + "CacheNodeType": "cache.m5.large", + "TransitEncryptionEnabled": false, + "AtRestEncryptionEnabled": false + } + } + +For more information, see `Creating a Redis Replication Group `__ in the *Elasticache User Guide*. diff -Nru awscli-1.11.13/awscli/examples/elasticache/decrease-replica-count.rst awscli-1.18.69/awscli/examples/elasticache/decrease-replica-count.rst --- awscli-1.11.13/awscli/examples/elasticache/decrease-replica-count.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/elasticache/decrease-replica-count.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,90 @@ +**To decrease replica count** + +The following ``decrease-replica-count`` example dynamically decreases the number of replics in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster downtime. :: + + aws elasticache decrease-replica-count \ + --replication-group-id my-cluster \ + --apply-immediately \ + --new-replica-count 2 + +Output:: + + { + "ReplicationGroup": { + "ReplicationGroupId": "my-cluster", + "Description": " ", + "Status": "modifying", + "PendingModifiedValues": {}, + "MemberClusters": [ + "myrepliace", + "my-cluster-001", + "my-cluster-002", + "my-cluster-003" + ], + "NodeGroups": [ + { + "NodeGroupId": "0001", + "Status": "modifying", + "PrimaryEndpoint": { + "Address": "my-cluster.xxxxx.ng.0001.usw2.cache.amazonaws.com", + "Port": 6379 + }, + "ReaderEndpoint": { + "Address": "my-cluster-ro.xxxxx.ng.0001.usw2.cache.amazonaws.com", + "Port": 6379 + }, + "NodeGroupMembers": [ + { + "CacheClusterId": "myrepliace", + "CacheNodeId": "0001", + "ReadEndpoint": { + "Address": "myrepliace.xxxxx.0001.usw2.cache.amazonaws.com", + "Port": 6379 + }, + "PreferredAvailabilityZone": "us-west-2a", + "CurrentRole": "replica" + }, + { + "CacheClusterId": "my-cluster-001", + "CacheNodeId": "0001", + "ReadEndpoint": { + "Address": "my-cluster-001.xxxxx.0001.usw2.cache.amazonaws.com", + "Port": 6379 + }, + "PreferredAvailabilityZone": "us-west-2a", + "CurrentRole": "primary" + }, + { + "CacheClusterId": "my-cluster-002", + "CacheNodeId": "0001", + "ReadEndpoint": { + "Address": "my-cluster-002.xxxxx.0001.usw2.cache.amazonaws.com", + "Port": 6379 + }, + "PreferredAvailabilityZone": "us-west-2a", + "CurrentRole": "replica" + }, + { + "CacheClusterId": "my-cluster-003", + "CacheNodeId": "0001", + "ReadEndpoint": { + "Address": "my-cluster-003.xxxxx.0001.usw2.cache.amazonaws.com", + "Port": 6379 + }, + "PreferredAvailabilityZone": "us-west-2a", + "CurrentRole": "replica" + } + ] + } + ], + "AutomaticFailover": "disabled", + "SnapshotRetentionLimit": 0, + "SnapshotWindow": "07:30-08:30", + "ClusterEnabled": false, + "CacheNodeType": "cache.r5.xlarge", + "TransitEncryptionEnabled": false, + "AtRestEncryptionEnabled": false + } + } + +For more information, see `Changing the Number of Replicas `__ in the *Elasticache User Guide*. diff -Nru awscli-1.11.13/awscli/examples/elasticache/delete-cache-cluster.rst awscli-1.18.69/awscli/examples/elasticache/delete-cache-cluster.rst --- awscli-1.11.13/awscli/examples/elasticache/delete-cache-cluster.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/elasticache/delete-cache-cluster.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,61 @@ +**To delete a cache cluster** + +The following ``delete-cache-cluster`` example deletes the specified previously provisioned cluster. The command deletes all associated cache nodes, node endpoints. and the cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cluster; you can't cancel or revert this operation. + +This operation is not valid for the following: + +* Redis (cluster mode enabled) clusters +* A cluster that is the last read replica of a replication group +* A node group (shard) that has Multi-AZ mode enabled +* A cluster from a Redis (cluster mode enabled) replication group +* A cluster that is not in the available state :: + + aws elasticache delete-cache-cluster \ + --cache-cluster-id "my-cluster-002" + +Output:: + + { + "CacheCluster": { + "CacheClusterId": "my-cluster-002", + "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", + "CacheNodeType": "cache.r5.xlarge", + "Engine": "redis", + "EngineVersion": "5.0.5", + "CacheClusterStatus": "deleting", + "NumCacheNodes": 1, + "PreferredAvailabilityZone": "us-west-2a", + "CacheClusterCreateTime": "2019-11-26T03:35:04.546Z", + "PreferredMaintenanceWindow": "mon:04:05-mon:05:05", + "PendingModifiedValues": {}, + "NotificationConfiguration": { + "TopicArn": "arn:aws:sns:us-west-x:xxxxxxx4152:My_Topic", + "TopicStatus": "active" + }, + "CacheSecurityGroups": [], + "CacheParameterGroup": { + "CacheParameterGroupName": "mygroup", + "ParameterApplyStatus": "in-sync", + "CacheNodeIdsToReboot": [] + }, + "CacheSubnetGroupName": "kxkxk", + "AutoMinorVersionUpgrade": true, + "SecurityGroups": [ + { + "SecurityGroupId": "sg-xxxxxxxxxx9836", + "Status": "active" + }, + { + "SecurityGroupId": "sg-xxxxxxxxxxxx7b", + "Status": "active" + } + ], + "ReplicationGroupId": "my-cluster", + "SnapshotRetentionLimit": 0, + "SnapshotWindow": "07:30-08:30", + "TransitEncryptionEnabled": false, + "AtRestEncryptionEnabled": false + } + } + +For more information, see `Deleting a Cluster `__ in the *Elasticache User Guide*. diff -Nru awscli-1.11.13/awscli/examples/elasticache/delete-cache-parameter-group.rst awscli-1.18.69/awscli/examples/elasticache/delete-cache-parameter-group.rst --- awscli-1.11.13/awscli/examples/elasticache/delete-cache-parameter-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/elasticache/delete-cache-parameter-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a cache parameter group** + +The following ``delete-cache-parameter-group`` example deletes the specified cache parameter group. You can't delete a cache parameter group if it's associated with any cache clusters. :: + + aws elasticache delete-cache-parameter-group \ + --cache-parameter-group-name myparamgroup + +This command produces no output. + +For more information, see `Deleting a Parameter Group `__ in the *Elasticache User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/elasticache/delete-cache-subnet-group.rst awscli-1.18.69/awscli/examples/elasticache/delete-cache-subnet-group.rst --- awscli-1.11.13/awscli/examples/elasticache/delete-cache-subnet-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/elasticache/delete-cache-subnet-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a cache subnet group** + +The following ``delete-cache-subnet-group`` example deletes the specified cache subnet group. You can't delete a cache subnet group if it's associated with any clusters. :: + + aws elasticache delete-cache-subnet-group \ + --cache-subnet-group-name "mygroup" + +This command produces no output. + +For more information, see `Deleting a Subnet Group `__ in the *Elasticache User Guide*. diff -Nru awscli-1.11.13/awscli/examples/elasticache/delete-replication-group.rst awscli-1.18.69/awscli/examples/elasticache/delete-replication-group.rst --- awscli-1.11.13/awscli/examples/elasticache/delete-replication-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/elasticache/delete-replication-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,26 @@ +**To delete a replication group** + +The following ``delete-replication-group`` example deletes the specified replication group. By default, this operation deletes the entire replication group, including the primary or primaries and all of the read replicas. If the replication group has only one primary, you can optionally delete only the read replicas, while keeping the primary by setting ``--retain-primary-cluster``. + +When you get a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you can't cancel or revert this operation. This operation is valid for Redis only. + + aws elasticache delete-replication-group \ + --replication-group-id "mygroup" + +Output:: + + { + "ReplicationGroup": { + "ReplicationGroupId": "mygroup", + "Description": "my group", + "Status": "deleting", + "PendingModifiedValues": {}, + "AutomaticFailover": "disabled", + "SnapshotRetentionLimit": 0, + "SnapshotWindow": "06:00-07:00", + "TransitEncryptionEnabled": false, + "AtRestEncryptionEnabled": false + } + } + +For more information, see `Deleting a Replication Group `__ in the *Elasticache User Guide*. diff -Nru awscli-1.11.13/awscli/examples/elasticache/describe-cache-clusters.rst awscli-1.18.69/awscli/examples/elasticache/describe-cache-clusters.rst --- awscli-1.11.13/awscli/examples/elasticache/describe-cache-clusters.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/elasticache/describe-cache-clusters.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,54 @@ +**To describe a cache cluster** + +The following ``describe-cache-clusters`` example returns information about the specific cache cluster. :: + + aws elasticache describe-cache-clusters \ + --cache-cluster-id "my-cluster-003" + +Output:: + + { + "CacheClusters": [ + { + "CacheClusterId": "my-cluster-003", + "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", + "CacheNodeType": "cache.r5.large", + "Engine": "redis", + "EngineVersion": "5.0.5", + "CacheClusterStatus": "available", + "NumCacheNodes": 1, + "PreferredAvailabilityZone": "us-west-2a", + "CacheClusterCreateTime": "2019-11-26T01:22:52.396Z", + "PreferredMaintenanceWindow": "mon:17:30-mon:18:30", + "PendingModifiedValues": {}, + "NotificationConfiguration": { + "TopicArn": "arn:aws:sns:us-west-2:xxxxxxxxxxx152:My_Topic", + "TopicStatus": "active" + }, + "CacheSecurityGroups": [], + "CacheParameterGroup": { + "CacheParameterGroupName": "default.redis5.0", + "ParameterApplyStatus": "in-sync", + "CacheNodeIdsToReboot": [] + }, + "CacheSubnetGroupName": "kxkxk", + "AutoMinorVersionUpgrade": true, + "SecurityGroups": [ + { + "SecurityGroupId": "sg-xxxxxd7b", + "Status": "active" + } + ], + "ReplicationGroupId": "my-cluster", + "SnapshotRetentionLimit": 0, + "SnapshotWindow": "06:30-07:30", + "AuthTokenEnabled": false, + "TransitEncryptionEnabled": false, + "AtRestEncryptionEnabled": false + } + ] + } + +For more information, see `Viewing a Cluster's Details `__ in the *Elasticache User Guide*. + + diff -Nru awscli-1.11.13/awscli/examples/elasticache/describe-cache-engine-versions.rst awscli-1.18.69/awscli/examples/elasticache/describe-cache-engine-versions.rst --- awscli-1.11.13/awscli/examples/elasticache/describe-cache-engine-versions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/elasticache/describe-cache-engine-versions.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,118 @@ +**To describe a cache engine version** + +The following ``describe-cache-engine-versions`` example returns a list of the available cache engines and their versions. :: + + aws elasticache describe-cache-engine-versions \ + --engine "Redis" + +Output:: + + { + "CacheEngineVersions": [ + { + "Engine": "redis", + "EngineVersion": "2.6.13", + "CacheParameterGroupFamily": "redis2.6", + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 2.6.13" + }, + { + "Engine": "redis", + "EngineVersion": "2.8.19", + "CacheParameterGroupFamily": "redis2.8", + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 2.8.19" + }, + { + "Engine": "redis", + "EngineVersion": "2.8.21", + "CacheParameterGroupFamily": "redis2.8", + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 2.8.21" + }, + { + "Engine": "redis", + "EngineVersion": "2.8.22", + "CacheParameterGroupFamily": "redis2.8", + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 2.8.22" + }, + { + "Engine": "redis", + "EngineVersion": "2.8.23", + "CacheParameterGroupFamily": "redis2.8", + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 2.8.23" + }, + { + "Engine": "redis", + "EngineVersion": "2.8.24", + "CacheParameterGroupFamily": "redis2.8", + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 2.8.24" + }, + { + "Engine": "redis", + "EngineVersion": "2.8.6", + "CacheParameterGroupFamily": "redis2.8", + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 2.8.6" + }, + { + "Engine": "redis", + "EngineVersion": "3.2.10", + "CacheParameterGroupFamily": "redis3.2", + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 3.2.10" + }, + { + "Engine": "redis", + "EngineVersion": "3.2.4", + "CacheParameterGroupFamily": "redis3.2", + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 3.2.4" + }, + { + "Engine": "redis", + "EngineVersion": "3.2.6", + "CacheParameterGroupFamily": "redis3.2", + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 3.2.6" + }, + { + "Engine": "redis", + "EngineVersion": "4.0.10", + "CacheParameterGroupFamily": "redis4.0", + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 4.0.10" + }, + { + "Engine": "redis", + "EngineVersion": "5.0.0", + "CacheParameterGroupFamily": "redis5.0", + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 5.0.0" + }, + { + "Engine": "redis", + "EngineVersion": "5.0.3", + "CacheParameterGroupFamily": "redis5.0", + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 5.0.3" + }, + { + "Engine": "redis", + "EngineVersion": "5.0.4", + "CacheParameterGroupFamily": "redis5.0", + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 5.0.4" + }, + { + "Engine": "redis", + "EngineVersion": "5.0.5", + "CacheParameterGroupFamily": "redis5.0", + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 5.0.5" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/elasticache/describe-cache-parameter-groups.rst awscli-1.18.69/awscli/examples/elasticache/describe-cache-parameter-groups.rst --- awscli-1.11.13/awscli/examples/elasticache/describe-cache-parameter-groups.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/elasticache/describe-cache-parameter-groups.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To describe a cache parameter group** + +The following ``describe-cache-parameter-groups`` example returns a list of cache parameter group descriptions. :: + + aws elasticache describe-cache-parameter-groups \ + --cache-parameter-group-name "mygroup" + +Output:: + + { + "CacheParameterGroups": [ + { + "CacheParameterGroupName": "mygroup", + "CacheParameterGroupFamily": "redis5.0", + "Description": " " + } + ] + } + +For more information, see `Configuring Engine Parameters Using Parameter Groups `__ in the *Elasticache User Guide*. + diff -Nru awscli-1.11.13/awscli/examples/elasticache/describe-cache-parameters.rst awscli-1.18.69/awscli/examples/elasticache/describe-cache-parameters.rst --- awscli-1.11.13/awscli/examples/elasticache/describe-cache-parameters.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/elasticache/describe-cache-parameters.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,640 @@ +**To describe cache parameters** + +The following ''describe-cache-parameters'' example returns the detailed parameter list for the specified cache parameter group. :: + + aws elasticache describe-cache-parameters \ + --cache-parameter-group-name "myparamgroup" + +Output:: + + { + "Parameters": [ + { + "ParameterName": "activedefrag", + "ParameterValue": "yes", + "Description": "Enabled active memory defragmentation", + "Source": "user", + "DataType": "string", + "AllowedValues": "yes,no", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "active-defrag-cycle-max", + "ParameterValue": "75", + "Description": "Maximal effort for defrag in CPU percentage", + "Source": "user", + "DataType": "integer", + "AllowedValues": "1-75", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "active-defrag-cycle-min", + "ParameterValue": "5", + "Description": "Minimal effort for defrag in CPU percentage", + "Source": "user", + "DataType": "integer", + "AllowedValues": "1-75", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "active-defrag-ignore-bytes", + "ParameterValue": "104857600", + "Description": "Minimum amount of fragmentation waste to start active defrag", + "Source": "user", + "DataType": "integer", + "AllowedValues": "1048576-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "active-defrag-max-scan-fields", + "ParameterValue": "1000", + "Description": "Maximum number of set/hash/zset/list fields that will be processed from the main dictionary scan", + "Source": "user", + "DataType": "integer", + "AllowedValues": "1-1000000", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "active-defrag-threshold-lower", + "ParameterValue": "10", + "Description": "Minimum percentage of fragmentation to start active defrag", + "Source": "user", + "DataType": "integer", + "AllowedValues": "1-100", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "active-defrag-threshold-upper", + "ParameterValue": "100", + "Description": "Maximum percentage of fragmentation at which we use maximum effort", + "Source": "user", + "DataType": "integer", + "AllowedValues": "1-100", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "activerehashing", + "ParameterValue": "yes", + "Description": "Apply rehashing or not.", + "Source": "user", + "DataType": "string", + "AllowedValues": "yes,no", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "requires-reboot" + }, + { + "ParameterName": "appendfsync", + "ParameterValue": "everysec", + "Description": "fsync policy for AOF persistence", + "Source": "system", + "DataType": "string", + "AllowedValues": "always,everysec,no", + "IsModifiable": false, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "appendonly", + "ParameterValue": "no", + "Description": "Enable Redis persistence.", + "Source": "system", + "DataType": "string", + "AllowedValues": "yes,no", + "IsModifiable": false, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "client-output-buffer-limit-normal-hard-limit", + "ParameterValue": "0", + "Description": "Normal client output buffer hard limit in bytes.", + "Source": "user", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "client-output-buffer-limit-normal-soft-limit", + "ParameterValue": "0", + "Description": "Normal client output buffer soft limit in bytes.", + "Source": "user", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "client-output-buffer-limit-normal-soft-seconds", + "ParameterValue": "0", + "Description": "Normal client output buffer soft limit in seconds.", + "Source": "user", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "client-output-buffer-limit-pubsub-hard-limit", + "ParameterValue": "33554432", + "Description": "Pubsub client output buffer hard limit in bytes.", + "Source": "user", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "client-output-buffer-limit-pubsub-soft-limit", + "ParameterValue": "8388608", + "Description": "Pubsub client output buffer soft limit in bytes.", + "Source": "user", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "client-output-buffer-limit-pubsub-soft-seconds", + "ParameterValue": "60", + "Description": "Pubsub client output buffer soft limit in seconds.", + "Source": "user", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "client-output-buffer-limit-replica-soft-seconds", + "ParameterValue": "60", + "Description": "Replica client output buffer soft limit in seconds.", + "Source": "system", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": false, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "client-query-buffer-limit", + "ParameterValue": "1073741824", + "Description": "Max size of a single client query buffer", + "Source": "user", + "DataType": "integer", + "AllowedValues": "1048576-1073741824", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "close-on-replica-write", + "ParameterValue": "yes", + "Description": "If enabled, clients who attempt to write to a read-only replica will be disconnected. Applicable to 2.8.23 and higher.", + "Source": "user", + "DataType": "string", + "AllowedValues": "yes,no", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "cluster-enabled", + "ParameterValue": "no", + "Description": "Enable cluster mode", + "Source": "user", + "DataType": "string", + "AllowedValues": "yes,no", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "requires-reboot" + }, + { + "ParameterName": "cluster-require-full-coverage", + "ParameterValue": "no", + "Description": "Whether cluster becomes unavailable if one or more slots are not covered", + "Source": "user", + "DataType": "string", + "AllowedValues": "yes,no", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "databases", + "ParameterValue": "16", + "Description": "Set the number of databases.", + "Source": "user", + "DataType": "integer", + "AllowedValues": "1-1200000", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "requires-reboot" + }, + { + "ParameterName": "hash-max-ziplist-entries", + "ParameterValue": "512", + "Description": "The maximum number of hash entries in order for the dataset to be compressed.", + "Source": "user", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "hash-max-ziplist-value", + "ParameterValue": "64", + "Description": "The threshold of biggest hash entries in order for the dataset to be compressed.", + "Source": "user", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "hll-sparse-max-bytes", + "ParameterValue": "3000", + "Description": "HyperLogLog sparse representation bytes limit", + "Source": "user", + "DataType": "integer", + "AllowedValues": "1-16000", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "lazyfree-lazy-eviction", + "ParameterValue": "no", + "Description": "Perform an asynchronous delete on evictions", + "Source": "user", + "DataType": "string", + "AllowedValues": "yes,no", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "lazyfree-lazy-expire", + "ParameterValue": "no", + "Description": "Perform an asynchronous delete on expired keys", + "Source": "user", + "DataType": "string", + "AllowedValues": "yes,no", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "lazyfree-lazy-server-del", + "ParameterValue": "no", + "Description": "Perform an asynchronous delete on key updates", + "Source": "user", + "DataType": "string", + "AllowedValues": "yes,no", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "lfu-decay-time", + "ParameterValue": "1", + "Description": "The amount of time in minutes to decrement the key counter for LFU eviction policy", + "Source": "user", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "lfu-log-factor", + "ParameterValue": "10", + "Description": "The log factor for incrementing key counter for LFU eviction policy", + "Source": "user", + "DataType": "integer", + "AllowedValues": "1-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "list-compress-depth", + "ParameterValue": "0", + "Description": "Number of quicklist ziplist nodes from each side of the list to exclude from compression. The head and tail of the list are always uncompressed for fast push/pop operations", + "Source": "user", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "list-max-ziplist-size", + "ParameterValue": "-2", + "Description": "The number of entries allowed per internal list node can be specified as a fixed maximum size or a maximum number of elements", + "Source": "system", + "DataType": "integer", + "AllowedValues": "-5,-4,-3,-2,-1,1-", + "IsModifiable": false, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "lua-replicate-commands", + "ParameterValue": "yes", + "Description": "Always enable Lua effect replication or not", + "Source": "user", + "DataType": "string", + "AllowedValues": "yes,no", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "lua-time-limit", + "ParameterValue": "5000", + "Description": "Max execution time of a Lua script in milliseconds. 0 for unlimited execution without warnings.", + "Source": "system", + "DataType": "integer", + "AllowedValues": "5000", + "IsModifiable": false, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "maxclients", + "ParameterValue": "65000", + "Description": "The maximum number of Redis clients.", + "Source": "system", + "DataType": "integer", + "AllowedValues": "1-65000", + "IsModifiable": false, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "requires-reboot" + }, + { + "ParameterName": "maxmemory-policy", + "ParameterValue": "volatile-lru", + "Description": "Max memory policy.", + "Source": "user", + "DataType": "string", + "AllowedValues": "volatile-lru,allkeys-lru,volatile-lfu,allkeys-lfu,volatile-random,allkeys-random,volatile-ttl,noeviction", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "maxmemory-samples", + "ParameterValue": "3", + "Description": "Max memory samples.", + "Source": "user", + "DataType": "integer", + "AllowedValues": "1-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "min-replicas-max-lag", + "ParameterValue": "10", + "Description": "The maximum amount of replica lag in seconds beyond which the master would stop taking writes. A value of 0 means the master always takes writes.", + "Source": "user", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "min-replicas-to-write", + "ParameterValue": "0", + "Description": "The minimum number of replicas that must be present with lag no greater than min-replicas-max-lag for master to take writes. Setting this to 0 means the master always takes writes.", + "Source": "user", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "notify-keyspace-events", + "Description": "The keyspace events for Redis to notify Pub/Sub clients about. By default all notifications are disabled", + "Source": "user", + "DataType": "string", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "proto-max-bulk-len", + "ParameterValue": "536870912", + "Description": "Max size of a single element request", + "Source": "user", + "DataType": "integer", + "AllowedValues": "1048576-536870912", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "rename-commands", + "ParameterValue": "", + "Description": "Redis commands that can be dynamically renamed by the customer", + "Source": "user", + "DataType": "string", + "AllowedValues": "APPEND,BITCOUNT,BITFIELD,BITOP,BITPOS,BLPOP,BRPOP,BRPOPLPUSH,BZPOPMIN,BZPOPMAX,CLIENT,COMMAND,DBSIZE,DECR,DECRBY,DEL,DISCARD,DUMP,ECHO,EVAL,EVALSHA,EXEC,EXISTS,EXPIRE,EXPIREAT,FLUSHALL,FLUSHDB,GEOADD,GEOHASH,GEOPOS,GEODIST,GEORADIUS,GEORADIUSBYMEMBER,GET,GETBIT,GETRANGE,GETSET,HDEL,HEXISTS,HGET,HGETALL,HINCRBY,HINCRBYFLOAT,HKEYS,HLEN,HMGET,HMSET,HSET,HSETNX,HSTRLEN,HVALS,INCR,INCRBY,INCRBYFLOAT,INFO,KEYS,LASTSAVE,LINDEX,LINSERT,LLEN,LPOP,LPUSH,LPUSHX,LRANGE,LREM,LSET,LTRIM,MEMORY,MGET,MONITOR,MOVE,MSET,MSETNX,MULTI,OBJECT,PERSIST,PEXPIRE,PEXPIREAT,PFADD,PFCOUNT,PFMERGE,PING,PSETEX,PSUBSCRIBE,PUBSUB,PTTL,PUBLISH,PUNSUBSCRIBE,RANDOMKEY,READONLY,READWRITE,RENAME,RENAMENX,RESTORE,ROLE,RPOP,RPOPLPUSH,RPUSH,RPUSHX,SADD,SCARD,SCRIPT,SDIFF,SDIFFSTORE,SELECT,SET,SETBIT,SETEX,SETNX,SETRANGE,SINTER,SINTERSTORE,SISMEMBER,SLOWLOG,SMEMBERS,SMOVE,SORT,SPOP,SRANDMEMBER,SREM,STRLEN,SUBSCRIBE,SUNION,SUNIONSTORE,SWAPDB,TIME,TOUCH,TTL,TYPE,UNSUBSCRIBE,UNLINK,UNWATCH,WAIT,WATCH,ZADD,ZCARD,ZCOUNT,ZINCRBY,ZINTERSTORE,ZLEXCOUNT,ZPOPMAX,ZPOPMIN,ZRANGE,ZRANGEBYLEX,ZREVRANGEBYLEX,ZRANGEBYSCORE,ZRANK,ZREM,ZREMRANGEBYLEX,ZREMRANGEBYRANK,ZREMRANGEBYSCORE,ZREVRANGE,ZREVRANGEBYSCORE,ZREVRANK,ZSCORE,ZUNIONSTORE,SCAN,SSCAN,HSCAN,ZSCAN,XINFO,XADD,XTRIM,XDEL,XRANGE,XREVRANGE,XLEN,XREAD,XGROUP,XREADGROUP,XACK,XCLAIM,XPENDING,GEORADIUS_RO,GEORADIUSBYMEMBER_RO,LOLWUT,XSETID,SUBSTR", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.3", + "ChangeType": "immediate" + }, + { + "ParameterName": "repl-backlog-size", + "ParameterValue": "1048576", + "Description": "The replication backlog size in bytes for PSYNC. This is the size of the buffer which accumulates slave data when slave is disconnected for some time, so that when slave reconnects again, only transfer the portion of data which the slave missed. Minimum value is 16K.", + "Source": "user", + "DataType": "integer", + "AllowedValues": "16384-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "repl-backlog-ttl", + "ParameterValue": "3600", + "Description": "The amount of time in seconds after the master no longer have any slaves connected for the master to free the replication backlog. A value of 0 means to never release the backlog.", + "Source": "user", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "replica-allow-chaining", + "ParameterValue": "no", + "Description": "Configures if chaining of replicas is allowed", + "Source": "system", + "DataType": "string", + "AllowedValues": "yes,no", + "IsModifiable": false, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "replica-ignore-maxmemory", + "ParameterValue": "yes", + "Description": "Determines if replica ignores maxmemory setting by not evicting items independent from the master", + "Source": "system", + "DataType": "string", + "AllowedValues": "yes,no", + "IsModifiable": false, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "replica-lazy-flush", + "ParameterValue": "no", + "Description": "Perform an asynchronous flushDB during replica sync", + "Source": "system", + "DataType": "string", + "AllowedValues": "yes,no", + "IsModifiable": false, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "reserved-memory-percent", + "ParameterValue": "25", + "Description": "The percent of memory reserved for non-cache memory usage. You may want to increase this parameter for nodes with read replicas, AOF enabled, etc, to reduce swap usage.", + "Source": "user", + "DataType": "integer", + "AllowedValues": "0-100", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "set-max-intset-entries", + "ParameterValue": "512", + "Description": "The limit in the size of the set in order for the dataset to be compressed.", + "Source": "user", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "slowlog-log-slower-than", + "ParameterValue": "10000", + "Description": "The execution time, in microseconds, to exceed in order for the command to get logged. Note that a negative number disables the slow log, while a value of zero forces the logging of every command.", + "Source": "user", + "DataType": "integer", + "AllowedValues": "-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "slowlog-max-len", + "ParameterValue": "128", + "Description": "The length of the slow log. There is no limit to this length. Just be aware that it will consume memory. You can reclaim memory used by the slow log with SLOWLOG RESET.", + "Source": "user", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "stream-node-max-bytes", + "ParameterValue": "4096", + "Description": "The maximum size of a single node in a stream in bytes", + "Source": "user", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "stream-node-max-entries", + "ParameterValue": "100", + "Description": "The maximum number of items a single node in a stream can contain", + "Source": "user", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "tcp-keepalive", + "ParameterValue": "300", + "Description": "If non-zero, send ACKs every given number of seconds.", + "Source": "user", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "timeout", + "ParameterValue": "0", + "Description": "Close connection if client is idle for a given number of seconds, or never if 0.", + "Source": "user", + "DataType": "integer", + "AllowedValues": "0,20-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "zset-max-ziplist-entries", + "ParameterValue": "128", + "Description": "The maximum number of sorted set entries in order for the dataset to be compressed.", + "Source": "user", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "zset-max-ziplist-value", + "ParameterValue": "64", + "Description": "The threshold of biggest sorted set entries in order for the dataset to be compressed.", + "Source": "user", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + } + ] + } + +For more information, see `Parameter Management `__ in the *Elasticache User Guide*. diff -Nru awscli-1.11.13/awscli/examples/elasticache/describe-engine-default-parameters.rst awscli-1.18.69/awscli/examples/elasticache/describe-engine-default-parameters.rst --- awscli-1.11.13/awscli/examples/elasticache/describe-engine-default-parameters.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/elasticache/describe-engine-default-parameters.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,640 @@ +**To describe engine default parameters** + +The following ``describe-engine-default-parameters`` example returns the default engine and system parameter information for the specified cache engine. :: + + aws elasticache describe-engine-default-parameters \ + --cache-parameter-group-family "redis5.0" + +Output:: + + { + "EngineDefaults": { + "Parameters": [ + { + "ParameterName": "activedefrag", + "ParameterValue": "no", + "Description": "Enabled active memory defragmentation", + "Source": "system", + "DataType": "string", + "AllowedValues": "yes,no", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "active-defrag-cycle-max", + "ParameterValue": "75", + "Description": "Maximal effort for defrag in CPU percentage", + "Source": "system", + "DataType": "integer", + "AllowedValues": "1-75", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "active-defrag-cycle-min", + "ParameterValue": "5", + "Description": "Minimal effort for defrag in CPU percentage", + "Source": "system", + "DataType": "integer", + "AllowedValues": "1-75", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "active-defrag-ignore-bytes", + "ParameterValue": "104857600", + "Description": "Minimum amount of fragmentation waste to start active defrag", + "Source": "system", + "DataType": "integer", + "AllowedValues": "1048576-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "active-defrag-max-scan-fields", + "ParameterValue": "1000", + "Description": "Maximum number of set/hash/zset/list fields that will be processed from the main dictionary scan", + "Source": "system", + "DataType": "integer", + "AllowedValues": "1-1000000", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "active-defrag-threshold-lower", + "ParameterValue": "10", + "Description": "Minimum percentage of fragmentation to start active defrag", + "Source": "system", + "DataType": "integer", + "AllowedValues": "1-100", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "active-defrag-threshold-upper", + "ParameterValue": "100", + "Description": "Maximum percentage of fragmentation at which we use maximum effort", + "Source": "system", + "DataType": "integer", + "AllowedValues": "1-100", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "activerehashing", + "ParameterValue": "yes", + "Description": "Apply rehashing or not.", + "Source": "system", + "DataType": "string", + "AllowedValues": "yes,no", + "IsModifiable": false, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "requires-reboot" + }, + { + "ParameterName": "appendfsync", + "ParameterValue": "everysec", + "Description": "fsync policy for AOF persistence", + "Source": "system", + "DataType": "string", + "AllowedValues": "always,everysec,no", + "IsModifiable": false, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "appendonly", + "ParameterValue": "no", + "Description": "Enable Redis persistence.", + "Source": "system", + "DataType": "string", + "AllowedValues": "yes,no", + "IsModifiable": false, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "client-output-buffer-limit-normal-hard-limit", + "ParameterValue": "0", + "Description": "Normal client output buffer hard limit in bytes.", + "Source": "system", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "client-output-buffer-limit-normal-soft-limit", + "ParameterValue": "0", + "Description": "Normal client output buffer soft limit in bytes.", + "Source": "system", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "client-output-buffer-limit-normal-soft-seconds", + "ParameterValue": "0", + "Description": "Normal client output buffer soft limit in seconds.", + "Source": "system", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "client-output-buffer-limit-pubsub-hard-limit", + "ParameterValue": "33554432", + "Description": "Pubsub client output buffer hard limit in bytes.", + "Source": "system", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "client-output-buffer-limit-pubsub-soft-limit", + "ParameterValue": "8388608", + "Description": "Pubsub client output buffer soft limit in bytes.", + "Source": "system", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "client-output-buffer-limit-pubsub-soft-seconds", + "ParameterValue": "60", + "Description": "Pubsub client output buffer soft limit in seconds.", + "Source": "system", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "client-output-buffer-limit-replica-soft-seconds", + "ParameterValue": "60", + "Description": "Replica client output buffer soft limit in seconds.", + "Source": "system", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": false, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "client-query-buffer-limit", + "ParameterValue": "1073741824", + "Description": "Max size of a single client query buffer", + "Source": "system", + "DataType": "integer", + "AllowedValues": "1048576-1073741824", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "close-on-replica-write", + "ParameterValue": "yes", + "Description": "If enabled, clients who attempt to write to a read-only replica will be disconnected. Applicable to 2.8.23 and higher.", + "Source": "system", + "DataType": "string", + "AllowedValues": "yes,no", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "cluster-enabled", + "ParameterValue": "no", + "Description": "Enable cluster mode", + "Source": "system", + "DataType": "string", + "AllowedValues": "yes,no", + "IsModifiable": false, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "requires-reboot" + }, + { + "ParameterName": "cluster-require-full-coverage", + "ParameterValue": "no", + "Description": "Whether cluster becomes unavailable if one or more slots are not covered", + "Source": "system", + "DataType": "string", + "AllowedValues": "yes,no", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "databases", + "ParameterValue": "16", + "Description": "Set the number of databases.", + "Source": "system", + "DataType": "integer", + "AllowedValues": "1-1200000", + "IsModifiable": false, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "requires-reboot" + }, + { + "ParameterName": "hash-max-ziplist-entries", + "ParameterValue": "512", + "Description": "The maximum number of hash entries in order for the dataset to be compressed.", + "Source": "system", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "hash-max-ziplist-value", + "ParameterValue": "64", + "Description": "The threshold of biggest hash entries in order for the dataset to be compressed.", + "Source": "system", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "hll-sparse-max-bytes", + "ParameterValue": "3000", + "Description": "HyperLogLog sparse representation bytes limit", + "Source": "system", + "DataType": "integer", + "AllowedValues": "1-16000", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "lazyfree-lazy-eviction", + "ParameterValue": "no", + "Description": "Perform an asynchronous delete on evictions", + "Source": "system", + "DataType": "string", + "AllowedValues": "yes,no", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "lazyfree-lazy-expire", + "ParameterValue": "no", + "Description": "Perform an asynchronous delete on expired keys", + "Source": "system", + "DataType": "string", + "AllowedValues": "yes,no", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "lazyfree-lazy-server-del", + "ParameterValue": "no", + "Description": "Perform an asynchronous delete on key updates", + "Source": "system", + "DataType": "string", + "AllowedValues": "yes,no", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "lfu-decay-time", + "ParameterValue": "1", + "Description": "The amount of time in minutes to decrement the key counter for LFU eviction policy", + "Source": "system", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "lfu-log-factor", + "ParameterValue": "10", + "Description": "The log factor for incrementing key counter for LFU eviction policy", + "Source": "system", + "DataType": "integer", + "AllowedValues": "1-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "list-compress-depth", + "ParameterValue": "0", + "Description": "Number of quicklist ziplist nodes from each side of the list to exclude from compression. The head and tail of the list are always uncompressed for fast push/pop operations", + "Source": "system", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "list-max-ziplist-size", + "ParameterValue": "-2", + "Description": "The number of entries allowed per internal list node can be specified as a fixed maximum size or a maximum number of elements", + "Source": "system", + "DataType": "integer", + "AllowedValues": "-5,-4,-3,-2,-1,1-", + "IsModifiable": false, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "lua-replicate-commands", + "ParameterValue": "yes", + "Description": "Always enable Lua effect replication or not", + "Source": "system", + "DataType": "string", + "AllowedValues": "yes,no", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "lua-time-limit", + "ParameterValue": "5000", + "Description": "Max execution time of a Lua script in milliseconds. 0 for unlimited execution without warnings.", + "Source": "system", + "DataType": "integer", + "AllowedValues": "5000", + "IsModifiable": false, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "maxclients", + "ParameterValue": "65000", + "Description": "The maximum number of Redis clients.", + "Source": "system", + "DataType": "integer", + "AllowedValues": "1-65000", + "IsModifiable": false, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "requires-reboot" + }, + { + "ParameterName": "maxmemory-policy", + "ParameterValue": "volatile-lru", + "Description": "Max memory policy.", + "Source": "system", + "DataType": "string", + "AllowedValues": "volatile-lru,allkeys-lru,volatile-lfu,allkeys-lfu,volatile-random,allkeys-random,volatile-ttl,noeviction", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "maxmemory-samples", + "ParameterValue": "3", + "Description": "Max memory samples.", + "Source": "system", + "DataType": "integer", + "AllowedValues": "1-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "min-replicas-max-lag", + "ParameterValue": "10", + "Description": "The maximum amount of replica lag in seconds beyond which the master would stop taking writes. A value of 0 means the master always takes writes.", + "Source": "system", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "min-replicas-to-write", + "ParameterValue": "0", + "Description": "The minimum number of replicas that must be present with lag no greater than min-replicas-max-lag for master to take writes. Setting this to 0 means the master always takes writes.", + "Source": "system", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "notify-keyspace-events", + "Description": "The keyspace events for Redis to notify Pub/Sub clients about. By default all notifications are disabled", + "Source": "system", + "DataType": "string", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "proto-max-bulk-len", + "ParameterValue": "536870912", + "Description": "Max size of a single element request", + "Source": "system", + "DataType": "integer", + "AllowedValues": "1048576-536870912", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "rename-commands", + "ParameterValue": "", + "Description": "Redis commands that can be dynamically renamed by the customer", + "Source": "system", + "DataType": "string", + "AllowedValues": "APPEND,BITCOUNT,BITFIELD,BITOP,BITPOS,BLPOP,BRPOP,BRPOPLPUSH,BZPOPMIN,BZPOPMAX,CLIENT,COMMAND,DBSIZE,DECR,DECRBY,DEL,DISCARD,DUMP,ECHO,EVAL,EVALSHA,EXEC,EXISTS,EXPIRE,EXPIREAT,FLUSHALL,FLUSHDB,GEOADD,GEOHASH,GEOPOS,GEODIST,GEORADIUS,GEORADIUSBYMEMBER,GET,GETBIT,GETRANGE,GETSET,HDEL,HEXISTS,HGET,HGETALL,HINCRBY,HINCRBYFLOAT,HKEYS,HLEN,HMGET,HMSET,HSET,HSETNX,HSTRLEN,HVALS,INCR,INCRBY,INCRBYFLOAT,INFO,KEYS,LASTSAVE,LINDEX,LINSERT,LLEN,LPOP,LPUSH,LPUSHX,LRANGE,LREM,LSET,LTRIM,MEMORY,MGET,MONITOR,MOVE,MSET,MSETNX,MULTI,OBJECT,PERSIST,PEXPIRE,PEXPIREAT,PFADD,PFCOUNT,PFMERGE,PING,PSETEX,PSUBSCRIBE,PUBSUB,PTTL,PUBLISH,PUNSUBSCRIBE,RANDOMKEY,READONLY,READWRITE,RENAME,RENAMENX,RESTORE,ROLE,RPOP,RPOPLPUSH,RPUSH,RPUSHX,SADD,SCARD,SCRIPT,SDIFF,SDIFFSTORE,SELECT,SET,SETBIT,SETEX,SETNX,SETRANGE,SINTER,SINTERSTORE,SISMEMBER,SLOWLOG,SMEMBERS,SMOVE,SORT,SPOP,SRANDMEMBER,SREM,STRLEN,SUBSCRIBE,SUNION,SUNIONSTORE,SWAPDB,TIME,TOUCH,TTL,TYPE,UNSUBSCRIBE,UNLINK,UNWATCH,WAIT,WATCH,ZADD,ZCARD,ZCOUNT,ZINCRBY,ZINTERSTORE,ZLEXCOUNT,ZPOPMAX,ZPOPMIN,ZRANGE,ZRANGEBYLEX,ZREVRANGEBYLEX,ZRANGEBYSCORE,ZRANK,ZREM,ZREMRANGEBYLEX,ZREMRANGEBYRANK,ZREMRANGEBYSCORE,ZREVRANGE,ZREVRANGEBYSCORE,ZREVRANK,ZSCORE,ZUNIONSTORE,SCAN,SSCAN,HSCAN,ZSCAN,XINFO,XADD,XTRIM,XDEL,XRANGE,XREVRANGE,XLEN,XREAD,XGROUP,XREADGROUP,XACK,XCLAIM,XPENDING,GEORADIUS_RO,GEORADIUSBYMEMBER_RO,LOLWUT,XSETID,SUBSTR", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.3", + "ChangeType": "immediate" + }, + { + "ParameterName": "repl-backlog-size", + "ParameterValue": "1048576", + "Description": "The replication backlog size in bytes for PSYNC. This is the size of the buffer which accumulates slave data when slave is disconnected for some time, so that when slave reconnects again, only transfer the portion of data which the slave missed. Minimum value is 16K.", + "Source": "system", + "DataType": "integer", + "AllowedValues": "16384-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "repl-backlog-ttl", + "ParameterValue": "3600", + "Description": "The amount of time in seconds after the master no longer have any slaves connected for the master to free the replication backlog. A value of 0 means to never release the backlog.", + "Source": "system", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "replica-allow-chaining", + "ParameterValue": "no", + "Description": "Configures if chaining of replicas is allowed", + "Source": "system", + "DataType": "string", + "AllowedValues": "yes,no", + "IsModifiable": false, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "replica-ignore-maxmemory", + "ParameterValue": "yes", + "Description": "Determines if replica ignores maxmemory setting by not evicting items independent from the master", + "Source": "system", + "DataType": "string", + "AllowedValues": "yes,no", + "IsModifiable": false, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "replica-lazy-flush", + "ParameterValue": "no", + "Description": "Perform an asynchronous flushDB during replica sync", + "Source": "system", + "DataType": "string", + "AllowedValues": "yes,no", + "IsModifiable": false, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "reserved-memory-percent", + "ParameterValue": "25", + "Description": "The percent of memory reserved for non-cache memory usage. You may want to increase this parameter for nodes with read replicas, AOF enabled, etc, to reduce swap usage.", + "Source": "system", + "DataType": "integer", + "AllowedValues": "0-100", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "set-max-intset-entries", + "ParameterValue": "512", + "Description": "The limit in the size of the set in order for the dataset to be compressed.", + "Source": "system", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "slowlog-log-slower-than", + "ParameterValue": "10000", + "Description": "The execution time, in microseconds, to exceed in order for the command to get logged. Note that a negative number disables the slow log, while a value of zero forces the logging of every command.", + "Source": "system", + "DataType": "integer", + "AllowedValues": "-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "slowlog-max-len", + "ParameterValue": "128", + "Description": "The length of the slow log. There is no limit to this length. Just be aware that it will consume memory. You can reclaim memory used by the slow log with SLOWLOG RESET.", + "Source": "system", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "stream-node-max-bytes", + "ParameterValue": "4096", + "Description": "The maximum size of a single node in a stream in bytes", + "Source": "system", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "stream-node-max-entries", + "ParameterValue": "100", + "Description": "The maximum number of items a single node in a stream can contain", + "Source": "system", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "tcp-keepalive", + "ParameterValue": "300", + "Description": "If non-zero, send ACKs every given number of seconds.", + "Source": "system", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "timeout", + "ParameterValue": "0", + "Description": "Close connection if client is idle for a given number of seconds, or never if 0.", + "Source": "system", + "DataType": "integer", + "AllowedValues": "0,20-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "zset-max-ziplist-entries", + "ParameterValue": "128", + "Description": "The maximum number of sorted set entries in order for the dataset to be compressed.", + "Source": "system", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + }, + { + "ParameterName": "zset-max-ziplist-value", + "ParameterValue": "64", + "Description": "The threshold of biggest sorted set entries in order for the dataset to be compressed.", + "Source": "system", + "DataType": "integer", + "AllowedValues": "0-", + "IsModifiable": true, + "MinimumEngineVersion": "5.0.0", + "ChangeType": "immediate" + } + ] + } + } diff -Nru awscli-1.11.13/awscli/examples/elasticache/describe-replication-groups.rst awscli-1.18.69/awscli/examples/elasticache/describe-replication-groups.rst --- awscli-1.11.13/awscli/examples/elasticache/describe-replication-groups.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/elasticache/describe-replication-groups.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,91 @@ +**To describe replication groups** + +The following ``describe-replication-groups`` example returns information about the specified replication group. :: + + aws elasticache describe-replication-groups + --replication-group-id "my-cluster" + +Output:: + + { + "ReplicationGroups": [ + { + "ReplicationGroupId": "my-cluster", + "Description": "mycluster", + "Status": "available", + "PendingModifiedValues": {}, + "MemberClusters": [ + "pat-cluster-001", + "pat-cluster-002", + "pat-cluster-003", + "pat-cluster-004" + ], + "NodeGroups": [ + { + "NodeGroupId": "0001", + "Status": "available", + "PrimaryEndpoint": { + "Address": "my-cluster.xxxxih.ng.0001.usw2.cache.amazonaws.com", + "Port": 6379 + }, + "ReaderEndpoint": { + "Address": "my-cluster-ro.xxxxih.ng.0001.usw2.cache.amazonaws.com", + "Port": 6379 + }, + "NodeGroupMembers": [ + { + "CacheClusterId": "my-cluster-001", + "CacheNodeId": "0001", + "ReadEndpoint": { + "Address": "pat-cluster-001.xxxih.0001.usw2.cache.amazonaws.com", + "Port": 6379 + }, + "PreferredAvailabilityZone": "us-west-2a", + "CurrentRole": "primary" + }, + { + "CacheClusterId": "my-cluster-002", + "CacheNodeId": "0001", + "ReadEndpoint": { + "Address": "pat-cluster-002.xxxxih.0001.usw2.cache.amazonaws.com", + "Port": 6379 + }, + "PreferredAvailabilityZone": "us-west-2a", + "CurrentRole": "replica" + }, + { + "CacheClusterId": "my-cluster-003", + "CacheNodeId": "0001", + "ReadEndpoint": { + "Address": "pat-cluster-003.xxxxih.0001.usw2.cache.amazonaws.com", + "Port": 6379 + }, + "PreferredAvailabilityZone": "us-west-2a", + "CurrentRole": "replica" + }, + { + "CacheClusterId": "my-cluster-004", + "CacheNodeId": "0001", + "ReadEndpoint": { + "Address": "pat-cluster-004.xxxih.0001.usw2.cache.amazonaws.com", + "Port": 6379 + }, + "PreferredAvailabilityZone": "us-west-2a", + "CurrentRole": "replica" + } + ] + } + ], + "AutomaticFailover": "disabled", + "SnapshotRetentionLimit": 0, + "SnapshotWindow": "07:30-08:30", + "ClusterEnabled": false, + "CacheNodeType": "cache.r5.xlarge", + "AuthTokenEnabled": false, + "TransitEncryptionEnabled": false, + "AtRestEncryptionEnabled": false + } + ] + } + +For more information, see `Viewing a Replication Group's Details `__ in the *Elasticache User Guide*. diff -Nru awscli-1.11.13/awscli/examples/elasticache/describe-reserved-cache-nodes.rst awscli-1.18.69/awscli/examples/elasticache/describe-reserved-cache-nodes.rst --- awscli-1.11.13/awscli/examples/elasticache/describe-reserved-cache-nodes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/elasticache/describe-reserved-cache-nodes.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,34 @@ +**To describe reserved cache nodes** + +The following ``describe-reserved-cache-nodes`` example returns information about reserved cache nodes for this account, or about the specified reserved cache node. + + aws elasticache describe-reserved-cache-nodes + +Output:: + + { + "ReservedCacheNodes": [ + { + "ReservedCacheNodeId": "mynode", + "ReservedCacheNodesOfferingId": "xxxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxx71", + "CacheNodeType": "cache.t3.small", + "StartTime": "2019-12-06T02:50:44.003Z", + "Duration": 31536000, + "FixedPrice": 0.0, + "UsagePrice": 0.0, + "CacheNodeCount": 1, + "ProductDescription": "redis", + "OfferingType": "No Upfront", + "State": "payment-pending", + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.023, + "RecurringChargeFrequency": "Hourly" + } + ], + "ReservationARN": "arn:aws:elasticache:us-west-2:xxxxxxxxxxxx52:reserved-instance:mynode" + } + ] + } + +For more information, see `Managing Costs with Reserved Nodes `__ in the *Elasticache User Guide*. diff -Nru awscli-1.11.13/awscli/examples/elasticache/describe-service-updates.rst awscli-1.18.69/awscli/examples/elasticache/describe-service-updates.rst --- awscli-1.11.13/awscli/examples/elasticache/describe-service-updates.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/elasticache/describe-service-updates.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,40 @@ +**To describe service updates** + +The following ``describe-service-updates`` example returns details about service updates. :: + + aws elasticache describe-service-updates + +Output:: + + { + "ServiceUpdates": [ + { + "ServiceUpdateName": "elc-xxxxxxxx7-001", + "ServiceUpdateReleaseDate": "2019-10-09T16:00:00Z", + "ServiceUpdateEndDate": "2020-02-09T15:59:59Z", + "ServiceUpdateSeverity": "important", + "ServiceUpdateRecommendedApplyByDate": "2019-11-08T15:59:59Z", + "ServiceUpdateStatus": "available", + "ServiceUpdateDescription": "Upgrades to improve the security, reliability, and operational performance of your ElastiCache nodes", + "ServiceUpdateType": "security-update", + "Engine": "redis, memcached", + "EngineVersion": "redis 2.6.13 and onwards, memcached 1.4.5 and onwards", + "AutoUpdateAfterRecommendedApplyByDate": false, + "EstimatedUpdateTime": "30 minutes per node" + }, + { + "ServiceUpdateName": "elc-xxxxxxxx4-001", + "ServiceUpdateReleaseDate": "2019-06-11T15:00:00Z", + "ServiceUpdateEndDate": "2019-10-01T09:24:00Z", + "ServiceUpdateSeverity": "important", + "ServiceUpdateRecommendedApplyByDate": "2019-07-11T14:59:59Z", + "ServiceUpdateStatus": "expired", + "ServiceUpdateDescription": "Upgrades to improve the security, reliability, and operational performance of your ElastiCache nodes", + "ServiceUpdateType": "security-update", + "Engine": "redis", + "EngineVersion": "redis 3.2.6, redis 4.0 and onwards", + "AutoUpdateAfterRecommendedApplyByDate": false, + "EstimatedUpdateTime": "30 minutes per node" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/elasticache/describe-snapshots.rst awscli-1.18.69/awscli/examples/elasticache/describe-snapshots.rst --- awscli-1.11.13/awscli/examples/elasticache/describe-snapshots.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/elasticache/describe-snapshots.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,102 @@ +**To describe snapshots** + +The following ''describe-snapshots'' example returns information about your cluster or replication group snapshots. :: + + aws elasticache describe-snapshots + +Output:: + + { + "Snapshots": [ + { + "SnapshotName": "automatic.my-cluster2-002-2019-12-05-06-38", + "CacheClusterId": "my-cluster2-002", + "SnapshotStatus": "available", + "SnapshotSource": "automated", + "CacheNodeType": "cache.r5.large", + "Engine": "redis", + "EngineVersion": "5.0.5", + "NumCacheNodes": 1, + "PreferredAvailabilityZone": "us-west-2a", + "CacheClusterCreateTime": "2019-11-26T01:22:52.396Z", + "PreferredMaintenanceWindow": "mon:17:30-mon:18:30", + "TopicArn": "arn:aws:sns:us-west-2:xxxxxxxxx52:My_Topic", + "Port": 6379, + "CacheParameterGroupName": "default.redis5.0", + "CacheSubnetGroupName": "kxkxk", + "VpcId": "vpc-a3e97cdb", + "AutoMinorVersionUpgrade": true, + "SnapshotRetentionLimit": 1, + "SnapshotWindow": "06:30-07:30", + "NodeSnapshots": [ + { + "CacheNodeId": "0001", + "CacheSize": "5 MB", + "CacheNodeCreateTime": "2019-11-26T01:22:52.396Z", + "SnapshotCreateTime": "2019-12-05T06:38:23Z" + } + ] + }, + { + "SnapshotName": "myreplica-backup", + "CacheClusterId": "myreplica", + "SnapshotStatus": "available", + "SnapshotSource": "manual", + "CacheNodeType": "cache.r5.large", + "Engine": "redis", + "EngineVersion": "5.0.5", + "NumCacheNodes": 1, + "PreferredAvailabilityZone": "us-west-2a", + "CacheClusterCreateTime": "2019-11-26T00:14:52.439Z", + "PreferredMaintenanceWindow": "sat:10:00-sat:11:00", + "TopicArn": "arn:aws:sns:us-west-2:xxxxxxxxxx152:My_Topic", + "Port": 6379, + "CacheParameterGroupName": "default.redis5.0", + "CacheSubnetGroupName": "kxkxk", + "VpcId": "vpc-a3e97cdb", + "AutoMinorVersionUpgrade": true, + "SnapshotRetentionLimit": 0, + "SnapshotWindow": "09:00-10:00", + "NodeSnapshots": [ + { + "CacheNodeId": "0001", + "CacheSize": "5 MB", + "CacheNodeCreateTime": "2019-11-26T00:14:52.439Z", + "SnapshotCreateTime": "2019-11-26T00:25:01Z" + } + ] + }, + { + "SnapshotName": "my-cluster", + "CacheClusterId": "my-cluster-003", + "SnapshotStatus": "available", + "SnapshotSource": "manual", + "CacheNodeType": "cache.r5.large", + "Engine": "redis", + "EngineVersion": "5.0.5", + "NumCacheNodes": 1, + "PreferredAvailabilityZone": "us-west-2a", + "CacheClusterCreateTime": "2019-11-25T23:56:17.186Z", + "PreferredMaintenanceWindow": "sat:10:00-sat:11:00", + "TopicArn": "arn:aws:sns:us-west-2:xxxxxxxxxx152:My_Topic", + "Port": 6379, + "CacheParameterGroupName": "default.redis5.0", + "CacheSubnetGroupName": "kxkxk", + "VpcId": "vpc-a3e97cdb", + "AutoMinorVersionUpgrade": true, + "SnapshotRetentionLimit": 0, + "SnapshotWindow": "09:00-10:00", + "NodeSnapshots": [ + { + "CacheNodeId": "0001", + "CacheSize": "5 MB", + "CacheNodeCreateTime": "2019-11-25T23:56:17.186Z", + "SnapshotCreateTime": "2019-11-26T03:08:33Z" + } + ] + } + ] + } + +For more information, see `Backup and Restore for ElastiCache for Redis `__ in the *Elasticache User Guide*. + diff -Nru awscli-1.11.13/awscli/examples/elasticache/describe-update-actions.rst awscli-1.18.69/awscli/examples/elasticache/describe-update-actions.rst --- awscli-1.11.13/awscli/examples/elasticache/describe-update-actions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/elasticache/describe-update-actions.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,74 @@ +**To describe update actions** + +The following ``describe-update-actions`` example returns details of update actions. :: + + aws elasticache describe-update-actions + +Output:: + + { + "UpdateActions": [ + { + "ReplicationGroupId": "mycluster", + "ServiceUpdateName": "elc-20191007-001", + "ServiceUpdateReleaseDate": "2019-10-09T16:00:00Z", + "ServiceUpdateSeverity": "important", + "ServiceUpdateStatus": "available", + "ServiceUpdateRecommendedApplyByDate": "2019-11-08T15:59:59Z", + "ServiceUpdateType": "security-update", + "UpdateActionAvailableDate": "2019-12-05T19:15:19.995Z", + "UpdateActionStatus": "complete", + "NodesUpdated": "9/9", + "UpdateActionStatusModifiedDate": "2019-12-05T19:15:20.461Z", + "SlaMet": "n/a", + "Engine": "redis" + }, + { + "CacheClusterId": "my-memcached-cluster", + "ServiceUpdateName": "elc-20191007-001", + "ServiceUpdateReleaseDate": "2019-10-09T16:00:00Z", + "ServiceUpdateSeverity": "important", + "ServiceUpdateStatus": "available", + "ServiceUpdateRecommendedApplyByDate": "2019-11-08T15:59:59Z", + "ServiceUpdateType": "security-update", + "UpdateActionAvailableDate": "2019-12-04T18:26:05.349Z", + "UpdateActionStatus": "complete", + "NodesUpdated": "1/1", + "UpdateActionStatusModifiedDate": "2019-12-04T18:26:05.352Z", + "SlaMet": "n/a", + "Engine": "redis" + }, + { + "ReplicationGroupId": "my-cluster", + "ServiceUpdateName": "elc-20191007-001", + "ServiceUpdateReleaseDate": "2019-10-09T16:00:00Z", + "ServiceUpdateSeverity": "important", + "ServiceUpdateStatus": "available", + "ServiceUpdateRecommendedApplyByDate": "2019-11-08T15:59:59Z", + "ServiceUpdateType": "security-update", + "UpdateActionAvailableDate": "2019-11-26T03:36:26.320Z", + "UpdateActionStatus": "complete", + "NodesUpdated": "4/4", + "UpdateActionStatusModifiedDate": "2019-12-04T22:11:12.664Z", + "SlaMet": "n/a", + "Engine": "redis" + }, + { + "ReplicationGroupId": "my-cluster2", + "ServiceUpdateName": "elc-20191007-001", + "ServiceUpdateReleaseDate": "2019-10-09T16:00:00Z", + "ServiceUpdateSeverity": "important", + "ServiceUpdateStatus": "available", + "ServiceUpdateRecommendedApplyByDate": "2019-11-08T15:59:59Z", + "ServiceUpdateType": "security-update", + "UpdateActionAvailableDate": "2019-11-26T01:26:01.617Z", + "UpdateActionStatus": "complete", + "NodesUpdated": "3/3", + "UpdateActionStatusModifiedDate": "2019-11-26T01:26:01.753Z", + "SlaMet": "n/a", + "Engine": "redis" + } + ] + } + +For more information, see `Self-Service Updates in Amazon ElastiCache `__ in the *Elasticache User Guide*. diff -Nru awscli-1.11.13/awscli/examples/elasticache/increase-replica-count.rst awscli-1.18.69/awscli/examples/elasticache/increase-replica-count.rst --- awscli-1.11.13/awscli/examples/elasticache/increase-replica-count.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/elasticache/increase-replica-count.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,70 @@ +**To increase replica count** + +The following ``increase-replica-count`` example does one of two things. It can dynamically increase the number of replicas in a Redis (cluster mode disabled) replication group. Or it can dynamically increase the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster downtime. :: + + aws elasticache increase-replica-count \ + --replication-group-id "my-cluster" \ + --apply-immediately \ + --new-replica-count 3 + +Output:: + + { + "ReplicationGroup": { + "ReplicationGroupId": "my-cluster", + "Description": " ", + "Status": "modifying", + "PendingModifiedValues": {}, + "MemberClusters": [ + "my-cluster-001", + "my-cluster-002", + "my-cluster-003", + "my-cluster-004" + ], + "NodeGroups": [ + { + "NodeGroupId": "0001", + "Status": "modifying", + "PrimaryEndpoint": { + "Address": "my-cluster.xxxxxih.ng.0001.usw2.cache.amazonaws.com", + "Port": 6379 + }, + "ReaderEndpoint": { + "Address": "my-cluster-ro.xxxxxxih.ng.0001.usw2.cache.amazonaws.com", + "Port": 6379 + }, + "NodeGroupMembers": [ + { + "CacheClusterId": "my-cluster-001", + "CacheNodeId": "0001", + "ReadEndpoint": { + "Address": "my-cluster-001.xxxxxih.0001.usw2.cache.amazonaws.com", + "Port": 6379 + }, + "PreferredAvailabilityZone": "us-west-2a", + "CurrentRole": "primary" + }, + { + "CacheClusterId": "my-cluster-003", + "CacheNodeId": "0001", + "ReadEndpoint": { + "Address": "my-cluster-003.xxxxxih.0001.usw2.cache.amazonaws.com", + "Port": 6379 + }, + "PreferredAvailabilityZone": "us-west-2a", + "CurrentRole": "replica" + } + ] + } + ], + "AutomaticFailover": "disabled", + "SnapshotRetentionLimit": 0, + "SnapshotWindow": "07:30-08:30", + "ClusterEnabled": false, + "CacheNodeType": "cache.r5.xlarge", + "TransitEncryptionEnabled": false, + "AtRestEncryptionEnabled": false + } + } + +For more information, see `Increasing the Number of Replicas in a Shard `__ in the *Elasticache User Guide*. diff -Nru awscli-1.11.13/awscli/examples/elasticache/list-allowed-node-type-modifications.rst awscli-1.18.69/awscli/examples/elasticache/list-allowed-node-type-modifications.rst --- awscli-1.11.13/awscli/examples/elasticache/list-allowed-node-type-modifications.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/elasticache/list-allowed-node-type-modifications.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,42 @@ +**To list the allowed node modifications** + +The following ``list-allowed-node-type-modifications`` example lists all the available node types that you can scale your Redis cluster's or replication group's current node type to. :: + + aws elasticache list-allowed-node-type-modifications \ + --replication-group-id "my-replication-group" + +Output:: + + { + "ScaleUpModifications": [ + "cache.m5.12xlarge", + "cache.m5.24xlarge", + "cache.m5.4xlarge", + "cache.r5.12xlarge", + "cache.r5.24xlarge", + "cache.r5.2xlarge", + "cache.r5.4xlarge" + ], + "ScaleDownModifications": [ + "cache.m3.large", + "cache.m3.medium", + "cache.m3.xlarge", + "cache.m4.large", + "cache.m4.xlarge", + "cache.m5.2xlarge", + "cache.m5.large", + "cache.m5.xlarge", + "cache.r3.large", + "cache.r4.large", + "cache.r4.xlarge", + "cache.r5.large", + "cache.t2.medium", + "cache.t2.micro", + "cache.t2.small", + "cache.t3.medium", + "cache.t3.micro", + "cache.t3.small" + ] + } + +For more information, see `Scaling ElastiCache for Redis Clusters `__ in the *Elasticache User Guide*. diff -Nru awscli-1.11.13/awscli/examples/elasticache/modify-cache-cluster.rst awscli-1.18.69/awscli/examples/elasticache/modify-cache-cluster.rst --- awscli-1.11.13/awscli/examples/elasticache/modify-cache-cluster.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/elasticache/modify-cache-cluster.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,39 @@ +**To modify cache clusters** + +The following ``modify-cache-cluster`` example modifies the settings for the specified cluster. :: + + aws elasticache modify-cache-cluster \ + --cache-cluster-id "my-cluster" \ + --num-cache-nodes 1 + +Output:: + + { + "CacheCluster": { + "CacheClusterId": "my-cluster", + "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", + "CacheNodeType": "cache.m5.large", + "Engine": "redis", + "EngineVersion": "5.0.5", + "CacheClusterStatus": "available", + "NumCacheNodes": 1, + "PreferredAvailabilityZone": "us-west-2c", + "CacheClusterCreateTime": "2019-12-04T18:24:56.652Z", + "PreferredMaintenanceWindow": "sat:10:00-sat:11:00", + "PendingModifiedValues": {}, + "CacheSecurityGroups": [], + "CacheParameterGroup": { + "CacheParameterGroupName": "default.redis5.0", + "ParameterApplyStatus": "in-sync", + "CacheNodeIdsToReboot": [] + }, + "CacheSubnetGroupName": "default", + "AutoMinorVersionUpgrade": true, + "SnapshotRetentionLimit": 0, + "SnapshotWindow": "07:00-08:00", + "TransitEncryptionEnabled": false, + "AtRestEncryptionEnabled": false + } + } + +For more information, see `Modifying an ElastiCache Cluster `__ in the *Elasticache User Guide*. diff -Nru awscli-1.11.13/awscli/examples/elasticache/modify-cache-parameter-group.rst awscli-1.18.69/awscli/examples/elasticache/modify-cache-parameter-group.rst --- awscli-1.11.13/awscli/examples/elasticache/modify-cache-parameter-group.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/elasticache/modify-cache-parameter-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,17 +1,15 @@ -**To modify cache parameter groups** - -This example modifies parameters for the specified cache parameter group. - -Command:: - - aws elasticache modify-cache-parameter-group \ - --cache-parameter-group-name my-redis-28 --parameter-name-values \ - ParameterName=close-on-slave-write,ParameterValue=no \ - ParameterName=timeout,ParameterValue=60 - -Output:: - - { - "CacheParameterGroupName": "my-redis-28" - } - +**To modify a cache parameter group** + +The following ``modify-cache-parameter-group`` example modifies the parameters of the specified cache parameter group. :: + + aws elasticache modify-cache-parameter-group \ + --cache-parameter-group-name "mygroup" \ + --parameter-name-values "ParameterName=activedefrag, ParameterValue=no" + +Output:: + + { + "CacheParameterGroupName": "mygroup" + } + +For more information, see `Modifying a Parameter Group `__ in the *Elasticache User Guide*. diff -Nru awscli-1.11.13/awscli/examples/elasticache/modify-cache-subnet-group.rst awscli-1.18.69/awscli/examples/elasticache/modify-cache-subnet-group.rst --- awscli-1.11.13/awscli/examples/elasticache/modify-cache-subnet-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/elasticache/modify-cache-subnet-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,27 @@ +**To modify a cache subnet group** + +The following ``modify-cache-subnet-group`` example modifies the specified cache subnet group. :: + + aws elasticache modify-cache-subnet-group \ + --cache-subnet-group-name kxkxk \ + --cache-subnet-group-description "mygroup" + +Output:: + + { + "CacheSubnetGroup": { + "CacheSubnetGroupName": "kxkxk", + "CacheSubnetGroupDescription": "mygroup", + "VpcId": "vpc-xxxxcdb", + "Subnets": [ + { + "SubnetIdentifier": "subnet-xxxxbff", + "SubnetAvailabilityZone": { + "Name": "us-west-2a" + } + } + ] + } + } + +For more information, see `Modifying a Subnet Group `__ in the *Elasticache User Guide*. diff -Nru awscli-1.11.13/awscli/examples/elasticache/modify-replication-group.rst awscli-1.18.69/awscli/examples/elasticache/modify-replication-group.rst --- awscli-1.11.13/awscli/examples/elasticache/modify-replication-group.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/elasticache/modify-replication-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,11 +1,113 @@ -**To promote a cache cluster to the primary role** - -This example promotes the cache cluster *mycluster-002* to the primary role for the specified replication group. - -Command:: - - aws elasticache modify-replication-group --replication-group-id mycluster \ - --primary-cluster-id mycluster-002 --apply-immediately - -The nodes of all other cache clusters in the replication group will be read replicas. -If the specified group's *autofailover* is enabled, you cannot mannualy promote cache clusters. +**To modify a replication group** + +The following ``modify-replication-group`` example modifies the settings for the specified replication group. +For Redis (cluster mode enabled) clusters, this operation cannot be used to change a cluster's node type or engine version. :: + + aws elasticache modify-replication-group / + --replication-group-id "my cluster" / + --replication-group-description "my cluster" / + --preferred-maintenance-window sun:23:00-mon:01:30 / + --notification-topic-arn arn:aws:sns:us-west-2:xxxxxxxxxxxxxx52:My_Topic + +Output:: + + { + "ReplicationGroup": { + "ReplicationGroupId": "mycluster", + "Description": "mycluster", + "Status": "available", + "PendingModifiedValues": {}, + "MemberClusters": [ + "mycluster-0001-001", + "mycluster-0001-002", + "mycluster-0001-003", + "mycluster-0003-001", + "mycluster-0003-002", + "mycluster-0003-003", + "mycluster-0004-001", + "mycluster-0004-002", + "mycluster-0004-003" + ], + "NodeGroups": [ + { + "NodeGroupId": "0001", + "Status": "available", + "Slots": "0-1767,3134-5461,6827-8191", + "NodeGroupMembers": [ + { + "CacheClusterId": "mycluster-0001-001", + "CacheNodeId": "0001", + "PreferredAvailabilityZone": "us-west-2b" + }, + { + "CacheClusterId": "mycluster-0001-002", + "CacheNodeId": "0001", + "PreferredAvailabilityZone": "us-west-2a" + }, + { + "CacheClusterId": "mycluster-0001-003", + "CacheNodeId": "0001", + "PreferredAvailabilityZone": "us-west-2c" + } + ] + }, + { + "NodeGroupId": "0003", + "Status": "available", + "Slots": "5462-6826,10923-11075,12441-16383", + "NodeGroupMembers": [ + { + "CacheClusterId": "mycluster-0003-001", + "CacheNodeId": "0001", + "PreferredAvailabilityZone": "us-west-2c" + }, + { + "CacheClusterId": "mycluster-0003-002", + "CacheNodeId": "0001", + "PreferredAvailabilityZone": "us-west-2b" + }, + { + "CacheClusterId": "mycluster-0003-003", + "CacheNodeId": "0001", + "PreferredAvailabilityZone": "us-west-2a" + } + ] + }, + { + "NodeGroupId": "0004", + "Status": "available", + "Slots": "1768-3133,8192-10922,11076-12440", + "NodeGroupMembers": [ + { + "CacheClusterId": "mycluster-0004-001", + "CacheNodeId": "0001", + "PreferredAvailabilityZone": "us-west-2b" + }, + { + "CacheClusterId": "mycluster-0004-002", + "CacheNodeId": "0001", + "PreferredAvailabilityZone": "us-west-2a" + }, + { + "CacheClusterId": "mycluster-0004-003", + "CacheNodeId": "0001", + "PreferredAvailabilityZone": "us-west-2c" + } + ] + } + ], + "AutomaticFailover": "enabled", + "ConfigurationEndpoint": { + "Address": "mycluster.xxxxxx.clustercfg.usw2.cache.amazonaws.com", + "Port": 6379 + }, + "SnapshotRetentionLimit": 1, + "SnapshotWindow": "13:00-14:00", + "ClusterEnabled": true, + "CacheNodeType": "cache.r5.large", + "TransitEncryptionEnabled": false, + "AtRestEncryptionEnabled": false + } + } + +For more information, see `Modifying a Replication Group __ in the *Elasticache User Guide*. diff -Nru awscli-1.11.13/awscli/examples/elasticache/reboot-cache-cluster.rst awscli-1.18.69/awscli/examples/elasticache/reboot-cache-cluster.rst --- awscli-1.11.13/awscli/examples/elasticache/reboot-cache-cluster.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/elasticache/reboot-cache-cluster.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,54 @@ +**To reboot a cache cluster** + +The following ``reboot-cache-cluster`` example reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cluster. During the reboot, the cluster status is set to ``REBOOTING``. :: + + aws elasticache reboot-cache-cluster \ + --cache-cluster-id "my-cluster-001" \ + --cache-node-ids-to-reboot "0001" + +Output:: + + { + "CacheCluster": { + "CacheClusterId": "my-cluster-001", + "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", + "CacheNodeType": "cache.r5.xlarge", + "Engine": "redis", + "EngineVersion": "5.0.5", + "CacheClusterStatus": "rebooting cache cluster nodes", + "NumCacheNodes": 1, + "PreferredAvailabilityZone": "us-west-2a", + "CacheClusterCreateTime": "2019-11-26T03:35:04.546Z", + "PreferredMaintenanceWindow": "mon:04:05-mon:05:05", + "PendingModifiedValues": {}, + "NotificationConfiguration": { + "TopicArn": "arn:aws:sns:us-west-2:xxxxxxxxxx152:My_Topic", + "TopicStatus": "active" + }, + "CacheSecurityGroups": [], + "CacheParameterGroup": { + "CacheParameterGroupName": "mygroup", + "ParameterApplyStatus": "in-sync", + "CacheNodeIdsToReboot": [] + }, + "CacheSubnetGroupName": "kxkxk", + "AutoMinorVersionUpgrade": true, + "SecurityGroups": [ + { + "SecurityGroupId": "sg-xxxxxxxxxxxxx836", + "Status": "active" + }, + { + "SecurityGroupId": "sg-xxxxxxxx7b", + "Status": "active" + } + ], + "ReplicationGroupId": "my-cluster", + "SnapshotRetentionLimit": 0, + "SnapshotWindow": "07:30-08:30", + "TransitEncryptionEnabled": false, + "AtRestEncryptionEnabled": false + } + } + +For more information, see `Rebooting a Cluster `_ in the *Amazon EMR Management Guide*. -**1. Quick start: to create an Amazon EMR cluster** +**Example 1: To create a cluster** -- Command:: +The following ``create-cluster`` example creates a simple EMR cluster. :: - aws emr create-cluster --release-label emr-5.0.0 --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m3.xlarge InstanceGroupType=CORE,InstanceCount=2,InstanceType=m3.xlarge --auto-terminate + aws emr create-cluster \ + --release-label emr-5.14.0 \ + --instance-type m4.large \ + --instance-count 2 -**2. Create an Amazon EMR cluster with ServiceRole and InstanceProfile** +**Example 2: To create an Amazon EMR cluster with default ServiceRole and InstanceProfile roles** -- Command:: +The following ``create-cluster`` example creates an Amazon EMR cluster that uses the ``--instance-groups`` configuration. :: - aws emr create-cluster --release-label emr-5.0.0 --service-role EMR_DefaultRole --ec2-attributes InstanceProfile=EMR_EC2_DefaultRole --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m3.xlarge InstanceGroupType=CORE,InstanceCount=2,InstanceType=m3.xlarge + aws emr create-cluster \ + --release-label emr-5.14.0 \ + --service-role EMR_DefaultRole \ + --ec2-attributes InstanceProfile=EMR_EC2_DefaultRole \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large -**3. Create an Amazon EMR cluster with default roles** +**Example 3: To create an Amazon EMR cluster that uses an instance fleet** -- Command:: +The following ``create-cluster`` example creates an Amazon EMR cluster that uses the ``--instance-fleets`` configuration, specifying two instance types for each fleet and two EC2 Subnets. :: - aws emr create-cluster --release-label emr-5.0.0 --use-default-roles --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m3.xlarge InstanceGroupType=CORE,InstanceCount=2,InstanceType=m3.xlarge --auto-terminate + aws emr create-cluster \ + --release-label emr-5.14.0 \ + --service-role EMR_DefaultRole \ + --ec2-attributes InstanceProfile=EMR_EC2_DefaultRole,SubnetIds=['subnet-ab12345c','subnet-de67890f'] \ + --instance-fleets InstanceFleetType=MASTER,TargetOnDemandCapacity=1,InstanceTypeConfigs=['{InstanceType=m4.large}'] InstanceFleetType=CORE,TargetSpotCapacity=11,InstanceTypeConfigs=['{InstanceType=m4.large,BidPrice=0.5,WeightedCapacity=3}','{InstanceType=m4.2xlarge,BidPrice=0.9,WeightedCapacity=5}'],LaunchSpecifications={SpotSpecification='{TimeoutDurationMinutes=120,TimeoutAction=SWITCH_TO_ON_DEMAND}'} -**4. Create an Amazon EMR cluster with applications** +**Example 4: To create a cluster with default roles** -- Create an Amazon EMR cluster with Hadoop, Hive and Pig installed:: +The following ``create-cluster`` example uses the ``--use-default-roles`` parameter to specify the default service role and instance profile. :: - aws emr create-cluster --applications Name=Hadoop Name=Hive Name=Pig --release-label emr-5.0.0 --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m3.xlarge InstanceGroupType=CORE,InstanceCount=2,InstanceType=m3.xlarge --auto-terminate - -- Create an Amazon EMR cluster with Spark installed: + aws emr create-cluster \ + --release-label emr-5.9.0 \ + --use-default-roles \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ + --auto-terminate - aws emr create-cluster --release-label emr-5.0.0 --applications Name=Spark --ec2-attributes KeyName=myKey --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m3.xlarge InstanceGroupType=CORE,InstanceCount=2,InstanceType=m3.xlarge --auto-terminate +**Example 5: To create a cluster and specify the applications to install** -**5. Change configuration for Hadoop MapReduce** +The following ``create-cluster`` example uses the ``--applications`` parameter to specify the applications that Amazon EMR installs. This example installs Hadoop, Hive and Pig. :: -The following example changes the maximum number of map tasks and sets the NameNode heap size: + aws emr create-cluster \ + --applications Name=Hadoop Name=Hive Name=Pig \ + --release-label emr-5.9.0 \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ + --auto-terminate -- Specifying configurations from a local file:: +**Example 6: To create a cluster that includes Spark** - aws emr create-cluster --configurations file://configurations.json --release-label emr-5.0.0 --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m3.xlarge InstanceGroupType=CORE,InstanceCount=2,InstanceType=m3.xlarge --auto-terminate +The following example installs Spark. :: -- Specifying configurations from a file in Amazon S3:: - - aws emr create-cluster --configurations https://s3.amazonaws.com/myBucket/configurations.json --release-label emr-5.0.0 --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m3.xlarge InstanceGroupType=CORE,InstanceCount=2,InstanceType=m3.xlarge --auto-terminate + aws emr create-cluster \ + --release-label emr-5.9.0 \ + --applications Name=Spark \ + --ec2-attributes KeyName=myKey \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ + --auto-terminate -- Contents of configurations.json:: +**Example 7: To specify a custom AMI to use for cluster instances** + +The following ``create-cluster`` example creates a cluster instance based on the Amazon Linux AMI with ID ``ami-a518e6df``. :: + + aws emr create-cluster \ + --name "Cluster with My Custom AMI" \ + --custom-ami-id ami-a518e6df \ + --ebs-root-volume-size 20 \ + --release-label emr-5.9.0 \ + --use-default-roles \ + --instance-count 2 \ + --instance-type m4.large + +**Example 8: To customize application configurations** + +The following examples use the ``--configurations`` parameter to specify a JSON configuration file that contains application customizations for Hadoop. For more information, see `Configuring Applications `_ in the *Amazon EMR Release Guide*. + +Contents of ``configurations.json``:: [ { @@ -63,260 +99,443 @@ } ] } - ] - -**6. Create an Amazon EMR cluster with MASTER, CORE, and TASK instance groups** + ] + +The following example references ``configurations.json`` as a local file. :: + + aws emr create-cluster \ + --configurations file://configurations.json \ + --release-label emr-5.9.0 \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ + --auto-terminate + +The following example references ``configurations.json`` as a file in Amazon S3. :: + + aws emr create-cluster \ + --configurations https://s3.amazonaws.com/myBucket/configurations.json \ + --release-label emr-5.9.0 \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ + --auto-terminate -- Command:: +**Example 9: To create a cluster with master, core, and task instance groups** - aws emr create-cluster --release-label emr-5.0.0 --auto-terminate --instance-groups Name=Master,InstanceGroupType=MASTER,InstanceType=m3.xlarge,InstanceCount=1 Name=Core,InstanceGroupType=CORE,InstanceType=m3.xlarge,InstanceCount=2 Name=Task,InstanceGroupType=TASK,InstanceType=m3.xlarge,InstanceCount=2 +The following ``create-cluster`` example uses ``--instance-groups`` to specify the type and number of EC2 instances to use for master, core, and task instance groups. :: -**7. Specify whether the cluster should terminate after completing all the steps** + aws emr create-cluster \ + --release-label emr-5.9.0 \ + --instance-groups Name=Master,InstanceGroupType=MASTER,InstanceType=m4.large,InstanceCount=1 Name=Core,InstanceGroupType=CORE,InstanceType=m4.large,InstanceCount=2 Name=Task,InstanceGroupType=TASK,InstanceType=m4.large,InstanceCount=2 -- Create an Amazon EMR cluster that terminates after completing all the steps:: +**Example 10: To specify that a cluster should terminate after completing all steps** - aws emr create-cluster --release-label emr-5.0.0 --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m3.xlarge InstanceGroupType=CORE,InstanceCount=2,InstanceType=m3.xlarge --auto-terminate +The following ``create-cluster`` example uses ``--auto-terminate`` to specify that the cluster should shut down automatically after completing all steps. :: -**8. Specify EC2 Attributes** + aws emr create-cluster \ + --release-label emr-5.9.0 \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ + --auto-terminate -- Create an Amazon EMR cluster with the Amazon EC2 key pair "myKey" and instance profile "myProfile":: +**Example 11: To specify cluster configuration details such as the Amazon EC2 key pair, network configuration, and security groups** - aws emr create-cluster --ec2-attributes KeyName=myKey,InstanceProfile=myProfile --release-label emr-5.0.0 --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m3.xlarge InstanceGroupType=CORE,InstanceCount=2,InstanceType=m3.xlarge --auto-terminate +The following ``create-cluster`` example creates a cluster with the Amazon EC2 key pair named ``myKey`` and a customized instance profile named ``myProfile``. Key pairs are used to authorize SSH connections to cluster nodes, most often the master node. For more information, see `Use an Amazon EC2 Key Pair for SSH Credentials `_ in the *Amazon EMR Management Guide*. :: -- Create an Amazon EMR cluster in an Amazon VPC subnet:: + aws emr create-cluster \ + --ec2-attributes KeyName=myKey,InstanceProfile=myProfile \ + --release-label emr-5.9.0 \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ + --auto-terminate - aws emr create-cluster --ec2-attributes SubnetId=subnet-xxxxx --release-label emr-5.0.0 --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m3.xlarge InstanceGroupType=CORE,InstanceCount=2,InstanceType=m3.xlarge --auto-terminate +The following example creates a cluster in an Amazon VPC subnet. :: -- Create an Amazon EMR cluster in an Availability Zone. For example, us-east-1b:: + aws emr create-cluster \ + --ec2-attributes SubnetId=subnet-xxxxx \ + --release-label emr-5.9.0 \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ + --auto-terminate - aws emr create-cluster --ec2-attributes AvailabilityZone=us-east-1b --release-label emr-5.0.0 --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m3.xlarge InstanceGroupType=CORE,InstanceCount=2,InstanceType=m3.xlarge +The following example creates a cluster in the ``us-east-1b`` availability zone. :: -- Create an Amazon EMR cluster specifying the Amazon EC2 security groups:: + aws emr create-cluster \ + --ec2-attributes AvailabilityZone=us-east-1b \ + --release-label emr-5.9.0 \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large - aws emr create-cluster --release-label emr-5.0.0 --service-role myServiceRole --ec2-attributes InstanceProfile=myRole,EmrManagedMasterSecurityGroup=sg-master1,EmrManagedSlaveSecurityGroup=sg-slave1,AdditionalMasterSecurityGroups=[sg-addMaster1,sg-addMaster2,sg-addMaster3,sg-addMaster4],AdditionalSlaveSecurityGroups=[sg-addSlave1,sg-addSlave2,sg-addSlave3,sg-addSlave4] --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m3.xlarge InstanceGroupType=CORE,InstanceCount=2,InstanceType=m3.xlarge +The following example creates a cluster and specifies only the Amazon EMR-managed security groups. :: -- Create an Amazon EMR cluster specifying only the Amazon EMR-managed Amazon EC2 security groups:: + aws emr create-cluster \ + --release-label emr-5.9.0 \ + --service-role myServiceRole \ + --ec2-attributes InstanceProfile=myRole,EmrManagedMasterSecurityGroup=sg-master1,EmrManagedSlaveSecurityGroup=sg-slave1 \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large - aws emr create-cluster --release-label emr-5.0.0 --service-role myServiceRole --ec2-attributes InstanceProfile=myRole,EmrManagedMasterSecurityGroup=sg-master1,EmrManagedSlaveSecurityGroup=sg-slave1 --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m3.xlarge InstanceGroupType=CORE,InstanceCount=2,InstanceType=m3.xlarge +The following example creates a cluster and specifies only additional Amazon EC2 security groups. :: -- Create an Amazon EMR cluster specifying only the additional Amazon EC2 security groups:: + aws emr create-cluster \ + --release-label emr-5.9.0 \ + --service-role myServiceRole \ + --ec2-attributes InstanceProfile=myRole,AdditionalMasterSecurityGroups=[sg-addMaster1,sg-addMaster2,sg-addMaster3,sg-addMaster4],AdditionalSlaveSecurityGroups=[sg-addSlave1,sg-addSlave2,sg-addSlave3,sg-addSlave4] \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large - aws emr create-cluster --release-label emr-5.0.0 --service-role myServiceRole --ec2-attributes InstanceProfile=myRole,AdditionalMasterSecurityGroups=[sg-addMaster1,sg-addMaster2,sg-addMaster3,sg-addMaster4],AdditionalSlaveSecurityGroups=[sg-addSlave1,sg-addSlave2,sg-addSlave3,sg-addSlave4] --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m3.xlarge InstanceGroupType=CORE,InstanceCount=2,InstanceType=m3.xlarge +The following example creates a cluster and specifies the EMR-Managed security groups, as well as additional security groups. :: -- Create an Amazon EMR cluster in a VPC private subnet and use a specific Amazon EC2 security group to enable the Amazon EMR service access (required for clusters in private subnets):: + aws emr create-cluster \ + --release-label emr-5.9.0 \ + --service-role myServiceRole \ + --ec2-attributes InstanceProfile=myRole,EmrManagedMasterSecurityGroup=sg-master1,EmrManagedSlaveSecurityGroup=sg-slave1,AdditionalMasterSecurityGroups=[sg-addMaster1,sg-addMaster2,sg-addMaster3,sg-addMaster4],AdditionalSlaveSecurityGroups=[sg-addSlave1,sg-addSlave2,sg-addSlave3,sg-addSlave4] \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large - aws emr create-cluster --release-label emr-5.0.0 --service-role myServiceRole --ec2-attributes InstanceProfile=myRole,ServiceAccessSecurityGroup=sg-service-access,EmrManagedMasterSecurityGroup=sg-master,EmrManagedSlaveSecurityGroup=sg-slave --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m3.xlarge InstanceGroupType=CORE,InstanceCount=2,InstanceType=m3.xlarge - +The following example creates a cluster in a VPC private subnet and use a specific Amazon EC2 security group to enable Amazon EMR service access, which is required for clusters in private subnets. :: -- JSON equivalent (contents of ec2_attributes.json):: + aws emr create-cluster \ + --release-label emr-5.9.0 \ + --service-role myServiceRole \ + --ec2-attributes InstanceProfile=myRole,ServiceAccessSecurityGroup=sg-service-access,EmrManagedMasterSecurityGroup=sg-master,EmrManagedSlaveSecurityGroup=sg-slave \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large + +The following example specifies security group configuration parameters using a JSON file named ``ec2_attributes.json`` that is stored locally. + +Contents of ``ec2_attributes.json``:: [ - { - "SubnetId": "subnet-xxxxx", - "KeyName": "myKey", - "InstanceProfile":"myRole", - "EmrManagedMasterSecurityGroup": "sg-master1", - "EmrManagedSlaveSecurityGroup": "sg-slave1", - "ServiceAccessSecurityGroup": "sg-service-access" - "AdditionalMasterSecurityGroups": ["sg-addMaster1","sg-addMaster2","sg-addMaster3","sg-addMaster4"], - "AdditionalSlaveSecurityGroups": ["sg-addSlave1","sg-addSlave2","sg-addSlave3","sg-addSlave4"] - } - ] + { + "SubnetId": "subnet-xxxxx", + "KeyName": "myKey", + "InstanceProfile":"myRole", + "EmrManagedMasterSecurityGroup": "sg-master1", + "EmrManagedSlaveSecurityGroup": "sg-slave1", + "ServiceAccessSecurityGroup": "sg-service-access" + "AdditionalMasterSecurityGroups": ["sg-addMaster1","sg-addMaster2","sg-addMaster3","sg-addMaster4"], + "AdditionalSlaveSecurityGroups": ["sg-addSlave1","sg-addSlave2","sg-addSlave3","sg-addSlave4"] + } + ] NOTE: JSON arguments must include options and values as their own items in the list. -- Command (using ec2_attributes.json):: +Command:: - aws emr create-cluster --release-label emr-5.0.0 --service-role myServiceRole --ec2-attributes file://./ec2_attributes.json --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m3.xlarge InstanceGroupType=CORE,InstanceCount=2,InstanceType=m3.xlarge + aws emr create-cluster \ + --release-label emr-5.9.0 \ + --service-role myServiceRole \ + --ec2-attributes file://ec2_attributes.json \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large -**9. Enable debugging and specify a Log URI** +**Example 12: To enable debugging and specify a log URI** -- Command:: +The following ``create-cluster`` example uses the ``--enable-debugging`` parameter, which allows you to view log files more easily using the debugging tool in the Amazon EMR console. The ``--log-uri`` parameter is required with ``--enable-debugging``. :: - aws emr create-cluster --enable-debugging --log-uri s3://myBucket/myLog --release-label emr-5.0.0 --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m3.xlarge InstanceGroupType=CORE,InstanceCount=2,InstanceType=m3.xlarge --auto-terminate + aws emr create-cluster \ + --enable-debugging \ + --log-uri s3://myBucket/myLog \ + --release-label emr-5.9.0 \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ + --auto-terminate -**10. Add tags when creating an Amazon EMR cluster** +**Example 13: To add tags when creating a cluster** -- Add a list of tags:: +Tags are key-value pairs that help you identify and manage clusters. The following ``create-cluster`` example uses the ``--tags`` parameter to create two tags for a cluster, one with the key name ``name`` and the value ``Shirley Rodriguez`` and the other with the key name ``address`` and the value ``123 Maple Street, Anytown, USA``. :: - aws emr create-cluster --tags name="John Doe" age=29 address="123 East NW Seattle" --release-label emr-5.0.0 --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m3.xlarge InstanceGroupType=CORE,InstanceCount=2,InstanceType=m3.xlarge --auto-terminate + aws emr create-cluster \ + --tags name="Shirley Rodriguez" age=29 department="Analytics" \ + --release-label emr-5.9.0 \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ + --auto-terminate -- List tags of an Amazon EMR cluster:: +The following example lists the tags applied to a cluster. :: - aws emr describe-cluster --cluster-id j-XXXXXXYY --query Cluster.Tags + aws emr describe-cluster \ + --cluster-id j-XXXXXXYY \ + --query Cluster.Tags -**11. Use a security configuration to enable encryption** - -- Command:: +**Example 14: To use a security configuration that enables encryption and other security features** - aws emr create-cluster --instance-type m3.xlarge --release-label emr-5.0.0 --security-configuration mySecurityConfiguration - -**12. To create an Amazon EMR cluster with EBS volumes configured to the instance groups** +The following ``create-cluster`` example uses the ``--security-configuration`` parameter to specify a security configuration for an EMR cluster. You can use security configurations with Amazon EMR version 4.8.0 or later. :: -- Create a cluster with multiple EBS volumes attached to the CORE instance group. EBS volumes can be attached to MASTER, CORE, and TASK instance groups. For instance groups with EBS configurations, which have an embedded JSON structure, you should enclose the entire instance group argument with single quotes. For instance groups with no EBS configuration, using single quotes is optional. + aws emr create-cluster \ + --instance-type m4.large \ + --release-label emr-5.9.0 \ + --security-configuration mySecurityConfiguration -- Command:: +**Example 15: To create a cluster with additional EBS storage volumes configured for the instance groups** - aws emr create-cluster --release-label emr-5.0.0 --use-default-roles --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=d2.xlarge 'InstanceGroupType=CORE,InstanceCount=2,InstanceType=d2.xlarge,EbsConfiguration={EbsOptimized=true,EbsBlockDeviceConfigs=[{VolumeSpecification={VolumeType=gp2,SizeInGB=100}},{VolumeSpecification={VolumeType=io1,SizeInGB=100,Iops=100},VolumesPerInstance=4}]}' --auto-terminate +When specifying additional EBS volumes, the following arguments are required: ``VolumeType``, ``SizeInGB`` if ``EbsBlockDeviceConfigs`` is specified. -- Create a cluster with multiple EBS volumes attached to the MASTER instance group. +The following ``create-cluster`` example creates a cluster with multiple EBS volumes attached to EC2 instances in the core instance group. :: -- Command:: + aws emr create-cluster \ + --release-label emr-5.9.0 \ + --use-default-roles \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=d2.xlarge 'InstanceGroupType=CORE,InstanceCount=2,InstanceType=d2.xlarge,EbsConfiguration={EbsOptimized=true,EbsBlockDeviceConfigs=[{VolumeSpecification={VolumeType=gp2,SizeInGB=100}},{VolumeSpecification={VolumeType=io1,SizeInGB=100,Iops=100},VolumesPerInstance=4}]}' \ + --auto-terminate - aws emr create-cluster --release-label emr-5.0.0 --use-default-roles --instance-groups 'InstanceGroupType=MASTER, InstanceCount=1, InstanceType=d2.xlarge, EbsConfiguration={EbsOptimized=true, EbsBlockDeviceConfigs=[{VolumeSpecification={VolumeType=io1, SizeInGB=100, Iops=100}},{VolumeSpecification={VolumeType=standard,SizeInGB=50},VolumesPerInstance=3}]}' InstanceGroupType=CORE,InstanceCount=2,InstanceType=d2.xlarge --auto-terminate +The following example creates a cluster with multiple EBS volumes attached to EC2 instances in the master instance group. :: -- Required parameters:: - - VolumeType, SizeInGB if EbsBlockDeviceConfigs specified + aws emr create-cluster \ + --release-label emr-5.9.0 \ + --use-default-roles \ + --instance-groups 'InstanceGroupType=MASTER, InstanceCount=1, InstanceType=d2.xlarge, EbsConfiguration={EbsOptimized=true, EbsBlockDeviceConfigs=[{VolumeSpecification={VolumeType=io1, SizeInGB=100, Iops=100}},{VolumeSpecification={VolumeType=standard,SizeInGB=50},VolumesPerInstance=3}]}' InstanceGroupType=CORE,InstanceCount=2,InstanceType=d2.xlarge \ + --auto-terminate -**13. To add custom JAR steps to a cluster when creating an Amazon EMR cluster** +**Example 16: To create a cluster with an automatic scaling policy** -- Command:: +You can attach automatic scaling policies to core and task instance groups using Amazon EMR version 4.0 and later. The automatic scaling policy dynamically adds and removes EC2 instances in response to an Amazon CloudWatch metric. For more information, see `Using Automatic Scaling in Amazon EMR` `_ in the *Amazon EMR Management Guide*. - aws emr create-cluster --steps Type=CUSTOM_JAR,Name=CustomJAR,ActionOnFailure=CONTINUE,Jar=s3://myBucket/mytest.jar,Args=arg1,arg2,arg3 Type=CUSTOM_JAR,Name=CustomJAR,ActionOnFailure=CONTINUE,Jar=s3://myBucket/mytest.jar,MainClass=mymainclass,Args=arg1,arg2,arg3 --release-label emr-5.0.0 --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m3.xlarge InstanceGroupType=CORE,InstanceCount=2,InstanceType=m3.xlarge --auto-terminate +When attaching an automatic scaling policy, you must also specify the default role for automatic scaling using ``--auto-scaling-role EMR_AutoScaling_DefaultRole``. -- Custom JAR steps required parameters:: +The following ``create-cluster`` example specifies the automatic scaling policy for the ``CORE`` instance group using the ``AutoScalingPolicy`` argument with an embedded JSON structure, which specifies the scaling policy configuration. Instance groups with an embedded JSON structure must have the entire collection of arguments enclosed in single quotes. Using single quotes is optional for instance groups without an embedded JSON structure. :: - Jar + aws emr create-cluster + --release-label emr-5.9.0 \ + --use-default-roles --auto-scaling-role EMR_AutoScaling_DefaultRole \ + --instance-groups InstanceGroupType=MASTER,InstanceType=d2.xlarge,InstanceCount=1 'InstanceGroupType=CORE,InstanceType=d2.xlarge,InstanceCount=2,AutoScalingPolicy={Constraints={MinCapacity=1,MaxCapacity=5},Rules=[{Name=TestRule,Description=TestDescription,Action={Market=ON_DEMAND,SimpleScalingPolicyConfiguration={AdjustmentType=EXACT_CAPACITY,ScalingAdjustment=2}},Trigger={CloudWatchAlarmDefinition={ComparisonOperator=GREATER_THAN,EvaluationPeriods=5,MetricName=TestMetric,Namespace=EMR,Period=3,Statistic=MAXIMUM,Threshold=4.5,Unit=NONE,Dimensions=[{Key=TestKey,Value=TestValue}]}}}]}' -- Custom JAR steps optional parameters:: +The following example uses a JSON file, ``instancegroupconfig.json``, to specify the configuration of all instance groups in a cluster. The JSON file specifies the automatic scaling policy configuration for the core instance group. - Type, Name, ActionOnFailure, Args +Contents of ``instancegroupconfig.json``:: -**14. To add streaming steps when creating an Amazon EMR cluster** + [ + { + "InstanceCount": 1, + "Name": "MyMasterIG", + "InstanceGroupType": "MASTER", + "InstanceType": "m4.large" + }, + { + "InstanceCount": 2, + "Name": "MyCoreIG", + "InstanceGroupType": "CORE", + "InstanceType": "m4.large", + "AutoScalingPolicy": { + "Constraints": { + "MinCapacity": 2, + "MaxCapacity": 10 + }, + "Rules": [ + { + "Name": "Default-scale-out", + "Description": "Replicates the default scale-out rule in the console for YARN memory.", + "Action": { + "SimpleScalingPolicyConfiguration": { + "AdjustmentType": "CHANGE_IN_CAPACITY", + "ScalingAdjustment": 1, + "CoolDown": 300 + } + }, + "Trigger": { + "CloudWatchAlarmDefinition": { + "ComparisonOperator": "LESS_THAN", + "EvaluationPeriods": 1, + "MetricName": "YARNMemoryAvailablePercentage", + "Namespace": "AWS/ElasticMapReduce", + "Period": 300, + "Threshold": 15, + "Statistic": "AVERAGE", + "Unit": "PERCENT", + "Dimensions": [ + { + "Key": "JobFlowId", + "Value": "${emr.clusterId}" + } + ] + } + } + } + ] + } + } + ] + +Command:: + + aws emr create-cluster \ + --release-label emr-5.9.0 \ + --service-role EMR_DefaultRole \ + --ec2-attributes InstanceProfile=EMR_EC2_DefaultRole \ + --instance-groups s3://mybucket/instancegroupconfig.json \ + --auto-scaling-role EMR_AutoScaling_DefaultRole + +**Example 17: Add custom JAR steps when creating a cluster** + +The following ``create-cluster`` example adds steps by specifying a JAR file stored in Amazon S3. Steps submit work to a cluster. The main function defined in the JAR file executes after EC2 instances are provisioned, any bootstrap actions have executed, and applications are installed. The steps are specified using ``Type=CUSTOM_JAR``. + +Custom JAR steps required the ``Jar=`` parameter, which specifies the path and file name of the JAR. Optional parameters are the following:: + + Type, Name, ActionOnFailure, Args, MainClass + +If main class is not specified, the JAR file should specify Main-Class in its manifest file. + +Command:: + + aws emr create-cluster \ + --steps Type=CUSTOM_JAR,Name=CustomJAR,ActionOnFailure=CONTINUE,Jar=s3://myBucket/mytest.jar,Args=arg1,arg2,arg3 Type=CUSTOM_JAR,Name=CustomJAR,ActionOnFailure=CONTINUE,Jar=s3://myBucket/mytest.jar,MainClass=mymainclass,Args=arg1,arg2,arg3 \ + --release-label emr-5.3.1 \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ + --auto-terminate -- Command:: +**Example 18: To add streaming steps when creating a cluster** - aws emr create-cluster --steps Type=STREAMING,Name='Streaming Program',ActionOnFailure=CONTINUE,Args=[-files,s3://elasticmapreduce/samples/wordcount/wordSplitter.py,-mapper,wordSplitter.py,-reducer,aggregate,-input,s3://elasticmapreduce/samples/wordcount/input,-output,s3://mybucket/wordcount/output] --release-label emr-5.0.0 --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m3.xlarge InstanceGroupType=CORE,InstanceCount=2,InstanceType=m3.xlarge --auto-terminate +The following ``create-cluster`` examples add a streaming step to a cluster that terminates after all steps run. -- Streaming steps required parameters:: +Streaming steps required parameters:: Type, Args -- Streaming steps optional parameters:: +Streaming steps optional parameters:: Name, ActionOnFailure -- JSON equivalent (contents of step.json):: +The following example specifies the step inline. :: - [ - { - "Name": "JSON Streaming Step", - "Args": ["-files","s3://elasticmapreduce/samples/wordcount/wordSplitter.py","-mapper","wordSplitter.py","-reducer","aggregate","-input","s3://elasticmapreduce/samples/wordcount/input","-output","s3://mybucket/wordcount/output"], - "ActionOnFailure": "CONTINUE", - "Type": "STREAMING" - } - ] + aws emr create-cluster \ + --steps Type=STREAMING,Name='Streaming Program',ActionOnFailure=CONTINUE,Args=[-files,s3://elasticmapreduce/samples/wordcount/wordSplitter.py,-mapper,wordSplitter.py,-reducer,aggregate,-input,s3://elasticmapreduce/samples/wordcount/input,-output,s3://mybucket/wordcount/output] \ + --release-label emr-5.3.1 \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ + --auto-terminate -NOTE: JSON arguments must include options and values as their own items in the list. - -- Command (using step.json):: +The following example uses a locally stored JSON configuration file named ``multiplefiles.json``. The JSON configuration specifies multiple files. To specify multiple files within a step, you must use a JSON configuration file to specify the step. - aws emr create-cluster --steps file://./step.json --release-label emr-4.0.0 --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m3.xlarge InstanceGroupType=CORE,InstanceCount=2,InstanceType=m3.xlarge --auto-terminate +Contents of ``multiplefiles.json``:: -**15. To use multiple files in a streaming step (JSON only)** + [ + { + "Name": "JSON Streaming Step", + "Args": [ + "-files", + "s3://elasticmapreduce/samples/wordcount/wordSplitter.py", + "-mapper", + "wordSplitter.py", + "-reducer", + "aggregate", + "-input", + "s3://elasticmapreduce/samples/wordcount/input", + "-output", + "s3://mybucket/wordcount/output" + ], + "ActionOnFailure": "CONTINUE", + "Type": "STREAMING" + } + ] -- JSON (multiplefiles.json):: +NOTE: JSON arguments must include options and values as their own items in the list. - [ - { - "Name": "JSON Streaming Step", - "Type": "STREAMING", - "ActionOnFailure": "CONTINUE", - "Args": [ - "-files", - "s3://mybucket/mapper.py,s3://mybucket/reducer.py", - "-mapper", - "mapper.py", - "-reducer", - "reducer.py", - "-input", - "s3://mybucket/input", - "-output", - "s3://mybucket/output"] - } - ] +Command:: -- Command:: + aws emr create-cluster \ + --steps file://./multiplefiles.json \ + --release-label emr-5.9.0 \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ + --auto-terminate - aws emr create-cluster --steps file://./multiplefiles.json --release-label emr-5.0.0 --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m3.xlarge InstanceGroupType=CORE,InstanceCount=2,InstanceType=m3.xlarge --auto-terminate +**Example 19: To add Hive steps when creating a cluster** -**16. To add Hive steps when creating an Amazon EMR cluster** +Command:: -- Command:: + aws emr create-cluster \ + --steps Type=HIVE,Name='Hive program',ActionOnFailure=CONTINUE,ActionOnFailure=TERMINATE_CLUSTER,Args=[-f,s3://elasticmapreduce/samples/hive-ads/libs/model-build.q,-d,INPUT=s3://elasticmapreduce/samples/hive-ads/tables,-d,OUTPUT=s3://mybucket/hive-ads/output/2014-04-18/11-07-32,-d,LIBS=s3://elasticmapreduce/samples/hive-ads/libs] \ + --applications Name=Hive \ + --release-label emr-5.3.1 \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large - aws emr create-cluster --steps Type=HIVE,Name='Hive program',ActionOnFailure=CONTINUE,ActionOnFailure=TERMINATE_CLUSTER,Args=[-f,s3://elasticmapreduce/samples/hive-ads/libs/model-build.q,-d,INPUT=s3://elasticmapreduce/samples/hive-ads/tables,-d,OUTPUT=s3://mybucket/hive-ads/output/2014-04-18/11-07-32,-d,LIBS=s3://elasticmapreduce/samples/hive-ads/libs] --applications Name=Hive --release-label emr-5.0.0 --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m3.xlarge InstanceGroupType=CORE,InstanceCount=2,InstanceType=m3.xlarge - -- Hive steps required parameters:: +Hive steps required parameters:: Type, Args -- Hive steps optional parameters:: +Hive steps optional parameters:: Name, ActionOnFailure -**17. To add Pig steps when creating an Amazon EMR cluster** +**Example 20: To add Pig steps when creating a cluster** -- Command:: +Command:: - aws emr create-cluster --steps Type=PIG,Name='Pig program',ActionOnFailure=CONTINUE,Args=[-f,s3://elasticmapreduce/samples/pig-apache/do-reports2.pig,-p,INPUT=s3://elasticmapreduce/samples/pig-apache/input,-p,OUTPUT=s3://mybucket/pig-apache/output] --applications Name=Pig --release-label emr-5.0.0 --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m3.xlarge InstanceGroupType=CORE,InstanceCount=2,InstanceType=m3.xlarge + aws emr create-cluster \ + --steps Type=PIG,Name='Pig program',ActionOnFailure=CONTINUE,Args=[-f,s3://elasticmapreduce/samples/pig-apache/do-reports2.pig,-p,INPUT=s3://elasticmapreduce/samples/pig-apache/input,-p,OUTPUT=s3://mybucket/pig-apache/output] \ + --applications Name=Pig \ + --release-label emr-5.3.1 \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large -- Pig steps required parameters:: +Pig steps required parameters:: Type, Args -- Pig steps optional parameters:: +Pig steps optional parameters:: + + Name, ActionOnFailure + +**Example 21: To add bootstrap actions** + +The following ``create-cluster`` example runs two bootstrap actions defined as scripts that are stored in Amazon S3. :: - Name, ActionOnFailure + aws emr create-cluster \ + --bootstrap-actions Path=s3://mybucket/myscript1,Name=BootstrapAction1,Args=[arg1,arg2] Path=s3://mybucket/myscript2,Name=BootstrapAction2,Args=[arg1,arg2] \ + --release-label emr-5.3.1 \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ + --auto-terminate -**18. Add a list of bootstrap actions when creating an Amazon EMR Cluster** +**Example 22: To enable EMRFS consistent view and customize the RetryCount and RetryPeriod settings** -- Command:: +The following ``create-cluster`` example specifies the retry count and retry period for EMRFS consistent view. The ``Consistent=true`` argument is required. :: - aws emr create-cluster --bootstrap-actions Path=s3://mybucket/myscript1,Name=BootstrapAction1,Args=[arg1,arg2] Path=s3://mybucket/myscript2,Name=BootstrapAction2,Args=[arg1,arg2] --release-label emr-5.0.0 --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m3.xlarge InstanceGroupType=CORE,InstanceCount=2,InstanceType=m3.xlarge --auto-terminate - -**19. To enable consistent view in EMRFS and change the RetryCount and Retry Period settings when creating an Amazon EMR cluster** + aws emr create-cluster \ + --instance-type m4.large \ + --release-label emr-5.9.0 \ + --emrfs Consistent=true,RetryCount=6,RetryPeriod=30 -- Command:: +The following example specifies the same EMRFS configuration as the previous example, using a locally stored JSON configuration file named ``emrfsconfig.json``. - aws emr create-cluster --instance-type m3.xlarge --release-label emr-5.0.0 --emrfs Consistent=true,RetryCount=5,RetryPeriod=30 - -- Required parameters:: - - Consistent=true +Contents of ``emrfsconfig.json``:: -- JSON equivalent (contents of emrfs.json):: - { - "Consistent": true, - "RetryCount": 5, - "RetryPeriod": 30 + "Consistent": true, + "RetryCount": 6, + "RetryPeriod": 30 } - -- Command (Using emrfs.json):: - - aws emr create-cluster --instance-type m3.xlarge --release-label emr-5.0.0 --emrfs file://emrfs.json - -**20. To enable consistent view with arguments e.g. change the DynamoDB read and write capacity when creating an Amazon EMR cluster** +Command:: + + aws emr create-cluster \ + --instance-type m4.large \ + --release-label emr-5.9.0 \ + --emrfs file://emrfsconfig.json + +**Example 23: To create a cluster with Kerberos configured** -- Command:: +The following ``create-cluster`` examples create a cluster using a security configuration with Kerberos enabled, and establishes Kerberos parameters for the cluster using ``--kerberos-attributes``. - aws emr create-cluster --instance-type m3.xlarge --release-label emr-5.0.0 --emrfs Consistent=true,RetryCount=5,RetryPeriod=30,Args=[fs.s3.consistent.metadata.read.capacity=600,fs.s3.consistent.metadata.write.capacity=300] +The following command specifies Kerberos attributes for the cluster inline. :: -- Required parameters:: - - Consistent=true + aws emr create-cluster \ + --instance-type m3.xlarge \ + --release-label emr-5.10.0 \ + --service-role EMR_DefaultRole \ + --ec2-attributes InstanceProfile=EMR_EC2_DefaultRole \ + --security-configuration mySecurityConfiguration \ + --kerberos-attributes Realm=EC2.INTERNAL,KdcAdminPassword=123,CrossRealmTrustPrincipalPassword=123 + +The following command specifies the same attributes, but references a locally stored JSON file named ``kerberos_attributes.json``. In this example, the file is saved in the same directory where you run the command. You can also reference a configuration file saved in Amazon S3. + +Contents of ``kerberos_attributes.json``:: -- JSON equivalent (contents of emrfs.json):: - { - "Consistent": true, - "RetryCount": 5, - "RetryPeriod": 30, - "Args":["fs.s3.consistent.metadata.read.capacity=600", "fs.s3.consistent.metadata.write.capacity=300"] + "Realm": "EC2.INTERNAL", + "KdcAdminPassword": "123", + "CrossRealmTrustPrincipalPassword": "123", } -- Command (Using emrfs.json):: - - aws emr create-cluster --instance-type m3.xlarge --release-label emr-5.0.0 --emrfs file://emrfs.json \ No newline at end of file +Command:: + + aws emr create-cluster \ + --instance-type m3.xlarge \ + --release-label emr-5.10.0 \ + --service-role EMR_DefaultRole \ + --ec2-attributes InstanceProfile=EMR_EC2_DefaultRole \ + --security-configuration mySecurityConfiguration \ + --kerberos-attributes file://kerberos_attributes.json + +The following ``create-cluster`` example creates an Amazon EMR cluster that uses the ``--instance-groups`` configuration and has a managed scaling policy. :: + + aws emr create-cluster \ + --release-label emr-5.30.0 \ + --service-role EMR_DefaultRole \ + --ec2-attributes InstanceProfile=EMR_EC2_DefaultRole \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large + --managed-scaling-policy ComputeLimits='{MinimumCapacityUnits=2,MaximumCapacityUnits=4,UnitType=Instances}' + diff -Nru awscli-1.11.13/awscli/examples/emr/create-cluster-synopsis.rst awscli-1.18.69/awscli/examples/emr/create-cluster-synopsis.rst --- awscli-1.11.13/awscli/examples/emr/create-cluster-synopsis.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/emr/create-cluster-synopsis.rst 1970-01-01 00:00:00.000000000 +0000 @@ -1,22 +0,0 @@ - create-cluster - --release-label | --ami-version - --instance-type | --instance-groups - --instance-count - [--auto-terminate | --no-auto-terminate] - [--use-default-roles] - [--service-role ] - [--configurations ] - [--name ] - [--log-uri ] - [--additional-info ] - [--ec2-attributes ] - [--termination-protected | --no-termination-protected] - [--visible-to-all-users | --no-visible-to-all-users] - [--enable-debugging | --no-enable-debugging] - [--tags ] - [--applications ] - [--emrfs ] - [--bootstrap-actions ] - [--steps ] - [--restore-from-hbase-backup ] - [--security-configuration ] diff -Nru awscli-1.11.13/awscli/examples/emr/create-cluster-synopsis.txt awscli-1.18.69/awscli/examples/emr/create-cluster-synopsis.txt --- awscli-1.11.13/awscli/examples/emr/create-cluster-synopsis.txt 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/emr/create-cluster-synopsis.txt 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,27 @@ + create-cluster + --release-label | --ami-version + --instance-fleets | --instance-groups | --instance-type --instance-count + [--auto-terminate | --no-auto-terminate] + [--use-default-roles] + [--service-role ] + [--configurations ] + [--name ] + [--log-uri ] + [--additional-info ] + [--ec2-attributes ] + [--termination-protected | --no-termination-protected] + [--scale-down-behavior ] + [--visible-to-all-users | --no-visible-to-all-users] + [--enable-debugging | --no-enable-debugging] + [--tags ] + [--applications ] + [--emrfs ] + [--bootstrap-actions ] + [--steps ] + [--restore-from-hbase-backup ] + [--security-configuration ] + [--custom-ami-id ] + [--ebs-root-volume-size ] + [--repo-upgrade-on-boot ] + [--kerberos-attributes ] + [--managed-scaling-policy ] diff -Nru awscli-1.11.13/awscli/examples/emr/create-security-configuration.rst awscli-1.18.69/awscli/examples/emr/create-security-configuration.rst --- awscli-1.11.13/awscli/examples/emr/create-security-configuration.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/emr/create-security-configuration.rst 2020-05-28 19:25:48.000000000 +0000 @@ -65,3 +65,61 @@ "CreationDateTime": 1474070889.129, "Name": "MySecurityConfig" } + +**2. To create a security configuration with Kerberos enabled using cluster-dedicated KDC and cross-realm trust** + +- Command:: + + aws emr create-security-configuration --name MySecurityConfig --security-configuration '{ + "AuthenticationConfiguration": { + "KerberosConfiguration": { + "Provider": "ClusterDedicatedKdc", + "ClusterDedicatedKdcConfiguration": { + "TicketLifetimeInHours": 24, + "CrossRealmTrustConfiguration": { + "Realm": "AD.DOMAIN.COM", + "Domain": "ad.domain.com", + "AdminServer": "ad.domain.com", + "KdcServer": "ad.domain.com" + } + } + } + } + }' + +- Output:: + + { + "CreationDateTime": 1490225558.982, + "Name": "MySecurityConfig" + } + +- JSON equivalent (contents of security_configuration.json):: + + { + "AuthenticationConfiguration": { + "KerberosConfiguration": { + "Provider": "ClusterDedicatedKdc", + "ClusterDedicatedKdcConfiguration": { + "TicketLifetimeInHours": 24, + "CrossRealmTrustConfiguration": { + "Realm": "AD.DOMAIN.COM", + "Domain": "ad.domain.com", + "AdminServer": "ad.domain.com", + "KdcServer": "ad.domain.com" + } + } + } + } + } + +- Command (using security_configuration.json):: + + aws emr create-security-configuration --name "MySecurityConfig" --security-configuration file://./security_configuration.json + +- Output:: + + { + "CreationDateTime": 1490225558.982, + "Name": "MySecurityConfig" + } diff -Nru awscli-1.11.13/awscli/examples/emr/describe-cluster.rst awscli-1.18.69/awscli/examples/emr/describe-cluster.rst --- awscli-1.11.13/awscli/examples/emr/describe-cluster.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/emr/describe-cluster.rst 2020-05-28 19:25:48.000000000 +0000 @@ -4,7 +4,7 @@ - Output:: - For release-label based cluster: + For release-label based uniform instance groups cluster: { "Cluster": { @@ -101,7 +101,85 @@ } - For ami based cluster: + For release-label based instance fleet cluster: + { + "Cluster": { + "Status": { + "Timeline": { + "ReadyDateTime": 1487897289.705, + "CreationDateTime": 1487896933.942 + }, + "State": "WAITING", + "StateChangeReason": { + "Message": "Waiting for steps to run" + } + }, + "Ec2InstanceAttributes": { + "EmrManagedMasterSecurityGroup": "sg-xxxxx", + "RequestedEc2AvailabilityZones": [], + "RequestedEc2SubnetIds": [], + "IamInstanceProfile": "EMR_EC2_DefaultRole", + "Ec2AvailabilityZone": "us-east-1a", + "EmrManagedSlaveSecurityGroup": "sg-xxxxx" + }, + "Name": "My Cluster", + "ServiceRole": "EMR_DefaultRole", + "Tags": [], + "TerminationProtected": false, + "ReleaseLabel": "emr-5.2.0", + "NormalizedInstanceHours": 472, + "InstanceCollectionType": "INSTANCE_FLEET", + "InstanceFleets": [ + { + "Status": { + "Timeline": { + "ReadyDateTime": 1487897212.74, + "CreationDateTime": 1487896933.948 + }, + "State": "RUNNING", + "StateChangeReason": { + "Message": "" + } + }, + "ProvisionedSpotCapacity": 1, + "Name": "MASTER", + "InstanceFleetType": "MASTER", + "LaunchSpecifications": { + "SpotSpecification": { + "TimeoutDurationMinutes": 60, + "TimeoutAction": "TERMINATE_CLUSTER" + } + }, + "TargetSpotCapacity": 1, + "ProvisionedOnDemandCapacity": 0, + "InstanceTypeSpecifications": [ + { + "BidPrice": "0.5", + "InstanceType": "m3.xlarge", + "WeightedCapacity": 1 + } + ], + "Id": "if-xxxxxxx", + "TargetOnDemandCapacity": 0 + } + ], + "Applications": [ + { + "Version": "2.7.3", + "Name": "Hadoop" + } + ], + "ScaleDownBehavior": "TERMINATE_AT_INSTANCE_HOUR", + "VisibleToAllUsers": true, + "BootstrapActions": [], + "MasterPublicDnsName": "ec2-xxx-xx-xxx-xx.compute-1.amazonaws.com", + "AutoTerminate": false, + "Id": "j-xxxxx", + "Configurations": [] + } + } + + For ami based uniform instance group cluster: { "Cluster": { diff -Nru awscli-1.11.13/awscli/examples/emr/list-instance-fleets.rst awscli-1.18.69/awscli/examples/emr/list-instance-fleets.rst --- awscli-1.11.13/awscli/examples/emr/list-instance-fleets.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/emr/list-instance-fleets.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,68 @@ +**To get configuration details of instance fleets in a cluster** + +This example lists the details of instance fleets in the cluster specified. + +Command:: + + list-instance-fleets --cluster-id 'j-12ABCDEFGHI34JK' + +Output:: + + { + "InstanceFleets": [ + { + "Status": { + "Timeline": { + "ReadyDateTime": 1488759094.637, + "CreationDateTime": 1488758719.817 + }, + "State": "RUNNING", + "StateChangeReason": { + "Message": "" + } + }, + "ProvisionedSpotCapacity": 6, + "Name": "CORE", + "InstanceFleetType": "CORE", + "LaunchSpecifications": { + "SpotSpecification": { + "TimeoutDurationMinutes": 60, + "TimeoutAction": "TERMINATE_CLUSTER" + } + }, + "ProvisionedOnDemandCapacity": 2, + "InstanceTypeSpecifications": [ + { + "BidPrice": "0.5", + "InstanceType": "m3.xlarge", + "WeightedCapacity": 2 + } + ], + "Id": "if-1ABC2DEFGHIJ3" + }, + { + "Status": { + "Timeline": { + "ReadyDateTime": 1488759058.598, + "CreationDateTime": 1488758719.811 + }, + "State": "RUNNING", + "StateChangeReason": { + "Message": "" + } + }, + "ProvisionedSpotCapacity": 0, + "Name": "MASTER", + "InstanceFleetType": "MASTER", + "ProvisionedOnDemandCapacity": 1, + "InstanceTypeSpecifications": [ + { + "BidPriceAsPercentageOfOnDemandPrice": 100.0, + "InstanceType": "m3.xlarge", + "WeightedCapacity": 1 + } + ], + "Id": "if-2ABC4DEFGHIJ4" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/emr/list-instances.rst awscli-1.18.69/awscli/examples/emr/list-instances.rst --- awscli-1.11.13/awscli/examples/emr/list-instances.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/emr/list-instances.rst 2020-05-28 19:25:48.000000000 +0000 @@ -4,7 +4,8 @@ Output:: - { + For a uniform instance group based cluster + { "Instances": [ { "Status": { @@ -55,4 +56,34 @@ "PrivateIpAddress": "172.21.11.214" } ] - } + } + + + For a fleet based cluster: + { + "Instances": [ + { + "Status": { + "Timeline": { + "ReadyDateTime": 1487810810.878, + "CreationDateTime": 1487810588.367, + "EndDateTime": 1488022990.924 + }, + "State": "TERMINATED", + "StateChangeReason": { + "Message": "Instance was terminated." + } + }, + "Ec2InstanceId": "i-xxxxx", + "InstanceFleetId": "if-xxxxx", + "EbsVolumes": [], + "PublicDnsName": "ec2-xx-xxx-xxx-xxx.compute-1.amazonaws.com", + "InstanceType": "m3.xlarge", + "PrivateDnsName": "ip-xx-xx-xxx-xx.ec2.internal", + "Market": "SPOT", + "PublicIpAddress": "xx.xx.xxx.xxx", + "Id": "ci-xxxxx", + "PrivateIpAddress": "10.47.191.80" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/emr/list-security-configurations.rst awscli-1.18.69/awscli/examples/emr/list-security-configurations.rst --- awscli-1.11.13/awscli/examples/emr/list-security-configurations.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/emr/list-security-configurations.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,20 +1,21 @@ -**To list security configurations in the current region** - - - Command:: - - aws emr list-security-configurations - - - Output:: - -{ - "SecurityConfigurations": [ - { - "CreationDateTime": 1473889697.417, - "Name": "MySecurityConfig-1" - }, - { - "CreationDateTime": 1473889697.417, - "Name": "MySecurityConfig-2" - } - ] -} \ No newline at end of file +**To list security configurations in the current region** + +Command:: + + aws emr list-security-configurations + +Output:: + + { + "SecurityConfigurations": [ + { + "CreationDateTime": 1473889697.417, + "Name": "MySecurityConfig-1" + }, + { + "CreationDateTime": 1473889697.417, + "Name": "MySecurityConfig-2" + } + ] + } + \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/emr/modify-instance-fleet.rst awscli-1.18.69/awscli/examples/emr/modify-instance-fleet.rst --- awscli-1.11.13/awscli/examples/emr/modify-instance-fleet.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/emr/modify-instance-fleet.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,7 @@ +**To change the target capacites of an instance fleet** + +This example changes the On-Demand and Spot target capacities to 1 for the instance fleet specified. + +Command:: + + aws emr modify-instance-fleet --cluster-id 'j-12ABCDEFGHI34JK' --instance-fleet InstanceFleetId='if-2ABC4DEFGHIJ4',TargetOnDemandCapacity=1,TargetSpotCapacity=1 diff -Nru awscli-1.11.13/awscli/examples/es/create-elasticsearch-domain.rst awscli-1.18.69/awscli/examples/es/create-elasticsearch-domain.rst --- awscli-1.11.13/awscli/examples/es/create-elasticsearch-domain.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/es/create-elasticsearch-domain.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,53 @@ +The following ``create-elasticsearch-domain`` command creates a new Amazon Elasticsearch Service domain within a VPC and restricts access to a single user. Amazon ES infers the VPC ID from the specified subnet and security group IDs:: + + aws es create-elasticsearch-domain --domain-name vpc-cli-example --elasticsearch-version 6.2 --elasticsearch-cluster-config InstanceType=m4.large.elasticsearch,InstanceCount=1 --ebs-options EBSEnabled=true,VolumeType=standard,VolumeSize=10 --access-policies '{"Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": {"AWS": "arn:aws:iam::123456789012:root" }, "Action":"es:*", "Resource": "arn:aws:es:us-west-1:123456789012:domain/vpc-cli-example/*" } ] }' --vpc-options SubnetIds=subnet-1a2a3a4a,SecurityGroupIds=sg-2a3a4a5a + +Output:: + + { + "DomainStatus": { + "ElasticsearchClusterConfig": { + "DedicatedMasterEnabled": false, + "InstanceCount": 1, + "ZoneAwarenessEnabled": false, + "InstanceType": "m4.large.elasticsearch" + }, + "DomainId": "123456789012/vpc-cli-example", + "CognitoOptions": { + "Enabled": false + }, + "VPCOptions": { + "SubnetIds": [ + "subnet-1a2a3a4a" + ], + "VPCId": "vpc-3a4a5a6a", + "SecurityGroupIds": [ + "sg-2a3a4a5a" + ], + "AvailabilityZones": [ + "us-west-1c" + ] + }, + "Created": true, + "Deleted": false, + "EBSOptions": { + "VolumeSize": 10, + "VolumeType": "standard", + "EBSEnabled": true + }, + "Processing": true, + "DomainName": "vpc-cli-example", + "SnapshotOptions": { + "AutomatedSnapshotStartHour": 0 + }, + "ElasticsearchVersion": "6.2", + "AccessPolicies": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:root\"},\"Action\":\"es:*\",\"Resource\":\"arn:aws:es:us-west-1:123456789012:domain/vpc-cli-example/*\"}]}", + "AdvancedOptions": { + "rest.action.multi.allow_explicit_index": "true" + }, + "EncryptionAtRestOptions": { + "Enabled": false + }, + "ARN": "arn:aws:es:us-west-1:123456789012:domain/vpc-cli-example" + } + } diff -Nru awscli-1.11.13/awscli/examples/events/delete-rule.rst awscli-1.18.69/awscli/examples/events/delete-rule.rst --- awscli-1.11.13/awscli/examples/events/delete-rule.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/events/delete-rule.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,5 @@ +**To delete a CloudWatch Events rule** + +This example deletes the rule named EC2InstanceStateChanges:: + + aws events delete-rule --name "EC2InstanceStateChanges" diff -Nru awscli-1.11.13/awscli/examples/events/describe-rule.rst awscli-1.18.69/awscli/examples/events/describe-rule.rst --- awscli-1.11.13/awscli/examples/events/describe-rule.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/events/describe-rule.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,5 @@ +**To display information about a CloudWatch Events rule** + +This example displays information about the rule named DailyLambdaFunction:: + + aws events describe-rule --name "DailyLambdaFunction" diff -Nru awscli-1.11.13/awscli/examples/events/disable-rule.rst awscli-1.18.69/awscli/examples/events/disable-rule.rst --- awscli-1.11.13/awscli/examples/events/disable-rule.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/events/disable-rule.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,5 @@ +**To disable a CloudWatch Events rule** + +This example disables the rule named DailyLambdaFunction. The rule is not deleted:: + + aws events disable-rule --name "DailyLambdaFunction" diff -Nru awscli-1.11.13/awscli/examples/events/enable-rule.rst awscli-1.18.69/awscli/examples/events/enable-rule.rst --- awscli-1.11.13/awscli/examples/events/enable-rule.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/events/enable-rule.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,5 @@ +**To enable a CloudWatch Events rule** + +This example enables the rule named DailyLambdaFunction, which had been previously disabled:: + + aws events enable-rule --name "DailyLambdaFunction" diff -Nru awscli-1.11.13/awscli/examples/events/list-rule-names-by-target.rst awscli-1.18.69/awscli/examples/events/list-rule-names-by-target.rst --- awscli-1.11.13/awscli/examples/events/list-rule-names-by-target.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/events/list-rule-names-by-target.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,5 @@ +**To display all the rules that have a specified target** + +This example displays all rules that have the Lambda function named "MyFunctionName" as the target:: + + aws events list-rule-names-by-target --target-arn "arn:aws:lambda:us-east-1:123456789012:function:MyFunctionName" diff -Nru awscli-1.11.13/awscli/examples/events/list-rules.rst awscli-1.18.69/awscli/examples/events/list-rules.rst --- awscli-1.11.13/awscli/examples/events/list-rules.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/events/list-rules.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To display a list of all CloudWatch Events rules** + +This example displays all CloudWatch Events rules in the region:: + + aws events list-rules + +**To display a list of CloudWatch Events rules beginning with a certain string.** + +This example displays all CloudWatch Events rules in the region that have a name starting with "Daily":: + + aws events list-rules --name-prefix "Daily" diff -Nru awscli-1.11.13/awscli/examples/events/list-targets-by-rule.rst awscli-1.18.69/awscli/examples/events/list-targets-by-rule.rst --- awscli-1.11.13/awscli/examples/events/list-targets-by-rule.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/events/list-targets-by-rule.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,5 @@ +**To display all the targets for a CloudWatch Events rule** + +This example displays all the targets of the rule named DailyLambdaFunction:: + + aws events list-targets-by-rule --rule "DailyLambdaFunction" diff -Nru awscli-1.11.13/awscli/examples/events/put-events.rst awscli-1.18.69/awscli/examples/events/put-events.rst --- awscli-1.11.13/awscli/examples/events/put-events.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/events/put-events.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,28 @@ +**To send a custom event to CloudWatch Events** + +This example sends a custom event to CloudWatch Events. The event is contained within the putevents.json file:: + + aws events put-events --entries file://putevents.json + +Here are the contents of the putevents.json file:: + + [ + { + "Source": "com.mycompany.myapp", + "Detail": "{ \"key1\": \"value1\", \"key2\": \"value2\" }", + "Resources": [ + "resource1", + "resource2" + ], + "DetailType": "myDetailType" + }, + { + "Source": "com.mycompany.myapp", + "Detail": "{ \"key1\": \"value3\", \"key2\": \"value4\" }", + "Resources": [ + "resource1", + "resource2" + ], + "DetailType": "myDetailType" + } + ] diff -Nru awscli-1.11.13/awscli/examples/events/put-rule.rst awscli-1.18.69/awscli/examples/events/put-rule.rst --- awscli-1.11.13/awscli/examples/events/put-rule.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/events/put-rule.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,13 @@ +**To create CloudWatch Events rules** + +This example creates a rule that triggers every day at 9:00am (UTC). If you use put-targets to add a Lambda function as a target of this rule, you could run the Lambda function every day at the specified time:: + + aws events put-rule --name "DailyLambdaFunction" --schedule-expression "cron(0 9 * * ? *)" + +This example creates a rule that triggers when any EC2 instance in the region changes state:: + + aws events put-rule --name "EC2InstanceStateChanges" --event-pattern "{\"source\":[\"aws.ec2\"],\"detail-type\":[\"EC2 Instance State-change Notification\"]}" --role-arn "arn:aws:iam::123456789012:role/MyRoleForThisRule" + +This example creates a rule that triggers when any EC2 instance in the region is stopped or terminated:: + + aws events put-rule --name "EC2InstanceStateChangeStopOrTerminate" --event-pattern "{\"source\":[\"aws.ec2\"],\"detail-type\":[\"EC2 Instance State-change Notification\"],\"detail\":{\"state\":[\"stopped\",\"terminated\"]}}" --role-arn "arn:aws:iam::123456789012:role/MyRoleForThisRule" diff -Nru awscli-1.11.13/awscli/examples/events/put-targets.rst awscli-1.18.69/awscli/examples/events/put-targets.rst --- awscli-1.11.13/awscli/examples/events/put-targets.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/events/put-targets.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,13 @@ +**To add targets for CloudWatch Events rules** + +This example adds a Lambda function as the target of a rule:: + + aws events put-targets --rule DailyLambdaFunction --targets "Id"="1","Arn"="arn:aws:lambda:us-east-1:123456789012:function:MyFunctionName" + +This example sets an Amazon Kinesis stream as the target, so that events caught by this rule are relayed to the stream:: + + aws events put-targets --rule EC2InstanceStateChanges --targets "Id"="1","Arn"="arn:aws:kinesis:us-east-1:123456789012:stream/MyStream","RoleArn"="arn:aws:iam::123456789012:role/MyRoleForThisRule" + +This example sets two Amazon Kinesis streams as targets for one rule:: + + aws events put-targets --rule DailyLambdaFunction --targets "Id"="Target1","Arn"="arn:aws:kinesis:us-east-1:379642911888:stream/MyStream1","RoleArn"="arn:aws:iam::379642911888:role/ MyRoleToAccessLambda" "Id"="Target2"," Arn"="arn:aws:kinesis:us-east-1:379642911888:stream/MyStream2","RoleArn"="arn:aws:iam::379642911888:role/MyRoleToAccessLambda" diff -Nru awscli-1.11.13/awscli/examples/events/remove-targets.rst awscli-1.18.69/awscli/examples/events/remove-targets.rst --- awscli-1.11.13/awscli/examples/events/remove-targets.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/events/remove-targets.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,5 @@ +**To remove a target for an event** + +This example removes the Amazon Kinesis stream named MyStream1 from being a target of the rule DailyLambdaFunction. When DailyLambdaFunction was created, this stream was set as a target with an ID of Target1:: + + aws events remove-targets --rule "DailyLambdaFunction" --ids "Target1" diff -Nru awscli-1.11.13/awscli/examples/events/test-event-pattern.rst awscli-1.18.69/awscli/examples/events/test-event-pattern.rst --- awscli-1.11.13/awscli/examples/events/test-event-pattern.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/events/test-event-pattern.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,5 @@ +**To check whether an event pattern matches a specified event** + +This example tests whether the pattern "source:com.mycompany.myapp" matches the specified event. In this example, the output would be "true":: + + aws events test-event-pattern --event-pattern "{\"source\":[\"com.mycompany.myapp\"]}" --event "{\"id\":\"1\",\"source\":\"com.mycompany.myapp\",\"detail-type\":\"myDetailType\",\"account\":\"123456789012\",\"region\":\"us-east-1\",\"time\":\"2017-04-11T20:11:04Z\"}" diff -Nru awscli-1.11.13/awscli/examples/fms/associate-admin-account.rst awscli-1.18.69/awscli/examples/fms/associate-admin-account.rst --- awscli-1.11.13/awscli/examples/fms/associate-admin-account.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/fms/associate-admin-account.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,10 @@ +**To set the Firewall Manager administrator account** + +The following ``associate-admin-account`` example sets the administrator account for Firewall Manager. :: + + aws fms associate-admin-account \ + --admin-account 123456789012 + +This command produces no output. + +For more information, see `Set the AWS Firewall Manager Administrator Account `__ in the *AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/fms/delete-notification-channel.rst awscli-1.18.69/awscli/examples/fms/delete-notification-channel.rst --- awscli-1.11.13/awscli/examples/fms/delete-notification-channel.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/fms/delete-notification-channel.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To remove the SNS topic information for Firewall Manager logs** + +The following ``delete-notification-channel`` example removes the SNS topic information. :: + + aws fms delete-notification-channel + +This command produces no output. + +For more information, see `Configure Amazon SNS Notifications and Amazon CloudWatch Alarms `__ in the *AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/fms/delete-policy.rst awscli-1.18.69/awscli/examples/fms/delete-policy.rst --- awscli-1.11.13/awscli/examples/fms/delete-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/fms/delete-policy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To delete a Firewall Manager policy** + +The following ``delete-policy`` example removes the policy with the specified ID, along with all of its resources. :: + + aws fms delete-policy \ + --policy-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ + --delete-all-policy-resources + +This command produces no output. + +For more information, see `Working with AWS Firewall Manager Policies `__ in the *AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/fms/disassociate-admin-account.rst awscli-1.18.69/awscli/examples/fms/disassociate-admin-account.rst --- awscli-1.11.13/awscli/examples/fms/disassociate-admin-account.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/fms/disassociate-admin-account.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To remove the Firewall Manager administrator account** + +The following ``disassociate-admin-account`` example removes the current administrator account association from Firewall Manager. :: + + aws fms disassociate-admin-account + +This command produces no output. + +For more information, see `Set the AWS Firewall Manager Administrator Account `__ in the *AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/fms/get-admin-account.rst awscli-1.18.69/awscli/examples/fms/get-admin-account.rst --- awscli-1.11.13/awscli/examples/fms/get-admin-account.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/fms/get-admin-account.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,14 @@ +**To retrieve the Firewall Manager administrator account** + +The following ``get-admin-account`` example retrieves the administrator account. :: + + aws fms get-admin-account + +Output:: + + { + "AdminAccount": "123456789012", + "RoleStatus": "READY" + } + +For more information, see `AWS Firewall Manager Prerequisites `__ in the *AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/fms/get-compliance-detail.rst awscli-1.18.69/awscli/examples/fms/get-compliance-detail.rst --- awscli-1.11.13/awscli/examples/fms/get-compliance-detail.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/fms/get-compliance-detail.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To retrieve the compliance information for an account** + +The following ``get-compliance-detail`` example retrieves compliance information for the specified policy and member account. :: + + aws fms get-compliance-detail \ + --policy-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ + --member-account 123456789012 + +Output:: + + { + "PolicyComplianceDetail": { + "EvaluationLimitExceeded": false, + "IssueInfoMap": {}, + "MemberAccount": "123456789012", + "PolicyId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "PolicyOwner": "123456789012", + "Violators": [] + } + +For more information, see `Viewing Resource Compliance with a Policy `__ in the *AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/fms/get-notification-channel.rst awscli-1.18.69/awscli/examples/fms/get-notification-channel.rst --- awscli-1.11.13/awscli/examples/fms/get-notification-channel.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/fms/get-notification-channel.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,14 @@ +**To retrieve the SNS topic information for Firewall Manager logs** + +The following ``get-notification-channel`` example retrieves the SNS topic information. :: + + aws fms get-notification-channel + +Output:: + + { + "SnsTopicArn": "arn:aws:sns:us-west-2:123456789012:us-west-2-fms", + "SnsRoleName": "arn:aws:iam::123456789012:role/aws-service-role/fms.amazonaws.com/AWSServiceRoleForFMS" + } + +For more information, see `Configure Amazon SNS Notifications and Amazon CloudWatch Alarms `__ in the *AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/fms/get-policy.rst awscli-1.18.69/awscli/examples/fms/get-policy.rst --- awscli-1.11.13/awscli/examples/fms/get-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/fms/get-policy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,27 @@ +**To retrieve a Firewall Manager policy** + +The following ``get-policy`` example retrieves the policy with the specified ID. :: + + aws fms get-policy \ + --policy-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 + +Output:: + + { + "Policy": { + "PolicyId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "PolicyName": "test", + "PolicyUpdateToken": "1:p+2RpKR4wPFx7mcrL1UOQQ==", + "SecurityServicePolicyData": { + "Type": "SECURITY_GROUPS_COMMON", + "ManagedServiceData": "{\"type\":\"SECURITY_GROUPS_COMMON\",\"revertManualSecurityGroupChanges\":true,\"exclusiveResourceSecurityGroupManagement\":false,\"securityGroups\":[{\"id\":\"sg-045c43ccc9724e63e\"}]}" + }, + "ResourceType": "AWS::EC2::Instance", + "ResourceTags": [], + "ExcludeResourceTags": false, + "RemediationEnabled": false + }, + "PolicyArn": "arn:aws:fms:us-west-2:123456789012:policy/d1ac59b8-938e-42b3-b2e0-7c620422ddc2" + } + +For more information, see `Working with AWS Firewall Manager Policies `__ in the *AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/fms/list-compliance-status.rst awscli-1.18.69/awscli/examples/fms/list-compliance-status.rst --- awscli-1.11.13/awscli/examples/fms/list-compliance-status.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/fms/list-compliance-status.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,35 @@ +**To retrieve the policy compliance information for member accounts** + +The following ``list-compliance-status`` example retrieves member account compliance information for the specified policy. :: + + aws fms list-compliance-status \ + --policy-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 + +Output:: + + { + "PolicyComplianceStatusList": [ + { + "PolicyOwner": "123456789012", + "PolicyId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "PolicyName": "test", + "MemberAccount": "123456789012", + "EvaluationResults": [ + { + "ComplianceStatus": "COMPLIANT", + "ViolatorCount": 0, + "EvaluationLimitExceeded": false + }, + { + "ComplianceStatus": "NON_COMPLIANT", + "ViolatorCount": 2, + "EvaluationLimitExceeded": false + } + ], + "LastUpdated": 1576283774.0, + "IssueInfoMap": {} + } + ] + } + +For more information, see `Viewing Resource Compliance with a Policy `__ in the *AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/fms/list-member-accounts.rst awscli-1.18.69/awscli/examples/fms/list-member-accounts.rst --- awscli-1.11.13/awscli/examples/fms/list-member-accounts.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/fms/list-member-accounts.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To retrieve the member accounts in the organization** + +The following ``list-member-accounts`` example lists all of the member accounts that are in the Firewall Manager administrator's organization. :: + + aws fms list-member-accounts + +Output:: + + { + "MemberAccounts": [ + "222222222222", + "333333333333", + "444444444444" + ] + } + +For more information, see `AWS Firewall Manager `__ in the *AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/fms/list-policies.rst awscli-1.18.69/awscli/examples/fms/list-policies.rst --- awscli-1.11.13/awscli/examples/fms/list-policies.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/fms/list-policies.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,32 @@ +**To retrieve all Firewall Manager policies** + +The following ``list-policies`` example retrieves the list of policies for the account. In this example, the output is limited to two results per request. Each call returns a ``NextToken`` that can be used as the value for the ``--starting-token`` parameter in the next ``list-policies`` call to get the next set of results for the list. :: + + aws fms list-policies \ + --max-items 2 + +Output:: + + { + "PolicyList": [ + { + "PolicyArn": "arn:aws:fms:us-west-2:123456789012:policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "PolicyId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "PolicyName": "test", + "ResourceType": "AWS::EC2::Instance", + "SecurityServiceType": "SECURITY_GROUPS_COMMON", + "RemediationEnabled": false + }, + { + "PolicyArn": "arn:aws:fms:us-west-2:123456789012:policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "PolicyId": "457c9b21-fc94-406c-ae63-21217395ba72", + "PolicyName": "test", + "ResourceType": "AWS::EC2::Instance", + "SecurityServiceType": "SECURITY_GROUPS_COMMON", + "RemediationEnabled": false + } + ], + "NextToken": "eyJOZXh0VG9rZW4iOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ==" + } + +For more information, see `Working with AWS Firewall Manager Policies `__ in the *AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/fms/put-notification-channel.rst awscli-1.18.69/awscli/examples/fms/put-notification-channel.rst --- awscli-1.11.13/awscli/examples/fms/put-notification-channel.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/fms/put-notification-channel.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To set the SNS topic information for Firewall Manager logs** + +The following ``put-notification-channel`` example sets the SNS topic information. :: + + aws fms put-notification-channel \ + --sns-topic-arn arn:aws:sns:us-west-2:123456789012:us-west-2-fms \ + --sns-role-name arn:aws:iam::123456789012:role/aws-service-role/fms.amazonaws.com/AWSServiceRoleForFMS + +This command produces no output. + +For more information, see `Configure Amazon SNS Notifications and Amazon CloudWatch Alarms `__ in the *AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/fms/put-policy.rst awscli-1.18.69/awscli/examples/fms/put-policy.rst --- awscli-1.11.13/awscli/examples/fms/put-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/fms/put-policy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,49 @@ +**To create a Firewall Manager policy** + +The following ``put-policy`` example creates a Firewall Manager security group policy. :: + + aws fms put-policy \ + --cli-input-json file://policy.json + +Contents of ``policy.json``:: + + { + "Policy": { + "PolicyName": "test", + "SecurityServicePolicyData": { + "Type": "SECURITY_GROUPS_USAGE_AUDIT", + "ManagedServiceData": "{\"type\":\"SECURITY_GROUPS_USAGE_AUDIT\",\"deleteUnusedSecurityGroups\":false,\"coalesceRedundantSecurityGroups\":true}" + }, + "ResourceType": "AWS::EC2::SecurityGroup", + "ResourceTags": [], + "ExcludeResourceTags": false, + "RemediationEnabled": false + }, + "TagList": [ + { + "Key": "foo", + "Value": "foo" + } + ] + } + +Output:: + + { + "Policy": { + "PolicyId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "PolicyName": "test", + "PolicyUpdateToken": "1:X9QGexP7HASDlsFp+G31Iw==", + "SecurityServicePolicyData": { + "Type": "SECURITY_GROUPS_USAGE_AUDIT", + "ManagedServiceData": "{\"type\":\"SECURITY_GROUPS_USAGE_AUDIT\",\"deleteUnusedSecurityGroups\":false,\"coalesceRedundantSecurityGroups\":true,\"optionalDelayForUnusedInMinutes\":null}" + }, + "ResourceType": "AWS::EC2::SecurityGroup", + "ResourceTags": [], + "ExcludeResourceTags": false, + "RemediationEnabled": false + }, + "PolicyArn": "arn:aws:fms:us-west-2:123456789012:policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" + } + +For more information, see `Working with AWS Firewall Manager Policies `__ in the *AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/gamelift/create-build.rst awscli-1.18.69/awscli/examples/gamelift/create-build.rst --- awscli-1.11.13/awscli/examples/gamelift/create-build.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/gamelift/create-build.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/gamelift/create-fleet.rst awscli-1.18.69/awscli/examples/gamelift/create-fleet.rst --- awscli-1.11.13/awscli/examples/gamelift/create-fleet.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/gamelift/create-fleet.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,160 @@ +**Example 1: To create a basic Linux fleet** + +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 MegaFrogRaceServer.NA.v2 \ + --description 'Hosts for v2 North America' \ + --build-id build-1111aaaa-22bb-33cc-44dd-5555eeee66ff \ + --certificate-configuration 'CertificateType=GENERATED' \ + --ec2-instance-type c4.large \ + --fleet-type ON_DEMAND \ + --runtime-configuration 'ServerProcesses=[{LaunchPath=/local/game/release-na/MegaFrogRace_Server.exe,ConcurrentExecutions=1}]' + +Output:: + + { + "FleetAttributes": { + "BuildId": "build-1111aaaa-22bb-33cc-44dd-5555eeee66ff", + "CertificateConfiguration": { + "CertificateType": "GENERATED" + }, + "CreationTime": 1496365885.44, + "Description": "Hosts for v2 North America", + "FleetArn": "arn:aws:gamelift:us-west-2:444455556666:fleet/fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", + "FleetId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", + "FleetType": "ON_DEMAND", + "InstanceType": "c4.large", + "MetricGroups": ["default"], + "Name": "MegaFrogRace.NA.v2", + "NewGameSessionProtectionPolicy": "NoProtection", + "OperatingSystem": "AMAZON_LINUX", + "ServerLaunchPath": "/local/game/release-na/MegaFrogRace_Server.exe", + "Status": "NEW" + } + } + +**Example 2: To create a basic Windows fleet** + +The following ``create-fleet`` example creates a minimally configured fleet of spot Windows instances to host a custom server build. You can complete the configuration by using ``update-fleet``. :: + + aws gamelift create-fleet \ + --name MegaFrogRace.NA.v2 \ + --description 'Hosts for v2 North America' \ + --build-id build-2222aaaa-33bb-44cc-55dd-6666eeee77ff \ + --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}]' + +Output:: + + { + "FleetAttributes": { + "BuildId": "build-2222aaaa-33bb-44cc-55dd-6666eeee77ff", + "CertificateConfiguration": { + "CertificateType": "GENERATED" + }, + "CreationTime": 1496365885.44, + "Description": "Hosts for v2 North America", + "FleetArn": "arn:aws:gamelift:us-west-2:444455556666:fleet/fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", + "FleetId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", + "FleetType": "SPOT", + "InstanceType": "c4.large", + "MetricGroups": ["default"], + "Name": "MegaFrogRace.NA.v2", + "NewGameSessionProtectionPolicy": "NoProtection", + "OperatingSystem": "WINDOWS_2012", + "ServerLaunchPath": "C:\game\Bin64.Release.Dedicated\MegaFrogRace_Server.exe", + "Status": "NEW" + } + } + + +**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. :: + + aws gamelift create-fleet \ + --name MegaFrogRace.NA.v2 \ + --description 'Hosts for v2 North America' \ + --build-id build-2222aaaa-33bb-44cc-55dd-6666eeee77ff \ + --certificate-configuration 'CertificateType=GENERATED' \ + --ec2-instance-type c4.large \ + --ec2-inbound-permissions 'FromPort=33435,ToPort=33435,IpRange=10.24.34.0/23,Protocol=UDP' \ + --fleet-type SPOT \ + --new-game-session-protection-policy FullProtection \ + --runtime-configuration file://runtime-config.json \ + --metric-groups default \ + --instance-role-arn 'arn:aws:iam::444455556666:role/GameLiftS3Access' + +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}] + +Output:: + + { + "FleetAttributes": { + "InstanceRoleArn": "arn:aws:iam::444455556666:role/GameLiftS3Access", + "Status": "NEW", + "InstanceType": "c4.large", + "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", + "OperatingSystem": "WINDOWS_2012", + "Name": "MegaFrogRace.NA.v2", + "CreationTime": 1569309011.11, + "MetricGroups": [ + "default" + ], + "BuildId": "build-2222aaaa-33bb-44cc-55dd-6666eeee77ff", + "ServerLaunchParameters": "abc", + "ServerLaunchPath": "C:\\game\\Bin64.Release.Dedicated\\MegaFrogRace_Server.exe", + "NewGameSessionProtectionPolicy": "FullProtection", + "CertificateConfiguration": { + "CertificateType": "GENERATED" + } + } + } + +**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. :: + + aws gamelift create-fleet \ + --name MegaFrogRace.NA.realtime \ + --description 'Mega Frog Race Realtime fleet' \ + --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}]' + +Output:: + + { + "FleetAttributes": { + "FleetId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", + "Status": "NEW", + "CreationTime": 1569310745.212, + "InstanceType": "c4.large", + "NewGameSessionProtectionPolicy": "NoProtection", + "CertificateConfiguration": { + "CertificateType": "GENERATED" + }, + "Name": "MegaFrogRace.NA.realtime", + "ScriptId": "script-1111aaaa-22bb-33cc-44dd-5555eeee66ff", + "FleetArn": "arn:aws:gamelift:us-west-2:444455556666:fleet/fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", + "FleetType": "SPOT", + "MetricGroups": [ + "default" + ], + "Description": "Mega Frog Race Realtime fleet", + "OperatingSystem": "AMAZON_LINUX" + } + } diff -Nru awscli-1.11.13/awscli/examples/gamelift/create-game-session-queue.rst awscli-1.18.69/awscli/examples/gamelift/create-game-session-queue.rst --- awscli-1.11.13/awscli/examples/gamelift/create-game-session-queue.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/gamelift/create-game-session-queue.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/gamelift/delete-build.rst awscli-1.18.69/awscli/examples/gamelift/delete-build.rst --- awscli-1.11.13/awscli/examples/gamelift/delete-build.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/gamelift/delete-build.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/gamelift/delete-fleet.rst awscli-1.18.69/awscli/examples/gamelift/delete-fleet.rst --- awscli-1.11.13/awscli/examples/gamelift/delete-fleet.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/gamelift/delete-fleet.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/gamelift/delete-game-session-queue.rst awscli-1.18.69/awscli/examples/gamelift/delete-game-session-queue.rst --- awscli-1.11.13/awscli/examples/gamelift/delete-game-session-queue.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/gamelift/delete-game-session-queue.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/gamelift/describe-build.rst awscli-1.18.69/awscli/examples/gamelift/describe-build.rst --- awscli-1.11.13/awscli/examples/gamelift/describe-build.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/gamelift/describe-build.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/gamelift/describe-ec2-instance-limits.rst awscli-1.18.69/awscli/examples/gamelift/describe-ec2-instance-limits.rst --- awscli-1.11.13/awscli/examples/gamelift/describe-ec2-instance-limits.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/gamelift/describe-ec2-instance-limits.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/gamelift/describe-fleet-attributes.rst awscli-1.18.69/awscli/examples/gamelift/describe-fleet-attributes.rst --- awscli-1.11.13/awscli/examples/gamelift/describe-fleet-attributes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/gamelift/describe-fleet-attributes.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/gamelift/describe-fleet-capacity.rst awscli-1.18.69/awscli/examples/gamelift/describe-fleet-capacity.rst --- awscli-1.11.13/awscli/examples/gamelift/describe-fleet-capacity.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/gamelift/describe-fleet-capacity.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/gamelift/describe-fleet-events.rst awscli-1.18.69/awscli/examples/gamelift/describe-fleet-events.rst --- awscli-1.11.13/awscli/examples/gamelift/describe-fleet-events.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/gamelift/describe-fleet-events.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/gamelift/describe-fleet-port-settings.rst awscli-1.18.69/awscli/examples/gamelift/describe-fleet-port-settings.rst --- awscli-1.11.13/awscli/examples/gamelift/describe-fleet-port-settings.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/gamelift/describe-fleet-port-settings.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/gamelift/describe-fleet-utilization.rst awscli-1.18.69/awscli/examples/gamelift/describe-fleet-utilization.rst --- awscli-1.11.13/awscli/examples/gamelift/describe-fleet-utilization.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/gamelift/describe-fleet-utilization.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/gamelift/describe-game-session-queues.rst awscli-1.18.69/awscli/examples/gamelift/describe-game-session-queues.rst --- awscli-1.11.13/awscli/examples/gamelift/describe-game-session-queues.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/gamelift/describe-game-session-queues.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/gamelift/describe-runtime-configuration.rst awscli-1.18.69/awscli/examples/gamelift/describe-runtime-configuration.rst --- awscli-1.11.13/awscli/examples/gamelift/describe-runtime-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/gamelift/describe-runtime-configuration.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/gamelift/list-builds.rst awscli-1.18.69/awscli/examples/gamelift/list-builds.rst --- awscli-1.11.13/awscli/examples/gamelift/list-builds.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/gamelift/list-builds.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/gamelift/list-fleets.rst awscli-1.18.69/awscli/examples/gamelift/list-fleets.rst --- awscli-1.11.13/awscli/examples/gamelift/list-fleets.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/gamelift/list-fleets.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/gamelift/request-upload-credentials.rst awscli-1.18.69/awscli/examples/gamelift/request-upload-credentials.rst --- awscli-1.11.13/awscli/examples/gamelift/request-upload-credentials.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/gamelift/request-upload-credentials.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/gamelift/start-fleet-actions.rst awscli-1.18.69/awscli/examples/gamelift/start-fleet-actions.rst --- awscli-1.11.13/awscli/examples/gamelift/start-fleet-actions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/gamelift/start-fleet-actions.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/gamelift/stop-fleet-actions.rst awscli-1.18.69/awscli/examples/gamelift/stop-fleet-actions.rst --- awscli-1.11.13/awscli/examples/gamelift/stop-fleet-actions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/gamelift/stop-fleet-actions.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/gamelift/update-build.rst awscli-1.18.69/awscli/examples/gamelift/update-build.rst --- awscli-1.11.13/awscli/examples/gamelift/update-build.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/gamelift/update-build.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/gamelift/update-game-session-queue.rst awscli-1.18.69/awscli/examples/gamelift/update-game-session-queue.rst --- awscli-1.11.13/awscli/examples/gamelift/update-game-session-queue.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/gamelift/update-game-session-queue.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/gamelift/upload-build.rst awscli-1.18.69/awscli/examples/gamelift/upload-build.rst --- awscli-1.11.13/awscli/examples/gamelift/upload-build.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/gamelift/upload-build.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/glacier/abort-vault-lock.rst awscli-1.18.69/awscli/examples/glacier/abort-vault-lock.rst --- awscli-1.11.13/awscli/examples/glacier/abort-vault-lock.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/glacier/abort-vault-lock.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To abort an in-progress vault lock process** + +The following ``abort-vault-lock`` example deletes a vault lock policy from the specified vault and resets the lock state of the vault lock to unlocked. :: + + aws glacier abort-vault-lock \ + --account-id - \ + --vault-name MyVaultName + +This command produces no output. + +For more information, see `Abort Vault Lock (DELETE lock-policy) `__ in the *Amazon Glacier API Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/glacier/complete-vault-lock.rst awscli-1.18.69/awscli/examples/glacier/complete-vault-lock.rst --- awscli-1.11.13/awscli/examples/glacier/complete-vault-lock.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/glacier/complete-vault-lock.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,12 @@ +**To complete an in-progress vault lock process** + +The following ``complete-vault-lock`` example completes the in-progress locking progress for the specified vault and sets the lock state of the vault lock to ``Locked``. You get the value for the ``lock-id`` parameter when you run ``initiate-lock-process``. :: + + aws glacier complete-vault-lock \ + --account-id - \ + --vault-name MyVaultName \ + --lock-id 9QZgEXAMPLEPhvL6xEXAMPLE + +This command produces no output. + +For more information, see `Complete Vault Lock (POST lockId) `__ in the *Amazon Glacier API Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/glacier/delete-archive.rst awscli-1.18.69/awscli/examples/glacier/delete-archive.rst --- awscli-1.11.13/awscli/examples/glacier/delete-archive.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/glacier/delete-archive.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete an archive from a vault** + +The following ``delete-archive`` example removes the specified archive from ``example_vault``. :: + + aws glacier delete-archive \ + --account-id 111122223333 \ + --vault-name example_vault \ + --archive-id Sc0u9ZP8yaWkmh-XGlIvAVprtLhaLCGnNwNl5I5x9HqPIkX5mjc0DrId3Ln-Gi_k2HzmlIDZUz117KSdVMdMXLuFWi9PJUitxWO73edQ43eTlMWkH0pd9zVSAuV_XXZBVhKhyGhJ7w + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/glacier/delete-vault-access-policy.rst awscli-1.18.69/awscli/examples/glacier/delete-vault-access-policy.rst --- awscli-1.11.13/awscli/examples/glacier/delete-vault-access-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/glacier/delete-vault-access-policy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To remove the access policy of a vault** + +The following ``delete-vault-access-policy`` example removes the access policy for the specified vault. :: + + aws glacier delete-vault-access-policy \ + --account-id 111122223333 \ + --vault-name example_vault + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/glacier/delete-vault-notifications.rst awscli-1.18.69/awscli/examples/glacier/delete-vault-notifications.rst --- awscli-1.11.13/awscli/examples/glacier/delete-vault-notifications.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/glacier/delete-vault-notifications.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To remove the SNS notifications for a vault** + +The following ``delete-vault-notifications`` example removes notifications sent by Amazon Simple Notification Service (Amazon SNS) for the specified vault. :: + + aws glacier delete-vault-notifications \ + --account-id 111122223333 \ + --vault-name example_vault + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/glacier/get-vault-access-policy.rst awscli-1.18.69/awscli/examples/glacier/get-vault-access-policy.rst --- awscli-1.11.13/awscli/examples/glacier/get-vault-access-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/glacier/get-vault-access-policy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,15 @@ +**To retrieve the access policy of a vault** + +The following ``get-vault-access-policy`` example retrieves the access policy for the specified vault. :: + + aws glacier get-vault-access-policy \ + --account-id 111122223333 \ + --vault-name example_vault + +Output:: + + { + "policy": { + "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::444455556666:root\"},\"Action\":\"glacier:ListJobs\",\"Resource\":\"arn:aws:glacier:us-east-1:111122223333:vaults/example_vault\"},{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::444455556666:root\"},\"Action\":\"glacier:UploadArchive\",\"Resource\":\"arn:aws:glacier:us-east-1:111122223333:vaults/example_vault\"}]}" + } + } diff -Nru awscli-1.11.13/awscli/examples/glacier/get-vault-lock.rst awscli-1.18.69/awscli/examples/glacier/get-vault-lock.rst --- awscli-1.11.13/awscli/examples/glacier/get-vault-lock.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/glacier/get-vault-lock.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To get the details of a vault lock** + +The following ``get-vault-lock`` example retrieved the details about the lock for the specified vault. :: + + aws glacier get-vault-lock \ + --account-id - \ + --vault-name MyVaultName + +Output:: + + { + "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Define-vault-lock\",\"Effect\":\"Deny\",\"Principal\":{\"AWS\":\"arn:aws:iam::999999999999:root\"},\"Action\":\"glacier:DeleteArchive\",\"Resource\":\"arn:aws:glacier:us-west-2:99999999999:vaults/MyVaultName\",\"Condition\":{\"NumericLessThanEquals\":{\"glacier:ArchiveAgeinDays\":\"365\"}}}]}", + "State": "Locked", + "CreationDate": "2019-07-29T22:25:28.640Z" + } + +For more information, see `Get Vault Lock (GET lock-policy) `__ in the *Amazon Glacier API Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/glacier/initiate-vault-lock.rst awscli-1.18.69/awscli/examples/glacier/initiate-vault-lock.rst --- awscli-1.11.13/awscli/examples/glacier/initiate-vault-lock.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/glacier/initiate-vault-lock.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,20 @@ +**To initiate the vault locking process** + +The following ``initiate-vault-lock`` example installs a vault lock policy on the specified vault and sets the lock state of the vault lock to ``InProgress``. You must complete the process by calling ``complete-vault-lock`` within 24 hours to set the state of the vault lock to ``Locked``. :: + + aws glacier initiate-vault-lock \ + --account-id - \ + --vault-name MyVaultName \ + --policy file://vault_lock_policy.json + +Contents of ``vault_lock_policy.json``:: + + {"Policy":"{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Define-vault-lock\",\"Effect\":\"Deny\",\"Principal\":{\"AWS\":\"arn:aws:iam::999999999999:root\"},\"Action\":\"glacier:DeleteArchive\",\"Resource\":\"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault\",\"Condition\":{\"NumericLessThanEquals\":{\"glacier:ArchiveAgeinDays\":\"365\"}}}]}"} + +The output is the vault lock ID that you can use to complete the vault lock process. :: + + { + "lockId": "9QZgEXAMPLEPhvL6xEXAMPLE" + } + +For more information, see `Initiate Vault Lock (POST lock-policy) `__ in the *Amazon Glacier API Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/glacier/list-provisioned-capacity.rst awscli-1.18.69/awscli/examples/glacier/list-provisioned-capacity.rst --- awscli-1.11.13/awscli/examples/glacier/list-provisioned-capacity.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/glacier/list-provisioned-capacity.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To retrieve the provisioned capacity units** + +The following ``list-provisioned-capacity`` example retrieves details for any provisioned capacity units for the specified account. :: + + aws glacier list-provisioned-capacity \ + --account-id 111122223333 + +Output:: + + { + "ProvisionedCapacityList": [ + { + "CapacityId": "HpASAuvfRFiVDbOjMfEIcr8K", + "ExpirationDate": "2020-03-18T19:59:24.000Z", + "StartDate": "2020-02-18T19:59:24.912Z" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/glacier/purchase-provisioned-capacity.rst awscli-1.18.69/awscli/examples/glacier/purchase-provisioned-capacity.rst --- awscli-1.11.13/awscli/examples/glacier/purchase-provisioned-capacity.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/glacier/purchase-provisioned-capacity.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,12 @@ +**To purchase a provisioned capacity unit** + +The following ``purchase-provisioned-capacity`` example purchases a provisioned capacity unit. :: + + aws glacier purchase-provisioned-capacity \ + --account-id 111122223333 + +Output:: + + { + "capacityId": "HpASAuvfRFiVDbOjMfEIcr8K" + } diff -Nru awscli-1.11.13/awscli/examples/glacier/set-vault-access-policy.rst awscli-1.18.69/awscli/examples/glacier/set-vault-access-policy.rst --- awscli-1.11.13/awscli/examples/glacier/set-vault-access-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/glacier/set-vault-access-policy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,10 @@ +**To set the access policy of a vault** + +The following ``set-vault-access-policy`` example attaches a permission policy to the specified vault. :: + + aws glacier set-vault-access-policy \ + --account-id 111122223333 \ + --vault-name example_vault + --policy '{"Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::444455556666:root\"},\"Action\":\"glacier:ListJobs\",\"Resource\":\"arn:aws:glacier:us-east-1:111122223333:vaults/example_vault\"},{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::444455556666:root\"},\"Action\":\"glacier:UploadArchive\",\"Resource\":\"arn:aws:glacier:us-east-1:111122223333:vaults/example_vault\"}]}"}' + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/glacier/wait/vault-exists.rst awscli-1.18.69/awscli/examples/glacier/wait/vault-exists.rst --- awscli-1.11.13/awscli/examples/glacier/wait/vault-exists.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/glacier/wait/vault-exists.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To pause until a vault exists*** + +The following ``wait vault-exists`` example pauses running and continues only after it confirms that the specified vault exists. :: + + aws glacier wait vault-exists \ + --account-id 111122223333 \ + --vault-name example_vault + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/glacier/wait/vault-not-exists.rst awscli-1.18.69/awscli/examples/glacier/wait/vault-not-exists.rst --- awscli-1.11.13/awscli/examples/glacier/wait/vault-not-exists.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/glacier/wait/vault-not-exists.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To pause until a vault no longer exists** + +The following ``wait vault-not-exists`` example pauses running and continues only after it confirms that the specified vault doesn't exist. :: + + aws glacier wait vault-not-exists \ + --account-id 111122223333 \ + --vault-name example_vault + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/globalaccelerator/advertise-byoip-cidr.rst awscli-1.18.69/awscli/examples/globalaccelerator/advertise-byoip-cidr.rst --- awscli-1.11.13/awscli/examples/globalaccelerator/advertise-byoip-cidr.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/globalaccelerator/advertise-byoip-cidr.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To advertise an address range** + +The following ``advertise-byoip-cidr`` example requests AWS to advertise an address range that you've provisioned for use with your AWS resources. :: + + aws globalaccelerator advertise-byoip-cidr \ + --cidr 198.51.100.0/24 + +Output:: + + { + "ByoipCidr": { + "Cidr": "198.51.100.0/24", + "State": "PENDING_ADVERTISING" + } + } + +For more information, see `Bring Your Own IP Address in AWS Global Accelerator `__ in the *AWS Global Accelerator Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/globalaccelerator/create-accelerator.rst awscli-1.18.69/awscli/examples/globalaccelerator/create-accelerator.rst --- awscli-1.11.13/awscli/examples/globalaccelerator/create-accelerator.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/globalaccelerator/create-accelerator.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,35 @@ +**To create an accelerator** + +The following ``create-accelerator`` example creates an accelerator with two tags. You must specify the ``US-West-2 (Oregon)`` Region to create or update an accelerator. :: + + aws globalaccelerator create-accelerator \ + --name ExampleAccelerator \ + --tags Key="Name",Value="Example Name" Key="Project",Value="Example Project" \ + --region us-west-2 \ + --ip-addresses 192.0.2.250,198.51.100.52 + +Output:: + + { + "Accelerator": { + "AcceleratorArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh", + "IpAddressType": "IPV4", + "Name": "ExampleAccelerator", + "Enabled": true, + "Status": "IN_PROGRESS", + "IpSets": [ + { + "IpAddresses": [ + "192.0.2.250", + "198.51.100.52" + ], + "IpFamily": "IPv4" + } + ], + "DnsName":"a1234567890abcdef.awsglobalaccelerator.com", + "CreatedTime": 1542394847.0, + "LastModifiedTime": 1542394847.0 + } + } + +For more information, see `Accelerators in AWS Global Accelerator `__ in the *AWS Global Accelerator Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/globalaccelerator/create-endpoint-group.rst awscli-1.18.69/awscli/examples/globalaccelerator/create-endpoint-group.rst --- awscli-1.11.13/awscli/examples/globalaccelerator/create-endpoint-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/globalaccelerator/create-endpoint-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,27 @@ +**To create an endpoint group** + +The following ``create-endpoint-group`` example creates an endpoint group with one endpoint. :: + + aws globalaccelerator create-endpoint-group \ + --listener-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz \ + --endpoint-group-region us-east-1 \ + --endpoint-configurations EndpointId=i-1234567890abcdef0,Weight=128 \ + --region us-west-2 + +Output:: + + { + "EndpointGroup": { + "TrafficDialPercentage": 100.0, + "EndpointDescriptions": [ + { + "Weight": 128, + "EndpointId": "i-1234567890abcdef0" + } + ], + "EndpointGroupArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz/endpoint-group/098765zyxwvu", + "EndpointGroupRegion": "us-east-1" + } + } + +For more information, see `Endpoint Groups in AWS Global Accelerator `__ in the *AWS Global Accelerator Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/globalaccelerator/create-listener.rst awscli-1.18.69/awscli/examples/globalaccelerator/create-listener.rst --- awscli-1.11.13/awscli/examples/globalaccelerator/create-listener.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/globalaccelerator/create-listener.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,31 @@ +**To create a listener** + +The following ``create-listener`` example creates a listener with two ports. :: + + aws globalaccelerator create-listener \ + --accelerator-arn arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh \ + --port-ranges FromPort=80,ToPort=80 FromPort=81,ToPort=81 \ + --protocol TCP \ + --region us-west-2 + +Output:: + + { + "Listener": { + "PortRanges": [ + { + "ToPort": 80, + "FromPort": 80 + }, + { + "ToPort": 81, + "FromPort": 81 + } + ], + "ClientAffinity": "NONE", + "Protocol": "TCP", + "ListenerArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz" + } + } + +For more information, see `Listeners in AWS Global Accelerator `__ in the *AWS Global Accelerator Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/globalaccelerator/deprovision-byoip-cidr.rst awscli-1.18.69/awscli/examples/globalaccelerator/deprovision-byoip-cidr.rst --- awscli-1.11.13/awscli/examples/globalaccelerator/deprovision-byoip-cidr.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/globalaccelerator/deprovision-byoip-cidr.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To deprovision an address range** + +The following ``deprovision-byoip-cidr`` example releases the specified address range that you provisioned to use with your AWS resources. :: + + aws globalaccelerator deprovision-byoip-cidr \ + --cidr "198.51.100.0/24" + +Output:: + + { + "ByoipCidr": { + "Cidr": "198.51.100.0/24", + "State": "PENDING_DEPROVISIONING" + } + } + +For more information, see `Bring Your Own IP Address in AWS Global Accelerator `__ in the *AWS Global Accelerator Developer Guide*. + diff -Nru awscli-1.11.13/awscli/examples/globalaccelerator/describe-accelerator-attributes.rst awscli-1.18.69/awscli/examples/globalaccelerator/describe-accelerator-attributes.rst --- awscli-1.11.13/awscli/examples/globalaccelerator/describe-accelerator-attributes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/globalaccelerator/describe-accelerator-attributes.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To describe an accelerator's attributes** + +The following ``describe-accelerator-attributes`` example describes the attributes for an accelerator. :: + + aws globalaccelerator describe-accelerator-attributes \ + --accelerator-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh + +Output:: + + { + "AcceleratorAttributes": { + "FlowLogsEnabled": true + "FlowLogsS3Bucket": flowlogs-abc + "FlowLogsS3Prefix": bucketprefix-abc + } + } + +For more information, see `Accelerators in AWS Global Accelerator `__ in the *AWS Global Accelerator Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/globalaccelerator/describe-accelerator.rst awscli-1.18.69/awscli/examples/globalaccelerator/describe-accelerator.rst --- awscli-1.11.13/awscli/examples/globalaccelerator/describe-accelerator.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/globalaccelerator/describe-accelerator.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,33 @@ +**To describe an accelerator** + +The following ``describe-accelerator`` example retrieves the details about the specified accelerator. :: + + aws globalaccelerator describe-accelerator \ + --accelerator-arn arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh \ + --region us-west-2 + +Output:: + + { + "Accelerator": { + "AcceleratorArn": "arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh", + "IpAddressType": "IPV4", + "Name": "ExampleAaccelerator", + "Enabled": true, + "Status": "IN_PROGRESS", + "IpSets": [ + { + "IpAddresses": [ + "192.0.2.250", + "198.51.100.52" + ], + "IpFamily": "IPv4" + } + ], + "DnsName":"a1234567890abcdef.awsglobalaccelerator.com", + "CreatedTime": 1542394847, + "LastModifiedTime": 1542395013 + } + } + +For more information, see `Accelerators in AWS Global Accelerator `__ in the *AWS Global Accelerator Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/globalaccelerator/describe-endpoint-group.rst awscli-1.18.69/awscli/examples/globalaccelerator/describe-endpoint-group.rst --- awscli-1.11.13/awscli/examples/globalaccelerator/describe-endpoint-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/globalaccelerator/describe-endpoint-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,32 @@ +**To describe an endpoint group** + +The following ``describe-endpoint-group`` example describes an endpoint group. :: + + aws globalaccelerator describe-endpoint-group \ + --endpoint-group-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/6789vxyz-vxyz-6789-vxyz-6789lmnopqrs/endpoint-group/ab88888example + +Output:: + + { + "EndpointGroup": { + "TrafficDialPercentage": 100.0, + "EndpointDescriptions": [ + { + "Weight": 128, + "EndpointId": "i-1234567890abcdef0" + }, + { + "Weight": 128, + "EndpointId": "arn:aws:elasticloadbalancing:us-east-1:000123456789:loadbalancer/app/ALBTesting/alb01234567890xyz" + }, + { + "Weight": 128, + "EndpointId": "arn:aws:elasticloadbalancing:us-east-1:000123456789:loadbalancer/net/NLBTesting/alb01234567890qrs" + } + ], + "EndpointGroupArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/6789vxyz-vxyz-6789-vxyz-6789lmnopqrs/endpoint-group/4321abcd-abcd-4321-abcd-4321abcdefg", + "EndpointGroupRegion": "us-east-1" + } + } + +For more information, see `Accelerators in AWS Global Accelerator `__ in the *AWS Global Accelerator Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/globalaccelerator/describe-listener.rst awscli-1.18.69/awscli/examples/globalaccelerator/describe-listener.rst --- awscli-1.11.13/awscli/examples/globalaccelerator/describe-listener.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/globalaccelerator/describe-listener.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,25 @@ +**To describe a listener** + +The following ``describe-listener`` example describes a listener. :: + + aws globalaccelerator describe-listener \ + --listener-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/abcdef1234 \ + --region us-west-2 + +Output:: + + { + "Listener": { + "ListenerArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/abcdef1234", + "PortRanges": [ + { + "FromPort": 80, + "ToPort": 80 + } + ], + "Protocol": "TCP", + "ClientAffinity": "NONE" + } + } + +For more information, see `Listeners in AWS Global Accelerator `__ in the *AWS Global Accelerator Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/globalaccelerator/list-accelerators.rst awscli-1.18.69/awscli/examples/globalaccelerator/list-accelerators.rst --- awscli-1.11.13/awscli/examples/globalaccelerator/list-accelerators.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/globalaccelerator/list-accelerators.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,52 @@ +**To list your accelerators** + +The following ``list-accelerators`` example lists the accelerators in your account. :: + + aws globalaccelerator list-accelerators + +Output:: + + { + "Accelerators": [ + { + "AcceleratorArn": "arn:aws:globalaccelerator::012345678901:accelerator/5555abcd-abcd-5555-abcd-5555EXAMPLE1", + "Name": "TestAccelerator", + "IpAddressType": "IPV4", + "Enabled": true, + "IpSets": [ + { + "IpFamily": "IPv4", + "IpAddresses": [ + "192.0.2.250", + "198.51.100.52" + ] + } + ], + "DnsName": "5a5a5a5a5a5a5a5a.awsglobalaccelerator.com", + "Status": "DEPLOYED", + "CreatedTime": 1552424416.0, + "LastModifiedTime": 1569375641.0 + }, + { + "AcceleratorArn": "arn:aws:globalaccelerator::888888888888:accelerator/8888abcd-abcd-8888-abcd-8888EXAMPLE2", + "Name": "ExampleAccelerator", + "IpAddressType": "IPV4", + "Enabled": true, + "IpSets": [ + { + "IpFamily": "IPv4", + "IpAddresses": [ + "192.0.2.100", + "198.51.100.10" + ] + } + ], + "DnsName": "6a6a6a6a6a6a6a.awsglobalaccelerator.com", + "Status": "DEPLOYED", + "CreatedTime": 1575585564.0, + "LastModifiedTime": 1579809243.0 + }, + ] + } + +For more information, see `Accelerators in AWS Global Accelerator `__ in the *AWS Global Accelerator Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/globalaccelerator/list-byoip-cidr.rst awscli-1.18.69/awscli/examples/globalaccelerator/list-byoip-cidr.rst --- awscli-1.11.13/awscli/examples/globalaccelerator/list-byoip-cidr.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/globalaccelerator/list-byoip-cidr.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,22 @@ +**To list your address ranges** + +The following ``advertise-byoip-cidr`` example advertises an address range with AWS Global Accelerator that you've provisioned for use with your AWS resources. :: + + aws globalaccelerator list-byoip-cidrs + +Output:: + + { + "ByoipCidrs": [ + { + "Cidr": "198.51.100.0/24", + "State": "READY" + } + { + "Cidr": "203.0.113.25/24", + "State": "READY" + } + ] + } + +For more information, see `Bring Your Own IP Address in AWS Global Accelerator `__ in the *AWS Global Accelerator Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/globalaccelerator/list-endpoint-groups.rst awscli-1.18.69/awscli/examples/globalaccelerator/list-endpoint-groups.rst --- awscli-1.11.13/awscli/examples/globalaccelerator/list-endpoint-groups.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/globalaccelerator/list-endpoint-groups.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,36 @@ +**To list endpoint groups** + +The following ``list-endpoint-groups`` example lists the endpoint groups for a listener. :: + + aws globalaccelerator list-endpoint-groups \ + --listener-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/abcdef1234 \ + --region us-west-2 + +Output:: + + { + "EndpointGroups": [ + { + "EndpointGroupArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/abcdef1234/endpoint-group/ab88888example", + "EndpointGroupRegion": "eu-central-1", + "EndpointDescriptions": [], + "TrafficDialPercentage": 100.0, + "HealthCheckPort": 80, + "HealthCheckProtocol": "TCP", + "HealthCheckIntervalSeconds": 30, + "ThresholdCount": 3 + } + { + "EndpointGroupArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/abcdef1234/endpoint-group/ab99999example", + "EndpointGroupRegion": "us-east-1", + "EndpointDescriptions": [], + "TrafficDialPercentage": 50.0, + "HealthCheckPort": 80, + "HealthCheckProtocol": "TCP", + "HealthCheckIntervalSeconds": 30, + "ThresholdCount": 3 + } + ] + } + +For more information, see `Endpoint Groups in AWS Global Accelerator `__ in the *AWS Global Accelerator Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/globalaccelerator/list-listeners.rst awscli-1.18.69/awscli/examples/globalaccelerator/list-listeners.rst --- awscli-1.11.13/awscli/examples/globalaccelerator/list-listeners.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/globalaccelerator/list-listeners.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,27 @@ +**To list listeners** + +The following ``list-listeners`` example lists the listeners for an accelerator. :: + + aws globalaccelerator list-listeners \ + --accelerator-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh \ + --region us-west-2 + +Output:: + + { + "Listeners": [ + { + "ListenerArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/abcdef1234", + "PortRanges": [ + { + "FromPort": 80, + "ToPort": 80 + } + ], + "Protocol": "TCP", + "ClientAffinity": "NONE" + } + ] + } + +For more information, see `Listeners in AWS Global Accelerator `__ in the *AWS Global Accelerator Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/globalaccelerator/list-tags-for-resource.rst awscli-1.18.69/awscli/examples/globalaccelerator/list-tags-for-resource.rst --- awscli-1.11.13/awscli/examples/globalaccelerator/list-tags-for-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/globalaccelerator/list-tags-for-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To list tags for an accelerator** + +The following ``list-tags-for-resource`` example lists the listeners for an accelerator. :: + + aws globalaccelerator list-tags-for-resource \ + --accelerator-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh + +Output:: + + { + "Tags": [ + { + "Key": "Project", + "Value": "A123456" + } + ] + } + +For more information, see `Tagging in AWS Global Accelerator `__ in the *AWS Global Accelerator Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/globalaccelerator/provision-byoip-cidr.rst awscli-1.18.69/awscli/examples/globalaccelerator/provision-byoip-cidr.rst --- awscli-1.11.13/awscli/examples/globalaccelerator/provision-byoip-cidr.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/globalaccelerator/provision-byoip-cidr.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To provision an address range** + +The following ``provision-byoip-cidr`` example provisions the specified address range to use with your AWS resources. :: + + aws globalaccelerator provision-byoip-cidr \ + --cidr 203.0.113.25/24 \ + --cidr-authorization-context Message="$text_message",Signature="$signed_message" + +Output:: + + { + "ByoipCidr": { + "Cidr": "203.0.113.25/24", + "State": "PENDING_PROVISIONING" + } + } + +For more information, see `Bring Your Own IP Address in AWS Global Accelerator `__ in the *AWS Global Accelerator Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/globalaccelerator/tag-resource.rst awscli-1.18.69/awscli/examples/globalaccelerator/tag-resource.rst --- awscli-1.11.13/awscli/examples/globalaccelerator/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/globalaccelerator/tag-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To tag an accelerator** + +The following ``tag-resource`` example adds tags to an accelerator. When successful, this command has no output. :: + + aws globalaccelerator tag-resource \ + --resource-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh \ + --tags Key="Name",Value="Example Name" Key="Project",Value="Example Project" + +For more information, see `Tagging in AWS Global Accelerator `__ in the *AWS Global Accelerator Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/globalaccelerator/untag-resource.rst awscli-1.18.69/awscli/examples/globalaccelerator/untag-resource.rst --- awscli-1.11.13/awscli/examples/globalaccelerator/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/globalaccelerator/untag-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To remove a tag from an accelerator** + +The following ``untag-resource`` example removes a tag from an accelerator. When successful, this command has no output. :: + + aws globalaccelerator untag-resource \ + --resource-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh \ + --tag-keys Key="Name" Key="Project" + +For more information, see `Tagging in AWS Global Accelerator `__ in the *AWS Global Accelerator Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/globalaccelerator/update-accelerator-attributes.rst awscli-1.18.69/awscli/examples/globalaccelerator/update-accelerator-attributes.rst --- awscli-1.11.13/awscli/examples/globalaccelerator/update-accelerator-attributes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/globalaccelerator/update-accelerator-attributes.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,22 @@ +**To update an accelerator's attributes** + +The following ``update-accelerator-attributes`` example updates an accelerator to enable flow logs. The us-west-2 AWS Region must be specified. :: + + aws globalaccelerator update-accelerator-attributes \ + --accelerator-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh \ + --flow-logs-enabled \ + --flow-logs-s3-bucket flowlogs-abc \ + --flow-logs-s3-prefix bucketprefix-abc \ + --region us-west-2 + +Output:: + + { + "AcceleratorAttributes": { + "FlowLogsEnabled": true + "FlowLogsS3Bucket": flowlogs-abc + "FlowLogsS3Prefix": bucketprefix-abc + } + } + +For more information, see `Accelerators in AWS Global Accelerator `__ in the *AWS Global Accelerator Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/globalaccelerator/update-accelerator.rst awscli-1.18.69/awscli/examples/globalaccelerator/update-accelerator.rst --- awscli-1.11.13/awscli/examples/globalaccelerator/update-accelerator.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/globalaccelerator/update-accelerator.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,34 @@ +**To update an accelerator** + +The following ``update-accelerator`` example modifies an accelerator to change the accelerator name. You must specify the ``US-West-2 (Oregon)`` Region to create or update accelerators. :: + + aws globalaccelerator update-accelerator \ + --accelerator-arn arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh \ + --name ExampleAcceleratorNew \ + --region us-west-2 + +Output:: + + { + "Accelerator": { + "AcceleratorArn": "arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh", + "IpAddressType": "IPV4", + "Name": "ExampleAcceleratorNew", + "Enabled": true, + "Status": "IN_PROGRESS", + "IpSets": [ + { + "IpAddresses": [ + "192.0.2.250", + "198.51.100.52" + ], + "IpFamily": "IPv4" + } + ], + "DnsName":"a1234567890abcdef.awsglobalaccelerator.com", + "CreatedTime": 1232394847, + "LastModifiedTime": 1232395654 + } + } + +For more information, see `Accelerators in AWS Global Accelerator `__ in the *AWS Global Accelerator Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/globalaccelerator/update-endpoint-group.rst awscli-1.18.69/awscli/examples/globalaccelerator/update-endpoint-group.rst --- awscli-1.11.13/awscli/examples/globalaccelerator/update-endpoint-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/globalaccelerator/update-endpoint-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,36 @@ +**To update an endpoint group** + +The following ``update-endpoint-group`` example adds endpoints to an endpoint group. :: + + aws globalaccelerator update-endpoint-group \ + --endpoint-group-arn arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/6789vxyz-vxyz-6789-vxyz-6789lmnopqrs/endpoint-group/ab88888example \ + --endpoint-configurations \ + EndpointId=eipalloc-eip01234567890abc,Weight=128 \ + EndpointId=arn:aws:elasticloadbalancing:us-east-1:000123456789:loadbalancer/app/ALBTesting/alb01234567890xyz,Weight=128 \ + EndpointId=arn:aws:elasticloadbalancing:us-east-1:000123456789:loadbalancer/net/NLBTesting/alb01234567890qrs,Weight=128 + +Output:: + + { + "EndpointGroup": { + "TrafficDialPercentage": 100, + "EndpointDescriptions": [ + { + "Weight": 128, + "EndpointId": "eip01234567890abc" + }, + { + "Weight": 128, + "EndpointId": "arn:aws:elasticloadbalancing:us-east-1:000123456789:loadbalancer/app/ALBTesting/alb01234567890xyz" + }, + { + "Weight": 128, + "EndpointId": "arn:aws:elasticloadbalancing:us-east-1:000123456789:loadbalancer/net/NLBTesting/alb01234567890qrs" + } + ], + "EndpointGroupArn": "arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/6789vxyz-vxyz-6789-vxyz-6789lmnopqrs/endpoint-group/4321abcd-abcd-4321-abcd-4321abcdefg", + "EndpointGroupRegion": "us-east-1" + } + } + +For more information, see `Endpoint Groups in AWS Global Accelerator `__ in the *AWS Global Accelerator Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/globalaccelerator/update-listener.rst awscli-1.18.69/awscli/examples/globalaccelerator/update-listener.rst --- awscli-1.11.13/awscli/examples/globalaccelerator/update-listener.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/globalaccelerator/update-listener.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,25 @@ +**To update a listener** + +The following ``update-listener`` example updates a listener to change the port. :: + + aws globalaccelerator update-listener \ + --listener-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz \ + --port-ranges FromPort=100,ToPort=100 + +Output:: + + { + "Listener": { + "ListenerArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz + "PortRanges": [ + { + "FromPort": 100, + "ToPort": 100 + } + ], + "Protocol": "TCP", + "ClientAffinity": "NONE" + } + } + +For more information, see `Listeners in AWS Global Accelerator `__ in the *AWS Global Accelerator Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/globalaccelerator/withdraw-byoip-cidr.rst awscli-1.18.69/awscli/examples/globalaccelerator/withdraw-byoip-cidr.rst --- awscli-1.11.13/awscli/examples/globalaccelerator/withdraw-byoip-cidr.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/globalaccelerator/withdraw-byoip-cidr.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To withdraw an address range** + +The following ``withdraw-byoip-cidr`` example withdraws an address range from AWS Global Accelerator that you've previously advertised for use with your AWS resources. :: + + aws globalaccelerator withdraw-byoip-cidr \ + --cidr 203.0.113.25/24 + +Output:: + + { + "ByoipCidr": { + "Cidr": "203.0.113.25/24", + "State": "PENDING_WITHDRAWING" + } + } + +For more information, see `Bring Your Own IP Address in AWS Global Accelerator `__ in the *AWS Global Accelerator Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/greengrass/associate-role-to-group.rst awscli-1.18.69/awscli/examples/greengrass/associate-role-to-group.rst --- awscli-1.11.13/awscli/examples/greengrass/associate-role-to-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/associate-role-to-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,15 @@ +**To associate a role with a Greengrass group** + +The following ``associate-role-to-group`` example associates the specified IAM role with a Greengrass group. The group role is used by local Lambda functions and connectors to access AWS services. For example, your group role might grant permissions required for CloudWatch Logs integration. :: + + aws greengrass associate-role-to-group \ + --group-id 2494ee3f-7f8a-4e92-a78b-d205f808b84b \ + --role-arn arn:aws:iam::123456789012:role/GG-Group-Role + +Output:: + + { + "AssociatedAt": "2019-09-10T20:03:30Z" + } + +For more information, see `Configure the Group Role `__ in the *AWS IoT Greengrass Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/greengrass/associate-service-role-to-account.rst awscli-1.18.69/awscli/examples/greengrass/associate-service-role-to-account.rst --- awscli-1.11.13/awscli/examples/greengrass/associate-service-role-to-account.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/associate-service-role-to-account.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,14 @@ +**To associate a service role with your AWS account** + +The following ``associate-service-role-to-account`` example associates an IAM service role, specified by its ARN, with AWS IoT Greengrass in your AWS account. You must have previously created the service role in IAM, and you must associate a policy document with it that allows AWS IoT Greengrass to assume this role. :: + + aws greengrass associate-service-role-to-account \ + --role-arn "arn:aws:iam::123456789012:role/service-role/Greengrass_ServiceRole" + +Output:: + + { + "AssociatedAt": "2019-06-25T18:12:45Z" + } + +For more information, see `Greengrass Service Role `__ in the *AWS IoT Greengrass Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/greengrass/create-connector-definition.rst awscli-1.18.69/awscli/examples/greengrass/create-connector-definition.rst --- awscli-1.11.13/awscli/examples/greengrass/create-connector-definition.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/create-connector-definition.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To create a connector definition** + +The following ``create-connector-definition`` example example creates a connector definition and an initial connector definition version. The initial version contains one connector. All connectors in a version define values for their parameters. :: + + aws greengrass create-connector-definition \ + --name MySNSConnector \ + --initial-version "{\"Connectors\": [{\"Id\":\"MySNSConnector\",\"ConnectorArn\":\"arn:aws:greengrass:us-west-2::/connectors/SNS/versions/1\",\"Parameters\": {\"DefaultSNSArn\":\"arn:aws:sns:us-west-2:123456789012:GGConnectorTopic\"}}]}" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/connectors/b5c4ebfd-f672-49a3-83cd-31c7216a7bb8", + "CreationTimestamp": "2019-06-19T19:30:01.300Z", + "Id": "b5c4ebfd-f672-49a3-83cd-31c7216a7bb8", + "LastUpdatedTimestamp": "2019-06-19T19:30:01.300Z", + "LatestVersion": "63c57963-c7c2-4a26-a7e2-7bf478ea2623", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/connectors/b5c4ebfd-f672-49a3-83cd-31c7216a7bb8/versions/63c57963-c7c2-4a26-a7e2-7bf478ea2623", + "Name": "MySNSConnector" + } + +For more information, see `Getting Started with Greengrass Connectors (CLI) `__ in the **AWS IoT Greengrass Developer Guide**. diff -Nru awscli-1.11.13/awscli/examples/greengrass/create-connector-definition-version.rst awscli-1.18.69/awscli/examples/greengrass/create-connector-definition-version.rst --- awscli-1.11.13/awscli/examples/greengrass/create-connector-definition-version.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/create-connector-definition-version.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,16 @@ +**To create a connector definition version** + +The following ``create-connector-definition-version`` example creates a connector definition version and associates it with the specified connector definition. All connectors in a version define values for their parameters. :: + + aws greengrass create-connector-definition-version \ + --connector-definition-id "55d0052b-0d7d-44d6-b56f-21867215e118" \ + --connectors "[{\"Id\": \"MyTwilioNotificationsConnector\", \"ConnectorArn\": \"arn:aws:greengrass:us-west-2::/connectors/TwilioNotifications/versions/2\", \"Parameters\": {\"TWILIO_ACCOUNT_SID\": \"AC1a8d4204890840d7fc482aab38090d57\", \"TwilioAuthTokenSecretArn\": \"arn:aws:secretsmanager:us-west-2:123456789012:secret:greengrass-TwilioAuthToken-ntSlp6\", \"TwilioAuthTokenSecretArn-ResourceId\": \"TwilioAuthToken\", \"DefaultFromPhoneNumber\": \"4254492999\"}}]" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/connectors/55d0052b-0d7d-44d6-b56f-21867215e118/versions/33f709a0-c825-49cb-9eea-dc8964fbd635", + "CreationTimestamp": "2019-06-24T20:46:30.134Z", + "Id": "55d0052b-0d7d-44d6-b56f-21867215e118", + "Version": "33f709a0-c825-49cb-9eea-dc8964fbd635" + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/create-core-definition.rst awscli-1.18.69/awscli/examples/greengrass/create-core-definition.rst --- awscli-1.11.13/awscli/examples/greengrass/create-core-definition.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/create-core-definition.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,104 @@ +**Example 1: To create an empty core definition** + +The following ``create-core-definition`` example creates an empty (no initial version) Greengrass core definition. Before the core is usable, you must use the ``create-core-definition-version`` command to provide the other parameters for the core. :: + + aws greengrass create-core-definition \ + --name cliGroup_Core + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/b5c08008-54cb-44bd-9eec-c121b04283b5", + "CreationTimestamp": "2019-06-25T18:23:22.106Z", + "Id": "b5c08008-54cb-44bd-9eec-c121b04283b5", + "LastUpdatedTimestamp": "2019-06-25T18:23:22.106Z", + "Name": "cliGroup_Core" + } + +**Example 2: To create a core definition with an initial version** + +The following ``create-core-definition`` example creates a core definition that contains an initial core definition version. The version can contain one core only. Before you can create a core, you must first create and provision the corresponding AWS IoT thing. This process includes the following ``iot`` commands, which return the ``ThingArn`` and ``CertificateArn`` required for the ``create-core-definition`` command. + +* Create the AWS IoT thing that corresponds to the core device:: + + aws iot create-thing \ + --thing-name "MyCoreDevice" + +Output:: + + { + "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyCoreDevice", + "thingName": "MyCoreDevice", + "thingId": "cb419a19-9099-4515-9cec-e9b0e760608a" + } + +* Create public and private keys and the core device certificate for the thing. This example uses the ``create-keys-and-certificate`` command and requires write permissions to the current directory. Alternatively, you can use the ``create-certificate-from-csr`` command. :: + + aws iot create-keys-and-certificate \ + --set-as-active \ + --certificate-pem-outfile "myCore.cert.pem" \ + --public-key-outfile "myCore.public.key" \ + --private-key-outfile "myCore.private.key" + +Output:: + + { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz", + "certificatePem": "-----BEGIN CERTIFICATE-----\nMIIDWTCAkGgAwIBATgIUCgq6EGqou6zFqWgIZRndgQEFW+gwDQYJKoZIhvc...KdGewQS\n-----END CERTIFICATE-----\n", + "keyPair": { + "PublicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBzrqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqKpRgnn6yq26U3y...wIDAQAB\n-----END PUBLIC KEY-----\n", + "PrivateKey": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIABAKCAQEAqKpRgnn6yq26U3yt5YFZquyukfRjbMXDcNOK4rMCxDR...fvY4+te\n-----END RSA PRIVATE KEY-----\n" + }, + "certificateId": "123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz" + } + +* Create an AWS IoT policy that allows ``iot`` and ``greengrass`` actions. For simplicity, the following policy allows actions on all resources, but your policy should be more restrictive. :: + + aws iot create-policy \ + --policy-name "Core_Devices" \ + --policy-document "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"iot:Publish\",\"iot:Subscribe\",\"iot:Connect\",\"iot:Receive\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"iot:GetThingShadow\",\"iot:UpdateThingShadow\",\"iot:DeleteThingShadow\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"greengrass:*\"],\"Resource\":[\"*\"]}]}" + +Output:: + + { + "policyName": "Core_Devices", + "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/Core_Devices", + "policyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"iot:Publish\",\"iot:Subscribe\",\"iot:Connect\",\"iot:Receive\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"iot:GetThingShadow\",\"iot:UpdateThingShadow\",\"iot:DeleteThingShadow\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"greengrass:*\"],\"Resource\":[\"*\"]}]}", + "policyVersionId": "1" + } + +* Attach the policy to the certificate:: + + aws iot attach-policy \ + --policy-name "Core_Devices" \ + --target "arn:aws:iot:us-west-2:123456789012:cert/123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz" + +This command produces no output. + +* Attach the thing to the certificate:: + + aws iot attach-thing-principal \ + --thing-name "MyCoreDevice" \ + --principal "arn:aws:iot:us-west-2:123456789012:cert/123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz" + +This command produces no output. + +* Create the core definition:: + + aws greengrass create-core-definition \ + --name "MyCores" \ + --initial-version "{\"Cores\":[{\"Id\":\"MyCoreDevice\",\"ThingArn\":\"arn:aws:iot:us-west-2:123456789012:thing/MyCoreDevice\",\"CertificateArn\":\"arn:aws:iot:us-west-2:123456789012:cert/123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz\",\"SyncShadow\":true}]}" + +Output:: + + { + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/582efe12-b05a-409e-9a24-a2ba1bcc4a12/versions/cc87b5b3-8f4b-465d-944c-1d6de5dbfcdb", + "Name": "MyCores", + "LastUpdatedTimestamp": "2019-09-18T00:11:06.197Z", + "LatestVersion": "cc87b5b3-8f4b-465d-944c-1d6de5dbfcdb", + "CreationTimestamp": "2019-09-18T00:11:06.197Z", + "Id": "582efe12-b05a-409e-9a24-a2ba1bcc4a12", + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/582efe12-b05a-409e-9a24-a2ba1bcc4a12" + } + +For more information, see `Configure the AWS IoT Greengrass Core `__ in the *AWS IoT Greengrass Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/greengrass/create-core-definition-version.rst awscli-1.18.69/awscli/examples/greengrass/create-core-definition-version.rst --- awscli-1.11.13/awscli/examples/greengrass/create-core-definition-version.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/create-core-definition-version.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,84 @@ +**To create a core definition version** + +The following ``create-core-definition-version`` example creates a core definition version and associates it with the specified core definition. The version can contain one core only. Before you can create a core, you must first create and provision the corresponding AWS IoT thing. This process includes the following ``iot`` commands, which return the ``ThingArn`` and ``CertificateArn`` required for the ``create-core-definition-version`` command. + +* Create the AWS IoT thing that corresponds to the core device:: + + aws iot create-thing \ + --thing-name "MyCoreDevice" + +Output:: + + { + "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyCoreDevice", + "thingName": "MyCoreDevice", + "thingId": "cb419a19-9099-4515-9cec-e9b0e760608a" + } + +* Create public and private keys and the core device certificate for the thing. This example uses the ``create-keys-and-certificate`` command and requires write permissions to the current directory. Alternatively, you can use the ``create-certificate-from-csr`` command. :: + + aws iot create-keys-and-certificate \ + --set-as-active \ + --certificate-pem-outfile "myCore.cert.pem" \ + --public-key-outfile "myCore.public.key" \ + --private-key-outfile "myCore.private.key" + +Output:: + + { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz", + "certificatePem": "-----BEGIN CERTIFICATE-----\nMIIDWTCAkGgAwIBATgIUCgq6EGqou6zFqWgIZRndgQEFW+gwDQYJKoZIhvc...KdGewQS\n-----END CERTIFICATE-----\n", + "keyPair": { + "PublicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBzrqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqKpRgnn6yq26U3y...wIDAQAB\n-----END PUBLIC KEY-----\n", + "PrivateKey": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIABAKCAQEAqKpRgnn6yq26U3yt5YFZquyukfRjbMXDcNOK4rMCxDR...fvY4+te\n-----END RSA PRIVATE KEY-----\n" + }, + "certificateId": "123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz" + } + +* Create an AWS IoT policy that allows ``iot`` and ``greengrass`` actions. For simplicity, the following policy allows actions on all resources, but your policy should be more restrictive. :: + + aws iot create-policy \ + --policy-name "Core_Devices" \ + --policy-document "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"iot:Publish\",\"iot:Subscribe\",\"iot:Connect\",\"iot:Receive\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"iot:GetThingShadow\",\"iot:UpdateThingShadow\",\"iot:DeleteThingShadow\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"greengrass:*\"],\"Resource\":[\"*\"]}]}" + +Output:: + + { + "policyName": "Core_Devices", + "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/Core_Devices", + "policyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"iot:Publish\",\"iot:Subscribe\",\"iot:Connect\",\"iot:Receive\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"iot:GetThingShadow\",\"iot:UpdateThingShadow\",\"iot:DeleteThingShadow\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"greengrass:*\"],\"Resource\":[\"*\"]}]}", + "policyVersionId": "1" + } + +* Attach the policy to the certificate:: + + aws iot attach-policy \ + --policy-name "Core_Devices" \ + --target "arn:aws:iot:us-west-2:123456789012:cert/123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz" + +This command produces no output. + +* Attach the thing to the certificate:: + + aws iot attach-thing-principal \ + --thing-name "MyCoreDevice" \ + --principal "arn:aws:iot:us-west-2:123456789012:cert/123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz" + +This command produces no output. + +* Create the core definition version:: + + aws greengrass create-core-definition-version \ + --core-definition-id "582efe12-b05a-409e-9a24-a2ba1bcc4a12" \ + --cores "[{\"Id\":\"MyCoreDevice\",\"ThingArn\":\"arn:aws:iot:us-west-2:123456789012:thing/MyCoreDevice\",\"CertificateArn\":\"arn:aws:iot:us-west-2:123456789012:cert/123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz\",\"SyncShadow\":true}]" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/582efe12-b05a-409e-9a24-a2ba1bcc4a12/versions/3fdc1190-2ce5-44de-b98b-eec8f9571014", + "Version": "3fdc1190-2ce5-44de-b98b-eec8f9571014", + "CreationTimestamp": "2019-09-18T00:15:09.838Z", + "Id": "582efe12-b05a-409e-9a24-a2ba1bcc4a12" + } + +For more information, see `Configure the AWS IoT Greengrass Core `__ in the *AWS IoT Greengrass Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/greengrass/create-deployment.rst awscli-1.18.69/awscli/examples/greengrass/create-deployment.rst --- awscli-1.11.13/awscli/examples/greengrass/create-deployment.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/create-deployment.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To create a deployment for a version of a Greengrass group** + +The following ``create-deployment`` example deploys the specified version of a Greengrass group. :: + + aws greengrass create-deployment \ + --deployment-type NewDeployment \ + --group-id "ce2e7d01-3240-4c24-b8e6-f6f6e7a9eeca" \ + --group-version-id "dc40c1e9-e8c8-4d28-a84d-a9cad5f599c9" + +Output:: + + { + "DeploymentArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/ce2e7d01-3240-4c24-b8e6-f6f6e7a9eeca/deployments/bfceb608-4e97-45bc-af5c-460144270308", + "DeploymentId": "bfceb608-4e97-45bc-af5c-460144270308" + } + +For more information, see `Getting Started with Connectors (CLI) `__ in the *AWS IoT Greengrass Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/greengrass/create-device-definition.rst awscli-1.18.69/awscli/examples/greengrass/create-device-definition.rst --- awscli-1.11.13/awscli/examples/greengrass/create-device-definition.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/create-device-definition.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,82 @@ +**To create a device definition** + +The following ``create-device-definition`` example creates a device definition that contains an initial device definition version. The initial version defines two devices. +Before you can create a Greengrass device, you must first create and provision the corresponding AWS IoT thing. This process includes the following ``iot`` commands that you must run to get the required information for the Greengrass command: + +* Create the AWS IoT thing that corresponds to the device:: + + aws iot create-thing \ + --thing-name "InteriorTherm" + +Output:: + + { + "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/InteriorTherm", + "thingName": "InteriorTherm", + "thingId": "01d4763c-78a6-46c6-92be-7add080394bf" + } + +* Create public and private keys and the device certificate for the thing. This example uses the ``create-keys-and-certificate`` command and requires write permissions to the current directory. Alternatively, you can use the ``create-certificate-from-csr`` command:: + + aws iot create-keys-and-certificate \ + --set-as-active \ + --certificate-pem-outfile "myDevice.cert.pem" \ + --public-key-outfile "myDevice.public.key" \ + --private-key-outfile "myDevice.private.key" + +Output:: + + { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92", + "certificatePem": "-----BEGIN CERTIFICATE-----\nMIIDWTCAkGgAwIBATgIUCgq6EGqou6zFqWgIZRndgQEFW+gwDQYJKoZIhvc...KdGewQS\n-----END CERTIFICATE-----\n", + "keyPair": { + "PublicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBzrqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqKpRgnn6yq26U3y...wIDAQAB\n-----END PUBLIC KEY-----\n", + "PrivateKey": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIABAKCAQEAqKpRgnn6yq26U3yt5YFZquyukfRjbMXDcNOK4rMCxDR...fvY4+te\n-----END RSA PRIVATE KEY-----\n" + }, + "certificateId": "66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92" + } + +* Create an AWS IoT policy that allows ``iot`` and ``greengrass`` actions. For simplicity, the following policy allows actions on all resources, but your policy can be more restrictive:: + + aws iot create-policy \ + --policy-name "GG_Devices" \ + --policy-document "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"iot:Publish\",\"iot:Subscribe\",\"iot:Connect\",\"iot:Receive\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"iot:GetThingShadow\",\"iot:UpdateThingShadow\",\"iot:DeleteThingShadow\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"greengrass:*\"],\"Resource\":[\"*\"]}]}" + +Output:: + + { + "policyName": "GG_Devices", + "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/GG_Devices", + "policyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"iot:Publish\",\"iot:Subscribe\",\"iot:Connect\",\"iot:Receive\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"iot:GetThingShadow\",\"iot:UpdateThingShadow\",\"iot:DeleteThingShadow\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"greengrass:*\"],\"Resource\":[\"*\"]}]}", + "policyVersionId": "1" + } + +* Attach the policy to the certificate:: + + aws iot attach-policy \ + --policy-name "GG_Devices" \ + --target "arn:aws:iot:us-west-2:123456789012:cert/66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92" + +* Attach the thing to the certificate :: + + aws iot attach-thing-principal \ + --thing-name "InteriorTherm" \ + --principal "arn:aws:iot:us-west-2:123456789012:cert/66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92" + +After you create and configure the IoT thing as shown above, use the ``ThingArn`` and ``CertificateArn`` from the first two commands in the following example. :: + + aws greengrass create-device-definition \ + --name "Sensors" \ + --initial-version "{\"Devices\":[{\"Id\":\"InteriorTherm\",\"ThingArn\":\"arn:aws:iot:us-west-2:123456789012:thing/InteriorTherm\",\"CertificateArn\":\"arn:aws:iot:us-west-2:123456789012:cert/66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92\",\"SyncShadow\":true},{\"Id\":\"ExteriorTherm\",\"ThingArn\":\"arn:aws:iot:us-west-2:123456789012:thing/ExteriorTherm\",\"CertificateArn\":\"arn:aws:iot:us-west-2:123456789012:cert/6c52ce1b47bde88a637e9ccdd45fe4e4c2c0a75a6866f8f63d980ee22fa51e02\",\"SyncShadow\":true}]}" + +Output:: + + { + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/f9ba083d-5ad4-4534-9f86-026a45df1ccd/versions/3b5cc510-58c1-44b5-9d98-4ad858ffa795", + "Name": "Sensors", + "LastUpdatedTimestamp": "2019-09-11T00:11:06.197Z", + "LatestVersion": "3b5cc510-58c1-44b5-9d98-4ad858ffa795", + "CreationTimestamp": "2019-09-11T00:11:06.197Z", + "Id": "f9ba083d-5ad4-4534-9f86-026a45df1ccd", + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/f9ba083d-5ad4-4534-9f86-026a45df1ccd" + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/create-device-definition-version.rst awscli-1.18.69/awscli/examples/greengrass/create-device-definition-version.rst --- awscli-1.11.13/awscli/examples/greengrass/create-device-definition-version.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/create-device-definition-version.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,79 @@ +**To create a device definition version** + +The following ``create-device-definition-version`` example creates a device definition version and associates it with the specified device definition. The version defines two devices. +Before you can create a Greengrass device, you must first create and provision the corresponding AWS IoT thing. This process includes the following ``iot`` commands that you must run to get the required information for the Greengrass command: + +* Create the AWS IoT thing that corresponds to the device:: + + aws iot create-thing \ + --thing-name "InteriorTherm" + +Output:: + + { + "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/InteriorTherm", + "thingName": "InteriorTherm", + "thingId": "01d4763c-78a6-46c6-92be-7add080394bf" + } + +* Create public and private keys and the device certificate for the thing. This example uses the ``create-keys-and-certificate`` command and requires write permissions to the current directory. Alternatively, you can use the ``create-certificate-from-csr`` command:: + + aws iot create-keys-and-certificate \ + --set-as-active \ + --certificate-pem-outfile "myDevice.cert.pem" \ + --public-key-outfile "myDevice.public.key" \ + --private-key-outfile "myDevice.private.key" + +Output:: + + { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92", + "certificatePem": "-----BEGIN CERTIFICATE-----\nMIIDWTCAkGgAwIBATgIUCgq6EGqou6zFqWgIZRndgQEFW+gwDQYJKoZIhvc...KdGewQS\n-----END CERTIFICATE-----\n", + "keyPair": { + "PublicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBzrqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqKpRgnn6yq26U3y...wIDAQAB\n-----END PUBLIC KEY-----\n", + "PrivateKey": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIABAKCAQEAqKpRgnn6yq26U3yt5YFZquyukfRjbMXDcNOK4rMCxDR...fvY4+te\n-----END RSA PRIVATE KEY-----\n" + }, + "certificateId": "66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92" + } + +* Create an AWS IoT policy that allows ``iot`` and ``greengrass`` actions. For simplicity, the following policy allows actions on all resources, but your policy can be more restrictive:: + + aws iot create-policy \ + --policy-name "GG_Devices" \ + --policy-document "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"iot:Publish\",\"iot:Subscribe\",\"iot:Connect\",\"iot:Receive\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"iot:GetThingShadow\",\"iot:UpdateThingShadow\",\"iot:DeleteThingShadow\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"greengrass:*\"],\"Resource\":[\"*\"]}]}" + +Output:: + + { + "policyName": "GG_Devices", + "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/GG_Devices", + "policyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"iot:Publish\",\"iot:Subscribe\",\"iot:Connect\",\"iot:Receive\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"iot:GetThingShadow\",\"iot:UpdateThingShadow\",\"iot:DeleteThingShadow\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"greengrass:*\"],\"Resource\":[\"*\"]}]}", + "policyVersionId": "1" + } + +* Attach the policy to the certificate:: + + aws iot attach-policy \ + --policy-name "GG_Devices" \ + --target "arn:aws:iot:us-west-2:123456789012:cert/66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92" + +* Attach the thing to the certificate :: + + aws iot attach-thing-principal \ + --thing-name "InteriorTherm" \ + --principal "arn:aws:iot:us-west-2:123456789012:cert/66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92" + +After you create and configure the IoT thing as shown above, use the ``ThingArn`` and ``CertificateArn`` from the first two commands in the following example. :: + + aws greengrass create-device-definition-version \ + --device-definition-id "f9ba083d-5ad4-4534-9f86-026a45df1ccd" \ + --devices "[{\"Id\":\"InteriorTherm\",\"ThingArn\":\"arn:aws:iot:us-west-2:123456789012:thing/InteriorTherm\",\"CertificateArn\":\"arn:aws:iot:us-west-2:123456789012:cert/66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92\",\"SyncShadow\":true},{\"Id\":\"ExteriorTherm\",\"ThingArn\":\"arn:aws:iot:us-west-2:123456789012:thing/ExteriorTherm\",\"CertificateArn\":\"arn:aws:iot:us-west-2:123456789012:cert/6c52ce1b47bde88a637e9ccdd45fe4e4c2c0a75a6866f8f63d980ee22fa51e02\",\"SyncShadow\":true}]" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/f9ba083d-5ad4-4534-9f86-026a45df1ccd/versions/83c13984-6fed-447e-84d5-5b8aa45d5f71", + "Version": "83c13984-6fed-447e-84d5-5b8aa45d5f71", + "CreationTimestamp": "2019-09-11T00:15:09.838Z", + "Id": "f9ba083d-5ad4-4534-9f86-026a45df1ccd" + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/create-function-definition.rst awscli-1.18.69/awscli/examples/greengrass/create-function-definition.rst --- awscli-1.11.13/awscli/examples/greengrass/create-function-definition.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/create-function-definition.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To create a Lambda function definition** + +The following ``create-function-definition`` example creates a Lambda function definition and an initial version by providing a list of Lambda functions (in this case, a list of just one function named ``TempMonitorFunction``) and their configurations. Before you can create the function definition, you need the Lambda function ARN. To create the function and its alias, use Lambda's ``create-function`` and ``publish-version`` commands. Lambda's ``create-function`` command requires the ARN of the execution role, even though AWS IoT Greengrass doesn't use that role because permissions are specified in the Greengrass group role. You can use the IAM ``create-role`` command to create an empty role to get an ARN to use with Lambda's ``create-function`` or you can use an existing execution role. :: + + aws greengrass create-function-definition \ + --name MyGreengrassFunctions \ + --initial-version "{\"Functions\": [{\"Id\": \"TempMonitorFunction\", \"FunctionArn\": \"arn:aws:lambda:us-west-2:123456789012:function:TempMonitor:GG_TempMonitor\", \"FunctionConfiguration\": {\"Executable\": \"temp_monitor.function_handler\", \"MemorySize\": 16000,\"Timeout\": 5}}]}" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/3b0d0080-87e7-48c6-b182-503ec743a08b", + "CreationTimestamp": "2019-06-19T22:24:44.585Z", + "Id": "3b0d0080-87e7-48c6-b182-503ec743a08b", + "LastUpdatedTimestamp": "2019-06-19T22:24:44.585Z", + "LatestVersion": "67f918b9-efb4-40b0-b87c-de8c9faf085b", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/3b0d0080-87e7-48c6-b182-503ec743a08b/versions/67f918b9-efb4-40b0-b87c-de8c9faf085b", + "Name": "MyGreengrassFunctions" + } + +For more information, see `How to Configure Local Resource Access Using the AWS Command Line Interface `__ in the *AWS IoT Greengrass Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/greengrass/create-function-definition-version.rst awscli-1.18.69/awscli/examples/greengrass/create-function-definition-version.rst --- awscli-1.11.13/awscli/examples/greengrass/create-function-definition-version.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/create-function-definition-version.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,15 @@ +**To create a version of the function defintion** + +The following ``create-function-definition-version`` example creates a new version of the specified function definition. This version specifies a single function whose ID is ``Hello-World-function``, allows access to the file system, and specifies a maximum memory size and timeout period. :: + + aws greengrass create-function-definition-version \ + --cli-input-json "{\"FunctionDefinitionId\": \"e626e8c9-3b8f-4bf3-9cdc-d26ecdeb9fa3\",\"Functions\": [{\"Id\": \"Hello-World-function\", \"FunctionArn\": \""arn:aws:lambda:us-west-2:123456789012:function:Greengrass_HelloWorld_Counter:gghw-alias"\",\"FunctionConfiguration\": {\"Environment\": {\"AccessSysfs\": true},\"Executable\": \"greengrassHelloWorldCounter.function_handler\",\"MemorySize\": 16000,\"Pinned\": false,\"Timeout\": 25}}]}" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/e626e8c9-3b8f-4bf3-9cdc-d26ecdeb9fa3/versions/74abd1cc-637e-4abe-8684-9a67890f4043", + "CreationTimestamp": "2019-06-25T22:03:43.376Z", + "Id": "e626e8c9-3b8f-4bf3-9cdc-d26ecdeb9fa3", + "Version": "74abd1cc-637e-4abe-8684-9a67890f4043" + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/create-group-certificate-authority.rst awscli-1.18.69/awscli/examples/greengrass/create-group-certificate-authority.rst --- awscli-1.11.13/awscli/examples/greengrass/create-group-certificate-authority.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/create-group-certificate-authority.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,14 @@ +**To create a certificate authority (CA) for a group** + +The following ``create-group-certificate-authority`` example creates or rotates a CA for the specified group. :: + + aws greengrass create-group-certificate-authority \ + --group-id "8eaadd72-ce4b-4f15-892a-0cc4f3a343f1" + +Output:: + + { + "GroupCertificateAuthorityArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/8eaadd72-ce4b-4f15-892a-0cc4f3a343f1/certificateauthorities/d31630d674c4437f6c5dbc0dca56312a902171ce2d086c38e509c8EXAMPLEcc5" + } + +For more information, see `AWS IoT Greengrass Security `__ in the *AWS IoT Greengrass Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/greengrass/create-group.rst awscli-1.18.69/awscli/examples/greengrass/create-group.rst --- awscli-1.11.13/awscli/examples/greengrass/create-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/create-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,16 @@ +**To create a Greeengrass group** + +The following ``create-group`` example creates a group named ``cli-created-group``. :: + + aws greengrass create-group \ + cli-created-group + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/4e22bd92-898c-436b-ade5-434d883ff749", + "CreationTimestamp": "2019-06-25T18:07:17.688Z", + "Id": "4e22bd92-898c-436b-ade5-434d883ff749", + "LastUpdatedTimestamp": "2019-06-25T18:07:17.688Z", + "Name": "cli-created-group" + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/create-group-version.rst awscli-1.18.69/awscli/examples/greengrass/create-group-version.rst --- awscli-1.11.13/awscli/examples/greengrass/create-group-version.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/create-group-version.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,32 @@ +**To create a version of a Greengrass group** + +The following ``create-group-version`` example creates a group version and associates it with the specified group. The version references the core, resource, connector, function, and subscription versions that contain the entities to include in this group version. You must create these entities before you can create the group version. + +* To create a resource definition with an initial version, use the ``create-resource-definition`` command. + +* To create a connector definition with an initial version, use the ``create-connector-definition`` command. + +* To create a function definition with an initial version, use the ``create-function-definition`` command. + +* To create a subscription definition with an initial version, use the ``create-subscription-definition`` command. + +* To retrieve the ARN of the latest core definition version, use the ``get-group-version`` command and specify the ID of the latest group version. :: + + aws greengrass create-group-version \ + --group-id "ce2e7d01-3240-4c24-b8e6-f6f6e7a9eeca" \ + --core-definition-version-arn "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/6a630442-8708-4838-ad36-eb98849d975e/versions/6c87151b-1fb4-4cb2-8b31-6ee715d8f8ba" \ + --resource-definition-version-arn "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/c8bb9ebc-c3fd-40a4-9c6a-568d75569d38/versions/a5f94d0b-f6bc-40f4-bb78-7a1c5fe13ba1" \ + --connector-definition-version-arn "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/connectors/55d0052b-0d7d-44d6-b56f-21867215e118/versions/78a3331b-895d-489b-8823-17b4f9f418a0" \ + --function-definition-version-arn "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/3b0d0080-87e7-48c6-b182-503ec743a08b/versions/67f918b9-efb4-40b0-b87c-de8c9faf085b" \ + --subscription-definition-version-arn "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/9d611d57-5d5d-44bd-a3b4-feccbdd69112/versions/aa645c47-ac90-420d-9091-8c7ffa4f103f" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/ce2e7d01-3240-4c24-b8e6-f6f6e7a9eeca/versions/e10b0459-4345-4a09-88a4-1af1f5d34638", + "CreationTimestamp": "2019-06-20T18:42:47.020Z", + "Id": "ce2e7d01-3240-4c24-b8e6-f6f6e7a9eeca", + "Version": "e10b0459-4345-4a09-88a4-1af1f5d34638" + } + +For more information, see `Overview of the AWS IoT Greengrass Group Object Model `__ in the *AWS IoT Greengrass Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/greengrass/create-logger-definition.rst awscli-1.18.69/awscli/examples/greengrass/create-logger-definition.rst --- awscli-1.11.13/awscli/examples/greengrass/create-logger-definition.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/create-logger-definition.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To create a logger definition** + +The following ``create-logger-definition`` example creates a logger definition that contains an initial logger definition version. The initial version defines three logging configurations: 1) system component logs on the file system of the core device, 2) user-defined Lambda function logs on the file system of the core device, and 3) user-defined Lambda function logs in Amazon CloudWatch Logs. Note: For CloudWatch Logs integration, your group role must grant appropriate permissions. :: + + aws greengrass create-logger-definition \ + --name "LoggingConfigs" \ + --initial-version "{\"Loggers\":[{\"Id\":\"1\",\"Component\":\"GreengrassSystem\",\"Level\":\"ERROR\",\"Space\":10240,\"Type\":\"FileSystem\"},{\"Id\":\"2\",\"Component\":\"Lambda\",\"Level\":\"INFO\",\"Space\":10240,\"Type\":\"FileSystem\"},{\"Id\":\"3\",\"Component\":\"Lambda\",\"Level\":\"INFO\",\"Type\":\"AWSCloudWatch\"}]}" + +Output:: + + { + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/loggers/a454b62a-5d56-4ca9-bdc4-8254e1662cb0/versions/de1d9854-1588-4525-b25e-b378f60f2322", + "Name": "LoggingConfigs", + "LastUpdatedTimestamp": "2019-07-23T23:52:17.165Z", + "LatestVersion": "de1d9854-1588-4525-b25e-b378f60f2322", + "CreationTimestamp": "2019-07-23T23:52:17.165Z", + "Id": "a454b62a-5d56-4ca9-bdc4-8254e1662cb0", + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/loggers/a454b62a-5d56-4ca9-bdc4-8254e1662cb0" + } + +For more information, see `Monitoring with AWS IoT Greengrass Logs `__ in the *AWS IoT Greengrass Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/greengrass/create-logger-definition-version.rst awscli-1.18.69/awscli/examples/greengrass/create-logger-definition-version.rst --- awscli-1.11.13/awscli/examples/greengrass/create-logger-definition-version.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/create-logger-definition-version.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To create a logger definition version** + +The following ``create-logger-definition-version`` example creates a logger definition version and associates it with a logger definition. The version defines four logging configurations: 1) system component logs on the file system of the core device, 2) user-defined Lambda function logs on the file system of the core device, 3) system component logs in Amazon CloudWatch Logs, and 4) user-defined Lambda function logs in Amazon CloudWatch Logs. Note: For CloudWatch Logs integration, your group role must grant appropriate permissions. :: + + aws greengrass create-logger-definition-version \ + --logger-definition-id "a454b62a-5d56-4ca9-bdc4-8254e1662cb0" \ + --loggers "[{\"Id\":\"1\",\"Component\":\"GreengrassSystem\",\"Level\":\"ERROR\",\"Space\":10240,\"Type\":\"FileSystem\"},{\"Id\":\"2\",\"Component\":\"Lambda\",\"Level\":\"INFO\",\"Space\":10240,\"Type\":\"FileSystem\"},{\"Id\":\"3\",\"Component\":\"GreengrassSystem\",\"Level\":\"WARN\",\"Type\":\"AWSCloudWatch\"},{\"Id\":\"4\",\"Component\":\"Lambda\",\"Level\":\"INFO\",\"Type\":\"AWSCloudWatch\"}]" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/loggers/a454b62a-5d56-4ca9-bdc4-8254e1662cb0/versions/49aedb1e-01a3-4d39-9871-3a052573f1ea", + "Version": "49aedb1e-01a3-4d39-9871-3a052573f1ea", + "CreationTimestamp": "2019-07-24T00:04:48.523Z", + "Id": "a454b62a-5d56-4ca9-bdc4-8254e1662cb0" + } + +For more information, see `Monitoring with AWS IoT Greengrass Logs `__ in the *AWS IoT Greengrass Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/greengrass/create-resource-definition.rst awscli-1.18.69/awscli/examples/greengrass/create-resource-definition.rst --- awscli-1.11.13/awscli/examples/greengrass/create-resource-definition.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/create-resource-definition.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To create a resource definition** + +The following ``create-resource-definition`` example creates a resource definition that contains a list of resources to be used in a Greengrass group. In this example, an initial version of the resource definition is included by providing a list of resources. The list includes one resource for a Twilio authorization token and the ARN for a secret stored in AWS Secrets Manager. You must create the secret before you can create the resource definition. :: + + aws greengrass create-resource-definition \ + --name MyGreengrassResources \ + --initial-version "{\"Resources\": [{\"Id\": \"TwilioAuthToken\",\"Name\": \"MyTwilioAuthToken\",\"ResourceDataContainer\": {\"SecretsManagerSecretResourceData\": {\"ARN\": \"arn:aws:secretsmanager:us-west-2:123456789012:secret:greengrass-TwilioAuthToken-ntSlp6\"}}}]}" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/c8bb9ebc-c3fd-40a4-9c6a-568d75569d38", + "CreationTimestamp": "2019-06-19T21:51:28.212Z", + "Id": "c8bb9ebc-c3fd-40a4-9c6a-568d75569d38", + "LastUpdatedTimestamp": "2019-06-19T21:51:28.212Z", + "LatestVersion": "a5f94d0b-f6bc-40f4-bb78-7a1c5fe13ba1", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/c8bb9ebc-c3fd-40a4-9c6a-568d75569d38/versions/a5f94d0b-f6bc-40f4-bb78-7a1c5fe13ba1", + "Name": "MyGreengrassResources" + } + +For more information, see `How to Configure Local Resource Access Using the AWS Command Line Interface `__ in the *AWS IoT Greengrass Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/greengrass/create-resource-definition-version.rst awscli-1.18.69/awscli/examples/greengrass/create-resource-definition-version.rst --- awscli-1.11.13/awscli/examples/greengrass/create-resource-definition-version.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/create-resource-definition-version.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,16 @@ +**To create a version of a resource definition** + +The following ``create-resource-definition-version`` example creates a new version of a TwilioAuthToken. :: + + aws greengrass create-resource-definition-version \ + --resource-definition-id "c8bb9ebc-c3fd-40a4-9c6a-568d75569d38" \ + --resources "[{\"Id\": \"TwilioAuthToken\",\"Name\": \"MyTwilioAuthToken\",\"ResourceDataContainer\": {\"SecretsManagerSecretResourceData\": {\"ARN\": \"arn:aws:secretsmanager:us-west-2:123456789012:secret:greengrass-TwilioAuthToken-ntSlp6\"}}}]" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/c8bb9ebc-c3fd-40a4-9c6a-568d75569d38/versions/b3bcada0-5fb6-42df-bf0b-1ee4f15e769e", + "CreationTimestamp": "2019-06-24T21:17:25.623Z", + "Id": "c8bb9ebc-c3fd-40a4-9c6a-568d75569d38", + "Version": "b3bcada0-5fb6-42df-bf0b-1ee4f15e769e" + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/create-software-update-job.rst awscli-1.18.69/awscli/examples/greengrass/create-software-update-job.rst --- awscli-1.11.13/awscli/examples/greengrass/create-software-update-job.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/create-software-update-job.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To create a software update job for a core** + +The following ``create-software-update-job`` example creates an over-the-air (OTA) update job to update the AWS IoT Greengrass Core software on the core whose name is ``MyFirstGroup_Core``. This command requires an IAM role that allows access to software update packages in Amazon S3 and includes ``iot.amazonaws.com`` as a trusted entity. :: + + aws greengrass create-software-update-job \ + --update-targets-architecture armv7l \ + --update-targets [\"arn:aws:iot:us-west-2:123456789012:thing/MyFirstGroup_Core\"] \ + --update-targets-operating-system raspbian \ + --software-to-update core \ + --s3-url-signer-role arn:aws:iam::123456789012:role/OTA_signer_role \ + --update-agent-log-level WARN + +Output:: + + { + "IotJobId": "GreengrassUpdateJob_30b353e3-3af7-4786-be25-4c446663c09e", + "IotJobArn": "arn:aws:iot:us-west-2:123456789012:job/GreengrassUpdateJob_30b353e3-3af7-4786-be25-4c446663c09e", + "PlatformSoftwareVersion": "1.9.3" + } + +For more information, see `OTA Updates of AWS IoT Greengrass Core Software `__ in the *AWS IoT Greengrass Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/greengrass/create-subscription-definition.rst awscli-1.18.69/awscli/examples/greengrass/create-subscription-definition.rst --- awscli-1.11.13/awscli/examples/greengrass/create-subscription-definition.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/create-subscription-definition.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To create a subscription definition** + +The following ``create-subscription-definition`` example creates a subscription definition and specifies its initial version. The initial version contains three subscriptions: one for the MQTT topic to which the connector subscribes, one to allow a function to receive temperature readings from AWS IoT, and one to allow AWS IoT to receive status information from the connector. The example provides the ARN for the Lambda function alias that was created earlier by using Lambda's ``create-alias`` command. :: + + aws greengrass create-subscription-definition \ + --initial-version "{\"Subscriptions\": [{\"Id\": \"TriggerNotification\", \"Source\": \"arn:aws:lambda:us-west-2:123456789012:function:TempMonitor:GG_TempMonitor\", \"Subject\": \"twilio/txt\", \"Target\": \"arn:aws:greengrass:us-west-2::/connectors/TwilioNotifications/versions/1\"},{\"Id\": \"TemperatureInput\", \"Source\": \"cloud\", \"Subject\": \"temperature/input\", \"Target\": \"arn:aws:lambda:us-west-2:123456789012:function:TempMonitor:GG_TempMonitor\"},{\"Id\": \"OutputStatus\", \"Source\": \"arn:aws:greengrass:us-west-2::/connectors/TwilioNotifications/versions/1\", \"Subject\": \"twilio/message/status\", \"Target\": \"cloud\"}]}" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/9d611d57-5d5d-44bd-a3b4-feccbdd69112", + "CreationTimestamp": "2019-06-19T22:34:26.677Z", + "Id": "9d611d57-5d5d-44bd-a3b4-feccbdd69112", + "LastUpdatedTimestamp": "2019-06-19T22:34:26.677Z", + "LatestVersion": "aa645c47-ac90-420d-9091-8c7ffa4f103f", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/9d611d57-5d5d-44bd-a3b4-feccbdd69112/versions/aa645c47-ac90-420d-9091-8c7ffa4f103f" + } + +For more information, see `Getting Started with Connectors (CLI) `__ in the *AWS IoT Greengrass Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/greengrass/create-subscription-definition-version.rst awscli-1.18.69/awscli/examples/greengrass/create-subscription-definition-version.rst --- awscli-1.11.13/awscli/examples/greengrass/create-subscription-definition-version.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/create-subscription-definition-version.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,16 @@ +**To create a new version of a subscription definition** + +The following ``create-subscription-definition-version`` example creates a new version of a subscription definition that contains three subscriptions: a trigger notification, a temperature input, and an output status. :: + + aws greengrass create-subscription-definition-version \ + --subscription-definition-id "9d611d57-5d5d-44bd-a3b4-feccbdd69112" \ + --subscriptions "[{\"Id\": \"TriggerNotification\", \"Source\": \"arn:aws:lambda:us-west-2:123456789012:function:TempMonitor:GG_TempMonitor\", \"Subject\": \"twilio/txt\", \"Target\": \"arn:aws:greengrass:us-west-2::/connectors/TwilioNotifications/versions/1\"},{\"Id\": \"TemperatureInput\", \"Source\": \"cloud\", \"Subject\": \"temperature/input\", \"Target\": \"arn:aws:lambda:us-west-2:123456789012:function:TempMonitor:GG_TempMonitor\"},{\"Id\": \"OutputStatus\", \"Source\": \"arn:aws:greengrass:us-west-2::/connectors/TwilioNotifications/versions/1\", \"Subject\": \"twilio/message/status\", \"Target\": \"cloud\"}]" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/9d611d57-5d5d-44bd-a3b4-feccbdd69112/versions/7b65dfae-50b6-4d0f-b3e0-27728bfb0620", + "CreationTimestamp": "2019-06-24T21:21:33.837Z", + "Id": "9d611d57-5d5d-44bd-a3b4-feccbdd69112", + "Version": "7b65dfae-50b6-4d0f-b3e0-27728bfb0620" + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/delete-connector-definition.rst awscli-1.18.69/awscli/examples/greengrass/delete-connector-definition.rst --- awscli-1.11.13/awscli/examples/greengrass/delete-connector-definition.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/delete-connector-definition.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To delete a connector definition** + +The following ``delete-connector-definition`` example deletes the specified Greengrass connector definition. If you delete a connector definition that is used by a group, that group can't be deployed successfully. :: + + aws greengrass delete-connector-definition \ + --connector-definition-id "b5c4ebfd-f672-49a3-83cd-31c7216a7bb8" + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/greengrass/delete-core-definition.rst awscli-1.18.69/awscli/examples/greengrass/delete-core-definition.rst --- awscli-1.11.13/awscli/examples/greengrass/delete-core-definition.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/delete-core-definition.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To delete a core definition** + +The following ``delete-core-definition`` example deletes the specified Greengrass core definition, including all versions. If you delete a core that is associated with a Greengrass group, that group can't be deployed successfully. :: + + aws greengrass delete-core-definition \ + --core-definition-id "ff36cc5f-9f98-4994-b468-9d9b6dc52abd" + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/greengrass/delete-device-definition.rst awscli-1.18.69/awscli/examples/greengrass/delete-device-definition.rst --- awscli-1.11.13/awscli/examples/greengrass/delete-device-definition.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/delete-device-definition.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To delete a device definition** + +The following ``delete-device-definition`` example deletes the specified device definition, including all of its versions. If you delete a device definition version that is used by a group version, the group version cannot be deployed successfully. :: + + aws greengrass delete-device-definition \ + --device-definition-id "f9ba083d-5ad4-4534-9f86-026a45df1ccd" + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/greengrass/delete-function-definition.rst awscli-1.18.69/awscli/examples/greengrass/delete-function-definition.rst --- awscli-1.11.13/awscli/examples/greengrass/delete-function-definition.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/delete-function-definition.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To delete a function definition** + +The following ``delete-function-definition`` example deletes the specified Greengrass function definition. If you delete a function definition that is used by a group, that group can't be deployed successfully. :: + + aws greengrass delete-function-definition \ + --function-definition-id "fd4b906a-dff3-4c1b-96eb-52ebfcfac06a" + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/greengrass/delete-group.rst awscli-1.18.69/awscli/examples/greengrass/delete-group.rst --- awscli-1.11.13/awscli/examples/greengrass/delete-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/delete-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To delete a group** + +The following ``delete-group`` example deletes the specified Greengrass group. :: + + aws greengrass delete-group \ + --group-id "4e22bd92-898c-436b-ade5-434d883ff749" + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/greengrass/delete-logger-definition.rst awscli-1.18.69/awscli/examples/greengrass/delete-logger-definition.rst --- awscli-1.11.13/awscli/examples/greengrass/delete-logger-definition.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/delete-logger-definition.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a logger definition** + +The following ``delete-logger-definition`` example deletes the specified logger definition, including all logger definition versions. If you delete a logger definition version that is used by a group version, the group version cannot be deployed successfully. :: + + aws greengrass delete-logger-definition \ + --logger-definition-id "a454b62a-5d56-4ca9-bdc4-8254e1662cb0" + +This command produces no output. + +For more information, see `Monitoring with AWS IoT Greengrass Logs `__ in the *AWS IoT Greengrass Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/greengrass/delete-resource-definition.rst awscli-1.18.69/awscli/examples/greengrass/delete-resource-definition.rst --- awscli-1.11.13/awscli/examples/greengrass/delete-resource-definition.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/delete-resource-definition.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To delete a resource definition** + +The following ``delete-resource-definition`` example deletes the specified resource definition, including all resource versions. If you delete a resource definition that is used by a group, that group can't be deployed successfully. :: + + aws greengrass delete-resource-definition \ + --resource-definition-id "ad8c101d-8109-4b0e-b97d-9cc5802ab658" + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/greengrass/delete-subscription-definition.rst awscli-1.18.69/awscli/examples/greengrass/delete-subscription-definition.rst --- awscli-1.11.13/awscli/examples/greengrass/delete-subscription-definition.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/delete-subscription-definition.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To delete a subscription definition** + +The following ``delete-subscription-definition`` example deletes the specified Greengrass subscription definition. If you delete a subscription that is being used by a group, that group can't be deployed successfully. :: + + aws greengrass delete-subscription-definition \ + --subscription-definition-id "cd6f1c37-d9a4-4e90-be94-01a7404f5967" + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/greengrass/disassociate-role-from-group.rst awscli-1.18.69/awscli/examples/greengrass/disassociate-role-from-group.rst --- awscli-1.11.13/awscli/examples/greengrass/disassociate-role-from-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/disassociate-role-from-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,14 @@ +**To disassociate the role from a Greengrass group** + +The following ``disassociate-role-from-group`` example disassociates the IAM role from the specified Greengrass group. :: + + aws greengrass disassociate-role-from-group \ + --group-id 2494ee3f-7f8a-4e92-a78b-d205f808b84b + +Output:: + + { + "DisassociatedAt": "2019-09-10T20:05:49Z" + } + +For more information, see `Configure the Group Role `__ in the *AWS IoT Greengrass Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/greengrass/disassociate-service-role-from-account.rst awscli-1.18.69/awscli/examples/greengrass/disassociate-service-role-from-account.rst --- awscli-1.11.13/awscli/examples/greengrass/disassociate-service-role-from-account.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/disassociate-service-role-from-account.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,13 @@ +**To disassociate a service role from your AWS account** + +The following ``disassociate-service-role-from-account`` example removes the service role that is associated with your AWS account. If you are not using the service role in any AWS Region, use the ``delete-role-policy`` command to detach the ``AWSGreengrassResourceAccessRolePolicy`` managed policy from the role, and then use the ``delete-role`` command to delete the role. :: + + aws greengrass disassociate-service-role-from-account + +Output:: + + { + "DisassociatedAt": "2019-06-25T22:12:55Z" + } + +For more information, see `Greengrass Service Role `__ in the **AWS IoT Greengrass Developer Guide**. diff -Nru awscli-1.11.13/awscli/examples/greengrass/get-associated-role.rst awscli-1.18.69/awscli/examples/greengrass/get-associated-role.rst --- awscli-1.11.13/awscli/examples/greengrass/get-associated-role.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/get-associated-role.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,15 @@ +**To get the role associated with a Greengrass group** + +The following ``get-associated-role`` example gets the IAM role that's associated with the specified Greengrass group. The group role is used by local Lambda functions and connectors to access AWS services. :: + + aws greengrass get-associated-role \ + --group-id 2494ee3f-7f8a-4e92-a78b-d205f808b84b + +Output:: + + { + "RoleArn": "arn:aws:iam::123456789012:role/GG-Group-Role", + "AssociatedAt": "2019-09-10T20:03:30Z" + } + +For more information, see `Configure the Group Role `__ in the *AWS IoT Greengrass Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/greengrass/get-bulk-deployment-status.rst awscli-1.18.69/awscli/examples/greengrass/get-bulk-deployment-status.rst --- awscli-1.11.13/awscli/examples/greengrass/get-bulk-deployment-status.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/get-bulk-deployment-status.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To check the status of your bulk deployment** + +The following ``get-bulk-deployment-status`` example retrieves status information for the specified bulk deployment operation. In this example, the file that specified the groups to be deployed has an invalid input record. :: + + aws greengrass get-bulk-deployment-status \ + --bulk-deployment-id "870fb41b-6288-4e0c-bc76-a7ba4b4d3267" + +Output:: + + { + "BulkDeploymentMetrics": { + "InvalidInputRecords": 1, + "RecordsProcessed": 1, + "RetryAttempts": 0 + }, + "BulkDeploymentStatus": "Completed", + "CreatedAt": "2019-06-25T16:11:33.265Z", + "tags": {} + } + +For more information, see `Create Bulk Deployments for Groups `__ in the *AWS IoT Greengrass Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/greengrass/get-connectivity-info.rst awscli-1.18.69/awscli/examples/greengrass/get-connectivity-info.rst --- awscli-1.11.13/awscli/examples/greengrass/get-connectivity-info.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/get-connectivity-info.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,37 @@ +**To get the connectivity information for a Greengrass core** + +The following ``get-connectivity-info`` example displays the endpoints that devices can use to connect to the specified Greengrass core. Connectivity information is a list of IP addresses or domain names, with corresponding port numbers and optional customer-defined metadata. :: + + aws greengrass get-connectivity-info \ + --thing-name "MyGroup_Core" + +Output:: + + { + "ConnectivityInfo": [ + { + "Metadata": "", + "PortNumber": 8883, + "HostAddress": "127.0.0.1", + "Id": "AUTOIP_127.0.0.1_0" + }, + { + "Metadata": "", + "PortNumber": 8883, + "HostAddress": "192.168.1.3", + "Id": "AUTOIP_192.168.1.3_1" + }, + { + "Metadata": "", + "PortNumber": 8883, + "HostAddress": "::1", + "Id": "AUTOIP_::1_2" + }, + { + "Metadata": "", + "PortNumber": 8883, + "HostAddress": "fe80::1e69:ed93:f5b:f6d", + "Id": "AUTOIP_fe80::1e69:ed93:f5b:f6d_3" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/get-connector-definition.rst awscli-1.18.69/awscli/examples/greengrass/get-connector-definition.rst --- awscli-1.11.13/awscli/examples/greengrass/get-connector-definition.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/get-connector-definition.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To retrieve information about a connector definition** + +The following ``get-connector-definition`` example retrieves information about the specified connector definition. To retrieve the IDs of your connector definitions, use the ``list-connector-definitions`` command. :: + + aws greengrass get-connector-definition \ + --connector-definition-id "b5c4ebfd-f672-49a3-83cd-31c7216a7bb8" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/connectors/b5c4ebfd-f672-49a3-83cd-31c7216a7bb8", + "CreationTimestamp": "2019-06-19T19:30:01.300Z", + "Id": "b5c4ebfd-f672-49a3-83cd-31c7216a7bb8", + "LastUpdatedTimestamp": "2019-06-19T19:30:01.300Z", + "LatestVersion": "63c57963-c7c2-4a26-a7e2-7bf478ea2623", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/connectors/b5c4ebfd-f672-49a3-83cd-31c7216a7bb8/versions/63c57963-c7c2-4a26-a7e2-7bf478ea2623", + "Name": "MySNSConnector", + "tags": {} + } + +For more information, see `Integrate with Services and Protocols Using Greengrass Connectors `__ in the **AWS IoT Greengrass Developer Guide**. diff -Nru awscli-1.11.13/awscli/examples/greengrass/get-connector-definition-version.rst awscli-1.18.69/awscli/examples/greengrass/get-connector-definition-version.rst --- awscli-1.11.13/awscli/examples/greengrass/get-connector-definition-version.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/get-connector-definition-version.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,29 @@ +**To retreive information about a specific version of a connector definition** + +The following ``get-connector-definition-version`` example retrieves information about the specified version of the specified connector definition. To retrieve the IDs of all versions of the connector definition, use the ``list-connector-definition-versions`` command. To retrieve the ID of the last version added to the connector definition, use the ``get-connector-definition`` command and check the ``LatestVersion`` property. :: + + aws greengrass get-connector-definition-version \ + --connector-definition-id "b5c4ebfd-f672-49a3-83cd-31c7216a7bb8" \ + --connector-definition-version-id "63c57963-c7c2-4a26-a7e2-7bf478ea2623" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/connectors/b5c4ebfd-f672-49a3-83cd-31c7216a7bb8/versions/63c57963-c7c2-4a26-a7e2-7bf478ea2623", + "CreationTimestamp": "2019-06-19T19:30:01.300Z", + "Definition": { + "Connectors": [ + { + "ConnectorArn": "arn:aws:greengrass:us-west-2::/connectors/SNS/versions/1", + "Id": "MySNSConnector", + "Parameters": { + "DefaultSNSArn": "arn:aws:sns:us-west-2:123456789012:GGConnectorTopic" + } + } + ] + }, + "Id": "b5c4ebfd-f672-49a3-83cd-31c7216a7bb8", + "Version": "63c57963-c7c2-4a26-a7e2-7bf478ea2623" + } + +For more information, see `Integrate with Services and Protocols Using Greengrass Connectors `__ in the **AWS IoT Greengrass Developer Guide**. diff -Nru awscli-1.11.13/awscli/examples/greengrass/get-core-definition.rst awscli-1.18.69/awscli/examples/greengrass/get-core-definition.rst --- awscli-1.11.13/awscli/examples/greengrass/get-core-definition.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/get-core-definition.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To retrieve details for a Greengrass core definition** + +The following ``get-core-definition`` example retrieves information about the specified core definition. To retrieve the IDs of your core definitions, use the ``list-core-definitions`` command. :: + + aws greengrass get-core-definition \ + --core-definition-id "c906ed39-a1e3-4822-a981-7b9bd57b4b46" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/237d6916-27cf-457f-ba0c-e86cfb5d25cd", + "CreationTimestamp": "2018-10-18T04:47:06.721Z", + "Id": "237d6916-27cf-457f-ba0c-e86cfb5d25cd", + "LastUpdatedTimestamp": "2018-10-18T04:47:06.721Z", + "LatestVersion": "bd2cd6d4-2bc5-468a-8962-39e071e34b68", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/237d6916-27cf-457f-ba0c-e86cfb5d25cd/versions/bd2cd6d4-2bc5-468a-8962-39e071e34b68", + "tags": {} + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/get-core-definition-version.rst awscli-1.18.69/awscli/examples/greengrass/get-core-definition-version.rst --- awscli-1.11.13/awscli/examples/greengrass/get-core-definition-version.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/get-core-definition-version.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,26 @@ +**To retrieve details about a specific version of the Greengrass core definition** + +The following ``get-core-definition-version`` example retrieves information about the specified version of the specified core definition. To retrieve the IDs of all versions of the core definition, use the ``list-core-definition-versions`` command. To retrieve the ID of the last version added to the core definition, use the ``get-core-definition`` command and check the ``LatestVersion`` property. :: + + aws greengrass get-core-definition-version \ + --core-definition-id "c906ed39-a1e3-4822-a981-7b9bd57b4b46" \ + --core-definition-version-id "42aeeac3-fd9d-4312-a8fd-ffa9404a20e0" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/c906ed39-a1e3-4822-a981-7b9bd57b4b46/versions/42aeeac3-fd9d-4312-a8fd-ffa9404a20e0", + "CreationTimestamp": "2019-06-18T16:21:21.351Z", + "Definition": { + "Cores": [ + { + "CertificateArn": "arn:aws:iot:us-west-2:123456789012:cert/928dea7b82331b47c3ff77b0e763fc5e64e2f7c884e6ef391baed9b6b8e21b45", + "Id": "1a39aac7-0885-4417-91f6-23e4cea6c511", + "SyncShadow": false, + "ThingArn": "arn:aws:iot:us-west-2:123456789012:thing/GGGroup4Pi3_Core" + } + ] + }, + "Id": "c906ed39-a1e3-4822-a981-7b9bd57b4b46", + "Version": "42aeeac3-fd9d-4312-a8fd-ffa9404a20e0" + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/get-deployment-status.rst awscli-1.18.69/awscli/examples/greengrass/get-deployment-status.rst --- awscli-1.11.13/awscli/examples/greengrass/get-deployment-status.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/get-deployment-status.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,15 @@ +**To retrieve the status of a deployment** + +The following ``get-deployment-status`` example retrieves the status for the specified deployment of the specified Greengrass group. To get the deployment ID, use the ``list-deployments`` command and specify the group ID. :: + + aws greengrass get-deployment-status \ + --group-id "1013db12-8b58-45ff-acc7-704248f66731" \ + --deployment-id "1065b8a0-812b-4f21-9d5d-e89b232a530f" + +Output:: + + { + "DeploymentStatus": "Success", + "DeploymentType": "NewDeployment", + "UpdatedAt": "2019-06-18T17:04:44.761Z" + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/get-device-definition.rst awscli-1.18.69/awscli/examples/greengrass/get-device-definition.rst --- awscli-1.11.13/awscli/examples/greengrass/get-device-definition.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/get-device-definition.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To get a device definition** + +The following ``get-device-definition`` example retrieves information about the specified device definition. To retrieve the IDs of your device definitions, use the ``list-device-definitions`` command. :: + + aws greengrass get-device-definition \ + --device-definition-id "f9ba083d-5ad4-4534-9f86-026a45df1ccd" + +Output:: + + { + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/f9ba083d-5ad4-4534-9f86-026a45df1ccd/versions/83c13984-6fed-447e-84d5-5b8aa45d5f71", + "Name": "TemperatureSensors", + "tags": {}, + "LastUpdatedTimestamp": "2019-09-11T00:19:03.698Z", + "LatestVersion": "83c13984-6fed-447e-84d5-5b8aa45d5f71", + "CreationTimestamp": "2019-09-11T00:11:06.197Z", + "Id": "f9ba083d-5ad4-4534-9f86-026a45df1ccd", + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/f9ba083d-5ad4-4534-9f86-026a45df1ccd" + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/get-device-definition-version.rst awscli-1.18.69/awscli/examples/greengrass/get-device-definition-version.rst --- awscli-1.11.13/awscli/examples/greengrass/get-device-definition-version.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/get-device-definition-version.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,32 @@ +**To get a device definition version** + +The following ``get-device-definition-version`` example retrieves information about the specified version of the specified device definition. To retrieve the IDs of all versions of the device definition, use the ``list-device-definition-versions`` command. To retrieve the ID of the last version added to the device definition, use the ``get-device-definition`` command and check the ``LatestVersion`` property. :: + + aws greengrass get-device-definition-version \ + --device-definition-id "f9ba083d-5ad4-4534-9f86-026a45df1ccd" \ + --device-definition-version-id "83c13984-6fed-447e-84d5-5b8aa45d5f71" + +Output:: + + { + "Definition": { + "Devices": [ + { + "CertificateArn": "arn:aws:iot:us-west-2:123456789012:cert/6c52ce1b47bde88a637e9ccdd45fe4e4c2c0a75a6866f8f63d980ee22fa51e02", + "ThingArn": "arn:aws:iot:us-west-2:123456789012:thing/ExteriorTherm", + "SyncShadow": true, + "Id": "ExteriorTherm" + }, + { + "CertificateArn": "arn:aws:iot:us-west-2:123456789012:cert/66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92", + "ThingArn": "arn:aws:iot:us-west-2:123456789012:thing/InteriorTherm", + "SyncShadow": true, + "Id": "InteriorTherm" + } + ] + }, + "Version": "83c13984-6fed-447e-84d5-5b8aa45d5f71", + "CreationTimestamp": "2019-09-11T00:15:09.838Z", + "Id": "f9ba083d-5ad4-4534-9f86-026a45df1ccd", + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/f9ba083d-5ad4-4534-9f86-026a45df1ccd/versions/83c13984-6fed-447e-84d5-5b8aa45d5f71" + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/get-function-definition.rst awscli-1.18.69/awscli/examples/greengrass/get-function-definition.rst --- awscli-1.11.13/awscli/examples/greengrass/get-function-definition.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/get-function-definition.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To retrieve a function definition** + +The following ``get-function-definition`` example displays details for the specified function definition. To retrieve the IDs of your function definitions, use the ``list-function-definitions`` command. :: + + aws greengrass get-function-definition \ + --function-definition-id "063f5d1a-1dd1-40b4-9b51-56f8993d0f85" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/063f5d1a-1dd1-40b4-9b51-56f8993d0f85", + "CreationTimestamp": "2019-06-18T16:21:21.431Z", + "Id": "063f5d1a-1dd1-40b4-9b51-56f8993d0f85", + "LastUpdatedTimestamp": "2019-06-18T16:21:21.431Z", + "LatestVersion": "9748fda7-1589-4fcc-ac94-f5559e88678b", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/063f5d1a-1dd1-40b4-9b51-56f8993d0f85/versions/9748fda7-1589-4fcc-ac94-f5559e88678b", + "tags": {} + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/get-function-definition-version.rst awscli-1.18.69/awscli/examples/greengrass/get-function-definition-version.rst --- awscli-1.11.13/awscli/examples/greengrass/get-function-definition-version.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/get-function-definition-version.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,43 @@ +**To retrieve details about a specific version of a Lambda function** + +The following ``get-function-definition-version`` retrieves information about the specified version of the specified function definition. To retrieve the IDs of all versions of the function definition, use the ``list-function-definition-versions`` command. To retrieve the ID of the last version added to the function definition, use the ``get-function-definition`` command and check the ``LatestVersion`` property. :: + + aws greengrass get-function-definition-version \ + --function-definition-id "063f5d1a-1dd1-40b4-9b51-56f8993d0f85" \ + --function-definition-version-id "9748fda7-1589-4fcc-ac94-f5559e88678b" + +Output:: + + { + "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", + "Definition": { + "Functions": [ + { + "FunctionArn": "arn:aws:lambda:::function:GGIPDetector:1", + "FunctionConfiguration": { + "Environment": {}, + "MemorySize": 32768, + "Pinned": true, + "Timeout": 3 + }, + "Id": "26b69bdb-e547-46bc-9812-84ec04b6cc8c" + }, + { + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:Greengrass_HelloWorld:GG_HelloWorld", + "FunctionConfiguration": { + "EncodingType": "json", + "Environment": { + "Variables": {} + }, + "MemorySize": 16384, + "Pinned": true, + "Timeout": 25 + }, + "Id": "384465a8-eedf-48c6-b793-4c35f7bfae9b" + } + ] + }, + "Id": "063f5d1a-1dd1-40b4-9b51-56f8993d0f85", + "Version": "9748fda7-1589-4fcc-ac94-f5559e88678b" + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/get-group-certificate-authority.rst awscli-1.18.69/awscli/examples/greengrass/get-group-certificate-authority.rst --- awscli-1.11.13/awscli/examples/greengrass/get-group-certificate-authority.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/get-group-certificate-authority.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,30 @@ +**To retrieve the CA associated with a Greengrass group** + +The following ``get-group-certificate-authority`` example retrieves the certificate authority (CA) that is associated with the specified Greengrass group. To get the certificate authority ID, use the ``list-group-certificate-authorities`` command and specify the group ID. :: + + aws greengrass get-group-certificate-authority \ + --group-id "1013db12-8b58-45ff-acc7-704248f66731" \ + --certificate-authority-id "f0430e1736ea8ed30cc5d5de9af67a7e3586bad9ae4d89c2a44163f65fdd8cf6" + +Output:: + + { + "GroupCertificateAuthorityArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731/certificateauthorities/f0430e1736ea8ed30cc5d5de9af67a7e3586bad9ae4d89c2a44163f65fdd8cf6", + "GroupCertificateAuthorityId": "f0430e1736ea8ed30cc5d5de9af67a7e3586bad9ae4d89c2a44163f65fdd8cf6", + "PemEncodedCertificate": "-----BEGIN CERTIFICATE----- + MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBWEXAMPLEGA1UEBhMC + VVMxCzAJBgNVBAgTAldBMRAwDEXAMPLEEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 + b24xFDASBgNVBAEXAMPLESBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd + BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jEXAMPLENMTEwNDI1MjA0NTIxWhcN + MTIwNDI0MjA0EXAMPLEBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD + VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWEXAMPLEDASBgNVBAsTC0lBTSBDb25z + b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWEXAMPLEgkqhkiG9w0BCQEWEG5vb25lQGFt + YXpvbi5EXAMPLE8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ + 21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CEXAMPLE93vUEIO3IyNoH/f0wYK8m9T + rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswYEXAMPLEgpE + Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKEXAMPLEAQEFBQADgYEAtCu4 + nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb + FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb + NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE= + -----END CERTIFICATE-----\n" + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/get-group-certificate-configuration.rst awscli-1.18.69/awscli/examples/greengrass/get-group-certificate-configuration.rst --- awscli-1.11.13/awscli/examples/greengrass/get-group-certificate-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/get-group-certificate-configuration.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,14 @@ +**To retrieve the configuration for the certificate authority used by the Greengrass group** + +The following ``get-group-certificate-configuration`` example retrieves the configuration for the certificate authority (CA) used by the specified Greengrass group. :: + + aws greengrass get-group-certificate-configuration \ + --group-id "1013db12-8b58-45ff-acc7-704248f66731" + +Output:: + + { + "CertificateAuthorityExpiryInMilliseconds": 2524607999000, + "CertificateExpiryInMilliseconds": 604800000, + "GroupId": "1013db12-8b58-45ff-acc7-704248f66731" + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/get-group.rst awscli-1.18.69/awscli/examples/greengrass/get-group.rst --- awscli-1.11.13/awscli/examples/greengrass/get-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/get-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To retrieve information about a Greengrass group** + +The following ``get-group`` example retrieves information about the specified Greengrass group. To retrieve the IDs of your groups, use the ``list-groups`` command. :: + + aws greengrass get-group \ + --group-id "1013db12-8b58-45ff-acc7-704248f66731" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731", + "CreationTimestamp": "2019-06-18T16:21:21.457Z", + "Id": "1013db12-8b58-45ff-acc7-704248f66731", + "LastUpdatedTimestamp": "2019-06-18T16:21:21.457Z", + "LatestVersion": "115136b3-cfd7-4462-b77f-8741a4b00e5e", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731/versions/115136b3-cfd7-4462-b77f-8741a4b00e5e", + "Name": "GGGroup4Pi3", + "tags": {} + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/get-group-version.rst awscli-1.18.69/awscli/examples/greengrass/get-group-version.rst --- awscli-1.11.13/awscli/examples/greengrass/get-group-version.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/get-group-version.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To retrieve information about a version of a Greengrass group** + +The following ``get-group-version`` example retrieves information about the specified version of the specified group. To retrieve the IDs of all versions of the group, use the ``list-group-versions`` command. To retrieve the ID of the last version added to the group, use the ``get-group`` command and check the ``LatestVersion`` property. :: + + aws greengrass get-group-version \ + --group-id "1013db12-8b58-45ff-acc7-704248f66731" \ + --group-version-id "115136b3-cfd7-4462-b77f-8741a4b00e5e" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731/versions/115136b3-cfd7-4462-b77f-8741a4b00e5e", + "CreationTimestamp": "2019-06-18T17:04:30.915Z", + "Definition": { + "CoreDefinitionVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/c906ed39-a1e3-4822-a981-7b9bd57b4b46/versions/42aeeac3-fd9d-4312-a8fd-ffa9404a20e0", + "FunctionDefinitionVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/063f5d1a-1dd1-40b4-9b51-56f8993d0f85/versions/9748fda7-1589-4fcc-ac94-f5559e88678b", + "SubscriptionDefinitionVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/70e49321-83d5-45d2-bc09-81f4917ae152/versions/88ae8699-12ac-4663-ba3f-4d7f0519140b" + }, + "Id": "1013db12-8b58-45ff-acc7-704248f66731", + "Version": "115136b3-cfd7-4462-b77f-8741a4b00e5e" + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/get-logger-definition.rst awscli-1.18.69/awscli/examples/greengrass/get-logger-definition.rst --- awscli-1.11.13/awscli/examples/greengrass/get-logger-definition.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/get-logger-definition.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To retrieve information about a logger definition** + +The following ``get-logger-definition`` example retrieves information about the specified logger definition. To retrieve the IDs of your logger definitions, use the ``list-logger-definitions`` command. :: + + aws greengrass get-logger-definition \ + --logger-definition-id "49eeeb66-f1d3-4e34-86e3-3617262abf23" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/loggers/49eeeb66-f1d3-4e34-86e3-3617262abf23", + "CreationTimestamp": "2019-05-08T16:10:13.809Z", + "Id": "49eeeb66-f1d3-4e34-86e3-3617262abf23", + "LastUpdatedTimestamp": "2019-05-08T16:10:13.809Z", + "LatestVersion": "5e3f6f64-a565-491e-8de0-3c0d8e0f2073", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/loggers/49eeeb66-f1d3-4e34-86e3-3617262abf23/versions/5e3f6f64-a565-491e-8de0-3c0d8e0f2073", + "tags": {} + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/get-logger-definition-version.rst awscli-1.18.69/awscli/examples/greengrass/get-logger-definition-version.rst --- awscli-1.11.13/awscli/examples/greengrass/get-logger-definition-version.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/get-logger-definition-version.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To retrieve information about a version of a logger definition** + +The following ``get-logger-definition-version`` example retrieves information about the specified version of the specified logger definition. To retrieve the IDs of all versions of the logger definition, use the ``list-logger-definition-versions`` command. To retrieve the ID of the last version added to the logger definition, use the ``get-logger-definition`` command and check the ``LatestVersion`` property. :: + + aws greengrass get-logger-definition-version \ + --logger-definition-id "49eeeb66-f1d3-4e34-86e3-3617262abf23" \ + --logger-definition-version-id "5e3f6f64-a565-491e-8de0-3c0d8e0f2073" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/loggers/49eeeb66-f1d3-4e34-86e3-3617262abf23/versions/5e3f6f64-a565-491e-8de0-3c0d8e0f2073", + "CreationTimestamp": "2019-05-08T16:10:13.866Z", + "Definition": { + "Loggers": [] + }, + "Id": "49eeeb66-f1d3-4e34-86e3-3617262abf23", + "Version": "5e3f6f64-a565-491e-8de0-3c0d8e0f2073" + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/get-resource-definition.rst awscli-1.18.69/awscli/examples/greengrass/get-resource-definition.rst --- awscli-1.11.13/awscli/examples/greengrass/get-resource-definition.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/get-resource-definition.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To retrieve information about a resource definition** + +The following ``get-resource-definition`` example retrieves information about the specified resource definition. To retrieve the IDs of your resource definitions, use the ``list-resource-definitions`` command. :: + + aws greengrass get-resource-definition \ + --resource-definition-id "ad8c101d-8109-4b0e-b97d-9cc5802ab658" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/ad8c101d-8109-4b0e-b97d-9cc5802ab658", + "CreationTimestamp": "2019-06-19T16:40:59.261Z", + "Id": "ad8c101d-8109-4b0e-b97d-9cc5802ab658", + "LastUpdatedTimestamp": "2019-06-19T16:40:59.261Z", + "LatestVersion": "26e8829a-491a-464d-9c87-664bf6f6f2be", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/ad8c101d-8109-4b0e-b97d-9cc5802ab658/versions/26e8829a-491a-464d-9c87-664bf6f6f2be", + "tags": {} + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/get-resource-definition-version.rst awscli-1.18.69/awscli/examples/greengrass/get-resource-definition-version.rst --- awscli-1.11.13/awscli/examples/greengrass/get-resource-definition-version.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/get-resource-definition-version.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,32 @@ +**To retrieve information about a specific version of a resource definition** + +The following ``get-resource-definition-version`` example retrieves information about the specified version of the specified resource definition. To retrieve the IDs of all versions of the resource definition, use the ``list-resource-definition-versions`` command. To retrieve the ID of the last version added to the resource definition, use the ``get-resource-definition`` command and check the ``LatestVersion`` property. :: + + aws greengrass get-resource-definition-version \ + --resource-definition-id "ad8c101d-8109-4b0e-b97d-9cc5802ab658" \ + --resource-definition-version-id "26e8829a-491a-464d-9c87-664bf6f6f2be" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/ad8c101d-8109-4b0e-b97d-9cc5802ab658/versions/26e8829a-491a-464d-9c87-664bf6f6f2be", + "CreationTimestamp": "2019-06-19T16:40:59.392Z", + "Definition": { + "Resources": [ + { + "Id": "26ff3f7b-839a-4217-9fdc-a218308b3963", + "Name": "usb-port", + "ResourceDataContainer": { + "LocalDeviceResourceData": { + "GroupOwnerSetting": { + "AutoAddGroupOwner": false + }, + "SourcePath": "/dev/bus/usb" + } + } + } + ] + }, + "Id": "ad8c101d-8109-4b0e-b97d-9cc5802ab658", + "Version": "26e8829a-491a-464d-9c87-664bf6f6f2be" + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/get-service-role-for-account.rst awscli-1.18.69/awscli/examples/greengrass/get-service-role-for-account.rst --- awscli-1.11.13/awscli/examples/greengrass/get-service-role-for-account.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/get-service-role-for-account.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,14 @@ +**To retrieve the details for the service role that is attached to your account** + +The following ``get-service-role-for-account`` example retrieves information about the service role that is attached to your AWS account. :: + + aws greengrass get-service-role-for-account + +Output:: + + { + "AssociatedAt": "2018-10-18T15:59:20Z", + "RoleArn": "arn:aws:iam::123456789012:role/service-role/Greengrass_ServiceRole" + } + +For more information, see `Greengrass Service Role `__ in the **AWS IoT Greengrass Developer Guide**. diff -Nru awscli-1.11.13/awscli/examples/greengrass/get-subscription-definition.rst awscli-1.18.69/awscli/examples/greengrass/get-subscription-definition.rst --- awscli-1.11.13/awscli/examples/greengrass/get-subscription-definition.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/get-subscription-definition.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To retrieve information about a subscription definition** + +The following ``get-subscription-definition`` example retrieves information about the specified subscription definition. To retrieve the IDs of your subscription definitions, use the ``list-subscription-definitions`` command. :: + + aws greengrass get-subscription-definition \ + --subscription-definition-id "70e49321-83d5-45d2-bc09-81f4917ae152" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/70e49321-83d5-45d2-bc09-81f4917ae152", + "CreationTimestamp": "2019-06-18T17:03:52.392Z", + "Id": "70e49321-83d5-45d2-bc09-81f4917ae152", + "LastUpdatedTimestamp": "2019-06-18T17:03:52.392Z", + "LatestVersion": "88ae8699-12ac-4663-ba3f-4d7f0519140b", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/70e49321-83d5-45d2-bc09-81f4917ae152/versions/88ae8699-12ac-4663-ba3f-4d7f0519140b", + "tags": {} + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/get-subscription-definition-version.rst awscli-1.18.69/awscli/examples/greengrass/get-subscription-definition-version.rst --- awscli-1.11.13/awscli/examples/greengrass/get-subscription-definition-version.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/get-subscription-definition-version.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,26 @@ +**To retrieve information about a specific version of a subscription definition** + +The following ``get-subscription-definition-version`` example retrieves retrieves information about the specified version of the specified subscription definition. To retrieve the IDs of all versions of the subscription definition, use the ``list-subscription-definition-versions`` command. To retrieve the ID of the last version added to the subscription definition, use the ``get-subscription-definition`` command and check the ``LatestVersion`` property. :: + + aws greengrass get-subscription-definition-version \ + --subscription-definition-id "70e49321-83d5-45d2-bc09-81f4917ae152" \ + --subscription-definition-version-id "88ae8699-12ac-4663-ba3f-4d7f0519140b" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/70e49321-83d5-45d2-bc09-81f4917ae152/versions/88ae8699-12ac-4663-ba3f-4d7f0519140b", + "CreationTimestamp": "2019-06-18T17:03:52.499Z", + "Definition": { + "Subscriptions": [ + { + "Id": "692c4484-d89f-4f64-8edd-1a041a65e5b6", + "Source": "arn:aws:lambda:us-west-2:123456789012:function:Greengrass_HelloWorld:GG_HelloWorld", + "Subject": "hello/world", + "Target": "cloud" + } + ] + }, + "Id": "70e49321-83d5-45d2-bc09-81f4917ae152", + "Version": "88ae8699-12ac-4663-ba3f-4d7f0519140b" + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/list-bulk-deployment-detailed-reports.rst awscli-1.18.69/awscli/examples/greengrass/list-bulk-deployment-detailed-reports.rst --- awscli-1.11.13/awscli/examples/greengrass/list-bulk-deployment-detailed-reports.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/list-bulk-deployment-detailed-reports.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/greengrass/list-bulk-deployments.rst awscli-1.18.69/awscli/examples/greengrass/list-bulk-deployments.rst --- awscli-1.11.13/awscli/examples/greengrass/list-bulk-deployments.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/list-bulk-deployments.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To list bulk deployments** + +The following ``list-bulk-deployments`` example lists all bulk deployments. :: + + aws greengrass list-bulk-deployments + +Output:: + + { + "BulkDeployments": [ + { + "BulkDeploymentArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/bulk/deployments/870fb41b-6288-4e0c-bc76-a7ba4b4d3267", + "BulkDeploymentId": "870fb41b-6288-4e0c-bc76-a7ba4b4d3267", + "CreatedAt": "2019-06-25T16:11:33.265Z" + } + ] + } + +For more information, see `Create Bulk Deployments for Groups `__ in the *AWS IoT Greengrass Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/greengrass/list-connector-definitions.rst awscli-1.18.69/awscli/examples/greengrass/list-connector-definitions.rst --- awscli-1.11.13/awscli/examples/greengrass/list-connector-definitions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/list-connector-definitions.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,23 @@ +**To list the Greengrass connectors that are defined** + +The following ``list-connector-definitions`` example lists all of the Greengrass connectors that are defined for your AWS account. :: + + aws greengrass list-connector-definitions + +Output:: + + { + "Definitions": [ + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/connectors/b5c4ebfd-f672-49a3-83cd-31c7216a7bb8", + "CreationTimestamp": "2019-06-19T19:30:01.300Z", + "Id": "b5c4ebfd-f672-49a3-83cd-31c7216a7bb8", + "LastUpdatedTimestamp": "2019-06-19T19:30:01.300Z", + "LatestVersion": "63c57963-c7c2-4a26-a7e2-7bf478ea2623", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/connectors/b5c4ebfd-f672-49a3-83cd-31c7216a7bb8/versions/63c57963-c7c2-4a26-a7e2-7bf478ea2623", + "Name": "MySNSConnector" + } + ] + } + +For more information, see `Integrate with Services and Protocols Using Greengrass Connectors `__ in the **AWS IoT Greengrass Developer Guide**. diff -Nru awscli-1.11.13/awscli/examples/greengrass/list-connector-definition-versions.rst awscli-1.18.69/awscli/examples/greengrass/list-connector-definition-versions.rst --- awscli-1.11.13/awscli/examples/greengrass/list-connector-definition-versions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/list-connector-definition-versions.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To list the versions that are available for a connector definition** + +The following ``list-connector-definition-versions`` example lists the versions that are available for the specified connector definition. Use the ``list-connector-definitions`` command to get the connector definition ID. :: + + aws greengrass list-connector-definition-versions \ + --connector-definition-id "b5c4ebfd-f672-49a3-83cd-31c7216a7bb8" + +Output:: + + { + "Versions": [ + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/connectors/b5c4ebfd-f672-49a3-83cd-31c7216a7bb8/versions/63c57963-c7c2-4a26-a7e2-7bf478ea2623", + "CreationTimestamp": "2019-06-19T19:30:01.300Z", + "Id": "b5c4ebfd-f672-49a3-83cd-31c7216a7bb8", + "Version": "63c57963-c7c2-4a26-a7e2-7bf478ea2623" + } + ] + } + +For more information, see `Integrate with Services and Protocols Using Greengrass Connectors `__ in the **AWS IoT Greengrass Developer Guide**. diff -Nru awscli-1.11.13/awscli/examples/greengrass/list-core-definitions.rst awscli-1.18.69/awscli/examples/greengrass/list-core-definitions.rst --- awscli-1.11.13/awscli/examples/greengrass/list-core-definitions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/list-core-definitions.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,44 @@ +**To list Greengrass core definitions** + +The following ``list-core-definitions`` example lists all of the Greengrass core definitions for your AWS account. :: + + aws greengrass list-core-definitions + +Output:: + + { + "Definitions": [ + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/0507843c-c1ef-4f06-b051-817030df7e7d", + "CreationTimestamp": "2018-10-17T04:30:32.786Z", + "Id": "0507843c-c1ef-4f06-b051-817030df7e7d", + "LastUpdatedTimestamp": "2018-10-17T04:30:32.786Z", + "LatestVersion": "bcdf9e86-3793-491e-93af-3cdfbf4e22b7", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/0507843c-c1ef-4f06-b051-817030df7e7d/versions/bcdf9e86-3793-491e-93af-3cdfbf4e22b7" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/31c22500-3509-4271-bafd-cf0655cda438", + "CreationTimestamp": "2019-06-18T16:24:16.064Z", + "Id": "31c22500-3509-4271-bafd-cf0655cda438", + "LastUpdatedTimestamp": "2019-06-18T16:24:16.064Z", + "LatestVersion": "2f350395-6d09-4c8a-8336-9ae5b57ace84", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/31c22500-3509-4271-bafd-cf0655cda438/versions/2f350395-6d09-4c8a-8336-9ae5b57ace84" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/c906ed39-a1e3-4822-a981-7b9bd57b4b46", + "CreationTimestamp": "2019-06-18T16:21:21.351Z", + "Id": "c906ed39-a1e3-4822-a981-7b9bd57b4b46", + "LastUpdatedTimestamp": "2019-06-18T16:21:21.351Z", + "LatestVersion": "42aeeac3-fd9d-4312-a8fd-ffa9404a20e0", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/c906ed39-a1e3-4822-a981-7b9bd57b4b46/versions/42aeeac3-fd9d-4312-a8fd-ffa9404a20e0" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/eaf280cb-138c-4d15-af36-6f681a1348f7", + "CreationTimestamp": "2019-06-18T16:14:17.709Z", + "Id": "eaf280cb-138c-4d15-af36-6f681a1348f7", + "LastUpdatedTimestamp": "2019-06-18T16:14:17.709Z", + "LatestVersion": "467c36e4-c5da-440c-a97b-084e62593b4c", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/eaf280cb-138c-4d15-af36-6f681a1348f7/versions/467c36e4-c5da-440c-a97b-084e62593b4c" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/list-core-definition-versions.rst awscli-1.18.69/awscli/examples/greengrass/list-core-definition-versions.rst --- awscli-1.11.13/awscli/examples/greengrass/list-core-definition-versions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/list-core-definition-versions.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To list the versions of a Greengrass core definition** + +The following ``list-core-definitions`` example lists all versions of the specied Greengrass core definition. You can use the ``list-core-definitions`` command to get the version ID. :: + + aws greengrass list-core-definition-versions \ + --core-definition-id "eaf280cb-138c-4d15-af36-6f681a1348f7" + +Output:: + + { + "Versions": [ + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/eaf280cb-138c-4d15-af36-6f681a1348f7/versions/467c36e4-c5da-440c-a97b-084e62593b4c", + "CreationTimestamp": "2019-06-18T16:14:17.709Z", + "Id": "eaf280cb-138c-4d15-af36-6f681a1348f7", + "Version": "467c36e4-c5da-440c-a97b-084e62593b4c" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/list-deployments.rst awscli-1.18.69/awscli/examples/greengrass/list-deployments.rst --- awscli-1.11.13/awscli/examples/greengrass/list-deployments.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/list-deployments.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To list the deployments for a Greengrass group** + +The following ``list-deployments`` example lists the deployments for the specified Greengrass group. You can use the ``list-groups`` command to look up your group ID. :: + + aws greengrass list-deployments \ + --group-id "1013db12-8b58-45ff-acc7-704248f66731" + +Output:: + + { + "Deployments": [ + { + "CreatedAt": "2019-06-18T17:04:32.702Z", + "DeploymentId": "1065b8a0-812b-4f21-9d5d-e89b232a530f", + "DeploymentType": "NewDeployment", + "GroupArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731/versions/115136b3-cfd7-4462-b77f-8741a4b00e5e" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/list-device-definitions.rst awscli-1.18.69/awscli/examples/greengrass/list-device-definitions.rst --- awscli-1.11.13/awscli/examples/greengrass/list-device-definitions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/list-device-definitions.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,39 @@ +**To list your device definitions** + +The following ``list-device-definitions`` example displays details about the device definitions in your AWS account in the specified AWS Region. :: + + aws greengrass list-device-definitions \ + --region us-west-2 + +Output:: + + { + "Definitions": [ + { + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/50f3274c-3f0a-4f57-b114-6f46085281ab/versions/c777b0f5-1059-449b-beaa-f003ebc56c34", + "LastUpdatedTimestamp": "2019-06-14T15:42:09.059Z", + "LatestVersion": "c777b0f5-1059-449b-beaa-f003ebc56c34", + "CreationTimestamp": "2019-06-14T15:42:09.059Z", + "Id": "50f3274c-3f0a-4f57-b114-6f46085281ab", + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/50f3274c-3f0a-4f57-b114-6f46085281ab" + }, + { + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/e01951c9-6134-479a-969a-1a15cac11c40/versions/514d57aa-4ee6-401c-9fac-938a9f7a51e5", + "Name": "TestDeviceDefinition", + "LastUpdatedTimestamp": "2019-04-16T23:17:43.245Z", + "LatestVersion": "514d57aa-4ee6-401c-9fac-938a9f7a51e5", + "CreationTimestamp": "2019-04-16T23:17:43.245Z", + "Id": "e01951c9-6134-479a-969a-1a15cac11c40", + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/e01951c9-6134-479a-969a-1a15cac11c40" + }, + { + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/f9ba083d-5ad4-4534-9f86-026a45df1ccd/versions/83c13984-6fed-447e-84d5-5b8aa45d5f71", + "Name": "TemperatureSensors", + "LastUpdatedTimestamp": "2019-09-10T00:19:03.698Z", + "LatestVersion": "83c13984-6fed-447e-84d5-5b8aa45d5f71", + "CreationTimestamp": "2019-09-11T00:11:06.197Z", + "Id": "f9ba083d-5ad4-4534-9f86-026a45df1ccd", + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/f9ba083d-5ad4-4534-9f86-026a45df1ccd" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/list-device-definition-versions.rst awscli-1.18.69/awscli/examples/greengrass/list-device-definition-versions.rst --- awscli-1.11.13/awscli/examples/greengrass/list-device-definition-versions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/list-device-definition-versions.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,25 @@ +**To list the versions of a device definition** + +The following ``list-device-definition-versions`` example displays the device definition versions associated with the specified device definition. :: + + aws greengrass list-device-definition-versions \ + --device-definition-id "f9ba083d-5ad4-4534-9f86-026a45df1ccd" + +Output:: + + { + "Versions": [ + { + "Version": "83c13984-6fed-447e-84d5-5b8aa45d5f71", + "CreationTimestamp": "2019-09-11T00:15:09.838Z", + "Id": "f9ba083d-5ad4-4534-9f86-026a45df1ccd", + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/f9ba083d-5ad4-4534-9f86-026a45df1ccd/versions/83c13984-6fed-447e-84d5-5b8aa45d5f71" + }, + { + "Version": "3b5cc510-58c1-44b5-9d98-4ad858ffa795", + "CreationTimestamp": "2019-09-11T00:11:06.197Z", + "Id": "f9ba083d-5ad4-4534-9f86-026a45df1ccd", + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/f9ba083d-5ad4-4534-9f86-026a45df1ccd/versions/3b5cc510-58c1-44b5-9d98-4ad858ffa795" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/list-function-definitions.rst awscli-1.18.69/awscli/examples/greengrass/list-function-definitions.rst --- awscli-1.11.13/awscli/examples/greengrass/list-function-definitions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/list-function-definitions.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,44 @@ +**To list Lambda functions** + +The following ``list-function-definitions`` example lists all of the Lambda functions defined for your AWS account. :: + + aws greengrass list-function-definitions + +Output:: + + { + "Definitions": [ + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/017970a5-8952-46dd-b1c1-020b3ae8e960", + "CreationTimestamp": "2018-10-17T04:30:32.884Z", + "Id": "017970a5-8952-46dd-b1c1-020b3ae8e960", + "LastUpdatedTimestamp": "2018-10-17T04:30:32.884Z", + "LatestVersion": "4380b302-790d-4ed8-92bf-02e88afecb15", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/017970a5-8952-46dd-b1c1-020b3ae8e960/versions/4380b302-790d-4ed8-92bf-02e88afecb15" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/063f5d1a-1dd1-40b4-9b51-56f8993d0f85", + "CreationTimestamp": "2019-06-18T16:21:21.431Z", + "Id": "063f5d1a-1dd1-40b4-9b51-56f8993d0f85", + "LastUpdatedTimestamp": "2019-06-18T16:21:21.431Z", + "LatestVersion": "9748fda7-1589-4fcc-ac94-f5559e88678b", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/063f5d1a-1dd1-40b4-9b51-56f8993d0f85/versions/9748fda7-1589-4fcc-ac94-f5559e88678b" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/6598e653-a262-440c-9967-e2697f64da7b", + "CreationTimestamp": "2019-06-18T16:24:16.123Z", + "Id": "6598e653-a262-440c-9967-e2697f64da7b", + "LastUpdatedTimestamp": "2019-06-18T16:24:16.123Z", + "LatestVersion": "38bc6ccd-98a2-4ce7-997e-16c84748fae4", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/6598e653-a262-440c-9967-e2697f64da7b/versions/38bc6ccd-98a2-4ce7-997e-16c84748fae4" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/c668df84-fad2-491b-95f4-655d2cad7885", + "CreationTimestamp": "2019-06-18T16:14:17.784Z", + "Id": "c668df84-fad2-491b-95f4-655d2cad7885", + "LastUpdatedTimestamp": "2019-06-18T16:14:17.784Z", + "LatestVersion": "37dd68c4-a64f-40ba-aa13-71fecc3ebded", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/c668df84-fad2-491b-95f4-655d2cad7885/versions/37dd68c4-a64f-40ba-aa13-71fecc3ebded" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/list-function-definition-versions.rst awscli-1.18.69/awscli/examples/greengrass/list-function-definition-versions.rst --- awscli-1.11.13/awscli/examples/greengrass/list-function-definition-versions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/list-function-definition-versions.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/greengrass/list-group-certificate-authorities.rst awscli-1.18.69/awscli/examples/greengrass/list-group-certificate-authorities.rst --- awscli-1.11.13/awscli/examples/greengrass/list-group-certificate-authorities.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/list-group-certificate-authorities.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To list the current CAs for a group** + +The following ``list-group-certificate-authorities`` example lists the current certificate authorities (CAs) for the specified Greengrass group. :: + + aws greengrass list-group-certificate-authorities \ + --group-id "1013db12-8b58-45ff-acc7-704248f66731" + +Output:: + + { + "GroupCertificateAuthorities": [ + { + "GroupCertificateAuthorityArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731/certificateauthorities/f0430e1736ea8ed30cc5d5de9af67a7e3586bad9ae4d89c2a44163f65fdd8cf6", + "GroupCertificateAuthorityId": "f0430e1736ea8ed30cc5d5de9af67a7e3586bad9ae4d89c2a44163f65fdd8cf6" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/list-groups.rst awscli-1.18.69/awscli/examples/greengrass/list-groups.rst --- awscli-1.11.13/awscli/examples/greengrass/list-groups.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/list-groups.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,39 @@ +**To list the Greengrass groups** + +The following ``list-groups`` example lists all Greengrass groups that are defined in your AWS account. :: + + aws greengrass list-groups + +Output:: + + { + "Groups": [ + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731", + "CreationTimestamp": "2019-06-18T16:21:21.457Z", + "Id": "1013db12-8b58-45ff-acc7-704248f66731", + "LastUpdatedTimestamp": "2019-06-18T16:21:21.457Z", + "LatestVersion": "115136b3-cfd7-4462-b77f-8741a4b00e5e", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731/versions/115136b3-cfd7-4462-b77f-8741a4b00e5e", + "Name": "GGGroup4Pi3" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1402daf9-71cf-4cfe-8be0-d5e80526d0d8", + "CreationTimestamp": "2018-10-31T21:52:46.603Z", + "Id": "1402daf9-71cf-4cfe-8be0-d5e80526d0d8", + "LastUpdatedTimestamp": "2018-10-31T21:52:46.603Z", + "LatestVersion": "749af901-60ab-456f-a096-91b12d983c29", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1402daf9-71cf-4cfe-8be0-d5e80526d0d8/versions/749af901-60ab-456f-a096-91b12d983c29", + "Name": "MyTestGroup" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/504b5c8d-bbed-4635-aff1-48ec5b586db5", + "CreationTimestamp": "2018-12-31T21:39:36.771Z", + "Id": "504b5c8d-bbed-4635-aff1-48ec5b586db5", + "LastUpdatedTimestamp": "2018-12-31T21:39:36.771Z", + "LatestVersion": "46911e8e-f9bc-4898-8b63-59c7653636ec", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/504b5c8d-bbed-4635-aff1-48ec5b586db5/versions/46911e8e-f9bc-4898-8b63-59c7653636ec", + "Name": "smp-ggrass-group" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/list-group-versions.rst awscli-1.18.69/awscli/examples/greengrass/list-group-versions.rst --- awscli-1.11.13/awscli/examples/greengrass/list-group-versions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/list-group-versions.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,43 @@ +**To list the versions of a Greengrass group** + +The following ``list-group-versions`` example lists the versions of the specified Greengrass group. :: + + aws greengrass list-group-versions \ + --group-id "1013db12-8b58-45ff-acc7-704248f66731" + +Output:: + + { + "Versions": [ + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731/versions/115136b3-cfd7-4462-b77f-8741a4b00e5e", + "CreationTimestamp": "2019-06-18T17:04:30.915Z", + "Id": "1013db12-8b58-45ff-acc7-704248f66731", + "Version": "115136b3-cfd7-4462-b77f-8741a4b00e5e" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731/versions/4340669d-d14d-44e3-920c-46c928750750", + "CreationTimestamp": "2019-06-18T17:03:52.663Z", + "Id": "1013db12-8b58-45ff-acc7-704248f66731", + "Version": "4340669d-d14d-44e3-920c-46c928750750" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731/versions/1b06e099-2d5b-4f10-91b9-78c4e060f5da", + "CreationTimestamp": "2019-06-18T17:02:44.189Z", + "Id": "1013db12-8b58-45ff-acc7-704248f66731", + "Version": "1b06e099-2d5b-4f10-91b9-78c4e060f5da" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731/versions/2d3f27f1-3b43-4554-ab7a-73ec30477efe", + "CreationTimestamp": "2019-06-18T17:01:42.401Z", + "Id": "1013db12-8b58-45ff-acc7-704248f66731", + "Version": "2d3f27f1-3b43-4554-ab7a-73ec30477efe" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731/versions/d20f7ae9-3444-4c1c-b025-e2ede23cdd31", + "CreationTimestamp": "2019-06-18T16:21:21.457Z", + "Id": "1013db12-8b58-45ff-acc7-704248f66731", + "Version": "d20f7ae9-3444-4c1c-b025-e2ede23cdd31" + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/greengrass/list-logger-definitions.rst awscli-1.18.69/awscli/examples/greengrass/list-logger-definitions.rst --- awscli-1.11.13/awscli/examples/greengrass/list-logger-definitions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/list-logger-definitions.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,20 @@ +**To get a list of logger definitions** + +The following ``list-logger-definitions`` example lists all of the logger definitions for your AWS account. :: + + aws greengrass list-logger-definitions + +Output:: + + { + "Definitions": [ + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/loggers/49eeeb66-f1d3-4e34-86e3-3617262abf23", + "CreationTimestamp": "2019-05-08T16:10:13.809Z", + "Id": "49eeeb66-f1d3-4e34-86e3-3617262abf23", + "LastUpdatedTimestamp": "2019-05-08T16:10:13.809Z", + "LatestVersion": "5e3f6f64-a565-491e-8de0-3c0d8e0f2073", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/loggers/49eeeb66-f1d3-4e34-86e3-3617262abf23/versions/5e3f6f64-a565-491e-8de0-3c0d8e0f2073" + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/greengrass/list-logger-definition-versions.rst awscli-1.18.69/awscli/examples/greengrass/list-logger-definition-versions.rst --- awscli-1.11.13/awscli/examples/greengrass/list-logger-definition-versions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/list-logger-definition-versions.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,25 @@ +**To get a list of versions of a logger definition** + +The following ``list-logger-definition-versions`` example gets a list of all versions of the specified logger definition. :: + + aws greengrass list-logger-definition-versions \ + --logger-definition-id "49eeeb66-f1d3-4e34-86e3-3617262abf23" + +Output:: + + { + "Versions": [ + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/loggers/49eeeb66-f1d3-4e34-86e3-3617262abf23/versions/5e3f6f64-a565-491e-8de0-3c0d8e0f2073", + "CreationTimestamp": "2019-05-08T16:10:13.866Z", + "Id": "49eeeb66-f1d3-4e34-86e3-3617262abf23", + "Version": "5e3f6f64-a565-491e-8de0-3c0d8e0f2073" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/loggers/49eeeb66-f1d3-4e34-86e3-3617262abf23/versions/3ec6d3af-eb85-48f9-a16d-1c795fe696d7", + "CreationTimestamp": "2019-05-08T16:10:13.809Z", + "Id": "49eeeb66-f1d3-4e34-86e3-3617262abf23", + "Version": "3ec6d3af-eb85-48f9-a16d-1c795fe696d7" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/list-resource-definitions.rst awscli-1.18.69/awscli/examples/greengrass/list-resource-definitions.rst --- awscli-1.11.13/awscli/examples/greengrass/list-resource-definitions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/list-resource-definitions.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,29 @@ +**To list the resources that are defined** + +The following ``list-resource-definitions`` example lists the resources that are defined for AWS IoT Greengrass to use. :: + + aws greengrass list-resource-definitions + +Output:: + + { + "Definitions": [ + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/ad8c101d-8109-4b0e-b97d-9cc5802ab658", + "CreationTimestamp": "2019-06-19T16:40:59.261Z", + "Id": "ad8c101d-8109-4b0e-b97d-9cc5802ab658", + "LastUpdatedTimestamp": "2019-06-19T16:40:59.261Z", + "LatestVersion": "26e8829a-491a-464d-9c87-664bf6f6f2be", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/ad8c101d-8109-4b0e-b97d-9cc5802ab658/versions/26e8829a-491a-464d-9c87-664bf6f6f2be" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/c8bb9ebc-c3fd-40a4-9c6a-568d75569d38", + "CreationTimestamp": "2019-06-19T21:51:28.212Z", + "Id": "c8bb9ebc-c3fd-40a4-9c6a-568d75569d38", + "LastUpdatedTimestamp": "2019-06-19T21:51:28.212Z", + "LatestVersion": "a5f94d0b-f6bc-40f4-bb78-7a1c5fe13ba1", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/c8bb9ebc-c3fd-40a4-9c6a-568d75569d38/versions/a5f94d0b-f6bc-40f4-bb78-7a1c5fe13ba1", + "Name": "MyGreengrassResources" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/list-resource-definition-versions.rst awscli-1.18.69/awscli/examples/greengrass/list-resource-definition-versions.rst --- awscli-1.11.13/awscli/examples/greengrass/list-resource-definition-versions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/list-resource-definition-versions.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,25 @@ +**To list the versions of a resource definition** + +The following ``list-resource-definition-versions`` example lists the versions for the specified Greengrass resource. :: + + aws greengrass list-resource-definition-versions \ + --resource-definition-id "ad8c101d-8109-4b0e-b97d-9cc5802ab658" + +Output:: + + { + "Versions": [ + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/ad8c101d-8109-4b0e-b97d-9cc5802ab658/versions/26e8829a-491a-464d-9c87-664bf6f6f2be", + "CreationTimestamp": "2019-06-19T16:40:59.392Z", + "Id": "ad8c101d-8109-4b0e-b97d-9cc5802ab658", + "Version": "26e8829a-491a-464d-9c87-664bf6f6f2be" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/ad8c101d-8109-4b0e-b97d-9cc5802ab658/versions/432d92f6-12de-4ec9-a704-619a942a62aa", + "CreationTimestamp": "2019-06-19T16:40:59.261Z", + "Id": "ad8c101d-8109-4b0e-b97d-9cc5802ab658", + "Version": "432d92f6-12de-4ec9-a704-619a942a62aa" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/list-subscription-definitions.rst awscli-1.18.69/awscli/examples/greengrass/list-subscription-definitions.rst --- awscli-1.11.13/awscli/examples/greengrass/list-subscription-definitions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/list-subscription-definitions.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,36 @@ +**To get a list subscription definitions** + +The following ``list-subscription-definitions`` example lists all of the AWS IoT Greengrass subscriptions that are defined in your AWS account. :: + + aws greengrass list-subscription-definitions + +Output:: + + { + "Definitions": [ + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/70e49321-83d5-45d2-bc09-81f4917ae152", + "CreationTimestamp": "2019-06-18T17:03:52.392Z", + "Id": "70e49321-83d5-45d2-bc09-81f4917ae152", + "LastUpdatedTimestamp": "2019-06-18T17:03:52.392Z", + "LatestVersion": "88ae8699-12ac-4663-ba3f-4d7f0519140b", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/70e49321-83d5-45d2-bc09-81f4917ae152/versions/88ae8699-12ac-4663-ba3f-4d7f0519140b" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/cd6f1c37-d9a4-4e90-be94-01a7404f5967", + "CreationTimestamp": "2018-10-18T15:45:34.024Z", + "Id": "cd6f1c37-d9a4-4e90-be94-01a7404f5967", + "LastUpdatedTimestamp": "2018-10-18T15:45:34.024Z", + "LatestVersion": "d1cf8fac-284f-4f6a-98fe-a2d36d089373", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/cd6f1c37-d9a4-4e90-be94-01a7404f5967/versions/d1cf8fac-284f-4f6a-98fe-a2d36d089373" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/fa81bc84-3f59-4377-a84b-5d0134da359b", + "CreationTimestamp": "2018-10-22T17:09:31.429Z", + "Id": "fa81bc84-3f59-4377-a84b-5d0134da359b", + "LastUpdatedTimestamp": "2018-10-22T17:09:31.429Z", + "LatestVersion": "086d1b08-b25a-477c-a16f-6f9b3a9c295a", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/fa81bc84-3f59-4377-a84b-5d0134da359b/versions/086d1b08-b25a-477c-a16f-6f9b3a9c295a" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/list-subscription-definition-versions.rst awscli-1.18.69/awscli/examples/greengrass/list-subscription-definition-versions.rst --- awscli-1.11.13/awscli/examples/greengrass/list-subscription-definition-versions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/list-subscription-definition-versions.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,25 @@ +**To list the versions of a subscription definition** + +The following ``list-subscription-definition-versions`` example lists all versions of the specified subscription. You can use the ``list-subscription-definitions`` command to look up the subscription ID. :: + + aws greengrass list-subscription-definition-versions \ + --subscription-definition-id "70e49321-83d5-45d2-bc09-81f4917ae152" + +Output:: + + { + "Versions": [ + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/70e49321-83d5-45d2-bc09-81f4917ae152/versions/88ae8699-12ac-4663-ba3f-4d7f0519140b", + "CreationTimestamp": "2019-06-18T17:03:52.499Z", + "Id": "70e49321-83d5-45d2-bc09-81f4917ae152", + "Version": "88ae8699-12ac-4663-ba3f-4d7f0519140b" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/70e49321-83d5-45d2-bc09-81f4917ae152/versions/7e320ba3-c369-4069-a2f0-90acb7f219d6", + "CreationTimestamp": "2019-06-18T17:03:52.392Z", + "Id": "70e49321-83d5-45d2-bc09-81f4917ae152", + "Version": "7e320ba3-c369-4069-a2f0-90acb7f219d6" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/list-tags-for-resource.rst awscli-1.18.69/awscli/examples/greengrass/list-tags-for-resource.rst --- awscli-1.11.13/awscli/examples/greengrass/list-tags-for-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/list-tags-for-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To list the tags attached to a resource** + +The following ``list-tags-for-resource`` example lists the tags and their values that are attached to the specified resource. :: + + aws greengrass list-tags-for-resource \ + --resource-arn "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/ad8c101d-8109-4b0e-b97d-9cc5802ab658" + +Output:: + + { + "tags": { + "ResourceSubType": "USB", + "ResourceType": "Device" + } + } + +For more information, see `Tagging Your Greengrass Resources `__ in the **AWS IoT Greengrass Developer Guide**. diff -Nru awscli-1.11.13/awscli/examples/greengrass/reset-deployments.rst awscli-1.18.69/awscli/examples/greengrass/reset-deployments.rst --- awscli-1.11.13/awscli/examples/greengrass/reset-deployments.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/reset-deployments.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,16 @@ +**To clean up deployment information for a Greengrass group** + +The following ``reset-deployments`` example cleans up deployment information for the specified Greengrass group. When you add the ``--force option``, the deployment information is reset without waiting for the core device to respond. :: + + aws greengrass reset-deployments \ + --group-id "1402daf9-71cf-4cfe-8be0-d5e80526d0d8" \ + --force + +Output:: + + { + "DeploymentArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1402daf9-71cf-4cfe-8be0-d5e80526d0d8/deployments/7dd4e356-9882-46a3-9e28-6d21900c011a", + "DeploymentId": "7dd4e356-9882-46a3-9e28-6d21900c011a" + } + +For more information, see `Reset Deployments `__ in the *AWS IoT Greengrass Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/greengrass/start-bulk-deployment.rst awscli-1.18.69/awscli/examples/greengrass/start-bulk-deployment.rst --- awscli-1.11.13/awscli/examples/greengrass/start-bulk-deployment.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/start-bulk-deployment.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,15 @@ +**To start a bulk deployment operation** + +The following ``start-bulk-deployment`` example starts a bulk deployment operation, using a file stored in an S3 bucket to specify the groups to be deployed. :: + + aws greengrass start-bulk-deployment \ + --cli-input-json "{\"InputFileUri\":\"https://gg-group-deployment1.s3-us-west-2.amazonaws.com/MyBulkDeploymentInputFile.txt\", \"ExecutionRoleArn\":\"arn:aws:iam::123456789012:role/ggCreateDeploymentRole\",\"AmznClientToken\":\"yourAmazonClientToken\"}" + +Output:: + + { + "BulkDeploymentArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/bulk/deployments/870fb41b-6288-4e0c-bc76-a7ba4b4d3267", + "BulkDeploymentId": "870fb41b-6288-4e0c-bc76-a7ba4b4d3267" + } + +For more information, see `Create Bulk Deployments for Groups `__ in the *AWS IoT Greengrass Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/greengrass/stop-bulk-deployment.rst awscli-1.18.69/awscli/examples/greengrass/stop-bulk-deployment.rst --- awscli-1.11.13/awscli/examples/greengrass/stop-bulk-deployment.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/stop-bulk-deployment.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,10 @@ +**To stop a bulk deployment** + +The following ``stop-bulk-deployment`` example stops the specified bulk deployment. If you try to stop a bulk deployment that is complete, you receive an error: ``InvalidInputException: Cannot change state of finished execution.`` :: + + aws greengrass stop-bulk-deployment \ + --bulk-deployment-id "870fb41b-6288-4e0c-bc76-a7ba4b4d3267" + +This command produces no output. + +For more information, see `Create Bulk Deployments for Groups `__ in the *AWS IoT Greengrass Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/greengrass/tag-resource.rst awscli-1.18.69/awscli/examples/greengrass/tag-resource.rst --- awscli-1.11.13/awscli/examples/greengrass/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/tag-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To apply tags to a resource** + +The following ``tag-resource`` example applies two tags, ``ResourceType`` and ``ResourceSubType``, to the specified Greengrass resource. This operation can both add new tags and values or update the value for existing tags. Use the ``untag-resource`` command to remove a tag. :: + + aws greengrass tag-resource \ + --resource-arn "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/ad8c101d-8109-4b0e-b97d-9cc5802ab658" \ + --tags "ResourceType=Device,ResourceSubType=USB" + +This command produces no output. + +For more information, see `Tagging Your Greengrass Resources `__ in the **AWS IoT Greengrass Developer Guide**. diff -Nru awscli-1.11.13/awscli/examples/greengrass/untag-resource.rst awscli-1.18.69/awscli/examples/greengrass/untag-resource.rst --- awscli-1.11.13/awscli/examples/greengrass/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/untag-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To remove a tag and its value from a resource** + +The following ``untag-resource`` example removes the tag whose key is ``Category`` from the specified Greengrass group. If the key ``Category`` does not exist for the specified resource, no error is returned. :: + + aws greengrass untag-resource \ + --resource-arn "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731" \ + --tag-keys "Category" + +This command produces no output. + +For more information, see `Tagging Your Greengrass Resources `__ in the **AWS IoT Greengrass Developer Guide**. diff -Nru awscli-1.11.13/awscli/examples/greengrass/update-connectivity-info.rst awscli-1.18.69/awscli/examples/greengrass/update-connectivity-info.rst --- awscli-1.11.13/awscli/examples/greengrass/update-connectivity-info.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/update-connectivity-info.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,13 @@ +**To update the connectivity information for a Greengrass core** + +The following ``update-connectivity-info`` example changes the endpoints that devices can use to connect to the specified Greengrass core. Connectivity information is a list of IP addresses or domain names, with corresponding port numbers and optional customer-defined metadata. You might need to update connectivity information when the local network changes. :: + + aws greengrass update-connectivity-info \ + --thing-name "MyGroup_Core" \ + --connectivity-info "[{\"Metadata\":\"\",\"PortNumber\":8883,\"HostAddress\":\"127.0.0.1\",\"Id\":\"localhost_127.0.0.1_0\"},{\"Metadata\":\"\",\"PortNumber\":8883,\"HostAddress\":\"192.168.1.3\",\"Id\":\"localIP_192.168.1.3\"}]" + +Output:: + + { + "Version": "312de337-59af-4cf9-a278-2a23bd39c300" + } diff -Nru awscli-1.11.13/awscli/examples/greengrass/update-connector-definition.rst awscli-1.18.69/awscli/examples/greengrass/update-connector-definition.rst --- awscli-1.11.13/awscli/examples/greengrass/update-connector-definition.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/update-connector-definition.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To update the name for a connector definition** + +The following ``update-connector-definition`` example updates the name for the specified connector definition. If you want to update the details for the connector, use the ``create-connector-definition-version`` command to create a new version. :: + + aws greengrass update-connector-definition \ + --connector-definition-id "55d0052b-0d7d-44d6-b56f-21867215e118" \ + --name "GreengrassConnectors2019" + +For more information, see `Integrate with Services and Protocols Using Connectors `__ in the *AWS IoT Greengrass Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/greengrass/update-core-definition.rst awscli-1.18.69/awscli/examples/greengrass/update-core-definition.rst --- awscli-1.11.13/awscli/examples/greengrass/update-core-definition.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/update-core-definition.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To update a core definition** + +The following ``update-core-definition`` example changes the name of the specified core definition. You can update only the ``name`` property of a core definition. :: + + aws greengrass update-core-definition \ + --core-definition-id "582efe12-b05a-409e-9a24-a2ba1bcc4a12" \ + --name "MyCoreDevices" + +This command produces no output. + +For more information, see `Configure the AWS IoT Greengrass Core `__ in the *AWS IoT Greengrass Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/greengrass/update-device-definition.rst awscli-1.18.69/awscli/examples/greengrass/update-device-definition.rst --- awscli-1.11.13/awscli/examples/greengrass/update-device-definition.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/update-device-definition.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To update a device definition** + +The following ``update-device-definition`` example changes the name of the specified device definition. You can only update the ``name`` property of a device definition. :: + + aws greengrass update-device-definition \ + --device-definition-id "f9ba083d-5ad4-4534-9f86-026a45df1ccd" \ + --name "TemperatureSensors" + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/greengrass/update-function-definition.rst awscli-1.18.69/awscli/examples/greengrass/update-function-definition.rst --- awscli-1.11.13/awscli/examples/greengrass/update-function-definition.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/update-function-definition.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To update the name for a function definition** + +The following ``update-function-definition`` example updates the name for the specified function definition. If you want to update the details for the function, use the ``create-function-definition-version`` command to create a new version. :: + + aws greengrass update-function-definition \ + --function-definition-id "e47952bd-dea9-4e2c-a7e1-37bbe8807f46" \ + --name ObsoleteFunction + +This command produces no output. + +For more information, see `Run Local Lambda Functions `__ in the *AWS IoT Greengrass Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/greengrass/update-group-certificate-configuration.rst awscli-1.18.69/awscli/examples/greengrass/update-group-certificate-configuration.rst --- awscli-1.11.13/awscli/examples/greengrass/update-group-certificate-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/update-group-certificate-configuration.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To update the expiry of a group's certificate authority (CA)** + +The following ``update-group-certificate-configuration`` example sets a 10-day expiry for the CA of the specified group. :: + + aws greengrass update-group-certificate-configuration \ + --group-id "8eaadd72-ce4b-4f15-892a-0cc4f3a343f1" \ + --certificate-expiry-in-milliseconds 864000000 + +Output:: + + { + "CertificateExpiryInMilliseconds": 864000000, + "CertificateAuthorityExpiryInMilliseconds": 2524607999000, + "GroupId": "8eaadd72-ce4b-4f15-892a-0cc4f3a343f1" + } + +For more information, see `AWS IoT Greengrass Security `__ in the *AWS IoT Greengrass Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/greengrass/update-group.rst awscli-1.18.69/awscli/examples/greengrass/update-group.rst --- awscli-1.11.13/awscli/examples/greengrass/update-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/update-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To update the group name** + +The following ``update-group`` example updates the name of the specified Greengrass group. If you want to update the details for the group, use the ``create-group-definition-version`` command to create a new version. :: + + aws greengrass update-group \ + --group-id "1402daf9-71cf-4cfe-8be0-d5e80526d0d8" \ + --name TestGroup4of6 + + + +For more information, see `Configure AWS IoT Greengrass on AWS IoT `__ in the *AWS IoT Greengrass Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/greengrass/update-logger-definition.rst awscli-1.18.69/awscli/examples/greengrass/update-logger-definition.rst --- awscli-1.11.13/awscli/examples/greengrass/update-logger-definition.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/update-logger-definition.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To update a logger definition** + +The following ``update-logger-definition`` example changes the name of the specified logger definition. You can only update the ``name`` property of a logger definition. :: + + aws greengrass update-logger-definition \ + --logger-definition-id "a454b62a-5d56-4ca9-bdc4-8254e1662cb0" \ + --name "LoggingConfigsForSensors" + +This command produces no output. + +For more information, see `Monitoring with AWS IoT Greengrass Logs `__ in the *AWS IoT Greengrass Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/greengrass/update-resource-definition.rst awscli-1.18.69/awscli/examples/greengrass/update-resource-definition.rst --- awscli-1.11.13/awscli/examples/greengrass/update-resource-definition.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/update-resource-definition.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To update the name for a resource definition** + +The following ``update-resource-definition`` example updates the name for the specified resource definition. If you want to change the details for the resource, use the ``create-resource-definition-version`` command to create a new version. :: + + aws greengrass update-resource-definition \ + --resource-definition-id "c8bb9ebc-c3fd-40a4-9c6a-568d75569d38" \ + --name GreengrassConnectorResoruces + +This command produces no output. + +For more information, see `Access Local Resources with Lambda Functions and Connectors `__ in the *AWS IoT Greengrass Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/greengrass/update-subscription-definition.rst awscli-1.18.69/awscli/examples/greengrass/update-subscription-definition.rst --- awscli-1.11.13/awscli/examples/greengrass/update-subscription-definition.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/greengrass/update-subscription-definition.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To update the name for a subscription definition** + +The following ``update-subscription-definition`` example updates the name for the specified subscription definition. If you want to change details for the subscription, use the ``create-subscription-definition-version`` command to create a new version. :: + + aws greengrass update-subscription-definition \ + --subscription-definition-id "fa81bc84-3f59-4377-a84b-5d0134da359b" \ + --name "ObsoleteSubscription" + +This command produces no output. + +For more information, see `title `__ in the *guide*. diff -Nru awscli-1.11.13/awscli/examples/iam/attach-user-policy.rst awscli-1.18.69/awscli/examples/iam/attach-user-policy.rst --- awscli-1.11.13/awscli/examples/iam/attach-user-policy.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/attach-user-policy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,8 +2,8 @@ The following ``attach-user-policy`` command attaches the AWS managed policy named ``AdministratorAccess`` to the IAM user named ``Alice``:: - aws iam attach-user-policy --policy-arn arn:aws:iam::aws:policy/AdministratorAccess --user-name Alice + aws iam attach-user-policy --policy-arn arn:aws:iam:ACCOUNT-ID:aws:policy/AdministratorAccess --user-name Alice For more information, see `Managed Policies and Inline Policies`_ in the *Using IAM* guide. -.. _`Managed Policies and Inline Policies`: http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html \ No newline at end of file +.. _`Managed Policies and Inline Policies`: http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html diff -Nru awscli-1.11.13/awscli/examples/iam/create-policy.rst awscli-1.18.69/awscli/examples/iam/create-policy.rst --- awscli-1.11.13/awscli/examples/iam/create-policy.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/create-policy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -32,7 +32,7 @@ "Resource": [ "arn:aws:s3:::my-bucket/shared/*" ] - }, + } ] } diff -Nru awscli-1.11.13/awscli/examples/iam/create-service-linked-role.rst awscli-1.18.69/awscli/examples/iam/create-service-linked-role.rst --- awscli-1.11.13/awscli/examples/iam/create-service-linked-role.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/create-service-linked-role.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,37 @@ +**To create a service-linked role** + +The following ``create-service-linked-role`` example creates a service-linked role for the specified AWS service and attaches the specified description. :: + + aws iam create-service-linked-role \ + --aws-service-name lex.amazonaws.com \ + --description "My service-linked role to support Lex" + +Output:: + + { + "Role": { + "Path": "/aws-service-role/lex.amazonaws.com/", + "RoleName": "AWSServiceRoleForLexBots", + "RoleId": "AROA1234567890EXAMPLE", + "Arn": "arn:aws:iam::1234567890:role/aws-service-role/lex.amazonaws.com/AWSServiceRoleForLexBots", + "CreateDate": "2019-04-17T20:34:14+00:00", + "AssumeRolePolicyDocument": { + "Version": "2012-10-17", + "Statement": [ + { + "Action": [ + "sts:AssumeRole" + ], + "Effect": "Allow", + "Principal": { + "Service": [ + "lex.amazonaws.com" + ] + } + } + ] + } + } + } + +For more information, see `Using Service-Linked Roles `_ in the *IAM User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iam/create-service-specific-credential.rst awscli-1.18.69/awscli/examples/iam/create-service-specific-credential.rst --- awscli-1.11.13/awscli/examples/iam/create-service-specific-credential.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/create-service-specific-credential.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,23 @@ +**Create a set of service-specific credentials for a user** + +The following ``create-service-specific-credential`` example creates a username and password that can be used to access only the configured service. :: + + aws iam create-service-specific-credential --user-name sofia --service-name codecommit.amazonaws.com + +Output:: + + { + "ServiceSpecificCredential": { + "CreateDate": "2019-04-18T20:45:36+00:00", + "ServiceName": "codecommit.amazonaws.com", + "ServiceUserName": "sofia-at-123456789012", + "ServicePassword": "k1zPZM6uVxMQ3oxqgoYlNuJPyRTZ1vREs76zTQE3eJk=", + "ServiceSpecificCredentialId": "ACCAEXAMPLE123EXAMPLE", + "UserName": "sofia", + "Status": "Active" + } + } + +For more information, see `Create Git Credentials for HTTPS Connections to CodeCommit`_ in the *AWS CodeCommit User Guide* + +.. _`Create Git Credentials for HTTPS Connections to CodeCommit`: https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-gc.html#setting-up-gc-iam diff -Nru awscli-1.11.13/awscli/examples/iam/create-user.rst awscli-1.18.69/awscli/examples/iam/create-user.rst --- awscli-1.11.13/awscli/examples/iam/create-user.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/create-user.rst 2020-05-28 19:25:48.000000000 +0000 @@ -11,7 +11,7 @@ "UserName": "Bob", "Path": "/", "CreateDate": "2013-06-08T03:20:41.270Z", - "UserId": "AKIAIOSFODNN7EXAMPLE", + "UserId": "AIDAIOSFODNN7EXAMPLE", "Arn": "arn:aws:iam::123456789012:user/Bob" } } @@ -19,4 +19,3 @@ For more information, see `Adding a New User to Your AWS Account`_ in the *Using IAM* guide. .. _`Adding a New User to Your AWS Account`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_SettingUpUser.html - diff -Nru awscli-1.11.13/awscli/examples/iam/decode-authorization-message.rst awscli-1.18.69/awscli/examples/iam/decode-authorization-message.rst --- awscli-1.11.13/awscli/examples/iam/decode-authorization-message.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/decode-authorization-message.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,12 @@ +**To decode a authorization failure message** + +The following ``decode-authorization-message`` example decodes the message returned by the EC2 console when attempting to launch an instance without the required permissions. :: + + aws sts decode-authorization-message \ + --encoded-message lxzA8VEjEvu-s0TTt3PgYCXik9YakOqsrFJGRZR98xNcyWAxwRq14xIvd-npzbgTevuufCTbjeBAaDARg9cbTK1rJbg3awM33o-Vy3ebPErE2-mWR9hVYdvX-0zKgVOWF9pWjZaJSMqxB-aLXo-I_8TTvBq88x8IFPbMArNdpu0IjxDjzf22PF3SOE3XvIQ-_PEO0aUqHCCcsSrFtvxm6yQD1nbm6VTIVrfa0Bzy8lsoMo7SjIaJ2r5vph6SY5vCCwg6o2JKe3hIHTa8zRrDbZSFMkcXOT6EOPkQXmaBsAC6ciG7Pz1JnEOvuj5NSTlSMljrAXczWuRKAs5GsMYiU8KZXZhokVzdQCUZkS5aVHumZbadu0io53jpgZqhMqvS4fyfK4auK0yKRMtS6JCXPlhkolEs7ZMFA0RVkutqhQqpSDPB5SX5l00lYipWyFK0_AyAx60vumPuVh8P0AzXwdFsT0l4D0m42NFIKxbWXsoJdqaOqVFyFEd0-Xx9AYAAIr6bhcis7C__bZh4dlAAWooHFGKgfoJcWGwgdzgbu9hWyVvKTpeot5hsb8qANYjJRCPXTKpi6PZfdijIkwb6gDMEsJ9qMtr62qP_989mwmtNgnVvBa_ir6oxJxVe_kL9SH1j5nsGDxQFajvPQhxWOHvEQIg_H0bnKWk + +The output is formatted as a single-line string of JSON text that you can parse with any JSON text processor:: + + { + "DecodedMessage": "{\"allowed\":false,\"explicitDeny\":false,\"matchedStatements\":{\"items\":[]},\"failures\":{\"items\":[]},\"context\":{\"principal\":{\"id\":\"AIDAV3ZUEFP6J7GY7O6LO\",\"name\":\"chain-user\",\"arn\":\"arn:aws:iam::403299380220:user/chain-user\"},\"action\":\"ec2:RunInstances\",\"resource\":\"arn:aws:ec2:us-east-2:403299380220:instance/*\",\"conditions\":{\"items\":[{\"key\":\"ec2:InstanceMarketType\",\"values\":{\"items\":[{\"value\":\"on-demand\"}]}},{\"key\":\"aws:Resource\",\"values\":{\"items\":[{\"value\":\"instance/*\"}]}},{\"key\":\"aws:Account\",\"values\":{\"items\":[{\"value\":\"403299380220\"}]}},{\"key\":\"ec2:AvailabilityZone\",\"values\":{\"items\":[{\"value\":\"us-east-2b\"}]}},{\"key\":\"ec2:ebsOptimized\",\"values\":{\"items\":[{\"value\":\"false\"}]}},{\"key\":\"ec2:IsLaunchTemplateResource\",\"values\":{\"items\":[{\"value\":\"false\"}]}},{\"key\":\"ec2:InstanceType\",\"values\":{\"items\":[{\"value\":\"t2.micro\"}]}},{\"key\":\"ec2:RootDeviceType\",\"values\":{\"items\":[{\"value\":\"ebs\"}]}},{\"key\":\"aws:Region\",\"values\":{\"items\":[{\"value\":\"us-east-2\"}]}},{\"key\":\"aws:Service\",\"values\":{\"items\":[{\"value\":\"ec2\"}]}},{\"key\":\"ec2:InstanceID\",\"values\":{\"items\":[{\"value\":\"*\"}]}},{\"key\":\"aws:Type\",\"values\":{\"items\":[{\"value\":\"instance\"}]}},{\"key\":\"ec2:Tenancy\",\"values\":{\"items\":[{\"value\":\"default\"}]}},{\"key\":\"ec2:Region\",\"values\":{\"items\":[{\"value\":\"us-east-2\"}]}},{\"key\":\"aws:ARN\",\"values\":{\"items\":[{\"value\":\"arn:aws:ec2:us-east-2:403299380220:instance/*\"}]}}]}}}" + } diff -Nru awscli-1.11.13/awscli/examples/iam/delete-access-key.rst awscli-1.18.69/awscli/examples/iam/delete-access-key.rst --- awscli-1.11.13/awscli/examples/iam/delete-access-key.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/delete-access-key.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,7 +2,7 @@ The following ``delete-access-key`` command deletes the specified access key (access key ID and secret access key) for the IAM user named ``Bob``:: - aws iam delete-access-key --access-key AKIDPMS9RO4H3FEXAMPLE --user-name Bob + aws iam delete-access-key --access-key-id AKIDPMS9RO4H3FEXAMPLE --user-name Bob To list the access keys defined for an IAM user, use the ``list-access-keys`` command. diff -Nru awscli-1.11.13/awscli/examples/iam/delete-open-id-connect-provider.rst awscli-1.18.69/awscli/examples/iam/delete-open-id-connect-provider.rst --- awscli-1.11.13/awscli/examples/iam/delete-open-id-connect-provider.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/delete-open-id-connect-provider.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,7 +2,7 @@ This example deletes the IAM OIDC provider that connects to the provider ``example.oidcprovider.com``:: - aws aim delete-open-id-connect-provider --open-id-connect-provider-arn arn:aws:iam::123456789012:oidc-provider/example.oidcprovider.com + aws iam delete-open-id-connect-provider --open-id-connect-provider-arn arn:aws:iam::123456789012:oidc-provider/example.oidcprovider.com For more information, see `Using OpenID Connect Identity Providers`_ in the *Using IAM* guide. diff -Nru awscli-1.11.13/awscli/examples/iam/delete-role-permissions-boundary.rst awscli-1.18.69/awscli/examples/iam/delete-role-permissions-boundary.rst --- awscli-1.11.13/awscli/examples/iam/delete-role-permissions-boundary.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/delete-role-permissions-boundary.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To delete a permissions boundary from an IAM role** + +The following ``delete-role-permissions-boundary`` example deletes the permissions boundary for the specified IAM role. To apply a permissions boundary to a role, use the ``put-role-permissions-boundary`` command. :: + + aws iam delete-role-permissions-boundary \ + --role-name lambda-application-role + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/iam/delete-server-certificate.rst awscli-1.18.69/awscli/examples/iam/delete-server-certificate.rst --- awscli-1.11.13/awscli/examples/iam/delete-server-certificate.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/delete-server-certificate.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To delete a server certificate from your AWS account** + +The following ``delete-server-certificate`` command removes the specified server certificate from your AWS account. This command produces no output. :: + + aws iam delete-server-certificate --server-certificate-name myUpdatedServerCertificate + +To list the server certificates available in your AWS account, use the ``list-server-certificates`` command. + +For more information, see `Creating, Uploading, and Deleting Server Certificates`_ in the *IAM Users Guide*. + +.. _`Creating, Uploading, and Deleting Server Certificates`: http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html diff -Nru awscli-1.11.13/awscli/examples/iam/delete-service-linked-role.rst awscli-1.18.69/awscli/examples/iam/delete-service-linked-role.rst --- awscli-1.11.13/awscli/examples/iam/delete-service-linked-role.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/delete-service-linked-role.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,13 @@ +**To delete a service-linked role** + +The following ``delete-service-linked-role`` example deletes the specified service-linked role that you no longer need. The deletion happens asynchronously. You can check the status of the deletion and confirm when it is done by using the ``get-service-linked-role-deletion-status`` command. :: + + aws iam delete-service-linked-role --role-name AWSServiceRoleForLexBots + +Output:: + + { + "DeletionTaskId": "task/aws-service-role/lex.amazonaws.com/AWSServiceRoleForLexBots/1a2b3c4d-1234-abcd-7890-abcdeEXAMPLE" + } + +For more information, see `Using Service-Linked Roles `_ in the *IAM User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iam/delete-service-specific-credential.rst awscli-1.18.69/awscli/examples/iam/delete-service-specific-credential.rst --- awscli-1.11.13/awscli/examples/iam/delete-service-specific-credential.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/delete-service-specific-credential.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,15 @@ +**Delete a service-specific credential for the requesting user** + +The following ``delete-service-specific-credential`` example deletes the specified service-specific credential for the user making the request. The ``service-specific-credential-id`` is provided when you create the credential and you can retrieve it by using the ``list-service-specific-credentials`` command. This command produces no output. :: + + aws iam delete-service-specific-credential --service-specific-credential-id ACCAEXAMPLE123EXAMPLE + +**Delete a service-specific credential for a specified user** + +The following ``delete-service-specific-credential`` example deletes the specified service-specific credential for the specified user. The ``service-specific-credential-id`` is provided when you create the credential and you can retrieve it by using the ``list-service-specific-credentials`` command. This command produces no output. :: + + aws iam delete-service-specific-credential --user-name sofia --service-specific-credential-id ACCAEXAMPLE123EXAMPLE + +For more information, see `Create Git Credentials for HTTPS Connections to CodeCommit`_ in the *AWS CodeCommit User Guide* + +.. _`Create Git Credentials for HTTPS Connections to CodeCommit`: https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-gc.html#setting-up-gc-iam diff -Nru awscli-1.11.13/awscli/examples/iam/delete-ssh-public-key.rst awscli-1.18.69/awscli/examples/iam/delete-ssh-public-key.rst --- awscli-1.11.13/awscli/examples/iam/delete-ssh-public-key.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/delete-ssh-public-key.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,7 @@ +**To delete an SSH public keys attached to an IAM user** + +The following ``delete-ssh-public-key`` command deletes the specified SSH public key attached to the IAM user ``sofia``. This command does not produce any output. :: + + aws iam delete-ssh-public-key --user-name sofia --ssh-public-key-id APKA123456789EXAMPLE + +For more information about SSH keys in IAM, see `Use SSH Keys and SSH with CodeCommit `_ in the *AWS IAM User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iam/delete-user-permissions-boundary.rst awscli-1.18.69/awscli/examples/iam/delete-user-permissions-boundary.rst --- awscli-1.11.13/awscli/examples/iam/delete-user-permissions-boundary.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/delete-user-permissions-boundary.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To delete a permissions boundary from an IAM user** + +The following ``delete-user-permissions-boundary`` example deletes the permissions boundary attached to the IAM user named ``intern``. To apply a permissions boundary to a user, use the ``put-user-permissions-boundary`` command. :: + + aws iam delete-user-permissions-boundary \ + --user-name intern + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/iam/generate-organizations-access-report.rst awscli-1.18.69/awscli/examples/iam/generate-organizations-access-report.rst --- awscli-1.11.13/awscli/examples/iam/generate-organizations-access-report.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/generate-organizations-access-report.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,40 @@ +**Example 1: To generate an access report for a root in an organization** + +The following ``generate-organizations-access-report`` example starts a background job to create an access report for the specified root in an organization. You can display the report after it's created by running the ``get-organizations-access-report`` command. :: + + aws iam generate-organizations-access-report \ + --entity-path o-4fxmplt198/r-c3xb + +Output:: + + { + "JobId": "a8b6c06f-aaa4-8xmp-28bc-81da71836359" + } + +**Example 2: To generate an access report for an account in an organization** + +The following ``generate-organizations-access-report`` example starts a background job to create an access report for account ID ``123456789012`` in the organization ``o-4fxmplt198``. You can display the report after it's created by running the ``get-organizations-access-report`` command. :: + + aws iam generate-organizations-access-report \ + --entity-path o-4fxmplt198/r-c3xb/123456789012 + +Output:: + + { + "JobId": "14b6c071-75f6-2xmp-fb77-faf6fb4201d2" + } + +**Example 3: To generate an access report for an account in an organizational unit in an organization** + +The following ``generate-organizations-access-report`` example starts a background job to create an access report for account ID ``234567890123`` in organizational unit ``ou-c3xb-lmu7j2yg`` in the organization ``o-4fxmplt198``. You can display the report after it's created by running the ``get-organizations-access-report`` command.:: + + aws iam generate-organizations-access-report \ + --entity-path o-4fxmplt198/r-c3xb/ou-c3xb-lmu7j2yg/234567890123 + +Output:: + + { + "JobId": "2eb6c2e6-0xmp-ec04-1425-c937916a64af" + } + +To get details about roots and organizational units in your organization, use the ``organizations list-roots`` and ``organizations list-organizational-units-for-parent`` commands. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iam/generate-service-last-accessed-details.rst awscli-1.18.69/awscli/examples/iam/generate-service-last-accessed-details.rst --- awscli-1.11.13/awscli/examples/iam/generate-service-last-accessed-details.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/generate-service-last-accessed-details.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,23 @@ +**To generate a service access report** + +The following ``generate-service-last-accessed-details`` example starts a background job to generate a report that lists the services accessed by IAM users and other entities with a custom policy named ``intern-boundary``. You can display the report after it is created by running the ``get-service-last-accessed-details`` command. :: + + aws iam generate-service-last-accessed-details \ + --arn arn:aws:iam::123456789012:policy/intern-boundary + +Output:: + + { + "JobId": "2eb6c2b8-7b4c-3xmp-3c13-03b72c8cdfdc" + } + +The following ``generate-service-last-accessed-details`` example starts a background job to generate a report that lists the services accessed by IAM users and other entities with the AWS managed ``AdministratorAccess`` policy. You can display the report after it is created by running the ``get-service-last-accessed-details`` command.:: + + aws iam generate-service-last-accessed-details \ + --arn arn:aws:iam::aws:policy/AdministratorAccess + +Output:: + + { + "JobId": "78b6c2ba-d09e-6xmp-7039-ecde30b26916" + } diff -Nru awscli-1.11.13/awscli/examples/iam/get-account-authorization-details.rst awscli-1.18.69/awscli/examples/iam/get-account-authorization-details.rst --- awscli-1.11.13/awscli/examples/iam/get-account-authorization-details.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/get-account-authorization-details.rst 2020-05-28 19:25:48.000000000 +0000 @@ -4,285 +4,293 @@ Output:: - { - "RoleDetailList": [ - { - "AssumeRolePolicyDocument": { - "Version": "2012-10-17", - "Statement": [ + { + "RoleDetailList": [ { - "Sid": "", - "Effect": "Allow", - "Principal": { - "Service": "ec2.amazonaws.com" - }, - "Action": "sts:AssumeRole" - } - ] - }, - "RoleId": "AROAFP4BKI7Y7TEXAMPLE", - "CreateDate": "2014-07-30T17:09:20Z", - "InstanceProfileList": [ - { - "InstanceProfileId": "AIPAFFYRBHWXW2EXAMPLE", - "Roles": [ - { "AssumeRolePolicyDocument": { - "Version":"2012-10-17", - "Statement": [ - { - "Sid":"", - "Effect":"Allow", - "Principal": { - "Service":"ec2.amazonaws.com" - }, - "Action":"sts:AssumeRole" - } - ] + "Version": "2012-10-17", + "Statement": [ + { + "Sid": "", + "Effect": "Allow", + "Principal": { + "Service": "ec2.amazonaws.com" + }, + "Action": "sts:AssumeRole" + } + ] }, - "RoleId": "AROAFP4BKI7Y7TEXAMPLE", + "RoleId": "AROA1234567890EXAMPLE", "CreateDate": "2014-07-30T17:09:20Z", + "InstanceProfileList": [ + { + "InstanceProfileId": "AIPA1234567890EXAMPLE", + "Roles": [ + { + "AssumeRolePolicyDocument": { + "Version": "2012-10-17", + "Statement": [ + { + "Sid": "", + "Effect": "Allow", + "Principal": { + "Service": "ec2.amazonaws.com" + }, + "Action": "sts:AssumeRole" + } + ] + }, + "RoleId": "AROA1234567890EXAMPLE", + "CreateDate": "2014-07-30T17:09:20Z", + "RoleName": "EC2role", + "Path": "/", + "Arn": "arn:aws:iam::123456789012:role/EC2role" + } + ], + "CreateDate": "2014-07-30T17:09:20Z", + "InstanceProfileName": "EC2role", + "Path": "/", + "Arn": "arn:aws:iam::123456789012:instance-profile/EC2role" + } + ], "RoleName": "EC2role", "Path": "/", + "AttachedManagedPolicies": [ + { + "PolicyName": "AmazonS3FullAccess", + "PolicyArn": "arn:aws:iam::aws:policy/AmazonS3FullAccess" + }, + { + "PolicyName": "AmazonDynamoDBFullAccess", + "PolicyArn": "arn:aws:iam::aws:policy/AmazonDynamoDBFullAccess" + } + ], + "RoleLastUsed": { + "Region": "us-west-2", + "LastUsedDate": "2019-11-13T17:30:00Z" + }, + "RolePolicyList": [], "Arn": "arn:aws:iam::123456789012:role/EC2role" - } - ], - "CreateDate": "2014-07-30T17:09:20Z", - "InstanceProfileName": "EC2role", - "Path": "/", - "Arn": "arn:aws:iam::123456789012:instance-profile/EC2role" - } - ], - "RoleName": "EC2role", - "Path": "/", - "AttachedManagedPolicies": [ - { - "PolicyName": "AmazonS3FullAccess", - "PolicyArn": "arn:aws:iam::aws:policy/AmazonS3FullAccess" - }, - { - "PolicyName": "AmazonDynamoDBFullAccess", - "PolicyArn": "arn:aws:iam::aws:policy/AmazonDynamoDBFullAccess" - } - ], - "RolePolicyList": [], - "Arn": "arn:aws:iam::123456789012:role/EC2role" - }], - "GroupDetailList": [ - { - "GroupId": "AIDACKCEVSQ6C7EXAMPLE", - "AttachedManagedPolicies": { - "PolicyName": "AdministratorAccess", - "PolicyArn": "arn:aws:iam::aws:policy/AdministratorAccess" - }, - "GroupName": "Admins", - "Path": "/", - "Arn": "arn:aws:iam::123456789012:group/Admins", - "CreateDate": "2013-10-14T18:32:24Z", - "GroupPolicyList": [] - }, - { - "GroupId": "AIDACKCEVSQ6C8EXAMPLE", - "AttachedManagedPolicies": { - "PolicyName": "PowerUserAccess", - "PolicyArn": "arn:aws:iam::aws:policy/PowerUserAccess" - }, - "GroupName": "Dev", - "Path": "/", - "Arn": "arn:aws:iam::123456789012:group/Dev", - "CreateDate": "2013-10-14T18:33:55Z", - "GroupPolicyList": [] - }, - { - "GroupId": "AIDACKCEVSQ6C9EXAMPLE", - "AttachedManagedPolicies": [], - "GroupName": "Finance", - "Path": "/", - "Arn": "arn:aws:iam::123456789012:group/Finance", - "CreateDate": "2013-10-14T18:57:48Z", - "GroupPolicyList": [ - { - "PolicyName": "policygen-201310141157", - "PolicyDocument": { - "Version":"2012-10-17", - "Statement": [ - { - "Action": "aws-portal:*", - "Sid":"Stmt1381777017000", - "Resource": "*", - "Effect":"Allow" - } - ] } - } - ] - }], - "UserDetailList": [ - { - "UserName": "Alice", - "GroupList": [ - "Admins" - ], - "CreateDate": "2013-10-14T18:32:24Z", - "UserId": "AIDACKCEVSQ6C2EXAMPLE", - "UserPolicyList": [], - "Path": "/", - "AttachedManagedPolicies": [], - "Arn": "arn:aws:iam::123456789012:user/Alice" - }, - { - "UserName": "Bob", - "GroupList": [ - "Admins" ], - "CreateDate": "2013-10-14T18:32:25Z", - "UserId": "AIDACKCEVSQ6C3EXAMPLE", - "UserPolicyList": [ - { - "PolicyName": "DenyBillingAndIAMPolicy", - "PolicyDocument": { - "Version":"2012-10-17", - "Statement": { - "Effect":"Deny", - "Action": [ - "aws-portal:*", - "iam:*" - ], - "Resource":"*" - } + "GroupDetailList": [ + { + "GroupId": "AIDA1234567890EXAMPLE", + "AttachedManagedPolicies": { + "PolicyName": "AdministratorAccess", + "PolicyArn": "arn:aws:iam::aws:policy/AdministratorAccess" + }, + "GroupName": "Admins", + "Path": "/", + "Arn": "arn:aws:iam::123456789012:group/Admins", + "CreateDate": "2013-10-14T18:32:24Z", + "GroupPolicyList": [] + }, + { + "GroupId": "AIDA1234567890EXAMPLE", + "AttachedManagedPolicies": { + "PolicyName": "PowerUserAccess", + "PolicyArn": "arn:aws:iam::aws:policy/PowerUserAccess" + }, + "GroupName": "Dev", + "Path": "/", + "Arn": "arn:aws:iam::123456789012:group/Dev", + "CreateDate": "2013-10-14T18:33:55Z", + "GroupPolicyList": [] + }, + { + "GroupId": "AIDA1234567890EXAMPLE", + "AttachedManagedPolicies": [], + "GroupName": "Finance", + "Path": "/", + "Arn": "arn:aws:iam::123456789012:group/Finance", + "CreateDate": "2013-10-14T18:57:48Z", + "GroupPolicyList": [ + { + "PolicyName": "policygen-201310141157", + "PolicyDocument": { + "Version": "2012-10-17", + "Statement": [ + { + "Action": "aws-portal:*", + "Sid": "Stmt1381777017000", + "Resource": "*", + "Effect": "Allow" + } + ] + } + } + ] } - } - ], - "Path": "/", - "AttachedManagedPolicies": [], - "Arn": "arn:aws:iam::123456789012:user/Bob" - }, - { - "UserName": "Charlie", - "GroupList": [ - "Dev" ], - "CreateDate": "2013-10-14T18:33:56Z", - "UserId": "AIDACKCEVSQ6C4EXAMPLE", - "UserPolicyList": [], - "Path": "/", - "AttachedManagedPolicies": [], - "Arn": "arn:aws:iam::123456789012:user/Charlie" - }], - "Policies": [ - { - "PolicyName": "create-update-delete-set-managed-policies", - "CreateDate": "2015-02-06T19:58:34Z", - "AttachmentCount": 1, - "IsAttachable": true, - "PolicyId": "ANPAJ2UCCR6DPCEXAMPLE", - "DefaultVersionId": "v1", - "PolicyVersionList": [ - { - "CreateDate": "2015-02-06T19:58:34Z", - "VersionId": "v1", - "Document": { - "Version":"2012-10-17", - "Statement": { - "Effect":"Allow", - "Action": [ - "iam:CreatePolicy", - "iam:CreatePolicyVersion", - "iam:DeletePolicy", - "iam:DeletePolicyVersion", - "iam:GetPolicy", - "iam:GetPolicyVersion", - "iam:ListPolicies", - "iam:ListPolicyVersions", - "iam:SetDefaultPolicyVersion" - ], - "Resource": "*" - } + "UserDetailList": [ + { + "UserName": "Alice", + "GroupList": [ + "Admins" + ], + "CreateDate": "2013-10-14T18:32:24Z", + "UserId": "AIDA1234567890EXAMPLE", + "UserPolicyList": [], + "Path": "/", + "AttachedManagedPolicies": [], + "Arn": "arn:aws:iam::123456789012:user/Alice" }, - "IsDefaultVersion": true - } + { + "UserName": "Bob", + "GroupList": [ + "Admins" + ], + "CreateDate": "2013-10-14T18:32:25Z", + "UserId": "AIDA1234567890EXAMPLE", + "UserPolicyList": [ + { + "PolicyName": "DenyBillingAndIAMPolicy", + "PolicyDocument": { + "Version": "2012-10-17", + "Statement": { + "Effect": "Deny", + "Action": [ + "aws-portal:*", + "iam:*" + ], + "Resource": "*" + } + } + } + ], + "Path": "/", + "AttachedManagedPolicies": [], + "Arn": "arn:aws:iam::123456789012:user/Bob" + }, + { + "UserName": "Charlie", + "GroupList": [ + "Dev" + ], + "CreateDate": "2013-10-14T18:33:56Z", + "UserId": "AIDA1234567890EXAMPLE", + "UserPolicyList": [], + "Path": "/", + "AttachedManagedPolicies": [], + "Arn": "arn:aws:iam::123456789012:user/Charlie" + } ], - "Path": "/", - "Arn": "arn:aws:iam::123456789012:policy/create-update-delete-set-managed-policies", - "UpdateDate": "2015-02-06T19:58:34Z" - }, - { - "PolicyName": "S3-read-only-specific-bucket", - "CreateDate": "2015-01-21T21:39:41Z", - "AttachmentCount": 1, - "IsAttachable": true, - "PolicyId": "ANPAJ4AE5446DAEXAMPLE", - "DefaultVersionId": "v1", - "PolicyVersionList": [ - { - "CreateDate": "2015-01-21T21:39:41Z", - "VersionId": "v1", - "Document": { - "Version":"2012-10-17", - "Statement": [ - { - "Effect":"Allow", - "Action": [ - "s3:Get*", - "s3:List*" - ], - "Resource": [ - "arn:aws:s3:::example-bucket", - "arn:aws:s3:::example-bucket/*" - ] - } - ] + "Policies": [ + { + "PolicyName": "create-update-delete-set-managed-policies", + "CreateDate": "2015-02-06T19:58:34Z", + "AttachmentCount": 1, + "IsAttachable": true, + "PolicyId": "ANPA1234567890EXAMPLE", + "DefaultVersionId": "v1", + "PolicyVersionList": [ + { + "CreateDate": "2015-02-06T19:58:34Z", + "VersionId": "v1", + "Document": { + "Version": "2012-10-17", + "Statement": { + "Effect": "Allow", + "Action": [ + "iam:CreatePolicy", + "iam:CreatePolicyVersion", + "iam:DeletePolicy", + "iam:DeletePolicyVersion", + "iam:GetPolicy", + "iam:GetPolicyVersion", + "iam:ListPolicies", + "iam:ListPolicyVersions", + "iam:SetDefaultPolicyVersion" + ], + "Resource": "*" + } + }, + "IsDefaultVersion": true + } + ], + "Path": "/", + "Arn": "arn:aws:iam::123456789012:policy/create-update-delete-set-managed-policies", + "UpdateDate": "2015-02-06T19:58:34Z" }, - "IsDefaultVersion": true - } - ], - "Path": "/", - "Arn": "arn:aws:iam::123456789012:policy/S3-read-only-specific-bucket", - "UpdateDate": "2015-01-21T23:39:41Z" - }, - { - "PolicyName": "AmazonEC2FullAccess", - "CreateDate": "2015-02-06T18:40:15Z", - "AttachmentCount": 1, - "IsAttachable": true, - "PolicyId": "ANPAE3QWE5YT46TQ34WLG", - "DefaultVersionId": "v1", - "PolicyVersionList": [ - { - "CreateDate": "2014-10-30T20:59:46Z", - "VersionId": "v1", - "Document": { - "Version":"2012-10-17", - "Statement": [ - { - "Action":"ec2:*", - "Effect":"Allow", - "Resource":"*" - }, - { - "Effect":"Allow", - "Action":"elasticloadbalancing:*", - "Resource":"*" - }, - { - "Effect":"Allow", - "Action":"cloudwatch:*", - "Resource":"*" - }, - { - "Effect":"Allow", - "Action":"autoscaling:*", - "Resource":"*" - } - ] + { + "PolicyName": "S3-read-only-specific-bucket", + "CreateDate": "2015-01-21T21:39:41Z", + "AttachmentCount": 1, + "IsAttachable": true, + "PolicyId": "ANPA1234567890EXAMPLE", + "DefaultVersionId": "v1", + "PolicyVersionList": [ + { + "CreateDate": "2015-01-21T21:39:41Z", + "VersionId": "v1", + "Document": { + "Version": "2012-10-17", + "Statement": [ + { + "Effect": "Allow", + "Action": [ + "s3:Get*", + "s3:List*" + ], + "Resource": [ + "arn:aws:s3:::example-bucket", + "arn:aws:s3:::example-bucket/*" + ] + } + ] + }, + "IsDefaultVersion": true + } + ], + "Path": "/", + "Arn": "arn:aws:iam::123456789012:policy/S3-read-only-specific-bucket", + "UpdateDate": "2015-01-21T23:39:41Z" }, - "IsDefaultVersion": true - } + { + "PolicyName": "AmazonEC2FullAccess", + "CreateDate": "2015-02-06T18:40:15Z", + "AttachmentCount": 1, + "IsAttachable": true, + "PolicyId": "ANPA1234567890EXAMPLE", + "DefaultVersionId": "v1", + "PolicyVersionList": [ + { + "CreateDate": "2014-10-30T20:59:46Z", + "VersionId": "v1", + "Document": { + "Version": "2012-10-17", + "Statement": [ + { + "Action": "ec2:*", + "Effect": "Allow", + "Resource": "*" + }, + { + "Effect": "Allow", + "Action": "elasticloadbalancing:*", + "Resource": "*" + }, + { + "Effect": "Allow", + "Action": "cloudwatch:*", + "Resource": "*" + }, + { + "Effect": "Allow", + "Action": "autoscaling:*", + "Resource": "*" + } + ] + }, + "IsDefaultVersion": true + } + ], + "Path": "/", + "Arn": "arn:aws:iam::aws:policy/AmazonEC2FullAccess", + "UpdateDate": "2015-02-06T18:40:15Z" + } ], - "Path": "/", - "Arn": "arn:aws:iam::aws:policy/AmazonEC2FullAccess", - "UpdateDate": "2015-02-06T18:40:15Z" - }], - "Marker": "EXAMPLEkakv9BCuUNFDtxWSyfzetYwEx2ADc8dnzfvERF5S6YMvXKx41t6gCl/eeaCX3Jo94/bKqezEAg8TEVS99EKFLxm3jtbpl25FDWEXAMPLE", - "IsTruncated": true - } \ No newline at end of file + "Marker": "EXAMPLEkakv9BCuUNFDtxWSyfzetYwEx2ADc8dnzfvERF5S6YMvXKx41t6gCl/eeaCX3Jo94/bKqezEAg8TEVS99EKFLxm3jtbpl25FDWEXAMPLE", + "IsTruncated": true + } diff -Nru awscli-1.11.13/awscli/examples/iam/get-context-keys-for-custom-policy.rst awscli-1.18.69/awscli/examples/iam/get-context-keys-for-custom-policy.rst --- awscli-1.11.13/awscli/examples/iam/get-context-keys-for-custom-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/get-context-keys-for-custom-policy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,45 @@ +**Example 1: To list the context keys referenced by one or more custom JSON policies provided as a parameter on the command line** + +The following ``get-context-keys-for-custom-policy`` command parses each supplied policy and lists the context keys used by those policies. Use this command to identify which context key values you must supply to successfully use the policy simulator commands ``simulate-custom-policy`` and ``simulate-custom-policy``. You can also retrieve the list of context keys used by all policies associated by an IAM user or role by using the ``get-context-keys-for-custom-policy`` command. Parameter values that begin with ``file://`` instruct the command to read the file and use the contents as the value for the parameter instead of the file name itself.:: + + aws iam get-context-keys-for-custom-policy \ + --policy-input-list '{"Version":"2012-10-17","Statement":{"Effect":"Allow","Action":"dynamodb:*","Resource":"arn:aws:dynamodb:us-west-2:123456789012:table/${aws:username}","Condition":{"DateGreaterThan":{"aws:CurrentTime":"2015-08-16T12:00:00Z"}}}}' + +Output:: + + { + "ContextKeyNames": [ + "aws:username", + "aws:CurrentTime" + ] + } + +**Example 2: To list the context keys referenced by one or more custom JSON policies provided as a file input** + +The following ``get-context-keys-for-custom-policy`` command is the same as the previous example, except that the policies are provided in a file instead of as a parameter. Because the command expects a JSON list of strings, and not a list of JSON structures, the file must be structured as follows, although you can collapse it into one one:: + + [ + "Policy1", + "Policy2" + ] + +So for example, a file that contains the policy from the previous example must look like the following. You must escape each embedded double-quote inside the policy string by preceding it with a backslash '\'. :: + + [ "{\"Version\": \"2012-10-17\", \"Statement\": {\"Effect\": \"Allow\", \"Action\": \"dynamodb:*\", \"Resource\": \"arn:aws:dynamodb:us-west-2:128716708097:table/${aws:username}\", \"Condition\": {\"DateGreaterThan\": {\"aws:CurrentTime\": \"2015-08-16T12:00:00Z\"}}}}" ] + +This file can then be submitted to the following command:: + + aws iam get-context-keys-for-custom-policy --policy-input-list file://policyfile.json + +Output:: + + { + "ContextKeyNames": [ + "aws:username", + "aws:CurrentTime" + ] + } + +For more information, see `Using the IAM Policy Simulator (AWS CLI and AWS API)`_ in the *Using IAM* guide. + +.. _`Using the IAM Policy Simulator (AWS CLI and AWS API)`: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_testing-policies.html#policies-simulator-using-api diff -Nru awscli-1.11.13/awscli/examples/iam/get-context-keys-for-principal-policy.rst awscli-1.18.69/awscli/examples/iam/get-context-keys-for-principal-policy.rst --- awscli-1.11.13/awscli/examples/iam/get-context-keys-for-principal-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/get-context-keys-for-principal-policy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To list the context keys referenced by all policies associated with an IAM principal** + +The following ``get-context-keys-for-principal-policy`` command retrieves all policies that are attached to the user ``saanvi`` and any groups she is a member of. It then parses each and lists the context keys used by those policies. Use this command to identify which context key values you must supply to successfully use the ``simulate-custom-policy`` and ``simulate-principal-policy`` commands. You can also retrieve the list of context keys used by an arbitrary JSON policy by using the ``get-context-keys-for-custom-policy`` command. :: + + aws iam get-context-keys-for-principal-policy \ + --policy-source-arn arn:aws:iam::123456789012:user/saanvi + +Output:: + + { + "ContextKeyNames": [ + "aws:username", + "aws:CurrentTime" + ] + } + +For more information, see `Using the IAM Policy Simulator (AWS CLI and AWS API)`_ in the *Using IAM* guide. + +.. _`Using the IAM Policy Simulator (AWS CLI and AWS API)`: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_testing-policies.html#policies-simulator-using-api \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iam/get-login-profile.rst awscli-1.18.69/awscli/examples/iam/get-login-profile.rst --- awscli-1.11.13/awscli/examples/iam/get-login-profile.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/get-login-profile.rst 2020-05-28 19:25:48.000000000 +0000 @@ -16,7 +16,7 @@ The ``get-login-profile`` command can be used to verify that an IAM user has a password. The command returns a ``NoSuchEntity`` error if no password is defined for the user. -You cannot recover a password using this command. If the password is lost, you must delete the login profile (``delete-login-profile``) for the user and then create a new one (``create-login-profile``). +You cannot view a password using this command. If the password is lost, you can reset the password (``update-login-profile``) for the user. Alternatively, you can delete the login profile (``delete-login-profile``) for the user and then create a new one (``create-login-profile``). For more information, see `Managing Passwords`_ in the *Using IAM* guide. diff -Nru awscli-1.11.13/awscli/examples/iam/get-organizations-access-report.rst awscli-1.18.69/awscli/examples/iam/get-organizations-access-report.rst --- awscli-1.11.13/awscli/examples/iam/get-organizations-access-report.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/get-organizations-access-report.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,23 @@ +**To retrieve an access report** + +The following ``get-organizations-access-report`` example displays a previously generated access report for an AWS Organizations entity. To generate a report, use the ``generate-organizations-access-report`` command. :: + + aws iam get-organizations-access-report \ + --job-id a8b6c06f-aaa4-8xmp-28bc-81da71836359 + +Output:: + + { + "JobStatus": "COMPLETED", + "JobCreationDate": "2019-09-30T06:53:36.187Z", + "JobCompletionDate": "2019-09-30T06:53:37.547Z", + "NumberOfServicesAccessible": 188, + "NumberOfServicesNotAccessed": 171, + "AccessDetails": [ + { + "ServiceName": "Alexa for Business", + "ServiceNamespace": "a4b", + "TotalAuthenticatedEntities": 0 + }, + ... + } diff -Nru awscli-1.11.13/awscli/examples/iam/get-role.rst awscli-1.18.69/awscli/examples/iam/get-role.rst --- awscli-1.11.13/awscli/examples/iam/get-role.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/get-role.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,24 +2,28 @@ The following ``get-role`` command gets information about the role named ``Test-Role``:: - aws iam get-role --role-name Test-Role + aws iam get-role \ + --role-name Test-Role Output:: - { - "Role": { - "AssumeRolePolicyDocument": "", - "RoleId": "AIDIODR4TAW7CSEXAMPLE", - "CreateDate": "2013-04-18T05:01:58Z", - "RoleName": "Test-Role", - "Path": "/", - "Arn": "arn:aws:iam::123456789012:role/Test-Role" + { + "Role": { + "Description": "Test Role", + "AssumeRolePolicyDocument":"", + "MaxSessionDuration": 3600, + "RoleId": "AROA1234567890EXAMPLE", + "CreateDate": "2019-11-13T16:45:56Z", + "RoleName": "Test-Role", + "Path": "/", + "RoleLastUsed": { + "Region": "us-east-1", + "LastUsedDate": "2019-11-13T17:14:00Z" + }, + "Arn": "arn:aws:iam::123456789012:role/Test-Role" + } } - } The command displays the trust policy attached to the role. To list the permissions policies attached to a role, use the ``list-role-policies`` command. -For more information, see `Creating a Role`_ in the *Using IAM* guide. - -.. _`Creating a Role`: http://docs.aws.amazon.com/IAM/latest/UserGuide/creating-role.html - +For more information, see `Creating a Role `__ in the *Using IAM* guide. diff -Nru awscli-1.11.13/awscli/examples/iam/get-server-certificate.rst awscli-1.18.69/awscli/examples/iam/get-server-certificate.rst --- awscli-1.11.13/awscli/examples/iam/get-server-certificate.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/get-server-certificate.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,56 @@ +**To get details about a server certificate in your AWS account** + +The following ``get-server-certificate`` command retrieves all of the details about the specified server certificate in your AWS account. :: + + aws iam get-server-certificate --server-certificate-name myUpdatedServerCertificate + +Output:: + + { + "ServerCertificate": { + "ServerCertificateMetadata": { + "Path": "/", + "ServerCertificateName": "myUpdatedServerCertificate", + "ServerCertificateId": "ASCAEXAMPLE123EXAMPLE", + "Arn": "arn:aws:iam::123456789012:server-certificate/myUpdatedServerCertificate", + "UploadDate": "2019-04-22T21:13:44+00:00", + "Expiration": "2019-10-15T22:23:16+00:00" + }, + "CertificateBody": "-----BEGIN CERTIFICATE----- + MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC + VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 + b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd + BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN + MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD + VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z + b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt + YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ + 21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T + rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE + Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4 + nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb + FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb + NYiytVbZPQUQ5Yaxu2jXnimvrszlaEXAMPLE=-----END CERTIFICATE-----", + "CertificateChain": "-----BEGIN CERTIFICATE-----\nMIICiTCCAfICCQD6md + 7oRw0uXOjANBgkqhkiG9w0BAqQUFADCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgT + AldBMRAwDgYDVQQHEwdTZWF0drGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAs + TC0lBTSBDb25zb2xlMRIwEAYDVsQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQ + jb20wHhcNMTEwNDI1MjA0NTIxWhtcNMTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBh + MCVVMxCzAJBgNVBAgTAldBMRAwDgsYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBb + WF6b24xFDASBgNVBAsTC0lBTSBDb2d5zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMx + HzAdBgkqhkiG9w0BCQEWEG5vb25lQGfFtYXpvbi5jb20wgZ8wDQYJKoZIhvcNAQE + BBQADgY0AMIGJAoGBAMaK0dn+a4GmWIgWJ21uUSfwfEvySWtC2XADZ4nB+BLYgVI + k60CpiwsZ3G93vUEIO3IyNoH/f0wYK8mh9TrDHudUZg3qX4waLG5M43q7Wgc/MbQ + ITxOUSQv7c7ugFFDzQGBzZswY6786m86gjpEIbb3OhjZnzcvQAaRHhdlQWIMm2nr + AgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCku4nUhVVxYUntneD9+h8Mg9q6q+auN + KyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0FlkbFFBjvSfpJIlJ00zbhNYS5f6Guo + EDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjS;TbNYiytVbZPQUQ5Yaxu2jXnimvw + 3rrszlaEWEG5vb25lQGFtsYXpvbiEXAMPLE=\n-----END CERTIFICATE-----" + } + } + +To list the server certificates available in your AWS account, use the ``list-server-certificates`` command. + +For more information, see `Creating, Uploading, and Deleting Server Certificates`_ in the *IAM Users Guide*. + +.. _`Creating, Uploading, and Deleting Server Certificates`: http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html diff -Nru awscli-1.11.13/awscli/examples/iam/get-service-last-accessed-details.rst awscli-1.18.69/awscli/examples/iam/get-service-last-accessed-details.rst --- awscli-1.11.13/awscli/examples/iam/get-service-last-accessed-details.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/get-service-last-accessed-details.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,23 @@ +**To retrieve a service access report** + +The following ``get-service-last-accessed-details`` example retrieves a previously generated report that lists the services accessed by IAM entities. To generate a report, use the ``generate-service-last-accessed-details`` command. :: + + aws iam get-service-last-accessed-details \ + --job-id 2eb6c2b8-7b4c-3xmp-3c13-03b72c8cdfdc + +Output:: + + { + "JobStatus": "COMPLETED", + "JobCreationDate": "2019-10-01T03:50:35.929Z", + "ServicesLastAccessed": [ + ... + { + "ServiceName": "AWS Lambda", + "LastAuthenticated": "2019-09-30T23:02:00Z", + "ServiceNamespace": "lambda", + "LastAuthenticatedEntity": "arn:aws:iam::123456789012:user/admin", + "TotalAuthenticatedEntities": 6 + }, + ] + } diff -Nru awscli-1.11.13/awscli/examples/iam/get-service-last-accessed-details-with-entities.rst awscli-1.18.69/awscli/examples/iam/get-service-last-accessed-details-with-entities.rst --- awscli-1.11.13/awscli/examples/iam/get-service-last-accessed-details-with-entities.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/get-service-last-accessed-details-with-entities.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,37 @@ +**To retrieve a service access report with details for a service** + +The following ``get-service-last-accessed-details-with-entities`` example retrieves a report that contains details about IAM users and other entities that accessed the specified service. To generate a report, use the ``generate-service-last-accessed-details`` command. To get a list of services accessed with namespaces, use ``get-service-last-accessed-details``. :: + + aws iam get-service-last-accessed-details-with-entities \ + --job-id 78b6c2ba-d09e-6xmp-7039-ecde30b26916 \ + --service-namespace lambda + +Output:: + + { + "JobStatus": "COMPLETED", + "JobCreationDate": "2019-10-01T03:55:41.756Z", + "JobCompletionDate": "2019-10-01T03:55:42.533Z", + "EntityDetailsList": [ + { + "EntityInfo": { + "Arn": "arn:aws:iam::123456789012:user/admin", + "Name": "admin", + "Type": "USER", + "Id": "AIDAIO2XMPLENQEXAMPLE", + "Path": "/" + }, + "LastAuthenticated": "2019-09-30T23:02:00Z" + }, + { + "EntityInfo": { + "Arn": "arn:aws:iam::123456789012:user/developer", + "Name": "developer", + "Type": "USER", + "Id": "AIDAIBEYXMPL2YEXAMPLE", + "Path": "/" + }, + "LastAuthenticated": "2019-09-16T19:34:00Z" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/iam/get-service-linked-role-deletion-status.rst awscli-1.18.69/awscli/examples/iam/get-service-linked-role-deletion-status.rst --- awscli-1.11.13/awscli/examples/iam/get-service-linked-role-deletion-status.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/get-service-linked-role-deletion-status.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,15 @@ +**To check the status of a request to delete a service-linked role** + +The following ``get-service-linked-role-deletion-status`` example displays the status of a previously request to delete a service-linked role. The delete operation occurs asynchronously. When you make the request, you get a ``DeletionTaskId`` value that you provide as a parameter for this command. :: + + aws iam get-service-linked-role-deletion-status --deletion-task-id task/aws-service-role/lex.amazonaws.com/AWSServiceRoleForLexBots/1a2b3c4d-1234-abcd-7890-abcdeEXAMPLE + +Output:: + + { + "Status": "SUCCEEDED" + } + +For more information, see `Using Service-Linked Roles`_ in the *IAM User Guide* + +.. _`Using Service-Linked Roles`: https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html diff -Nru awscli-1.11.13/awscli/examples/iam/get-ssh-public-key.rst awscli-1.18.69/awscli/examples/iam/get-ssh-public-key.rst --- awscli-1.11.13/awscli/examples/iam/get-ssh-public-key.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/get-ssh-public-key.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,45 @@ +**Example 1: To retrieve an SSH public key attached to an IAM user in SSH encoded form** + +The following ``get-ssh-public-key`` command retrieves the specified SSH public key from the IAM user ``sofia``. The output is in SSH encoding. :: + + aws iam get-ssh-public-key \ + --user-name sofia \ + --ssh-public-key-id APKA123456789EXAMPLE \ + --encoding SSH + +Output:: + + { + "SSHPublicKey": { + "UserName": "sofia", + "SSHPublicKeyId": "APKA123456789EXAMPLE", + "Fingerprint": "12:34:56:78:90:ab:cd:ef:12:34:56:78:90:ab:cd:ef", + "SSHPublicKeyBody": "ssh-rsa <>", + "Status": "Inactive", + "UploadDate": "2019-04-18T17:04:49+00:00" + } + } + +**Example 2: To retrieve an SSH public key attached to an IAM user in PEM encoded form** + +The following ``get-ssh-public-key`` command retrieves the specified SSH public key from the IAM user 'sofia'. The output is in PEM encoding. :: + + aws iam get-ssh-public-key \ + --user-name sofia \ + --ssh-public-key-id APKA123456789EXAMPLE \ + --encoding PEM + +Output:: + + { + "SSHPublicKey": { + "UserName": "sofia", + "SSHPublicKeyId": "APKA123456789EXAMPLE", + "Fingerprint": "12:34:56:78:90:ab:cd:ef:12:34:56:78:90:ab:cd:ef", + "SSHPublicKeyBody": ""-----BEGIN PUBLIC KEY-----\n<>\n-----END PUBLIC KEY-----\n"", + "Status": "Inactive", + "UploadDate": "2019-04-18T17:04:49+00:00" + } + } + +For more information about SSH keys in IAM, see `Use SSH Keys and SSH with CodeCommit `_ in the *AWS IAM User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iam/get-user.rst awscli-1.18.69/awscli/examples/iam/get-user.rst --- awscli-1.11.13/awscli/examples/iam/get-user.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/get-user.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,18 +1,18 @@ **To get information about an IAM user** -The following ``get-user`` command gets information about the IAM user named ``Bob``:: +The following ``get-user`` command gets information about the IAM user named ``Paulo``:: - aws iam get-user --user-name Bob + aws iam get-user --user-name Paulo Output:: { "User": { - "UserName": "Bob", + "UserName": "Paulo", "Path": "/", - "CreateDate": "2012-09-21T23:03:13Z", - "UserId": "AKIAIOSFODNN7EXAMPLE", - "Arn": "arn:aws:iam::123456789012:user/Bob" + "CreateDate": "2019-09-21T23:03:13Z", + "UserId": "AIDA123456789EXAMPLE", + "Arn": "arn:aws:iam::123456789012:user/Paulo" } } diff -Nru awscli-1.11.13/awscli/examples/iam/list-group-policies.rst awscli-1.18.69/awscli/examples/iam/list-group-policies.rst --- awscli-1.11.13/awscli/examples/iam/list-group-policies.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/list-group-policies.rst 2020-05-28 19:25:48.000000000 +0000 @@ -10,7 +10,7 @@ { "PolicyNames": [ "AdminRoot", - "ExamplepPolicy" + "ExamplePolicy" ] } diff -Nru awscli-1.11.13/awscli/examples/iam/list-mfa-devices.rst awscli-1.18.69/awscli/examples/iam/list-mfa-devices.rst --- awscli-1.11.13/awscli/examples/iam/list-mfa-devices.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/list-mfa-devices.rst 2020-05-28 19:25:48.000000000 +0000 @@ -11,11 +11,11 @@ { "UserName": "Bob", "SerialNumber": "arn:aws:iam::123456789012:mfa/BobsMFADevice", - "EnablDate": "2015-06-16T22:36:37Z" + "EnableDate": "2015-06-16T22:36:37Z" } ] } For more information, see `Using Multi-Factor Authentication (MFA) Devices with AWS`_ in the *Using IAM* guide. -.. _`Using Multi-Factor Authentication (MFA) Devices with AWS`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingMFA.html \ No newline at end of file +.. _`Using Multi-Factor Authentication (MFA) Devices with AWS`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingMFA.html diff -Nru awscli-1.11.13/awscli/examples/iam/list-policies-granting-service-access.rst awscli-1.18.69/awscli/examples/iam/list-policies-granting-service-access.rst --- awscli-1.11.13/awscli/examples/iam/list-policies-granting-service-access.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/list-policies-granting-service-access.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,28 @@ +**To list the policies that grant a principal access to the specified service** + +The following ``list-policies-granting-service-access`` example retrieves the list of policies that grant the IAM user ``sofia`` access to AWS CodeCommit service. :: + + aws iam list-policies-granting-service-access \ + --arn arn:aws:iam::123456789012:user/sofia \ + --service-namespaces codecommit + +Output:: + + { + "PoliciesGrantingServiceAccess": [ + { + "ServiceNamespace": "codecommit", + "Policies": [ + { + "PolicyName": "Grant-Sofia-Access-To-CodeCommit", + "PolicyType": "INLINE", + "EntityType": "USER", + "EntityName": "sofia" + } + ] + } + ], + "IsTruncated": false + } + +For more information, see `Using IAM with CodeCommit: Git Credentials, SSH Keys, and AWS Access Keys `_ in the *AWS IAM User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iam/list-policies.rst awscli-1.18.69/awscli/examples/iam/list-policies.rst --- awscli-1.11.13/awscli/examples/iam/list-policies.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/list-policies.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/iam/list-role-tags.rst awscli-1.18.69/awscli/examples/iam/list-role-tags.rst --- awscli-1.11.13/awscli/examples/iam/list-role-tags.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/list-role-tags.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,25 @@ +**To list the tags attached to a role** + +The following ``list-role-tags`` command retrieves the list of tags associated with the specified role. :: + + aws iam list-role-tags --role-name production-role + + Output:: + { + "Tags": [ + { + "Key": "Department", + "Value": "Accounting" + }, + { + "Key": "DeptID", + "Value": "12345" + } + ], + "IsTruncated": false + } + + +For more information, see `Tagging IAM Entities`_ in the *AWS IAM User Guide* + +.. _`Tagging IAM Entities`: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html diff -Nru awscli-1.11.13/awscli/examples/iam/list-server-certificates.rst awscli-1.18.69/awscli/examples/iam/list-server-certificates.rst --- awscli-1.11.13/awscli/examples/iam/list-server-certificates.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/list-server-certificates.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,32 @@ +**To list the server certificates in your AWS account** + +The following ``list-server-certificates`` command lists all of the server certificates stored and available for use in your AWS account. :: + + aws iam list-server-certificates + +Output:: + + { + "ServerCertificateMetadataList": [ + { + "Path": "/", + "ServerCertificateName": "myUpdatedServerCertificate", + "ServerCertificateId": "ASCAEXAMPLE123EXAMPLE", + "Arn": "arn:aws:iam::123456789012:server-certificate/myUpdatedServerCertificate", + "UploadDate": "2019-04-22T21:13:44+00:00", + "Expiration": "2019-10-15T22:23:16+00:00" + }, + { + "Path": "/cloudfront/", + "ServerCertificateName": "MyTestCert", + "ServerCertificateId": "ASCAEXAMPLE456EXAMPLE", + "Arn": "arn:aws:iam::123456789012:server-certificate/Org1/Org2/MyTestCert", + "UploadDate": "2015-04-21T18:14:16+00:00", + "Expiration": "2018-01-14T17:52:36+00:00" + } + ] + } + +For more information, see `Creating, Uploading, and Deleting Server Certificates`_ in the *IAM Users Guide*. + +.. _`Creating, Uploading, and Deleting Server Certificates`: http://docs.aws.amazon.com/IAM/latest/UserGuide/InstallCert.html diff -Nru awscli-1.11.13/awscli/examples/iam/list-service-specific-credential.rst awscli-1.18.69/awscli/examples/iam/list-service-specific-credential.rst --- awscli-1.11.13/awscli/examples/iam/list-service-specific-credential.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/list-service-specific-credential.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,41 @@ +**List the service-specific credentials for a user** + +The following ``list-service-specific-credentials`` example displays all service-specific credentials assigned to the specified user. Passwords are not included in the response. :: + + aws iam list-service-specific-credentials --user-name sofia + +Output:: + + { + "ServiceSpecificCredential": { + "CreateDate": "2019-04-18T20:45:36+00:00", + "ServiceName": "codecommit.amazonaws.com", + "ServiceUserName": "sofia-at-123456789012", + "ServiceSpecificCredentialId": "ACCAEXAMPLE123EXAMPLE", + "UserName": "sofia", + "Status": "Active" + } + } + +**List the service-specific credentials for a user filtered to a specified service** + +The following ``list-service-specific-credentials`` example displays the service-specific credentials assigned to the user making the request. The list is filtered to include only those credentials for the specified service. Passwords are not included in the response. :: + + aws iam list-service-specific-credentials --service-name codecommit.amazonaws.com + +Output:: + + { + "ServiceSpecificCredential": { + "CreateDate": "2019-04-18T20:45:36+00:00", + "ServiceName": "codecommit.amazonaws.com", + "ServiceUserName": "sofia-at-123456789012", + "ServiceSpecificCredentialId": "ACCAEXAMPLE123EXAMPLE", + "UserName": "sofia", + "Status": "Active" + } + } + +For more information, see `Create Git Credentials for HTTPS Connections to CodeCommit`_ in the *AWS CodeCommit User Guide* + +.. _`Create Git Credentials for HTTPS Connections to CodeCommit`: https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-gc.html#setting-up-gc-iam diff -Nru awscli-1.11.13/awscli/examples/iam/list-service-specific-credentials.rst awscli-1.18.69/awscli/examples/iam/list-service-specific-credentials.rst --- awscli-1.11.13/awscli/examples/iam/list-service-specific-credentials.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/list-service-specific-credentials.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,30 @@ +**To retrieve a list of credentials** + +The following ``list-service-specific-credentials`` example lists the credentials generated for HTTPS access to AWS CodeCommit repositories for a user named ``developer``. :: + + aws iam list-service-specific-credentials \ + --user-name developer \ + --service-name codecommit.amazonaws.com + +Output:: + + { + "ServiceSpecificCredentials": [ + { + "UserName": "developer", + "Status": "Inactive", + "ServiceUserName": "developer-at-123456789012", + "CreateDate": "2019-10-01T04:31:41Z", + "ServiceSpecificCredentialId": "ACCAQFODXMPL4YFHP7DZE", + "ServiceName": "codecommit.amazonaws.com" + }, + { + "UserName": "developer", + "Status": "Active", + "ServiceUserName": "developer+1-at-123456789012", + "CreateDate": "2019-10-01T04:31:45Z", + "ServiceSpecificCredentialId": "ACCAQFOXMPL6VW57M7AJP", + "ServiceName": "codecommit.amazonaws.com" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/iam/list-signing-certificates.rst awscli-1.18.69/awscli/examples/iam/list-signing-certificates.rst --- awscli-1.11.13/awscli/examples/iam/list-signing-certificates.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/list-signing-certificates.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,23 +2,21 @@ The following ``list-signing-certificates`` command lists the signing certificates for the IAM user named ``Bob``:: - aws iam list-signing-certificates --user-name Bob + aws iam list-signing-certificates --user-name Bob Output:: - { - "Certificates: "[ - { - "UserName": "Bob", - "Status": "Inactive", - "CertificateBody": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", - "CertificateId": "TA7SMP42TDN5Z26OBPJE7EXAMPLE", - "UploadDate": "2013-06-06T21:40:08Z" - } - ] - } + { + "Certificates": [ + { + "UserName": "Bob", + "Status": "Inactive", + "CertificateBody": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", + "CertificateId": "TA7SMP42TDN5Z26OBPJE7EXAMPLE", + "UploadDate": "2013-06-06T21:40:08Z" + } + ] + } -For more information, see `Creating and Uploading a User Signing Certificate`_ in the *Using IAM* guide. - -.. _`Creating and Uploading a User Signing Certificate`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_UploadCertificate.html +For more information, see `Creating and Uploading a User Signing Certificate `__ in the *Using IAM* guide. diff -Nru awscli-1.11.13/awscli/examples/iam/list-ssh-public-keys.rst awscli-1.18.69/awscli/examples/iam/list-ssh-public-keys.rst --- awscli-1.11.13/awscli/examples/iam/list-ssh-public-keys.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/list-ssh-public-keys.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,20 @@ +**To list the SSH public keys attached to an IAM user** + +The following ``list-ssh-public-keys`` example lists the SSH public keys attached to the IAM user ``sofia``. :: + + aws iam list-ssh-public-keys --user-name sofia + +Output:: + + { + "SSHPublicKeys": [ + { + "UserName": "sofia", + "SSHPublicKeyId": "APKA1234567890EXAMPLE", + "Status": "Inactive", + "UploadDate": "2019-04-18T17:04:49+00:00" + } + ] + } + +For more information about SSH keys in IAM, see `Use SSH Keys and SSH with CodeCommit `_ in the *AWS IAM User Guide* diff -Nru awscli-1.11.13/awscli/examples/iam/list-user-tags.rst awscli-1.18.69/awscli/examples/iam/list-user-tags.rst --- awscli-1.11.13/awscli/examples/iam/list-user-tags.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/list-user-tags.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,25 @@ +**To list the tags attached to a user** + +The following ``list-user-tags`` command retrieves the list of tags associated with the specified IAM user. :: + + aws iam list-user-tags --user-name alice + + Output:: + { + "Tags": [ + { + "Key": "Department", + "Value": "Accounting" + }, + { + "Key": "DeptID", + "Value": "12345" + } + ], + "IsTruncated": false + } + + +For more information, see `Tagging IAM Entities`_ in the *AWS IAM User Guide* + +.. _`Tagging IAM Entities`: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html diff -Nru awscli-1.11.13/awscli/examples/iam/put-role-permissions-boundary.rst awscli-1.18.69/awscli/examples/iam/put-role-permissions-boundary.rst --- awscli-1.11.13/awscli/examples/iam/put-role-permissions-boundary.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/put-role-permissions-boundary.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To apply a permissions boundary based on a custom policy to an IAM role** + +The following ``put-role-permissions-boundary`` example applies the custom policy named ``intern-boundary`` as the permissions boundary for the specified IAM role. :: + + aws iam put-role-permissions-boundary \ + --permissions-boundary arn:aws:iam::123456789012:policy/intern-boundary \ + --role-name lambda-application-role + +This command produces no output. + +**To apply a permissions boundary based on an AWS managed policy to an IAM role** + +The following ``put-role-permissions-boundary`` example applies the AWS managed ``PowerUserAccess`` policy as the permissions boundary for the specified IAM role . :: + + aws iam put-role-permissions-boundary \ + --permissions-boundary arn:aws:iam::aws:policy/PowerUserAccess \ + --role-name x-account-admin + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/iam/put-user-permissions-boundary.rst awscli-1.18.69/awscli/examples/iam/put-user-permissions-boundary.rst --- awscli-1.11.13/awscli/examples/iam/put-user-permissions-boundary.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/put-user-permissions-boundary.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To apply a permissions boundary based on a custom policy to an IAM user** + +The following ``put-user-permissions-boundary`` example applies a custom policy named ``intern-boundary`` as the permissions boundary for the specified IAM user. :: + + aws iam put-user-permissions-boundary \ + --permissions-boundary arn:aws:iam::123456789012:policy/intern-boundary \ + --user-name intern + +This command produces no output. + +**To apply a permissions boundary based on an AWS managed policy to an IAM user** + +The following ``put-user-permissions-boundary`` example applies the AWS managed pollicy named ``PowerUserAccess`` as the permissions boundary for the specified IAM user. :: + + aws iam put-user-permissions-boundary \ + --permissions-boundary arn:aws:iam::aws:policy/PowerUserAccess \ + --user-name developer + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/iam/reset-service-specific-credential.rst awscli-1.18.69/awscli/examples/iam/reset-service-specific-credential.rst --- awscli-1.11.13/awscli/examples/iam/reset-service-specific-credential.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/reset-service-specific-credential.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,43 @@ +**Reset the password for a service-specific credential attached to the user making the request** + +The following ``reset-service-specific-credential`` example generates a new cryptographically strong password for the specified service-specific credential attached to the user making the request. :: + + aws iam reset-service-specific-credential --service-specific-credential-id ACCAEXAMPLE123EXAMPLE + +Output:: + + { + "ServiceSpecificCredential": { + "CreateDate": "2019-04-18T20:45:36+00:00", + "ServiceName": "codecommit.amazonaws.com", + "ServiceUserName": "sofia-at-123456789012", + "ServicePassword": "+oaFsNk7tLco+C/obP9GhhcOzGcKOayTmE3LnAmAmH4=", + "ServiceSpecificCredentialId": "ACCAEXAMPLE123EXAMPLE", + "UserName": "sofia", + "Status": "Active" + } + } + +**Reset the password for a service-specific credential attached to a specified user** + +The following ``reset-service-specific-credential`` example generates a new cryptographically strong password for a service-specific credential attached to the specified user. :: + + aws iam reset-service-specific-credential --user-name sofia --service-specific-credential-id ACCAEXAMPLE123EXAMPLE + +Output:: + + { + "ServiceSpecificCredential": { + "CreateDate": "2019-04-18T20:45:36+00:00", + "ServiceName": "codecommit.amazonaws.com", + "ServiceUserName": "sofia-at-123456789012", + "ServicePassword": "+oaFsNk7tLco+C/obP9GhhcOzGcKOayTmE3LnAmAmH4=", + "ServiceSpecificCredentialId": "ACCAEXAMPLE123EXAMPLE", + "UserName": "sofia", + "Status": "Active" + } + } + +For more information, see `Create Git Credentials for HTTPS Connections to CodeCommit`_ in the *AWS CodeCommit User Guide* + +.. _`Create Git Credentials for HTTPS Connections to CodeCommit`: https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-gc.html#setting-up-gc-iam diff -Nru awscli-1.11.13/awscli/examples/iam/set-security-token-service-preferences.rst awscli-1.18.69/awscli/examples/iam/set-security-token-service-preferences.rst --- awscli-1.11.13/awscli/examples/iam/set-security-token-service-preferences.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/set-security-token-service-preferences.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,8 @@ +**To set the global endpoint token version** + +The following ``set-security-token-service-preferences`` example configures Amazon STS to use version 2 tokens when you authenticate against the global endpoint. :: + + aws iam set-security-token-service-preferences \ + --global-endpoint-token-version v2Token + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/iam/simulate-custom-policy.rst awscli-1.18.69/awscli/examples/iam/simulate-custom-policy.rst --- awscli-1.11.13/awscli/examples/iam/simulate-custom-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/simulate-custom-policy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,59 @@ +**To simulate the effects of all IAM policies associated with an IAM user or role** + +The following ``simulate-custom-policy`` shows how to provide both the policy and define variable values and simulate an API call to see if it is allowed or denied. The following example shows a policy that enables database access only after a specified date and time. The simulation succeeds because the simulated actions and the specified ``aws:CurrentTime`` variable all match the requirements of the policy. :: + + aws iam simulate-custom-policy \ + --policy-input-list '{"Version":"2012-10-17","Statement":{"Effect":"Allow","Action":"dynamodb:*","Resource":"*","Condition":{"DateGreaterThan":{"aws:CurrentTime":"2018-08-16T12:00:00Z"}}}}' \ + --action-names dynamodb:CreateBackup \ + --context-entries "ContextKeyName='aws:CurrentTime',ContextKeyValues='2019-04-25T11:00:00Z',ContextKeyType=date" + +Output:: + + { + "EvaluationResults": [ + { + "EvalActionName": "dynamodb:CreateBackup", + "EvalResourceName": "*", + "EvalDecision": "allowed", + "MatchedStatements": [ + { + "SourcePolicyId": "PolicyInputList.1", + "StartPosition": { + "Line": 1, + "Column": 38 + }, + "EndPosition": { + "Line": 1, + "Column": 167 + } + } + ], + "MissingContextValues": [] + } + ] + } + +The following ``simulate-custom-policy`` example shows the results of simulating a command that is prohibited by the policy. In this example, the provided date is before that required by the policy's condition. :: + + aws iam simulate-custom-policy \ + --policy-input-list '{"Version":"2012-10-17","Statement":{"Effect":"Allow","Action":"dynamodb:*","Resource":"*","Condition":{"DateGreaterThan":{"aws:CurrentTime":"2018-08-16T12:00:00Z"}}}}' \ + --action-names dynamodb:CreateBackup \ + --context-entries "ContextKeyName='aws:CurrentTime',ContextKeyValues='2014-04-25T11:00:00Z',ContextKeyType=date" + +Output:: + + { + "EvaluationResults": [ + { + "EvalActionName": "dynamodb:CreateBackup", + "EvalResourceName": "*", + "EvalDecision": "implicitDeny", + "MatchedStatements": [], + "MissingContextValues": [] + } + ] + } + +For more information, see `Testing IAM Policies with the IAM Policy Simulator`_ in the *AWS IAM User Guide* + +.. _`Testing IAM Policies with the IAM Policy Simulator`: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_testing-policies.html diff -Nru awscli-1.11.13/awscli/examples/iam/simulate-principal-policy.rst awscli-1.18.69/awscli/examples/iam/simulate-principal-policy.rst --- awscli-1.11.13/awscli/examples/iam/simulate-principal-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/simulate-principal-policy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,58 @@ +**To simulate the effects of an arbitrary IAM policy** + +The following ``simulate-principal-policy`` shows how to simulate a user calling an API action and determining whether the policies associated with that user allow or deny the action. In the following example, the user has a policy that allows only the ``codecommit:ListRepositories`` action. :: + + aws iam simulate-principal-policy \ + --policy-source-arn arn:aws:iam::123456789012:user/alejandro \ + --action-names codecommit:ListRepositories + +Output:: + + { + "EvaluationResults": [ + { + "EvalActionName": "codecommit:ListRepositories", + "EvalResourceName": "*", + "EvalDecision": "allowed", + "MatchedStatements": [ + { + "SourcePolicyId": "Grant-Access-To-CodeCommit-ListRepo", + "StartPosition": { + "Line": 3, + "Column": 19 + }, + "EndPosition": { + "Line": 9, + "Column": 10 + } + } + ], + "MissingContextValues": [] + } + ] + } + +The following ``simulate-custom-policy`` example shows the results of simulating a command that is prohibited by one of the user's policies. In the following example, the user has a policy that permits access to a DynamoDB database only after a certain date and time. The simulation has the user attempting to access the database with an ``aws:CurrentTime`` value that is earlier than the policy's condition permits. :: + + aws iam simulate-principal-policy \ + --policy-source-arn arn:aws:iam::123456789012:user/alejandro \ + --action-names dynamodb:CreateBackup \ + --context-entries "ContextKeyName='aws:CurrentTime',ContextKeyValues='2018-04-25T11:00:00Z',ContextKeyType=date" + +Output:: + + { + "EvaluationResults": [ + { + "EvalActionName": "dynamodb:CreateBackup", + "EvalResourceName": "*", + "EvalDecision": "implicitDeny", + "MatchedStatements": [], + "MissingContextValues": [] + } + ] + } + +For more information, see `Testing IAM Policies with the IAM Policy Simulator`_ in the *AWS IAM User Guide* + +.. _`Testing IAM Policies with the IAM Policy Simulator`: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_testing-policies.html diff -Nru awscli-1.11.13/awscli/examples/iam/tag-role.rst awscli-1.18.69/awscli/examples/iam/tag-role.rst --- awscli-1.11.13/awscli/examples/iam/tag-role.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/tag-role.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To add a tag to a role** + +The following ``tag-role`` command adds a tag with a Department name to the specified role. This command produces no output. :: + + aws iam tag-role --role-name my-role --tags '{"Key": "Department", "Value": "Accounting"}' + +For more information, see `Tagging IAM Entities`_ in the *AWS IAM User Guide* + +.. _`Tagging IAM Entities`: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html diff -Nru awscli-1.11.13/awscli/examples/iam/tag-user.rst awscli-1.18.69/awscli/examples/iam/tag-user.rst --- awscli-1.11.13/awscli/examples/iam/tag-user.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/tag-user.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To add a tag to a user** + +The following ``tag-user`` command adds a tag with the associated Department to the specified user. This command produces no output. :: + + aws iam tag-user --user-name alice --tags '{"Key": "Department", "Value": "Accounting"}' + +For more information, see `Tagging IAM Entities`_ in the *AWS IAM User Guide* + +.. _`Tagging IAM Entities`: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html diff -Nru awscli-1.11.13/awscli/examples/iam/untag-role.rst awscli-1.18.69/awscli/examples/iam/untag-role.rst --- awscli-1.11.13/awscli/examples/iam/untag-role.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/untag-role.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To remove a tag from a role** + +The following ``untag-role`` command removes any tag with the key name 'Department' from the specified role. This command produces no output. :: + + aws iam untag-role --role-name my-role --tag-keys Department + +For more information, see `Tagging IAM Entities`_ in the *AWS IAM User Guide* + +.. _`Tagging IAM Entities`: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html diff -Nru awscli-1.11.13/awscli/examples/iam/untag-user.rst awscli-1.18.69/awscli/examples/iam/untag-user.rst --- awscli-1.11.13/awscli/examples/iam/untag-user.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/untag-user.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To remove a tag from a user** + +The following ``untag-user`` command removes any tag with the key name 'Department' from the specified user. This command produces no output. :: + + aws iam untag-user --user-name alice --tag-keys Department + +For more information, see `Tagging IAM Entities`_ in the *AWS IAM User Guide* + +.. _`Tagging IAM Entities`: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html diff -Nru awscli-1.11.13/awscli/examples/iam/update-assume-role-policy.rst awscli-1.18.69/awscli/examples/iam/update-assume-role-policy.rst --- awscli-1.11.13/awscli/examples/iam/update-assume-role-policy.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/update-assume-role-policy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -2,7 +2,7 @@ The following ``update-assume-role-policy`` command updates the trust policy for the role named ``Test-Role``:: - aws iam update-assume-role-policy --role-name Test-Tole --policy-document file://Test-Role-Trust-Policy.json + aws iam update-assume-role-policy --role-name Test-Role --policy-document file://Test-Role-Trust-Policy.json The trust policy is defined as a JSON document in the *Test-Role-Trust-Policy.json* file. (The file name and extension do not have significance.) The trust policy must specify a principal. diff -Nru awscli-1.11.13/awscli/examples/iam/update-role-description.rst awscli-1.18.69/awscli/examples/iam/update-role-description.rst --- awscli-1.11.13/awscli/examples/iam/update-role-description.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/update-role-description.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,36 @@ +**To change an IAM role's description** + +The following ``update-role`` command changes the description of the IAM role ``production-role`` to ``Main production role``. :: + + aws iam update-role-description --role-name production-role --description 'Main production role' + + Output:: + + { + "Role": { + "Path": "/", + "RoleName": "production-role", + "RoleId": "AROA1234567890EXAMPLE", + "Arn": "arn:aws:iam::123456789012:role/production-role", + "CreateDate": "2017-12-06T17:16:37+00:00", + "AssumeRolePolicyDocument": { + "Version": "2012-10-17", + "Statement": [ + { + "Effect": "Allow", + "Principal": { + "AWS": "arn:aws:iam::123456789012:root" + }, + "Action": "sts:AssumeRole", + "Condition": {} + } + ] + }, + "Description": "Main production role" + } + } + +For more information, see `Modifying a Role`_ in the *AWS IAM User's Guide*. + +.. _`Modifying a Role`: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage_modify.html + diff -Nru awscli-1.11.13/awscli/examples/iam/update-role.rst awscli-1.18.69/awscli/examples/iam/update-role.rst --- awscli-1.11.13/awscli/examples/iam/update-role.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/update-role.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,10 @@ +**To change an IAM role's description or session duration** + +The following ``update-role`` command changes the description of the IAM role ``production-role`` to ``Main production role`` and sets the maximum session duration to 12 hours. :: + + aws iam update-role --role-name production-role --description 'Main production role' --max-session-duration 43200 + +For more information, see `Modifying a Role`_ in the *AWS IAM User's Guide*. + +.. _`Modifying a Role`: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage_modify.html + diff -Nru awscli-1.11.13/awscli/examples/iam/update-server-certificate.rst awscli-1.18.69/awscli/examples/iam/update-server-certificate.rst --- awscli-1.11.13/awscli/examples/iam/update-server-certificate.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/update-server-certificate.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To change the path or name of a server certificate in your AWS account** + +The following ``update-server-certificate`` command changes the name of the certificate from ``myServerCertificate`` to ``myUpdatedServerCertificate``. It also changes the path to ``/cloudfront/`` so that it can be accessed by the Amazon CloudFront service. This command produces no output. You can see the results of the update by running the ``list-server-certificates`` command. :: + + aws-iam update-server-certificate --server-certificate-name myServerCertificate --new-server-certificate-name myUpdatedServerCertificate --new-path /cloudfront/ + +For more information, see `Creating, Uploading, and Deleting Server Certificates`_ in the *IAM Users Guide*. + +.. _`Creating, Uploading, and Deleting Server Certificates`: http://docs.aws.amazon.com/IAM/latest/UserGuide/InstallCert.html diff -Nru awscli-1.11.13/awscli/examples/iam/update-service-specific-credential.rst awscli-1.18.69/awscli/examples/iam/update-service-specific-credential.rst --- awscli-1.11.13/awscli/examples/iam/update-service-specific-credential.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/update-service-specific-credential.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**Example 1: To update the status of the requesting user's service-specific credential** + +The following ``update-service-specific-credential`` example changes the status for the specified credential for the user making the request to ``Inactive``. This command produces no output. :: + + aws iam update-service-specific-credential \ + --service-specific-credential-id ACCAEXAMPLE123EXAMPLE \ + --status Inactive + +**Example 2: To update the status of a specified user's service-specific credential** + +The following ``update-service-specific-credential`` example changes the status for the credential of the specified user to Inactive. This command produces no output. :: + + aws iam update-service-specific-credential \ + --user-name sofia \ + --service-specific-credential-id ACCAEXAMPLE123EXAMPLE \ + --status Inactive + +For more information, see `Create Git Credentials for HTTPS Connections to CodeCommit `_ in the *AWS CodeCommit User Guide* diff -Nru awscli-1.11.13/awscli/examples/iam/update-ssh-public-key.rst awscli-1.18.69/awscli/examples/iam/update-ssh-public-key.rst --- awscli-1.11.13/awscli/examples/iam/update-ssh-public-key.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/update-ssh-public-key.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,12 @@ +**To change the status of an SSH public key** + +The following ``update-ssh-public-key`` command changes the status of the specified public key to ``Inactive``. :: + + aws iam update-ssh-public-key \ + --user-name sofia \ + --ssh-public-key-id APKA1234567890EXAMPLE \ + --status Inactive + +This command produces no output. + +For more information about SSH keys in IAM, see `Use SSH Keys and SSH with CodeCommit `_ in the *AWS IAM User Guide* diff -Nru awscli-1.11.13/awscli/examples/iam/upload-server-certificate.rst awscli-1.18.69/awscli/examples/iam/upload-server-certificate.rst --- awscli-1.11.13/awscli/examples/iam/upload-server-certificate.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/upload-server-certificate.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,15 +1,21 @@ **To upload a server certificate to your AWS account** -The following **upload-server-certificate** command uploads a server certificate to your AWS account:: +The following **upload-server-certificate** command uploads a server certificate to your AWS account. In this example, the certificate is in the file ``public_key_cert_file.pem``, the associated private key is in the file ``my_private_key.pem``, and the the certificate chain provided by the certificate authority (CA) is in the ``my_certificate_chain_file.pem`` file. When the file has finished uploading, it is available under the name *myServerCertificate*. Parameters that begin with ``file://`` tells the command to read the contents of the file and use that as the parameter value instead of the file name itself. :: - aws iam upload-server-certificate --server-certificate-name myServerCertificate --certificate-body file://public_key_cert_file.pem --private-key file://my_private_key.pem --certificate-chain file://my_certificate_chain_file.pem + aws iam upload-server-certificate --server-certificate-name myServerCertificate --certificate-body file://public_key_cert_file.pem --private-key file://my_private_key.pem --certificate-chain file://my_certificate_chain_file.pem -The certificate is in the file ``public_key_cert_file.pem``, and your private key is in the file ``my_private_key.pem``. -When the file has finished uploading, it is available under the name *myServerCertificate*. The certificate chain -provided by the certificate authority (CA) is included as the ``my_certificate_chain_file.pem`` file. +Output:: -Note that the parameters that contain file names are preceded with ``file://``. This tells the command that the -parameter value is a file name. You can include a complete path following ``file://``. + { + "ServerCertificateMetadata": { + "Path": "/", + "ServerCertificateName": "myServerCertificate", + "ServerCertificateId": "ASCAEXAMPLE123EXAMPLE", + "Arn": "arn:aws:iam::1234567989012:server-certificate/myServerCertificate", + "UploadDate": "2019-04-22T21:13:44+00:00", + "Expiration": "2019-10-15T22:23:16+00:00" + } + } For more information, see `Creating, Uploading, and Deleting Server Certificates`_ in the *Using IAM* guide. diff -Nru awscli-1.11.13/awscli/examples/iam/upload-ssh-public-key.rst awscli-1.18.69/awscli/examples/iam/upload-ssh-public-key.rst --- awscli-1.11.13/awscli/examples/iam/upload-ssh-public-key.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/upload-ssh-public-key.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,22 @@ +**To upload an SSH public key and associate it with a user** + +The following ``upload-ssh-public-key`` command uploads the public key found in the file 'sshkey.pub' and attaches it to the user 'sofia'. :: + + aws iam upload-ssh-public-key --user-name sofia --ssh-public-key-body file://sshkey.pub + +Output:: + + { + "SSHPublicKey": { + "UserName": "sofia", + "SSHPublicKeyId": "APKA1234567890EXAMPLE", + "Fingerprint": "12:34:56:78:90:ab:cd:ef:12:34:56:78:90:ab:cd:ef", + "SSHPublicKeyBody": "ssh-rsa <>", + "Status": "Active", + "UploadDate": "2019-04-18T17:04:49+00:00" + } + } + +For more information about how to generate keys in a format suitable for this command, see `SSH and Linux, macOS, or Unix: Set Up the Public and Private Keys for Git and CodeCommit`_ or `SSH and Windows: Set Up the Public and Private Keys for Git and CodeCommit`_in the *AWS CodeCommit User Guide* +.. _`SSH and Linux, macOS, or Unix: Set Up the Public and Private Keys for Git and CodeCommit`: https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-ssh-unixes.html#setting-up-ssh-unixes-keys +.. _`SSH and Windows: Set Up the Public and Private Keys for Git and CodeCommit`: https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-ssh-windows.html#setting-up-ssh-windows-keys-windows diff -Nru awscli-1.11.13/awscli/examples/iam/wait/instance-profile-exists.rst awscli-1.18.69/awscli/examples/iam/wait/instance-profile-exists.rst --- awscli-1.11.13/awscli/examples/iam/wait/instance-profile-exists.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/wait/instance-profile-exists.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,5 @@ +**To pause running until the specified instance profile exists** + +The following ``wait instance-profile-exists`` command pauses and continues only after it can confirm that the specified instance profile exists. There is no output. :: + + aws iam wait instance-profile-exists --instance-profile-name WebServer diff -Nru awscli-1.11.13/awscli/examples/iam/wait/policy-exists.rst awscli-1.18.69/awscli/examples/iam/wait/policy-exists.rst --- awscli-1.11.13/awscli/examples/iam/wait/policy-exists.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/wait/policy-exists.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,5 @@ +**To pause running until the specified role exists** + +The following ``wait policy-exists`` command pauses and continues only after it can confirm that the specified policy exists. There is no output. :: + + aws iam wait policy-exists --policy-name MyPolicy diff -Nru awscli-1.11.13/awscli/examples/iam/wait/role-exists.rst awscli-1.18.69/awscli/examples/iam/wait/role-exists.rst --- awscli-1.11.13/awscli/examples/iam/wait/role-exists.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/wait/role-exists.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,5 @@ +**To pause running until the specified role exists** + +The following ``wait role-exists`` command pauses and continues only after it can confirm that the specified role exists. There is no output. :: + + aws iam wait role-exists --role-name MyRole diff -Nru awscli-1.11.13/awscli/examples/iam/wait/user-exists.rst awscli-1.18.69/awscli/examples/iam/wait/user-exists.rst --- awscli-1.11.13/awscli/examples/iam/wait/user-exists.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iam/wait/user-exists.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,5 @@ +**To pause running until the specified user exists** + +The following ``wait user-exists`` command pauses and continues only after it can confirm that the specified user exists. There is no output. :: + + aws iam wait user-exists --user-name marcia diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/create-component.rst awscli-1.18.69/awscli/examples/imagebuilder/create-component.rst --- awscli-1.11.13/awscli/examples/imagebuilder/create-component.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/create-component.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,27 @@ +**To create a component** + +The following ``create-component`` example creates a component that uses a JSON document file and references a component document in YAML format that is uploaded to an Amazon S3 bucket. :: + + aws imagebuilder create-component \ + --cli-input-json file://create-component.json + +Contents of ``create-component.json``:: + + { + "name": "MyExampleComponent", + "semanticVersion": "2019.12.02", + "description": "An example component that builds, validates and tests an image", + "changeDescription": "Initial version.", + "platform": "Windows", + "uri": "s3://s3-bucket-name/s3-bucket-path/component.yaml" + } + +Output:: + + { + "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "componentBuildVersionArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/examplecomponent/2019.12.02/1" + } + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/create-distribution-configuration.rst awscli-1.18.69/awscli/examples/imagebuilder/create-distribution-configuration.rst --- awscli-1.11.13/awscli/examples/imagebuilder/create-distribution-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/create-distribution-configuration.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,54 @@ +**To create a distribution configuration** + +The following ``create-distribution-configuration`` example creates a distribution configuration using a JSON file. :: + + aws imagebuilder create-distribution-configuration \ + --cli-input-json file:/create-distribution-configuration.json + +Contents of ``create-distribution-configuration.json``:: + + { + "name": "MyExampleDistribution", + "description": "Copies AMI to eu-west-1", + "distributions": [ + { + "region": "us-west-2", + "amiDistributionConfiguration": { + "name": "Name {{imagebuilder:buildDate}}", + "description": "An example image name with parameter references", + "amiTags": { + "KeyName": "{{ssm:parameter_name}}" + }, + "launchPermission": { + "userIds": [ + "123456789012" + ] + } + } + }, + { + "region": "eu-west-1", + "amiDistributionConfiguration": { + "name": "My {{imagebuilder:buildVersion}} image {{imagebuilder:buildDate}}", + "amiTags": { + "KeyName": "Value" + }, + "launchPermission": { + "userIds": [ + "123456789012" + ] + } + } + } + ] + } + +Output:: + + { + "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution" + } + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/create-image-pipeline.rst awscli-1.18.69/awscli/examples/imagebuilder/create-image-pipeline.rst --- awscli-1.11.13/awscli/examples/imagebuilder/create-image-pipeline.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/create-image-pipeline.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,35 @@ +**To create an image pipeline** + +The following ``create-image-pipeline`` example creates an image pipeline using a JSON file. :: + + aws imagebuilder create-image-pipeline \ + --cli-input-json file://create-image-pipeline.json + +Contents of ``create-image-pipeline.json``:: + + { + "name": "MyWindows2016Pipeline", + "description": "Builds Windows 2016 Images", + "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03", + "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure", + "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution", + "imageTestsConfiguration": { + "imageTestsEnabled": true, + "timeoutMinutes": 60 + }, + "schedule": { + "scheduleExpression": "cron(0 0 * * SUN)", + "pipelineExecutionStartCondition": "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE" + }, + "status": "ENABLED" + } + +Output:: + + { + "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline" + } + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/create-image-recipe.rst awscli-1.18.69/awscli/examples/imagebuilder/create-image-recipe.rst --- awscli-1.11.13/awscli/examples/imagebuilder/create-image-recipe.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/create-image-recipe.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,34 @@ +**To create a recipe** + +The following ``create-image-recipe`` example creates an image recipe using a JSON file. Components are installed in the order in which they are specified. :: + + aws imagebuilder create-image-recipe \ + --cli-input-json file://create-image-recipe.json + +Contents of ``create-image-recipe.json``:: + + { + "name": "MyBasicRecipe", + "description": "This example image recipe creates a Windows 2016 image.", + "semanticVersion": "2019.12.03", + "components": + [ + { + "componentArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myexamplecomponent/2019.12.02/1" + }, + { + "componentArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myimportedcomponent/1.0.0/1" + } + ], + "parentImage": "arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/2019.x.x" + } + +Output:: + + { + "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03" + } + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/create-image.rst awscli-1.18.69/awscli/examples/imagebuilder/create-image.rst --- awscli-1.11.13/awscli/examples/imagebuilder/create-image.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/create-image.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To create an image** + +The following ``create-image`` example creates an image. :: + + aws imagebuilder create-image \ + --image-recipe-arn arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03 \ + --infrastructure-configuration-arn arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure + +Output:: + + { + "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/1" + } + + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/create-infrastructure-configuration.rst awscli-1.18.69/awscli/examples/imagebuilder/create-infrastructure-configuration.rst --- awscli-1.11.13/awscli/examples/imagebuilder/create-infrastructure-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/create-infrastructure-configuration.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,40 @@ +**To create an infrastructure configuration** + +The following ``create-infrastructure-configuration`` example creates an infrastructure configuration using a JSON file. :: + + aws imagebuilder create-infrastructure-configuration \ + --cli-input-json file://create-infrastructure-configuration.json + +Contents of ``create-infrastructure-configuration.json``:: + + { + "name": "MyExampleInfrastructure", + "description": "An example that will retain instances of failed builds", + "instanceTypes": [ + "m5.large", "m5.xlarge" + ], + "instanceProfileName": "EC2InstanceProfileForImageBuilder", + "securityGroupIds": [ + "sg-a1b2c3d4" + ], + "subnetId": "subnet-a1b2c3d4", + "logging": { + "s3Logs": { + "s3BucketName": "bucket-name", + "s3KeyPrefix": "bucket-path" + } + }, + "keyPair": "key-pair-name", + "terminateInstanceOnFailure": false, + "snsTopicArn": "arn:aws:sns:us-west-2:123456789012:sns-topic-name" + } + +Output:: + + { + "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure" + } + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/delete-component.rst awscli-1.18.69/awscli/examples/imagebuilder/delete-component.rst --- awscli-1.11.13/awscli/examples/imagebuilder/delete-component.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/delete-component.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,15 @@ +**To delete a component** + +The following ``delete-component`` example deletes a component build version by specifying its ARN. :: + + aws imagebuilder delete-component \ + --component-build-version-arn arn:aws:imagebuilder:us-west-2:123456789012:component/myexamplecomponent/2019.12.02/1 + +Output:: + + { + "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "componentBuildVersionArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myexamplecomponent/2019.12.02/1" + } + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/delete-image-pipeline.rst awscli-1.18.69/awscli/examples/imagebuilder/delete-image-pipeline.rst --- awscli-1.11.13/awscli/examples/imagebuilder/delete-image-pipeline.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/delete-image-pipeline.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,15 @@ +**To delete an image pipeline** + +The following ``delete-image-pipeline`` example deletes an image pipeline by specifying its ARN. :: + + aws imagebuilder delete-image-pipeline \ + --image-pipeline-arn arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/my-example-pipeline + +Output:: + + { + "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline" + } + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/delete-image-recipe.rst awscli-1.18.69/awscli/examples/imagebuilder/delete-image-recipe.rst --- awscli-1.11.13/awscli/examples/imagebuilder/delete-image-recipe.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/delete-image-recipe.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,15 @@ +**To delete an image recipe** + +The following ``delete-image-recipe`` example deletes an image recipe by specifying its ARN. :: + + aws imagebuilder delete-image-recipe \ + --image-recipe-arn arn:aws:imagebuilder:us-east-1:123456789012:image-recipe/mybasicrecipe/2019.12.03 + +Output:: + + { + "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03" + } + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/delete-image.rst awscli-1.18.69/awscli/examples/imagebuilder/delete-image.rst --- awscli-1.11.13/awscli/examples/imagebuilder/delete-image.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/delete-image.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,15 @@ +**To delete an image** + +The following ``delete-image`` example deletes an image build version by specifying its ARN. :: + + aws imagebuilder delete-image \ + --image-build-version-arn arn:aws:imagebuilder:us-west-2:123456789012:image/my-example-image/2019.12.02/1 + +Output:: + + { + "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/1" + } + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/delete-infrastructure-configuration.rst awscli-1.18.69/awscli/examples/imagebuilder/delete-infrastructure-configuration.rst --- awscli-1.11.13/awscli/examples/imagebuilder/delete-infrastructure-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/delete-infrastructure-configuration.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,15 @@ +**To delete an infrastructure configuration** + +The following ``delete-infrastructure-configuration`` example deletes an image pipeline by specifying its ARN. :: + + aws imagebuilder delete-infrastructure-configuration \ + --infrastructure-configuration-arn arn:aws:imagebuilder:us-east-1:123456789012:infrastructure-configuration/myexampleinfrastructure + +Output:: + + { + "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure" + } + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/get-component-policy.rst awscli-1.18.69/awscli/examples/imagebuilder/get-component-policy.rst --- awscli-1.11.13/awscli/examples/imagebuilder/get-component-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/get-component-policy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,13 @@ +**To get component policy details** + +The following ``get-component-policy`` example displays the details of a component policy by specifying its ARN. :: + + aws imagebuilder get-component-policy --image-arn arn:aws:imagebuilder:us-west-2:123456789012:component/my-example-component/2019.12.03/1 + +Output:: + + { + "Policy": "{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": [ "123456789012" ] }, "Action": [ "imagebuilder:GetComponent", "imagebuilder:ListComponents" ], "Resource": [ "arn:aws:imagebuilder:us-west-2:123456789012:component/my-example-component/2019.12.03/1" ] } ] }" + } + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/get-component.rst awscli-1.18.69/awscli/examples/imagebuilder/get-component.rst --- awscli-1.11.13/awscli/examples/imagebuilder/get-component.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/get-component.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,26 @@ +**To get component details** + +The following ``get-component`` example lists the details of a component by specifying its ARN. :: + + aws imagebuilder get-component \ + --component-build-version-arn arn:aws:imagebuilder:us-west-2:123456789012:component/component-name/1.0.0/1 + +Output:: + + { + "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "component": { + "arn": "arn:aws:imagebuilder:us-west-2:123456789012:component/component-name/1.0.0/1", + "name": "component-name", + "version": "1.0.0", + "type": "TEST", + "platform": "Linux", + "owner": "123456789012", + "data": "name: HelloWorldTestingDocument\ndescription: This is hello world testing document.\nschemaVersion: 1.0\n\nphases:\n - name: test\n steps:\n - name: HelloWorldStep\n action: ExecuteBash\n inputs:\n commands:\n - echo \"Hello World! Test.\"\n", + "encrypted": true, + "dateCreated": "2020-01-27T20:43:30.306Z", + "tags": {} + } + } + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/get-distribution-configuration.rst awscli-1.18.69/awscli/examples/imagebuilder/get-distribution-configuration.rst --- awscli-1.11.13/awscli/examples/imagebuilder/get-distribution-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/get-distribution-configuration.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,52 @@ +**To get the details of a distribution configuration** + +The following ``get-distribution-configuration`` example displays the details of a distribution configuration by specifying its ARN. :: + + aws imagebuilder get-distribution-configuration \ + --distribution-configuration-arn arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution + +Output:: + + { + "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "distributionConfiguration": { + "arn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution", + "name": "MyExampleDistribution", + "description": "Copies AMI to eu-west-1 and exports to S3", + "distributions": [ + { + "region": "us-west-2", + "amiDistributionConfiguration": { + "name": "Name {{imagebuilder:buildDate}}", + "description": "An example image name with parameter references", + "amiTags": { + "KeyName": "{{ssm:parameter_name}}" + }, + "launchPermission": { + "userIds": [ + "123456789012" + ] + } + } + }, + { + "region": "eu-west-1", + "amiDistributionConfiguration": { + "name": "My {{imagebuilder:buildVersion}} image {{imagebuilder:buildDate}}", + "amiTags": { + "KeyName": "Value" + }, + "launchPermission": { + "userIds": [ + "123456789012" + ] + } + } + } + ], + "dateCreated": "2020-02-19T18:40:10.529Z", + "tags": {} + } + } + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/get-image-pipeline.rst awscli-1.18.69/awscli/examples/imagebuilder/get-image-pipeline.rst --- awscli-1.11.13/awscli/examples/imagebuilder/get-image-pipeline.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/get-image-pipeline.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,35 @@ +**To get image pipeline details** + +The following ``get-image-pipeline`` example lists the details of an image pipeline by specifying its ARN. :: + + aws imagebuilder get-image-pipeline \ + --image-pipeline-arn arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline + +Output:: + + { + "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "imagePipeline": { + "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline", + "name": "MyWindows2016Pipeline", + "description": "Builds Windows 2016 Images", + "platform": "Windows", + "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03", + "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure", + "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution", + "imageTestsConfiguration": { + "imageTestsEnabled": true, + "timeoutMinutes": 60 + }, + "schedule": { + "scheduleExpression": "cron(0 0 * * SUN)", + "pipelineExecutionStartCondition": "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE" + }, + "status": "ENABLED", + "dateCreated": "2020-02-19T19:04:01.253Z", + "dateUpdated": "2020-02-19T19:04:01.253Z", + "tags": {} + } + } + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/get-image-policy.rst awscli-1.18.69/awscli/examples/imagebuilder/get-image-policy.rst --- awscli-1.11.13/awscli/examples/imagebuilder/get-image-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/get-image-policy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,14 @@ +**To get image policy details** + +The following ``get-image-policy`` example lists the details of an image policy by specifying its ARN. :: + + aws imagebuilder get-image-policy \ + --image-arn arn:aws:imagebuilder:us-west-2:123456789012:image/my-example-image/2019.12.03/1 + +Output:: + + { + "Policy": "{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": [ "123456789012" ] }, "Action": [ "imagebuilder:GetImage", "imagebuilder:ListImages" ], "Resource": [ "arn:aws:imagebuilder:us-west-2:123456789012:image/my-example-image/2019.12.03/1" ] } ] }" + } + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/get-image-recipe-policy.rst awscli-1.18.69/awscli/examples/imagebuilder/get-image-recipe-policy.rst --- awscli-1.11.13/awscli/examples/imagebuilder/get-image-recipe-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/get-image-recipe-policy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,14 @@ +**To get image recipe policy details** + +The following ``get-image-recipe-policy`` example lists the details of an image recipe policy by specifying its ARN. :: + + aws imagebuilder get-image-recipe-policy \ + --image-arn arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/my-example-image-recipe/2019.12.03/1 + +Output:: + + { + "Policy": "{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": [ "123456789012" ] }, "Action": [ "imagebuilder:GetImageRecipe", "imagebuilder:ListImageRecipes" ], "Resource": [ "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/my-example-image-recipe/2019.12.03/1" ] } ] }" + } + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/get-image.rst awscli-1.18.69/awscli/examples/imagebuilder/get-image.rst --- awscli-1.11.13/awscli/examples/imagebuilder/get-image.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/get-image.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,75 @@ +**To get image details** + +The following ``get-image`` example lists the details of an image by specifying its ARN. :: + + aws imagebuilder get-image \ + --image-build-version-arn arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/1 + +Output:: + + { + "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "image": { + "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/1", + "name": "MyBasicRecipe", + "version": "2019.12.03/1", + "platform": "Windows", + "state": { + "status": "BUILDING" + }, + "imageRecipe": { + "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03", + "name": "MyBasicRecipe", + "description": "This example image recipe creates a Windows 2016 image.", + "platform": "Windows", + "version": "2019.12.03", + "components": [ + { + "componentArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myexamplecomponent/2019.12.02/1" + }, + { + "componentArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myimportedcomponent/1.0.0/1" + } + ], + "parentImage": "arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/2019.12.17/1", + "dateCreated": "2020-02-14T19:46:16.904Z", + "tags": {} + }, + "infrastructureConfiguration": { + "arn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure", + "name": "MyExampleInfrastructure", + "description": "An example that will retain instances of failed builds", + "instanceTypes": [ + "m5.large", + "m5.xlarge" + ], + "instanceProfileName": "EC2InstanceProfileForImageFactory", + "securityGroupIds": [ + "sg-a1b2c3d4" + ], + "subnetId": "subnet-a1b2c3d4", + "logging": { + "s3Logs": { + "s3BucketName": "bucket-name", + "s3KeyPrefix": "bucket-path" + } + }, + "keyPair": "Sam", + "terminateInstanceOnFailure": false, + "snsTopicArn": "arn:aws:sns:us-west-2:123456789012:sns-name", + "dateCreated": "2020-02-14T21:21:05.098Z", + "tags": {} + }, + "imageTestsConfiguration": { + "imageTestsEnabled": true, + "timeoutMinutes": 720 + }, + "dateCreated": "2020-02-14T23:14:13.597Z", + "outputResources": { + "amis": [] + }, + "tags": {} + } + } + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/get-infrastructure-configuration.rst awscli-1.18.69/awscli/examples/imagebuilder/get-infrastructure-configuration.rst --- awscli-1.11.13/awscli/examples/imagebuilder/get-infrastructure-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/get-infrastructure-configuration.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,39 @@ +**To get infrastructure configuration details** + +The following ``get-infrastructure-configuration`` example lists the details of an infrastructure configuration by specifying its ARN. :: + + aws imagebuilder get-infrastructure-configuration \ + --infrastructure-configuration-arn arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure + +Output:: + + { + "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "infrastructureConfiguration": { + "arn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure", + "name": "MyExampleInfrastructure", + "description": "An example that will retain instances of failed builds", + "instanceTypes": [ + "m5.large", + "m5.xlarge" + ], + "instanceProfileName": "EC2InstanceProfileForImageBuilder", + "securityGroupIds": [ + "sg-a48c95ef" + ], + "subnetId": "subnet-a48c95ef", + "logging": { + "s3Logs": { + "s3BucketName": "bucket-name", + "s3KeyPrefix": "bucket-path" + } + }, + "keyPair": "Name", + "terminateInstanceOnFailure": false, + "snsTopicArn": "arn:aws:sns:us-west-2:123456789012:sns-name", + "dateCreated": "2020-02-19T19:11:51.858Z", + "tags": {} + } + } + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/import-component.rst awscli-1.18.69/awscli/examples/imagebuilder/import-component.rst --- awscli-1.11.13/awscli/examples/imagebuilder/import-component.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/import-component.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,29 @@ +**To import a component** + +The following ``import-component`` example imports a preexisting script using a JSON file. :: + + aws imagebuilder import-component \ + --cli-input-json file://import-component.json + +Contents of ``import-component.json``:: + + { + "name": "MyImportedComponent", + "semanticVersion": "1.0.0", + "description": "An example of how to import a component", + "changeDescription": "First commit message.", + "format": "SHELL", + "platform": "Windows", + "type": "BUILD", + "uri": "s3://s3-bucket-name/s3-bucket-path/component.yaml" + } + +Output:: + + { + "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "componentBuildVersionArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myimportedcomponent/1.0.0/1" + } + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/list-component-build-versions.rst awscli-1.18.69/awscli/examples/imagebuilder/list-component-build-versions.rst --- awscli-1.11.13/awscli/examples/imagebuilder/list-component-build-versions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/list-component-build-versions.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,29 @@ +**To list component build versions** + +The following ``list-component-build-versions`` example lists the component build versions with a specific semantic version. :: + + aws imagebuilder list-component-build-versions --component-version-arn arn:aws:imagebuilder:us-west-2:123456789012:component/myexamplecomponent/2019.12.02 + +Output:: + + { + "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "componentSummaryList": [ + { + "arn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myexamplecomponent/2019.12.02/1", + "name": "MyExampleComponent", + "version": "2019.12.02", + "platform": "Windows", + "type": "BUILD", + "owner": "123456789012", + "description": "An example component that builds, validates and tests an image", + "changeDescription": "Initial version.", + "dateCreated": "2020-02-19T18:53:45.940Z", + "tags": { + "KeyName": "KeyValue" + } + } + ] + } + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/list-components.rst awscli-1.18.69/awscli/examples/imagebuilder/list-components.rst --- awscli-1.11.13/awscli/examples/imagebuilder/list-components.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/list-components.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,24 @@ +**To list all of the component semantic versions** + +The following ``list-components`` example lists all of the component semantic versions to which you have access. You can optionally filter on whether to list components owned by you, by Amazon, or that have been shared with you by other accounts. :: + + aws imagebuilder list-components + +Output:: + + { + "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "componentVersionList": [ + { + "arn": "arn:aws:imagebuilder:us-west-2:123456789012:component/component-name/1.0.0", + "name": "component-name", + "version": "1.0.0", + "platform": "Linux", + "type": "TEST", + "owner": "123456789012", + "dateCreated": "2020-01-27T20:43:30.306Z" + } + ] + } + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/list-distribution-configurations.rst awscli-1.18.69/awscli/examples/imagebuilder/list-distribution-configurations.rst --- awscli-1.11.13/awscli/examples/imagebuilder/list-distribution-configurations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/list-distribution-configurations.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,24 @@ +**To list distributions** + +The following ``list-distribution-configurations`` example lists all of your distributions. :: + + aws imagebuilder list-distribution-configurations + +Output:: + + { + "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "distributionConfigurationSummaryList": [ + { + "arn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution", + "name": "MyExampleDistribution", + "description": "Copies AMI to eu-west-1 and exports to S3", + "dateCreated": "2020-02-19T18:40:10.529Z", + "tags": { + "KeyName": "KeyValue" + } + } + ] + } + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/list-image-build-versions.rst awscli-1.18.69/awscli/examples/imagebuilder/list-image-build-versions.rst --- awscli-1.11.13/awscli/examples/imagebuilder/list-image-build-versions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/list-image-build-versions.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,149 @@ +**To list image build versions** + +The following ``list-image-build-versions`` example lists all of the image build versions with a semantic version. :: + + aws imagebuilder list-image-build-versions \ + --image-version-arn arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03 + +Output:: + + { + "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "imageSummaryList": [ + { + "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/7", + "name": "MyBasicRecipe", + "version": "2019.12.03/7", + "platform": "Windows", + "state": { + "status": "FAILED", + "reason": "Can't start SSM Automation for arn arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/7 during building. Parameter \"iamInstanceProfileName\" has a null value." + }, + "owner": "123456789012", + "dateCreated": "2020-02-19T18:56:11.511Z", + "outputResources": { + "amis": [] + }, + "tags": {} + }, + { + "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/6", + "name": "MyBasicRecipe", + "version": "2019.12.03/6", + "platform": "Windows", + "state": { + "status": "FAILED", + "reason": "An internal error has occurred." + }, + "owner": "123456789012", + "dateCreated": "2020-02-18T22:49:08.142Z", + "outputResources": { + "amis": [ + { + "region": "us-west-2", + "image": "ami-a1b2c3d4567890ab", + "name": "MyBasicRecipe 2020-02-18T22-49-38.704Z", + "description": "This example image recipe creates a Windows 2016 image." + }, + { + "region": "us-west-2", + "image": "ami-a1b2c3d4567890ab", + "name": "Name 2020-02-18T22-49-08.131Z", + "description": "Copies AMI to eu-west-2 and exports to S3" + }, + { + "region": "eu-west-2", + "image": "ami-a1b2c3d4567890ab", + "name": "My 6 image 2020-02-18T22-49-08.131Z", + "description": "Copies AMI to eu-west-2 and exports to S3" + } + ] + }, + "tags": {} + }, + { + "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/5", + "name": "MyBasicRecipe", + "version": "2019.12.03/5", + "platform": "Windows", + "state": { + "status": "AVAILABLE" + }, + "owner": "123456789012", + "dateCreated": "2020-02-18T16:51:48.403Z", + "outputResources": { + "amis": [ + { + "region": "us-west-2", + "image": "ami-a1b2c3d4567890ab", + "name": "MyBasicRecipe 2020-02-18T16-52-18.965Z", + "description": "This example image recipe creates a Windows 2016 image." + } + ] + }, + "tags": {} + }, + { + "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/4", + "name": "MyBasicRecipe", + "version": "2019.12.03/4", + "platform": "Windows", + "state": { + "status": "AVAILABLE" + }, + "owner": "123456789012", + "dateCreated": "2020-02-18T16:50:01.827Z", + "outputResources": { + "amis": [ + { + "region": "us-west-2", + "image": "ami-a1b2c3d4567890ab", + "name": "MyBasicRecipe 2020-02-18T16-50-32.280Z", + "description": "This example image recipe creates a Windows 2016 image." + } + ] + }, + "tags": {} + }, + { + "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/3", + "name": "MyBasicRecipe", + "version": "2019.12.03/3", + "platform": "Windows", + "state": { + "status": "AVAILABLE" + }, + "owner": "123456789012", + "dateCreated": "2020-02-14T23:14:13.597Z", + "outputResources": { + "amis": [ + { + "region": "us-west-2", + "image": "ami-a1b2c3d4567890ab", + "name": "MyBasicRecipe 2020-02-14T23-14-44.243Z", + "description": "This example image recipe creates a Windows 2016 image." + } + ] + }, + "tags": {} + }, + { + "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/2", + "name": "MyBasicRecipe", + "version": "2019.12.03/2", + "platform": "Windows", + "state": { + "status": "FAILED", + "reason": "SSM execution 'a1b2c3d4-5678-90ab-cdef-EXAMPLE11111' failed with status = 'Failed' and failure message = 'Step fails when it is verifying the command has completed. Command a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 returns unexpected invocation result: \n{Status=[Failed], ResponseCode=[1], Output=[\n----------ERROR-------\nfailed to run commands: exit status 1], OutputPayload=[{\"Status\":\"Failed\",\"ResponseCode\":1,\"Output\":\"\\n----------ERROR-------\\nfailed to run commands: exit status 1\",\"CommandId\":\"a1b2c3d4-5678-90ab-cdef-EXAMPLE11111\"}], CommandId=[a1b2c3d4-5678-90ab-cdef-EXAMPLE11111]}. Please refer to Automation Service Troubleshooting Guide for more diagnosis details.'" + }, + "owner": "123456789012", + "dateCreated": "2020-02-14T22:57:42.593Z", + "outputResources": { + "amis": [] + }, + "tags": {} + } + ] + } + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/list-image-pipeline-images.rst awscli-1.18.69/awscli/examples/imagebuilder/list-image-pipeline-images.rst --- awscli-1.11.13/awscli/examples/imagebuilder/list-image-pipeline-images.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/list-image-pipeline-images.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,56 @@ +**To list image pipeline pipeline images** + +The following ``list-image-pipeline-images`` example lists all images that were created by a specific image pipeline. :: + + aws imagebuilder list-image-pipeline-images \ + --image-pipeline-arn arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline + +Output:: + + { + "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "imagePipelineList": [ + { + "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline", + "name": "MyWindows2016Pipeline", + "description": "Builds Windows 2016 Images", + "platform": "Windows", + "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03", + "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure", + "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution", + "imageTestsConfiguration": { + "imageTestsEnabled": true, + "timeoutMinutes": 60 + }, + "schedule": { + "scheduleExpression": "cron(0 0 * * SUN)", + "pipelineExecutionStartCondition": "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE" + }, + "status": "ENABLED", + "dateCreated": "2020-02-19T19:04:01.253Z", + "dateUpdated": "2020-02-19T19:04:01.253Z", + "tags": { + "KeyName": "KeyValue" + } + }, + { + "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/sam", + "name": "PipelineName", + "platform": "Linux", + "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/recipe-name-a1b2c3d45678/1.0.0", + "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/infrastructureconfiguration-name-a1b2c3d45678", + "imageTestsConfiguration": { + "imageTestsEnabled": true, + "timeoutMinutes": 720 + }, + "status": "ENABLED", + "dateCreated": "2019-12-16T18:19:02.068Z", + "dateUpdated": "2019-12-16T18:19:02.068Z", + "tags": { + "KeyName": "KeyValue" + } + } + ] + } + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/list-image-recipes.rst awscli-1.18.69/awscli/examples/imagebuilder/list-image-recipes.rst --- awscli-1.11.13/awscli/examples/imagebuilder/list-image-recipes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/list-image-recipes.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,37 @@ +**To list image recipes** + +The following ``list-image-recipes`` example lists all of your image recipes. :: + + aws imagebuilder list-image-recipes + +Output:: + + { + "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "imageRecipeSummaryList": [ + { + "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03", + "name": "MyBasicRecipe", + "platform": "Windows", + "owner": "123456789012", + "parentImage": "arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/2019.x.x", + "dateCreated": "2020-02-19T18:54:25.975Z", + "tags": { + "KeyName": "KeyValue" + } + }, + { + "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/recipe-name-a1b2c3d45678/1.0.0", + "name": "recipe-name-a1b2c3d45678", + "platform": "Linux", + "owner": "123456789012", + "parentImage": "arn:aws:imagebuilder:us-west-2:aws:image/amazon-linux-2-x86/2019.11.21", + "dateCreated": "2019-12-16T18:19:00.120Z", + "tags": { + "KeyName": "KeyValue" + } + } + ] + } + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/list-images.rst awscli-1.18.69/awscli/examples/imagebuilder/list-images.rst --- awscli-1.11.13/awscli/examples/imagebuilder/list-images.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/list-images.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,23 @@ +**To list images** + +The following ``list-images`` example lists all of the semantic versions you have access to. :: + + aws imagebuilder list-images + +Output:: + + { + "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "imageVersionList": [ + { + "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03", + "name": "MyBasicRecipe", + "version": "2019.12.03", + "platform": "Windows", + "owner": "123456789012", + "dateCreated": "2020-02-14T21:29:18.810Z" + } + ] + } + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/list-infrastructure-configurations.rst awscli-1.18.69/awscli/examples/imagebuilder/list-infrastructure-configurations.rst --- awscli-1.11.13/awscli/examples/imagebuilder/list-infrastructure-configurations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/list-infrastructure-configurations.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,30 @@ +**To list infrastructure configurations** + +The following ``list-infrastructure-configurations`` example lists all of your infrastructure configurations. :: + + aws imagebuilder list-infrastructure-configurations + +Output:: + + { + "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "infrastructureConfigurationSummaryList": [ + { + "arn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure", + "name": "MyExampleInfrastructure", + "description": "An example that will retain instances of failed builds", + "dateCreated": "2020-02-19T19:11:51.858Z", + "tags": {} + }, + { + "arn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/infrastructureconfiguration-name-a1b2c3d45678", + "name": "infrastructureConfiguration-name-a1b2c3d45678", + "dateCreated": "2019-12-16T18:19:01.038Z", + "tags": { + "KeyName": "KeyValue" + } + } + ] + } + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/list-tags-for-resource.rst awscli-1.18.69/awscli/examples/imagebuilder/list-tags-for-resource.rst --- awscli-1.11.13/awscli/examples/imagebuilder/list-tags-for-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/list-tags-for-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,16 @@ +**To list tags for a specific resource** + +The following ``list-tags-for-resource`` example lists all of the tags for a specific resource. :: + + aws imagebuilder list-tags-for-resource \ + --resource-arn arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline + +Output:: + + { + "tags": { + "KeyName": "KeyValue" + } + } + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/put-component-policy.rst awscli-1.18.69/awscli/examples/imagebuilder/put-component-policy.rst --- awscli-1.11.13/awscli/examples/imagebuilder/put-component-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/put-component-policy.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,16 @@ +**To apply a resource policy to a component** + +The following ``put-component-policy`` command applies a resource policy to a build component to enable cross-account sharing of build components. We recommend you use the RAM CLI command create-resource-share. If you use the EC2 Image Builder CLI command put-component-policy, you must also use the RAM CLI command promote-resource-share-create-from-policy in order for the resource to be visible to all principals with whom the resource is shared. :: + + aws imagebuilder put-component-policy \ + --image-arn arn:aws:imagebuilder:us-west-2:123456789012:component/examplecomponent/2019.12.02/1 \ + --policy '{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": [ "123456789012" ] }, "Action": [ "imagebuilder:GetComponent", "imagebuilder:ListComponents" ], "Resource": [ "arn:aws:imagebuilder:us-west-2:123456789012:component/examplecomponent/2019.12.02/1" ] } ] }' + +Output:: + + { + "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "componentArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/examplecomponent/2019.12.02/1" + } + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/put-image-policy.rst awscli-1.18.69/awscli/examples/imagebuilder/put-image-policy.rst --- awscli-1.11.13/awscli/examples/imagebuilder/put-image-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/put-image-policy.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,16 @@ +**To apply a resource policy to an image** + +The following ``put-image-policy`` command applies a resource policy to an image to enable cross-account sharing of images. We recommend you use the RAM CLI command create-resource-share. If you use the EC2 Image Builder CLI command put-image-policy, you must also use the RAM CLI command promote-resource-share-create-from-policy in order for the resource to be visible to all principals with whom the resource is shared. :: + + aws imagebuilder put-image-policy \ + --image-arn arn:aws:imagebuilder:us-west-2:123456789012:image/example-image/2019.12.02/1 \ + --policy '{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": [ "123456789012" ] }, "Action": [ "imagebuilder:GetImage", "imagebuilder:ListImages" ], "Resource": [ "arn:aws:imagebuilder:us-west-2:123456789012:image/example-image/2019.12.02/1" ] } ] }' + +Output:: + + { + "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "imageArn": "arn:aws:imagebuilder:us-west-2:123456789012:image/example-image/2019.12.02/1" + } + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/put-image-recipe-policy.rst awscli-1.18.69/awscli/examples/imagebuilder/put-image-recipe-policy.rst --- awscli-1.11.13/awscli/examples/imagebuilder/put-image-recipe-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/put-image-recipe-policy.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,16 @@ +**To apply a resource policy to an image recipe** + +The following ``put-image-recipe-policy`` command applies a resource policy to an image recipe to enable cross-account sharing of image recipes. We recommend you use the RAM CLI command create-resource-share. If you use the EC2 Image Builder CLI command put-image-recipe-policy, you must also use the RAM CLI command promote-resource-share-create-from-policy in order for the resource to be visible to all principals with whom the resource is shared. :: + + aws imagebuilder put-image-recipe-policy \ + --image-arn arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/example-image-recipe/2019.12.02/1 \ + --policy '{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": [ "123456789012" ] }, "Action": [ "imagebuilder:GetImageRecipe", "imagebuilder:ListImageRecipes" ], "Resource": [ "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/example-image-recipe/2019.12.02/1" ] } ] }' + +Output:: + + { + "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/example-image-recipe/2019.12.02/1" + } + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/start-image-pipeline-execution.rst awscli-1.18.69/awscli/examples/imagebuilder/start-image-pipeline-execution.rst --- awscli-1.11.13/awscli/examples/imagebuilder/start-image-pipeline-execution.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/start-image-pipeline-execution.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,18 @@ +**To start an image pipeline manually** + +The following ``start-image-pipeline-execution`` example manually starts an image pipeline. :: + + aws imagebuilder start-image-pipeline-execution \ + --image-pipeline-arn arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline + + +Output:: + + { + "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/1" + } + + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/tag-resource.rst awscli-1.18.69/awscli/examples/imagebuilder/tag-resource.rst --- awscli-1.11.13/awscli/examples/imagebuilder/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/tag-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To tag a resource** + +The following ``tag-resource`` example adds and tags a resource to EC2 Image Builder using a JSON file. :: + + aws imagebuilder tag-resource \ + --cli-input-json file://tag-resource.json + +Contents of ``tag-resource.json``:: + + { + "resourceArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline", + "tags": { + "KeyName: "KeyValue" + } + } + +This command produces no output. + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/untag-resource.rst awscli-1.18.69/awscli/examples/imagebuilder/untag-resource.rst --- awscli-1.11.13/awscli/examples/imagebuilder/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/untag-resource.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,19 @@ +**To remove a tag from a resource** + +The following ``untag-resource`` example removes a tag from a resource using a JSON file. :: + + aws imagebuilder untag-resource \ + --cli-input-json file://tag-resource.json + +Contents of ``untag-resource.json``:: + + { + "resourceArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline", + "tagKeys": [ + "KeyName" + ] + } + +This command produces no output. + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/update-distribution-configuration.rst awscli-1.18.69/awscli/examples/imagebuilder/update-distribution-configuration.rst --- awscli-1.11.13/awscli/examples/imagebuilder/update-distribution-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/update-distribution-configuration.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,36 @@ +**To update a distribution configuration** + +The following ``update-distribution-configuration`` example updates a distribution configuration using a JSON file. :: + + aws imagebuilder update-distribution-configuration \ + --cli-input-json file://update-distribution-configuration.json + +Contents of ``update-distribution-configuration.json``:: + + { + "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution", + "description": "Copies AMI to eu-west-2 and exports to S3", + "distributions": [ + { + "region": "us-west-2", + "amiDistributionConfiguration": { + "name": "Name {{imagebuilder:buildDate}}", + "description": "An example image name with parameter references" + } + }, + { + "region": "eu-west-2", + "amiDistributionConfiguration": { + "name": "My {{imagebuilder:buildVersion}} image {{imagebuilder:buildDate}}" + } + } + ] + } + +Output:: + + { + "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" + } + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/update-image-pipeline.rst awscli-1.18.69/awscli/examples/imagebuilder/update-image-pipeline.rst --- awscli-1.11.13/awscli/examples/imagebuilder/update-image-pipeline.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/update-image-pipeline.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,32 @@ +**To update an image pipeline** + +The following ``update-image-pipeline`` example updates an image pipeline using a JSON file. :: + + aws imagebuilder update-image-pipeline \ + --cli-input-json file://update-image-pipeline.json + +Contents of ``update-image-pipeline.json``:: + + { + "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline", + "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03", + "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure", + "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution", + "imageTestsConfiguration": { + "imageTestsEnabled": true, + "timeoutMinutes": 120 + }, + "schedule": { + "scheduleExpression": "cron(0 0 * * MON)", + "pipelineExecutionStartCondition": "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE" + }, + "status": "DISABLED" + } + +Output:: + + { + "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" + } + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/imagebuilder/update-infrastructure-configuration.rst awscli-1.18.69/awscli/examples/imagebuilder/update-infrastructure-configuration.rst --- awscli-1.11.13/awscli/examples/imagebuilder/update-infrastructure-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/imagebuilder/update-infrastructure-configuration.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,37 @@ +**To update an infrastructure configuration** + +The following ``update-infrastructure-configuration`` example updates an infrastructure configuration using a JSON file. :: + + aws imagebuilder update-infrastructure-configuration \ + --cli-input-json file:/update-infrastructure-configuration.json + +Contents of ``update-infrastructure-configuration.json``:: + + { + "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure", + "description": "An example that will terminate instances of failed builds", + "instanceTypes": [ + "m5.large", "m5.2xlarge" + ], + "instanceProfileName": "EC2InstanceProfileForImageFactory", + "securityGroupIds": [ + "sg-a48c95ef" + ], + "subnetId": "subnet-a48c95ef", + "logging": { + "s3Logs": { + "s3BucketName": "bucket-name", + "s3KeyPrefix": "bucket-path" + } + }, + "terminateInstanceOnFailure": true, + "snsTopicArn": "arn:aws:sns:us-west-2:123456789012:sns-name" + } + +Output:: + + { + "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" + } + +For more information, see `Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI `__ in the *EC2 Image Builder Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/inspector/list-assessment-run-agents.rst awscli-1.18.69/awscli/examples/inspector/list-assessment-run-agents.rst --- awscli-1.11.13/awscli/examples/inspector/list-assessment-run-agents.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/inspector/list-assessment-run-agents.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,170 +1,168 @@ **To list assessment run agents** -The following ``list-assessment-run-agents`` command lists the agents of the assessment run with the ARN of ``arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE``:: +The following ``list-assessment-run-agents`` command lists the agents of the assessment run with the specified ARN. :: - aws inspector list-assessment-run-agents --assessment-run-arn arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE + aws inspector list-assessment-run-agents \ + --assessment-run-arn arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE Output:: -{ - "assessmentRunAgents": [ - { - "agentHealth": "HEALTHY", - "agentHealthCode": "HEALTHY", - "agentId": "i-49113b93", - "assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE", - "telemetryMetadata": [ - { - "count": 2, - "dataSize": 345, - "messageType": "InspectorDuplicateProcess" - }, - { - "count": 3, - "dataSize": 255, - "messageType": "InspectorTimeEventMsg" - }, - { - "count": 4, - "dataSize": 1082, - "messageType": "InspectorNetworkInterface" - }, - { - "count": 2, - "dataSize": 349, - "messageType": "InspectorDnsEntry" - }, - { - "count": 11, - "dataSize": 2514, - "messageType": "InspectorDirectoryInfoMsg" - }, - { - "count": 1, - "dataSize": 179, - "messageType": "InspectorTcpV6ListeningPort" - }, - { - "count": 101, - "dataSize": 10949, - "messageType": "InspectorTerminal" - }, - { - "count": 26, - "dataSize": 5916, - "messageType": "InspectorUser" - }, - { - "count": 282, - "dataSize": 32148, - "messageType": "InspectorDynamicallyLoadedCodeModule" - }, - { - "count": 18, - "dataSize": 10172, - "messageType": "InspectorCreateProcess" - }, - { - "count": 3, - "dataSize": 8001, - "messageType": "InspectorProcessPerformance" - }, - { - "count": 1, - "dataSize": 360, - "messageType": "InspectorOperatingSystem" - }, - { - "count": 6, - "dataSize": 546, - "messageType": "InspectorStopProcess" - }, - { - "count": 1, - "dataSize": 1553, - "messageType": "InspectorInstanceMetaData" - }, - { - "count": 2, - "dataSize": 434, - "messageType": "InspectorTcpV4Connection" - }, - { - "count": 474, - "dataSize": 2960322, - "messageType": "InspectorPackageInfo" - }, - { - "count": 3, - "dataSize": 2235, - "messageType": "InspectorSystemPerformance" - }, - { - "count": 105, - "dataSize": 46048, - "messageType": "InspectorCodeModule" - }, - { - "count": 1, - "dataSize": 182, - "messageType": "InspectorUdpV6ListeningPort" - }, - { - "count": 2, - "dataSize": 371, - "messageType": "InspectorUdpV4ListeningPort" - }, - { - "count": 18, - "dataSize": 8362, - "messageType": "InspectorKernelModule" - }, - { - "count": 29, - "dataSize": 48788, - "messageType": "InspectorConfigurationInfo" - }, - { - "count": 1, - "dataSize": 79, - "messageType": "InspectorMonitoringStart" - }, - { - "count": 5, - "dataSize": 0, - "messageType": "InspectorSplitMsgBegin" - }, - { - "count": 51, - "dataSize": 4593, - "messageType": "InspectorGroup" - }, - { - "count": 1, - "dataSize": 184, - "messageType": "InspectorTcpV4ListeningPort" - }, - { - "count": 1159, - "dataSize": 3146579, - "messageType": "Total" - }, - { - "count": 5, - "dataSize": 0, - "messageType": "InspectorSplitMsgEnd" - }, - { - "count": 1, - "dataSize": 612, - "messageType": "InspectorLoadImageInProcess" - } - ] - } - ] - } - -For more information, see `AWS Agents`_ in the *Amazon Inspector* guide. - -.. _`AWS Agents`: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_agents.html + { + "assessmentRunAgents": [ + { + "agentHealth": "HEALTHY", + "agentHealthCode": "HEALTHY", + "agentId": "i-49113b93", + "assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE", + "telemetryMetadata": [ + { + "count": 2, + "dataSize": 345, + "messageType": "InspectorDuplicateProcess" + }, + { + "count": 3, + "dataSize": 255, + "messageType": "InspectorTimeEventMsg" + }, + { + "count": 4, + "dataSize": 1082, + "messageType": "InspectorNetworkInterface" + }, + { + "count": 2, + "dataSize": 349, + "messageType": "InspectorDnsEntry" + }, + { + "count": 11, + "dataSize": 2514, + "messageType": "InspectorDirectoryInfoMsg" + }, + { + "count": 1, + "dataSize": 179, + "messageType": "InspectorTcpV6ListeningPort" + }, + { + "count": 101, + "dataSize": 10949, + "messageType": "InspectorTerminal" + }, + { + "count": 26, + "dataSize": 5916, + "messageType": "InspectorUser" + }, + { + "count": 282, + "dataSize": 32148, + "messageType": "InspectorDynamicallyLoadedCodeModule" + }, + { + "count": 18, + "dataSize": 10172, + "messageType": "InspectorCreateProcess" + }, + { + "count": 3, + "dataSize": 8001, + "messageType": "InspectorProcessPerformance" + }, + { + "count": 1, + "dataSize": 360, + "messageType": "InspectorOperatingSystem" + }, + { + "count": 6, + "dataSize": 546, + "messageType": "InspectorStopProcess" + }, + { + "count": 1, + "dataSize": 1553, + "messageType": "InspectorInstanceMetaData" + }, + { + "count": 2, + "dataSize": 434, + "messageType": "InspectorTcpV4Connection" + }, + { + "count": 474, + "dataSize": 2960322, + "messageType": "InspectorPackageInfo" + }, + { + "count": 3, + "dataSize": 2235, + "messageType": "InspectorSystemPerformance" + }, + { + "count": 105, + "dataSize": 46048, + "messageType": "InspectorCodeModule" + }, + { + "count": 1, + "dataSize": 182, + "messageType": "InspectorUdpV6ListeningPort" + }, + { + "count": 2, + "dataSize": 371, + "messageType": "InspectorUdpV4ListeningPort" + }, + { + "count": 18, + "dataSize": 8362, + "messageType": "InspectorKernelModule" + }, + { + "count": 29, + "dataSize": 48788, + "messageType": "InspectorConfigurationInfo" + }, + { + "count": 1, + "dataSize": 79, + "messageType": "InspectorMonitoringStart" + }, + { + "count": 5, + "dataSize": 0, + "messageType": "InspectorSplitMsgBegin" + }, + { + "count": 51, + "dataSize": 4593, + "messageType": "InspectorGroup" + }, + { + "count": 1, + "dataSize": 184, + "messageType": "InspectorTcpV4ListeningPort" + }, + { + "count": 1159, + "dataSize": 3146579, + "messageType": "Total" + }, + { + "count": 5, + "dataSize": 0, + "messageType": "InspectorSplitMsgEnd" + }, + { + "count": 1, + "dataSize": 612, + "messageType": "InspectorLoadImageInProcess" + } + ] + } + ] + } +For more information, see `AWS Agents `_ in the *Amazon Inspector User Guide*. diff -Nru awscli-1.11.13/awscli/examples/inspector/list-assessment-runs.rst awscli-1.18.69/awscli/examples/inspector/list-assessment-runs.rst --- awscli-1.11.13/awscli/examples/inspector/list-assessment-runs.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/inspector/list-assessment-runs.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,20 +1,16 @@ **To list assessment runs** -The following ``list-assessment-runs`` command lists all existing assessment runs:: +The following ``list-assessment-runs`` command lists all existing assessment runs. :: - aws inspector list-assessment-runs + aws inspector list-assessment-runs Output:: -{ - "assessmentRunArns": - [ - "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE", - "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-v5D6fI3v" - ] -} - -For more information, see `Amazon Inspector Assessment Templates and Assessment Runs`_ in the *Amazon Inspector* guide. - -.. _`Amazon Inspector Assessment Templates and Assessment Runs`: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_assessments.html + { + "assessmentRunArns": [ + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE", + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-v5D6fI3v" + ] + } +For more information, see `Amazon Inspector Assessment Templates and Assessment Runs `_ in the *Amazon Inspector User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/add-thing-to-billing-group.rst awscli-1.18.69/awscli/examples/iot/add-thing-to-billing-group.rst --- awscli-1.11.13/awscli/examples/iot/add-thing-to-billing-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/add-thing-to-billing-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**Example 1: To add a thing by name to a billing group** + +The following ``add-thing-to-billing-group`` example adds the thing named ``MyLightBulb`` to the billing group named ``GroupOne``. :: + + aws iot add-thing-to-billing-group \ + --billing-group-name GroupOne \ + --thing-name MyLightBulb + +This command produces no output. + +**Example 2: To add a thing by ARN to a billing group** + +The following ``add-thing-to-billing-group`` example adds a thing with a specified ARN to a billing group with the specified ARN. Specifying an ARN is helpful if you work with multiple AWS Regions or accounts. It can help ensure that you are adding to the right Region and account. :: + + aws iot add-thing-to-thing-group \ + --billing-group-arn "arn:aws:iot:us-west-2:123456789012:billinggroup/GroupOne" \ + --thing-arn "arn:aws:iot:us-west-2:123456789012:thing/MyOtherLightBulb" + +This command produces no output. + +For more information, see `Billing Groups `__ in the *AWS IoT Developers Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/add-thing-to-thing-group.rst awscli-1.18.69/awscli/examples/iot/add-thing-to-thing-group.rst --- awscli-1.11.13/awscli/examples/iot/add-thing-to-thing-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/add-thing-to-thing-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,12 @@ +**To add a thing to a group** + +The following ``add-thing-to-thing-group`` example adds the specified thing to the specified thing group. :: + + aws iot add-thing-to-thing-group \ + --thing-name MyLightBulb \ + --thing-group-name LightBulbs + +This command produces no output. + +For more information, see `Thing Groups `__ in the *AWS IoT Developers Guide*. + diff -Nru awscli-1.11.13/awscli/examples/iot/associate-targets-with-job.rst awscli-1.18.69/awscli/examples/iot/associate-targets-with-job.rst --- awscli-1.11.13/awscli/examples/iot/associate-targets-with-job.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/associate-targets-with-job.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To associate a thing group with a continuous job** + +The following ``associate-targets-with-job`` example associates the specified thing group with the specified continuous job. :: + + aws iot associate-targets-with-job \ + --targets "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs" \ + --job-id "example-job-04" + +Output:: + + { + "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-04", + "jobId": "example-job-04", + "description": "example continuous job" + } + +For more information, see `Creating and Managing Jobs (CLI) `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/attach-policy.rst awscli-1.18.69/awscli/examples/iot/attach-policy.rst --- awscli-1.11.13/awscli/examples/iot/attach-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/attach-policy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,23 @@ +**Example 1: To attach a policy to a thing group** + +The following ``attach-policy`` example attaches the specified policy to a thing group identified by its ARN. :: + + aws iot attach-policy \ + --target "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs" \ + --policy-name "UpdateDeviceCertPolicy" + +This command does not produce any output. + +For more information, see `Thing Groups `__ in the *AWS IoT Developers Guide*. + +**Example 2: To attach a policy to a certificate** + +The following ``attach-policy`` example attaches the policy ``UpdateDeviceCertPolicy`` to the principal specified by a certificate. :: + + aws iot attach-policy \ + --policy-name UpdateDeviceCertPolicy \ + --target "arn:aws:iot:us-west-2:123456789012:cert/4f0ba725787aa94d67d2fca420eca022242532e8b3c58e7465c7778b443fd65e" + +This command does not produce any output. + +For more information, see `Attach an AWS IoT Policy to a Device Certificate `__ in the *AWS IoT Developers Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/attach-security-profile.rst awscli-1.18.69/awscli/examples/iot/attach-security-profile.rst --- awscli-1.11.13/awscli/examples/iot/attach-security-profile.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/attach-security-profile.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To associate a security profile with all unregistered devices** + +The following ``attach-security-profile`` example associates the AWS IoT Device Defender security profile named ``Testprofile`` with all unregistered devices in the ``us-west-2`` region for this AWS account. :: + + aws iot attach-security-profile \ + --security-profile-name Testprofile \ + --security-profile-target-arn "arn:aws:iot:us-west-2:123456789012:all/unregistered-things" + +This command produces no output. + +For more information, see `Detect Commands `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/attach-thing-principal.rst awscli-1.18.69/awscli/examples/iot/attach-thing-principal.rst --- awscli-1.11.13/awscli/examples/iot/attach-thing-principal.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/attach-thing-principal.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To attach a certificate to your thing** + +The following ``attach-thing-principal`` example attaches a certificate to the MyTemperatureSensor thing. The certificate is identified by an ARN. You can find the ARN for a certificate in the AWS IoT console. :: + + aws iot attach-thing-principal \ + --thing-name MyTemperatureSensor \ + --principal arn:aws:iot:us-west-2:123456789012:cert/2e1eb273792174ec2b9bf4e9b37e6c6c692345499506002a35159767055278e8 + +This command produces no output. + +For more information, see `How to Manage Things with the Registry `__ in the *AWS IoT Developers Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/cancel-audit-mitigation-actions-task.rst awscli-1.18.69/awscli/examples/iot/cancel-audit-mitigation-actions-task.rst --- awscli-1.11.13/awscli/examples/iot/cancel-audit-mitigation-actions-task.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/cancel-audit-mitigation-actions-task.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/iot/cancel-audit-task.rst awscli-1.18.69/awscli/examples/iot/cancel-audit-task.rst --- awscli-1.11.13/awscli/examples/iot/cancel-audit-task.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/cancel-audit-task.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,10 @@ +**To cancel an audit task** + +The following ``cancel-audit-task`` example cancels an audit task with the specified task ID. You cannot cancel a task that is complete. :: + + aws iot cancel-audit-task \ + --task-id a3aea009955e501a31b764abe1bebd3d + +This command produces no output. + +For more information, see `Audit Commands `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/cancel-certificate-transfer.rst awscli-1.18.69/awscli/examples/iot/cancel-certificate-transfer.rst --- awscli-1.11.13/awscli/examples/iot/cancel-certificate-transfer.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/cancel-certificate-transfer.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,10 @@ +**To cancel the transfer a certificate to a different AWS account** + +The following ``cancel-certificate-transfer`` example cancels the transfer of the specified certificate transfer. The certificate is identified by a certificate ID. You can find the ID for a certificate in the AWS IoT console. :: + + aws iot cancel-certificate-transfer \ + --certificate-id f0f33678c7c9a046e5cc87b2b1a58dfa0beec26db78addd5e605d630e05c7fc8 + +This command produces no output. + +For more information, see `CancelCertificateTransfer `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/cancel-job-execution.rst awscli-1.18.69/awscli/examples/iot/cancel-job-execution.rst --- awscli-1.11.13/awscli/examples/iot/cancel-job-execution.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/cancel-job-execution.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To cancel a job execution on a device** + +The following ``cancel-job-execution`` example cancels the execution of the specified job on a device. If the job is not in the ``QUEUED`` state, you must add the ``--force`` parameter. :: + + aws iot cancel-job-execution \ + --job-id "example-job-03" \ + --thing-name "MyRPi" + +This command produces no output. + +For more information, see `Creating and Managing Jobs (CLI) `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/cancel-job.rst awscli-1.18.69/awscli/examples/iot/cancel-job.rst --- awscli-1.11.13/awscli/examples/iot/cancel-job.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/cancel-job.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,16 @@ +**To cancel a job** + +The following ``cancel-job`` example cancels the specified job. :: + + aws iot cancel-job \ + --job-job "example-job-03" + +Output:: + + { + "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-03", + "jobId": "example-job-03", + "description": "example job test" + } + +For more information, see `Creating and Managing Jobs (CLI) `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/clear-default-authorizer.rst awscli-1.18.69/awscli/examples/iot/clear-default-authorizer.rst --- awscli-1.11.13/awscli/examples/iot/clear-default-authorizer.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/clear-default-authorizer.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To clear the default authorizer** + +The following ``clear-default-authorizer`` example clears the currently configured default custom authorizer. After you run this command, there is no default authorizer. When you use a custom authorizer, you must specify it by name in the HTTP request headers. :: + + aws iot clear-default-authorizer + +This command produces no output. + +For more information, see `ClearDefaultAuthorizer `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/create-authorizer.rst awscli-1.18.69/awscli/examples/iot/create-authorizer.rst --- awscli-1.11.13/awscli/examples/iot/create-authorizer.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/create-authorizer.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,27 @@ +**To create a custom authorizer** + +The following ``create-authorizer`` example creates a custom authorizer that uses the specified Lambda function as part of a custom authentication service. :: + + aws iot create-authorizer \ + --authorizer-name "CustomAuthorizer" \ + --authorizer-function-arn "arn:aws:lambda:us-west-2:123456789012:function:CustomAuthorizerFunction" \ + --token-key-name "MyAuthToken" \ + --status ACTIVE \ + --token-signing-public-keys FIRST_KEY="-----BEGIN PUBLIC KEY----- + MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA1uJOB4lQPgG/lM6ZfIwo + Z+7ENxAio9q6QD4FFqjGZsvjtYwjoe1RKK0U8Eq9xb5O3kRSmyIwTzwzm/f4Gf0Y + ZUloJ+t3PUUwHrmbYTAgTrCUgRFygjfgVwGCPs5ZAX4Eyqt5cr+AIHIiUDbxSa7p + zwOBKPeic0asNJpqT8PkBbRaKyleJh5oo81NDHHmVtbBm5A5YiJjqYXLaVAowKzZ + +GqsNvAQ9Jy1wI2VrEa1OfL8flDB/BJLm7zjpfPOHDJQgID0XnZwAlNnZcOhCwIx + 50g2LW2Oy9R/dmqtDmJiVP97Z4GykxPvwlYHrUXY0iW1R3AR/Ac1NhCTGZMwVDB1 + lQIDAQAB + -----END PUBLIC KEY-----" + +Output:: + + { + "authorizerName": "CustomAuthorizer", + "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer2" + } + +For more information, see `CreateAuthorizer `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/create-billing-group.rst awscli-1.18.69/awscli/examples/iot/create-billing-group.rst --- awscli-1.11.13/awscli/examples/iot/create-billing-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/create-billing-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,16 @@ +**To create a billing group** + +The following ``create-billing-group`` example creates a simple billing group named ``GroupOne``. :: + + aws iot create-billing-group \ + --billing-group-name GroupOne + +Output:: + + { + "billingGroupName": "GroupOne", + "billingGroupArn": "arn:aws:iot:us-west-2:123456789012:billinggroup/GroupOne", + "billingGroupId": "103de383-114b-4f51-8266-18f209ef5562" + } + +For more information, see `Billing Groups `__ in the *AWS IoT Developers Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/create-certificate-from-csr.rst awscli-1.18.69/awscli/examples/iot/create-certificate-from-csr.rst --- awscli-1.11.13/awscli/examples/iot/create-certificate-from-csr.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/create-certificate-from-csr.rst 2020-05-28 19:25:48.000000000 +0000 @@ -1,36 +1,16 @@ -Create Batches of Certificates from Batches of CSRs ---------------------------------------------------- -The following example shows how to create a batch of certificates given a -batch of CSRs. Assuming a set of CSRs are located inside of the -directory ``my-csr-directory``:: +**To create a device certificate from a certificate signing request (CSR)** - $ ls my-csr-directory/ - csr.pem csr2.pem +The following ``create-certificate-from-csr`` example creates a device certificate from a CSR. You can use the ``openssl`` command to create a CSR. :: + aws iot create-certificate-from-csr \ + --certificate-signing-request=file://certificate.csr -a certificate can be created for each CSR in that directory -using a single command. On Linux and OSX, this command is:: +Output:: - $ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{} + { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/c0c57bbc8baaf4631a9a0345c957657f5e710473e3ddbee1428d216d54d53ac9", + "certificateId": "c0c57bbc8baaf4631a9a0345c957657f5e710473e3ddbee1428d216d54d53ac9", + "certificatePem": "" + } - -This command lists all of the CSRs in ``my-csr-directory`` and -pipes each CSR filename to the ``aws iot create-certificate-from-csr`` AWS CLI -command to create a certificate for the corresponding CSR. - -The ``aws iot create-certificate-from-csr`` part of the command can also be -ran in parallel to speed up the certificate creation process:: - - $ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{} - - -On Windows PowerShell, the command to create certificates for all CSRs -in ``my-csr-directory`` is:: - - > ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_} - - -On Windows Command Prompt, the command to create certificates for all CSRs -in ``my-csr-directory`` is:: - - > forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path" +For more information, see `CreateCertificateFromCSR `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/create-dimension.rst awscli-1.18.69/awscli/examples/iot/create-dimension.rst --- awscli-1.11.13/awscli/examples/iot/create-dimension.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/create-dimension.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,17 @@ +**To create a dimension** + +The following ``create-dimension`` creates a dimension with a single topic filter called ``TopicFilterForAuthMessages``. :: + + aws iot create-dimension \ + --name TopicFilterForAuthMessages \ + --type TOPIC_FILTER \ + --string-values device/+/auth + +Output:: + + { + "name": "TopicFilterForAuthMessages", + "arn": "arn:aws:iot:eu-west-2:123456789012:dimension/TopicFilterForAuthMessages" + } + +For more information, see `Detect Commands `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/create-domain-configuration.rst awscli-1.18.69/awscli/examples/iot/create-domain-configuration.rst --- awscli-1.11.13/awscli/examples/iot/create-domain-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/create-domain-configuration.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/iot/create-dynamic-thing-group.rst awscli-1.18.69/awscli/examples/iot/create-dynamic-thing-group.rst --- awscli-1.11.13/awscli/examples/iot/create-dynamic-thing-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/create-dynamic-thing-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**To create a dynamic thing group** + +The following ``create-dynamic-thing-group`` example creates a dynamic thing group that contains any thing with a temperature attribute that is greater than 60 degrees. You must enable AWS IoT fleet indexing before you can use dynamic thing groups. :: + + aws iot create-dynamic-thing-group \ + --thing-group-name "RoomTooWarm" \ + --query-string "attributes.temperature>60" + +Output:: + + { + "thingGroupName": "RoomTooWarm", + "thingGroupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/RoomTooWarm", + "thingGroupId": "9d52492a-fc87-43f4-b6e2-e571d2ffcad1", + "indexName": "AWS_Things", + "queryString": "attributes.temperature>60", + "queryVersion": "2017-09-30" + } + +For more information, see `Dynamic Thing Groups `__ in the *AWS IoT Developers Guide*. + diff -Nru awscli-1.11.13/awscli/examples/iot/create-job.rst awscli-1.18.69/awscli/examples/iot/create-job.rst --- awscli-1.11.13/awscli/examples/iot/create-job.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/create-job.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,38 @@ +**Example 1: To create a job** + +The following ``create-job`` example creates a simple AWS IoT job that sends a JSON document to the ``MyRaspberryPi`` device. :: + + aws iot create-job \ + --job-id "example-job-01" \ + --targets "arn:aws:iot:us-west-2:123456789012:thing/MyRaspberryPi" \ + --document file://example-job.json \ + --description "example job test" \ + --target-selection SNAPSHOT + +Output:: + + { + "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-01", + "jobId": "example-job-01", + "description": "example job test" + } + +**Example 2: To create a continuous job** + +The following ``create-job`` example creates a job that continues to run after the things specified as targets have completed the job. In this example, the target is a thing group, so when new devices are added to the group, the continuous job runs on those new things. + + aws iot create-job \ + --job-id "example-job-04" \ + --targets "arn:aws:iot:us-west-2:123456789012:thinggroup/DeadBulbs" \ + --document file://example-job.json --description "example continuous job" \ + --target-selection CONTINUOUS + +Output:: + + { + "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-04", + "jobId": "example-job-04", + "description": "example continuous job" + } + +For more information, see `Creating and Managing Jobs (CLI) `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/create-keys-and-certificate.rst awscli-1.18.69/awscli/examples/iot/create-keys-and-certificate.rst --- awscli-1.11.13/awscli/examples/iot/create-keys-and-certificate.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/create-keys-and-certificate.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,38 @@ +**To create an RSA key pair and issue an X.509 certificate** + +The following ``create-keys-and-certificate`` creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key. Because this is the only time that AWS IoT provides the private key for this certificate, be sure to keep it in a secure location. :: + + aws iot create-keys-and-certificate \ + --certificate-pem-outfile "myTest.cert.pem" \ + --public-key-outfile "myTest.public.key" \ + --private-key-outfile "myTest.private.key" + +Output:: + + { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/9894ba17925e663f1d29c23af4582b8e3b7619c31f3fbd93adcb51ae54b83dc2", + "certificateId": "9894ba17925e663f1d29c23af4582b8e3b7619c31f3fbd93adcb51ae54b83dc2", + "certificatePem": " + -----BEGIN CERTIFICATE----- + MIICiTCCEXAMPLE6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC + VVMxCzAJBgNVBAgEXAMPLEAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 + b24xFDASBgNVBAsTC0lBTSEXAMPLE2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd + BgkqhkiG9w0BCQEWEG5vb25lQGFtYEXAMPLEb20wHhcNMTEwNDI1MjA0NTIxWhcN + MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCEXAMPLEJBgNVBAgTAldBMRAwDgYD + VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDAEXAMPLEsTC0lBTSBDb25z + b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEXAMPLE25lQGFt + YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+aEXAMPLE + EXAMPLEfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T + rDHudUZEXAMPLELG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE + Ibb3OhjZnzcvQAEXAMPLEWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4 + nUhVVxYUntneD9+h8Mg9qEXAMPLEyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb + FFBjvSfpJIlJ00zbhNYS5f6GuoEDEXAMPLEBHjJnyp378OD8uTs7fLvjx79LjSTb + NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE= + -----END CERTIFICATE-----\n", + "keyPair": { + "PublicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkEXAMPLEQEFAAOCAQ8AMIIBCgKCAQEAEXAMPLE1nnyJwKSMHw4h\nMMEXAMPLEuuN/dMAS3fyce8DW/4+EXAMPLEyjmoF/YVF/gHr99VEEXAMPLE5VF13\n59VK7cEXAMPLE67GK+y+jikqXOgHh/xJTwo+sGpWEXAMPLEDz18xOd2ka4tCzuWEXAMPLEahJbYkCPUBSU8opVkR7qkEXAMPLE1DR6sx2HocliOOLtu6Fkw91swQWEXAMPLE\GB3ZPrNh0PzQYvjUStZeccyNCx2EXAMPLEvp9mQOUXP6plfgxwKRX2fEXAMPLEDa\nhJLXkX3rHU2xbxJSq7D+XEXAMPLEcw+LyFhI5mgFRl88eGdsAEXAMPLElnI9EesG\nFQIDAQAB\n-----END PUBLIC KEY-----\n", + "PrivateKey": "-----BEGIN RSA PRIVATE KEY-----\nkey omittted for security reasons\n-----END RSA PRIVATE KEY-----\n" + } + } + +For more infomration, see `Create and Register an AWS IoT Device Certificate `__ in the **AWS IoT Developer Guide**. diff -Nru awscli-1.11.13/awscli/examples/iot/create-mitigation-action.rst awscli-1.18.69/awscli/examples/iot/create-mitigation-action.rst --- awscli-1.11.13/awscli/examples/iot/create-mitigation-action.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/create-mitigation-action.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/iot/create-ota-update.rst awscli-1.18.69/awscli/examples/iot/create-ota-update.rst --- awscli-1.11.13/awscli/examples/iot/create-ota-update.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/create-ota-update.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,50 @@ +**To create an OTA update for use with Amazon FreeRTOS** + +The following ``create-ota-update`` example creates an AWS IoT OTAUpdate on a target group of things or groups. This is part of an Amazon FreeRTOS over-the-air update which makes it possible for you to deploy new firmware images to a single device or a group of devices. :: + + aws iot create-ota-update \ + --cli-input-json file://create-ota-update.json + +Contents of ``create-ota-update.json``:: + + { + "otaUpdateId": "ota12345", + "description": "A critical update needed right away.", + "targets": [ + "device1", + "device2", + "device3", + "device4" + ], + "targetSelection": "SNAPSHOT", + "awsJobExecutionsRolloutConfig": { + "maximumPerMinute": 10 + }, + "files": [ + { + "fileName": "firmware.bin", + "fileLocation": { + "stream": { + "streamId": "004", + "fileId":123 + } + }, + "codeSigning": { + "awsSignerJobId": "48c67f3c-63bb-4f92-a98a-4ee0fbc2bef6" + } + } + ] + "roleArn": "arn:aws:iam:123456789012:role/service-role/my_ota_role" + } + +Output:: + + { + "otaUpdateId": "ota12345", + "awsIotJobId": "job54321", + "otaUpdateArn": "arn:aws:iot:us-west-2:123456789012:otaupdate/itsaupdate", + "awsIotJobArn": "arn:aws:iot:us-west-2:123456789012:job/itsajob", + "otaUpdateStatus": "CREATE_IN_PROGRESS" + } + +For more information, see `CreateOTAUpdate `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/create-policy.rst awscli-1.18.69/awscli/examples/iot/create-policy.rst --- awscli-1.11.13/awscli/examples/iot/create-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/create-policy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,90 @@ +**To create an AWS IoT policy** + +The following ``create-policy`` example creates an AWS IoT policy named TemperatureSensorPolicy. The ``policy.json`` file contains statements that allow AWS IoT policy actions. :: + + aws iot create-policy \ + --policy-name TemperatureSensorPolicy \ + --policy-document file://policy.json + +Contents of ``policy.json``:: + + { + "Version": "2012-10-17", + "Statement": [ + { + "Effect": "Allow", + "Action": [ + "iot:Publish", + "iot:Receive" + ], + "Resource": [ + "arn:aws:iot:us-west-2:123456789012:topic/topic_1", + "arn:aws:iot:us-west-2:123456789012:topic/topic_2" + ] + }, + { + "Effect": "Allow", + "Action": [ + "iot:Subscribe" + ], + "Resource": [ + "arn:aws:iot:us-west-2:123456789012:topicfilter/topic_1", + "arn:aws:iot:us-west-2:123456789012:topicfilter/topic_2" + ] + }, + { + "Effect": "Allow", + "Action": [ + "iot:Connect" + ], + "Resource": [ + "arn:aws:iot:us-west-2:123456789012:client/basicPubSub" + ] + } + ] + } + +Output:: + + { + "policyName": "TemperatureSensorPolicy", + "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/TemperatureSensorPolicy", + "policyDocument": "{ + \"Version\": \"2012-10-17\", + \"Statement\": [ + { + \"Effect\": \"Allow\", + \"Action\": [ + \"iot:Publish\", + \"iot:Receive\" + ], + \"Resource\": [ + \"arn:aws:iot:us-west-2:123456789012:topic/topic_1\", + \"arn:aws:iot:us-west-2:123456789012:topic/topic_2\" + ] + }, + { + \"Effect\": \"Allow\", + \"Action\": [ + \"iot:Subscribe\" + ], + \"Resource\": [ + \"arn:aws:iot:us-west-2:123456789012:topicfilter/topic_1\", + \"arn:aws:iot:us-west-2:123456789012:topicfilter/topic_2\" + ] + }, + { + \"Effect\": \"Allow\", + \"Action\": [ + \"iot:Connect\" + ], + \"Resource\": [ + \"arn:aws:iot:us-west-2:123456789012:client/basicPubSub\" + ] + } + ] + }", + "policyVersionId": "1" + } + +For more information, see `AWS IoT Policies `__ in the *AWS IoT Developers Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/create-policy-version.rst awscli-1.18.69/awscli/examples/iot/create-policy-version.rst --- awscli-1.11.13/awscli/examples/iot/create-policy-version.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/create-policy-version.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,32 @@ +**To update a policy with a new version** + +The following ``create-policy-version`` example updates a policy definition, creating a new policy version. This example also makes the new version the default. :: + + aws iot create-policy-version \ + --policy-name UpdateDeviceCertPolicy \ + --policy-document file://policy.json \ + --set-as-default + +Contents of ``policy.json``:: + + { + "Version": "2012-10-17", + "Statement": [ + { + "Effect": "Allow", + "Action": "iot:UpdateCertificate", + "Resource": "*" + } + ] + } + +Output:: + + { + "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/UpdateDeviceCertPolicy", + "policyDocument": "{ \"Version\": \"2012-10-17\", \"Statement\": [ { \"Effect\": \"Allow\", \"Action\": \"iot:UpdateCertificate\", \"Resource\": \"*\" } ] }", + "policyVersionId": "2", + "isDefaultVersion": true + } + +For more information, see `AWS IoT Policies `__ in the *AWS IoT Developers Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/create-provisioning-template.rst awscli-1.18.69/awscli/examples/iot/create-provisioning-template.rst --- awscli-1.11.13/awscli/examples/iot/create-provisioning-template.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/create-provisioning-template.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,82 @@ +**To create a provisioning template** + +The following ``create-provisioning-template`` example creates a provisioning template as defined by the file ``template.json``. :: + + aws iot create-provisioning-template \ + --template-name widget-template \ + --description "A provisioning template for widgets" \ + --provisioning-role-arn arn:aws:iam::123456789012:role/Provision_role \ + --template-body file://template.json + +Contents of ``template.json``:: + + { + "Parameters" : { + "DeviceLocation": { + "Type": "String" + } + }, + "Mappings": { + "LocationTable": { + "Seattle": { + "LocationUrl": "https://example.aws" + } + } + }, + "Resources" : { + "thing" : { + "Type" : "AWS::IoT::Thing", + "Properties" : { + "AttributePayload" : { + "version" : "v1", + "serialNumber" : "serialNumber" + }, + "ThingName" : {"Fn::Join":["",["ThingPrefix_",{"Ref":"SerialNumber"}]]}, + "ThingTypeName" : {"Fn::Join":["",["ThingTypePrefix_",{"Ref":"SerialNumber"}]]}, + "ThingGroups" : ["widgets", "WA"], + "BillingGroup": "BillingGroup" + }, + "OverrideSettings" : { + "AttributePayload" : "MERGE", + "ThingTypeName" : "REPLACE", + "ThingGroups" : "DO_NOTHING" + } + }, + "certificate" : { + "Type" : "AWS::IoT::Certificate", + "Properties" : { + "CertificateId": {"Ref": "AWS::IoT::Certificate::Id"}, + "Status" : "Active" + } + }, + "policy" : { + "Type" : "AWS::IoT::Policy", + "Properties" : { + "PolicyDocument" : { + "Version": "2012-10-17", + "Statement": [{ + "Effect": "Allow", + "Action":["iot:Publish"], + "Resource": ["arn:aws:iot:us-east-1:504350838278:topic/foo/bar"] + }] + } + } + } + }, + "DeviceConfiguration": { + "FallbackUrl": "https://www.example.com/test-site", + "LocationUrl": { + "Fn::FindInMap": ["LocationTable",{"Ref": "DeviceLocation"}, "LocationUrl"]} + } + } + } + +Output:: + + { + "templateArn": "arn:aws:iot:us-east-1:123456789012:provisioningtemplate/widget-template", + "templateName": "widget-template", + "defaultVersionId": 1 + } + +For more information, see `AWS IoT Secure Tunneling `__ in the *AWS IoT Core Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/create-provisioning-template-version.rst awscli-1.18.69/awscli/examples/iot/create-provisioning-template-version.rst --- awscli-1.11.13/awscli/examples/iot/create-provisioning-template-version.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/create-provisioning-template-version.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,81 @@ +**To create a provisioning template version** + +The following example creates a version for the specified provisioning template. The body of the new version is supplied in the file ``template.json``. :: + + aws iot create-provisioning-template-version \ + --template-name widget-template \ + --template-body file://template.json + +Contents of ``template.json``:: + + { + "Parameters" : { + "DeviceLocation": { + "Type": "String" + } + }, + "Mappings": { + "LocationTable": { + "Seattle": { + "LocationUrl": "https://example.aws" + } + } + }, + "Resources" : { + "thing" : { + "Type" : "AWS::IoT::Thing", + "Properties" : { + "AttributePayload" : { + "version" : "v1", + "serialNumber" : "serialNumber" + }, + "ThingName" : {"Fn::Join":["",["ThingPrefix_",{"Ref":"SerialNumber"}]]}, + "ThingTypeName" : {"Fn::Join":["",["ThingTypePrefix_",{"Ref":"SerialNumber"}]]}, + "ThingGroups" : ["widgets", "WA"], + "BillingGroup": "BillingGroup" + }, + "OverrideSettings" : { + "AttributePayload" : "MERGE", + "ThingTypeName" : "REPLACE", + "ThingGroups" : "DO_NOTHING" + } + }, + "certificate" : { + "Type" : "AWS::IoT::Certificate", + "Properties" : { + "CertificateId": {"Ref": "AWS::IoT::Certificate::Id"}, + "Status" : "Active" + } + }, + "policy" : { + "Type" : "AWS::IoT::Policy", + "Properties" : { + "PolicyDocument" : { + "Version": "2012-10-17", + "Statement": [{ + "Effect": "Allow", + "Action":["iot:Publish"], + "Resource": ["arn:aws:iot:us-east-1:123456789012:topic/foo/bar"] + }] + } + } + } + }, + "DeviceConfiguration": { + "FallbackUrl": "https://www.example.com/test-site", + "LocationUrl": { + "Fn::FindInMap": ["LocationTable",{"Ref": "DeviceLocation"}, "LocationUrl"]} + } + } + } + +Output:: + + { + "templateArn": "arn:aws:iot:us-east-1:123456789012:provisioningtemplate/widget-template", + "templateName": "widget-template", + "versionId": 2, + "isDefaultVersion": false + } + +For more information, see `AWS IoT Secure Tunneling `__ in the *AWS IoT Core Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/create-role-alias.rst awscli-1.18.69/awscli/examples/iot/create-role-alias.rst --- awscli-1.11.13/awscli/examples/iot/create-role-alias.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/create-role-alias.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,16 @@ +**To create a role alias** + +The following ``create-role-alias`` example creates a role alias called ``LightBulbRole`` for the specified role. :: + + aws iot create-role-alias \ + --role-alias LightBulbRole \ + --role-arn arn:aws:iam::123456789012:role/lightbulbrole-001 + +Output:: + + { + "roleAlias": "LightBulbRole", + "roleAliasArn": "arn:aws:iot:us-west-2:123456789012:rolealias/LightBulbRole" + } + +For more information, see `CreateRoleAlias `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/create-scheduled-audit.rst awscli-1.18.69/awscli/examples/iot/create-scheduled-audit.rst --- awscli-1.11.13/awscli/examples/iot/create-scheduled-audit.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/create-scheduled-audit.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To create a scheduled audit** + +The following ``create-scheduled-audit`` example creates a scheduled audit that runs weekly, on Wednesday, to check if CA certificates or device certificates are expiring. :: + + aws iot create-scheduled-audit \ + --scheduled-audit-name WednesdayCertCheck \ + --frequency WEEKLY \ + --day-of-week WED \ + --target-check-names CA_CERTIFICATE_EXPIRING_CHECK DEVICE_CERTIFICATE_EXPIRING_CHECK + +Output:: + + { + "scheduledAuditArn": "arn:aws:iot:us-west-2:123456789012:scheduledaudit/WednesdayCertCheck" + } + +For more information, see `Audit Commands `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/create-security-profile.rst awscli-1.18.69/awscli/examples/iot/create-security-profile.rst --- awscli-1.11.13/awscli/examples/iot/create-security-profile.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/create-security-profile.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To create a security profile** + +The following ``create-security-profile`` example creates a security profile that checks if cellular bandwidth exceeds a threshold or if more than 10 authorization failures occur within a five-minute period. :: + + aws iot create-security-profile \ + --security-profile-name PossibleIssue \ + --security-profile-description "Check to see if authorization fails 10 times in 5 minutes or if cellular bandwidth exceeds 128" \ + --behaviors "[{\"name\":\"CellularBandwidth\",\"metric\":\"aws:message-byte-size\",\"criteria\":{\"comparisonOperator\":\"greater-than\",\"value\":{\"count\":128},\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}},{\"name\":\"Authorization\",\"metric\":\"aws:num-authorization-failures\",\"criteria\":{\"comparisonOperator\":\"less-than\",\"value\":{\"count\":10},\"durationSeconds\":300,\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}}]" + +Output:: + + { + "securityProfileName": "PossibleIssue", + "securityProfileArn": "arn:aws:iot:us-west-2:123456789012:securityprofile/PossibleIssue" + } + +For more information, see `Detect Commands `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/create-stream.rst awscli-1.18.69/awscli/examples/iot/create-stream.rst --- awscli-1.11.13/awscli/examples/iot/create-stream.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/create-stream.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,34 @@ +**To create a stream for delivering one or more large files in chunks over MQTT** + +The following ``create-stream`` example creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files associated with a stream. :: + + aws iot create-stream \ + --cli-input-json file://create-stream.json + +Contents of ``create-stream.json``:: + + { + "streamId": "stream12345", + "description": "This stream is used for Amazon FreeRTOS OTA Update 12345.", + "files": [ + { + "fileId": 123, + "s3Location": { + "bucket":"codesign-ota-bucket", + "key":"48c67f3c-63bb-4f92-a98a-4ee0fbc2bef6" + } + } + ] + "roleArn": "arn:aws:iam:123456789012:role/service-role/my_ota_stream_role" + } + +Output:: + + { + "streamId": "stream12345", + "streamArn": "arn:aws:iot:us-west-2:123456789012:stream/stream12345", + "description": "This stream is used for Amazon FreeRTOS OTA Update 12345.", + "streamVersion": "1" + } + +For more information, see `CreateStream `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/create-thing-group.rst awscli-1.18.69/awscli/examples/iot/create-thing-group.rst --- awscli-1.11.13/awscli/examples/iot/create-thing-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/create-thing-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,33 @@ +**Example 1: To create a thing group** + +The following ``create-thing-group`` example creates a thing group named ``LightBulbs`` with a description and two attributes. :: + + aws iot create-thing-group \ + --thing-group-name LightBulbs \ + --thing-group-properties "thingGroupDescription=\"Generic bulb group\", attributePayload={attributes={Manufacturer=AnyCompany,wattage=60}}" + +Output:: + + { + "thingGroupName": "LightBulbs", + "thingGroupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs", + "thingGroupId": "9198bf9f-1e76-4a88-8e8c-e7140142c331" + } + +**Example 2: To create a thing group that's part of a parent group** + +The following ``create-thing-group`` creates a thing group named ``HalogenBulbs`` that has a parent thing group named ``LightBulbs``. :: + + aws iot create-thing-group \ + --thing-group-name HalogenBulbs \ + --parent-group-name LightBulbs + +Output:: + + { + "thingGroupName": "HalogenBulbs", + "thingGroupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/HalogenBulbs", + "thingGroupId": "f4ec6b84-b42b-499d-9ce1-4dbd4d4f6f6e" + } + +For more information, see `Thing Groups `__ in the *AWS IoT Developers Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/create-thing.rst awscli-1.18.69/awscli/examples/iot/create-thing.rst --- awscli-1.11.13/awscli/examples/iot/create-thing.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/create-thing.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,33 @@ +**Example 1: To create a thing record in the registry** + +The following ``create-thing`` example creates an entry for a device in the AWS IoT thing registry. :: + + aws iot create-thing \ + --thing-name SampleIoTThing + +Output:: + + { + "thingName": "SampleIoTThing", + "thingArn": "arn:aws:iot:us-west-2: 123456789012:thing/SampleIoTThing", + "thingId": " EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE " + } + +**Example 2: To define a thing that is associated with a thing type** + +The following ``create-thing`` example create a thing that has the specified thing type and its attributes. :: + + aws iot create-thing \ + --thing-name "MyLightBulb" \ + --thing-type-name "LightBulb" \ + --attribute-payload "{"attributes": {"wattage":"75", "model":"123"}}" + +Output:: + + { + "thingName": "MyLightBulb", + "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyLightBulb", + "thingId": "40da2e73-c6af-406e-b415-15acae538797" + } + +For more information, see `How to Manage Things with the Registry `__ and `Thing Types `__ in the *AWS IoT Developers Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/create-thing-type.rst awscli-1.18.69/awscli/examples/iot/create-thing-type.rst --- awscli-1.11.13/awscli/examples/iot/create-thing-type.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/create-thing-type.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,17 @@ +**To define a thing type** + +The following ``create-thing-type`` example defines a thing type and associated attributes. :: + + aws iot create-thing-type \ + --thing-type-name "LightBulb" \ + --thing-type-properties "thingTypeDescription=light bulb type, searchableAttributes=wattage,model" + +Output:: + + { + "thingTypeName": "LightBulb", + "thingTypeArn": "arn:aws:iot:us-west-2:123456789012:thingtype/LightBulb", + "thingTypeId": "ce3573b0-0a3c-45a7-ac93-4e0ce14cd190" + } + +For more information, see `Thing Types `__ in the *AWS IoT Developers Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/create-topic-rule.rst awscli-1.18.69/awscli/examples/iot/create-topic-rule.rst --- awscli-1.11.13/awscli/examples/iot/create-topic-rule.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/create-topic-rule.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,28 @@ +**To create a rule that sends an Amazon SNS alert** + +The following ``create-topic-rule`` example creates a rule that sends an Amazon SNS message when soil moisture level readings, as found in a device shadow, are low. :: + + aws iot create-topic-rule \ + --rule-name "LowMoistureRule" \ + --topic-rule-payload file://plant-rule.json + +The example requires the following JSON code to be saved to a file named ``plant-rule.json``:: + + { + "sql": "SELECT * FROM '$aws/things/MyRPi/shadow/update/accepted' WHERE state.reported.moisture = 'low'\n", + "description": "Sends an alert whenever soil moisture level readings are too low.", + "ruleDisabled": false, + "awsIotSqlVersion": "2016-03-23", + "actions": [{ + "sns": { + "targetArn": "arn:aws:sns:us-west-2:123456789012:MyRPiLowMoistureTopic", + "roleArn": "arn:aws:iam::123456789012:role/service-role/MyRPiLowMoistureTopicRole", + "messageFormat": "RAW" + } + }] + } + +This command produces no output. + +For more information, see `Creating an AWS IoT Rule `__ in the *AWS IoT Developers Guide*. + diff -Nru awscli-1.11.13/awscli/examples/iot/delete-account-audit-configuration.rst awscli-1.18.69/awscli/examples/iot/delete-account-audit-configuration.rst --- awscli-1.11.13/awscli/examples/iot/delete-account-audit-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/delete-account-audit-configuration.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,10 @@ +**To disable all audit checks for your AWS account** + +The following ``delete-account-audit-configuration`` example restores the default settings for AWS IoT Device Defender for this account, disabling all audit checks and clearing configuration data. It also deletes any scheduled audits for this account. **Use this command with caution.** :: + + aws iot delete-account-audit-configuration \ + --delete-scheduled-audits + +This command produces no output. + +For more information, see `Audit Commands `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/delete-authorizer.rst awscli-1.18.69/awscli/examples/iot/delete-authorizer.rst --- awscli-1.11.13/awscli/examples/iot/delete-authorizer.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/delete-authorizer.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a custom authorizer** + +The following ``delete-authorizer`` example deletes the authorizer named ``CustomAuthorizer``. A custom authorizer must be in the ``INACTIVE`` state before you can delete it. :: + + aws iot delete-authorizer \ + --authorizer-name CustomAuthorizer + +This command produces no output. + +For more information, see `DeleteAuthorizer `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/delete-billing-group.rst awscli-1.18.69/awscli/examples/iot/delete-billing-group.rst --- awscli-1.11.13/awscli/examples/iot/delete-billing-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/delete-billing-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To delete a billing group** + +The following ``delete-billing-group`` example deletes the specified billing group. You can delete a billing group even if it contains one or more things. :: + + aws iot delete-billing-group \ + --billing-group-name BillingGroupTwo + +This command does not produce any output. + +For more information, see `Billing Groups `__ in the *AWS IoT Developers Guide*. + diff -Nru awscli-1.11.13/awscli/examples/iot/delete-ca-certificate.rst awscli-1.18.69/awscli/examples/iot/delete-ca-certificate.rst --- awscli-1.11.13/awscli/examples/iot/delete-ca-certificate.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/delete-ca-certificate.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a CA certificate** + +The following ``delete-ca-certificate`` example deletes the CA certificate with the specified certificate ID. :: + + aws iot delete-ca-certificate \ + --certificate-id f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467 + +This command produces no output. + +For more information, see `DeleteCACertificate `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/delete-certificate.rst awscli-1.18.69/awscli/examples/iot/delete-certificate.rst --- awscli-1.11.13/awscli/examples/iot/delete-certificate.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/delete-certificate.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a device certificate** + +The following ``delete-certificate`` example deletes the device certificate with the specified ID. :: + + aws iot delete-certificate \ + --certificate-id c0c57bbc8baaf4631a9a0345c957657f5e710473e3ddbee1428d216d54d53ac9 + +This command produces no output. + +For more information, see `DeleteCertificate `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/delete-dimension.rst awscli-1.18.69/awscli/examples/iot/delete-dimension.rst --- awscli-1.11.13/awscli/examples/iot/delete-dimension.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/delete-dimension.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a dimension** + +The following ``delete-dimension`` example deletes a dimension called ``TopicFilterForAuthMessages``. :: + + aws iot delete-dimension \ + --name TopicFilterForAuthMessages + +This command produces no output. + +For more information, see `Detect Commands `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/delete-domain-configuration.rst awscli-1.18.69/awscli/examples/iot/delete-domain-configuration.rst --- awscli-1.11.13/awscli/examples/iot/delete-domain-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/delete-domain-configuration.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/iot/delete-dynamic-thing-group.rst awscli-1.18.69/awscli/examples/iot/delete-dynamic-thing-group.rst --- awscli-1.11.13/awscli/examples/iot/delete-dynamic-thing-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/delete-dynamic-thing-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a dynamic thing group** + +The following ``delete-dynamic-thing-group`` example deletes the specified dynamic thing group. :: + + aws iot delete-dynamic-thing-group \ + --thing-group-name "RoomTooWarm" + +This command produces no output. + +For more information, see `Dynamic Thing Groups `__ in the *AWS IoT Developers Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/delete-job-execution.rst awscli-1.18.69/awscli/examples/iot/delete-job-execution.rst --- awscli-1.11.13/awscli/examples/iot/delete-job-execution.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/delete-job-execution.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,12 @@ +**To delete a job execution** + +The following ``delete-job-execution`` example deletes the job execution of the specified job on a device. Use ``describe-job-execution`` to get the execution number. :: + + aws iot delete-job-execution + --job-id "example-job-02" + --thing-name "MyRaspberryPi" + --execution-number 1 + +This command produces no output. + +For more information, see `Creating and Managing Jobs (CLI) `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/delete-job.rst awscli-1.18.69/awscli/examples/iot/delete-job.rst --- awscli-1.11.13/awscli/examples/iot/delete-job.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/delete-job.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To delete a job** + +The following ``delete-job`` example deletes the specified job. By specifying the ``--force`` option, the job is deleted even if the status is ``IN_PROGRESS``. :: + + aws iot delete-job \ + --job-id "example-job-04" \ + --force + +This command produces no output. + +For more information, see `Creating and Managing Jobs (CLI) `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/delete-mitigation-action.rst awscli-1.18.69/awscli/examples/iot/delete-mitigation-action.rst --- awscli-1.11.13/awscli/examples/iot/delete-mitigation-action.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/delete-mitigation-action.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/iot/delete-ota-update.rst awscli-1.18.69/awscli/examples/iot/delete-ota-update.rst --- awscli-1.11.13/awscli/examples/iot/delete-ota-update.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/delete-ota-update.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,12 @@ +**To delete an OTA update** + +The following ``delete-ota-update`` example deletes the specified OTA update. :: + + aws iot delete-ota-update \ + --ota-update-id ota12345 \ + --delete-stream \ + --force-delete-aws-job + +This command produces no output. + +For more information, see `DeleteOTAUpdate `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/delete-policy.rst awscli-1.18.69/awscli/examples/iot/delete-policy.rst --- awscli-1.11.13/awscli/examples/iot/delete-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/delete-policy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To delete a policy** + +The following ``delete-policy`` example deletes the specified policy from your AWS account. :: + + aws iot delete-policy --policy-name UpdateDeviceCertPolicy + +This command produces no output. + +For more information, see `AWS IoT Policies `__ in the *AWS IoT Developers Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/delete-policy-version.rst awscli-1.18.69/awscli/examples/iot/delete-policy-version.rst --- awscli-1.11.13/awscli/examples/iot/delete-policy-version.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/delete-policy-version.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To delete a version of policy** + +The following ``delete-policy-version`` example deletes version 2 of the specified policy from your AWS account. :: + + aws iot delete-policy-version \ + --policy-name UpdateDeviceCertPolicy \ + --policy-version-id 2 + +This command produces no output. + +For more information, see `AWS IoT Policies `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/delete-provisioning-template.rst awscli-1.18.69/awscli/examples/iot/delete-provisioning-template.rst --- awscli-1.11.13/awscli/examples/iot/delete-provisioning-template.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/delete-provisioning-template.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a provisioning template** + +The following ``delete-provisioning-template`` example deletes the specified provisioning template. :: + + aws iot delete-provisioning-template \ + --template-name widget-template + +This command produces no output. + +For more information, see `AWS IoT Secure Tunneling `__ in the *AWS IoT Core Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/delete-provisioning-template-version.rst awscli-1.18.69/awscli/examples/iot/delete-provisioning-template-version.rst --- awscli-1.11.13/awscli/examples/iot/delete-provisioning-template-version.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/delete-provisioning-template-version.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To delete a provisioning template version** + +The following ``delete-provisioning-template-version`` example deletes version 2 of the specified provisioning template. :: + + aws iot delete-provisioning-template-version \ + --version-id 2 \ + --template-name "widget-template" + +This command produces no output. + +For more information, see `AWS IoT Secure Tunneling `__ in the *AWS IoT Core Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/delete-registration-code.rst awscli-1.18.69/awscli/examples/iot/delete-registration-code.rst --- awscli-1.11.13/awscli/examples/iot/delete-registration-code.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/delete-registration-code.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To delete your registration cod** + +The following ``delete-registration-code`` example deletes an AWS IoT account-specific registration code. :: + + aws iot delete-registration-code + +This command produces no output. + +For more information, see `Use Your Own Certificate `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/delete-role-alias.rst awscli-1.18.69/awscli/examples/iot/delete-role-alias.rst --- awscli-1.11.13/awscli/examples/iot/delete-role-alias.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/delete-role-alias.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete an AWS IoT role alias** + +The following ``delete-role-alias`` example deletes an AWS IoT role alias named ``LightBulbRole``. :: + + aws iot delete-role-alias \ + --role-alias LightBulbRole + +This command produces no output. + +For more information, see `Authorizing Direct Calls to AWS Services `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/delete-scheduled-audit.rst awscli-1.18.69/awscli/examples/iot/delete-scheduled-audit.rst --- awscli-1.11.13/awscli/examples/iot/delete-scheduled-audit.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/delete-scheduled-audit.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a scheduled audit** + +The following ``delete-scheduled-audit`` example deletes the AWS IoT Device Defender scheduled audit named ``AWSIoTDeviceDefenderDailyAudit``. :: + + aws iot delete-scheduled-audit \ + --scheduled-audit-name AWSIoTDeviceDefenderDailyAudit + +This command produces no output. + +For more information, see `Audit Commands `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/delete-security-profile.rst awscli-1.18.69/awscli/examples/iot/delete-security-profile.rst --- awscli-1.11.13/awscli/examples/iot/delete-security-profile.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/delete-security-profile.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a security profile** + +The following ``delete-security-profile`` example deletes a security profile named ``PossibleIssue``. :: + + aws iot delete-security-profile \ + --security-profile-name PossibleIssue + +This command produces no output. + +For more information, see `Detect Commands `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/delete-stream.rst awscli-1.18.69/awscli/examples/iot/delete-stream.rst --- awscli-1.11.13/awscli/examples/iot/delete-stream.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/delete-stream.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a stream** + +The following ``delete-stream`` example deletes the specified stream. :: + + aws iot delete-stream \ + --stream-id stream12345 + +This command produces no output. + +For more information, see `DeleteStream `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/delete-thing-group.rst awscli-1.18.69/awscli/examples/iot/delete-thing-group.rst --- awscli-1.11.13/awscli/examples/iot/delete-thing-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/delete-thing-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a thing group** + +The following ``delete-thing-group`` example deletes the specified thing group. You cannot delete a thing group if it contains things. :: + + aws iot delete-thing-group \ + --thing-group-name DefectiveBulbs + +This command produces no output. + +For more information, see `Thing Groups `__ in the *AWS IoT Developers Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/delete-thing.rst awscli-1.18.69/awscli/examples/iot/delete-thing.rst --- awscli-1.11.13/awscli/examples/iot/delete-thing.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/delete-thing.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To display detailed information about a thing** + +The following ``delete-thing`` example deletes a thing from the AWS IoT registry for your AWS account. + + aws iot delete-thing --thing-name "FourthBulb" + +This command produces no output. + +For more information, see `How to Manage Things with the Registry `__ in the *AWS IoT Developers Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/delete-thing-type.rst awscli-1.18.69/awscli/examples/iot/delete-thing-type.rst --- awscli-1.11.13/awscli/examples/iot/delete-thing-type.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/delete-thing-type.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**Example 1: To delete a thing type** + +The following ``delete-thing-type`` example deletes a deprecated thing type. :: + + aws iot delete-thing-type \ + --thing-type-name "obsoleteThingType" + +This command produces no output. + +For more information, see `Thing Types `__ in the *AWS IoT Developers Guide*. + diff -Nru awscli-1.11.13/awscli/examples/iot/delete-topic-rule.rst awscli-1.18.69/awscli/examples/iot/delete-topic-rule.rst --- awscli-1.11.13/awscli/examples/iot/delete-topic-rule.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/delete-topic-rule.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To delete a rule** + +The following ``delete-topic-rule`` example deletes the specified rule. :: + + aws iot delete-topic-rule \ + --rule-name "LowMoistureRule" + +This command produces no output. + +For more information, see `Deleting a Rule `__ in the *AWS IoT Developers Guide*. + diff -Nru awscli-1.11.13/awscli/examples/iot/delete-v2-logging-level.rst awscli-1.18.69/awscli/examples/iot/delete-v2-logging-level.rst --- awscli-1.11.13/awscli/examples/iot/delete-v2-logging-level.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/delete-v2-logging-level.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,9 @@ +**To delete the logging level for a thing group** + +The following ``delete-v2-logging-level`` example deletes the logging level for the specified thing group. :: + + aws iot delete-v2-logging-level \ + --target-type THING_GROUP \ + --target-name LightBulbs + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/iot/deprecate-thing-type.rst awscli-1.18.69/awscli/examples/iot/deprecate-thing-type.rst --- awscli-1.11.13/awscli/examples/iot/deprecate-thing-type.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/deprecate-thing-type.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**Example 1: To deprecate a thing type** + +The following ``deprecate-thing-type`` example deprecates a thing type so that users can't associate any new things with it. :: + + aws iot deprecate-thing-type \ + --thing-type-name "obsoleteThingType" + +This command produces no output. + +**Example 2: To reverse the deprecation of a thing type** + +The following ``deprecate-thing-type`` example reverses the deprecation of a thing type, which makes it possible for users to associate new things with it again. :: + + aws iot deprecate-thing-type \ + --thing-type-name "obsoleteThingType" \ + --undo-deprecate + +This command produces no output. + +For more information, see `Thing Types `__ in the *AWS IoT Developers Guide*. + diff -Nru awscli-1.11.13/awscli/examples/iot/describe-account-audit-configuration.rst awscli-1.18.69/awscli/examples/iot/describe-account-audit-configuration.rst --- awscli-1.11.13/awscli/examples/iot/describe-account-audit-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/describe-account-audit-configuration.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,52 @@ +**To view current audit configuration settings** + +The following ``describe-account-audit-configuration`` example lists the current settings for your AWS IoT Device Defender audit configuration. :: + + aws iot describe-account-audit-configuration + +Output:: + + { + "roleArn": "arn:aws:iam::123456789012:role/service-role/AWSIoTDeviceDefenderAudit_1551201085996", + "auditNotificationTargetConfigurations": { + "SNS": { + "targetArn": "arn:aws:sns:us-west-2:123456789012:ddaudits", + "roleArn": "arn:aws:iam::123456789012:role/service-role/AWSIoTDeviceDefenderAudit", + "enabled": true + } + }, + "auditCheckConfigurations": { + "AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK": { + "enabled": true + }, + "CA_CERTIFICATE_EXPIRING_CHECK": { + "enabled": true + }, + "CONFLICTING_CLIENT_IDS_CHECK": { + "enabled": true + }, + "DEVICE_CERTIFICATE_EXPIRING_CHECK": { + "enabled": true + }, + "DEVICE_CERTIFICATE_SHARED_CHECK": { + "enabled": true + }, + "IOT_POLICY_OVERLY_PERMISSIVE_CHECK": { + "enabled": true + }, + "LOGGING_DISABLED_CHECK": { + "enabled": true + }, + "REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK": { + "enabled": true + }, + "REVOKED_DEVICE_CERTIFICATE_STILL_ACTIVE_CHECK": { + "enabled": true + }, + "UNAUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK": { + "enabled": true + } + } + } + +For more information, see `Audit Commands `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/describe-audit-finding.rst awscli-1.18.69/awscli/examples/iot/describe-audit-finding.rst --- awscli-1.11.13/awscli/examples/iot/describe-audit-finding.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/describe-audit-finding.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/iot/describe-audit-mitigation-actions-task.rst awscli-1.18.69/awscli/examples/iot/describe-audit-mitigation-actions-task.rst --- awscli-1.11.13/awscli/examples/iot/describe-audit-mitigation-actions-task.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/describe-audit-mitigation-actions-task.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/iot/describe-audit-task.rst awscli-1.18.69/awscli/examples/iot/describe-audit-task.rst --- awscli-1.11.13/awscli/examples/iot/describe-audit-task.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/describe-audit-task.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,45 @@ +**To get information about an audit instance** + +The following ``describe-audit-task`` example gets information about an instance of an AWS IoT Device Defender audit. If the audit is complete, summary statistics for the run are included in the results. :: + + aws iot describe-audit-task \ + --task-id a3aea009955e501a31b764abe1bebd3d + +Output:: + + { + "taskStatus": "COMPLETED", + "taskType": "ON_DEMAND_AUDIT_TASK", + "taskStartTime": 1560356923.434, + "taskStatistics": { + "totalChecks": 3, + "inProgressChecks": 0, + "waitingForDataCollectionChecks": 0, + "compliantChecks": 3, + "nonCompliantChecks": 0, + "failedChecks": 0, + "canceledChecks": 0 + }, + "auditDetails": { + "CA_CERTIFICATE_EXPIRING_CHECK": { + "checkRunStatus": "COMPLETED_COMPLIANT", + "checkCompliant": true, + "totalResourcesCount": 0, + "nonCompliantResourcesCount": 0 + }, + "DEVICE_CERTIFICATE_EXPIRING_CHECK": { + "checkRunStatus": "COMPLETED_COMPLIANT", + "checkCompliant": true, + "totalResourcesCount": 6, + "nonCompliantResourcesCount": 0 + }, + "REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK": { + "checkRunStatus": "COMPLETED_COMPLIANT", + "checkCompliant": true, + "totalResourcesCount": 0, + "nonCompliantResourcesCount": 0 + } + } + } + +For more information, see `Audit Commands `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/describe-authorizer.rst awscli-1.18.69/awscli/examples/iot/describe-authorizer.rst --- awscli-1.11.13/awscli/examples/iot/describe-authorizer.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/describe-authorizer.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,25 @@ +**To get information about a custom authorizer** + +The following ``describe-authorizer`` example displays details for the specified custom authorizer. :: + + aws iot describe-authorizer \ + --authorizer-name CustomAuthorizer + +Output:: + + { + "authorizerDescription": { + "authorizerName": "CustomAuthorizer", + "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer", + "authorizerFunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:CustomAuthorizerFunction", + "tokenKeyName": "MyAuthToken", + "tokenSigningPublicKeys": { + "FIRST_KEY": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA1uJOB4lQPgG/lM6ZfIwo\nZ+7ENxAio9q6QD4FFqjGZsvjtYwjoe1RKK0U8Eq9xb5O3kRSmyIwTzwzm/f4Gf0Y\nZUloJ+t3PUUwHrmbYTAgTrCUgRFygjfgVwGCPs5ZAX4Eyqt5cr+AIHIiUDbxSa7p\nzwOBKPeic0asNJpqT8PkBbRaKyleJh5oo81NDHHmVtbBm5A5YiJjqYXLaVAowKzZ\n+GqsNvAQ9Jy1wI2VrEa1OfL8flDB/BJLm7zjpfPOHDJQgID0XnZwAlNnZcOhCwIx\n50g2LW2Oy9R/dmqtDmJiVP97Z4GykxPvwlYHrUXY0iW1R3AR/Ac1NhCTGZMwVDB1\nlQIDAQAB\n-----END PUBLIC KEY-----" + }, + "status": "ACTIVE", + "creationDate": 1571245658.069, + "lastModifiedDate": 1571245658.069 + } + } + +For more information, see `DescribeAuthorizer `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/describe-billing-group.rst awscli-1.18.69/awscli/examples/iot/describe-billing-group.rst --- awscli-1.11.13/awscli/examples/iot/describe-billing-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/describe-billing-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,20 @@ +**To get information about a billing group** + +The following ``describe-billing-group`` example gets information for the specified billing group. :: + + aws iot describe-billing-group --billing-group-name GroupOne + +Output:: + + { + "billingGroupName": "GroupOne", + "billingGroupId": "103de383-114b-4f51-8266-18f209ef5562", + "billingGroupArn": "arn:aws:iot:us-west-2:123456789012:billinggroup/GroupOne", + "version": 1, + "billingGroupProperties": {}, + "billingGroupMetadata": { + "creationDate": 1560199355.378 + } + } + +For more information, see `Billing Groups `__ in the *AWS IoT Developers Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/describe-ca-certificate.rst awscli-1.18.69/awscli/examples/iot/describe-ca-certificate.rst --- awscli-1.11.13/awscli/examples/iot/describe-ca-certificate.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/describe-ca-certificate.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,29 @@ +**To get details about a CA certificate** + +The following ``describe-ca-certificate`` example displays the details for the specified CA certificate. :: + + aws iot describe-ca-certificate \ + --certificate-id f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467 + +Output:: + + { + "certificateDescription": { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cacert/f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467", + "certificateId": "f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467", + "status": "INACTIVE", + "certificatePem": "-----BEGIN CERTIFICATE-----\nMIICzzCCAbegEXAMPLEJANVEPWXl8taPMA0GCSqGSIb3DQEBBQUAMB4xCzAJBgNV\nBAYTAlVTMQ8wDQYDVQQKDAZBbWF6b24wHhcNMTkwOTI0MjEzMTE1WhcNMjkwOTIx\nMjEzMTE1WjAeMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGQW1hem9uMIIBIjANBgkq\nhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAzd3R3ioalCS0MhFWfBrVGR036EK07UAf\nVdz9EXAMPLE1VczICbADnATK522kEIB51/18VzlFtAhQL5V5eybXKnB7QebNer5m\n4Yibx7shR5oqNzFsrXWxuugN5+w5gEfqNMawOjhF4LsculKG49yuqjcDU19/13ua\n3B2gxs1Pe7TiWWvUskzxnbO1F2WCshbEJvqY8fIWtGYCjTeJAgQ9hvZx/69XhKen\nwV9LJwOQxrsUS0Ty8IHwbB8fRy72VM3u7fJoaU+nO4jD5cqaoEPtzoeFUEXAMPLE\nyVAJpqHwgbYbcUfn7V+AB6yh1+0Fa1rEQGuZDPGyJslxwr5vh8nRewIDAQABoxAw\nDjAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUAA4IBAQA+3a5CV3IJgOnd0AgI\nBgVMtmYzTvqAngx26aG9/spvCjXckh2SBF+EcBlCFwH1yakwjJL1dR4yarnrfxgI\nEqP4AOYVimAVoQ5FBwnloHe16+3qtDiblU9DeXBUCtS55EcfrEXAMPLEYtXdqU5C\nU9ia4KAjV0dxW1+EFYMwX5eGeb0gDTNHBylV6B/fOSZiQAwDYp4x3B+gAP+a/bWB\nu1umOqtBdWe6L6/83L+JhaTByqV25iVJ4c/UZUnG8926wUlDM9zQvEXuEVvzZ7+m\n4PSNqst/nVOvnLpoG4e0WgcJgANuB33CSWtjWSuYsbhmqQRknGhREXAMPLEZT4fm\nfo0e\n-----END CERTIFICATE-----\n", + "ownedBy": "123456789012", + "creationDate": 1569365372.053, + "autoRegistrationStatus": "DISABLE", + "lastModifiedDate": 1569365372.053, + "customerVersion": 1, + "generationId": "c5c2eb95-140b-4f49-9393-6aaac85b2a90", + "validity": { + "notBefore": 1569360675.0, + "notAfter": 1884720675.0 + } + } + } + +For more information, see `DescribeCACertificate `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/describe-certificate.rst awscli-1.18.69/awscli/examples/iot/describe-certificate.rst --- awscli-1.11.13/awscli/examples/iot/describe-certificate.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/describe-certificate.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,44 @@ +**To get information about a certificate** + +The following ``describe-certificate`` example displays the details for the specified certificate. :: + + aws iot describe-certificate \ + --certificate-id "4f0ba725787aa94d67d2fca420eca022242532e8b3c58e7465c7778b443fd65e" + +Output:: + + { + "certificateDescription": { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/4f0ba725787aa94d67d2fca420eca022242532e8b3c58e7465c7778b443fd65e", + "certificateId": "4f0ba725787aa94d67d2fca420eca022242532e8b3c58e7465c7778b443fd65e", + "status": "ACTIVE", + "certificatePem": "-----BEGIN CERTIFICATE----- + MIICiTEXAMPLEQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC + VVMxCzAJBgNVBEXAMPLEMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 + b24xFDASBgNVBAsTC0lBTSBDEXAMPLElMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd + BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5EXAMPLEcNMTEwNDI1MjA0NTIxWhcN + MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNEXAMPLEdBMRAwDgYD + VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBEXAMPLEz + b2xEXAMPLEYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt + YXpvbi5jb20wgZ8EXAMPLEZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ + 21uUSfwfEvySWtC2XADZ4nB+BLYEXAMPLEpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T + rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7EXAMPLEGBzZswY6786m86gpE + Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFEXAMPLEAtCu4 + nUhVVxYUnEXAMPLE8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb + FFBjvSfpJIlJ00zbhNYS5f6GEXAMPLEl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb + NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE= + -----END CERTIFICATE-----", + "ownedBy": "123456789012", + "creationDate": 1541022751.983, + "lastModifiedDate": 1541022751.983, + "customerVersion": 1, + "transferData": {}, + "generationId": "6974fbed-2e61-4114-bc5e-4204cc79b045", + "validity": { + "notBefore": 1541022631.0, + "notAfter": 2524607999.0 + } + } + } + +For more information, see `DescribeCertificate `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/describe-default-authorizer.rst awscli-1.18.69/awscli/examples/iot/describe-default-authorizer.rst --- awscli-1.11.13/awscli/examples/iot/describe-default-authorizer.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/describe-default-authorizer.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,14 @@ +**To get information about the default custom authorizer** + +The following ``describe-default-authorizer`` example displays details for the default custom authorizer. :: + + aws iot describe-default-authorizer + +Output:: + + { + "authorizerName": "CustomAuthorizer", + "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer" + } + +For more information, see `DescribeDefaultAuthorizer `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/describe-dimension.rst awscli-1.18.69/awscli/examples/iot/describe-dimension.rst --- awscli-1.11.13/awscli/examples/iot/describe-dimension.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/describe-dimension.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,21 @@ +**To get information about a dimension** + +The following ``describe-dimension`` example gets information about a dimension named ``TopicFilterForAuthMessages``. :: + + aws iot describe-dimension \ + --name TopicFilterForAuthMessages + +Output:: + + { + "name": "TopicFilterForAuthMessages", + "arn": "arn:aws:iot:eu-west-2:123456789012:dimension/TopicFilterForAuthMessages", + "type": "TOPIC_FILTER", + "stringValues": [ + "device/+/auth" + ], + "creationDate": 1578620223.255, + "lastModifiedDate": 1578620223.255 + } + +For more information, see `Detect Commands `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/describe-domain-configuration.rst awscli-1.18.69/awscli/examples/iot/describe-domain-configuration.rst --- awscli-1.11.13/awscli/examples/iot/describe-domain-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/describe-domain-configuration.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/iot/describe-endpoint.rst awscli-1.18.69/awscli/examples/iot/describe-endpoint.rst --- awscli-1.11.13/awscli/examples/iot/describe-endpoint.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/describe-endpoint.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,28 @@ +**Example 1: To get your current AWS endpoint** + +The following ``describe-endpoint`` example retrieves the default AWS endpoint to which all commands are applied. :: + + aws iot describe-endpoint + +Output:: + + { + "endpointAddress": "abc123defghijk.iot.us-west-2.amazonaws.com" + } + +For more information, see `DescribeEndpoint `__ in the *AWS IoT Developer Guide*. + +**Example 2: To get your ATS endpoint** + +The following ``describe-endpoint`` example retrieves the Amazon Trust Services (ATS) endpoint. :: + + aws iot describe-endpoint \ + --endpoint-type iot:Data-ATS + +Output:: + + { + "endpointAddress": "abc123defghijk-ats.iot.us-west-2.amazonaws.com" + } + +For more information, see `X.509 Certificates and AWS IoT `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/describe-event-configurations.rst awscli-1.18.69/awscli/examples/iot/describe-event-configurations.rst --- awscli-1.11.13/awscli/examples/iot/describe-event-configurations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/describe-event-configurations.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,47 @@ +**To show which event types are published** + +The following ``describe-event-configurations`` example lists the configuration that controls which events are generated when something is added, updated, or deleted. :: + + aws iot describe-event-configurations + +Output:: + + { + "eventConfigurations": { + "CA_CERTIFICATE": { + "Enabled": false + }, + "CERTIFICATE": { + "Enabled": false + }, + "JOB": { + "Enabled": false + }, + "JOB_EXECUTION": { + "Enabled": false + }, + "POLICY": { + "Enabled": false + }, + "THING": { + "Enabled": false + }, + "THING_GROUP": { + "Enabled": false + }, + "THING_GROUP_HIERARCHY": { + "Enabled": false + }, + "THING_GROUP_MEMBERSHIP": { + "Enabled": false + }, + "THING_TYPE": { + "Enabled": false + }, + "THING_TYPE_ASSOCIATION": { + "Enabled": false + } + } + } + +For more information, see `Event Messages `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/describe-index.rst awscli-1.18.69/awscli/examples/iot/describe-index.rst --- awscli-1.11.13/awscli/examples/iot/describe-index.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/describe-index.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,16 @@ +**To retrieve the current status of the thing index** + +The following ``describe-index`` example retrieves the current status of the thing index. :: + + aws iot describe-index \ + --index-name "AWS_Things" + +Output:: + + { + "indexName": "AWS_Things", + "indexStatus": "ACTIVE", + "schema": "REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS" + } + +For more information, see `Managing Thing Indexing `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/describe-job-execution.rst awscli-1.18.69/awscli/examples/iot/describe-job-execution.rst --- awscli-1.11.13/awscli/examples/iot/describe-job-execution.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/describe-job-execution.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,24 @@ +**To get execution details for a job on a device** + +The following ``describe-job-execution`` example gets execution details for the specified job. :: + + aws iot describe-job-execution \ + --job-id "example-job-01" \ + --thing-name "MyRaspberryPi" + +Output:: + + { + "execution": { + "jobId": "example-job-01", + "status": "QUEUED", + "statusDetails": {}, + "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyRaspberryPi", + "queuedAt": 1560787023.636, + "lastUpdatedAt": 1560787023.636, + "executionNumber": 1, + "versionNumber": 1 + } + } + +For more information, see `Creating and Managing Jobs (CLI) `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/describe-job.rst awscli-1.18.69/awscli/examples/iot/describe-job.rst --- awscli-1.11.13/awscli/examples/iot/describe-job.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/describe-job.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,38 @@ +**To get detailed status for a job** + +The following ``describe-job`` example gets detailed status for the job whose ID is ``example-job-01``. :: + + aws iot describe-job \ + --job-id "example-job-01" + +Output:: + + { + "job": { + "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-01", + "jobId": "example-job-01", + "targetSelection": "SNAPSHOT", + "status": "IN_PROGRESS", + "targets": [ + "arn:aws:iot:us-west-2:123456789012:thing/MyRaspberryPi" + ], + "description": "example job test", + "presignedUrlConfig": {}, + "jobExecutionsRolloutConfig": {}, + "createdAt": 1560787022.733, + "lastUpdatedAt": 1560787026.294, + "jobProcessDetails": { + "numberOfCanceledThings": 0, + "numberOfSucceededThings": 0, + "numberOfFailedThings": 0, + "numberOfRejectedThings": 0, + "numberOfQueuedThings": 1, + "numberOfInProgressThings": 0, + "numberOfRemovedThings": 0, + "numberOfTimedOutThings": 0 + }, + "timeoutConfig": {} + } + } + +For more information, see `Creating and Managing Jobs (CLI) `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/describe-mitigation-action.rst awscli-1.18.69/awscli/examples/iot/describe-mitigation-action.rst --- awscli-1.11.13/awscli/examples/iot/describe-mitigation-action.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/describe-mitigation-action.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/iot/describe-role-alias.rst awscli-1.18.69/awscli/examples/iot/describe-role-alias.rst --- awscli-1.11.13/awscli/examples/iot/describe-role-alias.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/describe-role-alias.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,22 @@ +**To get information about an AWS IoT role alias** + +The following ``describe-role-alias`` example displays details for the specified role alias. :: + + aws iot describe-role-alias \ + --role-alias LightBulbRole + +Output:: + + { + "roleAliasDescription": { + "roleAlias": "LightBulbRole", + "roleAliasArn": "arn:aws:iot:us-west-2:123456789012:rolealias/LightBulbRole", + "roleArn": "arn:aws:iam::123456789012:role/light_bulb_role_001", + "owner": "123456789012", + "credentialDurationSeconds": 3600, + "creationDate": 1570558643.221, + "lastModifiedDate": 1570558643.221 + } + } + +For more information, see `DescribeRoleAlias `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/describe-scheduled-audit.rst awscli-1.18.69/awscli/examples/iot/describe-scheduled-audit.rst --- awscli-1.11.13/awscli/examples/iot/describe-scheduled-audit.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/describe-scheduled-audit.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,24 @@ +**To get information about a scheduled audit** + +The following ``describe-scheduled-audit`` example gets detailed information about an AWS IOT Device Defender scheduled audit named ``AWSIoTDeviceDefenderDailyAudit``. :: + + aws iot describe-scheduled-audit \ + --scheduled-audit-name AWSIoTDeviceDefenderDailyAudit + +Output:: + + { + "frequency": "DAILY", + "targetCheckNames": [ + "AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK", + "CONFLICTING_CLIENT_IDS_CHECK", + "DEVICE_CERTIFICATE_SHARED_CHECK", + "IOT_POLICY_OVERLY_PERMISSIVE_CHECK", + "REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK", + "UNAUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK" + ], + "scheduledAuditName": "AWSIoTDeviceDefenderDailyAudit", + "scheduledAuditArn": "arn:aws:iot:us-west-2:123456789012:scheduledaudit/AWSIoTDeviceDefenderDailyAudit" + } + +For more information, see `Audit Commands `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/describe-security-profile.rst awscli-1.18.69/awscli/examples/iot/describe-security-profile.rst --- awscli-1.11.13/awscli/examples/iot/describe-security-profile.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/describe-security-profile.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,46 @@ +**To get information about a security profile** + +The following ``describe-security-profile`` example gets information about the AWS IoT Device Defender security profile named ``PossibleIssue.`` :: + + aws iot describe-security-profile \ + --security-profile-name PossibleIssue + +Output:: + + { + "securityProfileName": "PossibleIssue", + "securityProfileArn": "arn:aws:iot:us-west-2:123456789012:securityprofile/PossibleIssue", + "securityProfileDescription": "check to see if authorization fails 10 times in 5 minutes or if cellular bandwidth exceeds 128", + "behaviors": [ + { + "name": "CellularBandwidth", + "metric": "aws:message-byte-size", + "criteria": { + "comparisonOperator": "greater-than", + "value": { + "count": 128 + }, + "consecutiveDatapointsToAlarm": 1, + "consecutiveDatapointsToClear": 1 + } + }, + { + "name": "Authorization", + "metric": "aws:num-authorization-failures", + "criteria": { + "comparisonOperator": "greater-than", + "value": { + "count": 10 + }, + "durationSeconds": 300, + "consecutiveDatapointsToAlarm": 1, + "consecutiveDatapointsToClear": 1 + } + } + ], + "version": 1, + "creationDate": 1560278102.528, + "lastModifiedDate": 1560278102.528 + } + +For more information, see `Detect Commands `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/describe-stream.rst awscli-1.18.69/awscli/examples/iot/describe-stream.rst --- awscli-1.11.13/awscli/examples/iot/describe-stream.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/describe-stream.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,31 @@ +**To get information about a stream** + +The following ``describe-stream`` example displays the details about the specified stream. :: + + aws iot describe-stream \ + --stream-id stream12345 + +Output:: + + { + "streamInfo": { + "streamId": "stream12345", + "streamArn": "arn:aws:iot:us-west-2:123456789012:stream/stream12345", + "streamVersion": 1, + "description": "This stream is used for Amazon FreeRTOS OTA Update 12345.", + "files": [ + { + "fileId": "123", + "s3Location": { + "bucket":"codesign-ota-bucket", + "key":"48c67f3c-63bb-4f92-a98a-4ee0fbc2bef6" + } + } + ], + "createdAt": 1557863215.995, + "lastUpdatedAt": 1557863215.995, + "roleArn": "arn:aws:iam:123456789012:role/service-role/my_ota_stream_role" + } + } + +For more information, see `DescribeStream `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/describe-thing-group.rst awscli-1.18.69/awscli/examples/iot/describe-thing-group.rst --- awscli-1.11.13/awscli/examples/iot/describe-thing-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/describe-thing-group.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,29 @@ +**To get information about a thing group** + +The following ``describe-thing-group`` example gets information about the thing group named ``HalogenBulbs``. :: + + aws iot describe-thing-group \ + --thing-group-name HalogenBulbs + +Output:: + + { + "thingGroupName": "HalogenBulbs", + "thingGroupId": "f4ec6b84-b42b-499d-9ce1-4dbd4d4f6f6e", + "thingGroupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/HalogenBulbs", + "version": 1, + "thingGroupProperties": {}, + "thingGroupMetadata": { + "parentGroupName": "LightBulbs", + "rootToParentThingGroups": [ + { + "groupName": "LightBulbs", + "groupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs" + } + ], + "creationDate": 1559927609.897 + } + } + +For more information, see `Thing Groups `__ in the *AWS IoT Developers Guide*. + diff -Nru awscli-1.11.13/awscli/examples/iot/describe-thing.rst awscli-1.18.69/awscli/examples/iot/describe-thing.rst --- awscli-1.11.13/awscli/examples/iot/describe-thing.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/describe-thing.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,23 @@ +**To display detailed information about a thing** + +The following ``describe-thing`` example display information about a thing (device) that is defined in the AWS IoT registry for your AWS account. + + aws iot describe-thing \ + --thing-name "MyLightBulb" + +Output:: + + { + "defaultClientId": "MyLightBulb", + "thingName": "MyLightBulb", + "thingId": "40da2e73-c6af-406e-b415-15acae538797", + "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyLightBulb", + "thingTypeName": "LightBulb", + "attributes": { + "model": "123", + "wattage": "75" + }, + "version": 1 + } + +For more information, see `How to Manage Things with the Registry `__ in the *AWS IoT Developers Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/describe-thing-type.rst awscli-1.18.69/awscli/examples/iot/describe-thing-type.rst --- awscli-1.11.13/awscli/examples/iot/describe-thing-type.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/describe-thing-type.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,27 @@ +**To get information about a thing type** + +The following ``describe-thing-type`` example display information about the specified thing type defined in your AWS account. :: + + aws iot describe-thing-type \ + --thing-type-name "LightBulb" + +Output:: + + { + "thingTypeName": "LightBulb", + "thingTypeId": "ce3573b0-0a3c-45a7-ac93-4e0ce14cd190", + "thingTypeArn": "arn:aws:iot:us-west-2:123456789012:thingtype/LightBulb", + "thingTypeProperties": { + "thingTypeDescription": "light bulb type", + "searchableAttributes": [ + "model", + "wattage" + ] + }, + "thingTypeMetadata": { + "deprecated": false, + "creationDate": 1559772562.498 + } + } + +For more information, see `Thing Types `__ in the *AWS IoT Developers Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/detach-policy.rst awscli-1.18.69/awscli/examples/iot/detach-policy.rst --- awscli-1.11.13/awscli/examples/iot/detach-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/detach-policy.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,21 @@ +**Example 1: To detach an AWS IoT policy from a thing group** + +The following ``detach-policy`` example detaches the specified policy from a thing group and, by extension, from all things in that group and any of the group's child groups. :: + + aws iot detach-policy \ + --target "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs" \ + --policy-name "MyFirstGroup_Core-policy" + +This command produces no output. + +For more information, see `Thing Groups `__ in the *AWS IoT Developers Guide*. + +**Example 2: To detach an AWS IoT policy from a device certificate** + +The following ``detach-policy`` example detaches the TemperatureSensorPolicy policy from a device certificate identified by ARN. :: + + aws iot detach-policy \ + --policy-name TemperatureSensorPolicy \ + --target arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142 + +This command produces no output. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iot/detach-security-profile.rst awscli-1.18.69/awscli/examples/iot/detach-security-profile.rst --- awscli-1.11.13/awscli/examples/iot/detach-security-profile.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/detach-security-profile.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To disassociate a security profile from a target** + +The following ``detach-security-profile`` example removes the association between the AWS IoT Device Defender security profile named ``Testprofile`` and the all registered things target. :: + + aws iot detach-security-profile \ + --security-profile-name Testprofile \ + --security-profile-target-arn "arn:aws:iot:us-west-2:123456789012:all/registered-things" + +This command produces no output. + +For more information, see `Detect Commands `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/detach-thing-principal.rst awscli-1.18.69/awscli/examples/iot/detach-thing-principal.rst --- awscli-1.11.13/awscli/examples/iot/detach-thing-principal.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/detach-thing-principal.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To detach a certificate/principal from a thing** + +The following ``detach-thing-principal`` example removes a certificate that represents a principal from the specified thing. :: + + aws iot detach-thing-principal \ + --thing-name "MyLightBulb" \ + --principal "arn:aws:iot:us-west-2:123456789012:cert/604c48437a57b7d5fc5d137c5be75011c6ee67c9a6943683a1acb4b1626bac36" + +This command produces no output. + +For more information, see `How to Manage Things with the Registry `__ in the *AWS IoT Developers Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/disable-topic-rule.rst awscli-1.18.69/awscli/examples/iot/disable-topic-rule.rst --- awscli-1.11.13/awscli/examples/iot/disable-topic-rule.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/disable-topic-rule.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,11 @@ +**To disable a topic rule** + +The following ``disable-topic-rule`` example disables the specified topic rule. :: + + aws iot disable-topic-rule \ + --rule-name "MyPlantPiMoistureAlertRule" + +This command produces no output. + + +For more information, see `Viewing Your Rules `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/enable-topic-rule.rst awscli-1.18.69/awscli/examples/iot/enable-topic-rule.rst --- awscli-1.11.13/awscli/examples/iot/enable-topic-rule.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/enable-topic-rule.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,10 @@ +**To enable a topic rule** + +The following ``enable-topic-rule`` example enables (or re-enables) the specified topic rule. :: + + aws iot enable-topic-rule \ + --rule-name "MyPlantPiMoistureAlertRule" + +This command produces no output. + +For more information, see `Viewing Your Rules `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/get-cardinality.rst awscli-1.18.69/awscli/examples/iot/get-cardinality.rst --- awscli-1.11.13/awscli/examples/iot/get-cardinality.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/get-cardinality.rst 2020-05-28 19:25:48.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.11.13/awscli/examples/iot/get-effective-policies.rst awscli-1.18.69/awscli/examples/iot/get-effective-policies.rst --- awscli-1.11.13/awscli/examples/iot/get-effective-policies.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/get-effective-policies.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,55 @@ +**To list the policies that effect a thing** + +The following ``get-effective-policies`` example lists the policies that effect the specified thing, including policies attached to any groups to which it belongs. :: + + aws iot get-effective-policies \ + --thing-name TemperatureSensor-001 \ + --principal arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142 + +Output:: + + { + "effectivePolicies": [ + { + "policyName": "TemperatureSensorPolicy", + "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/TemperatureSensorPolicy", + "policyDocument": "{ + \"Version\": \"2012-10-17\", + \"Statement\": [ + { + \"Effect\": \"Allow\", + \"Action\": [ + \"iot:Publish\", + \"iot:Receive\" + ], + \"Resource\": [ + \"arn:aws:iot:us-west-2:123456789012:topic/topic_1\", + \"arn:aws:iot:us-west-2:123456789012:topic/topic_2\" + ] + }, + { + \"Effect\": \"Allow\", + \"Action\": [ + \"iot:Subscribe\" + ], + \"Resource\": [ + \"arn:aws:iot:us-west-2:123456789012:topicfilter/topic_1\", + \"arn:aws:iot:us-west-2:123456789012:topicfilter/topic_2\" + ] + }, + { + \"Effect\": \"Allow\", + \"Action\": [ + \"iot:Connect\" + ], + \"Resource\": [ + \"arn:aws:iot:us-west-2:123456789012:client/basicPubSub\" + ] + } + ] + }" + } + ] + } + +For more information, see `Get Effective Policies for a Thing `__ in the *AWS IoT Developers Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/get-indexing-configuration.rst awscli-1.18.69/awscli/examples/iot/get-indexing-configuration.rst --- awscli-1.11.13/awscli/examples/iot/get-indexing-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/get-indexing-configuration.rst 2020-05-28 19:25:48.000000000 +0000 @@ -0,0 +1,20 @@ +**To get the thing indexing configuration** + +The following ``get-indexing-configuration`` example gets the current configuration data for AWS IoT fleet indexing. :: + + aws iot get-indexing-configuration + +Output:: + + { + "thingIndexingConfiguration": { + "thingIndexingMode": "OFF", + "thingConnectivityIndexingMode": "OFF" + }, + "thingGroupIndexingConfiguration": { + "thingGroupIndexingMode": "OFF" + } + } + +For more information, see `Managing Thing Indexing `__ in the *AWS IoT Developers Guide*. + diff -Nru awscli-1.11.13/awscli/examples/iot/get-job-document.rst awscli-1.18.69/awscli/examples/iot/get-job-document.rst --- awscli-1.11.13/awscli/examples/iot/get-job-document.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/get-job-document.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,14 @@ +**To retrieve the document for a job** + +The following ``get-job-document`` example displays details about the document for the job whose ID is ``example-job-01``. :: + + aws iot get-job-document \ + --job-id "example-job-01" + +Output:: + + { + "document": "\n{\n \"operation\":\"customJob\",\n \"otherInfo\":\"someValue\"\n}\n" + } + +For more information, see `Creating and Managing Jobs (CLI) `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/get-logging-options.rst awscli-1.18.69/awscli/examples/iot/get-logging-options.rst --- awscli-1.11.13/awscli/examples/iot/get-logging-options.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/get-logging-options.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,14 @@ +**To get the logging options** + +The following ``get-logging-options`` example gets the current logging options for your AWS account. :: + + aws iot get-logging-options + +Output:: + + { + "roleArn": "arn:aws:iam::123456789012:role/service-role/iotLoggingRole", + "logLevel": "ERROR" + } + +For more information, see `title `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/get-ota-update.rst awscli-1.18.69/awscli/examples/iot/get-ota-update.rst --- awscli-1.11.13/awscli/examples/iot/get-ota-update.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/get-ota-update.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,50 @@ +**To retrieve information about an OTA Update** + +The following ``get-ota-update`` example displays details about the specified OTA Update. :: + + aws iot get-ota-update \ + --ota-update-id ota12345 + +Output:: + + { + "otaUpdateInfo": { + "otaUpdateId": "ota12345", + "otaUpdateArn": "arn:aws:iot:us-west-2:123456789012:otaupdate/itsaupdate", + "creationDate": 1557863215.995, + "lastModifiedDate": 1557863215.995, + "description": "A critical update needed right away.", + "targets": [ + "device1", + "device2", + "device3", + "device4" + ], + "targetSelection": "SNAPSHOT", + "awsJobExecutionsRolloutConfig": { + "maximumPerMinute": 10 + }, + "otaUpdateFiles": [ + { + "fileName": "firmware.bin", + "fileLocation": { + "stream": { + "streamId": "004", + "fileId":123 + } + }, + "codeSigning": { + "awsSignerJobId": "48c67f3c-63bb-4f92-a98a-4ee0fbc2bef6" + } + } + ], + "roleArn": "arn:aws:iam:123456789012:role/service-role/my_ota_role" + "otaUpdateStatus": "CREATE_COMPLETE", + "awsIotJobId": "job54321", + "awsIotJobArn": "arn:aws:iot:us-west-2:123456789012:job/job54321", + "errorInfo": { + } + } + } + +For more information, see `GetOTAUpdate `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/get-percentiles.rst awscli-1.18.69/awscli/examples/iot/get-percentiles.rst --- awscli-1.11.13/awscli/examples/iot/get-percentiles.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/get-percentiles.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/iot/get-policy.rst awscli-1.18.69/awscli/examples/iot/get-policy.rst --- awscli-1.11.13/awscli/examples/iot/get-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/get-policy.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,21 @@ +**To get information about the default version of a policy** + +The following ``get-policy`` example retrieves information about the default version of the specified policy. :: + + aws iot get-policy \ + --policy-name UpdateDeviceCertPolicy + +Output:: + + { + "policyName": "UpdateDeviceCertPolicy", + "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/UpdateDeviceCertPolicy", + "policyDocument": "{ \"Version\": \"2012-10-17\", \"Statement\": [ { \"Effect\": \"Allow\", \"Action\": \"iot:UpdateCertificate\", \"Resource\": \"*\" } ] }", + "defaultVersionId": "2", + "creationDate": 1559925941.924, + "lastModifiedDate": 1559925941.924, + "generationId": "5066f1b6712ce9d2a1e56399771649a272d6a921762fead080e24fe52f24e042" + } + +For more information, see `AWS IoT Policies `__ in the *AWS IoT Developers Guide*. + diff -Nru awscli-1.11.13/awscli/examples/iot/get-policy-version.rst awscli-1.18.69/awscli/examples/iot/get-policy-version.rst --- awscli-1.11.13/awscli/examples/iot/get-policy-version.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/get-policy-version.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,23 @@ +**To get information about a specific version of a policy** + +The following ``get-policy-version`` example gets information about the first version of the specified policy. :: + + aws iot get-policy \ + --policy-name UpdateDeviceCertPolicy + --policy-version-id "1" + +Output:: + + { + "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/UpdateDeviceCertPolicy", + "policyName": "UpdateDeviceCertPolicy", + "policyDocument": "{ \"Version\": \"2012-10-17\", \"Statement\": [ { \"Effect\": \"Allow\", \"Action\": \"iot:UpdateCertificate\", \"Resource\": \"*\" } ] }", + "policyVersionId": "1", + "isDefaultVersion": false, + "creationDate": 1559925941.924, + "lastModifiedDate": 1559926175.458, + "generationId": "5066f1b6712ce9d2a1e56399771649a272d6a921762fead080e24fe52f24e042" + } + +For more information, see `AWS IoT Policies `__ in the *AWS IoT Developers Guide*. + diff -Nru awscli-1.11.13/awscli/examples/iot/get-registration-code.rst awscli-1.18.69/awscli/examples/iot/get-registration-code.rst --- awscli-1.11.13/awscli/examples/iot/get-registration-code.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/get-registration-code.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,13 @@ +**To get your AWS account-specific registration code** + +The following ``get-registration-code`` example retrieves your AWS account-specific registration code. :: + + aws iot get-registration-code + +Output:: + + { + "registrationCode": "15c51ae5e36ba59ba77042df1115862076bea4bd15841c838fcb68d5010a614c" + } + +For more information, see `Use Your Own Certificate `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/get-statistics.rst awscli-1.18.69/awscli/examples/iot/get-statistics.rst --- awscli-1.11.13/awscli/examples/iot/get-statistics.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/get-statistics.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,17 @@ +**To search the device index for aggregate data** + +The following ``get-statistics`` example returns the number of things that have a property called ``connectivity.connected`` set to ``false`` (that is, the number of devices that are not connected) in their device shadow. :: + + aws iot get-statistics \ + --index-name AWS_Things \ + --query-string "connectivity.connected:false" + +Output:: + + { + "statistics": { + "count": 6 + } + } + +For more information, see `Getting Statistics About Your Device Fleet `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/get-topic-rule.rst awscli-1.18.69/awscli/examples/iot/get-topic-rule.rst --- awscli-1.11.13/awscli/examples/iot/get-topic-rule.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/get-topic-rule.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,32 @@ +**To get information about a rule** + +The following ``get-topic-rule`` example gets information about the specified rule. :: + + aws iot get-topic-rule \ + --rule-name MyRPiLowMoistureAlertRule + +Output:: + + { + "ruleArn": "arn:aws:iot:us-west-2:123456789012:rule/MyRPiLowMoistureAlertRule", + "rule": { + "ruleName": "MyRPiLowMoistureAlertRule", + "sql": "SELECT * FROM '$aws/things/MyRPi/shadow/update/accepted' WHERE state.reported.moisture = 'low'\n ", + "description": "Sends an alert whenever soil moisture level readings are too low.", + "createdAt": 1558624363.0, + "actions": [ + { + "sns": { + "targetArn": "arn:aws:sns:us-west-2:123456789012:MyRPiLowMoistureTopic", + "roleArn": "arn:aws:iam::123456789012:role/service-role/MyRPiLowMoistureTopicRole", + "messageFormat": "RAW" + } + } + ], + "ruleDisabled": false, + "awsIotSqlVersion": "2016-03-23" + } + } + +For more information, see `Viewing Your Rules `__ in the *AWS IoT Developers Guide*. + diff -Nru awscli-1.11.13/awscli/examples/iot/get-v2-logging-options.rst awscli-1.18.69/awscli/examples/iot/get-v2-logging-options.rst --- awscli-1.11.13/awscli/examples/iot/get-v2-logging-options.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/get-v2-logging-options.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,15 @@ +**To list the current logging options** + +The following ``get-v2-logging-options`` example lists the current logging options for AWS IoT. :: + + aws iot get-v2-logging-options + +Output:: + + { + "roleArn": "arn:aws:iam::094249569039:role/service-role/iotLoggingRole", + "defaultLogLevel": "WARN", + "disableAllLogs": false + } + +For more information, see `title `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/list-active-violations.rst awscli-1.18.69/awscli/examples/iot/list-active-violations.rst --- awscli-1.11.13/awscli/examples/iot/list-active-violations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-active-violations.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,104 @@ +**To list the active violations** + +The following ``list-active-violations`` example lists all violations for the specified security profile. :: + + aws iot list-active-violations \ + --security-profile-name Testprofile + +Output:: + + { + "activeViolations": [ + { + "violationId": "174db59167fa474c80a652ad1583fd44", + "thingName": "iotconsole-1560269126751-1", + "securityProfileName": "Testprofile", + "behavior": { + "name": "Authorization", + "metric": "aws:num-authorization-failures", + "criteria": { + "comparisonOperator": "greater-than", + "value": { + "count": 10 + }, + "durationSeconds": 300, + "consecutiveDatapointsToAlarm": 1, + "consecutiveDatapointsToClear": 1 + } + }, + "lastViolationValue": { + "count": 0 + }, + "lastViolationTime": 1560293700.0, + "violationStartTime": 1560279000.0 + }, + { + "violationId": "c8a9466a093d3b7b35cd44ca58bdbeab", + "thingName": "TvnQoEoU", + "securityProfileName": "Testprofile", + "behavior": { + "name": "CellularBandwidth", + "metric": "aws:message-byte-size", + "criteria": { + "comparisonOperator": "greater-than", + "value": { + "count": 128 + }, + "consecutiveDatapointsToAlarm": 1, + "consecutiveDatapointsToClear": 1 + } + }, + "lastViolationValue": { + "count": 110 + }, + "lastViolationTime": 1560369000.0, + "violationStartTime": 1560276600.0 + }, + { + "violationId": "74aa393adea02e6648f3ac362beed55e", + "thingName": "iotconsole-1560269232412-2", + "securityProfileName": "Testprofile", + "behavior": { + "name": "Authorization", + "metric": "aws:num-authorization-failures", + "criteria": { + "comparisonOperator": "greater-than", + "value": { + "count": 10 + }, + "durationSeconds": 300, + "consecutiveDatapointsToAlarm": 1, + "consecutiveDatapointsToClear": 1 + } + }, + "lastViolationValue": { + "count": 0 + }, + "lastViolationTime": 1560276600.0, + "violationStartTime": 1560276600.0 + }, + { + "violationId": "1e6ab5f7cf39a1466fcd154e1377e406", + "thingName": "TvnQoEoU", + "securityProfileName": "Testprofile", + "behavior": { + "name": "Authorization", + "metric": "aws:num-authorization-failures", + "criteria": { + "comparisonOperator": "greater-than", + "value": { + "count": 10 + }, + "durationSeconds": 300, + "consecutiveDatapointsToAlarm": 1, + "consecutiveDatapointsToClear": 1 + } + }, + "lastViolationValue": { + "count": 0 + }, + "lastViolationTime": 1560369000.0, + "violationStartTime": 1560276600.0 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/iot/list-attached-policies.rst awscli-1.18.69/awscli/examples/iot/list-attached-policies.rst --- awscli-1.11.13/awscli/examples/iot/list-attached-policies.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-attached-policies.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,39 @@ +**Example 1: To list the policies attached to a group** + +The following ``list-attached-policies`` example lists the policies that are attached to the specified group. :: + + aws iot list-attached-policies \ + --target "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs" + +Output:: + + { + "policies": [ + { + "policyName": "UpdateDeviceCertPolicy", + "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/UpdateDeviceCertPolicy" + } + ] + } + +For more information, see `Thing Groups `__ in the *AWS IoT Developers Guide*. + +**Example 2: To list the policies attached to a device certificate** + +The following ``list-attached-policies`` example lists the AWS IoT policies attached to the device certificate. The certificate is identified by its ARN. :: + + aws iot list-attached-policies \ + --target arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142 + +Output:: + + { + "policies": [ + { + "policyName": "TemperatureSensorPolicy", + "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/TemperatureSensorPolicy" + } + ] + } + +For more information, see `Thing Groups `__ in the *AWS IoT Developers Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/list-audit-findings.rst awscli-1.18.69/awscli/examples/iot/list-audit-findings.rst --- awscli-1.11.13/awscli/examples/iot/list-audit-findings.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-audit-findings.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,149 @@ +**Example 1: To list all findings from an audit** + +The following ``list-audit-findings`` example lists all findings from an AWS IoT Device Defender audit with a specified task ID. :: + + aws iot list-audit-findings \ + --task-id a3aea009955e501a31b764abe1bebd3d + +Output:: + + { + "findings": [] + } + +**Example 2: To list findings for an audit check type** + +The following ``list-audit-findings`` example shows findings from AWS IoT Device Defender audits that ran between June 5, 2019 and June 19, 2019 in which devices are sharing a device certificate. When you specify a check name, you must provide a start and end time. :: + + aws iot list-audit-findings \ + --check-name DEVICE_CERTIFICATE_SHARED_CHECK \ + --start-time 1559747125 \ + --end-time 1560962028 + +Output:: + + { + "findings": [ + { + "taskId": "eeef61068b0eb03c456d746c5a26ee04", + "checkName": "DEVICE_CERTIFICATE_SHARED_CHECK", + "taskStartTime": 1560161017.172, + "findingTime": 1560161017.592, + "severity": "CRITICAL", + "nonCompliantResource": { + "resourceType": "DEVICE_CERTIFICATE", + "resourceIdentifier": { + "deviceCertificateId": "b193ab7162c0fadca83246d24fa090300a1236fe58137e121b011804d8ac1d6b" + } + }, + "relatedResources": [ + { + "resourceType": "CLIENT_ID", + "resourceIdentifier": { + "clientId": "ZipxgAIl" + }, + "additionalInfo": { + "CONNECTION_TIME": "1560086374068" + } + }, + { + "resourceType": "CLIENT_ID", + "resourceIdentifier": { + "clientId": "ZipxgAIl" + }, + "additionalInfo": { + "CONNECTION_TIME": "1560081552187", + "DISCONNECTION_TIME": "1560086371552" + } + }, + { + "resourceType": "CLIENT_ID", + "resourceIdentifier": { + "clientId": "ZipxgAIl" + }, + "additionalInfo": { + "CONNECTION_TIME": "1559289863631", + "DISCONNECTION_TIME": "1560081532716" + } + } + ], + "reasonForNonCompliance": "Certificate shared by one or more devices.", + "reasonForNonComplianceCode": "CERTIFICATE_SHARED_BY_MULTIPLE_DEVICES" + }, + { + "taskId": "bade6b5efd2e1b1569822f6021b39cf5", + "checkName": "DEVICE_CERTIFICATE_SHARED_CHECK", + "taskStartTime": 1559988217.27, + "findingTime": 1559988217.655, + "severity": "CRITICAL", + "nonCompliantResource": { + "resourceType": "DEVICE_CERTIFICATE", + "resourceIdentifier": { + "deviceCertificateId": "b193ab7162c0fadca83246d24fa090300a1236fe58137e121b011804d8ac1d6b" + } + }, + "relatedResources": [ + { + "resourceType": "CLIENT_ID", + "resourceIdentifier": { + "clientId": "xShGENLW" + }, + "additionalInfo": { + "CONNECTION_TIME": "1559972350825" + } + }, + { + "resourceType": "CLIENT_ID", + "resourceIdentifier": { + "clientId": "xShGENLW" + }, + "additionalInfo": { + "CONNECTION_TIME": "1559255062002", + "DISCONNECTION_TIME": "1559972350616" + } + } + ], + "reasonForNonCompliance": "Certificate shared by one or more devices.", + "reasonForNonComplianceCode": "CERTIFICATE_SHARED_BY_MULTIPLE_DEVICES" + }, + { + "taskId": "c23f6233ba2d35879c4bb2810fb5ffd6", + "checkName": "DEVICE_CERTIFICATE_SHARED_CHECK", + "taskStartTime": 1559901817.31, + "findingTime": 1559901817.767, + "severity": "CRITICAL", + "nonCompliantResource": { + "resourceType": "DEVICE_CERTIFICATE", + "resourceIdentifier": { + "deviceCertificateId": "b193ab7162c0fadca83246d24fa090300a1236fe58137e121b011804d8ac1d6b" + } + }, + "relatedResources": [ + { + "resourceType": "CLIENT_ID", + "resourceIdentifier": { + "clientId": "TvnQoEoU" + }, + "additionalInfo": { + "CONNECTION_TIME": "1559826729768" + } + }, + { + "resourceType": "CLIENT_ID", + "resourceIdentifier": { + "clientId": "TvnQoEoU" + }, + "additionalInfo": { + "CONNECTION_TIME": "1559345920964", + "DISCONNECTION_TIME": "1559826728402" + } + } + ], + "reasonForNonCompliance": "Certificate shared by one or more devices.", + "reasonForNonComplianceCode": "CERTIFICATE_SHARED_BY_MULTIPLE_DEVICES" + } + ] + } + +For more information, see `Audit Commands `__ in the *AWS IoT Developer Guide*. + diff -Nru awscli-1.11.13/awscli/examples/iot/list-audit-mitigation-actions-executions.rst awscli-1.18.69/awscli/examples/iot/list-audit-mitigation-actions-executions.rst --- awscli-1.11.13/awscli/examples/iot/list-audit-mitigation-actions-executions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-audit-mitigation-actions-executions.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/iot/list-audit-mitigation-actions-tasks.rst awscli-1.18.69/awscli/examples/iot/list-audit-mitigation-actions-tasks.rst --- awscli-1.11.13/awscli/examples/iot/list-audit-mitigation-actions-tasks.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-audit-mitigation-actions-tasks.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/iot/list-audit-tasks.rst awscli-1.18.69/awscli/examples/iot/list-audit-tasks.rst --- awscli-1.11.13/awscli/examples/iot/list-audit-tasks.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-audit-tasks.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,61 @@ +**To list all findings from an audit** + +The following ``list-audit-tasks`` example lists the audit tasks that ran between June 5, 2019 and June 12, 2019. :: + + aws iot list-audit-tasks \ + --start-time 1559747125 \ + --end-time 1560357228 + +Output:: + + { + "tasks": [ + { + "taskId": "a3aea009955e501a31b764abe1bebd3d", + "taskStatus": "COMPLETED", + "taskType": "ON_DEMAND_AUDIT_TASK" + }, + { + "taskId": "f76b4b5102b632cd9ae38a279c266da1", + "taskStatus": "COMPLETED", + "taskType": "SCHEDULED_AUDIT_TASK" + }, + { + "taskId": "51d9967d9f9ff4d26529505f6d2c444a", + "taskStatus": "COMPLETED", + "taskType": "SCHEDULED_AUDIT_TASK" + }, + { + "taskId": "eeef61068b0eb03c456d746c5a26ee04", + "taskStatus": "COMPLETED", + "taskType": "SCHEDULED_AUDIT_TASK" + }, + { + "taskId": "041c49557b7c7b04c079a49514b55589", + "taskStatus": "COMPLETED", + "taskType": "SCHEDULED_AUDIT_TASK" + }, + { + "taskId": "82c7f2afac1562d18a4560be73998acc", + "taskStatus": "COMPLETED", + "taskType": "SCHEDULED_AUDIT_TASK" + }, + { + "taskId": "bade6b5efd2e1b1569822f6021b39cf5", + "taskStatus": "COMPLETED", + "taskType": "SCHEDULED_AUDIT_TASK" + }, + { + "taskId": "c23f6233ba2d35879c4bb2810fb5ffd6", + "taskStatus": "COMPLETED", + "taskType": "SCHEDULED_AUDIT_TASK" + }, + { + "taskId": "ac9086b7222a2f5e2e17bb6fd30b3aeb", + "taskStatus": "COMPLETED", + "taskType": "SCHEDULED_AUDIT_TASK" + } + ] + } + +For more information, see `Audit Commands `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/list-authorizers.rst awscli-1.18.69/awscli/examples/iot/list-authorizers.rst --- awscli-1.11.13/awscli/examples/iot/list-authorizers.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-authorizers.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,26 @@ +**To list your custom authorizer** + +The following ``list-authorizers`` example lists the custom authorizers in your AWS account. :: + + aws iot list-authorizers + +Output:: + + { + "authorizers": [ + { + "authorizerName": "CustomAuthorizer", + "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer" + }, + { + "authorizerName": "CustomAuthorizer2", + "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer2" + }, + { + "authorizerName": "CustomAuthorizer3", + "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer3" + } + ] + } + +For more information, see `ListAuthorizers `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/list-billing-groups.rst awscli-1.18.69/awscli/examples/iot/list-billing-groups.rst --- awscli-1.11.13/awscli/examples/iot/list-billing-groups.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-billing-groups.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,18 @@ +**To list the billing groups for your AWS account and region** + +The following ``list-billing-groups`` example lists all billing groups that are defined for your AWS account and AWS Region. :: + + aws iot list-billing-groups + +Output:: + + { + "billingGroups": [ + { + "groupName": "GroupOne", + "groupArn": "arn:aws:iot:us-west-2:123456789012:billinggroup/GroupOne" + } + ] + } + +For more information, see `Billing Groups `__ in the *AWS IoT Developers Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/list-ca-certificates.rst awscli-1.18.69/awscli/examples/iot/list-ca-certificates.rst --- awscli-1.11.13/awscli/examples/iot/list-ca-certificates.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-ca-certificates.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,20 @@ +**To list the CA certificates registered in your AWS account** + +The following ``list-ca-certificates`` example lists the CA certificates registered in your AWS account. :: + + aws iot list-ca-certificates + +Output:: + + { + "certificates": [ + { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cacert/f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467", + "certificateId": "f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467", + "status": "INACTIVE", + "creationDate": 1569365372.053 + } + ] + } + +For more information, see `Use Your Own Certificate `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/list-certificates-by-ca.rst awscli-1.18.69/awscli/examples/iot/list-certificates-by-ca.rst --- awscli-1.11.13/awscli/examples/iot/list-certificates-by-ca.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-certificates-by-ca.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,21 @@ +**To list all device certificates signed with a CA certificate** + +The following ``list-certificates-by-ca`` example lists all device certificates in your AWS account that are signed with the specified CA certificate. :: + + aws iot list-certificates-by-ca \ + --ca-certificate-id f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467 + +Output:: + + { + "certificates": [ + { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142", + "certificateId": "488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142", + "status": "ACTIVE", + "creationDate": 1569363250.557 + } + ] + } + +For more information, see `ListCertificatesByCA `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/list-certificates.rst awscli-1.18.69/awscli/examples/iot/list-certificates.rst --- awscli-1.11.13/awscli/examples/iot/list-certificates.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-certificates.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,49 @@ +**Example 1: To list the certificates registered in your AWS account** + +The following ``list-certificates`` example lists all certificates registered in your account. If you have more than the default paging limit of 25, you can use the ``nextMarker`` response value from this command and supply it to the next command to get the next batch of results. Repeat until ``nextMarker`` returns without a value. :: + + aws iot list-certificates + +Output:: + + { + "certificates": [ + { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/604c48437a57b7d5fc5d137c5be75011c6ee67c9a6943683a1acb4b1626bac36", + "certificateId": "604c48437a57b7d5fc5d137c5be75011c6ee67c9a6943683a1acb4b1626bac36", + "status": "ACTIVE", + "creationDate": 1556810537.617 + }, + { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/262a1ac8a7d8aa72f6e96e365480f7313aa9db74b8339ec65d34dc3074e1c31e", + "certificateId": "262a1ac8a7d8aa72f6e96e365480f7313aa9db74b8339ec65d34dc3074e1c31e", + "status": "ACTIVE", + "creationDate": 1546447050.885 + }, + { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/b193ab7162c0fadca83246d24fa090300a1236fe58137e121b011804d8ac1d6b", + "certificateId": "b193ab7162c0fadca83246d24fa090300a1236fe58137e121b011804d8ac1d6b", + "status": "ACTIVE", + "creationDate": 1546292258.322 + }, + { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/7aebeea3845d14a44ec80b06b8b78a89f3f8a706974b8b34d18f5adf0741db42", + "certificateId": "7aebeea3845d14a44ec80b06b8b78a89f3f8a706974b8b34d18f5adf0741db42", + "status": "ACTIVE", + "creationDate": 1541457693.453 + }, + { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/54458aa39ebb3eb39c91ffbbdcc3a6ca1c7c094d1644b889f735a6fc2cd9a7e3", + "certificateId": "54458aa39ebb3eb39c91ffbbdcc3a6ca1c7c094d1644b889f735a6fc2cd9a7e3", + "status": "ACTIVE", + "creationDate": 1541113568.611 + }, + { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/4f0ba725787aa94d67d2fca420eca022242532e8b3c58e7465c7778b443fd65e", + "certificateId": "4f0ba725787aa94d67d2fca420eca022242532e8b3c58e7465c7778b443fd65e", + "status": "ACTIVE", + "creationDate": 1541022751.983 + } + ] + } + diff -Nru awscli-1.11.13/awscli/examples/iot/list-dimensions.rst awscli-1.18.69/awscli/examples/iot/list-dimensions.rst --- awscli-1.11.13/awscli/examples/iot/list-dimensions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-dimensions.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,16 @@ +**To list the dimensions for your AWS account** + +The following ``list-dimensions`` example lists all AWS IoT Device Defender dimensions that are defined in your AWS account. :: + + aws iot list-dimensions + +Output:: + + { + "dimensionNames": [ + "TopicFilterForAuthMessages", + "TopicFilterForActivityMessages" + ] + } + +For more information, see `Detect Commands `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/list-domain-configurations.rst awscli-1.18.69/awscli/examples/iot/list-domain-configurations.rst --- awscli-1.11.13/awscli/examples/iot/list-domain-configurations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-domain-configurations.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/iot/list-indices.rst awscli-1.18.69/awscli/examples/iot/list-indices.rst --- awscli-1.11.13/awscli/examples/iot/list-indices.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-indices.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,15 @@ +**To list the configured search indices** + +The following ``list-indices`` example lists all configured search indices in your AWS account. If you have not enabled thing indexing, you might not have any indices. :: + + aws iot list-indices + +Output:: + + { + "indexNames": [ + "AWS_Things" + ] + } + +For more information, see `Managing Thing Indexing `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/list-job-executions-for-job.rst awscli-1.18.69/awscli/examples/iot/list-job-executions-for-job.rst --- awscli-1.11.13/awscli/examples/iot/list-job-executions-for-job.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-job-executions-for-job.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,22 @@ +**To list the jobs in your AWS account** + +The following ``list-job-executions-for-job`` example lists all jobs in your AWS account, sorted by the job status. :: + + aws iot list-jobs + +Output:: + + { + "jobs": [ + { + "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-01", + "jobId": "example-job-01", + "targetSelection": "SNAPSHOT", + "status": "IN_PROGRESS", + "createdAt": 1560787022.733, + "lastUpdatedAt": 1560787026.294 + } + ] + } + +For more information, see `Creating and Managing Jobs (CLI) `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/list-job-executions-for-thing.rst awscli-1.18.69/awscli/examples/iot/list-job-executions-for-thing.rst --- awscli-1.11.13/awscli/examples/iot/list-job-executions-for-thing.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-job-executions-for-thing.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,24 @@ +**To list the jobs that were executed for a thing** + +The following ``list-job-executions-for-thing`` example lists all jobs that were executed for the thing named ``MyRaspberryPi``. :: + + aws iot list-job-executions-for-thing \ + --thing-name "MyRaspberryPi" + +Output:: + + { + "executionSummaries": [ + { + "jobId": "example-job-01", + "jobExecutionSummary": { + "status": "QUEUED", + "queuedAt": 1560787023.636, + "lastUpdatedAt": 1560787023.636, + "executionNumber": 1 + } + } + ] + } + +For more information, see `Creating and Managing Jobs (CLI) `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/list-jobs.rst awscli-1.18.69/awscli/examples/iot/list-jobs.rst --- awscli-1.11.13/awscli/examples/iot/list-jobs.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-jobs.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,22 @@ +**To list the jobs in your AWS account** + +The following ``list-jobs`` example lists all jobs in your AWS account, sorted by the job status. :: + + aws iot list-jobs + +Output:: + + { + "jobs": [ + { + "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-01", + "jobId": "example-job-01", + "targetSelection": "SNAPSHOT", + "status": "IN_PROGRESS", + "createdAt": 1560787022.733, + "lastUpdatedAt": 1560787026.294 + } + ] + } + +For more information, see `Creating and Managing Jobs (CLI) `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/list-mitigations-actions.rst awscli-1.18.69/awscli/examples/iot/list-mitigations-actions.rst --- awscli-1.11.13/awscli/examples/iot/list-mitigations-actions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-mitigations-actions.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/iot/list-ota-updates.rst awscli-1.18.69/awscli/examples/iot/list-ota-updates.rst --- awscli-1.11.13/awscli/examples/iot/list-ota-updates.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-ota-updates.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,19 @@ +**To list OTA Updates for the account** + +The following ``list-ota-updates`` example lists the available OTA updates. :: + + aws iot list-ota-updates + +Output:: + + { + "otaUpdates": [ + { + "otaUpdateId": "itsaupdate", + "otaUpdateArn": "arn:aws:iot:us-west-2:123456789012:otaupdate/itsaupdate", + "creationDate": 1557863215.995 + } + ] + } + +For more information, see `ListOTAUpdates `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/list-outgoing-certificates.rst awscli-1.18.69/awscli/examples/iot/list-outgoing-certificates.rst --- awscli-1.11.13/awscli/examples/iot/list-outgoing-certificates.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-outgoing-certificates.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,21 @@ +**To list certificates being transferred to a different AWS account** + +The following ``list-outgoing-certificates`` example lists all device certificates that are in the process of being transferred to a different AWS account using the ``transfer-certificate`` command. :: + + aws iot list-outgoing-certificates + +Output:: + + { + "outgoingCertificates": [ + { + "certificateArn": "arn:aws:iot:us-west-2:030714055129:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142", + "certificateId": "488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142", + "transferredTo": "030714055129", + "transferDate": 1569427780.441, + "creationDate": 1569363250.557 + } + ] + } + +For more information, see `ListOutgoingCertificates `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/list-policies.rst awscli-1.18.69/awscli/examples/iot/list-policies.rst --- awscli-1.11.13/awscli/examples/iot/list-policies.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-policies.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,27 @@ +**To list the policies defined in your AWS account** + +The following ``list-policies`` example lists all policies defined in your AWS account. :: + + aws iot list-policies + +Output:: + + { + "policies": [ + { + "policyName": "UpdateDeviceCertPolicy", + "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/UpdateDeviceCertPolicy" + }, + { + "policyName": "PlantIoTPolicy", + "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/PlantIoTPolicy" + }, + { + "policyName": "MyPiGroup_Core-policy", + "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/MyPiGroup_Core-policy" + } + ] + } + +For more information, see `AWS IoT Policies `__ in the *AWS IoT Developers Guide*. + diff -Nru awscli-1.11.13/awscli/examples/iot/list-policy-versions.rst awscli-1.18.69/awscli/examples/iot/list-policy-versions.rst --- awscli-1.11.13/awscli/examples/iot/list-policy-versions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-policy-versions.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,25 @@ +**Example 1: To see all versions of a policy** + +The following ``list-policy-versions`` example lists all versions of the specified policy and their creation dates. :: + + aws iot list-policy-versions \ + --policy-name LightBulbPolicy + +Output:: + + { + "policyVersions": [ + { + "versionId": "2", + "isDefaultVersion": true, + "createDate": 1559925941.924 + }, + { + "versionId": "1", + "isDefaultVersion": false, + "createDate": 1559925941.924 + } + ] + } + +For more information, see `AWS IoT Policies `__ in the *AWS IoT Developers Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/list-principal-things.rst awscli-1.18.69/awscli/examples/iot/list-principal-things.rst --- awscli-1.11.13/awscli/examples/iot/list-principal-things.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-principal-things.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,17 @@ +**To list the things attached with a principal** + +The following ``list-principal-things`` example lists the things attached to the principal specified by an ARN. :: + + aws iot list-principal-things \ + --principal arn:aws:iot:us-west-2:123456789012:cert/2e1eb273792174ec2b9bf4e9b37e6c6c692345499506002a35159767055278e8 + +Output:: + + { + "things": [ + "DeskLamp", + "TableLamp" + ] + } + +For more information, see `ListPrincipalThings `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/list-provisioning-templates.rst awscli-1.18.69/awscli/examples/iot/list-provisioning-templates.rst --- awscli-1.11.13/awscli/examples/iot/list-provisioning-templates.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-provisioning-templates.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,22 @@ +**To list provisioning templates** + +The following ``list-provisioning-templates`` example lists all of the provisioning templates in your AWS account. :: + + aws iot list-provisioning-templates + +Output:: + + { + "templates": [ + { + "templateArn": "arn:aws:iot:us-east-1:123456789012:provisioningtemplate/widget-template", + "templateName": "widget-template", + "description": "A provisioning template for widgets", + "creationDate": 1574800471.367, + "lastModifiedDate": 1574801192.324, + "enabled": false + } + ] + } + +For more information, see `AWS IoT Secure Tunneling `__ in the *AWS IoT Core Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/list-provisioning-template-versions.rst awscli-1.18.69/awscli/examples/iot/list-provisioning-template-versions.rst --- awscli-1.11.13/awscli/examples/iot/list-provisioning-template-versions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-provisioning-template-versions.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,25 @@ +**To list provisioning template versions** + +The following ``list-provisioning-template-versions`` example lists the available versions of the specified provisioning template. :: + + aws iot list-provisioning-template-versions \ + --template-name "widget-template" + +Output:: + + { + "versions": [ + { + "versionId": 1, + "creationDate": 1574800471.339, + "isDefaultVersion": true + }, + { + "versionId": 2, + "creationDate": 1574801192.317, + "isDefaultVersion": false + } + ] + } + +For more information, see `AWS IoT Secure Tunneling `__ in the *AWS IoT Core Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/list-role-aliases.rst awscli-1.18.69/awscli/examples/iot/list-role-aliases.rst --- awscli-1.11.13/awscli/examples/iot/list-role-aliases.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-role-aliases.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,16 @@ +**To list the AWS IoT role aliases in your AWS account** + +The following ``list-role-aliases`` example lists the AWS IoT role aliases in your AWS account. :: + + aws iot list-role-aliases + +Output:: + + { + "roleAliases": [ + "ResidentAlias", + "ElectricianAlias" + ] + } + +For more information, see `ListRoleAliases `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/list-scheduled-audits.rst awscli-1.18.69/awscli/examples/iot/list-scheduled-audits.rst --- awscli-1.11.13/awscli/examples/iot/list-scheduled-audits.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-scheduled-audits.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,25 @@ +**To list the scheduled audits for your AWS account** + +The following ``list-scheduled-audits`` example lists any audits scheduled for your AWS account. :: + + aws iot list-scheduled-audits + +Output:: + + { + "scheduledAudits": [ + { + "scheduledAuditName": "AWSIoTDeviceDefenderDailyAudit", + "scheduledAuditArn": "arn:aws:iot:us-west-2:123456789012:scheduledaudit/AWSIoTDeviceDefenderDailyAudit", + "frequency": "DAILY" + }, + { + "scheduledAuditName": "AWSDeviceDefenderWeeklyAudit", + "scheduledAuditArn": "arn:aws:iot:us-west-2:123456789012:scheduledaudit/AWSDeviceDefenderWeeklyAudit", + "frequency": "WEEKLY", + "dayOfWeek": "SUN" + } + ] + } + +For more information, see `Audit Commands `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/list-security-profiles-for-target.rst awscli-1.18.69/awscli/examples/iot/list-security-profiles-for-target.rst --- awscli-1.11.13/awscli/examples/iot/list-security-profiles-for-target.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-security-profiles-for-target.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,24 @@ +**To list the security profiles attached to a target** + +The following ``list-security-profiles-for-target`` example lists the AWS IoT Device Defender security profiles that are attached to unregistered devices. :: + + aws iot list-security-profiles-for-target \ + --security-profile-target-arn "arn:aws:iot:us-west-2:123456789012:all/unregistered-things" + +Output:: + + { + "securityProfileTargetMappings": [ + { + "securityProfileIdentifier": { + "name": "Testprofile", + "arn": "arn:aws:iot:us-west-2:123456789012:securityprofile/Testprofile" + }, + "target": { + "arn": "arn:aws:iot:us-west-2:123456789012:all/unregistered-things" + } + } + ] + } + +For more information, see `Detect Commands `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/list-security-profiles.rst awscli-1.18.69/awscli/examples/iot/list-security-profiles.rst --- awscli-1.11.13/awscli/examples/iot/list-security-profiles.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-security-profiles.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,18 @@ +**To list the security profiles for your AWS account** + +The following ``list-security-profiles`` example lists all AWS IoT Device Defender security profiles that are defined in your AWS account. :: + + aws iot list-security-profiles + +Output:: + + { + "securityProfileIdentifiers": [ + { + "name": "Testprofile", + "arn": "arn:aws:iot:us-west-2:123456789012:securityprofile/Testprofile" + } + ] + } + +For more information, see `Detect Commands `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/list-streams.rst awscli-1.18.69/awscli/examples/iot/list-streams.rst --- awscli-1.11.13/awscli/examples/iot/list-streams.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-streams.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,26 @@ +**To list the streams in the account** + +The following ``list-streams`` example lists all of the streams in your AWS account. :: + + aws iot list-streams + +Output:: + + { + "streams": [ + { + "streamId": "stream12345", + "streamArn": "arn:aws:iot:us-west-2:123456789012:stream/stream12345", + "streamVersion": 1, + "description": "This stream is used for Amazon FreeRTOS OTA Update 12345." + }, + { + "streamId": "stream54321", + "streamArn": "arn:aws:iot:us-west-2:123456789012:stream/stream54321", + "streamVersion": 1, + "description": "This stream is used for Amazon FreeRTOS OTA Update 54321." + } + ] + } + +For more information, see `ListStreams `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/list-tags-for-resource.rst awscli-1.18.69/awscli/examples/iot/list-tags-for-resource.rst --- awscli-1.11.13/awscli/examples/iot/list-tags-for-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-tags-for-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,23 @@ +**To display the tags and their values associated with a resource** + +The following ``list-tags-for-resource`` example displays the tags and values associated with the thing group ``LightBulbs``. :: + + aws iot list-tags-for-resource \ + --resource-arn "arn:aws:iot:us-west-2:094249569039:thinggroup/LightBulbs" + +Output:: + + { + "tags": [ + { + "Key": "Assembly", + "Value": "Fact1NW" + }, + { + "Key": "MyTag", + "Value": "777" + } + ] + } + +For more information, see `Tagging Your AWS IoT Resources `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/list-targets-for-policy.rst awscli-1.18.69/awscli/examples/iot/list-targets-for-policy.rst --- awscli-1.11.13/awscli/examples/iot/list-targets-for-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-targets-for-policy.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,17 @@ +**To list the principals associated with an AWS IoT policy** + +The following ``list-targets-for-policy`` example lists the device certificates to which the specified policy is attached. :: + + aws iot list-targets-for-policy \ + --policy-name UpdateDeviceCertPolicy + +Output:: + + { + "targets": [ + "arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142", + "arn:aws:iot:us-west-2:123456789012:cert/d1eb269fb55a628552143c8f96eb3c258fcd5331ea113e766ba0c82bf225f0be" + ] + } + +For more information, see `Thing Groups `__ in the *AWS IoT Developers Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/list-targets-for-security-profile.rst awscli-1.18.69/awscli/examples/iot/list-targets-for-security-profile.rst --- awscli-1.11.13/awscli/examples/iot/list-targets-for-security-profile.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-targets-for-security-profile.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,21 @@ +**To list the targets to which a security profile is applied** + +The following ``list-targets-for-security-profile`` example lists the targets to which the AWS IoT Device Defender security profile named ``PossibleIssue`` is applied. :: + + aws iot list-targets-for-security-profile \ + --security-profile-name Testprofile + +Output:: + + { + "securityProfileTargets": [ + { + "arn": "arn:aws:iot:us-west-2:123456789012:all/unregistered-things" + }, + { + "arn": "arn:aws:iot:us-west-2:123456789012:all/registered-things" + } + ] + } + +For more information, see `Detect Commands `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/list-thing-groups-for-thing.rst awscli-1.18.69/awscli/examples/iot/list-thing-groups-for-thing.rst --- awscli-1.11.13/awscli/examples/iot/list-thing-groups-for-thing.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-thing-groups-for-thing.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,24 @@ +**To list the groups that a thing belongs to** + +The following ``list-thing-groups-for-thing`` example lists the groups to which the specified thing belongs. :: + + aws iot list-thing-groups-for-thing \ + --thing-name MyLightBulb + +Output:: + + { + "thingGroups": [ + { + "groupName": "DeadBulbs", + "groupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/DeadBulbs" + }, + { + "groupName": "LightBulbs", + "groupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs" + } + ] + } + +For more information, see `Thing Groups `__ in the *AWS IoT Developers Guide*. + diff -Nru awscli-1.11.13/awscli/examples/iot/list-thing-groups.rst awscli-1.18.69/awscli/examples/iot/list-thing-groups.rst --- awscli-1.11.13/awscli/examples/iot/list-thing-groups.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-thing-groups.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,23 @@ +**To list the thing groups defined in your AWS account** + +The following ``describe-thing-group`` example lists all thing groups defined in your AWS account. :: + + aws iot list-thing-groups + +Output:: + + { + "thingGroups": [ + { + "groupName": "HalogenBulbs", + "groupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/HalogenBulbs" + }, + { + "groupName": "LightBulbs", + "groupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs" + } + ] + } + +For more information, see `Thing Groups `__ in the *AWS IoT Developers Guide*. + diff -Nru awscli-1.11.13/awscli/examples/iot/list-thing-principals.rst awscli-1.18.69/awscli/examples/iot/list-thing-principals.rst --- awscli-1.11.13/awscli/examples/iot/list-thing-principals.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-thing-principals.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,16 @@ +**To list the principals associated with a thing** + +The following ``list-thing-principals`` example lists the principals (X.509 certificates, IAM users, groups, roles, Amazon Cognito identities, or federated identities) associated with the specified thing. :: + + aws iot list-thing-principals \ + --thing-name MyRaspberryPi + +Output:: + + { + "principals": [ + "arn:aws:iot:us-west-2:123456789012:cert/33475ac865079a5ffd5ecd44240640349293facc760642d7d8d5dbb6b4c86893" + ] + } + +For more information, see `ListThingPrincipals `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/list-things-in-billing-group.rst awscli-1.18.69/awscli/examples/iot/list-things-in-billing-group.rst --- awscli-1.11.13/awscli/examples/iot/list-things-in-billing-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-things-in-billing-group.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,17 @@ +**To list the things in a billing group** + +The following ``list-things-in-billing-group`` example lists the things that are in the specified billing group. :: + + aws iot list-things-in-billing-group \ + --billing-group-name GroupOne + +Output:: + + { + "things": [ + "MyOtherLightBulb", + "MyLightBulb" + ] + } + +For more information, see `Billing Groups `__ in the *AWS IoT Developers Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/list-things-in-thing-group.rst awscli-1.18.69/awscli/examples/iot/list-things-in-thing-group.rst --- awscli-1.11.13/awscli/examples/iot/list-things-in-thing-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-things-in-thing-group.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,16 @@ +**To list the things that belong to a group** + +The following ``list-things-in-thing-group`` example lists the things that belong to the specified thing group. :: + + aws iot list-things-in-thing-group \ + --thing-group-name LightBulbs + +Output:: + + { + "things": [ + "MyLightBulb" + ] + } + +For more information, see `Thing Groups `__ in the *AWS IoT Developers Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/list-things.rst awscli-1.18.69/awscli/examples/iot/list-things.rst --- awscli-1.11.13/awscli/examples/iot/list-things.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-things.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,84 @@ +**Example 1: To list all things in the registry** + +The following ``list-things`` example lists the things (devices) that are defined in the AWS IoT registry for your AWS account. :: + + aws iot list-things + +Output:: + + { + "things": [ + { + "thingName": "ThirdBulb", + "thingTypeName": "LightBulb", + "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/ThirdBulb", + "attributes": { + "model": "123", + "wattage": "75" + }, + "version": 2 + }, + { + "thingName": "MyOtherLightBulb", + "thingTypeName": "LightBulb", + "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyOtherLightBulb", + "attributes": { + "model": "123", + "wattage": "75" + }, + "version": 3 + }, + { + "thingName": "MyLightBulb", + "thingTypeName": "LightBulb", + "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyLightBulb", + "attributes": { + "model": "123", + "wattage": "75" + }, + "version": 1 + }, + { + "thingName": "SampleIoTThing", + "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/SampleIoTThing", + "attributes": {}, + "version": 1 + } + ] + } + +**Example 2: To list the defined things that have a specific attribute** + +The following ``list-things`` example displays a list of things that have an attribute named ``wattage``. :: + + aws iot list-things \ + --attribute-name wattage + +Output:: + + { + "things": [ + { + "thingName": "MyLightBulb", + "thingTypeName": "LightBulb", + "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyLightBulb", + "attributes": { + "model": "123", + "wattage": "75" + }, + "version": 1 + }, + { + "thingName": "MyOtherLightBulb", + "thingTypeName": "LightBulb", + "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyOtherLightBulb", + "attributes": { + "model": "123", + "wattage": "75" + }, + "version": 3 + } + ] + } + +For more information, see `How to Manage Things with the Registry `__ in the *AWS IoT Developers Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/list-thing-types.rst awscli-1.18.69/awscli/examples/iot/list-thing-types.rst --- awscli-1.11.13/awscli/examples/iot/list-thing-types.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-thing-types.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,29 @@ +**To list the defined thing types** + +The following ``list-thing-types`` example displays a list of thing types defined in your AWS account. :: + + aws iot list-thing-types + +Output:: + + { + "thingTypes": [ + { + "thingTypeName": "LightBulb", + "thingTypeArn": "arn:aws:iot:us-west-2:123456789012:thingtype/LightBulb", + "thingTypeProperties": { + "thingTypeDescription": "light bulb type", + "searchableAttributes": [ + "model", + "wattage" + ] + }, + "thingTypeMetadata": { + "deprecated": false, + "creationDate": 1559772562.498 + } + } + ] + } + +For more information, see `Thing Types `__ in the *AWS IoT Developers Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/list-topic-rules.rst awscli-1.18.69/awscli/examples/iot/list-topic-rules.rst --- awscli-1.11.13/awscli/examples/iot/list-topic-rules.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-topic-rules.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,28 @@ +**To list your rules** + +The following ``list-topic-rules`` example lists all rules that you have defined. :: + + aws iot list-topic-rules + +Output:: + + { + "rules": [ + { + "ruleArn": "arn:aws:iot:us-west-2:123456789012:rule/MyRPiLowMoistureAlertRule", + "ruleName": "MyRPiLowMoistureAlertRule", + "topicPattern": "$aws/things/MyRPi/shadow/update/accepted", + "createdAt": 1558624363.0, + "ruleDisabled": false + }, + { + "ruleArn": "arn:aws:iot:us-west-2:123456789012:rule/MyPlantPiMoistureAlertRule", + "ruleName": "MyPlantPiMoistureAlertRule", + "topicPattern": "$aws/things/MyPlantPi/shadow/update/accepted", + "createdAt": 1541458459.0, + "ruleDisabled": false + } + ] + } + +For more information, see `Viewing Your Rules `__ in the *AWS IoT Developers Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/list-v2-logging-levels.rst awscli-1.18.69/awscli/examples/iot/list-v2-logging-levels.rst --- awscli-1.11.13/awscli/examples/iot/list-v2-logging-levels.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-v2-logging-levels.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,18 @@ +**To list logging levels** + +The following ``list-v2-logging-levels`` example lists the configured logging levels. If logging levels were not set, a ``NotConfiguredException`` occurs when you run this command. :: + + aws iot list-v2-logging-levels + +Output:: + + { + "logTargetConfigurations": [ + { + "logTarget": { + "targetType": "DEFAULT" + }, + "logLevel": "ERROR" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/iot/list-violation-events.rst awscli-1.18.69/awscli/examples/iot/list-violation-events.rst --- awscli-1.11.13/awscli/examples/iot/list-violation-events.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/list-violation-events.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,107 @@ +**To list the security profile violations during a time period** + +The following ``list-violation-events`` example lists violations that occurred between June 5, 2019 and June 12, 2019 for all AWS IoT Device Defender security profiles for the current AWS account and AWS Region. :: + + aws iot list-violation-events \ + --start-time 1559747125 \ + --end-time 1560351925 + +Output:: + + { + "violationEvents": [ + { + "violationId": "174db59167fa474c80a652ad1583fd44", + "thingName": "iotconsole-1560269126751-1", + "securityProfileName": "Testprofile", + "behavior": { + "name": "Authorization", + "metric": "aws:num-authorization-failures", + "criteria": { + "comparisonOperator": "greater-than", + "value": { + "count": 10 + }, + "durationSeconds": 300, + "consecutiveDatapointsToAlarm": 1, + "consecutiveDatapointsToClear": 1 + } + }, + "metricValue": { + "count": 0 + }, + "violationEventType": "in-alarm", + "violationEventTime": 1560279000.0 + }, + { + "violationId": "c8a9466a093d3b7b35cd44ca58bdbeab", + "thingName": "TvnQoEoU", + "securityProfileName": "Testprofile", + "behavior": { + "name": "CellularBandwidth", + "metric": "aws:message-byte-size", + "criteria": { + "comparisonOperator": "greater-than", + "value": { + "count": 128 + }, + "consecutiveDatapointsToAlarm": 1, + "consecutiveDatapointsToClear": 1 + } + }, + "metricValue": { + "count": 110 + }, + "violationEventType": "in-alarm", + "violationEventTime": 1560276600.0 + }, + { + "violationId": "74aa393adea02e6648f3ac362beed55e", + "thingName": "iotconsole-1560269232412-2", + "securityProfileName": "Testprofile", + "behavior": { + "name": "Authorization", + "metric": "aws:num-authorization-failures", + "criteria": { + "comparisonOperator": "greater-than", + "value": { + "count": 10 + }, + "durationSeconds": 300, + "consecutiveDatapointsToAlarm": 1, + "consecutiveDatapointsToClear": 1 + } + }, + "metricValue": { + "count": 0 + }, + "violationEventType": "in-alarm", + "violationEventTime": 1560276600.0 + }, + { + "violationId": "1e6ab5f7cf39a1466fcd154e1377e406", + "thingName": "TvnQoEoU", + "securityProfileName": "Testprofile", + "behavior": { + "name": "Authorization", + "metric": "aws:num-authorization-failures", + "criteria": { + "comparisonOperator": "greater-than", + "value": { + "count": 10 + }, + "durationSeconds": 300, + "consecutiveDatapointsToAlarm": 1, + "consecutiveDatapointsToClear": 1 + } + }, + "metricValue": { + "count": 0 + }, + "violationEventType": "in-alarm", + "violationEventTime": 1560276600.0 + } + ] + } + +For more information, see `Detect Commands `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/register-ca-certificate.rst awscli-1.18.69/awscli/examples/iot/register-ca-certificate.rst --- awscli-1.11.13/awscli/examples/iot/register-ca-certificate.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/register-ca-certificate.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,16 @@ +**To register a certificate authority (CA) certificate** + +The following ``register-ca-certificate`` example registers a CA certificate. The command supplies the CA certificate and a key verification certificate that proves you own the private key associated with the CA certificate. :: + + aws iot register-ca-certificate \ + --ca-certificate file://rootCA.pem \ + --verification-cert file://verificationCert.pem + +Output:: + + { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cacert/f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467", + "certificateId": "f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467" + } + +For more information, see `RegisterCACertificate `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/register-certificate.rst awscli-1.18.69/awscli/examples/iot/register-certificate.rst --- awscli-1.11.13/awscli/examples/iot/register-certificate.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/register-certificate.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,16 @@ +**To register a self signed device certificate** + +The following ``register-certificate`` example registers the ``deviceCert.pem`` device certificate signed by the ``rootCA.pem`` CA certificate. The CA certificate must be registered before you use it to register a self-signed device certificate. The self-signed certificate must be signed by the same CA certificate you pass to this command. :: + + aws iot register-certificate \ + --certificate-pem file://deviceCert.pem \ + --ca-certificate-pem file://rootCA.pem + +Output:: + + { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142", + "certificateId": "488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142" + } + +For more information, see `RegisterCertificate `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/reject-certificate-transfer.rst awscli-1.18.69/awscli/examples/iot/reject-certificate-transfer.rst --- awscli-1.11.13/awscli/examples/iot/reject-certificate-transfer.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/reject-certificate-transfer.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,10 @@ +**To reject a certificate transfer** + +The following ``reject-certificate-transfer`` example rejects the transfer of the specified device certificate from another AWS account. :: + + aws iot reject-certificate-transfer \ + --certificate-id f0f33678c7c9a046e5cc87b2b1a58dfa0beec26db78addd5e605d630e05c7fc8 + +This command produces no output. + +For more information, see `RejectCertificateTransfer `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/remove-thing-from-billing-group.rst awscli-1.18.69/awscli/examples/iot/remove-thing-from-billing-group.rst --- awscli-1.11.13/awscli/examples/iot/remove-thing-from-billing-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/remove-thing-from-billing-group.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,12 @@ +**To remove a thing from a billing group** + +The following ``remove-thing-from-billing-group`` example removes the specified thing from a billing group. :: + + aws iot remove-thing-from-billing-group \ + --billing-group-name GroupOne \ + --thing-name MyOtherLightBulb + +This command produces no output. + +For more information, see `Billing Groups `__ in the *AWS IoT Developers Guide*. + diff -Nru awscli-1.11.13/awscli/examples/iot/remove-thing-from-thing-group.rst awscli-1.18.69/awscli/examples/iot/remove-thing-from-thing-group.rst --- awscli-1.11.13/awscli/examples/iot/remove-thing-from-thing-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/remove-thing-from-thing-group.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,12 @@ +**To remove a thing from a thing group** + +The following ``remove-thing-from-thing-group`` example removes the specified thing from a thing group. :: + + aws iot remove-thing-from-thing-group \ + --thing-name bulb7 \ + --thing-group-name DeadBulbs + +This command produces no output. + +For more information, see `Thing Groups `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/replace-topic-rule.rst awscli-1.18.69/awscli/examples/iot/replace-topic-rule.rst --- awscli-1.11.13/awscli/examples/iot/replace-topic-rule.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/replace-topic-rule.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To update a topic's rule definition** + +The following ``replace-topic-rule`` example updates the specified rule to send an SNS alert when soil moisture level readings are too low. :: + + aws iot replace-topic-rule \ + --rule-name MyRPiLowMoistureAlertRule \ + --topic-rule-payload "{\"sql\": \"SELECT * FROM '$aws/things/MyRPi/shadow/update/accepted' WHERE state.reported.moisture = 'low'\", \"description\": \"Sends an alert when soil moisture level readings are too low.\",\"actions\": [{\"sns\":{\"targetArn\":\"arn:aws:sns:us-west-2:123456789012:MyRPiLowMoistureTopic\",\"roleArn\":\"arn:aws:iam::123456789012:role/service-role/MyRPiLowMoistureTopicRole\",\"messageFormat\": \"RAW\"}}],\"ruleDisabled\": false,\"awsIotSqlVersion\":\"2016-03-23\"}" + +This command produces no output. + +For more information, see `Creating an AWS IoT Rule `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/search-index.rst awscli-1.18.69/awscli/examples/iot/search-index.rst --- awscli-1.11.13/awscli/examples/iot/search-index.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/search-index.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,56 @@ +**To query the thing index** + +The following ``search-index`` example queries the ``AWS_Things`` index for things that have a type of ``LightBulb``. :: + + aws iot search-index \ + --index-name "AWS_Things" \ + --query-string "thingTypeName:LightBulb" + +Output:: + + { + "things": [ + { + "thingName": "MyLightBulb", + "thingId": "40da2e73-c6af-406e-b415-15acae538797", + "thingTypeName": "LightBulb", + "thingGroupNames": [ + "LightBulbs", + "DeadBulbs" + ], + "attributes": { + "model": "123", + "wattage": "75" + }, + "connectivity": { + "connected": false + } + }, + { + "thingName": "ThirdBulb", + "thingId": "615c8455-33d5-40e8-95fd-3ee8b24490af", + "thingTypeName": "LightBulb", + "attributes": { + "model": "123", + "wattage": "75" + }, + "connectivity": { + "connected": false + } + }, + { + "thingName": "MyOtherLightBulb", + "thingId": "6dae0d3f-40c1-476a-80c4-1ed24ba6aa11", + "thingTypeName": "LightBulb", + "attributes": { + "model": "123", + "wattage": "75" + }, + "connectivity": { + "connected": false + } + } + ] + } + +For more information, see `Managing Thing Indexing `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/set-default-authorizer.rst awscli-1.18.69/awscli/examples/iot/set-default-authorizer.rst --- awscli-1.11.13/awscli/examples/iot/set-default-authorizer.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/set-default-authorizer.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,15 @@ +**To set a default authorizer** + +The following ``set-default-authorizer`` example sets the custom authorizer named ``CustomAuthorizer`` as the default authorizer. :: + + aws iot set-default-authorizer \ + --authorizer-name CustomAuthorizer + +Output:: + + { + "authorizerName": "CustomAuthorizer", + "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer" + } + +For more information, see `CreateDefaultAuthorizer `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/set-default-policy-version.rst awscli-1.18.69/awscli/examples/iot/set-default-policy-version.rst --- awscli-1.11.13/awscli/examples/iot/set-default-policy-version.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/set-default-policy-version.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,9 @@ +**To set the default version for a policy** + +The following ``set-default-policy-version`` example sets the default version to ``2`` for the policy named ``UpdateDeviceCertPolicy``. :: + + aws iot set-default-policy-version \ + --policy-name UpdateDeviceCertPolicy \ + --policy-version-id 2 + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/iot/set-v2-logging-level.rst awscli-1.18.69/awscli/examples/iot/set-v2-logging-level.rst --- awscli-1.11.13/awscli/examples/iot/set-v2-logging-level.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/set-v2-logging-level.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,10 @@ +**To set the logging level for a thing group** + +The following ``set-v2-logging-level`` example sets the logging level to log warnings for the specified thing group. :: + + aws iot set-v2-logging-level \ + --log-target "{\"targetType\":\"THING_GROUP\",\"targetName\":\"LightBulbs\"}" \ + --log-level WARN + + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/iot/set-v2-logging-options.rst awscli-1.18.69/awscli/examples/iot/set-v2-logging-options.rst --- awscli-1.11.13/awscli/examples/iot/set-v2-logging-options.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/set-v2-logging-options.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,9 @@ +**To set the logging options** + +The following ``set-v2-logging-options`` example sets the default logging verbosity level to ERROR and specifies the ARN to use for logging. :: + + aws iot set-v2-logging-options \ + --default-log-level ERROR \ + --role-arn "arn:aws:iam::094249569039:role/service-role/iotLoggingRole" + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/iot/start-audit-mitigation-actions-task.rst awscli-1.18.69/awscli/examples/iot/start-audit-mitigation-actions-task.rst --- awscli-1.11.13/awscli/examples/iot/start-audit-mitigation-actions-task.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/start-audit-mitigation-actions-task.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/iot/start-on-demand-audit-task.rst awscli-1.18.69/awscli/examples/iot/start-on-demand-audit-task.rst --- awscli-1.11.13/awscli/examples/iot/start-on-demand-audit-task.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/start-on-demand-audit-task.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,14 @@ +**To start an audit right away** + +The following ``start-on-demand-audit-task`` example starts an AWS IoT Device Defender audit and performs three certificate checks. :: + + aws iot start-on-demand-audit-task \ + --target-check-names CA_CERTIFICATE_EXPIRING_CHECK DEVICE_CERTIFICATE_EXPIRING_CHECK REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK + +Output:: + + { + "taskId": "a3aea009955e501a31b764abe1bebd3d" + } + +For more information, see `Audit Commands `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/tag-resource.rst awscli-1.18.69/awscli/examples/iot/tag-resource.rst --- awscli-1.11.13/awscli/examples/iot/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/tag-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To specify a tag key and value for a resource** + +The following ``tag-resource`` example applies the tag with a key ``Assembly`` and the value ``Fact1NW`` to the thing group ``LightBulbs``. :: + + aws iot tag-resource \ + --tags Key=Assembly,Value="Fact1NW" \ + --resource-arn "arn:aws:iot:us-west-2:094249569039:thinggroup/LightBulbs" + +This command produces no output. + +For more information, see `Tagging Your AWS IoT Resources `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/test-authorization.rst awscli-1.18.69/awscli/examples/iot/test-authorization.rst --- awscli-1.11.13/awscli/examples/iot/test-authorization.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/test-authorization.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,52 @@ +**To test your AWS IoT policies** + +The following ``test-authorization`` example tests the AWS IoT policies associated with the specified principal. :: + + aws iot test-authorization \ + --auth-infos actionType=CONNECT,resources=arn:aws:iot:us-east-1:123456789012:client/client1 \ + --principal arn:aws:iot:us-west-2:123456789012:cert/aab1068f7f43ac3e3cae4b3a8aa3f308d2a750e6350507962e32c1eb465d9775 + +Output:: + + { + "authResults": [ + { + "authInfo": { + "actionType": "CONNECT", + "resources": [ + "arn:aws:iot:us-east-1:123456789012:client/client1" + ] + }, + "allowed": { + "policies": [ + { + "policyName": "TestPolicyAllowed", + "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/TestPolicyAllowed" + } + ] + }, + "denied": { + "implicitDeny": { + "policies": [ + { + "policyName": "TestPolicyDenied", + "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/TestPolicyDenied" + } + ] + }, + "explicitDeny": { + "policies": [ + { + "policyName": "TestPolicyExplicitDenied", + "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/TestPolicyExplicitDenied" + } + ] + } + }, + "authDecision": "IMPLICIT_DENY", + "missingContextValues": [] + } + ] + } + +For more information, see `TestAuthorization `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/test-invoke-authorizer.rst awscli-1.18.69/awscli/examples/iot/test-invoke-authorizer.rst --- awscli-1.11.13/awscli/examples/iot/test-invoke-authorizer.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/test-invoke-authorizer.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,22 @@ +**To test your custom authorizer** + +The following ``test-invoke-authorizer`` example testS your custom authorizer. :: + + aws iot test-invoke-authorizer \ + --authorizer-name IoTAuthorizer \ + --token allow \ + --token-signature "mE0GvaHqy9nER/FdgtJX5lXYEJ3b3vE7t1gEszc0TKGgLKWXTnPkb2AbKnOAZ8lGyoN5dVtWDWVmr25m7++zjbYIMk2TBvyGXhOmvKFBPkdgyA43KL6SiZy0cTqlPMcQDsP7VX2rXr7CTowCxSNKphGXdQe0/I5dQ+JO6KUaHwCmupt0/MejKtaNwiia064j6wprOAUwG5S1IYFuRd0X+wfo8pb0DubAIX1Ua705kuhRUcTx4SxUShEYKmN4IDEvLB6FsIr0B2wvB7y4iPmcajxzGl02ExvyCUNctCV9dYlRRGJj0nsGzBIXOI4sGytPfqlA7obdgmN22pkDzYvwjQ==" + +Output:: + + { + "isAuthenticated": true, + "principalId": "principalId", + "policyDocuments": [ + "{"Version":"2012-10-17","Statement":[{"Action":"iot:Publish","Effect":"Allow","Resource":"arn:aws:iot:us-west-2:123456789012:topic/customauthtesting"}]}" + ], + "refreshAfterInSeconds": 600, + "disconnectAfterInSeconds": 3600 + } + +For more information, see `TestInvokeAuthorizer `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/transfer-certificate.rst awscli-1.18.69/awscli/examples/iot/transfer-certificate.rst --- awscli-1.11.13/awscli/examples/iot/transfer-certificate.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/transfer-certificate.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,15 @@ +**To transfer a device certificate to a different AWS account** + +The following ``transfer-certificate`` example transfers a device certificate to another AWS account. The certificate and AWS account are identified by ID. :: + + aws iot transfer-certificate \ + --certificate-id 488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142 \ + --target-aws-account 030714055129 + +Output:: + + { + "transferredCertificateArn": "arn:aws:iot:us-west-2:030714055129:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142" + } + +For more information, see `TransferCertificate `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/untag-resource.rst awscli-1.18.69/awscli/examples/iot/untag-resource.rst --- awscli-1.11.13/awscli/examples/iot/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/untag-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,9 @@ +**To remove a tag key from a resource** + +The following ``untag-resource`` example removes the tag ``MyTag`` and its value from the thing group ``LightBulbs``. :: + + command + +This command produces no output. + +For more information, see `Tagging Your AWS IoT Resources `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/update-account-audit-configuration.rst awscli-1.18.69/awscli/examples/iot/update-account-audit-configuration.rst --- awscli-1.11.13/awscli/examples/iot/update-account-audit-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/update-account-audit-configuration.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,19 @@ +**Example 1: To enable Amazon SNS notifications for audit notifications** + +The following ``update-account-audit-configuration`` example enables Amazon SNS notifications for AWS IoT Device Defender audit notifications, specifying a target and the role used to write to that target. :: + + aws iot update-account-audit-configuration \ + --audit-notification-target-configurations "SNS={targetArn=\"arn:aws:sns:us-west-2:123456789012:ddaudits\",roleArn=\"arn:aws:iam::123456789012:role/service-role/AWSIoTDeviceDefenderAudit\",enabled=true}" + +This command produces no output. + +**Example 2: To enable an audit check** + +The following ``update-account-audit-configuration`` example enables the AWS IoT Device Defender audit check named ``AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK``. You cannot disable an audit check if it is part of the ``targetCheckNames`` for one or more scheduled audits for the AWS account. :: + + aws iot update-account-audit-configuration \ + --audit-check-configurations "{\"AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK\":{\"enabled\":true}}" + +This command produces no output. + +For more information, see `Audit Commands `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/update-authorizer.rst awscli-1.18.69/awscli/examples/iot/update-authorizer.rst --- awscli-1.11.13/awscli/examples/iot/update-authorizer.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/update-authorizer.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,16 @@ +**To update a custom authorizer** + +The following ``update-authorizer`` example he state of ``CustomAuthorizer2`` to ``INACTIVE``. :: + + aws iot update-authorizer \ + --authorizer-name CustomAuthorizer2 \ + --status INACTIVE + +Output:: + + { + "authorizerName": "CustomAuthorizer2", + "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer2" + } + +For more information, see `UpdateAuthorizer `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/update-billing-group.rst awscli-1.18.69/awscli/examples/iot/update-billing-group.rst --- awscli-1.11.13/awscli/examples/iot/update-billing-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/update-billing-group.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,15 @@ +**To update information about a billing group** + +The following ``update-billing-group`` example updates the description for the specified billing group. :: + + aws iot update-billing-group \ + --billing-group-name GroupOne \ + --billing-group-properties "billingGroupDescription=\"Primary bulb billing group\"" + +Output:: + + { + "version": 2 + } + +For more information, see `Billing Groups `__ in the *AWS IoT Developers Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/update-ca-certificate.rst awscli-1.18.69/awscli/examples/iot/update-ca-certificate.rst --- awscli-1.11.13/awscli/examples/iot/update-ca-certificate.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/update-ca-certificate.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To update a certificate authority (CA) certificate** + +The following ``update-ca-certificate`` example sets the specified CA certificate to ACTIVE status. :: + + aws iot update-ca-certificate \ + --certificate-id f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467 \ + --new-status ACTIVE + +This command produces no output. + +For more information, see `UpdateCACertificate `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/update-certificate.rst awscli-1.18.69/awscli/examples/iot/update-certificate.rst --- awscli-1.11.13/awscli/examples/iot/update-certificate.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/update-certificate.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To update a device certificate** + +The following ``update-certificate`` example sets the specified device certificate to INACTIVE status. :: + + aws iot update-certificate \ + --certificate-id d1eb269fb55a628552143c8f96eb3c258fcd5331ea113e766ba0c82bf225f0be \ + --new-status INACTIVE + +This command produces no output. + +For more information, see `UpdateCertificate `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/update-domain-configuration.rst awscli-1.18.69/awscli/examples/iot/update-domain-configuration.rst --- awscli-1.11.13/awscli/examples/iot/update-domain-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/update-domain-configuration.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/iot/update-dynamic-thing-group.rst awscli-1.18.69/awscli/examples/iot/update-dynamic-thing-group.rst --- awscli-1.11.13/awscli/examples/iot/update-dynamic-thing-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/update-dynamic-thing-group.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,16 @@ +**To update a dynamic thing group** + +The following ``update-dynamic-thing-group`` example updates the specified dynamic thing group. It provides a description and updates the query string to change the group membership criteria. :: + + aws iot update-dynamic-thing-group \ + --thing-group-name "RoomTooWarm" + --thing-group-properties "thingGroupDescription=\"This thing group contains rooms warmer than 65F.\"" \ + --query-string "attributes.temperature>65" + +Output:: + + { + "version": 2 + } + +For more information, see `Dynamic Thing Groups `__ in the *AWS IoT Developers Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/update-event-configurations.rst awscli-1.18.69/awscli/examples/iot/update-event-configurations.rst --- awscli-1.11.13/awscli/examples/iot/update-event-configurations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/update-event-configurations.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,10 @@ +**To show which event types are published** + +The following ``update-event-configurations`` example updates the configuration to enable messages when the CA certificate is added, updated, or deleted. :: + + aws iot update-event-configurations \ + --event-configurations "{\"CA_CERTIFICATE\":{\"Enabled\":true}}" + +This command produces no output. + +For more information, see `Event Messages `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/update-indexing-configuration.rst awscli-1.18.69/awscli/examples/iot/update-indexing-configuration.rst --- awscli-1.11.13/awscli/examples/iot/update-indexing-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/update-indexing-configuration.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To enable thing indexing** + +The following ``update-indexing-configuration`` example enables thing indexing to support searching registry data, shadow data, and thing connectivity status using the AWS_Things index. :: + + aws iot update-indexing-configuration + --thing-indexing-configuration thingIndexingMode=REGISTRY_AND_SHADOW,thingConnectivityIndexingMode=STATUS + +This command produces no output. + +For more information, see `Managing Thing Indexing `__ in the *AWS IoT Developers Guide*. + diff -Nru awscli-1.11.13/awscli/examples/iot/update-job.rst awscli-1.18.69/awscli/examples/iot/update-job.rst --- awscli-1.11.13/awscli/examples/iot/update-job.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/update-job.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,38 @@ +**To get detailed status for a job** + +The following ``update-job`` example gets detailed status for the job whose ID is ``example-job-01``. :: + + aws iot describe-job \ + --job-id "example-job-01" + +Output:: + + { + "job": { + "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-01", + "jobId": "example-job-01", + "targetSelection": "SNAPSHOT", + "status": "IN_PROGRESS", + "targets": [ + "arn:aws:iot:us-west-2:123456789012:thing/MyRaspberryPi" + ], + "description": "example job test", + "presignedUrlConfig": {}, + "jobExecutionsRolloutConfig": {}, + "createdAt": 1560787022.733, + "lastUpdatedAt": 1560787026.294, + "jobProcessDetails": { + "numberOfCanceledThings": 0, + "numberOfSucceededThings": 0, + "numberOfFailedThings": 0, + "numberOfRejectedThings": 0, + "numberOfQueuedThings": 1, + "numberOfInProgressThings": 0, + "numberOfRemovedThings": 0, + "numberOfTimedOutThings": 0 + }, + "timeoutConfig": {} + } + } + +For more information, see `Creating and Managing Jobs (CLI) `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/update-mitigation-action.rst awscli-1.18.69/awscli/examples/iot/update-mitigation-action.rst --- awscli-1.11.13/awscli/examples/iot/update-mitigation-action.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/update-mitigation-action.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/iot/update-provisioning-template.rst awscli-1.18.69/awscli/examples/iot/update-provisioning-template.rst --- awscli-1.11.13/awscli/examples/iot/update-provisioning-template.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/update-provisioning-template.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,13 @@ +**To update a provisioning template** + +The following ``update-provisioning-template`` example modifies the description and role arn for the specified provisioning template and enables the template. :: + + aws iot update-provisioning-template \ + --template-name widget-template \ + --enabled \ + --description "An updated provisioning template for widgets" \ + --provisioning-role-arn arn:aws:iam::504350838278:role/Provision_role + +This command produces no output. + +For more information, see `AWS IoT Secure Tunneling `__ in the *AWS IoT Core Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/update-role-alias.rst awscli-1.18.69/awscli/examples/iot/update-role-alias.rst --- awscli-1.11.13/awscli/examples/iot/update-role-alias.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/update-role-alias.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,16 @@ +**To update a role alias** + +The following ``update-role-alias`` example updates the ``LightBulbRole`` role alias. :: + + aws iot update-role-alias \ + --role-alias LightBulbRole \ + --role-arn arn:aws:iam::123456789012:role/lightbulbrole-001 + +Output:: + + { + "roleAlias": "LightBulbRole", + "roleAliasArn": "arn:aws:iot:us-west-2:123456789012:rolealias/LightBulbRole" + } + +For more information, see `UpdateRoleAlias `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/update-scheduled-audit.rst awscli-1.18.69/awscli/examples/iot/update-scheduled-audit.rst --- awscli-1.11.13/awscli/examples/iot/update-scheduled-audit.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/update-scheduled-audit.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,15 @@ +**To update a scheduled audit definition** + +The following ``update-scheduled-audit`` example changes the target check names for an AWS IoT Device Defender scheduled audit. :: + + aws iot update-scheduled-audit \ + --scheduled-audit-name WednesdayCertCheck \ + --target-check-names CA_CERTIFICATE_EXPIRING_CHECK DEVICE_CERTIFICATE_EXPIRING_CHECK REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK + +Output:: + + { + "scheduledAuditArn": "arn:aws:iot:us-west-2:123456789012:scheduledaudit/WednesdayCertCheck" + } + +For more information, see `Audit Commands `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/update-security-profile.rst awscli-1.18.69/awscli/examples/iot/update-security-profile.rst --- awscli-1.11.13/awscli/examples/iot/update-security-profile.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/update-security-profile.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,48 @@ +**To change a security profile** + +The following ``update-security-profile`` example updates both the description and the behaviors for an AWS IoT Device Defender security profile. :: + + aws iot update-security-profile \ + --security-profile-name PossibleIssue \ + --security-profile-description "Check to see if authorization fails 12 times in 5 minutes or if cellular bandwidth exceeds 128" \ + --behaviors "[{\"name\":\"CellularBandwidth\",\"metric\":\"aws:message-byte-size\",\"criteria\":{\"comparisonOperator\":\"greater-than\",\"value\":{\"count\":128},\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}},{\"name\":\"Authorization\",\"metric\":\"aws:num-authorization-failures\",\"criteria\":{\"comparisonOperator\":\"less-than\",\"value\":{\"count\":12},\"durationSeconds\":300,\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}}]" + +Output:: + + { + "securityProfileName": "PossibleIssue", + "securityProfileArn": "arn:aws:iot:us-west-2:123456789012:securityprofile/PossibleIssue", + "securityProfileDescription": "check to see if authorization fails 12 times in 5 minutes or if cellular bandwidth exceeds 128", + "behaviors": [ + { + "name": "CellularBandwidth", + "metric": "aws:message-byte-size", + "criteria": { + "comparisonOperator": "greater-than", + "value": { + "count": 128 + }, + "consecutiveDatapointsToAlarm": 1, + "consecutiveDatapointsToClear": 1 + } + }, + { + "name": "Authorization", + "metric": "aws:num-authorization-failures", + "criteria": { + "comparisonOperator": "less-than", + "value": { + "count": 12 + }, + "durationSeconds": 300, + "consecutiveDatapointsToAlarm": 1, + "consecutiveDatapointsToClear": 1 + } + } + ], + "version": 2, + "creationDate": 1560278102.528, + "lastModifiedDate": 1560352711.207 + } + +For more information, see `Detect Commands `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/update-stream.rst awscli-1.18.69/awscli/examples/iot/update-stream.rst --- awscli-1.11.13/awscli/examples/iot/update-stream.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/update-stream.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,34 @@ +**To update a stream** + +The following ``update-stream`` example updates an existing stream. The stream version is incremented by one. :: + + aws iot update-stream \ + --cli-input-json file://update-stream.json + +Contents of ``update-stream.json``:: + + { + "streamId": "stream12345", + "description": "This stream is used for Amazon FreeRTOS OTA Update 12345.", + "files": [ + { + "fileId": 123, + "s3Location": { + "bucket":"codesign-ota-bucket", + "key":"48c67f3c-63bb-4f92-a98a-4ee0fbc2bef6" + } + } + ] + "roleArn": "arn:aws:iam:us-west-2:123456789012:role/service-role/my_ota_stream_role" + } + +Output:: + + { + "streamId": "stream12345", + "streamArn": "arn:aws:iot:us-west-2:123456789012:stream/stream12345", + "description": "This stream is used for Amazon FreeRTOS OTA Update 12345.", + "streamVersion": 2 + } + +For more information, see `UpdateStream `__ in the *AWS IoT API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot/update-thing-group.rst awscli-1.18.69/awscli/examples/iot/update-thing-group.rst --- awscli-1.11.13/awscli/examples/iot/update-thing-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/update-thing-group.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,16 @@ +**To update the definition for a thing group** + +The following ``update-thing-group`` example updates the definition for the specified thing group, changing the description and two attributes. :: + + aws iot update-thing-group \ + --thing-group-name HalogenBulbs \ + --thing-group-properties "thingGroupDescription=\"Halogen bulb group\", attributePayload={attributes={Manufacturer=AnyCompany,wattage=60}}" + +Output:: + + { + "version": 2 + } + +For more information, see `Thing Groups `__ in the *AWS IoT Developers Guide*. + diff -Nru awscli-1.11.13/awscli/examples/iot/update-thing-groups-for-thing.rst awscli-1.18.69/awscli/examples/iot/update-thing-groups-for-thing.rst --- awscli-1.11.13/awscli/examples/iot/update-thing-groups-for-thing.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/update-thing-groups-for-thing.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,12 @@ +**To change the groups to which a thing belongs** + +The following ``update-thing-groups-for-thing`` example removes the thing named ``MyLightBulb`` from the group named ``DeadBulbs`` and adds it to the group named ``replaceableItems`` at the same time. :: + + aws iot update-thing-groups-for-thing \ + --thing-name MyLightBulb \ + --thing-groups-to-add "replaceableItems" \ + --thing-groups-to-remove "DeadBulbs" + +This command produces no output. + +For more information, see `Thing Groups `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/update-thing.rst awscli-1.18.69/awscli/examples/iot/update-thing.rst --- awscli-1.11.13/awscli/examples/iot/update-thing.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/update-thing.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,12 @@ +**To associate a thing with a thing type** + +The following ``update-thing`` example associates a thing in the AWS IoT registry with a thing type. When you make the association, you provide values for the attributes defined by the thing type. :: + + aws iot update-thing \ + --thing-name "MyOtherLightBulb" \ + --thing-type-name "LightBulb" \ + --attribute-payload "{"attributes": {"wattage":"75", "model":"123"}}" + +This command does not produce output. Use the ``describe-thing`` command to see the result. + +For more information, see `Thing Types `__ in the *AWS IoT Developers Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot/validate-security-profile-behaviors.rst awscli-1.18.69/awscli/examples/iot/validate-security-profile-behaviors.rst --- awscli-1.11.13/awscli/examples/iot/validate-security-profile-behaviors.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot/validate-security-profile-behaviors.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,33 @@ +**Example 1: To validate the behaviors parameters for a security profile** + +The following ``validate-security-profile-behaviors`` example validates a well-formed and correct set of behaviors for an AWS IoT Device Defender security profile. :: + + aws iot validate-security-profile-behaviors \ + --behaviors "[{\"name\":\"CellularBandwidth\",\"metric\":\"aws:message-byte-size\",\"criteria\":{\"comparisonOperator\":\"greater-than\",\"value\":{\"count\":128},\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}},{\"name\":\"Authorization\",\"metric\":\"aws:num-authorization-failures\",\"criteria\":{\"comparisonOperator\":\"greater-than\",\"value\":{\"count\":12},\"durationSeconds\":300,\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}}]" + +Output:: + + { + "valid": true, + "validationErrors": [] + } + +**Example 2: To validate incorrect behaviors parameters for a security profile** + +The following ``validate-security-profile-behaviors`` example validates a set of behaviors that contains an error for an AWS IoT Device Defender security profile. :: + + aws iot validate-security-profile-behaviors \ + --behaviors "[{\"name\":\"CellularBandwidth\",\"metric\":\"aws:message-byte-size\",\"criteria\":{\"comparisonOperator\":\"greater-than\",\"value\":{\"count\":128},\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}},{\"name\":\"Authorization\",\"metric\":\"aws:num-authorization-failures\",\"criteria\":{\"comparisonOperator\":\"greater-than\",\"value\":{\"count\":12},\"durationSeconds\":300,\"consecutiveDatapointsToAlarm\":100000,\"consecutiveDatapointsToClear\":1}}]" + +Output:: + + { + "valid": false, + "validationErrors": [ + { + "errorMessage": "Behavior Authorization is malformed. consecutiveDatapointsToAlarm 100000 should be in range[1,10]" + } + ] + } + +For more information, see `Detect Commands `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot1click-devices/claim-devices-by-claim-code.rst awscli-1.18.69/awscli/examples/iot1click-devices/claim-devices-by-claim-code.rst --- awscli-1.11.13/awscli/examples/iot1click-devices/claim-devices-by-claim-code.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot1click-devices/claim-devices-by-claim-code.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,15 @@ +**To claim one or more AWS IoT 1-Click devices using a claim code** + +The following ``claim-devices-by-claim-code`` example claims the specified AWS IoT 1-Click device using a claim code (instead of a device ID). :: + + aws iot1click-devices claim-devices-by-claim-code \ + --claim-code C-123EXAMPLE + +Output:: + + { + "Total": 9 + "ClaimCode": "C-123EXAMPLE" + } + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot1click-devices/describe-device.rst awscli-1.18.69/awscli/examples/iot1click-devices/describe-device.rst --- awscli-1.11.13/awscli/examples/iot1click-devices/describe-device.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot1click-devices/describe-device.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,27 @@ +**To describe a device** + +The following ``describe-device`` example describes the specified device. :: + + aws iot1click-devices describe-device \ + --device-id G030PM0123456789 + +Output:: + + { + "DeviceDescription": { + "Arn": "arn:aws:iot1click:us-west-2:012345678901:devices/G030PM0123456789", + "Attributes": { + "projectRegion": "us-west-2", + "projectName": "AnytownDumpsters", + "placementName": "customer217", + "deviceTemplateName": "empty-dumpster-request" + }, + "DeviceId": "G030PM0123456789", + "Enabled": false, + "RemainingLife": 99.9, + "Type": "button", + "Tags": {} + } + } + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot1click-devices/finalize-device-claim.rst awscli-1.18.69/awscli/examples/iot1click-devices/finalize-device-claim.rst --- awscli-1.11.13/awscli/examples/iot1click-devices/finalize-device-claim.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot1click-devices/finalize-device-claim.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,14 @@ +**To finalize a claim request for an AWS IoT 1-Click device using a device ID** + +The following ``finalize-device-claim`` example finalizes a claim request for the specified AWS IoT 1-Click device using a device ID (instead of a claim code). :: + + aws iot1click-devices finalize-device-claim \ + --device-id G030PM0123456789 + +Output:: + + { + "State": "CLAIMED" + } + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot1click-devices/get-device-methods.rst awscli-1.18.69/awscli/examples/iot1click-devices/get-device-methods.rst --- awscli-1.11.13/awscli/examples/iot1click-devices/get-device-methods.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot1click-devices/get-device-methods.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,30 @@ +**To list the available methods for a device** + +The following ``get-device-methods`` example lists the available methods for a device. :: + + aws iot1click-devices get-device-methods \ + --device-id G030PM0123456789 + +Output:: + + { + "DeviceMethods": [ + { + "MethodName": "getDeviceHealthParameters" + }, + { + "MethodName": "setDeviceHealthMonitorCallback" + }, + { + "MethodName": "getDeviceHealthMonitorCallback" + }, + { + "MethodName": "setOnClickCallback" + }, + { + "MethodName": "getOnClickCallback" + } + ] + } + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot1click-devices/initiate-device-claim.rst awscli-1.18.69/awscli/examples/iot1click-devices/initiate-device-claim.rst --- awscli-1.11.13/awscli/examples/iot1click-devices/initiate-device-claim.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot1click-devices/initiate-device-claim.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,14 @@ +**To initiate a claim request for an AWS IoT 1-Click device using a device ID** + +The following ``initiate-device-claim`` example initiates a claim request for the specified AWS IoT 1-Click device using a device ID (instead of a claim code). :: + + aws iot1click-devices initiate-device-claim \ + --device-id G030PM0123456789 + +Output:: + + { + "State": "CLAIM_INITIATED" + } + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot1click-devices/invoke-device-method.rst awscli-1.18.69/awscli/examples/iot1click-devices/invoke-device-method.rst --- awscli-1.11.13/awscli/examples/iot1click-devices/invoke-device-method.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot1click-devices/invoke-device-method.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,24 @@ +**To invoke a device method on a device** + +The following ``invoke-device-method`` example invokes the specified method on a device. :: + + aws iot1click-devices invoke-device-method \ + --cli-input-json file://invoke-device-method.json + +Contents of ``invoke-device-method.json``:: + + { + "DeviceId": "G030PM0123456789", + "DeviceMethod": { + "DeviceType": "device", + "MethodName": "getDeviceHealthParameters" + } + } + +Output:: + + { + "DeviceMethodResponse": "{\"remainingLife\": 99.8}" + } + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot1click-devices/list-device-events.rst awscli-1.18.69/awscli/examples/iot1click-devices/list-device-events.rst --- awscli-1.11.13/awscli/examples/iot1click-devices/list-device-events.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot1click-devices/list-device-events.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,32 @@ +**To list a device's events for a specified time range** + +The following ``list-device-events`` example lists the specified device's events for the specified time range. :: + + aws iot1click-devices list-device-events \ + --device-id G030PM0123456789 \ + --from-time-stamp 2019-07-17T15:45:12.880Z --to-time-stamp 2019-07-19T15:45:12.880Z + +Output:: + + { + "Events": [ + { + "Device": { + "Attributes": {}, + "DeviceId": "G030PM0123456789", + "Type": "button" + }, + "StdEvent": "{\"clickType\": \"SINGLE\", \"reportedTime\": \"2019-07-18T23:47:55.015Z\", \"certificateId\": \"fe8798a6c97c62ef8756b80eeefdcf2280f3352f82faa8080c74cc4f4a4d1811\", \"remainingLife\": 99.85000000000001, \"testMode\": false}" + }, + { + "Device": { + "Attributes": {}, + "DeviceId": "G030PM0123456789", + "Type": "button" + }, + "StdEvent": "{\"clickType\": \"DOUBLE\", \"reportedTime\": \"2019-07-19T00:14:41.353Z\", \"certificateId\": \"fe8798a6c97c62ef8756b80eeefdcf2280f3352f82faa8080c74cc4f4a4d1811\", \"remainingLife\": 99.8, \"testMode\": false}" + } + ] + } + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot1click-devices/list-devices.rst awscli-1.18.69/awscli/examples/iot1click-devices/list-devices.rst --- awscli-1.11.13/awscli/examples/iot1click-devices/list-devices.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot1click-devices/list-devices.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,26 @@ +**To list the devices of a specified type** + +The following ``list-devices`` example lists the devices of a specified type. :: + + aws iot1click-devices list-devices \ + --device-type button + +This command produces no output. + +Output:: + + { + "Devices": [ + { + "remainingLife": 99.9, + "attributes": { + "arn": "arn:aws:iot1click:us-west-2:123456789012:devices/G030PM0123456789", + "type": "button", + "deviceId": "G030PM0123456789", + "enabled": false + } + } + ] + } + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot1click-devices/list-tags-for-resource.rst awscli-1.18.69/awscli/examples/iot1click-devices/list-tags-for-resource.rst --- awscli-1.11.13/awscli/examples/iot1click-devices/list-tags-for-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot1click-devices/list-tags-for-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,17 @@ +**To list the tags for a device** + +The following ``list-tags-for-resource`` example list the tags for the specified device. :: + + aws iot1click-devices list-tags-for-resource \ + --resource-arn "arn:aws:iot1click:us-west-2:012345678901:devices/G030PM0123456789" + +Output:: + + { + "Tags": { + "Driver Phone": "123-555-0199", + "Driver": "Jorge Souza" + } + } + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot1click-devices/tag-resource.rst awscli-1.18.69/awscli/examples/iot1click-devices/tag-resource.rst --- awscli-1.11.13/awscli/examples/iot1click-devices/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot1click-devices/tag-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,20 @@ +**To add tags to a device AWS resource** + +The following ``tag-resource`` example adds two tags to the specified resource. :: + + aws iot1click-devices tag-resource \ + --cli-input-json file://devices-tag-resource.json + +Contents of ``devices-tag-resource.json``:: + + { + "ResourceArn": "arn:aws:iot1click:us-west-2:123456789012:devices/G030PM0123456789", + "Tags": { + "Driver": "Jorge Souza", + "Driver Phone": "123-555-0199" + } + } + +This command produces no output. + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot1click-devices/unclaim-device.rst awscli-1.18.69/awscli/examples/iot1click-devices/unclaim-device.rst --- awscli-1.11.13/awscli/examples/iot1click-devices/unclaim-device.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot1click-devices/unclaim-device.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,14 @@ +**To unclaim (deregister) a device from your AWS account** + +The following ``unclaim-device`` example unclaims (deregisters) the specified device from your AWS account. :: + + aws iot1click-devices unclaim-device \ + --device-id G030PM0123456789 + +Output:: + + { + "State": "UNCLAIMED" + } + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot1click-devices/untag-resource.rst awscli-1.18.69/awscli/examples/iot1click-devices/untag-resource.rst --- awscli-1.11.13/awscli/examples/iot1click-devices/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot1click-devices/untag-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,12 @@ +**To remove tags from a device AWS resource** + +The following ``untag-resource`` example removes the tags with the names ``Driver Phone`` and ``Driver`` from the specified device resource. :: + + aws iot1click-devices untag-resource \ + --resource-arn "arn:aws:iot1click:us-west-2:123456789012:projects/AnytownDumpsters" \ + --tag-keys "Driver Phone" "Driver" + + +This command produces no output. + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot1click-devices/update-device-state.rst awscli-1.18.69/awscli/examples/iot1click-devices/update-device-state.rst --- awscli-1.11.13/awscli/examples/iot1click-devices/update-device-state.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot1click-devices/update-device-state.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To update the ``enabled`` state for a device** + +The following ``update-device-state`` sets the state of the specified device to ``enabled``. :: + + aws iot1click-devices update-device-state \ + --device-id G030PM0123456789 \ + --enabled + +This command produces no output. + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot1click-projects/associate-device-with-placement.rst awscli-1.18.69/awscli/examples/iot1click-projects/associate-device-with-placement.rst --- awscli-1.11.13/awscli/examples/iot1click-projects/associate-device-with-placement.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot1click-projects/associate-device-with-placement.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,13 @@ +**To associate an AWS IoT 1-Click device with an existing placement** + +The following ``associate-device-with-placement`` example associates the specified AWS IoT 1-Click device with an existing placement. :: + + aws iot1click-projects associate-device-with-placement \ + --project-name AnytownDumpsters \ + --placement-name customer217 \ + --device-template-name empty-dumpster-request \ + --device-id G030PM0123456789 + +This command produces no output. + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot1click-projects/create-placement.rst awscli-1.18.69/awscli/examples/iot1click-projects/create-placement.rst --- awscli-1.11.13/awscli/examples/iot1click-projects/create-placement.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot1click-projects/create-placement.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,12 @@ +**To create an AWS IoT 1-Click placement for a project** + +The following ``create-placement`` example create an AWS IoT 1-Click placement for the specified project. :: + + aws iot1click-projects create-placement \ + --project-name AnytownDumpsters \ + --placement-name customer217 \ + --attributes "{"location": "123 Any Street Anytown, USA 10001", "phone": "123-456-7890"}" + +This command produces no output. + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot1click-projects/create-project.rst awscli-1.18.69/awscli/examples/iot1click-projects/create-project.rst --- awscli-1.11.13/awscli/examples/iot1click-projects/create-project.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot1click-projects/create-project.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,27 @@ +**To create an AWS IoT 1-Click project for zero or more placements** + +The following ``create-project`` example creates an AWS IoT 1-Click project for a placement. + + aws iot1click-projects create-project \ + --cli-input-json file://create-project.json + +Contents of ``create-project.json``:: + + { + "projectName": "AnytownDumpsters", + "description": "All dumpsters in the Anytown region.", + "placementTemplate": { + "defaultAttributes": { + "City" : "Anytown" + }, + "deviceTemplates": { + "empty-dumpster-request" : { + "deviceType": "button" + } + } + } + } + +This command produces no output. + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot1click-projects/delete-placement.rst awscli-1.18.69/awscli/examples/iot1click-projects/delete-placement.rst --- awscli-1.11.13/awscli/examples/iot1click-projects/delete-placement.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot1click-projects/delete-placement.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To delete a placement from a project** + +The following ``delete-placement`` example deletes the specified placement from a project. :: + + aws iot1click-projects delete-placement \ + --project-name AnytownDumpsters \ + --placement-name customer217 + +This command produces no output. + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot1click-projects/delete-project.rst awscli-1.18.69/awscli/examples/iot1click-projects/delete-project.rst --- awscli-1.11.13/awscli/examples/iot1click-projects/delete-project.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot1click-projects/delete-project.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a project from your AWS account** + +The following ``delete-project`` example deletes the specified project from your AWS account. :: + + aws iot1click-projects delete-project \ + --project-name AnytownDumpsters + +This command produces no output. + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot1click-projects/describe-placement.rst awscli-1.18.69/awscli/examples/iot1click-projects/describe-placement.rst --- awscli-1.11.13/awscli/examples/iot1click-projects/describe-placement.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot1click-projects/describe-placement.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,24 @@ +**To describe a placement for a project** + +The following ``describe-placement`` example describes a placement for the specified project. :: + + aws iot1click-projects describe-placement \ + --project-name AnytownDumpsters \ + --placement-name customer217 + +Output:: + + { + "placement": { + "projectName": "AnytownDumpsters", + "placementName": "customer217", + "attributes": { + "phone": "123-555-0110", + "location": "123 Any Street Anytown, USA 10001" + }, + "createdDate": 1563488454, + "updatedDate": 1563488454 + } + } + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot1click-projects/describe-project.rst awscli-1.18.69/awscli/examples/iot1click-projects/describe-project.rst --- awscli-1.11.13/awscli/examples/iot1click-projects/describe-project.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot1click-projects/describe-project.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,32 @@ +**To describe an AWS IoT 1-Click project** + +The following ``describe-project`` example describes the specified AWS IoT 1-Click project. :: + + aws iot1click-projects describe-project \ + --project-name AnytownDumpsters + +Output:: + + { + "project": { + "arn": "arn:aws:iot1click:us-west-2:012345678901:projects/AnytownDumpsters", + "projectName": "AnytownDumpsters", + "description": "All dumpsters in the Anytown region.", + "createdDate": 1563483100, + "updatedDate": 1563483100, + "placementTemplate": { + "defaultAttributes": { + "City": "Anytown" + }, + "deviceTemplates": { + "empty-dumpster-request": { + "deviceType": "button", + "callbackOverrides": {} + } + } + }, + "tags": {} + } + } + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot1click-projects/disassociate-device-from-placement.rst awscli-1.18.69/awscli/examples/iot1click-projects/disassociate-device-from-placement.rst --- awscli-1.11.13/awscli/examples/iot1click-projects/disassociate-device-from-placement.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot1click-projects/disassociate-device-from-placement.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,12 @@ +**To disassociate a device from a placement** + +The following ``disassociate-device-from-placement`` example disassociates the specified device from a placement. :: + + aws iot1click-projects disassociate-device-from-placement \ + --project-name AnytownDumpsters \ + --placement-name customer217 \ + --device-template-name empty-dumpster-request + +This command produces no output. + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot1click-projects/get-devices-in-placement.rst awscli-1.18.69/awscli/examples/iot1click-projects/get-devices-in-placement.rst --- awscli-1.11.13/awscli/examples/iot1click-projects/get-devices-in-placement.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot1click-projects/get-devices-in-placement.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,17 @@ +**To list all devices in a placement contained in a project** + +The following ``get-devices-in-placement`` example lists all devices in a the specified placement contained in the specified project. :: + + aws iot1click-projects get-devices-in-placement \ + --project-name AnytownDumpsters \ + --placement-name customer217 + +Output:: + + { + "devices": { + "empty-dumpster-request": "G030PM0123456789" + } + } + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot1click-projects/list-placements.rst awscli-1.18.69/awscli/examples/iot1click-projects/list-placements.rst --- awscli-1.11.13/awscli/examples/iot1click-projects/list-placements.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot1click-projects/list-placements.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,21 @@ +**To list all AWS IoT 1-Click placements for a project** + +The following ``list-placements`` example lists all AWS IoT 1-Click placements for the specified project. :: + + aws iot1click-projects list-placements \ + --project-name AnytownDumpsters + +Output:: + + { + "placements": [ + { + "projectName": "AnytownDumpsters", + "placementName": "customer217", + "createdDate": 1563488454, + "updatedDate": 1563488454 + } + ] + } + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot1click-projects/list-projects.rst awscli-1.18.69/awscli/examples/iot1click-projects/list-projects.rst --- awscli-1.11.13/awscli/examples/iot1click-projects/list-projects.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot1click-projects/list-projects.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,21 @@ +**To list all AWS IoT 1-Click projects** + +The following ``list-projects`` example list all AWS IoT 1-Click projects in your account. :: + + aws iot1click-projects list-projects + +Output:: + + { + "projects": [ + { + "arn": "arn:aws:iot1click:us-west-2:012345678901:projects/AnytownDumpsters", + "projectName": "AnytownDumpsters", + "createdDate": 1563483100, + "updatedDate": 1563483100, + "tags": {} + } + ] + } + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot1click-projects/list-tags-for-resource.rst awscli-1.18.69/awscli/examples/iot1click-projects/list-tags-for-resource.rst --- awscli-1.11.13/awscli/examples/iot1click-projects/list-tags-for-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot1click-projects/list-tags-for-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,17 @@ +**To list the tags for a project resource** + +The following ``list-tags-for-resource`` example list the tags for the specified project resource. :: + + aws iot1click-projects list-tags-for-resource \ + --resource-arn "arn:aws:iot1click:us-west-2:123456789012:projects/AnytownDumpsters" + +Output:: + + { + "tags": { + "Manager": "Li Juan", + "Account": "45215" + } + } + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot1click-projects/tag-resource.rst awscli-1.18.69/awscli/examples/iot1click-projects/tag-resource.rst --- awscli-1.11.13/awscli/examples/iot1click-projects/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot1click-projects/tag-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,20 @@ +**To add tags to a project resource** + +The following ``tag-resource`` example adds two tags to the specified project resource. :: + + aws iot1click-projects tag-resource \ + --cli-input-json file://devices-tag-resource.json + +Contents of ``devices-tag-resource.json``:: + + { + "resourceArn": "arn:aws:iot1click:us-west-2:123456789012:projects/AnytownDumpsters", + "tags": { + "Account": "45215", + "Manager": "Li Juan" + } + } + +This command produces no output. + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot1click-projects/untag-resource.rst awscli-1.18.69/awscli/examples/iot1click-projects/untag-resource.rst --- awscli-1.11.13/awscli/examples/iot1click-projects/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot1click-projects/untag-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To remove tags from a project resource** + +The following ``untag-resource`` example removes the tag with the key name ``Manager`` from the specified project. :: + + aws iot1click-projects untag-resource \ + --resource-arn "arn:aws:iot1click:us-west-2:123456789012:projects/AnytownDumpsters" \ + --tag-keys "Manager" + +This command produces no output. + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot1click-projects/update-placement.rst awscli-1.18.69/awscli/examples/iot1click-projects/update-placement.rst --- awscli-1.11.13/awscli/examples/iot1click-projects/update-placement.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot1click-projects/update-placement.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,21 @@ +**To update the "attributes" key-value pairs of a placement** + +The following ``update-placement`` example update the "attributes" key-value pairs of a placement. :: + + aws iot1click-projects update-placement \ + --cli-input-json file://update-placement.json + +Contents of ``update-placement.json``:: + + { + "projectName": "AnytownDumpsters", + "placementName": "customer217", + "attributes": { + "phone": "123-456-7890", + "location": "123 Any Street Anytown, USA 10001" + } + } + +This command produces no output. + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot1click-projects/update-project.rst awscli-1.18.69/awscli/examples/iot1click-projects/update-project.rst --- awscli-1.11.13/awscli/examples/iot1click-projects/update-project.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot1click-projects/update-project.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To update settings for a project** + +The following ``update-project`` example updates the description for a project. :: + + aws iot1click-projects update-project \ + --project-name AnytownDumpsters \ + --description "All dumpsters (yard waste, recycling, garbage) in the Anytown region." + +This command produces no output. + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotanalytics/batch-put-message.rst awscli-1.18.69/awscli/examples/iotanalytics/batch-put-message.rst --- awscli-1.11.13/awscli/examples/iotanalytics/batch-put-message.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotanalytics/batch-put-message.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,26 @@ +**To send a message to a channel** + +The following ``batch-put-message`` example sends a message to the specified channel. :: + + aws iotanalytics batch-put-message \ + --cli-input-json file://batch-put-message.json + +Contents of ``batch-put-message.json``:: + + { + "channelName": "mychannel", + "messages": [ + { + "messageId": "0001", + "payload": "eyAidGVtcGVyYXR1cmUiOiAyMCB9" + } + ] + } + +Output:: + + { + "batchPutMessageErrorEntries": [] + } + +For more information, see `BatchPutMessage `__ in the *AWS IoT Analytics API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotanalytics/cancel-pipeline-reprocessing.rst awscli-1.18.69/awscli/examples/iotanalytics/cancel-pipeline-reprocessing.rst --- awscli-1.11.13/awscli/examples/iotanalytics/cancel-pipeline-reprocessing.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotanalytics/cancel-pipeline-reprocessing.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To cancel the reprocessing of data through a pipeline** + +The following ``cancel-pipeline-reprocessing`` example cancels the reprocessing of data through the specified pipeline. :: + + aws iotanalytics cancel-pipeline-reprocessing \ + --pipeline-name mypipeline \ + --reprocessing-id "6ad2764f-fb13-4de3-b101-4e74af03b043" + +This command produces no output. + +For more information, see `CancelPipelineReprocessing `__ in the *AWS IoT Analytics API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotanalytics/create-channel.rst awscli-1.18.69/awscli/examples/iotanalytics/create-channel.rst --- awscli-1.11.13/awscli/examples/iotanalytics/create-channel.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotanalytics/create-channel.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,33 @@ +**To create a channel** + +The following ``create-channel`` example creates a channel with the specified configuration. A channel collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline. :: + + aws iotanalytics create-channel \ + --cli-input-json file://create-channel.json + +Contents of ``create-channel.json``:: + + { + "channelName": "mychannel", + "retentionPeriod": { + "unlimited": true + }, + "tags": [ + { + "key": "Environment", + "value": "Production" + } + ] + } + +Output:: + + { + "channelArn": "arn:aws:iotanalytics:us-west-2:123456789012:channel/mychannel", + "channelName": "mychannel", + "retentionPeriod": { + "unlimited": true + } + } + +For more information, see `CreateChannel `__ in the *AWS IoT Analytics API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotanalytics/create-dataset-content.rst awscli-1.18.69/awscli/examples/iotanalytics/create-dataset-content.rst --- awscli-1.11.13/awscli/examples/iotanalytics/create-dataset-content.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotanalytics/create-dataset-content.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,14 @@ +**To create the content of a dataset** + +The following ``create-dataset-content`` example creates the content of the specified dataset by applying a ``queryAction`` (an SQL query) or a ``containerAction`` (executing a containerized application). :: + + aws iotanalytics create-dataset-content \ + --dataset-name mydataset + +Output:: + + { + "versionId": "d494b416-9850-4670-b885-ca22f1e89d62" + } + +For more information, see `CreateDatasetContent `__ in the *AWS IoT Analytics API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotanalytics/create-dataset.rst awscli-1.18.69/awscli/examples/iotanalytics/create-dataset.rst --- awscli-1.11.13/awscli/examples/iotanalytics/create-dataset.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotanalytics/create-dataset.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,41 @@ +**To create a dataset** + +The following ``create-dataset`` example creates a dataset. A dataset stores data retrieved from a data store by applying a ``queryAction`` (a SQL query) or a ``containerAction`` (executing a containerized application). This operation creates the skeleton of a dataset. You can populate the dataset manually by calling ``CreateDatasetContent`` or automatically according to a ``trigger`` you specify. :: + + aws iotanalytics create-dataset \ + --cli-input-json file://create-dataset.json + +Contents of ``create-dataset.json``:: + + { + "datasetName": "mydataset", + "actions": [ + { + "actionName": "myDatasetAction", + "queryAction": { + "sqlQuery": "SELECT * FROM mydatastore" + } + } + ], + "retentionPeriod": { + "unlimited": true + }, + "tags": [ + { + "key": "Environment", + "value": "Production" + } + ] + } + +Output:: + + { + "datasetName": "mydataset", + "retentionPeriod": { + "unlimited": true + }, + "datasetArn": "arn:aws:iotanalytics:us-west-2:123456789012:dataset/mydataset" + } + +For more information, see `CreateDataset `__ in the *AWS IoT Analytics API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotanalytics/create-datastore.rst awscli-1.18.69/awscli/examples/iotanalytics/create-datastore.rst --- awscli-1.11.13/awscli/examples/iotanalytics/create-datastore.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotanalytics/create-datastore.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,34 @@ +**To create a data store** + +The following ``create-datastore`` example creates a data store, which is a repository for messages. :: + + aws iotanalytics create-datastore \ + --cli-input-json file://create-datastore.json + +Contents of ``create-datastore.json``:: + + { + "datastoreName": "mydatastore", + "retentionPeriod": { + "numberOfDays": 90 + }, + "tags": [ + { + "key": "Environment", + "value": "Production" + } + ] + } + +Output:: + + { + "datastoreName": "mydatastore", + "datastoreArn": "arn:aws:iotanalytics:us-west-2:123456789012:datastore/mydatastore", + "retentionPeriod": { + "numberOfDays": 90, + "unlimited": false + } + } + +For more information, see `CreateDatastore `__ in the *AWS IoT Analytics API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotanalytics/create-pipeline.rst awscli-1.18.69/awscli/examples/iotanalytics/create-pipeline.rst --- awscli-1.11.13/awscli/examples/iotanalytics/create-pipeline.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotanalytics/create-pipeline.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,50 @@ +**Create an IoT Analytics Pipeline** + +The following ``create-pipeline`` example creates a pipeline. A pipeline consumes messages from a channel and allows you to process the messages before storing them in a data store. You must specify both a channel and a data store activity and, optionally, as many as 23 additional activities in the ``pipelineActivities`` array. :: + + aws iotanalytics create-pipeline \ + --cli-input-json file://create-pipeline.json + +Contents of ``create-pipeline.json``:: + + { + "pipelineName": "mypipeline", + "pipelineActivities": [ + { + "channel": { + "name": "myChannelActivity", + "channelName": "mychannel", + "next": "myMathActivity" + } + }, + { + "datastore": { + "name": "myDatastoreActivity", + "datastoreName": "mydatastore" + } + }, + { + "math": { + "name": "myMathActivity", + "math": "((temp - 32) * 5.0) / 9.0", + "attribute": "tempC", + "next": "myDatastoreActivity" + } + } + ], + "tags": [ + { + "key": "Environment", + "value": "Beta" + } + ] + } + +Output:: + + { + "pipelineArn": "arn:aws:iotanalytics:us-west-2:123456789012:pipeline/mypipeline", + "pipelineName": "mypipeline" + } + +For more information, see `CreatePipeline `__ in the *AWS IoT Analytics API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotanalytics/delete-channel.rst awscli-1.18.69/awscli/examples/iotanalytics/delete-channel.rst --- awscli-1.11.13/awscli/examples/iotanalytics/delete-channel.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotanalytics/delete-channel.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,10 @@ +**Delete an IoT Analytics Channel** + +The following ``delete-channel`` example deletes the specified channel. :: + + aws iotanalytics delete-channel \ + --channel-name mychannel + +This command produces no output. + +For more information, see `DeleteChannel `__ in the *AWS IoT Analytics API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotanalytics/delete-dataset-content.rst awscli-1.18.69/awscli/examples/iotanalytics/delete-dataset-content.rst --- awscli-1.11.13/awscli/examples/iotanalytics/delete-dataset-content.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotanalytics/delete-dataset-content.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete dataset content** + +The following ``delete-dataset-content`` example deletes the content of the specified dataset. :: + + aws iotanalytics delete-dataset-content \ + --dataset-name mydataset + +This command produces no output. + +For more information, see `DeleteDatasetContent `__ in the *AWS IoT Analytics API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotanalytics/delete-dataset.rst awscli-1.18.69/awscli/examples/iotanalytics/delete-dataset.rst --- awscli-1.11.13/awscli/examples/iotanalytics/delete-dataset.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotanalytics/delete-dataset.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a dataset** + +The following ``delete-dataset`` example deletes the specified dataset. You don't have to delete the content of the dataset before you perform this operation. :: + + aws iotanalytics delete-dataset \ + --dataset-name mydataset + +This command produces no output. + +For more information, see `DeleteDataset `__ in the *AWS IoT Analytics API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotanalytics/delete-datastore.rst awscli-1.18.69/awscli/examples/iotanalytics/delete-datastore.rst --- awscli-1.11.13/awscli/examples/iotanalytics/delete-datastore.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotanalytics/delete-datastore.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To delete a data store** + +The following ``delete-datastore`` example deletes the specified data store. :: + + aws iotanalytics delete-datastore \ + --datastore-name mydatastore + + +This command produces no output. + +For more information, see `DeleteDatastore `__ in the *AWS IoT Analytics API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotanalytics/delete-pipeline.rst awscli-1.18.69/awscli/examples/iotanalytics/delete-pipeline.rst --- awscli-1.11.13/awscli/examples/iotanalytics/delete-pipeline.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotanalytics/delete-pipeline.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a pipeline** + +The following ``delete-pipeline`` example deletes the specified pipeline. :: + + aws iotanalytics delete-pipeline \ + --pipeline-name mypipeline + +This command produces no output. + +For more information, see `DeletePipeline `__ in the *AWS IoT Analytics API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotanalytics/describe-channel.rst awscli-1.18.69/awscli/examples/iotanalytics/describe-channel.rst --- awscli-1.11.13/awscli/examples/iotanalytics/describe-channel.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotanalytics/describe-channel.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,30 @@ +**To retrieve information about a channel** + +The following ``describe-channel`` example displays details, including statistics, for the specified channel. :: + + aws iotanalytics describe-channel \ + --channel-name mychannel \ + --include-statistics + +Output:: + + { + "statistics": { + "size": { + "estimatedSizeInBytes": 402.0, + "estimatedOn": 1561504380.0 + } + }, + "channel": { + "status": "ACTIVE", + "name": "mychannel", + "lastUpdateTime": 1557860351.001, + "creationTime": 1557860351.001, + "retentionPeriod": { + "unlimited": true + }, + "arn": "arn:aws:iotanalytics:us-west-2:123456789012:channel/mychannel" + } + } + +For more information, see `DescribeChannel `__ in the *AWS IoT Analytics API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotanalytics/describe-dataset.rst awscli-1.18.69/awscli/examples/iotanalytics/describe-dataset.rst --- awscli-1.11.13/awscli/examples/iotanalytics/describe-dataset.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotanalytics/describe-dataset.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,35 @@ +**To retrieve information about a dataset** + +The following ``describe-dataset`` example displays details for the specified dataset. :: + + aws iotanalytics describe-dataset \ + --dataset-name mydataset + +Output:: + + { + "dataset": { + "status": "ACTIVE", + "contentDeliveryRules": [], + "name": "mydataset", + "lastUpdateTime": 1557859240.658, + "triggers": [], + "creationTime": 1557859240.658, + "actions": [ + { + "actionName": "query_32", + "queryAction": { + "sqlQuery": "SELECT * FROM mydatastore", + "filters": [] + } + } + ], + "retentionPeriod": { + "numberOfDays": 90, + "unlimited": false + }, + "arn": "arn:aws:iotanalytics:us-west-2:123456789012:dataset/mydataset" + } + } + +For more information, see `DescribeDataset `__ in the *AWS IoT Analytics API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotanalytics/describe-datastore.rst awscli-1.18.69/awscli/examples/iotanalytics/describe-datastore.rst --- awscli-1.11.13/awscli/examples/iotanalytics/describe-datastore.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotanalytics/describe-datastore.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,30 @@ +**To retrieve information about a data store** + +The following ``describe-datastore`` example displays details, including statistics, for the specified data store. :: + + aws iotanalytics describe-datastore \ + --datastore-name mydatastore \ + --include-statistics + +Output:: + + { + "datastore": { + "status": "ACTIVE", + "name": "mydatastore", + "lastUpdateTime": 1557858971.02, + "creationTime": 1557858971.02, + "retentionPeriod": { + "unlimited": true + }, + "arn": "arn:aws:iotanalytics:us-west-2:123456789012:datastore/mydatastore" + }, + "statistics": { + "size": { + "estimatedSizeInBytes": 397.0, + "estimatedOn": 1561592040.0 + } + } + } + +For more information, see `DescribeDatastore `__ in the *AWS IoT Analytics API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotanalytics/describe-logging-options.rst awscli-1.18.69/awscli/examples/iotanalytics/describe-logging-options.rst --- awscli-1.11.13/awscli/examples/iotanalytics/describe-logging-options.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotanalytics/describe-logging-options.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,18 @@ +**To retrieve the current logging options** + +The following ``describe-logging-options`` example displays the current AWS IoT Analytics logging options. :: + + aws iotanalytics describe-logging-options + +This command produces no output. +Output:: + + { + "loggingOptions": { + "roleArn": "arn:aws:iam::123456789012:role/service-role/myIoTAnalyticsRole", + "enabled": true, + "level": "ERROR" + } + } + +For more information, see `DescribeLoggingOptions `__ in the *AWS IoT Analytics API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotanalytics/describe-pipeline.rst awscli-1.18.69/awscli/examples/iotanalytics/describe-pipeline.rst --- awscli-1.11.13/awscli/examples/iotanalytics/describe-pipeline.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotanalytics/describe-pipeline.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,41 @@ +**To retrieve information about a pipeline** + +The following ``describe-pipeline`` example displays details for the specified pipeline. :: + + aws iotanalytics describe-pipeline \ + --pipeline-name mypipeline + +Output:: + + { + "pipeline": { + "activities": [ + { + "channel": { + "channelName": "mychannel", + "name": "mychannel_28", + "next": "mydatastore_29" + } + }, + { + "datastore": { + "datastoreName": "mydatastore", + "name": "mydatastore_29" + } + } + ], + "name": "mypipeline", + "lastUpdateTime": 1561676362.515, + "creationTime": 1557859124.432, + "reprocessingSummaries": [ + { + "status": "SUCCEEDED", + "creationTime": 1561676362.189, + "id": "6ad2764f-fb13-4de3-b101-4e74af03b043" + } + ], + "arn": "arn:aws:iotanalytics:us-west-2:123456789012:pipeline/mypipeline" + } + } + +For more information, see `DescribePipeline `__ in the *AWS IoT Analytics API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotanalytics/get-dataset-content.rst awscli-1.18.69/awscli/examples/iotanalytics/get-dataset-content.rst --- awscli-1.11.13/awscli/examples/iotanalytics/get-dataset-content.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotanalytics/get-dataset-content.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,21 @@ +**To retrieve the contents of a dataset** + +The following ``get-dataset-content`` example retrieves the contents of a dataset as presigned URIs. :: + + aws iotanalytics get-dataset-content --dataset-name mydataset + +Output:: + + { + "status": { + "state": "SUCCEEDED" + }, + "timestamp": 1557863215.995, + "entries": [ + { + "dataURI": "https://aws-radiant-dataset-12345678-1234-1234-1234-123456789012.s3.us-west-2.amazonaws.com/results/12345678-e8b3-46ba-b2dd-efe8d86cf385.csv?X-Amz-Security-Token=...-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20190628T173437Z&X-Amz-SignedHeaders=host&X-Amz-Expires=7200&X-Amz-Credential=...F20190628%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=..." + } + ] + } + +For more information, see `GetDatasetContent `__ in the *guide*. diff -Nru awscli-1.11.13/awscli/examples/iotanalytics/list-channels.rst awscli-1.18.69/awscli/examples/iotanalytics/list-channels.rst --- awscli-1.11.13/awscli/examples/iotanalytics/list-channels.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotanalytics/list-channels.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,20 @@ +**To retrieve a list of channels** + +The following ``list-channels`` example displays summary information for the available channels. :: + + aws iotanalytics list-channels + +Output:: + + { + "channelSummaries": [ + { + "status": "ACTIVE", + "channelName": "mychannel", + "creationTime": 1557860351.001, + "lastUpdateTime": 1557860351.001 + } + ] + } + +For more information, see `ListChannels `__ in the *AWS IoT Analytics API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotanalytics/list-dataset-contents.rst awscli-1.18.69/awscli/examples/iotanalytics/list-dataset-contents.rst --- awscli-1.11.13/awscli/examples/iotanalytics/list-dataset-contents.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotanalytics/list-dataset-contents.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,23 @@ +**To list information about dataset contents** + +The following ``list-dataset-contents`` example lists information about dataset contents that have been created. :: + + aws iotanalytics list-dataset-contents \ + --dataset-name mydataset + +Output:: + + { + "datasetContentSummaries": [ + { + "status": { + "state": "SUCCEEDED" + }, + "scheduleTime": 1557863215.995, + "version": "b10ea2a9-66c1-4d99-8d1f-518113b738d0", + "creationTime": 1557863215.995 + } + ] + } + +For more information, see `ListDatasetContents `__ in the *AWS IoT Analytics API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotanalytics/list-datasets.rst awscli-1.18.69/awscli/examples/iotanalytics/list-datasets.rst --- awscli-1.11.13/awscli/examples/iotanalytics/list-datasets.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotanalytics/list-datasets.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,27 @@ +**To retrieve information about datasets** + +The following ``list-datasets`` example lists summary information about available datasets. :: + + aws iotanalytics list-datasets + +Output:: + + { + "datasetSummaries": [ + { + "status": "ACTIVE", + "datasetName": "mydataset", + "lastUpdateTime": 1557859240.658, + "triggers": [], + "creationTime": 1557859240.658, + "actions": [ + { + "actionName": "query_32", + "actionType": "QUERY" + } + ] + } + ] + } + +For more information, see `ListDatasets `__ in the *AWS IoT Analytics API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotanalytics/list-datastores.rst awscli-1.18.69/awscli/examples/iotanalytics/list-datastores.rst --- awscli-1.11.13/awscli/examples/iotanalytics/list-datastores.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotanalytics/list-datastores.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,20 @@ +**To retrieve a list of data stores** + +The following ``list-datastores`` example displays summary information about the available data stores. :: + + aws iotanalytics list-datastores + +Output:: + + { + "datastoreSummaries": [ + { + "status": "ACTIVE", + "datastoreName": "mydatastore", + "creationTime": 1557858971.02, + "lastUpdateTime": 1557858971.02 + } + ] + } + +For more information, see `ListDatastores `__ in the *AWS IoT Analytics API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotanalytics/list-pipelines.rst awscli-1.18.69/awscli/examples/iotanalytics/list-pipelines.rst --- awscli-1.11.13/awscli/examples/iotanalytics/list-pipelines.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotanalytics/list-pipelines.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,20 @@ +**To retrieve a list of pipelines** + +The following ``list-pipelines`` example displays a list of available pipelines. :: + + aws iotanalytics list-pipelines + +Output:: + + { + "pipelineSummaries": [ + { + "pipelineName": "mypipeline", + "creationTime": 1557859124.432, + "lastUpdateTime": 1557859124.432, + "reprocessingSummaries": [] + } + ] + } + +For more information, see `ListPipelines `__ in the *AWS IoT Analytics API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotanalytics/list-tags-for-resource.rst awscli-1.18.69/awscli/examples/iotanalytics/list-tags-for-resource.rst --- awscli-1.11.13/awscli/examples/iotanalytics/list-tags-for-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotanalytics/list-tags-for-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,19 @@ +**To list tags for a resource** + +The following ``list-tags-for-resource`` example Lists the tags that you have attached to the specified resource. :: + + aws iotanalytics list-tags-for-resource \ + --resource-arn "arn:aws:iotanalytics:us-west-2:123456789012:channel/mychannel" + +Output:: + + { + "tags": [ + { + "value": "bar", + "key": "foo" + } + ] + } + +For more information, see `ListTagsForResource `__ in the *AWS IoT Analytics API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotanalytics/put-logging-options.rst awscli-1.18.69/awscli/examples/iotanalytics/put-logging-options.rst --- awscli-1.11.13/awscli/examples/iotanalytics/put-logging-options.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotanalytics/put-logging-options.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,20 @@ +**To set or update logging options** + +The following ``put-logging-options`` example sets or updates the AWS IoT Analytics logging options. If you update the value of any ``loggingOptions`` field, it can take up to one minute for the change to take effect. Also, if you change the policy attached to the role you specified in the "roleArn" field (for example, to correct an invalid policy) it can take up to five minutes for that change to take effect. :: + + aws iotanalytics put-logging-options \ + --cli-input-json file://put-logging-options.json + +Contents of ``put-logging-options.json``:: + + { + "loggingOptions": { + "roleArn": "arn:aws:iam::123456789012:role/service-role/myIoTAnalyticsRole", + "level": "ERROR", + "enabled": true + } + } + +This command produces no output. + +For more information, see `PutLoggingOptions `__ in the *AWS IoT Analytics API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotanalytics/run-pipeline-activity.rst awscli-1.18.69/awscli/examples/iotanalytics/run-pipeline-activity.rst --- awscli-1.11.13/awscli/examples/iotanalytics/run-pipeline-activity.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotanalytics/run-pipeline-activity.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,36 @@ +**To simulate a pipeline activity** + +The following ``run-pipeline-activity`` example simulates the results of running a pipeline activity on a message payload. :: + + aws iotanalytics run-pipeline-activity \ + --pipeline-activity file://maths.json \ + --payloads file://payloads.json + +Contents of ``maths.json``:: + + { + "math": { + "name": "MyMathActivity", + "math": "((temp - 32) * 5.0) / 9.0", + "attribute": "tempC" + } + } + +Contents of ``payloads.json``:: + + [ + "{\"humidity\": 52, \"temp\": 68 }", + "{\"humidity\": 52, \"temp\": 32 }" + ] + +Output:: + + { + "logResult": "", + "payloads": [ + "eyJodW1pZGl0eSI6NTIsInRlbXAiOjY4LCJ0ZW1wQyI6MjB9", + "eyJodW1pZGl0eSI6NTIsInRlbXAiOjMyLCJ0ZW1wQyI6MH0=" + ] + } + +For more information, see `RunPipelineActivity `__ in the *AWS IoT Analytics API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotanalytics/sample-channel-data.rst awscli-1.18.69/awscli/examples/iotanalytics/sample-channel-data.rst --- awscli-1.11.13/awscli/examples/iotanalytics/sample-channel-data.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotanalytics/sample-channel-data.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,17 @@ +**To retrieve sample messages from a channel** + +The following ``sample-channel-data`` example retrieves a sample of messages from the specified channel ingested during the specified timeframe. You can retrieve up to 10 messages. :: + + aws iotanalytics sample-channel-data \ + --channel-name mychannel + +Output:: + + { + "payloads": [ + "eyAidGVtcGVyYXR1cmUiOiAyMCB9", + "eyAiZm9vIjogImJhciIgfQ==" + ] + } + +For more information, see `SampleChannelData `__ in the *AWS IoT Analytics API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotanalytics/start-pipeline-reprocessing.rst awscli-1.18.69/awscli/examples/iotanalytics/start-pipeline-reprocessing.rst --- awscli-1.11.13/awscli/examples/iotanalytics/start-pipeline-reprocessing.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotanalytics/start-pipeline-reprocessing.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,14 @@ +**To start pipeline reprocessing** + +The following ``start-pipeline-reprocessing`` example starts the reprocessing of raw message data through the specified pipeline. :: + + aws iotanalytics start-pipeline-reprocessing \ + --pipeline-name mypipeline + +Output:: + + { + "reprocessingId": "6ad2764f-fb13-4de3-b101-4e74af03b043" + } + +For more information, see `StartPipelineReprocessing `__ in the *AWS IoT Analytics API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotanalytics/tag-resource.rst awscli-1.18.69/awscli/examples/iotanalytics/tag-resource.rst --- awscli-1.11.13/awscli/examples/iotanalytics/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotanalytics/tag-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To add or modify tags for a resource** + +The following ``tag-resource`` example adds to or modifies the tags attached to the specified resource. :: + + aws iotanalytics tag-resource \ + --resource-arn "arn:aws:iotanalytics:us-west-2:123456789012:channel/mychannel" \ + --tags "[{\"key\": \"Environment\", \"value\": \"Production\"}]" + +This command produces no output. + +For more information, see `TagResource `__ in the *AWS IoT Analytics API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotanalytics/untag-resource.rst awscli-1.18.69/awscli/examples/iotanalytics/untag-resource.rst --- awscli-1.11.13/awscli/examples/iotanalytics/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotanalytics/untag-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,12 @@ +**To remove tags from a resource** + +The following ``untag-resource`` example removes the tags with the specified key names from the specified resource. :: + + aws iotanalytics untag-resource \ + --resource-arn "arn:aws:iotanalytics:us-west-2:123456789012:channel/mychannel" \ + --tag-keys "[\"Environment\"]" + +This command produces no output. + +For more information, see `UntagResource `__ in the *AWS IoT Analytics API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotanalytics/update-channel.rst awscli-1.18.69/awscli/examples/iotanalytics/update-channel.rst --- awscli-1.11.13/awscli/examples/iotanalytics/update-channel.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotanalytics/update-channel.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,19 @@ +**To modify a channel** + +The following ``update-channel`` example modifies the settings for the specified channel. :: + + aws iotanalytics update-channel \ + --cli-input-json file://update-channel.json + +Contents of ``update-channel.json``:: + + { + "channelName": "mychannel", + "retentionPeriod": { + "numberOfDays": 92 + } + } + +This command produces no output. + +For more information, see `UpdateChannel `__ in the *AWS IoT Analytics API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotanalytics/update-dataset.rst awscli-1.18.69/awscli/examples/iotanalytics/update-dataset.rst --- awscli-1.11.13/awscli/examples/iotanalytics/update-dataset.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotanalytics/update-dataset.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,28 @@ +**To update a dataset** + +The following ``update-dataset`` example modifies the settings of the specified dataset. :: + + aws iotanalytics update-dataset \ + --cli-input-json file://update-dataset.json + +Contents of ``update-dataset.json``:: + + { + "datasetName": "mydataset", + "actions": [ + { + "actionName": "myDatasetUpdateAction", + "queryAction": { + "sqlQuery": "SELECT * FROM mydatastore" + } + } + ], + "retentionPeriod": { + "numberOfDays": 92 + } + } + +This command produces no output. + +For more information, see `UpdateDataset `__ in the *AWS IoT Analytics API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotanalytics/update-datastore.rst awscli-1.18.69/awscli/examples/iotanalytics/update-datastore.rst --- awscli-1.11.13/awscli/examples/iotanalytics/update-datastore.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotanalytics/update-datastore.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,19 @@ +**To update a data store** + +The following ``update-datastore`` example modifies the settings of the specified data store. :: + + aws iotanalytics update-datastore \ + --cli-input-json file://update-datastore.json + +Contents of update-datastore.json:: + + { + "datastoreName": "mydatastore", + "retentionPeriod": { + "numberOfDays": 93 + } + } + +This command produces no output. + +For more information, see `UpdateDatastore `__ in the *AWS IoT Analytics API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotanalytics/update-pipeline.rst awscli-1.18.69/awscli/examples/iotanalytics/update-pipeline.rst --- awscli-1.11.13/awscli/examples/iotanalytics/update-pipeline.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotanalytics/update-pipeline.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,39 @@ +**To update a pipeline** + +The following ``update-pipeline`` example modifies the settings of the specified pipeline. You must specify both a channel and a data store activity and, optionally, as many as 23 additional activities, in the ``pipelineActivities`` array. :: + + aws iotanalytics update-pipeline \ + --cli-input-json file://update-pipeline.json + +Contents of update-pipeline.json:: + + { + "pipelineName": "mypipeline", + "pipelineActivities": [ + { + "channel": { + "name": "myChannelActivity", + "channelName": "mychannel", + "next": "myMathActivity" + } + }, + { + "datastore": { + "name": "myDatastoreActivity", + "datastoreName": "mydatastore" + } + }, + { + "math": { + "name": "myMathActivity", + "math": "(((temp - 32) * 5.0) / 9.0) + 273.15", + "attribute": "tempK", + "next": "myDatastoreActivity" + } + } + ] + } + +This command produces no output. + +For more information, see `UpdatePipeline `__ in the *AWS IoT Analytics API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iot-data/delete-thing-shadow.rst awscli-1.18.69/awscli/examples/iot-data/delete-thing-shadow.rst --- awscli-1.11.13/awscli/examples/iot-data/delete-thing-shadow.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot-data/delete-thing-shadow.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,14 @@ +**To delete a device's shadow document** + +The following ``delete-thing-shadow`` example deletes the entire shadow document for the device named ``MyRPi``. :: + + aws iot-data delete-thing-shadow \ + --thing-name MyRPi \ + "output.txt" + +The command produces no output on the display, but ``output.txt`` contains information that confirms the version and timestamp of the shadow document that you deleted. :: + + {"version":2,"timestamp":1560270384} + +For more information, see `Using Shadows `__ in the *AWS IoT Developers Guide*. + diff -Nru awscli-1.11.13/awscli/examples/iot-data/get-thing-shadow.rst awscli-1.18.69/awscli/examples/iot-data/get-thing-shadow.rst --- awscli-1.11.13/awscli/examples/iot-data/get-thing-shadow.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot-data/get-thing-shadow.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,27 @@ +**To get a thing shadow document** + +The following ``get-thing-shadow`` example gets the thing shadow document for the specified IoT thing. :: + + aws iot-data get-thing-shadow \ + --thing-name MyRPi \ + output.txt + +The command produces no output on the display, but the following shows the contents of ``output.txt``:: + + { + "state":{ + "reported":{ + "moisture":"low" + } + }, + "metadata":{ + "reported":{ + "moisture":{ + "timestamp":1560269319 + } + } + }, + "version":1,"timestamp":1560269405 + } + +For more information, see `Device Shadow Service Data Flow `__ in the *AWS IoT Developers Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot-data/update-thing-shadow.rst awscli-1.18.69/awscli/examples/iot-data/update-thing-shadow.rst --- awscli-1.11.13/awscli/examples/iot-data/update-thing-shadow.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot-data/update-thing-shadow.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,29 @@ +**To update a thing shadow** + +The following ``update-thing-shadow`` example modifies the current state of the device shadow for the specified thing and saves it to the file ``output.txt``. :: + + aws iot-data update-thing-shadow \ + --thing-name MyRPi \ + --payload "{"state":{"reported":{"moisture":"okay"}}}" \ + "output.txt" + +The command produces no output on the display, but the following shows the contents of ``output.txt``:: + + { + "state": { + "reported": { + "moisture": "okay" + } + }, + "metadata": { + "reported": { + "moisture": { + "timestamp": 1560270036 + } + } + }, + "version": 2, + "timestamp": 1560270036 + } + +For more information, see `Device Shadow Service Data Flow `__ in the *AWS IoT Developers Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotevents/batch-put-message.rst awscli-1.18.69/awscli/examples/iotevents/batch-put-message.rst --- awscli-1.11.13/awscli/examples/iotevents/batch-put-message.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents/batch-put-message.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,26 @@ +**To send messages (inputs) to AWS IoT Events** + +The following ``batch-put-message`` example sends a set of messages to the AWS IoT Events system. Each message payload is transformed into the input you specify ( ``inputName`` ) and ingested into any detectors that monitor that input. If multiple messages are sent, the order in which the messages are processed isn't guaranteed. To guarantee ordering, you must send messages one at a time and wait for a successful response. :: + + aws iotevents-data batch-put-message \ + --cli-input-json file://highPressureMessage.json + +Contents of ``highPressureMessage.json``:: + + { + "messages": [ + { + "messageId": "00001", + "inputName": "PressureInput", + "payload": "{\"motorid\": \"Fulton-A32\", \"sensorData\": {\"pressure\": 80, \"temperature\": 39} }" + } + ] + } + +Output:: + + { + "BatchPutMessageErrorEntries": [] + } + +For more information, see `BatchPutMessage `__ in the *AWS IoT Events API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotevents/batch-update-detector.rst awscli-1.18.69/awscli/examples/iotevents/batch-update-detector.rst --- awscli-1.11.13/awscli/examples/iotevents/batch-update-detector.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents/batch-update-detector.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,38 @@ +**To update a detector (instance)** + +The following ``batch-update-detector`` example updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model. :: + + aws iotevents-data batch-update-detector \ + --cli-input-json file://budFulton-A32.json + +Contents of ``budFulton-A32.json``:: + + { + "detectors": [ + { + "messageId": "00001", + "detectorModelName": "motorDetectorModel", + "keyValue": "Fulton-A32", + "state": { + "stateName": "Normal", + "variables": [ + { + "name": "pressureThresholdBreached", + "value": "0" + } + ], + "timers": [ + ] + } + } + ] + } + +Output:: + + { + "batchUpdateDetectorErrorEntries": [] + } + + +For more information, see `BatchUpdateDetector `__ in the *AWS IoT Events API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotevents/create-detector-model.rst awscli-1.18.69/awscli/examples/iotevents/create-detector-model.rst --- awscli-1.11.13/awscli/examples/iotevents/create-detector-model.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents/create-detector-model.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,140 @@ +**To create a detector model** + +The following ``create-detector-model`` example creates a detector model with its configuration specified by a parameter file. :: + + aws iotevents create-detector-model \ + --cli-input-json file://motorDetectorModel.json + +Contents of ``motorDetectorModel.json``:: + + { + "detectorModelName": "motorDetectorModel", + "detectorModelDefinition": { + "states": [ + { + "stateName": "Normal", + "onEnter": { + "events": [ + { + "eventName": "init", + "condition": "true", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "0" + } + } + ] + } + ] + }, + "onInput": { + "transitionEvents": [ + { + "eventName": "Overpressurized", + "condition": "$input.PressureInput.sensorData.pressure > 70", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "$variable.pressureThresholdBreached + 3" + } + } + ], + "nextState": "Dangerous" + } + ] + } + }, + { + "stateName": "Dangerous", + "onEnter": { + "events": [ + { + "eventName": "Pressure Threshold Breached", + "condition": "$variable.pressureThresholdBreached > 1", + "actions": [ + { + "sns": { + "targetArn": "arn:aws:sns:us-east-1:123456789012:underPressureAction" + } + } + ] + } + ] + }, + "onInput": { + "events": [ + { + "eventName": "Overpressurized", + "condition": "$input.PressureInput.sensorData.pressure > 70", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "3" + } + } + ] + }, + { + "eventName": "Pressure Okay", + "condition": "$input.PressureInput.sensorData.pressure <= 70", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "$variable.pressureThresholdBreached - 1" + } + } + ] + } + ], + "transitionEvents": [ + { + "eventName": "BackToNormal", + "condition": "$input.PressureInput.sensorData.pressure <= 70 && $variable.pressureThresholdBreached <= 1", + "nextState": "Normal" + } + ] + }, + "onExit": { + "events": [ + { + "eventName": "Normal Pressure Restored", + "condition": "true", + "actions": [ + { + "sns": { + "targetArn": "arn:aws:sns:us-east-1:123456789012:pressureClearedAction" + } + } + ] + } + ] + } + } + ], + "initialStateName": "Normal" + }, + "key": "motorid", + "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole" + } + +Output:: + + { + "detectorModelConfiguration": { + "status": "ACTIVATING", + "lastUpdateTime": 1560796816.077, + "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", + "creationTime": 1560796816.077, + "detectorModelArn": "arn:aws:iotevents:us-west-2:123456789012:detectorModel/motorDetectorModel", + "key": "motorid", + "detectorModelName": "motorDetectorModel", + "detectorModelVersion": "1" + } + } + +For more information, see `CreateDetectorModel `__ in the *AWS IoT Events API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotevents/create-input.rst awscli-1.18.69/awscli/examples/iotevents/create-input.rst --- awscli-1.11.13/awscli/examples/iotevents/create-input.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents/create-input.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,34 @@ +**To create an input** + +The following ``create-input`` example creates an input. :: + + aws iotevents create-input \ + --cli-input-json file://pressureInput.json + +Contents of ``pressureInput.json``:: + + { + "inputName": "PressureInput", + "inputDescription": "Pressure readings from a motor", + "inputDefinition": { + "attributes": [ + { "jsonPath": "sensorData.pressure" }, + { "jsonPath": "motorid" } + ] + } + } + +Output:: + + { + "inputConfiguration": { + "status": "ACTIVE", + "inputArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", + "lastUpdateTime": 1560795312.542, + "creationTime": 1560795312.542, + "inputName": "PressureInput", + "inputDescription": "Pressure readings from a motor" + } + } + +For more information, see `CreateInput `__ in the *AWS IoT Events API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotevents/delete-detector-model.rst awscli-1.18.69/awscli/examples/iotevents/delete-detector-model.rst --- awscli-1.11.13/awscli/examples/iotevents/delete-detector-model.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents/delete-detector-model.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a detector model** + +The following ``delete-detector-model`` example deletes the specified detector model. Any active instances of the detector model are also deleted. :: + + aws iotevents delete-detector-model \ + --detector-model-name motorDetectorModel + +This command produces no output. + +For more information, see `DeleteDetectorModel `__ in the *AWS IoT Events API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotevents/delete-input.rst awscli-1.18.69/awscli/examples/iotevents/delete-input.rst --- awscli-1.11.13/awscli/examples/iotevents/delete-input.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents/delete-input.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete an input** + +The following ``delete-input`` example deletes the specified input. :: + + aws iotevents delete-input \ + --input-name PressureInput + +This command produces no output. + +For more information, see `DeleteInput `__ in the *AWS IoT Events API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotevents/describe-detector-model.rst awscli-1.18.69/awscli/examples/iotevents/describe-detector-model.rst --- awscli-1.11.13/awscli/examples/iotevents/describe-detector-model.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents/describe-detector-model.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,139 @@ +**To get information about a detector model** + +The following ``describe-detector-model`` example displays details for the specified detector model. Because the ``version`` parameter is not specified, information about the latest version is returned. :: + + aws iotevents describe-detector-model \ + --detector-model-name motorDetectorModel + +Output:: + + { + "detectorModel": { + "detectorModelConfiguration": { + "status": "ACTIVE", + "lastUpdateTime": 1560796816.077, + "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", + "creationTime": 1560796816.077, + "detectorModelArn": "arn:aws:iotevents:us-west-2:123456789012:detectorModel/motorDetectorModel", + "key": "motorid", + "detectorModelName": "motorDetectorModel", + "detectorModelVersion": "1" + }, + "detectorModelDefinition": { + "states": [ + { + "onInput": { + "transitionEvents": [ + { + "eventName": "Overpressurized", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "$variable.pressureThresholdBreached + 3" + } + } + ], + "condition": "$input.PressureInput.sensorData.pressure > 70", + "nextState": "Dangerous" + } + ], + "events": [] + }, + "stateName": "Normal", + "onEnter": { + "events": [ + { + "eventName": "init", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "0" + } + } + ], + "condition": "true" + } + ] + }, + "onExit": { + "events": [] + } + }, + { + "onInput": { + "transitionEvents": [ + { + "eventName": "BackToNormal", + "actions": [], + "condition": "$input.PressureInput.sensorData.pressure <= 70 && $variable.pressureThresholdBreached <= 1", + "nextState": "Normal" + } + ], + "events": [ + { + "eventName": "Overpressurized", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "3" + } + } + ], + "condition": "$input.PressureInput.sensorData.pressure > 70" + }, + { + "eventName": "Pressure Okay", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "$variable.pressureThresholdBreached - 1" + } + } + ], + "condition": "$input.PressureInput.sensorData.pressure <= 70" + } + ] + }, + "stateName": "Dangerous", + "onEnter": { + "events": [ + { + "eventName": "Pressure Threshold Breached", + "actions": [ + { + "sns": { + "targetArn": "arn:aws:sns:us-east-1:123456789012:underPressureAction" + } + } + ], + "condition": "$variable.pressureThresholdBreached > 1" + } + ] + }, + "onExit": { + "events": [ + { + "eventName": "Normal Pressure Restored", + "actions": [ + { + "sns": { + "targetArn": "arn:aws:sns:us-east-1:123456789012:pressureClearedAction" + } + } + ], + "condition": "true" + } + ] + } + } + ], + "initialStateName": "Normal" + } + } + } + +For more information, see `DescribeDetectorModel `__ in the *AWS IoT Events API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotevents/describe-detector.rst awscli-1.18.69/awscli/examples/iotevents/describe-detector.rst --- awscli-1.11.13/awscli/examples/iotevents/describe-detector.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents/describe-detector.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,31 @@ +**To get information about a detector (instance).** + +The following ``describe-detector`` example displays details for the specified detector (instance). :: + + aws iotevents-data describe-detector \ + --detector-model-name motorDetectorModel \ + --key-value "Fulton-A32" + +Output:: + + { + "detector": { + "lastUpdateTime": 1560797852.776, + "creationTime": 1560797852.775, + "state": { + "variables": [ + { + "name": "pressureThresholdBreached", + "value": "3" + } + ], + "stateName": "Dangerous", + "timers": [] + }, + "keyValue": "Fulton-A32", + "detectorModelName": "motorDetectorModel", + "detectorModelVersion": "1" + } + } + +For more information, see `DescribeDetector `__ in the *AWS IoT Events API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotevents/describe-input.rst awscli-1.18.69/awscli/examples/iotevents/describe-input.rst --- awscli-1.11.13/awscli/examples/iotevents/describe-input.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents/describe-input.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,34 @@ +**To get information about an input** + +The following ``describe-input`` example displays details for the specified input. :: + + aws iotevents describe-input \ + --input-name PressureInput + +Output:: + + { + "input": { + "inputConfiguration": { + "status": "ACTIVE", + "inputArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", + "lastUpdateTime": 1560795312.542, + "creationTime": 1560795312.542, + "inputName": "PressureInput", + "inputDescription": "Pressure readings from a motor" + }, + "inputDefinition": { + "attributes": [ + { + "jsonPath": "sensorData.pressure" + }, + { + "jsonPath": "motorid" + } + ] + } + } + } + + +For more information, see `DescribeInput `__ in the *AWS IoT Events API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotevents/describe-logging-options.rst awscli-1.18.69/awscli/examples/iotevents/describe-logging-options.rst --- awscli-1.11.13/awscli/examples/iotevents/describe-logging-options.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents/describe-logging-options.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,17 @@ +**To get information about logging settings** + +The following ``describe-logging-options`` example retrieves the current settings of the AWS IoT Events logging options. :: + + aws iotevents describe-logging-options + +Output:: + + { + "loggingOptions": { + "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", + "enabled": false, + "level": "ERROR" + } + } + +For more information, see `DescribeLoggingOptions `__ in the *AWS IoT Events API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotevents/list-detector-models.rst awscli-1.18.69/awscli/examples/iotevents/list-detector-models.rst --- awscli-1.11.13/awscli/examples/iotevents/list-detector-models.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents/list-detector-models.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,19 @@ +**To get a list of your detector models** + +The following ``list-detector-models`` example Lists the detector models you have created. Only the metadata associated with each detector model is returned. :: + + aws iotevents list-detector-models + +Output:: + + { + "detectorModelSummaries": [ + { + "detectorModelName": "motorDetectorModel", + "creationTime": 1552072424.212 + "detectorModelDescription": "Detect overpressure in a motor." + } + ] + } + +For more information, see `ListDetectorModels `__ in the *AWS IoT Events API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotevents/list-detector-model-versions.rst awscli-1.18.69/awscli/examples/iotevents/list-detector-model-versions.rst --- awscli-1.11.13/awscli/examples/iotevents/list-detector-model-versions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents/list-detector-model-versions.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,24 @@ +**To get information about versions of a detector model** + +The following ``list-detector-model-versions`` example Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned. :: + + aws iotevents list-detector-model-versions \ + --detector-model-name motorDetectorModel + +Output:: + + { + "detectorModelVersionSummaries": [ + { + "status": "ACTIVE", + "lastUpdateTime": 1560796816.077, + "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", + "creationTime": 1560796816.077, + "detectorModelArn": "arn:aws:iotevents:us-west-2:123456789012:detectorModel/motorDetectorModel", + "detectorModelName": "motorDetectorModel", + "detectorModelVersion": "1" + } + ] + } + +For more information, see `ListDetectorModelVersions `__ in the *AWS IoT Events API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotevents/list-detectors.rst awscli-1.18.69/awscli/examples/iotevents/list-detectors.rst --- awscli-1.11.13/awscli/examples/iotevents/list-detectors.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents/list-detectors.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,25 @@ +**To get a list of detectors for a detector model** + +The following ``list-detectors`` example lists the detectors (the instances of a detector model) in your account. :: + + aws iotevents-data list-detectors \ + --detector-model-name motorDetectorModel + +Output:: + + { + "detectorSummaries": [ + { + "lastUpdateTime": 1558129925.2, + "creationTime": 1552073155.527, + "state": { + "stateName": "Normal" + }, + "keyValue": "Fulton-A32", + "detectorModelName": "motorDetectorModel", + "detectorModelVersion": "1" + } + ] + } + +For more information, see `ListDetectors `__ in the *AWS IoT Events API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotevents/list-inputs.rst awscli-1.18.69/awscli/examples/iotevents/list-inputs.rst --- awscli-1.11.13/awscli/examples/iotevents/list-inputs.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents/list-inputs.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,21 @@ +**To list inputs** + +The following ``list-inputs`` example lists the inputs you have created in your account. :: + + aws iotevents list-inputs + +This command produces no output. +Output:: + + { + { + "status": "ACTIVE", + "inputArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", + "lastUpdateTime": 1551742986.768, + "creationTime": 1551742986.768, + "inputName": "PressureInput", + "inputDescription": "Pressure readings from a motor" + } + } + +For more information, see `ListInputs `__ in the *AWS IoT Events API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotevents/list-tags-for-resource.rst awscli-1.18.69/awscli/examples/iotevents/list-tags-for-resource.rst --- awscli-1.11.13/awscli/examples/iotevents/list-tags-for-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents/list-tags-for-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,19 @@ +**To list tags assigned to a resource.** + +The following ``list-tags-for-resource`` example lists the tag key names and values you have assigned to the resource. :: + + aws iotevents list-tags-for-resource \ + --resource-arn "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput" + +Output:: + + { + "tags": [ + { + "value": "motor", + "key": "deviceType" + } + ] + } + +For more information, see `ListTagsForResource `__ in the *AWS IoT Events API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotevents/put-logging-options.rst awscli-1.18.69/awscli/examples/iotevents/put-logging-options.rst --- awscli-1.11.13/awscli/examples/iotevents/put-logging-options.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents/put-logging-options.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,26 @@ +**To set logging options** + +The following ``put-logging-options`` example sets or updates the AWS IoT Events logging options. If you update the value of any ``loggingOptions` field, it can take up to one minute for the change to take effect. Also, if you change the policy attached to the role you specified in the ``roleArn`` field (for example, to correct an invalid policy) it can take up to five minutes for that change to take effect. :: + + aws iotevents put-logging-options \ + --cli-input-json file://logging-options.json + +Contents of ``logging-options.json``:: + + { + "loggingOptions": { + "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", + "level": "DEBUG", + "enabled": true, + "detectorDebugOptions": [ + { + "detectorModelName": "motorDetectorModel", + "keyValue": "Fulton-A32" + } + ] + } + } + +This command produces no output. + +For more information, see `PutLoggingOptions `__ in the *AWS IoT Events API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotevents/tag-resource.rst awscli-1.18.69/awscli/examples/iotevents/tag-resource.rst --- awscli-1.11.13/awscli/examples/iotevents/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents/tag-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,22 @@ +**To add tags to a resource** + +The following ``tag-resource`` example adds or modifies (if key ``deviceType`` already exists) the tag attached the specified resource. :: + + aws iotevents tag-resource \ + --cli-input-json file://pressureInput.tag.json + +Contents of ``pressureInput.tag.json``:: + + { + "resourceArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", + "tags": [ + { + "key": "deviceType", + "value": "motor" + } + ] + } + +This command produces no output. + +For more information, see `TagResource `__ in the *AWS IoT Events API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotevents/untag-resource.rst awscli-1.18.69/awscli/examples/iotevents/untag-resource.rst --- awscli-1.11.13/awscli/examples/iotevents/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents/untag-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To remove tags from a resource** + +The following ``untag-resource`` example removes the tag with the specified key name from the specified resource. :: + + aws iotevents untag-resource \ + --resource-arn arn:aws:iotevents:us-west-2:123456789012:input/PressureInput \ + --tagkeys deviceType + +This command produces no output. + +For more information, see `UntagResource `__ in the *AWS IoT Events API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotevents/update-detector-model.rst awscli-1.18.69/awscli/examples/iotevents/update-detector-model.rst --- awscli-1.11.13/awscli/examples/iotevents/update-detector-model.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents/update-detector-model.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,139 @@ +**To update a detector model** + +The following ``update-detector-model`` example updates the specified detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive. :: + + aws iotevents update-detector-model \ + --cli-input-json file://motorDetectorModel.update.json + +Contents of ``motorDetectorModel.update.json``:: + + { + "detectorModelName": "motorDetectorModel", + "detectorModelDefinition": { + "states": [ + { + "stateName": "Normal", + "onEnter": { + "events": [ + { + "eventName": "init", + "condition": "true", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "0" + } + } + ] + } + ] + }, + "onInput": { + "transitionEvents": [ + { + "eventName": "Overpressurized", + "condition": "$input.PressureInput.sensorData.pressure > 70", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "$variable.pressureThresholdBreached + 3" + } + } + ], + "nextState": "Dangerous" + } + ] + } + }, + { + "stateName": "Dangerous", + "onEnter": { + "events": [ + { + "eventName": "Pressure Threshold Breached", + "condition": "$variable.pressureThresholdBreached > 1", + "actions": [ + { + "sns": { + "targetArn": "arn:aws:sns:us-east-1:123456789012:underPressureAction" + } + } + ] + } + ] + }, + "onInput": { + "events": [ + { + "eventName": "Overpressurized", + "condition": "$input.PressureInput.sensorData.pressure > 70", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "3" + } + } + ] + }, + { + "eventName": "Pressure Okay", + "condition": "$input.PressureInput.sensorData.pressure <= 70", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "$variable.pressureThresholdBreached - 1" + } + } + ] + } + ], + "transitionEvents": [ + { + "eventName": "BackToNormal", + "condition": "$input.PressureInput.sensorData.pressure <= 70 && $variable.pressureThresholdBreached <= 1", + "nextState": "Normal" + } + ] + }, + "onExit": { + "events": [ + { + "eventName": "Normal Pressure Restored", + "condition": "true", + "actions": [ + { + "sns": { + "targetArn": "arn:aws:sns:us-east-1:123456789012:pressureClearedAction" + } + } + ] + } + ] + } + } + ], + "initialStateName": "Normal" + }, + "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole" + } + +Output:: + + { + "detectorModelConfiguration": { + "status": "ACTIVATING", + "lastUpdateTime": 1560799387.719, + "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", + "creationTime": 1560799387.719, + "detectorModelArn": "arn:aws:iotevents:us-west-2:123456789012:detectorModel/motorDetectorModel", + "key": "motorid", + "detectorModelName": "motorDetectorModel", + "detectorModelVersion": "2" + } + } + +For more information, see `UpdateDetectorModel `__ in the *AWS IoT Events API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotevents/update-input.rst awscli-1.18.69/awscli/examples/iotevents/update-input.rst --- awscli-1.11.13/awscli/examples/iotevents/update-input.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents/update-input.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,34 @@ +**To update an input** + +The following ``update-input`` example updates the specified input with a new description and definition. :: + + aws iotevents update-input \ + --cli-input-json file://pressureInput.json + +Contents of ``pressureInput.json``:: + + { + "inputName": "PressureInput", + "inputDescription": "Pressure readings from a motor", + "inputDefinition": { + "attributes": [ + { "jsonPath": "sensorData.pressure" }, + { "jsonPath": "motorid" } + ] + } + } + +Output:: + + { + "inputConfiguration": { + "status": "ACTIVE", + "inputArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", + "lastUpdateTime": 1560795976.458, + "creationTime": 1560795312.542, + "inputName": "PressureInput", + "inputDescription": "Pressure readings from a motor" + } + } + +For more information, see `UpdateInput `__ in the *AWS IoT Events API Reference*. diff -Nru awscli-1.11.13/awscli/examples/iotevents-data/batch-put-message.rst awscli-1.18.69/awscli/examples/iotevents-data/batch-put-message.rst --- awscli-1.11.13/awscli/examples/iotevents-data/batch-put-message.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents-data/batch-put-message.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,27 @@ +**To send messages (inputs) to AWS IoT Events** + +The following ``batch-put-message`` example sends a set of messages to the AWS IoT Events system. Each message payload is transformed into the input you specify ( ``inputName`` ) and ingested into any detectors that monitor that input. If multiple messages are sent, the order in which the messages are processed isn't guaranteed. To guarantee ordering, you must send messages one at a time and wait for a successful response. :: + + aws iotevents-data batch-put-message \ + --cli-input-json file://highPressureMessage.json + +Contents of ``highPressureMessage.json``:: + + { + "messages": [ + { + "messageId": "00001", + "inputName": "PressureInput", + "payload": "{\"motorid\": \"Fulton-A32\", \"sensorData\": {\"pressure\": 80, \"temperature\": 39} }" + } + ] + } + +Output:: + + { + "BatchPutMessageErrorEntries": [] + } + +For more information, see `BatchPutMessage `__ in the *AWS IoT Events Developer Guide**. + diff -Nru awscli-1.11.13/awscli/examples/iotevents-data/batch-update-detector.rst awscli-1.18.69/awscli/examples/iotevents-data/batch-update-detector.rst --- awscli-1.11.13/awscli/examples/iotevents-data/batch-update-detector.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents-data/batch-update-detector.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,38 @@ +**To update a detector (instance)** + +The following ``batch-update-detector`` example updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model. :: + + aws iotevents-data batch-update-detector \ + --cli-input-json file://budFulton-A32.json + +Contents of ``budFulton-A32.json``:: + + { + "detectors": [ + { + "messageId": "00001", + "detectorModelName": "motorDetectorModel", + "keyValue": "Fulton-A32", + "state": { + "stateName": "Normal", + "variables": [ + { + "name": "pressureThresholdBreached", + "value": "0" + } + ], + "timers": [ + ] + } + } + ] + } + +Output:: + + { + "batchUpdateDetectorErrorEntries": [] + } + +For more information, see `BatchUpdateDetector `__ in the *AWS IoT Events Developer Guide**. + diff -Nru awscli-1.11.13/awscli/examples/iotevents-data/create-detector-model.rst awscli-1.18.69/awscli/examples/iotevents-data/create-detector-model.rst --- awscli-1.11.13/awscli/examples/iotevents-data/create-detector-model.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents-data/create-detector-model.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,141 @@ +**To create a detector model** + +The following ``create-detector-model`` example creates a detector model. :: + + aws iotevents create-detector-model \ + --cli-input-json file://motorDetectorModel.json + +Contents of ``motorDetectorModel.json``:: + + { + "detectorModelName": "motorDetectorModel", + "detectorModelDefinition": { + "states": [ + { + "stateName": "Normal", + "onEnter": { + "events": [ + { + "eventName": "init", + "condition": "true", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "0" + } + } + ] + } + ] + }, + "onInput": { + "transitionEvents": [ + { + "eventName": "Overpressurized", + "condition": "$input.PressureInput.sensorData.pressure > 70", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "$variable.pressureThresholdBreached + 3" + } + } + ], + "nextState": "Dangerous" + } + ] + } + }, + { + "stateName": "Dangerous", + "onEnter": { + "events": [ + { + "eventName": "Pressure Threshold Breached", + "condition": "$variable.pressureThresholdBreached > 1", + "actions": [ + { + "sns": { + "targetArn": "arn:aws:sns:us-east-1:123456789012:underPressureAction" + } + } + ] + } + ] + }, + "onInput": { + "events": [ + { + "eventName": "Overpressurized", + "condition": "$input.PressureInput.sensorData.pressure > 70", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "3" + } + } + ] + }, + { + "eventName": "Pressure Okay", + "condition": "$input.PressureInput.sensorData.pressure <= 70", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "$variable.pressureThresholdBreached - 1" + } + } + ] + } + ], + "transitionEvents": [ + { + "eventName": "BackToNormal", + "condition": "$input.PressureInput.sensorData.pressure <= 70 && $variable.pressureThresholdBreached <= 1", + "nextState": "Normal" + } + ] + }, + "onExit": { + "events": [ + { + "eventName": "Normal Pressure Restored", + "condition": "true", + "actions": [ + { + "sns": { + "targetArn": "arn:aws:sns:us-east-1:123456789012:pressureClearedAction" + } + } + ] + } + ] + } + } + ], + "initialStateName": "Normal" + }, + "key": "motorid", + "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole" + } + +Output:: + + { + "detectorModelConfiguration": { + "status": "ACTIVATING", + "lastUpdateTime": 1560796816.077, + "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", + "creationTime": 1560796816.077, + "detectorModelArn": "arn:aws:iotevents:us-west-2:123456789012:detectorModel/motorDetectorModel", + "key": "motorid", + "detectorModelName": "motorDetectorModel", + "detectorModelVersion": "1" + } + } + +For more information, see `CreateDetectorModel `__ in the *AWS IoT Events Developer Guide**. + diff -Nru awscli-1.11.13/awscli/examples/iotevents-data/create-input.rst awscli-1.18.69/awscli/examples/iotevents-data/create-input.rst --- awscli-1.11.13/awscli/examples/iotevents-data/create-input.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents-data/create-input.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,34 @@ +**To create an input** + +The following ``create-input`` example creates an input. :: + + aws iotevents create-input \ + --cli-input-json file://pressureInput.json + +Contents of ``pressureInput.json``:: + + { + "inputName": "PressureInput", + "inputDescription": "Pressure readings from a motor", + "inputDefinition": { + "attributes": [ + { "jsonPath": "sensorData.pressure" }, + { "jsonPath": "motorid" } + ] + } + } + +Output:: + + { + "inputConfiguration": { + "status": "ACTIVE", + "inputArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", + "lastUpdateTime": 1560795312.542, + "creationTime": 1560795312.542, + "inputName": "PressureInput", + "inputDescription": "Pressure readings from a motor" + } + } + +For more information, see `CreateInput `__ in the *AWS IoT Events Developer Guide**. diff -Nru awscli-1.11.13/awscli/examples/iotevents-data/delete-detector-model.rst awscli-1.18.69/awscli/examples/iotevents-data/delete-detector-model.rst --- awscli-1.11.13/awscli/examples/iotevents-data/delete-detector-model.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents-data/delete-detector-model.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To delete a detector model** + +The following ``delete-detector-model`` example deletes a detector model. Any active instances of the detector model are also deleted. :: + + aws iotevents delete-detector-model \ + --detector-model-name motorDetectorModel* + +This command produces no output. + +For more information, see `DeleteDetectorModel `__ in the *AWS IoT Events Developer Guide**. + diff -Nru awscli-1.11.13/awscli/examples/iotevents-data/delete-input.rst awscli-1.18.69/awscli/examples/iotevents-data/delete-input.rst --- awscli-1.11.13/awscli/examples/iotevents-data/delete-input.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents-data/delete-input.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete an input** + +The following ``delete-input`` example deletes an input. :: + + aws iotevents delete-input \ + --input-name PressureInput + +This command produces no output. + +For more information, see `DeleteInput `__ in the *AWS IoT Events Developer Guide**. diff -Nru awscli-1.11.13/awscli/examples/iotevents-data/describe-detector-model.rst awscli-1.18.69/awscli/examples/iotevents-data/describe-detector-model.rst --- awscli-1.11.13/awscli/examples/iotevents-data/describe-detector-model.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents-data/describe-detector-model.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,140 @@ +**To get information about a detector model** + +The following ``describe-detector-model`` example describes a detector model. If the ``version`` parameter is not specified, the command returns information about the latest version. :: + + aws iotevents describe-detector-model \ + --detector-model-name motorDetectorModel + +Output:: + + { + "detectorModel": { + "detectorModelConfiguration": { + "status": "ACTIVE", + "lastUpdateTime": 1560796816.077, + "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", + "creationTime": 1560796816.077, + "detectorModelArn": "arn:aws:iotevents:us-west-2:123456789012:detectorModel/motorDetectorModel", + "key": "motorid", + "detectorModelName": "motorDetectorModel", + "detectorModelVersion": "1" + }, + "detectorModelDefinition": { + "states": [ + { + "onInput": { + "transitionEvents": [ + { + "eventName": "Overpressurized", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "$variable.pressureThresholdBreached + 3" + } + } + ], + "condition": "$input.PressureInput.sensorData.pressure > 70", + "nextState": "Dangerous" + } + ], + "events": [] + }, + "stateName": "Normal", + "onEnter": { + "events": [ + { + "eventName": "init", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "0" + } + } + ], + "condition": "true" + } + ] + }, + "onExit": { + "events": [] + } + }, + { + "onInput": { + "transitionEvents": [ + { + "eventName": "BackToNormal", + "actions": [], + "condition": "$input.PressureInput.sensorData.pressure <= 70 && $variable.pressureThresholdBreached <= 1", + "nextState": "Normal" + } + ], + "events": [ + { + "eventName": "Overpressurized", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "3" + } + } + ], + "condition": "$input.PressureInput.sensorData.pressure > 70" + }, + { + "eventName": "Pressure Okay", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "$variable.pressureThresholdBreached - 1" + } + } + ], + "condition": "$input.PressureInput.sensorData.pressure <= 70" + } + ] + }, + "stateName": "Dangerous", + "onEnter": { + "events": [ + { + "eventName": "Pressure Threshold Breached", + "actions": [ + { + "sns": { + "targetArn": "arn:aws:sns:us-east-1:123456789012:underPressureAction" + } + } + ], + "condition": "$variable.pressureThresholdBreached > 1" + } + ] + }, + "onExit": { + "events": [ + { + "eventName": "Normal Pressure Restored", + "actions": [ + { + "sns": { + "targetArn": "arn:aws:sns:us-east-1:123456789012:pressureClearedAction" + } + } + ], + "condition": "true" + } + ] + } + } + ], + "initialStateName": "Normal" + } + } + } + +For more information, see `DescribeDetectorModel `__ in the *AWS IoT Events Developer Guide**. + diff -Nru awscli-1.11.13/awscli/examples/iotevents-data/describe-detector.rst awscli-1.18.69/awscli/examples/iotevents-data/describe-detector.rst --- awscli-1.11.13/awscli/examples/iotevents-data/describe-detector.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents-data/describe-detector.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,31 @@ +**To get information about a detector (instance)** + +The following ``describe-detector`` example returns information about the specified detector (instance). :: + + aws iotevents-data describe-detector \ + --detector-model-name motorDetectorModel \ + --key-value "Fulton-A32" + +Output:: + + { + "detector": { + "lastUpdateTime": 1560797852.776, + "creationTime": 1560797852.775, + "state": { + "variables": [ + { + "name": "pressureThresholdBreached", + "value": "3" + } + ], + "stateName": "Dangerous", + "timers": [] + }, + "keyValue": "Fulton-A32", + "detectorModelName": "motorDetectorModel", + "detectorModelVersion": "1" + } + } + +For more information, see `DescribeDetector `__ in the *AWS IoT Events Developer Guide**. diff -Nru awscli-1.11.13/awscli/examples/iotevents-data/describe-input.rst awscli-1.18.69/awscli/examples/iotevents-data/describe-input.rst --- awscli-1.11.13/awscli/examples/iotevents-data/describe-input.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents-data/describe-input.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,33 @@ +**To get information about an input** + +The following ``describe-input`` example retrieves the details of an input. :: + + aws iotevents describe-input \ + --input-name PressureInput + +Output:: + + { + "input": { + "inputConfiguration": { + "status": "ACTIVE", + "inputArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", + "lastUpdateTime": 1560795312.542, + "creationTime": 1560795312.542, + "inputName": "PressureInput", + "inputDescription": "Pressure readings from a motor" + }, + "inputDefinition": { + "attributes": [ + { + "jsonPath": "sensorData.pressure" + }, + { + "jsonPath": "motorid" + } + ] + } + } + } + +For more information, see `DescribeInput `__ in the *AWS IoT Events Developer Guide**. diff -Nru awscli-1.11.13/awscli/examples/iotevents-data/describe-logging-options.rst awscli-1.18.69/awscli/examples/iotevents-data/describe-logging-options.rst --- awscli-1.11.13/awscli/examples/iotevents-data/describe-logging-options.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents-data/describe-logging-options.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,17 @@ +**To get information about logging settings** + +The following ``describe-logging-options`` example retrieves the current AWS IoT Events logging options. :: + + aws iotevents describe-logging-options + +Output:: + + { + "loggingOptions": { + "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", + "enabled": false, + "level": "ERROR" + } + } + +For more information, see `DescribeLoggingOptions `__ in the *AWS IoT Events Developer Guide**. diff -Nru awscli-1.11.13/awscli/examples/iotevents-data/list-detector-models.rst awscli-1.18.69/awscli/examples/iotevents-data/list-detector-models.rst --- awscli-1.11.13/awscli/examples/iotevents-data/list-detector-models.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents-data/list-detector-models.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,20 @@ +**To get a list of your detector models** + +The following ``list-detector-models`` example lists the detector models you have created. Only the metadata associated with each detector model is returned. :: + + aws iotevents list-detector-models + +Output:: + + { + "detectorModelSummaries": [ + { + "detectorModelName": "motorDetectorModel", + "creationTime": 1552072424.212 + "detectorModelDescription": "Detect overpressure in a motor." + } + ] + } + +For more information, see `ListDetectorModels `__ in the *AWS IoT Events Developer Guide**. + diff -Nru awscli-1.11.13/awscli/examples/iotevents-data/list-detector-model-versions.rst awscli-1.18.69/awscli/examples/iotevents-data/list-detector-model-versions.rst --- awscli-1.11.13/awscli/examples/iotevents-data/list-detector-model-versions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents-data/list-detector-model-versions.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,24 @@ +**To get information about versions of a detector model** + +The following ``list-detector-model-versions`` example lists all the versions of a detector model. Only the metadata associated with each detector model version is returned. :: + + aws iotevents list-detector-model-versions \ + --detector-model-name motorDetectorModel + +Output:: + + { + "detectorModelVersionSummaries": [ + { + "status": "ACTIVE", + "lastUpdateTime": 1560796816.077, + "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", + "creationTime": 1560796816.077, + "detectorModelArn": "arn:aws:iotevents:us-west-2:123456789012:detectorModel/motorDetectorModel", + "detectorModelName": "motorDetectorModel", + "detectorModelVersion": "1" + } + ] + } + +For more information, see `ListDetectorModelVersions `__ in the *AWS IoT Events Developer Guide**. diff -Nru awscli-1.11.13/awscli/examples/iotevents-data/list-detectors.rst awscli-1.18.69/awscli/examples/iotevents-data/list-detectors.rst --- awscli-1.11.13/awscli/examples/iotevents-data/list-detectors.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents-data/list-detectors.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,26 @@ +**To get a list of detectors for a detector model** + +The following ``list-detectors`` example lists detectors (the instances of a detector model). :: + + aws iotevents-data list-detectors \ + --detector-model-name motorDetectorModel + +Output:: + + { + "detectorSummaries": [ + { + "lastUpdateTime": 1558129925.2, + "creationTime": 1552073155.527, + "state": { + "stateName": "Normal" + }, + "keyValue": "Fulton-A32", + "detectorModelName": "motorDetectorModel", + "detectorModelVersion": "1" + } + ] + } + +For more information, see `ListDetectors `__ in the *AWS IoT Events Developer Guide**. + diff -Nru awscli-1.11.13/awscli/examples/iotevents-data/list-inputs.rst awscli-1.18.69/awscli/examples/iotevents-data/list-inputs.rst --- awscli-1.11.13/awscli/examples/iotevents-data/list-inputs.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents-data/list-inputs.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,19 @@ +**To list inputs** + +The following ``list-inputs`` example lists the inputs that you've created. :: + + aws iotevents list-inputs + +Output:: + + { + "status": "ACTIVE", + "inputArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", + "lastUpdateTime": 1551742986.768, + "creationTime": 1551742986.768, + "inputName": "PressureInput", + "inputDescription": "Pressure readings from a motor" + } + +For more information, see `ListInputs `__ in the *AWS IoT Events Developer Guide**. + diff -Nru awscli-1.11.13/awscli/examples/iotevents-data/list-tags-for-resource.rst awscli-1.18.69/awscli/examples/iotevents-data/list-tags-for-resource.rst --- awscli-1.11.13/awscli/examples/iotevents-data/list-tags-for-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents-data/list-tags-for-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,20 @@ +**To list tags assigned to a resource** + +The following ``list-tags-for-resource`` example lists the tags (metadata) you have assigned to the resource. :: + + aws iotevents list-tags-for-resource \ + --resource-arn "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput" + +Output:: + + { + "tags": [ + { + "value": "motor", + "key": "deviceType" + } + ] + } + +For more information, see `ListTagsForResource `__ in the *AWS IoT Events Developer Guide**. + diff -Nru awscli-1.11.13/awscli/examples/iotevents-data/put-logging-options.rst awscli-1.18.69/awscli/examples/iotevents-data/put-logging-options.rst --- awscli-1.11.13/awscli/examples/iotevents-data/put-logging-options.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents-data/put-logging-options.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,27 @@ +**To set logging options** + +The following ``list-tags-for-resource`` example sets or updates the AWS IoT Events logging options. If you update the value of any ``loggingOptions`` field, it takes up to one minute for the change to take effect. Also, if you change the policy attached to the role you specified in the ``roleArn`` field (for example, to correct an invalid policy) it takes up to five minutes for that change to take effect. :: + + aws iotevents put-logging-options \ + --cli-input-json file://logging-options.json + +Contents of ``logging-options.json``:: + + { + "loggingOptions": { + "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", + "level": "DEBUG", + "enabled": true, + "detectorDebugOptions": [ + { + "detectorModelName": "motorDetectorModel", + "keyValue": "Fulton-A32" + } + ] + } + } + +This command produces no output. + +For more information, see `PutLoggingOptions `__ in the *AWS IoT Events Developer Guide**. + diff -Nru awscli-1.11.13/awscli/examples/iotevents-data/tag-resource.rst awscli-1.18.69/awscli/examples/iotevents-data/tag-resource.rst --- awscli-1.11.13/awscli/examples/iotevents-data/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents-data/tag-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,24 @@ +**To add tags to a resource** + +The following ``tag-resource`` example adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource. :: + + aws iotevents tag-resource \ + --cli-input-json file://pressureInput.tag.json + + +Contents of ``pressureInput.tag.json``:: + + { + "resourceArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", + "tags": [ + { + "key": "deviceType", + "value": "motor" + } + ] + } + +This command produces no output. + +For more information, see `TagResource `__ in the *AWS IoT Events Developer Guide**. + diff -Nru awscli-1.11.13/awscli/examples/iotevents-data/untag-resource.rst awscli-1.18.69/awscli/examples/iotevents-data/untag-resource.rst --- awscli-1.11.13/awscli/examples/iotevents-data/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents-data/untag-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,21 @@ +**To remove tags from a resource** + +The following ``untag-resource`` example removes the specified tags from the resource. :: + + aws iotevents untag-resource \ + --cli-input-json file://pressureInput.untag.json + + +Contents of ``pressureInput.untag.json``:: + + { + "resourceArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", + "tagKeys": [ + "deviceType" + ] + } + +This command produces no output. + +For more information, see `UntagResource `__ in the *AWS IoT Events Developer Guide**. + diff -Nru awscli-1.11.13/awscli/examples/iotevents-data/update-detector-model.rst awscli-1.18.69/awscli/examples/iotevents-data/update-detector-model.rst --- awscli-1.11.13/awscli/examples/iotevents-data/update-detector-model.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents-data/update-detector-model.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,140 @@ +**To update a detector model** + +The following ``update-detector-model`` example updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive. :: + + aws iotevents update-detector-model \ + --cli-input-json file://motorDetectorModel.update.json + +Contents of motorDetectorModel.update.json:: + + { + "detectorModelName": "motorDetectorModel", + "detectorModelDefinition": { + "states": [ + { + "stateName": "Normal", + "onEnter": { + "events": [ + { + "eventName": "init", + "condition": "true", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "0" + } + } + ] + } + ] + }, + "onInput": { + "transitionEvents": [ + { + "eventName": "Overpressurized", + "condition": "$input.PressureInput.sensorData.pressure > 70", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "$variable.pressureThresholdBreached + 3" + } + } + ], + "nextState": "Dangerous" + } + ] + } + }, + { + "stateName": "Dangerous", + "onEnter": { + "events": [ + { + "eventName": "Pressure Threshold Breached", + "condition": "$variable.pressureThresholdBreached > 1", + "actions": [ + { + "sns": { + "targetArn": "arn:aws:sns:us-east-1:123456789012:underPressureAction" + } + } + ] + } + ] + }, + "onInput": { + "events": [ + { + "eventName": "Overpressurized", + "condition": "$input.PressureInput.sensorData.pressure > 70", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "3" + } + } + ] + }, + { + "eventName": "Pressure Okay", + "condition": "$input.PressureInput.sensorData.pressure <= 70", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "$variable.pressureThresholdBreached - 1" + } + } + ] + } + ], + "transitionEvents": [ + { + "eventName": "BackToNormal", + "condition": "$input.PressureInput.sensorData.pressure <= 70 && $variable.pressureThresholdBreached <= 1", + "nextState": "Normal" + } + ] + }, + "onExit": { + "events": [ + { + "eventName": "Normal Pressure Restored", + "condition": "true", + "actions": [ + { + "sns": { + "targetArn": "arn:aws:sns:us-east-1:123456789012:pressureClearedAction" + } + } + ] + } + ] + } + } + ], + "initialStateName": "Normal" + }, + "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole" + } + +Output:: + + { + "detectorModelConfiguration": { + "status": "ACTIVATING", + "lastUpdateTime": 1560799387.719, + "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", + "creationTime": 1560799387.719, + "detectorModelArn": "arn:aws:iotevents:us-west-2:123456789012:detectorModel/motorDetectorModel", + "key": "motorid", + "detectorModelName": "motorDetectorModel", + "detectorModelVersion": "2" + } + } + +For more information, see `UpdateDetectorModel `__ in the *AWS IoT Events Developer Guide**. + diff -Nru awscli-1.11.13/awscli/examples/iotevents-data/update-input.rst awscli-1.18.69/awscli/examples/iotevents-data/update-input.rst --- awscli-1.11.13/awscli/examples/iotevents-data/update-input.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotevents-data/update-input.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,35 @@ +**To update an input** + +The following ``update-input`` example updates an input. :: + + aws iotevents update-input \ + --cli-input-json file://pressureInput.json + +Contents of ``pressureInput.json``:: + + { + "inputName": "PressureInput", + "inputDescription": "Pressure readings from a motor", + "inputDefinition": { + "attributes": [ + { "jsonPath": "sensorData.pressure" }, + { "jsonPath": "motorid" } + ] + } + } + +Output:: + + { + "inputConfiguration": { + "status": "ACTIVE", + "inputArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", + "lastUpdateTime": 1560795976.458, + "creationTime": 1560795312.542, + "inputName": "PressureInput", + "inputDescription": "Pressure readings from a motor" + } + } + +For more information, see `UpdateInput `__ in the *AWS IoT Events Developer Guide**. + diff -Nru awscli-1.11.13/awscli/examples/iot-jobs-data/describe-job-execution.rst awscli-1.18.69/awscli/examples/iot-jobs-data/describe-job-execution.rst --- awscli-1.11.13/awscli/examples/iot-jobs-data/describe-job-execution.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot-jobs-data/describe-job-execution.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,24 @@ +**To get the details of a job execution** + +The following ``describe-job-execution`` example retrieves the details of the latest execution of the specified job and thing. :: + + aws iot-jobs-data describe-job-execution \ + --job-id SampleJob \ + --thing-name MotionSensor1 + +Output:: + + { + "execution": { + "approximateSecondsBeforeTimedOut": 88, + "executionNumber": 2939653338, + "jobId": "SampleJob", + "lastUpdatedAt": 1567701875.743, + "queuedAt": 1567701902.444, + "status": "QUEUED", + "thingName": "MotionSensor1 ", + "versionNumber": 3 + } + } + +For more information, see `Devices and Jobs `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot-jobs-data/get-pending-job-executions.rst awscli-1.18.69/awscli/examples/iot-jobs-data/get-pending-job-executions.rst --- awscli-1.11.13/awscli/examples/iot-jobs-data/get-pending-job-executions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot-jobs-data/get-pending-job-executions.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,24 @@ +**To get a list of all jobs that are not in a terminal status for a thing** + +The following ``get-pending-job-executions`` example displays a list of all jobs that aren't in a terminal state for the specified thing. :: + + aws iot-jobs-data get-pending-job-executions \ + --thing-name MotionSensor1 + +Output:: + + { + "inProgressJobs": [ + ], + "queuedJobs": [ + { + "executionNumber": 2939653338, + "jobId": "SampleJob", + "lastUpdatedAt": 1567701875.743, + "queuedAt": 1567701902.444, + "versionNumber": 3 + } + ] + } + +For more information, see `Devices and Jobs `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot-jobs-data/start-next-pending-job-execution.rst awscli-1.18.69/awscli/examples/iot-jobs-data/start-next-pending-job-execution.rst --- awscli-1.11.13/awscli/examples/iot-jobs-data/start-next-pending-job-execution.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot-jobs-data/start-next-pending-job-execution.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,25 @@ +**To get and start the next pending job execution for a thing** + +The following ``start-next-pending-job-execution`` example retrieves and starts the next job execution whose status is `IN_PROGRESS` or `QUEUED` for the specified thing. :: + + aws iot-jobs-data start-next-pending-job-execution \ + --thing-name MotionSensor1 + +This command produces no output. +Output:: + + { + "execution": { + "approximateSecondsBeforeTimedOut": 88, + "executionNumber": 2939653338, + "jobId": "SampleJob", + "lastUpdatedAt": 1567714853.743, + "queuedAt": 1567701902.444, + "startedAt": 1567714871.690, + "status": "IN_PROGRESS", + "thingName": "MotionSensor1 ", + "versionNumber": 3 + } + } + +For more information, see `Devices and Jobs `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iot-jobs-data/update-job-execution.rst awscli-1.18.69/awscli/examples/iot-jobs-data/update-job-execution.rst --- awscli-1.11.13/awscli/examples/iot-jobs-data/update-job-execution.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iot-jobs-data/update-job-execution.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,20 @@ +**To update the status of a job execution** + +The following ``update-job-execution`` example updates the status of the specified job and thing. :: + + aws iot-jobs-data update-job-execution \ + --job-id SampleJob \ + --thing-name MotionSensor1 \ + --status REMOVED + +This command produces no output. +Output:: + + { + "executionState": { + "status": "REMOVED", + "versionNumber": 3 + }, + } + +For more information, see `Devices and Jobs `__ in the *AWS IoT Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/associate-assets.rst awscli-1.18.69/awscli/examples/iotsitewise/associate-assets.rst --- awscli-1.11.13/awscli/examples/iotsitewise/associate-assets.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/associate-assets.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,12 @@ +**To associate a child asset to a parent asset** + +The following ``associate-assets`` example associates a wind turbine asset to a wind farm asset, where the wind turbine asset model exists as a hierarchy in the wind farm asset model. :: + + aws iotsitewise associate-assets \ + --asset-id a1b2c3d4-5678-90ab-cdef-44444EXAMPLE \ + --hierarchy-id a1b2c3d4-5678-90ab-cdef-77777EXAMPLE \ + --child-asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE + +This command produces no output. + +For more information, see `Associating assets `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/batch-associate-project-assets.rst awscli-1.18.69/awscli/examples/iotsitewise/batch-associate-project-assets.rst --- awscli-1.11.13/awscli/examples/iotsitewise/batch-associate-project-assets.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/batch-associate-project-assets.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,11 @@ +**To associate an asset to a project** + +The following ``batch-associate-project-assets`` example associates a wind farm asset to a project. :: + + aws iotsitewise batch-associate-project-assets \ + --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE \ + --asset-ids a1b2c3d4-5678-90ab-cdef-44444EXAMPLE + +This command produces no output. + +For more information, see `Adding assets to projects `__ in the *AWS IoT SiteWise Monitor Application Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/batch-disassociate-project-assets.rst awscli-1.18.69/awscli/examples/iotsitewise/batch-disassociate-project-assets.rst --- awscli-1.11.13/awscli/examples/iotsitewise/batch-disassociate-project-assets.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/batch-disassociate-project-assets.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,11 @@ +**To disassociate an asset from a project** + +The following ``batch-disassociate-project-assets`` example disassociates a wind farm asset from a project. :: + + aws iotsitewise batch-disassociate-project-assets \ + --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE \ + --asset-ids a1b2c3d4-5678-90ab-cdef-44444EXAMPLE + +This command produces no output. + +For more information, see `Adding assets to projects `__ in the *AWS IoT SiteWise Monitor Application Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/batch-put-asset-property-value.rst awscli-1.18.69/awscli/examples/iotsitewise/batch-put-asset-property-value.rst --- awscli-1.11.13/awscli/examples/iotsitewise/batch-put-asset-property-value.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/batch-put-asset-property-value.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,50 @@ +**To send data to asset properties** + +The following ``batch-put-asset-property-value`` example sends power and temperature data to the asset properties identified by property aliases. :: + + aws iotsitewise batch-put-asset-property-value \ + --cli-input-json file://batch-put-asset-property-value.json + +Contents of ``batch-put-asset-property-value.json``:: + + { + "entries": [ + { + "entryId": "1575691200./company/windfarm/3/turbine/7/power", + "propertyAlias": "/company/windfarm/3/turbine/7/power", + "propertyValues": [ + { + "value": { + "doubleValue": 4.92 + }, + "timestamp": { + "timeInSeconds": 1575691200 + }, + "quality": "GOOD" + } + ] + }, + { + "entryId": "1575691200./company/windfarm/3/turbine/7/temperature", + "propertyAlias": "/company/windfarm/3/turbine/7/temperature", + "propertyValues": [ + { + "value": { + "integerValue": 38 + }, + "timestamp": { + "timeInSeconds": 1575691200 + } + } + ] + } + ] + } + +Output:: + + { + "errorEntries": [] + } + +For more information, see `Ingesting data using the AWS IoT SiteWise API `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/create-access-policy.rst awscli-1.18.69/awscli/examples/iotsitewise/create-access-policy.rst --- awscli-1.11.13/awscli/examples/iotsitewise/create-access-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/create-access-policy.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,63 @@ +**Example 1: To grant a user administrative access to a portal** + +The following ``create-access-policy`` example creates an access policy that grants a user administrative access to a web portal for a wind farm company. :: + + aws iotsitewise create-access-policy \ + --cli-input-json file://create-portal-administrator-access-policy.json + +Contents of ``create-portal-administrator-access-policy.json``:: + + { + "accessPolicyIdentity": { + "user": { + "id": "a1b2c3d4e5-a1b2c3d4-5678-90ab-cdef-bbbbbEXAMPLE" + } + }, + "accessPolicyPermission": "ADMINISTRATOR", + "accessPolicyResource": { + "portal": { + "id": "a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE" + } + } + } + +Output:: + + { + "accessPolicyId": "a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE", + "accessPolicyArn": "arn:aws:iotsitewise:us-west-2:123456789012:access-policy/a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE" + } + +For more information, see `Adding or removing portal administrators `__ in the *AWS IoT SiteWise User Guide*. + +**Example 2: To grant a user read-only access to a project** + +The following ``create-access-policy`` example creates an access policy that grants a user read-only access to a wind farm project. :: + + aws iotsitewise create-access-policy \ + --cli-input-json file://create-project-viewer-access-policy.json + +Contents of ``create-project-viewer-access-policy.json``:: + + { + "accessPolicyIdentity": { + "user": { + "id": "a1b2c3d4e5-a1b2c3d4-5678-90ab-cdef-bbbbbEXAMPLE" + } + }, + "accessPolicyPermission": "VIEWER", + "accessPolicyResource": { + "project": { + "id": "a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE" + } + } + } + +Output:: + + { + "accessPolicyId": "a1b2c3d4-5678-90ab-cdef-dddddEXAMPLE", + "accessPolicyArn": "arn:aws:iotsitewise:us-west-2:123456789012:access-policy/a1b2c3d4-5678-90ab-cdef-dddddEXAMPLE" + } + +For more information, see `Assigning project viewers `__ in the *AWS IoT SiteWise Monitor Application Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/create-asset-model.rst awscli-1.18.69/awscli/examples/iotsitewise/create-asset-model.rst --- awscli-1.11.13/awscli/examples/iotsitewise/create-asset-model.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/create-asset-model.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,98 @@ +**To create an asset model** + +The following ``create-asset-model`` example creates an asset model that defines a wind turbine with the following properties: + +- Serial number - The serial number of a wind turbine +- Generated power - The generated power data stream from a wind turbine +- Temperature C - The temperature data stream from a wind turbine in Celsius +- Temperature F - The mapped temperature data points from Celsius to Fahrenheit + +:: + + aws iotsitewise create-asset-model \ + --cli-input-json file://create-wind-turbine-model.json + +Contents of ``create-wind-turbine-model.json``:: + + { + "assetModelName": "Wind Turbine Model", + "assetModelDescription": "Represents a wind turbine", + "assetModelProperties": [ + { + "name": "Serial Number", + "dataType": "STRING", + "type": { + "attribute": {} + } + }, + { + "name": "Generated Power", + "dataType": "DOUBLE", + "unit": "kW", + "type": { + "measurement": {} + } + }, + { + "name": "Temperature C", + "dataType": "DOUBLE", + "unit": "Celsius", + "type": { + "measurement": {} + } + }, + { + "name": "Temperature F", + "dataType": "DOUBLE", + "unit": "Fahrenheit", + "type": { + "transform": { + "expression": "temp_c * 9 / 5 + 32", + "variables": [ + { + "name": "temp_c", + "value": { + "propertyId": "Temperature C" + } + } + ] + } + } + }, + { + "name": "Total Generated Power", + "dataType": "DOUBLE", + "unit": "kW", + "type": { + "metric": { + "expression": "sum(power)", + "variables": [ + { + "name": "power", + "value": { + "propertyId": "Generated Power" + } + } + ], + "window": { + "tumbling": { + "interval": "1h" + } + } + } + } + } + ] + } + +Output:: + + { + "assetModelId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "assetModelArn": "arn:aws:iotsitewise:us-west-2:123456789012:asset-model/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "assetModelStatus": { + "state": "CREATING" + } + } + +For more information, see `Defining asset models `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/create-asset.rst awscli-1.18.69/awscli/examples/iotsitewise/create-asset.rst --- awscli-1.11.13/awscli/examples/iotsitewise/create-asset.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/create-asset.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,19 @@ +**To create an asset** + +The following ``create-asset`` example creates a wind turbine asset from a wind turbine asset model. :: + + aws iotsitewise create-asset \ + --asset-model-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ + --asset-name "Wind Turbine 1" + +Output:: + + { + "assetId": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE", + "assetArn": "arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE", + "assetStatus": { + "state": "CREATING" + } + } + +For more information, see `Creating assets `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/create-dashboard.rst awscli-1.18.69/awscli/examples/iotsitewise/create-dashboard.rst --- awscli-1.11.13/awscli/examples/iotsitewise/create-dashboard.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/create-dashboard.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,40 @@ +**To create a dashboard** + +The following ``create-dashboard`` example creates a dashboard with a line chart that displays total generated power for a wind farm. :: + + aws iotsitewise create-dashboard \ + --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE \ + --dashboard-name "Wind Farm" \ + --dashboard-definition file://create-wind-farm-dashboard.json + +Contents of ``create-wind-farm-dashboard.json``:: + + { + "widgets": [ + { + "type": "monitor-line-chart", + "title": "Generated Power", + "x": 0, + "y": 0, + "height": 3, + "width": 3, + "metrics": [ + { + "label": "Power", + "type": "iotsitewise", + "assetId": "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE", + "propertyId": "a1b2c3d4-5678-90ab-cdef-99999EXAMPLE" + } + ] + } + ] + } + +Output:: + + { + "dashboardId": "a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE", + "dashboardArn": "arn:aws:iotsitewise:us-west-2:123456789012:dashboard/a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE" + } + +For more information, see `Creating dashboards (CLI) `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/create-gateway.rst awscli-1.18.69/awscli/examples/iotsitewise/create-gateway.rst --- awscli-1.11.13/awscli/examples/iotsitewise/create-gateway.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/create-gateway.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,16 @@ +**To create a gateway** + +The following ``create-gateway`` example creates a gateway that runs on AWS IoT Greengrass. :: + + aws iotsitewise create-gateway \ + --gateway-name ExampleCorpGateway \ + --gateway-platform greengrass={groupArn=arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/a1b2c3d4-5678-90ab-cdef-1b1b1EXAMPLE} + +Output:: + + { + "gatewayId": "a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE", + "gatewayArn": "arn:aws:iotsitewise:us-west-2:123456789012:gateway/a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE" + } + +For more information, see `Configuring a gateway `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/create-portal.rst awscli-1.18.69/awscli/examples/iotsitewise/create-portal.rst --- awscli-1.11.13/awscli/examples/iotsitewise/create-portal.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/create-portal.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,23 @@ +**To create a portal** + +The following ``create-portal`` example creates a web portal for a wind farm company. You can create portals only in the same Region where you enabled AWS Single Sign-On. :: + + aws iotsitewise create-portal \ + --portal-name WindFarmPortal \ + --portal-description "A portal that contains wind farm projects for Example Corp." \ + --portal-contact-email support@example.com \ + --role-arn arn:aws:iam::123456789012:role/service-role/MySiteWiseMonitorServiceRole + +Output:: + + { + "portalId": "a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE", + "portalArn": "arn:aws:iotsitewise:us-west-2:123456789012:portal/a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE", + "portalStartUrl": "https://a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE.app.iotsitewise.aws", + "portalStatus": { + "state": "CREATING" + }, + "ssoApplicationId": "ins-a1b2c3d4-EXAMPLE" + } + +For more information, see `Getting started with AWS IoT SiteWise Monitor `__ in the *AWS IoT SiteWise User Guide* and `Enabling AWS SSO `__ in the *AWS IoT SiteWise User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/create-project.rst awscli-1.18.69/awscli/examples/iotsitewise/create-project.rst --- awscli-1.11.13/awscli/examples/iotsitewise/create-project.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/create-project.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,17 @@ +**To create a project** + +The following ``create-project`` example creates a wind farm project. :: + + aws iotsitewise create-project \ + --portal-id a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE \ + --project-name "Wind Farm 1" \ + --project-description "Contains asset visualizations for Wind Farm #1 for Example Corp." + +Output:: + + { + "projectId": "a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE", + "projectArn": "arn:aws:iotsitewise:us-west-2:123456789012:project/a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE" + } + +For more information, see `Creating projects `__ in the *AWS IoT SiteWise Monitor Application Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/delete-access-policy.rst awscli-1.18.69/awscli/examples/iotsitewise/delete-access-policy.rst --- awscli-1.11.13/awscli/examples/iotsitewise/delete-access-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/delete-access-policy.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,10 @@ +**To revoke a user's access to a project or portal** + +The following ``delete-access-policy`` example deletes an access policy that grants a user administrative access to a portal. :: + + aws iotsitewise delete-access-policy \ + --access-policy-id a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE + +This command produces no output. + +For more information, see `Adding or removing portal administrators `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/delete-asset-model.rst awscli-1.18.69/awscli/examples/iotsitewise/delete-asset-model.rst --- awscli-1.11.13/awscli/examples/iotsitewise/delete-asset-model.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/delete-asset-model.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,16 @@ +**To delete an asset model** + +The following ``delete-asset-model`` example deletes a wind turbine asset model. :: + + aws iotsitewise delete-asset-model \ + --asset-model-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE + +Output:: + + { + "assetModelStatus": { + "state": "DELETING" + } + } + +For more information, see `Deleting asset models `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/delete-asset.rst awscli-1.18.69/awscli/examples/iotsitewise/delete-asset.rst --- awscli-1.11.13/awscli/examples/iotsitewise/delete-asset.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/delete-asset.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,16 @@ +**To delete an asset** + +The following ``delete-asset`` example deletes a wind turbine asset. :: + + aws iotsitewise delete-asset \ + --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE + +Output:: + + { + "assetStatus": { + "state": "DELETING" + } + } + +For more information, see `Deleting assets `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/delete-dashboard.rst awscli-1.18.69/awscli/examples/iotsitewise/delete-dashboard.rst --- awscli-1.11.13/awscli/examples/iotsitewise/delete-dashboard.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/delete-dashboard.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a dashboard** + +The following ``delete-dashboard`` example deletes a wind turbine dashboard. :: + + aws iotsitewise delete-dashboard \ + --dashboard-id a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE + +This command produces no output. + +For more information, see `Deleting dashboards `__ in the *AWS IoT SiteWise Monitor Application Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/delete-gateway.rst awscli-1.18.69/awscli/examples/iotsitewise/delete-gateway.rst --- awscli-1.11.13/awscli/examples/iotsitewise/delete-gateway.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/delete-gateway.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a gateway** + +The following ``delete-gateway`` example deletes a gateway. :: + + aws iotsitewise delete-gateway \ + --gateway-id a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE + +This command produces no output. + +For more information, see `Ingesting data using a gateway `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/delete-portal.rst awscli-1.18.69/awscli/examples/iotsitewise/delete-portal.rst --- awscli-1.11.13/awscli/examples/iotsitewise/delete-portal.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/delete-portal.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,16 @@ +**To delete a portal** + +The following ``delete-portal`` example deletes a web portal for a wind farm company. :: + + aws iotsitewise delete-portal \ + --portal-id a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE + +Output:: + + { + "portalStatus": { + "state": "DELETING" + } + } + +For more information, see `Deleting a portal `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/delete-project.rst awscli-1.18.69/awscli/examples/iotsitewise/delete-project.rst --- awscli-1.11.13/awscli/examples/iotsitewise/delete-project.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/delete-project.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a project** + +The following ``delete-project`` example deletes a wind farm project. :: + + aws iotsitewise delete-project \ + --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE + +This command produces no output. + +For more information, see `Deleting projects `__ in the *AWS IoT SiteWise Monitor Application Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/describe-access-policy.rst awscli-1.18.69/awscli/examples/iotsitewise/describe-access-policy.rst --- awscli-1.11.13/awscli/examples/iotsitewise/describe-access-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/describe-access-policy.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,28 @@ +**To describe an access policy** + +The following ``describe-access-policy`` example describes an access policy that grants a user administrative access to a web portal for a wind farm company. :: + + aws iotsitewise describe-access-policy \ + --access-policy-id a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE + +Output:: + + { + "accessPolicyId": "a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE", + "accessPolicyArn": "arn:aws:iotsitewise:us-west-2:123456789012:access-policy/a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE", + "accessPolicyIdentity": { + "user": { + "id": "a1b2c3d4e5-a1b2c3d4-5678-90ab-cdef-bbbbbEXAMPLE" + } + }, + "accessPolicyResource": { + "portal": { + "id": "a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE" + } + }, + "accessPolicyPermission": "ADMINISTRATOR", + "accessPolicyCreationDate": "2020-02-20T22:35:15.552880124Z", + "accessPolicyLastUpdateDate": "2020-02-20T22:35:15.552880124Z" + } + +For more information, see `Adding or removing portal administrators `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/describe-asset-model.rst awscli-1.18.69/awscli/examples/iotsitewise/describe-asset-model.rst --- awscli-1.11.13/awscli/examples/iotsitewise/describe-asset-model.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/describe-asset-model.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,66 @@ +**To describe an asset model** + +The following ``describe-asset-model`` example describes a wind farm asset model. :: + + aws iotsitewise describe-asset-model \ + --asset-model-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE + +Output:: + + { + "assetModelId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", + "assetModelArn": "arn:aws:iotsitewise:us-west-2:123456789012:asset-model/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", + "assetModelName": "Wind Farm Model", + "assetModelDescription": "Represents a wind farm that comprises many wind turbines", + "assetModelProperties": [ + { + "id": "a1b2c3d4-5678-90ab-cdef-99999EXAMPLE", + "name": "Total Generated Power", + "dataType": "DOUBLE", + "unit": "kW", + "type": { + "metric": { + "expression": "sum(power)", + "variables": [ + { + "name": "power", + "value": { + "propertyId": "a1b2c3d4-5678-90ab-cdef-66666EXAMPLE", + "hierarchyId": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE" + } + } + ], + "window": { + "tumbling": { + "interval": "1h" + } + } + } + } + }, + { + "id": "a1b2c3d4-5678-90ab-cdef-88888EXAMPLE", + "name": "Region", + "dataType": "STRING", + "type": { + "attribute": { + "defaultValue": " " + } + } + } + ], + "assetModelHierarchies": [ + { + "id": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE", + "name": "Wind Turbines", + "childAssetModelId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" + } + ], + "assetModelCreationDate": 1575671284.0, + "assetModelLastUpdateDate": 1575671988.0, + "assetModelStatus": { + "state": "ACTIVE" + } + } + +For more information, see `Describing a specific asset model `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/describe-asset-property.rst awscli-1.18.69/awscli/examples/iotsitewise/describe-asset-property.rst --- awscli-1.11.13/awscli/examples/iotsitewise/describe-asset-property.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/describe-asset-property.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,46 @@ +**To describe an asset property** + +The following ``describe-asset-property`` example describes a wind farm asset's total generated power property. :: + + aws iotsitewise describe-asset-property \ + --asset-id a1b2c3d4-5678-90ab-cdef-44444EXAMPLE \ + --property-id a1b2c3d4-5678-90ab-cdef-99999EXAMPLE + +Output:: + + { + "assetId": "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE", + "assetName": "Wind Farm 1", + "assetModelId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", + "assetProperty": { + "id": "a1b2c3d4-5678-90ab-cdef-99999EXAMPLE", + "name": "Total Generated Power", + "notification": { + "topic": "$aws/sitewise/asset-models/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE/assets/a1b2c3d4-5678-90ab-cdef-44444EXAMPLE/properties/a1b2c3d4-5678-90ab-cdef-99999EXAMPLE", + "state": "DISABLED" + }, + "dataType": "DOUBLE", + "unit": "kW", + "type": { + "metric": { + "expression": "sum(power)", + "variables": [ + { + "name": "power", + "value": { + "propertyId": "a1b2c3d4-5678-90ab-cdef-66666EXAMPLE", + "hierarchyId": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE" + } + } + ], + "window": { + "tumbling": { + "interval": "1h" + } + } + } + } + } + } + +For more information, see `Describing a specific asset property `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/describe-asset.rst awscli-1.18.69/awscli/examples/iotsitewise/describe-asset.rst --- awscli-1.11.13/awscli/examples/iotsitewise/describe-asset.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/describe-asset.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,41 @@ +**To describe an asset** + +The following ``describe-asset`` example describes a wind farm asset. :: + + aws iotsitewise describe-asset \ + --asset-id a1b2c3d4-5678-90ab-cdef-44444EXAMPLE + +Output:: + + { + "assetId": "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE", + "assetArn": "arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-44444EXAMPLE", + "assetName": "Wind Farm 1", + "assetModelId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", + "assetProperties": [ + { + "id": "a1b2c3d4-5678-90ab-cdef-88888EXAMPLE", + "name": "Region", + "dataType": "STRING" + }, + { + "id": "a1b2c3d4-5678-90ab-cdef-99999EXAMPLE", + "name": "Total Generated Power", + "dataType": "DOUBLE", + "unit": "kW" + } + ], + "assetHierarchies": [ + { + "id": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE", + "name": "Wind Turbines" + } + ], + "assetCreationDate": 1575672453.0, + "assetLastUpdateDate": 1575672453.0, + "assetStatus": { + "state": "ACTIVE" + } + } + +For more information, see `Describing a specific asset `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/describe-dashboard.rst awscli-1.18.69/awscli/examples/iotsitewise/describe-dashboard.rst --- awscli-1.11.13/awscli/examples/iotsitewise/describe-dashboard.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/describe-dashboard.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,20 @@ +**To describe a dashboard** + +The following ``describe-dashboard`` example describes a wind farm dashboard. :: + + aws iotsitewise describe-dashboard \ + --dashboard-id a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE + +Output:: + + { + "dashboardId": "a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE", + "dashboardArn": "arn:aws:iotsitewise:us-west-2:123456789012:dashboard/a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE", + "dashboardName": "Wind Farm", + "projectId": "a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE", + "dashboardDefinition": "{\"widgets\":[{\"type\":\"monitor-line-chart\",\"title\":\"Generated Power\",\"x\":0,\"y\":0,\"height\":3,\"width\":3,\"metrics\":[{\"label\":\"Power\",\"type\":\"iotsitewise\",\"assetId\":\"a1b2c3d4-5678-90ab-cdef-44444EXAMPLE\",\"propertyId\":\"a1b2c3d4-5678-90ab-cdef-99999EXAMPLE\"}]}]}", + "dashboardCreationDate": "2020-05-01T20:32:12.228476348Z", + "dashboardLastUpdateDate": "2020-05-01T20:32:12.228476348Z" + } + +For more information, see `Viewing dashboards `__ in the *AWS IoT SiteWise Monitor Application Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/describe-gateway-capability-configuration.rst awscli-1.18.69/awscli/examples/iotsitewise/describe-gateway-capability-configuration.rst --- awscli-1.11.13/awscli/examples/iotsitewise/describe-gateway-capability-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/describe-gateway-capability-configuration.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,18 @@ +**To describe a gateway capability** + +The following ``describe-gateway-capability-configuration`` example describes an OPC-UA source capability. :: + + aws iotsitewise describe-gateway-capability-configuration \ + --gateway-id a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE \ + --capability-namespace "iotsitewise:opcuacollector:1" + +Output:: + + { + "gatewayId": "a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE", + "capabilityNamespace": "iotsitewise:opcuacollector:1", + "capabilityConfiguration": "{\"sources\":[{\"name\":\"Wind Farm #1\",\"endpoint\":{\"certificateTrust\":{\"type\":\"TrustAny\"},\"endpointUri\":\"opc.tcp://203.0.113.0:49320\",\"securityPolicy\":\"BASIC256\",\"messageSecurityMode\":\"SIGN_AND_ENCRYPT\",\"identityProvider\":{\"type\":\"Username\",\"usernameSecretArn\":\"arn:aws:secretsmanager:us-east-1:123456789012:secret:greengrass-factory1-auth-3QNDmM\"},\"nodeFilterRules\":[]},\"measurementDataStreamPrefix\":\"\"}]}", + "capabilitySyncStatus": "IN_SYNC" + } + +For more information, see `Configuring data sources `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/describe-gateway.rst awscli-1.18.69/awscli/examples/iotsitewise/describe-gateway.rst --- awscli-1.11.13/awscli/examples/iotsitewise/describe-gateway.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/describe-gateway.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,29 @@ +**To describe a gateway** + +The following ``describe-gateway`` example describes a gateway. :: + + aws iotsitewise describe-gateway \ + --gateway-id a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE + +Output:: + + { + "gatewayId": "a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE", + "gatewayName": "ExampleCorpGateway", + "gatewayArn": "arn:aws:iotsitewise:us-west-2:123456789012:gateway/a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE", + "gatewayPlatform": { + "greengrass": { + "groupArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/a1b2c3d4-5678-90ab-cdef-1b1b1EXAMPLE" + } + }, + "gatewayCapabilitySummaries": [ + { + "capabilityNamespace": "iotsitewise:opcuacollector:1", + "capabilitySyncStatus": "IN_SYNC" + } + ], + "creationDate": 1588369971.457, + "lastUpdateDate": 1588369971.457 + } + +For more information, see `Ingesting data using a gateway `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/describe-logging-options.rst awscli-1.18.69/awscli/examples/iotsitewise/describe-logging-options.rst --- awscli-1.11.13/awscli/examples/iotsitewise/describe-logging-options.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/describe-logging-options.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,15 @@ +**To retrieve the current AWS IoT SiteWise logging options** + +The following ``describe-logging-options`` example retrieves the current AWS IoT SiteWise logging options for your AWS account in the current Region. :: + + aws iotsitewise describe-logging-options + +Output:: + + { + "loggingOptions": { + "level": "INFO" + } + } + +For more information, see `Monitoring AWS IoT SiteWise with Amazon CloudWatch Logs `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/describe-portal.rst awscli-1.18.69/awscli/examples/iotsitewise/describe-portal.rst --- awscli-1.11.13/awscli/examples/iotsitewise/describe-portal.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/describe-portal.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,26 @@ +**To describe a portal** + +The following ``describe-portal`` example describes a web portal for a wind farm company. :: + + aws iotsitewise describe-portal \ + --portal-id a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE + +Output:: + + { + "portalId": "a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE", + "portalArn": "arn:aws:iotsitewise:us-west-2:123456789012:portal/a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE", + "portalName": "WindFarmPortal", + "portalDescription": "A portal that contains wind farm projects for Example Corp.", + "portalClientId": "E-a1b2c3d4e5f6_a1b2c3d4e5f6EXAMPLE", + "portalStartUrl": "https://a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE.app.iotsitewise.aws", + "portalContactEmail": "support@example.com", + "portalStatus": { + "state": "ACTIVE" + }, + "portalCreationDate": "2020-02-04T23:01:52.90248068Z", + "portalLastUpdateDate": "2020-02-04T23:01:52.90248078Z", + "roleArn": "arn:aws:iam::123456789012:role/MySiteWiseMonitorServiceRole" + } + +For more information, see `Administering your portals `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/describe-project.rst awscli-1.18.69/awscli/examples/iotsitewise/describe-project.rst --- awscli-1.11.13/awscli/examples/iotsitewise/describe-project.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/describe-project.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,20 @@ +**To describe a project** + +The following ``describe-project`` example describes a wind farm project. :: + + aws iotsitewise describe-project \ + --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE + +Output:: + + { + "projectId": "a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE", + "projectArn": "arn:aws:iotsitewise:us-west-2:123456789012:project/a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE", + "projectName": "Wind Farm 1", + "portalId": "a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE", + "projectDescription": "Contains asset visualizations for Wind Farm #1 for Example Corp.", + "projectCreationDate": "2020-02-20T21:58:43.362246001Z", + "projectLastUpdateDate": "2020-02-20T21:58:43.362246095Z" + } + +For more information, see `Viewing project details `__ in the *AWS IoT SiteWise Monitor Application Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/disassociate-assets.rst awscli-1.18.69/awscli/examples/iotsitewise/disassociate-assets.rst --- awscli-1.11.13/awscli/examples/iotsitewise/disassociate-assets.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/disassociate-assets.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,12 @@ +**To disassociate a child asset from a parent asset** + +The following ``disassociate-assets`` example disassociates a wind turbine asset from a wind farm asset. :: + + aws iotsitewise disassociate-assets \ + --asset-id a1b2c3d4-5678-90ab-cdef-44444EXAMPLE \ + --hierarchy-id a1b2c3d4-5678-90ab-cdef-77777EXAMPLE \ + --child-asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE + +This command produces no output. + +For more information, see `Associating assets `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/get-asset-property-aggregates.rst awscli-1.18.69/awscli/examples/iotsitewise/get-asset-property-aggregates.rst --- awscli-1.11.13/awscli/examples/iotsitewise/get-asset-property-aggregates.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/get-asset-property-aggregates.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,28 @@ +**To retrieve an asset property's aggregated average and count values** + +The following ``get-asset-property-aggregates`` example retrieves a wind turbine asset's average total power and count of total power data points for a 1 hour period in time. :: + + aws iotsitewise get-asset-property-aggregates \ + --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \ + --property-id a1b2c3d4-5678-90ab-cdef-66666EXAMPLE \ + --start-date 1580849400 \ + --end-date 1580853000 \ + --aggregate-types AVERAGE COUNT \ + --resolution 1h + +Output:: + + { + "aggregatedValues": [ + { + "timestamp": 1580850000.0, + "quality": "GOOD", + "value": { + "average": 8723.46538886233, + "count": 12.0 + } + } + ] + } + +For more information, see `Querying asset property aggregates `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/get-asset-property-value-history.rst awscli-1.18.69/awscli/examples/iotsitewise/get-asset-property-value-history.rst --- awscli-1.11.13/awscli/examples/iotsitewise/get-asset-property-value-history.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/get-asset-property-value-history.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,58 @@ +**To retrieve an asset property's historical values** + +The following ``get-asset-property-value-history`` example retrieves a wind turbine asset's total power values for a 20 minute period in time. :: + + aws iotsitewise get-asset-property-value-history \ + --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \ + --property-id a1b2c3d4-5678-90ab-cdef-66666EXAMPLE \ + --start-date 1580851800 \ + --end-date 1580853000 + +Output:: + + { + "assetPropertyValueHistory": [ + { + "value": { + "doubleValue": 7217.787046814844 + }, + "timestamp": { + "timeInSeconds": 1580852100, + "offsetInNanos": 0 + }, + "quality": "GOOD" + }, + { + "value": { + "doubleValue": 6941.242811875451 + }, + "timestamp": { + "timeInSeconds": 1580852400, + "offsetInNanos": 0 + }, + "quality": "GOOD" + }, + { + "value": { + "doubleValue": 6976.797662266717 + }, + "timestamp": { + "timeInSeconds": 1580852700, + "offsetInNanos": 0 + }, + "quality": "GOOD" + }, + { + "value": { + "doubleValue": 6890.8677520453875 + }, + "timestamp": { + "timeInSeconds": 1580853000, + "offsetInNanos": 0 + }, + "quality": "GOOD" + } + ] + } + +For more information, see `Querying historical asset property values `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/get-asset-property-value.rst awscli-1.18.69/awscli/examples/iotsitewise/get-asset-property-value.rst --- awscli-1.11.13/awscli/examples/iotsitewise/get-asset-property-value.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/get-asset-property-value.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,24 @@ +**To retrieve an asset property's current value** + +The following ``get-asset-property-value`` example retrieves a wind turbine asset's current total power. :: + + aws iotsitewise get-asset-property-value \ + --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \ + --property-id a1b2c3d4-5678-90ab-cdef-66666EXAMPLE + +Output:: + + { + "propertyValue": { + "value": { + "doubleValue": 6890.8677520453875 + }, + "timestamp": { + "timeInSeconds": 1580853000, + "offsetInNanos": 0 + }, + "quality": "GOOD" + } + } + +For more information, see `Querying current asset property values `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/list-access-policies.rst awscli-1.18.69/awscli/examples/iotsitewise/list-access-policies.rst --- awscli-1.11.13/awscli/examples/iotsitewise/list-access-policies.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/list-access-policies.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,30 @@ +**To list all access policies** + +The following ``list-access-policies`` example lists all access policies for a user who is a portal administrator. :: + + aws iotsitewise list-access-policies \ + --identity-type USER \ + --identity-id a1b2c3d4e5-a1b2c3d4-5678-90ab-cdef-bbbbbEXAMPLE + +Output:: + + { + "accessPolicySummaries": [ + { + "id": "a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE", + "identity": { + "user": { + "id": "a1b2c3d4e5-a1b2c3d4-5678-90ab-cdef-bbbbbEXAMPLE" + } + }, + "resource": { + "portal": { + "id": "a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE" + } + }, + "permission": "ADMINISTRATOR" + } + ] + } + +For more information, see `Administering your portals `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/list-asset-models.rst awscli-1.18.69/awscli/examples/iotsitewise/list-asset-models.rst --- awscli-1.11.13/awscli/examples/iotsitewise/list-asset-models.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/list-asset-models.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,36 @@ +**To list all asset models** + +The following ``list-asset-models`` example lists all asset models that are defined in your AWS account in the current Region. :: + + aws iotsitewise list-asset-models + +Output:: + + { + "assetModelSummaries": [ + { + "id": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", + "arn": "arn:aws:iotsitewise:us-west-2:123456789012:asset-model/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", + "name": "Wind Farm Model", + "description": "Represents a wind farm that comprises many wind turbines", + "creationDate": 1575671284.0, + "lastUpdateDate": 1575671988.0, + "status": { + "state": "ACTIVE" + } + }, + { + "id": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "arn": "arn:aws:iotsitewise:us-west-2:123456789012:asset-model/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "name": "Wind Turbine Model", + "description": "Represents a wind turbine manufactured by Example Corp", + "creationDate": 1575671207.0, + "lastUpdateDate": 1575686273.0, + "status": { + "state": "ACTIVE" + } + } + ] + } + +For more information, see `Listing all asset models `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/list-assets.rst awscli-1.18.69/awscli/examples/iotsitewise/list-assets.rst --- awscli-1.11.13/awscli/examples/iotsitewise/list-assets.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/list-assets.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,60 @@ +**Example 1: To list all top-level assets** + +The following ``list-assets`` example lists all assets that are top-level in the asset hierarchy tree and defined in your AWS account in the current Region. :: + + aws iotsitewise list-assets \ + --filter TOP_LEVEL + +Output:: + + { + "assetSummaries": [ + { + "id": "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE", + "arn": "arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-44444EXAMPLE", + "name": "Wind Farm 1", + "assetModelId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", + "creationDate": 1575672453.0, + "lastUpdateDate": 1575672453.0, + "status": { + "state": "ACTIVE" + }, + "hierarchies": [ + { + "id": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE", + "name": "Wind Turbines" + } + ] + } + ] + } + +For more information, see `Listing assets `__ in the *AWS IoT SiteWise User Guide*. + +**Example 2: To list all assets based on an asset model** + +The following ``list-assets`` example lists all assets that based on an asset model and defined in your AWS account in the current Region. :: + + aws iotsitewise list-assets \ + --asset-model-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE + +Output:: + + { + "assetSummaries": [ + { + "id": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE", + "arn": "arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE", + "name": "Wind Turbine 1", + "assetModelId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "creationDate": 1575671550.0, + "lastUpdateDate": 1575686308.0, + "status": { + "state": "ACTIVE" + }, + "hierarchies": [] + } + ] + } + +For more information, see `Listing assets `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/list-associated-assets.rst awscli-1.18.69/awscli/examples/iotsitewise/list-associated-assets.rst --- awscli-1.11.13/awscli/examples/iotsitewise/list-associated-assets.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/list-associated-assets.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,28 @@ +**To list all assets associated to an asset in a specific hierarchy** + +The following ``list-associated-assets`` example lists all wind turbine assets associated to a wind farm asset. :: + + aws iotsitewise list-associated-assets \ + --asset-id a1b2c3d4-5678-90ab-cdef-44444EXAMPLE \ + --hierarchy-id a1b2c3d4-5678-90ab-cdef-77777EXAMPLE + +Output:: + + { + "assetSummaries": [ + { + "id": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE", + "arn": "arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE", + "name": "Wind Turbine 1", + "assetModelId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "creationDate": 1575671550.0, + "lastUpdateDate": 1575686308.0, + "status": { + "state": "ACTIVE" + }, + "hierarchies": [] + } + ] + } + +For more information, see `Listing assets associated to a specific asset `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/list-dashboards.rst awscli-1.18.69/awscli/examples/iotsitewise/list-dashboards.rst --- awscli-1.11.13/awscli/examples/iotsitewise/list-dashboards.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/list-dashboards.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,21 @@ +**To list all dashboards in a project** + +The following ``list-dashboards`` example lists all dashboards that are defined in a project. :: + + aws iotsitewise list-dashboards \ + --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE + +Output:: + + { + "dashboardSummaries": [ + { + "id": "a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE", + "name": "Wind Farm", + "creationDate": "2020-05-01T20:32:12.228476348Z", + "lastUpdateDate": "2020-05-01T20:32:12.228476348Z" + } + ] + } + +For more information, see `Viewing dashboards `__ in the *AWS IoT SiteWise Monitor Application Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/list-gateways.rst awscli-1.18.69/awscli/examples/iotsitewise/list-gateways.rst --- awscli-1.11.13/awscli/examples/iotsitewise/list-gateways.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/list-gateways.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,26 @@ +**To list all gateways** + +The following ``list-gateways`` example lists all gateways that are defined in your AWS account in the current Region. :: + + aws iotsitewise list-gateways + +Output:: + + { + "gatewaySummaries": [ + { + "gatewayId": "a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE", + "gatewayName": "ExampleCorpGateway", + "gatewayCapabilitySummaries": [ + { + "capabilityNamespace": "iotsitewise:opcuacollector:1", + "capabilitySyncStatus": "IN_SYNC" + } + ], + "creationDate": 1588369971.457, + "lastUpdateDate": 1588369971.457 + } + ] + } + +For more information, see `Ingesting data using a gateway `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/list-portals.rst awscli-1.18.69/awscli/examples/iotsitewise/list-portals.rst --- awscli-1.11.13/awscli/examples/iotsitewise/list-portals.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/list-portals.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,23 @@ +**To list all portals** + +The following ``list-portals`` example lists all portals that are defined in your AWS account in the current Region. :: + + aws iotsitewise list-portals + +Output:: + + { + "portalSummaries": [ + { + "id": "a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE", + "name": "WindFarmPortal", + "description": "A portal that contains wind farm projects for Example Corp.", + "startUrl": "https://a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE.app.iotsitewise.aws", + "creationDate": "2020-02-04T23:01:52.90248068Z", + "lastUpdateDate": "2020-02-04T23:01:52.90248078Z", + "roleArn": "arn:aws:iam::123456789012:role/service-role/MySiteWiseMonitorServiceRole" + } + ] + } + +For more information, see `Administering your portals `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/list-project-assets.rst awscli-1.18.69/awscli/examples/iotsitewise/list-project-assets.rst --- awscli-1.11.13/awscli/examples/iotsitewise/list-project-assets.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/list-project-assets.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,16 @@ +**To list all assets associated to a project** + +The following ``list-project-assets`` example lists all assets that are associated to a wind farm project. :: + + aws iotsitewise list-projects \ + --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE + +Output:: + + { + "assetIds": [ + "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE" + ] + } + +For more information, see `Adding assets to projects `__ in the *AWS IoT SiteWise Monitor Application Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/list-projects.rst awscli-1.18.69/awscli/examples/iotsitewise/list-projects.rst --- awscli-1.11.13/awscli/examples/iotsitewise/list-projects.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/list-projects.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,22 @@ +**To list all projects in a portal** + +The following ``list-projects`` example lists all projects that are defined in a portal. :: + + aws iotsitewise list-projects \ + --portal-id a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE + +Output:: + + { + "projectSummaries": [ + { + "id": "a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE", + "name": "Wind Farm 1", + "description": "Contains asset visualizations for Wind Farm #1 for Example Corp.", + "creationDate": "2020-02-20T21:58:43.362246001Z", + "lastUpdateDate": "2020-02-20T21:58:43.362246095Z" + } + ] + } + +For more information, see `Viewing project details `__ in the *AWS IoT SiteWise Monitor Application Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/list-tags-for-resource.rst awscli-1.18.69/awscli/examples/iotsitewise/list-tags-for-resource.rst --- awscli-1.11.13/awscli/examples/iotsitewise/list-tags-for-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/list-tags-for-resource.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,16 @@ +**To list all tags for a resource** + +The following ``list-tags-for-resource`` example lists all tags for a wind turbine asset. :: + + aws iotsitewise list-tags-for-resource \ + --resource-arn arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE + +Output:: + + { + "tags": { + "Owner": "richard-roe" + } + } + +For more information, see `Tagging your resources `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/put-logging-options.rst awscli-1.18.69/awscli/examples/iotsitewise/put-logging-options.rst --- awscli-1.11.13/awscli/examples/iotsitewise/put-logging-options.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/put-logging-options.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,10 @@ +**To specify the level of logging** + +The following ``put-logging-options`` example enables ``INFO`` level logging in AWS IoT SiteWise. Other levels include ``DEBUG`` and ``OFF``. :: + + aws iotsitewise put-logging-options \ + --logging-options level=INFO + +This command produces no output. + +For more information, see `Monitoring AWS IoT SiteWise with Amazon CloudWatch Logs `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/tag-resource.rst awscli-1.18.69/awscli/examples/iotsitewise/tag-resource.rst --- awscli-1.11.13/awscli/examples/iotsitewise/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/tag-resource.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,11 @@ +**To add a tag to a resource** + +The following ``tag-resource`` example adds an owner tag to a wind turbine asset. This lets you control access to the asset based on who owns it. :: + + aws iotsitewise tag-resource \ + --resource-arn arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \ + --tags Owner=richard-roe + +This command produces no output. + +For more information, see `Tagging your resources `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/untag-resource.rst awscli-1.18.69/awscli/examples/iotsitewise/untag-resource.rst --- awscli-1.11.13/awscli/examples/iotsitewise/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/untag-resource.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,11 @@ +**To remove a tag from a resource** + +The following ``untag-resource`` example removes an owner tag from a wind turbine asset. :: + + aws iotsitewise untag-resource \ + --resource-arn arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \ + --tag-keys Owner + +This command produces no output. + +For more information, see `Tagging your resources `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/update-access-policy.rst awscli-1.18.69/awscli/examples/iotsitewise/update-access-policy.rst --- awscli-1.11.13/awscli/examples/iotsitewise/update-access-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/update-access-policy.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,27 @@ +**To grant a project viewer ownership of a project** + +The following ``update-access-policy`` example update an access policy that grants a project viewer ownership of a project. :: + + aws iotsitewise update-access-policy \ + --access-policy-id a1b2c3d4-5678-90ab-cdef-dddddEXAMPLE + --cli-input-json file://update-project-viewer-access-policy.json + +Contents of ``update-project-viewer-access-policy.json``:: + + { + "accessPolicyIdentity": { + "user": { + "id": "a1b2c3d4e5-a1b2c3d4-5678-90ab-cdef-bbbbbEXAMPLE" + } + }, + "accessPolicyPermission": "ADMINISTRATOR", + "accessPolicyResource": { + "project": { + "id": "a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE" + } + } + } + +This command produces no output. + +For more information, see `Assigning project owners `__ in the *AWS IoT SiteWise Monitor Application Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/update-asset-model.rst awscli-1.18.69/awscli/examples/iotsitewise/update-asset-model.rst --- awscli-1.11.13/awscli/examples/iotsitewise/update-asset-model.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/update-asset-model.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,67 @@ +**To update an asset model** + +The following ``update-asset-model`` example updates a wind farm asset model's description. This example includes the model's existing IDs and definitions, because ``update-asset-model`` overwrites the existing model with the new model. :: + + aws iotsitewise update-asset-model \ + --cli-input-json file://update-wind-farm-model.json + +Contents of ``update-wind-farm-model.json``:: + + { + "assetModelName": "Wind Farm Model", + "assetModelDescription": "Represents a wind farm that comprises many wind turbines", + "assetModelProperties": [ + { + "id": "a1b2c3d4-5678-90ab-cdef-88888EXAMPLE", + "name": "Region", + "dataType": "STRING", + "type": { + "attribute": {} + } + }, + { + "id": "a1b2c3d4-5678-90ab-cdef-99999EXAMPLE", + "name": "Total Generated Power", + "dataType": "DOUBLE", + "unit": "kW", + "type": { + "metric": { + "expression": "sum(power)", + "variables": [ + { + "name": "power", + "value": { + "hierarchyId": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE", + "propertyId": "a1b2c3d4-5678-90ab-cdef-66666EXAMPLE" + } + } + ], + "window": { + "tumbling": { + "interval": "1h" + } + } + } + } + } + ], + "assetModelHierarchies": [ + { + "id": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE", + "name": "Wind Turbines", + "childAssetModelId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" + } + ] + } + +Output:: + + { + "assetModelId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", + "assetModelArn": "arn:aws:iotsitewise:us-west-2:123456789012:asset-model/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", + "assetModelStatus": { + "state": "CREATING" + } + } + +For more information, see `Updating asset models `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/update-asset-property.rst awscli-1.18.69/awscli/examples/iotsitewise/update-asset-property.rst --- awscli-1.11.13/awscli/examples/iotsitewise/update-asset-property.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/update-asset-property.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,27 @@ +**Example 1: To update an asset property's alias** + +The following ``update-asset-property`` example updates a wind turbine asset's power property alias. :: + + aws iotsitewise update-asset-property \ + --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \ + --property-id a1b2c3d4-5678-90ab-cdef-55555EXAMPLE \ + --property-alias "/examplecorp/windfarm/1/turbine/1/power" \ + --property-notification-state DISABLED + +This command produces no output. + +For more information, see `Mapping industrial data streams to asset properties `__ in the *AWS IoT SiteWise User Guide*. + +**Example 2: To enable asset property notifications** + +The following ``update-asset-property`` example enables asset property update notifications for a wind turbine asset's power property. Property value updates are published to the MQTT topic ``$aws/sitewise/asset-models//assets//properties/``, where each ID is replaced by the property, asset, and model ID of the asset property. :: + + aws iotsitewise update-asset-property \ + --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \ + --property-id a1b2c3d4-5678-90ab-cdef-66666EXAMPLE \ + --property-notification-state ENABLED \ + --property-alias "/examplecorp/windfarm/1/turbine/1/power" + +This command produces no output. + +For more information, see `Interacting with other services `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/update-asset.rst awscli-1.18.69/awscli/examples/iotsitewise/update-asset.rst --- awscli-1.11.13/awscli/examples/iotsitewise/update-asset.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/update-asset.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,17 @@ +**To update an asset's name** + +The following ``update-asset`` example updates a wind turbine asset's name. :: + + aws iotsitewise update-asset \ + --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \ + --asset-name "Wind Turbine 2" + +Output:: + + { + "assetStatus": { + "state": "UPDATING" + } + } + +For more information, see `Updating assets `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/update-dashboard.rst awscli-1.18.69/awscli/examples/iotsitewise/update-dashboard.rst --- awscli-1.11.13/awscli/examples/iotsitewise/update-dashboard.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/update-dashboard.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,35 @@ +**To update a dashboard** + +The following ``update-dashboard`` example changes the title of a dashboard's line chart that displays total generated power for a wind farm. :: + + aws iotsitewise update-dashboard \ + --project-id a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE \ + --dashboard-name "Wind Farm" \ + --dashboard-definition file://update-wind-farm-dashboard.json + +Contents of ``update-wind-farm-dashboard.json``:: + + { + "widgets": [ + { + "type": "monitor-line-chart", + "title": "Total Generated Power", + "x": 0, + "y": 0, + "height": 3, + "width": 3, + "metrics": [ + { + "label": "Power", + "type": "iotsitewise", + "assetId": "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE", + "propertyId": "a1b2c3d4-5678-90ab-cdef-99999EXAMPLE" + } + ] + } + ] + } + +This command produces no output. + +For more information, see `Creating dashboards (CLI) `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/update-gateway-capability-configuration.rst awscli-1.18.69/awscli/examples/iotsitewise/update-gateway-capability-configuration.rst --- awscli-1.11.13/awscli/examples/iotsitewise/update-gateway-capability-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/update-gateway-capability-configuration.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,46 @@ +**To update a gateway capability** + +The following ``update-gateway-capability-configuration`` example configures an OPC-UA source with the following properties:: + +- Trusts any certificate. +- Uses the Basic256 algorithm to secure messages. +- Uses the SignAndEncrypt mode to secure connections. +- Uses authentication credentials stored in an AWS Secrets Manager secret. + + aws iotsitewise update-gateway-capability-configuration \ + --gateway-id a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE \ + --capability-namespace "iotsitewise:opcuacollector:1" \ + --capability-configuration file://opc-ua-capability-configuration.json + +Contents of ``opc-ua-capability-configuration.json``:: + + { + "sources": [ + { + "name": "Wind Farm #1", + "endpoint": { + "certificateTrust": { + "type": "TrustAny" + }, + "endpointUri": "opc.tcp://203.0.113.0:49320", + "securityPolicy": "BASIC256", + "messageSecurityMode": "SIGN_AND_ENCRYPT", + "identityProvider": { + "type": "Username", + "usernameSecretArn": "arn:aws:secretsmanager:us-west-2:123456789012:secret:greengrass-windfarm1-auth-1ABCDE" + }, + "nodeFilterRules": [] + }, + "measurementDataStreamPrefix": "" + } + ] + } + +Output:: + + { + "capabilityNamespace": "iotsitewise:opcuacollector:1", + "capabilitySyncStatus": "OUT_OF_SYNC" + } + +For more information, see `Configuring data sources `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/update-gateway.rst awscli-1.18.69/awscli/examples/iotsitewise/update-gateway.rst --- awscli-1.11.13/awscli/examples/iotsitewise/update-gateway.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/update-gateway.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,11 @@ +**To update a gateway's name** + +The following ``update-gateway`` example updates a gateway's name. :: + + aws iotsitewise update-gateway \ + --gateway-id a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE \ + --gateway-name ExampleCorpGateway1 + +This command produces no output. + +For more information, see `Ingesting data using a gateway `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/update-portal.rst awscli-1.18.69/awscli/examples/iotsitewise/update-portal.rst --- awscli-1.11.13/awscli/examples/iotsitewise/update-portal.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/update-portal.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,20 @@ +**To update a portal's details** + +The following ``update-portal`` example updates a web portal for a wind farm company. :: + + aws iotsitewise update-portal \ + --portal-id a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE \ + --portal-name WindFarmPortal \ + --portal-description "A portal that contains wind farm projects for Example Corp." \ + --portal-contact-email support@example.com \ + --role-arn arn:aws:iam::123456789012:role/MySiteWiseMonitorServiceRole + +Output:: + + { + "portalStatus": { + "state": "UPDATING" + } + } + +For more information, see `Administering your portals `__ in the *AWS IoT SiteWise User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotsitewise/update-project.rst awscli-1.18.69/awscli/examples/iotsitewise/update-project.rst --- awscli-1.11.13/awscli/examples/iotsitewise/update-project.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotsitewise/update-project.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,12 @@ +**To update a project's details** + +The following ``update-project`` example updates a wind farm project. :: + + aws iotsitewise update-project \ + --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE \ + --project-name "Wind Farm 1" \ + --project-description "Contains asset visualizations for Wind Farm #1 for Example Corp." + +This command produces no output. + +For more information, see `Changing project details `__ in the *AWS IoT SiteWise Monitor Application Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/iotthingsgraph/associate-entity-to-thing.rst awscli-1.18.69/awscli/examples/iotthingsgraph/associate-entity-to-thing.rst --- awscli-1.11.13/awscli/examples/iotthingsgraph/associate-entity-to-thing.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotthingsgraph/associate-entity-to-thing.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To associate a thing with a device** + +The following ``associate-entity-to-thing`` example associates a thing with a device. The example uses a motion sensor device that is in the public namespace. :: + + aws iotthingsgraph associate-entity-to-thing \ + --thing-name "MotionSensorName" \ + --entity-id "urn:tdm:aws/examples:Device:HCSR501MotionSensor" + +This command produces no output. + +For more information, see `Creating and Uploading Models `__ in the *AWS IoT Things Graph User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotthingsgraph/create-flow-template.rst awscli-1.18.69/awscli/examples/iotthingsgraph/create-flow-template.rst --- awscli-1.11.13/awscli/examples/iotthingsgraph/create-flow-template.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotthingsgraph/create-flow-template.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,18 @@ +**To create a flow** + +The following ``create-flow-template`` example creates a flow (workflow). The value of ``MyFlowDefinition`` is the GraphQL that models the flow. :: + + aws iotthingsgraph create-flow-template \ + --definition language=GRAPHQL,text="MyFlowDefinition" + +Output:: + + { + "summary": { + "createdAt": 1559248067.545, + "id": "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow", + "revisionNumber": 1 + } + } + +For more information, see `Working with Flows `__ in the *AWS IoT Things Graph User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotthingsgraph/create-system-instance.rst awscli-1.18.69/awscli/examples/iotthingsgraph/create-system-instance.rst --- awscli-1.11.13/awscli/examples/iotthingsgraph/create-system-instance.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotthingsgraph/create-system-instance.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,23 @@ +**To create a system instance** + +The following ``create-system-instance`` example creates a system instance. The value of ``MySystemInstanceDefinition`` is the GraphQL that models the system instance. :: + + aws iotthingsgraph create-system-instance -\ + -definition language=GRAPHQL,text="MySystemInstanceDefinition" \ + --target CLOUD \ + --flow-actions-role-arn myRoleARN + +Output:: + + { + "summary": { + "id": "urn:tdm:us-west-2/123456789012/default:Deployment:Room218", + "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room218", + "status": "NOT_DEPLOYED", + "target": "CLOUD", + "createdAt": 1559249315.208, + "updatedAt": 1559249315.208 + } + } + +For more information, see `Working with Systems and Flow Configurations `__ in the *AWS IoT Things Graph User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotthingsgraph/create-system-template.rst awscli-1.18.69/awscli/examples/iotthingsgraph/create-system-template.rst --- awscli-1.11.13/awscli/examples/iotthingsgraph/create-system-template.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotthingsgraph/create-system-template.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,19 @@ +**To create a system** + +The following ``create-system-template`` example creates a system. The value of MySystemDefinition is the GraphQL that models the system. :: + + aws iotthingsgraph create-system-template \ + --definition language=GRAPHQL,text="MySystemDefinition" + +Output:: + + { + "summary": { + "createdAt": 1559249776.254, + "id": "urn:tdm:us-west-2/123456789012/default:System:MySystem", + "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:System/default/MySystem", + "revisionNumber": 1 + } + } + +For more information, see `Creating Systems `__ in the *AWS IoT Things Graph User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotthingsgraph/delete-flow-template.rst awscli-1.18.69/awscli/examples/iotthingsgraph/delete-flow-template.rst --- awscli-1.11.13/awscli/examples/iotthingsgraph/delete-flow-template.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotthingsgraph/delete-flow-template.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a flow** + +The following ``delete-flow-template`` example deletes a flow (workflow). :: + + aws iotthingsgraph delete-flow-template \ + --id "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow" + +This command produces no output. + +For more information, see `Lifecycle Management for AWS IoT Things Graph Entities, Flows, Systems, and Deployments `__ in the *AWS IoT Things Graph User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotthingsgraph/delete-namespace.rst awscli-1.18.69/awscli/examples/iotthingsgraph/delete-namespace.rst --- awscli-1.11.13/awscli/examples/iotthingsgraph/delete-namespace.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotthingsgraph/delete-namespace.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,14 @@ +**To delete a namespace** + +The following ``delete-namespace`` example deletes a namespace. :: + + aws iotthingsgraph delete-namespace + +Output:: + + { + "namespaceArn": "arn:aws:iotthingsgraph:us-west-2:123456789012", + "namespaceName": "us-west-2/123456789012/default" + } + +For more information, see `Lifecycle Management for AWS IoT Things Graph Entities, Flows, Systems, and Deployments `__ in the *AWS IoT Things Graph User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotthingsgraph/delete-system-instance.rst awscli-1.18.69/awscli/examples/iotthingsgraph/delete-system-instance.rst --- awscli-1.11.13/awscli/examples/iotthingsgraph/delete-system-instance.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotthingsgraph/delete-system-instance.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a system instance** + +The following ``delete-system-instance`` example deletes a system instance. :: + + aws iotthingsgraph delete-system-instance \ + --id "urn:tdm:us-west-2/123456789012/default:Deployment:Room218" + +This command produces no output. + +For more information, see `Lifecycle Management for AWS IoT Things Graph Entities, Flows, Systems, and Deployments `__ in the *AWS IoT Things Graph User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotthingsgraph/delete-system-template.rst awscli-1.18.69/awscli/examples/iotthingsgraph/delete-system-template.rst --- awscli-1.11.13/awscli/examples/iotthingsgraph/delete-system-template.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotthingsgraph/delete-system-template.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a system** + +The following ``delete-system-template`` example deletes a system. :: + + aws iotthingsgraph delete-system-template \ + --id "urn:tdm:us-west-2/123456789012/default:System:MySystem" + +This command produces no output. + +For more information, see `Lifecycle Management for AWS IoT Things Graph Entities, Flows, Systems, and Deployments `__ in the *AWS IoT Things Graph User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotthingsgraph/deploy-system-instance.rst awscli-1.18.69/awscli/examples/iotthingsgraph/deploy-system-instance.rst --- awscli-1.11.13/awscli/examples/iotthingsgraph/deploy-system-instance.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotthingsgraph/deploy-system-instance.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,21 @@ +**To deploy a system instance** + +The following ``delete-system-template`` example deploys a system instance. :: + + aws iotthingsgraph deploy-system-instance \ + --id "urn:tdm:us-west-2/123456789012/default:Deployment:Room218" + +Output:: + + { + "summary": { + "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment:Room218", + "createdAt": 1559249776.254, + "id": "urn:tdm:us-west-2/123456789012/default:Deployment:Room218", + "status": "DEPLOYED_IN_TARGET", + "target": "CLOUD", + "updatedAt": 1559249776.254 + } + } + +For more information, see `Working with Systems and Flow Configurations `__ in the *AWS IoT Things Graph User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotthingsgraph/deprecate-flow-template.rst awscli-1.18.69/awscli/examples/iotthingsgraph/deprecate-flow-template.rst --- awscli-1.11.13/awscli/examples/iotthingsgraph/deprecate-flow-template.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotthingsgraph/deprecate-flow-template.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,10 @@ +**To deprecate a flow** + +The following ``deprecate-flow-template`` example deprecates a flow (workflow). :: + + aws iotthingsgraph deprecate-flow-template \ + --id "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow" + +This command produces no output. + +For more information, see `Lifecycle Management for AWS IoT Things Graph Entities, Flows, Systems, and Deployments `__ in the *AWS IoT Things Graph User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotthingsgraph/deprecate-system-template.rst awscli-1.18.69/awscli/examples/iotthingsgraph/deprecate-system-template.rst --- awscli-1.11.13/awscli/examples/iotthingsgraph/deprecate-system-template.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotthingsgraph/deprecate-system-template.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,10 @@ +**To deprecate a system** + +The following ``deprecate-system-template`` example deprecates a system. :: + + aws iotthingsgraph deprecate-system-template \ + --id "urn:tdm:us-west-2/123456789012/default:System:MySystem" + +This command produces no output. + +For more information, see `Lifecycle Management for AWS IoT Things Graph Entities, Flows, Systems, and Deployments `__ in the *AWS IoT Things Graph User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotthingsgraph/describe-namespace.rst awscli-1.18.69/awscli/examples/iotthingsgraph/describe-namespace.rst --- awscli-1.11.13/awscli/examples/iotthingsgraph/describe-namespace.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotthingsgraph/describe-namespace.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,16 @@ +**To get a description of your namespace** + +The following ``describe-namespace`` example gets a description of your namespace. :: + + aws iotthingsgraph describe-namespace + +Output:: + + { + "namespaceName": "us-west-2/123456789012/default", + "trackingNamespaceName": "aws", + "trackingNamespaceVersion": 1, + "namespaceVersion": 5 + } + +For more information, see `Namespaces `__ in the *AWS IoT Things Graph User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotthingsgraph/dissociate-entity-from-thing.rst awscli-1.18.69/awscli/examples/iotthingsgraph/dissociate-entity-from-thing.rst --- awscli-1.11.13/awscli/examples/iotthingsgraph/dissociate-entity-from-thing.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotthingsgraph/dissociate-entity-from-thing.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To dissociate a thing from a device** + +The following ``dissociate-entity-from-thing`` example dissociates a thing from a device. :: + + aws iotthingsgraph dissociate-entity-from-thing \ + --thing-name "MotionSensorName" \ + --entity-type "DEVICE" + +This command produces no output. + +For more information, see `Creating and Uploading Models `__ in the *AWS IoT Things Graph User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotthingsgraph/get-entities.rst awscli-1.18.69/awscli/examples/iotthingsgraph/get-entities.rst --- awscli-1.11.13/awscli/examples/iotthingsgraph/get-entities.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotthingsgraph/get-entities.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,24 @@ +**To get definitions for entities** + +The following ``get-entities`` example gets a definition for a device model. :: + + aws iotthingsgraph get-entities \ + --ids "urn:tdm:aws/examples:DeviceModel:MotionSensor" + +Output:: + + { + "descriptions": [ + { + "id": "urn:tdm:aws/examples:DeviceModel:MotionSensor", + "type": "DEVICE_MODEL", + "createdAt": 1559256190.599, + "definition": { + "language": "GRAPHQL", + "text": "##\n# Specification of motion sensor devices interface.\n##\ntype MotionSensor @deviceModel(id: \"urn:tdm:aws/examples:deviceModel:MotionSensor\",\n capability: \"urn:tdm:aws/examples:capability:MotionSensorCapability\") {ignore:void}" + } + } + ] + } + +For more information, see `Creating and Uploading Models `__ in the *AWS IoT Things Graph User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotthingsgraph/get-flow-template-revisions.rst awscli-1.18.69/awscli/examples/iotthingsgraph/get-flow-template-revisions.rst --- awscli-1.11.13/awscli/examples/iotthingsgraph/get-flow-template-revisions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotthingsgraph/get-flow-template-revisions.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,20 @@ +**To get revision information about a flow** + +The following ``get-flow-template-revisions`` example gets revision information about a flow (workflow). :: + + aws iotthingsgraph get-flow-template-revisions \ + --id urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow + +Output:: + + { + "summaries": [ + { + "id": "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow", + "revisionNumber": 1, + "createdAt": 1559247540.292 + } + ] + } + +For more information, see `Working with Flows `__ in the *AWS IoT Things Graph User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotthingsgraph/get-flow-template.rst awscli-1.18.69/awscli/examples/iotthingsgraph/get-flow-template.rst --- awscli-1.11.13/awscli/examples/iotthingsgraph/get-flow-template.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotthingsgraph/get-flow-template.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,25 @@ +**To get a flow definition** + +The following ``get-flow-template`` example gets a definition for a flow (workflow). :: + + aws iotthingsgraph get-flow-template \ + --id "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow" + +Output:: + + { + "description": { + "summary": { + "id": "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow", + "revisionNumber": 1, + "createdAt": 1559247540.292 + }, + "definition": { + "language": "GRAPHQL", + "text": "{\nquery MyFlow($camera: string!, $screen: string!) @workflowType(id: \"urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow\") @annotation(type: \"tgc:FlowEvent\", id: \"sledged790c1b2bcd949e09da0c9bfc077f79d\", x: 1586, y: 653) @triggers(definition: \"{MotionSensor(description: \\\"\\\") @position(x: 1045, y: 635.6666564941406) {\\n condition(expr: \\\"devices[name == \\\\\\\"motionSensor\\\\\\\"].events[name == \\\\\\\"StateChanged\\\\\\\"].lastEvent\\\")\\n action(expr: \\\"\\\")\\n}}\") {\n variables {\n cameraResult @property(id: \"urn:tdm:aws/examples:property:CameraStateProperty\")\n }\n steps {\n step(name: \"Camera\", outEvent: [\"sledged790c1b2bcd949e09da0c9bfc077f79d\"]) @position(x: 1377, y: 638.6666564941406) {\n DeviceActivity(deviceModel: \"urn:tdm:aws/examples:deviceModel:Camera\", out: \"cameraResult\", deviceId: \"${camera}\") {\n capture\n }\n }\n step(name: \"Screen\", inEvent: [\"sledged790c1b2bcd949e09da0c9bfc077f79d\"]) @position(x: 1675.6666870117188, y: 637.9999847412109) {\n DeviceActivity(deviceModel: \"urn:tdm:aws/examples:deviceModel:Screen\", deviceId: \"${screen}\") {\n display(imageUrl: \"${cameraResult.lastClickedImage}\")\n }\n }\n }\n}\n}" + }, + "validatedNamespaceVersion": 5 + } + } + +For more information, see `Working with Flows `__ in the *AWS IoT Things Graph User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotthingsgraph/get-namespace-deletion-status.rst awscli-1.18.69/awscli/examples/iotthingsgraph/get-namespace-deletion-status.rst --- awscli-1.11.13/awscli/examples/iotthingsgraph/get-namespace-deletion-status.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotthingsgraph/get-namespace-deletion-status.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,15 @@ +**To get the status of the namespace deletion task** + +The following ``get-namespace-deletion-status`` example gets the status of the namespace deletion task. :: + + aws iotthingsgraph get-namespace-deletion-status + +Output:: + + { + "namespaceArn": "arn:aws:iotthingsgraph:us-west-2:123456789012", + "namespaceName": "us-west-2/123456789012/default" + "status": "SUCCEEDED " + } + +For more information, see `Namespaces `__ in the *AWS IoT Things Graph User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotthingsgraph/get-system-instance.rst awscli-1.18.69/awscli/examples/iotthingsgraph/get-system-instance.rst --- awscli-1.11.13/awscli/examples/iotthingsgraph/get-system-instance.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotthingsgraph/get-system-instance.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,32 @@ +**To get a system instance** + +The following ``get-system-instance`` example gets a definition for a system instance. :: + + aws iotthingsgraph get-system-instance \ + --id "urn:tdm:us-west-2/123456789012/default:Deployment:Room218" + +Output:: + + { + "description": { + "summary": { + "id": "urn:tdm:us-west-2/123456789012/default:Deployment:Room218", + "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room218", + "status": "NOT_DEPLOYED", + "target": "CLOUD", + "createdAt": 1559249315.208, + "updatedAt": 1559249315.208 + }, + "definition": { + "language": "GRAPHQL", + "text": "{\r\nquery Room218 @deployment(id: \"urn:tdm:us-west-2/123456789012/default:Deployment:Room218\", systemId: \"urn:tdm:us-west-2/123456789012/default:System:SecurityFlow\") {\r\n motionSensor(deviceId: \"MotionSensorName\")\r\n screen(deviceId: \"ScreenName\")\r\n camera(deviceId: \"CameraName\") \r\n triggers {MotionEventTrigger(description: \"a trigger\") { \r\n condition(expr: \"devices[name == 'motionSensor'].events[name == 'StateChanged'].lastEvent\") \r\n action(expr: \"ThingsGraph.startFlow('SecurityFlow', bindings[name == 'camera'].deviceId, bindings[name == 'screen'].deviceId)\")\r\n }\r\n }\r\n }\r\n }" + }, + "metricsConfiguration": { + "cloudMetricEnabled": false + }, + "validatedNamespaceVersion": 5, + "flowActionsRoleArn": "arn:aws:iam::123456789012:role/ThingsGraphRole" + } + } + +For more information, see `Working with Systems and Flow Configurations `__ in the *AWS IoT Things Graph User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotthingsgraph/get-system-template-revisions.rst awscli-1.18.69/awscli/examples/iotthingsgraph/get-system-template-revisions.rst --- awscli-1.11.13/awscli/examples/iotthingsgraph/get-system-template-revisions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotthingsgraph/get-system-template-revisions.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,21 @@ +**To get revision information about a system** + +The following ``get-system-template-revisions`` example gets revision information about a system. :: + + aws iotthingsgraph get-system-template-revisions \ + --id "urn:tdm:us-west-2/123456789012/default:System:MySystem" + +Output:: + + { + "summaries": [ + { + "id": "urn:tdm:us-west-2/123456789012/default:System:MySystem", + "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:System/default/MySystem", + "revisionNumber": 1, + "createdAt": 1559247540.656 + } + ] + } + +For more information, see `Working with Systems and Flow Configurations `__ in the *AWS IoT Things Graph User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotthingsgraph/get-system-template.rst awscli-1.18.69/awscli/examples/iotthingsgraph/get-system-template.rst --- awscli-1.11.13/awscli/examples/iotthingsgraph/get-system-template.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotthingsgraph/get-system-template.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,26 @@ +**To get a system** + +The following ``get-system-template`` example gets a definition for a system. :: + + aws iotthingsgraph get-system-template \ + --id "urn:tdm:us-west-2/123456789012/default:System:MySystem" + +Output:: + + { + "description": { + "summary": { + "id": "urn:tdm:us-west-2/123456789012/default:System:MySystem", + "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:System/default/MyFlow", + "revisionNumber": 1, + "createdAt": 1559247540.656 + }, + "definition": { + "language": "GRAPHQL", + "text": "{\ntype MySystem @systemType(id: \"urn:tdm:us-west-2/123456789012/default:System:MySystem\", description: \"\") {\n camera: Camera @thing(id: \"urn:tdm:aws/examples:deviceModel:Camera\")\n screen: Screen @thing(id: \"urn:tdm:aws/examples:deviceModel:Screen\")\n motionSensor: MotionSensor @thing(id: \"urn:tdm:aws/examples:deviceModel:MotionSensor\")\n MyFlow: MyFlow @workflow(id: \"urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow\")\n}\n}" + }, + "validatedNamespaceVersion": 5 + } + } + +For more information, see `Working with Systems and Flow Configurations `__ in the *AWS IoT Things Graph User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotthingsgraph/get-upload-status.rst awscli-1.18.69/awscli/examples/iotthingsgraph/get-upload-status.rst --- awscli-1.11.13/awscli/examples/iotthingsgraph/get-upload-status.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotthingsgraph/get-upload-status.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,17 @@ +**To get the status of your entity upload** + +The following ``get-upload-status`` example gets the status of your entity upload operation. The value of ``MyUploadId`` is the ID value returned by the ``upload-entity-definitions`` operation. :: + + aws iotthingsgraph get-upload-status \ + --upload-id "MyUploadId" + +Output:: + + { + "namespaceName": "us-west-2/123456789012/default", + "namespaceVersion": 5, + "uploadId": "f6294f1e-b109-4bbe-9073-f451a2dda2da", + "uploadStatus": "SUCCEEDED" + } + +For more information, see `Modeling Entities `__ in the *AWS IoT Things Graph User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotthingsgraph/list-flow-execution-messages.rst awscli-1.18.69/awscli/examples/iotthingsgraph/list-flow-execution-messages.rst --- awscli-1.11.13/awscli/examples/iotthingsgraph/list-flow-execution-messages.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotthingsgraph/list-flow-execution-messages.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,21 @@ +**To get information about events in a flow execution** + +The following ``list-flow-execution-messages`` example gets information about events in a flow execution. :: + + aws iotthingsgraph list-flow-execution-messages \ + --flow-execution-id "urn:tdm:us-west-2/123456789012/default:Workflow:SecurityFlow_2019-05-11T19:39:55.317Z_MotionSensor_69b151ad-a611-42f5-ac21-fe537f9868ad" + +Output:: + + { + "messages": [ + { + "eventType": "EXECUTION_STARTED", + "messageId": "f6294f1e-b109-4bbe-9073-f451a2dda2da", + "payload": "Flow execution started", + "timestamp": 1559247540.656 + } + ] + } + +For more information, see `Working with Flows `__ in the *AWS IoT Things Graph User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotthingsgraph/list-tags-for-resource.rst awscli-1.18.69/awscli/examples/iotthingsgraph/list-tags-for-resource.rst --- awscli-1.11.13/awscli/examples/iotthingsgraph/list-tags-for-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotthingsgraph/list-tags-for-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,19 @@ +**To list all tags for a resource** + +The following ``list-tags-for-resource`` example list all tags for an AWS IoT Things Graph resource. :: + + aws iotthingsgraph list-tags-for-resource \ + --resource-arn "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room218" + +Output:: + + { + "tags": [ + { + "key": "Type", + "value": "Residential" + } + ] + } + +For more information, see `Tagging Your AWS IoT Things Graph Resources `__ in the *AWS IoT Things Graph User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotthingsgraph/search-entities.rst awscli-1.18.69/awscli/examples/iotthingsgraph/search-entities.rst --- awscli-1.11.13/awscli/examples/iotthingsgraph/search-entities.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotthingsgraph/search-entities.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,40 @@ +**To search for entities** + +The following ``search-entities`` example searches for all entities of type ``EVENT``. :: + + aws iotthingsgraph search-entities \ + --entity-types "EVENT" + +Output:: + + { + "descriptions": [ + { + "id": "urn:tdm:aws/examples:Event:MotionSensorEvent", + "type": "EVENT", + "definition": { + "language": "GRAPHQL", + "text": "##\n# Description of events emitted by motion sensor.\n##\ntype MotionSensorEvent @eventType(id: \"urn:tdm:aws/examples:event:MotionSensorEvent\",\n payload: \"urn:tdm:aws/examples:property:MotionSensorStateProperty\") {ignore:void}" + } + }, + { + "id": "urn:tdm:us-west-2/123456789012/default:Event:CameraClickedEventV2", + "type": "EVENT", + "definition": { + "language": "GRAPHQL", + "text": "type CameraClickedEventV2 @eventType(id: \"urn:tdm:us-west-2/123456789012/default:event:CameraClickedEventV2\",\r\npayload: \"urn:tdm:aws:Property:Boolean\"){ignore:void}" + } + }, + { + "id": "urn:tdm:us-west-2/123456789012/default:Event:MotionSensorEventV2", + "type": "EVENT", + "definition": { + "language": "GRAPHQL", + "text": "# Event emitted by the motion sensor.\r\ntype MotionSensorEventV2 @eventType(id: \"urn:tdm:us-west-2/123456789012/default:event:MotionSensorEventV2\",\r\npayload: \"urn:tdm:us-west-2/123456789012/default:property:MotionSensorStateProperty2\") {ignore:void}" + } + } + ], + "nextToken": "urn:tdm:us-west-2/123456789012/default:Event:MotionSensorEventV2" + } + +For more information, see `AWS IoT Things Graph Data Model Reference `__ in the *AWS IoT Things Graph User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotthingsgraph/search-flow-executions.rst awscli-1.18.69/awscli/examples/iotthingsgraph/search-flow-executions.rst --- awscli-1.11.13/awscli/examples/iotthingsgraph/search-flow-executions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotthingsgraph/search-flow-executions.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,23 @@ +**To search for flow executions** + +The following ``search-flow-executions`` example search for all executions of a flow in a specified system instance. :: + + aws iotthingsgraph search-flow-executions \ + --system-instance-id "urn:tdm:us-west-2/123456789012/default:Deployment:Room218" + +Output:: + + { + "summaries": [ + { + "createdAt": 1559247540.656, + "flowExecutionId": "f6294f1e-b109-4bbe-9073-f451a2dda2da", + "flowTemplateId": "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow", + "status": "RUNNING ", + "systemInstanceId": "urn:tdm:us-west-2/123456789012/default:System:MySystem", + "updatedAt": 1559247540.656 + } + ] + } + +For more information, see `Working with Systems and Flow Configurations `__ in the *AWS IoT Things Graph User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotthingsgraph/search-flow-templates.rst awscli-1.18.69/awscli/examples/iotthingsgraph/search-flow-templates.rst --- awscli-1.11.13/awscli/examples/iotthingsgraph/search-flow-templates.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotthingsgraph/search-flow-templates.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,25 @@ +**To search for flows (or workflows)** + +The following ``search-flow-templates`` example searches for all flows (workflows) that contain the Camera device model. :: + + aws iotthingsgraph search-flow-templates \ + --filters name="DEVICE_MODEL_ID",value="urn:tdm:aws/examples:DeviceModel:Camera" + +Output:: + + { + "summaries": [ + { + "id": "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow", + "revisionNumber": 1, + "createdAt": 1559247540.292 + }, + { + "id": "urn:tdm:us-west-2/123456789012/default:Workflow:SecurityFlow", + "revisionNumber": 3, + "createdAt": 1548283099.27 + } + ] + } + +For more information, see `Working with Flows `__ in the *AWS IoT Things Graph User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotthingsgraph/search-system-instances.rst awscli-1.18.69/awscli/examples/iotthingsgraph/search-system-instances.rst --- awscli-1.11.13/awscli/examples/iotthingsgraph/search-system-instances.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotthingsgraph/search-system-instances.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,63 @@ +**To search for system instances** + +The following ``search-system-instances`` example searches for all system instances that contain the specified system. :: + + aws iotthingsgraph search-system-instances \ + --filters name="SYSTEM_TEMPLATE_ID",value="urn:tdm:us-west-2/123456789012/default:System:SecurityFlow" + +Output:: + + { + "summaries": [ + { + "id": "urn:tdm:us-west-2/123456789012/default:Deployment:DeploymentForSample", + "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/DeploymentForSample", + "status": "NOT_DEPLOYED", + "target": "GREENGRASS", + "greengrassGroupName": "ThingsGraphGrnGr", + "createdAt": 1555716314.707, + "updatedAt": 1555716314.707 + }, + { + "id": "urn:tdm:us-west-2/123456789012/default:Deployment:MockDeployment", + "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/MockDeployment", + "status": "DELETED_IN_TARGET", + "target": "GREENGRASS", + "greengrassGroupName": "ThingsGraphGrnGr", + "createdAt": 1549416462.049, + "updatedAt": 1549416722.361, + "greengrassGroupId": "01d04b07-2a51-467f-9d03-0c90b3cdcaaf", + "greengrassGroupVersionId": "7365aed7-2d3e-4d13-aad8-75443d45eb05" + }, + { + "id": "urn:tdm:us-west-2/123456789012/default:Deployment:MockDeployment2", + "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/MockDeployment2", + "status": "DEPLOYED_IN_TARGET", + "target": "GREENGRASS", + "greengrassGroupName": "ThingsGraphGrnGr", + "createdAt": 1549572385.774, + "updatedAt": 1549572418.408, + "greengrassGroupId": "01d04b07-2a51-467f-9d03-0c90b3cdcaaf", + "greengrassGroupVersionId": "bfa70ab3-2bf7-409c-a4d4-bc8328ae5b86" + }, + { + "id": "urn:tdm:us-west-2/123456789012/default:Deployment:Room215", + "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room215", + "status": "NOT_DEPLOYED", + "target": "GREENGRASS", + "greengrassGroupName": "ThingsGraphGG", + "createdAt": 1547056918.413, + "updatedAt": 1547056918.413 + }, + { + "id": "urn:tdm:us-west-2/123456789012/default:Deployment:Room218", + "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room218", + "status": "NOT_DEPLOYED", + "target": "CLOUD", + "createdAt": 1559249315.208, + "updatedAt": 1559249315.208 + } + ] + } + +For more information, see `Working with Systems and Flow Configurations `__ in the *AWS IoT Things Graph User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotthingsgraph/search-system-templates.rst awscli-1.18.69/awscli/examples/iotthingsgraph/search-system-templates.rst --- awscli-1.11.13/awscli/examples/iotthingsgraph/search-system-templates.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotthingsgraph/search-system-templates.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,21 @@ +**To search for system** + +The following ``search-system-templates`` example searches for all systems that contain the specified flow. :: + + aws iotthingsgraph search-system-templates \ + --filters name="FLOW_TEMPLATE_ID",value="urn:tdm:us-west-2/123456789012/default:Workflow:SecurityFlow" + +Output:: + + { + "summaries": [ + { + "id": "urn:tdm:us-west-2/123456789012/default:System:SecurityFlow", + "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:System/default/SecurityFlow", + "revisionNumber": 1, + "createdAt": 1548283099.433 + } + ] + } + +For more information, see `Working with Flows `__ in the *AWS IoT Things Graph User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotthingsgraph/search-things.rst awscli-1.18.69/awscli/examples/iotthingsgraph/search-things.rst --- awscli-1.11.13/awscli/examples/iotthingsgraph/search-things.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotthingsgraph/search-things.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,23 @@ +**To search for things associated with devices and device models** + +The following ``search-things`` example searches for all things that are associated with the HCSR501MotionSensor device. :: + + aws iotthingsgraph search-things \ + --entity-id "urn:tdm:aws/examples:Device:HCSR501MotionSensor" + +Output:: + + { + "things": [ + { + "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MotionSensor1", + "thingName": "MotionSensor1" + }, + { + "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/TG_MS", + "thingName": "TG_MS" + } + ] + } + +For more information, see `Creating and Uploading Models `__ in the *AWS IoT Things Graph User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotthingsgraph/tag-resource.rst awscli-1.18.69/awscli/examples/iotthingsgraph/tag-resource.rst --- awscli-1.11.13/awscli/examples/iotthingsgraph/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotthingsgraph/tag-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To create a tag for a resource** + +The following ``tag-resource`` example creates a tag for the specified resource. :: + + aws iotthingsgraph tag-resource \ + --resource-arn "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room218" \ + --tags key="Type",value="Residential" + +This command produces no output. + +For more information, see `Tagging Your AWS IoT Things Graph Resources `__ in the *AWS IoT Things Graph User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotthingsgraph/undeploy-system-instance.rst awscli-1.18.69/awscli/examples/iotthingsgraph/undeploy-system-instance.rst --- awscli-1.11.13/awscli/examples/iotthingsgraph/undeploy-system-instance.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotthingsgraph/undeploy-system-instance.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,24 @@ +**To undeploy a system instance from its target** + +The following ``undeploy-system-instance`` example removes a system instance from its target. :: + + aws iotthingsgraph undeploy-system-instance \ + --id "urn:tdm:us-west-2/123456789012/default:Deployment:Room215" + +Output:: + + { + "summary": { + "id": "urn:tdm:us-west-2/123456789012/default:Deployment:Room215", + "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room215", + "status": "PENDING_DELETE", + "target": "GREENGRASS", + "greengrassGroupName": "ThingsGraphGrnGr", + "createdAt": 1553189694.255, + "updatedAt": 1559344549.601, + "greengrassGroupId": "01d04b07-2a51-467f-9d03-0c90b3cdcaaf", + "greengrassGroupVersionId": "731b371d-d644-4b67-ac64-3934e99b75d7" + } + } + +For more information, see `Lifecycle Management for AWS IoT Things Graph Entities, Flows, Systems, and Deployments `__ in the *AWS IoT Things Graph User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotthingsgraph/untag-resource.rst awscli-1.18.69/awscli/examples/iotthingsgraph/untag-resource.rst --- awscli-1.11.13/awscli/examples/iotthingsgraph/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotthingsgraph/untag-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To remove a tag for a resource** + +The following ``untag-resource`` example removes a tag for the specified resource. :: + + aws iotthingsgraph untag-resource \ + --resource-arn "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room218" \ + --tag-keys "Type" + +This command produces no output. + +For more information, see `Tagging Your AWS IoT Things Graph Resources `__ in the *AWS IoT Things Graph User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotthingsgraph/update-flow-template.rst awscli-1.18.69/awscli/examples/iotthingsgraph/update-flow-template.rst --- awscli-1.11.13/awscli/examples/iotthingsgraph/update-flow-template.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotthingsgraph/update-flow-template.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,19 @@ +**To update a flow** + +The following ``update-flow-template`` example updates a flow (workflow). The value of ``MyFlowDefinition`` is the GraphQL that models the flow. :: + + aws iotthingsgraph update-flow-template \ + --id "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow" \ + --definition language=GRAPHQL,text="MyFlowDefinition" + +Output:: + + { + "summary": { + "createdAt": 1559248067.545, + "id": "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow", + "revisionNumber": 2 + } + } + +For more information, see `Working with Flows `__ in the *AWS IoT Things Graph User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotthingsgraph/update-system-template.rst awscli-1.18.69/awscli/examples/iotthingsgraph/update-system-template.rst --- awscli-1.11.13/awscli/examples/iotthingsgraph/update-system-template.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotthingsgraph/update-system-template.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,20 @@ +**To update a system** + +The following ``update-system-template`` example updates a system. The value of ``MySystemDefinition`` is the GraphQL that models the system. :: + + aws iotthingsgraph update-system-template \ + --id "urn:tdm:us-west-2/123456789012/default:System:MySystem" \ + --definition language=GRAPHQL,text="MySystemDefinition" + +Output:: + + { + "summary": { + "createdAt": 1559249776.254, + "id": "urn:tdm:us-west-2/123456789012/default:System:MySystem", + "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:System/default/MySystem", + "revisionNumber": 2 + } + } + +For more information, see `Creating Systems `__ in the *AWS IoT Things Graph User Guide*. diff -Nru awscli-1.11.13/awscli/examples/iotthingsgraph/upload-entity-definitions.rst awscli-1.18.69/awscli/examples/iotthingsgraph/upload-entity-definitions.rst --- awscli-1.11.13/awscli/examples/iotthingsgraph/upload-entity-definitions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/iotthingsgraph/upload-entity-definitions.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,14 @@ +**To upload entity definitions** + +The following ``upload-entity-definitions`` example uploads entity definitions to your namespace. The value of ``MyEntityDefinitions`` is the GraphQL that models the entities. :: + + aws iotthingsgraph upload-entity-definitions \ + --document language=GRAPHQL,text="MyEntityDefinitions" + +Output:: + + { + "uploadId": "f6294f1e-b109-4bbe-9073-f451a2dda2da" + } + +For more information, see `Modeling Entities `__ in the *AWS IoT Things Graph User Guide*. diff -Nru awscli-1.11.13/awscli/examples/kafka/create-cluster.rst awscli-1.18.69/awscli/examples/kafka/create-cluster.rst --- awscli-1.11.13/awscli/examples/kafka/create-cluster.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kafka/create-cluster.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,31 @@ +**To create an Amazon MSK cluster** + +The following ``create-cluster`` example creates an MSK cluster named ``MessagingCluster`` with three broker nodes. A JSON file named ``brokernodegroupinfo.json`` specifies the three subnets over which you want Amazon MSK to distribute the broker nodes. This example doesn't specify the monitoring level, so the cluster gets the ``DEFAULT`` level. :: + + aws kafka create-cluster \ + --cluster-name "MessagingCluster" \ + --broker-node-group-info file://brokernodegroupinfo.json \ + --kafka-version "2.2.1" \ + --number-of-broker-nodes 3 + +Contents of ``brokernodegroupinfo.json``:: + + { + "InstanceType": "kafka.m5.xlarge", + "BrokerAZDistribution": "DEFAULT", + "ClientSubnets": [ + "subnet-0123456789111abcd", + "subnet-0123456789222abcd", + "subnet-0123456789333abcd" + ] + } + +Output:: + + { + "ClusterArn": "arn:aws:kafka:us-west-2:123456789012:cluster/MessagingCluster/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2", + "ClusterName": "MessagingCluster", + "State": "CREATING" + } + +For more information, see `Create an Amazon MSK Cluster `__ in the *Amazon Managed Streaming for Apache Kafka*. diff -Nru awscli-1.11.13/awscli/examples/kafka/create-configuration.rst awscli-1.18.69/awscli/examples/kafka/create-configuration.rst --- awscli-1.11.13/awscli/examples/kafka/create-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kafka/create-configuration.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,32 @@ +**To create a custom Amazon MSK configuration** + +The following ``create-configuration`` example creates a custom MSK configuration with the server properties that are specified in the input file. :: + + aws kafka create-configuration \ + --name "CustomConfiguration" \ + --description "Topic autocreation enabled; Apache ZooKeeper timeout 2000 ms; Log rolling 604800000 ms." \ + --kafka-versions "2.2.1" \ + --server-properties file://configuration.txt + +Contents of ``configuration.txt``:: + + auto.create.topics.enable = true + zookeeper.connection.timeout.ms = 2000 + log.roll.ms = 604800000 + +This command produces no output. +Output:: + + { + "Arn": "arn:aws:kafka:us-west-2:123456789012:configuration/CustomConfiguration/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2", + "CreationTime": "2019-10-09T15:26:05.548Z", + "LatestRevision": + { + "CreationTime": "2019-10-09T15:26:05.548Z", + "Description": "Topic autocreation enabled; Apache ZooKeeper timeout 2000 ms; Log rolling 604800000 ms.", + "Revision": 1 + }, + "Name": "CustomConfiguration" + } + +For more information, see `Amazon MSK Configuration Operations `__ in the *Amazon Managed Streaming for Apache Kafka Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/kafka/update-broker-storage.rst awscli-1.18.69/awscli/examples/kafka/update-broker-storage.rst --- awscli-1.11.13/awscli/examples/kafka/update-broker-storage.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kafka/update-broker-storage.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,18 @@ +**To update the EBS storage for brokers** + +The following ``update-broker-storage`` example updates the amount of EBS storage for all the brokers in the cluster. Amazon MSK sets the target storage amount for each broker to the amount specified in the example. You can get the current version of the cluster by describing the cluster or by listing all of the clusters. :: + + + aws kafka update-broker-storage \ + --cluster-arn "arn:aws:kafka:us-west-2:123456789012:cluster/MessagingCluster/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2" \ + --current-version "K21V3IB1VIZYYH" \ + --target-broker-ebs-volume-info "KafkaBrokerNodeId=ALL,VolumeSizeGB=1100" + +The output returns an ARN for this ``update-broker-storage`` operation. To determine if this operation is complete, use the ``describe-cluster-operation`` command with this ARN as input. :: + + { + "ClusterArn": "arn:aws:kafka:us-west-2:123456789012:cluster/MessagingCluster/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2", + "ClusterOperationArn": "arn:aws:kafka:us-west-2:123456789012:cluster-operation/V123450123/a1b2c3d4-1234-abcd-cdef-22222EXAMPLE-2/a1b2c3d4-abcd-1234-bcde-33333EXAMPLE" + } + +For more information, see `Update the EBS Storage for Brokers `__ in the *Amazon Managed Streaming for Apache Kafka Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/kafka/update-cluster-configuration.rst awscli-1.18.69/awscli/examples/kafka/update-cluster-configuration.rst --- awscli-1.11.13/awscli/examples/kafka/update-cluster-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kafka/update-cluster-configuration.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,25 @@ +**To update the configuration of an Amazon MSK cluster** + +The following ``update-cluster-configuration`` example updates the configuration of the specified existing MSK cluster. It uses a custom MSK configuration. :: + + + aws kafka update-cluster-configuration \ + --cluster-arn "arn:aws:kafka:us-west-2:123456789012:cluster/MessagingCluster/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2" \ + --configuration-info file://configuration-info.json \ + --current-version "K21V3IB1VIZYYH" + +Contents of ``configuration-info.json``:: + + { + "Arn": "arn:aws:kafka:us-west-2:123456789012:configuration/CustomConfiguration/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2", + "Revision": 1 + } + +The output returns an ARN for this ``update-cluster-configuration`` operation. To determine if this operation is complete, use the ``describe-cluster-operation`` command with this ARN as input. :: + + { + "ClusterArn": "arn:aws:kafka:us-west-2:123456789012:cluster/MessagingCluster/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2", + "ClusterOperationArn": "arn:aws:kafka:us-west-2:123456789012:cluster-operation/V123450123/a1b2c3d4-1234-abcd-cdef-22222EXAMPLE-2/a1b2c3d4-abcd-1234-bcde-33333EXAMPLE" + } + +For more information, see `Update the Configuration of an Amazon MSK Cluster `__ in the *Amazon Managed Streaming for Apache Kafka Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/kinesis/add-tags-to-stream.rst awscli-1.18.69/awscli/examples/kinesis/add-tags-to-stream.rst --- awscli-1.11.13/awscli/examples/kinesis/add-tags-to-stream.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kinesis/add-tags-to-stream.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/kinesis/create-stream.rst awscli-1.18.69/awscli/examples/kinesis/create-stream.rst --- awscli-1.11.13/awscli/examples/kinesis/create-stream.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kinesis/create-stream.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/kinesis/decrease-stream-retention-period.rst awscli-1.18.69/awscli/examples/kinesis/decrease-stream-retention-period.rst --- awscli-1.11.13/awscli/examples/kinesis/decrease-stream-retention-period.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kinesis/decrease-stream-retention-period.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/kinesis/delete-stream.rst awscli-1.18.69/awscli/examples/kinesis/delete-stream.rst --- awscli-1.11.13/awscli/examples/kinesis/delete-stream.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kinesis/delete-stream.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/kinesis/deregister-stream-consumer.rst awscli-1.18.69/awscli/examples/kinesis/deregister-stream-consumer.rst --- awscli-1.11.13/awscli/examples/kinesis/deregister-stream-consumer.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kinesis/deregister-stream-consumer.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/kinesis/describe-limits.rst awscli-1.18.69/awscli/examples/kinesis/describe-limits.rst --- awscli-1.11.13/awscli/examples/kinesis/describe-limits.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kinesis/describe-limits.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/kinesis/describe-stream-consumer.rst awscli-1.18.69/awscli/examples/kinesis/describe-stream-consumer.rst --- awscli-1.11.13/awscli/examples/kinesis/describe-stream-consumer.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kinesis/describe-stream-consumer.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/kinesis/describe-stream.rst awscli-1.18.69/awscli/examples/kinesis/describe-stream.rst --- awscli-1.11.13/awscli/examples/kinesis/describe-stream.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kinesis/describe-stream.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/kinesis/describe-stream-summary.rst awscli-1.18.69/awscli/examples/kinesis/describe-stream-summary.rst --- awscli-1.11.13/awscli/examples/kinesis/describe-stream-summary.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kinesis/describe-stream-summary.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/kinesis/disable-enhanced-monitoring.rst awscli-1.18.69/awscli/examples/kinesis/disable-enhanced-monitoring.rst --- awscli-1.11.13/awscli/examples/kinesis/disable-enhanced-monitoring.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kinesis/disable-enhanced-monitoring.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/kinesis/enable-enhanced-monitoring.rst awscli-1.18.69/awscli/examples/kinesis/enable-enhanced-monitoring.rst --- awscli-1.11.13/awscli/examples/kinesis/enable-enhanced-monitoring.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kinesis/enable-enhanced-monitoring.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/kinesis/get-records.rst awscli-1.18.69/awscli/examples/kinesis/get-records.rst --- awscli-1.11.13/awscli/examples/kinesis/get-records.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kinesis/get-records.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/kinesis/get-shard-iterator.rst awscli-1.18.69/awscli/examples/kinesis/get-shard-iterator.rst --- awscli-1.11.13/awscli/examples/kinesis/get-shard-iterator.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kinesis/get-shard-iterator.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/kinesis/increase-stream-retention-period.rst awscli-1.18.69/awscli/examples/kinesis/increase-stream-retention-period.rst --- awscli-1.11.13/awscli/examples/kinesis/increase-stream-retention-period.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kinesis/increase-stream-retention-period.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/kinesis/list-shards.rst awscli-1.18.69/awscli/examples/kinesis/list-shards.rst --- awscli-1.11.13/awscli/examples/kinesis/list-shards.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kinesis/list-shards.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/kinesis/list-streams.rst awscli-1.18.69/awscli/examples/kinesis/list-streams.rst --- awscli-1.11.13/awscli/examples/kinesis/list-streams.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kinesis/list-streams.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/kinesis/list-tags-for-stream.rst awscli-1.18.69/awscli/examples/kinesis/list-tags-for-stream.rst --- awscli-1.11.13/awscli/examples/kinesis/list-tags-for-stream.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kinesis/list-tags-for-stream.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/kinesis/merge-shards.rst awscli-1.18.69/awscli/examples/kinesis/merge-shards.rst --- awscli-1.11.13/awscli/examples/kinesis/merge-shards.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kinesis/merge-shards.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/kinesis/put-record.rst awscli-1.18.69/awscli/examples/kinesis/put-record.rst --- awscli-1.11.13/awscli/examples/kinesis/put-record.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kinesis/put-record.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/kinesis/put-records.rst awscli-1.18.69/awscli/examples/kinesis/put-records.rst --- awscli-1.11.13/awscli/examples/kinesis/put-records.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kinesis/put-records.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/kinesis/register-stream-consumer.rst awscli-1.18.69/awscli/examples/kinesis/register-stream-consumer.rst --- awscli-1.11.13/awscli/examples/kinesis/register-stream-consumer.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kinesis/register-stream-consumer.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/kinesis/remove-tags-from-stream.rst awscli-1.18.69/awscli/examples/kinesis/remove-tags-from-stream.rst --- awscli-1.11.13/awscli/examples/kinesis/remove-tags-from-stream.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kinesis/remove-tags-from-stream.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/kinesis/split-shard.rst awscli-1.18.69/awscli/examples/kinesis/split-shard.rst --- awscli-1.11.13/awscli/examples/kinesis/split-shard.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kinesis/split-shard.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/kinesis/start-stream-encryption.rst awscli-1.18.69/awscli/examples/kinesis/start-stream-encryption.rst --- awscli-1.11.13/awscli/examples/kinesis/start-stream-encryption.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kinesis/start-stream-encryption.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/kinesis/stop-stream-encryption.rst awscli-1.18.69/awscli/examples/kinesis/stop-stream-encryption.rst --- awscli-1.11.13/awscli/examples/kinesis/stop-stream-encryption.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kinesis/stop-stream-encryption.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/kinesis/update-shard-count.rst awscli-1.18.69/awscli/examples/kinesis/update-shard-count.rst --- awscli-1.11.13/awscli/examples/kinesis/update-shard-count.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kinesis/update-shard-count.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/kms/cancel-key-deletion.rst awscli-1.18.69/awscli/examples/kms/cancel-key-deletion.rst --- awscli-1.11.13/awscli/examples/kms/cancel-key-deletion.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kms/cancel-key-deletion.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,26 @@ +**To cancel the scheduled deletion of a customer managed CMK** + +The following ``cancel-key-deletion`` example cancels the scheduled deletion of a customer managed CMK and re-enables the CMK so you can use it in cryptographic operations. + +The first command in the example uses the ``cancel-key-deletion`` command to cancel the scheduled deletion of the CMK. It uses the ``--key-id`` parameter to identify the CMK. This example uses a key ID value, but you can use either the key ID or the key ARN of the CMK. + + +To re-enable the CMK, use the ``enable-key`` command. To identify the CMK, use the ``--key-id`` parameter. This example uses a key ID value, but you can use either the key ID or the key ARN of the CMK. :: + + aws kms cancel-key-deletion \ + --key-id 1234abcd-12ab-34cd-56ef-1234567890ab + +The ``cancel-key-deletion`` response returns the key ARN of the CMK whose deletion was canceled. :: + + { + "KeyId": "arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab" + } + +When the ``cancel-key-deletion`` command succeeds, the scheduled deletion is canceled. However, the key state of the CMK is ``Disabled``, so you can't use the CMK in cryptographic operations. To restore its functionality, you must re-enable the CMK. :: + + aws kms enable-key \ + --key-id 1234abcd-12ab-34cd-56ef-1234567890ab + +The ``enable-key`` operation does not return a response. To verify that the CMK is re-enabled and there is no deletion date associated with the CMK, use the ``describe-key`` operation. + +For more information, see `Scheduling and Canceling Key Deletion `__ in the *AWS Key Management Service Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/kms/connect-custom-key-store.rst awscli-1.18.69/awscli/examples/kms/connect-custom-key-store.rst --- awscli-1.11.13/awscli/examples/kms/connect-custom-key-store.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kms/connect-custom-key-store.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,10 @@ +**To connect a custom key store** + +The following ``connect-custom-key-store`` example reconnects the specified custom key store. You can use a command like this one to connect a custom key store for the first time or to reconnect a key store that was disconnected. :: + + aws kms connect-custom-key-store \ + --custom-key-store-id cks-1234567890abcdef0 + +This command does not return any output. To verify that the command was effective, use the ``describe-custom-key-stores`` command. + +For more information, see `Connecting and Disconnecting a Custom Key Store `__ in the *AWS Key Management Service Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/kms/create-alias.rst awscli-1.18.69/awscli/examples/kms/create-alias.rst --- awscli-1.11.13/awscli/examples/kms/create-alias.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kms/create-alias.rst 2020-05-28 19:25:50.000000000 +0000 @@ -1,7 +1,9 @@ -The following command creates an alias named ``example-alias`` for the customer master key (CMK) identified by key ID ``1234abcd-12ab-34cd-56ef-1234567890ab``. +**To create an alias for a CMK** -.. code:: +The following ``create-alias`` command creates an alias named ``example-alias`` for the customer master key (CMK) identified by key ID ``1234abcd-12ab-34cd-56ef-1234567890ab``. - aws kms create-alias --alias-name alias/example-alias --target-key-id 1234abcd-12ab-34cd-56ef-1234567890ab +Alias names must begin with ``alias/``. Do not use alias names that begin with ``alias/aws``; these are reserved for use by AWS. :: -Alias names must begin with ``alias/``. Do not use alias names that begin with ``alias/aws``; these are reserved for use by AWS. \ No newline at end of file + aws kms create-alias \ + --alias-name alias/example-alias \ + --target-key-id 1234abcd-12ab-34cd-56ef-1234567890ab diff -Nru awscli-1.11.13/awscli/examples/kms/create-custom-key-store.rst awscli-1.18.69/awscli/examples/kms/create-custom-key-store.rst --- awscli-1.11.13/awscli/examples/kms/create-custom-key-store.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kms/create-custom-key-store.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,25 @@ +**To create a custom key store** + +The following ``create-custom-key-store`` example creates a custom key store with an existing custom key store. + +* This example uses the ``custom-key-store-name`` parameter to assign ``ExampleKeyStore`` as a friendly name for the key store. + +* It uses the ``cloud-hsm-cluster-id`` parameter to identify the ``cluster-1a23b4cdefg`` cluster. + +* It uses the ``key-store-password`` parameter to provide the password of the ``kmsuser`` user in the ``cluster-1a23b4cdefg`` cluster. This gives AWS KMS permission to use the cluster on your behalf. + +* It uses the ``trust-anchor-certificate`` parameter to specify the ``customerCA.crt`` file. In the AWS CLI, the ``file://`` prefix is required. :: + + aws kms create-custom-key-store \ + --custom-key-store-name ExampleKeyStore \ + --cloud-hsm-cluster-id cluster-1a23b4cdefg \ + --key-store-password kmsPswd \ + --trust-anchor-certificate file://customerCA.crt + +The output of this command includes the ID of the new custom key store. You can use this ID to identify the custom key store in other AWS KMS CLI commands. :: + + { + "CustomKeyStoreId": cks-1234567890abcdef0 + } + +For more information, see `Creating a Custom Key Store `__ in the *AWS Key Management Service Developer Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/kms/create-grant.rst awscli-1.18.69/awscli/examples/kms/create-grant.rst --- awscli-1.11.13/awscli/examples/kms/create-grant.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kms/create-grant.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,21 @@ +**To create a grant** + +The following ``create-grant`` example creates a grant that allows the ``exampleUser`` user to use the ``decrypt`` command on the ``1234abcd-12ab-34cd-56ef-1234567890ab`` example CMK. The retiring principal is the ``adminRole`` role. The grant uses the ``EncryptionContextSubset`` grant constraint to allow this permission only when the encryption context in the ``decrypt`` request includes the "Department": "IT" key-value pair. :: + + aws kms create-grant \ + --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ + --grantee-principal arn:aws:iam::123456789012:user/exampleUser \ + --operations Decrypt \ + --constraints EncryptionContextSubset={Department=IT} \ + --retiring-principal arn:aws:iam::123456789012:role/adminRole + +The output of this command includes the ID of the new grant and a grant token. You can use the ID and token to identify the grant to other AWS KMS CLI commands, including ``retire-grant`` and ``revoke-grant``. :: + + { + "GrantId": "1a2b3c4d2f5e69f440bae30eaec9570bb1fb7358824f9ddfa1aa5a0dab1a59b2", + "GrantToken": "" + } + +To view detailed information about the grant, use the ``list-grants`` command. + +For more information, see `Using Grants `__ in the *AWS Key Management Service Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/kms/create-key.rst awscli-1.18.69/awscli/examples/kms/create-key.rst --- awscli-1.11.13/awscli/examples/kms/create-key.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kms/create-key.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,33 @@ +**To create a customer managed CMK in AWS KMS** + +The following ``create-key`` example creates a customer managed CMK. + +* The ``--tags`` parameter uses shorthand syntax to add a tag with a key name ``Purpose`` and value of ``Test``. For information about using shorthand syntax, see `Using Shorthand Syntax with the AWS Command Line Interface `__ in the *AWS CLI User Guide*. +* The ``--description parameter`` adds an optional description. + +Because this doesn't specify a policy, the CMK gets the `default key policy __. To view the key policy, use the ``get-key-policy`` command. To change the key policy, use the ``put-key-policy`` command. :: + + aws kms create-key \ + --tags TagKey=Purpose,TagValue=Test \ + --description "Development test key" + +The ``create-key`` command returns the key metadata, including the key ID and ARN of the new CMK. You can use these values to identify the CMK to other AWS KMS operations. The output does not include the tags. To view the tags for a CMK, use the ``list-resource-tags command``. :: + + { + "KeyMetadata": { + "AWSAccountId": "123456789012", + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", + "Arn": "arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab", + "CreationDate": 1566160362.664, + "Enabled": true, + "Description": "Development test key", + "KeyUsage": "ENCRYPT_DECRYPT", + "KeyState": "Enabled", + "Origin": "AWS_KMS", + "KeyManager": "CUSTOMER" + } + } + +Note: The ``create-key`` command does not let you specify an alias, To create an alias that points to the new CMK, use the ``create-alias`` command. + +For more information, see `Creating Keys `__ in the *AWS Key Management Service Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/kms/decrypt.rst awscli-1.18.69/awscli/examples/kms/decrypt.rst --- awscli-1.11.13/awscli/examples/kms/decrypt.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kms/decrypt.rst 2020-05-28 19:25:50.000000000 +0000 @@ -1,8 +1,11 @@ -The following command demonstrates the recommended way to decrypt data with the AWS CLI. +**Example 1: To decrypt an encrypted file** -.. code:: +The following ``decrypt`` command demonstrates the recommended way to decrypt data with the AWS CLI. :: - aws kms decrypt --ciphertext-blob fileb://ExampleEncryptedFile --output text --query Plaintext | base64 --decode > ExamplePlaintextFile + aws kms decrypt \ + --ciphertext-blob fileb://ExampleEncryptedFile \ + --output text \ + --query Plaintext | base64 --decode > ExamplePlaintextFile The command does several things: @@ -26,14 +29,13 @@ The final part of the command (``> ExamplePlaintextFile``) saves the binary plaintext data to a file. -**Example: Using the AWS CLI to decrypt data from the Windows command prompt** +**Example 2: Using the AWS CLI to decrypt data from the Windows command prompt** -The preceding example assumes the ``base64`` utility is available, which is commonly the case on Linux and Mac OS X. For the Windows command prompt, use ``certutil`` instead of ``base64``. This requires two commands, as shown in the following examples. +The preceding example assumes the ``base64`` utility is available, which is commonly the case on Linux and Mac OS X. For the Windows command prompt, use ``certutil`` instead of ``base64``. This requires two commands, as shown in the following examples. :: -.. code:: + aws kms decrypt \ + --ciphertext-blob fileb://ExampleEncryptedFile \ + --output text \ + --query Plaintext > ExamplePlaintextFile.base64 - aws kms decrypt --ciphertext-blob fileb://ExampleEncryptedFile --output text --query Plaintext > ExamplePlaintextFile.base64 - -.. code:: - - certutil -decode ExamplePlaintextFile.base64 ExamplePlaintextFile \ No newline at end of file + certutil -decode ExamplePlaintextFile.base64 ExamplePlaintextFile diff -Nru awscli-1.11.13/awscli/examples/kms/delete-alias.rst awscli-1.18.69/awscli/examples/kms/delete-alias.rst --- awscli-1.11.13/awscli/examples/kms/delete-alias.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kms/delete-alias.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,12 @@ +**To delete an AWS KMS alias** + +The following ``delete-alias`` example deletes the alias ``alias/example-alias``. + +* The ``--alias-name`` parameter specifies the alias to delete. The alias name must begin with `alias/`. :: + + aws kms delete-alias \ + --alias-name alias/example-alias + +This command produces no output. To find the alias, use the ``list-aliases`` command. + +For more information, see `Working with Aliases `__ in the *AWS Key Management Service Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/kms/delete-custom-key-store.rst awscli-1.18.69/awscli/examples/kms/delete-custom-key-store.rst --- awscli-1.11.13/awscli/examples/kms/delete-custom-key-store.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kms/delete-custom-key-store.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,12 @@ +**To delete a custom key store** + +The following ``delete-custom-key-store`` example deletes the specified custom key store. This command doesn't have any effect on the associated CloudHSM cluster. + +**NOTE:** Before you can delete a custom key store, you must schedule the deletion of all CMKs in the custom key store and then wait for those CMKs to be deleted. Then, you must disconnect the custom key store. :: + + delete-custom-key-store \ + --custom-key-store-id cks-1234567890abcdef0 + +This command does not return any output. To verify that the custom key store is deleted, use the ``describe-custom-key-stores`` command. + +For more information, see `Deleting a Custom Key Store `__ in the *AWS Key Management Service Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/kms/describe-custom-key-stores.rst awscli-1.18.69/awscli/examples/kms/describe-custom-key-stores.rst --- awscli-1.11.13/awscli/examples/kms/describe-custom-key-stores.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kms/describe-custom-key-stores.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,25 @@ +**To get details about a custom key store** + +The following ``describe-custom-key-store`` example displays details for the specified custom key store. You can use this command to get details about a particular custom key store or all custom key stores in an AWS account and Region. + +To identify a particular custom key store, this example uses the ``custom-key-store-name`` parameter with the key store name. If you prefer, you can use the ``custom-key-store-id`` parameter with the key store ID. To get all custom key stores in the account and Region, omit all parameters. :: + + aws kms describe-custom-key-stores \ + --custom-key-store-name ExampleKeyStore + +The output of this command includes useful details about the custom key store including its connection state (``ConnectionState``). If the connection state is ``FAILED``, the output includes a ``ConnectionErrorCode`` field that describes the problem. :: + + { + "CustomKeyStores": [ + { + "CloudHsmClusterId": "cluster-1a23b4cdefg", + "ConnectionState": "CONNECTED", + "CreationDate": "1.599288695918E9", + "CustomKeyStoreId": "cks-1234567890abcdef0", + "CustomKeyStoreName": "ExampleKeyStore", + "TrustAnchorCertificate": "" + } + ] + } + +For more information, see `Viewing a Custom Key Store `__ in the *AWS Key Management Service Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/kms/describe-key.rst awscli-1.18.69/awscli/examples/kms/describe-key.rst --- awscli-1.11.13/awscli/examples/kms/describe-key.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kms/describe-key.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,26 @@ +**To find detailed information about a customer master key (CMK)** + +The following ``describe-key`` example retrieves detailed information about the AWS managed CMK for Amazon S3. + +This example uses an alias name value for the ``--key-id`` parameter, but you can use a key ID, key ARN, alias name, or alias ARN in this command. :: + + aws kms describe-key --key-id alias/aws/s3 + +Output:: + + { + "KeyMetadata": { + "Description": "Default master key that protects my S3 objects when no other key is defined", + "Arn": "arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab", + "KeyState": "Enabled", + "Origin": "AWS_KMS", + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", + "KeyUsage": "ENCRYPT_DECRYPT", + "AWSAccountId": "123456789012", + "Enabled": true, + "KeyManager": "AWS", + "CreationDate": 1566518783.394 + } + } + +For more information, see `Viewing Keys`__ in the *AWS Key Management Service Developer Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/kms/disconnect-custom-key-store.rst awscli-1.18.69/awscli/examples/kms/disconnect-custom-key-store.rst --- awscli-1.11.13/awscli/examples/kms/disconnect-custom-key-store.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kms/disconnect-custom-key-store.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,10 @@ +**To disconnect a custom key store** + +The following ``disconnect-custom-key-store`` example disconnects the specified custom key store. :: + + aws kms disconnect-custom-key-store \ + --custom-key-store-id cks-1234567890abcdef0 + +This command does not return any output. To verify that the command was effective, use the ``describe-custom-key-stores`` command. + +For more information, see `Connecting and Disconnecting a Custom Key Store `__ in the *AWS Key Management Service Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/kms/encrypt.rst awscli-1.18.69/awscli/examples/kms/encrypt.rst --- awscli-1.11.13/awscli/examples/kms/encrypt.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kms/encrypt.rst 2020-05-28 19:25:50.000000000 +0000 @@ -1,8 +1,13 @@ -The following command demonstrates the recommended way to encrypt data with the AWS CLI. +**Example 1: To encrypt the contents of a file on Linux or MacOS** -.. code:: +The following ``encrypt`` command demonstrates the recommended way to encrypt data with the AWS CLI. :: - aws kms encrypt --key-id 1234abcd-12ab-34cd-56ef-1234567890ab --plaintext fileb://ExamplePlaintextFile --output text --query CiphertextBlob | base64 --decode > ExampleEncryptedFile + aws kms encrypt \ + --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ + --plaintext fileb://ExamplePlaintextFile \ + --output text \ + --query CiphertextBlob | base64 \ + --decode > ExampleEncryptedFile The command does several things: @@ -10,7 +15,7 @@ The ``fileb://`` prefix instructs the CLI to read the data to encrypt, called the *plaintext*, from a file and pass the file's contents to the command's ``--plaintext`` parameter. If the file is not in the current directory, type the full path to file. For example: ``fileb:///var/tmp/ExamplePlaintextFile`` or ``fileb://C:\Temp\ExamplePlaintextFile``. - For more information about reading AWS CLI parameter values from a file, see `Loading Parameters from a File `_ in the *AWS Command Line Interface User Guide* and `Best Practices for Local File Parameters `_ on the AWS Command Line Tool Blog. + For more information about reading AWS CLI parameter values from a file, see `Loading Parameters from a File `_ in the *AWS Command Line Interface User Guide* and `Best Practices for Local File Parameters `_ on the AWS Command Line Tool Blog #. Uses the ``--output`` and ``--query`` parameters to control the command's output. @@ -26,14 +31,14 @@ The final part of the command (``> ExampleEncryptedFile``) saves the binary ciphertext to a file to make decryption easier. For an example command that uses the AWS CLI to decrypt data, see the `decrypt examples `_. -**Example: Using the AWS CLI to encrypt data from the Windows command prompt** +**Example 2: Using the AWS CLI to encrypt data on Windows** -The preceding example assumes the ``base64`` utility is available, which is commonly the case on Linux and Mac OS X. For the Windows command prompt, use ``certutil`` instead of ``base64``. This requires two commands, as shown in the following examples. +The preceding example assumes the ``base64`` utility is available, which is commonly the case on Linux and MacOS. For the Windows command prompt, use ``certutil`` instead of ``base64``. This requires two commands, as shown in the following examples. :: -.. code:: + aws kms encrypt \ + --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ + --plaintext fileb://ExamplePlaintextFile \ + --output text \ + --query CiphertextBlob > C:\Temp\ExampleEncryptedFile.base64 - aws kms encrypt --key-id 1234abcd-12ab-34cd-56ef-1234567890ab --plaintext fileb://ExamplePlaintextFile --output text --query CiphertextBlob > C:\Temp\ExampleEncryptedFile.base64 - -.. code:: - - certutil -decode C:\Temp\ExampleEncryptedFile.base64 C:\Temp\ExampleEncryptedFile \ No newline at end of file + certutil -decode C:\Temp\ExampleEncryptedFile.base64 C:\Temp\ExampleEncryptedFile diff -Nru awscli-1.11.13/awscli/examples/kms/generate-random.rst awscli-1.18.69/awscli/examples/kms/generate-random.rst --- awscli-1.11.13/awscli/examples/kms/generate-random.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kms/generate-random.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,52 @@ +**Example 1: To generate a 256-bit random number** + +The following ``generate-random`` example generates a 256-bit (32-byte) random number. + +When you run this command, you must use the ``number-of-bytes`` parameter to specify the length of the random number in bytes. + +You don't specify a CMK when you run this command. Unless you specify a `custom key store `__, AWS KMS generates the random number. It is not associated with any particular CMK. :: + + aws kms generate-random --number-of-bytes 32 + +In the output, the random number is in the ``Plaintext`` field. :: + + { + "Plaintext": "Hcl7v6T2E+Iangu357rhmlKZUnsb/LqzhHiNt6XNfQ0=" + } + +**Example 2: To generate a 256-bit random number and save it to a file (Linux or macOs)** + +The following example uses the ``generate-random`` command to generate a 256-bit (32-byte), base64-encoded random byte string on a Linix or macOS computer. The example decodes the byte string and saves it in the ``ExampleRandom`` file. + +When you run this command, you must use the ``number-of-bytes`` parameter to specify the length of the random number in bytes. + +You don't specify a CMK when you run this command. Unless you specify a `custom key store `__, AWS KMS generates the random number. It is not associated with any particular CMK. + +* The ``--number-of-bytes`` parameter with a value of ``32`` requests a 32-byte (256-bit) string. +* The ``--output`` parameter with a value of ``text`` directs the AWS CLI to return the output as text, instead of JSON. +* The ``--query`` parameter extracts the value of the ``Plaintext`` property from the response. +* The pipe operator ( | ) sends the output of the command to the ``base64`` utility, which decodes the extracted output. +* The redirection operator (>) saves the decoded byte string to the ``ExampleRandom`` file. + + aws kms generate-random --number-of-bytes 32 --output text --query Plaintext | base64 --decode > ExampleRandom + +This command produces no output. + +**Example 3: To generate a 256-bit random number and save it to a file(Windows Command Prompt)** + +The following example uses the ``generate-random`` command to generate a 256-bit (32-byte), base64-encoded random byte string. The example decodes the byte string and saves it in the `ExampleRandom.base64` file. + +This example is the same as the previous example, except that it uses the ``certutil`` utility in Windows to base64-decode the random byte string before saving it in a file. + +The first command generates the base64-encoded random byte string and saves it in a temporary file, ``ExampleRandom.base64``. The second command uses the ``certutil -decode`` command to decode the base64-encoded byte string in the ``ExampleRandom.base64`` file. Then, it saves the decoded byte string in the ``ExampleRandom`` file. :: + + aws kms generate-random --number-of-bytes 32 --output text --query Plaintext > ExampleRandom.base64 + certutil -decode ExampleRandom.base64 ExampleRandom + +Output:: + + Input Length = 18 + Output Length = 12 + CertUtil: -decode command completed successfully. + +For more information, see `GenerateRandom `__ in the *AWS Key Management Service API Reference*. diff -Nru awscli-1.11.13/awscli/examples/kms/get-key-policy.rst awscli-1.18.69/awscli/examples/kms/get-key-policy.rst --- awscli-1.11.13/awscli/examples/kms/get-key-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kms/get-key-policy.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,20 @@ +**To copy a key policy from one CMK to another CMK** + +The following ``get-key-policy`` example gets the key policy from one CMK and saves it in a text file. Then, it replaces the policy of a different CMK using the text file as the policy input. + +Because the ``--policy`` parameter of ``put-key-policy`` requires a string, you must use the ``--output text`` option to return the output as a text string instead of JSON. :: + + aws kms get-key-policy \ + --policy-name default \ + --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ + --query Policy \ + --output text > policy.txt + + aws kms put-key-policy \ + --policy-name default \ + --key-id 0987dcba-09fe-87dc-65ba-ab0987654321 \ + --policy file://policy.txt + +This command produces no output. + +For more information, see `PutKeyPolicy `__ in the *AWS KMS API Reference*. diff -Nru awscli-1.11.13/awscli/examples/kms/list-aliases.rst awscli-1.18.69/awscli/examples/kms/list-aliases.rst --- awscli-1.11.13/awscli/examples/kms/list-aliases.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kms/list-aliases.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,62 @@ +**Example 1: To list all aliases in an AWS account and Region** + +The following example uses the ``list-aliases`` command to list all aliases in the default Region of the AWS account. The output includes aliases associated with AWS managed CMKs and customer managed CMKs. :: + + aws kms list-aliases + +Output:: + + { + "Aliases": [ + { + "AliasArn": "arn:aws:kms:us-west-2:111122223333:alias/testKey", + "AliasName": "alias/testKey", + "TargetKeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + }, + { + "AliasArn": "arn:aws:kms:us-west-2:111122223333:alias/FinanceDept", + "AliasName": "alias/FinanceDept", + "TargetKeyId": "0987dcba-09fe-87dc-65ba-ab0987654321" + }, + { + "AliasArn": "arn:aws:kms:us-west-2:111122223333:alias/aws/dynamodb", + "AliasName": "alias/aws/dynamodb", + "TargetKeyId": "1a2b3c4d-5e6f-1a2b-3c4d-5e6f1a2b3c4d" + }, + { + "AliasArn": "arn:aws:kms:us-west-2:111122223333:alias/aws/ebs", + "AliasName": "alias/aws/ebs", + "TargetKeyId": "0987ab65-43cd-21ef-09ab-87654321cdef" + }, + ... + ] + } + +**Example 2: To list all aliases for a particular CMK** + +The following example uses the ``list-aliases`` command and its ``key-id`` parameter to list all aliases that are associated with a particular CMK. + +Each alias is associated with only one CMK, but a CMK can have multiple aliases. This command is very useful because the AWS KMS console lists only one alias for each CMK. To find all aliases for a CMK, you must use the ``list-aliases`` command. + +This example uses the key ID of the CMK for the ``--key-id`` parameter, but you can use a key ID, key ARN, alias name, or alias ARN in this command. :: + + aws kms list-aliases --key-id 1234abcd-12ab-34cd-56ef-1234567890ab + +Output:: + + { + "Aliases": [ + { + "TargetKeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", + "AliasArn": "arn:aws:kms:us-west-2:111122223333:alias/oregon-test-key", + "AliasName": "alias/oregon-test-key" + }, + { + "TargetKeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", + "AliasArn": "arn:aws:kms:us-west-2:111122223333:alias/project121-test", + "AliasName": "alias/project121-test" + } + ] + } + +For more information, see `Working with Aliases `__ in the *AWS Key Management Service Developer Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/kms/list-grants.rst awscli-1.18.69/awscli/examples/kms/list-grants.rst --- awscli-1.11.13/awscli/examples/kms/list-grants.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kms/list-grants.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,41 @@ +**To view the grants on an AWS CMK** + +The following ``list-grants`` example displays all of the grants on the specified AWS managed CMK for Amazon DynamoDB in your account. This grant allows DynamoDB to use the CMK on your behalf to encrypt a DynamoDB table before writing it to disk. You can use a command like this one to view the grants on the AWS managed CMKs and customer managed CMKs in the AWS account and Region. + +This command uses the ``key-id`` parameter with a key ID to identify the CMK. You can use a key ID or key ARN to identify the CMK. To get the key ID or key ARN of an AWS managed CMK, use the ``list-keys`` or ``list-aliases`` command. :: + + aws kms list-grants \ + --key-id 1234abcd-12ab-34cd-56ef-1234567890ab + +The output shows that the grant gives Amazon DynamoDB permission to use the CMK for cryptographic operations, and gives it permission to view details about the CMK (``DescribeKey``) and to retire grants (``RetireGrant``). The ``EncryptionContextSubset`` constraint limits these permission to requests that include the specified encryption context pairs. As a result, the permissions in the grant are effective only on specified account and DynamoDB table. :: + + { + "Grants": [ + { + "Constraints": { + "EncryptionContextSubset": { + "aws:dynamodb:subscriberId": "123456789012", + "aws:dynamodb:tableName": "Services" + } + }, + "IssuingAccount": "arn:aws:iam::123456789012:root", + "Name": "8276b9a6-6cf0-46f1-b2f0-7993a7f8c89a", + "Operations": [ + "Decrypt", + "Encrypt", + "GenerateDataKey", + "ReEncryptFrom", + "ReEncryptTo", + "RetireGrant", + "DescribeKey" + ], + "GrantId": "1667b97d27cf748cf05b487217dd4179526c949d14fb3903858e25193253fe59", + "KeyId": "arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab", + "RetiringPrincipal": "dynamodb.us-west-2.amazonaws.com", + "GranteePrincipal": "dynamodb.us-west-2.amazonaws.com", + "CreationDate": 1518567315.0 + } + ] + } + +For more information, see `Using Grants `__ in the *AWS Key Management Service Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/kms/put-key-policy.rst awscli-1.18.69/awscli/examples/kms/put-key-policy.rst --- awscli-1.11.13/awscli/examples/kms/put-key-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kms/put-key-policy.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,80 @@ +**To change the key policy for a customer master key (CMK)** + +The following ``put-key-policy`` example changes the key policy for a customer managed CMK. + +To begin, create a key policy and save it in a local JSON file. In this example, the file is ``key_policy.json``. You can also specify the key policy as a string value of the ``policy`` parameter. + +The first statement in this key policy gives the AWS account permission to use IAM policies to control access to the CMK. The second statement gives the ``test-user`` user permission to run the ``describe-key`` and ``list-keys`` commands on the CMK. + +Contents of ``key_policy.json``:: + + { + "Version" : "2012-10-17", + "Id" : "key-default-1", + "Statement" : [ + { + "Sid" : "Enable IAM User Permissions", + "Effect" : "Allow", + "Principal" : { + "AWS" : "arn:aws:iam::111122223333:root" + }, + "Action" : "kms:", + "Resource" : "*" + }, + { + "Sid" : "Allow Use of Key", + "Effect" : "Allow", + "Principal" : { + "AWS" : "arn:aws:iam::111122223333:user/test-user" + }, + "Action" : [ + "kms:DescribeKey", + "kms:ListKeys" + ], + "Resource" : "*" + } + ] + } + +To identify the CMK, this example uses the key ID, but you can also usa key ARN. To specify the key policy, the command uses the ``policy`` parameter. To indicate that the policy is in a file, it uses the required ``file://`` prefix. This prefix is required to identify files on all supported operating systems. Finally, the command uses the ``policy-name`` parameter with a value of ``default``. This parameter is required, even though ``default`` is the only valid value. :: + + aws kms put-key-policy \ + --policy-name default \ + --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ + --policy file://key_policy.json + +This command does not produce any output. To verify that the command was effective, use the ``get-key-policy`` command. The following example command gets the key policy for the same CMK. The ``output`` parameter with a value of ``text`` returns a text format that is easy to read. :: + + aws kms get-key-policy \ + --policy-name default \ + --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ + --output text + +Output:: + + { + "Version" : "2012-10-17", + "Id" : "key-default-1", + "Statement" : [ + { + "Sid" : "Enable IAM User Permissions", + "Effect" : "Allow", + "Principal" : { + "AWS" : "arn:aws:iam::111122223333:root" + }, + "Action" : "kms:", + "Resource" : "*" + }, + { + "Sid" : "Allow Use of Key", + "Effect" : "Allow", + "Principal" : { + "AWS" : "arn:aws:iam::111122223333:user/test-user" + }, + "Action" : [ "kms:Describe", "kms:List" ], + "Resource" : "*" + } + ] + } + +For more information, see `Changing a Key Policy `__ in the *AWS Key Management Service Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/kms/re-encrypt.rst awscli-1.18.69/awscli/examples/kms/re-encrypt.rst --- awscli-1.11.13/awscli/examples/kms/re-encrypt.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kms/re-encrypt.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,76 @@ +**Example 1: To re-encrypt encrypted data under a different CMK** + +The following ``re-encrypt`` example re-encrypts data that was encrypted using the ``encrypt`` operation in the AWS CLI. You can use the ``re-encrypt`` command to re-encrypt the result of any AWS KMS operation that encrypted data or data keys. + +This example writes the output to the command line so you can see the all of the properties in the response. However, unless you're testing or demonstrating this operation, you should base64-decode the encrypted data and save it in a file. + +The command in this example re-encrypts the data under a different CMK, but you can re-encrypt it under the same CMK to change characteristics of the encryption, such as the encryption context. + +To run this command, you must have ``kms:ReEncryptFrom`` permission on the CMK that encrypted the data and ``kms:ReEncryptTo`` permissions on the CMK that you use to re-encrypt the data. + +* The ``--ciphertext-blob`` parameter identifies the ciphertext to re-encrypt. The file ``ExampleEncryptedFile`` contains the base64-decoded output of the encrypt command. +* The ``fileb://`` prefix of the file name tells the CLI to treat the input file as binary instead of text. +* The ``--destination-key-id`` parameter specifies the CMK under which the data is to be re-encrypted. This example uses the key ID to identify the CMK, but you can use a key ID, key ARN, alias name, or alias ARN in this command. +* You do not need to specify the CMK that was used to encrypt the data. AWS KMS gets that information from metadata in the ciphertext. :: + + aws kms re-encrypt \ + --ciphertext-blob fileb://ExampleEncryptedFile \ + --destination-key-id 0987dcba-09fe-87dc-65ba-ab0987654321 + +The output includes the following properties: + +* The ``SourceKeyID`` is the key ID of the CMK that originally encrypted the CMK. +* The ``KeyId`` is the ID of the CMK that re-encrypted the data. +* The ``CiphertextBlob``, which is the re-encrypted data in base64-encoded format. :: + + { + "CiphertextBlob": "AQICAHgJtIvJqgOGUX6NLvVXnW5OOQT...", + "SourceKeyId": "arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab", + "KeyId": "arn:aws:kms:us-west-2:123456789012:key/0987dcba-09fe-87dc-65ba-ab0987654321" + } + +**Example 2: To re-encrypt encrypted data under a different CMK (Linux or macOs)** + +The following ``re-encrypt`` example demonstrates the recommended way to re-encrypt data with the AWS CLI. This example re-encrypts the ciphertext that was encrypted by the encrypt command, but you can use the same procedure to re-encrypt data keys. + +This example is the same as the previous example except that it does not write the output to the command line. Instead, after re-encrypting the ciphertext under a different CMK, it extracts the re-encrypted ciphertext from the response, base64-decodes it, and saves the binary data in a file. You can store the file safely. Then, you can use the file in decrypt or re-encrypt commands in the AWS CLI. + +To run this command, you must have ``kms:ReEncryptFrom`` permission on the CMK that encrypted the data and ``kms:ReEncryptTo`` permissions on the CMK that will re-encrypt the data. +The ``--ciphertext-blob`` parameter identifies the ciphertext to re-encrypt. + +* The ``fileb://`` prefix tells the CLI to treat the input file as binary instead of text. +* The ``--destination-key-id`` parameter specifies the CMK under which the data is re-encrypted. This example uses the key ID to identify the CMK, but you can use a key ID, key ARN, alias name, or alias ARN in this command. +* You do not need to specify the CMK that was used to encrypt the data. AWS KMS gets that information from metadata in the ciphertext. +* The ``--output`` parameter with a value of ``text`` directs the AWS CLI to return the output as text, instead of JSON. +* The ``--query`` parameter extracts the value of the ``CiphertextBlob`` property from the response. +* The pipe operator ( | ) sends the output of the CLI command to the ``base64`` utility, which decodes the extracted output. The ``CiphertextBlob`` that the re-encrypt operation returns is base64-encoded text. However, the ``decrypt`` and ``re-encrypt`` commands require binary data. The example decodes the base64-encoded ciphertext back to binary and then saves it in a file. You can use the file as input to the decrypt or re-encrypt commands. :: + + aws kms re-encrypt \ + --ciphertext-blob fileb://ExampleEncryptedFile \ + --destination-key-id 0987dcba-09fe-87dc-65ba-ab0987654321 \ + --output text \ + --query CiphertextBlob | base64 --decode > ExampleReEncryptedFile + +This command produces no output on screen because it is redirected to a file. + +**Example 3: To re-encrypted encrypted data under a different CMK (Windows Command Prompt)** + +This example is the same as the previous example, except that it uses the ``certutil`` utility in Windows to base64-decode the ciphertext before saving it in a file. + +* The first command re-encrypts the ciphertext and saves the base64-encoded ciphertext in a temporary file named ``ExampleReEncryptedFile.base64``. +* The second command uses the ``certutil -decode`` command to decode the base64-encoded ciphertext in the file to binary. Then, it saves the binary ciphertext in the file ``ExampleReEncryptedFile``. This file is ready to be used in a decrypt or re-encrypt command in the AWS CLI. :: + + aws kms re-encrypt ^ + --ciphertext-blob fileb://ExampleEncryptedFile ^ + --destination-key-id 0987dcba-09fe-87dc-65ba-ab0987654321 ^ + --output text ^ + --query CiphertextBlob > ExampleReEncryptedFile.base64 + certutil -decode ExampleReEncryptedFile.base64 ExampleReEncryptedFile + +Output:: + + Input Length = 18 + Output Length = 12 + CertUtil: -decode command completed successfully. + +For more information, see `ReEncrypt `__ in the *AWS Key Management Service API Reference*. diff -Nru awscli-1.11.13/awscli/examples/kms/schedule-key-deletion.rst awscli-1.18.69/awscli/examples/kms/schedule-key-deletion.rst --- awscli-1.11.13/awscli/examples/kms/schedule-key-deletion.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kms/schedule-key-deletion.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,19 @@ +**To schedule the deletion of a customer managed CMK.** + +The following ``schedule-key-deletion`` example schedules the specified customer managed CMK to be deleted in 15 days. + +* The ``--key-id`` parameter identifies the CMK. This example uses a key ARN value, but you can use either the key ID or the ARN of the CMK. +* The ``--pending-window-in-days`` parameter specifies the length of the waiting period. By default, the waiting period is 30 days. This example specifies a value of 15, which tells AWS to permanently delete the CMK 15 days after the command completes. :: + + aws kms schedule-key-deletion \ + --key-id arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab \ + --pending-window-in-days 15 + +The response returns the key ARN and the deletion date in Unix time. To view the deletion date in local time, use the AWS KMS console. :: + + { + "KeyId": "arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab", + "DeletionDate": 1567382400.0 + } + +For more information, see `Deleting Customer Master Keys `__ in the *AWS Key Management Service Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/kms/update-alias.rst awscli-1.18.69/awscli/examples/kms/update-alias.rst --- awscli-1.11.13/awscli/examples/kms/update-alias.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kms/update-alias.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,14 @@ +**To associate an alias with a different CMK** + +The following ``update-alias`` example associates the alias ``alias/test-key`` with a different CMK. + +* The ``--alias-name`` parameter specifies the alias. The alias name value must begin with ``alias/``. +* The ``--target-key-id`` parameter specifies the CMK to associate with the alias. You don't need to specify the current CMK for the alias. :: + + aws kms update-alias \ + --alias-name alias/test-key \ + --target-key-id 1234abcd-12ab-34cd-56ef-1234567890ab + +This command produces no output. To find the alias, use the ``list-aliases`` command. + +For more information, see `Working with Aliases `__ in the *AWS Key Management Service Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/kms/update-custom-key-store.rst awscli-1.18.69/awscli/examples/kms/update-custom-key-store.rst --- awscli-1.11.13/awscli/examples/kms/update-custom-key-store.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kms/update-custom-key-store.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,13 @@ +**To edit custom key store settings** + +The following ``update-custom-key-store`` example provides the current password for the ``kmsuser`` in the CloudHSM cluster that is associated with the specified key store. This command doesn't change the ``kmsuser`` password. It just tells AWS KMS the current password. If KMS doesn't have the current ``kmsuser`` password, it cannot connect to the custom key store. + +**NOTE:** Before updating the custom key store, you must disconnect it. Use the ``disconnect-custom-key-store`` command. After the command completes, you can reconnect the custom key store. Use the ``connect-custom-key-store`` command. :: + + aws kms update-custom-key-store \ + --custom-key-store-id cks-1234567890abcdef0 \ + --key-store-password ExamplePassword + +This command does not return any output. To verify that the password change was effective, connect the custom key store. + +For more information, see `Editing Custom Key Store Settings `__ in the *AWS Key Management Service Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/kms/update-key-description.rst awscli-1.18.69/awscli/examples/kms/update-key-description.rst --- awscli-1.11.13/awscli/examples/kms/update-key-description.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/kms/update-key-description.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,29 @@ +**Example 1: To delete the description of a customer managed CMK** + +The following ``update-key-description`` example deletes the description to a customer managed CMK. + +* The ``--key-id`` parameter identifies the CMK in the command. This example uses a key ID value, but you can use either the key ID or the key ARN of the CMK. +* The ``--description`` parameter with an empty string value ('') deletes the existing description. :: + + aws kms update-key-description \ + --key-id 0987dcba-09fe-87dc-65ba-ab0987654321 \ + --description '' + +This command produces no output. To view the description of a CMK, use the the describe-key command. + +For more information, see `UpdateKeyDescription `__ in the *AWS Key Management Service API Reference*. + +**Example 2: To add or change a description to a customer managed CMK** + +The following ``update-key-description`` example adds a description to a customer managed CMK. You can use the same command to change an existing description. + +* The ``--key-id`` parameter identifies the CMK in the command. This example uses a key ARN value, but you can use either the key ID or the key ARN of the CMK. +* The ``--description`` parameter specifies the new description. The value of this parameter replaces the current description of the CMK, if any. :: + + aws kms update-key-description \ + --key-id arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab \ + --description "IT Department test key" + +This command produces no output. To view the description of a CMK, use the ``describe-key`` command. + +For more information, see `UpdateKeyDescription `__ in the *AWS Key Management Service API Reference*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/lambda/add-layer-version-permission.rst awscli-1.18.69/awscli/examples/lambda/add-layer-version-permission.rst --- awscli-1.11.13/awscli/examples/lambda/add-layer-version-permission.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/add-layer-version-permission.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,28 @@ +**To add permissions to a layer version** + +The following ``add-layer-version-permission`` example grants permission for the specified account to use version 1 of the layer ``my-layer``. :: + + aws lambda add-layer-version-permission \ + --layer-name my-layer \ + --statement-id xaccount \ + --action lambda:GetLayerVersion \ + --principal 123456789012 \ + --version-number 1 + +Output:: + + { + "RevisionId": "35d87451-f796-4a3f-a618-95a3671b0a0c", + "Statement": + { + "Sid":"xaccount", + "Effect":"Allow", + "Principal":{ + "AWS":"arn:aws:iam::210987654321:root" + }, + "Action":"lambda:GetLayerVersion", + "Resource":"arn:aws:lambda:us-east-2:123456789012:layer:my-layer:1" + } + } + +For more information, see `AWS Lambda Layers `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/add-permission.rst awscli-1.18.69/awscli/examples/lambda/add-permission.rst --- awscli-1.11.13/awscli/examples/lambda/add-permission.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/add-permission.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,26 @@ +**To add permissions to an existing Lambda function** + +The following ``add-permission`` example grants the Amazon SNS service permission to invoke a function named ``my-function``. :: + + aws lambda add-permission \ + --function-name my-function \ + --action lambda:InvokeFunction \ + --statement-id sns \ + --principal sns.amazonaws.com + +Output:: + + { + "Statement": + { + "Sid":"sns", + "Effect":"Allow", + "Principal":{ + "Service":"sns.amazonaws.com" + }, + "Action":"lambda:InvokeFunction", + "Resource":"arn:aws:lambda:us-east-2:123456789012:function:my-function" + } + } + +For more information, see `Using Resource-based Policies for AWS Lambda `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/create-alias.rst awscli-1.18.69/awscli/examples/lambda/create-alias.rst --- awscli-1.11.13/awscli/examples/lambda/create-alias.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/create-alias.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,21 @@ +**To create an alias for a Lambda function** + +The following ``create-alias`` example creates an alias named ``LIVE`` that points to version 1 of the ``my-function`` Lambda function. :: + + aws lambda create-alias \ + --function-name my-function \ + --description "alias for live version of function" \ + --function-version 1 \ + --name LIVE + +Output:: + + { + "FunctionVersion": "1", + "Name": "LIVE", + "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:LIVE", + "RevisionId": "873282ed-4cd3-4dc8-a069-d0c647e470c6", + "Description": "alias for live version of function" + } + +For more information, see `Configuring AWS Lambda Function Aliases `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/create-event-source-mapping.rst awscli-1.18.69/awscli/examples/lambda/create-event-source-mapping.rst --- awscli-1.11.13/awscli/examples/lambda/create-event-source-mapping.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/create-event-source-mapping.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,22 @@ +**To create a mapping between an event source and an AWS Lambda function** + +The following ``create-event-source-mapping`` example creates a mapping between an SQS queue and the ``my-function`` Lambda function. :: + + aws lambda create-event-source-mapping \ + --function-name my-function \ + --batch-size 5 \ + --event-source-arn arn:aws:sqs:us-west-2:123456789012:mySQSqueue + +Output:: + + { + "UUID": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "StateTransitionReason": "USER_INITIATED", + "LastModified": 1569284520.333, + "BatchSize": 5, + "State": "Creating", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "EventSourceArn": "arn:aws:sqs:us-west-2:123456789012:mySQSqueue" + } + +For more information, see `AWS Lambda Event Source Mapping `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/create-function.rst awscli-1.18.69/awscli/examples/lambda/create-function.rst --- awscli-1.11.13/awscli/examples/lambda/create-function.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/create-function.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,36 @@ +**To create a Lambda function** + +The following ``create-function`` example creates a Lambda function named ``my-function``. :: + + aws lambda create-function \ + --function-name my-function \ + --runtime nodejs10.x \ + --zip-file fileb://my-function.zip \ + --handler my-function.handler \ + --role arn:aws:iam::123456789012:role/service-role/MyTestFunction-role-tges6bf4 + +Contents of ``my-function.zip``: +This file is a deployment package that contains your function code and any dependencies. + +Output:: + + { + "TracingConfig": { + "Mode": "PassThrough" + }, + "CodeSha256": "PFn4S+er27qk+UuZSTKEQfNKG/XNn7QJs90mJgq6oH8=", + "FunctionName": "my-function", + "CodeSize": 308, + "RevisionId": "873282ed-4cd3-4dc8-a069-d0c647e470c6", + "MemorySize": 128, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "Version": "$LATEST", + "Role": "arn:aws:iam::123456789012:role/service-role/MyTestFunction-role-zgur6bf4", + "Timeout": 3, + "LastModified": "2019-08-14T22:26:11.234+0000", + "Handler": "my-function.handler", + "Runtime": "nodejs10.x", + "Description": "" + } + +For more information, see `AWS Lambda Function Configuration `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/delete-alias.rst awscli-1.18.69/awscli/examples/lambda/delete-alias.rst --- awscli-1.11.13/awscli/examples/lambda/delete-alias.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/delete-alias.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To delete an alias of a Lambda function** + +The following ``delete-alias`` example deletes the alias named ``LIVE`` from the ``my-function`` Lambda function. :: + + aws lambda delete-alias \ + --function-name my-function \ + --name LIVE + +This command produces no output. + +For more information, see `Configuring AWS Lambda Function Aliases `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/delete-event-source-mapping.rst awscli-1.18.69/awscli/examples/lambda/delete-event-source-mapping.rst --- awscli-1.11.13/awscli/examples/lambda/delete-event-source-mapping.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/delete-event-source-mapping.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,20 @@ +**To delete the mapping between an event source and an AWS Lambda function** + +The following ``delete-event-source-mapping`` example deletes the mapping between an SQS queue and the ``my-function`` Lambda function. :: + + aws lambda delete-event-source-mapping \ + --uuid a1b2c3d4-5678-90ab-cdef-11111EXAMPLE + +Output:: + + { + "UUID": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "StateTransitionReason": "USER_INITIATED", + "LastModified": 1569285870.271, + "BatchSize": 5, + "State": "Deleting", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "EventSourceArn": "arn:aws:sqs:us-west-2:123456789012:mySQSqueue" + } + +For more information, see `AWS Lambda Event Source Mapping `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/delete-function-concurrency.rst awscli-1.18.69/awscli/examples/lambda/delete-function-concurrency.rst --- awscli-1.11.13/awscli/examples/lambda/delete-function-concurrency.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/delete-function-concurrency.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,10 @@ +**To remove the reserved concurrent execution limit from a function** + +The following ``delete-function-concurrency`` example deletes the reserved concurrent execution limit from the ``my-function`` function. :: + + aws lambda delete-function-concurrency \ + --function-name my-function + +This command produces no output. + +For more information, see `Reserving Concurrency for a Lambda Function `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/delete-function-event-invoke-config.rst awscli-1.18.69/awscli/examples/lambda/delete-function-event-invoke-config.rst --- awscli-1.11.13/awscli/examples/lambda/delete-function-event-invoke-config.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/delete-function-event-invoke-config.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/lambda/delete-function.rst awscli-1.18.69/awscli/examples/lambda/delete-function.rst --- awscli-1.11.13/awscli/examples/lambda/delete-function.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/delete-function.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a Lambda function** + +The following ``delete-function`` example deletes the Lambda function named ``my-function``. :: + + aws lambda delete-function \ + --function-name my-function + +This command produces no output. + +For more information, see `AWS Lambda Function Configuration `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/delete-layer-version.rst awscli-1.18.69/awscli/examples/lambda/delete-layer-version.rst --- awscli-1.11.13/awscli/examples/lambda/delete-layer-version.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/delete-layer-version.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To delete a version of a Lambda layer** + +The following ``delete-layer-version`` example deletes version 2 of the layer named ``my-layer``. :: + + aws lambda delete-layer-version \ + --layer-name my-layer \ + --version-number 2 + +This command produces no output. + +For more information, see `AWS Lambda Layers `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/delete-provisioned-concurrency-config.rst awscli-1.18.69/awscli/examples/lambda/delete-provisioned-concurrency-config.rst --- awscli-1.11.13/awscli/examples/lambda/delete-provisioned-concurrency-config.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/delete-provisioned-concurrency-config.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/lambda/get-account-settings.rst awscli-1.18.69/awscli/examples/lambda/get-account-settings.rst --- awscli-1.11.13/awscli/examples/lambda/get-account-settings.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/get-account-settings.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,23 @@ +**To retrieve details about your account in an AWS Region** + +The following ``get-account-settings`` example displays the Lambda limits and usage information for your account. :: + + aws lambda get-account-settings + +Output:: + + { + "AccountLimit": { + "CodeSizeUnzipped": 262144000, + "UnreservedConcurrentExecutions": 1000, + "ConcurrentExecutions": 1000, + "CodeSizeZipped": 52428800, + "TotalCodeSize": 80530636800 + }, + "AccountUsage": { + "FunctionCount": 4, + "TotalCodeSize": 9426 + } + } + +For more information, see `AWS Lambda Limits `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/get-alias.rst awscli-1.18.69/awscli/examples/lambda/get-alias.rst --- awscli-1.11.13/awscli/examples/lambda/get-alias.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/get-alias.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,19 @@ +**To retrieve details about a function alias** + +The following ``get-alias`` example displays details for the alias named ``LIVE`` on the ``my-function`` Lambda function. :: + + aws lambda get-alias \ + --function-name my-function \ + --name LIVE + +Output:: + + { + "FunctionVersion": "3", + "Name": "LIVE", + "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:LIVE", + "RevisionId": "594f41fb-b85f-4c20-95c7-6ca5f2a92c93", + "Description": "alias for live version of function" + } + +For more information, see `Configuring AWS Lambda Function Aliases `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/get-event-source-mapping.rst awscli-1.18.69/awscli/examples/lambda/get-event-source-mapping.rst --- awscli-1.11.13/awscli/examples/lambda/get-event-source-mapping.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/get-event-source-mapping.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,20 @@ +**To retrieve details about an event source mapping** + +The following ``get-event-source-mapping`` example displays the details for the mapping between an SQS queue and the ``my-function`` Lambda function. :: + + aws lambda get-event-source-mapping \ + --uuid "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" + +Output:: + + { + "UUID": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "StateTransitionReason": "USER_INITIATED", + "LastModified": 1569284520.333, + "BatchSize": 5, + "State": "Enabled", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "EventSourceArn": "arn:aws:sqs:us-west-2:123456789012:mySQSqueue" + } + +For more information, see `AWS Lambda Event Source Mapping `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/get-function-concurrency.rst awscli-1.18.69/awscli/examples/lambda/get-function-concurrency.rst --- awscli-1.11.13/awscli/examples/lambda/get-function-concurrency.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/get-function-concurrency.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/lambda/get-function-configuration.rst awscli-1.18.69/awscli/examples/lambda/get-function-configuration.rst --- awscli-1.11.13/awscli/examples/lambda/get-function-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/get-function-configuration.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,34 @@ +**To retrieve the version-specific settings of a Lambda function** + +The following ``get-function-configuration`` example displays the settings for version 2 of the ``my-function`` function. :: + + aws lambda get-function-configuration \ + --function-name my-function:2 + +Output:: + + { + "FunctionName": "my-function", + "LastModified": "2019-09-26T20:28:40.438+0000", + "RevisionId": "e52502d4-9320-4688-9cd6-152a6ab7490d", + "MemorySize": 256, + "Version": "2", + "Role": "arn:aws:iam::123456789012:role/service-role/my-function-role-uy3l9qyq", + "Timeout": 3, + "Runtime": "nodejs10.x", + "TracingConfig": { + "Mode": "PassThrough" + }, + "CodeSha256": "5tT2qgzYUHaqwR716pZ2dpkn/0J1FrzJmlKidWoaCgk=", + "Description": "", + "VpcConfig": { + "SubnetIds": [], + "VpcId": "", + "SecurityGroupIds": [] + }, + "CodeSize": 304, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:2", + "Handler": "index.handler" + } + +For more information, see `AWS Lambda Function Configuration `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/get-function-event-invoke-config.rst awscli-1.18.69/awscli/examples/lambda/get-function-event-invoke-config.rst --- awscli-1.11.13/awscli/examples/lambda/get-function-event-invoke-config.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/get-function-event-invoke-config.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/lambda/get-function.rst awscli-1.18.69/awscli/examples/lambda/get-function.rst --- awscli-1.11.13/awscli/examples/lambda/get-function.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/get-function.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,43 @@ +**To retrieve information about a function** + +The following ``get-function`` example displays information about the ``my-function`` function. :: + + aws lambda get-function \ + --function-name my-function + +Output:: + + { + "Concurrency": { + "ReservedConcurrentExecutions": 100 + }, + "Code": { + "RepositoryType": "S3", + "Location": "https://awslambda-us-west-2-tasks.s3.us-west-2.amazonaws.com/snapshots/123456789012/my-function..." + }, + "Configuration": { + "TracingConfig": { + "Mode": "PassThrough" + }, + "Version": "$LATEST", + "CodeSha256": "5tT2qgzYUHoqwR616pZ2dpkn/0J1FrzJmlKidWaaCgk=", + "FunctionName": "my-function", + "VpcConfig": { + "SubnetIds": [], + "VpcId": "", + "SecurityGroupIds": [] + }, + "MemorySize": 128, + "RevisionId": "28f0fb31-5c5c-43d3-8955-03e76c5c1075", + "CodeSize": 304, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "Handler": "index.handler", + "Role": "arn:aws:iam::123456789012:role/service-role/helloWorldPython-role-uy3l9qyq", + "Timeout": 3, + "LastModified": "2019-09-24T18:20:35.054+0000", + "Runtime": "nodejs10.x", + "Description": "" + } + } + +For more information, see `AWS Lambda Function Configuration `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/get-layer-version-by-arn.rst awscli-1.18.69/awscli/examples/lambda/get-layer-version-by-arn.rst --- awscli-1.11.13/awscli/examples/lambda/get-layer-version-by-arn.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/get-layer-version-by-arn.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,27 @@ +**To retrieve information about a Lambda layer version** + +The following ``get-layer-version-by-arn`` example displays information about the layer version with the specified Amazon Resource Name (ARN). :: + + aws lambda get-layer-version-by-arn \ + --arn "arn:aws:lambda:us-west-2:123456789012:layer:AWSLambda-Python37-SciPy1x:2" + +Output:: + + { + "LayerVersionArn": "arn:aws:lambda:us-west-2:123456789012:layer:AWSLambda-Python37-SciPy1x:2", + "Description": "AWS Lambda SciPy layer for Python 3.7 (scipy-1.1.0, numpy-1.15.4) https://github.com/scipy/scipy/releases/tag/v1.1.0 https://github.com/numpy/numpy/releases/tag/v1.15.4", + "CreatedDate": "2018-11-12T10:09:38.398+0000", + "LayerArn": "arn:aws:lambda:us-west-2:123456789012:layer:AWSLambda-Python37-SciPy1x", + "Content": { + "CodeSize": 41784542, + "CodeSha256": "GGmv8ocUw4cly0T8HL0Vx/f5V4RmSCGNjDIslY4VskM=", + "Location": "https://awslambda-us-west-2-layers.s3.us-west-2.amazonaws.com/snapshots/123456789012/..." + }, + "Version": 2, + "CompatibleRuntimes": [ + "python3.7" + ], + "LicenseInfo": "SciPy: https://github.com/scipy/scipy/blob/master/LICENSE.txt, NumPy: https://github.com/numpy/numpy/blob/master/LICENSE.txt" + } + +For more information, see `AWS Lambda Layers `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/get-layer-version-policy.rst awscli-1.18.69/awscli/examples/lambda/get-layer-version-policy.rst --- awscli-1.11.13/awscli/examples/lambda/get-layer-version-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/get-layer-version-policy.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,29 @@ +**To retrieve the permissions policy for a Lambda layer version** + +The following ``get-layer-version-policy`` example displays policy information about version 1 for the layer named ``my-layer``. :: + + aws lambda get-layer-version-policy \ + --layer-name my-layer \ + --version-number 1 + +Output:: + + { + "Policy": { + "Version":"2012-10-17", + "Id":"default", + "Statement": + [ + { + "Sid":"xaccount", + "Effect":"Allow", + "Principal": {"AWS":"arn:aws:iam::123456789012:root"}, + "Action":"lambda:GetLayerVersion", + "Resource":"arn:aws:lambda:us-west-2:123456789012:layer:my-layer:1" + } + ] + }, + "RevisionId": "c68f21d2-cbf0-4026-90f6-1375ee465cd0" + } + +For more information, see `AWS Lambda Layers `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/get-layer-version.rst awscli-1.18.69/awscli/examples/lambda/get-layer-version.rst --- awscli-1.11.13/awscli/examples/lambda/get-layer-version.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/get-layer-version.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,29 @@ +**To retrieve information about a Lambda layer version** + +The following ``get-layer-version`` example displays information for version 1 of the layer named ``my-layer``. :: + + aws lambda get-layer-version \ + --layer-name my-layer \ + --version-number 1 + +Output:: + + { + "Content": { + "Location": "https://awslambda-us-east-2-layers.s3.us-east-2.amazonaws.com/snapshots/123456789012/my-layer-4aaa2fbb-ff77-4b0a-ad92-5b78a716a96a?versionId=27iWyA73cCAYqyH...", + "CodeSha256": "tv9jJO+rPbXUUXuRKi7CwHzKtLDkDRJLB3cC3Z/ouXo=", + "CodeSize": 169 + }, + "LayerArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer", + "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer:1", + "Description": "My Python layer", + "CreatedDate": "2018-11-14T23:03:52.894+0000", + "Version": 1, + "LicenseInfo": "MIT", + "CompatibleRuntimes": [ + "python3.6", + "python3.7" + ] + } + +For more information, see `AWS Lambda Layers `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/get-policy.rst awscli-1.18.69/awscli/examples/lambda/get-policy.rst --- awscli-1.11.13/awscli/examples/lambda/get-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/get-policy.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,28 @@ +**To retrieve the resource-based IAM policy for a function, version, or alias** + +The following ``get-policy`` example displays policy information about the ``my-function`` Lambda function. :: + + aws lambda get-policy \ + --function-name my-function + +Output:: + + { + "Policy": { + "Version":"2012-10-17", + "Id":"default", + "Statement": + [ + { + "Sid":"iot-events", + "Effect":"Allow", + "Principal": {"Service":"iotevents.amazonaws.com"}, + "Action":"lambda:InvokeFunction", + "Resource":"arn:aws:lambda:us-west-2:123456789012:function:my-function" + } + ] + }, + "RevisionId": "93017fc9-59cb-41dc-901b-4845ce4bf668" + } + +For more information, see `Using Resource-based Policies for AWS Lambda `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/get-provisioned-concurrency-config.rst awscli-1.18.69/awscli/examples/lambda/get-provisioned-concurrency-config.rst --- awscli-1.11.13/awscli/examples/lambda/get-provisioned-concurrency-config.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/get-provisioned-concurrency-config.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/lambda/invoke.rst awscli-1.18.69/awscli/examples/lambda/invoke.rst --- awscli-1.11.13/awscli/examples/lambda/invoke.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/invoke.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,35 @@ +**Example 1: To invoke a Lambda function synchronously** + +The following ``invoke`` example invokes the ``my-function`` function synchronously. :: + + aws lambda invoke \ + --function-name my-function \ + --payload '{ "name": "Bob" }' \ + response.json + +Output:: + + { + "ExecutedVersion": "$LATEST", + "StatusCode": 200 + } + +For more information, see `Synchronous Invocation `__ in the *AWS Lambda Developer Guide*. + +**Example 2: To invoke a Lambda function asynchronously** + +The following ``invoke`` example invokes the ``my-function`` function asynchronously. :: + + aws lambda invoke \ + --function-name my-function \ + --invocation-type Event \ + --payload '{ "name": "Bob" }' \ + response.json + +Output:: + + { + "StatusCode": 202 + } + +For more information, see `Asynchronous Invocation `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/list-aliases.rst awscli-1.18.69/awscli/examples/lambda/list-aliases.rst --- awscli-1.11.13/awscli/examples/lambda/list-aliases.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/list-aliases.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,29 @@ +**To retrieve the list of aliases for a Lambda function** + +The following ``list-aliases`` example displays a list of the aliases for the ``my-function`` Lambda function. :: + + aws lambda list-aliases \ + --function-name my-function + +Output:: + + { + "Aliases": [ + { + "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:BETA", + "RevisionId": "a410117f-ab16-494e-8035-7e204bb7933b", + "FunctionVersion": "2", + "Name": "BETA", + "Description": "alias for beta version of function" + }, + { + "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:LIVE", + "RevisionId": "21d40116-f8b1-40ba-9360-3ea284da1bb5", + "FunctionVersion": "1", + "Name": "LIVE", + "Description": "alias for live version of function" + } + ] + } + +For more information, see `Configuring AWS Lambda Function Aliases `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/list-event-source-mappings.rst awscli-1.18.69/awscli/examples/lambda/list-event-source-mappings.rst --- awscli-1.11.13/awscli/examples/lambda/list-event-source-mappings.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/list-event-source-mappings.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,24 @@ +**To list the event source mappings for a function** + +The following ``list-event-source-mappings`` example displays a list of the event source mappings for the ``my-function`` Lambda function. :: + + aws lambda list-event-source-mappings \ + --function-name my-function + +Output:: + + { + "EventSourceMappings": [ + { + "UUID": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "StateTransitionReason": "USER_INITIATED", + "LastModified": 1569284520.333, + "BatchSize": 5, + "State": "Enabled", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "EventSourceArn": "arn:aws:sqs:us-west-2:123456789012:mySQSqueue" + } + ] + } + +For more information, see `AWS Lambda Event Source Mapping `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/list-function-event-invoke-configs.rst awscli-1.18.69/awscli/examples/lambda/list-function-event-invoke-configs.rst --- awscli-1.11.13/awscli/examples/lambda/list-function-event-invoke-configs.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/list-function-event-invoke-configs.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/lambda/list-functions.rst awscli-1.18.69/awscli/examples/lambda/list-functions.rst --- awscli-1.11.13/awscli/examples/lambda/list-functions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/list-functions.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,88 @@ +**To retrieve a list of Lambda functions** + +The following ``list-functions`` example displays a list of all of the functions for the current user. :: + + aws lambda list-functions + +Output:: + + { + "Functions": [ + { + "TracingConfig": { + "Mode": "PassThrough" + }, + "Version": "$LATEST", + "CodeSha256": "dBG9m8SGdmlEjw/JYXlhhvCrAv5TxvXsbL/RMr0fT/I=", + "FunctionName": "helloworld", + "MemorySize": 128, + "RevisionId": "1718e831-badf-4253-9518-d0644210af7b", + "CodeSize": 294, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:helloworld", + "Handler": "helloworld.handler", + "Role": "arn:aws:iam::123456789012:role/service-role/MyTestFunction-role-zgur6bf4", + "Timeout": 3, + "LastModified": "2019-09-23T18:32:33.857+0000", + "Runtime": "nodejs10.x", + "Description": "" + }, + { + "TracingConfig": { + "Mode": "PassThrough" + }, + "Version": "$LATEST", + "CodeSha256": "sU0cJ2/hOZevwV/lTxCuQqK3gDZP3i8gUoqUUVRmY6E=", + "FunctionName": "my-function", + "VpcConfig": { + "SubnetIds": [], + "VpcId": "", + "SecurityGroupIds": [] + }, + "MemorySize": 256, + "RevisionId": "93017fc9-59cb-41dc-901b-4845ce4bf668", + "CodeSize": 266, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "Handler": "index.handler", + "Role": "arn:aws:iam::123456789012:role/service-role/helloWorldPython-role-uy3l9qyq", + "Timeout": 3, + "LastModified": "2019-10-01T16:47:28.490+0000", + "Runtime": "nodejs10.x", + "Description": "" + }, + { + "Layers": [ + { + "CodeSize": 41784542, + "Arn": "arn:aws:lambda:us-west-2:420165488524:layer:AWSLambda-Python37-SciPy1x:2" + }, + { + "CodeSize": 4121, + "Arn": "arn:aws:lambda:us-west-2:123456789012:layer:pythonLayer:1" + } + ], + "TracingConfig": { + "Mode": "PassThrough" + }, + "Version": "$LATEST", + "CodeSha256": "ZQukCqxtkqFgyF2cU41Avj99TKQ/hNihPtDtRcc08mI=", + "FunctionName": "my-python-function", + "VpcConfig": { + "SubnetIds": [], + "VpcId": "", + "SecurityGroupIds": [] + }, + "MemorySize": 128, + "RevisionId": "80b4eabc-acf7-4ea8-919a-e874c213707d", + "CodeSize": 299, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-python-function", + "Handler": "lambda_function.lambda_handler", + "Role": "arn:aws:iam::123456789012:role/service-role/my-python-function-role-z5g7dr6n", + "Timeout": 3, + "LastModified": "2019-10-01T19:40:41.643+0000", + "Runtime": "python3.7", + "Description": "" + } + ] + } + +For more information, see `AWS Lambda Function Configuration `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/list-layers.rst awscli-1.18.69/awscli/examples/lambda/list-layers.rst --- awscli-1.11.13/awscli/examples/lambda/list-layers.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/list-layers.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,30 @@ +**To list the layers that are compatible with your function's runtime** + +The following ``list-layers`` example displays information about layers that are compatible with the Python 3.7 runtime. :: + + aws lambda list-layers \ + --compatible-runtime python3.7 + +Output:: + + { + "Layers": [ + { + "LayerName": "my-layer", + "LayerArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer", + "LatestMatchingVersion": { + "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer:2", + "Version": 2, + "Description": "My layer", + "CreatedDate": "2018-11-15T00:37:46.592+0000", + "CompatibleRuntimes": [ + "python3.6", + "python3.7" + ] + } + } + ] + } + + +For more information, see `AWS Lambda Layers `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/list-layer-versions.rst awscli-1.18.69/awscli/examples/lambda/list-layer-versions.rst --- awscli-1.11.13/awscli/examples/lambda/list-layer-versions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/list-layer-versions.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,27 @@ +**To list the versions of an AWS Lambda layer** + +The following ``list-layers-versions`` example displays information about the versions for the layer named ``my-layer``. :: + + aws lambda list-layer-versions \ + --layer-name my-layer + +Output:: + + { + "Layers": [ + { + + "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer:2", + "Version": 2, + "Description": "My layer", + "CreatedDate": "2018-11-15T00:37:46.592+0000", + "CompatibleRuntimes": [ + "python3.6", + "python3.7" + ] + + } + ] + } + +For more information, see `AWS Lambda Layers `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/list-provisioned-concurrency-configs.rst awscli-1.18.69/awscli/examples/lambda/list-provisioned-concurrency-configs.rst --- awscli-1.11.13/awscli/examples/lambda/list-provisioned-concurrency-configs.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/list-provisioned-concurrency-configs.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/lambda/list-tags.rst awscli-1.18.69/awscli/examples/lambda/list-tags.rst --- awscli-1.11.13/awscli/examples/lambda/list-tags.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/list-tags.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,17 @@ +**To retrieve the list of tags for a Lambda function** + +The following ``list-tags`` example displays the tags attached to the ``my-function`` Lambda function. :: + + aws lambda list-tags \ + --resource arn:aws:lambda:us-west-2:123456789012:function:my-function + +Output:: + + { + "Tags": { + "Category": "Web Tools", + "Department": "Sales" + } + } + +For more information, see `Tagging Lambda Functions `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/list-versions-by-function.rst awscli-1.18.69/awscli/examples/lambda/list-versions-by-function.rst --- awscli-1.11.13/awscli/examples/lambda/list-versions-by-function.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/list-versions-by-function.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,84 @@ +**To retrieve a list of versions of a function** + +The following ``list-versions-by-function`` example displays the list of versions for the ``my-function`` Lambda function. :: + + aws lambda list-versions-by-function \ + --function-name my-function + +Output:: + + { + "Versions": [ + { + "TracingConfig": { + "Mode": "PassThrough" + }, + "Version": "$LATEST", + "CodeSha256": "sU0cJ2/hOZevwV/lTxCuQqK3gDZP3i8gUoqUUVRmY6E=", + "FunctionName": "my-function", + "VpcConfig": { + "SubnetIds": [], + "VpcId": "", + "SecurityGroupIds": [] + }, + "MemorySize": 256, + "RevisionId": "93017fc9-59cb-41dc-901b-4845ce4bf668", + "CodeSize": 266, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:$LATEST", + "Handler": "index.handler", + "Role": "arn:aws:iam::123456789012:role/service-role/helloWorldPython-role-uy3l9qyq", + "Timeout": 3, + "LastModified": "2019-10-01T16:47:28.490+0000", + "Runtime": "nodejs10.x", + "Description": "" + }, + { + "TracingConfig": { + "Mode": "PassThrough" + }, + "Version": "1", + "CodeSha256": "5tT2qgzYUHoqwR616pZ2dpkn/0J1FrzJmlKidWaaCgk=", + "FunctionName": "my-function", + "VpcConfig": { + "SubnetIds": [], + "VpcId": "", + "SecurityGroupIds": [] + }, + "MemorySize": 256, + "RevisionId": "949c8914-012e-4795-998c-e467121951b1", + "CodeSize": 304, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:1", + "Handler": "index.handler", + "Role": "arn:aws:iam::123456789012:role/service-role/helloWorldPython-role-uy3l9qyq", + "Timeout": 3, + "LastModified": "2019-09-26T20:28:40.438+0000", + "Runtime": "nodejs10.x", + "Description": "new version" + }, + { + "TracingConfig": { + "Mode": "PassThrough" + }, + "Version": "2", + "CodeSha256": "sU0cJ2/hOZevwV/lTxCuQqK3gDZP3i8gUoqUUVRmY6E=", + "FunctionName": "my-function", + "VpcConfig": { + "SubnetIds": [], + "VpcId": "", + "SecurityGroupIds": [] + }, + "MemorySize": 256, + "RevisionId": "cd669f21-0f3d-4e1c-9566-948837f2e2ea", + "CodeSize": 266, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:2", + "Handler": "index.handler", + "Role": "arn:aws:iam::123456789012:role/service-role/helloWorldPython-role-uy3l9qyq", + "Timeout": 3, + "LastModified": "2019-10-01T16:47:28.490+0000", + "Runtime": "nodejs10.x", + "Description": "newer version" + } + ] + } + +For more information, see `Configuring AWS Lambda Function Aliases `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/publish-layer-version.rst awscli-1.18.69/awscli/examples/lambda/publish-layer-version.rst --- awscli-1.11.13/awscli/examples/lambda/publish-layer-version.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/publish-layer-version.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,32 @@ +**To create a Lambda layer version** + +The following ``publish-layer-version`` example creates a new Python library layer version. The command retrieves the layer content a file named ``layer.zip`` in the specified S3 bucket. :: + + aws lambda publish-layer-version \ + --layer-name my-layer \ + --description "My Python layer" \ + --license-info "MIT" \ + --content S3Bucket=lambda-layers-us-west-2-123456789012,S3Key=layer.zip \ + --compatible-runtimes python3.6 python3.7 + +Output:: + + { + "Content": { + "Location": "https://awslambda-us-west-2-layers.s3.us-west-2.amazonaws.com/snapshots/123456789012/my-layer-4aaa2fbb-ff77-4b0a-ad92-5b78a716a96a?versionId=27iWyA73cCAYqyH...", + "CodeSha256": "tv9jJO+rPbXUUXuRKi7CwHzKtLDkDRJLB3cC3Z/ouXo=", + "CodeSize": 169 + }, + "LayerArn": "arn:aws:lambda:us-west-2:123456789012:layer:my-layer", + "LayerVersionArn": "arn:aws:lambda:us-west-2:123456789012:layer:my-layer:1", + "Description": "My Python layer", + "CreatedDate": "2018-11-14T23:03:52.894+0000", + "Version": 1, + "LicenseInfo": "MIT", + "CompatibleRuntimes": [ + "python3.6", + "python3.7" + ] + } + +For more information, see `AWS Lambda Layers `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/publish-version.rst awscli-1.18.69/awscli/examples/lambda/publish-version.rst --- awscli-1.11.13/awscli/examples/lambda/publish-version.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/publish-version.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,29 @@ +**To publish a new version of a function** + +The following ``publish-version`` example publishes a new version of the ``my-function`` Lambda function. :: + + aws lambda publish-version \ + --function-name my-function + +Output:: + + { + "TracingConfig": { + "Mode": "PassThrough" + }, + "CodeSha256": "dBG9m8SGdmlEjw/JYXlhhvCrAv5TxvXsbL/RMr0fT/I=", + "FunctionName": "my-function", + "CodeSize": 294, + "RevisionId": "f31d3d39-cc63-4520-97d4-43cd44c94c20", + "MemorySize": 128, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:3", + "Version": "2", + "Role": "arn:aws:iam::123456789012:role/service-role/MyTestFunction-role-zgur6bf4", + "Timeout": 3, + "LastModified": "2019-09-23T18:32:33.857+0000", + "Handler": "my-function.handler", + "Runtime": "nodejs10.x", + "Description": "" + } + +For more information, see `Configuring AWS Lambda Function Aliases `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/put-function-concurrency.rst awscli-1.18.69/awscli/examples/lambda/put-function-concurrency.rst --- awscli-1.11.13/awscli/examples/lambda/put-function-concurrency.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/put-function-concurrency.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,15 @@ +**To configure a reserved concurrency limit for a function** + +The following ``put-function-concurrency`` example configures 100 reserved concurrent executions for the ``my-function`` function. :: + + aws lambda put-function-concurrency \ + --function-name my-function \ + --reserved-concurrent-executions 100 + +Output:: + + { + "ReservedConcurrentExecutions": 100 + } + +For more information, see `Reserving Concurrency for a Lambda Function `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/put-function-event-invoke-config.rst awscli-1.18.69/awscli/examples/lambda/put-function-event-invoke-config.rst --- awscli-1.11.13/awscli/examples/lambda/put-function-event-invoke-config.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/put-function-event-invoke-config.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/lambda/put-provisioned-concurrency-config.rst awscli-1.18.69/awscli/examples/lambda/put-provisioned-concurrency-config.rst --- awscli-1.11.13/awscli/examples/lambda/put-provisioned-concurrency-config.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/put-provisioned-concurrency-config.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/lambda/remove-layer-version-permission.rst awscli-1.18.69/awscli/examples/lambda/remove-layer-version-permission.rst --- awscli-1.11.13/awscli/examples/lambda/remove-layer-version-permission.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/remove-layer-version-permission.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,12 @@ +**To delete layer-version permissions** + +The following ``remove-layer-version-permission`` example deletes permission for an account to configure a layer version. :: + + aws lambda remove-layer-version-permission \ + --layer-name my-layer \ + --statement-id xaccount \ + --version-number 1 + +This command produces no output. + +For more information, see `AWS Lambda Layers `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/remove-permission.rst awscli-1.18.69/awscli/examples/lambda/remove-permission.rst --- awscli-1.11.13/awscli/examples/lambda/remove-permission.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/remove-permission.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To remove permissions from an existing Lambda function** + +The following ``remove-permission`` example removes permission to invoke a function named ``my-function``. :: + + aws lambda remove-permission \ + --function-name my-function \ + --statement-id sns + +This command produces no output. + +For more information, see `Using Resource-based Policies for AWS Lambda `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/tag-resource.rst awscli-1.18.69/awscli/examples/lambda/tag-resource.rst --- awscli-1.11.13/awscli/examples/lambda/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/tag-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To add tags to an existing Lambda function** + +The following ``tag-resource`` example adds a tag with the key name ``DEPARTMENT`` and a value of ``Department A`` to the specified Lambda function. :: + + aws lambda tag-resource \ + --resource arn:aws:lambda:us-west-2:123456789012:function:my-function \ + --tags "DEPARTMENT=Department A" + +This command produces no output. + +For more information, see `Tagging Lambda Functions `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/untag-resource.rst awscli-1.18.69/awscli/examples/lambda/untag-resource.rst --- awscli-1.11.13/awscli/examples/lambda/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/untag-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To remove tags from an existing Lambda function** + +The following ``untag-resource`` example removes the tag with the key name ``DEPARTMENT`` tag from the ``my-function`` Lambda function. :: + + aws lambda untag-resource \ + --resource arn:aws:lambda:us-west-2:123456789012:function:my-function \ + --tag-keys DEPARTMENT + +This command produces no output. + +For more information, see `Tagging Lambda Functions `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/update-alias.rst awscli-1.18.69/awscli/examples/lambda/update-alias.rst --- awscli-1.11.13/awscli/examples/lambda/update-alias.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/update-alias.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,20 @@ +**To update a function alias** + +The following ``update-alias`` example updates the alias named ``LIVE`` to point to version 3 of the ``my-function`` Lambda function. :: + + aws lambda update-alias \ + --function-name my-function \ + --function-version 3 \ + --name LIVE + +Output:: + + { + "FunctionVersion": "3", + "Name": "LIVE", + "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:LIVE", + "RevisionId": "594f41fb-b85f-4c20-95c7-6ca5f2a92c93", + "Description": "alias for live version of function" + } + +For more information, see `Configuring AWS Lambda Function Aliases `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/update-event-source-mapping.rst awscli-1.18.69/awscli/examples/lambda/update-event-source-mapping.rst --- awscli-1.11.13/awscli/examples/lambda/update-event-source-mapping.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/update-event-source-mapping.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,21 @@ +**To update the mapping between an event source and an AWS Lambda function** + +The following ``update-event-source-mapping`` example updates the batch size to 8 in the specified mapping. :: + + aws lambda update-event-source-mapping \ + --uuid "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" \ + --batch-size 8 + +Output:: + + { + "UUID": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "StateTransitionReason": "USER_INITIATED", + "LastModified": 1569284520.333, + "BatchSize": 8, + "State": "Updating", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "EventSourceArn": "arn:aws:sqs:us-west-2:123456789012:mySQSqueue" + } + +For more information, see `AWS Lambda Event Source Mapping `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/update-function-code.rst awscli-1.18.69/awscli/examples/lambda/update-function-code.rst --- awscli-1.11.13/awscli/examples/lambda/update-function-code.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/update-function-code.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,35 @@ +**To update the code of a Lambda function** + +The following ``update-function-code`` example replaces the code of the unpublished ($LATEST) version of the ``my-function`` function with the contents of the specified zip file. :: + + aws lambda update-function-code \ + --function-name my-function \ + --zip-file fileb://my-function.zip + +Output:: + + { + "FunctionName": "my-function", + "LastModified": "2019-09-26T20:28:40.438+0000", + "RevisionId": "e52502d4-9320-4688-9cd6-152a6ab7490d", + "MemorySize": 256, + "Version": "$LATEST", + "Role": "arn:aws:iam::123456789012:role/service-role/my-function-role-uy3l9qyq", + "Timeout": 3, + "Runtime": "nodejs10.x", + "TracingConfig": { + "Mode": "PassThrough" + }, + "CodeSha256": "5tT2qgzYUHaqwR716pZ2dpkn/0J1FrzJmlKidWoaCgk=", + "Description": "", + "VpcConfig": { + "SubnetIds": [], + "VpcId": "", + "SecurityGroupIds": [] + }, + "CodeSize": 304, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "Handler": "index.handler" + } + +For more information, see `AWS Lambda Function Configuration `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/update-function-configuration.rst awscli-1.18.69/awscli/examples/lambda/update-function-configuration.rst --- awscli-1.11.13/awscli/examples/lambda/update-function-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/update-function-configuration.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,35 @@ +**To modify the configuration of a function** + +The following ``update-function-configuration`` example modifies the memory size to be 256 MB for the unpublished ($LATEST) version of the ``my-function`` function. :: + + aws lambda update-function-configuration \ + --function-name my-function \ + --memory-size 256 + +Output:: + + { + "FunctionName": "my-function", + "LastModified": "2019-09-26T20:28:40.438+0000", + "RevisionId": "e52502d4-9320-4688-9cd6-152a6ab7490d", + "MemorySize": 256, + "Version": "$LATEST", + "Role": "arn:aws:iam::123456789012:role/service-role/my-function-role-uy3l9qyq", + "Timeout": 3, + "Runtime": "nodejs10.x", + "TracingConfig": { + "Mode": "PassThrough" + }, + "CodeSha256": "5tT2qgzYUHaqwR716pZ2dpkn/0J1FrzJmlKidWoaCgk=", + "Description": "", + "VpcConfig": { + "SubnetIds": [], + "VpcId": "", + "SecurityGroupIds": [] + }, + "CodeSize": 304, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "Handler": "index.handler" + } + +For more information, see `AWS Lambda Function Configuration `__ in the *AWS Lambda Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lambda/update-function-event-invoke-config.rst awscli-1.18.69/awscli/examples/lambda/update-function-event-invoke-config.rst --- awscli-1.11.13/awscli/examples/lambda/update-function-event-invoke-config.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lambda/update-function-event-invoke-config.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/license-manager/create-license-configuration.rst awscli-1.18.69/awscli/examples/license-manager/create-license-configuration.rst --- awscli-1.11.13/awscli/examples/license-manager/create-license-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/license-manager/create-license-configuration.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,29 @@ +**Example 1: To create a license configuration** + +The following ``create-license-configuration`` example creates a license configuration with a hard limit of 10 cores. :: + + aws license-manager create-license-configuration --name my-license-configuration \ + --license-counting-type Core \ + --license-count 10 \ + --license-count-hard-limit + +Output:: + + { + "LicenseConfigurationArn": "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba41EXAMPLE1111" + } + +**Example 2: To create a license configuration** + +The following ``create-license-configuration`` example creates a license configuration with a soft limit of 100 vCPUs. It uses a rule to enable vCPU optimization. :: + + aws license-manager create-license-configuration --name my-license-configuration + --license-counting-type vCPU \ + --license-count 100 \ + --license-rules "#honorVcpuOptimization=true" + +Output:: + + { + "LicenseConfigurationArn": "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba41EXAMPLE2222" + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/license-manager/delete-license-configuration.rst awscli-1.18.69/awscli/examples/license-manager/delete-license-configuration.rst --- awscli-1.11.13/awscli/examples/license-manager/delete-license-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/license-manager/delete-license-configuration.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,8 @@ +**To delete a license configuration** + +The following ``delete-license-configuration`` example deletes the specified license configuration. :: + + aws license-manager delete-license-configuration \ + --license-configuration-arn arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba4f56c1EXAMPLE + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/license-manager/get-license-configuration.rst awscli-1.18.69/awscli/examples/license-manager/get-license-configuration.rst --- awscli-1.11.13/awscli/examples/license-manager/get-license-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/license-manager/get-license-configuration.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,52 @@ +**To get license configuration information** + +The following ``get-license-configuration`` example displays details for the specified license configuration. :: + + aws license-manager get-license-configuration \ + --license-configuration-arn arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-38b658717b87478aaa7c00883EXAMPLE + +Output:: + + { + "LicenseConfigurationId": "lic-38b658717b87478aaa7c00883EXAMPLE", + "LicenseConfigurationArn": "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-38b658717b87478aaa7c00883EXAMPLE", + "Name": "my-license-configuration", + "LicenseCountingType": "vCPU", + "LicenseRules": [], + "LicenseCountHardLimit": false, + "ConsumedLicenses": 0, + "Status": "AVAILABLE", + "OwnerAccountId": "123456789012", + "ConsumedLicenseSummaryList": [ + { + "ResourceType": "EC2_INSTANCE", + "ConsumedLicenses": 0 + }, + { + "ResourceType": "EC2_HOST", + "ConsumedLicenses": 0 + }, + { + "ResourceType": "SYSTEMS_MANAGER_MANAGED_INSTANCE", + "ConsumedLicenses": 0 + } + ], + "ManagedResourceSummaryList": [ + { + "ResourceType": "EC2_INSTANCE", + "AssociationCount": 0 + }, + { + "ResourceType": "EC2_HOST", + "AssociationCount": 0 + }, + { + "ResourceType": "EC2_AMI", + "AssociationCount": 2 + }, + { + "ResourceType": "SYSTEMS_MANAGER_MANAGED_INSTANCE", + "AssociationCount": 0 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/license-manager/get-service-settings.rst awscli-1.18.69/awscli/examples/license-manager/get-service-settings.rst --- awscli-1.11.13/awscli/examples/license-manager/get-service-settings.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/license-manager/get-service-settings.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,24 @@ +**To get the License Manager settings** + +The following ``get-service-settings`` example displays the service settings for License Manager in the current Region. :: + + aws license-manager get-service-settings + +The following shows example output if cross-account resource discovery is disabled. :: + + { + "OrganizationConfiguration": { + "EnableIntegration": false + }, + "EnableCrossAccountsDiscovery": false + } + +The following shows example output if cross-account resource discovery is enabled. :: + + { + "S3BucketArn": "arn:aws:s3:::aws-license-manager-service-c22d6279-35c4-47c4-bb", + "OrganizationConfiguration": { + "EnableIntegration": true + }, + "EnableCrossAccountsDiscovery": true + } diff -Nru awscli-1.11.13/awscli/examples/license-manager/list-associations-for-license-configuration.rst awscli-1.18.69/awscli/examples/license-manager/list-associations-for-license-configuration.rst --- awscli-1.11.13/awscli/examples/license-manager/list-associations-for-license-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/license-manager/list-associations-for-license-configuration.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,25 @@ +**To get associations for a license configuration** + +The following ``list-associations-for-license-configuration`` example displays detailed information for the associations of the specified license configuration. :: + + aws license-manager list-associations-for-license-configuration \ + --license-configuration-arn arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-38b658717b87478aaa7c00883EXAMPLE + +Output:: + + { + "LicenseConfigurationAssociations": [ + { + "ResourceArn": "arn:aws:ec2:us-west-2::image/ami-1234567890abcdef0", + "ResourceType": "EC2_AMI", + "ResourceOwnerId": "123456789012", + "AssociationTime": 1568825118.617 + }, + { + "ResourceArn": "arn:aws:ec2:us-west-2::image/ami-0abcdef1234567890", + "ResourceType": "EC2_AMI", + "ResourceOwnerId": "123456789012", + "AssociationTime": 1568825118.946 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/license-manager/list-license-configurations.rst awscli-1.18.69/awscli/examples/license-manager/list-license-configurations.rst --- awscli-1.11.13/awscli/examples/license-manager/list-license-configurations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/license-manager/list-license-configurations.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,66 @@ +**Example 1: To list all of your license configurations** + +The following ``list-license-configurations`` example lists all your license configurations. :: + + aws license-manager list-license-configurations + +Output:: + + { + "LicenseConfigurations": [ + { + "LicenseConfigurationId": "lic-6eb6586f508a786a2ba4f56c1EXAMPLE", + "LicenseConfigurationArn": "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba4f56c1EXAMPLE", + "Name": "my-license-configuration", + "LicenseCountingType": "Core", + "LicenseRules": [], + "LicenseCount": 10, + "LicenseCountHardLimit": true, + "ConsumedLicenses": 0, + "Status": "AVAILABLE", + "OwnerAccountId": "123456789012", + "ConsumedLicenseSummaryList": [ + { + "ResourceType": "EC2_INSTANCE", + "ConsumedLicenses": 0 + }, + { + "ResourceType": "EC2_HOST", + "ConsumedLicenses": 0 + }, + { + "ResourceType": "SYSTEMS_MANAGER_MANAGED_INSTANCE", + "ConsumedLicenses": 0 + } + ], + "ManagedResourceSummaryList": [ + { + "ResourceType": "EC2_INSTANCE", + "AssociationCount": 0 + }, + { + "ResourceType": "EC2_HOST", + "AssociationCount": 0 + }, + { + "ResourceType": "EC2_AMI", + "AssociationCount": 0 + }, + { + "ResourceType": "SYSTEMS_MANAGER_MANAGED_INSTANCE", + "AssociationCount": 0 + } + ] + }, + { + ... + } + ] + } + +**Example 2: To list a specific license configuration** + +The following ``list-license-configurations`` example lists only the specified license configuration. :: + + aws license-manager list-license-configurations \ + --license-configuration-arns arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-38b658717b87478aaa7c00883EXAMPLE diff -Nru awscli-1.11.13/awscli/examples/license-manager/list-license-specifications-for-resource.rst awscli-1.18.69/awscli/examples/license-manager/list-license-specifications-for-resource.rst --- awscli-1.11.13/awscli/examples/license-manager/list-license-specifications-for-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/license-manager/list-license-specifications-for-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,13 @@ +**To list the license configurations for a resource** + +The following ``list-license-specifications-for-resource`` example lists the license configurations associated with the specified Amazon Machine Image (AMI). :: + + aws license-manager list-license-specifications-for-resource \ + --resource-arn arn:aws:ec2:us-west-2::image/ami-1234567890abcdef0 + +Output:: + + { + "LicenseConfigurationArn": "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-38b658717b87478aaa7c00883EXAMPLE" + } + diff -Nru awscli-1.11.13/awscli/examples/license-manager/list-resource-inventory.rst awscli-1.18.69/awscli/examples/license-manager/list-resource-inventory.rst --- awscli-1.11.13/awscli/examples/license-manager/list-resource-inventory.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/license-manager/list-resource-inventory.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,36 @@ +**To list resources in the resource inventory** + +The following ``list-resource-inventory`` example lists the resources managed using Systems Manager inventory. :: + + aws license-manager list-resource-inventory + +Output:: + + { + "ResourceInventoryList": [ + { + "Platform": "Red Hat Enterprise Linux Server", + "ResourceType": "EC2Instance", + "PlatformVersion": "7.4", + "ResourceArn": "arn:aws:ec2:us-west-2:1234567890129:instance/i-05d3cdfb05bd36376", + "ResourceId": "i-05d3cdfb05bd36376", + "ResourceOwningAccountId": "1234567890129" + }, + { + "Platform": "Amazon Linux", + "ResourceType": "EC2Instance", + "PlatformVersion": "2", + "ResourceArn": "arn:aws:ec2:us-west-2:1234567890129:instance/i-0b1d036cfd4594808", + "ResourceId": "i-0b1d036cfd4594808", + "ResourceOwningAccountId": "1234567890129" + }, + { + "Platform": "Microsoft Windows Server 2019 Datacenter", + "ResourceType": "EC2Instance", + "PlatformVersion": "10.0.17763", + "ResourceArn": "arn:aws:ec2:us-west-2:1234567890129:instance/i-0cdb3b54a2a8246ad", + "ResourceId": "i-0cdb3b54a2a8246ad", + "ResourceOwningAccountId": "1234567890129" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/license-manager/list-tags-for-resource.rst awscli-1.18.69/awscli/examples/license-manager/list-tags-for-resource.rst --- awscli-1.11.13/awscli/examples/license-manager/list-tags-for-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/license-manager/list-tags-for-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,17 @@ +**To list the tags for a license configuration** + +The following ``list-tags-for-resource`` example lists the tags for the specified license configuration. :: + + aws license-manager list-tags-for-resource \ + --resource-arn arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba4f56c1EXAMPLE + +Output:: + + { + "Tags": [ + { + "Key": "project", + "Value": "lima" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/license-manager/list-usage-for-license-configuration.rst awscli-1.18.69/awscli/examples/license-manager/list-usage-for-license-configuration.rst --- awscli-1.11.13/awscli/examples/license-manager/list-usage-for-license-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/license-manager/list-usage-for-license-configuration.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,21 @@ +**To list the licenses in use for a license configuration** + +The following ``list-usage-for-license-configuration`` example lists information about the resources using licenses for the specified license configuration. For example, if the license type is vCPU, any instances consume one license per vCPU. :: + + aws license-manager list-usage-for-license-configuration \ + --license-configuration-arn arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-38b658717b87478aaa7c00883EXAMPLE + +Output:: + + { + "LicenseConfigurationUsageList": [ + { + "ResourceArn": "arn:aws:ec2:us-west-2:123456789012:instance/i-04a636d18e83cfacb", + "ResourceType": "EC2_INSTANCE", + "ResourceStatus": "running", + "ResourceOwnerId": "123456789012", + "AssociationTime": 1570892850.519, + "ConsumedLicenses": 2 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/license-manager/tag-resource.rst awscli-1.18.69/awscli/examples/license-manager/tag-resource.rst --- awscli-1.11.13/awscli/examples/license-manager/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/license-manager/tag-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,9 @@ +**To add a tag a license configuration** + +The following ``tag-resource`` example adds the specified tag (key name and value) to the specified license configuration. :: + + aws license-manager tag-resource \ + --tags Key=project,Value=lima \ + --resource-arn arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba4f56c1EXAMPLE + +This command produces no output. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/license-manager/untag-resource.rst awscli-1.18.69/awscli/examples/license-manager/untag-resource.rst --- awscli-1.11.13/awscli/examples/license-manager/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/license-manager/untag-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,9 @@ +**To remove tags from a license configuration** + +The following ``untag-resource`` example removes the specified tag (key name and resource) from the specified license configuration. :: + + aws license-manager untag-resource \ + --tag-keys project \ + --resource-arn arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba4f56c1EXAMPLE + +This command produces no output. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/license-manager/update-license-configuration.rst awscli-1.18.69/awscli/examples/license-manager/update-license-configuration.rst --- awscli-1.11.13/awscli/examples/license-manager/update-license-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/license-manager/update-license-configuration.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,17 @@ +**To update a license configuration** + +The following ``update-license-configuration`` example updates the specified license configuration to remove the hard limit. :: + + aws license-manager update-license-configuration \ + --no-license-count-hard-limit \ + --license-configuration-arn arn:aws:license-manager:us-west-2:880185128111:license-configuration:lic-6eb6586f508a786a2ba4f56c1EXAMPLE + +This command produces no output. + +The following ``update-license-configuration`` example updates the specified license configuration to change its status to ``DISABLED``. :: + + aws license-manager update-license-configuration \ + --license-configuration-status DISABLED + --license-configuration-arn arn:aws:license-manager:us-west-2:880185128111:license-configuration:lic-6eb6586f508a786a2ba4f56c1EXAMPLE + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/license-manager/update-license-specifications-for-resource.rst awscli-1.18.69/awscli/examples/license-manager/update-license-specifications-for-resource.rst --- awscli-1.11.13/awscli/examples/license-manager/update-license-specifications-for-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/license-manager/update-license-specifications-for-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,10 @@ +**To update the license configurations for a resource** + +The following ``update-license-specifications-for-resource`` example replaces the license configuration associated with the specified Amazon Machine Image (AMI) by removing one license configuration and adding another. :: + + aws license-manager update-license-specifications-for-resource \ + --resource-arn arn:aws:ec2:us-west-2::image/ami-1234567890abcdef0 \ + --remove-license-specifications LicenseConfigurationArn= arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-38b658717b87478aaa7c00883EXAMPLE \ + --add-license-specifications LicenseConfigurationArn=arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-42b6deb06e5399a980d555927EXAMPLE + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/license-manager/update-service-settings.rst awscli-1.18.69/awscli/examples/license-manager/update-service-settings.rst --- awscli-1.11.13/awscli/examples/license-manager/update-service-settings.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/license-manager/update-service-settings.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,10 @@ +**To update the License Manager settings** + +The following ``update-service-settings`` example enables cross-account resource discovery for License Manager in the current AWS Region. The Amazon S3 bucket is the Resource Data Sync required for Systems Manager inventory. :: + + aws license-manager update-service-settings \ + --organization-configuration EnableIntegration=true \ + --enable-cross-accounts-discovery \ + --s3-bucket-arn arn:aws:s3:::aws-license-manager-service-abcd1234EXAMPLE + +This command produces no output. diff -Nru awscli-1.11.13/awscli/examples/lightsail/allocate-static-ip.rst awscli-1.18.69/awscli/examples/lightsail/allocate-static-ip.rst --- awscli-1.11.13/awscli/examples/lightsail/allocate-static-ip.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/allocate-static-ip.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,27 @@ +**To create a static IP** + +The following ``allocate-static-ip`` example creates the specified static IP, which can be attached to an instance. :: + + aws lightsail allocate-static-ip \ + --static-ip-name StaticIp-1 + +Output:: + + { + "operations": [ + { + "id": "b5d06d13-2f19-4683-889f-dEXAMPLEed79", + "resourceName": "StaticIp-1", + "resourceType": "StaticIp", + "createdAt": 1571071325.076, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationType": "AllocateStaticIp", + "status": "Succeeded", + "statusChangedAt": 1571071325.274 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/attach-disk.rst awscli-1.18.69/awscli/examples/lightsail/attach-disk.rst --- awscli-1.11.13/awscli/examples/lightsail/attach-disk.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/attach-disk.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,45 @@ +**To attach a block storage disk to an instance** + +The following ``attach-disk`` example attaches disk ``Disk-1`` to instance ``WordPress_Multisite-1`` with the disk path of ``/dev/xvdf`` :: + + aws lightsail attach-disk \ + --disk-name Disk-1 \ + --disk-path /dev/xvdf \ + --instance-name WordPress_Multisite-1 + +Output:: + + { + "operations": [ + { + "id": "10a08267-19ce-43be-b913-6EXAMPLE7e80", + "resourceName": "Disk-1", + "resourceType": "Disk", + "createdAt": 1571071465.472, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationDetails": "WordPress_Multisite-1", + "operationType": "AttachDisk", + "status": "Started", + "statusChangedAt": 1571071465.472 + }, + { + "id": "2912c477-5295-4539-88c9-bEXAMPLEd1f0", + "resourceName": "WordPress_Multisite-1", + "resourceType": "Instance", + "createdAt": 1571071465.474, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationDetails": "Disk-1", + "operationType": "AttachDisk", + "status": "Started", + "statusChangedAt": 1571071465.474 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/attach-instances-to-load-balancer.rst awscli-1.18.69/awscli/examples/lightsail/attach-instances-to-load-balancer.rst --- awscli-1.11.13/awscli/examples/lightsail/attach-instances-to-load-balancer.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/attach-instances-to-load-balancer.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,104 @@ +**To attach instances to a load balancer** + +The following ``attach-instances-to-load-balancer`` example attaches instances ``MEAN-1``, ``MEAN-2``, and ``MEAN-3`` to the load balancer ``LoadBalancer-1``. :: + + aws lightsail attach-instances-to-load-balancer \ + --instance-names {"MEAN-1","MEAN-2","MEAN-3"} \ + --load-balancer-name LoadBalancer-1 + +Output:: + + { + "operations": [ + { + "id": "8055d19d-abb2-40b9-b527-1EXAMPLE3c7b", + "resourceName": "LoadBalancer-1", + "resourceType": "LoadBalancer", + "createdAt": 1571071699.892, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationDetails": "MEAN-2", + "operationType": "AttachInstancesToLoadBalancer", + "status": "Started", + "statusChangedAt": 1571071699.892 + }, + { + "id": "c35048eb-8538-456a-a118-0EXAMPLEfb73", + "resourceName": "MEAN-2", + "resourceType": "Instance", + "createdAt": 1571071699.887, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationDetails": "LoadBalancer-1", + "operationType": "AttachInstancesToLoadBalancer", + "status": "Started", + "statusChangedAt": 1571071699.887 + }, + { + "id": "910d09e0-adc5-4372-bc2e-0EXAMPLEd891", + "resourceName": "LoadBalancer-1", + "resourceType": "LoadBalancer", + "createdAt": 1571071699.882, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationDetails": "MEAN-3", + "operationType": "AttachInstancesToLoadBalancer", + "status": "Started", + "statusChangedAt": 1571071699.882 + }, + { + "id": "178b18ac-43e8-478c-9bed-1EXAMPLE4755", + "resourceName": "MEAN-3", + "resourceType": "Instance", + "createdAt": 1571071699.901, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationDetails": "LoadBalancer-1", + "operationType": "AttachInstancesToLoadBalancer", + "status": "Started", + "statusChangedAt": 1571071699.901 + }, + { + "id": "fb62536d-2a98-4190-a6fc-4EXAMPLE7470", + "resourceName": "LoadBalancer-1", + "resourceType": "LoadBalancer", + "createdAt": 1571071699.885, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationDetails": "MEAN-1", + "operationType": "AttachInstancesToLoadBalancer", + "status": "Started", + "statusChangedAt": 1571071699.885 + }, + { + "id": "787dac0d-f98d-46c3-8571-3EXAMPLE5a85", + "resourceName": "MEAN-1", + "resourceType": "Instance", + "createdAt": 1571071699.901, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationDetails": "LoadBalancer-1", + "operationType": "AttachInstancesToLoadBalancer", + "status": "Started", + "statusChangedAt": 1571071699.901 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/attach-load-balancer-tls-certificate.rst awscli-1.18.69/awscli/examples/lightsail/attach-load-balancer-tls-certificate.rst --- awscli-1.11.13/awscli/examples/lightsail/attach-load-balancer-tls-certificate.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/attach-load-balancer-tls-certificate.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,44 @@ +**To attach a TLS certificate to a load balancer** + +The following ``attach-load-balancer-tls-certificate`` example attaches the load balancer TLS certificate ``Certificate2`` to the load balancer ``LoadBalancer-1``. :: + + aws lightsail attach-load-balancer-tls-certificate \ + --certificate-name Certificate2 \ + --load-balancer-name LoadBalancer-1 + +Output:: + + { + "operations": [ + { + "id": "cf1ad6e3-3cbb-4b8a-a7f2-3EXAMPLEa118", + "resourceName": "LoadBalancer-1", + "resourceType": "LoadBalancer", + "createdAt": 1571072255.416, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationDetails": "Certificate2", + "operationType": "AttachLoadBalancerTlsCertificate", + "status": "Succeeded", + "statusChangedAt": 1571072255.416 + }, + { + "id": "dae1bcfb-d531-4c06-b4ea-bEXAMPLEc04e", + "resourceName": "Certificate2", + "resourceType": "LoadBalancerTlsCertificate", + "createdAt": 1571072255.416, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationDetails": "LoadBalancer-1", + "operationType": "AttachLoadBalancerTlsCertificate", + "status": "Succeeded", + "statusChangedAt": 1571072255.416 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/attach-static-ip.rst awscli-1.18.69/awscli/examples/lightsail/attach-static-ip.rst --- awscli-1.11.13/awscli/examples/lightsail/attach-static-ip.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/attach-static-ip.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,44 @@ +**To attach a static IP to an instance** + +The following ``attach-static-ip`` example attaches static IP ``StaticIp-1`` to instance ``MEAN-1``. :: + + aws lightsail attach-static-ip \ + --static-ip-name StaticIp-1 \ + --instance-name MEAN-1 + +Output:: + + { + "operations": [ + { + "id": "45e6fa13-4808-4b8d-9292-bEXAMPLE20b2", + "resourceName": "StaticIp-1", + "resourceType": "StaticIp", + "createdAt": 1571072569.375, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationDetails": "MEAN-1", + "operationType": "AttachStaticIp", + "status": "Succeeded", + "statusChangedAt": 1571072569.375 + }, + { + "id": "9ee09a17-863c-4e51-8a6d-3EXAMPLE5475", + "resourceName": "MEAN-1", + "resourceType": "Instance", + "createdAt": 1571072569.376, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationDetails": "StaticIp-1", + "operationType": "AttachStaticIp", + "status": "Succeeded", + "statusChangedAt": 1571072569.376 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/close-instance-public-ports.rst awscli-1.18.69/awscli/examples/lightsail/close-instance-public-ports.rst --- awscli-1.11.13/awscli/examples/lightsail/close-instance-public-ports.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/close-instance-public-ports.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,27 @@ +**To close firewall ports for an instance** + +The following ``close-instance-public-ports`` example closes TCP port ``22`` on instance ``MEAN-2``. :: + + aws lightsail close-instance-public-ports \ + --instance-name MEAN-2 \ + --port-info fromPort=22,protocol=TCP,toPort=22 + +Output:: + + { + "operation": { + "id": "4f328636-1c96-4649-ae6d-1EXAMPLEf446", + "resourceName": "MEAN-2", + "resourceType": "Instance", + "createdAt": 1571072845.737, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationDetails": "22/tcp", + "operationType": "CloseInstancePublicPorts", + "status": "Succeeded", + "statusChangedAt": 1571072845.737 + } + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/copy-snapshot.rst awscli-1.18.69/awscli/examples/lightsail/copy-snapshot.rst --- awscli-1.11.13/awscli/examples/lightsail/copy-snapshot.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/copy-snapshot.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,135 @@ +**Example 1: To copy a snapshot within the same AWS Region** + +The following ``copy-snapshot`` example copies instance snapshot ``MEAN-1-1571075291`` as instance snapshot ``MEAN-1-Copy`` within the same AWS Region ``us-west-2``. :: + + aws lightsail copy-snapshot \ + --source-snapshot-name MEAN-1-1571075291 \ + --target-snapshot-name MEAN-1-Copy \ + --source-region us-west-2 + +Output:: + + { + "operations": [ + { + "id": "ced16fc1-f401-4556-8d82-1EXAMPLEb982", + "resourceName": "MEAN-1-Copy", + "resourceType": "InstanceSnapshot", + "createdAt": 1571075581.498, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationDetails": "us-west-2:MEAN-1-1571075291", + "operationType": "CopySnapshot", + "status": "Started", + "statusChangedAt": 1571075581.498 + } + ] + } + +For more information, see `Copying snapshots from one AWS Region to another in Amazon Lightsail `__ in the *Lightsail Dev Guide*. + +**Example 2: To copy a snapshot from one AWS Region to another** + +The following ``copy-snapshot`` example copies instance snapshot ``MEAN-1-1571075291`` as instance snapshot ``MEAN-1-1571075291-Copy`` from AWS Region ``us-west-2`` to ``us-east-1``. :: + + aws lightsail copy-snapshot \ + --source-snapshot-name MEAN-1-1571075291 \ + --target-snapshot-name MEAN-1-1571075291-Copy \ + --source-region us-west-2 \ + --region us-east-1 + +Output:: + + { + "operations": [ + { + "id": "91116b79-119c-4451-b44a-dEXAMPLEd97b", + "resourceName": "MEAN-1-1571075291-Copy", + "resourceType": "InstanceSnapshot", + "createdAt": 1571075695.069, + "location": { + "availabilityZone": "all", + "regionName": "us-east-1" + }, + "isTerminal": false, + "operationDetails": "us-west-2:MEAN-1-1571075291", + "operationType": "CopySnapshot", + "status": "Started", + "statusChangedAt": 1571075695.069 + } + ] + } + +For more information, see `Copying snapshots from one AWS Region to another in Amazon Lightsail `__ in the *Lightsail Dev Guide*. + +**Example 3: To copy an automatic snapshot within the same AWS Region** + +The following ``copy-snapshot`` example copies automatic snapshot ``2019-10-14`` of instance ``WordPress-1`` as a manual snapshot ``WordPress-1-10142019`` in the AWS Region ``us-west-2``. :: + + aws lightsail copy-snapshot \ + --source-resource-name WordPress-1 \ + --restore-date 2019-10-14 \ + --target-snapshot-name WordPress-1-10142019 \ + --source-region us-west-2 + +Output:: + + { + "operations": [ + { + "id": "be3e6754-cd1d-48e6-ad9f-2EXAMPLE1805", + "resourceName": "WordPress-1-10142019", + "resourceType": "InstanceSnapshot", + "createdAt": 1571082412.311, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationDetails": "us-west-2:WordPress-1", + "operationType": "CopySnapshot", + "status": "Started", + "statusChangedAt": 1571082412.311 + } + ] + } + +For more information, see `Keeping automatic snapshots of instances or disks in Amazon Lightsail `__ in the *Lightsail Dev Guide*. + +**Example 4: To copy an automatic snapshot from one AWS Region to another** + +The following ``copy-snapshot`` example copies automatic snapshot ``2019-10-14`` of instance ``WordPress-1`` as a manual snapshot ``WordPress-1-10142019`` from the AWS Region ``us-west-2`` to ``us-east-1``. :: + + aws lightsail copy-snapshot \ + --source-resource-name WordPress-1 \ + --restore-date 2019-10-14 \ + --target-snapshot-name WordPress-1-10142019 \ + --source-region us-west-2 \ + --region us-east-1 + +Output:: + + { + "operations": [ + { + "id": "dffa128b-0b07-476e-b390-bEXAMPLE3775", + "resourceName": "WordPress-1-10142019", + "resourceType": "InstanceSnapshot", + "createdAt": 1571082493.422, + "location": { + "availabilityZone": "all", + "regionName": "us-east-1" + }, + "isTerminal": false, + "operationDetails": "us-west-2:WordPress-1", + "operationType": "CopySnapshot", + "status": "Started", + "statusChangedAt": 1571082493.422 + } + ] + } + +For more information, see `Keeping automatic snapshots of instances or disks in Amazon Lightsail `__ in the *Lightsail Dev Guide*. diff -Nru awscli-1.11.13/awscli/examples/lightsail/create-disk-from-snapshot.rst awscli-1.18.69/awscli/examples/lightsail/create-disk-from-snapshot.rst --- awscli-1.11.13/awscli/examples/lightsail/create-disk-from-snapshot.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/create-disk-from-snapshot.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,32 @@ +**To create a create a disk from a disk snapshot** + +The following ``create-disk-from-snapshot`` example creates a block storage disk named ``Disk-2`` from the specified block storage disk snapshot. The disk is created in the specified AWS Region and Availability Zone, with 32 GB of storage space. :: + + aws lightsail create-disk-from-snapshot \ + --disk-name Disk-2 \ + --disk-snapshot-name Disk-1-1566839161 \ + --availability-zone us-west-2a \ + --size-in-gb 32 + +Output:: + + { + "operations": [ + { + "id": "d42b605d-5ef1-4b4a-8791-7a3e8b66b5e7", + "resourceName": "Disk-2", + "resourceType": "Disk", + "createdAt": 1569624941.471, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationType": "CreateDiskFromSnapshot", + "status": "Started", + "statusChangedAt": 1569624941.791 + } + ] + } + +For more information, see `Creating a block storage disk from a snapshot in Amazon Lightsail `__ in the *Lightsail Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lightsail/create-disk.rst awscli-1.18.69/awscli/examples/lightsail/create-disk.rst --- awscli-1.11.13/awscli/examples/lightsail/create-disk.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/create-disk.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,29 @@ +**To create a block storage disk** + +The following ``create-disk`` example creates a block storage disk ``Disk-1`` in the specified AWS Region and Availability Zone, with 32 GB of storage space. :: + + aws lightsail create-disk \ + --disk-name Disk-1 \ + --availability-zone us-west-2a \ + --size-in-gb 32 + +Output:: + + { + "operations": [ + { + "id": "1c85e2ec-86ba-4697-b936-77f4d3dc013a", + "resourceName": "Disk-1", + "resourceType": "Disk", + "createdAt": 1569449220.36, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationType": "CreateDisk", + "status": "Started", + "statusChangedAt": 1569449220.588 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/create-disk-snapshot.rst awscli-1.18.69/awscli/examples/lightsail/create-disk-snapshot.rst --- awscli-1.11.13/awscli/examples/lightsail/create-disk-snapshot.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/create-disk-snapshot.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,91 @@ +**Example 1: To create a snapshot of a disk** + +The following ``create-disk-snapshot`` example creates a snapshot named ``DiskSnapshot-1`` of the specified block storage disk. :: + + aws lightsail create-disk-snapshot \ + --disk-name Disk-1 \ + --disk-snapshot-name DiskSnapshot-1 + +Output:: + + { + "operations": [ + { + "id": "fa74c6d2-03a3-4f42-a7c7-792f124d534b", + "resourceName": "DiskSnapshot-1", + "resourceType": "DiskSnapshot", + "createdAt": 1569625129.739, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationDetails": "Disk-1", + "operationType": "CreateDiskSnapshot", + "status": "Started", + "statusChangedAt": 1569625129.739 + }, + { + "id": "920a25df-185c-4528-87cd-7b85f5488c06", + "resourceName": "Disk-1", + "resourceType": "Disk", + "createdAt": 1569625129.739, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationDetails": "DiskSnapshot-1", + "operationType": "CreateDiskSnapshot", + "status": "Started", + "statusChangedAt": 1569625129.739 + } + ] + } + +**Example 2: To create a snapshot of an instance's system disk** + +The following ``create-disk-snapshot`` example creates a snapshot of the specified instance's system disk. :: + + aws lightsail create-disk-snapshot \ + --instance-name WordPress-1 \ + --disk-snapshot-name SystemDiskSnapshot-1 + +Output:: + + { + "operations": [ + { + "id": "f508cf1c-6597-42a6-a4c3-4aebd75af0d9", + "resourceName": "SystemDiskSnapshot-1", + "resourceType": "DiskSnapshot", + "createdAt": 1569625294.685, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationDetails": "WordPress-1", + "operationType": "CreateDiskSnapshot", + "status": "Started", + "statusChangedAt": 1569625294.685 + }, + { + "id": "0bb9f712-da3b-4d99-b508-3bf871d989e5", + "resourceName": "WordPress-1", + "resourceType": "Instance", + "createdAt": 1569625294.685, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationDetails": "SystemDiskSnapshot-1", + "operationType": "CreateDiskSnapshot", + "status": "Started", + "statusChangedAt": 1569625294.685 + } + ] + } + +For more information, see `Snapshots in Amazon Lightsail `__ and `Creating a snapshot of an instance root volume in Amazon Lightsail `__ in the *Lightsail Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lightsail/create-domain-entry.rst awscli-1.18.69/awscli/examples/lightsail/create-domain-entry.rst --- awscli-1.11.13/awscli/examples/lightsail/create-domain-entry.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/create-domain-entry.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,31 @@ +**To create a domain entry (DNS record)** + +The following ``create-domain-entry`` example creates a DNS record (A) for the apex of the specified domain that points to an instance's IP address. + +**Note:** Lightsail's domain-related API operations are available in only the ``us-east-1`` Region. If your CLI profile is configured to use a different Region, you must include the ``--region us-east-1`` parameter or the command fails. :: + + aws lightsail create-domain-entry \ + --region us-east-1 \ + --domain-name example.com \ + --domain-entry name=example.com,type=A,target=192.0.2.0 + +Output:: + + { + "operation": { + "id": "5be4494d-56f4-41fc-8730-693dcd0ef9e2", + "resourceName": "example.com", + "resourceType": "Domain", + "createdAt": 1569865296.519, + "location": { + "availabilityZone": "all", + "regionName": "global" + }, + "isTerminal": true, + "operationType": "CreateDomainEntry", + "status": "Succeeded", + "statusChangedAt": 1569865296.519 + } + } + +For more information, see `DNS in Amazon Lightsail `__ and `Creating a DNS zone to manage your domain's DNS records in Amazon Lightsail `__ in the *Lightsail Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lightsail/create-domain.rst awscli-1.18.69/awscli/examples/lightsail/create-domain.rst --- awscli-1.11.13/awscli/examples/lightsail/create-domain.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/create-domain.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,30 @@ +**To create a domain (DNS zone)** + +The following ``create-domain`` example creates a DNS zone for the specified domain. + +**Note:** Lightsail's domain-related API operations are available in only the ``us-east-1`` Region. If your CLI profile is configured to use a different Region, you must include the ``--region us-east-1`` parameter or the command fails. :: + + aws lightsail create-domain \ + --region us-east-1 \ + --domain-name example.com + +Output:: + + { + "operation": { + "id": "64e522c8-9ae1-4c05-9b65-3f237324dc34", + "resourceName": "example.com", + "resourceType": "Domain", + "createdAt": 1569864291.92, + "location": { + "availabilityZone": "all", + "regionName": "global" + }, + "isTerminal": true, + "operationType": "CreateDomain", + "status": "Succeeded", + "statusChangedAt": 1569864292.109 + } + } + +For more information, see `DNS in Amazon Lightsail `__ and `Creating a DNS zone to manage your domain's DNS records in Amazon Lightsail `__ in the *Lightsail Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lightsail/create-instances-from-snapshot.rst awscli-1.18.69/awscli/examples/lightsail/create-instances-from-snapshot.rst --- awscli-1.11.13/awscli/examples/lightsail/create-instances-from-snapshot.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/create-instances-from-snapshot.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,32 @@ +**To create an instance from a snapshot** + +The following ``create-instances-from-snapshot`` example creates an instance from the specified instance snapshot, in the specified AWS Region and Availability Zone, using the $10 USD bundle. + +**Note:** The bundle that you specify must be equal to or greater in specifications than the bundle of the original source instance used to create the snapshot. :: + + aws lightsail create-instances-from-snapshot \ + --instance-snapshot-name WordPress-1-1569866208 \ + --instance-names WordPress-2 \ + --availability-zone us-west-2a \ + --bundle-id medium_2_0 + +Output:: + + { + "operations": [ + { + "id": "003f8271-b711-464d-b9b8-7f3806cb496e", + "resourceName": "WordPress-2", + "resourceType": "Instance", + "createdAt": 1569865914.908, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationType": "CreateInstancesFromSnapshot", + "status": "Started", + "statusChangedAt": 1569865914.908 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/create-instance-snapshot.rst awscli-1.18.69/awscli/examples/lightsail/create-instance-snapshot.rst --- awscli-1.11.13/awscli/examples/lightsail/create-instance-snapshot.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/create-instance-snapshot.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,44 @@ +**To create a snapshot of an instance** + +The following ``create-instance-snapshot`` example creates a snapshot from the specified instance. :: + + aws lightsail create-instance-snapshot \ + --instance-name WordPress-1 \ + --instance-snapshot-name WordPress-Snapshot-1 + +Output:: + + { + "operations": [ + { + "id": "4c3db559-9dd0-41e7-89c0-2cb88c19786f", + "resourceName": "WordPress-Snapshot-1", + "resourceType": "InstanceSnapshot", + "createdAt": 1569866438.48, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationDetails": "WordPress-1", + "operationType": "CreateInstanceSnapshot", + "status": "Started", + "statusChangedAt": 1569866438.48 + }, + { + "id": "c04fdc45-2981-488c-88b5-d6d2fd759a6a", + "resourceName": "WordPress-1", + "resourceType": "Instance", + "createdAt": 1569866438.48, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationDetails": "WordPress-Snapshot-1", + "operationType": "CreateInstanceSnapshot", + "status": "Started", + "statusChangedAt": 1569866438.48 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/create-instances.rst awscli-1.18.69/awscli/examples/lightsail/create-instances.rst --- awscli-1.11.13/awscli/examples/lightsail/create-instances.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/create-instances.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,89 @@ +**Example 1: To create a single instance** + +The following ``create-instances`` example creates an instance in the specified AWS Region and Availability Zone, using the WordPress blueprint, and the $3.50 USD bundle. :: + + aws lightsail create-instances \ + --instance-names Instance-1 \ + --availability-zone us-west-2a \ + --blueprint-id wordpress_5_1_1_2 \ + --bundle-id nano_2_0 + +Output:: + + { + "operations": [ + { + "id": "9a77158f-7be3-4d6d-8054-cf5ae2b720cc", + "resourceName": "Instance-1", + "resourceType": "Instance", + "createdAt": 1569447986.061, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationType": "CreateInstance", + "status": "Started", + "statusChangedAt": 1569447986.061 + } + ] + } + +**Example 2: To create multiple instances at one time** + +The following ``create-instances`` example creates three instances in the specified AWS Region and Availability Zone, using the WordPress blueprint, and the $3.50 USD bundle. :: + + aws lightsail create-instances \ + --instance-names {"Instance1","Instance2","Instance3"} \ + --availability-zone us-west-2a \ + --blueprint-id wordpress_5_1_1_2 \ + --bundle-id nano_2_0 + +Output:: + + { + "operations": [ + { + "id": "5492f015-9d2e-48c6-8eea-b516840e6903", + "resourceName": "Instance1", + "resourceType": "Instance", + "createdAt": 1569448780.054, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationType": "CreateInstance", + "status": "Started", + "statusChangedAt": 1569448780.054 + }, + { + "id": "c58b5f46-2676-44c8-b95c-3ad375898515", + "resourceName": "Instance2", + "resourceType": "Instance", + "createdAt": 1569448780.054, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationType": "CreateInstance", + "status": "Started", + "statusChangedAt": 1569448780.054 + }, + { + "id": "a5ad8006-9bee-4499-9eb7-75e42e6f5882", + "resourceName": "Instance3", + "resourceType": "Instance", + "createdAt": 1569448780.054, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationType": "CreateInstance", + "status": "Started", + "statusChangedAt": 1569448780.054 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/create-key-pair.rst awscli-1.18.69/awscli/examples/lightsail/create-key-pair.rst --- awscli-1.11.13/awscli/examples/lightsail/create-key-pair.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/create-key-pair.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,39 @@ +**To create a key pair** + +The following ``create-key-pair`` example creates a key pair that you can use to authenticate and connect to an instance. :: + + aws lightsail create-key-pair \ + --key-pair-name MyPersonalKeyPair + +The output provides the private key base64 value that you can use to authenticate to instances that use the created key pair. +**Note:** Copy and paste the private key base64 value to a safe location because you cannot retrieve it later. :: + + { + "keyPair": { + "name": "MyPersonalKeyPair", + "arn": "arn:aws:lightsail:us-west-2:111122223333:KeyPair/55025c71-198f-403b-b42f-a69433e724fb", + "supportCode": "621291663362/MyPersonalKeyPair", + "createdAt": 1569866556.567, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "resourceType": "KeyPair" + }, + "publicKeyBase64": "ssh-rsa ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCV0xUEwx96amPERH7K1bVT1tTFl9OmNk6o7m5YVHk9xlOdMbDRbFvhtXvw4jzJXXz5pBMxWOaGMz5K8QyTVOznoqp13Z8SBooH29hgmBNXiII1XPzEwqbj8mfo1+YVM5s5VuxWwm+BHUgedGUXno6uF7agqxZNO1kPLJBIVTW26SSYBJ0tE+y804UyVsjrbUqCaMXDhmfXpWulMPwuXhwcKh7e8hwoTfkiX0E6Ql+KqF/MiA3w6DCjEqvvdIO7SiEZJFsuGNfYDDN3w60Rel5MUhmn3OJdn4y/A7NWb3IxL4pPfVE4rgFRKU8n1jp9kwRnlVMVBOWuGXk6n+H6M2f1 ", + "privateKeyBase64": "-----BEGIN RSA PRIVATE KEY-----EXAMPLETCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC\nVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6\nb24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsEXAMPLEd\nBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN\nMTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD\nVQQHEwdTZWF0dGxlMQ8wDQEXAMPLEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z\nb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt\nYXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMEXAMPLE4GmWIWJ\n21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T\nrDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE\nIbb3OhjZnzcvQAaREXAMPLEMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4\nnUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb\nFFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OEXAMPLELvjx79LjSTb\nNYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE=\n-----END RSA PRIVATE KEY-----", + "operation": { + "id": "67f984db-9994-45fe-ad38-59bafcaf82ef", + "resourceName": "MyPersonalKeyPair", + "resourceType": "KeyPair", + "createdAt": 1569866556.567, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationType": "CreateKeyPair", + "status": "Succeeded", + "statusChangedAt": 1569866556.704 + } + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/create-load-balancer.rst awscli-1.18.69/awscli/examples/lightsail/create-load-balancer.rst --- awscli-1.11.13/awscli/examples/lightsail/create-load-balancer.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/create-load-balancer.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,63 @@ +**To create a load balancer** + +The following ``create-load-balancer`` example creates a load balancer with a TLS certificate. The TLS certificate applies to the specified domains, and routes traffic to instances on port 80. :: + + aws lightsail create-load-balancer \ + --certificate-alternative-names www.example.com test.example.com \ + --certificate-domain-name example.com \ + --certificate-name Certificate-1 \ + --instance-port 80 \ + --load-balancer-name LoadBalancer-1 + +Output:: + + { + "operations": [ + { + "id": "cc7b920a-83d8-4762-a74e-9174fe1540be", + "resourceName": "LoadBalancer-1", + "resourceType": "LoadBalancer", + "createdAt": 1569867169.406, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationType": "CreateLoadBalancer", + "status": "Started", + "statusChangedAt": 1569867169.406 + }, + { + "id": "658ed43b-f729-42f3-a8e4-3f8024d3c98d", + "resourceName": "LoadBalancer-1", + "resourceType": "LoadBalancerTlsCertificate", + "createdAt": 1569867170.193, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationDetails": "LoadBalancer-1", + "operationType": "CreateLoadBalancerTlsCertificate", + "status": "Succeeded", + "statusChangedAt": 1569867170.54 + }, + { + "id": "4757a342-5181-4870-b1e0-227eebc35ab5", + "resourceName": "LoadBalancer-1", + "resourceType": "LoadBalancer", + "createdAt": 1569867170.193, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationDetails": "Certificate-1", + "operationType": "CreateLoadBalancerTlsCertificate", + "status": "Succeeded", + "statusChangedAt": 1569867170.54 + } + ] + } + +For more information, see `Lightsail load balancers `__ in the *Lightsail Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/lightsail/create-load-balancer-tls-certificate.rst awscli-1.18.69/awscli/examples/lightsail/create-load-balancer-tls-certificate.rst --- awscli-1.11.13/awscli/examples/lightsail/create-load-balancer-tls-certificate.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/create-load-balancer-tls-certificate.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,47 @@ +**To create a TLS certificate for a load balancer** + +The following ``create-load-balancer-tls-certificate`` example creates a TLS certificate that is attached to the specified load balancer. The certificate created applies to the specified domains. +**Note:** Only two certificates can be created for a load balancer. :: + + aws lightsail create-load-balancer-tls-certificate \ + --certificate-alternative-names abc.example.com \ + --certificate-domain-name example.com \ + --certificate-name MySecondCertificate \ + --load-balancer-name MyFirstLoadBalancer + +Output:: + + { + "operations": [ + { + "id": "be663aed-cb46-41e2-9b23-e2f747245bd4", + "resourceName": "MySecondCertificate", + "resourceType": "LoadBalancerTlsCertificate", + "createdAt": 1569867364.971, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationDetails": "MyFirstLoadBalancer", + "operationType": "CreateLoadBalancerTlsCertificate", + "status": "Succeeded", + "statusChangedAt": 1569867365.219 + }, + { + "id": "f3dfa930-969e-41cc-ac7d-337178716f6d", + "resourceName": "MyFirstLoadBalancer", + "resourceType": "LoadBalancer", + "createdAt": 1569867364.971, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationDetails": "MySecondCertificate", + "operationType": "CreateLoadBalancerTlsCertificate", + "status": "Succeeded", + "statusChangedAt": 1569867365.219 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/create-relational-database-from-snapshot.rst awscli-1.18.69/awscli/examples/lightsail/create-relational-database-from-snapshot.rst --- awscli-1.11.13/awscli/examples/lightsail/create-relational-database-from-snapshot.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/create-relational-database-from-snapshot.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,32 @@ +**To create a managed database from a snapshot** + +The following ``create-relational-database-from-snapshot`` example creates a managed database from the specified snapshot in the specified AWS Region and Availability Zone, using the $15 USD standard database bundle. +**Note:** The bundle that you specify must be equal to or greater in specifications than the bundle of the original source database used to create the snapshot. :: + + aws lightsail create-relational-database-from-snapshot \ + --relational-database-snapshot-name Database-Oregon-1-1566839359 \ + --relational-database-name Database-1 \ + --availability-zone us-west-2a \ + --relational-database-bundle-id micro_1_0 \ + --no-publicly-accessible + +Output:: + + { + "operations": [ + { + "id": "ad6d9193-9d5c-4ea1-97ae-8fe6de600b4c", + "resourceName": "Database-1", + "resourceType": "RelationalDatabase", + "createdAt": 1569867916.938, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationType": "CreateRelationalDatabaseFromSnapshot", + "status": "Started", + "statusChangedAt": 1569867918.643 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/create-relational-database.rst awscli-1.18.69/awscli/examples/lightsail/create-relational-database.rst --- awscli-1.11.13/awscli/examples/lightsail/create-relational-database.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/create-relational-database.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,33 @@ +**To create a managed database** + +The following ``create-relational-database`` example creates a managed database in the specified AWS Region and Availability Zone, using the MySQL 5.6 database engine (mysql_5_6), and the $15 USD standard database bundle (micro_1_0). The managed database is pre-populated a master user name, and is not publicly accessible. :: + + aws lightsail create-relational-database \ + --relational-database-name Database-1 \ + --availability-zone us-west-2a \ + --relational-database-blueprint-id mysql_5_6 \ + --relational-database-bundle-id micro_1_0 \ + --master-database-name dbmaster \ + --master-username user \ + --no-publicly-accessible + +Output:: + + { + "operations": [ + { + "id": "b52bedee-73ed-4798-8d2a-9c12df89adcd", + "resourceName": "Database-1", + "resourceType": "RelationalDatabase", + "createdAt": 1569450017.244, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationType": "CreateRelationalDatabase", + "status": "Started", + "statusChangedAt": 1569450018.637 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/create-relational-database-snapshot.rst awscli-1.18.69/awscli/examples/lightsail/create-relational-database-snapshot.rst --- awscli-1.11.13/awscli/examples/lightsail/create-relational-database-snapshot.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/create-relational-database-snapshot.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,44 @@ +**To create a snapshot of a managed database** + +The following ``create-relational-database-snapshot`` example creates a snapshot of the specified managed database. :: + + aws lightsail create-relational-database-snapshot \ + --relational-database-name Database1 \ + --relational-database-snapshot-name RelationalDatabaseSnapshot1 + +Output:: + + { + "operations": [ + { + "id": "853667fb-ea91-4c02-8d20-8fc5fd43b9eb", + "resourceName": "RelationalDatabaseSnapshot1", + "resourceType": "RelationalDatabaseSnapshot", + "createdAt": 1569868074.645, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationDetails": "Database1", + "operationType": "CreateRelationalDatabaseSnapshot", + "status": "Started", + "statusChangedAt": 1569868074.645 + }, + { + "id": "fbafa521-3cac-4be8-9773-1c143780b239", + "resourceName": "Database1", + "resourceType": "RelationalDatabase", + "createdAt": 1569868074.645, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationDetails": "RelationalDatabaseSnapshot1", + "operationType": "CreateRelationalDatabaseSnapshot", + "status": "Started", + "statusChangedAt": 1569868074.645 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/delete-auto-snapshot.rst awscli-1.18.69/awscli/examples/lightsail/delete-auto-snapshot.rst --- awscli-1.11.13/awscli/examples/lightsail/delete-auto-snapshot.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/delete-auto-snapshot.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,30 @@ +**To delete an automatic snapshot** + +The following ``delete-auto-snapshot`` example deletes the automatic snapshot ``2019-10-10`` of instance ``WordPress-1``. :: + + aws lightsail delete-auto-snapshot \ + --resource-name WordPress-1 \ + --date 2019-10-10 + +Output:: + + { + "operations": [ + { + "id": "31c36e09-3d52-46d5-b6d8-7EXAMPLE534a", + "resourceName": "WordPress-1", + "resourceType": "Instance", + "createdAt": 1571088141.501, + "location": { + "availabilityZone": "us-west-2", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationDetails": "DeleteAutoSnapshot-2019-10-10", + "operationType": "DeleteAutoSnapshot", + "status": "Succeeded" + } + ] + } + +For more information, see `Deleting automatic snapshots of instances or disks in Amazon Lightsail `__ in the *Lightsail Dev Guide*. diff -Nru awscli-1.11.13/awscli/examples/lightsail/delete-disk.rst awscli-1.18.69/awscli/examples/lightsail/delete-disk.rst --- awscli-1.11.13/awscli/examples/lightsail/delete-disk.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/delete-disk.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,27 @@ +**To delete a block storage disk** + +The following ``delete-disk`` example deletes the specified block storage disk. :: + + aws lightsail delete-disk \ + --disk-name Disk-1 + +Output:: + + { + "operations": [ + { + "id": "6378c70f-4d75-4f7a-ab66-730fca0bb2fc", + "resourceName": "Disk-1", + "resourceType": "Disk", + "createdAt": 1569872887.864, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationType": "DeleteDisk", + "status": "Succeeded", + "statusChangedAt": 1569872887.864 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/delete-disk-snapshot.rst awscli-1.18.69/awscli/examples/lightsail/delete-disk-snapshot.rst --- awscli-1.11.13/awscli/examples/lightsail/delete-disk-snapshot.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/delete-disk-snapshot.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,27 @@ +**To delete a snapshot of a block storage disk** + +The following ``delete-disk-snapshot`` example deletes the specified snapshot of a block storage disk :: + + aws lightsail delete-disk-snapshot \ + --disk-snapshot-name DiskSnapshot-1 + +Output:: + + { + "operations": [ + { + "id": "d1e5766d-b81e-4595-ad5d-02afbccfcd5d", + "resourceName": "DiskSnapshot-1", + "resourceType": "DiskSnapshot", + "createdAt": 1569873552.79, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationType": "DeleteDiskSnapshot", + "status": "Succeeded", + "statusChangedAt": 1569873552.79 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/delete-domain-entry.rst awscli-1.18.69/awscli/examples/lightsail/delete-domain-entry.rst --- awscli-1.11.13/awscli/examples/lightsail/delete-domain-entry.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/delete-domain-entry.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,29 @@ +**To delete a domain entry (DNS record)** + +The following ``delete-domain-entry`` example deletes the specified domain entry from an existing domain. + +**Note:** Lightsail's domain-related API operations are available in only the ``us-east-1`` Region. If your CLI profile is configured to use a different Region, you must include the ``--region us-east-1`` parameter or the command fails. :: + + aws lightsail delete-domain-entry \ + --region us-east-1 \ + --domain-name example.com \ + --domain-entry name=123.example.com,target=192.0.2.0,type=A + +Output:: + + { + "operation": { + "id": "06eacd01-d785-420e-8daa-823150c7dca1", + "resourceName": "example.com ", + "resourceType": "Domain", + "createdAt": 1569874157.005, + "location": { + "availabilityZone": "all", + "regionName": "global" + }, + "isTerminal": true, + "operationType": "DeleteDomainEntry", + "status": "Succeeded", + "statusChangedAt": 1569874157.005 + } + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/delete-domain.rst awscli-1.18.69/awscli/examples/lightsail/delete-domain.rst --- awscli-1.11.13/awscli/examples/lightsail/delete-domain.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/delete-domain.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,28 @@ +**To delete a domain (DNS zone)** + +The following ``delete-domain`` example deletes the specified domain and all of the entries in the domain (DNS records). + +**Note:** Lightsail's domain-related API operations are available in only the ``us-east-1`` Region. If your CLI profile is configured to use a different Region, you must include the ``--region us-east-1`` parameter or the command fails. :: + + aws lightsail delete-domain \ + --region us-east-1 \ + --domain-name example.com + +Output:: + + { + "operation": { + "id": "fcef5265-5af1-4a46-a3d7-90b5e18b9b32", + "resourceName": "example.com", + "resourceType": "Domain", + "createdAt": 1569873788.13, + "location": { + "availabilityZone": "all", + "regionName": "global" + }, + "isTerminal": true, + "operationType": "DeleteDomain", + "status": "Succeeded", + "statusChangedAt": 1569873788.13 + } + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/delete-instance.rst awscli-1.18.69/awscli/examples/lightsail/delete-instance.rst --- awscli-1.11.13/awscli/examples/lightsail/delete-instance.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/delete-instance.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,57 @@ +**To delete an instance** + +The following ``delete-instance`` example deletes the specified instance. :: + + aws lightsail delete-instance \ + --instance-name WordPress-1 + +Output:: + + { + "operations": [ + { + "id": "d77345a3-8f80-4d2e-b47d-aaa622718df2", + "resourceName": "Disk-1", + "resourceType": "Disk", + "createdAt": 1569874357.469, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationDetails": "WordPress-1", + "operationType": "DetachDisk", + "status": "Started", + "statusChangedAt": 1569874357.469 + }, + { + "id": "708fa606-2bfd-4e48-a2c1-0b856585b5b1", + "resourceName": "WordPress-1", + "resourceType": "Instance", + "createdAt": 1569874357.465, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationDetails": "Disk-1", + "operationType": "DetachDisk", + "status": "Started", + "statusChangedAt": 1569874357.465 + }, + { + "id": "3187e823-8acb-405d-b098-fad5ceb17bec", + "resourceName": "WordPress-1", + "resourceType": "Instance", + "createdAt": 1569874357.829, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationType": "DeleteInstance", + "status": "Succeeded", + "statusChangedAt": 1569874357.829 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/delete-instance-snapshot.rst awscli-1.18.69/awscli/examples/lightsail/delete-instance-snapshot.rst --- awscli-1.11.13/awscli/examples/lightsail/delete-instance-snapshot.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/delete-instance-snapshot.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,27 @@ +**title** + +The following ``delete-instance-snapshot`` example deletes the specified snapshot of an instance. :: + + aws lightsail delete-instance-snapshot \ + --instance-snapshot-name WordPress-1-Snapshot-1 + +Output:: + + { + "operations": [ + { + "id": "14dad182-976a-46c6-bfd4-9480482bf0ea", + "resourceName": "WordPress-1-Snapshot-1", + "resourceType": "InstanceSnapshot", + "createdAt": 1569874524.562, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationType": "DeleteInstanceSnapshot", + "status": "Succeeded", + "statusChangedAt": 1569874524.562 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/delete-key-pair.rst awscli-1.18.69/awscli/examples/lightsail/delete-key-pair.rst --- awscli-1.11.13/awscli/examples/lightsail/delete-key-pair.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/delete-key-pair.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,25 @@ +**To delete a key pair** + +The following ``delete-key-pair`` example deletes the specified key pair. :: + + aws lightsail delete-key-pair \ + --key-pair-name MyPersonalKeyPair + +Output:: + + { + "operation": { + "id": "81621463-df38-4810-b866-6e801a15abbf", + "resourceName": "MyPersonalKeyPair", + "resourceType": "KeyPair", + "createdAt": 1569874626.466, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationType": "DeleteKeyPair", + "status": "Succeeded", + "statusChangedAt": 1569874626.685 + } + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/delete-known-host-keys.rst awscli-1.18.69/awscli/examples/lightsail/delete-known-host-keys.rst --- awscli-1.11.13/awscli/examples/lightsail/delete-known-host-keys.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/delete-known-host-keys.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,29 @@ +**To delete known host keys from an instance** + +The following ``delete-known-host-keys`` example deletes the known host key from the specified instance. :: + + aws lightsail delete-known-host-keys \ + --instance-name Instance-1 + +Output:: + + { + "operations": [ + { + "id": "c61afe9c-45a4-41e6-a97e-d212364da3f5", + "resourceName": "Instance-1", + "resourceType": "Instance", + "createdAt": 1569874760.201, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationType": "DeleteKnownHostKeys", + "status": "Succeeded", + "statusChangedAt": 1569874760.201 + } + ] + } + +For more information, see `Troubleshooting connection issues with the Amazon Lightsail browser-based SSH or RDP client `__ in the *Lightsail Dev Guide*. diff -Nru awscli-1.11.13/awscli/examples/lightsail/delete-load-balancer.rst awscli-1.18.69/awscli/examples/lightsail/delete-load-balancer.rst --- awscli-1.11.13/awscli/examples/lightsail/delete-load-balancer.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/delete-load-balancer.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,57 @@ +**To delete a load balancer** + +The following ``delete-load-balancer`` example deletes the specified load balancer and any associated TLS certificates. :: + + aws lightsail delete-load-balancer \ + --load-balancer-name MyFirstLoadBalancer + +Output:: + + { + "operations": [ + { + "id": "a8c968c7-72a3-4680-a714-af8f03eea535", + "resourceName": "MyFirstLoadBalancer", + "resourceType": "LoadBalancer", + "createdAt": 1569875092.125, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationType": "DeleteLoadBalancer", + "status": "Succeeded", + "statusChangedAt": 1569875092.125 + }, + { + "id": "f91a29fc-8ce3-4e69-a227-ea70ca890bf5", + "resourceName": "MySecondCertificate", + "resourceType": "LoadBalancerTlsCertificate", + "createdAt": 1569875091.938, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationType": "DeleteLoadBalancerTlsCertificate", + "status": "Started", + "statusChangedAt": 1569875091.938 + }, + { + "id": "cf64c060-154b-4eb4-ba57-84e2e41563d6", + "resourceName": "MyFirstLoadBalancer", + "resourceType": "LoadBalancer", + "createdAt": 1569875091.94, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationType": "DeleteLoadBalancerTlsCertificate", + "status": "Started", + "statusChangedAt": 1569875091.94 + } + ] + } + +For more information, see `title `__ in the *guide*. diff -Nru awscli-1.11.13/awscli/examples/lightsail/delete-load-balancer-tls-certificate.rst awscli-1.18.69/awscli/examples/lightsail/delete-load-balancer-tls-certificate.rst --- awscli-1.11.13/awscli/examples/lightsail/delete-load-balancer-tls-certificate.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/delete-load-balancer-tls-certificate.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,42 @@ +**To delete a TLS certificate for a load balancer** + +The following ``delete-load-balancer-tls-certificate`` example deletes the specifie TLS certificate from the specified load balancer. :: + + aws lightsail delete-load-balancer-tls-certificate \ + --load-balancer-name MyFirstLoadBalancer \ + --certificate-name MyFirstCertificate + +Output:: + + { + "operations": [ + { + "id": "50bec274-e45e-4caa-8a69-b763ef636583", + "resourceName": "MyFirstCertificate", + "resourceType": "LoadBalancerTlsCertificate", + "createdAt": 1569874989.48, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationType": "DeleteLoadBalancerTlsCertificate", + "status": "Started", + "statusChangedAt": 1569874989.48 + }, + { + "id": "78c58cdc-a59a-4b27-8213-500638634a8f", + "resourceName": "MyFirstLoadBalancer", + "resourceType": "LoadBalancer", + "createdAt": 1569874989.48, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationType": "DeleteLoadBalancerTlsCertificate", + "status": "Started", + "statusChangedAt": 1569874989.48 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/delete-relational-database.rst awscli-1.18.69/awscli/examples/lightsail/delete-relational-database.rst --- awscli-1.11.13/awscli/examples/lightsail/delete-relational-database.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/delete-relational-database.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,57 @@ +**To delete a managed database** + +The following ``delete-relational-database`` example deletes the specified managed database. :: + + aws lightsail delete-relational-database \ + --relational-database-name Database-1 + +Output:: + + { + "operations": [ + { + "id": "3b0c41c1-053d-46f0-92a3-14f76141dc86", + "resourceName": "Database-1", + "resourceType": "RelationalDatabase", + "createdAt": 1569875210.999, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationType": "DeleteRelationalDatabase", + "status": "Started", + "statusChangedAt": 1569875210.999 + }, + { + "id": "01ddeae8-a87a-4a4b-a1f3-092c71bf9180", + "resourceName": "Database-1", + "resourceType": "RelationalDatabase", + "createdAt": 1569875211.029, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationDetails": "Database-1-FinalSnapshot-1569875210793", + "operationType": "CreateRelationalDatabaseSnapshot", + "status": "Started", + "statusChangedAt": 1569875211.029 + }, + { + "id": "74d73681-30e8-4532-974e-1f23cd3f9f73", + "resourceName": "Database-1-FinalSnapshot-1569875210793", + "resourceType": "RelationalDatabaseSnapshot", + "createdAt": 1569875211.029, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationDetails": "Database-1", + "operationType": "CreateRelationalDatabaseSnapshot", + "status": "Started", + "statusChangedAt": 1569875211.029 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/delete-relational-database-snapshot.rst awscli-1.18.69/awscli/examples/lightsail/delete-relational-database-snapshot.rst --- awscli-1.11.13/awscli/examples/lightsail/delete-relational-database-snapshot.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/delete-relational-database-snapshot.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,27 @@ +**To delete a snapshot of a managed database** + +The following ``delete-relational-database-snapshot`` example deletes the specified snapshot of a managed database. :: + + aws lightsail delete-relational-database-snapshot \ + --relational-database-snapshot-name Database-Oregon-1-1566839359 + +Output:: + + { + "operations": [ + { + "id": "b99acae8-735b-4823-922f-30af580e3729", + "resourceName": "Database-Oregon-1-1566839359", + "resourceType": "RelationalDatabaseSnapshot", + "createdAt": 1569875293.58, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationType": "DeleteRelationalDatabaseSnapshot", + "status": "Succeeded", + "statusChangedAt": 1569875293.58 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/detach-static-ip.rst awscli-1.18.69/awscli/examples/lightsail/detach-static-ip.rst --- awscli-1.11.13/awscli/examples/lightsail/detach-static-ip.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/detach-static-ip.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,43 @@ +**To detach a static IP from an instance** + +The following ``detach-static-ip`` example detaches static IP ``StaticIp-1`` from any attached instance. :: + + aws lightsail detach-static-ip \ + --static-ip-name StaticIp-1 + +Output:: + + { + "operations": [ + { + "id": "2a43d8a3-9f2d-4fe7-bdd0-eEXAMPLE3cf3", + "resourceName": "StaticIp-1", + "resourceType": "StaticIp", + "createdAt": 1571088261.999, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationDetails": "MEAN-1", + "operationType": "DetachStaticIp", + "status": "Succeeded", + "statusChangedAt": 1571088261.999 + }, + { + "id": "41a7d40c-74e8-4d2e-a837-cEXAMPLEf747", + "resourceName": "MEAN-1", + "resourceType": "Instance", + "createdAt": 1571088262.022, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationDetails": "StaticIp-1", + "operationType": "DetachStaticIp", + "status": "Succeeded", + "statusChangedAt": 1571088262.022 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-active-names.rst awscli-1.18.69/awscli/examples/lightsail/get-active-names.rst --- awscli-1.11.13/awscli/examples/lightsail/get-active-names.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-active-names.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,16 @@ +**To get active resource names** + +The following ``get-active-names`` example returns the active resource names in the configured AWS Region. :: + + aws lightsail get-active-names + +Output:: + + { + "activeNames": [ + "WordPress-1", + "StaticIp-1", + "MEAN-1", + "Plesk_Hosting_Stack_on_Ubuntu-1" + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-auto-snapshots.rst awscli-1.18.69/awscli/examples/lightsail/get-auto-snapshots.rst --- awscli-1.11.13/awscli/examples/lightsail/get-auto-snapshots.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-auto-snapshots.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,41 @@ +**To get the available automatic snapshots for an instance** + +The following ``get-auto-snapshots`` example returns the available automatic snapshots for instance ``WordPress-1``. :: + + aws lightsail get-auto-snapshots \ + --resource-name WordPress-1 + +Output:: + + { + "resourceName": "WordPress-1", + "resourceType": "Instance", + "autoSnapshots": [ + { + "date": "2019-10-14", + "createdAt": 1571033872.0, + "status": "Success", + "fromAttachedDisks": [] + }, + { + "date": "2019-10-13", + "createdAt": 1570947473.0, + "status": "Success", + "fromAttachedDisks": [] + }, + { + "date": "2019-10-12", + "createdAt": 1570861072.0, + "status": "Success", + "fromAttachedDisks": [] + }, + { + "date": "2019-10-11", + "createdAt": 1570774672.0, + "status": "Success", + "fromAttachedDisks": [] + } + ] + } + +For more information, see `Keeping automatic snapshots of instances or disks in Amazon Lightsail `__ in the *Lightsail Dev Guide*. diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-blueprints.rst awscli-1.18.69/awscli/examples/lightsail/get-blueprints.rst --- awscli-1.11.13/awscli/examples/lightsail/get-blueprints.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-blueprints.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,56 @@ +**To get the blueprints for new instances** + +The following ``get-blueprints`` example displays details about all of the available blueprints that can be used to create new instances in Amazon Lightsail. :: + + aws lightsail get-blueprints + +Output:: + + { + "blueprints": [ + { + "blueprintId": "wordpress", + "name": "WordPress", + "group": "wordpress", + "type": "app", + "description": "Bitnami, the leaders in application packaging, and Automattic, the experts behind WordPress, have teamed up to offer this official WordPress image. This image is a pre-configured, ready-to-run image for running WordPress on Amazon Lightsail. WordPress is the world's most popular content management platform. Whether it's for an enterprise or small business website, or a personal or corporate blog, content authors can easily create content using its new Gutenberg editor, and developers can extend the base platform with additional features. Popular plugins like Jetpack, Akismet, All in One SEO Pack, WP Mail, Google Analytics for WordPress, and Amazon Polly are all pre-installed in this image. Let's Encrypt SSL certificates are supported through an auto-configuration script.", + "isActive": true, + "minPower": 0, + "version": "5.2.2-3", + "versionCode": "1", + "productUrl": "https://aws.amazon.com/marketplace/pp/B00NN8Y43U", + "licenseUrl": "https://d7umqicpi7263.cloudfront.net/eula/product/7d426cb7-9522-4dd7-a56b-55dd8cc1c8d0/588fd495-6492-4610-b3e8-d15ce864454c.txt", + "platform": "LINUX_UNIX" + }, + { + "blueprintId": "lamp_7_1_28", + "name": "LAMP (PHP 7)", + "group": "lamp_7", + "type": "app", + "description": "LAMP with PHP 7.x certified by Bitnami greatly simplifies the development and deployment of PHP applications. It includes the latest versions of PHP 7.x, Apache and MySQL together with phpMyAdmin and popular PHP frameworks Zend, Symfony, CodeIgniter, CakePHP, Smarty, and Laravel. Other pre-configured components and PHP modules include FastCGI, ModSecurity, SQLite, Varnish, ImageMagick, xDebug, Xcache, OpenLDAP, Memcache, OAuth, PEAR, PECL, APC, GD and cURL. It is secure by default and supports multiple applications, each with its own virtual host and project directory. Let's Encrypt SSL certificates are supported through an auto-configuration script.", + "isActive": true, + "minPower": 0, + "version": "7.1.28", + "versionCode": "1", + "productUrl": "https://aws.amazon.com/marketplace/pp/B072JNJZ5C", + "licenseUrl": "https://d7umqicpi7263.cloudfront.net/eula/product/cb6afd05-a3b2-4916-a3e6-bccd414f5f21/12ab56cc-6a8c-4977-9611-dcd770824aad.txt", + "platform": "LINUX_UNIX" + }, + { + "blueprintId": "nodejs", + "name": "Node.js", + "group": "node", + "type": "app", + "description": "Node.js certified by Bitnami is a pre-configured, ready to run image for Node.js on Amazon EC2. It includes the latest version of Node.js, Apache, Python and Redis. The image supports multiple Node.js applications, each with its own virtual host and project directory. It is configured for production use and is secure by default, as all ports except HTTP, HTTPS and SSH ports are closed. Let's Encrypt SSL certificates are supported through an auto-configuration script. Developers benefit from instant access to a secure, update and consistent Node.js environment without having to manually install and configure multiple components and libraries.", + "isActive": true, + "minPower": 0, + "version": "12.7.0", + "versionCode": "1", + "productUrl": "https://aws.amazon.com/marketplace/pp/B00NNZUAKO", + "licenseUrl": "https://d7umqicpi7263.cloudfront.net/eula/product/033793fe-951d-47d0-aa94-5fbd0afb3582/25f8fa66-c868-4d80-adf8-4a2b602064ae.txt", + "platform": "LINUX_UNIX" + }, + ... + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-bundles.rst awscli-1.18.69/awscli/examples/lightsail/get-bundles.rst --- awscli-1.11.13/awscli/examples/lightsail/get-bundles.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-bundles.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,59 @@ +**To get the bundles for new instances** + +The following ``get-bundles`` example displays details about all of the available bundles that can be used to create new instances in Amazon Lightsail. :: + + aws lightsail get-bundles + +Output:: + + { + "bundles": [ + { + "price": 3.5, + "cpuCount": 1, + "diskSizeInGb": 20, + "bundleId": "nano_2_0", + "instanceType": "nano", + "isActive": true, + "name": "Nano", + "power": 300, + "ramSizeInGb": 0.5, + "transferPerMonthInGb": 1024, + "supportedPlatforms": [ + "LINUX_UNIX" + ] + }, + { + "price": 5.0, + "cpuCount": 1, + "diskSizeInGb": 40, + "bundleId": "micro_2_0", + "instanceType": "micro", + "isActive": true, + "name": "Micro", + "power": 500, + "ramSizeInGb": 1.0, + "transferPerMonthInGb": 2048, + "supportedPlatforms": [ + "LINUX_UNIX" + ] + }, + { + "price": 10.0, + "cpuCount": 1, + "diskSizeInGb": 60, + "bundleId": "small_2_0", + "instanceType": "small", + "isActive": true, + "name": "Small", + "power": 1000, + "ramSizeInGb": 2.0, + "transferPerMonthInGb": 3072, + "supportedPlatforms": [ + "LINUX_UNIX" + ] + }, + ... + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-cloud-formation-stack-records.rst awscli-1.18.69/awscli/examples/lightsail/get-cloud-formation-stack-records.rst --- awscli-1.11.13/awscli/examples/lightsail/get-cloud-formation-stack-records.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-cloud-formation-stack-records.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,34 @@ +**To get the CloudFormation stack records and their associated stacks** + +The following ``get-cloud-formation-stack-records`` example displays details about the CloudFormation stack records and their associated stacks used to create Amazon EC2 resources from exported Amazon Lightsail snapshots. :: + + aws lightsail get-cloud-formation-stack-records + +Output:: + + { + "cloudFormationStackRecords": [ + { + "name": "CloudFormationStackRecord-588a4243-e2d1-490d-8200-3a7513ecebdf", + "arn": "arn:aws:lightsail:us-west-2:111122223333:CloudFormationStackRecord/28d646ab-27bc-48d9-a422-1EXAMPLE6d37", + "createdAt": 1565301666.586, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "resourceType": "CloudFormationStackRecord", + "state": "Succeeded", + "sourceInfo": [ + { + "resourceType": "ExportSnapshotRecord", + "name": "ExportSnapshotRecord-e02f23d7-0453-4aa9-9c95-91aa01a141dd", + "arn": "arn:aws:lightsail:us-west-2:111122223333:ExportSnapshotRecord/f12b8792-f3ea-4d6f-b547-2EXAMPLE8796" + } + ], + "destinationInfo": { + "id": "arn:aws:cloudformation:us-west-2:111122223333:stack/Lightsail-Stack-588a4243-e2d1-490d-8200-3EXAMPLEebdf/063203b0-ba28-11e9-838b-0EXAMPLE8b00", + "service": "Aws::CloudFormation::Stack" + } + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-disk.rst awscli-1.18.69/awscli/examples/lightsail/get-disk.rst --- awscli-1.11.13/awscli/examples/lightsail/get-disk.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-disk.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,33 @@ +**To get information about a block storage disk** + +The following ``get-disk`` example displays details about the disk ``Disk-1``. :: + + aws lightsail get-disk \ + --disk-name Disk-1 + +Output:: + + { + "disk": { + "name": "Disk-1", + "arn": "arn:aws:lightsail:us-west-2:111122223333:Disk/c21cfb0a-07f2-44ae-9a23-bEXAMPLE8096", + "supportCode": "6EXAMPLE3362/vol-0EXAMPLEf2f88b32f", + "createdAt": 1566585439.587, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "resourceType": "Disk", + "tags": [], + "sizeInGb": 8, + "isSystemDisk": false, + "iops": 100, + "path": "/dev/xvdf", + "state": "in-use", + "attachedTo": "WordPress_Multisite-1", + "isAttached": true, + "attachmentState": "attached" + } + } + +For more information, see `title `__ in the *guide*. diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-disk-snapshot.rst awscli-1.18.69/awscli/examples/lightsail/get-disk-snapshot.rst --- awscli-1.11.13/awscli/examples/lightsail/get-disk-snapshot.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-disk-snapshot.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,31 @@ +**To get information about a disk snapshot** + +The following ``get-disk-snapshot`` example displays details about the disk snapshot ``Disk-1-1566839161``. :: + + aws lightsail get-disk-snapshot \ + --disk-snapshot-name Disk-1-1566839161 + +Output:: + + { + "diskSnapshot": { + "name": "Disk-1-1566839161", + "arn": "arn:aws:lightsail:us-west-2:111122223333:DiskSnapshot/e2d0fa53-8ee0-41a0-8e56-0EXAMPLE1051", + "supportCode": "6EXAMPLE3362/snap-0EXAMPLE06100d09", + "createdAt": 1566839163.749, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "resourceType": "DiskSnapshot", + "tags": [], + "sizeInGb": 8, + "state": "completed", + "progress": "100%", + "fromDiskName": "Disk-1", + "fromDiskArn": "arn:aws:lightsail:us-west-2:111122223333:Disk/c21cfb0a-07f2-44ae-9a23-bEXAMPLE8096", + "isFromAutoSnapshot": false + } + } + +For more information, see `title `__ in the *guide*. diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-disk-snapshots.rst awscli-1.18.69/awscli/examples/lightsail/get-disk-snapshots.rst --- awscli-1.11.13/awscli/examples/lightsail/get-disk-snapshots.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-disk-snapshots.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,48 @@ +**To get information about all disk snapshots** + +The following ``get-disk-snapshots`` example displays details about all of the disk snapshots in the configured AWS Region. :: + + aws lightsail get-disk-snapshots + +Output:: + + { + "diskSnapshots": [ + { + "name": "Disk-2-1571090588", + "arn": "arn:aws:lightsail:us-west-2:111122223333:DiskSnapshot/32e889a9-38d4-4687-9f21-eEXAMPLE7839", + "supportCode": "6EXAMPLE3362/snap-0EXAMPLE1ca192a4", + "createdAt": 1571090591.226, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "resourceType": "DiskSnapshot", + "tags": [], + "sizeInGb": 8, + "state": "completed", + "progress": "100%", + "fromDiskName": "Disk-2", + "fromDiskArn": "arn:aws:lightsail:us-west-2:111122223333:Disk/6a343ff8-6341-422d-86e2-bEXAMPLE16c2", + "isFromAutoSnapshot": false + }, + { + "name": "Disk-1-1566839161", + "arn": "arn:aws:lightsail:us-west-2:111122223333:DiskSnapshot/e2d0fa53-8ee0-41a0-8e56-0EXAMPLE1051", + "supportCode": "6EXAMPLE3362/snap-0EXAMPLEe06100d09", + "createdAt": 1566839163.749, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "resourceType": "DiskSnapshot", + "tags": [], + "sizeInGb": 8, + "state": "completed", + "progress": "100%", + "fromDiskName": "Disk-1", + "fromDiskArn": "arn:aws:lightsail:us-west-2:111122223333:Disk/c21cfb0a-07f2-44ae-9a23-bEXAMPLE8096", + "isFromAutoSnapshot": false + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-disks.rst awscli-1.18.69/awscli/examples/lightsail/get-disks.rst --- awscli-1.11.13/awscli/examples/lightsail/get-disks.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-disks.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,50 @@ +**To get information about all block storage disks** + +The following ``get-disks`` example displays details about all of the disks in the configured AWS Region. :: + + aws lightsail get-disks + +Output:: + + { + "disks": [ + { + "name": "Disk-2", + "arn": "arn:aws:lightsail:us-west-2:111122223333:Disk/6a343ff8-6341-422d-86e2-bEXAMPLE16c2", + "supportCode": "6EXAMPLE3362/vol-0EXAMPLE929602087", + "createdAt": 1571090461.634, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "resourceType": "Disk", + "tags": [], + "sizeInGb": 8, + "isSystemDisk": false, + "iops": 100, + "state": "available", + "isAttached": false, + "attachmentState": "detached" + }, + { + "name": "Disk-1", + "arn": "arn:aws:lightsail:us-west-2:111122223333:Disk/c21cfb0a-07f2-44ae-9a23-bEXAMPLE8096", + "supportCode": "6EXAMPLE3362/vol-0EXAMPLEf2f88b32f", + "createdAt": 1566585439.587, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "resourceType": "Disk", + "tags": [], + "sizeInGb": 8, + "isSystemDisk": false, + "iops": 100, + "path": "/dev/xvdf", + "state": "in-use", + "attachedTo": "WordPress_Multisite-1", + "isAttached": true, + "attachmentState": "attached" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-domain.rst awscli-1.18.69/awscli/examples/lightsail/get-domain.rst --- awscli-1.11.13/awscli/examples/lightsail/get-domain.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-domain.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,70 @@ +**To get information about a domain** + +The following ``get-domain`` example displays details about the domain ``example.com``. + +**Note:** Lightsail's domain-related API operations are available in only the ``us-east-1`` AWS Region. If your CLI profile is configured to use a different Region, you must include the`` --region us-east-1`` parameter or the command fails. :: + + aws lightsail get-domain \ + --domain-name example.com \ + --region us-east-1 + +Output:: + + { + "domain": { + "name": "example.com", + "arn": "arn:aws:lightsail:global:111122223333:Domain/28cda903-3f15-44b2-9baf-3EXAMPLEb304", + "supportCode": "6EXAMPLE3362//hostedzone/ZEXAMPLEONGSC1", + "createdAt": 1570728588.6, + "location": { + "availabilityZone": "all", + "regionName": "global" + }, + "resourceType": "Domain", + "tags": [], + "domainEntries": [ + { + "id": "-1682899164", + "name": "example.com", + "target": "192.0.2.0", + "isAlias": false, + "type": "A" + }, + { + "id": "1703104243", + "name": "example.com", + "target": "ns-137.awsdns-17.com", + "isAlias": false, + "type": "NS" + }, + { + "id": "-1038331153", + "name": "example.com", + "target": "ns-1710.awsdns-21.co.uk", + "isAlias": false, + "type": "NS" + }, + { + "id": "-2107289565", + "name": "example.com", + "target": "ns-692.awsdns-22.net", + "isAlias": false, + "type": "NS" + }, + { + "id": "1582095705", + "name": "example.com", + "target": "ns-1436.awsdns-51.org", + "isAlias": false, + "type": "NS" + }, + { + "id": "-1769796132", + "name": "example.com", + "target": "ns-1710.awsdns-21.co.uk. awsdns-hostmaster.amazon.com. 1 7200 900 1209600 86400", + "isAlias": false, + "type": "SOA" + } + ] + } + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-domains.rst awscli-1.18.69/awscli/examples/lightsail/get-domains.rst --- awscli-1.11.13/awscli/examples/lightsail/get-domains.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-domains.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,204 @@ +**To get information about all domains** + +The following ``get-domains`` example displays details about all of the domains in the configured AWS Region. + +**Note:** Lightsail's domain-related API operations are available in only the ``us-east-1`` AWS Region. If your CLI profile is configured to use a different Region, you must include the ``--region us-east-1`` parameter or the command fails. :: + + aws lightsail get-domains \ + --region us-east-1 + +Output:: + + { + "domains": [ + { + "name": "example.com", + "arn": "arn:aws:lightsail:global:111122223333:Domain/28cda903-3f15-44b2-9baf-3EXAMPLEb304", + "supportCode": "6EXAMPLE3362//hostedzone/ZEXAMPLEONGSC1", + "createdAt": 1570728588.6, + "location": { + "availabilityZone": "all", + "regionName": "global" + }, + "resourceType": "Domain", + "tags": [], + "domainEntries": [ + { + "id": "-1682899164", + "name": "example.com", + "target": "192.0.2.0", + "isAlias": false, + "type": "A" + }, + { + "id": "1703104243", + "name": "example.com", + "target": "ns-137.awsdns-17.com", + "isAlias": false, + "type": "NS" + }, + { + "id": "-1038331153", + "name": "example.com", + "target": "ns-4567.awsdns-21.co.uk", + "isAlias": false, + "type": "NS" + }, + { + "id": "-2107289565", + "name": "example.com", + "target": "ns-333.awsdns-22.net", + "isAlias": false, + "type": "NS" + }, + { + "id": "1582095705", + "name": "example.com", + "target": "ns-1111.awsdns-51.org", + "isAlias": false, + "type": "NS" + }, + { + "id": "-1769796132", + "name": "example.com", + "target": "ns-1234.awsdns-21.co.uk. awsdns-hostmaster.amazon.com. 1 7200 900 1209600 86400", + "isAlias": false, + "type": "SOA" + }, + { + "id": "1029454894", + "name": "_dead6a124ede046a0319eb44a4eb3cbc.example.com", + "target": "_be133b0a0899fb7b6bf79d9741d1a383.hkvuiqjoua.acm-validations.aws", + "isAlias": false, + "type": "CNAME" + } + ] + }, + { + "name": "example.net", + "arn": "arn:aws:lightsail:global:111122223333:Domain/9c9f0d70-c92e-4753-86c2-6EXAMPLE029d", + "supportCode": "6EXAMPLE3362//hostedzone/ZEXAMPLE5TPKMV", + "createdAt": 1556661071.384, + "location": { + "availabilityZone": "all", + "regionName": "global" + }, + "resourceType": "Domain", + "tags": [], + "domainEntries": [ + { + "id": "-766320943", + "name": "example.net", + "target": "192.0.2.2", + "isAlias": false, + "type": "A" + }, + { + "id": "-453913825", + "name": "example.net", + "target": "ns-123.awsdns-10.net", + "isAlias": false, + "type": "NS" + }, + { + "id": "1553601564", + "name": "example.net", + "target": "ns-4444.awsdns-47.co.uk", + "isAlias": false, + "type": "NS" + }, + { + "id": "1653797661", + "name": "example.net", + "target": "ns-7890.awsdns-61.org", + "isAlias": false, + "type": "NS" + }, + { + "id": "706414698", + "name": "example.net", + "target": "ns-123.awsdns-44.com", + "isAlias": false, + "type": "NS" + }, + { + "id": "337271745", + "name": "example.net", + "target": "ns-4444.awsdns-47.co.uk. awsdns-hostmaster.amazon.com. 1 7200 900 1209600 86400", + "isAlias": false, + "type": "SOA" + }, + { + "id": "-1785431096", + "name": "www.example.net", + "target": "192.0.2.2", + "isAlias": false, + "type": "A" + } + ] + }, + { + "name": "example.org", + "arn": "arn:aws:lightsail:global:111122223333:Domain/f0f13ba3-3df0-4fdc-8ebb-1EXAMPLEf26e", + "supportCode": "6EXAMPLE3362//hostedzone/ZEXAMPLEAFO38", + "createdAt": 1556661199.106, + "location": { + "availabilityZone": "all", + "regionName": "global" + }, + "resourceType": "Domain", + "tags": [], + "domainEntries": [ + { + "id": "2065301345", + "name": "example.org", + "target": "192.0.2.4", + "isAlias": false, + "type": "A" + }, + { + "id": "-447198516", + "name": "example.org", + "target": "ns-123.awsdns-45.com", + "isAlias": false, + "type": "NS" + }, + { + "id": "136463022", + "name": "example.org", + "target": "ns-9999.awsdns-15.co.uk", + "isAlias": false, + "type": "NS" + }, + { + "id": "1395941679", + "name": "example.org", + "target": "ns-555.awsdns-01.net", + "isAlias": false, + "type": "NS" + }, + { + "id": "872052569", + "name": "example.org", + "target": "ns-6543.awsdns-38.org", + "isAlias": false, + "type": "NS" + }, + { + "id": "1001949377", + "name": "example.org", + "target": "ns-1234.awsdns-15.co.uk. awsdns-hostmaster.amazon.com. 1 7200 900 1209600 86400", + "isAlias": false, + "type": "SOA" + }, + { + "id": "1046191192", + "name": "www.example.org", + "target": "192.0.2.4", + "isAlias": false, + "type": "A" + } + ] + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-export-snapshot-record.rst awscli-1.18.69/awscli/examples/lightsail/get-export-snapshot-record.rst --- awscli-1.11.13/awscli/examples/lightsail/get-export-snapshot-record.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-export-snapshot-record.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,80 @@ +**To get the records of snapshots exported to Amazon EC2** + +The following ``get-export-snapshot-record`` example displays details about Amazon Lightsail instance or disk snapshots exported to Amazon EC2. :: + + aws lightsail get-export-snapshot-records + +Output:: + + { + "exportSnapshotRecords": [ + { + "name": "ExportSnapshotRecord-d2da10ce-0b3c-4ae1-ab3a-2EXAMPLEa586", + "arn": "arn:aws:lightsail:us-west-2:111122223333:ExportSnapshotRecord/076c7060-b0cc-4162-98f0-2EXAMPLEe28e", + "createdAt": 1543534665.678, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "resourceType": "ExportSnapshotRecord", + "state": "Succeeded", + "sourceInfo": { + "resourceType": "InstanceSnapshot", + "createdAt": 1540339310.706, + "name": "WordPress-512MB-Oregon-1-1540339219", + "arn": "arn:aws:lightsail:us-west-2:111122223333:InstanceSnapshot/5446f534-ed60-4c17-b4a5-bEXAMPLEf8b7", + "fromResourceName": "WordPress-512MB-Oregon-1", + "fromResourceArn": "arn:aws:lightsail:us-west-2:111122223333:Instance/4b8f1f24-e4d1-4cf3-88ff-cEXAMPLEa397", + "instanceSnapshotInfo": { + "fromBundleId": "nano_2_0", + "fromBlueprintId": "wordpress_4_9_8", + "fromDiskInfo": [ + { + "path": "/dev/sda1", + "sizeInGb": 20, + "isSystemDisk": true + } + ] + } + }, + "destinationInfo": { + "id": "ami-0EXAMPLEc0d65058e", + "service": "Aws::EC2::Image" + } + }, + { + "name": "ExportSnapshotRecord-1c94e884-40ff-4fe1-9302-0EXAMPLE14c2", + "arn": "arn:aws:lightsail:us-west-2:111122223333:ExportSnapshotRecord/fb392ce8-6567-4013-9bfd-3EXAMPLE5b4c", + "createdAt": 1543432110.2, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "resourceType": "ExportSnapshotRecord", + "state": "Succeeded", + "sourceInfo": { + "resourceType": "InstanceSnapshot", + "createdAt": 1540833603.545, + "name": "LAMP_PHP_5-512MB-Oregon-1-1540833565", + "arn": "arn:aws:lightsail:us-west-2:111122223333:InstanceSnapshot/82334399-b5f2-49ec-8382-0EXAMPLEe45f", + "fromResourceName": "LAMP_PHP_5-512MB-Oregon-1", + "fromResourceArn": "arn:aws:lightsail:us-west-2:111122223333:Instance/863b9f35-ab1e-4418-bdd2-1EXAMPLEbab2", + "instanceSnapshotInfo": { + "fromBundleId": "nano_2_0", + "fromBlueprintId": "lamp_5_6_37_2", + "fromDiskInfo": [ + { + "path": "/dev/sda1", + "sizeInGb": 20, + "isSystemDisk": true + } + ] + } + }, + "destinationInfo": { + "id": "ami-0EXAMPLE7c5ec84e2", + "service": "Aws::EC2::Image" + } + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-instance-access-details.rst awscli-1.18.69/awscli/examples/lightsail/get-instance-access-details.rst --- awscli-1.11.13/awscli/examples/lightsail/get-instance-access-details.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-instance-access-details.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,42 @@ +**To get host key information for an instance** + +The following ``get-instance-access-details`` example displays host key information for instance ``WordPress_Multisite-1``. :: + + aws lightsail get-instance-access-details \ + --instance-name WordPress_Multisite-1 + +Output:: + + { + "accessDetails": { + "certKey": "ssh-rsa-cert-v01@openssh.com AEXAMPLEaC1yc2EtY2VydC12MDFAb3BlbnNzaC5jb20AAAAgNf076Dt3ppmPd0fPxZVMmS491aEAYYH9cHqAJ3fNML8AAAADAQABAAABAQD4APep5Ta2gHLk7m/vEXAMPLE2eBWJyQvn7ol/i0+s966h5sx8qUD79lPB7q5UESd5VZGFtytrykfQJnjiwqe7EV5agzvjblLj26Fb37EKda9HVfCOu8pWbvky7Tyn9w299a6CsG5o8HrkOymDE2c59lYxXGkilKo5I9aZLBAdXn3t3oKtq9zsjYGjyEmarPYoVDT1ft8HaUGu4aCv1peI0+ZEXAMPLEAWaucW9Huh0WYN5yrmL252c4v13JTVmytaEZvLvt5itVoWXQY0ZDyrLUcZSKxyq5n00Mgvj2fiZdt+xMfQM9xVz0rXZmqx8uJidJpRgLCMTviofwQJU/K1EXAMPLEAAAAAAAABAAAALS00MzMzMDU4MzA4ODg1MTY2NjM4Onp6UWlndHk4UElRSG9STitOTG5QSEE9PQAAAAsAAAAHYml0bmFtaQAAAABdpPL7AAEXAMPLEgcAAAAAAAAAggAAABVwZXJtaXQtWDExLWZvcndhcmRpbmcAAAAAAAAAF3Blcm1pdC1hZ2VudC1mb3J3YXJkaW5nAAAAAAAAABZwZXJtaXQtEXAMPLEmb3J3YXJkaW5nAAAAAAAAAApwZXJtaXQtcHR5AAAAAAAAAA5wZXJtaXQtdXNlci1yYwAAAAAAAAAAAAACFwAAAAdzc2gtcnNhAAAAAwEAAQEXAMPLECqCbiK9b450HtRD1ZpiksT6oxc8U7nLNkVFC1j7JqZvP9ee3ux+LiB+ozNbUA0cdNL9Y67x7qPv/R7XhTc21+2A+8+GuVpK/Kz9dqDMKNAEXAMPLE+YYN+tiXm7Y8OgziK+7iDB7xUuQ4vghmn4+qgz9mKwYgWvVe2+0XLuV7cnWPB7iUlHQg+E3LUKrV4ZFw9pj7X2dFdNKfMxwWgI1ISWKimEXAMPLEeHjrf1Rqc/QH6TpWCvPfcx8uvwVqdwTfkE/SfA5BCzbGGI1UmIUadh8nHcb5FamQ1hK7kECy47K/x9FMn/KwmM7pCwJbSLDMO7n9bnbvck6m8ZoB2N2YLMG5dW7BerEXAMPLEobqfdtyYJHHel1EyyEJs1fWNU3D5JIGlgzcPAV+ZlbQyUCZXf0oslSa+HE85fO/FRq9SVSBSHrmbeb0frlPhgMzgSmqLeyhlbr6wwWIDbREXAMPLEJZ49H7RdQxdKyYrZPWvRgcr0qI2EL0tAajnpQQ8UZqeO9/Aqter0xN5PhFL0J49OWTacwCGRAjLhibAx7K1t/1ZXWo6c+ijq8clll327EXAMPLE/e89GC89KcmKCxfGQniDAUgF8UqofIbq3ZOUgiAAYCVXclI4L68NhVXyoWuQXPBRQSEXAMPLEWm74tDL9tFN3c7tSe/Oz0cTR+4sAAAIPAAAAB3NzaC1yc2EAAAIAQnG/L0DqiSnLrWhEox4aHqMgd0m0oLLAYx6OQH9F0TM9EXAMPLE961rzSCMon7ZgsWNnL0OwZQgDG+rtJ4N0B7HOVwns4ynUFbzNQ3qFGGeE3lKwX1L41vV1iSy7sDk8aI0LmrKJi1LE1Qc1l8uboRlwoXOYEXAMPLEaUCeX+10+WEXAMPLEg6Y4U4ZvE2B3xyRdpvysb5TGFNtk5qPslacnVkoLOGsZZXMpLGJnG4OBpQLLtpj9sNMxAgZPCAUjhkqkQWYJxJzvFN7sUMOArUwKPFJE2kaEXAMPLEOUrVGBbCTioRztlPsxY7hoXm73N929eZpNhxP3U+nxO9O4NUZ2pTWbVSUaV1gm6pug9xbwNO1Im21t34JeLlKTqxcJ6zzS8W0c0KKpAm5c4hWkseMbyutS2jav/4hiS+BhrYgptzfwe5qRXEXAMPLEHZQr3YfGzYoBJ/lLK3NHhxOihhsfAYwMei0BFZT1F/7CT3IH4iitEkIgodi06/Mw6UDqMPozyQCK1lEA6LFhYCOZG9drWcoRa74lM4kY9TP028Za8gDMh1WpkXLq9Gixon5OHP8aM/sEXAMPLEr2+fnkw+1BtoO5L6+VKoPlXaGqZ/fBYEXAMPLEAMQHjnLM1JYNvtEEPhp+TNzXHzuixWf/Ht04m0AVpXrzIDXaS1O2tXY=", + "ipAddress": "192.0.2.0", + "privateKey": "-----BEGIN RSA PRIVATE KEY-----\nEXAMPLEBAAKCAQEA+AD3qeU2toBy5O5v7wnRLVo/tngVickL5+6Jf4tPrPeuoebM\nfKlA+/ZTwe6uVBEneVWRhbcra8pH0CZ44sKnuxFeWoM7425S49uhW9+xCnWvR1Xw\njrvKVm75Mu08p/cNvfWugrBuaPB65DspgxNnOfZWMVxpIpSqOSPWmSwQHV597d6C\nrEXAMPLEo8hJmqz2KFQ09X7fB2lBruGgr9aXiNPmWmovYKqwFmrnFvR7odFmDecq\n5EXAMPLE9dyU1ZsrWhGby77eYrVaFl0GNGQ8qy1HGUiscquZ9NDIL49n4mXbfsTH\n0EXAMPLE12ZqsfLiYnSaUYCwjE74qH8ECVPytQIDAQABAoIBAHeZV9Z58JHAjifz\nCEXAMPLEEqC3doOVDgXSlkKI92qNo4z2VcUEho878paCuVVXVHcCGgSnGeyIh2tN\nMEXAMPLESohR427BhH3YLA+3Z5SIvnejbTgYPfLC37B8khTaYqkqMvdZiFVZK5qn\nIEXAMPLEM93oF9eSZCjcLKB/jGHsfb0eCDMP8BshHE2beuqzVMoK1DxOnvoP3+Fp\nAEXAMPLESq6pDpCo9YVUX8g1u3Ro9cPl2LXHDy+oVEY5KhbZQJ7VU1I72WOvppWW\nOEXAMPLEkgYlq7p6qYtYcSgTEjz14gDiMfQ7SyHB3alkIoNONQ9ZPaWHyJvymeud\noQTNuz0CgYEA/LFWNTEZrzdzdR1kJmyNRmAermU0B6utyNENChAlHGSHkB+1lVSh\nbEXAMPLEQo9ooUeW5UxO3YwacZLoDT1mwxw1Ptc1+PNycZoLe1fE9UdARrdmGTob\n8l7CPLSXp3xuR8VqSp2fnIc7hfiQs/NrPX9gm/EOrB0we0RKyDSzWScCgYEA+z/r\niob+nJZq0YbnOSuP6oMULP4vnWniWj8MIhUJU53LwSAM8DeJdONKDdkuiOd52aAL\nVgn7nLo88rVWKhJwVc4tu/rNgZLcR3bP4+kL6zand0KQnMLyOzNA2Ys26aa5udH1\nqWl0WTt9WEm/h10ndC1knOMectrvsG17b38y5sMCgYEA54NiRGGz8oCPW6GN/FZA\nKEXAMPLE5tw34GEH3Uxlc9n3CejDaQmczOATwX4nIwRZDEqWyYZcS0btg1jhGiBD\nYEXAMPLEkc8Z71L/agZEAaVCEog9FqfSqwB+XTfoKh8qur74X1yCu9p6gof1q6k9\neEXAMPLEchJcNNOg4ETIfMkCgYBdVORRhE4mqvWpOdzA7v66FdEz2YSkjAXKkmsW\naEXAMPLE8Z/8yBSmuBv1Qv03XA12my462uB92uzzGAuW+1yBc2Kn1sXqYTy0y1z0\ngEXAMPLEBogjw4MqHKL1bPKMHyQU8/q24PaYgzHPzy13wlH6pTYf1XqlHdE2D6Vv\nyEXAMPLEgQC3i/kVVhky/2XRwRVlC7JO2Bg3QGTx38hpmDa5IuofKANjA+Wa3/zy\nbEXAMPLE6ytQgD9GN/YtBq+uhO+2ZkvXPL+CWRi0ZRXpPwYDBBFU9Cw0AuWWGlL8\nwEXAMPLExMlcysRgcWB9RNgf3AuOpFd2i6XT/riNsvvkpmJ+VooU8g==\n-----END RSA PRIVATE KEY-----\n", + "protocol": "ssh", + "instanceName": "WordPress_Multisite-1", + "username": "bitnami", + "hostKeys": [ + { + "algorithm": "ssh-rsa", + "publicKey": "AEXAMPLEaC1yc2EAAAADAQABAAABAQCoeR9ieZTjQ3pXCHczuAYZFjlF7t+uBkXuqeGMRex78pCvmS+DiEXAMPLEuJ1Q8dcKhrQL4HpXbD9dosVCTaJnJwb4MQqsuSVFdHFzy3guP+BKclWqtxJEXAMPLEsBGqZZlrIv6a9bTA0TCplZ8AD+hSRTaSXXqg6FT+Qf16IktH0XlMs7xIEXAMPLEmNtjCpzZiGXDHzytoMvUgwa8uHPp44Og36EUu4VqQxoUHPJKoXvcQizyk3K8ym0hP0TpDZhD8cqwRfd6EHp4Q1br/Ot6y9HwvykEXAMPLEAfbKjbR42+u6+OSlkr4d339q2U1sTDytJhhs8HUel1wTfGRfp", + "witnessedAt": 1570744377.699, + "fingerprintSHA1": "SHA1:GEXAMPLEMoYgUg0ucadqU9Bt3Lk", + "fingerprintSHA256": "SHA256:IEXAMPLEcB5vgxnAUoJawbdZ+MwELhIp6FUxuwq/LIU" + }, + { + "algorithm": "ssh-ed25519", + "publicKey": "AEXAMPLEaC1lZDI1NTE5AAAAIC1gwGPDfGaONxEXAMPLEJX3UNap781QxHQmn8nzlrUv", + "witnessedAt": 1570744377.697, + "fingerprintSHA1": "SHA1:VEXAMPLE5ReqSmTgv03sSUw9toU", + "fingerprintSHA256": "SHA256:0EXAMPLEdE6tI95k3TJpG+qhJbAoknB0yz9nAEaDt3A" + }, + { + "algorithm": "ecdsa-sha2-nistp256", + "publicKey": "AEXAMPLEZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABEXAMPLE9B4mZy8YSsZW7cixCDq5yHSAAxjJkDo54C+EnKlDCsYtUkxxEXAMPLE6VOWL2z63RTKa2AUPgd8irjxWI=", + "witnessedAt": 1570744377.707, + "fingerprintSHA1": "SHA1:UEXAMPLEOYCfXsCf2G6tDg+7YG0", + "fingerprintSHA256": "SHA256:wEXAMPLEQ9a/iEXAMPLEhRufm6U9vFU4cpkMPHnBsNA" + } + ] + } + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-instance-metric-data.rst awscli-1.18.69/awscli/examples/lightsail/get-instance-metric-data.rst --- awscli-1.11.13/awscli/examples/lightsail/get-instance-metric-data.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-instance-metric-data.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,82 @@ +**To get metric data for an instance** + +The following ``get-instance-metric-data`` example returns the average percent of ``CPUUtilization`` every ``7200`` seconds (2 hours) between ``1571342400`` and ``1571428800`` for instance ``MEAN-1``. + +We recommend that you use a unix time converter to identify the start and end times. :: + + aws lightsail get-instance-metric-data \ + --instance-name MEAN-1 \ + --metric-name CPUUtilization \ + --period 7200 \ + --start-time 1571342400 \ + --end-time 1571428800 \ + --unit Percent \ + --statistics Average + +Output:: + + { + "metricName": "CPUUtilization", + "metricData": [ + { + "average": 0.26113718770120725, + "timestamp": 1571342400.0, + "unit": "Percent" + }, + { + "average": 0.26861268928111953, + "timestamp": 1571392800.0, + "unit": "Percent" + }, + { + "average": 0.28187475104748777, + "timestamp": 1571378400.0, + "unit": "Percent" + }, + { + "average": 0.2651936960458352, + "timestamp": 1571421600.0, + "unit": "Percent" + }, + { + "average": 0.2561856213712188, + "timestamp": 1571371200.0, + "unit": "Percent" + }, + { + "average": 0.3021383254607764, + "timestamp": 1571356800.0, + "unit": "Percent" + }, + { + "average": 0.2618381649223539, + "timestamp": 1571407200.0, + "unit": "Percent" + }, + { + "average": 0.26331929394825787, + "timestamp": 1571400000.0, + "unit": "Percent" + }, + { + "average": 0.2576348407007818, + "timestamp": 1571385600.0, + "unit": "Percent" + }, + { + "average": 0.2513008454658378, + "timestamp": 1571364000.0, + "unit": "Percent" + }, + { + "average": 0.26329974562758346, + "timestamp": 1571414400.0, + "unit": "Percent" + }, + { + "average": 0.2667092536656445, + "timestamp": 1571349600.0, + "unit": "Percent" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-instance-port-states.rst awscli-1.18.69/awscli/examples/lightsail/get-instance-port-states.rst --- awscli-1.11.13/awscli/examples/lightsail/get-instance-port-states.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-instance-port-states.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,31 @@ +**To get firewall information for an instance** + +The following ``get-instance-port-states`` example returns the firewall ports configured for instance ``MEAN-1``. :: + + aws lightsail get-instance-port-states \ + --instance-name MEAN-1 + +Output:: + + { + "portStates": [ + { + "fromPort": 80, + "toPort": 80, + "protocol": "tcp", + "state": "open" + }, + { + "fromPort": 22, + "toPort": 22, + "protocol": "tcp", + "state": "open" + }, + { + "fromPort": 443, + "toPort": 443, + "protocol": "tcp", + "state": "open" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-instance.rst awscli-1.18.69/awscli/examples/lightsail/get-instance.rst --- awscli-1.11.13/awscli/examples/lightsail/get-instance.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-instance.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,84 @@ +**To get information about an instance** + +The following ``get-instance`` example displays details about the instance ``MEAN-1``. :: + + aws lightsail get-instance \ + --instance-name MEAN-1 + +Output:: + + { + "instance": { + "name": "MEAN-1", + "arn": "arn:aws:lightsail:us-west-2:111122223333:Instance/bd470fc5-a68b-44c5-8dbc-EXAMPLE4bada", + "supportCode": "6EXAMPLE3362/i-05EXAMPLE407c97d3", + "createdAt": 1570635023.124, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "resourceType": "Instance", + "tags": [], + "blueprintId": "mean_4_0_9", + "blueprintName": "MEAN", + "bundleId": "medium_2_0", + "isStaticIp": false, + "privateIpAddress": "192.0.2.0", + "publicIpAddress": "192.0.2.0", + "hardware": { + "cpuCount": 2, + "disks": [ + { + "createdAt": 1570635023.124, + "sizeInGb": 80, + "isSystemDisk": true, + "iops": 240, + "path": "/dev/sda1", + "attachedTo": "MEAN-1", + "attachmentState": "attached" + } + ], + "ramSizeInGb": 4.0 + }, + "networking": { + "monthlyTransfer": { + "gbPerMonthAllocated": 4096 + }, + "ports": [ + { + "fromPort": 80, + "toPort": 80, + "protocol": "tcp", + "accessFrom": "Anywhere (0.0.0.0/0)", + "accessType": "public", + "commonName": "", + "accessDirection": "inbound" + }, + { + "fromPort": 22, + "toPort": 22, + "protocol": "tcp", + "accessFrom": "Anywhere (0.0.0.0/0)", + "accessType": "public", + "commonName": "", + "accessDirection": "inbound" + }, + { + "fromPort": 443, + "toPort": 443, + "protocol": "tcp", + "accessFrom": "Anywhere (0.0.0.0/0)", + "accessType": "public", + "commonName": "", + "accessDirection": "inbound" + } + ] + }, + "state": { + "code": 16, + "name": "running" + }, + "username": "bitnami", + "sshKeyName": "MyKey" + } + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-instance-snapshot.rst awscli-1.18.69/awscli/examples/lightsail/get-instance-snapshot.rst --- awscli-1.11.13/awscli/examples/lightsail/get-instance-snapshot.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-instance-snapshot.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,31 @@ +**To get information about a specified instance snapshot** + +The following ``get-instance-snapshot`` example displays details about the specified instance snapshot. :: + + aws lightsail get-instance-snapshot \ + --instance-snapshot-name MEAN-1-1571419854 + +Output:: + + { + "instanceSnapshot": { + "name": "MEAN-1-1571419854", + "arn": "arn:aws:lightsail:us-west-2:111122223333:InstanceSnapshot/ac54700c-48a8-40fd-b065-2EXAMPLEac8f", + "supportCode": "6EXAMPLE3362/ami-0EXAMPLE67a73020d", + "createdAt": 1571419891.927, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "resourceType": "InstanceSnapshot", + "tags": [], + "state": "available", + "fromAttachedDisks": [], + "fromInstanceName": "MEAN-1", + "fromInstanceArn": "arn:aws:lightsail:us-west-2:111122223333:Instance/bd470fc5-a68b-44c5-8dbc-8EXAMPLEbada", + "fromBlueprintId": "mean_4_0_9", + "fromBundleId": "medium_2_0", + "isFromAutoSnapshot": false, + "sizeInGb": 80 + } + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-instance-snapshots.rst awscli-1.18.69/awscli/examples/lightsail/get-instance-snapshots.rst --- awscli-1.11.13/awscli/examples/lightsail/get-instance-snapshots.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-instance-snapshots.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,56 @@ +**To get information about all of your instance snapshots** + +The following ``get-instance-snapshots`` example displays details about all of the instance snapshots in the configured AWS Region. :: + + aws lightsail get-instance-snapshots + +Output:: + + { + "instanceSnapshots": [ + { + "name": "MEAN-1-1571421498", + "arn": "arn:aws:lightsail:us-west-2:111122223333:InstanceSnapshot/a20e6ebe-b0ee-4ae4-a750-3EXAMPLEcb0c", + "supportCode": "6EXAMPLE3362/ami-0EXAMPLEe33cabfa1", + "createdAt": 1571421527.755, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "resourceType": "InstanceSnapshot", + "tags": [ + { + "key": "no_delete" + } + ], + "state": "available", + "fromAttachedDisks": [], + "fromInstanceName": "MEAN-1", + "fromInstanceArn": "arn:aws:lightsail:us-west-2:111122223333:Instance/1761aa0a-6038-4f25-8b94-2EXAMPLE19fd", + "fromBlueprintId": "wordpress_5_1_1_2", + "fromBundleId": "micro_2_0", + "isFromAutoSnapshot": false, + "sizeInGb": 40 + }, + { + "name": "MEAN-1-1571419854", + "arn": "arn:aws:lightsail:us-west-2:111122223333:InstanceSnapshot/ac54700c-48a8-40fd-b065-2EXAMPLEac8f", + "supportCode": "6EXAMPLE3362/ami-0EXAMPLE67a73020d", + "createdAt": 1571419891.927, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "resourceType": "InstanceSnapshot", + "tags": [], + "state": "available", + "fromAttachedDisks": [], + "fromInstanceName": "MEAN-1", + "fromInstanceArn": "arn:aws:lightsail:us-west-2:111122223333:Instance/bd470fc5-a68b-44c5-8dbc-8EXAMPLEbada", + "fromBlueprintId": "mean_4_0_9", + "fromBundleId": "medium_2_0", + "isFromAutoSnapshot": false, + "sizeInGb": 80 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-instances.rst awscli-1.18.69/awscli/examples/lightsail/get-instances.rst --- awscli-1.11.13/awscli/examples/lightsail/get-instances.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-instances.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,202 @@ +**To get information about all instances** + +The following ``get-instances`` example displays details about all of the instances in the configured AWS Region. :: + + aws lightsail get-instances + +Output:: + + { + "instances": [ + { + "name": "Windows_Server_2016-1", + "arn": "arn:aws:lightsail:us-west-2:111122223333:Instance/0f44fbb9-8f55-4e47-a25e-EXAMPLE04763", + "supportCode": "62EXAMPLE362/i-0bEXAMPLE71a686b9", + "createdAt": 1571332358.665, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "resourceType": "Instance", + "tags": [], + "blueprintId": "windows_server_2016", + "blueprintName": "Windows Server 2016", + "bundleId": "small_win_2_0", + "isStaticIp": false, + "privateIpAddress": "192.0.2.0", + "publicIpAddress": "192.0.2.0", + "hardware": { + "cpuCount": 1, + "disks": [ + { + "createdAt": 1571332358.665, + "sizeInGb": 60, + "isSystemDisk": true, + "iops": 180, + "path": "/dev/sda1", + "attachedTo": "Windows_Server_2016-1", + "attachmentState": "attached" + }, + { + "name": "my-disk-for-windows-server", + "arn": "arn:aws:lightsail:us-west-2:111122223333:Disk/4123a81c-484c-49ea-afea-5EXAMPLEda87", + "supportCode": "6EXAMPLE3362/vol-0EXAMPLEb2b99ca3d", + "createdAt": 1571355063.494, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "resourceType": "Disk", + "tags": [], + "sizeInGb": 128, + "isSystemDisk": false, + "iops": 384, + "path": "/dev/xvdf", + "state": "in-use", + "attachedTo": "Windows_Server_2016-1", + "isAttached": true, + "attachmentState": "attached" + } + ], + "ramSizeInGb": 2.0 + }, + "networking": { + "monthlyTransfer": { + "gbPerMonthAllocated": 3072 + }, + "ports": [ + { + "fromPort": 80, + "toPort": 80, + "protocol": "tcp", + "accessFrom": "Anywhere (0.0.0.0/0)", + "accessType": "public", + "commonName": "", + "accessDirection": "inbound" + }, + { + "fromPort": 22, + "toPort": 22, + "protocol": "tcp", + "accessFrom": "Anywhere (0.0.0.0/0)", + "accessType": "public", + "commonName": "", + "accessDirection": "inbound" + }, + { + "fromPort": 3389, + "toPort": 3389, + "protocol": "tcp", + "accessFrom": "Anywhere (0.0.0.0/0)", + "accessType": "public", + "commonName": "", + "accessDirection": "inbound" + } + ] + }, + "state": { + "code": 16, + "name": "running" + }, + "username": "Administrator", + "sshKeyName": "LightsailDefaultKeyPair" + }, + { + "name": "MEAN-1", + "arn": "arn:aws:lightsail:us-west-2:111122223333:Instance/bd470fc5-a68b-44c5-8dbc-8EXAMPLEbada", + "supportCode": "6EXAMPLE3362/i-0EXAMPLEa407c97d3", + "createdAt": 1570635023.124, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "resourceType": "Instance", + "tags": [], + "blueprintId": "mean_4_0_9", + "blueprintName": "MEAN", + "bundleId": "medium_2_0", + "isStaticIp": false, + "privateIpAddress": "192.0.2.0", + "publicIpAddress": "192.0.2.0", + "hardware": { + "cpuCount": 2, + "disks": [ + { + "name": "Disk-1", + "arn": "arn:aws:lightsail:us-west-2:111122223333:Disk/c21cfb0a-07f2-44ae-9a23-bEXAMPLE8096", + "supportCode": "6EXAMPLE3362/vol-0EXAMPLEf2f88b32f", + "createdAt": 1566585439.587, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "resourceType": "Disk", + "tags": [ + { + "key": "test" + } + ], + "sizeInGb": 8, + "isSystemDisk": false, + "iops": 100, + "path": "/dev/xvdf", + "state": "in-use", + "attachedTo": "MEAN-1", + "isAttached": true, + "attachmentState": "attached" + }, + { + "createdAt": 1570635023.124, + "sizeInGb": 80, + "isSystemDisk": true, + "iops": 240, + "path": "/dev/sda1", + "attachedTo": "MEAN-1", + "attachmentState": "attached" + } + ], + "ramSizeInGb": 4.0 + }, + "networking": { + "monthlyTransfer": { + "gbPerMonthAllocated": 4096 + }, + "ports": [ + { + "fromPort": 80, + "toPort": 80, + "protocol": "tcp", + "accessFrom": "Anywhere (0.0.0.0/0)", + "accessType": "public", + "commonName": "", + "accessDirection": "inbound" + }, + { + "fromPort": 22, + "toPort": 22, + "protocol": "tcp", + "accessFrom": "Anywhere (0.0.0.0/0)", + "accessType": "public", + "commonName": "", + "accessDirection": "inbound" + }, + { + "fromPort": 443, + "toPort": 443, + "protocol": "tcp", + "accessFrom": "Anywhere (0.0.0.0/0)", + "accessType": "public", + "commonName": "", + "accessDirection": "inbound" + } + ] + }, + "state": { + "code": 16, + "name": "running" + }, + "username": "bitnami", + "sshKeyName": "MyTestKey" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-instance-state.rst awscli-1.18.69/awscli/examples/lightsail/get-instance-state.rst --- awscli-1.11.13/awscli/examples/lightsail/get-instance-state.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-instance-state.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,15 @@ +**To get information about the state of an instance** + +The following ``get-instance-state`` example returns the state of the specified instance. :: + + aws lightsail get-instance-state \ + --instance-name MEAN-1 + +Output:: + + { + "state": { + "code": 16, + "name": "running" + } + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-key-pair.rst awscli-1.18.69/awscli/examples/lightsail/get-key-pair.rst --- awscli-1.11.13/awscli/examples/lightsail/get-key-pair.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-key-pair.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,24 @@ +**To get information about a key pair** + +The following ``get-key-pair`` example displays details about the specified key pair. :: + + aws lightsail get-key-pair \ + --key-pair-name MyKey1 + +Output:: + + { + "keyPair": { + "name": "MyKey1", + "arn": "arn:aws:lightsail:us-west-2:111122223333:KeyPair/19a4efdf-3054-43d6-91fd-eEXAMPLE21bf", + "supportCode": "6EXAMPLE3362/MyKey1", + "createdAt": 1571255026.975, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "resourceType": "KeyPair", + "tags": [], + "fingerprint": "00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:gg:hh:ii:jj" + } + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-key-pairs.rst awscli-1.18.69/awscli/examples/lightsail/get-key-pairs.rst --- awscli-1.11.13/awscli/examples/lightsail/get-key-pairs.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-key-pairs.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,25 @@ +**To get information about all key pairs** + +The following ``get-key-pairs`` example displays details about all of the key pairs in the configured AWS Region. :: + + aws lightsail get-key-pairs + +Output:: + + { + "keyPairs": [ + { + "name": "MyKey1", + "arn": "arn:aws:lightsail:us-west-2:111122223333:KeyPair/19a4efdf-3054-43d6-91fd-eEXAMPLE21bf", + "supportCode": "6EXAMPLE3362/MyKey1", + "createdAt": 1571255026.975, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "resourceType": "KeyPair", + "tags": [], + "fingerprint": "00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:gg:hh:ii:jj" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-load-balancer.rst awscli-1.18.69/awscli/examples/lightsail/get-load-balancer.rst --- awscli-1.11.13/awscli/examples/lightsail/get-load-balancer.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-load-balancer.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,55 @@ +**To get information about a load balancer** + +The following ``get-load-balancer`` example displays details about the specified load balancer. :: + + aws lightsail get-load-balancer \ + --load-balancer-name LoadBalancer-1 + +Output:: + + { + "loadBalancer": { + "name": "LoadBalancer-1", + "arn": "arn:aws:lightsail:us-west-2:111122223333:LoadBalancer/40486b2b-1ad0-4152-83e4-cEXAMPLE6f4b", + "supportCode": "6EXAMPLE3362/arn:aws:elasticloadbalancing:us-west-2:333322221111:loadbalancer/app/bEXAMPLE128cb59d86f946a9395dd304/1EXAMPLE8dd9d77e", + "createdAt": 1571677906.723, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "resourceType": "LoadBalancer", + "tags": [], + "dnsName": "bEXAMPLE128cb59d86f946a9395dd304-1486911371.us-west-2.elb.amazonaws.com", + "state": "active", + "protocol": "HTTP", + "publicPorts": [ + 80 + ], + "healthCheckPath": "/", + "instancePort": 80, + "instanceHealthSummary": [ + { + "instanceName": "MEAN-3", + "instanceHealth": "healthy" + }, + { + "instanceName": "MEAN-1", + "instanceHealth": "healthy" + }, + { + "instanceName": "MEAN-2", + "instanceHealth": "healthy" + } + ], + "tlsCertificateSummaries": [ + { + "name": "example-com", + "isAttached": false + } + ], + "configurationOptions": { + "SessionStickinessEnabled": "false", + "SessionStickiness_LB_CookieDurationSeconds": "86400" + } + } + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-load-balancers.rst awscli-1.18.69/awscli/examples/lightsail/get-load-balancers.rst --- awscli-1.11.13/awscli/examples/lightsail/get-load-balancers.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-load-balancers.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,56 @@ +**To get information about all load balancers** + +The following ``get-load-balancers`` example displays details about all of the load balancers in the configured AWS Region. :: + + aws lightsail get-load-balancers + +Output:: + + { + "loadBalancers": [ + { + "name": "LoadBalancer-1", + "arn": "arn:aws:lightsail:us-west-2:111122223333:LoadBalancer/40486b2b-1ad0-4152-83e4-cEXAMPLE6f4b", + "supportCode": "6EXAMPLE3362/arn:aws:elasticloadbalancing:us-west-2:333322221111:loadbalancer/app/bEXAMPLE128cb59d86f946a9395dd304/1EXAMPLE8dd9d77e", + "createdAt": 1571677906.723, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "resourceType": "LoadBalancer", + "tags": [], + "dnsName": "bEXAMPLE128cb59d86f946a9395dd304-1486911371.us-west-2.elb.amazonaws.com", + "state": "active", + "protocol": "HTTP", + "publicPorts": [ + 80 + ], + "healthCheckPath": "/", + "instancePort": 80, + "instanceHealthSummary": [ + { + "instanceName": "MEAN-3", + "instanceHealth": "healthy" + }, + { + "instanceName": "MEAN-1", + "instanceHealth": "healthy" + }, + { + "instanceName": "MEAN-2", + "instanceHealth": "healthy" + } + ], + "tlsCertificateSummaries": [ + { + "name": "example-com", + "isAttached": false + } + ], + "configurationOptions": { + "SessionStickinessEnabled": "false", + "SessionStickiness_LB_CookieDurationSeconds": "86400" + } + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-load-balancer-tls-certificates.rst awscli-1.18.69/awscli/examples/lightsail/get-load-balancer-tls-certificates.rst --- awscli-1.11.13/awscli/examples/lightsail/get-load-balancer-tls-certificates.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-load-balancer-tls-certificates.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,48 @@ +**To get information about TLS certificates for a load balancer** + +The following ``get-load-balancer-tls-certificates`` example displays details about the TLS certificates for the specified load balancer. :: + + aws lightsail get-load-balancer-tls-certificates \ + --load-balancer-name LoadBalancer-1 + +Output:: + + { + "tlsCertificates": [ + { + "name": "example-com", + "arn": "arn:aws:lightsail:us-west-2:111122223333:LoadBalancerTlsCertificate/d7bf4643-6a02-4cd4-b3c4-fEXAMPLE9b4d", + "supportCode": "6EXAMPLE3362/arn:aws:acm:us-west-2:333322221111:certificate/9af8e32c-a54e-4a67-8c63-cEXAMPLEb314", + "createdAt": 1571678025.3, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "resourceType": "LoadBalancerTlsCertificate", + "loadBalancerName": "LoadBalancer-1", + "isAttached": false, + "status": "ISSUED", + "domainName": "example.com", + "domainValidationRecords": [ + { + "name": "_dEXAMPLE4ede046a0319eb44a4eb3cbc.example.com.", + "type": "CNAME", + "value": "_bEXAMPLE0899fb7b6bf79d9741d1a383.hkvuiqjoua.acm-validations.aws.", + "validationStatus": "SUCCESS", + "domainName": "example.com" + } + ], + "issuedAt": 1571678070.0, + "issuer": "Amazon", + "keyAlgorithm": "RSA-2048", + "notAfter": 1605960000.0, + "notBefore": 1571616000.0, + "serial": "00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff", + "signatureAlgorithm": "SHA256WITHRSA", + "subject": "CN=example.com", + "subjectAlternativeNames": [ + "example.com" + ] + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-operation.rst awscli-1.18.69/awscli/examples/lightsail/get-operation.rst --- awscli-1.11.13/awscli/examples/lightsail/get-operation.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-operation.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,26 @@ +**To get information about a single operation** + +The following ``get-operation`` example displays details about the specified operation. :: + + aws lightsail get-operation \ + --operation-id e5700e8a-daf2-4b49-bc01-3EXAMPLE910a + + +Output:: + + { + "operation": { + "id": "e5700e8a-daf2-4b49-bc01-3EXAMPLE910a", + "resourceName": "Instance-1", + "resourceType": "Instance", + "createdAt": 1571679872.404, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationType": "CreateInstance", + "status": "Succeeded", + "statusChangedAt": 1571679890.304 + } + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-operations-for-resource.rst awscli-1.18.69/awscli/examples/lightsail/get-operations-for-resource.rst --- awscli-1.11.13/awscli/examples/lightsail/get-operations-for-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-operations-for-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,60 @@ +**To get all operations for a resource** + +The following ``get-operations-for-resource`` example displays details about all operations for the specified resource. :: + + aws lightsail get-operations-for-resource \ + --resource-name LoadBalancer-1 + +Output:: + + { + "operations": [ + { + "id": "e2973046-43f8-4252-a4b4-9EXAMPLE69ce", + "resourceName": "LoadBalancer-1", + "resourceType": "LoadBalancer", + "createdAt": 1571678786.071, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationDetails": "MEAN-1", + "operationType": "DetachInstancesFromLoadBalancer", + "status": "Succeeded", + "statusChangedAt": 1571679087.57 + }, + { + "id": "2d742a18-0e7f-48c8-9705-3EXAMPLEf98a", + "resourceName": "LoadBalancer-1", + "resourceType": "LoadBalancer", + "createdAt": 1571678782.784, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationDetails": "MEAN-1", + "operationType": "AttachInstancesToLoadBalancer", + "status": "Succeeded", + "statusChangedAt": 1571678798.465 + }, + { + "id": "6c700fcc-4246-40ab-952b-1EXAMPLEdac2", + "resourceName": "LoadBalancer-1", + "resourceType": "LoadBalancer", + "createdAt": 1571678775.297, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationDetails": "MEAN-3", + "operationType": "AttachInstancesToLoadBalancer", + "status": "Succeeded", + "statusChangedAt": 1571678842.806 + }, + ... + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-operations.rst awscli-1.18.69/awscli/examples/lightsail/get-operations.rst --- awscli-1.11.13/awscli/examples/lightsail/get-operations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-operations.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,58 @@ +**To get information about all operations** + +The following ``get-operations`` example displays details about all of the operations in the configured AWS Region. :: + + aws lightsail get-operations + +Output:: + + { + "operations": [ + { + "id": "e5700e8a-daf2-4b49-bc01-3EXAMPLE910a", + "resourceName": "Instance-1", + "resourceType": "Instance", + "createdAt": 1571679872.404, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationType": "CreateInstance", + "status": "Succeeded", + "statusChangedAt": 1571679890.304 + }, + { + "id": "701a3339-930e-4914-a9f9-7EXAMPLE68d7", + "resourceName": "WordPress-1", + "resourceType": "Instance", + "createdAt": 1571678786.072, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationDetails": "LoadBalancer-1", + "operationType": "DetachInstancesFromLoadBalancer", + "status": "Succeeded", + "statusChangedAt": 1571679086.399 + }, + { + "id": "e2973046-43f8-4252-a4b4-9EXAMPLE69ce", + "resourceName": "LoadBalancer-1", + "resourceType": "LoadBalancer", + "createdAt": 1571678786.071, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationDetails": "WordPress-1", + "operationType": "DetachInstancesFromLoadBalancer", + "status": "Succeeded", + "statusChangedAt": 1571679087.57 + }, + ... + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-regions.rst awscli-1.18.69/awscli/examples/lightsail/get-regions.rst --- awscli-1.11.13/awscli/examples/lightsail/get-regions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-regions.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,38 @@ +**To get all AWS Regions for Amazon Lightsail** + +The following ``get-regions`` example displays details about all of the AWS Regions for Amazon Lightsail. :: + + aws lightsail get-regions + +Output:: + + { + "regions": [ + { + "continentCode": "NA", + "description": "This region is recommended to serve users in the eastern United States", + "displayName": "Virginia", + "name": "us-east-1", + "availabilityZones": [], + "relationalDatabaseAvailabilityZones": [] + }, + { + "continentCode": "NA", + "description": "This region is recommended to serve users in the eastern United States", + "displayName": "Ohio", + "name": "us-east-2", + "availabilityZones": [], + "relationalDatabaseAvailabilityZones": [] + }, + { + "continentCode": "NA", + "description": "This region is recommended to serve users in the northwestern United States, Alaska, and western Canada", + "displayName": "Oregon", + "name": "us-west-2", + "availabilityZones": [], + "relationalDatabaseAvailabilityZones": [] + }, + ... + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-relational-database-blueprints.rst awscli-1.18.69/awscli/examples/lightsail/get-relational-database-blueprints.rst --- awscli-1.11.13/awscli/examples/lightsail/get-relational-database-blueprints.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-relational-database-blueprints.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,60 @@ +**To get the blueprints for new relational databases** + +The following ``get-relational-database-blueprints`` example displays details about all of the available relational database blueprints that can be used to create new relational databases in Amazon Lightsail. :: + + aws lightsail get-relational-database-blueprints + +Output:: + + { + "blueprints": [ + { + "blueprintId": "mysql_5_6", + "engine": "mysql", + "engineVersion": "5.6.44", + "engineDescription": "MySQL Community Edition", + "engineVersionDescription": "MySQL 5.6.44", + "isEngineDefault": false + }, + { + "blueprintId": "mysql_5_7", + "engine": "mysql", + "engineVersion": "5.7.26", + "engineDescription": "MySQL Community Edition", + "engineVersionDescription": "MySQL 5.7.26", + "isEngineDefault": true + }, + { + "blueprintId": "mysql_8_0", + "engine": "mysql", + "engineVersion": "8.0.16", + "engineDescription": "MySQL Community Edition", + "engineVersionDescription": "MySQL 8.0.16", + "isEngineDefault": false + }, + { + "blueprintId": "postgres_9_6", + "engine": "postgres", + "engineVersion": "9.6.15", + "engineDescription": "PostgreSQL", + "engineVersionDescription": "PostgreSQL 9.6.15-R1", + "isEngineDefault": false + }, + { + "blueprintId": "postgres_10", + "engine": "postgres", + "engineVersion": "10.10", + "engineDescription": "PostgreSQL", + "engineVersionDescription": "PostgreSQL 10.10-R1", + "isEngineDefault": false + }, + { + "blueprintId": "postgres_11", + "engine": "postgres", + "engineVersion": "11.5", + "engineDescription": "PostgreSQL", + "engineVersionDescription": "PostgreSQL 11.5-R1", + "isEngineDefault": true + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-relational-database-bundles.rst awscli-1.18.69/awscli/examples/lightsail/get-relational-database-bundles.rst --- awscli-1.11.13/awscli/examples/lightsail/get-relational-database-bundles.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-relational-database-bundles.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,100 @@ +**To get the bundles for new relational databases** + +The following ``get-relational-database-bundles`` example displays details about all of the available relational database bundles that can be used to create new relational databases in Amazon Lightsail. :: + + aws lightsail get-relational-database-bundles + +Output:: + + { + "bundles": [ + { + "bundleId": "micro_1_0", + "name": "Micro", + "price": 15.0, + "ramSizeInGb": 1.0, + "diskSizeInGb": 40, + "transferPerMonthInGb": 100, + "cpuCount": 1, + "isEncrypted": false, + "isActive": true + }, + { + "bundleId": "micro_ha_1_0", + "name": "Micro with High Availability", + "price": 30.0, + "ramSizeInGb": 1.0, + "diskSizeInGb": 40, + "transferPerMonthInGb": 100, + "cpuCount": 1, + "isEncrypted": false, + "isActive": true + }, + { + "bundleId": "small_1_0", + "name": "Small", + "price": 30.0, + "ramSizeInGb": 2.0, + "diskSizeInGb": 80, + "transferPerMonthInGb": 100, + "cpuCount": 1, + "isEncrypted": true, + "isActive": true + }, + { + "bundleId": "small_ha_1_0", + "name": "Small with High Availability", + "price": 60.0, + "ramSizeInGb": 2.0, + "diskSizeInGb": 80, + "transferPerMonthInGb": 100, + "cpuCount": 1, + "isEncrypted": true, + "isActive": true + }, + { + "bundleId": "medium_1_0", + "name": "Medium", + "price": 60.0, + "ramSizeInGb": 4.0, + "diskSizeInGb": 120, + "transferPerMonthInGb": 100, + "cpuCount": 2, + "isEncrypted": true, + "isActive": true + }, + { + "bundleId": "medium_ha_1_0", + "name": "Medium with High Availability", + "price": 120.0, + "ramSizeInGb": 4.0, + "diskSizeInGb": 120, + "transferPerMonthInGb": 100, + "cpuCount": 2, + "isEncrypted": true, + "isActive": true + }, + { + "bundleId": "large_1_0", + "name": "Large", + "price": 115.0, + "ramSizeInGb": 8.0, + "diskSizeInGb": 240, + "transferPerMonthInGb": 200, + "cpuCount": 2, + "isEncrypted": true, + "isActive": true + }, + { + "bundleId": "large_ha_1_0", + "name": "Large with High Availability", + "price": 230.0, + "ramSizeInGb": 8.0, + "diskSizeInGb": 240, + "transferPerMonthInGb": 200, + "cpuCount": 2, + "isEncrypted": true, + "isActive": true + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-relational-database-events.rst awscli-1.18.69/awscli/examples/lightsail/get-relational-database-events.rst --- awscli-1.11.13/awscli/examples/lightsail/get-relational-database-events.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-relational-database-events.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,31 @@ +**To get the events for a relational database** + +The following ``get-relational-database-events`` example displays details about events in the last 17 hours (1020 minutes) for the specified relational database. :: + + aws lightsail get-relational-database-events \ + --relational-database-name Database-1 \ + --duration-in-minutes 1020 + +Output:: + + { + "relationalDatabaseEvents": [ + { + "resource": "Database-1", + "createdAt": 1571654146.553, + "message": "Backing up Relational Database", + "eventCategories": [ + "backup" + ] + }, + { + "resource": "Database-1", + "createdAt": 1571654249.98, + "message": "Finished Relational Database backup", + "eventCategories": [ + "backup" + ] + } + ] + } + diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-relational-database-log-events.rst awscli-1.18.69/awscli/examples/lightsail/get-relational-database-log-events.rst --- awscli-1.11.13/awscli/examples/lightsail/get-relational-database-log-events.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-relational-database-log-events.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,55 @@ +**To get log events for a relational database** + +The following ``get-relational-database-log-events`` example displays details about the specified log between ``1570733176`` and ``1571597176`` for relational database ``Database1``. The information returned is configured to start from ``head``. + +We recommend that you use a unix time converter to identify the start and end times. :: + + aws lightsail get-relational-database-log-events \ + --relational-database-name Database1 \ + --log-stream-name error \ + --start-from-head \ + --start-time 1570733176 \ + --end-time 1571597176 + +Output:: + + { + "resourceLogEvents": [ + { + "createdAt": 1570820267.0, + "message": "2019-10-11 18:57:47 20969 [Warning] IP address '192.0.2.0' could not be resolved: Name or service not known" + }, + { + "createdAt": 1570860974.0, + "message": "2019-10-12 06:16:14 20969 [Warning] IP address '8192.0.2.0' could not be resolved: Temporary failure in name resolution" + }, + { + "createdAt": 1570860977.0, + "message": "2019-10-12 06:16:17 20969 [Warning] IP address '192.0.2.0' could not be resolved: Temporary failure in name resolution" + }, + { + "createdAt": 1570860979.0, + "message": "2019-10-12 06:16:19 20969 [Warning] IP address '192.0.2.0' could not be resolved: Temporary failure in name resolution" + }, + { + "createdAt": 1570860981.0, + "message": "2019-10-12 06:16:21 20969 [Warning] IP address '192.0.2.0' could not be resolved: Temporary failure in name resolution" + }, + { + "createdAt": 1570860982.0, + "message": "2019-10-12 06:16:22 20969 [Warning] IP address '192.0.2.0' could not be resolved: Temporary failure in name resolution" + }, + { + "createdAt": 1570860984.0, + "message": "2019-10-12 06:16:24 20969 [Warning] IP address '192.0.2.0' could not be resolved: Temporary failure in name resolution" + }, + { + "createdAt": 1570860986.0, + "message": "2019-10-12 06:16:26 20969 [Warning] IP address '192.0.2.0' could not be resolved: Temporary failure in name resolution" + }, + ... + } + ], + "nextBackwardToken": "eEXAMPLEZXJUZXh0IjoiZnRWb3F3cUpRSlQ5NndMYThxelRUZlFhR3J6c2dKWEEvM2kvajZMZzVVVWpqRDN0YjFXTjNrak5pRk9iVFRZdjkwVGlpZGw5NFJGSFRQTEdJSjdpQnFCRk5CZFJlYTZaSXpScStuZjJEYXhqM2grUFVJOEpIYlU5YWJ2QitvQWN5cEFyVUo3VDk1QWY3bVF6MEwvcVovVldZdGc9Iiwibm9uY2UiOiJBNHpzdWMvUkZZKzRvUzhEIiwiY2lwaGVyIjoiQUVTL0dDTS9Ob1BhZGEXAMPLEQ==", + "nextForwardToken": "eEXAMPLEZXJUZXh0IjoiT09Lb0Z6ZFRJbHhaNEQ5N2tPbkkwRmwwNUxPZjFTbFFwUklQbzlSaWgvMWVXbEk4aG56VHg4bW1Gb3grbDVodUVNZEdiZXN0TzVYcjlLK1FUdFB2RlJLS2FMcU05WkN3Rm1uVzBkOFpDR2g0b1BBVlg2NVFGNDNPazZzRXJieHRuU0xzdkRNTkFUMTZibU9HM2YyaGxiS0hUUDA9Iiwibm9uY2UiOiJFQmI4STQ3cU5aWXNXZ0g4IiwiY2lwaGVyIjoiQUVTL0dDTS9Ob1BhZGEXAMPLEQ==" + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-relational-database-log-streams.rst awscli-1.18.69/awscli/examples/lightsail/get-relational-database-log-streams.rst --- awscli-1.11.13/awscli/examples/lightsail/get-relational-database-log-streams.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-relational-database-log-streams.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,17 @@ +**To get the log streams for a relational database** + +The following ``get-relational-database-log-streams`` example returns all of the available log streams for the specified relational database. :: + + aws lightsail get-relational-database-log-streams \ + --relational-database-name Database1 + +Output:: + + { + "logStreams": [ + "audit", + "error", + "general", + "slowquery" + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-relational-database-master-user-password.rst awscli-1.18.69/awscli/examples/lightsail/get-relational-database-master-user-password.rst --- awscli-1.11.13/awscli/examples/lightsail/get-relational-database-master-user-password.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-relational-database-master-user-password.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,13 @@ +**To get the master user password for a relational database** + +The following ``get-relational-database-master-user-password`` example returns information about the master user password for the specified relational database. :: + + aws lightsail get-relational-database-master-user-password \ + --relational-database-name Database-1 + +Output:: + + { + "masterUserPassword": "VEXAMPLEec.9qvx,_t<)Wkf)kwboM,>2", + "createdAt": 1571259453.959 + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-relational-database-metric-data.rst awscli-1.18.69/awscli/examples/lightsail/get-relational-database-metric-data.rst --- awscli-1.11.13/awscli/examples/lightsail/get-relational-database-metric-data.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-relational-database-metric-data.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,72 @@ +**To get metric data for a relational database** + +The following ``get-relational-database-metric-data`` example returns the count sum of the metric ``DatabaseConnections`` over the period of 24 hours (``86400`` seconds) between ``1570733176`` and ``1571597176`` for relational database ``Database1``. + +We recommend that you use a unix time converter to identify the start and end times. :: + + aws lightsail get-relational-database-metric-data \ + --relational-database-name Database1 \ + --metric-name DatabaseConnections \ + --period 86400 \ + --start-time 1570733176 \ + --end-time 1571597176 \ + --unit Count \ + --statistics Sum + +Output:: + + { + "metricName": "DatabaseConnections", + "metricData": [ + { + "sum": 1.0, + "timestamp": 1571510760.0, + "unit": "Count" + }, + { + "sum": 1.0, + "timestamp": 1570733160.0, + "unit": "Count" + }, + { + "sum": 1.0, + "timestamp": 1570992360.0, + "unit": "Count" + }, + { + "sum": 0.0, + "timestamp": 1571251560.0, + "unit": "Count" + }, + { + "sum": 721.0, + "timestamp": 1570819560.0, + "unit": "Count" + }, + { + "sum": 1.0, + "timestamp": 1571078760.0, + "unit": "Count" + }, + { + "sum": 2.0, + "timestamp": 1571337960.0, + "unit": "Count" + }, + { + "sum": 684.0, + "timestamp": 1570905960.0, + "unit": "Count" + }, + { + "sum": 0.0, + "timestamp": 1571165160.0, + "unit": "Count" + }, + { + "sum": 1.0, + "timestamp": 1571424360.0, + "unit": "Count" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-relational-database-parameters.rst awscli-1.18.69/awscli/examples/lightsail/get-relational-database-parameters.rst --- awscli-1.11.13/awscli/examples/lightsail/get-relational-database-parameters.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-relational-database-parameters.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,54 @@ +**To get parameters for a relational database** + +The following ``get-relational-database-parameters`` example returns information about all of the available parameters for the specified relational database. :: + + aws lightsail get-relational-database-parameters \ + --relational-database-name Database-1 + +Output:: + + { + "parameters": [ + { + "allowedValues": "0,1", + "applyMethod": "pending-reboot", + "applyType": "dynamic", + "dataType": "boolean", + "description": "Automatically set all granted roles as active after the user has authenticated successfully.", + "isModifiable": true, + "parameterName": "activate_all_roles_on_login", + "parameterValue": "0" + }, + { + "allowedValues": "0,1", + "applyMethod": "pending-reboot", + "applyType": "static", + "dataType": "boolean", + "description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded", + "isModifiable": false, + "parameterName": "allow-suspicious-udfs" + }, + { + "allowedValues": "0,1", + "applyMethod": "pending-reboot", + "applyType": "dynamic", + "dataType": "boolean", + "description": "Sets the autocommit mode", + "isModifiable": true, + "parameterName": "autocommit" + }, + { + "allowedValues": "0,1", + "applyMethod": "pending-reboot", + "applyType": "static", + "dataType": "boolean", + "description": "Controls whether the server autogenerates SSL key and certificate files in the data directory, if they do not already exist.", + "isModifiable": false, + "parameterName": "auto_generate_certs" + }, + ... + } + ] + } + +For more information, see `Updating database parameters in Amazon Lightsail `__ in the *Lightsail Dev Guide*. diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-relational-database.rst awscli-1.18.69/awscli/examples/lightsail/get-relational-database.rst --- awscli-1.11.13/awscli/examples/lightsail/get-relational-database.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-relational-database.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,46 @@ +**To get information about a relational database** + +The following ``get-relational-database`` example displays details about the specified relational database. :: + + aws lightsail get-relational-database \ + --relational-database-name Database-1 + +Output:: + + { + "relationalDatabase": { + "name": "Database-1", + "arn": "arn:aws:lightsail:us-west-2:111122223333:RelationalDatabase/7ea932b1-b85a-4bd5-9b3e-bEXAMPLE8cc4", + "supportCode": "6EXAMPLE3362/ls-9EXAMPLE8ad863723b62cc8901a8aa6e794ae0d2", + "createdAt": 1571259453.795, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "resourceType": "RelationalDatabase", + "tags": [], + "relationalDatabaseBlueprintId": "mysql_8_0", + "relationalDatabaseBundleId": "micro_1_0", + "masterDatabaseName": "dbmaster", + "hardware": { + "cpuCount": 1, + "diskSizeInGb": 40, + "ramSizeInGb": 1.0 + }, + "state": "available", + "backupRetentionEnabled": false, + "pendingModifiedValues": {}, + "engine": "mysql", + "engineVersion": "8.0.16", + "masterUsername": "dbmasteruser", + "parameterApplyStatus": "in-sync", + "preferredBackupWindow": "10:01-10:31", + "preferredMaintenanceWindow": "sat:11:14-sat:11:44", + "publiclyAccessible": true, + "masterEndpoint": { + "port": 3306, + "address": "ls-9EXAMPLE8ad863723b62ccEXAMPLEa6e794ae0d2.czowadgeezqi.us-west-2.rds.amazonaws.com" + }, + "pendingMaintenanceActions": [] + } + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-relational-database-snapshot.rst awscli-1.18.69/awscli/examples/lightsail/get-relational-database-snapshot.rst --- awscli-1.11.13/awscli/examples/lightsail/get-relational-database-snapshot.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-relational-database-snapshot.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,31 @@ +**To get information about a relational database snapshot** + +The following ``get-relational-database-snapshot`` example displays details about the specified relational database snapshot. :: + + aws lightsail get-relational-database-snapshot \ + --relational-database-snapshot-name Database-1-1571350042 + +Output:: + + { + "relationalDatabaseSnapshot": { + "name": "Database-1-1571350042", + "arn": "arn:aws:lightsail:us-west-2:111122223333:RelationalDatabaseSnapshot/0389bbad-4b85-4c3d-9EXAMPLEaee3643d2", + "supportCode": "6EXAMPLE3362/ls-8EXAMPLE2ba7ad041451946fafc2ad19cfbd9eb2", + "createdAt": 1571350046.238, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "resourceType": "RelationalDatabaseSnapshot", + "tags": [], + "engine": "mysql", + "engineVersion": "8.0.16", + "sizeInGb": 40, + "state": "available", + "fromRelationalDatabaseName": "Database-1", + "fromRelationalDatabaseArn": "arn:aws:lightsail:us-west-2:111122223333:RelationalDatabase/7ea932b1-b85a-4bd5-9b3e-bEXAMPLE8cc4", + "fromRelationalDatabaseBundleId": "micro_1_0", + "fromRelationalDatabaseBlueprintId": "mysql_8_0" + } + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-relational-database-snapshots.rst awscli-1.18.69/awscli/examples/lightsail/get-relational-database-snapshots.rst --- awscli-1.11.13/awscli/examples/lightsail/get-relational-database-snapshots.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-relational-database-snapshots.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,56 @@ +**To get information about all relational database snapshots** + +The following ``get-relational-database-snapshots`` example displays details about all of the relational database snapshots in the configured AWS Region. :: + + aws lightsail get-relational-database-snapshots + +Output:: + + { + "relationalDatabaseSnapshots": [ + { + "name": "Database-1-1571350042", + "arn": "arn:aws:lightsail:us-west-2:111122223333:RelationalDatabaseSnapshot/0389bbad-4b85-4c3d-9861-6EXAMPLE43d2", + "supportCode": "6EXAMPLE3362/ls-8EXAMPLE2ba7ad041451946fafc2ad19cfbd9eb2", + "createdAt": 1571350046.238, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "resourceType": "RelationalDatabaseSnapshot", + "tags": [], + "engine": "mysql", + "engineVersion": "8.0.16", + "sizeInGb": 40, + "state": "available", + "fromRelationalDatabaseName": "Database-1", + "fromRelationalDatabaseArn": "arn:aws:lightsail:us-west-2:111122223333:RelationalDatabase/7ea932b1-b85a-4bd5-9b3e-bEXAMPLE8cc4", + "fromRelationalDatabaseBundleId": "micro_1_0", + "fromRelationalDatabaseBlueprintId": "mysql_8_0" + }, + { + "name": "Database1-Console", + "arn": "arn:aws:lightsail:us-west-2:111122223333:RelationalDatabaseSnapshot/8b94136e-06ec-4b1a-a3fb-5EXAMPLEe1e9", + "supportCode": "6EXAMPLE3362/ls-9EXAMPLE14b000d34c8d1c432734e137612d5b5c", + "createdAt": 1571249981.025, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "resourceType": "RelationalDatabaseSnapshot", + "tags": [ + { + "key": "test" + } + ], + "engine": "mysql", + "engineVersion": "5.6.44", + "sizeInGb": 40, + "state": "available", + "fromRelationalDatabaseName": "Database1", + "fromRelationalDatabaseArn": "arn:aws:lightsail:us-west-2:111122223333:RelationalDatabase/a6161cb7-4535-4f16-9dcf-8EXAMPLE3d4e", + "fromRelationalDatabaseBundleId": "micro_1_0", + "fromRelationalDatabaseBlueprintId": "mysql_5_6" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-relational-databases.rst awscli-1.18.69/awscli/examples/lightsail/get-relational-databases.rst --- awscli-1.11.13/awscli/examples/lightsail/get-relational-databases.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-relational-databases.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,84 @@ +**To get information about all relational databases** + +The following ``get-relational-databases`` example displays details about all of the relational databases in the configured AWS Region. :: + + aws lightsail get-relational-databases + +Output:: + + { + "relationalDatabases": [ + { + "name": "MySQL", + "arn": "arn:aws:lightsail:us-west-2:111122223333:RelationalDatabase/8529020c-3ab9-4d51-92af-5EXAMPLE8979", + "supportCode": "6EXAMPLE3362/ls-3EXAMPLEa995d8c3b06b4501356e5f2f28e1aeba", + "createdAt": 1554306019.155, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "resourceType": "RelationalDatabase", + "tags": [], + "relationalDatabaseBlueprintId": "mysql_8_0", + "relationalDatabaseBundleId": "micro_1_0", + "masterDatabaseName": "dbmaster", + "hardware": { + "cpuCount": 1, + "diskSizeInGb": 40, + "ramSizeInGb": 1.0 + }, + "state": "available", + "backupRetentionEnabled": true, + "pendingModifiedValues": {}, + "engine": "mysql", + "engineVersion": "8.0.15", + "latestRestorableTime": 1571686200.0, + "masterUsername": "dbmasteruser", + "parameterApplyStatus": "in-sync", + "preferredBackupWindow": "07:51-08:21", + "preferredMaintenanceWindow": "tue:12:18-tue:12:48", + "publiclyAccessible": true, + "masterEndpoint": { + "port": 3306, + "address": "ls-3EXAMPLEa995d8c3b06b4501356e5f2fEXAMPLEa.czowadgeezqi.us-west-2.rds.amazonaws.com" + }, + "pendingMaintenanceActions": [] + }, + { + "name": "Postgres", + "arn": "arn:aws:lightsail:us-west-2:111122223333:RelationalDatabase/e9780b6b-d0ab-4af2-85f1-1EXAMPLEac68", + "supportCode": "6EXAMPLE3362/ls-3EXAMPLEb4fffb5cec056220c734713e14bd5fcd", + "createdAt": 1554306000.814, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "resourceType": "RelationalDatabase", + "tags": [], + "relationalDatabaseBlueprintId": "postgres_11", + "relationalDatabaseBundleId": "micro_1_0", + "masterDatabaseName": "dbmaster", + "hardware": { + "cpuCount": 1, + "diskSizeInGb": 40, + "ramSizeInGb": 1.0 + }, + "state": "available", + "backupRetentionEnabled": true, + "pendingModifiedValues": {}, + "engine": "postgres", + "engineVersion": "11.1", + "latestRestorableTime": 1571686339.0, + "masterUsername": "dbmasteruser", + "parameterApplyStatus": "in-sync", + "preferredBackupWindow": "06:19-06:49", + "preferredMaintenanceWindow": "sun:10:19-sun:10:49", + "publiclyAccessible": false, + "masterEndpoint": { + "port": 5432, + "address": "ls-3EXAMPLEb4fffb5cec056220c734713eEXAMPLEd.czowadgeezqi.us-west-2.rds.amazonaws.com" + }, + "pendingMaintenanceActions": [] + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-static-ip.rst awscli-1.18.69/awscli/examples/lightsail/get-static-ip.rst --- awscli-1.11.13/awscli/examples/lightsail/get-static-ip.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-static-ip.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,24 @@ +**To get information about a static IP** + +The following ``get-static-ip`` example displays details about the specified static IP. :: + + aws lightsail get-static-ip \ + --static-ip-name StaticIp-1 + +Output:: + + { + "staticIp": { + "name": "StaticIp-1", + "arn": "arn:aws:lightsail:us-west-2:111122223333:StaticIp/2257cd76-1f0e-4ac0-82e2-2EXAMPLE23ad", + "supportCode": "6EXAMPLE3362/192.0.2.0", + "createdAt": 1571071325.076, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "resourceType": "StaticIp", + "ipAddress": "192.0.2.0", + "isAttached": false + } + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/get-static-ips.rst awscli-1.18.69/awscli/examples/lightsail/get-static-ips.rst --- awscli-1.11.13/awscli/examples/lightsail/get-static-ips.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/get-static-ips.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,39 @@ +**To get information about all static IPs** + +The following ``get-static-ips`` example displays details about all of the static IPs in the configured AWS Region. :: + + aws lightsail get-static-ips + +Output:: + + { + "staticIps": [ + { + "name": "StaticIp-1", + "arn": "arn:aws:lightsail:us-west-2:111122223333:StaticIp/2257cd76-1f0e-4ac0-8EXAMPLE16f9423ad", + "supportCode": "6EXAMPLE3362/192.0.2.0", + "createdAt": 1571071325.076, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "resourceType": "StaticIp", + "ipAddress": "192.0.2.0", + "isAttached": false + }, + { + "name": "StaticIP-2", + "arn": "arn:aws:lightsail:us-west-2:111122223333:StaticIp/c61edb40-e5f0-4fd6-ae7c-8EXAMPLE19f8", + "supportCode": "6EXAMPLE3362/192.0.2.2", + "createdAt": 1568305385.681, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "resourceType": "StaticIp", + "ipAddress": "192.0.2.2", + "attachedTo": "WordPress-1", + "isAttached": true + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/is-vpc-peered.rst awscli-1.18.69/awscli/examples/lightsail/is-vpc-peered.rst --- awscli-1.11.13/awscli/examples/lightsail/is-vpc-peered.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/is-vpc-peered.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,12 @@ +**To identify if your Amazon Lightsail virtual private cloud is peered** + +The following ``is-vpc-peered`` example returns the peering status of the Amazon Lightsail virtual private cloud (VPC) for the specified AWS Region. :: + + aws lightsail is-vpc-peered \ + --region us-west-2 + +Output:: + + { + "isPeered": true + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/open-instance-public-ports.rst awscli-1.18.69/awscli/examples/lightsail/open-instance-public-ports.rst --- awscli-1.11.13/awscli/examples/lightsail/open-instance-public-ports.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/open-instance-public-ports.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,27 @@ +**To open firewall ports for an instance** + +The following ``open-instance-public-ports`` example opens TCP port 22 on the specified instance. :: + + aws lightsail open-instance-public-ports \ + --instance-name MEAN-2 \ + --port-info fromPort=22,protocol=TCP,toPort=22 + +Output:: + + { + "operation": { + "id": "719744f0-a022-46f2-9f11-6EXAMPLE4642", + "resourceName": "MEAN-2", + "resourceType": "Instance", + "createdAt": 1571072906.849, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationDetails": "22/tcp", + "operationType": "OpenInstancePublicPorts", + "status": "Succeeded", + "statusChangedAt": 1571072906.849 + } + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/peer-vpc.rst awscli-1.18.69/awscli/examples/lightsail/peer-vpc.rst --- awscli-1.11.13/awscli/examples/lightsail/peer-vpc.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/peer-vpc.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,27 @@ +**To peer the Amazon Lightsail virtual private cloud** + +The following ``peer-vpc`` example peers the Amazon Lightsail virtual private cloud (VPC) for the specified AWS Region. :: + + aws lightsail peer-vpc \ + --region us-west-2 + + +Output:: + + { + "operation": { + "id": "787e846a-54ac-497f-bce2-9EXAMPLE5d91", + "resourceName": "vpc-0EXAMPLEa5261efb3", + "resourceType": "PeeredVpc", + "createdAt": 1571694233.104, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationDetails": "vpc-e2b3eb9b", + "operationType": "PeeredVpc", + "status": "Succeeded", + "statusChangedAt": 1571694233.104 + } + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/reboot-instance.rst awscli-1.18.69/awscli/examples/lightsail/reboot-instance.rst --- awscli-1.11.13/awscli/examples/lightsail/reboot-instance.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/reboot-instance.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,28 @@ +**To reboot an instance** + +The following ``reboot-instance`` example reboots the specified instance. :: + + aws lightsail reboot-instance \ + --instance-name MEAN-1 + +Output:: + + { + "operations": [ + { + "id": "2b679f1c-8b71-4bb4-8e97-8EXAMPLEed93", + "resourceName": "MEAN-1", + "resourceType": "Instance", + "createdAt": 1571694445.49, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationDetails": "", + "operationType": "RebootInstance", + "status": "Succeeded", + "statusChangedAt": 1571694445.49 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/reboot-relational-database.rst awscli-1.18.69/awscli/examples/lightsail/reboot-relational-database.rst --- awscli-1.11.13/awscli/examples/lightsail/reboot-relational-database.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/reboot-relational-database.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,28 @@ +**To reboot a relational database** + +The following ``reboot-relational-database`` example reboots the specified relational database. :: + + aws lightsail reboot-relational-database \ + --relational-database-name Database-1 + +Output:: + + { + "operations": [ + { + "id": "e4c980c0-3137-496c-9c91-1EXAMPLEdec2", + "resourceName": "Database-1", + "resourceType": "RelationalDatabase", + "createdAt": 1571694532.91, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationDetails": "", + "operationType": "RebootRelationalDatabase", + "status": "Started", + "statusChangedAt": 1571694532.91 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/release-static-ip.rst awscli-1.18.69/awscli/examples/lightsail/release-static-ip.rst --- awscli-1.11.13/awscli/examples/lightsail/release-static-ip.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/release-static-ip.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,27 @@ +**To delete a static IP** + +The following ``release-static-ip`` example deletes the specified static IP. :: + + aws lightsail release-static-ip \ + --static-ip-name StaticIp-1 + +Output:: + + { + "operations": [ + { + "id": "e374c002-dc6d-4c7f-919f-2EXAMPLE13ce", + "resourceName": "StaticIp-1", + "resourceType": "StaticIp", + "createdAt": 1571694962.003, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationType": "ReleaseStaticIp", + "status": "Succeeded", + "statusChangedAt": 1571694962.003 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/start-instance.rst awscli-1.18.69/awscli/examples/lightsail/start-instance.rst --- awscli-1.11.13/awscli/examples/lightsail/start-instance.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/start-instance.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,27 @@ +**To start an instance** + +The following ``start-instance`` example starts the specified instance. :: + + aws lightsail start-instance \ + --instance-name WordPress-1 + +Output:: + + { + "operations": [ + { + "id": "f88d2a93-7cea-4165-afce-2d688cb18f23", + "resourceName": "WordPress-1", + "resourceType": "Instance", + "createdAt": 1571695583.463, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationType": "StartInstance", + "status": "Started", + "statusChangedAt": 1571695583.463 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/start-relational-database.rst awscli-1.18.69/awscli/examples/lightsail/start-relational-database.rst --- awscli-1.11.13/awscli/examples/lightsail/start-relational-database.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/start-relational-database.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,27 @@ +**To start a relational database** + +The following ``start-relational-database`` example starts the specified relational database. :: + + aws lightsail start-relational-database \ + --relational-database-name Database-1 + +Output:: + + { + "operations": [ + { + "id": "4d5294ec-a38a-4fda-9e37-aEXAMPLE0d24", + "resourceName": "Database-1", + "resourceType": "RelationalDatabase", + "createdAt": 1571695998.822, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationType": "StartRelationalDatabase", + "status": "Started", + "statusChangedAt": 1571695998.822 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/stop-instance.rst awscli-1.18.69/awscli/examples/lightsail/stop-instance.rst --- awscli-1.11.13/awscli/examples/lightsail/stop-instance.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/stop-instance.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,27 @@ +**To stop an instance** + +The following ``stop-instance`` example stops the specified instance. :: + + aws lightsail stop-instance \ + --instance-name WordPress-1 + +Output:: + + { + "operations": [ + { + "id": "265357e2-2943-4d51-888a-1EXAMPLE7585", + "resourceName": "WordPress-1", + "resourceType": "Instance", + "createdAt": 1571695471.134, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationType": "StopInstance", + "status": "Started", + "statusChangedAt": 1571695471.134 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/stop-relational-database.rst awscli-1.18.69/awscli/examples/lightsail/stop-relational-database.rst --- awscli-1.11.13/awscli/examples/lightsail/stop-relational-database.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/stop-relational-database.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,27 @@ +**To stop a relational database** + +The following ``stop-relational-database`` example stops the specified relational database. :: + + aws lightsail stop-relational-database \ + --relational-database-name Database-1 + +Output:: + + { + "operations": [ + { + "id": "cc559c19-4adb-41e4-b75b-5EXAMPLE4e61", + "resourceName": "Database-1", + "resourceType": "RelationalDatabase", + "createdAt": 1571695526.29, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationType": "StopRelationalDatabase", + "status": "Started", + "statusChangedAt": 1571695526.29 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/lightsail/unpeer-vpc.rst awscli-1.18.69/awscli/examples/lightsail/unpeer-vpc.rst --- awscli-1.11.13/awscli/examples/lightsail/unpeer-vpc.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/lightsail/unpeer-vpc.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,26 @@ +**To unpeer the Amazon Lightsail virtual private cloud** + +The following ``unpeer-vpc`` example unpeers the Amazon Lightsail virtual private cloud (VPC) for the specified AWS Region. :: + + aws lightsail unpeer-vpc \ + --region us-west-2 + +Output:: + + { + "operation": { + "id": "531aca64-7157-47ab-84c6-eEXAMPLEd898", + "resourceName": "vpc-0EXAMPLEa5261efb3", + "resourceType": "PeeredVpc", + "createdAt": 1571694109.945, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationDetails": "vpc-e2b3eb9b", + "operationType": "UnpeeredVpc", + "status": "Succeeded", + "statusChangedAt": 1571694109.945 + } + } diff -Nru awscli-1.11.13/awscli/examples/mediaconnect/add-flow-outputs.rst awscli-1.18.69/awscli/examples/mediaconnect/add-flow-outputs.rst --- awscli-1.11.13/awscli/examples/mediaconnect/add-flow-outputs.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconnect/add-flow-outputs.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,39 @@ +**To add outputs to a flow** + +The following ``add-flow-outputs`` example adds outputs to the specified flow. :: + + aws mediaconnect add-flow-outputs \ + --flow-arn arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame \ + --outputs Description='NYC stream',Destination=192.0.2.12,Name=NYC,Port=3333,Protocol=rtp-fec,SmoothingLatency=100 Description='LA stream',Destination=203.0.113.9,Name=LA,Port=4444,Protocol=rtp-fec,SmoothingLatency=100 + +Output:: + + { + "Outputs": [ + { + "Port": 3333, + "OutputArn": "arn:aws:mediaconnect:us-east-1:111122223333:output:2-3aBC45dEF67hiJ89-c34de5fG678h:NYC", + "Name": "NYC", + "Description": "NYC stream", + "Destination": "192.0.2.12", + "Transport": { + "Protocol": "rtp-fec", + "SmoothingLatency": 100 + } + }, + { + "Port": 4444, + "OutputArn": "arn:aws:mediaconnect:us-east-1:111122223333:output:2-987655dEF67hiJ89-c34de5fG678h:LA", + "Name": "LA", + "Description": "LA stream", + "Destination": "203.0.113.9", + "Transport": { + "Protocol": "rtp-fec", + "SmoothingLatency": 100 + } + } + ], + "FlowArn": "arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame" + } + +For more information, see `Adding Outputs to a Flow `__ in the *AWS Elemental MediaConnect User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediaconnect/create-flow.rst awscli-1.18.69/awscli/examples/mediaconnect/create-flow.rst --- awscli-1.11.13/awscli/examples/mediaconnect/create-flow.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconnect/create-flow.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,37 @@ +**To create a flow** + +The following ``create-flow`` example creates a flow with the specified configuration. :: + + aws mediaconnect create-flow \ + --availability-zone us-west-2c \ + --name ExampleFlow \ + --source Description='Example source, backup',IngestPort=1055,Name=BackupSource,Protocol=rtp,WhitelistCidr=10.24.34.0/23 + +Output:: + + { + "Flow": { + "FlowArn": "arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:ExampleFlow", + "AvailabilityZone": "us-west-2c", + "EgressIp": "54.245.71.21", + "Source": { + "IngestPort": 1055, + "SourceArn": "arn:aws:mediaconnect:us-east-1:123456789012:source:2-3aBC45dEF67hiJ89-c34de5fG678h:BackupSource", + "Transport": { + "Protocol": "rtp", + "MaxBitrate": 80000000 + }, + "Description": "Example source, backup", + "IngestIp": "54.245.71.21", + "WhitelistCidr": "10.24.34.0/23", + "Name": "mySource" + }, + "Entitlements": [], + "Name": "ExampleFlow", + "Outputs": [], + "Status": "STANDBY", + "Description": "Example source, backup" + } + } + +For more information, see `Creating a Flow `__ in the *AWS Elemental MediaConnect User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediaconnect/delete-flow.rst awscli-1.18.69/awscli/examples/mediaconnect/delete-flow.rst --- awscli-1.11.13/awscli/examples/mediaconnect/delete-flow.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconnect/delete-flow.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,15 @@ +**To delete a flow** + +The following ``delete-flow`` example deletes the specified flow. :: + + aws mediaconnect delete-flow \ + --flow-arn arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow + +Output:: + + { + "FlowArn": "arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow", + "Status": "DELETING" + } + +For more information, see `Deleting a Flow `__ in the *AWS Elemental MediaConnect User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediaconnect/describe-flow.rst awscli-1.18.69/awscli/examples/mediaconnect/describe-flow.rst --- awscli-1.11.13/awscli/examples/mediaconnect/describe-flow.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconnect/describe-flow.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,65 @@ +**To view the details of a flow** + +The following ``describe-flow`` example displays the specified flow's details, such as ARN, Availability Zone, status, source, entitlements, and outputs. :: + + aws mediaconnect describe-flow \ + --flow-arn arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow + +Output:: + + { + "Flow": { + "EgressIp": "54.201.4.39", + "AvailabilityZone": "us-west-2c", + "Status": "ACTIVE", + "FlowArn": "arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow", + "Entitlements": [ + { + "EntitlementArn": "arn:aws:mediaconnect:us-west-2:123456789012:entitlement:1-AaBb11CcDd22EeFf-34DE5fG12AbC:MyEntitlement", + "Description": "Assign to this account", + "Name": "MyEntitlement", + "Subscribers": [ + "444455556666" + ] + } + ], + "Description": "NYC awards show", + "Name": "AwardsShow", + "Outputs": [ + { + "Port": 2355, + "Name": "NYC", + "Transport": { + "SmoothingLatency": 0, + "Protocol": "rtp-fec" + }, + "OutputArn": "arn:aws:mediaconnect:us-east-1:123456789012:output:2-3aBC45dEF67hiJ89-c34de5fG678h:NYC", + "Destination": "192.0.2.0" + }, + { + "Port": 3025, + "Name": "LA", + "Transport": { + "SmoothingLatency": 0, + "Protocol": "rtp-fec" + }, + "OutputArn": "arn:aws:mediaconnect:us-east-1:123456789012:output:2-987655dEF67hiJ89-c34de5fG678h:LA", + "Destination": "192.0.2.0" + } + ], + "Source": { + "IngestIp": "54.201.4.39", + "SourceArn": "arn:aws:mediaconnect:us-east-1:123456789012:source:3-4aBC56dEF78hiJ90-4de5fG6Hi78Jk:ShowSource", + "Transport": { + "MaxBitrate": 80000000, + "Protocol": "rtp" + }, + "IngestPort": 1069, + "Description": "Saturday night show", + "Name": "ShowSource", + "WhitelistCidr": "10.24.34.0/23" + } + } + } + +For more information, see `Viewing the Details of a Flow `__ in the *AWS Elemental MediaConnect User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediaconnect/grant-flow-entitlements.rst awscli-1.18.69/awscli/examples/mediaconnect/grant-flow-entitlements.rst --- awscli-1.11.13/awscli/examples/mediaconnect/grant-flow-entitlements.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconnect/grant-flow-entitlements.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,39 @@ +**To grant an entitlement on a flow** + +The following ``grant-flow-entitlements`` example grants an entitlement to the specified existing flow to share your content with another AWS account. :: + + aws mediaconnect grant-flow-entitlements \ + --flow-arn arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame \ + --entitlements Description='For AnyCompany',Encryption={"Algorithm=aes128,KeyType=static-key,RoleArn=arn:aws:iam::111122223333:role/MediaConnect-ASM,SecretArn=arn:aws:secretsmanager:us-west-2:111122223333:secret:mySecret1"},Name=AnyCompany_Entitlement,Subscribers=444455556666 Description='For Example Corp',Name=ExampleCorp,Subscribers=777788889999 + +Output:: + + { + "Entitlements": [ + { + "Name": "AnyCompany_Entitlement", + "EntitlementArn": "arn:aws:mediaconnect:us-west-2:111122223333:entitlement:1-11aa22bb11aa22bb-3333cccc4444:AnyCompany_Entitlement", + "Subscribers": [ + "444455556666" + ], + "Description": "For AnyCompany", + "Encryption": { + "SecretArn": "arn:aws:secretsmanager:us-west-2:111122223333:secret:mySecret1", + "Algorithm": "aes128", + "RoleArn": "arn:aws:iam::111122223333:role/MediaConnect-ASM", + "KeyType": "static-key" + } + }, + { + "Name": "ExampleCorp", + "EntitlementArn": "arn:aws:mediaconnect:us-west-2:111122223333:entitlement:1-3333cccc4444dddd-1111aaaa2222:ExampleCorp", + "Subscribers": [ + "777788889999" + ], + "Description": "For Example Corp" + } + ], + "FlowArn": "arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame" + } + +For more information, see `Granting an Entitlement on a Flow `__ in the *AWS Elemental MediaConnect User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediaconnect/list-entitlements.rst awscli-1.18.69/awscli/examples/mediaconnect/list-entitlements.rst --- awscli-1.11.13/awscli/examples/mediaconnect/list-entitlements.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconnect/list-entitlements.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,18 @@ +**To view a list of entitlements** + +The following ``list-entitlements`` example displays a list of all entitlements that have been granted to the account. :: + + aws mediaconnect list-entitlements + +Output:: + + { + "Entitlements": [ + { + "EntitlementArn": "arn:aws:mediaconnect:us-west-2:111122223333:entitlement:1-11aa22bb11aa22bb-3333cccc4444:MyEntitlement", + "EntitlementName": "MyEntitlement" + } + ] + } + +For more information, see `ListEntitlements `__ in the *AWS Elemental MediaConnect API Reference*. diff -Nru awscli-1.11.13/awscli/examples/mediaconnect/list-flows.rst awscli-1.18.69/awscli/examples/mediaconnect/list-flows.rst --- awscli-1.11.13/awscli/examples/mediaconnect/list-flows.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconnect/list-flows.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,30 @@ +**To view a list of flows** + +The following ``list-flows`` example displays a list of flows. :: + + aws mediaconnect list-flows + +Output:: + + { + "Flows": [ + { + "Status": "STANDBY", + "SourceType": "OWNED", + "AvailabilityZone": "us-west-2a", + "Description": "NYC awards show", + "Name": "AwardsShow", + "FlowArn": "arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow" + }, + { + "Status": "STANDBY", + "SourceType": "OWNED", + "AvailabilityZone": "us-west-2c", + "Description": "LA basketball game", + "Name": "BasketballGame", + "FlowArn": "arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BasketballGame" + } + ] + } + +For more information, see `Viewing a List of Flows `__ in the *AWS Elemental MediaConnect User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediaconnect/list-tags-for-resource.rst awscli-1.18.69/awscli/examples/mediaconnect/list-tags-for-resource.rst --- awscli-1.11.13/awscli/examples/mediaconnect/list-tags-for-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconnect/list-tags-for-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,17 @@ +**To list tags for a MediaConnect resource** + +The following ``list-tags-for-resource`` example displays the tag keys and values associated with the specified MediaConnect resource. :: + + aws mediaconnect list-tags-for-resource \ + --resource-arn arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BasketballGame + +Output:: + + { + "Tags": { + "region": "west", + "stage": "prod" + } + } + +For more information, see `ListTagsForResource, TagResource, UntagResource `__ in the *AWS Elemental MediaConnect API Reference*. diff -Nru awscli-1.11.13/awscli/examples/mediaconnect/remove-flow-output.rst awscli-1.18.69/awscli/examples/mediaconnect/remove-flow-output.rst --- awscli-1.11.13/awscli/examples/mediaconnect/remove-flow-output.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconnect/remove-flow-output.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,16 @@ +**To remove an output from a flow** + +The following ``remove-flow-output`` example removes an output from the specified flow. :: + + aws mediaconnect remove-flow-output \ + --flow-arn arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame \ + --output-arn arn:aws:mediaconnect:us-east-1:111122223333:output:2-3aBC45dEF67hiJ89-c34de5fG678h:NYC + +Output:: + + { + "FlowArn": "arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame", + "OutputArn": "arn:aws:mediaconnect:us-east-1:111122223333:output:2-3aBC45dEF67hiJ89-c34de5fG678h:NYC" + } + +For more information, see `Removing Outputs from a Flow `__ in the *AWS Elemental MediaConnect User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediaconnect/revoke-flow-entitlement.rst awscli-1.18.69/awscli/examples/mediaconnect/revoke-flow-entitlement.rst --- awscli-1.11.13/awscli/examples/mediaconnect/revoke-flow-entitlement.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconnect/revoke-flow-entitlement.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,16 @@ +**To revoke an entitlement** + +The following ``revoke-flow-entitlement`` example revokes an entitlement on the specified flow. :: + + aws mediaconnect revoke-flow-entitlement \ + --flow-arn arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame \ + --entitlement-arn arn:aws:mediaconnect:us-west-2:111122223333:entitlement:1-11aa22bb11aa22bb-3333cccc4444:AnyCompany_Entitlement + +Output:: + + { + "FlowArn": "arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame", + "EntitlementArn": "arn:aws:mediaconnect:us-west-2:111122223333:entitlement:1-11aa22bb11aa22bb-3333cccc4444:AnyCompany_Entitlement" + } + +For more information, see `Revoking an Entitlement `__ in the *AWS Elemental MediaConnect User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediaconnect/start-flow.rst awscli-1.18.69/awscli/examples/mediaconnect/start-flow.rst --- awscli-1.11.13/awscli/examples/mediaconnect/start-flow.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconnect/start-flow.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,16 @@ +**To start a flow** + +The following ``start-flow`` example starts the specified flow. :: + + aws mediaconnect start-flow \ + --flow-arn arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow + +This command produces no output. +Output:: + + { + "FlowArn": "arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow", + "Status": "STARTING" + } + +For more information, see `Starting a Flow `__ in the *AWS Elemental MediaConnect User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediaconnect/stop-flow.rst awscli-1.18.69/awscli/examples/mediaconnect/stop-flow.rst --- awscli-1.11.13/awscli/examples/mediaconnect/stop-flow.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconnect/stop-flow.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,15 @@ +**To stop a flow** + +The following ``stop-flow`` example stops the specified flow. :: + + aws mediaconnect stop-flow \ + --flow-arn arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow + +Output:: + + { + "Status": "STOPPING", + "FlowArn": "arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow" + } + +For more information, see `Stopping a Flow `__ in the *AWS Elemental MediaConnect User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediaconnect/tag-resource.rst awscli-1.18.69/awscli/examples/mediaconnect/tag-resource.rst --- awscli-1.11.13/awscli/examples/mediaconnect/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconnect/tag-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To add tags to a MediaConnect resource** + +The following ``tag-resource`` example adds a tag with a key name and value to the specified MediaConnect resource. :: + + aws mediaconnect tag-resource \ + --resource-arn arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BasketballGame + --tags region=west + +This command produces no output. + +For more information, see `ListTagsForResource, TagResource, UntagResource `__ in the *AWS Elemental MediaConnect API Reference*. diff -Nru awscli-1.11.13/awscli/examples/mediaconnect/untag-resource.rst awscli-1.18.69/awscli/examples/mediaconnect/untag-resource.rst --- awscli-1.11.13/awscli/examples/mediaconnect/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconnect/untag-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To remove tags from a MediaConnect resource** + +The following ``untag-resource`` example remove the tag with the specified key name and its associated value from a MediaConnect resource. :: + + aws mediaconnect untag-resource \ + --resource-arn arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BasketballGame \ + --tag-keys region + +This command produces no output. + +For more information, see `ListTagsForResource, TagResource, UntagResource `__ in the *AWS Elemental MediaConnect API Reference*. diff -Nru awscli-1.11.13/awscli/examples/mediaconnect/update-flow-entitlement.rst awscli-1.18.69/awscli/examples/mediaconnect/update-flow-entitlement.rst --- awscli-1.11.13/awscli/examples/mediaconnect/update-flow-entitlement.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconnect/update-flow-entitlement.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,31 @@ +**To update an entitlement** + +The following ``update-flow-entitlement`` example updates the specified entitlement with a new description and subscriber. :: + + aws mediaconnect update-flow-entitlement \ + --flow-arn arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame \ + --entitlement-arn arn:aws:mediaconnect:us-west-2:111122223333:entitlement:1-11aa22bb11aa22bb-3333cccc4444:AnyCompany_Entitlement \ + --description 'For AnyCompany Affiliate' \ + --subscribers 777788889999 + +Output:: + + { + "FlowArn": "arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame", + "Entitlement": { + "Name": "AnyCompany_Entitlement", + "Description": "For AnyCompany Affiliate", + "EntitlementArn": "arn:aws:mediaconnect:us-west-2:111122223333:entitlement:1-11aa22bb11aa22bb-3333cccc4444:AnyCompany_Entitlement", + "Encryption": { + "KeyType": "static-key", + "Algorithm": "aes128", + "RoleArn": "arn:aws:iam::111122223333:role/MediaConnect-ASM", + "SecretArn": "arn:aws:secretsmanager:us-west-2:111122223333:secret:mySecret1" + }, + "Subscribers": [ + "777788889999" + ] + } + } + +For more information, see `Updating an Entitlement `__ in the *AWS Elemental MediaConnect User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediaconnect/update-flow-output.rst awscli-1.18.69/awscli/examples/mediaconnect/update-flow-output.rst --- awscli-1.11.13/awscli/examples/mediaconnect/update-flow-output.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconnect/update-flow-output.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,27 @@ +**To update an output on a flow** + +The following ``update-flow-output`` example update an output on the specified flow. :: + + aws mediaconnect update-flow-output \ + --flow-arn arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame \ + --output-arn arn:aws:mediaconnect:us-east-1:111122223333:output:2-3aBC45dEF67hiJ89-c34de5fG678h:NYC \ + --port 3331 + +Output:: + + { + "FlowArn": "arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame", + "Output": { + "Name": "NYC", + "Port": 3331, + "Description": "NYC stream", + "Transport": { + "Protocol": "rtp-fec", + "SmoothingLatency": 100 + }, + "OutputArn": "arn:aws:mediaconnect:us-east-1:111122223333:output:2-3aBC45dEF67hiJ89-c34de5fG678h:NYC", + "Destination": "192.0.2.12" + } + } + +For more information, see `Updating Outputs on a Flow `__ in the *AWS Elemental MediaConnect User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediaconnect/update-flow-source.rst awscli-1.18.69/awscli/examples/mediaconnect/update-flow-source.rst --- awscli-1.11.13/awscli/examples/mediaconnect/update-flow-source.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconnect/update-flow-source.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,30 @@ +**To update the source of an existing flow** + +The following ``update-flow-source`` example updates the source of an existing flow. :: + + aws mediaconnect update-flow-source \ + --flow-arn arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow \ + --source-arn arn:aws:mediaconnect:us-east-1:111122223333:source:3-4aBC56dEF78hiJ90-4de5fG6Hi78Jk:ShowSource \ + --description 'Friday night show' \ + --ingest-port 3344 \ + --protocol rtp-fec \ + --whitelist-cidr 10.24.34.0/23 + +Output:: + + { + "FlowArn": "arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow", + "Source": { + "IngestIp": "34.210.136.56", + "WhitelistCidr": "10.24.34.0/23", + "Transport": { + "Protocol": "rtp-fec" + }, + "IngestPort": 3344, + "Name": "ShowSource", + "Description": "Friday night show", + "SourceArn": "arn:aws:mediaconnect:us-east-1:111122223333:source:3-4aBC56dEF78hiJ90-4de5fG6Hi78Jk:ShowSource" + } + } + +For more information, see `Updating the Source of a Flow `__ in the *AWS Elemental MediaConnect User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediaconvert/cancel-job.rst awscli-1.18.69/awscli/examples/mediaconvert/cancel-job.rst --- awscli-1.11.13/awscli/examples/mediaconvert/cancel-job.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconvert/cancel-job.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,12 @@ +**To cancel a job that is in a queue** + +The following ``cancel-job`` example cancels the job with ID ``1234567891234-abc123``. You can't cancel a job that the service has started processing. :: + + aws mediaconvert cancel-job \ + --endpoint-url https://abcd1234.mediaconvert.region-name-1.amazonaws.com \ + --region region-name-1 \ + --id 1234567891234-abc123 + +To get your account-specific endpoint, use ``describe-endpoints``, or send the command without the endpoint. The service returns an error and your endpoint. + +For more information, see `Working with AWS Elemental MediaConvert Jobs `_ in the *AWS Elemental MediaConvert User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediaconvert/create-job.rst awscli-1.18.69/awscli/examples/mediaconvert/create-job.rst --- awscli-1.11.13/awscli/examples/mediaconvert/create-job.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconvert/create-job.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,16 @@ +**To create a job** + +The following ``create-job`` example creates a transcoding job with the settings that are specified in a file ``job.json`` that resides on the system that you send the command from. This JSON job specification might specify each setting individually, reference a job template, or reference output presets. :: + + aws mediaconvert create-job \ + --endpoint-url https://abcd1234.mediaconvert.region-name-1.amazonaws.com \ + --region region-name-1 \ + --cli-input-json file://~/job.json + +You can use the AWS Elemental MediaConvert console to generate the JSON job specification by choosing your job settings, and then choosing **Show job JSON** at the bottom of the **Job** section. + +To get your account-specific endpoint, use ``describe-endpoints``, or send the command without the endpoint. The service returns an error and your endpoint. + +If your request is successful, the service returns the JSON job specification that you sent with your request. + +For more information, see `Working with AWS Elemental MediaConvert Jobs `_ in the *AWS Elemental MediaConvert User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediaconvert/create-job-template.rst awscli-1.18.69/awscli/examples/mediaconvert/create-job-template.rst --- awscli-1.11.13/awscli/examples/mediaconvert/create-job-template.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconvert/create-job-template.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,18 @@ +**To create a job template** + +The following ``create-job-template`` example creates a job template with the transcoding settings that are specified in the file ``job-template.json`` that resides on your system. :: + + aws mediaconvert create-job-template \ + --endpoint-url https://abcd1234.mediaconvert.region-name-1.amazonaws.com \ + --region region-name-1 \ + --name JobTemplate1 \ + --cli-input-json file://~/job-template.json + +If you create your job template JSON file by using ``get-job-template`` and then modifying the file, remove the ``JobTemplate`` object, but keep the `Settings` child object inside it. Also, make sure to remove the following key-value pairs: ``LastUpdated``, ``Arn``, ``Type``, and ``CreatedAt``. You can specific the category, description, name, and queue either in the JSON file or at the command line. + +To get your account-specific endpoint, use ``describe-endpoints``, or send the command without the endpoint. The service returns an error and your endpoint. + +If your request is successful, the service returns the JSON specification for the job template that you created. + +For more information, see `Working with AWS Elemental MediaConvert Job Templates `_ in the *AWS Elemental MediaConvert User Guide*. + diff -Nru awscli-1.11.13/awscli/examples/mediaconvert/create-preset.rst awscli-1.18.69/awscli/examples/mediaconvert/create-preset.rst --- awscli-1.11.13/awscli/examples/mediaconvert/create-preset.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconvert/create-preset.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,14 @@ +**To create a custom output preset** + +The following ``create-preset`` example creates a custom output preset based on the output settings that are specified in the file ``preset.json``. You can specify the category, description, and name either in the JSON file or at the command line. :: + + aws mediaconvert create-preset \ + --endpoint-url https://abcd1234.mediaconvert.region-name-1.amazonaws.com + --region region-name-1 \ + --cli-input-json file://~/preset.json + +If you create your preset JSON file by using ``get-preset`` and then modifying the output file, ensure that you remove the following key-value pairs: ``LastUpdated``, ``Arn``, ``Type``, and ``CreatedAt``. + +To get your account-specific endpoint, use ``describe-endpoints``, or send the command without the endpoint. The service returns an error and your endpoint. + +For more information, see `Working with AWS Elemental MediaConvert Output Presets `_ in the *AWS Elemental MediaConvert User Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/mediaconvert/create-queue.rst awscli-1.18.69/awscli/examples/mediaconvert/create-queue.rst --- awscli-1.11.13/awscli/examples/mediaconvert/create-queue.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconvert/create-queue.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,27 @@ +**To create a custom queue** + +The following ``create-queue`` example creates a custom transcoding queue. :: + + aws mediaconvert create-queue \ + --endpoint-url https://abcd1234.mediaconvert.region-name-1.amazonaws.com \ + --region region-name-1 \ + --name Queue1 \ + --description "Keep this queue empty unless job is urgent." + +To get your account-specific endpoint, use ``describe-endpoints``, or send the command without the endpoint. The service returns an error and your endpoint. + +Output:: + + { + "Queue": { + "Status": "ACTIVE", + "Name": "Queue1", + "LastUpdated": 1518034928, + "Arn": "arn:aws:mediaconvert:region-name-1:012345678998:queues/Queue1", + "Type": "CUSTOM", + "CreatedAt": 1518034928, + "Description": "Keep this queue empty unless job is urgent." + } + } + +For more information, see `Working with AWS Elemental MediaConvert Queues `_ in the *AWS Elemental MediaConvert User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediaconvert/delete-job-template.rst awscli-1.18.69/awscli/examples/mediaconvert/delete-job-template.rst --- awscli-1.11.13/awscli/examples/mediaconvert/delete-job-template.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconvert/delete-job-template.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,12 @@ +**To delete a job template** + +The following ``delete-job-template`` example deletes the specified custom job template. :: + + aws mediaconvert delete-job-template \ + --name "DASH Streaming" \ + --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com + +This command produces no output. Run ``aws mediaconvert list-job-templates`` to confirm that your template was deleted. + + +For more information, see `Working with AWS Elemental MediaConvert Job Templates `__ in the *AWS Elemental MediaConvert User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediaconvert/delete-preset.rst awscli-1.18.69/awscli/examples/mediaconvert/delete-preset.rst --- awscli-1.11.13/awscli/examples/mediaconvert/delete-preset.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconvert/delete-preset.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To delete a custom on-demand queue** + +The following ``delete-preset`` example deletes the specified custom preset. :: + + aws mediaconvert delete-preset \ + --name SimpleMP4 \ + --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com + +This command produces no output. Run ``aws mediaconvert list-presets`` to confirm that your preset was deleted. + +For more information, see `Working with AWS Elemental MediaConvert Output Presets `__ in the *AWS Elemental MediaConvert User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediaconvert/delete-queue.rst awscli-1.18.69/awscli/examples/mediaconvert/delete-queue.rst --- awscli-1.11.13/awscli/examples/mediaconvert/delete-queue.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconvert/delete-queue.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,14 @@ +**To delete a custom on-demand queue** + +The following ``delete-queue`` example deletes the specified custom on-demand queue. + +You can't delete your default queue. You can't delete a reserved queue that has an active pricing plan or that contains unprocessed jobs. :: + + aws mediaconvert delete-queue \ + --name Customer1 \ + --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com + + +This command produces no output. Run ``aws mediaconvert list-queues`` to confirm that your queue was deleted. + +For more information, see `Working with AWS Elemental MediaConvert Queues `__ in the *AWS Elemental MediaConvert User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediaconvert/describe-endpoints.rst awscli-1.18.69/awscli/examples/mediaconvert/describe-endpoints.rst --- awscli-1.11.13/awscli/examples/mediaconvert/describe-endpoints.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconvert/describe-endpoints.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,18 @@ +**To get your account-specific endpoint** + +The following ``describe-endpoints`` example retrieves the endpoint that you need to send any other request to the service. :: + + aws mediaconvert describe-endpoints + +Output:: + + { + "Endpoints": [ + { + "Url": "https://abcd1234.mediaconvert.region-name-1.amazonaws.com" + } + ] + } + +For more information, see `Getting Started with MediaConvert Using the API `_ in the *AWS Elemental +MediaConvert API Reference*. diff -Nru awscli-1.11.13/awscli/examples/mediaconvert/get-job.rst awscli-1.18.69/awscli/examples/mediaconvert/get-job.rst --- awscli-1.11.13/awscli/examples/mediaconvert/get-job.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconvert/get-job.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,36 @@ +**To get details for a particular job** + +The following example requests the information for the job with ID ``1234567890987-1ab2c3``, which in this example ended in an error. :: + + aws mediaconvert get-job \ + --endpoint-url https://abcd1234.mediaconvert.region-name-1.amazonaws.com \ + --region region-name-1 \ + --id 1234567890987-1ab2c3 + +To get your account-specific endpoint, use ``describe-endpoints``, or send the command without the endpoint. The service returns an error and your endpoint. + +If your request is successful, the service returns a JSON file with job information, including job settings, any returned errors, and other job data, as follows:: + + { + "Job": { + "Status": "ERROR", + "Queue": "arn:aws:mediaconvert:region-name-1:012345678998:queues/Queue1", + "Settings": { + ...... + }, + "ErrorMessage": "Unable to open input file [s3://my-input-bucket/file-name.mp4]: [Failed probe/open: [Failed to read data: AssumeRole failed]]", + "ErrorCode": 1434, + "Role": "arn:aws:iam::012345678998:role/MediaConvertServiceRole", + "Arn": "arn:aws:mediaconvert:us-west-1:012345678998:jobs/1234567890987-1ab2c3", + "UserMetadata": {}, + "Timing": { + "FinishTime": 1517442131, + "SubmitTime": 1517442103, + "StartTime": 1517442104 + }, + "Id": "1234567890987-1ab2c3", + "CreatedAt": 1517442103 + } + } + +For more information, see `Working with AWS Elemental MediaConvert Jobs `_ in the *AWS Elemental MediaConvert User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediaconvert/get-job-template.rst awscli-1.18.69/awscli/examples/mediaconvert/get-job-template.rst --- awscli-1.11.13/awscli/examples/mediaconvert/get-job-template.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconvert/get-job-template.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,27 @@ +**To get details for a job template** + +The following ``get-job-template`` example displays the JSON definition of the specified custom job template. :: + + aws mediaconvert get-job-template \ + --name "DASH Streaming" \ + --endpoint-url https://abcd1234.mediaconvert.us-east-1.amazonaws.com + +Output:: + + { + "JobTemplate": { + "StatusUpdateInterval": "SECONDS_60", + "LastUpdated": 1568652998, + "Description": "Create a DASH streaming ABR stack", + "CreatedAt": 1568652998, + "Priority": 0, + "Name": "DASH Streaming", + "Settings": { + ...... + }, + "Arn": "arn:aws:mediaconvert:us-west-2:123456789012:jobTemplates/DASH Streaming", + "Type": "CUSTOM" + } + } + +For more information, see `Working with AWS Elemental MediaConvert Job Templates `__ in the *AWS Elemental MediaConvert User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediaconvert/get-preset.rst awscli-1.18.69/awscli/examples/mediaconvert/get-preset.rst --- awscli-1.11.13/awscli/examples/mediaconvert/get-preset.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconvert/get-preset.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,97 @@ +**To get details for a particular preset** + +The following ``get-preset`` example requests the JSON definition of the specified custom preset. :: + + aws mediaconvert get-preset \ + --name SimpleMP4 \ + --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com + +Output:: + + { + "Preset": { + "Description": "Creates basic MP4 file. No filtering or preproccessing.", + "Arn": "arn:aws:mediaconvert:us-west-2:123456789012:presets/SimpleMP4", + "LastUpdated": 1568843141, + "Name": "SimpleMP4", + "Settings": { + "ContainerSettings": { + "Mp4Settings": { + "FreeSpaceBox": "EXCLUDE", + "CslgAtom": "INCLUDE", + "MoovPlacement": "PROGRESSIVE_DOWNLOAD" + }, + "Container": "MP4" + }, + "AudioDescriptions": [ + { + "LanguageCodeControl": "FOLLOW_INPUT", + "AudioTypeControl": "FOLLOW_INPUT", + "CodecSettings": { + "AacSettings": { + "RawFormat": "NONE", + "CodecProfile": "LC", + "AudioDescriptionBroadcasterMix": "NORMAL", + "SampleRate": 48000, + "Bitrate": 96000, + "RateControlMode": "CBR", + "Specification": "MPEG4", + "CodingMode": "CODING_MODE_2_0" + }, + "Codec": "AAC" + } + } + ], + "VideoDescription": { + "RespondToAfd": "NONE", + "TimecodeInsertion": "DISABLED", + "Sharpness": 50, + "ColorMetadata": "INSERT", + "CodecSettings": { + "H264Settings": { + "FramerateControl": "INITIALIZE_FROM_SOURCE", + "SpatialAdaptiveQuantization": "ENABLED", + "Softness": 0, + "Telecine": "NONE", + "CodecLevel": "AUTO", + "QualityTuningLevel": "SINGLE_PASS", + "UnregisteredSeiTimecode": "DISABLED", + "Slices": 1, + "Syntax": "DEFAULT", + "GopClosedCadence": 1, + "AdaptiveQuantization": "HIGH", + "EntropyEncoding": "CABAC", + "InterlaceMode": "PROGRESSIVE", + "ParControl": "INITIALIZE_FROM_SOURCE", + "NumberBFramesBetweenReferenceFrames": 2, + "GopSizeUnits": "FRAMES", + "RepeatPps": "DISABLED", + "CodecProfile": "MAIN", + "FieldEncoding": "PAFF", + "GopSize": 90.0, + "SlowPal": "DISABLED", + "SceneChangeDetect": "ENABLED", + "GopBReference": "DISABLED", + "RateControlMode": "CBR", + "FramerateConversionAlgorithm": "DUPLICATE_DROP", + "FlickerAdaptiveQuantization": "DISABLED", + "DynamicSubGop": "STATIC", + "MinIInterval": 0, + "TemporalAdaptiveQuantization": "ENABLED", + "Bitrate": 400000, + "NumberReferenceFrames": 3 + }, + "Codec": "H_264" + }, + "AfdSignaling": "NONE", + "AntiAlias": "ENABLED", + "ScalingBehavior": "DEFAULT", + "DropFrameTimecode": "ENABLED" + } + }, + "Type": "CUSTOM", + "CreatedAt": 1568841521 + } + } + +For more information, see `Working with AWS Elemental MediaConvert Output Presets `__ in the *AWS Elemental MediaConvert User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediaconvert/get-queue.rst awscli-1.18.69/awscli/examples/mediaconvert/get-queue.rst --- awscli-1.11.13/awscli/examples/mediaconvert/get-queue.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconvert/get-queue.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,25 @@ +**To get details for a queue** + +The following ``get-queue`` example retrieves the details of the specified custom queue. :: + + aws mediaconvert get-queue \ + --name Customer1 \ + --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com + +Output:: + + { + "Queue": { + "LastUpdated": 1526428502, + "Type": "CUSTOM", + "SubmittedJobsCount": 0, + "Status": "ACTIVE", + "PricingPlan": "ON_DEMAND", + "CreatedAt": 1526428502, + "ProgressingJobsCount": 0, + "Arn": "arn:aws:mediaconvert:us-west-2:123456789012:queues/Customer1", + "Name": "Customer1" + } + } + +For more information, see `Working with AWS Elemental MediaConvert Queues `__ in the *AWS Elemental MediaConvert User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediaconvert/list-jobs.rst awscli-1.18.69/awscli/examples/mediaconvert/list-jobs.rst --- awscli-1.11.13/awscli/examples/mediaconvert/list-jobs.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconvert/list-jobs.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To get details for all jobs in a region** + +The following example requests the information for all of your jobs in the specified region. :: + + aws mediaconvert list-jobs \ + --endpoint-url https://abcd1234.mediaconvert.region-name-1.amazonaws.com \ + --region region-name-1 + +To get your account-specific endpoint, use ``describe-endpoints``, or send the command without the endpoint. The service returns an error and your endpoint. + +For more information, see `Working with AWS Elemental MediaConvert Jobs `_ in the *AWS Elemental MediaConvert User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediaconvert/list-job-templates.rst awscli-1.18.69/awscli/examples/mediaconvert/list-job-templates.rst --- awscli-1.11.13/awscli/examples/mediaconvert/list-job-templates.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconvert/list-job-templates.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,112 @@ +**Example 1: To list your custom job templates** + +The following ``list-job-templates`` example lists all custom job templates in the current Region. To list the system job templates, see the next example. :: + + aws mediaconvert list-job-templates \ + --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com + +Output:: + + { + "JobTemplates": [ + { + "Description": "Create a DASH streaming ABR stack", + "Arn": "arn:aws:mediaconvert:us-west-2:123456789012:jobTemplates/DASH Streaming", + "Name": "DASH Streaming", + "LastUpdated": 1568653007, + "Priority": 0, + "Settings": { + ...... + }, + "Type": "CUSTOM", + "StatusUpdateInterval": "SECONDS_60", + "CreatedAt": 1568653007 + }, + { + "Description": "Create a high-res file", + "Arn": "arn:aws:mediaconvert:us-west-2:123456789012:jobTemplates/File", + "Name": "File", + "LastUpdated": 1568653007, + "Priority": 0, + "Settings": { + ...... + }, + "Type": "CUSTOM", + "StatusUpdateInterval": "SECONDS_60", + "CreatedAt": 1568653023 + } + ] + } + +**Example 2: To list the MediaConvert system job templates** + +The following ``list-job-templates`` example lists all system job templates. :: + + aws mediaconvert list-job-templates \ + --endpoint-url https://abcd1234.mediaconvert.us-east-1.amazonaws.com \ + --list-by SYSTEM + +Output:: + + { + "JobTemplates": [ + { + "CreatedAt": 1568321779, + "Arn": "arn:aws:mediaconvert:us-east-1:123456789012:jobTemplates/System-Generic_Mp4_Hev1_Avc_Aac_Sdr_Qvbr", + "Name": "System-Generic_Mp4_Hev1_Avc_Aac_Sdr_Qvbr", + "Description": "GENERIC, MP4, AVC + HEV1(HEVC,SDR), AAC, SDR, QVBR", + "Category": "GENERIC", + "Settings": { + "AdAvailOffset": 0, + "OutputGroups": [ + { + "Outputs": [ + { + "Extension": "mp4", + "Preset": "System-Generic_Hd_Mp4_Avc_Aac_16x9_Sdr_1280x720p_30Hz_5Mbps_Qvbr_Vq9", + "NameModifier": "_Generic_Hd_Mp4_Avc_Aac_16x9_Sdr_1280x720p_30Hz_5000Kbps_Qvbr_Vq9" + }, + { + "Extension": "mp4", + "Preset": "System-Generic_Hd_Mp4_Avc_Aac_16x9_Sdr_1920x1080p_30Hz_10Mbps_Qvbr_Vq9", + "NameModifier": "_Generic_Hd_Mp4_Avc_Aac_16x9_Sdr_1920x1080p_30Hz_10000Kbps_Qvbr_Vq9" + }, + { + "Extension": "mp4", + "Preset": "System-Generic_Sd_Mp4_Avc_Aac_16x9_Sdr_640x360p_30Hz_0.8Mbps_Qvbr_Vq7", + "NameModifier": "_Generic_Sd_Mp4_Avc_Aac_16x9_Sdr_640x360p_30Hz_800Kbps_Qvbr_Vq7" + }, + { + "Extension": "mp4", + "Preset": "System-Generic_Hd_Mp4_Hev1_Aac_16x9_Sdr_1280x720p_30Hz_4Mbps_Qvbr_Vq9", + "NameModifier": "_Generic_Hd_Mp4_Hev1_Aac_16x9_Sdr_1280x720p_30Hz_4000Kbps_Qvbr_Vq9" + }, + { + "Extension": "mp4", + "Preset": "System-Generic_Hd_Mp4_Hev1_Aac_16x9_Sdr_1920x1080p_30Hz_8Mbps_Qvbr_Vq9", + "NameModifier": "_Generic_Hd_Mp4_Hev1_Aac_16x9_Sdr_1920x1080p_30Hz_8000Kbps_Qvbr_Vq9" + }, + { + "Extension": "mp4", + "Preset": "System-Generic_Uhd_Mp4_Hev1_Aac_16x9_Sdr_3840x2160p_30Hz_12Mbps_Qvbr_Vq9", + "NameModifier": "_Generic_Uhd_Mp4_Hev1_Aac_16x9_Sdr_3840x2160p_30Hz_12000Kbps_Qvbr_Vq9" + } + ], + "OutputGroupSettings": { + "FileGroupSettings": { + + }, + "Type": "FILE_GROUP_SETTINGS" + }, + "Name": "File Group" + } + ] + }, + "Type": "SYSTEM", + "LastUpdated": 1568321779 + }, + ...... + ] + } + +For more information, see `Working with AWS Elemental MediaConvert Job Templates `__ in the *AWS Elemental MediaConvert User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediaconvert/list-presets.rst awscli-1.18.69/awscli/examples/mediaconvert/list-presets.rst --- awscli-1.11.13/awscli/examples/mediaconvert/list-presets.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconvert/list-presets.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,79 @@ +**Example 1: To list your custom output presets** + +The following ``list-presets`` example lists your custom output presets. To list the system presets, see the next example. :: + + aws mediaconvert list-presets \ + --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com + +Output:: + + { + "Presets": [ + { + "Name": "SimpleMP4", + "CreatedAt": 1568841521, + "Settings": { + ...... + }, + "Arn": "arn:aws:mediaconvert:us-east-1:003235472598:presets/SimpleMP4", + "Type": "CUSTOM", + "LastUpdated": 1568843141, + "Description": "Creates basic MP4 file. No filtering or preproccessing." + }, + { + "Name": "SimpleTS", + "CreatedAt": 1568843113, + "Settings": { + ... truncated for brevity ... + }, + "Arn": "arn:aws:mediaconvert:us-east-1:003235472598:presets/SimpleTS", + "Type": "CUSTOM", + "LastUpdated": 1568843113, + "Description": "Create a basic transport stream." + } + ] + } + +**Example 2: To list the system output presets** + +The following ``list-presets`` example lists the available MediaConvert system presets. To list your custom presets, see the previous example. :: + + aws mediaconvert list-presets \ + --list-by SYSTEM \ + --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com + +Output:: + + { + "Presets": [ + { + "Arn": "arn:aws:mediaconvert:us-west-2:123456789012:presets/System-Avc_16x9_1080p_29_97fps_8500kbps", + "Name": "System-Avc_16x9_1080p_29_97fps_8500kbps", + "CreatedAt": 1568321789, + "Description": "Wifi, 1920x1080, 16:9, 29.97fps, 8500kbps", + "LastUpdated": 1568321789, + "Type": "SYSTEM", + "Category": "HLS", + "Settings": { + ...... + } + }, + + ...... + + { + "Arn": "arn:aws:mediaconvert:us-east-1:123456789012:presets/System-Xdcam_HD_1080i_29_97fps_35mpbs", + "Name": "System-Xdcam_HD_1080i_29_97fps_35mpbs", + "CreatedAt": 1568321790, + "Description": "XDCAM MPEG HD, 1920x1080i, 29.97fps, 35mbps", + "LastUpdated": 1568321790, + "Type": "SYSTEM", + "Category": "MXF", + "Settings": { + ...... + } + } + ] + } + +For more information, see `Working with AWS Elemental MediaConvert Output Presets `__ in the *AWS Elemental MediaConvert User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediaconvert/list-queues.rst awscli-1.18.69/awscli/examples/mediaconvert/list-queues.rst --- awscli-1.11.13/awscli/examples/mediaconvert/list-queues.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconvert/list-queues.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,58 @@ +**To list your queues** + +The following ``list-queues`` example lists all of your MediaConvert queues. :: + + aws mediaconvert list-queues \ + --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com + + +Output:: + + { + "Queues": [ + { + "PricingPlan": "ON_DEMAND", + "Type": "SYSTEM", + "Status": "ACTIVE", + "CreatedAt": 1503451595, + "Name": "Default", + "SubmittedJobsCount": 0, + "ProgressingJobsCount": 0, + "Arn": "arn:aws:mediaconvert:us-west-2:123456789012:queues/Default", + "LastUpdated": 1534549158 + }, + { + "PricingPlan": "ON_DEMAND", + "Type": "CUSTOM", + "Status": "ACTIVE", + "CreatedAt": 1537460025, + "Name": "Customer1", + "SubmittedJobsCount": 0, + "Description": "Jobs we run for our cusotmer.", + "ProgressingJobsCount": 0, + "Arn": "arn:aws:mediaconvert:us-west-2:123456789012:queues/Customer1", + "LastUpdated": 1537460025 + }, + { + "ProgressingJobsCount": 0, + "Status": "ACTIVE", + "Name": "transcode-library", + "SubmittedJobsCount": 0, + "LastUpdated": 1564066204, + "ReservationPlan": { + "Status": "ACTIVE", + "ReservedSlots": 1, + "PurchasedAt": 1564066203, + "Commitment": "ONE_YEAR", + "ExpiresAt": 1595688603, + "RenewalType": "EXPIRE" + }, + "PricingPlan": "RESERVED", + "Arn": "arn:aws:mediaconvert:us-west-2:123456789012:queues/transcode-library", + "Type": "CUSTOM", + "CreatedAt": 1564066204 + } + ] + } + +For more information, see `Working with AWS Elemental MediaConvert Queues `__ in the *AWS Elemental MediaConvert User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediaconvert/list-tags-for-resource.rst awscli-1.18.69/awscli/examples/mediaconvert/list-tags-for-resource.rst --- awscli-1.11.13/awscli/examples/mediaconvert/list-tags-for-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconvert/list-tags-for-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,20 @@ +**To list the tags on a MediaConvert queue, job template, or output preset** + +The following ``list-tags-for-resource`` example lists the tags on the specified output preset. :: + + aws mediaconvert list-tags-for-resource \ + --arn arn:aws:mediaconvert:us-west-2:123456789012:presets/SimpleMP4 \ + --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com + +Output:: + + { + "ResourceTags": { + "Tags": { + "customer": "zippyVideo" + }, + "Arn": "arn:aws:mediaconvert:us-west-2:123456789012:presets/SimpleMP4" + } + } + +For more information, see `Tagging AWS Elemental MediaConvert Queues, Job Templates, and Output Presets `__ in the *AWS Elemental MediaConvert User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediaconvert/update-job-template.rst awscli-1.18.69/awscli/examples/mediaconvert/update-job-template.rst --- awscli-1.11.13/awscli/examples/mediaconvert/update-job-template.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconvert/update-job-template.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,113 @@ +**To change a job template** + +The following ``update-job-template`` example replaces the JSON definition of the specified custom job template with the JSON definition in the provided file. + + aws mediaconvert update-job-template \ + --name File1 \ + --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com \ + --cli-input-json file://~/job-template-update.json + +Contents of ``job-template-update.json``:: + + { + "Description": "A simple job template that generates a single file output.", + "Queue": "arn:aws:mediaconvert:us-east-1:012345678998:queues/Default", + "Name": "SimpleFile", + "Settings": { + "OutputGroups": [ + { + "Name": "File Group", + "Outputs": [ + { + "ContainerSettings": { + "Container": "MP4", + "Mp4Settings": { + "CslgAtom": "INCLUDE", + "FreeSpaceBox": "EXCLUDE", + "MoovPlacement": "PROGRESSIVE_DOWNLOAD" + } + }, + "VideoDescription": { + "ScalingBehavior": "DEFAULT", + "TimecodeInsertion": "DISABLED", + "AntiAlias": "ENABLED", + "Sharpness": 50, + "CodecSettings": { + "Codec": "H_264", + "H264Settings": { + "InterlaceMode": "PROGRESSIVE", + "NumberReferenceFrames": 3, + "Syntax": "DEFAULT", + "Softness": 0, + "GopClosedCadence": 1, + "GopSize": 90, + "Slices": 1, + "GopBReference": "DISABLED", + "SlowPal": "DISABLED", + "SpatialAdaptiveQuantization": "ENABLED", + "TemporalAdaptiveQuantization": "ENABLED", + "FlickerAdaptiveQuantization": "DISABLED", + "EntropyEncoding": "CABAC", + "Bitrate": 400000, + "FramerateControl": "INITIALIZE_FROM_SOURCE", + "RateControlMode": "CBR", + "CodecProfile": "MAIN", + "Telecine": "NONE", + "MinIInterval": 0, + "AdaptiveQuantization": "HIGH", + "CodecLevel": "AUTO", + "FieldEncoding": "PAFF", + "SceneChangeDetect": "ENABLED", + "QualityTuningLevel": "SINGLE_PASS", + "FramerateConversionAlgorithm": "DUPLICATE_DROP", + "UnregisteredSeiTimecode": "DISABLED", + "GopSizeUnits": "FRAMES", + "ParControl": "INITIALIZE_FROM_SOURCE", + "NumberBFramesBetweenReferenceFrames": 2, + "RepeatPps": "DISABLED", + "DynamicSubGop": "STATIC" + } + }, + "AfdSignaling": "NONE", + "DropFrameTimecode": "ENABLED", + "RespondToAfd": "NONE", + "ColorMetadata": "INSERT" + }, + "AudioDescriptions": [ + { + "AudioTypeControl": "FOLLOW_INPUT", + "CodecSettings": { + "Codec": "AAC", + "AacSettings": { + "AudioDescriptionBroadcasterMix": "NORMAL", + "Bitrate": 96000, + "RateControlMode": "CBR", + "CodecProfile": "LC", + "CodingMode": "CODING_MODE_2_0", + "RawFormat": "NONE", + "SampleRate": 48000, + "Specification": "MPEG4" + } + }, + "LanguageCodeControl": "FOLLOW_INPUT" + } + ] + } + ], + "OutputGroupSettings": { + "Type": "FILE_GROUP_SETTINGS", + "FileGroupSettings": {} + } + } + ], + "AdAvailOffset": 0 + }, + "StatusUpdateInterval": "SECONDS_60", + "Priority": 0 + } + +The system returns the JSON payload that you send with your request, even when the request results in an error. Therefore, the JSON returned is not necessarily the new definition of the job template. + +Because the JSON payload can be long, you might need to scroll up to see any error messages. + +For more information, see `Working with AWS Elemental MediaConvert Job Templates `__ in the *AWS Elemental MediaConvert User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediaconvert/update-preset.rst awscli-1.18.69/awscli/examples/mediaconvert/update-preset.rst --- awscli-1.11.13/awscli/examples/mediaconvert/update-preset.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconvert/update-preset.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,28 @@ +**To change a preset** + +The following ``update-preset`` example replaces the description for the specified preset. + :: + + aws mediaconvert update-preset \ + --name Customer1 \ + --description "New description text." + --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com + +This command produces no output. +Output:: + + { + "Preset": { + "Arn": "arn:aws:mediaconvert:us-east-1:003235472598:presets/SimpleMP4", + "Settings": { + ...... + }, + "Type": "CUSTOM", + "LastUpdated": 1568938411, + "Description": "New description text.", + "Name": "SimpleMP4", + "CreatedAt": 1568938240 + } + } + +For more information, see `Working with AWS Elemental MediaConvert Output Presets `__ in the *AWS Elemental MediaConvert User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediaconvert/update-queue.rst awscli-1.18.69/awscli/examples/mediaconvert/update-queue.rst --- awscli-1.11.13/awscli/examples/mediaconvert/update-queue.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediaconvert/update-queue.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,26 @@ +**To change a queue** + +The following ``update-queue`` example pauses the specified queue, by changing its status to ``PAUSED``. :: + + aws mediaconvert update-queue \ + --name Customer1 \ + --status PAUSED + --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com + +Output:: + + { + "Queue": { + "LastUpdated": 1568839845, + "Status": "PAUSED", + "ProgressingJobsCount": 0, + "CreatedAt": 1526428516, + "Arn": "arn:aws:mediaconvert:us-west-1:123456789012:queues/Customer1", + "Name": "Customer1", + "SubmittedJobsCount": 0, + "PricingPlan": "ON_DEMAND", + "Type": "CUSTOM" + } + } + +For more information, see `Working with AWS Elemental MediaConvert Queues `__ in the *AWS Elemental MediaConvert User Guide*. diff -Nru awscli-1.11.13/awscli/examples/medialive/create-channel.rst awscli-1.18.69/awscli/examples/medialive/create-channel.rst --- awscli-1.11.13/awscli/examples/medialive/create-channel.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/medialive/create-channel.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,164 @@ +**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.11.13/awscli/examples/medialive/create-input.rst awscli-1.18.69/awscli/examples/medialive/create-input.rst --- awscli-1.11.13/awscli/examples/medialive/create-input.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/medialive/create-input.rst 2020-05-28 19:25:50.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-input \ + --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.11.13/awscli/examples/mediapackage/create-channel.rst awscli-1.18.69/awscli/examples/mediapackage/create-channel.rst --- awscli-1.11.13/awscli/examples/mediapackage/create-channel.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediapackage/create-channel.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,33 @@ +**To create a channel** + +The following ``create-channel`` command creates a channel named ``sportschannel`` in the current account. :: + + aws mediapackage create-channel --id sportschannel + +Output:: + + { + "Arn": "arn:aws:mediapackage:us-west-2:111222333:channels/6d345804ec3f46c9b454a91d4a80d0e0", + "HlsIngest": { + "IngestEndpoints": [ + { + "Id": "6d345804ec3f46c9b454a91d4a80d0e0", + "Password": "generatedwebdavpassword1", + "Url": "https://f31c86aed53b815a.mediapackage.us-west-2.amazonaws.com/in/v2/6d345804ec3f46c9b454a91d4a80d0e0/6d345804ec3f46c9b454a91d4a80d0e0/channel", + "Username": "generatedwebdavusername1" + }, + { + "Id": "2daa32878af24803b24183727211b8ff", + "Password": "generatedwebdavpassword2", + "Url": "https://6ebbe7e04c4b0afa.mediapackage.us-west-2.amazonaws.com/in/v2/6d345804ec3f46c9b454a91d4a80d0e0/2daa32878af24803b24183727211b8ff/channel", + "Username": "generatedwebdavusername2" + } + ] + }, + "Id": "sportschannel", + "Tags": { + "region": "west" + } + } + +For more information, see `Creating a Channel `__ in the *AWS Elemental MediaPackage User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediapackage/create-origin-endpoint.rst awscli-1.18.69/awscli/examples/mediapackage/create-origin-endpoint.rst --- awscli-1.11.13/awscli/examples/mediapackage/create-origin-endpoint.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediapackage/create-origin-endpoint.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,49 @@ +**To create an origin endpoint** + +The following ``create-origin-endpoint`` command creates an origin endpoint named ``cmafsports`` with the package settings provided in a JSON file and specified endpoint settings. :: + + aws mediapackage create-origin-endpoint \ + --channel-id sportschannel \ + --id cmafsports \ + --cmaf-package file://file/path/cmafpkg.json --description "cmaf output of sports" \ + --id cmaf_sports \ + --manifest-name sports_channel \ + --startover-window-seconds 300 \ + --tags region=west,media=sports \ + --time-delay-seconds 10 + +Output:: + + { + "Arn": "arn:aws:mediapackage:us-west-2:111222333:origin_endpoints/1dc6718be36f4f34bb9cd86bc50925e6", + "ChannelId": "sportschannel", + "CmafPackage": { + "HlsManifests": [ + { + "AdMarkers": "PASSTHROUGH", + "Id": "cmaf_sports_endpoint", + "IncludeIframeOnlyStream": true, + "ManifestName": "index", + "PlaylistType": "EVENT", + "PlaylistWindowSeconds": 300, + "ProgramDateTimeIntervalSeconds": 300, + "Url": "https://c4af3793bf76b33c.mediapackage.us-west-2.amazonaws.com/out/v1/1dc6718be36f4f34bb9cd86bc50925e6/cmaf_sports_endpoint/index.m3u8" + } + ], + "SegmentDurationSeconds": 2, + "SegmentPrefix": "sportschannel" + }, + "Description": "cmaf output of sports", + "Id": "cmaf_sports", + "ManifestName": "sports_channel", + "StartoverWindowSeconds": 300, + "Tags": { + "region": "west", + "media": "sports" + }, + "TimeDelaySeconds": 10, + "Url": "", + "Whitelist": [] + } + +For more information, see `Creating an Endpoint `__ in the *AWS Elemental MediaPackage User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediapackage/delete-channel.rst awscli-1.18.69/awscli/examples/mediapackage/delete-channel.rst --- awscli-1.11.13/awscli/examples/mediapackage/delete-channel.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediapackage/delete-channel.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a channel** + +The following ``delete-channel`` command deletes the channel named ``test``. :: + + aws mediapackage delete-channel \ + --id test + +This command produces no output. + +For more information, see `Deleting a Channel `__ in the *AWS Elemental MediaPackage User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediapackage/delete-origin-endpoint.rst awscli-1.18.69/awscli/examples/mediapackage/delete-origin-endpoint.rst --- awscli-1.11.13/awscli/examples/mediapackage/delete-origin-endpoint.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediapackage/delete-origin-endpoint.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,8 @@ +**To delete an origin endpoint** + +The following ``delete-origin-endpoint`` command deletes the origin endpoint named ``tester2``. :: + + aws mediapackage delete-origin-endpoint \ + --id tester2 + +For more information, see `Deleting an Endpoint `__ in the *AWS Elemental MediaPackage User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediapackage/describe-channel.rst awscli-1.18.69/awscli/examples/mediapackage/describe-channel.rst --- awscli-1.11.13/awscli/examples/mediapackage/describe-channel.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediapackage/describe-channel.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,32 @@ +**To describe a channel** + +The following ``describe-channel`` command displays all of the details of the channel named ``test``. :: + + aws mediapackage describe-channel \ + --id test + +Output:: + + { + "Arn": "arn:aws:mediapackage:us-west-2:111222333:channels/584797f1740548c389a273585dd22a63", + "HlsIngest": { + "IngestEndpoints": [ + { + "Id": "584797f1740548c389a273585dd22a63", + "Password": "webdavgeneratedpassword1", + "Url": "https://9be9c4405c474882.mediapackage.us-west-2.amazonaws.com/in/v2/584797f1740548c389a273585dd22a63/584797f1740548c389a273585dd22a63/channel", + "Username": "webdavgeneratedusername1" + }, + { + "Id": "7d187c8616fd455f88aaa5a9fcf74442", + "Password": "webdavgeneratedpassword2", + "Url": "https://7bf454c57220328d.mediapackage.us-west-2.amazonaws.com/in/v2/584797f1740548c389a273585dd22a63/7d187c8616fd455f88aaa5a9fcf74442/channel", + "Username": "webdavgeneratedusername2" + } + ] + }, + "Id": "test", + "Tags": {} + } + +For more information, see `Viewing Channel Details`__ in the *AWS Elemental MediaPackage User Guide* diff -Nru awscli-1.11.13/awscli/examples/mediapackage/describe-origin-endpoint.rst awscli-1.18.69/awscli/examples/mediapackage/describe-origin-endpoint.rst --- awscli-1.11.13/awscli/examples/mediapackage/describe-origin-endpoint.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediapackage/describe-origin-endpoint.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,40 @@ +**To describe an origin endpoint** + +The following ``describe-origin-endpoint`` command displays all of the details of the origin endpoint named ``cmaf_sports``. :: + + aws mediapackage describe-origin-endpoint \ + --id cmaf_sports + +Output:: + + { + "Arn": "arn:aws:mediapackage:us-west-2:111222333:origin_endpoints/1dc6718be36f4f34bb9cd86bc50925e6", + "ChannelId": "sportschannel", + "CmafPackage": { + "HlsManifests": [ + { + "AdMarkers": "NONE", + "Id": "cmaf_sports_endpoint", + "IncludeIframeOnlyStream": false, + "PlaylistType": "EVENT", + "PlaylistWindowSeconds": 60, + "ProgramDateTimeIntervalSeconds": 0, + "Url": "https://c4af3793bf76b33c.mediapackage.us-west-2.amazonaws.com/out/v1/1dc6718be36f4f34bb9cd86bc50925e6/cmaf_sports_endpoint/index.m3u8" + } + ], + "SegmentDurationSeconds": 2, + "SegmentPrefix": "sportschannel" + }, + "Id": "cmaf_sports", + "ManifestName": "index", + "StartoverWindowSeconds": 0, + "Tags": { + "region": "west", + "media": "sports" + }, + "TimeDelaySeconds": 0, + "Url": "", + "Whitelist": [] + } + +For more information, see `Viewing a Single Endpoint `__ in the *AWS Elemental MediaPackage User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediapackage/list-channels.rst awscli-1.18.69/awscli/examples/mediapackage/list-channels.rst --- awscli-1.11.13/awscli/examples/mediapackage/list-channels.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediapackage/list-channels.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,35 @@ +**To list all channels** + +The following ``list-channels`` command lists all of the channels that are configured on the current AWS account. :: + + aws mediapackage list-channels + +Output:: + + { + "Channels": [ + { + "Arn": "arn:aws:mediapackage:us-west-2:111222333:channels/584797f1740548c389a273585dd22a63", + "HlsIngest": { + "IngestEndpoints": [ + { + "Id": "584797f1740548c389a273585dd22a63", + "Password": "webdavgeneratedpassword1", + "Url": "https://9be9c4405c474882.mediapackage.us-west-2.amazonaws.com/in/v2/584797f1740548c389a273585dd22a63/584797f1740548c389a273585dd22a63/channel", + "Username": "webdavgeneratedusername1" + }, + { + "Id": "7d187c8616fd455f88aaa5a9fcf74442", + "Password": "webdavgeneratedpassword2", + "Url": "https://7bf454c57220328d.mediapackage.us-west-2.amazonaws.com/in/v2/584797f1740548c389a273585dd22a63/7d187c8616fd455f88aaa5a9fcf74442/channel", + "Username": "webdavgeneratedusername2" + } + ] + }, + "Id": "test", + "Tags": {} + } + ] + } + +For more information, see `Viewing Channel Details `__ in the *AWS Elemental MediaPackage User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediapackage/list-origin-endpoints.rst awscli-1.18.69/awscli/examples/mediapackage/list-origin-endpoints.rst --- awscli-1.11.13/awscli/examples/mediapackage/list-origin-endpoints.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediapackage/list-origin-endpoints.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,67 @@ +**To list all origin-endpoints on a channel** + +The following ``list-origin-endpoints`` command lists all of the origin endpoints that are configured on the channel named ``test``. :: + + aws mediapackage list-origin-endpoints \ + --channel-id test + +Output:: + + { + "OriginEndpoints": [ + { + "Arn": "arn:aws:mediapackage:us-west-2:111222333:origin_endpoints/247cff871f2845d3805129be22f2c0a2", + "ChannelId": "test", + "DashPackage": { + "ManifestLayout": "FULL", + "ManifestWindowSeconds": 60, + "MinBufferTimeSeconds": 30, + "MinUpdatePeriodSeconds": 15, + "PeriodTriggers": [], + "Profile": "NONE", + "SegmentDurationSeconds": 2, + "SegmentTemplateFormat": "NUMBER_WITH_TIMELINE", + "StreamSelection": { + "MaxVideoBitsPerSecond": 2147483647, + "MinVideoBitsPerSecond": 0, + "StreamOrder": "ORIGINAL" + }, + "SuggestedPresentationDelaySeconds": 25 + }, + "Id": "tester2", + "ManifestName": "index", + "StartoverWindowSeconds": 0, + "Tags": {}, + "TimeDelaySeconds": 0, + "Url": "https://8343f7014c0ea438.mediapackage.us-west-2.amazonaws.com/out/v1/247cff871f2845d3805129be22f2c0a2/index.mpd", + "Whitelist": [] + }, + { + "Arn": "arn:aws:mediapackage:us-west-2:111222333:origin_endpoints/869e237f851549e9bcf10e3bc2830839", + "ChannelId": "test", + "HlsPackage": { + "AdMarkers": "NONE", + "IncludeIframeOnlyStream": false, + "PlaylistType": "EVENT", + "PlaylistWindowSeconds": 60, + "ProgramDateTimeIntervalSeconds": 0, + "SegmentDurationSeconds": 6, + "StreamSelection": { + "MaxVideoBitsPerSecond": 2147483647, + "MinVideoBitsPerSecond": 0, + "StreamOrder": "ORIGINAL" + }, + "UseAudioRenditionGroup": false + }, + "Id": "tester", + "ManifestName": "index", + "StartoverWindowSeconds": 0, + "Tags": {}, + "TimeDelaySeconds": 0, + "Url": "https://8343f7014c0ea438.mediapackage.us-west-2.amazonaws.com/out/v1/869e237f851549e9bcf10e3bc2830839/index.m3u8", + "Whitelist": [] + } + ] + } + +For more information, see `Viewing all Endpoints Associated with a Channel `__ in the *AWS Elemental MediaPackage User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediapackage/list-tags-for-resource.rst awscli-1.18.69/awscli/examples/mediapackage/list-tags-for-resource.rst --- awscli-1.11.13/awscli/examples/mediapackage/list-tags-for-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediapackage/list-tags-for-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,16 @@ +**To list the tags assigned to a resource** + +The following ``list-tags-for-resource`` command lists the tags that are assigned to the specified resource. :: + + aws mediapackage list-tags-for-resource \ + --resource-arn arn:aws:mediapackage:us-west-2:111222333:channels/6d345804ec3f46c9b454a91d4a80d0e0 + +Output:: + + { + "Tags": { + "region": "west" + } + } + +For more information, see `Tagging Resources in AWS Elemental MediaPackage `__ in the *AWS Elemental MediaPackage User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediapackage/rotate-ingest-endpoint-credentials.rst awscli-1.18.69/awscli/examples/mediapackage/rotate-ingest-endpoint-credentials.rst --- awscli-1.11.13/awscli/examples/mediapackage/rotate-ingest-endpoint-credentials.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediapackage/rotate-ingest-endpoint-credentials.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,33 @@ +**To rotate ingest credentials** + +The following ``rotate-ingest-endpoint-credentials`` command rotates the WebDAV username and password for the specified ingest endpoint. :: + + aws mediapackage rotate-ingest-endpoint-credentials \ + --id test \ + --ingest-endpoint-id 584797f1740548c389a273585dd22a63 + +Output:: + + { + "Arn": "arn:aws:mediapackage:us-west-2:111222333:channels/584797f1740548c389a273585dd22a63", + "HlsIngest": { + "IngestEndpoints": [ + { + "Id": "584797f1740548c389a273585dd22a63", + "Password": "webdavregeneratedpassword1", + "Url": "https://9be9c4405c474882.mediapackage.us-west-2.amazonaws.com/in/v2/584797f1740548c389a273585dd22a63/584797f1740548c389a273585dd22a63/channel", + "Username": "webdavregeneratedusername1" + }, + { + "Id": "7d187c8616fd455f88aaa5a9fcf74442", + "Password": "webdavgeneratedpassword2", + "Url": "https://7bf454c57220328d.mediapackage.us-west-2.amazonaws.com/in/v2/584797f1740548c389a273585dd22a63/7d187c8616fd455f88aaa5a9fcf74442/channel", + "Username": "webdavgeneratedusername2" + } + ] + }, + "Id": "test", + "Tags": {} + } + +For more information, see `Rotating Credentials on an Input URL `__ in the *AWS Elemental MediaPackage User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediapackage/tag-resource.rst awscli-1.18.69/awscli/examples/mediapackage/tag-resource.rst --- awscli-1.11.13/awscli/examples/mediapackage/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediapackage/tag-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To add a tag to a resource** + +The following ``tag-resource`` commands adds a ``region=west`` key and value pair to the specified resource. :: + + aws mediapackage tag-resource \ + --resource-arn arn:aws:mediapackage:us-west-2:111222333:channels/6d345804ec3f46c9b454a91d4a80d0e0 \ + --tags region=west + +This command produces no output. + +For more information, see `Tagging Resources in AWS Elemental MediaPackage `__ in the *AWS Elemental MediaPackage User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediapackage/untag-resource.rst awscli-1.18.69/awscli/examples/mediapackage/untag-resource.rst --- awscli-1.11.13/awscli/examples/mediapackage/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediapackage/untag-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,9 @@ +**To remove a tag from a resource** + +The following ``untag-resource`` command removes the tag with the key ``region`` from the specified channel. :: + + aws mediapackage untag-resource \ + --resource-arn arn:aws:mediapackage:us-west-2:111222333:channels/6d345804ec3f46c9b454a91d4a80d0e0 \ + --tag-keys region + +For more information, see `Tagging Resources in AWS Elemental MediaPackage `__ in the *AWS Elemental MediaPackage User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediapackage/update-channel.rst awscli-1.18.69/awscli/examples/mediapackage/update-channel.rst --- awscli-1.11.13/awscli/examples/mediapackage/update-channel.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediapackage/update-channel.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,34 @@ +**To update a channel** + +The following ``update-channel`` command updates the channel named ``sportschannel`` to include the description ``24x7 sports``. :: + + aws mediapackage update-channel \ + --id sportschannel \ + --description "24x7 sports" + +Output:: + + { + "Arn": "arn:aws:mediapackage:us-west-2:111222333:channels/6d345804ec3f46c9b454a91d4a80d0e0", + "Description": "24x7 sports", + "HlsIngest": { + "IngestEndpoints": [ + { + "Id": "6d345804ec3f46c9b454a91d4a80d0e0", + "Password": "generatedwebdavpassword1", + "Url": "https://f31c86aed53b815a.mediapackage.us-west-2.amazonaws.com/in/v2/6d345804ec3f46c9b454a91d4a80d0e0/6d345804ec3f46c9b454a91d4a80d0e0/channel", + "Username": "generatedwebdavusername1" + }, + { + "Id": "2daa32878af24803b24183727211b8ff", + "Password": "generatedwebdavpassword2", + "Url": "https://6ebbe7e04c4b0afa.mediapackage.us-west-2.amazonaws.com/in/v2/6d345804ec3f46c9b454a91d4a80d0e0/2daa32878af24803b24183727211b8ff/channel", + "Username": "generatedwebdavusername2" + } + ] + }, + "Id": "sportschannel", + "Tags": {} + } + +For more information, see `Editing a Channel `__ in the *AWS Elemental MediaPackage User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediapackage/update-origin-endpoint.rst awscli-1.18.69/awscli/examples/mediapackage/update-origin-endpoint.rst --- awscli-1.11.13/awscli/examples/mediapackage/update-origin-endpoint.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediapackage/update-origin-endpoint.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,41 @@ +**To update an origin endpoint** + +The following ``update-origin-endpoint`` command updates the origin endpoint named ``cmaf_sports``. It changes the time delay to ``0`` seconds. :: + + aws mediapackage update-origin-endpoint \ + --id cmaf_sports \ + --time-delay-seconds 0 + +Output:: + + { + "Arn": "arn:aws:mediapackage:us-west-2:111222333:origin_endpoints/1dc6718be36f4f34bb9cd86bc50925e6", + "ChannelId": "sportschannel", + "CmafPackage": { + "HlsManifests": [ + { + "AdMarkers": "NONE", + "Id": "cmaf_sports_endpoint", + "IncludeIframeOnlyStream": false, + "PlaylistType": "EVENT", + "PlaylistWindowSeconds": 60, + "ProgramDateTimeIntervalSeconds": 0, + "Url": "https://c4af3793bf76b33c.mediapackage.us-west-2.amazonaws.com/out/v1/1dc6718be36f4f34bb9cd86bc50925e6/cmaf_sports_endpoint/index.m3u8" + } + ], + "SegmentDurationSeconds": 2, + "SegmentPrefix": "sportschannel" + }, + "Id": "cmaf_sports", + "ManifestName": "index", + "StartoverWindowSeconds": 0, + "Tags": { + "region": "west", + "media": "sports" + }, + "TimeDelaySeconds": 0, + "Url": "", + "Whitelist": [] + } + +For more information, see `Editing an Endpoint `__ in the *AWS Elemental MediaPackage User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediapackage-vod/create-asset.rst awscli-1.18.69/awscli/examples/mediapackage-vod/create-asset.rst --- awscli-1.11.13/awscli/examples/mediapackage-vod/create-asset.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediapackage-vod/create-asset.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/mediapackage-vod/create-packaging-configuration.rst awscli-1.18.69/awscli/examples/mediapackage-vod/create-packaging-configuration.rst --- awscli-1.11.13/awscli/examples/mediapackage-vod/create-packaging-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediapackage-vod/create-packaging-configuration.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/mediapackage-vod/create-packaging-group.rst awscli-1.18.69/awscli/examples/mediapackage-vod/create-packaging-group.rst --- awscli-1.11.13/awscli/examples/mediapackage-vod/create-packaging-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediapackage-vod/create-packaging-group.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/mediapackage-vod/delete-asset.rst awscli-1.18.69/awscli/examples/mediapackage-vod/delete-asset.rst --- awscli-1.11.13/awscli/examples/mediapackage-vod/delete-asset.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediapackage-vod/delete-asset.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/mediapackage-vod/delete-packaging-configuration.rst awscli-1.18.69/awscli/examples/mediapackage-vod/delete-packaging-configuration.rst --- awscli-1.11.13/awscli/examples/mediapackage-vod/delete-packaging-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediapackage-vod/delete-packaging-configuration.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/mediapackage-vod/delete-packaging-group.rst awscli-1.18.69/awscli/examples/mediapackage-vod/delete-packaging-group.rst --- awscli-1.11.13/awscli/examples/mediapackage-vod/delete-packaging-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediapackage-vod/delete-packaging-group.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/mediapackage-vod/describe-asset.rst awscli-1.18.69/awscli/examples/mediapackage-vod/describe-asset.rst --- awscli-1.11.13/awscli/examples/mediapackage-vod/describe-asset.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediapackage-vod/describe-asset.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/mediapackage-vod/describe-packaging-configuration.rst awscli-1.18.69/awscli/examples/mediapackage-vod/describe-packaging-configuration.rst --- awscli-1.11.13/awscli/examples/mediapackage-vod/describe-packaging-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediapackage-vod/describe-packaging-configuration.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/mediapackage-vod/describe-packaging-group.rst awscli-1.18.69/awscli/examples/mediapackage-vod/describe-packaging-group.rst --- awscli-1.11.13/awscli/examples/mediapackage-vod/describe-packaging-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediapackage-vod/describe-packaging-group.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/mediapackage-vod/list-assets.rst awscli-1.18.69/awscli/examples/mediapackage-vod/list-assets.rst --- awscli-1.11.13/awscli/examples/mediapackage-vod/list-assets.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediapackage-vod/list-assets.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/mediapackage-vod/list-packaging-configurations.rst awscli-1.18.69/awscli/examples/mediapackage-vod/list-packaging-configurations.rst --- awscli-1.11.13/awscli/examples/mediapackage-vod/list-packaging-configurations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediapackage-vod/list-packaging-configurations.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/mediapackage-vod/list-packaging-groups.rst awscli-1.18.69/awscli/examples/mediapackage-vod/list-packaging-groups.rst --- awscli-1.11.13/awscli/examples/mediapackage-vod/list-packaging-groups.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediapackage-vod/list-packaging-groups.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/mediastore/create-container.rst awscli-1.18.69/awscli/examples/mediastore/create-container.rst --- awscli-1.11.13/awscli/examples/mediastore/create-container.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediastore/create-container.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,19 @@ +**To create a container** + +The following ``create-container`` example creates a new, empty container. :: + + aws mediastore create-container --container-name ExampleContainer + +Output:: + + { + "Container": { + "AccessLoggingEnabled": false, + "CreationTime": 1563557265, + "Name": "ExampleContainer", + "Status": "CREATING", + "ARN": "arn:aws:mediastore:us-west-2:111122223333:container/ExampleContainer" + } + } + +For more information, see `Creating a Container `__ in the *AWS Elemental MediaStore User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediastore/delete-container-policy.rst awscli-1.18.69/awscli/examples/mediastore/delete-container-policy.rst --- awscli-1.11.13/awscli/examples/mediastore/delete-container-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediastore/delete-container-policy.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a container policy** + +The following ``delete-container-policy`` example deletes the policy that is assigned to the specified container. When the policy is deleted, AWS Elemental MediaStore automatically assigns the default policy to the container. :: + + aws mediastore delete-container-policy \ + --container-name LiveEvents + +This command produces no output. + +For more information, see `DeleteContainerPolicy `__ in the *AWS Elemental MediaStore API reference*. diff -Nru awscli-1.11.13/awscli/examples/mediastore/delete-container.rst awscli-1.18.69/awscli/examples/mediastore/delete-container.rst --- awscli-1.11.13/awscli/examples/mediastore/delete-container.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediastore/delete-container.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a container** + +The following ``delete-container`` example deletes the specified container. You can delete a container only if it has no objects. :: + + aws mediastore delete-container \ + --container-name=ExampleLiveDemo + +This command produces no output. + +For more information, see `Deleting a Container `__ in the *AWS Elemental MediaStore User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediastore/delete-cors-policy.rst awscli-1.18.69/awscli/examples/mediastore/delete-cors-policy.rst --- awscli-1.11.13/awscli/examples/mediastore/delete-cors-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediastore/delete-cors-policy.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a CORS policy** + +The following ``delete-cors-policy`` example deletes the cross-origin resource sharing (CORS) policy that is assigned to the specified container. :: + + aws mediastore delete-cors-policy \ + --container-name ExampleContainer + +This command produces no output. + +For more information, see `Deleting a CORS Policy `__ in the *AWS Elemental MediaStore User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediastore/delete-lifecycle-policy.rst awscli-1.18.69/awscli/examples/mediastore/delete-lifecycle-policy.rst --- awscli-1.11.13/awscli/examples/mediastore/delete-lifecycle-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediastore/delete-lifecycle-policy.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete an object lifecycle policy** + +The following ``delete-lifecycle-policy`` example deletes the object lifecycle policy attached to the specified container. This change can take up to 20 minutes to take effect. :: + + aws mediastore delete-lifecycle-policy \ + --container-name LiveEvents + +This command produces no output. + +For more information, see `Deleting an Object Lifecycle Policy `__ in the *AWS Elemental MediaStore User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediastore/describe-container.rst awscli-1.18.69/awscli/examples/mediastore/describe-container.rst --- awscli-1.11.13/awscli/examples/mediastore/describe-container.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediastore/describe-container.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,21 @@ +**To view the details of a container** + +The following ``describe-container`` example displays the details of the specified container. :: + + aws mediastore describe-container \ + --container-name ExampleContainer + +Output:: + + { + "Container": { + "CreationTime": 1563558086, + "AccessLoggingEnabled": false, + "ARN": "arn:aws:mediastore:us-west-2:111122223333:container/ExampleContainer", + "Status": "ACTIVE", + "Name": "ExampleContainer", + "Endpoint": "https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com" + } + } + +For more information, see `Viewing the Details for a Container `__ in the *AWS Elemental MediaStore User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediastore/describe-object.rst awscli-1.18.69/awscli/examples/mediastore/describe-object.rst --- awscli-1.11.13/awscli/examples/mediastore/describe-object.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediastore/describe-object.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,18 @@ +**To view a list of objects and folders in a specific container** + +The following ``describe-object`` example displays items (objects and folders) stored in a specific container. :: + + aws mediastore-data describe-object \ + --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ + --path /folder_name/file1234.jpg + +Output:: + + { + "ContentType": "image/jpeg", + "LastModified": "Fri, 19 Jul 2019 21:32:20 GMT", + "ContentLength": "2307346", + "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3" + } + +For more information, see `Viewing the Details of an Object `__ in the *AWS Elemental MediaStore User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediastore/get-container-policy.rst awscli-1.18.69/awscli/examples/mediastore/get-container-policy.rst --- awscli-1.11.13/awscli/examples/mediastore/get-container-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediastore/get-container-policy.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,35 @@ +**To view a container policy** + +The following ``get-container-policy`` example displays the resource-based policy of the specified container. :: + + aws mediastore get-container-policy \ + --container-name ExampleLiveDemo + +Output:: + + { + "Policy": { + "Version": "2012-10-17", + "Statement": [ + { + "Sid": "PublicReadOverHttps", + "Effect": "Allow", + "Principal": { + "AWS": "arn:aws:iam::111122223333:root" + }, + "Action": [ + "mediastore:GetObject", + "mediastore:DescribeObject" + ], + "Resource": "arn:aws:mediastore:us-west-2:111122223333:container/ExampleLiveDemo/", + "Condition": { + "Bool": { + "aws:SecureTransport": "true" + } + } + } + ] + } + } + +For more information, see `Viewing a Container Policy `__ in the *AWS Elemental MediaStore User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediastore/get-cors-policy.rst awscli-1.18.69/awscli/examples/mediastore/get-cors-policy.rst --- awscli-1.11.13/awscli/examples/mediastore/get-cors-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediastore/get-cors-policy.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,29 @@ +**To view a CORS policy** + +The following ``get-cors-policy`` example displays the cross-origin resource sharing (CORS) policy that is assigned to the specified container. :: + + aws mediastore get-cors-policy \ + --container-name ExampleContainer \ + --region us-west-2 + +Output:: + + { + "CorsPolicy": [ + { + "AllowedMethods": [ + "GET", + "HEAD" + ], + "MaxAgeSeconds": 3000, + "AllowedOrigins": [ + "" + ], + "AllowedHeaders": [ + "" + ] + } + ] + } + +For more information, see `Viewing a CORS Policy `__ in the *AWS Elemental MediaStore User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediastore/get-lifecycle-policy.rst awscli-1.18.69/awscli/examples/mediastore/get-lifecycle-policy.rst --- awscli-1.11.13/awscli/examples/mediastore/get-lifecycle-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediastore/get-lifecycle-policy.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,38 @@ +**To view an object lifecycle policy** + +The following ``get-lifecycle-policy`` example displays the object lifecycle policy attached to the specified container. :: + + aws mediastore get-lifecycle-policy \ + --container-name LiveEvents + +Output:: + + { + "LifecyclePolicy": { + "rules": [ + { + "definition": { + "path": [ + { + "prefix": "Football/" + }, + { + "prefix": "Baseball/" + } + ], + "days_since_create": [ + { + "numeric": [ + ">", + 28 + ] + } + ] + }, + "action": "EXPIRE" + } + ] + } + } + +For more information, see `Viewing an Object Lifecycle Policy `__ in the *AWS Elemental MediaStore User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediastore/get-object.rst awscli-1.18.69/awscli/examples/mediastore/get-object.rst --- awscli-1.11.13/awscli/examples/mediastore/get-object.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediastore/get-object.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,39 @@ +**To download an object** + +The following ``get-object`` example download an object to the specified endpoint. :: + + aws mediastore-data get-object \ + --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ + --path=/folder_name/README.md README.md + +Output:: + + { + "ContentLength": "2307346", + "ContentType": "image/jpeg", + "LastModified": "Fri, 19 Jul 2019 21:32:20 GMT", + "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3", + "StatusCode": 200 + } + +**To download part of an object** + +The following ``get-object`` example downloads a portion an object to the specified endpoint. :: + + aws mediastore-data get-object \ + --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ + --path /folder_name/README.md \ + --range="bytes=0-100" README2.md + +Output:: + + { + "StatusCode": 206, + "ContentRange": "bytes 0-100/2307346", + "ContentLength": "101", + "LastModified": "Fri, 19 Jul 2019 21:32:20 GMT", + "ContentType": "image/jpeg", + "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3" + } + +For more information, see `Downloading an Object `__ in the *AWS Elemental MediaStore User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediastore/list-containers.rst awscli-1.18.69/awscli/examples/mediastore/list-containers.rst --- awscli-1.11.13/awscli/examples/mediastore/list-containers.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediastore/list-containers.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,30 @@ +**To view a list of containers** + +The following ``list-containers`` example displays a list of all containers that are associated with your account. :: + + aws mediastore list-containers + +Output:: + + { + "Containers": [ + { + "CreationTime": 1505317931, + "Endpoint": "https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com", + "Status": "ACTIVE", + "ARN": "arn:aws:mediastore:us-west-2:111122223333:container/ExampleLiveDemo", + "AccessLoggingEnabled": false, + "Name": "ExampleLiveDemo" + }, + { + "CreationTime": 1506528818, + "Endpoint": "https://fffggghhhiiijj.data.mediastore.us-west-2.amazonaws.com", + "Status": "ACTIVE", + "ARN": "arn:aws:mediastore:us-west-2:111122223333:container/ExampleContainer", + "AccessLoggingEnabled": false, + "Name": "ExampleContainer" + } + ] + } + +For more information, see `Viewing a List of Containers `__ in the *AWS Elemental MediaStore User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediastore/list-items.rst awscli-1.18.69/awscli/examples/mediastore/list-items.rst --- awscli-1.11.13/awscli/examples/mediastore/list-items.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediastore/list-items.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,53 @@ +**Example 1: To view a list of objects and folders in a specific container** + +The following ``list-items`` example displays items (objects and folders) stored in the specified container. :: + + aws mediastore-data list-items \ + --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com + +Output:: + + { + "Items": [ + { + "ContentType": "image/jpeg", + "LastModified": 1563571859.379, + "Name": "filename.jpg", + "Type": "OBJECT", + "ETag": "543ab21abcd1a234ab123456a1a2b12345ab12abc12a1234abc1a2bc12345a12", + "ContentLength": 3784 + }, + { + "Type": "FOLDER", + "Name": "ExampleLiveDemo" + } + ] + } + +**Example 2: To view a list of objects and folders in a specific folder** + +The following ``list-items`` example displays items (objects and folders) stored in a specific folder. :: + + aws mediastore-data list-items \ + --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com + +Output:: + + { + "Items": [ + { + "ContentType": "image/jpeg", + "LastModified": 1563571859.379, + "Name": "filename.jpg", + "Type": "OBJECT", + "ETag": "543ab21abcd1a234ab123456a1a2b12345ab12abc12a1234abc1a2bc12345a12", + "ContentLength": 3784 + }, + { + "Type": "FOLDER", + "Name": "ExampleLiveDemo" + } + ] + } + +For more information, see `Viewing a List of Objects `__ in the *AWS Elemental MediaStore User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediastore/list-tags-for-resource.rst awscli-1.18.69/awscli/examples/mediastore/list-tags-for-resource.rst --- awscli-1.11.13/awscli/examples/mediastore/list-tags-for-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediastore/list-tags-for-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,23 @@ +**To list tags for a container** + +The following ``list-tags-for-resource`` example displays the tag keys and values assigned to the specified container. :: + + aws mediastore list-tags-for-resource \ + --resource arn:aws:mediastore:us-west-2:1213456789012:container/ExampleContainer + +Output:: + + { + "Tags": [ + { + "Value": "Test", + "Key": "Environment" + }, + { + "Value": "West", + "Key": "Region" + } + ] + } + +For more information, see `ListTagsForResource `__ in the *AWS Elemental MediaStore API Reference*. diff -Nru awscli-1.11.13/awscli/examples/mediastore/put-container-policy.rst awscli-1.18.69/awscli/examples/mediastore/put-container-policy.rst --- awscli-1.11.13/awscli/examples/mediastore/put-container-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediastore/put-container-policy.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To edit a container policy** + +The following ``put-container-policy`` example assigns a different policy to the specified container. In this example, the updated policy is defined in a file named ``LiveEventsContainerPolicy.json``. :: + + aws mediastore put-container-policy \ + --container-name LiveEvents \ + --policy file://LiveEventsContainerPolicy.json + +This command produces no output. + +For more information, see `Editing a Container Policy `__ in the *AWS Elemental MediaStore User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediastore/put-cors-policy.rst awscli-1.18.69/awscli/examples/mediastore/put-cors-policy.rst --- awscli-1.11.13/awscli/examples/mediastore/put-cors-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediastore/put-cors-policy.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,17 @@ +**Example 1: To add a CORS policy** + +The following ``put-cors-policy`` example adds a cross-origin resource sharing (CORS) policy to the specified container. The contents of the CORS policy are in the file named ``corsPolicy.json``. :: + + aws mediastore put-cors-policy \ + --container-name ExampleContainer \ + --cors-policy file://corsPolicy.json + +This command produces no output. + +For more information, see `Adding a CORS Policy to a Container `__ in the *AWS Elemental MediaStore User Guide*. + +**Example 2: To edit a CORS policy** + +The following ``put-cors-policy`` example updates the cross-origin resource sharing (CORS) policy that is assigned to the specified container. The contents of the updated CORS policy are in the file named ``corsPolicy2.json``. + +For more information, see `Editing a CORS Policy `__ in the *AWS Elemental MediaStore User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediastore/put-lifecycle-policy.rst awscli-1.18.69/awscli/examples/mediastore/put-lifecycle-policy.rst --- awscli-1.11.13/awscli/examples/mediastore/put-lifecycle-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediastore/put-lifecycle-policy.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To create an object lifecycle policy** + +The following ``put-lifecycle-policy`` example attaches an object lifecycle policy to the specified container. This enables you to specify how long the service should store objects in your container. MediaStore deletes objects in the container once they reach their expiration date, as indicated in the policy, which is in the file named ``LiveEventsLifecyclePolicy.json``. :: + + aws mediastore put-lifecycle-policy \ + --container-name ExampleContainer \ + --lifecycle-policy file://ExampleLifecyclePolicy.json + +This command produces no output. + +For more information, see `Adding an Object Lifecycle Policy to a Container `__ in the *AWS Elemental MediaStore User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediastore/put-object.rst awscli-1.18.69/awscli/examples/mediastore/put-object.rst --- awscli-1.11.13/awscli/examples/mediastore/put-object.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediastore/put-object.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,20 @@ +**To upload an object** + +The following ``put-object`` example uploads an object to the specified container. You can specify a folder path where the object will be saved within the container. If the folder already exists, AWS Elemental MediaStore stores the object in the folder. If the folder doesn't exist, the service creates it, and then stores the object in the folder. :: + + aws mediastore-data put-object \ + --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ + --body README.md \ + --path /folder_name/README.md \ + --cache-control "max-age=6, public" \ + --content-type binary/octet-stream + +Output:: + + { + "ContentSHA256": "74b5fdb517f423ed750ef214c44adfe2be36e37d861eafe9c842cbe1bf387a9d", + "StorageClass": "TEMPORAL", + "ETag": "af3e4731af032167a106015d1f2fe934e68b32ed1aa297a9e325f5c64979277b" + } + +For more information, see `Uploading an Object `__ in the *AWS Elemental MediaStore User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediastore/start-access-logging.rst awscli-1.18.69/awscli/examples/mediastore/start-access-logging.rst --- awscli-1.11.13/awscli/examples/mediastore/start-access-logging.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediastore/start-access-logging.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,10 @@ +**To enable access logging on a container** + +The following ``start-access-logging`` example enable access logging on the specified container. :: + + aws mediastore start-access-logging \ + --container-name LiveEvents + +This command produces no output. + +For more information, see `Enabling Access Logging for a Container `__ in the *AWS Elemental MediaStore User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediastore/stop-access-logging.rst awscli-1.18.69/awscli/examples/mediastore/stop-access-logging.rst --- awscli-1.11.13/awscli/examples/mediastore/stop-access-logging.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediastore/stop-access-logging.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,10 @@ +**To disable access logging on a container** + +The following ``stop-access-logging`` example disables access logging on the specified container. :: + + aws mediastore stop-access-logging \ + --container-name LiveEvents + +This command produces no output. + +For more information, see `Disabling Access Logging for a Container `__ in the *AWS Elemental MediaStore User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediastore/tag-resource.rst awscli-1.18.69/awscli/examples/mediastore/tag-resource.rst --- awscli-1.11.13/awscli/examples/mediastore/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediastore/tag-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To add tags to a container** + +The following ``tag-resource`` example adds tag keys and values to the specified container. :: + + aws mediastore tag-resource \ + --resource arn:aws:mediastore:us-west-2:123456789012:container/ExampleContainer \ + --tags '[{"Key": "Region", "Value": "West"}, {"Key": "Environment", "Value": "Test"}]' + +This command produces no output. + +For more information, see `TagResource `__ in the *AWS Elemental MediaStore API Reference*. diff -Nru awscli-1.11.13/awscli/examples/mediastore/untag-resource.rst awscli-1.18.69/awscli/examples/mediastore/untag-resource.rst --- awscli-1.11.13/awscli/examples/mediastore/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediastore/untag-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To remove tags from a container** + +The following ``untag-resource`` example removes the specified tag key and its associated value from a container. :: + + aws mediastore untag-resource \ + --resource arn:aws:mediastore:us-west-2:123456789012:container/ExampleContainer \ + --tag-keys Region + +This command produces no output. + +For more information, see `UntagResource `__ in the *AWS Elemental MediaStore API Reference.*. diff -Nru awscli-1.11.13/awscli/examples/mediastore-data/delete-object.rst awscli-1.18.69/awscli/examples/mediastore-data/delete-object.rst --- awscli-1.11.13/awscli/examples/mediastore-data/delete-object.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediastore-data/delete-object.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To delete an object** + +The following ``delete-object`` example deletes the specified object. :: + + aws mediastore-data delete-object \ + --endpoint=https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ + --path=/folder_name/README.md + +This command produces no output. + +For more information, see `Deleting an Object `__ in the *AWS Elemental MediaStore User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediastore-data/describe-object.rst awscli-1.18.69/awscli/examples/mediastore-data/describe-object.rst --- awscli-1.11.13/awscli/examples/mediastore-data/describe-object.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediastore-data/describe-object.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,18 @@ +**To view the headers for an object** + +The following ``describe-object`` example displays the headers for an object at the specified path. :: + + aws mediastore-data describe-object \ + --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ + --path events/baseball/setup.jpg + +Output:: + + { + "LastModified": "Fri, 19 Jul 2019 21:50:31 GMT", + "ContentType": "image/jpeg", + "ContentLength": "3860266", + "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3" + } + +For more information, see `Viewing the Details of an Object `__ in the *AWS Elemental MediaStore User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediastore-data/get-object.rst awscli-1.18.69/awscli/examples/mediastore-data/get-object.rst --- awscli-1.11.13/awscli/examples/mediastore-data/get-object.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediastore-data/get-object.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,39 @@ +**Example 1: To download an entire object** + +The following ``get-object`` example downloads the specified object. :: + + aws mediastore-data get-object \ + --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ + --path events/baseball/setup.jpg setup.jpg + +Output:: + + { + "ContentType": "image/jpeg", + "StatusCode": 200, + "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3", + "ContentLength": "3860266", + "LastModified": "Fri, 19 Jul 2019 21:50:31 GMT" + } + +**Example 2: To download part of an object** + +The following ``get-object`` example downloads the specified part of an object. :: + + aws mediastore-data get-object \ + --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ + --path events/baseball/setup.jpg setup.jpg \ + --range "bytes=0-100" + +Output:: + + { + "StatusCode": 206, + "LastModified": "Fri, 19 Jul 2019 21:50:31 GMT", + "ContentType": "image/jpeg", + "ContentRange": "bytes 0-100/3860266", + "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3", + "ContentLength": "101" + } + +For more information, see `Downloading an Object `__ in the *AWS Elemental MediaStore User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediastore-data/list-items.rst awscli-1.18.69/awscli/examples/mediastore-data/list-items.rst --- awscli-1.11.13/awscli/examples/mediastore-data/list-items.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediastore-data/list-items.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,50 @@ +**Example 1: To view a list of items (objects and folders) stored in a container** + +The following ``list-items`` example displays a list of items (objects and folders) stored in the specified container. :: + + aws mediastore-data list-items \ + --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com + +Output:: + + { + "Items": [ + { + "Type": "OBJECT", + "ContentLength": 3784, + "Name": "setup.jpg", + "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3", + "ContentType": "image/jpeg", + "LastModified": 1563571859.379 + }, + { + "Type": "FOLDER", + "Name": "events" + } + ] + } + +**Example 2: To view a list of items (objects and folders) stored in a folder** + +The following ``list-items`` example displays a list of items (objects and folders) stored in the specified folder. :: + + aws mediastore-data list-items \ + --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ + --path events/baseball + +Output:: + + { + "Items": [ + { + "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3", + "ContentType": "image/jpeg", + "Type": "OBJECT", + "ContentLength": 3860266, + "LastModified": 1563573031.872, + "Name": "setup.jpg" + } + ] + } + +For more information, see `Viewing a List of Objects `__ in the *AWS Elemental MediaStore User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediastore-data/put-object.rst awscli-1.18.69/awscli/examples/mediastore-data/put-object.rst --- awscli-1.11.13/awscli/examples/mediastore-data/put-object.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediastore-data/put-object.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,39 @@ +**Example 1: To upload an object to a container** + +The following ``put-object`` example upload an object to the specified container. :: + + aws mediastore-data put-object \ + --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ + --body ReadMe.md \ + --path ReadMe.md \ + --cache-control "max-age=6, public" \ + --content-type binary/octet-stream + +Output:: + + { + "ContentSHA256": "f29bc64a9d3732b4b9035125fdb3285f5b6455778edca72414671e0ca3b2e0de", + "StorageClass": "TEMPORAL", + "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3" + } + +**Example 2: To upload an object to a folder within a container** + +The following ``put-object`` example upload an object to the specified folder within a container. :: + + aws mediastore-data put-object \ + --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ + --body ReadMe.md \ + --path /september-events/ReadMe.md \ + --cache-control "max-age=6, public" \ + --content-type binary/octet-stream + +Output:: + + { + "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3", + "ContentSHA256": "f29bc64a9d3732b4b9035125fdb3285f5b6455778edca72414671e0ca3b2e0de", + "StorageClass": "TEMPORAL" + } + +For more information, see `Uploading an Object `__ in the *AWS Elemental MediaStore User Guide*. diff -Nru awscli-1.11.13/awscli/examples/mediatailor/delete-playback-configuration.rst awscli-1.18.69/awscli/examples/mediatailor/delete-playback-configuration.rst --- awscli-1.11.13/awscli/examples/mediatailor/delete-playback-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediatailor/delete-playback-configuration.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/mediatailor/get-playback-configuration.rst awscli-1.18.69/awscli/examples/mediatailor/get-playback-configuration.rst --- awscli-1.11.13/awscli/examples/mediatailor/get-playback-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediatailor/get-playback-configuration.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/mediatailor/list-playback-configurations.rst awscli-1.18.69/awscli/examples/mediatailor/list-playback-configurations.rst --- awscli-1.11.13/awscli/examples/mediatailor/list-playback-configurations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediatailor/list-playback-configurations.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/mediatailor/put-playback-configuration.rst awscli-1.18.69/awscli/examples/mediatailor/put-playback-configuration.rst --- awscli-1.11.13/awscli/examples/mediatailor/put-playback-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/mediatailor/put-playback-configuration.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/associate-customer-gateway.rst awscli-1.18.69/awscli/examples/networkmanager/associate-customer-gateway.rst --- awscli-1.11.13/awscli/examples/networkmanager/associate-customer-gateway.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/associate-customer-gateway.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/associate-link.rst awscli-1.18.69/awscli/examples/networkmanager/associate-link.rst --- awscli-1.11.13/awscli/examples/networkmanager/associate-link.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/associate-link.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/create-device.rst awscli-1.18.69/awscli/examples/networkmanager/create-device.rst --- awscli-1.11.13/awscli/examples/networkmanager/create-device.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/create-device.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/create-global-network.rst awscli-1.18.69/awscli/examples/networkmanager/create-global-network.rst --- awscli-1.11.13/awscli/examples/networkmanager/create-global-network.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/create-global-network.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/create-link.rst awscli-1.18.69/awscli/examples/networkmanager/create-link.rst --- awscli-1.11.13/awscli/examples/networkmanager/create-link.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/create-link.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/create-site.rst awscli-1.18.69/awscli/examples/networkmanager/create-site.rst --- awscli-1.11.13/awscli/examples/networkmanager/create-site.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/create-site.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/delete-bucket-analytics-configuration.rst awscli-1.18.69/awscli/examples/networkmanager/delete-bucket-analytics-configuration.rst --- awscli-1.11.13/awscli/examples/networkmanager/delete-bucket-analytics-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/delete-bucket-analytics-configuration.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/delete-bucket-metrics-configuration.rst awscli-1.18.69/awscli/examples/networkmanager/delete-bucket-metrics-configuration.rst --- awscli-1.11.13/awscli/examples/networkmanager/delete-bucket-metrics-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/delete-bucket-metrics-configuration.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/delete-device.rst awscli-1.18.69/awscli/examples/networkmanager/delete-device.rst --- awscli-1.11.13/awscli/examples/networkmanager/delete-device.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/delete-device.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/delete-global-network.rst awscli-1.18.69/awscli/examples/networkmanager/delete-global-network.rst --- awscli-1.11.13/awscli/examples/networkmanager/delete-global-network.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/delete-global-network.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/delete-link.rst awscli-1.18.69/awscli/examples/networkmanager/delete-link.rst --- awscli-1.11.13/awscli/examples/networkmanager/delete-link.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/delete-link.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/delete-public-access-block.rst awscli-1.18.69/awscli/examples/networkmanager/delete-public-access-block.rst --- awscli-1.11.13/awscli/examples/networkmanager/delete-public-access-block.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/delete-public-access-block.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/delete-site.rst awscli-1.18.69/awscli/examples/networkmanager/delete-site.rst --- awscli-1.11.13/awscli/examples/networkmanager/delete-site.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/delete-site.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/deregister-transit-gateway.rst awscli-1.18.69/awscli/examples/networkmanager/deregister-transit-gateway.rst --- awscli-1.11.13/awscli/examples/networkmanager/deregister-transit-gateway.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/deregister-transit-gateway.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/describe-global-networks.rst awscli-1.18.69/awscli/examples/networkmanager/describe-global-networks.rst --- awscli-1.11.13/awscli/examples/networkmanager/describe-global-networks.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/describe-global-networks.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/disassociate-customer-gateway.rst awscli-1.18.69/awscli/examples/networkmanager/disassociate-customer-gateway.rst --- awscli-1.11.13/awscli/examples/networkmanager/disassociate-customer-gateway.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/disassociate-customer-gateway.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/disassociate-link.rst awscli-1.18.69/awscli/examples/networkmanager/disassociate-link.rst --- awscli-1.11.13/awscli/examples/networkmanager/disassociate-link.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/disassociate-link.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/get-bucket-analytics-configuration.rst awscli-1.18.69/awscli/examples/networkmanager/get-bucket-analytics-configuration.rst --- awscli-1.11.13/awscli/examples/networkmanager/get-bucket-analytics-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/get-bucket-analytics-configuration.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/get-bucket-metrics-configuration.rst awscli-1.18.69/awscli/examples/networkmanager/get-bucket-metrics-configuration.rst --- awscli-1.11.13/awscli/examples/networkmanager/get-bucket-metrics-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/get-bucket-metrics-configuration.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/get-customer-gateway-associations.rst awscli-1.18.69/awscli/examples/networkmanager/get-customer-gateway-associations.rst --- awscli-1.11.13/awscli/examples/networkmanager/get-customer-gateway-associations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/get-customer-gateway-associations.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/get-devices.rst awscli-1.18.69/awscli/examples/networkmanager/get-devices.rst --- awscli-1.11.13/awscli/examples/networkmanager/get-devices.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/get-devices.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/get-link-associations.rst awscli-1.18.69/awscli/examples/networkmanager/get-link-associations.rst --- awscli-1.11.13/awscli/examples/networkmanager/get-link-associations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/get-link-associations.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/get-links.rst awscli-1.18.69/awscli/examples/networkmanager/get-links.rst --- awscli-1.11.13/awscli/examples/networkmanager/get-links.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/get-links.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/get-object-retention.rst awscli-1.18.69/awscli/examples/networkmanager/get-object-retention.rst --- awscli-1.11.13/awscli/examples/networkmanager/get-object-retention.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/get-object-retention.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/get-public-access-block.rst awscli-1.18.69/awscli/examples/networkmanager/get-public-access-block.rst --- awscli-1.11.13/awscli/examples/networkmanager/get-public-access-block.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/get-public-access-block.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/get-sites.rst awscli-1.18.69/awscli/examples/networkmanager/get-sites.rst --- awscli-1.11.13/awscli/examples/networkmanager/get-sites.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/get-sites.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/get-transit-gateway-registrations.rst awscli-1.18.69/awscli/examples/networkmanager/get-transit-gateway-registrations.rst --- awscli-1.11.13/awscli/examples/networkmanager/get-transit-gateway-registrations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/get-transit-gateway-registrations.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/list-bucket-analytics-configurations.rst awscli-1.18.69/awscli/examples/networkmanager/list-bucket-analytics-configurations.rst --- awscli-1.11.13/awscli/examples/networkmanager/list-bucket-analytics-configurations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/list-bucket-analytics-configurations.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/list-bucket-metrics-configurations.rst awscli-1.18.69/awscli/examples/networkmanager/list-bucket-metrics-configurations.rst --- awscli-1.11.13/awscli/examples/networkmanager/list-bucket-metrics-configurations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/list-bucket-metrics-configurations.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/list-tags-for-resource.rst awscli-1.18.69/awscli/examples/networkmanager/list-tags-for-resource.rst --- awscli-1.11.13/awscli/examples/networkmanager/list-tags-for-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/list-tags-for-resource.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/put-bucket-metrics-configuration.rst awscli-1.18.69/awscli/examples/networkmanager/put-bucket-metrics-configuration.rst --- awscli-1.11.13/awscli/examples/networkmanager/put-bucket-metrics-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/put-bucket-metrics-configuration.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/put-object-retention.rst awscli-1.18.69/awscli/examples/networkmanager/put-object-retention.rst --- awscli-1.11.13/awscli/examples/networkmanager/put-object-retention.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/put-object-retention.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/put-public-access-block.rst awscli-1.18.69/awscli/examples/networkmanager/put-public-access-block.rst --- awscli-1.11.13/awscli/examples/networkmanager/put-public-access-block.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/put-public-access-block.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/register-transit-gateway.rst awscli-1.18.69/awscli/examples/networkmanager/register-transit-gateway.rst --- awscli-1.11.13/awscli/examples/networkmanager/register-transit-gateway.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/register-transit-gateway.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/tag-resource.rst awscli-1.18.69/awscli/examples/networkmanager/tag-resource.rst --- awscli-1.11.13/awscli/examples/networkmanager/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/tag-resource.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/untag-resource.rst awscli-1.18.69/awscli/examples/networkmanager/untag-resource.rst --- awscli-1.11.13/awscli/examples/networkmanager/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/untag-resource.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/update-device.rst awscli-1.18.69/awscli/examples/networkmanager/update-device.rst --- awscli-1.11.13/awscli/examples/networkmanager/update-device.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/update-device.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/update-global-network.rst awscli-1.18.69/awscli/examples/networkmanager/update-global-network.rst --- awscli-1.11.13/awscli/examples/networkmanager/update-global-network.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/update-global-network.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/update-link.rst awscli-1.18.69/awscli/examples/networkmanager/update-link.rst --- awscli-1.11.13/awscli/examples/networkmanager/update-link.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/update-link.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/networkmanager/update-site.rst awscli-1.18.69/awscli/examples/networkmanager/update-site.rst --- awscli-1.11.13/awscli/examples/networkmanager/update-site.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/networkmanager/update-site.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/opsworks/create-deployment.rst awscli-1.18.69/awscli/examples/opsworks/create-deployment.rst --- awscli-1.11.13/awscli/examples/opsworks/create-deployment.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/opsworks/create-deployment.rst 2020-05-28 19:25:50.000000000 +0000 @@ -1,69 +1,66 @@ -**To deploy apps and run stack commands** +**Example 1: To deploy apps and run stack commands** -The following examples show how to use the ``create-deployment`` command to deploy apps and run stack commands. Notice that the -quote (``"``) characters in the JSON object that specifies the command are all preceded by -escape characters (\). Without the escape characters, the command might -return an invalid JSON error. +The following examples show how to use the ``create-deployment`` command to deploy apps and run stack commands. Notice that the quote (``"``) characters in the JSON object that specifies the command are all preceded by escape characters (\\). Without the escape characters, the command might return an invalid JSON error. -**Deploy an App** +The following ``create-deployment`` example deploys an app to a specified stack. :: -The following ``create-deployment`` command deploys an app to a specified stack. :: + aws opsworks create-deployment \ + --stack-id cfb7e082-ad1d-4599-8e81-de1c39ab45bf \ + --app-id 307be5c8-d55d-47b5-bd6e-7bd417c6c7eb + --command "{\"Name\":\"deploy\"}" - aws opsworks --region us-east-1 create-deployment --stack-id cfb7e082-ad1d-4599-8e81-de1c39ab45bf --app-id 307be5c8-d55d-47b5-bd6e-7bd417c6c7eb --command "{\"Name\":\"deploy\"}" +Output:: -*Output*:: + { + "DeploymentId": "5746c781-df7f-4c87-84a7-65a119880560" + } - { - "DeploymentId": "5746c781-df7f-4c87-84a7-65a119880560" - } +**Example 2: To deploy a Rails App and Migrate the Database** -**Deploy a Rails App and Migrate the Database** +The following ``create-deployment`` command deploys a Ruby on Rails app to a specified stack and migrates the database. :: -The following ``create-deployment`` command deploys a Ruby on Rails app to a specified stack and migrates the -database. :: + aws opsworks create-deployment \ + --stack-id cfb7e082-ad1d-4599-8e81-de1c39ab45bf \ + --app-id 307be5c8-d55d-47b5-bd6e-7bd417c6c7eb \ + --command "{\"Name\":\"deploy\", \"Args\":{\"migrate\":[\"true\"]}}" - aws opsworks --region us-east-1 create-deployment --stack-id cfb7e082-ad1d-4599-8e81-de1c39ab45bf --app-id 307be5c8-d55d-47b5-bd6e-7bd417c6c7eb --command "{\"Name\":\"deploy\", \"Args\":{\"migrate\":[\"true\"]}}" +Output:: -*Output*:: + { + "DeploymentId": "5746c781-df7f-4c87-84a7-65a119880560" + } - { - "DeploymentId": "5746c781-df7f-4c87-84a7-65a119880560" - } +For more information on deployment, see `Deploying Apps `__ in the *AWS OpsWorks User Guide*. -For more information on deployment, see `Deploying Apps`_ in the *AWS OpsWorks User Guide*. +**Example 3: Run a Recipe** -**Execute a Recipe** +The following ``create-deployment`` command runs a custom recipe, ``phpapp::appsetup``, on the instances in a specified stack. :: -The following ``create-deployment`` command runs a custom recipe, ``phpapp::appsetup``, on the instances in a specified -stack. :: + aws opsworks create-deployment \ + --stack-id 935450cc-61e0-4b03-a3e0-160ac817d2bb \ + --command "{\"Name\":\"execute_recipes\", \"Args\":{\"recipes\":[\"phpapp::appsetup\"]}}" - aws opsworks --region ap-south-1 create-deployment --stack-id 935450cc-61e0-4b03-a3e0-160ac817d2bb --command "{\"Name\":\"execute_recipes\", \"Args\":{\"recipes\":[\"phpapp::appsetup\"]}} +Output:: -*Output*:: + { + "DeploymentId": "5cbaa7b9-4e09-4e53-aa1b-314fbd106038" + } - { - "DeploymentId": "5cbaa7b9-4e09-4e53-aa1b-314fbd106038" - } +For more information, see `Run Stack Commands `__ in the *AWS OpsWorks User Guide*. -For more information, see `Run Stack Commands`_ in the *AWS OpsWorks User Guide*. - -**Install Dependencies** +**Example 4: Install Dependencies** The following ``create-deployment`` command installs dependencies, such as packages or Ruby gems, on the instances in a specified stack. :: - aws opsworks --region ap-south-1 create-deployment --stack-id 935450cc-61e0-4b03-a3e0-160ac817d2bb --command "{\"Name\":\"install_dependencies\"}" - -*Output*:: - - { - "DeploymentId": "aef5b255-8604-4928-81b3-9b0187f962ff" - } - -**More Information** + aws opsworks create-deployment \ + --stack-id 935450cc-61e0-4b03-a3e0-160ac817d2bb \ + --command "{\"Name\":\"install_dependencies\"}" -For more information, see `Run Stack Commands`_ in the *AWS OpsWorks User Guide*. +Output:: -.. _`Deploying Apps`: http://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-deploying.html -.. _`Run Stack Commands`: http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-commands.html + { + "DeploymentId": "aef5b255-8604-4928-81b3-9b0187f962ff" + } +For more information, see `Run Stack Commands `__ in the *AWS OpsWorks User Guide*. diff -Nru awscli-1.11.13/awscli/examples/opsworks/describe-elastic-load-balancers.rst awscli-1.18.69/awscli/examples/opsworks/describe-elastic-load-balancers.rst --- awscli-1.11.13/awscli/examples/opsworks/describe-elastic-load-balancers.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/opsworks/describe-elastic-load-balancers.rst 2020-05-28 19:25:50.000000000 +0000 @@ -2,33 +2,31 @@ The following ``describe-elastic-load-balancers`` command describes a specified stack's load balancers. :: - aws opsworks --region us-west-1 describe-elastic-load-balancers --stack-id d72553d4-8727-448c-9b00-f024f0ba1b06 + aws opsworks --region us-west-2 describe-elastic-load-balancers --stack-id 6f4660e5-37a6-4e42-bfa0-1358ebd9c182 -*Output*: This particular stack has one app. +*Output*: This particular stack has one load balancer. :: { - "Apps": [ - { - "StackId": "38ee91e2-abdc-4208-a107-0b7168b3cc7a", - "AppSource": { - "Url": "https://s3-us-west-2.amazonaws.com/opsworks-tomcat/simplejsp.zip", - "Type": "archive" - }, - "Name": "SimpleJSP", - "EnableSsl": false, - "SslConfiguration": {}, - "AppId": "da1decc1-0dff-43ea-ad7c-bb667cd87c8b", - "Attributes": { - "RailsEnv": null, - "AutoBundleOnDeploy": "true", - "DocumentRoot": "ROOT" - }, - "Shortname": "simplejsp", - "Type": "other", - "CreatedAt": "2013-08-01T21:46:54+00:00" - } + "ElasticLoadBalancers": [ + { + "SubnetIds": [ + "subnet-60e4ea04", + "subnet-66e1c110" + ], + "Ec2InstanceIds": [], + "ElasticLoadBalancerName": "my-balancer", + "Region": "us-west-2", + "LayerId": "344973cb-bf2b-4cd0-8d93-51cd819bab04", + "AvailabilityZones": [ + "us-west-2a", + "us-west-2b" + ], + "VpcId": "vpc-b319f9d4", + "StackId": "6f4660e5-37a6-4e42-bfa0-1358ebd9c182", + "DnsName": "my-balancer-2094040179.us-west-2.elb.amazonaws.com" + } ] } @@ -37,4 +35,3 @@ For more information, see Apps_ in the *AWS OpsWorks User Guide*. .. _Apps: http://docs.aws.amazon.com/opsworks/latest/userguide/workingapps.html - diff -Nru awscli-1.11.13/awscli/examples/opsworks/describe-instances.rst awscli-1.18.69/awscli/examples/opsworks/describe-instances.rst --- awscli-1.11.13/awscli/examples/opsworks/describe-instances.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/opsworks/describe-instances.rst 2020-05-28 19:25:50.000000000 +0000 @@ -89,7 +89,7 @@ **More Information** -For more information, see Instances_ in the *AWS OpsWorks User Guide*. +For more information, see `Instances`_ in the *AWS OpsWorks User Guide*. -.. _Instances: http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances.html +.. _`Instances`: http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances.html diff -Nru awscli-1.11.13/awscli/examples/opsworks/describe-my-user-profile.rst awscli-1.18.69/awscli/examples/opsworks/describe-my-user-profile.rst --- awscli-1.11.13/awscli/examples/opsworks/describe-my-user-profile.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/opsworks/describe-my-user-profile.rst 2020-05-28 19:25:50.000000000 +0000 @@ -3,7 +3,7 @@ The following example shows how to obtain the profile of the AWS Identity and Access Management (IAM) user that is running the command. :: - aws opsworks --region us-east-1 describe-user-profile + aws opsworks --region us-east-1 describe-my-user-profile *Output*: For brevity, most of the user's SSH public key is replaced by an ellipsis (...). :: diff -Nru awscli-1.11.13/awscli/examples/opsworks/describe-stack-provisioning-parameters.rst awscli-1.18.69/awscli/examples/opsworks/describe-stack-provisioning-parameters.rst --- awscli-1.11.13/awscli/examples/opsworks/describe-stack-provisioning-parameters.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/opsworks/describe-stack-provisioning-parameters.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,32 @@ +**To return the provisioning parameters for a stack** + +The following ``describe-stack-provisioning-parameters`` example returns the provisioning parameters for a specified stack. Provisioning parameters include settings such as the agent installation location and public key that OpsWorks uses to manage the agent on instances in a stack. :: + + aws opsworks describe-stack-provisioning-parameters \ + --stack-id 62744d97-6faf-4ecb-969b-a086fEXAMPLE + +Output:: + + { + "AgentInstallerUrl": "https://opsworks-instance-agent-us-west-2.s3.amazonaws.com/ID_number/opsworks-agent-installer.tgz", + "Parameters": { + "agent_installer_base_url": "https://opsworks-instance-agent-us-west-2.s3.amazonaws.com", + "agent_installer_tgz": "opsworks-agent-installer.tgz", + "assets_download_bucket": "opsworks-instance-assets-us-west-2.s3.amazonaws.com", + "charlie_public_key": "-----BEGIN PUBLIC KEY-----PUBLIC_KEY_EXAMPLE\n-----END PUBLIC KEY-----", + "instance_service_endpoint": "opsworks-instance-service.us-west-2.amazonaws.com", + "instance_service_port": "443", + "instance_service_region": "us-west-2", + "instance_service_ssl_verify_peer": "true", + "instance_service_use_ssl": "true", + "ops_works_endpoint": "opsworks.us-west-2.amazonaws.com", + "ops_works_port": "443", + "ops_works_region": "us-west-2", + "ops_works_ssl_verify_peer": "true", + "ops_works_use_ssl": "true", + "verbose": "false", + "wait_between_runs": "30" + } + } + +For more information, see `Run Stack Commands `__ in the *AWS OpsWorks User Guide*. diff -Nru awscli-1.11.13/awscli/examples/opsworks/register.rst awscli-1.18.69/awscli/examples/opsworks/register.rst --- awscli-1.11.13/awscli/examples/opsworks/register.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/opsworks/register.rst 2020-05-28 19:25:50.000000000 +0000 @@ -7,8 +7,7 @@ .. _`Registering Amazon EC2 and On-premises Instances`: http://docs.aws.amazon.com/opsworks/latest/userguide/registered-instances-register-registering.html -**Note**: For brevity, the examples omit the ``region`` argument. AWS OpsWorks CLI commands should set ``region`` -to us-east-1 regardless of the stack's location. +**Note**: For brevity, the examples omit the ``region`` argument. *To register an Amazon EC2 instance* diff -Nru awscli-1.11.13/awscli/examples/opsworkscm/associate-node.rst awscli-1.18.69/awscli/examples/opsworkscm/associate-node.rst --- awscli-1.11.13/awscli/examples/opsworkscm/associate-node.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/opsworkscm/associate-node.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,22 @@ +**To associate nodes** + +The following ``associate-node`` command associates a node named ``i-44de882p`` with +a Chef Automate server named ``automate-06``, meaning that the ``automate-06`` server +manages the node, and communicates recipe commands to the node through ``chef-client`` agent software +that is installed on the node by the associate-node command. Valid node names are EC2 instance IDs.:: + + aws opsworks-cm associate-node --server-name "automate-06" --node-name "i-43de882p" --engine-attributes "Name=CHEF_ORGANIZATION,Value='MyOrganization' Name=CHEF_NODE_PUBLIC_KEY,Value='Public_key_contents'" + +The output returned by the command resembles the following. +*Output*:: + + { + "NodeAssociationStatusToken": "AHUY8wFe4pdXtZC5DiJa5SOLp5o14DH//rHRqHDWXxwVoNBxcEy4V7R0NOFymh7E/1HumOBPsemPQFE6dcGaiFk" + } + +**More Information** + +For more information, see `Adding Nodes Automatically in AWS OpsWorks for Chef Automate`_ in the *AWS OpsWorks User Guide*. + +.. _`Adding Nodes Automatically in AWS OpsWorks for Chef Automate`: http://docs.aws.amazon.com/opsworks/latest/userguide/opscm-unattend-assoc.html + diff -Nru awscli-1.11.13/awscli/examples/opsworkscm/create-backup.rst awscli-1.18.69/awscli/examples/opsworkscm/create-backup.rst --- awscli-1.11.13/awscli/examples/opsworkscm/create-backup.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/opsworkscm/create-backup.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,46 @@ +**To create backups** + +The following ``create-backup`` command starts a manual backup of a Chef Automate server +named ``automate-06`` in the ``us-east-1`` region. The command adds a descriptive message to +the backup in the ``--description`` parameter.:: + + aws opsworks-cm create-backup --server-name 'automate-06' --description "state of my infrastructure at launch" + +The output shows you information similar to the following about the new backup. +*Output*:: + + { + "Backups": [ + { + "BackupArn": "string", + "BackupId": "automate-06-20160729133847520", + "BackupType": "MANUAL", + "CreatedAt": 2016-07-29T13:38:47.520Z, + "Description": "state of my infrastructure at launch", + "Engine": "Chef", + "EngineModel": "Single", + "EngineVersion": "12", + "InstanceProfileArn": "arn:aws:iam::1019881987024:instance-profile/automate-06-1010V4UU2WRM2", + "InstanceType": "m4.large", + "KeyPair": "", + "PreferredBackupWindow": "", + "PreferredMaintenanceWindow": "", + "S3LogUrl": "https://s3.amazonaws.com/automate-06/automate-06-20160729133847520", + "SecurityGroupIds": [ "sg-1a24c270" ], + "ServerName": "automate-06", + "ServiceRoleArn": "arn:aws:iam::1019881987024:role/aws-opsworks-cm-service-role.1114810729735", + "Status": "OK", + "StatusDescription": "", + "SubnetIds": [ "subnet-49436a18" ], + "ToolsVersion": "string", + "UserArn": "arn:aws:iam::1019881987024:user/opsworks-user" + } + ], + } + +**More Information** + +For more information, see `Back Up and Restore an AWS OpsWorks for Chef Automate Server`_ in the *AWS OpsWorks User Guide*. + +.. _`Back Up and Restore an AWS OpsWorks for Chef Automate Server`: http://docs.aws.amazon.com/opsworks/latest/userguide/opscm-backup-restore.html + diff -Nru awscli-1.11.13/awscli/examples/opsworkscm/create-server.rst awscli-1.18.69/awscli/examples/opsworkscm/create-server.rst --- awscli-1.11.13/awscli/examples/opsworkscm/create-server.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/opsworkscm/create-server.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,48 @@ +**To create a server** + +The following ``create-server`` example creates a new Chef Automate server named ``automate-06`` in your default region. Note that defaults are used for most other settings, such as number of backups to retain, and maintenance and backup start times. Before you run a ``create-server`` command, complete prerequisites in `Getting Started with AWS OpsWorks for Chef Automate `_ in the *AWS Opsworks for Chef Automate User Guide*. :: + + aws opsworks-cm create-server \ + --engine "Chef" \ + --engine-model "Single" \ + --engine-version "12" \ + --server-name "automate-06" \ + --instance-profile-arn "arn:aws:iam::1019881987024:instance-profile/aws-opsworks-cm-ec2-role" \ + --instance-type "t2.medium" \ + --key-pair "amazon-test" \ + --service-role-arn "arn:aws:iam::044726508045:role/aws-opsworks-cm-service-role" + +The output shows you information similar to the following about the new server:: + + { + "Server": { + "BackupRetentionCount": 10, + "CreatedAt": 2016-07-29T13:38:47.520Z, + "DisableAutomatedBackup": FALSE, + "Endpoint": "https://opsworks-cm.us-east-1.amazonaws.com", + "Engine": "Chef", + "EngineAttributes": [ + { + "Name": "CHEF_DELIVERY_ADMIN_PASSWORD", + "Value": "1Password1" + } + ], + "EngineModel": "Single", + "EngineVersion": "12", + "InstanceProfileArn": "arn:aws:iam::1019881987024:instance-profile/aws-opsworks-cm-ec2-role", + "InstanceType": "t2.medium", + "KeyPair": "amazon-test", + "MaintenanceStatus": "", + "PreferredBackupWindow": "Sun:02:00", + "PreferredMaintenanceWindow": "00:00", + "SecurityGroupIds": [ "sg-1a24c270" ], + "ServerArn": "arn:aws:iam::1019881987024:instance/automate-06-1010V4UU2WRM2", + "ServerName": "automate-06", + "ServiceRoleArn": "arn:aws:iam::1019881987024:role/aws-opsworks-cm-service-role", + "Status": "CREATING", + "StatusReason": "", + "SubnetIds": [ "subnet-49436a18" ] + } + } + +For more information, see `UpdateServer `_ in the *AWS OpsWorks for Chef Automate API Reference*. diff -Nru awscli-1.11.13/awscli/examples/opsworkscm/delete-backup.rst awscli-1.18.69/awscli/examples/opsworkscm/delete-backup.rst --- awscli-1.11.13/awscli/examples/opsworkscm/delete-backup.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/opsworkscm/delete-backup.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,17 @@ +**To delete backups** + +The following ``delete-backup`` command deletes a manual or automated backup of +a Chef Automate server, identified by the backup ID. This command is useful when +you are approaching the maximum number of backups that you can save, or you want +to minimize your Amazon S3 storage costs.:: + + aws opsworks-cm delete-backup --backup-id "automate-06-2016-11-19T23:42:40.240Z" + +The output shows whether the backup deletion succeeded. + +**More Information** + +For more information, see `Back Up and Restore an AWS OpsWorks for Chef Automate Server`_ in the *AWS OpsWorks User Guide*. + +.. _`Back Up and Restore an AWS OpsWorks for Chef Automate Server`: http://docs.aws.amazon.com/opsworks/latest/userguide/opscm-backup-restore.html + diff -Nru awscli-1.11.13/awscli/examples/opsworkscm/delete-server.rst awscli-1.18.69/awscli/examples/opsworkscm/delete-server.rst --- awscli-1.11.13/awscli/examples/opsworkscm/delete-server.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/opsworkscm/delete-server.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,16 @@ +**To delete servers** + +The following ``delete-server`` command deletes a Chef Automate server, identified +by the server's name. After the server is deleted, it is no longer returned by +``DescribeServer`` requests.:: + + aws opsworks-cm delete-server --server-name "automate-06" + +The output shows whether the server deletion succeeded. + +**More Information** + +For more information, see `Delete an AWS OpsWorks for Chef Automate Server`_ in the *AWS OpsWorks User Guide*. + +.. _`Delete an AWS OpsWorks for Chef Automate Server`: http://docs.aws.amazon.com/opsworks/latest/userguide/opscm-delete-server.html + diff -Nru awscli-1.11.13/awscli/examples/opsworkscm/describe-account-attributes.rst awscli-1.18.69/awscli/examples/opsworkscm/describe-account-attributes.rst --- awscli-1.11.13/awscli/examples/opsworkscm/describe-account-attributes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/opsworkscm/describe-account-attributes.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,26 @@ +**To describe account attributes** + +The following ``describe-account-attributes`` command returns information about your +account's usage of AWS OpsWorks for Chef Automate resources.:: + + aws opsworks-cm describe-account-attributes + +The output for each account attribute entry returned by the command resembles the following. +*Output*:: + + { + "Attributes": [ + { + "Maximum": 5, + "Name": "ServerLimit", + "Used": 2 + } + ] + } + +**More Information** + +For more information, see `DescribeAccountAttributes`_ in the *AWS OpsWorks for Chef Automate API Reference*. + +.. _`DescribeAccountAttributes`: http://docs.aws.amazon.com/opsworks-cm/latest/APIReference/API_DescribeAccountAttributes.html + diff -Nru awscli-1.11.13/awscli/examples/opsworkscm/describe-backups.rst awscli-1.18.69/awscli/examples/opsworkscm/describe-backups.rst --- awscli-1.11.13/awscli/examples/opsworkscm/describe-backups.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/opsworkscm/describe-backups.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,45 @@ +**To describe backups** + +The following ``describe-backups`` command returns information about all backups +associated with your account in your default region.:: + + aws opsworks-cm describe-backups + +The output for each backup entry returned by the command resembles the following. +*Output*:: + + { + "Backups": [ + { + "BackupArn": "string", + "BackupId": "automate-06-20160729133847520", + "BackupType": "MANUAL", + "CreatedAt": 2016-07-29T13:38:47.520Z, + "Description": "state of my infrastructure at launch", + "Engine": "Chef", + "EngineModel": "Single", + "EngineVersion": "12", + "InstanceProfileArn": "arn:aws:iam::1019881987024:instance-profile/automate-06-1010V4UU2WRM2", + "InstanceType": "m4.large", + "KeyPair": "", + "PreferredBackupWindow": "", + "PreferredMaintenanceWindow": "", + "S3LogUrl": "https://s3.amazonaws.com/automate-06/automate-06-20160729133847520", + "SecurityGroupIds": [ "sg-1a24c270" ], + "ServerName": "automate-06", + "ServiceRoleArn": "arn:aws:iam::1019881987024:role/aws-opsworks-cm-service-role.1114810729735", + "Status": "Successful", + "StatusDescription": "", + "SubnetIds": [ "subnet-49436a18" ], + "ToolsVersion": "string", + "UserArn": "arn:aws:iam::1019881987024:user/opsworks-user" + } + ], + } + +**More Information** + +For more information, see `Back Up and Restore an AWS OpsWorks for Chef Automate Server`_ in the *AWS OpsWorks User Guide*. + +.. _`Back Up and Restore an AWS OpsWorks for Chef Automate Server`: http://docs.aws.amazon.com/opsworks/latest/userguide/opscm-backup-restore.html + diff -Nru awscli-1.11.13/awscli/examples/opsworkscm/describe-events.rst awscli-1.18.69/awscli/examples/opsworkscm/describe-events.rst --- awscli-1.11.13/awscli/examples/opsworkscm/describe-events.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/opsworkscm/describe-events.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,20 @@ +**To describe events** + +The following ``describe-events`` example returns information about all events that are associated with the specified Chef Automate server. :: + + aws opsworks-cm describe-events --server-name 'automate-06' + +The output for each event entry returned by the command resembles the following example:: + + { + "ServerEvents": [ + { + "CreatedAt": 2016-07-29T13:38:47.520Z, + "LogUrl": "https://s3.amazonaws.com/automate-06/automate-06-20160729133847520", + "Message": "Updates successfully installed.", + "ServerName": "automate-06" + } + ] + } + +For more information, see `General Troubleshooting Tips `_ in the *AWS OpsWorks User Guide*. diff -Nru awscli-1.11.13/awscli/examples/opsworkscm/describe-node-association-status.rst awscli-1.18.69/awscli/examples/opsworkscm/describe-node-association-status.rst --- awscli-1.11.13/awscli/examples/opsworkscm/describe-node-association-status.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/opsworkscm/describe-node-association-status.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,20 @@ +**To describe node association status** + +The following ``describe-node-association-status`` command returns the status of a +request to associate a node with a Chef Automate server named ``automate-06``.:: + + aws opsworks-cm describe-node-association-status --server-name "automate-06" --node-association-status-token "AflJKl+/GoKLZJBdDQEx0O65CDi57blQe9nKM8joSok0pQ9xr8DqApBN9/1O6sLdSvlfDEKkEx+eoCHvjoWHaOs=" + +The output for each account attribute entry returned by the command resembles the following. +*Output*:: + + { + "NodeAssociationStatus": "IN_PROGRESS" + } + +**More Information** + +For more information, see `DescribeNodeAssociationStatus`_ in the *AWS OpsWorks for Chef Automate API Reference*. + +.. _`DescribeNodeAssociationStatus`: http://docs.aws.amazon.com/opsworks-cm/latest/APIReference/API_DescribeNodeAssociationStatus.html + diff -Nru awscli-1.11.13/awscli/examples/opsworkscm/describe-servers.rst awscli-1.18.69/awscli/examples/opsworkscm/describe-servers.rst --- awscli-1.11.13/awscli/examples/opsworkscm/describe-servers.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/opsworkscm/describe-servers.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,48 @@ +**To describe servers** + +The following ``describe-servers`` command returns information about all servers +that are associated with your account, and in your default region.:: + + aws opsworks-cm describe-servers + +The output for each server entry returned by the command resembles the following. +*Output*:: + + { + "Servers": [ + { + "BackupRetentionCount": 8, + "CreatedAt": 2016-07-29T13:38:47.520Z, + "DisableAutomatedBackup": FALSE, + "Endpoint": "https://opsworks-cm.us-east-1.amazonaws.com", + "Engine": "Chef", + "EngineAttributes": [ + { + "Name": "CHEF_DELIVERY_ADMIN_PASSWORD", + "Value": "1Password1" + } + ], + "EngineModel": "Single", + "EngineVersion": "12", + "InstanceProfileArn": "arn:aws:iam::1019881987024:instance-profile/automate-06-1010V4UU2WRM2", + "InstanceType": "m4.large", + "KeyPair": "", + "MaintenanceStatus": "SUCCESS", + "PreferredBackupWindow": "03:00", + "PreferredMaintenanceWindow": "Mon:09:00", + "SecurityGroupIds": [ "sg-1a24c270" ], + "ServerArn": "arn:aws:iam::1019881987024:instance/automate-06-1010V4UU2WRM2", + "ServerName": "automate-06", + "ServiceRoleArn": "arn:aws:iam::1019881987024:role/aws-opsworks-cm-service-role.1114810729735", + "Status": "HEALTHY", + "StatusReason": "", + "SubnetIds": [ "subnet-49436a18" ] + } + ] + } + +**More Information** + +For more information, see `DescribeServers`_ in the *AWS OpsWorks for Chef Automate API Guide*. + +.. _`DescribeServers`: http://docs.aws.amazon.com/opsworks-cm/latest/APIReference/API_DescribeServers.html diff -Nru awscli-1.11.13/awscli/examples/opsworkscm/disassociate-node.rst awscli-1.18.69/awscli/examples/opsworkscm/disassociate-node.rst --- awscli-1.11.13/awscli/examples/opsworkscm/disassociate-node.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/opsworkscm/disassociate-node.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,19 @@ +**To disassociate nodes** + +The following ``disassociate-node`` command disassociates a node named ``i-44de882p``, removing the node from +management by a Chef Automate server named ``automate-06``. Valid node names are EC2 instance IDs.:: + + aws opsworks-cm disassociate-node --server-name "automate-06" --node-name "i-43de882p" --engine-attributes "Name=CHEF_ORGANIZATION,Value='MyOrganization' Name=CHEF_NODE_PUBLIC_KEY,Value='Public_key_contents'" + +The output returned by the command resembles the following. +*Output*:: + + { + "NodeAssociationStatusToken": "AHUY8wFe4pdXtZC5DiJa5SOLp5o14DH//rHRqHDWXxwVoNBxcEy4V7R0NOFymh7E/1HumOBPsemPQFE6dcGaiFk" + } + +**More Information** + +For more information, see `Delete an AWS OpsWorks for Chef Automate Server`_ in the *AWS OpsWorks User Guide*. + +.. _`Delete an AWS OpsWorks for Chef Automate Server`: http://docs.aws.amazon.com/opsworks/latest/userguide/opscm-delete-server.html diff -Nru awscli-1.11.13/awscli/examples/opsworkscm/restore-server.rst awscli-1.18.69/awscli/examples/opsworkscm/restore-server.rst --- awscli-1.11.13/awscli/examples/opsworkscm/restore-server.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/opsworkscm/restore-server.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,20 @@ +**To restore a server** + +The following ``restore-server`` command performs an in-place restoration of a +Chef Automate server named ``automate-06`` in your default region from a backup +with an ID of ``automate-06-2016-11-22T16:13:27.998Z``. Restoring a server restores +connections to the nodes that the Chef Automate server was managing at the time +that the specified backup was performed. + + aws opsworks-cm restore-server --backup-id "automate-06-2016-11-22T16:13:27.998Z" --server-name "automate-06" + +The output is the command ID only. +*Output*:: + + (None) + +**More Information** + +For more information, see `Restore a Failed AWS OpsWorks for Chef Automate Server`_ in the *AWS OpsWorks User Guide*. + +.. _`Restore a Failed AWS OpsWorks for Chef Automate Server`: http://docs.aws.amazon.com/opsworks/latest/userguide/opscm-chef-restore.html diff -Nru awscli-1.11.13/awscli/examples/opsworkscm/start-maintenance.rst awscli-1.18.69/awscli/examples/opsworkscm/start-maintenance.rst --- awscli-1.11.13/awscli/examples/opsworkscm/start-maintenance.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/opsworkscm/start-maintenance.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,40 @@ +**To start maintenance** + +The following ``start-maintenance`` example manually starts maintenance on the specified Chef Automate server in your default region. This command can be useful if an earlier, automated maintenance attempt failed, and the underlying cause of maintenance failure has been resolved. :: + + aws opsworks-cm start-maintenance --server-name 'automate-06' + +The output shows you information similar to the following about the maintenance request. :: + + { + "Server": { + "BackupRetentionCount": 8, + "CreatedAt": 2016-07-29T13:38:47.520Z, + "DisableAutomatedBackup": TRUE, + "Endpoint": "https://opsworks-cm.us-east-1.amazonaws.com", + "Engine": "Chef", + "EngineAttributes": [ + { + "Name": "CHEF_DELIVERY_ADMIN_PASSWORD", + "Value": "1Password1" + } + ], + "EngineModel": "Single", + "EngineVersion": "12", + "InstanceProfileArn": "arn:aws:iam::1019881987024:instance-profile/automate-06-1010V4UU2WRM2", + "InstanceType": "m4.large", + "KeyPair": "", + "MaintenanceStatus": "SUCCESS", + "PreferredBackupWindow": "", + "PreferredMaintenanceWindow": "", + "SecurityGroupIds": [ "sg-1a24c270" ], + "ServerArn": "arn:aws:iam::1019881987024:instance/automate-06-1010V4UU2WRM2", + "ServerName": "automate-06", + "ServiceRoleArn": "arn:aws:iam::1019881987024:role/aws-opsworks-cm-service-role.1114810729735", + "Status": "HEALTHY", + "StatusReason": "", + "SubnetIds": [ "subnet-49436a18" ] + } + } + +For more information, see `StartMaintenance `_ in the *AWS OpsWorks for Chef Automate API Reference*. diff -Nru awscli-1.11.13/awscli/examples/opsworkscm/update-server-engine-attributes.rst awscli-1.18.69/awscli/examples/opsworkscm/update-server-engine-attributes.rst --- awscli-1.11.13/awscli/examples/opsworkscm/update-server-engine-attributes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/opsworkscm/update-server-engine-attributes.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,43 @@ +**To update server engine attributes** + +The following ``update-server-engine-attributes`` command updates the value of the ``CHEF_PIVOTAL_KEY`` engine attribute for a Chef Automate server named ``automate-06``. It is currently not possible to change the value of other engine attributes. :: + + aws opsworks-cm update-server-engine-attributes \ + --attribute-name CHEF_PIVOTAL_KEY \ + --attribute-value "new key value" \ + --server-name "automate-06" + +The output shows you information similar to the following about the updated server. :: + + { + "Server": { + "BackupRetentionCount": 2, + "CreatedAt": 2016-07-29T13:38:47.520Z, + "DisableAutomatedBackup": FALSE, + "Endpoint": "https://opsworks-cm.us-east-1.amazonaws.com", + "Engine": "Chef", + "EngineAttributes": [ + { + "Name": "CHEF_PIVOTAL_KEY", + "Value": "new key value" + } + ], + "EngineModel": "Single", + "EngineVersion": "12", + "InstanceProfileArn": "arn:aws:iam::1019881987024:instance-profile/automate-06-1010V4UU2WRM2", + "InstanceType": "m4.large", + "KeyPair": "", + "MaintenanceStatus": "SUCCESS", + "PreferredBackupWindow": "Mon:09:15", + "PreferredMaintenanceWindow": "03:00", + "SecurityGroupIds": [ "sg-1a24c270" ], + "ServerArn": "arn:aws:iam::1019881987024:instance/automate-06-1010V4UU2WRM2", + "ServerName": "automate-06", + "ServiceRoleArn": "arn:aws:iam::1019881987024:role/aws-opsworks-cm-service-role.1114810729735", + "Status": "HEALTHY", + "StatusReason": "", + "SubnetIds": [ "subnet-49436a18" ] + } + } + +For more information, see `UpdateServerEngineAttributes `_ in the *AWS OpsWorks for Chef Automate API Reference*. diff -Nru awscli-1.11.13/awscli/examples/opsworkscm/update-server.rst awscli-1.18.69/awscli/examples/opsworkscm/update-server.rst --- awscli-1.11.13/awscli/examples/opsworkscm/update-server.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/opsworkscm/update-server.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,42 @@ +**To update a server** + +The following ``update-server`` command updates the maintenance start time of the specified Chef Automate server in your default region. The ``--preferred-maintenance-window`` parameter is added to change the start day and time of server maintenance to Mondays at 9:15 a.m. UTC.:: + + aws opsworks-cm update-server \ + --server-name "automate-06" \ + --preferred-maintenance-window "Mon:09:15" + +The output shows you information similar to the following about the updated server. :: + + { + "Server": { + "BackupRetentionCount": 8, + "CreatedAt": 2016-07-29T13:38:47.520Z, + "DisableAutomatedBackup": TRUE, + "Endpoint": "https://opsworks-cm.us-east-1.amazonaws.com", + "Engine": "Chef", + "EngineAttributes": [ + { + "Name": "CHEF_DELIVERY_ADMIN_PASSWORD", + "Value": "1Password1" + } + ], + "EngineModel": "Single", + "EngineVersion": "12", + "InstanceProfileArn": "arn:aws:iam::1019881987024:instance-profile/automate-06-1010V4UU2WRM2", + "InstanceType": "m4.large", + "KeyPair": "", + "MaintenanceStatus": "OK", + "PreferredBackupWindow": "Mon:09:15", + "PreferredMaintenanceWindow": "03:00", + "SecurityGroupIds": [ "sg-1a24c270" ], + "ServerArn": "arn:aws:iam::1019881987024:instance/automate-06-1010V4UU2WRM2", + "ServerName": "automate-06", + "ServiceRoleArn": "arn:aws:iam::1019881987024:role/aws-opsworks-cm-service-role.1114810729735", + "Status": "HEALTHY", + "StatusReason": "", + "SubnetIds": [ "subnet-49436a18" ] + } + } + +For more information, see `UpdateServer `_ in the *AWS OpsWorks for Chef Automate API Reference*. diff -Nru awscli-1.11.13/awscli/examples/organizations/accept-handshake.rst awscli-1.18.69/awscli/examples/organizations/accept-handshake.rst --- awscli-1.11.13/awscli/examples/organizations/accept-handshake.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/accept-handshake.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,52 @@ +**To accept a handshake from another account** + +Bill, the owner of an organization, has previously invited Juan's account to join his organization. The following example shows Juan's account accepting the handshake and thus agreeing to the invitation. :: + + aws organizations accept-handshake --handshake-id h-examplehandshakeid111 + +The output shows the following: :: + + { + "Handshake": { + "Action": "INVITE", + "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", + "RequestedTimestamp": 1481656459.257, + "ExpirationTimestamp": 1482952459.257, + "Id": "h-examplehandshakeid111", + "Parties": [ + { + "Id": "o-exampleorgid", + "Type": "ORGANIZATION" + }, + { + "Id": "juan@example.com", + "Type": "EMAIL" + } + ], + "Resources": [ + { + "Resources": [ + { + "Type": "MASTER_EMAIL", + "Value": "bill@amazon.com" + }, + { + "Type": "MASTER_NAME", + "Value": "Org Master Account" + }, + { + "Type": "ORGANIZATION_FEATURE_SET", + "Value": "ALL" + } + ], + "Type": "ORGANIZATION", + "Value": "o-exampleorgid" + }, + { + "Type": "EMAIL", + "Value": "juan@example.com" + } + ], + "State": "ACCEPTED" + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/organizations/attach-policy.rst awscli-1.18.69/awscli/examples/organizations/attach-policy.rst --- awscli-1.11.13/awscli/examples/organizations/attach-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/attach-policy.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,17 @@ +**To attach a policy to a root, OU, or account** + +**Example 1** + +The following example shows how to attach a service control policy (SCP) to an OU: :: + + aws organizations attach-policy + --policy-id p-examplepolicyid111 + --target-id ou-examplerootid111-exampleouid111 + +**Example 2** + +The following example shows how to attach a service control policy directly to an account: :: + + aws organizations attach-policy + --policy-id p-examplepolicyid111 + --target-id 333333333333 diff -Nru awscli-1.11.13/awscli/examples/organizations/cancel-handshake.rst awscli-1.18.69/awscli/examples/organizations/cancel-handshake.rst --- awscli-1.11.13/awscli/examples/organizations/cancel-handshake.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/cancel-handshake.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,56 @@ +**To cancel a handshake sent from another account** + +Bill previously sent an invitation to Susan's account to join his organization. He changes his mind and decides to cancel the invitation before Susan accepts it. The following example shows Bill's cancellation: :: + + aws organizations cancel-handshake --handshake-id h-examplehandshakeid111 + +The output includes a handshake object that shows that the state is now ``CANCELED``: :: + + { + "Handshake": { + "Id": "h-examplehandshakeid111", + "State":"CANCELED", + "Action": "INVITE", + "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", + "Parties": [ + { + "Id": "o-exampleorgid", + "Type": "ORGANIZATION" + }, + { + "Id": "susan@example.com", + "Type": "EMAIL" + } + ], + "Resources": [ + { + "Type": "ORGANIZATION", + "Value": "o-exampleorgid", + "Resources": [ + { + "Type": "MASTER_EMAIL", + "Value": "bill@example.com" + }, + { + "Type": "MASTER_NAME", + "Value": "Master Account" + }, + { + "Type": "ORGANIZATION_FEATURE_SET", + "Value": "CONSOLIDATED_BILLING" + } + ] + }, + { + "Type": "EMAIL", + "Value": "anika@example.com" + }, + { + "Type": "NOTES", + "Value": "This is a request for Susan's account to join Bob's organization." + } + ], + "RequestedTimestamp": 1.47008383521E9, + "ExpirationTimestamp": 1.47137983521E9 + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/organizations/create-account.rst awscli-1.18.69/awscli/examples/organizations/create-account.rst --- awscli-1.11.13/awscli/examples/organizations/create-account.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/create-account.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,20 @@ +**To create a member account that is automatically part of the organization** + +The following example shows how to create a member account in an organization. The member account is configured with the name Production Account and the email address of susan@example.com. Organizations automatically creates an IAM role using the default name of OrganizationAccountAccessRole because the roleName parameter is not specified. Also, the setting that allows IAM users or roles with sufficient permissions to access account billing data is set to the default value of ALLOW because the IamUserAccessToBilling parameter is not specified. Organizations automatically sends Susan a "Welcome to AWS" email: :: + + aws organizations create-account --email susan@example.com --account-name "Production Account" + +The output includes a request object that shows that the status is now ``IN_PROGRESS``: :: + + { + "CreateAccountStatus": { + "State": "IN_PROGRESS", + "Id": "car-examplecreateaccountrequestid111" + } + } + +You can later query the current status of the request by providing the Id response value to the describe-create-account-status command as the value for the create-account-request-id parameter. + +For more information, see `Creating an AWS Account in Your Organization`_ in the *AWS Organizations Users Guide*. + +.. _`Creating an AWS Account in Your Organization`: http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_create.html diff -Nru awscli-1.11.13/awscli/examples/organizations/create-organizational-unit.rst awscli-1.18.69/awscli/examples/organizations/create-organizational-unit.rst --- awscli-1.11.13/awscli/examples/organizations/create-organizational-unit.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/create-organizational-unit.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,15 @@ +**To create an OU in a root or parent OU** + +The following example shows how to create an OU that is named AccountingOU: :: + + aws organizations create-organizational-unit --parent-id r-examplerootid111 --name AccountingOU + +The output includes an organizationalUnit object with details about the new OU: :: + + { + "OrganizationalUnit": { + "Id": "ou-examplerootid111-exampleouid111", + "Arn": "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111", + "Name": "AccountingOU" + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/organizations/create-organization.rst awscli-1.18.69/awscli/examples/organizations/create-organization.rst --- awscli-1.11.13/awscli/examples/organizations/create-organization.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/create-organization.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,48 @@ +**Example 1: To create a new organization** + +Bill wants to create an organization using credentials from account 111111111111. The following example shows that the account becomes the master account in the new organization. Because he does not specify a features set, the new organization defaults to all features enabled and service control policies are enabled on the root. :: + + aws organizations create-organization + +The output includes an organization object with details about the new organization: :: + + { + "Organization": { + "AvailablePolicyTypes": [ + { + "Status": "ENABLED", + "Type": "SERVICE_CONTROL_POLICY" + } + ], + "MasterAccountId": "111111111111", + "MasterAccountArn": "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111", + "MasterAccountEmail": "bill@example.com", + "FeatureSet": "ALL", + "Id": "o-exampleorgid", + "Arn": "arn:aws:organizations::111111111111:organization/o-exampleorgid" + } + } + +**Example 2: To create a new organization with only consolidated billing features enabled** + +The following example creates an organization that supports only the consolidated billing features: :: + + aws organizations create-organization --feature-set CONSOLIDATED_BILLING + +The output includes an organization object with details about the new organization: :: + + { + "Organization": { + "Arn": "arn:aws:organizations::111111111111:organization/o-exampleorgid", + "AvailablePolicyTypes": [], + "Id": "o-exampleorgid", + "MasterAccountArn": "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111", + "MasterAccountEmail": "bill@example.com", + "MasterAccountId": "111111111111", + "FeatureSet": "CONSOLIDATED_BILLING" + } + } + +For more information, see `Creating an Organization`_ in the *AWS Organizations Users Guide*. + +.. _`Creating an Organization`: http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_create.html diff -Nru awscli-1.11.13/awscli/examples/organizations/create-policy.rst awscli-1.18.69/awscli/examples/organizations/create-policy.rst --- awscli-1.11.13/awscli/examples/organizations/create-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/create-policy.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,29 @@ +**Example 1: To create a policy with a text source file for the JSON policy** + +The following example shows you how to create an service control policy (SCP) named ``AllowAllS3Actions``. The policy contents are taken from a file on the local computer called ``policy.json``. :: + + aws organizations create-policy --content file://policy.json --name AllowAllS3Actions, --type SERVICE_CONTROL_POLICY --description "Allows delegation of all S3 actions" + +The output includes a policy object with details about the new policy: :: + + { + "Policy": { + "Content": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"s3:*\"],\"Resource\":[\"*\"]}]}", + "PolicySummary": { + "Arn": "arn:aws:organizations::o-exampleorgid:policy/service_control_policy/p-examplepolicyid111", + "Description": "Allows delegation of all S3 actions", + "Name": "AllowAllS3Actions", + "Type":"SERVICE_CONTROL_POLICY" + } + } + } + +**Example 2: To create a policy with a JSON policy as a parameter** + +The following example shows you how to create the same SCP, this time by embedding the policy contents as a JSON string in the parameter. The string must be escaped with backslashes before the double quotes to ensure that they are treated as literals in the parameter, which itself is surrounded by double quotes: :: + + aws organizations create-policy --content "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"s3:*\"],\"Resource\":[\"*\"]}]}" --name AllowAllS3Actions --type SERVICE_CONTROL_POLICY --description "Allows delegation of all S3 actions" + +For more information about creating and using policies in your organization, see `Managing Organization Policies`_ in the *AWS Organizations User Guide*. + +.. _`Managing Organization Policies`: http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies.html \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/organizations/decline-handshake.rst awscli-1.18.69/awscli/examples/organizations/decline-handshake.rst --- awscli-1.11.13/awscli/examples/organizations/decline-handshake.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/decline-handshake.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,52 @@ +**To decline a handshake sent from another account** + +The following example shows that Susan, an admin who is the owner of account 222222222222, declines an invitation to join Bill's organization. The DeclineHandshake operation returns a handshake object, showing that the state is now DECLINED: :: + + aws organizations decline-handshake --handshake-id h-examplehandshakeid111 + +The output includes a handshake object that shows the new state of ``DECLINED``: :: + + { + "Handshake": { + "Id": "h-examplehandshakeid111", + "State": "DECLINED", + "Resources": [ + { + "Type": "ORGANIZATION", + "Value": "o-exampleorgid", + "Resources": [ + { + "Type": "MASTER_EMAIL", + "Value": "bill@example.com" + }, + { + "Type": "MASTER_NAME", + "Value": "Master Account" + } + ] + }, + { + "Type": "EMAIL", + "Value": "susan@example.com" + }, + { + "Type": "NOTES", + "Value": "This is an invitation to Susan's account to join the Bill's organization." + } + ], + "Parties": [ + { + "Type": "EMAIL", + "Id": "susan@example.com" + }, + { + "Type": "ORGANIZATION", + "Id": "o-exampleorgid" + } + ], + "Action": "INVITE", + "RequestedTimestamp": 1470684478.687, + "ExpirationTimestamp": 1471980478.687, + "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111" + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/organizations/delete-organizational-unit.rst awscli-1.18.69/awscli/examples/organizations/delete-organizational-unit.rst --- awscli-1.11.13/awscli/examples/organizations/delete-organizational-unit.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/delete-organizational-unit.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,5 @@ +**To delete an OU** + +The following example shows how to delete an OU. The example assumes that you previously removed all accounts and other OUs from the OU: :: + + aws organizations delete-organizational-unit --organizational-unit-id ou-examplerootid111-exampleouid111 diff -Nru awscli-1.11.13/awscli/examples/organizations/delete-organization.rst awscli-1.18.69/awscli/examples/organizations/delete-organization.rst --- awscli-1.11.13/awscli/examples/organizations/delete-organization.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/delete-organization.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,5 @@ +**To delete an organization** + +The following example shows how to delete an organization. To perform this operation, you must be an admin of the master account in the organization. The example assumes that you previously removed all the member accounts, OUs, and policies from the organization: :: + + aws organizations delete-organization \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/organizations/delete-policy.rst awscli-1.18.69/awscli/examples/organizations/delete-policy.rst --- awscli-1.11.13/awscli/examples/organizations/delete-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/delete-policy.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,5 @@ +**To delete a policy** + +The following example shows how to delete a policy from an organization. The example assumes that you previously detached the policy from all entities: :: + + aws organizations delete-policy --policy-id p-examplepolicyid111 \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/organizations/describe-account.rst awscli-1.18.69/awscli/examples/organizations/describe-account.rst --- awscli-1.11.13/awscli/examples/organizations/describe-account.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/describe-account.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,19 @@ +**To get the details about an account** + +The following example shows you how to request details about an account: :: + + aws organizations describe-account --account-id 555555555555 + +The output shows an account object with the details about the account: :: + + { + "Account": { + "Id": "555555555555", + "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/555555555555", + "Name": "Beta account", + "Email": "anika@example.com", + "JoinedMethod": "INVITED", + "JoinedTimeStamp": 1481756563.134, + "Status": "ACTIVE" + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/organizations/describe-create-account-status.rst awscli-1.18.69/awscli/examples/organizations/describe-create-account-status.rst --- awscli-1.11.13/awscli/examples/organizations/describe-create-account-status.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/describe-create-account-status.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,20 @@ +**To get the latest status about a request to create an account** + +The following example shows how to request the latest status for a previous request to create an account in an organization. The specified --request-id comes from the response of the original call to create-account. The account creation request shows by the status field that Organizations successfully completed the creation of the account. + +Command:: + + aws organizations describe-create-account-status --create-account-request-id car-examplecreateaccountrequestid111 + +Output:: + + { + "CreateAccountStatus": { + "State": "SUCCEEDED", + "AccountId": "555555555555", + "AccountName": "Beta account", + "RequestedTimestamp": 1470684478.687, + "CompletedTimestamp": 1470684532.472, + "Id": "car-examplecreateaccountrequestid111" + } + } diff -Nru awscli-1.11.13/awscli/examples/organizations/describe-handshake.rst awscli-1.18.69/awscli/examples/organizations/describe-handshake.rst --- awscli-1.11.13/awscli/examples/organizations/describe-handshake.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/describe-handshake.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,48 @@ +**To get information about a handshake** + +The following example shows you how to request details about a handshake. The handshake ID comes either from the original call to ``InviteAccountToOrganization``, or from a call to ``ListHandshakesForAccount`` or ``ListHandshakesForOrganization``: :: + + aws organizations describe-handshake --handshake-id h-examplehandshakeid111 + +The output includes a handshake object that has all the details about the requested handshake: :: + + { + "Handshake": { + "Id": "h-examplehandshakeid111", + "State": "OPEN", + "Resources": [ + { + "Type": "ORGANIZATION", + "Value": "o-exampleorgid", + "Resources": [ + { + "Type": "MASTER_EMAIL", + "Value": "bill@example.com" + }, + { + "Type": "MASTER_NAME", + "Value": "Master Account" + } + ] + }, + { + "Type": "EMAIL", + "Value": "anika@example.com" + } + ], + "Parties": [ + { + "Type": "ORGANIZATION", + "Id": "o-exampleorgid" + }, + { + "Type": "EMAIL", + "Id": "anika@example.com" + } + ], + "Action": "INVITE", + "RequestedTimestamp": 1470158698.046, + "ExpirationTimestamp": 1471454698.046, + "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111" + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/organizations/describe-organizational-unit.rst awscli-1.18.69/awscli/examples/organizations/describe-organizational-unit.rst --- awscli-1.11.13/awscli/examples/organizations/describe-organizational-unit.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/describe-organizational-unit.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,15 @@ +**To get information about an OU** + +The following example shows how to request details about an OU: :: + + aws organizations describe-organizational-unit --organizational-unit-id ou-examplerootid111-exampleouid111 + +The output includes an OrganizationUnit object that contains the details about the OU: :: + + { + "OrganizationalUnit": { + "Name": "Accounting Group", + "Arn": "arn:aws:organizations::o-exampleorgid:ou/o-exampleorgid/ou-examplerootid111-exampleouid111", + "Id": "ou-examplerootid111-exampleouid111" + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/organizations/describe-organization.rst awscli-1.18.69/awscli/examples/organizations/describe-organization.rst --- awscli-1.11.13/awscli/examples/organizations/describe-organization.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/describe-organization.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,24 @@ +**To get information about the current organization** + +The following example shows you how to request details about an organization: :: + + aws organizations describe-organization + +The output includes an organization object that has the details about the organization: :: + + { + "Organization": { + "MasterAccountArn": "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111", + "MasterAccountEmail": "bill@example.com", + "MasterAccountId": "111111111111", + "Id": "o-exampleorgid", + "FeatureSet": "ALL", + "Arn": "arn:aws:organizations::111111111111:organization/o-exampleorgid", + "AvailablePolicyTypes": [ + { + "Status": "ENABLED", + "Type": "SERVICE_CONTROL_POLICY" + } + ] + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/organizations/describe-policy.rst awscli-1.18.69/awscli/examples/organizations/describe-policy.rst --- awscli-1.11.13/awscli/examples/organizations/describe-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/describe-policy.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,21 @@ +**To get information about a policy** + +The following example shows how to request information about a policy: :: + + aws organizations describe-policy --policy-id p-examplepolicyid111 + +The output includes a policy object that contains details about the policy: :: + + { + "Policy": { + "Content": "{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": \"*\",\n \"Resource\": \"*\"\n }\n ]\n}", + "PolicySummary": { + "Arn": "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111", + "Type": "SERVICE_CONTROL_POLICY", + "Id": "p-examplepolicyid111", + "AwsManaged": false, + "Name": "AllowAllS3Actions", + "Description": "Enables admins to delegate S3 permissions" + } + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/organizations/detach-policy.rst awscli-1.18.69/awscli/examples/organizations/detach-policy.rst --- awscli-1.11.13/awscli/examples/organizations/detach-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/detach-policy.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,5 @@ +**To detach a policy from a root, OU, or account** + +The following example shows how to detach a policy from an OU: :: + + aws organizations detach-policy --target-id ou-examplerootid111-exampleouid111 --policy-id p-examplepolicyid111 diff -Nru awscli-1.11.13/awscli/examples/organizations/disable-policy-type.rst awscli-1.18.69/awscli/examples/organizations/disable-policy-type.rst --- awscli-1.11.13/awscli/examples/organizations/disable-policy-type.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/disable-policy-type.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,16 @@ +**To disable a policy type in a root** + +The following example shows how to disable the service control policy (SCP) policy type in a root: :: + + aws organizations disable-policy-type --root-id r-examplerootid111 --policy-type SERVICE_CONTROL_POLICY + +The output shows that the PolicyTypes response element no longer includes SERVICE_CONTROL_POLICY: :: + + { + "Root": { + "PolicyTypes": [], + "Name": "Root", + "Id": "r-examplerootid111", + "Arn": "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111" + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/organizations/enable-all-features.rst awscli-1.18.69/awscli/examples/organizations/enable-all-features.rst --- awscli-1.11.13/awscli/examples/organizations/enable-all-features.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/enable-all-features.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,30 @@ +**To enable all features in an organization** + +This example shows the administrator asking all the invited accounts in the organization to approve enabled all features in the organization. AWS Organizations sends an email to the address that is registered with every invited member account asking the owner to approve the change to all features by accepting the handshake that is sent. After all invited member accounts accept the handshake, the organization administrator can finalize the change to all features, and those with appropriate permissions can create policies and apply them to roots, OUs, and accounts: :: + + aws organizations enable-all-features + +The output is a handshake object that is sent to all invited member accounts for approval: :: + + { + "Handshake": { + "Action": "ENABLE_ALL_FEATURES", + "Arn":"arn:aws:organizations::111111111111:handshake/o-exampleorgid/enable_all_features/h-examplehandshakeid111", + "ExpirationTimestamp":1.483127868609E9, + "Id":"h-examplehandshakeid111", + "Parties": [ + { + "id":"o-exampleorgid", + "type":"ORGANIZATION" + } + ], + "requestedTimestamp":1.481831868609E9, + "resources": [ + { + "type":"ORGANIZATION", + "value":"o-exampleorgid" + } + ], + "state":"REQUESTED" + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/organizations/enable-policy-type.rst awscli-1.18.69/awscli/examples/organizations/enable-policy-type.rst --- awscli-1.11.13/awscli/examples/organizations/enable-policy-type.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/enable-policy-type.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,21 @@ +**To enable the use of a policy type in a root** + +The following example shows how to enable the service control policy (SCP) policy type in a root: :: + + aws organizations enable-policy-type --root-id r-examplerootid111 --policy-type SERVICE_CONTROL_POLICY + +The output shows a root object with a policyTypes response element showing that SCPs are now enabled: :: + + { + "Root": { + "PolicyTypes": [ + { + "Status":"ENABLED", + "Type":"SERVICE_CONTROL_POLICY" + } + ], + "Id": "r-examplerootid111", + "Name": "Root", + "Arn": "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111" + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/organizations/invite-account-to-organization.rst awscli-1.18.69/awscli/examples/organizations/invite-account-to-organization.rst --- awscli-1.11.13/awscli/examples/organizations/invite-account-to-organization.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/invite-account-to-organization.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,52 @@ +**To invite an account to join an organization** + +The following example shows the master account owned by bill@example.com inviting the account owned by juan@example.com to join an organization: :: + + aws organizations invite-account-to-organization --target '{"Type": "EMAIL", "Id": "juan@example.com"}' --notes "This is a request for Juan's account to join Bill's organization." + +The output includes a handshake structure that shows what is sent to the invited account: :: + + { + "Handshake": { + "Action": "INVITE", + "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", + "ExpirationTimestamp": 1482952459.257, + "Id": "h-examplehandshakeid111", + "Parties": [ + { + "Id": "o-exampleorgid", + "Type": "ORGANIZATION" + }, + { + "Id": "juan@example.com", + "Type": "EMAIL" + } + ], + "RequestedTimestamp": 1481656459.257, + "Resources": [ + { + "Resources": [ + { + "Type": "MASTER_EMAIL", + "Value": "bill@amazon.com" + }, + { + "Type": "MASTER_NAME", + "Value": "Org Master Account" + }, + { + "Type": "ORGANIZATION_FEATURE_SET", + "Value": "FULL" + } + ], + "Type": "ORGANIZATION", + "Value": "o-exampleorgid" + }, + { + "Type": "EMAIL", + "Value": "juan@example.com" + } + ], + "State": "OPEN" + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/organizations/leave-organization.rst awscli-1.18.69/awscli/examples/organizations/leave-organization.rst --- awscli-1.11.13/awscli/examples/organizations/leave-organization.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/leave-organization.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,5 @@ +**To leave an organization as a member account** + +The following example shows the administrator of a member account requesting to leave the organization it is currently a member of: :: + + aws organizations leave-organization diff -Nru awscli-1.11.13/awscli/examples/organizations/list-accounts-for-parent.rst awscli-1.18.69/awscli/examples/organizations/list-accounts-for-parent.rst --- awscli-1.11.13/awscli/examples/organizations/list-accounts-for-parent.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/list-accounts-for-parent.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,30 @@ +**To retrieve a list of all of the accounts in a specified parent root or OU** + +The following example shows how to request a list of the accounts in an OU: :: + + aws organizations list-accounts-for-parent --parent-id ou-examplerootid111-exampleouid111 + +The output includes a list of account summary objects. :: + + { + "Accounts": [ + { + "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333", + "JoinedMethod": "INVITED", + "JoinedTimestamp": 1481835795.536, + "Id": "333333333333", + "Name": "Development Account", + "Email": "juan@example.com", + "Status": "ACTIVE" + }, + { + "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/444444444444", + "JoinedMethod": "INVITED", + "JoinedTimestamp": 1481835812.143, + "Id": "444444444444", + "Name": "Test Account", + "Email": "anika@example.com", + "Status": "ACTIVE" + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/organizations/list-accounts.rst awscli-1.18.69/awscli/examples/organizations/list-accounts.rst --- awscli-1.11.13/awscli/examples/organizations/list-accounts.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/list-accounts.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,48 @@ +**To retrieve a list of all of the accounts in an organization** + +The following example shows you how to request a list of the accounts in an organization: :: + + aws organizations list-accounts + +The output includes a list of account summary objects. :: + + { + "Accounts": [ + { + "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111", + "JoinedMethod": "INVITED", + "JoinedTimestamp": 1481830215.45, + "Id": "111111111111", + "Name": "Master Account", + "Email": "bill@example.com", + "Status": "ACTIVE" + }, + { + "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/222222222222", + "JoinedMethod": "INVITED", + "JoinedTimestamp": 1481835741.044, + "Id": "222222222222", + "Name": "Production Account", + "Email": "alice@example.com", + "Status": "ACTIVE" + }, + { + "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333", + "JoinedMethod": "INVITED", + "JoinedTimestamp": 1481835795.536, + "Id": "333333333333", + "Name": "Development Account", + "Email": "juan@example.com", + "Status": "ACTIVE" + }, + { + "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/444444444444", + "JoinedMethod": "INVITED", + "JoinedTimestamp": 1481835812.143, + "Id": "444444444444", + "Name": "Test Account", + "Email": "anika@example.com", + "Status": "ACTIVE" + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/organizations/list-children.rst awscli-1.18.69/awscli/examples/organizations/list-children.rst --- awscli-1.11.13/awscli/examples/organizations/list-children.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/list-children.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,20 @@ +**To retrieve the child accounts and OUs of a parent OU or root** + +The following example you how to list the root or OU that contains that account 444444444444: :: + + aws organizations list-children --child-type ORGANIZATIONAL_UNIT --parent-id ou-examplerootid111-exampleouid111 + +The output shows the two child OUs that are contained by the parent: :: + + { + "Children": [ + { + "Id": "ou-examplerootid111-exampleouid111", + "Type":"ORGANIZATIONAL_UNIT" + }, + { + "Id":"ou-examplerootid111-exampleouid222", + "Type":"ORGANIZATIONAL_UNIT" + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/organizations/list-create-account-status.rst awscli-1.18.69/awscli/examples/organizations/list-create-account-status.rst --- awscli-1.11.13/awscli/examples/organizations/list-create-account-status.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/list-create-account-status.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,39 @@ +**Example 1: To retrieve a list of the account creation requests made in the current organization** + +The following example shows how to request a list of account creation requests for an organization that have completed successfully: :: + + aws organizations list-create-account-status --states SUCCEEDED + +The output includes an array of objects with information about each request. :: + + { + "CreateAccountStatuses": [ + { + "AccountId": "444444444444", + "AccountName": "Developer Test Account", + "CompletedTimeStamp": 1481835812.143, + "Id": "car-examplecreateaccountrequestid111", + "RequestedTimeStamp": 1481829432.531, + "State": "SUCCEEDED" + } + ] + } + +**Example 2: To retrieve a list of the in progress account creation requests made in the current organization** + +The following example gets a list of in-progress account creation requests for an organization: :: + + aws organizations list-create-account-status --states IN_PROGRESS + +The output includes an array of objects with information about each request. :: + + { + "CreateAccountStatuses": [ + { + "State": "IN_PROGRESS", + "Id": "car-examplecreateaccountrequestid111", + "RequestedTimeStamp": 1481829432.531, + "AccountName": "Production Account" + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/organizations/list-handshakes-for-account.rst awscli-1.18.69/awscli/examples/organizations/list-handshakes-for-account.rst --- awscli-1.11.13/awscli/examples/organizations/list-handshakes-for-account.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/list-handshakes-for-account.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,52 @@ +**To retrieve a list of the handshakes sent to an account** + +The following example shows how to get a list of all handshakes that are associated with the account of the credentials that were used to call the operation: :: + + aws organizations list-handshakes-for-account + +The output includes a list of handshake structures with information about each handshake including its current state: :: + + { + "Handshake": { + "Action": "INVITE", + "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", + "ExpirationTimestamp": 1482952459.257, + "Id": "h-examplehandshakeid111", + "Parties": [ + { + "Id": "o-exampleorgid", + "Type": "ORGANIZATION" + }, + { + "Id": "juan@example.com", + "Type": "EMAIL" + } + ], + "RequestedTimestamp": 1481656459.257, + "Resources": [ + { + "Resources": [ + { + "Type": "MASTER_EMAIL", + "Value": "bill@amazon.com" + }, + { + "Type": "MASTER_NAME", + "Value": "Org Master Account" + }, + { + "Type": "ORGANIZATION_FEATURE_SET", + "Value": "FULL" + } + ], + "Type": "ORGANIZATION", + "Value": "o-exampleorgid" + }, + { + "Type": "EMAIL", + "Value": "juan@example.com" + } + ], + "State": "OPEN" + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/organizations/list-handshakes-for-organization.rst awscli-1.18.69/awscli/examples/organizations/list-handshakes-for-organization.rst --- awscli-1.11.13/awscli/examples/organizations/list-handshakes-for-organization.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/list-handshakes-for-organization.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,100 @@ +**To retrieve a list of the handshakes associated with an organization** + +The following example shows how to get a list of handshakes that are associated with the current organization: :: + + aws organizations list-handshakes-for-organization + +The output shows two handshakes. The first one is an invitation to Juan's account and shows a state of OPEN. The second is an invitation to Anika's account and shows a state of ACCEPTED: :: + + { + "Handshakes": [ + { + "Action": "INVITE", + "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", + "ExpirationTimestamp": 1482952459.257, + "Id": "h-examplehandshakeid111", + "Parties": [ + { + "Id": "o-exampleorgid", + "Type": "ORGANIZATION" + }, + { + "Id": "juan@example.com", + "Type": "EMAIL" + } + ], + "RequestedTimestamp": 1481656459.257, + "Resources": [ + { + "Resources": [ + { + "Type": "MASTER_EMAIL", + "Value": "bill@amazon.com" + }, + { + "Type": "MASTER_NAME", + "Value": "Org Master Account" + }, + { + "Type": "ORGANIZATION_FEATURE_SET", + "Value": "FULL" + } + ], + "Type": "ORGANIZATION", + "Value": "o-exampleorgid" + }, + { + "Type": "EMAIL", + "Value": "juan@example.com" + }, + { + "Type":"NOTES", + "Value":"This is an invitation to Juan's account to join Bill's organization." + } + ], + "State": "OPEN" + }, + { + "Action": "INVITE", + "State":"ACCEPTED", + "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", + "ExpirationTimestamp": 1.471797437427E9, + "Id": "h-examplehandshakeid222", + "Parties": [ + { + "Id": "o-exampleorgid", + "Type": "ORGANIZATION" + }, + { + "Id": "anika@example.com", + "Type": "EMAIL" + } + ], + "RequestedTimestamp": 1.469205437427E9, + "Resources": [ + { + "Resources": [ + { + "Type":"MASTER_EMAIL", + "Value":"bill@example.com" + }, + { + "Type":"MASTER_NAME", + "Value":"Master Account" + } + ], + "Type":"ORGANIZATION", + "Value":"o-exampleorgid" + }, + { + "Type":"EMAIL", + "Value":"anika@example.com" + }, + { + "Type":"NOTES", + "Value":"This is an invitation to Anika's account to join Bill's organization." + } + ] + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/organizations/list-organizational-units-for-parent.rst awscli-1.18.69/awscli/examples/organizations/list-organizational-units-for-parent.rst --- awscli-1.11.13/awscli/examples/organizations/list-organizational-units-for-parent.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/list-organizational-units-for-parent.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,20 @@ +**To retrieve a list of the OUs in a parent OU or root** + +The following example shows you how to get a list of OUs in a specified root: :: + + aws organizations list-organizational-units-for-parent --parent-id r-examplerootid111 + +The output shows that the specified root contains two OUs and shows details of each: :: + + { + "OrganizationalUnits": [ + { + "Name": "AccountingDepartment", + "Arn": "arn:aws:organizations::o-exampleorgid:ou/r-examplerootid111/ou-examplerootid111-exampleouid111" + }, + { + "Name": "ProductionDepartment", + "Arn": "arn:aws:organizations::o-exampleorgid:ou/r-examplerootid111/ou-examplerootid111-exampleouid222" + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/organizations/list-parents.rst awscli-1.18.69/awscli/examples/organizations/list-parents.rst --- awscli-1.11.13/awscli/examples/organizations/list-parents.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/list-parents.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,17 @@ +**To list the parent OUs or roots for an account or child OU** + +The following example you how to list the root or parent OU that contains that account 444444444444: :: + + aws organizations list-parents --child-id 444444444444 + + +The output shows that the specified account is in the OU with specified ID: :: + + { + "Parents": [ + { + "Id": "ou-examplerootid111-exampleouid111", + "Type": "ORGANIZATIONAL_UNIT" + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/organizations/list-policies-for-target.rst awscli-1.18.69/awscli/examples/organizations/list-policies-for-target.rst --- awscli-1.11.13/awscli/examples/organizations/list-policies-for-target.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/list-policies-for-target.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,20 @@ +**To retrieve a list of the SCPs attached directly to an account** + +The following example shows how to get a list of all service control policies (SCPs), as specified by the Filter parameter, that are directly attached to an account: :: + + aws organizations list-policies-for-target --filter SERVICE_CONTROL_POLICY --target-id 444444444444 + +The output includes a list of policy structures with summary information about the policies. The list does not include policies that apply to the account because of inheritance from its location in an OU hierarchy: :: + + { + "Policies": [ + { + "Type": "SERVICE_CONTROL_POLICY", + "Name": "AllowAllEC2Actions", + "AwsManaged", false, + "Id": "p-examplepolicyid222", + "Arn": "arn:aws:organizations::o-exampleorgid:policy/service_control_policy/p-examplepolicyid222", + "Description": "Enables account admins to delegate permissions for any EC2 actions to users and roles in their accounts." + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/organizations/list-policies.rst awscli-1.18.69/awscli/examples/organizations/list-policies.rst --- awscli-1.11.13/awscli/examples/organizations/list-policies.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/list-policies.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,36 @@ +**To retrieve a list of all policies in an organization of a certain type** + +The following example shows you how to get a list of SCPs, as specified by the filter parameter: :: + + aws organizations list-policies --filter SERVICE_CONTROL_POLICY + +The output includes a list of policies with summary information: :: + + { + "Policies": [ + { + "Type": "SERVICE_CONTROL_POLICY", + "Name": "AllowAllS3Actions", + "AwsManaged": false, + "Id": "p-examplepolicyid111", + "Arn": "arn:aws:organizations::111111111111:policy/service_control_policy/p-examplepolicyid111", + "Description": "Enables account admins to delegate permissions for any S3 actions to users and roles in their accounts." + }, + { + "Type": "SERVICE_CONTROL_POLICY", + "Name": "AllowAllEC2Actions", + "AwsManaged": false, + "Id": "p-examplepolicyid222", + "Arn": "arn:aws:organizations::111111111111:policy/service_control_policy/p-examplepolicyid222", + "Description": "Enables account admins to delegate permissions for any EC2 actions to users and roles in their accounts." + }, + { + "AwsManaged": true, + "Description": "Allows access to every operation", + "Type": "SERVICE_CONTROL_POLICY", + "Id": "p-FullAWSAccess", + "Arn": "arn:aws:organizations::aws:policy/service_control_policy/p-FullAWSAccess", + "Name": "FullAWSAccess" + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/organizations/list-roots.rst awscli-1.18.69/awscli/examples/organizations/list-roots.rst --- awscli-1.11.13/awscli/examples/organizations/list-roots.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/list-roots.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,23 @@ +**To retrieve a list of the roots in an organization** + +This example shows you how to get the list of roots for an organization: :: + + aws organizations list-roots + +The output includes a list of root structures with summary information: :: + + { + "Roots": [ + { + "Name": "Root", + "Arn": "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111", + "Id": "r-examplerootid111", + "PolicyTypes": [ + { + "Status":"ENABLED", + "Type":"SERVICE_CONTROL_POLICY" + } + ] + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/organizations/list-targets-for-policy.rst awscli-1.18.69/awscli/examples/organizations/list-targets-for-policy.rst --- awscli-1.11.13/awscli/examples/organizations/list-targets-for-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/list-targets-for-policy.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,30 @@ +**To retrieve a list of the roots, OUs, and accounts that a policy is attached to** + +The following example shows how to get a list of the roots, OUs, and accounts that the specified policy is attached to: :: + + aws organizations list-targets-for-policy --policy-id p-FullAWSAccess + +The output includes a list of attachment objects with summary information about the roots, OUs, and accounts the policy is attached to: :: + + { + "Targets": [ + { + "Arn": "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111", + "Name": "Root", + "TargetId":"r-examplerootid111", + "Type":"ROOT" + }, + { + "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333;", + "Name": "Developer Test Account", + "TargetId": "333333333333", + "Type": "ACCOUNT" + }, + { + "Arn":"arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111", + "Name":"Accounting", + "TargetId":"ou-examplerootid111-exampleouid111", + "Type":"ORGANIZATIONAL_UNIT" + } + ] + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/organizations/move-account.rst awscli-1.18.69/awscli/examples/organizations/move-account.rst --- awscli-1.11.13/awscli/examples/organizations/move-account.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/move-account.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,5 @@ +**To move an account between roots or OUs** + +The following example shows you how to move the master account in the organization from the root to an OU: :: + + aws organizations move-account --account-id 333333333333 --source-parent-id r-examplerootid111 --destination-parent-id ou-examplerootid111-exampleouid111 \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/organizations/remove-account-from-organization.rst awscli-1.18.69/awscli/examples/organizations/remove-account-from-organization.rst --- awscli-1.11.13/awscli/examples/organizations/remove-account-from-organization.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/remove-account-from-organization.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,5 @@ +**To remove an account from an organization as the master account** + +The following example shows you how to remove an account from an organization: :: + + aws organizations remove-account-from-organization --account-id 333333333333 diff -Nru awscli-1.11.13/awscli/examples/organizations/update-organizational-unit.rst awscli-1.18.69/awscli/examples/organizations/update-organizational-unit.rst --- awscli-1.11.13/awscli/examples/organizations/update-organizational-unit.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/update-organizational-unit.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,15 @@ +**To rename an OU** + +This example shows you how to rename an OU: In this example, the OU is renamed "AccountingOU": :: + + aws organizations update-organizational-unit --organizational-unit-id ou-examplerootid111-exampleouid111 --name AccountingOU + +The output shows the new name: :: + + { + "OrganizationalUnit": { + "Id": "ou-examplerootid111-exampleouid111" + "Name": "AccountingOU", + "Arn": "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111"" + } + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/organizations/update-policy.rst awscli-1.18.69/awscli/examples/organizations/update-policy.rst --- awscli-1.11.13/awscli/examples/organizations/update-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/organizations/update-policy.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,48 @@ +**Example 1: To rename a policy** + +The following ``update-policy`` example renames a policy and gives it a new description. :: + + aws organizations update-policy \ + --policy-id p-examplepolicyid111 \ + --name Renamed-Policy \ + --description "This description replaces the original." + +The output shows the new name and description. :: + + { + "Policy": { + "Content": "{\n \"Version\":\"2012-10-17\",\n \"Statement\":{\n \"Effect\":\"Allow\",\n \"Action\":\"ec2:*\",\n \"Resource\":\"*\"\n }\n}\n", + "PolicySummary": { + "Id": "p-examplepolicyid111", + "AwsManaged": false, + "Arn":"arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111", + "Description": "This description replaces the original.", + "Name": "Renamed-Policy", + "Type": "SERVICE_CONTROL_POLICY" + } + } + } + +**Example 2: To replace a policy's JSON text content** + +The following example shows you how to replace the JSON text of the SCP in the previous example with a new JSON policy text string that allows S3 instead of EC2: :: + + aws organizations update-policy \ + --policy-id p-examplepolicyid111 \ + --content "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"s3:*\",\"Resource\":\"*\"}}" + +The output shows the new content:: + + { + "Policy": { + "Content": "{ \"Version\": \"2012-10-17\", \"Statement\": { \"Effect\": \"Allow\", \"Action\": \"s3:*\", \"Resource\": \"*\" } }", + "PolicySummary": { + "Arn": "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111", + "AwsManaged": false; + "Description": "This description replaces the original.", + "Id": "p-examplepolicyid111", + "Name": "Renamed-Policy", + "Type": "SERVICE_CONTROL_POLICY" + } + } + } diff -Nru awscli-1.11.13/awscli/examples/pi/describe-dimension-keys.rst awscli-1.18.69/awscli/examples/pi/describe-dimension-keys.rst --- awscli-1.11.13/awscli/examples/pi/describe-dimension-keys.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/pi/describe-dimension-keys.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,56 @@ +**To describe dimension keys** + +This example requests the names of all wait events. The data is summarized by event name, and the aggregate values of those events over the specified time period. + +Command:: + + aws pi describe-dimension-keys --service-type RDS --identifier db-LKCGOBK26374TPTDFXOIWVCPPM --start-time 1527026400 --end-time 1527080400 --metric db.load.avg --group-by '{"Group":"db.wait_event"}' + +Output:: + + { + "AlignedEndTime": 1.5270804E9, + "AlignedStartTime": 1.5270264E9, + "Keys": [ + { + "Dimensions": {"db.wait_event.name": "wait/synch/mutex/innodb/aurora_lock_thread_slot_futex"}, + "Total": 0.05906906851195666 + }, + { + "Dimensions": {"db.wait_event.name": "wait/io/aurora_redo_log_flush"}, + "Total": 0.015824722186149193 + }, + { + "Dimensions": {"db.wait_event.name": "CPU"}, + "Total": 0.008014396230265477 + }, + { + "Dimensions": {"db.wait_event.name": "wait/io/aurora_respond_to_client"}, + "Total": 0.0036361612526204477 + }, + { + "Dimensions": {"db.wait_event.name": "wait/io/table/sql/handler"}, + "Total": 0.0019108398419382965 + }, + { + "Dimensions": {"db.wait_event.name": "wait/synch/cond/mysys/my_thread_var::suspend"}, + "Total": 8.533847837782684E-4 + }, + { + "Dimensions": {"db.wait_event.name": "wait/io/file/csv/data"}, + "Total": 6.864181956477376E-4 + }, + { + "Dimensions": {"db.wait_event.name": "Unknown"}, + "Total": 3.895887056379051E-4 + }, + { + "Dimensions": {"db.wait_event.name": "wait/synch/mutex/sql/FILE_AS_TABLE::LOCK_shim_lists"}, + "Total": 3.710368625122906E-5 + }, + { + "Dimensions": {"db.wait_event.name": "wait/lock/table/sql/handler"}, + "Total": 0 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/pi/get-resource-metrics.rst awscli-1.18.69/awscli/examples/pi/get-resource-metrics.rst --- awscli-1.11.13/awscli/examples/pi/get-resource-metrics.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/pi/get-resource-metrics.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,67 @@ +**To get resource metrics** + +This example requests data points for the *db.wait_event* dimension group, and for the *db.wait_event.name* dimension within that group. In the response, the relevant data points are grouped by the requested dimension (*db.wait_event.name*). + + + +Command:: + + aws pi get-resource-metrics --service-type RDS --identifier db-LKCGOBK26374TPTDFXOIWVCPPM --start-time 1527026400 --end-time 1527080400 --period-in-seconds 300 --metric db.load.avg --metric-queries file://metric-queries.json + +The arguments for ``--metric-queries`` are stored in a JSON file, ``metric-queries.json``. Here are the contents of that file:: + + [ + { + "Metric": "db.load.avg", + "GroupBy": { + "Group":"db.wait_event" + } + } + ] + + +Output:: + + { + "AlignedEndTime": 1.5270804E9, + "AlignedStartTime": 1.5270264E9, + "Identifier": "db-LKCGOBK26374TPTDFXOIWVCPPM", + "MetricList": [ + { + "Key": { + "Metric": "db.load.avg" + }, + "DataPoints": [ + { + "Timestamp": 1527026700.0, + "Value": 1.3533333333333333 + }, + { + "Timestamp": 1527027000.0, + "Value": 0.88 + }, + <...remaining output omitted...> + ] + }, + { + "Key": { + "Metric": "db.load.avg", + "Dimensions": { + "db.wait_event.name": "wait/synch/mutex/innodb/aurora_lock_thread_slot_futex" + } + }, + "DataPoints": [ + { + "Timestamp": 1527026700.0, + "Value": 0.8566666666666667 + }, + { + "Timestamp": 1527027000.0, + "Value": 0.8633333333333333 + }, + <...remaining output omitted...> + ], + }, + <...remaining output omitted...> + ] + } diff -Nru awscli-1.11.13/awscli/examples/pinpoint/create-app.rst awscli-1.18.69/awscli/examples/pinpoint/create-app.rst --- awscli-1.11.13/awscli/examples/pinpoint/create-app.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/pinpoint/create-app.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,37 @@ +**Example 1: To create an application** + +The following ``create-app`` example creates a new application (project). :: + + aws pinpoint create-app \ + --create-application-request Name=ExampleCorp + +Output:: + + { + "ApplicationResponse": { + "Arn": "arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example", + "Id": "810c7aab86d42fb2b56c8c966example", + "Name": "ExampleCorp", + "tags": {} + } + } + +**Example 2: To create an application that is tagged** + +The following ``create-app`` example creates a new application (project) and associates a tag (key and value) with the application. :: + + aws pinpoint create-app \ + --create-application-request Name=ExampleCorp,tags={"Stack"="Test"} + +Output:: + + { + "ApplicationResponse": { + "Arn": "arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example", + "Id": "810c7aab86d42fb2b56c8c966example", + "Name": "ExampleCorp", + "tags": { + "Stack": "Test" + } + } + } diff -Nru awscli-1.11.13/awscli/examples/pinpoint/delete-app.rst awscli-1.18.69/awscli/examples/pinpoint/delete-app.rst --- awscli-1.11.13/awscli/examples/pinpoint/delete-app.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/pinpoint/delete-app.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,17 @@ +**To delete an application** + +The following ``delete-app`` example deletes an application (project). :: + + aws pinpoint delete-app \ + --application-id 810c7aab86d42fb2b56c8c966example + +Output:: + + { + "ApplicationResponse": { + "Arn": "arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example", + "Id": "810c7aab86d42fb2b56c8c966example", + "Name": "ExampleCorp", + "tags": {} + } + } diff -Nru awscli-1.11.13/awscli/examples/pinpoint/get-apps.rst awscli-1.18.69/awscli/examples/pinpoint/get-apps.rst --- awscli-1.11.13/awscli/examples/pinpoint/get-apps.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/pinpoint/get-apps.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,41 @@ +**To retrieve information about all of your applications** + +The following ``get-apps`` example retrieves information about all of your applications (projects). :: + + aws pinpoint get-apps + +Output:: + + { + "ApplicationsResponse": { + "Item": [ + { + "Arn": "arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example", + "Id": "810c7aab86d42fb2b56c8c966example", + "Name": "ExampleCorp", + "tags": { + "Year": "2019", + "Stack": "Production" + } + }, + { + "Arn": "arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/42d8c7eb0990a57ba1d5476a3example", + "Id": "42d8c7eb0990a57ba1d5476a3example", + "Name": "AnyCompany", + "tags": {} + }, + { + "Arn": "arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/80f5c382b638ffe5ad12376bbexample", + "Id": "80f5c382b638ffe5ad12376bbexample", + "Name": "ExampleCorp_Test", + "tags": { + "Year": "2019", + "Stack": "Test" + } + } + ], + "NextToken": "eyJDcmVhdGlvbkRhdGUiOiIyMDE5LTA3LTE2VDE0OjM4OjUzLjkwM1oiLCJBY2NvdW50SWQiOiI1MTIzOTcxODM4NzciLCJBcHBJZCI6Ijk1ZTM2MGRiMzBkMjQ1ZjRiYTYwYjhlMzllMzZlNjZhIn0" + } + } + +The presence of the ``NextToken`` response value indicates that there is more output available. Call the command again and supply that value as the ``NextToken`` input parameter. diff -Nru awscli-1.11.13/awscli/examples/pinpoint/list-tags-for-resource.rst awscli-1.18.69/awscli/examples/pinpoint/list-tags-for-resource.rst --- awscli-1.11.13/awscli/examples/pinpoint/list-tags-for-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/pinpoint/list-tags-for-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,19 @@ +**To retrieve a list of tags for a resource** + +The following ``list-tags-for-resource`` example retrieves all the tags (key names and values) that are associated with the specified resource. :: + + aws pinpoint list-tags-for-resource \ + --resource-arn arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example + +Output:: + + { + "TagsModel": { + "tags": { + "Year": "2019", + "Stack": "Production" + } + } + } + +For more information, see 'Tagging Amazon Pinpoint Resources '__ in the *Amazon Pinpoint Developer Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/pinpoint/tag-resource.rst awscli-1.18.69/awscli/examples/pinpoint/tag-resource.rst --- awscli-1.11.13/awscli/examples/pinpoint/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/pinpoint/tag-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To add tags to a resource** + +The following example adds two tags (key names and values) to a resource. :: + + aws pinpoint list-tags-for-resource \ + --resource-arn arn:aws:mobiletargeting:us-east-1:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example \ + --tags-model tags={Stack=Production,Year=2019} + +This command produces no output. + +For more information, see 'Tagging Amazon Pinpoint Resources '__ in the *Amazon Pinpoint Developer Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/pinpoint/untag-resource.rst awscli-1.18.69/awscli/examples/pinpoint/untag-resource.rst --- awscli-1.11.13/awscli/examples/pinpoint/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/pinpoint/untag-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,21 @@ +**Example 1: To remove a tag from a resource** + +The following ``untag-resource`` example removes the specified tag (key name and value) from a resource. :: + + aws pinpoint untag-resource \ + --resource-arn arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example \ + --tag-keys Year + +This command produces no output. + +**Example 2: To remove multiple tags from a resource** + +The following ``untag-resource`` example removes the specified tags (key names and values) from a resource. :: + + aws pinpoint untag-resource \ + --resource-arn arn:aws:mobiletargeting:us-east-1:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example \ + --tag-keys Year Stack + +This command produces no output. + +For more information, see 'Tagging Amazon Pinpoint Resources '__ in the *Amazon Pinpoint Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/pricing/describe-services.rst awscli-1.18.69/awscli/examples/pricing/describe-services.rst --- awscli-1.11.13/awscli/examples/pricing/describe-services.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/pricing/describe-services.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,82 @@ +**To retrieve service metadata** + +This example retrieves the metadata for the Amazon EC2 service code. + +Command:: + + aws pricing describe-services --service-code AmazonEC2 --format-version aws_v1 --max-items 1 + +Output:: + + { + "Services": [ + { + "ServiceCode": "AmazonEC2", + "AttributeNames": [ + "volumeType", + "maxIopsvolume", + "instance", + "instanceCapacity10xlarge", + "locationType", + "instanceFamily", + "operatingSystem", + "clockSpeed", + "LeaseContractLength", + "ecu", + "networkPerformance", + "instanceCapacity8xlarge", + "group", + "maxThroughputvolume", + "gpuMemory", + "ebsOptimized", + "elasticGpuType", + "maxVolumeSize", + "gpu", + "processorFeatures", + "intelAvxAvailable", + "instanceCapacity4xlarge", + "servicecode", + "groupDescription", + "processorArchitecture", + "physicalCores", + "productFamily", + "enhancedNetworkingSupported", + "intelTurboAvailable", + "memory", + "dedicatedEbsThroughput", + "vcpu", + "OfferingClass", + "instanceCapacityLarge", + "capacitystatus", + "termType", + "storage", + "intelAvx2Available", + "storageMedia", + "physicalProcessor", + "provisioned", + "servicename", + "PurchaseOption", + "instanceCapacity18xlarge", + "instanceType", + "tenancy", + "usagetype", + "normalizationSizeFactor", + "instanceCapacity2xlarge", + "instanceCapacity16xlarge", + "maxIopsBurstPerformance", + "instanceCapacity12xlarge", + "instanceCapacity32xlarge", + "instanceCapacityXlarge", + "licenseModel", + "currentGeneration", + "preInstalledSw", + "location", + "instanceCapacity24xlarge", + "instanceCapacity9xlarge", + "instanceCapacityMedium", + "operation" + ] + } + ], + "FormatVersion": "aws_v1" + } diff -Nru awscli-1.11.13/awscli/examples/pricing/get-attribute-values.rst awscli-1.18.69/awscli/examples/pricing/get-attribute-values.rst --- awscli-1.11.13/awscli/examples/pricing/get-attribute-values.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/pricing/get-attribute-values.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,22 @@ +**To retrieve a list of attribute values** + +The following ``get-attribute-values`` example retrieves a list of values available for the given attribute. :: + + aws pricing get-attribute-values \ + --service-code AmazonEC2 \ + --attribute-name volumeType \ + --max-items 2 + +Output:: + + { + "NextToken": "eyJOZXh0VG9rZW4iOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ==", + "AttributeValues": [ + { + "Value": "Cold HDD" + }, + { + "Value": "General Purpose" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/pricing/get-products.rst awscli-1.18.69/awscli/examples/pricing/get-products.rst --- awscli-1.11.13/awscli/examples/pricing/get-products.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/pricing/get-products.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,32 @@ +**To retrieve a list of products** + +This example retrieves a list of products that match the given criteria. + +Command:: + + aws pricing get-products --filters file://filters.json --format-version aws_v1 --max-results 1 --service-code AmazonEC2 + +filters.json:: + + [ + { + "Type": "TERM_MATCH", + "Field": "ServiceCode", + "Value": "AmazonEC2" + }, + { + "Type": "TERM_MATCH", + "Field": "volumeType", + "Value": "Provisioned IOPS" + } + ] + +Output:: + + { + "FormatVersion": "aws_v1", + "NextToken": "WGDY7ko8fQXdlaUZVdasFQ==:RVSagyIFn770XQOzdUIcO9BY6ucBG9itXAZGZF/zioUzOsUKh6PCcPWaOyPZRiMePb986TeoKYB9l55fw/CyoMq5ymnGmT1Vj39TljbbAlhcqnVfTmPIilx8Uy5bdDaBYy/e/2Ofw9Edzsykbs8LTBuNbiDQ+BBds5yeI9AQkUepruKk3aEahFPxJ55kx/zk", + "PriceList": [ + "{\"product\":{\"productFamily\":\"Storage\",\"attributes\":{\"storageMedia\":\"SSD-backed\",\"maxThroughputvolume\":\"320 MB/sec\",\"volumeType\":\"Provisioned IOPS\",\"maxIopsvolume\":\"20000\",\"servicecode\":\"AmazonEC2\",\"usagetype\":\"APS1-EBS:VolumeUsage.piops\",\"locationType\":\"AWS Region\",\"location\":\"Asia Pacific (Singapore)\",\"servicename\":\"Amazon Elastic Compute Cloud\",\"maxVolumeSize\":\"16 TiB\",\"operation\":\"\"},\"sku\":\"3MKHN58N7RDDVGKJ\"},\"serviceCode\":\"AmazonEC2\",\"terms\":{\"OnDemand\":{\"3MKHN58N7RDDVGKJ.JRTCKXETXF\":{\"priceDimensions\":{\"3MKHN58N7RDDVGKJ.JRTCKXETXF.6YS6EN2CT7\":{\"unit\":\"GB-Mo\",\"endRange\":\"Inf\",\"description\":\"$0.138 per GB-month of Provisioned IOPS SSD (io1) provisioned storage - Asia Pacific (Singapore)\",\"appliesTo\":[],\"rateCode\":\"3MKHN58N7RDDVGKJ.JRTCKXETXF.6YS6EN2CT7\",\"beginRange\":\"0\",\"pricePerUnit\":{\"USD\":\"0.1380000000\"}}},\"sku\":\"3MKHN58N7RDDVGKJ\",\"effectiveDate\":\"2018-08-01T00:00:00Z\",\"offerTermCode\":\"JRTCKXETXF\",\"termAttributes\":{}}}},\"version\":\"20180808005701\",\"publicationDate\":\"2018-08-08T00:57:01Z\"}" + ] + } diff -Nru awscli-1.11.13/awscli/examples/qldb/create-ledger.rst awscli-1.18.69/awscli/examples/qldb/create-ledger.rst --- awscli-1.11.13/awscli/examples/qldb/create-ledger.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/qldb/create-ledger.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,40 @@ +**Example 1: To create a ledger with default properties** + +The following ``create-ledger`` example creates a ledger with the name ``myExampleLedger`` and the permissions mode ``ALLOW_ALL``. The optional parameter for deletion protection is not specified, so it defaults to ``true``. :: + + aws qldb create-ledger \ + --name myExampleLedger \ + --permissions-mode ALLOW_ALL + +Output:: + + { + "State": "CREATING", + "Arn": "arn:aws:qldb:us-west-2:123456789012:ledger/myExampleLedger", + "DeletionProtection": true, + "CreationDateTime": 1568839243.951, + "Name": "myExampleLedger" + } + +**Example 2: To create a ledger with deletion protection disabled and with specified tags** + +The following ``create-ledger`` example creates a ledger with the name ``myExampleLedger2`` and the permissions mode ``ALLOW_ALL``. The deletion protection feature is disabled, and the specified tags are attached to the resource. :: + + aws qldb create-ledger \ + --name myExampleLedger \ + --no-deletion-protection \ + --permissions-mode ALLOW_ALL \ + --tags IsTest=true,Domain=Test + +Output:: + + { + "Arn": "arn:aws:qldb:us-west-2:123456789012:ledger/myExampleLedger2", + "DeletionProtection": false, + "CreationDateTime": 1568839543.557, + "State": "CREATING", + "Name": "myExampleLedger2" + } + + +For more information, see `Basic Operations for Amazon QLDB Ledgers `__ in the *Amazon QLDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/qldb/delete-ledger.rst awscli-1.18.69/awscli/examples/qldb/delete-ledger.rst --- awscli-1.11.13/awscli/examples/qldb/delete-ledger.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/qldb/delete-ledger.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a ledger** + +The following ``delete-ledger`` example deletes the specified ledger. :: + + aws qldb delete-ledger \ + --name myExampleLedger + +This command produces no output. + +For more information, see `Basic Operations for Amazon QLDB Ledgers `__ in the *Amazon QLDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/qldb/describe-journal-s3-export.rst awscli-1.18.69/awscli/examples/qldb/describe-journal-s3-export.rst --- awscli-1.11.13/awscli/examples/qldb/describe-journal-s3-export.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/qldb/describe-journal-s3-export.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,30 @@ +**To describe a journal export job** + +The following ``describe-journal-s3-export`` example displays the details for the specified export job from a ledger. :: + + aws qldb describe-journal-s3-export \ + --name myExampleLedger \ + --export-id ADR2ONPKN5LINYGb4dp7yZ + +Output:: + + { + "ExportDescription": { + "S3ExportConfiguration": { + "Bucket": "awsExampleBucket", + "Prefix": "ledgerexport1/", + "EncryptionConfiguration": { + "ObjectEncryptionType": "SSE_S3" + } + }, + "RoleArn": "arn:aws:iam::123456789012:role/my-s3-export-role", + "Status": "COMPLETED", + "ExportCreationTime": 1568847801.418, + "InclusiveStartTime": 1568764800.0, + "ExclusiveEndTime": 1568847599.0, + "LedgerName": "myExampleLedger", + "ExportId": "ADR2ONPKN5LINYGb4dp7yZ" + } + } + +For more information, see `Exporting Your Journal in Amazon QLDB `__ in the *Amazon QLDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/qldb/describe-ledger.rst awscli-1.18.69/awscli/examples/qldb/describe-ledger.rst --- awscli-1.11.13/awscli/examples/qldb/describe-ledger.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/qldb/describe-ledger.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,18 @@ +**To describe a ledger** + +The following ``describe-ledger`` example displays the details for the specified ledger. :: + + aws qldb describe-ledger \ + --name myExampleLedger + +Output:: + + { + "CreationDateTime": 1568839243.951, + "Arn": "arn:aws:qldb:us-west-2:123456789012:ledger/myExampleLedger", + "State": "ACTIVE", + "Name": "myExampleLedger", + "DeletionProtection": true + } + +For more information, see `Basic Operations for Amazon QLDB Ledgers `__ in the *Amazon QLDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/qldb/export-journal-to-s3.rst awscli-1.18.69/awscli/examples/qldb/export-journal-to-s3.rst --- awscli-1.11.13/awscli/examples/qldb/export-journal-to-s3.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/qldb/export-journal-to-s3.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,28 @@ +**To export journal blocks to S3** + +The following ``export-journal-to-s3`` example creates an export job for journal blocks within a specified date and time range from a ledger with the name ``myExampleLedger``. The export job writes the blocks into a specified Amazon S3 bucket. :: + + aws qldb export-journal-to-s3 \ + --name myExampleLedger \ + --inclusive-start-time 2019-09-18T00:00:00Z \ + --exclusive-end-time 2019-09-18T22:59:59Z \ + --role-arn arn:aws:iam::123456789012:role/my-s3-export-role \ + --s3-export-configuration file://my-s3-export-config.json + +Contents of ``my-s3-export-config.json``:: + + { + "Bucket": "awsExampleBucket", + "Prefix": "ledgerexport1/", + "EncryptionConfiguration": { + "ObjectEncryptionType": "SSE_S3" + } + } + +Output:: + + { + "ExportId": "ADR2ONPKN5LINYGb4dp7yZ" + } + +For more information, see `Exporting Your Journal in Amazon QLDB `__ in the *Amazon QLDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/qldb/get-block.rst awscli-1.18.69/awscli/examples/qldb/get-block.rst --- awscli-1.11.13/awscli/examples/qldb/get-block.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/qldb/get-block.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,55 @@ +**Example 1: To get a journal block and proof for verification using input files** + +The following ``get-block`` example requests a block data object and a proof from the specified ledger. The request is for a specified digest tip address and block address. :: + + aws qldb get-block \ + --name vehicle-registration \ + --block-address file://myblockaddress.json \ + --digest-tip-address file://mydigesttipaddress.json + +Contents of ``myblockaddress.json``:: + + { + "IonText": "{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:100}" + } + +Contents of ``mydigesttipaddress.json``:: + + { + "IonText": "{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:123}" + } + +Output:: + + { + "Block": { + "IonText": "{blockAddress:{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:100},transactionId:\"FnQeJBAicTX0Ah32ZnVtSX\",blockTimestamp:2019-09-16T19:37:05.360Z,blockHash:{{NoChM92yKRuJAb/jeLd1VnYn4DHiWIf071ACfic9uHc=}},entriesHash:{{l05LOsiKV14SDbuaYnH7uwXzUvqzIwUiRLXGbTyj/nY=}},previousBlockHash:{{7kewBXhpdbClcZKxhVmpoMHpUGOJtWQD0iY2LPfZkYA=}},entriesHashList:[{{eRSwnmAM7WWANWDd5iGOyK+T4tDXyzUq6HZ/0fgLHos=}},{{mHVex/yjHAWjFPpwhBuH2GKXmKJjK2FBa9faqoUVNtg=}},{{y5cCBr7pOAIUfsVQ1j0TqtE97b4b4oo1R0vnYyE5wWM=}},{{TvTXygML1bMe6NvEZtGkX+KR+W/EJl4qD1mmV77KZQg=}}],transactionInfo:{statements:[{statement:\"FROM VehicleRegistration AS r \\nWHERE r.VIN = '1N4AL11D75C109151'\\nINSERT INTO r.Owners.SecondaryOwners\\n VALUE { 'PersonId' : 'CMVdR77XP8zAglmmFDGTvt' }\",startTime:2019-09-16T19:37:05.302Z,statementDigest:{{jcgPX2vsOJ0waum4qmDYtn1pCAT9xKNIzA+2k4R+mxA=}}}],documents:{JUJgkIcNbhS2goq8RqLuZ4:{tableName:\"VehicleRegistration\",tableId:\"BFJKdXgzt9oF4wjMbuxy4G\",statements:[0]}}},revisions:[{blockAddress:{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:100},hash:{{mHVex/yjHAWjFPpwhBuH2GKXmKJjK2FBa9faqoUVNtg=}},data:{VIN:\"1N4AL11D75C109151\",LicensePlateNumber:\"LEWISR261LL\",State:\"WA\",PendingPenaltyTicketAmount:90.25,ValidFromDate:2017-08-21,ValidToDate:2020-05-11,Owners:{PrimaryOwner:{PersonId:\"BFJKdXhnLRT27sXBnojNGW\"},SecondaryOwners:[{PersonId:\"CMVdR77XP8zAglmmFDGTvt\"}]},City:\"Everett\"},metadata:{id:\"JUJgkIcNbhS2goq8RqLuZ4\",version:3,txTime:2019-09-16T19:37:05.344Z,txId:\"FnQeJBAicTX0Ah32ZnVtSX\"}}]}" + }, + "Proof": { + "IonText": "[{{l3+EXs69K1+rehlqyWLkt+oHDlw4Zi9pCLW/t/mgTPM=}},{{48CXG3ehPqsxCYd34EEa8Fso0ORpWWAO8010RJKf3Do=}},{{9UnwnKSQT0i3ge1JMVa+tMIqCEDaOPTkWxmyHSn8UPQ=}},{{3nW6Vryghk+7pd6wFCtLufgPM6qXHyTNeCb1sCwcDaI=}},{{Irb5fNhBrNEQ1VPhzlnGT/ZQPadSmgfdtMYcwkNOxoI=}},{{+3CWpYG/ytf/vq9GidpzSx6JJiLXt1hMQWNnqOy3jfY=}},{{NPx6cRhwsiy5m9UEWS5JTJrZoUdO2jBOAAOmyZAT+qE=}}]" + } + } + +For more information, see `Data Verification in Amazon QLDB `__ in the *Amazon QLDB Developer Guide*. + +**Example 2: To get a journal block and proof for verification using shorthand syntax** + +The following ``get-block`` example requests a block data object and a proof from the specified ledger using shorthand syntax. The request is for a specified digest tip address and block address. :: + + aws qldb get-block \ + --name vehicle-registration \ + --block-address 'IonText="{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:100}"' \ + --digest-tip-address 'IonText="{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:123}"' + +Output:: + + { + "Block": { + "IonText": "{blockAddress:{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:100},transactionId:\"FnQeJBAicTX0Ah32ZnVtSX\",blockTimestamp:2019-09-16T19:37:05.360Z,blockHash:{{NoChM92yKRuJAb/jeLd1VnYn4DHiWIf071ACfic9uHc=}},entriesHash:{{l05LOsiKV14SDbuaYnH7uwXzUvqzIwUiRLXGbTyj/nY=}},previousBlockHash:{{7kewBXhpdbClcZKxhVmpoMHpUGOJtWQD0iY2LPfZkYA=}},entriesHashList:[{{eRSwnmAM7WWANWDd5iGOyK+T4tDXyzUq6HZ/0fgLHos=}},{{mHVex/yjHAWjFPpwhBuH2GKXmKJjK2FBa9faqoUVNtg=}},{{y5cCBr7pOAIUfsVQ1j0TqtE97b4b4oo1R0vnYyE5wWM=}},{{TvTXygML1bMe6NvEZtGkX+KR+W/EJl4qD1mmV77KZQg=}}],transactionInfo:{statements:[{statement:\"FROM VehicleRegistration AS r \\nWHERE r.VIN = '1N4AL11D75C109151'\\nINSERT INTO r.Owners.SecondaryOwners\\n VALUE { 'PersonId' : 'CMVdR77XP8zAglmmFDGTvt' }\",startTime:2019-09-16T19:37:05.302Z,statementDigest:{{jcgPX2vsOJ0waum4qmDYtn1pCAT9xKNIzA+2k4R+mxA=}}}],documents:{JUJgkIcNbhS2goq8RqLuZ4:{tableName:\"VehicleRegistration\",tableId:\"BFJKdXgzt9oF4wjMbuxy4G\",statements:[0]}}},revisions:[{blockAddress:{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:100},hash:{{mHVex/yjHAWjFPpwhBuH2GKXmKJjK2FBa9faqoUVNtg=}},data:{VIN:\"1N4AL11D75C109151\",LicensePlateNumber:\"LEWISR261LL\",State:\"WA\",PendingPenaltyTicketAmount:90.25,ValidFromDate:2017-08-21,ValidToDate:2020-05-11,Owners:{PrimaryOwner:{PersonId:\"BFJKdXhnLRT27sXBnojNGW\"},SecondaryOwners:[{PersonId:\"CMVdR77XP8zAglmmFDGTvt\"}]},City:\"Everett\"},metadata:{id:\"JUJgkIcNbhS2goq8RqLuZ4\",version:3,txTime:2019-09-16T19:37:05.344Z,txId:\"FnQeJBAicTX0Ah32ZnVtSX\"}}]}" + }, + "Proof": { + "IonText": "[{{l3+EXs69K1+rehlqyWLkt+oHDlw4Zi9pCLW/t/mgTPM=}},{{48CXG3ehPqsxCYd34EEa8Fso0ORpWWAO8010RJKf3Do=}},{{9UnwnKSQT0i3ge1JMVa+tMIqCEDaOPTkWxmyHSn8UPQ=}},{{3nW6Vryghk+7pd6wFCtLufgPM6qXHyTNeCb1sCwcDaI=}},{{Irb5fNhBrNEQ1VPhzlnGT/ZQPadSmgfdtMYcwkNOxoI=}},{{+3CWpYG/ytf/vq9GidpzSx6JJiLXt1hMQWNnqOy3jfY=}},{{NPx6cRhwsiy5m9UEWS5JTJrZoUdO2jBOAAOmyZAT+qE=}}]" + } + } + +For more information, see `Data Verification in Amazon QLDB `__ in the *Amazon QLDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/qldb/get-digest.rst awscli-1.18.69/awscli/examples/qldb/get-digest.rst --- awscli-1.11.13/awscli/examples/qldb/get-digest.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/qldb/get-digest.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,17 @@ +**To get a digest for a ledger** + +The following ``get-digest`` example requests a digest from the specified ledger at the latest committed block in the journal. :: + + aws qldb get-digest \ + --name vehicle-registration + +Output:: + + { + "Digest": "6m6BMXobbJKpMhahwVthAEsN6awgnHK62Qq5McGP1Gk=", + "DigestTipAddress": { + "IonText": "{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:123}" + } + } + +For more information, see `Data Verification in Amazon QLDB `__ in the *Amazon QLDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/qldb/get-revision.rst awscli-1.18.69/awscli/examples/qldb/get-revision.rst --- awscli-1.11.13/awscli/examples/qldb/get-revision.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/qldb/get-revision.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,57 @@ +**Example 1: To get a document revision and proof for verification using input files** + +The following ``get-revision`` example requests a revision data object and a proof from the specified ledger. The request is for a specified digest tip address, document ID, and block address of the revision. :: + + aws qldb get-revision \ + --name vehicle-registration \ + --block-address file://myblockaddress.json \ + --document-id JUJgkIcNbhS2goq8RqLuZ4 \ + --digest-tip-address file://mydigesttipaddress.json + +Contents of ``myblockaddress.json``:: + + { + "IonText": "{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:100}" + } + +Contents of ``mydigesttipaddress.json``:: + + { + "IonText": "{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:123}" + } + +Output:: + + { + "Revision": { + "IonText": "{blockAddress:{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:100},hash:{{mHVex/yjHAWjFPpwhBuH2GKXmKJjK2FBa9faqoUVNtg=}},data:{VIN:\"1N4AL11D75C109151\",LicensePlateNumber:\"LEWISR261LL\",State:\"WA\",PendingPenaltyTicketAmount:90.25,ValidFromDate:2017-08-21,ValidToDate:2020-05-11,Owners:{PrimaryOwner:{PersonId:\"BFJKdXhnLRT27sXBnojNGW\"},SecondaryOwners:[{PersonId:\"CMVdR77XP8zAglmmFDGTvt\"}]},City:\"Everett\"},metadata:{id:\"JUJgkIcNbhS2goq8RqLuZ4\",version:3,txTime:2019-09-16T19:37:05.344Z,txId:\"FnQeJBAicTX0Ah32ZnVtSX\"}}" + }, + "Proof": { + "IonText": "[{{eRSwnmAM7WWANWDd5iGOyK+T4tDXyzUq6HZ/0fgLHos=}},{{VV1rdaNuf+yJZVGlmsM6gr2T52QvBO8Lg+KgpjcnWAU=}},{{7kewBXhpdbClcZKxhVmpoMHpUGOJtWQD0iY2LPfZkYA=}},{{l3+EXs69K1+rehlqyWLkt+oHDlw4Zi9pCLW/t/mgTPM=}},{{48CXG3ehPqsxCYd34EEa8Fso0ORpWWAO8010RJKf3Do=}},{{9UnwnKSQT0i3ge1JMVa+tMIqCEDaOPTkWxmyHSn8UPQ=}},{{3nW6Vryghk+7pd6wFCtLufgPM6qXHyTNeCb1sCwcDaI=}},{{Irb5fNhBrNEQ1VPhzlnGT/ZQPadSmgfdtMYcwkNOxoI=}},{{+3CWpYG/ytf/vq9GidpzSx6JJiLXt1hMQWNnqOy3jfY=}},{{NPx6cRhwsiy5m9UEWS5JTJrZoUdO2jBOAAOmyZAT+qE=}}]" + } + } + +For more information, see `Data Verification in Amazon QLDB `__ in the *Amazon QLDB Developer Guide*. + +**Example 2: To get a document revision and proof for verification using shorthand syntax** + +The following ``get-revision`` example requests a revision data object and a proof from the specified ledger using shorthand syntax. The request is for a specified digest tip address, document ID, and block address of the revision. :: + + aws qldb get-revision \ + --name vehicle-registration \ + --block-address 'IonText="{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:100}"' \ + --document-id JUJgkIcNbhS2goq8RqLuZ4 \ + --digest-tip-address 'IonText="{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:123}"' + +Output:: + + { + "Revision": { + "IonText": "{blockAddress:{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:100},hash:{{mHVex/yjHAWjFPpwhBuH2GKXmKJjK2FBa9faqoUVNtg=}},data:{VIN:\"1N4AL11D75C109151\",LicensePlateNumber:\"LEWISR261LL\",State:\"WA\",PendingPenaltyTicketAmount:90.25,ValidFromDate:2017-08-21,ValidToDate:2020-05-11,Owners:{PrimaryOwner:{PersonId:\"BFJKdXhnLRT27sXBnojNGW\"},SecondaryOwners:[{PersonId:\"CMVdR77XP8zAglmmFDGTvt\"}]},City:\"Everett\"},metadata:{id:\"JUJgkIcNbhS2goq8RqLuZ4\",version:3,txTime:2019-09-16T19:37:05.344Z,txId:\"FnQeJBAicTX0Ah32ZnVtSX\"}}" + }, + "Proof": { + "IonText": "[{{eRSwnmAM7WWANWDd5iGOyK+T4tDXyzUq6HZ/0fgLHos=}},{{VV1rdaNuf+yJZVGlmsM6gr2T52QvBO8Lg+KgpjcnWAU=}},{{7kewBXhpdbClcZKxhVmpoMHpUGOJtWQD0iY2LPfZkYA=}},{{l3+EXs69K1+rehlqyWLkt+oHDlw4Zi9pCLW/t/mgTPM=}},{{48CXG3ehPqsxCYd34EEa8Fso0ORpWWAO8010RJKf3Do=}},{{9UnwnKSQT0i3ge1JMVa+tMIqCEDaOPTkWxmyHSn8UPQ=}},{{3nW6Vryghk+7pd6wFCtLufgPM6qXHyTNeCb1sCwcDaI=}},{{Irb5fNhBrNEQ1VPhzlnGT/ZQPadSmgfdtMYcwkNOxoI=}},{{+3CWpYG/ytf/vq9GidpzSx6JJiLXt1hMQWNnqOy3jfY=}},{{NPx6cRhwsiy5m9UEWS5JTJrZoUdO2jBOAAOmyZAT+qE=}}]" + } + } + +For more information, see `Data Verification in Amazon QLDB `__ in the *Amazon QLDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/qldb/list-journal-s3-exports-for-ledger.rst awscli-1.18.69/awscli/examples/qldb/list-journal-s3-exports-for-ledger.rst --- awscli-1.11.13/awscli/examples/qldb/list-journal-s3-exports-for-ledger.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/qldb/list-journal-s3-exports-for-ledger.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,31 @@ +**To list journal export jobs for a ledger** + +The following ``list-journal-s3-exports-for-ledger`` example lists journal export jobs for the specified ledger. :: + + aws qldb list-journal-s3-exports-for-ledger \ + --name myExampleLedger + +Output:: + + { + "JournalS3Exports": [ + { + "LedgerName": "myExampleLedger", + "ExclusiveEndTime": 1568847599.0, + "ExportCreationTime": 1568847801.418, + "S3ExportConfiguration": { + "Bucket": "awsExampleBucket", + "Prefix": "ledgerexport1/", + "EncryptionConfiguration": { + "ObjectEncryptionType": "SSE_S3" + } + }, + "ExportId": "ADR2ONPKN5LINYGb4dp7yZ", + "RoleArn": "arn:aws:iam::123456789012:role/qldb-s3-export", + "InclusiveStartTime": 1568764800.0, + "Status": "IN_PROGRESS" + } + ] + } + +For more information, see `Exporting Your Journal in Amazon QLDB `__ in the *Amazon QLDB Developer Guide*. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/qldb/list-journal-s3-exports.rst awscli-1.18.69/awscli/examples/qldb/list-journal-s3-exports.rst --- awscli-1.11.13/awscli/examples/qldb/list-journal-s3-exports.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/qldb/list-journal-s3-exports.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,46 @@ +**To list journal export jobs** + +The following ``list-journal-s3-exports`` example lists journal export jobs for all ledgers that are associated with the current AWS account and Region. :: + + aws qldb list-journal-s3-exports + +Output:: + + { + "JournalS3Exports": [ + { + "Status": "IN_PROGRESS", + "LedgerName": "myExampleLedger", + "S3ExportConfiguration": { + "EncryptionConfiguration": { + "ObjectEncryptionType": "SSE_S3" + }, + "Bucket": "awsExampleBucket", + "Prefix": "ledgerexport1/" + }, + "RoleArn": "arn:aws:iam::123456789012:role/my-s3-export-role", + "ExportCreationTime": 1568847801.418, + "ExportId": "ADR2ONPKN5LINYGb4dp7yZ", + "InclusiveStartTime": 1568764800.0, + "ExclusiveEndTime": 1568847599.0 + }, + { + "Status": "COMPLETED", + "LedgerName": "myExampleLedger2", + "S3ExportConfiguration": { + "EncryptionConfiguration": { + "ObjectEncryptionType": "SSE_S3" + }, + "Bucket": "awsExampleBucket", + "Prefix": "ledgerexport1/" + }, + "RoleArn": "arn:aws:iam::123456789012:role/my-s3-export-role", + "ExportCreationTime": 1568846847.638, + "ExportId": "2pdvW8UQrjBAiYTMehEJDI", + "InclusiveStartTime": 1568592000.0, + "ExclusiveEndTime": 1568764800.0 + } + ] + } + +For more information, see `Exporting Your Journal in Amazon QLDB `__ in the *Amazon QLDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/qldb/list-ledgers.rst awscli-1.18.69/awscli/examples/qldb/list-ledgers.rst --- awscli-1.11.13/awscli/examples/qldb/list-ledgers.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/qldb/list-ledgers.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,24 @@ +**To list your available ledgers** + +The following ``list-ledgers`` example lists all ledgers that are associated with the current AWS account and Region. :: + + aws qldb list-ledgers + +Output:: + + { + "Ledgers": [ + { + "State": "ACTIVE", + "CreationDateTime": 1568839243.951, + "Name": "myExampleLedger" + }, + { + "State": "ACTIVE", + "CreationDateTime": 1568839543.557, + "Name": "myExampleLedger2" + } + ] + } + +For more information, see `Basic Operations for Amazon QLDB Ledgers `__ in the *Amazon QLDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/qldb/list-tags-for-resource.rst awscli-1.18.69/awscli/examples/qldb/list-tags-for-resource.rst --- awscli-1.11.13/awscli/examples/qldb/list-tags-for-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/qldb/list-tags-for-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,17 @@ +**To list the tags attached to a ledger** + +The following ``list-tags-for-resource`` example lists all tags attached to the specified ledger. :: + + aws qldb list-tags-for-resource \ + --resource-arn arn:aws:qldb:us-west-2:123456789012:ledger/myExampleLedger + +Output:: + + { + "Tags": { + "IsTest": "true", + "Domain": "Test" + } + } + +For more information, see `Tagging Amazon QLDB Resources `__ in the *Amazon QLDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/qldb/tag-resource.rst awscli-1.18.69/awscli/examples/qldb/tag-resource.rst --- awscli-1.11.13/awscli/examples/qldb/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/qldb/tag-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To tag a ledger** + +The following ``tag-resource`` example adds a set of tags to a specified ledger. :: + + aws qldb tag-resource \ + --resource-arn arn:aws:qldb:us-west-2:123456789012:ledger/myExampleLedger \ + --tags IsTest=true,Domain=Test + +This command produces no output. + +For more information, see `Tagging Amazon QLDB Resources `__ in the *Amazon QLDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/qldb/untag-resource.rst awscli-1.18.69/awscli/examples/qldb/untag-resource.rst --- awscli-1.11.13/awscli/examples/qldb/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/qldb/untag-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To remove tags from a resource** + +The following ``untag-resource`` example removes tags with the specified tag keys from a specified ledger. :: + + aws qldb untag-resource \ + --resource-arn arn:aws:qldb:us-west-2:123456789012:ledger/myExampleLedger \ + --tag-keys IsTest Domain + +This command produces no output. + +For more information, see `Tagging Amazon QLDB Resources `__ in the *Amazon QLDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/qldb/update-ledger.rst awscli-1.18.69/awscli/examples/qldb/update-ledger.rst --- awscli-1.11.13/awscli/examples/qldb/update-ledger.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/qldb/update-ledger.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,19 @@ +**To update properties of a ledger** + +The following ``update-ledger`` example updates the specified ledger to disable the deletion protection feature. :: + + aws qldb update-ledger \ + --name myExampleLedger \ + --no-deletion-protection + +Output:: + + { + "CreationDateTime": 1568839243.951, + "Arn": "arn:aws:qldb:us-west-2:123456789012:ledger/myExampleLedger", + "DeletionProtection": false, + "Name": "myExampleLedger", + "State": "ACTIVE" + } + +For more information, see `Basic Operations for Amazon QLDB Ledgers `__ in the *Amazon QLDB Developer Guide*. diff -Nru awscli-1.11.13/awscli/examples/ram/accept-resource-share-invitation.rst awscli-1.18.69/awscli/examples/ram/accept-resource-share-invitation.rst --- awscli-1.11.13/awscli/examples/ram/accept-resource-share-invitation.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ram/accept-resource-share-invitation.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,23 @@ +**To accept a resource share invitation** + +The following ``reject-resource-share-invitation`` example rejects the specified resource share invitation. :: + + aws ram reject-resource-share-invitation \ + --resource-share-invitation-arn arn:aws:ram:us-west-2:123456789012:resource-share-invitation/arn:aws:ram:us-east-1:210774411744:resource-share-invitation/32b639f0-14b8-7e8f-55ea-e6117EXAMPLE + +Output:: + + { + "resourceShareInvitations": [ + { + "resourceShareInvitationArn": "arn:aws:ram:us-west2-1:21077EXAMPLE:resource-share-invitation/32b639f0-14b8-7e8f-55ea-e6117EXAMPLE", + "resourceShareName": "project-resource-share", + "resourceShareArn": "arn:aws:ram:us-west-2:21077EXAMPLE:resource-share/fcb639f0-1449-4744-35bc-a983fc0d4ce1", + "senderAccountId": "21077EXAMPLE", + "receiverAccountId": "123456789012", + "invitationTimestamp": 1565319592.463, + "status": "ACCEPTED" + } + ] + } + diff -Nru awscli-1.11.13/awscli/examples/ram/associate-resource-share.rst awscli-1.18.69/awscli/examples/ram/associate-resource-share.rst --- awscli-1.11.13/awscli/examples/ram/associate-resource-share.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ram/associate-resource-share.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,19 @@ +**To associate a resource with a resource share** + +The following ``associate-resource-share`` example associates the specified subnet with the specified resource share. :: + + aws ram associate-resource-share \ + --resource-arns arn:aws:ec2:us-west-2:123456789012:subnet/subnet-0250c25a1f4e15235 \ + --resource-share-arn arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE + +Output:: + + { + "resourceShareAssociations": [ + "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE", + "associatedEntity": "arn:aws:ec2:us-west-2:123456789012:subnet/subnet-0250c25a1f4e15235", + "associationType": "RESOURCE", + "status": "ASSOCIATING", + "external": false + ] + } diff -Nru awscli-1.11.13/awscli/examples/ram/create-resource-share.rst awscli-1.18.69/awscli/examples/ram/create-resource-share.rst --- awscli-1.11.13/awscli/examples/ram/create-resource-share.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ram/create-resource-share.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,51 @@ +**Example 1: To create a resource share** + +The following ``create-resource-share`` example creates a resource share with the specified name. :: + + aws ram create-resource-share \ + --name my-resource-share + +Output:: + + { + "resourceShare": { + "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE", + "name": "my-resource-share", + "owningAccountId": "123456789012", + "allowExternalPrincipals": true, + "status": "ACTIVE", + "creationTime": 1565295733.282, + "lastUpdatedTime": 1565295733.282 + } + } + +**Example 2: To create a resource share with AWS accounts as principals** + +The following ``create-resource-share`` example creates a resource share and adds the specified principals. :: + + aws ram create-resource-share \ + --name my-resource-share \ + --principals 0abcdef1234567890 + +**EXAMPLE 3: To create a resource share restricted to your organization in AWS Organizations** + +The following ``create-resource-share`` example creates a resource share that is restricted to your organization and adds the specified OU as a principal. :: + + aws ram create-resource-share \ + --name my-resource-share \ + --no-allow-external-principals \ + --principals arn:aws:organizations::123456789012:ou/o-gx7EXAMPLE/ou-29c5-zEXAMPLE + +Output:: + + { + "resourceShare": { + "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/3ab63985-99d9-1cd2-7d24-75e93EXAMPLE", + "name": "my-resource-share", + "owningAccountId": "123456789012", + "allowExternalPrincipals": false, + "status": "ACTIVE", + "creationTime": 1565295733.282, + "lastUpdatedTime": 1565295733.282 + } + } diff -Nru awscli-1.11.13/awscli/examples/ram/delete-resource-share.rst awscli-1.18.69/awscli/examples/ram/delete-resource-share.rst --- awscli-1.11.13/awscli/examples/ram/delete-resource-share.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ram/delete-resource-share.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,12 @@ +**To delete a resource share** + +The following ``delete-resource-share`` example deletes the specified resource share. :: + + aws ram delete-resource-share \ + --resource-share-arn arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE + +The following output indicates success:: + + { + "returnValue": true + } diff -Nru awscli-1.11.13/awscli/examples/ram/disassociate-resource-share.rst awscli-1.18.69/awscli/examples/ram/disassociate-resource-share.rst --- awscli-1.11.13/awscli/examples/ram/disassociate-resource-share.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ram/disassociate-resource-share.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,19 @@ +**To disassociate a resource from a resource share** + +The following ``disassociate-resource-share`` example disassociates the specified subnet from the specified resource share. :: + + aws ram disassociate-resource-share \ + --resource-arns arn:aws:ec2:us-west-2:123456789012:subnet/subnet-0250c25a1f4e15235 \ + --resource-share-arn arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE + +Output:: + + { + "resourceShareAssociations": [ + "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE", + "associatedEntity": "arn:aws:ec2:us-west-2:123456789012:subnet/subnet-0250c25a1f4e15235", + "associationType": "RESOURCE", + "status": "DISASSOCIATING", + "external": false + ] + } diff -Nru awscli-1.11.13/awscli/examples/ram/enable-sharing-with-aws-organization.rst awscli-1.18.69/awscli/examples/ram/enable-sharing-with-aws-organization.rst --- awscli-1.11.13/awscli/examples/ram/enable-sharing-with-aws-organization.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ram/enable-sharing-with-aws-organization.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To enable resource sharing across AWS Organizations** + +The following ``enable-sharing-with-aws-organization`` example enables resource sharing across your organization or organizational units. :: + + aws ram enable-sharing-with-aws-organization + +The following output indicates success. :: + + { + "returnValue": true + } diff -Nru awscli-1.11.13/awscli/examples/ram/get-resource-policies.rst awscli-1.18.69/awscli/examples/ram/get-resource-policies.rst --- awscli-1.11.13/awscli/examples/ram/get-resource-policies.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ram/get-resource-policies.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,14 @@ +**To get the policies for a resource** + +The following ``get-resource-policies`` example displays the policies for the specified subnet associated with a resource share. :: + + aws ram get-resource-policies \ + --resource-arns arn:aws:ec2:us-west-2:123456789012:subnet/subnet-0250c25a1f4e15235 + +Output:: + + { + "policies": [ + "{\"Version\":\"2008-10-17\",\"Statement\":[{\"Sid\":\"RamStatement1\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":[]},\"Action\":[\"ec2:RunInstances\",\"ec2:CreateNetworkInterface\",\"ec2:DescribeSubnets\"],\"Resource\":\"arn:aws:ec2:us-west-2:123456789012:subnet/subnet-0250c25a1f4e15235\"}]}" + ] + } diff -Nru awscli-1.11.13/awscli/examples/ram/get-resource-share-associations.rst awscli-1.18.69/awscli/examples/ram/get-resource-share-associations.rst --- awscli-1.11.13/awscli/examples/ram/get-resource-share-associations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ram/get-resource-share-associations.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,46 @@ +**Example 1: To list resource associations** + +The following ``get-resource-share-associations`` example lists your resource associations. :: + + aws ram get-resource-share-associations \ + --association-type RESOURCE + +Output:: + + { + "resourceShareAssociations": [ + { + "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE", + "associatedEntity": "arn:aws:ec2:us-west-2:123456789012:subnet/subnet-0250c25a1f4e15235", + "associationType": "RESOURCE", + "status": "ASSOCIATED", + "creationTime": 1565303590.973, + "lastUpdatedTime": 1565303591.695, + "external": false + } + ] + } + +**Example 2: To list principal associations** + +The following ``get-resource-share-associations`` example lists the principal associations for the specified resource share. :: + + aws ram get-resource-share-associations \ + --association-type PRINCIPAL \ + --resource-share-arn arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE + +Output:: + + { + "resourceShareAssociations": [ + { + "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE", + "associatedEntity": "0abcdef1234567890", + "associationType": "PRINCIPAL", + "status": "ASSOCIATED", + "creationTime": 1565296791.818, + "lastUpdatedTime": 1565296792.119, + "external": true + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/ram/get-resource-share-invitations.rst awscli-1.18.69/awscli/examples/ram/get-resource-share-invitations.rst --- awscli-1.11.13/awscli/examples/ram/get-resource-share-invitations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ram/get-resource-share-invitations.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,21 @@ +**To list your resource share invitations** + +The following ``get-resource-share-invitations`` example lists your resource share invitations. :: + + aws ram get-resource-share-invitations + +Output:: + + { + "resourceShareInvitations": [ + { + "resourceShareInvitationArn": "arn:aws:ram:us-west2-1:21077EXAMPLE:resource-share-invitation/32b639f0-14b8-7e8f-55ea-e6117EXAMPLE", + "resourceShareName": "project-resource-share", + "resourceShareArn": "arn:aws:ram:us-west-2:21077EXAMPLE:resource-share/fcb639f0-1449-4744-35bc-a983fc0d4ce1", + "senderAccountId": "21077EXAMPLE", + "receiverAccountId": "123456789012", + "invitationTimestamp": 1565312166.258, + "status": "PENDING" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/ram/get-resource-shares.rst awscli-1.18.69/awscli/examples/ram/get-resource-shares.rst --- awscli-1.11.13/awscli/examples/ram/get-resource-shares.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ram/get-resource-shares.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,37 @@ +**To list your resource shares** + +The following ``get-resource-shares`` example lists your resource shares. :: + + aws ram get-resource-shares \ + --resource-owner SELF + +Output:: + + { + "resourceShares": [ + { + "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/3ab63985-99d9-1cd2-7d24-75e93EXAMPLE", + "name": "my-resource-share", + "owningAccountId": "123456789012", + "allowExternalPrincipals": false, + "status": "ACTIVE", + "tags": [ + { + "key": "project", + "value": "lima" + } + ] + "creationTime": 1565295733.282, + "lastUpdatedTime": 1565295733.282 + }, + { + "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE", + "name": "my-resource-share", + "owningAccountId": "123456789012", + "allowExternalPrincipals": true, + "status": "ACTIVE", + "creationTime": 1565295733.282, + "lastUpdatedTime": 1565295733.282 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/ram/list-principals.rst awscli-1.18.69/awscli/examples/ram/list-principals.rst --- awscli-1.11.13/awscli/examples/ram/list-principals.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ram/list-principals.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,20 @@ +**To list principals with access to a resource** + +The following ``list-principals`` example displays a list of the principals that can access the subnets associated with a resource share. :: + + aws ram list-principals \ + --resource-type ec2:Subnet + +Output:: + + { + "principals": [ + { + "id": "arn:aws:organizations::123456789012:ou/o-gx7EXAMPLE/ou-29c5-zEXAMPLE", + "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE", + "creationTime": 1565298209.737, + "lastUpdatedTime": 1565298211.019, + "external": false + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/ram/list-resources.rst awscli-1.18.69/awscli/examples/ram/list-resources.rst --- awscli-1.11.13/awscli/examples/ram/list-resources.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ram/list-resources.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,22 @@ +**To list the resources associated with a resource share** + +The following ``list-resources`` example lists the subnets that you added to the specified resource share. :: + + aws ram list-resources \ + --resource-type ec2:Subnet \ + --resource-owner SELF \ + --resource-share-arn arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE + +Output:: + + { + "resources": [ + { + "arn": "aarn:aws:ec2:us-west-2:123456789012:subnet/subnet-0250c25a1f4e15235", + "type": "ec2:Subnet", + "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE", + "creationTime": 1565301545.023, + "lastUpdatedTime": 1565301545.947 + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/ram/reject-resource-share-invitation.rst awscli-1.18.69/awscli/examples/ram/reject-resource-share-invitation.rst --- awscli-1.11.13/awscli/examples/ram/reject-resource-share-invitation.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ram/reject-resource-share-invitation.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,20 @@ +**To reject a resource share invitation** + +The following ``reject-resource-share-invitation`` example rejects the specified resource share invitation. :: + + aws ram reject-resource-share-invitation \ + --resource-share-invitation-arn arn:aws:ram:us-west-2:123456789012:resource-share-invitation/arn:aws:ram:us-east-1:210774411744:resource-share-invitation/32b639f0-14b8-7e8f-55ea-e6117EXAMPLE + +Output:: + + "resourceShareInvitations": [ + { + "resourceShareInvitationArn": "arn:aws:ram:us-west2-1:21077EXAMPLE:resource-share-invitation/32b639f0-14b8-7e8f-55ea-e6117EXAMPLE", + "resourceShareName": "project-resource-share", + "resourceShareArn": "arn:aws:ram:us-west-2:21077EXAMPLE:resource-share/fcb639f0-1449-4744-35bc-a983fc0d4ce1", + "senderAccountId": "21077EXAMPLE", + "receiverAccountId": "123456789012", + "invitationTimestamp": 1565319592.463, + "status": "REJECTED" + } + ] diff -Nru awscli-1.11.13/awscli/examples/ram/tag-resource.rst awscli-1.18.69/awscli/examples/ram/tag-resource.rst --- awscli-1.11.13/awscli/examples/ram/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ram/tag-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,9 @@ +**To add tags to a resource share** + +The following ``tag-resource`` example adds a tag key ``project`` and associated value ``lima`` to the specified resource share. :: + + aws ram tag-resource \ + --tags key=project,value=lima + --resource-share-arn arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE + +This command produces no output. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ram/untag-resource.rst awscli-1.18.69/awscli/examples/ram/untag-resource.rst --- awscli-1.11.13/awscli/examples/ram/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ram/untag-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,8 @@ +**To remove tags from a resource share** + +The following ``untag-resource`` example removes the ``project`` tag key and associated value from the specified resource share. :: + + aws ram untag-resource \ + --tag-keys project + +This command produces no output. \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/ram/update-resource-share.rst awscli-1.18.69/awscli/examples/ram/update-resource-share.rst --- awscli-1.11.13/awscli/examples/ram/update-resource-share.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/ram/update-resource-share.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,21 @@ +**To update a resource share** + +The following ``update-resource-share`` example makes changes to the specified resource share. :: + + aws ram update-resource-share \ + --allow-external-principals \ + --resource-share-arn arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE + +Output:: + + { + "resourceShare": { + "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE", + "name": "my-resource-share", + "owningAccountId": "123456789012", + "allowExternalPrincipals": true, + "status": "ACTIVE", + "creationTime": 1565295733.282, + "lastUpdatedTime": 1565303080.023 + } + } diff -Nru awscli-1.11.13/awscli/examples/rds/add-option-to-option-group.rst awscli-1.18.69/awscli/examples/rds/add-option-to-option-group.rst --- awscli-1.11.13/awscli/examples/rds/add-option-to-option-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/add-option-to-option-group.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,61 @@ +**To add an option to an option group** + +The following ``add-option-to-option-group`` example adds an option to the specified option group. :: + + aws rds add-option-to-option-group \ + --option-group-name myoptiongroup \ + --options OptionName=OEM,Port=5500,DBSecurityGroupMemberships=default \ + --apply-immediately + +Output:: + + { + "OptionGroup": { + "OptionGroupName": "myoptiongroup", + "OptionGroupDescription": "Test Option Group", + "EngineName": "oracle-ee", + "MajorEngineVersion": "12.1", + "Options": [ + { + "OptionName": "Timezone", + "OptionDescription": "Change time zone", + "Persistent": true, + "Permanent": false, + "OptionSettings": [ + { + "Name": "TIME_ZONE", + "Value": "Australia/Sydney", + "DefaultValue": "UTC", + "Description": "Specifies the timezone the user wants to change the system time to", + "ApplyType": "DYNAMIC", + "DataType": "STRING", + "AllowedValues": "Africa/Cairo,Africa/Casablanca,Africa/Harare,Africa/Lagos,Africa/Luanda,Africa/Monrovia,Africa/Nairobi,Africa/Tripoli,Africa/Windhoek,America/Araguaina,America/Argentina/Buenos_Aires,America/Asuncion,America/Bogota,America/Caracas,America/Chicago,America/Chihuahua,America/Cuiaba,America/Denver,America/Detroit,America/Fortaleza,America/Godthab,America/Guatemala,America/Halifax,America/Lima,America/Los_Angeles,America/Manaus,America/Matamoros,America/Mexico_City,America/Monterrey,America/Montevideo,America/New_York,America/Phoenix,America/Santiago,America/Sao_Paulo,America/Tijuana,America/Toronto,Asia/Amman,Asia/Ashgabat,Asia/Baghdad,Asia/Baku,Asia/Bangkok,Asia/Beirut,Asia/Calcutta,Asia/Damascus,Asia/Dhaka,Asia/Hong_Kong,Asia/Irkutsk,Asia/Jakarta,Asia/Jerusalem,Asia/Kabul,Asia/Karachi,Asia/Kathmandu,Asia/Kolkata,Asia/Krasnoyarsk,Asia/Magadan,Asia/Manila,Asia/Muscat,Asia/Novosibirsk,Asia/Rangoon,Asia/Riyadh,Asia/Seoul,Asia/Shanghai,Asia/Singapore,Asia/Taipei,Asia/Tehran,Asia/Tokyo,Asia/Ulaanbaatar,Asia/Vladivostok,Asia/Yakutsk,Asia/Yerevan,Atlantic/Azores,Atlantic/Cape_Verde,Australia/Adelaide,Australia/Brisbane,Australia/Darwin,Australia/Eucla,Australia/Hobart,Australia/Lord_Howe,Australia/Perth,Australia/Sydney,Brazil/DeNoronha,Brazil/East,Canada/Newfoundland,Canada/Saskatchewan,Etc/GMT-3,Europe/Amsterdam,Europe/Athens,Europe/Berlin,Europe/Dublin,Europe/Helsinki,Europe/Kaliningrad,Europe/London,Europe/Madrid,Europe/Moscow,Europe/Paris,Europe/Prague,Europe/Rome,Europe/Sarajevo,Pacific/Apia,Pacific/Auckland,Pacific/Chatham,Pacific/Fiji,Pacific/Guam,Pacific/Honolulu,Pacific/Kiritimati,Pacific/Marquesas,Pacific/Samoa,Pacific/Tongatapu,Pacific/Wake,US/Alaska,US/Central,US/East-Indiana,US/Eastern,US/Pacific,UTC", + "IsModifiable": true, + "IsCollection": false + } + ], + "DBSecurityGroupMemberships": [], + "VpcSecurityGroupMemberships": [] + }, + { + "OptionName": "OEM", + "OptionDescription": "Oracle 12c EM Express", + "Persistent": false, + "Permanent": false, + "Port": 5500, + "OptionSettings": [], + "DBSecurityGroupMemberships": [ + { + "DBSecurityGroupName": "default", + "Status": "authorized" + } + ], + "VpcSecurityGroupMemberships": [] + } + ], + "AllowsVpcAndNonVpcInstanceMemberships": false, + "OptionGroupArn": "arn:aws:rds:us-east-1:123456789012:og:myoptiongroup" + } + } + +For more information, see `Adding an Option to an Option Group `__ in the *Amazon RDS User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/add-role-to-db-instance.rst awscli-1.18.69/awscli/examples/rds/add-role-to-db-instance.rst --- awscli-1.11.13/awscli/examples/rds/add-role-to-db-instance.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/add-role-to-db-instance.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,12 @@ +**To associate an AWS Identity and Access Management (IAM) role with a DB instance** + +The following ``add-role-to-db-instance`` example adds the role to an Oracle DB instance named ``test-instance``. :: + + aws rds add-role-to-db-instance \ + --db-instance-identifier test-instance \ + --feature-name S3_INTEGRATION \ + --role-arn arn:aws:iam::111122223333:role/rds-s3-integration-role + +This command produces no output. + +For more information, see `Prerequisites for Amazon RDS Oracle Integration with Amazon S3 `__ in the *Amazon RDS User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/add-source-identifier-to-subscription.rst awscli-1.18.69/awscli/examples/rds/add-source-identifier-to-subscription.rst --- awscli-1.11.13/awscli/examples/rds/add-source-identifier-to-subscription.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/add-source-identifier-to-subscription.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,30 @@ +**To add a source identifier to a subscription** + +The following ``add-source-identifier`` example adds another source identifier to an existing subscription. :: + + aws rds add-source-identifier-to-subscription \ + --subscription-name my-instance-events \ + --source-identifier test-instance-repl + +Output:: + + { + "EventSubscription": { + "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018", + "CustSubscriptionId": "my-instance-events", + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "Enabled": false, + "Status": "modifying", + "EventCategoriesList": [ + "backup", + "recovery" + ], + "CustomerAwsId": "123456789012", + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", + "SourceType": "db-instance", + "SourceIdsList": [ + "test-instance", + "test-instance-repl" + ] + } + } diff -Nru awscli-1.11.13/awscli/examples/rds/add-tags-to-resource.rst awscli-1.18.69/awscli/examples/rds/add-tags-to-resource.rst --- awscli-1.11.13/awscli/examples/rds/add-tags-to-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/add-tags-to-resource.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,11 @@ +**To add tags to a resource** + +The following ``add-tags-to-resource`` example add tags to an RDS database. :: + + aws rds add-tags-to-resource \ + --resource-name arn:aws:rds:us-east-1:123456789012:db:database-mysql \ + --tags "[{\"Key\": \"Name\",\"Value\": \"MyDatabase\"},{\"Key\": \"Environment\",\"Value\": \"test\"}]" + +This command produces no output. + +For more information, see `Tagging Amazon RDS Resources `__ in the *Amazon RDS User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/add-tag-to-resource.rst awscli-1.18.69/awscli/examples/rds/add-tag-to-resource.rst --- awscli-1.11.13/awscli/examples/rds/add-tag-to-resource.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/add-tag-to-resource.rst 1970-01-01 00:00:00.000000000 +0000 @@ -1,14 +0,0 @@ -**To add a tag to an Amazon RDS resource** - -The following ``add-tags-to-resource`` command adds a tag to an Amazon RDS resource. In the example, a DB instance is -identified by the instance's ARN, arn:aws:rds:us-west-2:001234567890:db:mysql-db1. The tag that is added to the DB -instance has a key of ``project`` and a value of ``salix``:: - - aws rds add-tags-to-resource --resource-name arn:aws:rds:us-west-2:001234567890:db:mysql-db1 --tags account=sg01,project=salix - -This command outputs a JSON block that acknowledges the change to the RDS resource. - -For more information, see `Tagging an Amazon RDS DB Instance`_ in the *AWS Command Line Interface User Guide*. - -.. _`Tagging an Amazon RDS DB Instance`: http://docs.aws.amazon.com/cli/latest/userguide/cli-rds-add-tags.html - diff -Nru awscli-1.11.13/awscli/examples/rds/backtrack-db-cluster.rst awscli-1.18.69/awscli/examples/rds/backtrack-db-cluster.rst --- awscli-1.11.13/awscli/examples/rds/backtrack-db-cluster.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/backtrack-db-cluster.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,7 @@ +**To backtrack an Aurora DB cluster** + +The following ``backtrack-db-cluster`` example backtracks the specified DB cluster sample-cluster to March 19, 2018, at 10 a.m. :: + + aws rds backtrack-db-cluster --db-cluster-identifier sample-cluster --backtrack-to 2018-03-19T10:00:00+00:00 + +This command outputs a JSON block that acknowledges the change to the RDS resource. diff -Nru awscli-1.11.13/awscli/examples/rds/copy-db-cluster-parameter-group.rst awscli-1.18.69/awscli/examples/rds/copy-db-cluster-parameter-group.rst --- awscli-1.11.13/awscli/examples/rds/copy-db-cluster-parameter-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/copy-db-cluster-parameter-group.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,21 @@ +**To copy a DB cluster parameter group** + +The following ``copy-db-cluster-parameter-group`` example makes a copy of a DB cluster parameter group. :: + + aws rds copy-db-cluster-parameter-group \ + --source-db-cluster-parameter-group-identifier mydbclusterpg \ + --target-db-cluster-parameter-group-identifier mydbclusterpgcopy \ + --target-db-cluster-parameter-group-description "Copy of mydbclusterpg parameter group" + +Output:: + + { + "DBClusterParameterGroup": { + "DBClusterParameterGroupName": "mydbclusterpgcopy", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterpgcopy", + "DBParameterGroupFamily": "aurora-mysql5.7", + "Description": "Copy of mydbclusterpg parameter group" + } + } + +For more information, see `Copying a DB Cluster Parameter Group `__ in the *Amazon Aurora Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/copy-db-cluster-snapshot.rst awscli-1.18.69/awscli/examples/rds/copy-db-cluster-snapshot.rst --- awscli-1.11.13/awscli/examples/rds/copy-db-cluster-snapshot.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/copy-db-cluster-snapshot.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,40 @@ +**To copy a DB cluster snapshot** + +The following ``copy-db-cluster-snapshot`` example creates a copy of a DB cluster snapshot, including its tags. :: + + aws rds copy-db-cluster-snapshot \ + --source-db-cluster-snapshot-identifier arn:aws:rds:us-east-1:123456789012:cluster-snapshot:rds:myaurora-2019-06-04-09-16 + --target-db-cluster-snapshot-identifier myclustersnapshotcopy \ + --copy-tags + +Output:: + + { + "DBClusterSnapshot": { + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "DBClusterSnapshotIdentifier": "myclustersnapshotcopy", + "DBClusterIdentifier": "myaurora", + "SnapshotCreateTime": "2019-06-04T09:16:42.649Z", + "Engine": "aurora-mysql", + "AllocatedStorage": 0, + "Status": "available", + "Port": 0, + "VpcId": "vpc-6594f31c", + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "MasterUsername": "myadmin", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LicenseModel": "aurora-mysql", + "SnapshotType": "manual", + "PercentProgress": 100, + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:myclustersnapshotcopy", + "IAMDatabaseAuthenticationEnabled": false + } + } + +For more information, see `Copying a Snapshot `__ in the *Amazon Aurora User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/copy-db-parameter-group.rst awscli-1.18.69/awscli/examples/rds/copy-db-parameter-group.rst --- awscli-1.11.13/awscli/examples/rds/copy-db-parameter-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/copy-db-parameter-group.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,21 @@ +**To copy a DB cluster parameter group** + +The following ``copy-db-parameter-group`` example makes a copy of a DB parameter group. :: + + aws rds copy-db-parameter-group \ + --source-db-parameter-group-identifier mydbpg \ + --target-db-parameter-group-identifier mydbpgcopy \ + --target-db-parameter-group-description "Copy of mydbpg parameter group" + +Output:: + + { + "DBParameterGroup": { + "DBParameterGroupName": "mydbpgcopy", + "DBParameterGroupArn": "arn:aws:rds:us-east-1:814387698303:pg:mydbpgcopy", + "DBParameterGroupFamily": "mysql5.7", + "Description": "Copy of mydbpg parameter group" + } + } + +For more information, see `Copying a DB Parameter Group `__ in the *Amazon RDS Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/copy-db-snapshot.rst awscli-1.18.69/awscli/examples/rds/copy-db-snapshot.rst --- awscli-1.11.13/awscli/examples/rds/copy-db-snapshot.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/copy-db-snapshot.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,42 @@ +**To copy a DB snapshot** + +The following ``copy-db-snapshot`` example creates a copy of a DB snapshot. :: + + aws rds copy-db-snapshot \ + --source-db-snapshot-identifier rds:database-mysql-2019-06-06-08-38 + --target-db-snapshot-identifier mydbsnapshotcopy + +Output:: + + { + "DBSnapshot": { + "VpcId": "vpc-6594f31c", + "Status": "creating", + "Encrypted": true, + "SourceDBSnapshotIdentifier": "arn:aws:rds:us-east-1:123456789012:snapshot:rds:database-mysql-2019-06-06-08-38", + "MasterUsername": "admin", + "Iops": 1000, + "Port": 3306, + "LicenseModel": "general-public-license", + "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshotcopy", + "EngineVersion": "5.6.40", + "OptionGroupName": "default:mysql-5-6", + "ProcessorFeatures": [], + "Engine": "mysql", + "StorageType": "io1", + "DbiResourceId": "db-ZI7UJ5BLKMBYFGX7FDENCKADC4", + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "SnapshotType": "manual", + "IAMDatabaseAuthenticationEnabled": false, + "SourceRegion": "us-east-1", + "DBInstanceIdentifier": "database-mysql", + "InstanceCreateTime": "2019-04-30T15:45:53.663Z", + "AvailabilityZone": "us-east-1f", + "PercentProgress": 0, + "AllocatedStorage": 100, + "DBSnapshotIdentifier": "mydbsnapshotcopy" + } + } + + +For more information, see `Copying a Snapshot `__ in the *Amazon RDS User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/copy-option-group.rst awscli-1.18.69/awscli/examples/rds/copy-option-group.rst --- awscli-1.11.13/awscli/examples/rds/copy-option-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/copy-option-group.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,24 @@ +**To copy an option group** + +The following ``copy-option-group`` example makes a copy of an option group. :: + + aws rds copy-option-group \ + --source-option-group-identifier myoptiongroup \ + --target-option-group-identifier new-option-group \ + --target-option-group-description "My option group copy" + +Output:: + + { + "OptionGroup": { + "Options": [], + "OptionGroupName": "new-option-group", + "MajorEngineVersion": "11.2", + "OptionGroupDescription": "My option group copy", + "AllowsVpcAndNonVpcInstanceMemberships": true, + "EngineName": "oracle-ee", + "OptionGroupArn": "arn:aws:rds:us-east-1:123456789012:og:new-option-group" + } + } + +For more information, see `Making a Copy of an Option Group `__ in the *Amazon RDS User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/create-db-cluster-endpoint.rst awscli-1.18.69/awscli/examples/rds/create-db-cluster-endpoint.rst --- awscli-1.11.13/awscli/examples/rds/create-db-cluster-endpoint.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/create-db-cluster-endpoint.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,29 @@ +**To create a custom DB cluster endpoint** + +The following ``create-db-cluster-endpoint`` example creates a custom DB cluster endpoint and associate it with the specified Aurora DB cluster. :: + + aws rds create-db-cluster-endpoint \ + --db-cluster-endpoint-identifier mycustomendpoint \ + --endpoint-type reader \ + --db-cluster-identifier mydbcluster \ + --static-members dbinstance1 dbinstance2 + +Output:: + + { + "DBClusterEndpointIdentifier": "mycustomendpoint", + "DBClusterIdentifier": "mydbcluster", + "DBClusterEndpointResourceIdentifier": "cluster-endpoint-ANPAJ4AE5446DAEXAMPLE", + "Endpoint": "mycustomendpoint.cluster-custom-cnpexample.us-east-1.rds.amazonaws.com", + "Status": "creating", + "EndpointType": "CUSTOM", + "CustomEndpointType": "READER", + "StaticMembers": [ + "dbinstance1", + "dbinstance2" + ], + "ExcludedMembers": [], + "DBClusterEndpointArn": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:mycustomendpoint" + } + +For more information, see `Amazon Aurora Connection Management `__ in the *Amazon Aurora User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/create-db-cluster-parameter-group.rst awscli-1.18.69/awscli/examples/rds/create-db-cluster-parameter-group.rst --- awscli-1.11.13/awscli/examples/rds/create-db-cluster-parameter-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/create-db-cluster-parameter-group.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,21 @@ +**To create a DB cluster parameter group** + +The following ``create-db-cluster-parameter-group`` example creates a DB cluster parameter group. :: + + aws rds create-db-cluster-parameter-group \ + --db-cluster-parameter-group-name mydbclusterparametergroup \ + --db-parameter-group-family aurora5.6 \ + --description "My new cluster parameter group" + +Output:: + + { + "DBClusterParameterGroup": { + "DBClusterParameterGroupName": "mydbclusterparametergroup", + "DBParameterGroupFamily": "aurora5.6", + "Description": "My new cluster parameter group", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterparametergroup" + } + } + +For more information, see `Creating a DB Cluster Parameter Group `__ in the *Amazon Aurora User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/create-db-cluster.rst awscli-1.18.69/awscli/examples/rds/create-db-cluster.rst --- awscli-1.11.13/awscli/examples/rds/create-db-cluster.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/create-db-cluster.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,118 @@ +**Example 1: To create a MySQL 5.7--compatible DB cluster** + +The following ``create-db-cluster`` example create a MySQL 5.7-compatible DB cluster. Replace the sample password ``secret99`` with a secure password. The writer DB instance is the first instance that is created in a DB cluster. When you use the console to create a DB cluster, Amazon RDS automatically creates the writer DB instance for your DB cluster. However, when you use the AWS CLI to create a DB cluster, you must explicitly create the writer DB instance for your DB cluster using the ``create-db-instance`` AWS CLI command. :: + + aws rds create-db-cluster \ + --db-cluster-identifier sample-cluster \ + --engine aurora-mysql \ + --engine-version 5.7.12 \ + --master-username master \ + --master-user-password secret99 \ + --db-subnet-group-name default \ + --vpc-security-group-ids sg-0b9130572daf3dc16 + +Output:: + + { + "DBCluster": { + "DBSubnetGroup": "default", + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-0b9130572daf3dc16", + "Status": "active" + } + ], + "AllocatedStorage": 1, + "AssociatedRoles": [], + "PreferredBackupWindow": "09:12-09:42", + "ClusterCreateTime": "2019-06-07T23:21:33.048Z", + "DeletionProtection": false, + "IAMDatabaseAuthenticationEnabled": false, + "ReadReplicaIdentifiers": [], + "EngineMode": "provisioned", + "Engine": "aurora-mysql", + "StorageEncrypted": false, + "MultiAZ": false, + "PreferredMaintenanceWindow": "mon:04:31-mon:05:01", + "HttpEndpointEnabled": false, + "BackupRetentionPeriod": 1, + "DbClusterResourceId": "cluster-ANPAJ4AE5446DAEXAMPLE", + "DBClusterIdentifier": "sample-cluster", + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "MasterUsername": "master", + "EngineVersion": "5.7.12", + "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster", + "DBClusterMembers": [], + "Port": 3306, + "Status": "creating", + "Endpoint": "sample-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com", + "DBClusterParameterGroup": "default.aurora-mysql5.7", + "HostedZoneId": "Z2R2ITUGPM61AM", + "ReaderEndpoint": "sample-cluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", + "CopyTagsToSnapshot": false + } + } + +**Example 2: To create a PostgreSQL--compatible DB cluster** + +The following ``create-db-cluster`` example creates a PostgreSQL-compatible DB cluster. Replace the example password ``secret99`` with a secure password. The writer DB instance is the first instance that is created in a DB cluster. When you use the console to create a DB cluster, Amazon RDS automatically creates the writer DB instance for your DB cluster. However, when you use the AWS CLI to create a DB cluster, you must explicitly create the writer DB instance for your DB cluster using the ``create-db-instance`` AWS CLI command. :: + + aws rds create-db-cluster \ + --db-cluster-identifier sample-pg-cluster \ + --engine aurora-postgresql \ + --master-username master \ + --master-user-password secret99 \ + --db-subnet-group-name default \ + --vpc-security-group-ids sg-0b9130572daf3dc16 + +Output:: + + { + "DBCluster": { + "Endpoint": "sample-pg-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com", + "HttpEndpointEnabled": false, + "DBClusterMembers": [], + "EngineMode": "provisioned", + "CopyTagsToSnapshot": false, + "HostedZoneId": "Z2R2ITUGPM61AM", + "IAMDatabaseAuthenticationEnabled": false, + "AllocatedStorage": 1, + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-0b9130572daf3dc16", + "Status": "active" + } + ], + "DeletionProtection": false, + "StorageEncrypted": false, + "BackupRetentionPeriod": 1, + "PreferredBackupWindow": "09:56-10:26", + "ClusterCreateTime": "2019-06-07T23:26:08.371Z", + "DBClusterParameterGroup": "default.aurora-postgresql9.6", + "EngineVersion": "9.6.9", + "Engine": "aurora-postgresql", + "Status": "creating", + "DBClusterIdentifier": "sample-pg-cluster", + "MultiAZ": false, + "Port": 5432, + "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-pg-cluster", + "AssociatedRoles": [], + "DbClusterResourceId": "cluster-ANPAJ4AE5446DAEXAMPLE", + "PreferredMaintenanceWindow": "wed:03:33-wed:04:03", + "ReaderEndpoint": "sample-pg-cluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", + "MasterUsername": "master", + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1c" + ], + "ReadReplicaIdentifiers": [], + "DBSubnetGroup": "default" + } + } + +For more information, see `Creating an Amazon Aurora DB Cluster `__ in the *Amazon Aurora Users Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/create-db-cluster-snapshot.rst awscli-1.18.69/awscli/examples/rds/create-db-cluster-snapshot.rst --- awscli-1.11.13/awscli/examples/rds/create-db-cluster-snapshot.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/create-db-cluster-snapshot.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,39 @@ +**To create a DB cluster snapshot** + +The following ``create-db-cluster-snapshot`` example creates a DB cluster snapshot. :: + + aws rds create-db-cluster-snapshot \ + --db-cluster-identifier mydbcluster \ + --db-cluster-snapshot-identifier mydbclustersnapshot + +Output:: + + { + "DBClusterSnapshot": { + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "DBClusterSnapshotIdentifier": "mydbclustersnapshot", + "DBClusterIdentifier": "mydbcluster", + "SnapshotCreateTime": "2019-06-18T21:21:00.469Z", + "Engine": "aurora-mysql", + "AllocatedStorage": 1, + "Status": "creating", + "Port": 0, + "VpcId": "vpc-6594f31c", + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "MasterUsername": "myadmin", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LicenseModel": "aurora-mysql", + "SnapshotType": "manual", + "PercentProgress": 0, + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:mydbclustersnapshot", + "IAMDatabaseAuthenticationEnabled": false + } + } + +For more information, see `Creating a DB Cluster Snapshot `__ in the *Amazon Aurora User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/create-db-instance-read-replica.rst awscli-1.18.69/awscli/examples/rds/create-db-instance-read-replica.rst --- awscli-1.11.13/awscli/examples/rds/create-db-instance-read-replica.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/create-db-instance-read-replica.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,20 @@ +**To create a DB instance read replica** + +This example creates a read replica of an existing DB instance named ``test-instance``. The read replica is named ``test-instance-repl``. :: + + aws rds create-db-instance-read-replica \ + --db-instance-identifier test-instance-repl \ + --source-db-instance-identifier test-instance + +Output:: + + { + "DBInstance": { + "IAMDatabaseAuthenticationEnabled": false, + "MonitoringInterval": 0, + "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance-repl", + "ReadReplicaSourceDBInstanceIdentifier": "test-instance", + "DBInstanceIdentifier": "test-instance-repl", + ...some output truncated... + } + } diff -Nru awscli-1.11.13/awscli/examples/rds/create-db-instance.rst awscli-1.18.69/awscli/examples/rds/create-db-instance.rst --- awscli-1.11.13/awscli/examples/rds/create-db-instance.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/create-db-instance.rst 2020-05-28 19:25:50.000000000 +0000 @@ -1,55 +1,124 @@ -**To create an Amazon RDS DB instance** +**To create a DB instance** -The following ``create-db-instance`` command launches a new Amazon RDS DB instance:: +The following ``create-db-instance`` example launches a new DB instance. :: - aws rds create-db-instance --db-instance-identifier sg-cli-test \ - --allocated-storage 20 --db-instance-class db.m1.small --engine mysql \ - --master-username myawsuser --master-user-password myawsuser + aws rds create-db-instance \ + --allocated-storage 20 --db-instance-class db.m1.small \ + --db-instance-identifier test-instance \ + --engine mysql \ + --enable-cloudwatch-logs-exports '["audit","error","general","slowquery"]' \ + --master-username master \ + --master-user-password secret99 -In the preceding example, the DB instance is created with 20 Gb of standard storage and has a DB engine class of -db.m1.small. The master username and master password are provided. - -This command outputs a JSON block that indicates that the DB instance was created:: +Output:: { "DBInstance": { + "DBInstanceIdentifier": "test-instance", + "DBInstanceClass": "db.m1.small", "Engine": "mysql", - "MultiAZ": false, - "DBSecurityGroups": [ + "DBInstanceStatus": "creating", + "MasterUsername": "master", + "AllocatedStorage": 20, + "PreferredBackupWindow": "10:27-10:57", + "BackupRetentionPeriod": 1, + "DBSecurityGroups": [], + "VpcSecurityGroups": [ { - "Status": "active", - "DBSecurityGroupName": "default" + "VpcSecurityGroupId": "sg-f839b688", + "Status": "active" } ], - "DBInstanceStatus": "creating", "DBParameterGroups": [ { "DBParameterGroupName": "default.mysql5.6", "ParameterApplyStatus": "in-sync" } ], - "MasterUsername": "myawsuser", + "DBSubnetGroup": { + "DBSubnetGroupName": "default", + "DBSubnetGroupDescription": "default", + "VpcId": "vpc-136a4c6a", + "SubnetGroupStatus": "Complete", + "Subnets": [ + { + "SubnetIdentifier": "subnet-cbfff283", + "SubnetAvailabilityZone": { + "Name": "us-east-1b" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-d7c825e8", + "SubnetAvailabilityZone": { + "Name": "us-east-1e" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-6746046b", + "SubnetAvailabilityZone": { + "Name": "us-east-1f" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-bac383e0", + "SubnetAvailabilityZone": { + "Name": "us-east-1c" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-42599426", + "SubnetAvailabilityZone": { + "Name": "us-east-1d" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-da327bf6", + "SubnetAvailabilityZone": { + "Name": "us-east-1a" + }, + "SubnetStatus": "Active" + } + ] + }, + "PreferredMaintenanceWindow": "sat:05:47-sat:06:17", + "PendingModifiedValues": { + "MasterUserPassword": "****", + "PendingCloudwatchLogsExports": { + "LogTypesToEnable": [ + "audit", + "error", + "general", + "slowquery" + ] + } + }, + "MultiAZ": false, + "EngineVersion": "5.6.39", + "AutoMinorVersionUpgrade": true, + "ReadReplicaDBInstanceIdentifiers": [], "LicenseModel": "general-public-license", "OptionGroupMemberships": [ { - "Status": "in-sync", - "OptionGroupName": "default:mysql-5-6" + "OptionGroupName": "default:mysql-5-6", + "Status": "in-sync" } ], - "AutoMinorVersionUpgrade": true, - "PreferredBackupWindow": "11:58-12:28", - "VpcSecurityGroups": [], "PubliclyAccessible": true, - "PreferredMaintenanceWindow": "sat:13:10-sat:13:40", - "AllocatedStorage": 20, - "EngineVersion": "5.6.13", - "DBInstanceClass": "db.m1.small", - "ReadReplicaDBInstanceIdentifiers": [], - "BackupRetentionPeriod": 1, - "DBInstanceIdentifier": "sg-cli-test", - "PendingModifiedValues": { - "MasterUserPassword": "****" - } + "StorageType": "standard", + "DbInstancePort": 0, + "StorageEncrypted": false, + "DbiResourceId": "db-ETDZIIXHEWY5N7GXVC4SH7H5IA", + "CACertificateIdentifier": "rds-ca-2015", + "DomainMemberships": [], + "CopyTagsToSnapshot": false, + "MonitoringInterval": 0, + "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance", + "IAMDatabaseAuthenticationEnabled": false, + "PerformanceInsightsEnabled": false } } - diff -Nru awscli-1.11.13/awscli/examples/rds/create-db-parameter-group.rst awscli-1.18.69/awscli/examples/rds/create-db-parameter-group.rst --- awscli-1.11.13/awscli/examples/rds/create-db-parameter-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/create-db-parameter-group.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,21 @@ +**To create a DB parameter group** + +The following ``create-db-parameter-group`` example creates a DB parameter group. :: + + aws rds create-db-parameter-group \ + --db-parameter-group-name mydbparametergroup \ + --db-parameter-group-family MySQL5.6 \ + --description "My new parameter group" + +Output:: + + { + "DBParameterGroup": { + "DBParameterGroupName": "mydbparametergroup", + "DBParameterGroupFamily": "mysql5.6", + "Description": "My new parameter group", + "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:mydbparametergroup" + } + } + +For more information, see `Creating a DB Parameter Group `__ in the *Amazon RDS User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/create-db-security-group.rst awscli-1.18.69/awscli/examples/rds/create-db-security-group.rst --- awscli-1.11.13/awscli/examples/rds/create-db-security-group.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/create-db-security-group.rst 2020-05-28 19:25:50.000000000 +0000 @@ -6,9 +6,16 @@ In the example, the new DB security group is named ``mysecgroup`` and has a description. -This command output a JSON block that contains information about the DB security group. - -For more information, see `Create an Amazon RDS DB Security Group`_ in the *AWS Command Line Interface User Guide*. - -.. _`Create an Amazon RDS DB Security Group`: http://docs.aws.amazon.com/cli/latest/userguide/cli-rds-create-secgroup.html +Output:: + { + "DBSecurityGroup": { + "OwnerId": "123456789012", + "DBSecurityGroupName": "mysecgroup", + "DBSecurityGroupDescription": "My Test Security Group", + "VpcId": "vpc-a1b2c3d4", + "EC2SecurityGroups": [], + "IPRanges": [], + "DBSecurityGroupArn": "arn:aws:rds:us-west-2:123456789012:secgrp:mysecgroup" + } + } diff -Nru awscli-1.11.13/awscli/examples/rds/create-db-snapshot.rst awscli-1.18.69/awscli/examples/rds/create-db-snapshot.rst --- awscli-1.11.13/awscli/examples/rds/create-db-snapshot.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/create-db-snapshot.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,39 @@ +**To create a DB snapshot** + +The following ``create-db-snapshot`` example creates a DB snapshot. :: + + aws rds create-db-snapshot \ + --db-instance-identifier database-mysql \ + --db-snapshot-identifier mydbsnapshot + +Output:: + + { + "DBSnapshot": { + "DBSnapshotIdentifier": "mydbsnapshot", + "DBInstanceIdentifier": "database-mysql", + "Engine": "mysql", + "AllocatedStorage": 100, + "Status": "creating", + "Port": 3306, + "AvailabilityZone": "us-east-1b", + "VpcId": "vpc-6594f31c", + "InstanceCreateTime": "2019-04-30T15:45:53.663Z", + "MasterUsername": "admin", + "EngineVersion": "5.6.40", + "LicenseModel": "general-public-license", + "SnapshotType": "manual", + "Iops": 1000, + "OptionGroupName": "default:mysql-5-6", + "PercentProgress": 0, + "StorageType": "io1", + "Encrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshot", + "IAMDatabaseAuthenticationEnabled": false, + "ProcessorFeatures": [], + "DbiResourceId": "db-AKIAIOSFODNN7EXAMPLE" + } + } + +For more information, see `Creating a DB Snapshot `__ in the *Amazon RDS User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/create-event-subscription.rst awscli-1.18.69/awscli/examples/rds/create-event-subscription.rst --- awscli-1.11.13/awscli/examples/rds/create-event-subscription.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/create-event-subscription.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,28 @@ +**To create an event subscription** + +The following ``create-event-subscription`` example creates a subscription for backup and recovery events for DB instances in the current AWS account. Notifications are sent to an Amazon Simple Notification Service topic, specified by ``--sns-topic-arn``. :: + + aws rds create-event-subscription \ + --subscription-name my-instance-events \ + --source-type db-instance \ + --event-categories '["backup","recovery"]' \ + --sns-topic-arn arn:aws:sns:us-east-1:123456789012:interesting-events + +Output:: + + { + "EventSubscription": { + "Status": "creating", + "CustSubscriptionId": "my-instance-events", + "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018", + "EventCategoriesList": [ + "backup", + "recovery" + ], + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", + "CustomerAwsId": "123456789012", + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "SourceType": "db-instance", + "Enabled": true + } + } diff -Nru awscli-1.11.13/awscli/examples/rds/create-option-group.rst awscli-1.18.69/awscli/examples/rds/create-option-group.rst --- awscli-1.11.13/awscli/examples/rds/create-option-group.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/create-option-group.rst 2020-05-28 19:25:50.000000000 +0000 @@ -1,15 +1,23 @@ **To Create an Amazon RDS option group** -The following ``create-option-group`` command creates a new Amazon RDS option group:: - - aws rds create-option-group --option-group-name MyOptionGroup --engine-name oracle-ee --major-engine-version 11.2 --option-group-description "Oracle Database Manager Database Control" - -In the example, the option group is created for Oracle Enterprise Edition version *11.2*, is named *MyOptionGroup* and -includes a description. - -This command output a JSON block that contains information on the option group. - -For more information, see `Create an Amazon RDS Option Group`_ in the *AWS Command Line Interface User Guide*. - -.. _`Create an Amazon RDS Option Group`: http://docs.aws.amazon.com/cli/latest/userguide/cli-rds-create-option-group.html +The following ``create-option-group`` command creates a new Amazon RDS option group for ``Oracle Enterprise Edition`` version ``11.2`, is named ``MyOptionGroup`` and includes a description. :: + aws rds create-option-group \ + --option-group-name MyOptionGroup \ + --engine-name oracle-ee \ + --major-engine-version 11.2 \ + --option-group-description "Oracle Database Manager Database Control" + +Output:: + + { + "OptionGroup": { + "OptionGroupName": "myoptiongroup", + "OptionGroupDescription": "Oracle Database Manager Database Control", + "EngineName": "oracle-ee", + "MajorEngineVersion": "11.2", + "Options": [], + "AllowsVpcAndNonVpcInstanceMemberships": true, + "OptionGroupArn": "arn:aws:rds:us-west-2:123456789012:og:myoptiongroup" + } + } diff -Nru awscli-1.11.13/awscli/examples/rds/delete-db-cluster-endpoint.rst awscli-1.18.69/awscli/examples/rds/delete-db-cluster-endpoint.rst --- awscli-1.11.13/awscli/examples/rds/delete-db-cluster-endpoint.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/delete-db-cluster-endpoint.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,27 @@ +**To delete a custom DB cluster endpoint** + +The following ``delete-db-cluster-endpoint`` example deletes the specified custom DB cluster endpoint. :: + + aws rds delete-db-cluster-endpoint \ + --db-cluster-endpoint-identifier mycustomendpoint + +Output:: + + { + "DBClusterEndpointIdentifier": "mycustomendpoint", + "DBClusterIdentifier": "mydbcluster", + "DBClusterEndpointResourceIdentifier": "cluster-endpoint-ANPAJ4AE5446DAEXAMPLE", + "Endpoint": "mycustomendpoint.cluster-custom-cnpexample.us-east-1.rds.amazonaws.com", + "Status": "deleting", + "EndpointType": "CUSTOM", + "CustomEndpointType": "READER", + "StaticMembers": [ + "dbinstance1", + "dbinstance2", + "dbinstance3" + ], + "ExcludedMembers": [], + "DBClusterEndpointArn": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:mycustomendpoint" + } + +For more information, see `Amazon Aurora Connection Management `__ in the *Amazon Aurora User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/delete-db-cluster-parameter-group.rst awscli-1.18.69/awscli/examples/rds/delete-db-cluster-parameter-group.rst --- awscli-1.11.13/awscli/examples/rds/delete-db-cluster-parameter-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/delete-db-cluster-parameter-group.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a DB cluster parameter group** + +The following ``delete-db-cluster-parameter-group`` example deletes the specified DB cluster parameter group. :: + + aws rds delete-db-cluster-parameter-group \ + --db-cluster-parameter-group-name mydbclusterparametergroup + +This command produces no output. + +For more information, see `Working with DB Parameter Groups and DB Cluster Parameter Groups `__ in the *Amazon Aurora User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/delete-db-cluster-snapshot.rst awscli-1.18.69/awscli/examples/rds/delete-db-cluster-snapshot.rst --- awscli-1.11.13/awscli/examples/rds/delete-db-cluster-snapshot.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/delete-db-cluster-snapshot.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,38 @@ +**To delete a DB cluster snapshot** + +The following ``delete-db-cluster-snapshot`` example deletes the specified DB cluster snapshot. :: + + aws rds delete-db-cluster-snapshot \ + --db-cluster-snapshot-identifier mydbclustersnapshot + +Output:: + + { + "DBClusterSnapshot": { + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "DBClusterSnapshotIdentifier": "mydbclustersnapshot", + "DBClusterIdentifier": "mydbcluster", + "SnapshotCreateTime": "2019-06-18T21:21:00.469Z", + "Engine": "aurora-mysql", + "AllocatedStorage": 0, + "Status": "available", + "Port": 0, + "VpcId": "vpc-6594f31c", + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "MasterUsername": "myadmin", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LicenseModel": "aurora-mysql", + "SnapshotType": "manual", + "PercentProgress": 100, + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:mydbclustersnapshot", + "IAMDatabaseAuthenticationEnabled": false + } + } + +For more information, see `Deleting a Snapshot `__ in the *Amazon RDS User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/delete-db-security-group.rst awscli-1.18.69/awscli/examples/rds/delete-db-security-group.rst --- awscli-1.11.13/awscli/examples/rds/delete-db-security-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/delete-db-security-group.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a DB security group** + +The following ``delete-db-security-group`` example deletes the DB security group named ``mysecgroup``. :: + + aws rds delete-db-security-group \ + --db-security-group-name mysecgroup + +This command produces no output. + +For more information, see `Deleting DB VPC Security Groups `__ in the *Amazon RDS User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/delete-db-snapshot.rst awscli-1.18.69/awscli/examples/rds/delete-db-snapshot.rst --- awscli-1.11.13/awscli/examples/rds/delete-db-snapshot.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/delete-db-snapshot.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,39 @@ +**To delete a DB snapshot** + +The following ``delete-db-snapshot`` example deletes the specified DB snapshot. :: + + aws rds delete-db-snapshot \ + --db-snapshot-identifier mydbsnapshot + +Output:: + + { + "DBSnapshot": { + "DBSnapshotIdentifier": "mydbsnapshot", + "DBInstanceIdentifier": "database-mysql", + "SnapshotCreateTime": "2019-06-18T22:08:40.702Z", + "Engine": "mysql", + "AllocatedStorage": 100, + "Status": "deleted", + "Port": 3306, + "AvailabilityZone": "us-east-1b", + "VpcId": "vpc-6594f31c", + "InstanceCreateTime": "2019-04-30T15:45:53.663Z", + "MasterUsername": "admin", + "EngineVersion": "5.6.40", + "LicenseModel": "general-public-license", + "SnapshotType": "manual", + "Iops": 1000, + "OptionGroupName": "default:mysql-5-6", + "PercentProgress": 100, + "StorageType": "io1", + "Encrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshot", + "IAMDatabaseAuthenticationEnabled": false, + "ProcessorFeatures": [], + "DbiResourceId": "db-AKIAIOSFODNN7EXAMPLE" + } + } + +For more information, see `Deleting a Snapshot `__ in the *Amazon RDS User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/delete-event-subscription.rst awscli-1.18.69/awscli/examples/rds/delete-event-subscription.rst --- awscli-1.11.13/awscli/examples/rds/delete-event-subscription.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/delete-event-subscription.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,27 @@ +**To delete an event subscription** + +The following ``delete-event-subscription`` example deletes the specified event subscription. :: + + aws rds delete-event-subscription --subscription-name my-instance-events + +Output:: + + { + "EventSubscription": { + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "CustomerAwsId": "123456789012", + "Enabled": false, + "SourceIdsList": [ + "test-instance" + ], + "SourceType": "db-instance", + "EventCategoriesList": [ + "backup", + "recovery" + ], + "SubscriptionCreationTime": "2018-07-31 23:22:01.893", + "CustSubscriptionId": "my-instance-events", + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", + "Status": "deleting" + } + } diff -Nru awscli-1.11.13/awscli/examples/rds/delete-option-group.rst awscli-1.18.69/awscli/examples/rds/delete-option-group.rst --- awscli-1.11.13/awscli/examples/rds/delete-option-group.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/delete-option-group.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete an option group** + +The following ``delete-option-group`` example deletes the specified option group. :: + + aws rds delete-option-group \ + --option-group-name myoptiongroup + +This command produces no output. + +For more information, see `Deleting an Option Group `__ in the *Amazon RDS User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/describe-account-attributes.rst awscli-1.18.69/awscli/examples/rds/describe-account-attributes.rst --- awscli-1.11.13/awscli/examples/rds/describe-account-attributes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/describe-account-attributes.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,87 @@ +**To describe account attributes** + +The following ``describe-account-attributes`` example retrieves the attributes for the current AWS account. :: + + aws rds describe-account-attributes + +Output:: + + { + "AccountQuotas": [ + { + "Max": 40, + "Used": 4, + "AccountQuotaName": "DBInstances" + }, + { + "Max": 40, + "Used": 0, + "AccountQuotaName": "ReservedDBInstances" + }, + { + "Max": 100000, + "Used": 40, + "AccountQuotaName": "AllocatedStorage" + }, + { + "Max": 25, + "Used": 0, + "AccountQuotaName": "DBSecurityGroups" + }, + { + "Max": 20, + "Used": 0, + "AccountQuotaName": "AuthorizationsPerDBSecurityGroup" + }, + { + "Max": 50, + "Used": 1, + "AccountQuotaName": "DBParameterGroups" + }, + { + "Max": 100, + "Used": 3, + "AccountQuotaName": "ManualSnapshots" + }, + { + "Max": 20, + "Used": 0, + "AccountQuotaName": "EventSubscriptions" + }, + { + "Max": 50, + "Used": 1, + "AccountQuotaName": "DBSubnetGroups" + }, + { + "Max": 20, + "Used": 1, + "AccountQuotaName": "OptionGroups" + }, + { + "Max": 20, + "Used": 6, + "AccountQuotaName": "SubnetsPerDBSubnetGroup" + }, + { + "Max": 5, + "Used": 0, + "AccountQuotaName": "ReadReplicasPerMaster" + }, + { + "Max": 40, + "Used": 1, + "AccountQuotaName": "DBClusters" + }, + { + "Max": 50, + "Used": 0, + "AccountQuotaName": "DBClusterParameterGroups" + }, + { + "Max": 5, + "Used": 0, + "AccountQuotaName": "DBClusterRoles" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/rds/describe-certificates.rst awscli-1.18.69/awscli/examples/rds/describe-certificates.rst --- awscli-1.11.13/awscli/examples/rds/describe-certificates.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/describe-certificates.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,20 @@ +**To describe certificates** + +The following ``describe-certificates`` example retrieves the details of the certificate associated with the user's default region. :: + + aws rds describe-certificates + +Output:: + + { + "Certificates": [ + { + "Thumbprint": "34478a908a83ae45dcb61676d235ece975c62c63", + "ValidFrom": "2015-02-05T21:54:04Z", + "CertificateIdentifier": "rds-ca-2015", + "ValidTill": "2020-03-05T21:54:04Z", + "CertificateType": "CA", + "CertificateArn": "arn:aws:rds:us-east-1::cert:rds-ca-2015" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/rds/describe-db-cluster-endpoints.rst awscli-1.18.69/awscli/examples/rds/describe-db-cluster-endpoints.rst --- awscli-1.11.13/awscli/examples/rds/describe-db-cluster-endpoints.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/describe-db-cluster-endpoints.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,38 @@ +**To describe DB cluster endpoints** + +The following ``describe-db-cluster-endpoints`` example retrieves details for your DB cluster endpoints. :: + + aws rds describe-db-cluster-endpoints + +Output:: + + { + "DBClusterEndpoints": [ + { + "DBClusterIdentifier": "my-database-1", + "Endpoint": "my-database-1.cluster-cnpexample.us-east-1.rds.amazonaws.com", + "Status": "creating", + "EndpointType": "WRITER" + }, + { + "DBClusterIdentifier": "my-database-1", + "Endpoint": "my-database-1.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", + "Status": "creating", + "EndpointType": "READER" + }, + { + "DBClusterIdentifier": "mydbcluster", + "Endpoint": "mydbcluster.cluster-cnpexamle.us-east-1.rds.amazonaws.com", + "Status": "available", + "EndpointType": "WRITER" + }, + { + "DBClusterIdentifier": "mydbcluster", + "Endpoint": "mydbcluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", + "Status": "available", + "EndpointType": "READER" + } + ] + } + +For more information, see `Amazon Aurora Connection Management `__ in the *Amazon Aurora User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/describe-db-cluster-parameter-groups.rst awscli-1.18.69/awscli/examples/rds/describe-db-cluster-parameter-groups.rst --- awscli-1.11.13/awscli/examples/rds/describe-db-cluster-parameter-groups.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/describe-db-cluster-parameter-groups.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,44 @@ +**To describe DB cluster parameter groups** + +The following ``describe-db-cluster-parameter-groups`` example retrieves details for your DB cluster parameter groups. :: + + aws rds describe-db-cluster-parameter-groups + +Output:: + + { + "DBClusterParameterGroups": [ + { + "DBClusterParameterGroupName": "default.aurora-mysql5.7", + "DBParameterGroupFamily": "aurora-mysql5.7", + "Description": "Default cluster parameter group for aurora-mysql5.7", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora-mysql5.7" + }, + { + "DBClusterParameterGroupName": "default.aurora-postgresql9.6", + "DBParameterGroupFamily": "aurora-postgresql9.6", + "Description": "Default cluster parameter group for aurora-postgresql9.6", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora-postgresql9.6" + }, + { + "DBClusterParameterGroupName": "default.aurora5.6", + "DBParameterGroupFamily": "aurora5.6", + "Description": "Default cluster parameter group for aurora5.6", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora5.6" + }, + { + "DBClusterParameterGroupName": "mydbclusterpg", + "DBParameterGroupFamily": "aurora-mysql5.7", + "Description": "My DB cluster parameter group", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterpg" + }, + { + "DBClusterParameterGroupName": "mydbclusterpgcopy", + "DBParameterGroupFamily": "aurora-mysql5.7", + "Description": "Copy of mydbclusterpg parameter group", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterpgcopy" + } + ] + } + +For more information, see `Working with DB Parameter Groups and DB Cluster Parameter Groups `__ in the *Amazon Aurora User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/describe-db-cluster-parameters.rst awscli-1.18.69/awscli/examples/rds/describe-db-cluster-parameters.rst --- awscli-1.11.13/awscli/examples/rds/describe-db-cluster-parameters.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/describe-db-cluster-parameters.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,43 @@ +**To describe the parameters in a DB cluster parameter group** + +The following ``describe-db-cluster-parameters`` example retrieves details about the parameters in a DB cluster parameter group. :: + + aws rds describe-db-cluster-parameters \ + --db-cluster-parameter-group-name mydbclusterpg + +Output:: + + { + "Parameters": [ + { + "ParameterName": "allow-suspicious-udfs", + "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded", + "Source": "engine-default", + "ApplyType": "static", + "DataType": "boolean", + "AllowedValues": "0,1", + "IsModifiable": false, + "ApplyMethod": "pending-reboot", + "SupportedEngineModes": [ + "provisioned" + ] + }, + { + "ParameterName": "aurora_lab_mode", + "ParameterValue": "0", + "Description": "Enables new features in the Aurora engine.", + "Source": "engine-default", + "ApplyType": "static", + "DataType": "boolean", + "AllowedValues": "0,1", + "IsModifiable": true, + "ApplyMethod": "pending-reboot", + "SupportedEngineModes": [ + "provisioned" + ] + }, + ...some output truncated... + ] + } + +For more information, see `Working with DB Parameter Groups and DB Cluster Parameter Groups `__ in the *Amazon Aurora User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/describe-db-cluster-snapshot-attributes.rst awscli-1.18.69/awscli/examples/rds/describe-db-cluster-snapshot-attributes.rst --- awscli-1.11.13/awscli/examples/rds/describe-db-cluster-snapshot-attributes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/describe-db-cluster-snapshot-attributes.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,24 @@ +**To describe the attribute names and values for a DB cluster snapshot** + +The following ``describe-db-cluster-snapshot-attributes`` example retrieves details of the attribute names and values for the specified DB cluster snapshot. :: + + aws rds describe-db-cluster-snapshot-attributes \ + --db-cluster-snapshot-identifier myclustersnapshot + +Output:: + + { + "DBClusterSnapshotAttributesResult": { + "DBClusterSnapshotIdentifier": "myclustersnapshot", + "DBClusterSnapshotAttributes": [ + { + "AttributeName": "restore", + "AttributeValues": [ + "123456789012" + ] + } + ] + } + } + +For more information, see `Sharing a DB Cluster Snapshot `__ in the *Amazon Aurora User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/describe-db-cluster-snapshots.rst awscli-1.18.69/awscli/examples/rds/describe-db-cluster-snapshots.rst --- awscli-1.11.13/awscli/examples/rds/describe-db-cluster-snapshots.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/describe-db-cluster-snapshots.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,65 @@ +**To describe a DB cluster snapshot for a DB cluster** + +The following ``describe-db-cluster-snapshots`` example retrieves the details for the DB cluster snapshots for the specified DB cluster. :: + + aws rds describe-db-cluster-snapshots \ + --db-cluster-identifier mydbcluster + +Output:: + + { + "DBClusterSnapshots": [ + { + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "DBClusterSnapshotIdentifier": "myclustersnapshotcopy", + "DBClusterIdentifier": "mydbcluster", + "SnapshotCreateTime": "2019-06-04T09:16:42.649Z", + "Engine": "aurora-mysql", + "AllocatedStorage": 0, + "Status": "available", + "Port": 0, + "VpcId": "vpc-6594f31c", + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "MasterUsername": "myadmin", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LicenseModel": "aurora-mysql", + "SnapshotType": "manual", + "PercentProgress": 100, + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:814387698303:cluster-snapshot:myclustersnapshotcopy", + "IAMDatabaseAuthenticationEnabled": false + }, + { + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "DBClusterSnapshotIdentifier": "rds:mydbcluster-2019-06-20-09-16", + "DBClusterIdentifier": "mydbcluster", + "SnapshotCreateTime": "2019-06-20T09:16:26.569Z", + "Engine": "aurora-mysql", + "AllocatedStorage": 0, + "Status": "available", + "Port": 0, + "VpcId": "vpc-6594f31c", + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "MasterUsername": "myadmin", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LicenseModel": "aurora-mysql", + "SnapshotType": "automated", + "PercentProgress": 100, + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:814387698303:key/AKIAIOSFODNN7EXAMPLE", + "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:rds:mydbcluster-2019-06-20-09-16", + "IAMDatabaseAuthenticationEnabled": false + } + ] + } + +For more information, see `Creating a DB Cluster Snapshot `__ in the *Amazon Aurora User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/describe-db-clusters.rst awscli-1.18.69/awscli/examples/rds/describe-db-clusters.rst --- awscli-1.11.13/awscli/examples/rds/describe-db-clusters.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/describe-db-clusters.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,96 @@ +**To describe a DB cluster** + +The following ``describe-db-clusters`` example retrieves the details of the specified DB cluster. :: + + aws rds describe-db-clusters \ + --db-cluster-identifier mydbcluster + +Output:: + + { + "DBClusters": [ + { + "AllocatedStorage": 1, + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "BackupRetentionPeriod": 1, + "DatabaseName": "mydbcluster", + "DBClusterIdentifier": "mydbcluster", + "DBClusterParameterGroup": "default.aurora-mysql5.7", + "DBSubnetGroup": "default", + "Status": "available", + "EarliestRestorableTime": "2019-06-19T09:16:28.210Z", + "Endpoint": "mydbcluster.cluster-cnpexample.us-east-1.rds.amazonaws.com", + "ReaderEndpoint": "mydbcluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", + "MultiAZ": true, + "Engine": "aurora-mysql", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LatestRestorableTime": "2019-06-20T22:38:14.908Z", + "Port": 3306, + "MasterUsername": "myadmin", + "PreferredBackupWindow": "09:09-09:39", + "PreferredMaintenanceWindow": "sat:04:09-sat:04:39", + "ReadReplicaIdentifiers": [], + "DBClusterMembers": [ + { + "DBInstanceIdentifier": "dbinstance3", + "IsClusterWriter": false, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + }, + { + "DBInstanceIdentifier": "dbinstance1", + "IsClusterWriter": false, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + }, + { + "DBInstanceIdentifier": "dbinstance2", + "IsClusterWriter": false, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + }, + { + "DBInstanceIdentifier": "mydbcluster", + "IsClusterWriter": false, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + }, + { + "DBInstanceIdentifier": "mydbcluster-us-east-1b", + "IsClusterWriter": false, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + }, + { + "DBInstanceIdentifier": "mydbcluster", + "IsClusterWriter": true, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + } + ], + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-0b9130572daf3dc16", + "Status": "active" + } + ], + "HostedZoneId": "Z2R2ITUGPM61AM", + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:814387698303:key/AKIAIOSFODNN7EXAMPLE", + "DbClusterResourceId": "cluster-AKIAIOSFODNN7EXAMPLE", + "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:mydbcluster", + "AssociatedRoles": [], + "IAMDatabaseAuthenticationEnabled": false, + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "EngineMode": "provisioned", + "DeletionProtection": false, + "HttpEndpointEnabled": false + } + ] + } + +For more information, see `Amazon Aurora DB Clusters `__ in the *Amazon Aurora User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/describe-db-engine-versions.rst awscli-1.18.69/awscli/examples/rds/describe-db-engine-versions.rst --- awscli-1.11.13/awscli/examples/rds/describe-db-engine-versions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/describe-db-engine-versions.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,44 @@ +**To describe the DB engine versions for the MySQL DB engine** + +The following ``describe-db-engine-versions`` example displays details about each of the DB engine versions for the specified DB engine. :: + + aws rds describe-db-engine-versions \ + --engine mysql + +Output:: + + { + "DBEngineVersions": [ + { + "Engine": "mysql", + "EngineVersion": "5.5.46", + "DBParameterGroupFamily": "mysql5.5", + "DBEngineDescription": "MySQL Community Edition", + "DBEngineVersionDescription": "MySQL 5.5.46", + "ValidUpgradeTarget": [ + { + "Engine": "mysql", + "EngineVersion": "5.5.53", + "Description": "MySQL 5.5.53", + "AutoUpgrade": false, + "IsMajorVersionUpgrade": false + }, + { + "Engine": "mysql", + "EngineVersion": "5.5.54", + "Description": "MySQL 5.5.54", + "AutoUpgrade": false, + "IsMajorVersionUpgrade": false + }, + { + "Engine": "mysql", + "EngineVersion": "5.5.57", + "Description": "MySQL 5.5.57", + "AutoUpgrade": false, + "IsMajorVersionUpgrade": false + }, + ...some output truncated... + ] + } + +For more information, see `What Is Amazon Relational Database Service (Amazon RDS)? `__ in the *Amazon RDS User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/describe-db-instance-automated-backups.rst awscli-1.18.69/awscli/examples/rds/describe-db-instance-automated-backups.rst --- awscli-1.11.13/awscli/examples/rds/describe-db-instance-automated-backups.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/describe-db-instance-automated-backups.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,41 @@ +**To describe the automated backups for a DB instance** + +The following ``describe-db-instance-automated-backups`` example displays details about the automated backups for the specified DB instance. :: + + aws rds describe-db-instance-automated-backups \ + --db-instance-identifier database-mysql + +Output:: + + { + "DBInstanceAutomatedBackups": [ + { + "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:database-mysql", + "DbiResourceId": "db-AKIAIOSFODNN7EXAMPLE", + "Region": "us-east-1", + "DBInstanceIdentifier": "database-mysql", + "RestoreWindow": { + "EarliestTime": "2019-06-13T08:39:38.359Z", + "LatestTime": "2019-06-20T23:00:00Z" + }, + "AllocatedStorage": 100, + "Status": "active", + "Port": 3306, + "AvailabilityZone": "us-east-1b", + "VpcId": "vpc-6594f31c", + "InstanceCreateTime": "2019-04-30T15:45:53Z", + "MasterUsername": "admin", + "Engine": "mysql", + "EngineVersion": "5.6.40", + "LicenseModel": "general-public-license", + "Iops": 1000, + "OptionGroupName": "default:mysql-5-6", + "Encrypted": true, + "StorageType": "io1", + "KmsKeyId": "arn:aws:kms:us-east-1:814387698303:key/AKIAIOSFODNN7EXAMPLE", + "IAMDatabaseAuthenticationEnabled": false + } + ] + } + +For more information, see `Working With Backups `__ in the *Amazon RDS User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/describe-db-instances.rst awscli-1.18.69/awscli/examples/rds/describe-db-instances.rst --- awscli-1.11.13/awscli/examples/rds/describe-db-instances.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/describe-db-instances.rst 2020-05-28 19:25:50.000000000 +0000 @@ -1,102 +1,26 @@ -**To describe Amazon RDS DB instances** - -The following ``describe-db-instances`` command lists all of the DB instances for an AWS account:: - - aws rds describe-db-instances - -This command outputs a JSON block that lists the DB instances:: - -{ - "DBInstances": [ - { - "PubliclyAccessible": false, - "MasterUsername": "mymasteruser", - "MonitoringInterval": 0, - "LicenseModel": "general-public-license", - "VpcSecurityGroups": [ - { - "Status": "active", - "VpcSecurityGroupId": "sg-1203dc23" - } - ], - "InstanceCreateTime": "2016-06-13T20:09:43.836Z", - "CopyTagsToSnapshot": false, - "OptionGroupMemberships": [ - { - "Status": "in-sync", - "OptionGroupName": "default:mysql-5-6" - } - ], - "PendingModifiedValues": {}, - "Engine": "mysql", - "MultiAZ": false, - "LatestRestorableTime": "2016-06-13T21:00:00Z", - "DBSecurityGroups": [], - "DBParameterGroups": [ - { - "DBParameterGroupName": "default.mysql5.6", - "ParameterApplyStatus": "in-sync" - } - ], - "AutoMinorVersionUpgrade": true, - "PreferredBackupWindow": "08:03-08:33", - "DBSubnetGroup": { - "Subnets": [ - { - "SubnetStatus": "Active", - "SubnetIdentifier": "subnet-6a88c933", - "SubnetAvailabilityZone": { - "Name": "us-east-1a" - } - }, - { - "SubnetStatus": "Active", - "SubnetIdentifier": "subnet-98302fa2", - "SubnetAvailabilityZone": { - "Name": "us-east-1e" - } - }, - { - "SubnetStatus": "Active", - "SubnetIdentifier": "subnet-159bf13e", - "SubnetAvailabilityZone": { - "Name": "us-east-1c" - } - }, - { - "SubnetStatus": "Active", - "SubnetIdentifier": "subnet-67466810", - "SubnetAvailabilityZone": { - "Name": "us-east-1d" - } - } - ], - "DBSubnetGroupName": "default", - "VpcId": "vpc-a2b3aab6", - "DBSubnetGroupDescription": "default", - "SubnetGroupStatus": "Complete" - }, - "ReadReplicaDBInstanceIdentifiers": [], - "AllocatedStorage": 50, - "BackupRetentionPeriod": 7, - "DBName": "sample", - "PreferredMaintenanceWindow": "sat:04:35-sat:05:05", - "Endpoint": { - "Port": 3306, - "Address": "mydbinstance-1.ctrzran0rynq.us-east-1.rds.amazonaws.com" - }, - "DBInstanceStatus": "stopped", - "EngineVersion": "5.6.27", - "AvailabilityZone": "us-east-1e", - "DomainMemberships": [], - "StorageType": "standard", - "DbiResourceId": "db-B3COT4JG5UC4IACGJ72IGR34RM", - "CACertificateIdentifier": "rds-ca-2015", - "StorageEncrypted": false, - "DBInstanceClass": "db.t2.micro", - "DbInstancePort": 0, - "DBInstanceIdentifier": "mydbinstance-1" - } - ] -} - +**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.11.13/awscli/examples/rds/describe-db-log-files.rst awscli-1.18.69/awscli/examples/rds/describe-db-log-files.rst --- awscli-1.11.13/awscli/examples/rds/describe-db-log-files.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/describe-db-log-files.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,43 @@ +**To describe the log files for a DB instance** + +The following ``describe-db-log-files`` example retrieves details about the log files for the specified DB instance. :: + + aws rds describe-db-log-files -\ + -db-instance-identifier test-instance + +Output:: + + { + "DescribeDBLogFiles": [ + { + "Size": 0, + "LastWritten": 1533060000000, + "LogFileName": "error/mysql-error-running.log" + }, + { + "Size": 2683, + "LastWritten": 1532994300000, + "LogFileName": "error/mysql-error-running.log.0" + }, + { + "Size": 107, + "LastWritten": 1533057300000, + "LogFileName": "error/mysql-error-running.log.18" + }, + { + "Size": 13105, + "LastWritten": 1532991000000, + "LogFileName": "error/mysql-error-running.log.23" + }, + { + "Size": 0, + "LastWritten": 1533061200000, + "LogFileName": "error/mysql-error.log" + }, + { + "Size": 3519, + "LastWritten": 1532989252000, + "LogFileName": "mysqlUpgrade" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/rds/describe-db-parameter-groups.rst awscli-1.18.69/awscli/examples/rds/describe-db-parameter-groups.rst --- awscli-1.11.13/awscli/examples/rds/describe-db-parameter-groups.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/describe-db-parameter-groups.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,39 @@ +**To describe your DB parameter group** + +The following ``describe-db-parameter-groups`` example retrieves details about your DB parameter groups. :: + + aws rds describe-db-parameter-groups + +Output:: + + { + "DBParameterGroups": [ + { + "DBParameterGroupName": "default.aurora-mysql5.7", + "DBParameterGroupFamily": "aurora-mysql5.7", + "Description": "Default parameter group for aurora-mysql5.7", + "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.aurora-mysql5.7" + }, + { + "DBParameterGroupName": "default.aurora-postgresql9.6", + "DBParameterGroupFamily": "aurora-postgresql9.6", + "Description": "Default parameter group for aurora-postgresql9.6", + "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.aurora-postgresql9.6" + }, + { + "DBParameterGroupName": "default.aurora5.6", + "DBParameterGroupFamily": "aurora5.6", + "Description": "Default parameter group for aurora5.6", + "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.aurora5.6" + }, + { + "DBParameterGroupName": "default.mariadb10.1", + "DBParameterGroupFamily": "mariadb10.1", + "Description": "Default parameter group for mariadb10.1", + "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.mariadb10.1" + }, + ...some output truncated... + ] + } + +For more information, see `Working with DB Parameter Groups `__ in the *Amazon RDS User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/describe-db-parameters.rst awscli-1.18.69/awscli/examples/rds/describe-db-parameters.rst --- awscli-1.11.13/awscli/examples/rds/describe-db-parameters.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/describe-db-parameters.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,36 @@ +**To describe the parameters in a DB parameter group** + +The following ``describe-db-parameters`` example retrieves the details of the specified DB parameter group. :: + + aws rds describe-db-parameters \ + --db-parameter-group-name mydbpg + +Output:: + + { + "Parameters": [ + { + "ParameterName": "allow-suspicious-udfs", + "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded", + "Source": "engine-default", + "ApplyType": "static", + "DataType": "boolean", + "AllowedValues": "0,1", + "IsModifiable": false, + "ApplyMethod": "pending-reboot" + }, + { + "ParameterName": "auto_generate_certs", + "Description": "Controls whether the server autogenerates SSL key and certificate files in the data directory, if they do not already exist.", + "Source": "engine-default", + "ApplyType": "static", + "DataType": "boolean", + "AllowedValues": "0,1", + "IsModifiable": false, + "ApplyMethod": "pending-reboot" + }, + ...some output truncated... + ] + } + +For more information, see `Working with DB Parameter Groups `__ in the *Amazon RDS User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/describe-db-security-groups.rst awscli-1.18.69/awscli/examples/rds/describe-db-security-groups.rst --- awscli-1.11.13/awscli/examples/rds/describe-db-security-groups.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/describe-db-security-groups.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,31 @@ +**To list DB security groups** + +The following ``describe-db-security-groups`` example lists DB security groups. :: + + aws rds describe-db-security-groups + +Output:: + + { + "DBSecurityGroups": [ + { + "OwnerId": "123456789012", + "DBSecurityGroupName": "default", + "DBSecurityGroupDescription": "default", + "EC2SecurityGroups": [], + "IPRanges": [], + "DBSecurityGroupArn": "arn:aws:rds:us-west-1:111122223333:secgrp:default" + }, + { + "OwnerId": "123456789012", + "DBSecurityGroupName": "mysecgroup", + "DBSecurityGroupDescription": "My Test Security Group", + "VpcId": "vpc-1234567f", + "EC2SecurityGroups": [], + "IPRanges": [], + "DBSecurityGroupArn": "arn:aws:rds:us-west-1:111122223333:secgrp:mysecgroup" + } + ] + } + +For more information, see `Listing Available DB Security Groups `__ in the *Amazon RDS User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/describe-db-snapshot-attributes.rst awscli-1.18.69/awscli/examples/rds/describe-db-snapshot-attributes.rst --- awscli-1.11.13/awscli/examples/rds/describe-db-snapshot-attributes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/describe-db-snapshot-attributes.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,25 @@ +**To describe the attribute names and values for a DB snapshot** + +The following ``describe-db-snapshot-attributes`` example describes the attribute names and values for a DB snapshot. :: + + aws rds describe-db-snapshot-attributes \ + --db-snapshot-identifier mydbsnapshot + +Output:: + + { + "DBSnapshotAttributesResult": { + "DBSnapshotIdentifier": "mydbsnapshot", + "DBSnapshotAttributes": [ + { + "AttributeName": "restore", + "AttributeValues": [ + "123456789012", + "210987654321" + ] + } + ] + } + } + +For more information, see `Sharing a DB Snapshot `__ in the *Amazon RDS User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/describe-db-snapshots.rst awscli-1.18.69/awscli/examples/rds/describe-db-snapshots.rst --- awscli-1.11.13/awscli/examples/rds/describe-db-snapshots.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/describe-db-snapshots.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,39 @@ +**To describe a DB snapshot for a DB instance** + +The following ``describe-db-snapshots`` example retrieves the details of a DB snapshot for a DB instance. :: + + aws rds describe-db-snapshots \ + --db-snapshot-identifier mydbsnapshot + +Output:: + + { + "DBSnapshots": [ + { + "DBSnapshotIdentifier": "mydbsnapshot", + "DBInstanceIdentifier": "mysqldb", + "SnapshotCreateTime": "2018-02-08T22:28:08.598Z", + "Engine": "mysql", + "AllocatedStorage": 20, + "Status": "available", + "Port": 3306, + "AvailabilityZone": "us-east-1f", + "VpcId": "vpc-6594f31c", + "InstanceCreateTime": "2018-02-08T22:24:55.973Z", + "MasterUsername": "mysqladmin", + "EngineVersion": "5.6.37", + "LicenseModel": "general-public-license", + "SnapshotType": "manual", + "OptionGroupName": "default:mysql-5-6", + "PercentProgress": 100, + "StorageType": "gp2", + "Encrypted": false, + "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshot", + "IAMDatabaseAuthenticationEnabled": false, + "ProcessorFeatures": [], + "DbiResourceId": "db-AKIAIOSFODNN7EXAMPLE" + } + ] + } + +For more information, see `Creating a DB Snapshot `__ in the *Amazon RDS User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/describe-db-subnet-groups.rst awscli-1.18.69/awscli/examples/rds/describe-db-subnet-groups.rst --- awscli-1.11.13/awscli/examples/rds/describe-db-subnet-groups.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/describe-db-subnet-groups.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,51 @@ +**To describe a DB subnet group** + +The following ``describe-db-subnet-groups`` example retrieves the details of the specified DB subnet group. :: + + aws rds describe-db-subnet-groups + +Output:: + + { + "DBSubnetGroups": [ + { + "DBSubnetGroupName": "mydbsubnetgroup", + "DBSubnetGroupDescription": "My DB Subnet Group", + "VpcId": "vpc-971c12ee", + "SubnetGroupStatus": "Complete", + "Subnets": [ + { + "SubnetIdentifier": "subnet-d8c8e7f4", + "SubnetAvailabilityZone": { + "Name": "us-east-1a" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-718fdc7d", + "SubnetAvailabilityZone": { + "Name": "us-east-1f" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-cbc8e7e7", + "SubnetAvailabilityZone": { + "Name": "us-east-1a" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-0ccde220", + "SubnetAvailabilityZone": { + "Name": "us-east-1a" + }, + "SubnetStatus": "Active" + } + ], + "DBSubnetGroupArn": "arn:aws:rds:us-east-1:123456789012:subgrp:mydbsubnetgroup" + } + ] + } + +For more information, see `Amazon Virtual Private Cloud VPCs and Amazon RDS `__ in the *Amazon RDS User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/describe-engine-default-cluster-parameters.rst awscli-1.18.69/awscli/examples/rds/describe-engine-default-cluster-parameters.rst --- awscli-1.11.13/awscli/examples/rds/describe-engine-default-cluster-parameters.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/describe-engine-default-cluster-parameters.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,29 @@ +**To describe the default engine and system parameter information for the Aurora database engine** + +The following ``describe-engine-default-cluster-parameters`` example retrieves the details of the default engine and system parameter information for Aurora DB clusters with MySQL 5.7 compatibility. :: + + aws rds describe-engine-default-cluster-parameters \ + --db-parameter-group-family aurora-mysql5.7 + +Output:: + + { + "EngineDefaults": { + "Parameters": [ + { + "ParameterName": "aurora_load_from_s3_role", + "Description": "IAM role ARN used to load data from AWS S3", + "Source": "engine-default", + "ApplyType": "dynamic", + "DataType": "string", + "IsModifiable": true, + "SupportedEngineModes": [ + "provisioned" + ] + }, + ...some output truncated... + ] + } + } + +For more information, see `Working with DB Parameter Groups and DB Cluster Parameter Groups `__ in the *Amazon Aurora User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/describe-engine-default-parameters.rst awscli-1.18.69/awscli/examples/rds/describe-engine-default-parameters.rst --- awscli-1.11.13/awscli/examples/rds/describe-engine-default-parameters.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/describe-engine-default-parameters.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,27 @@ +**To describe the default engine and system parameter information for the database engine** + +The following ``describe-engine-default-parameters`` example retrieves details for the default engine and system parameter information for MySQL 5.7 DB instances. :: + + aws rds describe-engine-default-parameters \ + --db-parameter-group-family mysql5.7 + +Output:: + + { + "EngineDefaults": { + "Parameters": [ + { + "ParameterName": "allow-suspicious-udfs", + "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded", + "Source": "engine-default", + "ApplyType": "static", + "DataType": "boolean", + "AllowedValues": "0,1", + "IsModifiable": false + }, + ...some output truncated... + ] + } + } + +For more information, see `Working with DB Parameter Groups `__ in the *Amazon RDS User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/describe-event-categories.rst awscli-1.18.69/awscli/examples/rds/describe-event-categories.rst --- awscli-1.11.13/awscli/examples/rds/describe-event-categories.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/describe-event-categories.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,67 @@ +**To describe event categories** + +The following ``describe-event-categories`` example retrieves details about the event categories for all available event sources. :: + + aws rds describe-event-categories + +Output:: + + { + "EventCategoriesMapList": [ + { + "SourceType": "db-instance", + "EventCategories": [ + "deletion", + "read replica", + "failover", + "restoration", + "maintenance", + "low storage", + "configuration change", + "backup", + "creation", + "availability", + "recovery", + "failure", + "backtrack", + "notification" + ] + }, + { + "SourceType": "db-security-group", + "EventCategories": [ + "configuration change", + "failure" + ] + }, + { + "SourceType": "db-parameter-group", + "EventCategories": [ + "configuration change" + ] + }, + { + "SourceType": "db-snapshot", + "EventCategories": [ + "deletion", + "creation", + "restoration", + "notification" + ] + }, + { + "SourceType": "db-cluster", + "EventCategories": [ + "failover", + "failure", + "notification" + ] + }, + { + "SourceType": "db-cluster-snapshot", + "EventCategories": [ + "backup" + ] + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/rds/describe-events.rst awscli-1.18.69/awscli/examples/rds/describe-events.rst --- awscli-1.11.13/awscli/examples/rds/describe-events.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/describe-events.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,34 @@ +**To describe events** + +The following ``describe-events`` example retrieves details for the events that have occurred for the specified DB instance. :: + + aws rds describe-events \ + --source-identifier test-instance \ + --source-type db-instance + +Output:: + + { + "Events": [ + { + "SourceType": "db-instance", + "SourceIdentifier": "test-instance", + "EventCategories": [ + "backup" + ], + "Message": "Backing up DB instance", + "Date": "2018-07-31T23:09:23.983Z", + "SourceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance" + }, + { + "SourceType": "db-instance", + "SourceIdentifier": "test-instance", + "EventCategories": [ + "backup" + ], + "Message": "Finished DB Instance backup", + "Date": "2018-07-31T23:15:13.049Z", + "SourceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/rds/describe-event-subscriptions.rst awscli-1.18.69/awscli/examples/rds/describe-event-subscriptions.rst --- awscli-1.11.13/awscli/examples/rds/describe-event-subscriptions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/describe-event-subscriptions.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,27 @@ +**To describe event subscriptions** + +This example describes all of the Amazon RDS event subscriptions for the current AWS account. :: + + aws rds describe-event-subscriptions + +Output:: + + { + "EventSubscriptionsList": [ + { + "EventCategoriesList": [ + "backup", + "recovery" + ], + "Enabled": true, + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "Status": "creating", + "SourceType": "db-instance", + "CustomerAwsId": "123456789012", + "SubscriptionCreationTime": "2018-07-31 23:22:01.893", + "CustSubscriptionId": "my-instance-events", + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events" + }, + ...some output truncated... + ] + } diff -Nru awscli-1.11.13/awscli/examples/rds/describe-option-groups.rst awscli-1.18.69/awscli/examples/rds/describe-option-groups.rst --- awscli-1.11.13/awscli/examples/rds/describe-option-groups.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/describe-option-groups.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,25 @@ +**To describe the available option groups** + +The following ``describe-option-groups`` example lists the options groups for an Oracle Database 19c instance. :: + + aws rds describe-option-groups \ + --engine-name oracle-ee \ + --major-engine-version 19 + +Output:: + + { + "OptionGroupsList": [ + { + "OptionGroupName": "default:oracle-ee-19", + "OptionGroupDescription": "Default option group for oracle-ee 19", + "EngineName": "oracle-ee", + "MajorEngineVersion": "19", + "Options": [], + "AllowsVpcAndNonVpcInstanceMemberships": true, + "OptionGroupArn": "arn:aws:rds:us-west-1:111122223333:og:default:oracle-ee-19" + } + ] + } + +For more information, see `Listing the Options and Option Settings for an Option Group `__ in the *Amazon RDS User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/describe-orderable-db-instance-options.rst awscli-1.18.69/awscli/examples/rds/describe-orderable-db-instance-options.rst --- awscli-1.11.13/awscli/examples/rds/describe-orderable-db-instance-options.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/describe-orderable-db-instance-options.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,46 @@ +**To describe orderable DB instance options** + +The following ``describe-orderable-db-instance-options`` example retrieves details about the orderable options for a DB instances running the MySQL DB engine. :: + + aws rds describe-orderable-db-instance-options \ + --engine mysql + +Output:: + + { + "OrderableDBInstanceOptions": [ + { + "MinStorageSize": 5, + "ReadReplicaCapable": true, + "MaxStorageSize": 6144, + "AvailabilityZones": [ + { + "Name": "us-east-1a" + }, + { + "Name": "us-east-1b" + }, + { + "Name": "us-east-1c" + }, + { + "Name": "us-east-1d" + } + ], + "SupportsIops": false, + "AvailableProcessorFeatures": [], + "MultiAZCapable": true, + "DBInstanceClass": "db.m1.large", + "Vpc": true, + "StorageType": "gp2", + "LicenseModel": "general-public-license", + "EngineVersion": "5.5.46", + "SupportsStorageEncryption": false, + "SupportsEnhancedMonitoring": true, + "Engine": "mysql", + "SupportsIAMDatabaseAuthentication": false, + "SupportsPerformanceInsights": false + } + ] + ...some output truncated... + } diff -Nru awscli-1.11.13/awscli/examples/rds/describe-reserved-db-instances-offerings.rst awscli-1.18.69/awscli/examples/rds/describe-reserved-db-instances-offerings.rst --- awscli-1.11.13/awscli/examples/rds/describe-reserved-db-instances-offerings.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/describe-reserved-db-instances-offerings.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,30 @@ +**To describe reserved DB instance offerings** + +The following ``describe-reserved-db-instances-offerings`` example retrieves details about reserved DB instance options for ``oracle``. :: + + aws rds describe-reserved-db-instances-offerings \ + --product-description oracle + +Output:: + + { + "ReservedDBInstancesOfferings": [ + { + "CurrencyCode": "USD", + "UsagePrice": 0.0, + "ProductDescription": "oracle-se2(li)", + "ReservedDBInstancesOfferingId": "005bdee3-9ef4-4182-aa0c-58ef7cb6c2f8", + "MultiAZ": true, + "DBInstanceClass": "db.m4.xlarge", + "OfferingType": "Partial Upfront", + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.594, + "RecurringChargeFrequency": "Hourly" + } + ], + "FixedPrice": 4089.0, + "Duration": 31536000 + }, + ...some output truncated... + } \ No newline at end of file diff -Nru awscli-1.11.13/awscli/examples/rds/describe-reserved-db-instances.rst awscli-1.18.69/awscli/examples/rds/describe-reserved-db-instances.rst --- awscli-1.11.13/awscli/examples/rds/describe-reserved-db-instances.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/describe-reserved-db-instances.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,6 @@ +**To describe reserved DB instances** + +The following ``describe-reserved-db-instances`` example retrieves details about any reserved DB instances in the current AWS account. :: + + aws rds describe-reserved-db-instances + diff -Nru awscli-1.11.13/awscli/examples/rds/describe-source-regions.rst awscli-1.18.69/awscli/examples/rds/describe-source-regions.rst --- awscli-1.11.13/awscli/examples/rds/describe-source-regions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/describe-source-regions.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,67 @@ +**To describe source regions** + +The following ``describe-source-regions`` example retrieves details about all of the source regions. :: + + aws rds describe-source-regions + +Output:: + + { + "SourceRegions": [ + { + "RegionName": "ap-northeast-1", + "Endpoint": "https://rds.ap-northeast-1.amazonaws.com", + "Status": "available" + }, + { + "RegionName": "ap-northeast-2", + "Endpoint": "https://rds.ap-northeast-2.amazonaws.com", + "Status": "available" + }, + { + "RegionName": "ap-south-1", + "Endpoint": "https://rds.ap-south-1.amazonaws.com", + "Status": "available" + }, + { + "RegionName": "ap-southeast-1", + "Endpoint": "https://rds.ap-southeast-1.amazonaws.com", + "Status": "available" + }, + { + "RegionName": "ap-southeast-2", + "Endpoint": "https://rds.ap-southeast-2.amazonaws.com", + "Status": "available" + }, + { + "RegionName": "eu-central-1", + "Endpoint": "https://rds.eu-central-1.amazonaws.com", + "Status": "available" + }, + { + "RegionName": "eu-west-1", + "Endpoint": "https://rds.eu-west-1.amazonaws.com", + "Status": "available" + }, + { + "RegionName": "eu-west-2", + "Endpoint": "https://rds.eu-west-2.amazonaws.com", + "Status": "available" + }, + { + "RegionName": "sa-east-1", + "Endpoint": "https://rds.sa-east-1.amazonaws.com", + "Status": "available" + }, + { + "RegionName": "us-east-1", + "Endpoint": "https://rds.amazonaws.com", + "Status": "available" + }, + { + "RegionName": "us-west-1", + "Endpoint": "https://rds.us-west-1.amazonaws.com", + "Status": "available" + } + ] + } diff -Nru awscli-1.11.13/awscli/examples/rds/describe-valid-db-instance-modifications.rst awscli-1.18.69/awscli/examples/rds/describe-valid-db-instance-modifications.rst --- awscli-1.11.13/awscli/examples/rds/describe-valid-db-instance-modifications.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/describe-valid-db-instance-modifications.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,95 @@ +**To describe valid modifications for a DB instance** + +The following ``describe-valid-db-instance-modifications`` example retrieves details about the valid modifications for the specified DB instance. :: + + aws rds describe-valid-db-instance-modifications \ + --db-instance-identifier test-instance + +Output:: + + { + "ValidDBInstanceModificationsMessage": { + "ValidProcessorFeatures": [], + "Storage": [ + { + "StorageSize": [ + { + "Step": 1, + "To": 20, + "From": 20 + }, + { + "Step": 1, + "To": 6144, + "From": 22 + } + ], + "ProvisionedIops": [ + { + "Step": 1, + "To": 0, + "From": 0 + } + ], + "IopsToStorageRatio": [ + { + "To": 0.0, + "From": 0.0 + } + ], + "StorageType": "gp2" + }, + { + "StorageSize": [ + { + "Step": 1, + "To": 6144, + "From": 100 + } + ], + "ProvisionedIops": [ + { + "Step": 1, + "To": 40000, + "From": 1000 + } + ], + "IopsToStorageRatio": [ + { + "To": 50.0, + "From": 1.0 + } + ], + "StorageType": "io1" + }, + { + "StorageSize": [ + { + "Step": 1, + "To": 20, + "From": 20 + }, + { + "Step": 1, + "To": 3072, + "From": 22 + } + ], + "ProvisionedIops": [ + { + "Step": 1, + "To": 0, + "From": 0 + } + ], + "IopsToStorageRatio": [ + { + "To": 0.0, + "From": 0.0 + } + ], + "StorageType": "magnetic" + } + ] + } + } diff -Nru awscli-1.11.13/awscli/examples/rds/download-db-log-file-portion.rst awscli-1.18.69/awscli/examples/rds/download-db-log-file-portion.rst --- awscli-1.11.13/awscli/examples/rds/download-db-log-file-portion.rst 2016-11-03 20:32:27.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/download-db-log-file-portion.rst 2020-05-28 19:25:50.000000000 +0000 @@ -1,15 +1,18 @@ -**How to download your log file** +**To download a DB log file** -By default, this command will only download the latest part of your log file:: +The following ``download-db-log-file-portion`` example downloads only the latest part of your log file, saving it to a local file named ``tail.txt``. :: - aws rds download-db-log-file-portion --db-instance-identifier myinstance \ - --log-file-name log.txt --output text > tail.txt + aws rds download-db-log-file-portion \ + --db-instance-identifier test-instance \ + --log-file-name log.txt \ + --output text > tail.txt -In order to download the entire file, you need `--starting-token 0` parameter:: +To download the entire file, you need to include the ``--starting-token 0`` parameter. The following example saves the output to a local file named ``full.txt``. :: - aws rds download-db-log-file-portion --db-instance-identifier myinstance \ - --log-file-name log.txt --starting-token 0 --output text > full.txt + aws rds download-db-log-file-portion \ + --db-instance-identifier test-instance \ + --log-file-name log.txt \ + --starting-token 0 \ + --output text > full.txt -Note that, the downloaded file may contain several extra blank lines. -They appear at the end of each part of the log file while being downloaded. -This will generally not cause any trouble in your log file analysis. +The saved file might contain blank lines. They appear at the end of each part of the log file while being downloaded. This generally doesn't cause any trouble in your log file analysis. diff -Nru awscli-1.11.13/awscli/examples/rds/generate-auth-token.rst awscli-1.18.69/awscli/examples/rds/generate-auth-token.rst --- awscli-1.11.13/awscli/examples/rds/generate-auth-token.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/generate-auth-token.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,13 @@ +**To generate an authentication token** + +The following ``generate-db-auth-token`` example generates an authentication token for use with IAM database authentication. :: + + aws rds generate-db-auth-token \ + --hostname aurmysql-test.cdgmuqiadpid.us-west-2.rds.amazonaws.com \ + --port 3306 \ + --region us-east-1 \ + --username jane_doe + +Output:: + + aurmysql-test.cdgmuqiadpid.us-west-2.rds.amazonaws.com:3306/?Action=connect&DBUser=jane_doe&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIESZCNJ3OEXAMPLE%2F20180731%2Fus-east-1%2Frds-db%2Faws4_request&X-Amz-Date=20180731T235209Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=5a8753ebEXAMPLEa2c724e5667797EXAMPLE9d6ec6e3f427191fa41aeEXAMPLE diff -Nru awscli-1.11.13/awscli/examples/rds/modify-db-cluster-endpoint.rst awscli-1.18.69/awscli/examples/rds/modify-db-cluster-endpoint.rst --- awscli-1.11.13/awscli/examples/rds/modify-db-cluster-endpoint.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/modify-db-cluster-endpoint.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,28 @@ +**To modify a custom DB cluster endpoint** + +The following ``modify-db-cluster-endpoint`` example modifies the specified custom DB cluster endpoint. :: + + aws rds modify-db-cluster-endpoint \ + --db-cluster-endpoint-identifier mycustomendpoint \ + --static-members dbinstance1 dbinstance2 dbinstance3 + +Output:: + + { + "DBClusterEndpointIdentifier": "mycustomendpoint", + "DBClusterIdentifier": "mydbcluster", + "DBClusterEndpointResourceIdentifier": "cluster-endpoint-ANPAJ4AE5446DAEXAMPLE", + "Endpoint": "mycustomendpoint.cluster-custom-cnpexample.us-east-1.rds.amazonaws.com", + "Status": "modifying", + "EndpointType": "CUSTOM", + "CustomEndpointType": "READER", + "StaticMembers": [ + "dbinstance1", + "dbinstance2", + "dbinstance3" + ], + "ExcludedMembers": [], + "DBClusterEndpointArn": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:mycustomendpoint" + } + +For more information, see `Amazon Aurora Connection Management `__ in the *Amazon Aurora User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/modify-db-cluster-snapshot-attribute.rst awscli-1.18.69/awscli/examples/rds/modify-db-cluster-snapshot-attribute.rst --- awscli-1.11.13/awscli/examples/rds/modify-db-cluster-snapshot-attribute.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/modify-db-cluster-snapshot-attribute.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,26 @@ +**To modify a DB cluster snapshot attribute** + +The following ``modify-db-cluster-snapshot-attribute`` example makes changes to the specified DB cluster snapshot attribute. :: + + aws rds modify-db-cluster-snapshot-attribute \ + --db-cluster-snapshot-identifier myclustersnapshot \ + --attribute-name restore \ + --values-to-add 123456789012 + +Output:: + + { + "DBClusterSnapshotAttributesResult": { + "DBClusterSnapshotIdentifier": "myclustersnapshot", + "DBClusterSnapshotAttributes": [ + { + "AttributeName": "restore", + "AttributeValues": [ + "123456789012" + ] + } + ] + } + } + +For more information, see `Restoring from a DB Cluster Snapshot `__ in the *Amazon Aurora User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/modify-db-instance.rst awscli-1.18.69/awscli/examples/rds/modify-db-instance.rst --- awscli-1.11.13/awscli/examples/rds/modify-db-instance.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/modify-db-instance.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,24 @@ +**To modify a DB instance** + +The following ``modify-db-instance`` example changes the instance class of the specified running DB instance. The ``--apply-immediately`` parameter causes the DB engine to be replaced immediately, instead of waiting until the next maintenance window. :: + + aws rds modify-db-instance \ + --db-instance-identifier test-instance \ + --db-instance-class db.m1.large \ + --apply-immediately + +Output:: + + { + "DBInstance": { + "DBInstanceIdentifier": "test-instance", + "DBInstanceClass": "db.m1.small", + "Engine": "mysql", + "DBInstanceStatus": "modifying", + <...output omitted...> + "PendingModifiedValues": { + "DBInstanceClass": "db.m1.large" + } + <...some output omitted...> + } + } diff -Nru awscli-1.11.13/awscli/examples/rds/modify-db-snapshot-attributes.rst awscli-1.18.69/awscli/examples/rds/modify-db-snapshot-attributes.rst --- awscli-1.11.13/awscli/examples/rds/modify-db-snapshot-attributes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/modify-db-snapshot-attributes.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,27 @@ +**To modify a DB snapshot attribute** + +The following ``modify-db-snapshot-attribute`` example permits two AWS account identifiers, ``111122223333`` and ``444455556666``, to restore the DB snapshot named ``mydbsnapshot``. :: + + aws rds modify-db-snapshot-attribute \ + --db-snapshot-identifier mydbsnapshot \ + --attribute-name restore \ + --values-to-add '["111122223333","444455556666"]' + +Output:: + + { + "DBSnapshotAttributesResult": { + "DBSnapshotIdentifier": "mydbsnapshot", + "DBSnapshotAttributes": [ + { + "AttributeName": "restore", + "AttributeValues": [ + "111122223333", + "444455556666" + ] + } + ] + } + } + +For more information, see `Sharing a Snapshot `__ in the *Amazon RDS User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/modify-event-subscription.rst awscli-1.18.69/awscli/examples/rds/modify-event-subscription.rst --- awscli-1.11.13/awscli/examples/rds/modify-event-subscription.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/modify-event-subscription.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,26 @@ +**To modify an event subscription** + +The following ``modify-event-subscription`` example disables the specified event subscription, so that it no longer publishes notifications to the specified Amazon Simple Notification Service topic. :: + + aws rds modify-event-subscription \ + --subscription-name my-instance-events \ + --no-enabled + +Output:: + + { + "EventSubscription": { + "EventCategoriesList": [ + "backup", + "recovery" + ], + "CustomerAwsId": "123456789012", + "SourceType": "db-instance", + "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018", + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", + "CustSubscriptionId": "my-instance-events", + "Status": "modifying", + "Enabled": false + } + } diff -Nru awscli-1.11.13/awscli/examples/rds/promote-read-replica.rst awscli-1.18.69/awscli/examples/rds/promote-read-replica.rst --- awscli-1.11.13/awscli/examples/rds/promote-read-replica.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/promote-read-replica.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,18 @@ +**To promote a read replica** + +The following ``promote-read-replica`` example promotes the specified read replica to become a standalone DB instance. :: + + aws rds promote-read-replica \ + --db-instance-identifier test-instance-repl + +Output:: + + { + "DBInstance": { + "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance-repl", + "StorageType": "standard", + "ReadReplicaSourceDBInstanceIdentifier": "test-instance", + "DBInstanceStatus": "modifying", + ...some output truncated... + } + } diff -Nru awscli-1.11.13/awscli/examples/rds/purchase-reserved-db-instance.rst awscli-1.18.69/awscli/examples/rds/purchase-reserved-db-instance.rst --- awscli-1.11.13/awscli/examples/rds/purchase-reserved-db-instance.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/purchase-reserved-db-instance.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,7 @@ +**To purchase a reserved DB instance offering** + +The following ``purchase-reserved-db-instances-offering`` example purchases a reserved DB instance offering. The ``reserved-db-instances-offering-id`` must be a valid offering ID, as returned by the ``describe-reserved-db-instances-offering`` command. + + aws rds purchase-reserved-db-instances-offering \ + --reserved-db-instances-offering-id 438012d3-4a52-4cc7-b2e3-8dff72e0e706 + diff -Nru awscli-1.11.13/awscli/examples/rds/reboot-db-instance.rst awscli-1.18.69/awscli/examples/rds/reboot-db-instance.rst --- awscli-1.11.13/awscli/examples/rds/reboot-db-instance.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/reboot-db-instance.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,24 @@ +**To reboot a DB instance** + +The following ``reboot-db-instance`` example starts a reboot of the specified DB instance. :: + + aws rds reboot-db-instance \ + --db-instance-identifier test-instance + +Output:: + + { + "DBInstance": { + "DBInstanceIdentifier": "test-instance", + "DBInstanceClass": "db.m1.small", + "Engine": "mysql", + "DBInstanceStatus": "rebooting", + "MasterUsername": "myawsuser", + "Endpoint": { + "Address": "test-instance.cdgmuqiadpid.us-east-1.rds.amazonaws.com", + "Port": 3306, + "HostedZoneId": "Z2R2ITUGPM61AM" + }, + <...some output omitted...> + } + } diff -Nru awscli-1.11.13/awscli/examples/rds/remove-role-from-db-instance.rst awscli-1.18.69/awscli/examples/rds/remove-role-from-db-instance.rst --- awscli-1.11.13/awscli/examples/rds/remove-role-from-db-instance.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/remove-role-from-db-instance.rst 2020-05-28 19:26:18.000000000 +0000 @@ -0,0 +1,12 @@ +**To disassociate an AWS Identity and Access Management (IAM) role from a DB instance** + +The following ``remove-role-from-db-instance`` example removes the role named ``rds-s3-integration-role`` from an Oracle DB instance named ``test-instance``. :: + + aws rds remove-role-from-db-instance \ + --db-instance-identifier test-instance \ + --feature-name S3_INTEGRATION \ + --role-arn arn:aws:iam::111122223333:role/rds-s3-integration-role + +This command produces no output. + +For more information, see `Disabling RDS SQL Server Integration with S3 `__ in the *Amazon RDS User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds/remove-source-identifier-from-subscription.rst awscli-1.18.69/awscli/examples/rds/remove-source-identifier-from-subscription.rst --- awscli-1.11.13/awscli/examples/rds/remove-source-identifier-from-subscription.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/remove-source-identifier-from-subscription.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,29 @@ +**To remove a source identifier from a subscription** + +The following ``remove-source-identifier`` example removes the specified source identifier from an existing subscription. :: + + aws rds remove-source-identifier-from-subscription \ + --subscription-name my-instance-events \ + --source-identifier test-instance-repl + +Output:: + + { + "EventSubscription": { + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018", + "EventCategoriesList": [ + "backup", + "recovery" + ], + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", + "Status": "modifying", + "CustSubscriptionId": "my-instance-events", + "CustomerAwsId": "123456789012", + "SourceIdsList": [ + "test-instance" + ], + "SourceType": "db-instance", + "Enabled": false + } + } diff -Nru awscli-1.11.13/awscli/examples/rds/restore-db-instance-from-db-snapshot.rst awscli-1.18.69/awscli/examples/rds/restore-db-instance-from-db-snapshot.rst --- awscli-1.11.13/awscli/examples/rds/restore-db-instance-from-db-snapshot.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/restore-db-instance-from-db-snapshot.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,17 @@ +**To restore a DB instance from a DB snapshot** + +The following ``restore-db-instance-from-db-snapshot`` example creates a new DB instance named ``restored-test-instance`` from the specified DB snapshot. :: + + aws rds restore-db-instance-from-db-snapshot \ + --db-instance-identifier restored-test-instance \ + --db-snapshot-identifier test-instance-snap + +Output:: + + { + "DBInstance": { + "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:restored-test-instance", + "DBInstanceStatus": "creating", + ...some output truncated... + } + } diff -Nru awscli-1.11.13/awscli/examples/rds/restore-db-instance-from-s3.rst awscli-1.18.69/awscli/examples/rds/restore-db-instance-from-s3.rst --- awscli-1.11.13/awscli/examples/rds/restore-db-instance-from-s3.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/restore-db-instance-from-s3.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,10 @@ +**To restore a DB instance from a backup in Amazon S3** + +The following ``restore-db-instance-from-s3`` example creates a new DB instance named ``restored-test-instance`` from an existing backup in the ``my-backups`` S3 bucket. :: + + aws rds restore-db-instance-from-s3 \ + --db-instance-identifier restored-test-instance \ + --allocated-storage 250 --db-instance-class db.m4.large --engine mysql \ + --master-username master --master-user-password secret99 \ + --s3-bucket-name my-backups --s3-ingestion-role-arn arn:aws:iam::123456789012:role/my-role \ + --source-engine mysql --source-engine-version 5.6.27 diff -Nru awscli-1.11.13/awscli/examples/rds/restore-db-instance-to-point-in-time.rst awscli-1.18.69/awscli/examples/rds/restore-db-instance-to-point-in-time.rst --- awscli-1.11.13/awscli/examples/rds/restore-db-instance-to-point-in-time.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/restore-db-instance-to-point-in-time.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,20 @@ +**To restore a DB instance to a point in time** + +The following ``restore-db-instance-to-point-in-time`` example restores ``test-instance`` to a new DB instance named ``restored-test-instance``, as of the specified time. :: + + aws rds restore-db-instance-to-point-in-time \ + --source-db-instance-identifier test-instance \ + --target-db-instance restored-test-instance \ + --restore-time 2018-07-30T23:45:00.000Z + +Output:: + + { + "DBInstance": { + "AllocatedStorage": 20, + "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:restored-test-instance", + "DBInstanceStatus": "creating", + "DBInstanceIdentifier": "restored-test-instance", + ...some output truncated... + } + } diff -Nru awscli-1.11.13/awscli/examples/rds/start-db-instance.rst awscli-1.18.69/awscli/examples/rds/start-db-instance.rst --- awscli-1.11.13/awscli/examples/rds/start-db-instance.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/start-db-instance.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,15 @@ +**To start a DB instance** + +The following ``start-db-instance`` example starts the specified DB instance. :: + + aws rds start-db-instance \ + --db-instance-identifier test-instance + +Output:: + + { + "DBInstance": { + "DBInstanceStatus": "starting", + ...some output truncated... + } + } diff -Nru awscli-1.11.13/awscli/examples/rds/stop-db-instance.rst awscli-1.18.69/awscli/examples/rds/stop-db-instance.rst --- awscli-1.11.13/awscli/examples/rds/stop-db-instance.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds/stop-db-instance.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,15 @@ +**To stop a DB instance** + +The following ``stop-db-instance`` example stops the specified DB instance. :: + + aws rds stop-db-instance \ + --db-instance-identifier test-instance + +Output:: + + { + "DBInstance": { + "DBInstanceStatus": "stopping", + ...some output truncated... + } + } diff -Nru awscli-1.11.13/awscli/examples/rds-data/batch-execute-statement.rst awscli-1.18.69/awscli/examples/rds-data/batch-execute-statement.rst --- awscli-1.11.13/awscli/examples/rds-data/batch-execute-statement.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds-data/batch-execute-statement.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,16 @@ +**To execute a batch SQL statement** + +The following ``batch-execute-statement`` example executes a batch SQL statement over an array of data with a parameter set. :: + + aws rds-data batch-execute-statement \ + --resource-arn "arn:aws:rds:us-west-2:123456789012:cluster:mydbcluster" \ + --database "mydb" \ + --secret-arn "arn:aws:secretsmanager:us-west-2:123456789012:secret:mysecret" \ + --sql "insert into mytable values (:id, :val)" \ + --parameter-sets "[[{\"name\": \"id\", \"value\": {\"longValue\": 1}},{\"name\": \"val\", \"value\": {\"stringValue\": \"ValueOne\"}}], + [{\"name\": \"id\", \"value\": {\"longValue\": 2}},{\"name\": \"val\", \"value\": {\"stringValue\": \"ValueTwo\"}}], + [{\"name\": \"id\", \"value\": {\"longValue\": 3}},{\"name\": \"val\", \"value\": {\"stringValue\": \"ValueThree\"}}]]" + +This command produces no output. + +For more information, see `Using the Data API for Aurora Serverless `__ in the *Amazon RDS User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds-data/begin-transaction.rst awscli-1.18.69/awscli/examples/rds-data/begin-transaction.rst --- awscli-1.11.13/awscli/examples/rds-data/begin-transaction.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds-data/begin-transaction.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,16 @@ +**To start a SQL transaction** + +The following ``begin-transaction`` example starts a SQL transaction. :: + + aws rds-data begin-transaction \ + --resource-arn "arn:aws:rds:us-west-2:123456789012:cluster:mydbcluster" \ + --database "mydb" \ + --secret-arn "arn:aws:secretsmanager:us-west-2:123456789012:secret:mysecret" + +Output:: + + { + "transactionId": "ABC1234567890xyz" + } + +For more information, see `Using the Data API for Aurora Serverless `__ in the *Amazon RDS User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds-data/commit-transaction.rst awscli-1.18.69/awscli/examples/rds-data/commit-transaction.rst --- awscli-1.11.13/awscli/examples/rds-data/commit-transaction.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds-data/commit-transaction.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,16 @@ +**To commit a SQL transaction** + +The following ``commit-transaction`` example ends the specified SQL transaction and commits the changes that you made as part of it. :: + + aws rds-data commit-transaction \ + --resource-arn "arn:aws:rds:us-west-2:123456789012:cluster:mydbcluster" \ + --secret-arn "arn:aws:secretsmanager:us-west-2:123456789012:secret:mysecret" \ + --transaction-id "ABC1234567890xyz" + +Output:: + + { + "transactionStatus": "Transaction Committed" + } + +For more information, see `Using the Data API for Aurora Serverless `__ in the *Amazon RDS User Guide*. diff -Nru awscli-1.11.13/awscli/examples/rds-data/execute-statement.rst awscli-1.18.69/awscli/examples/rds-data/execute-statement.rst --- awscli-1.11.13/awscli/examples/rds-data/execute-statement.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds-data/execute-statement.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,36 @@ +**Example 1: To execute a SQL statement that is part of a transaction** + +The following ``execute-statement`` example runs a SQL statement that is part of a transaction. :: + + aws rds-data execute-statement \ + --resource-arn "arn:aws:rds:us-west-2:123456789012:cluster:mydbcluster" \ + --database "mydb" \ + --secret-arn "arn:aws:secretsmanager:us-west-2:123456789012:secret:mysecret" \ + --sql "update mytable set quantity=5 where id=201" \ + --transaction-id "ABC1234567890xyz" + +Output:: + + { + "numberOfRecordsUpdated": 1 + } + +**Example 2: To execute a SQL statement with parameters** + +The following ``execute-statement`` example runs a SQL statement with parameters. :: + + aws rds-data execute-statement \ + --resource-arn "arn:aws:rds:us-east-1:123456789012:cluster:mydbcluster" \ + --database "mydb" \ + --secret-arn "arn:aws:secretsmanager:us-east-1:123456789012:secret:mysecret" \ + --sql "insert into mytable values (:id, :val)" \ + --parameters "[{\"name\": \"id\", \"value\": {\"longValue\": 1}},{\"name\": \"val\", \"value\": {\"stringValue\": \"value1\"}}]" + +Output:: + + { + "numberOfRecordsUpdated": 1 + } + +For more information, see `Using the Data API for Aurora Serverless `__ in the *Amazon RDS User Guide*. + diff -Nru awscli-1.11.13/awscli/examples/rds-data/rollback-transaction.rst awscli-1.18.69/awscli/examples/rds-data/rollback-transaction.rst --- awscli-1.11.13/awscli/examples/rds-data/rollback-transaction.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/rds-data/rollback-transaction.rst 2020-05-28 19:25:50.000000000 +0000 @@ -0,0 +1,16 @@ +**To roll back a SQL transaction** + +The following ``rollback-transaction`` example rolls back the specified SQL transaction. :: + + aws rds-data rollback-transaction \ + --resource-arn "arn:aws:rds:us-west-2:123456789012:cluster:mydbcluster" \ + --secret-arn "arn:aws:secretsmanager:us-west-2:123456789012:secret:mysecret" \ + --transaction-id "ABC1234567890xyz" + +Output:: + + { + "transactionStatus": "Rollback Complete" + } + +For more information, see `Using the Data API for Aurora Serverless `__ in the *Amazon RDS User Guide*. diff -Nru awscli-1.11.13/awscli/examples/redshift/accept-reserved-node-exchange.rst awscli-1.18.69/awscli/examples/redshift/accept-reserved-node-exchange.rst --- awscli-1.11.13/awscli/examples/redshift/accept-reserved-node-exchange.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/redshift/accept-reserved-node-exchange.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/redshift/batch-delete-cluster-snapshots.rst awscli-1.18.69/awscli/examples/redshift/batch-delete-cluster-snapshots.rst --- awscli-1.11.13/awscli/examples/redshift/batch-delete-cluster-snapshots.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/redshift/batch-delete-cluster-snapshots.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/redshift/batch-modify-cluster-snapshots.rst awscli-1.18.69/awscli/examples/redshift/batch-modify-cluster-snapshots.rst --- awscli-1.11.13/awscli/examples/redshift/batch-modify-cluster-snapshots.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/redshift/batch-modify-cluster-snapshots.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/redshift/cancel-resize.rst awscli-1.18.69/awscli/examples/redshift/cancel-resize.rst --- awscli-1.11.13/awscli/examples/redshift/cancel-resize.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/redshift/cancel-resize.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/redshift/create-event-subscription.rst awscli-1.18.69/awscli/examples/redshift/create-event-subscription.rst --- awscli-1.11.13/awscli/examples/redshift/create-event-subscription.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/redshift/create-event-subscription.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/redshift/create-hsm-client-certificate.rst awscli-1.18.69/awscli/examples/redshift/create-hsm-client-certificate.rst --- awscli-1.11.13/awscli/examples/redshift/create-hsm-client-certificate.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/redshift/create-hsm-client-certificate.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/redshift/create-hsm-configuration.rst awscli-1.18.69/awscli/examples/redshift/create-hsm-configuration.rst --- awscli-1.11.13/awscli/examples/redshift/create-hsm-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/redshift/create-hsm-configuration.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/redshift/create-snapshot-copy-grant.rst awscli-1.18.69/awscli/examples/redshift/create-snapshot-copy-grant.rst --- awscli-1.11.13/awscli/examples/redshift/create-snapshot-copy-grant.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/redshift/create-snapshot-copy-grant.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/redshift/create-snapshot-schedule.rst awscli-1.18.69/awscli/examples/redshift/create-snapshot-schedule.rst --- awscli-1.11.13/awscli/examples/redshift/create-snapshot-schedule.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/redshift/create-snapshot-schedule.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/redshift/create-tags.rst awscli-1.18.69/awscli/examples/redshift/create-tags.rst --- awscli-1.11.13/awscli/examples/redshift/create-tags.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/redshift/create-tags.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/redshift/delete-event-subscription.rst awscli-1.18.69/awscli/examples/redshift/delete-event-subscription.rst --- awscli-1.11.13/awscli/examples/redshift/delete-event-subscription.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/redshift/delete-event-subscription.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/redshift/delete-hsm-client-certificate.rst awscli-1.18.69/awscli/examples/redshift/delete-hsm-client-certificate.rst --- awscli-1.11.13/awscli/examples/redshift/delete-hsm-client-certificate.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/redshift/delete-hsm-client-certificate.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/redshift/delete-hsm-configuration.rst awscli-1.18.69/awscli/examples/redshift/delete-hsm-configuration.rst --- awscli-1.11.13/awscli/examples/redshift/delete-hsm-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/redshift/delete-hsm-configuration.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/redshift/delete-scheduled-action.rst awscli-1.18.69/awscli/examples/redshift/delete-scheduled-action.rst --- awscli-1.11.13/awscli/examples/redshift/delete-scheduled-action.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/redshift/delete-scheduled-action.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/redshift/delete-snapshot-copy-grant.rst awscli-1.18.69/awscli/examples/redshift/delete-snapshot-copy-grant.rst --- awscli-1.11.13/awscli/examples/redshift/delete-snapshot-copy-grant.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/redshift/delete-snapshot-copy-grant.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/redshift/delete-snapshot-schedule.rst awscli-1.18.69/awscli/examples/redshift/delete-snapshot-schedule.rst --- awscli-1.11.13/awscli/examples/redshift/delete-snapshot-schedule.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/redshift/delete-snapshot-schedule.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/redshift/delete-tags.rst awscli-1.18.69/awscli/examples/redshift/delete-tags.rst --- awscli-1.11.13/awscli/examples/redshift/delete-tags.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/redshift/delete-tags.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/redshift/describe-account-attributes.rst awscli-1.18.69/awscli/examples/redshift/describe-account-attributes.rst --- awscli-1.11.13/awscli/examples/redshift/describe-account-attributes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/redshift/describe-account-attributes.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/redshift/describe-cluster-db-revisions.rst awscli-1.18.69/awscli/examples/redshift/describe-cluster-db-revisions.rst --- awscli-1.11.13/awscli/examples/redshift/describe-cluster-db-revisions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/redshift/describe-cluster-db-revisions.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/redshift/describe-cluster-tracks.rst awscli-1.18.69/awscli/examples/redshift/describe-cluster-tracks.rst --- awscli-1.11.13/awscli/examples/redshift/describe-cluster-tracks.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/redshift/describe-cluster-tracks.rst 2020-05-28 19:25:50.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.11.13/awscli/examples/redshift/describe-event-categories.rst awscli-1.18.69/awscli/examples/redshift/describe-event-categories.rst --- awscli-1.11.13/awscli/examples/redshift/describe-event-categories.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.18.69/awscli/examples/redshift/describe-event-categories.rst 2020-05-28 19:25:50.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