diff -Nru awscli-1.21.9/awscli/alias.py awscli-1.22.34/awscli/alias.py --- awscli-1.21.9/awscli/alias.py 2021-11-02 18:19:30.000000000 +0000 +++ awscli-1.22.34/awscli/alias.py 2022-01-12 19:04:32.000000000 +0000 @@ -153,7 +153,7 @@ :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 + parameters. This is used to parse the service command and any global parameters from the alias's value. :type shadow_proxy_command: CLICommand @@ -180,7 +180,7 @@ 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 + # Pass the update remaining 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: diff -Nru awscli-1.21.9/awscli/arguments.py awscli-1.22.34/awscli/arguments.py --- awscli-1.21.9/awscli/arguments.py 2021-11-02 18:19:46.000000000 +0000 +++ awscli-1.22.34/awscli/arguments.py 2022-01-12 19:04:32.000000000 +0000 @@ -494,7 +494,7 @@ aws foo bar --enabled - For cases wher the boolean parameter is required we need to add + For cases where the boolean parameter is required we need to add two parameters:: aws foo bar --enabled diff -Nru awscli-1.21.9/awscli/compat.py awscli-1.22.34/awscli/compat.py --- awscli-1.21.9/awscli/compat.py 2021-11-02 18:19:30.000000000 +0000 +++ awscli-1.22.34/awscli/compat.py 2022-01-12 19:04:32.000000000 +0000 @@ -77,7 +77,7 @@ It is deliberately set to binary mode so that `\r` does not get added to the line ending. This can be useful when printing commands where a - windows style line ending would casuse errors. + windows style line ending would cause errors. """ def __enter__(self): diff -Nru awscli-1.21.9/awscli/customizations/s3/subcommands.py awscli-1.22.34/awscli/customizations/s3/subcommands.py --- awscli-1.21.9/awscli/customizations/s3/subcommands.py 2021-11-02 18:19:46.000000000 +0000 +++ awscli-1.22.34/awscli/customizations/s3/subcommands.py 2022-01-12 19:04:32.000000000 +0000 @@ -249,12 +249,12 @@ STORAGE_CLASS = {'name': 'storage-class', 'choices': ['STANDARD', 'REDUCED_REDUNDANCY', 'STANDARD_IA', 'ONEZONE_IA', 'INTELLIGENT_TIERING', 'GLACIER', - 'DEEP_ARCHIVE'], + 'DEEP_ARCHIVE', 'GLACIER_IR'], 'help_text': ( "The type of storage to use for the object. " "Valid choices are: STANDARD | REDUCED_REDUNDANCY " "| STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING " - "| GLACIER | DEEP_ARCHIVE. " + "| GLACIER | DEEP_ARCHIVE | GLACIER_IR. " "Defaults to 'STANDARD'")} diff -Nru awscli-1.21.9/awscli/examples/apigateway/put-rest-api.rst awscli-1.22.34/awscli/examples/apigateway/put-rest-api.rst --- awscli-1.21.9/awscli/examples/apigateway/put-rest-api.rst 2021-11-02 18:19:30.000000000 +0000 +++ awscli-1.22.34/awscli/examples/apigateway/put-rest-api.rst 2022-01-12 19:04:32.000000000 +0000 @@ -2,10 +2,10 @@ Command:: - aws apigateway put-rest-api --rest-api-id 1234123412 --mode overwrite --body 'file:///path/to/API_Swagger_template.json' + aws apigateway put-rest-api --rest-api-id 1234123412 --mode overwrite --body 'fileb:///path/to/API_Swagger_template.json' **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' + aws apigateway put-rest-api --rest-api-id 1234123412 --mode merge --body 'fileb:///path/to/API_Swagger_template.json' diff -Nru awscli-1.21.9/awscli/examples/appconfig/create-application.rst awscli-1.22.34/awscli/examples/appconfig/create-application.rst --- awscli-1.21.9/awscli/examples/appconfig/create-application.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/appconfig/create-application.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,17 @@ +**To create an application** + +The following ``create-application`` example creates an application in AWS AppConfig. :: + + aws appconfig create-application \ + --name "example-application" \ + --description "An application used for creating an example." + +Output:: + + { + "Description": "An application used for creating an example.", + "Id": "339ohji", + "Name": "example-application" + } + +For more information, see `Step 1: Creating an AWS AppConfig application `__ in the *AWS AppConfig User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/appconfig/create-configuration-profile.rst awscli-1.22.34/awscli/examples/appconfig/create-configuration-profile.rst --- awscli-1.21.9/awscli/examples/appconfig/create-configuration-profile.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/appconfig/create-configuration-profile.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,24 @@ +**To create a configuration profile** + +The following ``create-configuration-profile`` example creates a configuration profile using a configuration stored in Parameter Store, a capability of Systems Manager. :: + + aws appconfig create-configuration-profile \ + --application-id "339ohji" \ + --name "Example-Configuration-Profile" \ + --location-uri "ssm-parameter://Example-Parameter" \ + --retrieval-role-arn "arn:aws:iam::111122223333:role/Example-App-Config-Role" + +Output:: + + { + "ApplicationId": "339ohji", + "Description": null, + "Id": "ur8hx2f", + "LocationUri": "ssm-parameter://Example-Parameter", + "Name": "Example-Configuration-Profile", + "RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role", + "Type": null, + "Validators": null + } + +For more information, see `Step 3: Creating a configuration and a configuration profile `__ in the *AWS AppConfig User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/appconfig/create-environment.rst awscli-1.22.34/awscli/examples/appconfig/create-environment.rst --- awscli-1.21.9/awscli/examples/appconfig/create-environment.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/appconfig/create-environment.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,20 @@ +**To create an environment** + +The following ``create-environment`` example creates an AWS AppConfig environment named Example-Environment using the application you created using create-application. :: + + aws appconfig create-environment \ + --application-id "339ohji" \ + --name "Example-Environment" + +Output:: + + { + "ApplicationId": "339ohji", + "Description": null, + "Id": "54j1r29", + "Monitors": null, + "Name": "Example-Environment", + "State": "ReadyForDeployment" + } + +For more information, see `Step 2: Creating an environment `__ in the *AWS AppConfig User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/appconfig/create-hosted-configuration-version.rst awscli-1.22.34/awscli/examples/appconfig/create-hosted-configuration-version.rst --- awscli-1.21.9/awscli/examples/appconfig/create-hosted-configuration-version.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/appconfig/create-hosted-configuration-version.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,26 @@ +**To create a hosted configuration version** + +The following ``create-hosted-configuration-version`` example creates a new configuration in the AWS AppConfig hosted configuration store. The configuration content must first be converted to base64. :: + + aws appconfig create-hosted-configuration-version \ + --application-id "339ohji" \ + --configuration-profile-id "ur8hx2f" \ + --content eyAiTmFtZSI6ICJFeGFtcGxlQXBwbGljYXRpb24iLCAiSWQiOiBFeGFtcGxlSUQsICJSYW5rIjogNyB9 \ + --content-type "application/json" \ + configuration_version_output_file + +Contents of ``configuration_version_output_file``:: + + { "Name": "ExampleApplication", "Id": ExampleID, "Rank": 7 } + +Output:: + + { + "ApplicationId": "339ohji", + "ConfigurationProfileId": "ur8hx2f", + "VersionNumber": "1", + "ContentType": "application/json" + } + + +For more information, see `About the AWS AppConfig hosted configuration store `__ in the *AWS Appconfig User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/appconfig/delete-application.rst awscli-1.22.34/awscli/examples/appconfig/delete-application.rst --- awscli-1.21.9/awscli/examples/appconfig/delete-application.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/appconfig/delete-application.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete an application** + +The following ``delete-application`` example deletes the specified application. :: + + aws appconfig delete-application \ + --application-id 339ohji + +This command produces no output. + +For more information, see `Step 1: Creating an AWS AppConfig application `__ in the *AWS AppConfig User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/appconfig/delete-configuration-profile.rst awscli-1.22.34/awscli/examples/appconfig/delete-configuration-profile.rst --- awscli-1.21.9/awscli/examples/appconfig/delete-configuration-profile.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/appconfig/delete-configuration-profile.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,11 @@ +**To delete a configuration profile** + +The following ``delete-configuration-profile`` example deletes the specified configuration profile. :: + + aws appconfig delete-configuration-profile \ + --application-id 339ohji \ + --configuration-profile-id ur8hx2f + +This command produces no output. + +For more information, see `Step 3: Creating a configuration and a configuration profile `__ in the *AWS AppConfig User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/appconfig/delete-deployment-strategy.rst awscli-1.22.34/awscli/examples/appconfig/delete-deployment-strategy.rst --- awscli-1.21.9/awscli/examples/appconfig/delete-deployment-strategy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/appconfig/delete-deployment-strategy.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,10 @@ +**To delete a deployment strategy** + +The following ``delete-deployment-strategy`` example deletes the specified deployment strategy. :: + + aws appconfig delete-deployment-strategy \ + --deployment-strategy-id 1225qzk + +This command produces no output. + +For more information, see `Step 4: Creating a deployment strategy `__ in the *AWS AppConfig User Guide*. diff -Nru awscli-1.21.9/awscli/examples/appconfig/delete-environment.rst awscli-1.22.34/awscli/examples/appconfig/delete-environment.rst --- awscli-1.21.9/awscli/examples/appconfig/delete-environment.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/appconfig/delete-environment.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,11 @@ +**To delete an environment** + +The following ``delete-environment`` example deletes the specified application environment. :: + + aws appconfig delete-environment \ + --application-id 339ohji \ + --environment-id 54j1r29 + +This command produces no output. + +For more information, see `Step 2: Creating an environment `__ in the *AWS AppConfig User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/appconfig/delete-hosted-configuration-version.rst awscli-1.22.34/awscli/examples/appconfig/delete-hosted-configuration-version.rst --- awscli-1.21.9/awscli/examples/appconfig/delete-hosted-configuration-version.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/appconfig/delete-hosted-configuration-version.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,13 @@ +**To delete a hosted configuration version** + +The following ``delete-hosted-configuration-version`` example deletes a configuration version hosted in the AWS AppConfig hosted configuration store. :: + + aws appconfig delete-hosted-configuration-version \ + --application-id 339ohji \ + --configuration-profile-id ur8hx2f \ + --version-number 1 + +Output:: +This command produces no output. + +For more information, see `Step 3: Creating a configuration and a configuration profile `__ in the *AWS AppConfig User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/appconfig/get-application.rst awscli-1.22.34/awscli/examples/appconfig/get-application.rst --- awscli-1.21.9/awscli/examples/appconfig/get-application.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/appconfig/get-application.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,16 @@ +**To list details of an application** + +The following ``get-application`` example lists the details of the specified application. :: + + aws appconfig get-application \ + --application-id 339ohji + +Output:: + + { + "Description": "An application used for creating an example.", + "Id": "339ohji", + "Name": "example-application" + } + +For more information, see `How AWS AppConfig works `__ in the *AWS AppConfig User Guide*. diff -Nru awscli-1.21.9/awscli/examples/appconfig/get-configuration-profile.rst awscli-1.22.34/awscli/examples/appconfig/get-configuration-profile.rst --- awscli-1.21.9/awscli/examples/appconfig/get-configuration-profile.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/appconfig/get-configuration-profile.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,19 @@ +**To retrieve configuration profile details** + +The following ``get-configuration-profile`` example returns the details of the specified configuration profile. :: + + aws appconfig get-configuration-profile \ + --application-id 339ohji \ + --configuration-profile-id ur8hx2f + +Output:: + + { + "ApplicationId": "339ohji", + "Id": "ur8hx2f", + "Name": "Example-Configuration-Profile", + "LocationUri": "ssm-parameter://Example-Parameter", + "RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role" + } + +For more information, see `Step 3: Creating a configuration and a configuration profile `__ in the *AWS AppConfig User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/appconfig/get-configuration.rst awscli-1.22.34/awscli/examples/appconfig/get-configuration.rst --- awscli-1.21.9/awscli/examples/appconfig/get-configuration.rst 2021-11-02 18:19:30.000000000 +0000 +++ awscli-1.22.34/awscli/examples/appconfig/get-configuration.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,19 +1,23 @@ -**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_name - -Output:: - - { - "ConfigurationVersion": "2", - "ContentType": "application/octet-stream" - } - -For more information, see `Retrieving the Configuration `__ in the *AWS Systems Manager User Guide*. +**To retrieve configuration details** + +The following ``get-configuration`` example returns the configuration details of the example application. On subsequent calls to get-configuration use the ``client-configuration-version`` parameter to only update the configuration of your application if the version has changed. Only updating the configuration when the version has changed avoids excess charges incurred by calling get-configuration. :: + + aws appconfig get-configuration \ + --application "example-application" \ + --environment "Example-Environment" \ + --configuration "Example-Configuration-Profile" \ + --client-id "test-id" \ + configuration-output-file + +Contents of ``configuration-output-file``:: + + { "Name": "ExampleApplication", "Id": ExampleID, "Rank": 7 } + +Output:: + + { + "ConfigurationVersion": "1", + "ContentType": "application/json" + } + +For more information, see `Step 6: Receiving the configuration `__ in the *AWS AppConfig User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/appconfig/get-deployment.rst awscli-1.22.34/awscli/examples/appconfig/get-deployment.rst --- awscli-1.21.9/awscli/examples/appconfig/get-deployment.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/appconfig/get-deployment.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,75 @@ +**To retrieve deployment details** + +The following ``get-deployment`` example lists details of the deployment to the application in the specified environment and deployment. :: + + aws appconfig get-deployment \ + --application-id 339ohji \ + --environment-id 54j1r29 \ + --deployment-number 1 + +Output:: + + { + "ApplicationId": "339ohji", + "EnvironmentId": "54j1r29", + "DeploymentStrategyId": "1225qzk", + "ConfigurationProfileId": "ur8hx2f", + "DeploymentNumber": 1, + "ConfigurationName": "Example-Configuration-Profile", + "ConfigurationLocationUri": "ssm-parameter://Example-Parameter", + "ConfigurationVersion": "1", + "DeploymentDurationInMinutes": 15, + "GrowthType": "LINEAR", + "GrowthFactor": 25.0, + "FinalBakeTimeInMinutes": 0, + "State": "COMPLETE", + "EventLog": [ + { + "EventType": "DEPLOYMENT_COMPLETED", + "TriggeredBy": "APPCONFIG", + "Description": "Deployment completed", + "OccurredAt": "2021-09-17T21:59:03.888000+00:00" + }, + { + "EventType": "BAKE_TIME_STARTED", + "TriggeredBy": "APPCONFIG", + "Description": "Deployment bake time started", + "OccurredAt": "2021-09-17T21:58:57.722000+00:00" + }, + { + "EventType": "PERCENTAGE_UPDATED", + "TriggeredBy": "APPCONFIG", + "Description": "Configuration available to 100.00% of clients", + "OccurredAt": "2021-09-17T21:55:56.816000+00:00" + }, + { + "EventType": "PERCENTAGE_UPDATED", + "TriggeredBy": "APPCONFIG", + "Description": "Configuration available to 75.00% of clients", + "OccurredAt": "2021-09-17T21:52:56.567000+00:00" + }, + { + "EventType": "PERCENTAGE_UPDATED", + "TriggeredBy": "APPCONFIG", + "Description": "Configuration available to 50.00% of clients", + "OccurredAt": "2021-09-17T21:49:55.737000+00:00" + }, + { + "EventType": "PERCENTAGE_UPDATED", + "TriggeredBy": "APPCONFIG", + "Description": "Configuration available to 25.00% of clients", + "OccurredAt": "2021-09-17T21:46:55.187000+00:00" + }, + { + "EventType": "DEPLOYMENT_STARTED", + "TriggeredBy": "USER", + "Description": "Deployment started", + "OccurredAt": "2021-09-17T21:43:54.205000+00:00" + } + ], + "PercentageComplete": 100.0, + "StartedAt": "2021-09-17T21:43:54.205000+00:00", + "CompletedAt": "2021-09-17T21:59:03.888000+00:00" + } + +For more information, see `Step 5: Deploying a configuration `__ in the *AWS AppConfig User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/appconfig/get-deployment-strategy.rst awscli-1.22.34/awscli/examples/appconfig/get-deployment-strategy.rst --- awscli-1.21.9/awscli/examples/appconfig/get-deployment-strategy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/appconfig/get-deployment-strategy.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,20 @@ +**To retrieve details of a deployment strategy** + +The following ``get-deployment-strategy`` example lists the details of the specified deployment strategy. :: + + aws appconfig get-deployment-strategy \ + --deployment-strategy-id 1225qzk + +Output:: + + { + "Id": "1225qzk", + "Name": "Example-Deployment", + "DeploymentDurationInMinutes": 15, + "GrowthType": "LINEAR", + "GrowthFactor": 25.0, + "FinalBakeTimeInMinutes": 0, + "ReplicateTo": "SSM_DOCUMENT" + } + +For more information, see `Step 4: Creating a deployment strategy `__ in the *AWS AppConfig User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/appconfig/get-environment.rst awscli-1.22.34/awscli/examples/appconfig/get-environment.rst --- awscli-1.21.9/awscli/examples/appconfig/get-environment.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/appconfig/get-environment.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,18 @@ +**To retrieve environment details** + +The following ``get-environment`` example returns the details and state of the specified environment. :: + + aws appconfig get-environment \ + --application-id 339ohji \ + --environment-id 54j1r29 + +Output:: + + { + "ApplicationId": "339ohji", + "Id": "54j1r29", + "Name": "Example-Environment", + "State": "ReadyForDeployment" + } + +For more information, see `Step 2: Creating an environment `__ in the *AWS AppConfig User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/appconfig/get-hosted-configuration-version.rst awscli-1.22.34/awscli/examples/appconfig/get-hosted-configuration-version.rst --- awscli-1.21.9/awscli/examples/appconfig/get-hosted-configuration-version.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/appconfig/get-hosted-configuration-version.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,24 @@ +**To retreive hosted configuration details** + +The following ``get-hosted-configuration-version`` example retrieves the configuration details of the AWS AppConfig hosted configuration. :: + + aws appconfig get-hosted-configuration-version \ + --application-id 339ohji \ + --configuration-profile-id ur8hx2f \ + --version-number 1 \ + hosted-configuration-version-output + +Contents of ``hosted-configuration-version-output``:: + + { "Name": "ExampleApplication", "Id": ExampleID, "Rank": 7 } + +Output:: + + { + "ApplicationId": "339ohji", + "ConfigurationProfileId": "ur8hx2f", + "VersionNumber": "1", + "ContentType": "application/json" + } + +For more information, see `About the AWS AppConfig hosted configuration store `__ in the *AWS AppConfig User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/appconfig/list-applications.rst awscli-1.22.34/awscli/examples/appconfig/list-applications.rst --- awscli-1.21.9/awscli/examples/appconfig/list-applications.rst 2021-11-02 18:19:30.000000000 +0000 +++ awscli-1.22.34/awscli/examples/appconfig/list-applications.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,19 +1,23 @@ -**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*. +**To list the available applications** + +The following ``list-applications`` example lists the available applications in your AWS account. :: + + aws appconfig list-applications + +Output:: + + { + "Items": [ + { + "Id": "339ohji", + "Name": "test-application", + "Description": "An application used for creating an example." + }, + { + "Id": "rwalwu7", + "Name": "Test-Application" + } + ] + } + +For more information, see `Step 1: Creating an AWS AppConfig application `__ in the *AWS AppConfig User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/appconfig/list-configuration-profiles.rst awscli-1.22.34/awscli/examples/appconfig/list-configuration-profiles.rst --- awscli-1.21.9/awscli/examples/appconfig/list-configuration-profiles.rst 2021-11-02 18:19:30.000000000 +0000 +++ awscli-1.22.34/awscli/examples/appconfig/list-configuration-profiles.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,33 +1,21 @@ -**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*. +**To list the available configuration profiles** + +The following ``list-configuration-profiles`` example lists the available configuration profiles for the specified application. :: + + aws appconfig list-configuration-profiles \ + --application-id 339ohji + +Output:: + + { + "Items": [ + { + "ApplicationId": "339ohji", + "Id": "ur8hx2f", + "Name": "Example-Configuration-Profile", + "LocationUri": "ssm-parameter://Example-Parameter" + } + ] + } + +For more information, see `Step 3: Creating a configuration and a configuration profile `__ in the *AWS AppConfig User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/appconfig/list-deployments.rst awscli-1.22.34/awscli/examples/appconfig/list-deployments.rst --- awscli-1.21.9/awscli/examples/appconfig/list-deployments.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/appconfig/list-deployments.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,29 @@ +**To list the available deployments** + +The following ``list-deployments`` example lists the available deployments in your AWS account for the specified application and environment. :: + + aws appconfig list-deployments \ + --application-id 339ohji \ + --environment-id 54j1r29 + +Output:: + + { + "Items": [ + { + "DeploymentNumber": 1, + "ConfigurationName": "Example-Configuration-Profile", + "ConfigurationVersion": "1", + "DeploymentDurationInMinutes": 15, + "GrowthType": "LINEAR", + "GrowthFactor": 25.0, + "FinalBakeTimeInMinutes": 0, + "State": "COMPLETE", + "PercentageComplete": 100.0, + "StartedAt": "2021-09-17T21:43:54.205000+00:00", + "CompletedAt": "2021-09-17T21:59:03.888000+00:00" + } + ] + } + +For more information, see `Step 5: Deploying a configuration `__ in the *AWS AppConfig User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/appconfig/list-deployment-strategies.rst awscli-1.22.34/awscli/examples/appconfig/list-deployment-strategies.rst --- awscli-1.21.9/awscli/examples/appconfig/list-deployment-strategies.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/appconfig/list-deployment-strategies.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,53 @@ +**To list the available deployment strategies** + +The following ``list-deployment-strategies`` example lists the available deployment strategies in your AWS account. :: + + aws appconfig list-deployment-strategies + +Output:: + + { + "Items": [ + { + "Id": "1225qzk", + "Name": "Example-Deployment", + "DeploymentDurationInMinutes": 15, + "GrowthType": "LINEAR", + "GrowthFactor": 25.0, + "FinalBakeTimeInMinutes": 0, + "ReplicateTo": "SSM_DOCUMENT" + }, + { + "Id": "AppConfig.AllAtOnce", + "Name": "AppConfig.AllAtOnce", + "Description": "Quick", + "DeploymentDurationInMinutes": 0, + "GrowthType": "LINEAR", + "GrowthFactor": 100.0, + "FinalBakeTimeInMinutes": 10, + "ReplicateTo": "NONE" + }, + { + "Id": "AppConfig.Linear50PercentEvery30Seconds", + "Name": "AppConfig.Linear50PercentEvery30Seconds", + "Description": "Test/Demo", + "DeploymentDurationInMinutes": 1, + "GrowthType": "LINEAR", + "GrowthFactor": 50.0, + "FinalBakeTimeInMinutes": 1, + "ReplicateTo": "NONE" + }, + { + "Id": "AppConfig.Canary10Percent20Minutes", + "Name": "AppConfig.Canary10Percent20Minutes", + "Description": "AWS Recommended", + "DeploymentDurationInMinutes": 20, + "GrowthType": "EXPONENTIAL", + "GrowthFactor": 10.0, + "FinalBakeTimeInMinutes": 10, + "ReplicateTo": "NONE" + } + ] + } + +For more information, see `Step 4: Creating a deployment strategy `__ in the *AWS AppConfig User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/appconfig/list-environments.rst awscli-1.22.34/awscli/examples/appconfig/list-environments.rst --- awscli-1.21.9/awscli/examples/appconfig/list-environments.rst 2021-11-02 18:19:30.000000000 +0000 +++ awscli-1.22.34/awscli/examples/appconfig/list-environments.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,23 +1,21 @@ -**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*. +**To list the available environments** + +The following ``list-environments`` example lists the available environments in your AWS account for the specified application. :: + + aws appconfig list-environments \ + --application-id 339ohji + +Output:: + + { + "Items": [ + { + "ApplicationId": "339ohji", + "Id": "54j1r29", + "Name": "Example-Environment", + "State": "ReadyForDeployment" + } + ] + } + +For more information, see `Step 2: Creating an environment `__ in the *AWS AppConfig User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/appconfig/list-hosted-configuration-versions.rst awscli-1.22.34/awscli/examples/appconfig/list-hosted-configuration-versions.rst --- awscli-1.21.9/awscli/examples/appconfig/list-hosted-configuration-versions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/appconfig/list-hosted-configuration-versions.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,22 @@ +**To list the available hosted configuration versions** + +The following ``list-hosted-configuration-versions`` example lists the configurations versions hosted in the AWS AppConfig hosted configuration store for the specified application and configuration profile. :: + + aws appconfig list-hosted-configuration-versions \ + --application-id 339ohji \ + --configuration-profile-id ur8hx2f + +Output:: + + { + "Items": [ + { + "ApplicationId": "339ohji", + "ConfigurationProfileId": "ur8hx2f", + "VersionNumber": 1, + "ContentType": "application/json" + } + ] + } + +For more information, see `About the AWS AppConfig hosted configuration store `__ in the *AWS AppConfig User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/appconfig/list-tags-for-resource.rst awscli-1.22.34/awscli/examples/appconfig/list-tags-for-resource.rst --- awscli-1.21.9/awscli/examples/appconfig/list-tags-for-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/appconfig/list-tags-for-resource.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,16 @@ +**To list the tags of an application** + +The following ``list-tags-for-resource`` example lists the tags of a specified application. :: + + aws appconfig list-tags-for-resource \ + --resource-arn arn:aws:appconfig:us-east-1:682428703967:application/339ohji + +Output:: + + { + "Tags": { + "group1": "1" + } + } + +For more information, see `Step 1: Creating an AWS AppConfig application `__ in the *AWS AppConfig User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/appconfig/start-deployment.rst awscli-1.22.34/awscli/examples/appconfig/start-deployment.rst --- awscli-1.21.9/awscli/examples/appconfig/start-deployment.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/appconfig/start-deployment.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,40 @@ +**To start a configuration deployment** + +The following ``start-deployment`` example starts a deployment to the application using the specified environment, deployment strategy, and configuration profile. :: + + aws appconfig start-deployment \ + --application-id 339ohji \ + --environment-id 54j1r29 \ + --deployment-strategy-id 1225qzk \ + --configuration-profile-id ur8hx2f \ + --configuration-version 1 + +Output:: + + { + "ApplicationId": "339ohji", + "EnvironmentId": "54j1r29", + "DeploymentStrategyId": "1225qzk", + "ConfigurationProfileId": "ur8hx2f", + "DeploymentNumber": 1, + "ConfigurationName": "Example-Configuration-Profile", + "ConfigurationLocationUri": "ssm-parameter://Example-Parameter", + "ConfigurationVersion": "1", + "DeploymentDurationInMinutes": 15, + "GrowthType": "LINEAR", + "GrowthFactor": 25.0, + "FinalBakeTimeInMinutes": 0, + "State": "DEPLOYING", + "EventLog": [ + { + "EventType": "DEPLOYMENT_STARTED", + "TriggeredBy": "USER", + "Description": "Deployment started", + "OccurredAt": "2021-09-17T21:43:54.205000+00:00" + } + ], + "PercentageComplete": 0.0, + "StartedAt": "2021-09-17T21:43:54.205000+00:00" + } + +For more information, see `Step 5: Deploying a configuration `__ in the *AWS AppConfig User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/appconfig/stop-deployment.rst awscli-1.22.34/awscli/examples/appconfig/stop-deployment.rst --- awscli-1.21.9/awscli/examples/appconfig/stop-deployment.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/appconfig/stop-deployment.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,20 @@ +**To stop configuration deployment** + +The following ``stop-deployment`` example stops the deployment of an application configuration to the specified environment. :: + + aws appconfig stop-deployment \ + --application-id 339ohji \ + --environment-id 54j1r29 \ + --deployment-number 2 + +Output:: + + { + "DeploymentNumber": 0, + "DeploymentDurationInMinutes": 0, + "GrowthFactor": 0.0, + "FinalBakeTimeInMinutes": 0, + "PercentageComplete": 0.0 + } + +For more information, see `Step 5: Deploying a configuration `__ in the *AWS AppConfig User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/appconfig/tag-resource.rst awscli-1.22.34/awscli/examples/appconfig/tag-resource.rst --- awscli-1.21.9/awscli/examples/appconfig/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/appconfig/tag-resource.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,11 @@ +**To tag an application** + +The following ``tag-resource`` example tags an application resource. :: + + aws appconfig tag-resource \ + --resource-arn arn:aws:appconfig:us-east-1:682428703967:application/339ohji \ + --tags '{"group1" : "1"}' + +This command produces no output. + +For more information, see `Step 1: Creating an AWS AppConfig application `__ in the *AWS AppConfig User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/appconfig/untag-resource.rst awscli-1.22.34/awscli/examples/appconfig/untag-resource.rst --- awscli-1.21.9/awscli/examples/appconfig/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/appconfig/untag-resource.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,11 @@ +**To remove a tag from an application** + +The following ``untag-resource`` example removes the group1 tag from the specified application. :: + + aws appconfig untag-resource \ + --resource-arn arn:aws:appconfig:us-east-1:111122223333:application/339ohji \ + --tag-keys '["group1"]' + +This command produces no output. + +For more information, see `Step 1: Creating an AWS AppConfig application `__ in the *AWS AppConfig User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/appconfig/update-application.rst awscli-1.22.34/awscli/examples/appconfig/update-application.rst --- awscli-1.21.9/awscli/examples/appconfig/update-application.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/appconfig/update-application.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,17 @@ +**To update an application** + +The following ``update-application`` example updates the name of the specified application. :: + + aws appconfig update-application \ + --application-id 339ohji \ + --name "Example-Application" + +Output:: + + { + "Id": "339ohji", + "Name": "Example-Application", + "Description": "An application used for creating an example." + } + +For more information, see `Step 1: Creating an AWS AppConfig application `__ in the *AWS AppConfig User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/appconfig/update-configuration-profile.rst awscli-1.22.34/awscli/examples/appconfig/update-configuration-profile.rst --- awscli-1.21.9/awscli/examples/appconfig/update-configuration-profile.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/appconfig/update-configuration-profile.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,21 @@ +**To update a configuration profile** + +The following ``update-configuration-profile`` example updates the description of the specified configuration profile. :: + + aws appconfig update-configuration-profile \ + --application-id 339ohji \ + --configuration-profile-id ur8hx2f \ + --description "Configuration profile used for examples." + +Output:: + + { + "ApplicationId": "339ohji", + "Id": "ur8hx2f", + "Name": "Example-Configuration-Profile", + "Description": "Configuration profile used for examples.", + "LocationUri": "ssm-parameter://Example-Parameter", + "RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role" + } + +For more information, see `Step 3: Creating a configuration and a configuration profile `__ in the *AWS AppConfig User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/appconfig/update-deployment-strategy.rst awscli-1.22.34/awscli/examples/appconfig/update-deployment-strategy.rst --- awscli-1.21.9/awscli/examples/appconfig/update-deployment-strategy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/appconfig/update-deployment-strategy.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,21 @@ +**To update a deployment strategy** + +The following ``update-deployment-strategy`` example updates final bake time to 20 minutes in the specified deployment strategy. :: + + aws appconfig update-deployment-strategy \ + --deployment-strategy-id 1225qzk \ + --final-bake-time-in-minutes 20 + +Output:: + + { + "Id": "1225qzk", + "Name": "Example-Deployment", + "DeploymentDurationInMinutes": 15, + "GrowthType": "LINEAR", + "GrowthFactor": 25.0, + "FinalBakeTimeInMinutes": 20, + "ReplicateTo": "SSM_DOCUMENT" + } + +For more information, see `Step 4: Creating a deployment strategy `__ in the *AWS AppConfig User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/appconfig/update-environment.rst awscli-1.22.34/awscli/examples/appconfig/update-environment.rst --- awscli-1.21.9/awscli/examples/appconfig/update-environment.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/appconfig/update-environment.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,20 @@ +**To update an environment** + +The following ``update-environment`` example updates an environment's description. :: + + aws appconfig update-environment \ + --application-id 339ohji \ + --environment-id 54j1r29 \ + --description "An environment for examples." + +Output:: + + { + "ApplicationId": "339ohji", + "Id": "54j1r29", + "Name": "Example-Environment", + "Description": "An environment for examples.", + "State": "RolledBack" + } + +For more information, see `Step 2: Creating an environment `__ in the *AWS AppConfig User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/appconfig/validate-configuration.rst awscli-1.22.34/awscli/examples/appconfig/validate-configuration.rst --- awscli-1.21.9/awscli/examples/appconfig/validate-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/appconfig/validate-configuration.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,12 @@ +**To validate a configuration** + +The following ``validate-configuration`` example uses the validators in a configuration profile to validate a configuration. :: + + aws appconfig validate-configuration \ + --application-id abc1234 \ + --configuration-profile-id ur8hx2f \ + --configuration-version 1 + +The command produces no output. + +For more information, see `Step 3: Creating a configuration and a configuration profile `__ in the *AWS AppConfig User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/apprunner/associate-custom-domain.rst awscli-1.22.34/awscli/examples/apprunner/associate-custom-domain.rst --- awscli-1.21.9/awscli/examples/apprunner/associate-custom-domain.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/apprunner/associate-custom-domain.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,41 @@ +**To associate a domain name and the www subdomain with a service** + +The following ``associate-custom-domain`` example associates a custom domain name that you control with an App Runner service. +The domain name is the root domain ``example.com``, including the special-case subdomain ``www.example.com``. :: + + aws apprunner associate-custom-domain \ + --cli-input-json file://input.json + +Contents of ``input.json``:: + + { + "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", + "DomainName": "example.com", + "EnableWWWSubdomain": true + } + +Output:: + + { + "CustomDomain": { + "CertificateValidationRecords": [ + { + "Name": "_70d3f50a94f7c72dc28784cf55db2f6b.example.com", + "Status": "PENDING_VALIDATION", + "Type": "CNAME", + "Value": "_1270c137383c6307b6832db02504c4b0.bsgbmzkfwj.acm-validations.aws." + }, + { + "Name": "_287870d3f50a94f7c72dc4cf55db2f6b.www.example.com", + "Status": "PENDING_VALIDATION", + "Type": "CNAME", + "Value": "_832db01270c137383c6307b62504c4b0.mzkbsgbfwj.acm-validations.aws." + } + ], + "DomainName": "example.com", + "EnableWWWSubdomain": true, + "Status": "CREATING" + }, + "DNSTarget": "psbqam834h.us-east-1.awsapprunner.com", + "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa" + } diff -Nru awscli-1.21.9/awscli/examples/apprunner/create-auto-scaling-configuration.rst awscli-1.22.34/awscli/examples/apprunner/create-auto-scaling-configuration.rst --- awscli-1.21.9/awscli/examples/apprunner/create-auto-scaling-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/apprunner/create-auto-scaling-configuration.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,33 @@ +**To create a high availability auto scaling configuration** + +The following ``create-auto-scaling-configuration`` example creates an auto scaling configuration optimized for high availability by setting ``MinSize`` to 5. +With this configuration, App Runner attempts to spread your service instances over the most Availability Zones possible, up to five, depending on the AWS Region. + +The call returns an ``AutoScalingConfiguration`` object with the other settings set to their defaults. +In the example, this is the first call to create a configuration named ``high-availability``. The revision is set to 1, and it's the latest revision. :: + + aws apprunner create-auto-scaling-configuration \ + --cli-input-json file://input.json + +Contents of ``input.json``:: + + { + "AutoScalingConfigurationName": "high-availability", + "MinSize": 5 + } + +Output:: + + { + "AutoScalingConfiguration": { + "AutoScalingConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/1/2f50e7656d7819fead0f59672e68042e", + "AutoScalingConfigurationName": "high-availability", + "AutoScalingConfigurationRevision": 1, + "CreatedAt": "2020-11-03T00:29:17Z", + "Latest": true, + "Status": "ACTIVE", + "MaxConcurrency": 100, + "MaxSize": 50, + "MinSize": 5 + } + } diff -Nru awscli-1.21.9/awscli/examples/apprunner/create-connection.rst awscli-1.22.34/awscli/examples/apprunner/create-connection.rst --- awscli-1.21.9/awscli/examples/apprunner/create-connection.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/apprunner/create-connection.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,27 @@ +**To create a GitHub connection** + +The following ``create-connection`` example creates a connection to a private GitHub code repository. The connection status after a successful call is ``PENDING_HANDSHAKE``. This is because an authentication handshake with the provider still hasn't happened. Complete the handshake using the App Runner console. :: + + aws apprunner create-connection \ + --cli-input-json file://input.json + +Contents of ``input.json``:: + + { + "ConnectionName": "my-github-connection", + "ProviderType": "GITHUB" + } + +Output:: + + { + "Connection": { + "ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-connection", + "ConnectionName": "my-github-connection", + "Status": "PENDING_HANDSHAKE", + "CreatedAt": "2020-11-03T00:32:51Z", + "ProviderType": "GITHUB" + } + } + +For more information, see `Managing App Runner connections `__ in the *AWS App Runner Developer Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/apprunner/create-service.rst awscli-1.22.34/awscli/examples/apprunner/create-service.rst --- awscli-1.21.9/awscli/examples/apprunner/create-service.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/apprunner/create-service.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,251 @@ +**Example 1: To create a source code repository service** + +The following ``create-service`` example creates an App Runner service based on a Python source code repository. :: + + aws apprunner create-service \ + --cli-input-json file://input.json + +Contents of ``input.json``:: + + { + "ServiceName": "python-app", + "SourceConfiguration": { + "AuthenticationConfiguration": { + "ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-connection/e7656250f67242d7819feade6800f59e" + }, + "AutoDeploymentsEnabled": true, + "CodeRepository": { + "RepositoryUrl": "https://github.com/my-account/python-hello", + "SourceCodeVersion": { + "Type": "BRANCH", + "Value": "main" + }, + "CodeConfiguration": { + "ConfigurationSource": "API", + "CodeConfigurationValues": { + "Runtime": "PYTHON_3", + "BuildCommand": "pip install -r requirements.txt", + "StartCommand": "python server.py", + "Port": "8080", + "RuntimeEnvironmentVariables": [ + { + "NAME": "Jane" + } + ] + } + } + } + }, + "InstanceConfiguration": { + "CPU": "1 vCPU", + "Memory": "3 GB" + } + } + +Output:: + + { + "OperationId": "17fe9f55-7e91-4097-b243-fcabbb69a4cf", + "Service": { + "CreatedAt": "2020-11-20T19:05:25Z", + "UpdatedAt": "2020-11-20T19:05:25Z", + "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", + "ServiceId": "8fe1e10304f84fd2b0df550fe98a71fa", + "ServiceName": "python-app", + "ServiceUrl": "psbqam834h.us-east-1.awsapprunner.com", + "SourceConfiguration": { + "AuthenticationConfiguration": { + "ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-connection/e7656250f67242d7819feade6800f59e" + }, + "AutoDeploymentsEnabled": true, + "CodeRepository": { + "CodeConfiguration": { + "CodeConfigurationValues": { + "BuildCommand": "pip install -r requirements.txt", + "Port": "8080", + "Runtime": "PYTHON_3", + "RuntimeEnvironmentVariables": [ + { + "NAME": "Jane" + } + ], + "StartCommand": "python server.py" + }, + "ConfigurationSource": "Api" + }, + "RepositoryUrl": "https://github.com/my-account/python-hello", + "SourceCodeVersion": { + "Type": "BRANCH", + "Value": "main" + } + } + }, + "Status": "OPERATION_IN_PROGRESS", + "InstanceConfiguration": { + "CPU": "1 vCPU", + "Memory": "3 GB" + } + } + } + +**Example 2: To create a source code repository service** + +The following ``create-service`` example creates an App Runner service based on a Python source code repository. :: + + aws apprunner create-service \ + --cli-input-json file://input.json + +Contents of ``input.json``:: + + { + "ServiceName": "python-app", + "SourceConfiguration": { + "AuthenticationConfiguration": { + "ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-connection/e7656250f67242d7819feade6800f59e" + }, + "AutoDeploymentsEnabled": true, + "CodeRepository": { + "RepositoryUrl": "https://github.com/my-account/python-hello", + "SourceCodeVersion": { + "Type": "BRANCH", + "Value": "main" + }, + "CodeConfiguration": { + "ConfigurationSource": "API", + "CodeConfigurationValues": { + "Runtime": "PYTHON_3", + "BuildCommand": "pip install -r requirements.txt", + "StartCommand": "python server.py", + "Port": "8080", + "RuntimeEnvironmentVariables": [ + { + "NAME": "Jane" + } + ] + } + } + } + }, + "InstanceConfiguration": { + "CPU": "1 vCPU", + "Memory": "3 GB" + } + } + +Output:: + + { + "OperationId": "17fe9f55-7e91-4097-b243-fcabbb69a4cf", + "Service": { + "CreatedAt": "2020-11-20T19:05:25Z", + "UpdatedAt": "2020-11-20T19:05:25Z", + "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", + "ServiceId": "8fe1e10304f84fd2b0df550fe98a71fa", + "ServiceName": "python-app", + "ServiceUrl": "psbqam834h.us-east-1.awsapprunner.com", + "SourceConfiguration": { + "AuthenticationConfiguration": { + "ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-connection/e7656250f67242d7819feade6800f59e" + }, + "AutoDeploymentsEnabled": true, + "CodeRepository": { + "CodeConfiguration": { + "CodeConfigurationValues": { + "BuildCommand": "pip install -r requirements.txt", + "Port": "8080", + "Runtime": "PYTHON_3", + "RuntimeEnvironmentVariables": [ + { + "NAME": "Jane" + } + ], + "StartCommand": "python server.py" + }, + "ConfigurationSource": "Api" + }, + "RepositoryUrl": "https://github.com/my-account/python-hello", + "SourceCodeVersion": { + "Type": "BRANCH", + "Value": "main" + } + } + }, + "Status": "OPERATION_IN_PROGRESS", + "InstanceConfiguration": { + "CPU": "1 vCPU", + "Memory": "3 GB" + } + } + } + +**Example 3: To create a source image repository service** + +The following ``create-service`` example creates an App Runner service based on an image stored in Elastic Container Registry (ECR). :: + + aws apprunner create-service \ + --cli-input-json file://input.json + +Contents of ``input.json``:: + + { + "ServiceName": "golang-container-app", + "SourceConfiguration": { + "AuthenticationConfiguration": { + "AccessRoleArn": "arn:aws:iam::123456789012:role/my-ecr-role" + }, + "AutoDeploymentsEnabled": true, + "ImageRepository": { + "ImageIdentifier": "123456789012.dkr.ecr.us-east-1.amazonaws.com/golang-app:latest", + "ImageConfiguration": { + "Port": "8080", + "RuntimeEnvironmentVariables": [ + { + "NAME": "Jane" + } + ] + }, + "ImageRepositoryType": "ECR" + } + }, + "InstanceConfiguration": { + "CPU": "1 vCPU", + "Memory": "3 GB" + } + } + +Output:: + + { + "OperationId": "17fe9f55-7e91-4097-b243-fcabbb69a4cf", + "Service": { + "CreatedAt": "2020-11-06T23:15:30Z", + "UpdatedAt": "2020-11-06T23:15:30Z", + "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/golang-container-app/51728f8a20ce46d39b25398a6c8e9d1a", + "ServiceId": "51728f8a20ce46d39b25398a6c8e9d1a", + "ServiceName": "golang-container-app", + "ServiceUrl": "psbqam834h.us-east-1.awsapprunner.com", + "SourceConfiguration": { + "AuthenticationConfiguration": { + "AccessRoleArn": "arn:aws:iam::123456789012:role/my-ecr-role" + }, + "AutoDeploymentsEnabled": true, + "ImageRepository": { + "ImageIdentifier": "123456789012.dkr.ecr.us-east-1.amazonaws.com/golang-app:latest", + "ImageConfiguration": { + "Port": "8080", + "RuntimeEnvironmentVariables": [ + { + "NAME": "Jane" + } + ] + }, + "ImageRepositoryType": "ECR" + } + }, + "Status": "OPERATION_IN_PROGRESS", + "InstanceConfiguration": { + "CPU": "1 vCPU", + "Memory": "3 GB" + } + } + } diff -Nru awscli-1.21.9/awscli/examples/apprunner/delete-auto-scaling-configuration.rst awscli-1.22.34/awscli/examples/apprunner/delete-auto-scaling-configuration.rst --- awscli-1.21.9/awscli/examples/apprunner/delete-auto-scaling-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/apprunner/delete-auto-scaling-configuration.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,66 @@ +**Example 1: To delete the latest active revision of an auto scaling configuration** + +The following ``delete-auto-scaling-configuration`` example deletes the latest active revision of an App Runner auto scaling configuration. +To delete the latest active revision, specify an Amazon Resource Name (ARN) that ends with the configuration name, without the revision component. + +In the example, two revisions exist before this action. Therefore, revision 2 (the latest) is deleted. +However, it now shows ``"Latest": false``, because, after being deleted, it isn't the latest active revision anymore. :: + + aws apprunner delete-auto-scaling-configuration \ + --cli-input-json file://input.json + +Contents of ``input.json``:: + + { + "AutoScalingConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability" + } + +Output:: + + { + "AutoScalingConfiguration": { + "AutoScalingConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/2/e76562f50d78042e819fead0f59672e6", + "AutoScalingConfigurationName": "high-availability", + "AutoScalingConfigurationRevision": 2, + "CreatedAt": "2021-02-25T17:42:59Z", + "DeletedAt": "2021-03-02T08:07:06Z", + "Latest": false, + "Status": "INACTIVE", + "MaxConcurrency": 30, + "MaxSize": 90, + "MinSize": 5 + } + } + +**Example 2: To delete a specific revision of an auto scaling configuration** + +The following ``delete-auto-scaling-configuration`` example deletes a specific revision of an App Runner auto scaling configuration. +To delete a specific revision, specify an ARN that includes the revision number. + +In the example, several revisions exist before this action. The action deletes revision ``1``. :: + + aws apprunner delete-auto-scaling-configuration \ + --cli-input-json file://input.json + +Contents of ``input.json``:: + + { + "AutoScalingConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/1" + } + +Output:: + + { + "AutoScalingConfiguration": { + "AutoScalingConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/1/2f50e7656d7819fead0f59672e68042e", + "AutoScalingConfigurationName": "high-availability", + "AutoScalingConfigurationRevision": 1, + "CreatedAt": "2020-11-03T00:29:17Z", + "DeletedAt": "2021-03-02T08:07:06Z", + "Latest": false, + "Status": "INACTIVE", + "MaxConcurrency": 100, + "MaxSize": 50, + "MinSize": 5 + } + } diff -Nru awscli-1.21.9/awscli/examples/apprunner/delete-connection.rst awscli-1.22.34/awscli/examples/apprunner/delete-connection.rst --- awscli-1.21.9/awscli/examples/apprunner/delete-connection.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/apprunner/delete-connection.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,26 @@ +**To delete a connection** + +The following ``delete-connection`` example deletes an App Runner connection. +The connection status after a successful call is ``DELETED``. +This is because the connection is no longer available. :: + + aws apprunner delete-connection \ + --cli-input-json file://input.json + +Contents of ``input.json``:: + + { + "ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-connection" + } + +Output:: + + { + "Connection": { + "ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-connection", + "ConnectionName": "my-github-connection", + "Status": "DELETED", + "CreatedAt": "2020-11-03T00:32:51Z", + "ProviderType": "GITHUB" + } + } diff -Nru awscli-1.21.9/awscli/examples/apprunner/delete-service.rst awscli-1.22.34/awscli/examples/apprunner/delete-service.rst --- awscli-1.21.9/awscli/examples/apprunner/delete-service.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/apprunner/delete-service.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,58 @@ +**To delete a service** + +The following ``delete-service`` example deletes an App Runner service. :: + + aws apprunner delete-service \ + --cli-input-json file://input.json + +Contents of ``input.json``:: + + { + "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa" + } + +Output:: + + { + "OperationId": "17fe9f55-7e91-4097-b243-fcabbb69a4cf", + "Service": { + "CreatedAt": "2020-11-20T19:05:25Z", + "UpdatedAt": "2020-11-20T19:05:25Z", + "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", + "ServiceId": "8fe1e10304f84fd2b0df550fe98a71fa", + "ServiceName": "python-app", + "ServiceUrl": "psbqam834h.us-east-1.awsapprunner.com", + "SourceConfiguration": { + "AuthenticationConfiguration": { + "ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-connection/e7656250f67242d7819feade6800f59e" + }, + "AutoDeploymentsEnabled": true, + "CodeRepository": { + "CodeConfiguration": { + "CodeConfigurationValues": { + "BuildCommand": "pip install -r requirements.txt", + "Port": "8080", + "Runtime": "PYTHON_3", + "RuntimeEnvironmentVariables": [ + { + "NAME": "Jane" + } + ], + "StartCommand": "python server.py" + }, + "ConfigurationSource": "Api" + }, + "RepositoryUrl": "https://github.com/my-account/python-hello", + "SourceCodeVersion": { + "Type": "BRANCH", + "Value": "main" + } + } + }, + "Status": "OPERATION_IN_PROGRESS", + "InstanceConfiguration": { + "CPU": "1 vCPU", + "Memory": "3 GB" + } + } + } diff -Nru awscli-1.21.9/awscli/examples/apprunner/describe-auto-scaling-configuration.rst awscli-1.22.34/awscli/examples/apprunner/describe-auto-scaling-configuration.rst --- awscli-1.21.9/awscli/examples/apprunner/describe-auto-scaling-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/apprunner/describe-auto-scaling-configuration.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,61 @@ +**Example 1: To describe the latest active revision of an auto scaling configuration** + +The following ``describe-auto-scaling-configuration`` example gets a description of the latest active revision of an App Runner auto scaling configuration. To describe the latest active revision, specify an ARN that ends with the configuration name, without the revision component. + +In the example, two revisions exist. Therefore, revision ``2`` (the latest) is described. The resulting object shows ``"Latest": true``. :: + + aws apprunner describe-auto-scaling-configuration \ + --cli-input-json file://input.json + +Contents of ``input.json``:: + + { + "AutoScalingConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability" + } + +Output:: + + { + "AutoScalingConfiguration": { + "AutoScalingConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/2/e76562f50d78042e819fead0f59672e6", + "AutoScalingConfigurationName": "high-availability", + "AutoScalingConfigurationRevision": 2, + "CreatedAt": "2021-02-25T17:42:59Z", + "Latest": true, + "Status": "ACTIVE", + "MaxConcurrency": 30, + "MaxSize": 90, + "MinSize": 5 + } + } + +**Example 2: To describe a specific revision of an auto scaling configuration** + +The following ``describe-auto-scaling-configuration`` example get a description of a specific revision of an App Runner auto scaling configuration. To describe a specific revision, specify an ARN that includes the revision number. + +In the example, several revisions exist and revision ``1`` is queried. The resulting object shows ``"Latest": false``. :: + + aws apprunner describe-auto-scaling-configuration \ + --cli-input-json file://input.json + +Contents of ``input.json``:: + + { + "AutoScalingConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/1" + } + +Output:: + + { + "AutoScalingConfiguration": { + "AutoScalingConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/1/2f50e7656d7819fead0f59672e68042e", + "AutoScalingConfigurationName": "high-availability", + "AutoScalingConfigurationRevision": 1, + "CreatedAt": "2020-11-03T00:29:17Z", + "Latest": false, + "Status": "ACTIVE", + "MaxConcurrency": 100, + "MaxSize": 50, + "MinSize": 5 + } + } diff -Nru awscli-1.21.9/awscli/examples/apprunner/describe-custom-domains.rst awscli-1.22.34/awscli/examples/apprunner/describe-custom-domains.rst --- awscli-1.21.9/awscli/examples/apprunner/describe-custom-domains.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/apprunner/describe-custom-domains.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,55 @@ +**To get descriptions of custom domain names associated with a service** + +The following ``describe-custom-domains`` example get descriptions and status of the custom domain names associated with an App Runner service. :: + + aws apprunner describe-custom-domains \ + --cli-input-json file://input.json + +Contents of ``input.json``:: + + { + "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", + "DomainName": "example.com", + "EnableWWWSubdomain": true + } + +Output:: + + { + "CustomDomains": [ + { + "CertificateValidationRecords": [ + { + "Name": "_70d3f50a94f7c72dc28784cf55db2f6b.example.com", + "Status": "PENDING_VALIDATION", + "Type": "CNAME", + "Value": "_1270c137383c6307b6832db02504c4b0.bsgbmzkfwj.acm-validations.aws." + }, + { + "Name": "_287870d3f50a94f7c72dc4cf55db2f6b.www.example.com", + "Status": "PENDING_VALIDATION", + "Type": "CNAME", + "Value": "_832db01270c137383c6307b62504c4b0.mzkbsgbfwj.acm-validations.aws." + } + ], + "DomainName": "example.com", + "EnableWWWSubdomain": true, + "Status": "PENDING_CERTIFICATE_DNS_VALIDATION" + }, + { + "CertificateValidationRecords": [ + { + "Name": "_a94f784c70d3f507c72dc28f55db2f6b.deals.example.com", + "Status": "SUCCESS", + "Type": "CNAME", + "Value": "_2db02504c1270c137383c6307b6834b0.bsgbmzkfwj.acm-validations.aws." + } + ], + "DomainName": "deals.example.com", + "EnableWWWSubdomain": false, + "Status": "ACTIVE" + } + ], + "DNSTarget": "psbqam834h.us-east-1.awsapprunner.com", + "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa" + } diff -Nru awscli-1.21.9/awscli/examples/apprunner/describe-service.rst awscli-1.22.34/awscli/examples/apprunner/describe-service.rst --- awscli-1.21.9/awscli/examples/apprunner/describe-service.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/apprunner/describe-service.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,57 @@ +**To describe a service** + +The following ``describe-service`` example gets a description of an App Runner service. :: + + aws apprunner describe-service \ + --cli-input-json file://input.json + +Contents of ``input.json``:: + + { + "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa" + } + +Output:: + + { + "Service": { + "CreatedAt": "2020-11-20T19:05:25Z", + "UpdatedAt": "2020-11-20T19:05:25Z", + "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", + "ServiceId": "8fe1e10304f84fd2b0df550fe98a71fa", + "ServiceName": "python-app", + "ServiceUrl": "psbqam834h.us-east-1.awsapprunner.com", + "SourceConfiguration": { + "AuthenticationConfiguration": { + "ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-connection/e7656250f67242d7819feade6800f59e" + }, + "AutoDeploymentsEnabled": true, + "CodeRepository": { + "CodeConfiguration": { + "CodeConfigurationValues": { + "BuildCommand": "pip install -r requirements.txt", + "Port": "8080", + "Runtime": "PYTHON_3", + "RuntimeEnvironmentVariables": [ + { + "NAME": "Jane" + } + ], + "StartCommand": "python server.py" + }, + "ConfigurationSource": "Api" + }, + "RepositoryUrl": "https://github.com/my-account/python-hello", + "SourceCodeVersion": { + "Type": "BRANCH", + "Value": "main" + } + } + }, + "Status": "RUNNING", + "InstanceConfiguration": { + "CPU": "1 vCPU", + "Memory": "3 GB" + } + } + } diff -Nru awscli-1.21.9/awscli/examples/apprunner/disassociate-custom-domain.rst awscli-1.22.34/awscli/examples/apprunner/disassociate-custom-domain.rst --- awscli-1.21.9/awscli/examples/apprunner/disassociate-custom-domain.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/apprunner/disassociate-custom-domain.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,40 @@ +**To disassociate a domain name from a service** + +The following ``disassociate-custom-domain`` example disassociates the domain ``example.com`` from an App Runner service. +The call also disassociates the subdomain ``www.example.com`` that was associated together with the root domain. :: + + aws apprunner disassociate-custom-domain \ + --cli-input-json file://input.json + +Contents of ``input.json``:: + + { + "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", + "DomainName": "example.com" + } + +Output:: + + { + "CustomDomain": { + "CertificateValidationRecords": [ + { + "Name": "_70d3f50a94f7c72dc28784cf55db2f6b.example.com", + "Status": "PENDING_VALIDATION", + "Type": "CNAME", + "Value": "_1270c137383c6307b6832db02504c4b0.bsgbmzkfwj.acm-validations.aws." + }, + { + "Name": "_287870d3f50a94f7c72dc4cf55db2f6b.www.example.com", + "Status": "PENDING_VALIDATION", + "Type": "CNAME", + "Value": "_832db01270c137383c6307b62504c4b0.mzkbsgbfwj.acm-validations.aws." + } + ], + "DomainName": "example.com", + "EnableWWWSubdomain": true, + "Status": "DELETING" + }, + "DNSTarget": "psbqam834h.us-east-1.awsapprunner.com", + "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa" + } diff -Nru awscli-1.21.9/awscli/examples/apprunner/list-auto-scaling-configurations.rst awscli-1.22.34/awscli/examples/apprunner/list-auto-scaling-configurations.rst --- awscli-1.21.9/awscli/examples/apprunner/list-auto-scaling-configurations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/apprunner/list-auto-scaling-configurations.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,33 @@ +**To get a paginated listing of App Runner auto scaling configurations** + +The following ``list-auto-scaling-configurations`` example lists all App Runner auto scaling configurations in your AWS account. +Up to five auto scaling configurations are listed in each response. ``AutoScalingConfigurationName`` and ``LatestOnly`` aren't specified. +Their defaults cause the latest revision of all active configurations to be listed. + +In this example, the response includes two results and there aren't additional ones, so no ``NextToken`` is returned. :: + + aws apprunner list-auto-scaling-configurations \ + --cli-input-json file://input.json + +Contents of ``input.json``:: + + { + "MaxResults": 5 + } + +Output:: + + { + "AutoScalingConfigurationSummaryList": [ + { + "AutoScalingConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/2/e76562f50d78042e819fead0f59672e6", + "AutoScalingConfigurationName": "high-availability", + "AutoScalingConfigurationRevision": 2 + }, + { + "AutoScalingConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/low-cost/1/50d7804e7656fead0f59672e62f2e819", + "AutoScalingConfigurationName": "low-cost", + "AutoScalingConfigurationRevision": 1 + } + ] + } diff -Nru awscli-1.21.9/awscli/examples/apprunner/list-connections.rst awscli-1.22.34/awscli/examples/apprunner/list-connections.rst --- awscli-1.21.9/awscli/examples/apprunner/list-connections.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/apprunner/list-connections.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,53 @@ +**Example 1: To list all connections** + +The following ``list-connections`` example lists all App Runner connections in the AWS account. :: + + aws apprunner list-connections + +Output:: + + { + "ConnectionSummaryList": [ + { + "ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-connection", + "ConnectionName": "my-github-connection", + "Status": "AVAILABLE", + "CreatedAt": "2020-11-03T00:32:51Z", + "ProviderType": "GITHUB" + }, + { + "ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-org-connection", + "ConnectionName": "my-github-org-connection", + "Status": "AVAILABLE", + "CreatedAt": "2020-11-03T02:54:17Z", + "ProviderType": "GITHUB" + } + ] + } + +**Example 2: To list a connection by name** + +The following ``list-connections`` example lists a connection by its name. :: + + aws apprunner list-connections \ + --cli-input-json file://input.json + +Contents of ``input.json``:: + + { + "ConnectionName": "my-github-org-connection" + } + +Output:: + + { + "ConnectionSummaryList": [ + { + "ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-org-connection", + "ConnectionName": "my-github-org-connection", + "Status": "AVAILABLE", + "CreatedAt": "2020-11-03T02:54:17Z", + "ProviderType": "GITHUB" + } + ] + } diff -Nru awscli-1.21.9/awscli/examples/apprunner/list-operations.rst awscli-1.22.34/awscli/examples/apprunner/list-operations.rst --- awscli-1.21.9/awscli/examples/apprunner/list-operations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/apprunner/list-operations.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,29 @@ +**To list operations that occurred on a servicee** + +The following ``list-operations`` example lists all operations that occurred on an App Runner service so far. +In this example, the service is new and only a single operation of type ``CREATE_SERVICE`` has occurred. :: + + aws apprunner list-operations \ + --cli-input-json file://input.json + +Contents of ``input.json``:: + + { + "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa" + } + +Output:: + + { + "OperationSummaryList": [ + { + "EndedAt": 1606156217, + "Id": "17fe9f55-7e91-4097-b243-fcabbb69a4cf", + "StartedAt": 1606156014, + "Status": "SUCCEEDED", + "TargetArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", + "Type": "CREATE_SERVICE", + "UpdatedAt": 1606156217 + } + ] + } diff -Nru awscli-1.21.9/awscli/examples/apprunner/list-services.rst awscli-1.22.34/awscli/examples/apprunner/list-services.rst --- awscli-1.21.9/awscli/examples/apprunner/list-services.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/apprunner/list-services.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,40 @@ +**To get a paginated listing of App Runner services** + +The following ``list-services`` example lists all App Runner services in the AWS account. Up to two services are listed in each response. +This example shows the first request. The response includes two results and a token that can be used in the next request. +When a subsequent response doesn't include a token, all services have been listed. :: + + aws apprunner list-services \ + --cli-input-json file://input.json + +Contents of ``input.json``:: + + { + "MaxResults": 2 + } + +Output:: + + { + "NextToken": "eyJDdXN0b21lckFjY291bnRJZCI6IjI3MDIwNTQwMjg0NSIsIlNlcnZpY2VTdGF0dXNDb2RlIjoiUFJPVklTSU9OSU5HIiwiSGFzaEtleSI6IjI3MDIwNTQwMjg0NSNhYjhmOTRjZmUyOWE0NjBmYjg3NjBhZmQyZWU4NzU1NSJ9", + "ServiceSummaryList": [ + { + "CreatedAt": "2020-11-20T19:05:25Z", + "UpdatedAt": "2020-11-23T12:41:37Z", + "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", + "ServiceId": "8fe1e10304f84fd2b0df550fe98a71fa", + "ServiceName": "python-app", + "ServiceUrl": "psbqam834h.us-east-1.awsapprunner.com", + "Status": "RUNNING" + }, + { + "CreatedAt": "2020-11-06T23:15:30Z", + "UpdatedAt": "2020-11-23T13:21:22Z", + "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/golang-container-app/ab8f94cfe29a460fb8760afd2ee87555", + "ServiceId": "ab8f94cfe29a460fb8760afd2ee87555", + "ServiceName": "golang-container-app", + "ServiceUrl": "e2m8rrrx33.us-east-1.awsapprunner.com", + "Status": "RUNNING" + } + ] + } diff -Nru awscli-1.21.9/awscli/examples/apprunner/list-tags-for-resource.rst awscli-1.22.34/awscli/examples/apprunner/list-tags-for-resource.rst --- awscli-1.21.9/awscli/examples/apprunner/list-tags-for-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/apprunner/list-tags-for-resource.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,27 @@ +**To list tags associated with an App Runner service** + +The following ``list-tags-for-resource`` example lists all the tags that are associated with an App Runner service. :: + + aws apprunner list-tags-for-resource \ + --cli-input-json file://input.json + +Contents of ``input.json``:: + + { + "ResourceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa" + } + +Output:: + + { + "Tags": [ + { + "Key": "Department", + "Value": "Retail" + }, + { + "Key": "CustomerId", + "Value": "56439872357912" + } + ] + } diff -Nru awscli-1.21.9/awscli/examples/apprunner/pause-service.rst awscli-1.22.34/awscli/examples/apprunner/pause-service.rst --- awscli-1.21.9/awscli/examples/apprunner/pause-service.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/apprunner/pause-service.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,58 @@ +**To pause a service** + +The following ``pause-service`` example pauses an App Runner service. :: + + aws apprunner pause-service \ + --cli-input-json file://input.json + +Contents of ``input.json``:: + + { + "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa" + } + +Output:: + + { + "OperationId": "17fe9f55-7e91-4097-b243-fcabbb69a4cf", + "Service": { + "CreatedAt": "2020-11-20T19:05:25Z", + "UpdatedAt": "2020-11-23T12:41:37Z", + "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", + "ServiceId": "8fe1e10304f84fd2b0df550fe98a71fa", + "ServiceName": "python-app", + "ServiceUrl": "psbqam834h.us-east-1.awsapprunner.com", + "SourceConfiguration": { + "AuthenticationConfiguration": { + "ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-connection/e7656250f67242d7819feade6800f59e" + }, + "AutoDeploymentsEnabled": true, + "CodeRepository": { + "CodeConfiguration": { + "CodeConfigurationValues": { + "BuildCommand": "pip install -r requirements.txt", + "Port": "8080", + "Runtime": "PYTHON_3", + "RuntimeEnvironmentVariables": [ + { + "NAME": "Jane" + } + ], + "StartCommand": "python server.py" + }, + "ConfigurationSource": "Api" + }, + "RepositoryUrl": "https://github.com/my-account/python-hello", + "SourceCodeVersion": { + "Type": "BRANCH", + "Value": "main" + } + } + }, + "Status": "OPERATION_IN_PROGRESS", + "InstanceConfiguration": { + "CPU": "1 vCPU", + "Memory": "3 GB" + } + } + } diff -Nru awscli-1.21.9/awscli/examples/apprunner/resume-service.rst awscli-1.22.34/awscli/examples/apprunner/resume-service.rst --- awscli-1.21.9/awscli/examples/apprunner/resume-service.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/apprunner/resume-service.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,58 @@ +**To resume a service** + +The following ``resume-service`` example resumes an App Runner service. :: + + aws apprunner resume-service \ + --cli-input-json file://input.json + +Contents of ``input.json``:: + + { + "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa" + } + +Output:: + + { + "OperationId": "17fe9f55-7e91-4097-b243-fcabbb69a4cf", + "Service": { + "CreatedAt": "2020-11-20T19:05:25Z", + "UpdatedAt": "2020-11-23T12:41:37Z", + "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", + "ServiceId": "8fe1e10304f84fd2b0df550fe98a71fa", + "ServiceName": "python-app", + "ServiceUrl": "psbqam834h.us-east-1.awsapprunner.com", + "SourceConfiguration": { + "AuthenticationConfiguration": { + "ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-connection/e7656250f67242d7819feade6800f59e" + }, + "AutoDeploymentsEnabled": true, + "CodeRepository": { + "CodeConfiguration": { + "CodeConfigurationValues": { + "BuildCommand": "pip install -r requirements.txt", + "Port": "8080", + "Runtime": "PYTHON_3", + "RuntimeEnvironmentVariables": [ + { + "NAME": "Jane" + } + ], + "StartCommand": "python server.py" + }, + "ConfigurationSource": "Api" + }, + "RepositoryUrl": "https://github.com/my-account/python-hello", + "SourceCodeVersion": { + "Type": "BRANCH", + "Value": "main" + } + } + }, + "Status": "OPERATION_IN_PROGRESS", + "InstanceConfiguration": { + "CPU": "1 vCPU", + "Memory": "3 GB" + } + } + } \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/apprunner/start-deployment.rst awscli-1.22.34/awscli/examples/apprunner/start-deployment.rst --- awscli-1.21.9/awscli/examples/apprunner/start-deployment.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/apprunner/start-deployment.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,18 @@ +**To initiate a manual deployment** + +The following ``start-deployment`` example performs a manual deployment to an App Runner service. :: + + aws apprunner start-deployment \ + --cli-input-json file://input.json + +Contents of ``input.json``:: + + { + "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa" + } + +Output:: + + { + "OperationId": "853a7d5b-fc9f-4730-831b-fd8037ab832a" + } \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/apprunner/tag-resource.rst awscli-1.22.34/awscli/examples/apprunner/tag-resource.rst --- awscli-1.21.9/awscli/examples/apprunner/tag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/apprunner/tag-resource.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,24 @@ +**To add tags to an App Runner service** + +The following ``tag-resource`` example adds two tags to an App Runner service. :: + + aws apprunner tag-resource \ + --cli-input-json file://input.json + +Contents of ``input.json``:: + + { + "ResourceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", + "Tags": [ + { + "Key": "Department", + "Value": "Retail" + }, + { + "Key": "CustomerId", + "Value": "56439872357912" + } + ] + } + +This command produces no output. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/apprunner/untag-resource.rst awscli-1.22.34/awscli/examples/apprunner/untag-resource.rst --- awscli-1.21.9/awscli/examples/apprunner/untag-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/apprunner/untag-resource.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,18 @@ +**To remove tags from an App Runner service** + +The following ``untag-resource`` example removes two tags from an App Runner service. :: + + aws apprunner untag-resource \ + --cli-input-json file://input.json + +Contents of ``input.json``:: + + { + "ResourceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", + "TagKeys": [ + "Department", + "CustomerId" + ] + } + +This command produces no output. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/apprunner/update-service.rst awscli-1.22.34/awscli/examples/apprunner/update-service.rst --- awscli-1.21.9/awscli/examples/apprunner/update-service.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/apprunner/update-service.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,64 @@ +**To update memory size** + +The following ``update-service`` example updates the memory size of instances (scaling units) of an App Runner service to 2048 MiB. + +When the call succeeds, App Runner starts an asynchronous update process. +The ``Service`` structure that's returned by the call reflects the new memory value that's being applied by this call. :: + + aws apprunner update-service \ + --cli-input-json file://input.json + +Contents of ``input.json``:: + + { + "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", + "InstanceConfiguration": { + "Memory": "4 GB" + } + } + +Output:: + + { + "OperationId": "17fe9f55-7e91-4097-b243-fcabbb69a4cf", + "Service": { + "CreatedAt": "2020-11-20T19:05:25Z", + "UpdatedAt": "2020-11-23T12:41:37Z", + "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", + "ServiceId": "8fe1e10304f84fd2b0df550fe98a71fa", + "ServiceName": "python-app", + "ServiceUrl": "psbqam834h.us-east-1.awsapprunner.com", + "SourceConfiguration": { + "AuthenticationConfiguration": { + "ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-connection/e7656250f67242d7819feade6800f59e" + }, + "AutoDeploymentsEnabled": true, + "CodeRepository": { + "CodeConfiguration": { + "CodeConfigurationValues": { + "BuildCommand": "pip install -r requirements.txt", + "Port": "8080", + "Runtime": "PYTHON_3", + "RuntimeEnvironmentVariables": [ + { + "NAME": "Jane" + } + ], + "StartCommand": "python server.py" + }, + "ConfigurationSource": "Api" + }, + "RepositoryUrl": "https://github.com/my-account/python-hello", + "SourceCodeVersion": { + "Type": "BRANCH", + "Value": "main" + } + } + }, + "Status": "OPERATION_IN_PROGRESS", + "InstanceConfiguration": { + "CPU": "1 vCPU", + "Memory": "4 GB" + } + } + } diff -Nru awscli-1.21.9/awscli/examples/cloudcontrol/create-resource.rst awscli-1.22.34/awscli/examples/cloudcontrol/create-resource.rst --- awscli-1.21.9/awscli/examples/cloudcontrol/create-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/cloudcontrol/create-resource.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,22 @@ +**To create a resource** + +The following ``create-resource`` example creates an AWS::Kinesis::Stream resource, named ResourceExample, with a retention period of 168 hours and a shard count of three. :: + + aws cloudcontrol create-resource \ + --type-name AWS::Kinesis::Stream \ + --desired-state "{\"Name\": \"ResourceExample\",\"RetentionPeriodHours\":168, \"ShardCount\":3}" + +Output:: + + { + "ProgressEvent": { + "EventTime": 1632506656.706, + "TypeName": "AWS::Kinesis::Stream", + "OperationStatus": "IN_PROGRESS", + "Operation": "CREATE", + "Identifier": "ResourceExample", + "RequestToken": "20999d87-e304-4725-ad84-832dcbfd7fc5" + } + } + +For more information, see `Creating a resource `__ in the *Cloud Control API User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/cloudcontrol/delete-resource.rst awscli-1.22.34/awscli/examples/cloudcontrol/delete-resource.rst --- awscli-1.21.9/awscli/examples/cloudcontrol/delete-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/cloudcontrol/delete-resource.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,22 @@ +**To delete a resource** + +The following ``delete-resource`` example deletes a AWS::Kinesis::Stream resource with the identifier ResourceExample from your AWS account. :: + + aws cloudcontrol delete-resource \ + --type-name AWS::Kinesis::Stream \ + --identifier ResourceExample + +Output:: + + { + "ProgressEvent": { + "TypeName": "AWS::Kinesis::Stream", + "Identifier": "ResourceExample", + "RequestToken": "e48f26ff-d0f9-4ab8-a878-120db1edf111", + "Operation": "DELETE", + "OperationStatus": "IN_PROGRESS", + "EventTime": 1632950300.14 + } + } + +For more information, see `Deleting a resource `__ in the *Cloud Control API User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/cloudcontrol/get-resource-request-status.rst awscli-1.22.34/awscli/examples/cloudcontrol/get-resource-request-status.rst --- awscli-1.21.9/awscli/examples/cloudcontrol/get-resource-request-status.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/cloudcontrol/get-resource-request-status.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,23 @@ +**To get the status information of a resource request** + +The following ``get-resource-request-status`` example returns status information about the specified resource request. :: + + aws cloudcontrol get-resource-request-status \ + --request-token "e1a6b86e-46bd-41ac-bfba-001234567890" + +Output:: + + { + "ProgressEvent": { + "TypeName": "AWS::Kinesis::Stream", + "Identifier": "Demo", + "RequestToken": "e1a6b86e-46bd-41ac-bfba-001234567890", + "Operation": "CREATE", + "OperationStatus": "FAILED", + "EventTime": 1632950268.481, + "StatusMessage": "Resource of type 'AWS::Kinesis::Stream' with identifier 'Demo' already exists.", + "ErrorCode": "AlreadyExists" + } + } + +For more information, see `Managing resource operation requests `__ in the *Cloud Control API User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/cloudcontrol/get-resource.rst awscli-1.22.34/awscli/examples/cloudcontrol/get-resource.rst --- awscli-1.21.9/awscli/examples/cloudcontrol/get-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/cloudcontrol/get-resource.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,19 @@ +**To get the current state of a resource** + +The following ``get-resource`` example returns the current state of the AWS::Kinesis::Stream resource named ResourceExample. :: + + aws cloudcontrol get-resource \ + --type-name AWS::Kinesis::Stream \ + --identifier ResourceExample + +Output:: + + { + "TypeName": "AWS::Kinesis::Stream", + "ResourceDescription": { + "Identifier": "ResourceExample", + "Properties": "{\"Arn\":\"arn:aws:kinesis:us-west-2:099908667365:stream/ResourceExample\",\"RetentionPeriodHours\":168,\"Name\":\"ResourceExample\",\"ShardCount\":3}" + } + } + +For more information, see `Reading a resource's current state `__ in the *Cloud Control API User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/cloudcontrol/list-resource-requests.rst awscli-1.22.34/awscli/examples/cloudcontrol/list-resource-requests.rst --- awscli-1.21.9/awscli/examples/cloudcontrol/list-resource-requests.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/cloudcontrol/list-resource-requests.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,25 @@ +**To list the active resource operation requests** + +The following ``list-resource-requests`` example lists the resource requests for CREATE and UPDATE operations that have failed in your AWS account. :: + + aws cloudcontrol list-resource-requests \ + --resource-request-status-filter Operations=CREATE,OperationStatuses=FAILED + +Output:: + + { + "ResourceRequestStatusSummaries": [ + { + "TypeName": "AWS::Kinesis::Stream", + "Identifier": "Demo", + "RequestToken": "e1a6b86e-46bd-41ac-bfba-633abcdfdbd7", + "Operation": "CREATE", + "OperationStatus": "FAILED", + "EventTime": 1632950268.481, + "StatusMessage": "Resource of type 'AWS::Kinesis::Stream' with identifier 'Demo' already exists.", + "ErrorCode": "AlreadyExists" + } + ] + } + +For more information, see `Managing resource operation requests `__ in the *Cloud Control API User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/cloudcontrol/list-resources.rst awscli-1.22.34/awscli/examples/cloudcontrol/list-resources.rst --- awscli-1.21.9/awscli/examples/cloudcontrol/list-resources.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/cloudcontrol/list-resources.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,24 @@ +**To list the resources of a given type** + +The following ``list-resources`` example lists the AWS::Kinesis::Stream resources provisioned in your AWS account. :: + + aws cloudcontrol list-resources \ + --type-name AWS::Kinesis::Stream + +Output:: + + { + "TypeName": "AWS::Kinesis::Stream", + "ResourceDescriptions": [ + { + "Identifier": "MyKinesisStream", + "Properties": "{\"Name\":\"MyKinesisStream\"}" + }, + { + "Identifier": "AnotherStream", + "Properties": "{\"Name\":\"AnotherStream\"}" + } + ] + } + +For more information, see `Discovering resources `__ in the *Cloud Control API User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/cloudcontrol/update-resource.rst awscli-1.22.34/awscli/examples/cloudcontrol/update-resource.rst --- awscli-1.21.9/awscli/examples/cloudcontrol/update-resource.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/cloudcontrol/update-resource.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,23 @@ +**To update the properties of an existing resource** + +The following ``update-resource`` example updates the retention policy of an AWS::Logs::LogGroup resource named ExampleLogGroup to 90 days. :: + + aws cloudcontrol update-resource \ + --type-name AWS::Logs::LogGroup \ + --identifier ExampleLogGroup \ + --patch-document "[{\"op\":\"replace\",\"path\":\"/RetentionInDays\",\"value\":90}]" + +Output:: + + { + "ProgressEvent": { + "EventTime": "2021-08-09T18:17:15.219Z", + "TypeName": "AWS::Logs::LogGroup", + "OperationStatus": "IN_PROGRESS", + "Operation": "UPDATE", + "Identifier": "ExampleLogGroup", + "RequestToken": "5f40c577-3534-4b20-9599-0b0123456789" + } + } + +For more information, see `Updating a resource `__ in the *Cloud Control API User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/cloudformation/activate-type.rst awscli-1.22.34/awscli/examples/cloudformation/activate-type.rst --- awscli-1.21.9/awscli/examples/cloudformation/activate-type.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/cloudformation/activate-type.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,17 @@ +**To activate a type** + +The following ``activate-type`` example activates a public third-party extension, making it available for use in stack templates. :: + + aws cloudformation activate-type \ + --region us-west-2 \ + --type RESOURCE \ + --type-name Example::Test::1234567890abcdef0 \ + --type-name-alias Example::Test::Alias + +Output:: + + { + "Arn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/Example-Test-Alias" + } + +For more information, see `Using the AWS CloudFormation registry `__ in the *AWS CloudFormation User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/cloudformation/batch-describe-type-configurations.rst awscli-1.22.34/awscli/examples/cloudformation/batch-describe-type-configurations.rst --- awscli-1.21.9/awscli/examples/cloudformation/batch-describe-type-configurations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/cloudformation/batch-describe-type-configurations.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,25 @@ +**To batch describe a type configuration** + +The following ``batch-describe-type-configurations`` example configures the data for the type. :: + + aws cloudformation batch-describe-type-configurations \ + --region us-west-2 \ + --type-configuration-identifiers TypeArn="arn:aws:cloudformation:us-west-2:123456789012:type/resource/Example-Test-Type,TypeConfigurationAlias=MyConfiguration" + +Output:: + + { + "Errors": [], + "UnprocessedTypeConfigurations": [], + "TypeConfigurations": [ + { + "Arn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/Example-Test-Type", + "Alias": "MyConfiguration", + "Configuration": "{\n \"Example\": {\n \"ApiKey\": \"examplekey\",\n \"ApplicationKey\": \"examplekey1\",\n \"ApiURL\": \"exampleurl\"\n }\n}", + "LastUpdated": "2021-10-01T15:25:46.210000+00:00", + "TypeArn": "arn:aws:cloudformation:us-east-1:123456789012:type/resource/Example-Test-Type" + } + ] + } + +For more information, see `Using the AWS CloudFormation registry `__ in the *AWS CloudFormation User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/cloudformation/deactivate-type.rst awscli-1.22.34/awscli/examples/cloudformation/deactivate-type.rst --- awscli-1.21.9/awscli/examples/cloudformation/deactivate-type.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/cloudformation/deactivate-type.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,12 @@ +**To deactivate a type** + +The following ``deactivate-type`` example deactivates a public extension that was previously activated in this account and Region. :: + + aws cloudformation deactivate-type \ + --region us-west-2 \ + --type MODULE \ + --type-name Example::Test::Type::MODULE + +This command produces no output. + +For more information, see `Using the AWS CloudFormation registry `__ in the *AWS CloudFormation User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/cloudformation/describe-publisher.rst awscli-1.22.34/awscli/examples/cloudformation/describe-publisher.rst --- awscli-1.21.9/awscli/examples/cloudformation/describe-publisher.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/cloudformation/describe-publisher.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,18 @@ +**To describe a publisher** + +The following ``describe-publisher`` example configures the information for a publisher. :: + + aws cloudformation describe-publisher \ + --region us-west-2 \ + --publisher-id 000q6TfUovXsEMmgKowxDZLlwqr2QUsh + +Output:: + + { + "PublisherId": "000q6TfUovXsEMmgKowxDZLlwqr2QUshd2e75c8c", + "PublisherStatus": "VERIFIED", + "IdentityProvider": "AWS_Marketplace", + "PublisherProfile": "https://aws.amazon.com/marketplace/seller-profile?id=2c5dc1f0-17cd-4259-8e46-822a83gdtegd" + } + +For more information, see `Using the AWS CloudFormation registry `__ in the *AWS CloudFormation User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/cloudformation/list-type-versions.rst awscli-1.22.34/awscli/examples/cloudformation/list-type-versions.rst --- awscli-1.21.9/awscli/examples/cloudformation/list-type-versions.rst 2021-11-02 18:19:30.000000000 +0000 +++ awscli-1.22.34/awscli/examples/cloudformation/list-type-versions.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,33 +1,14 @@ -**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*. +**To list an extension's version** + +The following ``list-type-versions`` example returns summary information about the versions of an extension. :: + + aws cloudformation list-type-versions \ + --endpoint https://example.com \ + --region us-west-2 \ + --type RESOURCE \ + --type-name My::Resource::Example \ + --publisher-id 123456789012 + +This command produces no output. + +For more information, see `Using the AWS CloudFormation registry `__ in the *AWS CloudFormation User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/cloudformation/publish-type.rst awscli-1.22.34/awscli/examples/cloudformation/publish-type.rst --- awscli-1.21.9/awscli/examples/cloudformation/publish-type.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/cloudformation/publish-type.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,16 @@ +**To publish an extension** + +The following ``publish-type`` example publishes the specified extension to the CloudFormation registry as a public extension in this Region. :: + + aws cloudformation publish-type \ + --region us-west-2 \ + --type RESOURCE \ + --type-name Example::Test::1234567890abcdef0 + +Output:: + + { + "PublicTypeArn":"arn:aws:cloudformation:us-west-2::type/resource/000q6TfUovXsEMmgKowxDZLlwqr2QUshd2e75c8c/Example-Test-1234567890abcdef0/1.0.0" + } + +For more information, see `Using the AWS CloudFormation registry `__ in the *AWS CloudFormation User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/cloudformation/register-publisher.rst awscli-1.22.34/awscli/examples/cloudformation/register-publisher.rst --- awscli-1.21.9/awscli/examples/cloudformation/register-publisher.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/cloudformation/register-publisher.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,15 @@ +**To register a publisher** + +The following ``register-publisher`` example registers a publisher and accepts the terms and condition parameter. :: + + aws cloudformation register-publisher \ + --region us-west-2 \ + --accept-terms-and-conditions + +Output:: + + { + "PublisherId": "000q6TfUovXsEMmgKowxDZLlwqr2QUshd2e75c8c" + } + +For more information, see `Using the AWS CloudFormation registry `__ in the *AWS CloudFormation User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/cloudformation/set-type-configuration.rst awscli-1.22.34/awscli/examples/cloudformation/set-type-configuration.rst --- awscli-1.21.9/awscli/examples/cloudformation/set-type-configuration.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/cloudformation/set-type-configuration.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,18 @@ +**To configure data** + +The following ``set-type-configuration`` example specifies the configuration data for a registered CloudFormation extension, in the given account and Region. :: + + aws cloudformation set-type-configuration \ + --region us-west-2 \ + --type RESOURCE \ + --type-name Example::Test::Type \ + --configuration-alias default \ + --configuration "{\"CredentialKey\": \"testUserCredential\"}" + +Output:: + + { + "ConfigurationArn": "arn:aws:cloudformation:us-west-2:123456789012:type-configuration/resource/Example-Test-Type/default" + } + +For more information, see `Using the AWS CloudFormation registry `__ in the *AWS CloudFormation User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/cloudformation/test-type.rst awscli-1.22.34/awscli/examples/cloudformation/test-type.rst --- awscli-1.21.9/awscli/examples/cloudformation/test-type.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/cloudformation/test-type.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,14 @@ +**To test an extension** + +The following ``test-type`` example tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry. :: + + aws cloudformation test-type \ + --arn arn:aws:cloudformation:us-west-2:123456789012:type/resource/Sample-Test-Resource123/00000001 + +Output:: + + { + "TypeVersionArn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/Sample-Test-Resource123/00000001" + } + +For more information, see `Using the AWS CloudFormation registry `__ in the *AWS CloudFormation User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/cloudtrail/lookup-events.rst awscli-1.22.34/awscli/examples/cloudtrail/lookup-events.rst --- awscli-1.21.9/awscli/examples/cloudtrail/lookup-events.rst 2021-11-02 18:19:30.000000000 +0000 +++ awscli-1.22.34/awscli/examples/cloudtrail/lookup-events.rst 2022-01-12 19:04:32.000000000 +0000 @@ -11,7 +11,7 @@ { "EventId": "654ccbc0-ba0d-486a-9076-dbf7274677a7", "Username": "my-session-name", - "EventTime": 1453844532.0, + "EventTime": "2021-11-18T09:41:02-08:00", "CloudTrailEvent": "{\"eventVersion\":\"1.02\",\"userIdentity\":{\"type\":\"AssumedRole\",\"principalId\":\"AROAJIKPFTA72SWU4L7T4:my-session-name\",\"arn\":\"arn:aws:sts::123456789012:assumed-role/my-role/my-session-name\",\"accountId\":\"123456789012\",\"sessionContext\":{\"attributes\":{\"mfaAuthenticated\":\"false\",\"creationDate\":\"2016-01-26T21:42:12Z\"},\"sessionIssuer\":{\"type\":\"Role\",\"principalId\":\"AROAJIKPFTA72SWU4L7T4\",\"arn\":\"arn:aws:iam::123456789012:role/my-role\",\"accountId\":\"123456789012\",\"userName\":\"my-role\"}}},\"eventTime\":\"2016-01-26T21:42:12Z\",\"eventSource\":\"signin.amazonaws.com\",\"eventName\":\"ConsoleLogin\",\"awsRegion\":\"us-east-1\",\"sourceIPAddress\":\"72.21.198.70\",\"userAgent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.111 Safari/537.36\",\"requestParameters\":null,\"responseElements\":{\"ConsoleLogin\":\"Success\"},\"additionalEventData\":{\"MobileVersion\":\"No\",\"MFAUsed\":\"No\"},\"eventID\":\"654ccbc0-ba0d-486a-9076-dbf7274677a7\",\"eventType\":\"AwsConsoleSignIn\",\"recipientAccountId\":\"123456789012\"}", "EventName": "ConsoleLogin", "Resources": [] diff -Nru awscli-1.21.9/awscli/examples/cognito-idp/resend-confirmation-code.rst awscli-1.22.34/awscli/examples/cognito-idp/resend-confirmation-code.rst --- awscli-1.21.9/awscli/examples/cognito-idp/resend-confirmation-code.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/cognito-idp/resend-confirmation-code.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,17 +1,19 @@ -**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 +**To resend a confirmation code** + +The following ``resend-confirmation-code`` example sends a confirmation code to the user ``jane``. :: + + aws cognito-idp resend-confirmation-code \ + --client-id 12a3b456c7de890f11g123hijk \ + --username jane + +Output:: + + { + "CodeDeliveryDetails": { + "Destination": "j***@e***.com", + "DeliveryMedium": "EMAIL", + "AttributeName": "email" + } + } + +For more information, see `Signing up and confirming user accounts `__ in the *Amazon Cognito Developer Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/allocate-address.rst awscli-1.22.34/awscli/examples/ec2/allocate-address.rst --- awscli-1.21.9/awscli/examples/ec2/allocate-address.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/allocate-address.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,31 +1,56 @@ -**Example 1: To allocate an Elastic IP address for EC2-Classic** - -The following ``allocate-address`` example allocates an Elastic IP address to use with an instance in EC2-Classic. :: - - aws ec2 allocate-address - -Output:: - - { - "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": "70.224.234.241", - "AllocationId": "eipalloc-02463d08ceEXAMPLE", - "PublicIpv4Pool": "amazon", - "NetworkBorderGroup": "us-west-2-lax-1", - "Domain": "vpc" - } +**Example 1: To allocate an Elastic IP address from Amazon's address pool** + +The following ``allocate-address`` example allocates an Elastic IP address. Amazon EC2 selects the address from Amazon's address pool. :: + + aws ec2 allocate-address + +Output:: + + { + "PublicIp": "70.224.234.241", + "AllocationId": "eipalloc-01435ba59eEXAMPLE", + "PublicIpv4Pool": "amazon", + "NetworkBorderGroup": "us-west-2", + "Domain": "vpc" + } + +For more information, see `Elastic IP addresses `__ in the *Amazon EC2 User Guide*. + +**Example 2: To allocate an Elastic IP address and associate it with a network border group** + +The following ``allocate-address`` example allocates an Elastic IP address and associates it with the specified network border group. :: + + aws ec2 allocate-address \ + --network-border-group us-west-2-lax-1 + +Output:: + + { + "PublicIp": "70.224.234.241", + "AllocationId": "eipalloc-e03dd489ceEXAMPLE", + "PublicIpv4Pool": "amazon", + "NetworkBorderGroup": "us-west-2-lax-1", + "Domain": "vpc" + } + +For more information, see `Elastic IP addresses `__ in the *Amazon EC2 User Guide*. + +**Example 3: To allocate an Elastic IP address from an address pool that you own** + +The following ``allocate-address`` example allocates an Elastic IP address from an address pool that you have brought to your Amazon Web Services account. Amazon EC2 selects the address from the address pool. :: + + aws ec2 allocate-address \ + --public-ipv4-pool ipv4pool-ec2-1234567890abcdef0 + +Output:: + + { + "AllocationId": "eipalloc-02463d08ceEXAMPLE", + "NetworkBorderGroup": "us-west-2", + "CustomerOwnedIp": "18.218.95.81", + "CustomerOwnedIpv4Pool": "ipv4pool-ec2-1234567890abcdef0", + "Domain": "vpc" + "NetworkBorderGroup": "us-west-2", + } + +For more information, see `Elastic IP addresses `__ in the *Amazon EC2 User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/allocate-ipam-pool-cidr.rst awscli-1.22.34/awscli/examples/ec2/allocate-ipam-pool-cidr.rst --- awscli-1.21.9/awscli/examples/ec2/allocate-ipam-pool-cidr.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/allocate-ipam-pool-cidr.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,28 @@ +**To allocate a CIDR from an IPAM pool** + +The following ``allocate-ipam-pool-cidr`` example allocates a CIDR from an IPAM pool. + +(Linux):: + + aws ec2 allocate-ipam-pool-cidr \ + --ipam-pool-id ipam-pool-0533048da7d823723 \ + --netmask-length 24 + +(Windows):: + + aws ec2 allocate-ipam-pool-cidr ^ + --ipam-pool-id ipam-pool-0533048da7d823723 ^ + --netmask-length 24 + +Output:: + + { + "IpamPoolAllocation": { + "Cidr": "10.0.0.0/24", + "IpamPoolAllocationId": "ipam-pool-alloc-018ecc28043b54ba38e2cd99943cebfbd", + "ResourceType": "custom", + "ResourceOwner": "123456789012" + } + } + +For more information, see `Manually allocate a CIDR to a pool to reserve IP address space `__ in the *Amazon VPC IPAM User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/associate-transit-gateway-multicast-domain.rst awscli-1.22.34/awscli/examples/ec2/associate-transit-gateway-multicast-domain.rst --- awscli-1.21.9/awscli/examples/ec2/associate-transit-gateway-multicast-domain.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/associate-transit-gateway-multicast-domain.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,28 +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*. +**To associate a transit gateway with a multicast domain** + +The following ``associate-transit-gateway-multicast-domain`` example associates the specified subnet and attachment with the specified multicast domain. :: + + aws ec2 associate-transit-gateway-multicast-domain \ + --transit-gateway-multicast-domain-id tgw-mcast-domain-0c4905cef79d6e597 \ + --transit-gateway-attachment-id tgw-attach-028c1dd0f8f5cbe8e \ + --subnet-ids 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 `Managing multicast domains `__ in the *Transit Gateways Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/attach-internet-gateway.rst awscli-1.22.34/awscli/examples/ec2/attach-internet-gateway.rst --- awscli-1.21.9/awscli/examples/ec2/attach-internet-gateway.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/attach-internet-gateway.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,7 +1,11 @@ -**To attach an Internet gateway to your VPC** - -This example attaches the specified Internet gateway to the specified VPC. If the command succeeds, no output is returned. - -Command:: - - aws ec2 attach-internet-gateway --internet-gateway-id igw-c0a643a9 --vpc-id vpc-a01106c2 \ No newline at end of file +**To attach an internet gateway to your VPC** + +The following ``attach-internet-gateway`` example attaches the specified internet gateway to the specific VPC. :: + + aws ec2 attach-internet-gateway \ + --internet-gateway-id igw-0d0fb496b3EXAMPLE \ + --vpc-id vpc-0a60eb65b4EXAMPLE + +This command produces no output. + +For more information, see `Internet gateways `__ in the *Amazon VPC User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/copy-image.rst awscli-1.22.34/awscli/examples/ec2/copy-image.rst --- awscli-1.21.9/awscli/examples/ec2/copy-image.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/copy-image.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,13 +1,35 @@ -**To copy an AMI to another region** - -This example copies the specified AMI from the ``us-east-1`` region to the ``ap-northeast-1`` region. - -Command:: - - aws ec2 copy-image --source-image-id ami-5731123e --source-region us-east-1 --region ap-northeast-1 --name "My server" - -Output:: - - { - "ImageId": "ami-438bea42" - } \ No newline at end of file +**Example 1: To copy an AMI to another Region** + +The following ``copy-image`` example command copies the specified AMI from the ``us-west-2`` Region to the ``us-east-1`` Region and adds a short description. :: + + aws ec2 copy-image \ + --region us-east-1 \ + --source-region us-west-2 \ + --source-image-id ami-066877671789bd71b \ + --description "This is my copied image." + +Output:: + + { + "ImageId": "ami-066877671789bd71b" + } + +For more information, see `Copy an AMI `__ in the *Amazon EC2 User Guide*. + +**Example 2: To copy an AMI to another Region and encrypt the backing snapshot** + +The following ``copy-image`` command copies the specified AMI from the ``us-west-2`` Region to the current Region and encrypts the backing snapshot using the specified KMS key. :: + + aws ec2 copy-image \ + --source-region us-west-2 \ + --source-image-id snap-066877671789bd71b \ + --encrypted \ + --kms-key-id alias/my-kms-key + +Output:: + + { + "ImageId": "ami-066877671789bd71b" + } + +For more information, see `Copy an AMI `__ in the *Amazon EC2 User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/copy-snapshot.rst awscli-1.22.34/awscli/examples/ec2/copy-snapshot.rst --- awscli-1.21.9/awscli/examples/ec2/copy-snapshot.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/copy-snapshot.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,25 +1,35 @@ -**Example 1: To copy a 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. :: - - 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" - } - -**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 \ - --kms-key-id alias/my-cmk +**Example 1: To copy a snapshot to another Region** + +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. :: + + 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" + } + +For more information, see `Copy an Amazon EBS snapshot `__ in the *Amazon EC2 User Guide*. + +**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 KMS key. :: + + aws ec2 copy-snapshot \ + --source-region us-west-2 \ + --source-snapshot-id snap-066877671789bd71b \ + --encrypted \ + --kms-key-id alias/my-kms-key + +Output:: + + { + "SnapshotId": "snap-066877671789bd71b" + } + +For more information, see `Copy an Amazon EBS snapshot `__ in the *Amazon EC2 User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/create-fleet.rst awscli-1.22.34/awscli/examples/ec2/create-fleet.rst --- awscli-1.21.9/awscli/examples/ec2/create-fleet.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/create-fleet.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,156 +1,144 @@ -**To create an EC2 Fleet that launches Spot Instances as the default purchasing model** +**Example 1: 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. +The following ``create-fleet`` 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. +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 - aws ec2 create-fleet --cli-input-json file://file_name.json +Contents of file_name.json:: + + { + "LaunchTemplateConfigs": [ + { + "LaunchTemplateSpecification": { + "LaunchTemplateId": "lt-0e8c754449b27161c", + "Version": "1" + } + } + ], + "TargetCapacitySpecification": { + "TotalTargetCapacity": 2, + "DefaultTargetCapacityType": "spot" + } + } 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" - } - } + { + "FleetId": "fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE" + } +**Example 2: To create an EC2 Fleet that launches On-Demand Instances as the default purchasing model** -**To create an EC2 Fleet that launches On-Demand Instances as the default purchasing model** +The following ``create-fleet`` 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. -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. :: -When you create an EC2 Fleet, use a JSON file to specify information about the instances to launch. + aws ec2 create-fleet \ + --cli-input-json file://file_name.json -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:: +Contents of file_name.json:: { "LaunchTemplateConfigs": [ - { - "LaunchTemplateSpecification": { - "LaunchTemplateId": "lt-0e8c754449b27161c", - "Version": "1" - } - - } - ], - "TargetCapacitySpecification": { - "TotalTargetCapacity": 2, - "DefaultTargetCapacityType": "on-demand" + { + "LaunchTemplateSpecification": { + "LaunchTemplateId": "lt-0e8c754449b27161c", + "Version": "1" + } } - } - - -**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" + "TotalTargetCapacity": 2, + "DefaultTargetCapacityType": "on-demand" } } +Output:: -**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 + { + "FleetId": "fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE" + } + + +**Example 3: To create an EC2 Fleet that launches On-Demand Instances as the primary capacity** + +The following ``create-fleet`` 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. :: + + aws ec2 create-fleet \ + --cli-input-json file://file_name.json + +Contents of file_name.json:: + + { + "LaunchTemplateConfigs": [ + { + "LaunchTemplateSpecification": { + "LaunchTemplateId": "lt-0e8c754449b27161c", + "Version": "1" + } + } + ], + "TargetCapacitySpecification": { + "TotalTargetCapacity": 2, + "OnDemandTargetCapacity":1, + "DefaultTargetCapacityType": "spot" + } + } Output:: - { - "FleetId": "fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE" - } - -Where file_name.json contains the following:: + { + "FleetId": "fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE" + } + +**Example 4: 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. The following ``create-fleet`` 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. :: + + aws ec2 create-fleet \ + --cli-input-json file://file_name.jsonContents of file_name.json:: + + { + "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" + } + } - { - "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" - } - ] +Output:: - } - ], - "TargetCapacitySpecification": { - "TotalTargetCapacity": 2, - "DefaultTargetCapacityType": "spot" - } - } + { + "FleetId": "fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE" + } \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/create-internet-gateway.rst awscli-1.22.34/awscli/examples/ec2/create-internet-gateway.rst --- awscli-1.21.9/awscli/examples/ec2/create-internet-gateway.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/create-internet-gateway.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,17 +1,24 @@ -**To create an Internet gateway** - -This example creates an Internet gateway. - -Command:: - - aws ec2 create-internet-gateway - -Output:: - - { - "InternetGateway": { - "Tags": [], - "InternetGatewayId": "igw-c0a643a9", - "Attachments": [] - } - } \ No newline at end of file +**To create an internet gateway** + +The following ``create-internet-gateway`` example creates an internet gateway with the tag ``Name=my-igw``. :: + + aws ec2 create-internet-gateway \ + --tag-specifications ResourceType=internet-gateway,Tags=[{Key=Name,Value=my-igw}] + +Output:: + + { + "InternetGateway": { + "Attachments": [], + "InternetGatewayId": "igw-0d0fb496b3994d755", + "OwnerId": "123456789012", + "Tags": [ + { + "Key": "Name", + "Value": "my-igw" + } + ] + } + } + +For more information, see `Internet gateways `__ in the *Amazon VPC User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/create-ipam-pool.rst awscli-1.22.34/awscli/examples/ec2/create-ipam-pool.rst --- awscli-1.21.9/awscli/examples/ec2/create-ipam-pool.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/create-ipam-pool.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,63 @@ +**To create an IPAM pool** + +The following ``create-ipam-pool`` example creates an IPAM pool. + +(Linux):: + + aws ec2 create-ipam-pool \ + --ipam-scope-id ipam-scope-02fc38cd4c48e7d38 \ + --address-family ipv4 \ + --auto-import \ + --allocation-min-netmask-length 16 \ + --allocation-max-netmask-length 26 \ + --allocation-default-netmask-length 24 \ + --allocation-resource-tags "Key=Environment,Value=Preprod" \ + --tag-specifications 'ResourceType=ipam-pool,Tags=[{Key=Name,Value="Preprod pool"}]' + +(Windows):: + + aws ec2 create-ipam-pool ^ + --ipam-scope-id ipam-scope-02fc38cd4c48e7d38 ^ + --address-family ipv4 ^ + --auto-import ^ + --allocation-min-netmask-length 16 ^ + --allocation-max-netmask-length 26 ^ + --allocation-default-netmask-length 24 ^ + --allocation-resource-tags "Key=Environment,Value=Preprod" ^ + --tag-specifications ResourceType=ipam-pool,Tags=[{Key=Name,Value="Preprod pool"}] + +Output:: + + { + "IpamPool": { + "OwnerId": "123456789012", + "IpamPoolId": "ipam-pool-0533048da7d823723", + "IpamPoolArn": "arn:aws:ec2::123456789012:ipam-pool/ipam-pool-0533048da7d823723", + "IpamScopeArn": "arn:aws:ec2::123456789012:ipam-scope/ipam-scope-02fc38cd4c48e7d38", + "IpamScopeType": "private", + "IpamArn": "arn:aws:ec2::123456789012:ipam/ipam-08440e7a3acde3908", + "IpamRegion": "us-east-1", + "Locale": "None", + "PoolDepth": 1, + "State": "create-in-progress", + "AutoImport": true, + "AddressFamily": "ipv4", + "AllocationMinNetmaskLength": 16, + "AllocationMaxNetmaskLength": 26, + "AllocationDefaultNetmaskLength": 24, + "AllocationResourceTags": [ + { + "Key": "Environment", + "Value": "Preprod" + } + ], + "Tags": [ + { + "Key": "Name", + "Value": "Preprod pool" + } + ] + } + } + +For more information, see `Plan for IP address provisioning `__ in the *Amazon VPC IPAM User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/create-ipam.rst awscli-1.22.34/awscli/examples/ec2/create-ipam.rst --- awscli-1.21.9/awscli/examples/ec2/create-ipam.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/create-ipam.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,51 @@ +**To create an IPAM** + +The following ``create-ipam`` example creates an IPAM. + +(Linux):: + + aws ec2 create-ipam \ + --description "Example description" \ + --operating-regions "RegionName=us-east-2" "RegionName=us-west-1" \ + --tag-specifications 'ResourceType=ipam,Tags=[{Key=Name,Value=ExampleIPAM}]' + +(Windows):: + + aws ec2 create-ipam ^ + --description "Example description" ^ + --operating-regions "RegionName=us-east-2" "RegionName=us-west-1" ^ + --tag-specifications ResourceType=ipam,Tags=[{Key=Name,Value=ExampleIPAM}] + +Output:: + + { + "Ipam": { + "OwnerId": "123456789012", + "IpamId": "ipam-036486dfa6af58ee0", + "IpamArn": "arn:aws:ec2::123456789012:ipam/ipam-036486dfa6af58ee0", + "IpamRegion": "us-east-1", + "PublicDefaultScopeId": "ipam-scope-071b8042b0195c183", + "PrivateDefaultScopeId": "ipam-scope-0807405dece705a30", + "ScopeCount": 2, + "OperatingRegions": [ + { + "RegionName": "us-east-2" + }, + { + "RegionName": "us-west-1" + }, + { + "RegionName": "us-east-1" + } + ], + "State": "create-in-progress", + "Tags": [ + { + "Key": "Name", + "Value": "ExampleIPAM" + } + ] + } + } + +For more information, see `Create an IPAM `__ in the *Amazon VPC IPAM User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/create-ipam-scope.rst awscli-1.22.34/awscli/examples/ec2/create-ipam-scope.rst --- awscli-1.21.9/awscli/examples/ec2/create-ipam-scope.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/create-ipam-scope.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,42 @@ +**To create an IPAM scope** + +The following ``create-ipam-scope`` example creates an IPAM scope. + +(Linux):: + + aws ec2 create-ipam-scope \ + --ipam-id ipam-08440e7a3acde3908 \ + --description "Example description" \ + --tag-specifications 'ResourceType=ipam-scope,Tags=[{Key=Name,Value="Example name value"}]' + +(Windows):: + + aws ec2 create-ipam-scope ^ + --ipam-id ipam-08440e7a3acde3908 ^ + --description "Example description" ^ + --tag-specifications ResourceType=ipam-scope,Tags=[{Key=Name,Value="Example name value"}] + +Output:: + + { + "IpamScope": { + "OwnerId": "123456789012", + "IpamScopeId": "ipam-scope-01c1ebab2b63bd7e4", + "IpamScopeArn": "arn:aws:ec2::123456789012:ipam-scope/ipam-scope-01c1ebab2b63bd7e4", + "IpamArn": "arn:aws:ec2::123456789012:ipam/ipam-08440e7a3acde3908", + "IpamRegion": "us-east-1", + "IpamScopeType": "private", + "IsDefault": false, + "Description": "Example description", + "PoolCount": 0, + "State": "create-in-progress", + "Tags": [ + { + "Key": "Name", + "Value": "Example name value" + } + ] + } + } + +For more information, see `Create additional scopes `__ in the *Amazon VPC IPAM User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/create-nat-gateway.rst awscli-1.22.34/awscli/examples/ec2/create-nat-gateway.rst --- awscli-1.21.9/awscli/examples/ec2/create-nat-gateway.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/create-nat-gateway.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,24 +1,53 @@ -**To create a NAT gateway** - -This example creates a NAT gateway in subnet ``subnet-1a2b3c4d`` and associates an Elastic IP address with the allocation ID ``eipalloc-37fc1a52`` with the NAT gateway. - -Command:: - - aws ec2 create-nat-gateway --subnet-id subnet-1a2b3c4d --allocation-id eipalloc-37fc1a52 - -Output:: - - { - "NatGateway": { - "NatGatewayAddresses": [ - { - "AllocationId": "eipalloc-37fc1a52" - } - ], - "VpcId": "vpc-1122aabb", - "State": "pending", - "NatGatewayId": "nat-08d48af2a8e83edfd", - "SubnetId": "subnet-1a2b3c4d", - "CreateTime": "2015-12-17T12:45:26.732Z" - } - } \ No newline at end of file +**Example 1: To create a public NAT gateway** + +The following ``create-nat-gateway`` example creates a public NAT gateway in the specified subnet and associates the Elastic IP address with the specified allocation ID. When you create a public NAT gateway, you must associate an Elastic IP address. :: + + aws ec2 create-nat-gateway \ + --subnet-id subnet-0250c25a1fEXAMPLE \ + --allocation-id eipalloc-09ad461b0dEXAMPLE + +Output:: + + { + "NatGateway": { + "CreateTime": "2021-12-01T22:22:38.000Z", + "NatGatewayAddresses": [ + { + "AllocationId": "eipalloc-09ad461b0dEXAMPLE" + } + ], + "NatGatewayId": "nat-0c61bf8a12EXAMPLE", + "State": "pending", + "SubnetId": "subnet-0250c25a1fEXAMPLE", + "VpcId": "vpc-0a60eb65b4EXAMPLE", + "ConnectivityType": "public" + } + } + +For more information, see `NAT gateways `__ in the *Amazon VPC User Guide*. + +**Example 2: To create a private NAT gateway** + +The following ``create-nat-gateway`` example creates a private NAT gateway in the specified subnet. A private NAT gateway does not have an associated Elastic IP address. :: + + aws ec2 create-nat-gateway \ + --subnet-id subnet-0250c25a1fEXAMPLE \ + --connectivity-type private + +Output:: + + { + "NatGateway": { + "CreateTime": "2021-12-01T22:26:00.000Z", + "NatGatewayAddresses": [ + {} + ], + "NatGatewayId": "nat-011b568379EXAMPLE", + "State": "pending", + "SubnetId": "subnet-0250c25a1fEXAMPLE", + "VpcId": "vpc-0a60eb65b4EXAMPLE", + "ConnectivityType": "private" + } + } + +For more information, see `NAT gateways `__ in the *Amazon VPC User Guide*. diff -Nru awscli-1.21.9/awscli/examples/ec2/create-subnet.rst awscli-1.22.34/awscli/examples/ec2/create-subnet.rst --- awscli-1.21.9/awscli/examples/ec2/create-subnet.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/create-subnet.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,68 +1,123 @@ -**Example 1: To create a subnet with an IPv4 CIDR block** - -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. :: - - aws ec2 create-subnet \ - --vpc-id vpc-081ec835f3EXAMPLE \ - --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": { - "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*. +**Example 1: To create a subnet with an IPv4 CIDR block only** + +The following ``create-subnet`` example creates a subnet in the specified VPC with the specified IPv4 CIDR block. :: + + aws ec2 create-subnet \ + --vpc-id vpc-081ec835f3EXAMPLE \ + --cidr-block 10.0.0.0/24 \ + --tag-specifications ResourceType=subnet,Tags=[{Key=Name,Value=my-ipv4-only-subnet}] + +Output:: + + { + "Subnet": { + "AvailabilityZone": "us-west-2a", + "AvailabilityZoneId": "usw2-az2", + "AvailableIpAddressCount": 251, + "CidrBlock": "10.0.0.0/24", + "DefaultForAz": false, + "MapPublicIpOnLaunch": false, + "State": "available", + "SubnetId": "subnet-0e99b93155EXAMPLE", + "VpcId": "vpc-081ec835f3EXAMPLE", + "OwnerId": "123456789012", + "AssignIpv6AddressOnCreation": false, + "Ipv6CidrBlockAssociationSet": [], + "Tags": [ + { + "Key": "Name", + "Value": "my-ipv4-only-subnet" + } + ], + "SubnetArn": "arn:aws:ec2:us-west-2:123456789012:subnet/subnet-0e99b93155EXAMPLE" + } + } + +**Example 2: To create a subnet with both IPv4 and IPv6 CIDR blocks** + +The following ``create-subnet`` example creates a subnet in the specified VPC with the specified IPv4 and IPv6 CIDR blocks. :: + + aws ec2 create-subnet \ + --vpc-id vpc-081ec835f3EXAMPLE \ + --cidr-block 10.0.0.0/24 \ + --ipv6-cidr-block 2600:1f16:cfe:3660::/64 \ + --tag-specifications ResourceType=subnet,Tags=[{Key=Name,Value=my-ipv4-ipv6-subnet}] + +Output:: + + { + "Subnet": { + "AvailabilityZone": "us-west-2a", + "AvailabilityZoneId": "usw2-az2", + "AvailableIpAddressCount": 251, + "CidrBlock": "10.0.0.0/24", + "DefaultForAz": false, + "MapPublicIpOnLaunch": false, + "State": "available", + "SubnetId": "subnet-0736441d38EXAMPLE", + "VpcId": "vpc-081ec835f3EXAMPLE", + "OwnerId": "123456789012", + "AssignIpv6AddressOnCreation": false, + "Ipv6CidrBlockAssociationSet": [ + { + "AssociationId": "subnet-cidr-assoc-06c5f904499fcc623", + "Ipv6CidrBlock": "2600:1f13:cfe:3660::/64", + "Ipv6CidrBlockState": { + "State": "associating" + } + } + ], + "Tags": [ + { + "Key": "Name", + "Value": "my-ipv4-ipv6-subnet" + } + ], + "SubnetArn": "arn:aws:ec2:us-west-2:123456789012:subnet/subnet-0736441d38EXAMPLE" + } + } + +**Example 3: To create a subnet with an IPv6 CIDR block only** + +The following ``create-subnet`` example creates a subnet in the specified VPC with the specified IPv6 CIDR block. :: + + aws ec2 create-subnet \ + --vpc-id vpc-081ec835f3EXAMPLE \ + --ipv6-native \ + --ipv6-cidr-block 2600:1f16:115:200::/64 \ + --tag-specifications ResourceType=subnet,Tags=[{Key=Name,Value=my-ipv6-only-subnet}] + +Output:: + + { + "Subnet": { + "AvailabilityZone": "us-west-2a", + "AvailabilityZoneId": "usw2-az2", + "AvailableIpAddressCount": 0, + "DefaultForAz": false, + "MapPublicIpOnLaunch": false, + "State": "available", + "SubnetId": "subnet-03f720e7deEXAMPLE", + "VpcId": "vpc-081ec835f3EXAMPLE", + "OwnerId": "123456789012", + "AssignIpv6AddressOnCreation": true, + "Ipv6CidrBlockAssociationSet": [ + { + "AssociationId": "subnet-cidr-assoc-01ef639edde556709", + "Ipv6CidrBlock": "2600:1f13:cfe:3660::/64", + "Ipv6CidrBlockState": { + "State": "associating" + } + } + ], + "Tags": [ + { + "Key": "Name", + "Value": "my-ipv6-only-subnet" + } + ], + "SubnetArn": "arn:aws:ec2:us-west-2:123456789012:subnet/subnet-03f720e7deEXAMPLE" + } + } + +For more information, see `VPCs and subnets `__ in the *Amazon VPC User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/create-transit-gateway-connect-peer.rst awscli-1.22.34/awscli/examples/ec2/create-transit-gateway-connect-peer.rst --- awscli-1.21.9/awscli/examples/ec2/create-transit-gateway-connect-peer.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/create-transit-gateway-connect-peer.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,45 @@ +**To create a Transit Gateway Connect peer** + +The following ``create-transit-gateway-connect-peer`` example creates a Connect peer. :: + + aws ec2 create-transit-gateway-connect-peer \ + --transit-gateway-attachment-id tgw-attach-0f0927767cEXAMPLE \ + --peer-address 172.31.1.11 \ + --inside-cidr-blocks 169.254.6.0/29 + +Output:: + + { + "TransitGatewayConnectPeer": { + "TransitGatewayAttachmentId": "tgw-attach-0f0927767cEXAMPLE", + "TransitGatewayConnectPeerId": "tgw-connect-peer-0666adbac4EXAMPLE", + "State": "pending", + "CreationTime": "2021-10-13T03:35:17.000Z", + "ConnectPeerConfiguration": { + "TransitGatewayAddress": "10.0.0.234", + "PeerAddress": "172.31.1.11", + "InsideCidrBlocks": [ + "169.254.6.0/29" + ], + "Protocol": "gre", + "BgpConfigurations": [ + { + "TransitGatewayAsn": 64512, + "PeerAsn": 64512, + "TransitGatewayAddress": "169.254.6.2", + "PeerAddress": "169.254.6.1", + "BgpStatus": "down" + }, + { + "TransitGatewayAsn": 64512, + "PeerAsn": 64512, + "TransitGatewayAddress": "169.254.6.3", + "PeerAddress": "169.254.6.1", + "BgpStatus": "down" + } + ] + } + } + } + +For more information, see `Transit gateway Connect attachments and Transit Gateway Connect peers `__ in the *Transit Gateways Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/create-transit-gateway-connect.rst awscli-1.22.34/awscli/examples/ec2/create-transit-gateway-connect.rst --- awscli-1.21.9/awscli/examples/ec2/create-transit-gateway-connect.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/create-transit-gateway-connect.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,24 +1,24 @@ -**To create a transit gateway Connect attachment** - -The following "create-transit-gateway-connect" example creates a Connect attachment for the specified attachment with the "gre" protocol. :: - - aws ec2 create-transit-gateway-connect \ - --transport-transit-gateway-attachment-id tgw-attach-0a89069f57EXAMPLE \ - --options "Protocol=gre" - -Output:: - - { - "TransitGatewayConnect": { - "TransitGatewayAttachmentId": "tgw-attach-037012e5dcEXAMPLE", - "TransportTransitGatewayAttachmentId": "tgw-attach-0a89069f57EXAMPLE", - "TransitGatewayId": "tgw-02f776b1a7EXAMPLE", - "State": "pending", - "CreationTime": "2021-03-09T19:59:17+00:00", - "Options": { - "Protocol": "gre" - } - } - } - -For more information, see `Transit gateway Connect attachments and Connect peers `__ in the *User Guide for AWSPrivateLink*. \ No newline at end of file +**To create a transit gateway Connect attachment** + +The following ``create-transit-gateway-connect`` example creates a Connect attachment, with the "gre" protocol, for the specified attachment. :: + + aws ec2 create-transit-gateway-connect \ + --transport-transit-gateway-attachment-id tgw-attach-0a89069f57EXAMPLE \ + --options "Protocol=gre" + +Output:: + + { + "TransitGatewayConnect": { + "TransitGatewayAttachmentId": "tgw-attach-037012e5dcEXAMPLE", + "TransportTransitGatewayAttachmentId": "tgw-attach-0a89069f57EXAMPLE", + "TransitGatewayId": "tgw-02f776b1a7EXAMPLE", + "State": "pending", + "CreationTime": "2021-03-09T19:59:17+00:00", + "Options": { + "Protocol": "gre" + } + } + } + +For more information, see `Transit gateway Connect attachments and Transit Gateway Connect peers `__ in the *Transit Gateways Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/create-transit-gateway-multicast-domain.rst awscli-1.22.34/awscli/examples/ec2/create-transit-gateway-multicast-domain.rst --- awscli-1.21.9/awscli/examples/ec2/create-transit-gateway-multicast-domain.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/create-transit-gateway-multicast-domain.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,53 @@ +**Example 1: To create an IGMP multicast domain** + +The following ``create-transit-gateway-multicast-domain`` example creates a multicast domain for the specified transit gateway. With static sources disabled, any instances in subnets associated with the multicast domain can send multicast traffic. If at least one member uses the IGMP protocol, you must enable IGMPv2 support. :: + + aws ec2 create-transit-gateway-multicast-domain \ + --transit-gateway-id tgw-0bf0bffefaEXAMPLE \ + --options StaticSourcesSupport=disable,Igmpv2Support=enable + +Output:: + + { + "TransitGatewayMulticastDomain": { + "TransitGatewayMulticastDomainId": "tgw-mcast-domain-0c9e29e2a7EXAMPLE", + "TransitGatewayId": "tgw-0bf0bffefaEXAMPLE", + "TransitGatewayMulticastDomainArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway-multicast-domain/tgw-mcast-domain-0c9e29e2a7EXAMPLE", + "OwnerId": "123456789012", + "Options": { + "Igmpv2Support": "enable", + "StaticSourcesSupport": "disable", + "AutoAcceptSharedAssociations": "disable" + }, + "State": "pending", + "CreationTime": "2021-09-29T22:17:13.000Z" + } + } + +**Example 2: To create a static multicast domain** + +The following ``create-transit-gateway-multicast-domain`` example creates a multicast domain for the specified transit gateway. With static sources enabled, you must statically add sources. :: + + aws ec2 create-transit-gateway-multicast-domain \ + --transit-gateway-id tgw-0bf0bffefaEXAMPLE \ + --options StaticSourcesSupport=enable,Igmpv2Support=disable + +Output:: + + { + "TransitGatewayMulticastDomain": { + "TransitGatewayMulticastDomainId": "tgw-mcast-domain-000fb24d04EXAMPLE", + "TransitGatewayId": "tgw-0bf0bffefaEXAMPLE", + "TransitGatewayMulticastDomainArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway-multicast-domain/tgw-mcast-domain-000fb24d04EXAMPLE", + "OwnerId": "123456789012", + "Options": { + "Igmpv2Support": "disable", + "StaticSourcesSupport": "enable", + "AutoAcceptSharedAssociations": "disable" + }, + "State": "pending", + "CreationTime": "2021-09-29T22:20:19.000Z" + } + } + +For more information, see `Managing multicast domains `__ in the *Transit Gateways Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/create-transit-gateway-route.rst awscli-1.22.34/awscli/examples/ec2/create-transit-gateway-route.rst --- awscli-1.21.9/awscli/examples/ec2/create-transit-gateway-route.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/create-transit-gateway-route.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,27 +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*. +**To create a transit gateway route** + +The following ``create-transit-gateway-route`` example creates a route, with the specified destination, 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 `Transit gateway route tables `__ in the *Transit Gateways Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/create-transit-gateway-route-table.rst awscli-1.22.34/awscli/examples/ec2/create-transit-gateway-route-table.rst --- awscli-1.21.9/awscli/examples/ec2/create-transit-gateway-route-table.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/create-transit-gateway-route-table.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,21 +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*. +**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 *Transit Gateways Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/create-transit-gateway.rst awscli-1.22.34/awscli/examples/ec2/create-transit-gateway.rst --- awscli-1.21.9/awscli/examples/ec2/create-transit-gateway.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/create-transit-gateway.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,31 +1,32 @@ -**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*. +**To create a transit gateway** + +The following ``create-transit-gateway`` 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 *Transit Gateways Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/create-transit-gateway-vpc-attachment.rst awscli-1.22.34/awscli/examples/ec2/create-transit-gateway-vpc-attachment.rst --- awscli-1.21.9/awscli/examples/ec2/create-transit-gateway-vpc-attachment.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/create-transit-gateway-vpc-attachment.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,60 +1,62 @@ -**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*. +**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" + } + } + } + +For more information, see `Create a transit gateway attachment to a VPC `__ in the *Transit Gateways Guide*. + +**Example 2: To associate a transit gateway with multiple subnets in a VPC** + +The following ``create-transit-gateway-vpc-attachment`` example creates a transit gateway attachment to the specified VPC and subnets. :: + + aws ec2 create-transit-gateway-vpc-attachment \ + --transit-gateway-id tgw-02f776b1a7EXAMPLE \ + --vpc-id vpc-3EXAMPLE \ + --subnet-ids "subnet-dEXAMPLE" "subnet-6EXAMPLE" + +Output:: + + { + "TransitGatewayVpcAttachment": { + "TransitGatewayAttachmentId": "tgw-attach-0e141e0bebEXAMPLE", + "TransitGatewayId": "tgw-02f776b1a7EXAMPLE", + "VpcId": "vpc-3EXAMPLE", + "VpcOwnerId": "111122223333", + "State": "pending", + "SubnetIds": [ + "subnet-6EXAMPLE", + "subnet-dEXAMPLE" + ], + "CreationTime": "2019-12-17T20:07:52.000Z", + "Options": { + "DnsSupport": "enable", + "Ipv6Support": "disable" + } + } + } + +For more information, see `Create a transit gateway attachment to a VPC `__ in the *Transit Gateways Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/create-vpc.rst awscli-1.22.34/awscli/examples/ec2/create-vpc.rst --- awscli-1.21.9/awscli/examples/ec2/create-vpc.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/create-vpc.rst 2022-01-12 19:04:32.000000000 +0000 @@ -34,7 +34,7 @@ **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. +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 \ @@ -64,10 +64,10 @@ "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. +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 \ @@ -108,4 +108,54 @@ } } -For more information, see `Creating a VPC `__ in the *AWS VPC User Guide*. +**Example 4: To create a VPC with a CIDR from an IPAM pool** + +The following ``create-vpc`` example creates a VPC with a CIDR from an Amazon VPC IP Address Manager (IPAM) pool. + +(Linux):: + + aws ec2 create-vpc \ + --ipv4-ipam-pool-id ipam-pool-0533048da7d823723 \ + --tag-specifications ResourceType=vpc,Tags='[{Key=Environment,Value="Preprod"},{Key=Owner,Value="Build Team"}]' + +(Windows):: + + aws ec2 create-vpc ^ + --ipv4-ipam-pool-id ipam-pool-0533048da7d823723 ^ + --tag-specifications ResourceType=vpc,Tags=[{Key=Environment,Value="Preprod"},{Key=Owner,Value="Build Team"}] + +Output:: + + { + "Vpc": { + "CidrBlock": "10.0.1.0/24", + "DhcpOptionsId": "dopt-2afccf50", + "State": "pending", + "VpcId": "vpc-010e1791024eb0af9", + "OwnerId": "123456789012", + "InstanceTenancy": "default", + "Ipv6CidrBlockAssociationSet": [], + "CidrBlockAssociationSet": [ + { + "AssociationId": "vpc-cidr-assoc-0a77de1d803226d4b", + "CidrBlock": "10.0.1.0/24", + "CidrBlockState": { + "State": "associated" + } + } + ], + "IsDefault": false, + "Tags": [ + { + "Key": "Environment", + "Value": "Preprod" + }, + { + "Key": "Owner", + "Value": "Build Team" + } + ] + } + } + +For more information, see `Create a VPC that uses an IPAM pool CIDR `__ in the *Amazon VPC IPAM User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/delete-internet-gateway.rst awscli-1.22.34/awscli/examples/ec2/delete-internet-gateway.rst --- awscli-1.21.9/awscli/examples/ec2/delete-internet-gateway.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/delete-internet-gateway.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,7 +1,10 @@ -**To delete an Internet gateway** - -This example deletes the specified Internet gateway. If the command succeeds, no output is returned. - -Command:: - - aws ec2 delete-internet-gateway --internet-gateway-id igw-c0a643a9 +**To delete an internet gateway** + +The following ``delete-internet-gateway`` example deletes the specified internet gateway. :: + + aws ec2 delete-internet-gateway \ + --internet-gateway-id igw-0d0fb496b3EXAMPLE + +This command produces no output. + +For more information, see `Internet gateways `__ in the *Amazon VPC User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/delete-ipam.rst awscli-1.22.34/awscli/examples/ec2/delete-ipam.rst --- awscli-1.21.9/awscli/examples/ec2/delete-ipam.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/delete-ipam.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,34 @@ +**To delete an IPAM** + +The following ``delete-ipam`` example deletes an IPAM. :: + + aws ec2 delete-ipam \ + --ipam-id ipam-036486dfa6af58ee0 + +Output:: + + { + "Ipam": { + "OwnerId": "123456789012", + "IpamId": "ipam-036486dfa6af58ee0", + "IpamArn": "arn:aws:ec2::123456789012:ipam/ipam-036486dfa6af58ee0", + "IpamRegion": "us-east-1", + "PublicDefaultScopeId": "ipam-scope-071b8042b0195c183", + "PrivateDefaultScopeId": "ipam-scope-0807405dece705a30", + "ScopeCount": 2, + "OperatingRegions": [ + { + "RegionName": "us-east-1" + }, + { + "RegionName": "us-east-2" + }, + { + "RegionName": "us-west-1" + } + ], + "State": "delete-in-progress" + } + } + +For more information, see `Delete an IPAM `__ in the *Amazon VPC IPAM User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/delete-ipam-scope.rst awscli-1.22.34/awscli/examples/ec2/delete-ipam-scope.rst --- awscli-1.21.9/awscli/examples/ec2/delete-ipam-scope.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/delete-ipam-scope.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,25 @@ +**To delete an IPAM scope** + +The following ``delete-ipam-scope`` example deletes an IPAM. :: + + aws ec2 delete-ipam-scope \ + --ipam-scope-id ipam-scope-01c1ebab2b63bd7e4 + +Output:: + + { + "IpamScope": { + "OwnerId": "123456789012", + "IpamScopeId": "ipam-scope-01c1ebab2b63bd7e4", + "IpamScopeArn": "arn:aws:ec2::123456789012:ipam-scope/ipam-scope-01c1ebab2b63bd7e4", + "IpamArn": "arn:aws:ec2::123456789012:ipam/ipam-08440e7a3acde3908", + "IpamRegion": "us-east-1", + "IpamScopeType": "private", + "IsDefault": false, + "Description": "Example description", + "PoolCount": 0, + "State": "delete-in-progress" + } + } + +For more information, see `Delete a scope `__ in the *Amazon VPC IPAM User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/delete-transit-gateway-connect-peer.rst awscli-1.22.34/awscli/examples/ec2/delete-transit-gateway-connect-peer.rst --- awscli-1.21.9/awscli/examples/ec2/delete-transit-gateway-connect-peer.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/delete-transit-gateway-connect-peer.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,43 @@ +**To delete a Transit Gateway Connect peer** + +The following ``delete-transit-gateway-connect-peer`` example deletes the specified Connect peer. :: + + aws ec2 delete-transit-gateway-connect-peer \ + --transit-gateway-connect-peer-id tgw-connect-peer-0666adbac4EXAMPLE + +Output:: + + { + "TransitGatewayConnectPeer": { + "TransitGatewayAttachmentId": "tgw-attach-0f0927767cEXAMPLE", + "TransitGatewayConnectPeerId": "tgw-connect-peer-0666adbac4EXAMPLE", + "State": "deleting", + "CreationTime": "2021-10-13T03:35:17.000Z", + "ConnectPeerConfiguration": { + "TransitGatewayAddress": "10.0.0.234", + "PeerAddress": "172.31.1.11", + "InsideCidrBlocks": [ + "169.254.6.0/29" + ], + "Protocol": "gre", + "BgpConfigurations": [ + { + "TransitGatewayAsn": 64512, + "PeerAsn": 64512, + "TransitGatewayAddress": "169.254.6.2", + "PeerAddress": "169.254.6.1", + "BgpStatus": "down" + }, + { + "TransitGatewayAsn": 64512, + "PeerAsn": 64512, + "TransitGatewayAddress": "169.254.6.3", + "PeerAddress": "169.254.6.1", + "BgpStatus": "down" + } + ] + } + } + } + +For more information, see `Transit gateway Connect attachments and Transit Gateway Connect peers `__ in the *Transit Gateways Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/delete-transit-gateway-connect.rst awscli-1.22.34/awscli/examples/ec2/delete-transit-gateway-connect.rst --- awscli-1.21.9/awscli/examples/ec2/delete-transit-gateway-connect.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/delete-transit-gateway-connect.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,23 @@ +**To delete a transit gateway Connect attachment** + +The following ``delete-transit-gateway-connect`` example deletes the specified Connect attachment. :: + + aws ec2 delete-transit-gateway-connect \ + --transit-gateway-attachment-id tgw-attach-037012e5dcEXAMPLE + +Output:: + + { + "TransitGatewayConnect": { + "TransitGatewayAttachmentId": "tgw-attach-037012e5dcEXAMPLE", + "TransportTransitGatewayAttachmentId": "tgw-attach-0a89069f57EXAMPLE", + "TransitGatewayId": "tgw-02f776b1a7EXAMPLE", + "State": "deleting", + "CreationTime": "2021-03-09T19:59:17+00:00", + "Options": { + "Protocol": "gre" + } + } + } + +For more information, see `Transit gateway Connect attachments and Transit Gateway Connect peers `__ in the *Transit Gateways Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/delete-transit-gateway-multicast-domain.rst awscli-1.22.34/awscli/examples/ec2/delete-transit-gateway-multicast-domain.rst --- awscli-1.21.9/awscli/examples/ec2/delete-transit-gateway-multicast-domain.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/delete-transit-gateway-multicast-domain.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,19 +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*. +**To delete a transit gateway multicast domain** + +The following ``delete-transit-gateway-multicast-domain`` example deletes the specified multicast domain. :: + + 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 `Managing multicast domains `__ in the *Transit Gateways Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/delete-transit-gateway-route.rst awscli-1.22.34/awscli/examples/ec2/delete-transit-gateway-route.rst --- awscli-1.21.9/awscli/examples/ec2/delete-transit-gateway-route.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/delete-transit-gateway-route.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,26 +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*. +**To delete a CIDR block from a route table** + +The following ``delete-transit-gateway-route`` example 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 *Transit Gateways Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/delete-transit-gateway-route-table.rst awscli-1.22.34/awscli/examples/ec2/delete-transit-gateway-route-table.rst --- awscli-1.21.9/awscli/examples/ec2/delete-transit-gateway-route-table.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/delete-transit-gateway-route-table.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,21 +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*. +**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 *Transit Gateways Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/delete-transit-gateway.rst awscli-1.22.34/awscli/examples/ec2/delete-transit-gateway.rst --- awscli-1.21.9/awscli/examples/ec2/delete-transit-gateway.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/delete-transit-gateway.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,29 +1,30 @@ -**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*. +**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 *Transit Gateways Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/delete-transit-gateway-vpc-attachment.rst awscli-1.22.34/awscli/examples/ec2/delete-transit-gateway-vpc-attachment.rst --- awscli-1.21.9/awscli/examples/ec2/delete-transit-gateway-vpc-attachment.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/delete-transit-gateway-vpc-attachment.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,26 +1,21 @@ -**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*. +**To delete a transit gateway VPC attachment** + +The following ``delete-transit-gateway-vpc-attachment`` example deletes the specified 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" + } + } + +For more information, see `Delete a VPC attachment `__ in the *Transit Gateways Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/deprovision-ipam-pool-cidr.rst awscli-1.22.34/awscli/examples/ec2/deprovision-ipam-pool-cidr.rst --- awscli-1.21.9/awscli/examples/ec2/deprovision-ipam-pool-cidr.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/deprovision-ipam-pool-cidr.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,26 @@ +**To deprovision an IPAM pool CIDR** + +The following ``deprovision-ipam-pool-cidr`` example deprovisions a CIDR provisioned to an IPAM pool. + +(Linux):: + + aws ec2 deprovision-ipam-pool-cidr \ + --ipam-pool-id ipam-pool-02ec043a19bbe5d08 \ + --cidr 11.0.0.0/16 + +(Windows):: + + aws ec2 deprovision-ipam-pool-cidr ^ + --ipam-pool-id ipam-pool-02ec043a19bbe5d08 ^ + --cidr 11.0.0.0/16 + +Output:: + + { + "IpamPoolCidr": { + "Cidr": "11.0.0.0/16", + "State": "pending-deprovision" + } + } + +For more information, see `Deprovision pool CIDRs `__ in the *Amazon VPC IPAM User Guide*. diff -Nru awscli-1.21.9/awscli/examples/ec2/describe-internet-gateways.rst awscli-1.22.34/awscli/examples/ec2/describe-internet-gateways.rst --- awscli-1.21.9/awscli/examples/ec2/describe-internet-gateways.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/describe-internet-gateways.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,31 +1,31 @@ -**To describe your internet gateways** - -The following ``describe-internet-gateways`` example retrieves details about all of your internet gateways. :: - - aws ec2 describe-internet-gateways - -Output:: - - { - "InternetGateways": [ - { - "Attachments": [], - "InternetGatewayId": "igw-036dde5c85EXAMPLE", - "OwnerId": "111122223333", - "Tags": [] - }, - { - "Attachments": [ - { - "State": "available", - "VpcId": "vpc-cEXAMPLE" - } - ], - "InternetGatewayId": "igw-0EXAMPLE", - "OwnerId": "111122223333", - "Tags": [] - } - ] - } - -For more information, see `Internet Gateways `__ in the *AWS VPC User Guide*. +**To describe an internet gateway** + +The following ``describe-internet-gateways`` example describes the specified internet gateway. :: + + aws ec2 describe-internet-gateways \ + --internet-gateway-ids igw-0d0fb496b3EXAMPLE + +Output:: + + { + "InternetGateways": [ + { + "Attachments": [ + { + "State": "available", + "VpcId": "vpc-0a60eb65b4EXAMPLE" + } + ], + "InternetGatewayId": "igw-0d0fb496b3EXAMPLE", + "OwnerId": "123456789012", + "Tags": [ + { + "Key": "Name", + "Value": "my-igw" + } + ] + } + ] + } + +For more information, see `Internet gateways `__ in the *Amazon VPC User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/describe-ipam-pools.rst awscli-1.22.34/awscli/examples/ec2/describe-ipam-pools.rst --- awscli-1.21.9/awscli/examples/ec2/describe-ipam-pools.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/describe-ipam-pools.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,49 @@ +**To view the details for an IPAM pool** + +The following ``describe-ipam-pools`` example shows the details for pools. + +(Linux):: + + aws ec2 describe-ipam-pools \ + --filters Name=owner-id,Values=123456789012 Name=ipam-scope-id,Values=ipam-scope-02fc38cd4c48e7d38 + +(Windows):: + + aws ec2 describe-ipam-pools ^ + --filters Name=owner-id,Values=123456789012 Name=ipam-scope-id,Values=ipam-scope-02fc38cd4c48e7d38 + +Output:: + + { + "IpamPools": [ + { + "OwnerId": "123456789012", + "IpamPoolId": "ipam-pool-02ec043a19bbe5d08", + "IpamPoolArn": "arn:aws:ec2::123456789012:ipam-pool/ipam-pool-02ec043a19bbe5d08", + "IpamScopeArn": "arn:aws:ec2::123456789012:ipam-scope/ipam-scope-02fc38cd4c48e7d38", + "IpamScopeType": "private", + "IpamArn": "arn:aws:ec2::123456789012:ipam/ipam-08440e7a3acde3908", + "IpamRegion": "us-east-1", + "Locale": "None", + "PoolDepth": 1, + "State": "create-complete", + "AutoImport": true, + "AddressFamily": "ipv4", + "AllocationMinNetmaskLength": 16, + "AllocationMaxNetmaskLength": 26, + "AllocationDefaultNetmaskLength": 24, + "AllocationResourceTags": [ + { + "Key": "Environment", + "Value": "Preprod" + } + ], + "Tags": [ + { + "Key": "Name", + "Value": "Preprod pool" + } + ] + } + ] + } \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/describe-ipam-scopes.rst awscli-1.22.34/awscli/examples/ec2/describe-ipam-scopes.rst --- awscli-1.21.9/awscli/examples/ec2/describe-ipam-scopes.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/describe-ipam-scopes.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,55 @@ +**To view the details for an IPAM scope** + +The following ``describe-ipam-scopes`` example shows the details for scopes. :: + + aws ec2 describe-ipam-scopes \ + --filters Name=owner-id,Values=123456789012 Name=ipam-id,Values=ipam-08440e7a3acde3908 + +Output:: + + { + "IpamScopes": [ + { + "OwnerId": "123456789012", + "IpamScopeId": "ipam-scope-02fc38cd4c48e7d38", + "IpamScopeArn": "arn:aws:ec2::123456789012:ipam-scope/ipam-scope-02fc38cd4c48e7d38", + "IpamArn": "arn:aws:ec2::123456789012:ipam/ipam-08440e7a3acde3908", + "IpamRegion": "us-east-1", + "IpamScopeType": "private", + "IsDefault": true, + "PoolCount": 2, + "State": "create-complete", + "Tags": [] + }, + { + "OwnerId": "123456789012", + "IpamScopeId": "ipam-scope-0b9eed026396dbc16", + "IpamScopeArn": "arn:aws:ec2::123456789012:ipam-scope/ipam-scope-0b9eed026396dbc16", + "IpamArn": "arn:aws:ec2::123456789012:ipam/ipam-08440e7a3acde3908", + "IpamRegion": "us-east-1", + "IpamScopeType": "public", + "IsDefault": true, + "PoolCount": 0, + "State": "create-complete", + "Tags": [] + }, + { + "OwnerId": "123456789012", + "IpamScopeId": "ipam-scope-0f1aff29486355c22", + "IpamScopeArn": "arn:aws:ec2::123456789012:ipam-scope/ipam-scope-0f1aff29486355c22", + "IpamArn": "arn:aws:ec2::123456789012:ipam/ipam-08440e7a3acde3908", + "IpamRegion": "us-east-1", + "IpamScopeType": "private", + "IsDefault": false, + "Description": "Example description", + "PoolCount": 0, + "State": "create-complete", + "Tags": [ + { + "Key": "Name", + "Value": "Example name value" + } + ] + } + ] + } \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/describe-ipams.rst awscli-1.22.34/awscli/examples/ec2/describe-ipams.rst --- awscli-1.21.9/awscli/examples/ec2/describe-ipams.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/describe-ipams.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,40 @@ +**To view the details for an IPAM** + +The following ``describe-ipams`` example shows the details of an IPAM. :: + + aws ec2 describe-ipams \ + --filters Name=owner-id,Values=123456789012 + +Output:: + + { + "Ipams": [ + { + "OwnerId": "123456789012", + "IpamId": "ipam-08440e7a3acde3908", + "IpamArn": "arn:aws:ec2::123456789012:ipam/ipam-08440e7a3acde3908", + "IpamRegion": "us-east-1", + "PublicDefaultScopeId": "ipam-scope-0b9eed026396dbc16", + "PrivateDefaultScopeId": "ipam-scope-02fc38cd4c48e7d38", + "ScopeCount": 3, + "OperatingRegions": [ + { + "RegionName": "us-east-1" + }, + { + "RegionName": "us-east-2" + }, + { + "RegionName": "us-west-1" + } + ], + "State": "create-complete", + "Tags": [ + { + "Key": "Name", + "Value": "ExampleIPAM" + } + ] + } + ] + } \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/describe-transit-gateway-attachments.rst awscli-1.22.34/awscli/examples/ec2/describe-transit-gateway-attachments.rst --- awscli-1.21.9/awscli/examples/ec2/describe-transit-gateway-attachments.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/describe-transit-gateway-attachments.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,79 +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*. +**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 `Work with transit gateways `__ in the *Transit Gateways Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/describe-transit-gateway-connect-peers.rst awscli-1.22.34/awscli/examples/ec2/describe-transit-gateway-connect-peers.rst --- awscli-1.21.9/awscli/examples/ec2/describe-transit-gateway-connect-peers.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/describe-transit-gateway-connect-peers.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,46 @@ +**To describe a Transit Gateway Connect peer** + +The following ``describe-transit-gateway-connect-peers`` example describes the specified Connect peer. :: + + aws ec2 describe-transit-gateway-connect-peers \ + --transit-gateway-connect-peer-ids tgw-connect-peer-0666adbac4EXAMPLE + +Output:: + + { + "TransitGatewayConnectPeers": [ + { + "TransitGatewayAttachmentId": "tgw-attach-0f0927767cEXAMPLE", + "TransitGatewayConnectPeerId": "tgw-connect-peer-0666adbac4EXAMPLE", + "State": "available", + "CreationTime": "2021-10-13T03:35:17.000Z", + "ConnectPeerConfiguration": { + "TransitGatewayAddress": "10.0.0.234", + "PeerAddress": "172.31.1.11", + "InsideCidrBlocks": [ + "169.254.6.0/29" + ], + "Protocol": "gre", + "BgpConfigurations": [ + { + "TransitGatewayAsn": 64512, + "PeerAsn": 64512, + "TransitGatewayAddress": "169.254.6.2", + "PeerAddress": "169.254.6.1", + "BgpStatus": "down" + }, + { + "TransitGatewayAsn": 64512, + "PeerAsn": 64512, + "TransitGatewayAddress": "169.254.6.3", + "PeerAddress": "169.254.6.1", + "BgpStatus": "down" + } + ] + }, + "Tags": [] + } + ] + } + +For more information, see `Transit gateway Connect attachments and Transit Gateway Connect peers `__ in the *Transit Gateways Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/describe-transit-gateway-connects.rst awscli-1.22.34/awscli/examples/ec2/describe-transit-gateway-connects.rst --- awscli-1.21.9/awscli/examples/ec2/describe-transit-gateway-connects.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/describe-transit-gateway-connects.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,28 +1,26 @@ -**To describe all carrier gateways** - -The following "describe-carrier-gateways" example lists all your carrier gateways. :: - - aws ec2 describe-carrier-gateways - -Output:: - - { - "CarrierGateways": [ - { - "CarrierGatewayId": "cagw-0465cdEXAMPLE1111", - "VpcId": "vpc-0c529aEXAMPLE", - "State": "available", - "OwnerId": "123456789012", - "Tags": [ - { - - "Key": "example", - "Value": "tag" - } - ] - } - ] - } - -For more information, see `Carrier gateways `__ in the *Amazon Virtual Private Cloud -User Guide*. \ No newline at end of file +**To describe a transit gateway Connect attachment** + +The following ``describe-transit-gateway-connects`` example describes the specified Connect attachment. :: + + aws ec2 describe-transit-gateway-connects \ + --transit-gateway-attachment-ids tgw-attach-037012e5dcEXAMPLE + +Output:: + + { + "TransitGatewayConnects": [ + { + "TransitGatewayAttachmentId": "tgw-attach-037012e5dcEXAMPLE", + "TransportTransitGatewayAttachmentId": "tgw-attach-0a89069f57EXAMPLE", + "TransitGatewayId": "tgw-02f776b1a7EXAMPLE", + "State": "available", + "CreationTime": "2021-03-09T19:59:17+00:00", + "Options": { + "Protocol": "gre" + }, + "Tags": [] + } + ] + } + +For more information, see `Transit gateway Connect attachments and Transit Gateway Connect peers `__ in the *Transit Gateways Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/describe-transit-gateway-route-tables.rst awscli-1.22.34/awscli/examples/ec2/describe-transit-gateway-route-tables.rst --- awscli-1.21.9/awscli/examples/ec2/describe-transit-gateway-route-tables.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/describe-transit-gateway-route-tables.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,32 +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*. +**To describe your transit gateway route tables** + +The following ``describe-transit-gateway-route-tables`` example displays details for 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 *Transit Gateways Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/describe-transit-gateway-vpc-attachments.rst awscli-1.22.34/awscli/examples/ec2/describe-transit-gateway-vpc-attachments.rst --- awscli-1.21.9/awscli/examples/ec2/describe-transit-gateway-vpc-attachments.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/describe-transit-gateway-vpc-attachments.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,36 +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* +**To describe your transit gateway VPC attachments** + +The following ``describe-transit-gateway-vpc-attachments`` example displays details for 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 *Transit Gateways Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/detach-internet-gateway.rst awscli-1.22.34/awscli/examples/ec2/detach-internet-gateway.rst --- awscli-1.21.9/awscli/examples/ec2/detach-internet-gateway.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/detach-internet-gateway.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,7 +1,11 @@ -**To detach an Internet gateway from your VPC** - -This example detaches the specified Internet gateway from the specified VPC. If the command succeeds, no output is returned. - -Command:: - - aws ec2 detach-internet-gateway --internet-gateway-id igw-c0a643a9 --vpc-id vpc-a01106c2 +**To detach an internet gateway from your VPC** + +The following ``detach-internet-gateway`` example detaches the specified internet gateway from the specific VPC. :: + + aws ec2 detach-internet-gateway \ + --internet-gateway-id igw-0d0fb496b3EXAMPLE \ + --vpc-id vpc-0a60eb65b4EXAMPLE + +This command produces no output. + +For more information, see `Internet gateways `__ in the *Amazon VPC User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/disable-transit-gateway-route-table-propagation.rst awscli-1.22.34/awscli/examples/ec2/disable-transit-gateway-route-table-propagation.rst --- awscli-1.21.9/awscli/examples/ec2/disable-transit-gateway-route-table-propagation.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/disable-transit-gateway-route-table-propagation.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,21 +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*. +**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 `Transit gateway route tables `__ in the *Transit Gateways Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/disassociate-transit-gateway-multicast-domain.rst awscli-1.22.34/awscli/examples/ec2/disassociate-transit-gateway-multicast-domain.rst --- awscli-1.21.9/awscli/examples/ec2/disassociate-transit-gateway-multicast-domain.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/disassociate-transit-gateway-multicast-domain.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,27 +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*'. +**To disassociate subnets from a multicast domain** + +The following ``disassociate-transit-gateway-multicast-domain`` 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 `Working with multicast `__ in the *Transit Gateways Guide*'. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/disassociate-transit-gateway-route-table.rst awscli-1.22.34/awscli/examples/ec2/disassociate-transit-gateway-route-table.rst --- awscli-1.21.9/awscli/examples/ec2/disassociate-transit-gateway-route-table.rst 2021-11-02 18:19:46.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/disassociate-transit-gateway-route-table.rst 2022-01-12 19:04:32.000000000 +0000 @@ -18,4 +18,4 @@ } } -For more information, see `Delete an Association for a Transit Gateway Route Table `__ in the *AWS Transit Gateways Guide*. \ No newline at end of file +For more information, see `Transit gateway route tables `__ in the *Transit Gateways Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/enable-ipam-organization-admin-account.rst awscli-1.22.34/awscli/examples/ec2/enable-ipam-organization-admin-account.rst --- awscli-1.21.9/awscli/examples/ec2/enable-ipam-organization-admin-account.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/enable-ipam-organization-admin-account.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,14 @@ +**To integrate with AWS Organizations and delegate a member account as the IPAM account** + +The following ``enable-ipam-organization-admin-account`` example integrates IPAM with AWS Organizations and delegates a member account as the IPAM account. :: + + aws ec2 enable-ipam-organization-admin-account \ + --delegated-admin-account-id 320805250157 + +Output:: + + { + "Success": true + } + +For more information, see `Integrate IPAM with AWS Organizations `__ in the *Amazon VPC IPAM User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/enable-transit-gateway-route-table-propagation.rst awscli-1.22.34/awscli/examples/ec2/enable-transit-gateway-route-table-propagation.rst --- awscli-1.21.9/awscli/examples/ec2/enable-transit-gateway-route-table-propagation.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/enable-transit-gateway-route-table-propagation.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,21 +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*. +**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 `Transit gateway route tables `__ in the *Transit Gateways Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/get-ipam-address-history.rst awscli-1.22.34/awscli/examples/ec2/get-ipam-address-history.rst --- awscli-1.21.9/awscli/examples/ec2/get-ipam-address-history.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/get-ipam-address-history.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,64 @@ +**To get the history of a CIDR** + +The following ``get-ipam-address-history`` example gets the history of a CIDR. + +(Linux):: + + aws ec2 get-ipam-address-history \ + --cidr 10.0.0.0/16 \ + --ipam-scope-id ipam-scope-02fc38cd4c48e7d38 \ + --start-time 2021-12-08T01:00:00.000Z \ + --end-time 2021-12-10T01:00:00.000Z + +(Windows):: + + aws ec2 get-ipam-address-history ^ + --cidr 10.0.0.0/16 ^ + --ipam-scope-id ipam-scope-02fc38cd4c48e7d38 ^ + --start-time 2021-12-08T01:00:00.000Z ^ + --end-time 2021-12-10T01:00:00.000Z + +Output:: + + { + "HistoryRecords": [ + { + "ResourceOwnerId": "123456789012", + "ResourceRegion": "us-west-1", + "ResourceType": "vpc", + "ResourceId": "vpc-06cbefa9ee907e1c0", + "ResourceCidr": "10.0.0.0/16", + "ResourceName": "Demo", + "ResourceComplianceStatus": "unmanaged", + "ResourceOverlapStatus": "overlapping", + "VpcId": "vpc-06cbefa9ee907e1c0", + "SampledStartTime": "2021-12-08T19:54:57.675000+00:00" + }, + { + "ResourceOwnerId": "123456789012", + "ResourceRegion": "us-east-2", + "ResourceType": "vpc", + "ResourceId": "vpc-042702f474812c9ad", + "ResourceCidr": "10.0.0.0/16", + "ResourceName": "test", + "ResourceComplianceStatus": "unmanaged", + "ResourceOverlapStatus": "overlapping", + "VpcId": "vpc-042702f474812c9ad", + "SampledStartTime": "2021-12-08T19:54:59.019000+00:00" + }, + { + "ResourceOwnerId": "123456789012", + "ResourceRegion": "us-east-2", + "ResourceType": "vpc", + "ResourceId": "vpc-042b8a44f64267d67", + "ResourceCidr": "10.0.0.0/16", + "ResourceName": "tester", + "ResourceComplianceStatus": "unmanaged", + "ResourceOverlapStatus": "overlapping", + "VpcId": "vpc-042b8a44f64267d67", + "SampledStartTime": "2021-12-08T19:54:59.019000+00:00" + } + ] + } + +For more information, see `View the history of IP addresses `__ in the *Amazon VPC IPAM User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/get-ipam-pool-allocations.rst awscli-1.22.34/awscli/examples/ec2/get-ipam-pool-allocations.rst --- awscli-1.21.9/awscli/examples/ec2/get-ipam-pool-allocations.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/get-ipam-pool-allocations.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,28 @@ +**To get the CIDRs allocated from an IPAM pool** + +The following ``get-ipam-pool-allocations`` example gets the CIDRs allocated from an IPAM pool. + +(Linux):: + + aws ec2 get-ipam-pool-allocations \ + --ipam-pool-id ipam-pool-0533048da7d823723 \ + --filters Name=ipam-pool-allocation-id,Values=ipam-pool-alloc-0e6186d73999e47389266a5d6991e6220 + +(Windows):: + + aws ec2 get-ipam-pool-allocations ^ + --ipam-pool-id ipam-pool-0533048da7d823723 ^ + --filters Name=ipam-pool-allocation-id,Values=ipam-pool-alloc-0e6186d73999e47389266a5d6991e6220 + +Output:: + + { + "IpamPoolAllocations": [ + { + "Cidr": "10.0.0.0/16", + "IpamPoolAllocationId": "ipam-pool-alloc-0e6186d73999e47389266a5d6991e6220", + "ResourceType": "custom", + "ResourceOwner": "123456789012" + } + ] + } \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/get-ipam-pool-cidrs.rst awscli-1.22.34/awscli/examples/ec2/get-ipam-pool-cidrs.rst --- awscli-1.21.9/awscli/examples/ec2/get-ipam-pool-cidrs.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/get-ipam-pool-cidrs.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,24 @@ +**To get the CIDRs provisioned to an IPAM pool** + +The following ``get-ipam-pool-cidrs`` example gets the CIDRs provisioned to an IPAM pool. + +(Linux):: + + aws ec2 get-ipam-pool-cidrs \ + --ipam-pool-id ipam-pool-0533048da7d823723 \ + --filters 'Name=cidr,Values=10.*' + +(Windows):: + + aws ec2 get-ipam-pool-cidrs ^ + --ipam-pool-id ipam-pool-0533048da7d823723 ^ + --filters Name=cidr,Values=10.* + +Output:: + + { + "IpamPoolCidr": { + "Cidr": "10.0.0.0/24", + "State": "provisioned" + } + } \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/get-ipam-resource-cidrs.rst awscli-1.22.34/awscli/examples/ec2/get-ipam-resource-cidrs.rst --- awscli-1.21.9/awscli/examples/ec2/get-ipam-resource-cidrs.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/get-ipam-resource-cidrs.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,49 @@ +**To get the CIDRs allocated to a resource** + +The following ``get-ipam-resource-cidrs`` example gets the CIDRs allocated to a resource. + +(Linux):: + + aws ec2 get-ipam-resource-cidrs \ + --ipam-scope-id ipam-scope-02fc38cd4c48e7d38 \ + --filters Name=management-state,Values=unmanaged + +(Windows):: + + aws ec2 get-ipam-resource-cidrs ^ + --ipam-scope-id ipam-scope-02fc38cd4c48e7d38 ^ + --filters Name=management-state,Values=unmanaged + +Output:: + + { + "IpamResourceCidrs": [ + { + "IpamId": "ipam-08440e7a3acde3908", + "IpamScopeId": "ipam-scope-02fc38cd4c48e7d38", + "ResourceRegion": "us-east-2", + "ResourceOwnerId": "123456789012", + "ResourceId": "vpc-621b8709", + "ResourceName": "Default AWS VPC", + "ResourceCidr": "172.33.0.0/16", + "ResourceType": "vpc", + "ResourceTags": [ + { + "Key": "Environment", + "Value": "Test" + }, + { + "Key": "Name", + "Value": "Default AWS VPC" + } + ], + "IpUsage": 0.0039, + "ComplianceStatus": "unmanaged", + "ManagementState": "unmanaged", + "OverlapStatus": "nonoverlapping", + "VpcId": "vpc-621b8709" + } + ] + } + +For more information, see `Monitor CIDR usage by resource `__ in the *Amazon VPC IPAM User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/get-transit-gateway-attachment-propagations.rst awscli-1.22.34/awscli/examples/ec2/get-transit-gateway-attachment-propagations.rst --- awscli-1.21.9/awscli/examples/ec2/get-transit-gateway-attachment-propagations.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/get-transit-gateway-attachment-propagations.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,19 +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*. +**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 `Transit gateway route tables `__ in the *Transit Gateways Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/get-transit-gateway-multicast-domain-associations.rst awscli-1.22.34/awscli/examples/ec2/get-transit-gateway-multicast-domain-associations.rst --- awscli-1.21.9/awscli/examples/ec2/get-transit-gateway-multicast-domain-associations.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/get-transit-gateway-multicast-domain-associations.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,60 +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*. +**To view the information about the transit gateway multicast domain associations** + +The following ``get-transit-gateway-multicast-domain-associations`` example returns the associations for the specified 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 `Managing multicast domains `__ in the *Transit Gateways Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/get-transit-gateway-route-table-associations.rst awscli-1.22.34/awscli/examples/ec2/get-transit-gateway-route-table-associations.rst --- awscli-1.21.9/awscli/examples/ec2/get-transit-gateway-route-table-associations.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/get-transit-gateway-route-table-associations.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,21 +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*. +**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 `Transit gateway route tables `__ in the *Transit Gateways Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/get-transit-gateway-route-table-propagations.rst awscli-1.22.34/awscli/examples/ec2/get-transit-gateway-route-table-propagations.rst --- awscli-1.21.9/awscli/examples/ec2/get-transit-gateway-route-table-propagations.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/get-transit-gateway-route-table-propagations.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,33 +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*. +**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. :: + + aws 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 `Transit gateway route tables `__ in the *Transit Gateways Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/modify-ipam-pool.rst awscli-1.22.34/awscli/examples/ec2/modify-ipam-pool.rst --- awscli-1.21.9/awscli/examples/ec2/modify-ipam-pool.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/modify-ipam-pool.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,52 @@ +**To modify an IPAM pool** + +The following ``modify-ipam-pool`` example modifies an IPAM pool. + +(Linux):: + + aws ec2 modify-ipam-pool \ + --ipam-pool-id ipam-pool-0533048da7d823723 \ + --add-allocation-resource-tags "Key=Owner,Value=Build Team" \ + --clear-allocation-default-netmask-length \ + --allocation-min-netmask-length 14 + +(Windows):: + + aws ec2 modify-ipam-pool ^ + --ipam-pool-id ipam-pool-0533048da7d823723 ^ + --add-allocation-resource-tags "Key=Owner,Value=Build Team" ^ + --clear-allocation-default-netmask-length ^ + --allocation-min-netmask-length 14 + +Output:: + + { + "IpamPool": { + "OwnerId": "123456789012", + "IpamPoolId": "ipam-pool-0533048da7d823723", + "IpamPoolArn": "arn:aws:ec2::123456789012:ipam-pool/ipam-pool-0533048da7d823723", + "IpamScopeArn": "arn:aws:ec2::123456789012:ipam-scope/ipam-scope-02fc38cd4c48e7d38", + "IpamScopeType": "private", + "IpamArn": "arn:aws:ec2::123456789012:ipam/ipam-08440e7a3acde3908", + "IpamRegion": "us-east-1", + "Locale": "None", + "PoolDepth": 1, + "State": "modify-complete", + "AutoImport": true, + "AddressFamily": "ipv4", + "AllocationMinNetmaskLength": 14, + "AllocationMaxNetmaskLength": 26, + "AllocationResourceTags": [ + { + "Key": "Environment", + "Value": "Preprod" + }, + { + "Key": "Owner", + "Value": "Build Team" + } + ] + } + } + +For more information, see `Edit a pool `__ in the *Amazon VPC IPAM User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/modify-ipam-resource-cidr.rst awscli-1.22.34/awscli/examples/ec2/modify-ipam-resource-cidr.rst --- awscli-1.21.9/awscli/examples/ec2/modify-ipam-resource-cidr.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/modify-ipam-resource-cidr.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,57 @@ +**To modify the CIDR allocated to a resource** + +The following ``modify-ipam-resource-cidr`` example modifies a resource CIDR. + +(Linux):: + + aws ec2 modify-ipam-resource-cidr \ + --current-ipam-scope-id ipam-scope-02fc38cd4c48e7d38 \ + --destination-ipam-scope-id ipam-scope-0da34c61fd189a141 \ + --resource-id vpc-010e1791024eb0af9 \ + --resource-cidr 10.0.1.0/24 \ + --resource-region us-east-1 \ + --monitored + +(Windows):: + + aws ec2 modify-ipam-resource-cidr ^ + --current-ipam-scope-id ipam-scope-02fc38cd4c48e7d38 ^ + --destination-ipam-scope-id ipam-scope-0da34c61fd189a141 ^ + --resource-id vpc-010e1791024eb0af9 ^ + --resource-cidr 10.0.1.0/24 ^ + --resource-region us-east-1 ^ + --monitored + +Output:: + + { + "IpamResourceCidr": { + "IpamId": "ipam-08440e7a3acde3908", + "IpamScopeId": "ipam-scope-0da34c61fd189a141", + "IpamPoolId": "ipam-pool-0533048da7d823723", + "ResourceRegion": "us-east-1", + "ResourceOwnerId": "123456789012", + "ResourceId": "vpc-010e1791024eb0af9", + "ResourceCidr": "10.0.1.0/24", + "ResourceType": "vpc", + "ResourceTags": [ + { + "Key": "Environment", + "Value": "Preprod" + }, + { + "Key": "Owner", + "Value": "Build Team" + } + ], + "IpUsage": 0.0, + "ComplianceStatus": "noncompliant", + "ManagementState": "managed", + "OverlapStatus": "overlapping", + "VpcId": "vpc-010e1791024eb0af9" + } + } + +For more information on moving resources, see `Move resource CIDRs between scopes `__ in the *Amazon VPC IPAM User Guide*. + +For more information on changing monitoring states, see `Change the monitoring state of resource CIDRs `__ in the *Amazon VPC IPAM User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/modify-ipam.rst awscli-1.22.34/awscli/examples/ec2/modify-ipam.rst --- awscli-1.21.9/awscli/examples/ec2/modify-ipam.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/modify-ipam.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,44 @@ +**To modify an IPAM** + +The following ``modify-ipam`` example modifies an IPAM by adding an Operating Region. + +(Linux):: + + aws ec2 modify-ipam \ + --ipam-id ipam-08440e7a3acde3908 \ + --add-operating-regions RegionName=us-west-2 + +(Windows):: + + aws ec2 modify-ipam ^ + --ipam-id ipam-08440e7a3acde3908 ^ + --add-operating-regions RegionName=us-west-2 + +Output:: + + { + "Ipam": { + "OwnerId": "123456789012", + "IpamId": "ipam-08440e7a3acde3908", + "IpamArn": "arn:aws:ec2::123456789012:ipam/ipam-08440e7a3acde3908", + "IpamRegion": "us-east-1", + "PublicDefaultScopeId": "ipam-scope-0b9eed026396dbc16", + "PrivateDefaultScopeId": "ipam-scope-02fc38cd4c48e7d38", + "ScopeCount": 3, + "OperatingRegions": [ + { + "RegionName": "us-east-1" + }, + { + "RegionName": "us-east-2" + }, + { + "RegionName": "us-west-1" + }, + { + "RegionName": "us-west-2" + } + ], + "State": "modify-in-progress" + } + } \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/modify-transit-gateway-vpc-attachment.rst awscli-1.22.34/awscli/examples/ec2/modify-transit-gateway-vpc-attachment.rst --- awscli-1.21.9/awscli/examples/ec2/modify-transit-gateway-vpc-attachment.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/modify-transit-gateway-vpc-attachment.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,30 +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*. +**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 *Transit Gateways Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/move-byoip-cidr-to-ipam.rst awscli-1.22.34/awscli/examples/ec2/move-byoip-cidr-to-ipam.rst --- awscli-1.21.9/awscli/examples/ec2/move-byoip-cidr-to-ipam.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/move-byoip-cidr-to-ipam.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,31 @@ +**To transfer a BYOIP CIDR to IPAM** + +The following ``move-byoip-cidr-to-ipam`` example transfers a BYOIP CIDR to IPAM. + +(Linux):: + + aws ec2 move-byoip-cidr-to-ipam \ + --region us-west-2 \ + --ipam-pool-id ipam-pool-0a03d430ca3f5c035 \ + --ipam-pool-owner 111111111111 \ + --cidr 130.137.249.0/24 + +(Windows):: + + aws ec2 move-byoip-cidr-to-ipam ^ + --region us-west-2 ^ + --ipam-pool-id ipam-pool-0a03d430ca3f5c035 ^ + --ipam-pool-owner 111111111111 ^ + --cidr 130.137.249.0/24 + + +Output:: + + { + "ByoipCidr": { + "Cidr": "130.137.249.0/24", + "State": "pending-transfer" + } + } + +For more information, see `Tutorial: Transfer an existing BYOIP IPv4 CIDR to IPAM `__ in the *Amazon VPC IPAM User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/provision-ipam-pool-cidr.rst awscli-1.22.34/awscli/examples/ec2/provision-ipam-pool-cidr.rst --- awscli-1.21.9/awscli/examples/ec2/provision-ipam-pool-cidr.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/provision-ipam-pool-cidr.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,26 @@ +**To provision a CIDR to an IPAM pool** + +The following ``provision-ipam-pool-cidr`` example provisions a CIDR to an IPAM pool. + +(Linux):: + + aws ec2 provision-ipam-pool-cidr \ + --ipam-pool-id ipam-pool-0533048da7d823723 \ + --cidr 10.0.0.0/24 + +(Windows):: + + aws ec2 provision-ipam-pool-cidr ^ + --ipam-pool-id ipam-pool-0533048da7d823723 ^ + --cidr 10.0.0.0/24 + +Output:: + + { + "IpamPoolCidr": { + "Cidr": "10.0.0.0/24", + "State": "pending-provision" + } + } + +For more information, see `Provision CIDRs to a pool `__ in the *Amazon VPC IPAM User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/register-transit-gateway-multicast-group-members.rst awscli-1.22.34/awscli/examples/ec2/register-transit-gateway-multicast-group-members.rst --- awscli-1.21.9/awscli/examples/ec2/register-transit-gateway-multicast-group-members.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/register-transit-gateway-multicast-group-members.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,22 +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*. +**To view the information about the transit gateway multicast domain associations** + +The following ``register-transit-gateway-multicast-group-members`` example returns the associations for the specified 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 `Managing multicast domains `__ in the *Transit Gateways User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/register-transit-gateway-multicast-group-sources.rst awscli-1.22.34/awscli/examples/ec2/register-transit-gateway-multicast-group-sources.rst --- awscli-1.21.9/awscli/examples/ec2/register-transit-gateway-multicast-group-sources.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/register-transit-gateway-multicast-group-sources.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,22 @@ +**To register a source with a transit gateway multicast group.** + +The following ``register-transit-gateway-multicast-group-sources`` 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 `Managing multicast domains `__ in the *Transit Gateways Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/reject-transit-gateway-vpc-attachments.rst awscli-1.22.34/awscli/examples/ec2/reject-transit-gateway-vpc-attachments.rst --- awscli-1.21.9/awscli/examples/ec2/reject-transit-gateway-vpc-attachments.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/reject-transit-gateway-vpc-attachments.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,28 +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*. +**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 *Transit Gateways Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/replace-transit-gateway-route.rst awscli-1.22.34/awscli/examples/ec2/replace-transit-gateway-route.rst --- awscli-1.21.9/awscli/examples/ec2/replace-transit-gateway-route.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/replace-transit-gateway-route.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,27 +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*. +**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 *Transit Gateways Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/search-transit-gateway-multicast-groups.rst awscli-1.22.34/awscli/examples/ec2/search-transit-gateway-multicast-groups.rst --- awscli-1.21.9/awscli/examples/ec2/search-transit-gateway-multicast-groups.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/search-transit-gateway-multicast-groups.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,26 +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*. +**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 `Managing multicast groups `__ in the *Transit Gateways Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ec2/search-transit-gateway-routes.rst awscli-1.22.34/awscli/examples/ec2/search-transit-gateway-routes.rst --- awscli-1.21.9/awscli/examples/ec2/search-transit-gateway-routes.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ec2/search-transit-gateway-routes.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,41 +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*. +**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 `Transit gateway route tables `__ in the *Transit Gateways Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/elbv2/modify-listener.rst awscli-1.22.34/awscli/examples/elbv2/modify-listener.rst --- awscli-1.21.9/awscli/examples/elbv2/modify-listener.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/elbv2/modify-listener.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,59 +1,86 @@ -**To change the default action** - -This example changes the default action for the specified listener. - -Command:: - - aws elbv2 modify-listener --listener-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2 --default-actions Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/2453ed029918f21f - -Output:: - - { - "Listeners": [ - { - "Protocol": "HTTP", - "DefaultActions": [ - { - "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/2453ed029918f21f", - "Type": "forward" - } - ], - "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", - "Port": 80, - "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2" - } - ] - } - -**To change the server certificate** - -This example changes the server certificate for the specified HTTPS listener. - -Command:: - - aws elbv2 modify-listener --listener-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65 --certificates CertificateArn=arn:aws:iam::123456789012:server-certificate/my-new-server-cert - -Output:: - - { - "Listeners": [ - { - "Protocol": "HTTPS", - "DefaultActions": [ - { - "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", - "Type": "forward" - } - ], - "SslPolicy": "ELBSecurityPolicy-2015-05", - "Certificates": [ - { - "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-new-server-cert" - } - ], - "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", - "Port": 443, - "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65" - } - ] - } +**Example 1: To change the default action to a forward action** + +The following ``modify-listener`` example changes the default action (to a **forward** action)for the specified listener. :: + + aws elbv2 modify-listener \ + --listener-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2 \ + --default-actions Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/2453ed029918f21f + +Output:: + + { + "Listeners": [ + { + "Protocol": "HTTP", + "DefaultActions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/2453ed029918f21f", + "Type": "forward" + } + ], + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Port": 80, + "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2" + } + ] + } + +**Example 2: To change the default action to a redirect action** + +The following ``modify-listener`` example changes the default action to a **redirect** action for the specified listener. :: + + aws elbv2 modify-listener \ + --listener-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2 \ + --default-actions Type=redirect,TargetGroupArn=arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/2453ed029918f21f + +Output:: + + { + "Listeners": [ + { + "Protocol": "HTTP", + "DefaultActions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/2453ed029918f21f", + "Type": "redirect" + } + ], + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Port": 80, + "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2" + } + ] + } + +**Example 3: To change the server certificate** + +This example changes the server certificate for the specified HTTPS listener. :: + + aws elbv2 modify-listener \ + --listener-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65 \ + --certificates CertificateArn=arn:aws:iam::123456789012:server-certificate/my-new-server-cert + +Output:: + + { + "Listeners": [ + { + "Protocol": "HTTPS", + "DefaultActions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Type": "forward" + } + ], + "SslPolicy": "ELBSecurityPolicy-2015-05", + "Certificates": [ + { + "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-new-server-cert" + } + ], + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Port": 443, + "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65" + } + ] + } \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/iot/delete-domain-configuration.rst awscli-1.22.34/awscli/examples/iot/delete-domain-configuration.rst --- awscli-1.21.9/awscli/examples/iot/delete-domain-configuration.rst 2021-11-02 18:19:32.000000000 +0000 +++ awscli-1.22.34/awscli/examples/iot/delete-domain-configuration.rst 2022-01-12 19:04:32.000000000 +0000 @@ -2,10 +2,10 @@ The following ``delete-domain-configuration`` example deletes a domain configuration named ``additionalDataDomain`` from your AWS account. :: - aws iot update-domain-configuration \ + aws iot delete-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*. +For more information, see `Configurable Endpoints `__ in the *AWS IoT Developer Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ram/accept-resource-share-invitation.rst awscli-1.22.34/awscli/examples/ram/accept-resource-share-invitation.rst --- awscli-1.21.9/awscli/examples/ram/accept-resource-share-invitation.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ram/accept-resource-share-invitation.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,23 +1,20 @@ **To accept a resource share invitation** -The following ``reject-resource-share-invitation`` example rejects the specified resource share invitation. :: +The following ``accept-resource-share-invitation`` example accepts the specified resource share invitation. Principals in the invited account can immediately start using the resources in the share. :: - 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 + aws ram accept-resource-share-invitation \ + --resource-share-invitation-arn arn:aws:ram:us-west-2:111111111111:resource-share-invitation/1e3477be-4a95-46b4-bbe0-c4001EXAMPLE 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" - } - ] + "resourceShareInvitation": { + "resourceShareInvitationArn": "arn:aws:ram:us-west-2:111111111111:resource-share-invitation/1e3477be-4a95-46b4-bbe0-c4001EXAMPLE", + "resourceShareName": "MyLicenseShare", + "resourceShareArn": "arn:aws:ram:us-west-2:111111111111:resource-share/27d09b4b-5e12-41d1-a4f2-19dedEXAMPLE", + "senderAccountId": "111111111111", + "receiverAccountId": "222222222222", + "invitationTimestamp": "2021-09-22T15:07:35.620000-07:00", + "status": "ACCEPTED" + } } - diff -Nru awscli-1.21.9/awscli/examples/ram/associate-resource-share-permission.rst awscli-1.22.34/awscli/examples/ram/associate-resource-share-permission.rst --- awscli-1.21.9/awscli/examples/ram/associate-resource-share-permission.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ram/associate-resource-share-permission.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,14 @@ +**To associate a RAM managed permission with a resource share** + +The following ``associate-resource-share-permission`` example replaces the existing managed permission for the relevant resource type with the specified managed permission. Access to all resources of the relevant resource type is governed by the new permission. :: + + aws ram associate-resource-share-permission \ + --permission-arn arn:aws:ram::aws:permission/AWSRAMPermissionGlueDatabaseReadWrite \ + --replace \ + --resource-share-arn arn:aws:ram:us-west-2:123456789012:resource-share/27d09b4b-5e12-41d1-a4f2-19dedEXAMPLE + +Output:: + + { + "returnValue": true + } \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ram/associate-resource-share.rst awscli-1.22.34/awscli/examples/ram/associate-resource-share.rst --- awscli-1.21.9/awscli/examples/ram/associate-resource-share.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ram/associate-resource-share.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,19 +1,43 @@ -**To associate a resource with a resource share** +**Example 1: To associate a resource with a resource share** -The following ``associate-resource-share`` example associates the specified subnet with the specified resource share. :: +The following ``associate-resource-share`` example adds a license configuration to 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 + --resource-share arn:aws:ram:us-west-2:123456789012:resource-share/27d09b4b-5e12-41d1-a4f2-19dedEXAMPLE \ + --resource-arns arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-36be0485f5ae379cc74cf8e92EXAMPLE 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 + { + "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/27d09b4b-5e12-41d1-a4f2-19dedEXAMPLE", + "associatedEntity": "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-36be0485f5ae379cc74cf8e92EXAMPLE", + "associationType": "RESOURCE", + "status": "ASSOCIATING", + "external": false + } ] } + +**Example 2: To associate a principal with a resource share** + +The following ``associate-resource-share`` example grants access for the specified resource share to all accounts in the specified organizational unit. :: + + aws ram associate-resource-share \ + --resource-share-arn arn:aws:ram:us-west-2:123456789012:resource-share/27d09b4b-5e12-41d1-a4f2-19dedEXAMPLE \ + --principals arn:aws:organizations::123456789012:ou/o-63bEXAMPLE/ou-46xi-rEXAMPLE + +Output:: + + { + "resourceShareAssociations": [ + { + "status": "ASSOCIATING", + "associationType": "PRINCIPAL", + "associatedEntity": "arn:aws:organizations::123456789012:ou/o-63bEXAMPLE/ou-46xi-rEXAMPLE", + "external": false, + "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/27d09b4b-5e12-41d1-a4f2-19dedEXAMPLE" + } + ] + } \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ram/create-resource-share.rst awscli-1.22.34/awscli/examples/ram/create-resource-share.rst --- awscli-1.21.9/awscli/examples/ram/create-resource-share.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ram/create-resource-share.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,51 +1,51 @@ **Example 1: To create a resource share** -The following ``create-resource-share`` example creates a resource share with the specified name. :: +The following ``create-resource-share`` example creates an empty resource share with the specified name. You must separately add resources, principals, and permissions to the share. :: aws ram create-resource-share \ - --name my-resource-share + --name MyNewResourceShare Output:: { "resourceShare": { - "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE", - "name": "my-resource-share", + "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/4476c27d-8feb-4b21-afe9-7de23EXAMPLE", + "name": "MyNewResourceShare", "owningAccountId": "123456789012", "allowExternalPrincipals": true, "status": "ACTIVE", - "creationTime": 1565295733.282, - "lastUpdatedTime": 1565295733.282 + "creationTime": 1634586271.302, + "lastUpdatedTime": 1634586271.302 } } **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. :: +The following ``create-resource-share`` example creates a resource share and grants access to the specified AWS account (222222222222). If the specified principals are not part of the same AWS Organization, then invitations are sent and must be accepted before access is granted. :: aws ram create-resource-share \ - --name my-resource-share \ - --principals 0abcdef1234567890 + --name MyNewResourceShare \ + --principals 222222222222 -**EXAMPLE 3: To create a resource share restricted to your organization in AWS Organizations** +**Example 3: To create a resource share restricted to your AWS Organization** -The following ``create-resource-share`` example creates a resource share that is restricted to your organization and adds the specified OU as a principal. :: +The following ``create-resource-share`` example creates a resource share that is restricted to accounts in the AWS Organization that your account is a member of, and adds the specified OU as a principal. All accounts in that OU can use the resources in the resource share. :: - aws ram create-resource-share \ - --name my-resource-share \ - --no-allow-external-principals \ - --principals arn:aws:organizations::123456789012:ou/o-gx7EXAMPLE/ou-29c5-zEXAMPLE + aws ram create-resource-share \ + --name MyNewResourceShare \ + --no-allow-external-principals \ + --principals arn:aws:organizations::123456789012:ou/o-63bEXAMPLE/ou-46xi-rEXAMPLE Output:: { "resourceShare": { - "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/3ab63985-99d9-1cd2-7d24-75e93EXAMPLE", - "name": "my-resource-share", + "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/7be8694e-095c-41ca-9ce8-7be4aEXAMPLE", + "name": "MyNewResourceShare", "owningAccountId": "123456789012", "allowExternalPrincipals": false, "status": "ACTIVE", - "creationTime": 1565295733.282, - "lastUpdatedTime": 1565295733.282 + "creationTime": 1634587042.49, + "lastUpdatedTime": 1634587042.49 } - } + } \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ram/disassociate-resource-share-permission.rst awscli-1.22.34/awscli/examples/ram/disassociate-resource-share-permission.rst --- awscli-1.21.9/awscli/examples/ram/disassociate-resource-share-permission.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ram/disassociate-resource-share-permission.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,13 @@ +**To remove a RAM managed permission for a resource type from a resource share** + +The following ``disassociate-resource-share-permission`` example removes the RAM managed permission for Glue databases from the specified resource share. :: + + aws ram disassociate-resource-share-permission \ + --resource-share-arn arn:aws:ram:us-west-2:123456789012:resource-share/27d09b4b-5e12-41d1-a4f2-19dedEXAMPLE \ + --permission-arn arn:aws:ram::aws:permission/AWSRAMPermissionGlueDatabaseReadWrite + +Output:: + + { + "returnValue": true + } diff -Nru awscli-1.21.9/awscli/examples/ram/disassociate-resource-share.rst awscli-1.22.34/awscli/examples/ram/disassociate-resource-share.rst --- awscli-1.21.9/awscli/examples/ram/disassociate-resource-share.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ram/disassociate-resource-share.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,9 +1,9 @@ -**To disassociate a resource from a resource share** +**To remove a resource from a resource share** -The following ``disassociate-resource-share`` example disassociates the specified subnet from the specified resource share. :: +The following ``disassociate-resource-share`` example removes the specified resource, in this case a VPC subnet, from the specified resource share. Any principals with access to the resource share can no longer perform operations on that resource. :: aws ram disassociate-resource-share \ - --resource-arns arn:aws:ec2:us-west-2:123456789012:subnet/subnet-0250c25a1f4e15235 \ + --resource-arns arn:aws:ec2:us-west-2:123456789012:subnet/subnet-0250c25a1fEXAMPLE \ --resource-share-arn arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE Output:: @@ -11,7 +11,7 @@ { "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", + "associatedEntity": "arn:aws:ec2:us-west-2:123456789012:subnet/subnet-0250c25a1fEXAMPLE", "associationType": "RESOURCE", "status": "DISASSOCIATING", "external": false diff -Nru awscli-1.21.9/awscli/examples/ram/enable-sharing-with-aws-organization.rst awscli-1.22.34/awscli/examples/ram/enable-sharing-with-aws-organization.rst --- awscli-1.21.9/awscli/examples/ram/enable-sharing-with-aws-organization.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ram/enable-sharing-with-aws-organization.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,6 +1,6 @@ **To enable resource sharing across AWS Organizations** -The following ``enable-sharing-with-aws-organization`` example enables resource sharing across your organization or organizational units. :: +The following ``enable-sharing-with-aws-organization`` example enables resource sharing across your organization and organizational units. :: aws ram enable-sharing-with-aws-organization @@ -8,4 +8,4 @@ { "returnValue": true - } + } \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ram/get-permission.rst awscli-1.22.34/awscli/examples/ram/get-permission.rst --- awscli-1.21.9/awscli/examples/ram/get-permission.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ram/get-permission.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,22 @@ +**To retrieve the details for a RAM managed permission** + +The following ``get-permission`` example displays the details for the default version of the specified RAM managed permission. :: + + aws ram get-permission \ + --permission-arn arn:aws:ram::aws:permission/AWSRAMPermissionGlueTableReadWriteForDatabase + +Output:: + + { + "permission": { + "arn": "arn:aws:ram::aws:permission/AWSRAMPermissionGlueTableReadWriteForDatabase", + "version": "2", + "defaultVersion": true, + "name": "AWSRAMPermissionGlueTableReadWriteForDatabase", + "resourceType": "glue:Database", + "permission": "{\"Effect\":\"Allow\",\"Action\":[\"glue:GetTable\", \"glue:UpdateTable\", \"glue:DeleteTable\", \"glue:BatchDeleteTable\", \"glue:BatchDeleteTableVersion\", \"glue:GetTableVersion\", \"glue:GetTableVersions\", \"glue:GetPartition\", \"glue:GetPartitions\", \"glue:BatchGetPartition\", \"glue:BatchCreatePartition\", \"glue:CreatePartition\", \"glue:UpdatePartition\", \"glue:BatchDeletePartition\", \"glue:DeletePartition\", \"glue:GetTables\", \"glue:SearchTables\"]}", + "creationTime": 1624912434.431, + "lastUpdatedTime": 1624912434.431, + "isResourceTypeDefault": false + } + } diff -Nru awscli-1.21.9/awscli/examples/ram/get-resource-policies.rst awscli-1.22.34/awscli/examples/ram/get-resource-policies.rst --- awscli-1.21.9/awscli/examples/ram/get-resource-policies.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ram/get-resource-policies.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,14 +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. :: +The following ``get-resource-policies`` example displays the resource-based permission policies for the specified resource associated with a resource share. :: aws ram get-resource-policies \ - --resource-arns arn:aws:ec2:us-west-2:123456789012:subnet/subnet-0250c25a1f4e15235 + --resource-arns arn:aws:ec2:us-west-2:123456789012:subnet/subnet-0250c25a1fEXAMPLE 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\"}]}" + "{\"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-0250c25a1fEXAMPLE\"}]}" ] } diff -Nru awscli-1.21.9/awscli/examples/ram/get-resource-share-associations.rst awscli-1.22.34/awscli/examples/ram/get-resource-share-associations.rst --- awscli-1.21.9/awscli/examples/ram/get-resource-share-associations.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ram/get-resource-share-associations.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,6 +1,6 @@ -**Example 1: To list resource associations** +**Example 1: To list all resource associations for all resource types** -The following ``get-resource-share-associations`` example lists your resource associations. :: +The following ``get-resource-share-associations`` example lists the resource associations for all resource types across all of your resource shares. :: aws ram get-resource-share-associations \ --association-type RESOURCE @@ -11,36 +11,48 @@ "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", + "associatedEntity": "arn:aws:ec2:us-west-2:123456789012:subnet/subnet-0250c25a1fEXAMPLE", + "resourceShareName": "MySubnetShare", "associationType": "RESOURCE", "status": "ASSOCIATED", "creationTime": 1565303590.973, "lastUpdatedTime": 1565303591.695, "external": false + }, + { + "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/8167bdfe-4480-4a01-8632-315e0EXAMPLE", + "associatedEntity": "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-36be0485f5ae379cc74cf8e92EXAMPLE", + "resourceShareName": "MyLicenseShare", + "associationType": "RESOURCE", + "status": "ASSOCIATED", + "creationTime": 1632342958.457, + "lastUpdatedTime": 1632342958.907, + "external": false } ] } -**Example 2: To list principal associations** +**Example 2: To list principal associations for a resource share** -The following ``get-resource-share-associations`` example lists the principal associations for the specified resource share. :: +The following ``get-resource-share-associations`` example lists only the principal associations for only the specified resource share. :: + + aws ram get-resource-share-associations \ + --resource-share-arns arn:aws:ram:us-west-2:123456789012:resource-share/7be8694e-095c-41ca-9ce8-7be4aEXAMPLE \ + --association-type PRINCIPAL - 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", + "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/7be8694e-095c-41ca-9ce8-7be4aEXAMPLE", + "resourceShareName": "MyNewResourceShare", + "associatedEntity": "arn:aws:organizations::123456789012:ou/o-63bEXAMPLE/ou-46xi-rEXAMPLE", "associationType": "PRINCIPAL", "status": "ASSOCIATED", - "creationTime": 1565296791.818, - "lastUpdatedTime": 1565296792.119, - "external": true + "creationTime": 1634587042.49, + "lastUpdatedTime": 1634587044.291, + "external": false } ] } diff -Nru awscli-1.21.9/awscli/examples/ram/get-resource-share-invitations.rst awscli-1.22.34/awscli/examples/ram/get-resource-share-invitations.rst --- awscli-1.21.9/awscli/examples/ram/get-resource-share-invitations.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ram/get-resource-share-invitations.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,6 +1,6 @@ **To list your resource share invitations** -The following ``get-resource-share-invitations`` example lists your resource share invitations. :: +The following ``get-resource-share-invitations`` example lists your current resource share invitations. :: aws ram get-resource-share-invitations @@ -9,11 +9,11 @@ { "resourceShareInvitations": [ { - "resourceShareInvitationArn": "arn:aws:ram:us-west2-1:21077EXAMPLE:resource-share-invitation/32b639f0-14b8-7e8f-55ea-e6117EXAMPLE", + "resourceShareInvitationArn": "arn:aws:ram:us-west2-1:111111111111: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", + "resourceShareArn": "arn:aws:ram:us-west-2:111111111111:resource-share/fcb639f0-1449-4744-35bc-a983fEXAMPLE", + "senderAccountId": "111111111111", + "receiverAccountId": "222222222222", "invitationTimestamp": 1565312166.258, "status": "PENDING" } diff -Nru awscli-1.21.9/awscli/examples/ram/get-resource-shares.rst awscli-1.22.34/awscli/examples/ram/get-resource-shares.rst --- awscli-1.21.9/awscli/examples/ram/get-resource-shares.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ram/get-resource-shares.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,6 +1,6 @@ -**To list your resource shares** +**Example 1: To list resource shares you own and share with others** -The following ``get-resource-shares`` example lists your resource shares. :: +The following ``get-resource-shares`` example lists the resource shares that created and are sharing with others. :: aws ram get-resource-shares \ --resource-owner SELF @@ -35,3 +35,16 @@ } ] } + +**Example 2: To list resource shares owned by others and shared with you** + +The following ``get-resource-shares`` example lists the resource shares that others created and shared with you. In this example, there are none. :: + + aws ram get-resource-shares \ + --resource-owner OTHER-ACCOUNTS + +Output:: + + { + "resourceShares": [] + } diff -Nru awscli-1.21.9/awscli/examples/ram/list-pending-invitation-resources.rst awscli-1.22.34/awscli/examples/ram/list-pending-invitation-resources.rst --- awscli-1.21.9/awscli/examples/ram/list-pending-invitation-resources.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ram/list-pending-invitation-resources.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,29 @@ +**To list the resources that are available in a pending resource share** + +The following ``list-pending-invitation-resources`` example lists all of the resources that are in the resource share associated with the specified invitation. :: + + aws ram list-pending-invitation-resources \ + --resource-share-invitation-arn arn:aws:ram:us-west-2:123456789012:resource-share-invitation/1e3477be-4a95-46b4-bbe0-c4001EXAMPLE + +Output:: + + { + "resources": [ + { + "arn": "arn:aws:ec2:us-west-2:123456789012:subnet/subnet-04a555b0e6EXAMPLE", + "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/7be8694e-095c-41ca-9ce8-7be4aEXAMPLE", + "creationTime": 1634676051.269, + "lastUpdatedTime": 1634676052.07, + "status": "AVAILABLE", + "type": "ec2:Subnet" + }, + { + "arn": "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-36be0485f5ae379cc74cf8e92EXAMPLE", + "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE", + "creationTime": 1624912434.431, + "lastUpdatedTime": 1624912434.431, + "status": "AVAILABLE", + "type": "license-manager:LicenseConfiguration" + } + ] + } diff -Nru awscli-1.21.9/awscli/examples/ram/list-permissions.rst awscli-1.22.34/awscli/examples/ram/list-permissions.rst --- awscli-1.21.9/awscli/examples/ram/list-permissions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ram/list-permissions.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,95 @@ +**To list the available RAM managed permissions** + +The following ``list-permissions`` example lists all of the RAM managed permissions available for only the AWS Glue database resource type. :: + + aws ram list-permissions \ + --resource-type glue:Database + +Output:: + + { + "permissions": [ + { + "arn": "arn:aws:ram::aws:permission/AWSRAMDefaultPermissionGlueDatabase", + "version": "1", + "defaultVersion": true, + "name": "AWSRAMDefaultPermissionGlueDatabase", + "resourceType": "glue:Database", + "creationTime": 1592007820.935, + "lastUpdatedTime": 1592007820.935, + "isResourceTypeDefault": true + }, + { + "arn": "arn:aws:ram::aws:permission/AWSRAMPermissionGlueAllTablesReadWriteForDatabase", + "version": "2", + "defaultVersion": true, + "name": "AWSRAMPermissionGlueAllTablesReadWriteForDatabase", + "resourceType": "glue:Database", + "creationTime": 1624912413.323, + "lastUpdatedTime": 1624912413.323, + "isResourceTypeDefault": false + }, + { + "arn": "arn:aws:ram::aws:permission/AWSRAMPermissionGlueDatabaseReadWrite", + "version": "2", + "defaultVersion": true, + "name": "AWSRAMPermissionGlueDatabaseReadWrite", + "resourceType": "glue:Database", + "creationTime": 1624912417.4, + "lastUpdatedTime": 1624912417.4, + "isResourceTypeDefault": false + }, + { + "arn": "arn:aws:ram::aws:permission/AWSRAMPermissionGlueTableReadWriteForDatabase", + "version": "2", + "defaultVersion": true, + "name": "AWSRAMPermissionGlueTableReadWriteForDatabase", + "resourceType": "glue:Database", + "creationTime": 1624912434.431, + "lastUpdatedTime": 1624912434.431, + "isResourceTypeDefault": false + } + ] + } + +The following ``list-permissions`` example displays the available RAM managed permissions for all resource types. :: + + aws ram list-permissions + +Output:: + + { + "permissions": [ + { + "arn": "arn:aws:ram::aws:permission/AWSRAMBlankEndEntityCertificateAPICSRPassthroughIssuanceCertificateAuthority", + "version": "1", + "defaultVersion": true, + "name": "AWSRAMBlankEndEntityCertificateAPICSRPassthroughIssuanceCertificateAuthority", + "resourceType": "acm-pca:CertificateAuthority", + "creationTime": 1623264861.085, + "lastUpdatedTime": 1623264861.085, + "isResourceTypeDefault": false + }, + { + "arn": "arn:aws:ram::aws:permission/AWSRAMDefaultPermissionAppMesh", + "version": "1", + "defaultVersion": true, + "name": "AWSRAMDefaultPermissionAppMesh", + "resourceType": "appmesh:Mesh", + "creationTime": 1589307188.584, + "lastUpdatedTime": 1589307188.584, + "isResourceTypeDefault": true + }, + ...TRUNCATED FOR BREVITY... + { + "arn": "arn:aws:ram::aws:permission/AWSRAMSubordinateCACertificatePathLen0IssuanceCertificateAuthority", + "version": "1", + "defaultVersion": true, + "name": "AWSRAMSubordinateCACertificatePathLen0IssuanceCertificateAuthority", + "resourceType": "acm-pca:CertificateAuthority", + "creationTime": 1623264876.75, + "lastUpdatedTime": 1623264876.75, + "isResourceTypeDefault": false + } + ] + } diff -Nru awscli-1.21.9/awscli/examples/ram/list-principals.rst awscli-1.22.34/awscli/examples/ram/list-principals.rst --- awscli-1.21.9/awscli/examples/ram/list-principals.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ram/list-principals.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,6 +1,6 @@ **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. :: +The following ``list-principals`` example displays a list of the principals that can access resources of the specified type through any resource shares. :: aws ram list-principals \ --resource-type ec2:Subnet diff -Nru awscli-1.21.9/awscli/examples/ram/list-resource-share-permissions.rst awscli-1.22.34/awscli/examples/ram/list-resource-share-permissions.rst --- awscli-1.21.9/awscli/examples/ram/list-resource-share-permissions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ram/list-resource-share-permissions.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,27 @@ +**To list all of the RAM managed permissions currently attached to a resource share** + +The following ``list-resource-share-permissions`` example lists all of the RAM managed permissions that are attached to the specified resource share. :: + + aws ram list-resource-share-permissions \ + --resource-share-arn arn:aws:ram:us-west-2:123456789012:resource-share/27d09b4b-5e12-41d1-a4f2-19dedEXAMPLE + +Output:: + + { + "permissions": [ + { + "arn": "arn:aws:ram::aws:permission/AWSRAMDefaultPermissionLicenseConfiguration", + "version": "1", + "resourceType": "license-manager:LicenseConfiguration", + "status": "ASSOCIATED", + "lastUpdatedTime": 1632342984.234 + }, + { + "arn": "arn:aws:ram::aws:permission/AWSRAMPermissionGlueDatabaseReadWrite", + "version": "2", + "resourceType": "glue:Database", + "status": "ASSOCIATED", + "lastUpdatedTime": 1632512462.297 + } + ] + } diff -Nru awscli-1.21.9/awscli/examples/ram/list-resources.rst awscli-1.22.34/awscli/examples/ram/list-resources.rst --- awscli-1.21.9/awscli/examples/ram/list-resources.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ram/list-resources.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,6 +1,6 @@ **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. :: +The following ``list-resources`` example lists all resources in the specified resource share that are of the specified resource type. :: aws ram list-resources \ --resource-type ec2:Subnet \ diff -Nru awscli-1.21.9/awscli/examples/ram/list-resource-types.rst awscli-1.22.34/awscli/examples/ram/list-resource-types.rst --- awscli-1.21.9/awscli/examples/ram/list-resource-types.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ram/list-resource-types.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,29 @@ +**To list the resource types that are supported by AWS RAM** + +The following ``list-resource-types`` example lists all of the resource types currently supported by AWS RAM. :: + + aws ram list-resource-types + +Output:: + + { + "resourceTypes": [ + { + "resourceType": "route53resolver:FirewallRuleGroup", + "serviceName": "route53resolver" + }, + { + "resourceType": "ec2:LocalGatewayRouteTable", + "serviceName": "ec2" + }, + ...OUTPUT TRUNCATED FOR BREVITY... + { + "resourceType": "ec2:Subnet", + "serviceName": "ec2" + }, + { + "resourceType": "ec2:TransitGatewayMulticastDomain", + "serviceName": "ec2" + } + ] + } diff -Nru awscli-1.21.9/awscli/examples/ram/promote-resource-share-created-from-policy.rst awscli-1.22.34/awscli/examples/ram/promote-resource-share-created-from-policy.rst --- awscli-1.21.9/awscli/examples/ram/promote-resource-share-created-from-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ram/promote-resource-share-created-from-policy.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,12 @@ +**To promote a resource-policy based resource share to full functionality in AWS RAM** + +The following ``promote-resource-share-created-from-policy`` example takes a resource share that you created implicitly by attaching a resource-based policy, and converts it to be fully functional with the AWS RAM console and its CLI and API operations. :: + + aws ram promote-resource-share-created-from-policy \ + --resource-share-arn arn:aws:ram:us-east-1:123456789012:resource-share/91fa8429-2d06-4032-909a-90909EXAMPLE + +Output:: + + { + "returnValue": true + } diff -Nru awscli-1.21.9/awscli/examples/ram/reject-resource-share-invitation.rst awscli-1.22.34/awscli/examples/ram/reject-resource-share-invitation.rst --- awscli-1.21.9/awscli/examples/ram/reject-resource-share-invitation.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ram/reject-resource-share-invitation.rst 2022-01-12 19:04:32.000000000 +0000 @@ -3,17 +3,17 @@ 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 + --resource-share-invitation-arn arn:aws:ram:us-west-2:111111111111: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", + "resourceShareInvitationArn": "arn:aws:ram:us-west2-1:111111111111: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", + "resourceShareArn": "arn:aws:ram:us-west-2:111111111111:resource-share/fcb639f0-1449-4744-35bc-a983fEXAMPLE", + "senderAccountId": "111111111111", + "receiverAccountId": "222222222222", "invitationTimestamp": 1565319592.463, "status": "REJECTED" } diff -Nru awscli-1.21.9/awscli/examples/ram/tag-resource.rst awscli-1.22.34/awscli/examples/ram/tag-resource.rst --- awscli-1.21.9/awscli/examples/ram/tag-resource.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ram/tag-resource.rst 2022-01-12 19:04:32.000000000 +0000 @@ -3,7 +3,7 @@ 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 + --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.21.9/awscli/examples/ram/untag-resource.rst awscli-1.22.34/awscli/examples/ram/untag-resource.rst --- awscli-1.21.9/awscli/examples/ram/untag-resource.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ram/untag-resource.rst 2022-01-12 19:04:32.000000000 +0000 @@ -3,6 +3,7 @@ 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 + --tag-keys project \ + --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.21.9/awscli/examples/ram/update-resource-share.rst awscli-1.22.34/awscli/examples/ram/update-resource-share.rst --- awscli-1.21.9/awscli/examples/ram/update-resource-share.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ram/update-resource-share.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,6 +1,6 @@ **To update a resource share** -The following ``update-resource-share`` example makes changes to the specified resource share. :: +The following ``update-resource-share`` example changes the specified resource share to allow external principals that are not in an AWS Organization. :: aws ram update-resource-share \ --allow-external-principals \ diff -Nru awscli-1.21.9/awscli/examples/s3api/create-bucket.rst awscli-1.22.34/awscli/examples/s3api/create-bucket.rst --- awscli-1.21.9/awscli/examples/s3api/create-bucket.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/s3api/create-bucket.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,24 +1,52 @@ -The following command creates a bucket named ``my-bucket``:: +**Example 1: To create a bucket** - aws s3api create-bucket --bucket my-bucket --region us-east-1 +The following ``create-bucket`` example creates a bucket named ``my-bucket``:: + + aws s3api create-bucket \ + --bucket my-bucket \ + --region us-east-1 Output:: - { - "Location": "/my-bucket" - } + { + "Location": "/my-bucket" + } + +For more information, see `Creating a bucket `__ in the *Amazon S3 User Guide*. +**Example 2: To create a bucket with owner enforced** + +The following ``create-bucket`` example creates a bucket named ``my-bucket`` that uses the bucket owner enforced setting for S3 Object Ownership. :: + + aws s3api create-bucket \ + --bucket my-bucket \ + --region us-east-1 \ + --object-ownership BucketOwnerEnforced + +Output:: -The following command creates a bucket named ``my-bucket`` in the + { + "Location": "/my-bucket" + } + +For more information, see `Controlling ownership of objects and disabling ACLs `__ in the *Amazon S3 User Guide*. + +**Example 3: To create a bucket outside of the ``us-east-1`` region** + +The following ``create-bucket`` example creates a bucket named ``my-bucket`` in the ``eu-west-1`` region. Regions outside of ``us-east-1`` require the appropriate ``LocationConstraint`` to be specified in order to create the bucket in the -desired region:: - - $ aws s3api create-bucket --bucket my-bucket --region eu-west-1 --create-bucket-configuration LocationConstraint=eu-west-1 +desired region. :: + aws s3api create-bucket \ + --bucket my-bucket \ + --region eu-west-1 \ + --create-bucket-configuration LocationConstraint=eu-west-1 Output:: { "Location": "http://my-bucket.s3.amazonaws.com/" } + +For more information, see `Creating a bucket `__ in the *Amazon S3 User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/s3api/put-bucket-logging.rst awscli-1.22.34/awscli/examples/s3api/put-bucket-logging.rst --- awscli-1.21.9/awscli/examples/s3api/put-bucket-logging.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/s3api/put-bucket-logging.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,31 +1,83 @@ -The example below sets the logging policy for *MyBucket*. The AWS user *bob@example.com* will have full control over -the log files, and no one else has any access. First, grant S3 permission with ``put-bucket-acl``:: +**Example 1: To set bucket policy logging** - aws s3api put-bucket-acl --bucket MyBucket --grant-write URI=http://acs.amazonaws.com/groups/s3/LogDelivery --grant-read-acp URI=http://acs.amazonaws.com/groups/s3/LogDelivery +The following ``put-bucket-logging`` example sets the logging policy for *MyBucket*. First, grant the logging service principal permission in your bucket policy using the ``put-bucket-policy`` command. :: -Then apply the logging policy:: + aws s3api put-bucket-policy \ + --bucket MyBucket \ + --policy file://policy.json - aws s3api put-bucket-logging --bucket MyBucket --bucket-logging-status file://logging.json - -``logging.json`` is a JSON document in the current folder that contains the logging policy:: +Contents of ``policy.json``:: { - "LoggingEnabled": { - "TargetBucket": "MyBucket", - "TargetPrefix": "MyBucketLogs/", - "TargetGrants": [ - { - "Grantee": { - "Type": "AmazonCustomerByEmail", - "EmailAddress": "bob@example.com" - }, - "Permission": "FULL_CONTROL" - } + "Version": "2012-10-17", + "Statement": [ + { + "Sid": "S3ServerAccessLogsPolicy", + "Effect": "Allow", + "Principal": {"Service": "logging.s3.amazonaws.com"}, + "Action": "s3:PutObject", + "Resource": "arn:aws:s3:::MyBucket/Logs/*", + "Condition": { + "ArnLike": {"aws:SourceARN": "arn:aws:s3:::SOURCE-BUCKET-NAME"}, + "StringEquals": {"aws:SourceAccount": "SOURCE-AWS-ACCOUNT-ID"} + } + } ] - } } -.. note:: the ``put-bucket-acl`` command is required to grant S3's log delivery system the necessary permissions (write - and read-acp permissions). +To apply the logging policy, use ``put-bucket-logging``. :: + + aws s3api put-bucket-logging \ + --bucket MyBucket \ + --bucket-logging-status file://logging.json + +Contents of ``logging.json``:: + + { + "LoggingEnabled": { + "TargetBucket": "MyBucket", + "TargetPrefix": "Logs/" + } + } + +.. Note:: The ``put-bucket-policy`` command is required to grant ``s3:PutObject`` permissions to the logging service principal. + +For more information, see `Amazon S3 Server Access Logging `__ in the *Amazon S3 User Guide*. + +**Example 2: To set a bucket policy for logging access to only a single user** + +The following ``put-bucket-logging`` example sets the logging policy for *MyBucket*. The AWS user *bob@example.com* will have full control over +the log files, and no one else has any access. First, grant S3 permission with ``put-bucket-acl``. :: + + aws s3api put-bucket-acl \ + --bucket MyBucket \ + --grant-write URI=http://acs.amazonaws.com/groups/s3/LogDelivery \ + --grant-read-acp URI=http://acs.amazonaws.com/groups/s3/LogDelivery + +Then apply the logging policy using ``put-bucket-logging``. :: + + aws s3api put-bucket-logging \ + --bucket MyBucket \ + --bucket-logging-status file://logging.json + +Contents of ``logging.json``:: + + { + "LoggingEnabled": { + "TargetBucket": "MyBucket", + "TargetPrefix": "MyBucketLogs/", + "TargetGrants": [ + { + "Grantee": { + "Type": "AmazonCustomerByEmail", + "EmailAddress": "bob@example.com" + }, + "Permission": "FULL_CONTROL" + } + ] + } + } + +.. Note:: the ``put-bucket-acl`` command is required to grant S3's log delivery system the necessary permissions (write and read-acp permissions). -For more information, see `Amazon S3 Server Access Logging `__ in the *Amazon S3 Developer Guide*. +For more information, see `Amazon S3 Server Access Logging `__ in the *Amazon S3 Developer Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/secretsmanager/cancel-rotate-secret.rst awscli-1.22.34/awscli/examples/secretsmanager/cancel-rotate-secret.rst --- awscli-1.21.9/awscli/examples/secretsmanager/cancel-rotate-secret.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/secretsmanager/cancel-rotate-secret.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,13 +1,15 @@ -**To cancel scheduled rotation for a secret** - -The following example shows how to cancel rotation for a secret. The operation sets the ``RotationEnabled`` field to false and cancels all scheduled rotations. To resume scheduled rotations, you must re-enable rotation by calling the ``rotate-secret`` operation. :: - - aws secretsmanager cancel-rotate-secret --secret-id MyTestDatabaseSecret - -The output shows the following: :: - - { - "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", - "Name": "MyTestDatabaseSecret" - } - +**To turn off automatic rotation for a secret** + +The following ``cancel-rotate-secret`` example turns off automatic rotation for a secret. To resume rotation, call ``rotate-secret``. :: + + aws secretsmanager cancel-rotate-secret \ + --secret-id MyTestSecret + +Output:: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-a1b2c3", + "Name": "MyTestSecret" + } + +For more information, see `Rotate a secret `__ in the *Secrets Manager User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/secretsmanager/create-secret.rst awscli-1.22.34/awscli/examples/secretsmanager/create-secret.rst --- awscli-1.21.9/awscli/examples/secretsmanager/create-secret.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/secretsmanager/create-secret.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,15 +1,47 @@ -**To create a basic secret** - -The following example shows how to create a secret. The credentials stored in the encrypted secret value are retrieved from a file on disk named ``mycreds.json``. :: - - aws secretsmanager create-secret --name MyTestDatabaseSecret \ - --description "My test database secret created with the CLI" \ - --secret-string file://mycreds.json - -The output shows the following: :: - - { - "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", - "Name": "MyTestDatabaseSecret", - "VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE" - } \ No newline at end of file +**Example 1: To create a secret** + +The following ``create-secret`` example creates a secret with two key-value pairs. :: + + aws secretsmanager create-secret \ + --name MyTestSecret \ + --description "My test secret created with the CLI." \ + --secret-string "{\"user\":\"diegor\",\"password\":\"i29wwX!%9wFV\"}" + +Output:: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-a1b2c3", + "Name": "MyTestSecret", + "VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE" + } + +For more information, see `Create a secret `__ in the *Secrets Manager User Guide*. + +**Example 2: To create a secret from credentials in a JSON file** + +The following ``create-secret`` example creates a secret from credentials in a file. For more information, see `Loading AWS CLI parameters from a file `__ in the *AWS CLI User Guide*. :: + + aws secretsmanager create-secret \ + --name MyTestSecret \ + --secret-string file://mycreds.json + +Contents of ``mycreds.json``:: + + { + "engine": "mysql", + "username": "saanvis", + "password": "i29wwX!%9wFV", + "host": "my-database-endpoint.us-west-2.rds.amazonaws.com", + "dbname": "myDatabase", + "port": "3306" + } + +Output:: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-a1b2c3", + "Name": "MyTestSecret", + "VersionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" + } + +For more information, see `Create a secret `__ in the *Secrets Manager User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/secretsmanager/delete-resource-policy.rst awscli-1.22.34/awscli/examples/secretsmanager/delete-resource-policy.rst --- awscli-1.21.9/awscli/examples/secretsmanager/delete-resource-policy.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/secretsmanager/delete-resource-policy.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,13 +1,15 @@ -**To delete the resource-based policy attached to a secret** - -The following example shows how to delete the resource-based policy that is attached to a secret. For more information, see `Resource-based Policies` in the *Secrets Manager User Guide*. -.. _`Resource-based Policies`: http://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_overview.html#auth-and-access_resource-policies:: - - aws secretsmanager delete-resource-policy --secret-id MyTestDatabaseSecret - -The output shows the following. :: - - { - "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseMasterSecret-a1b2c3", - "Name": "MyTestDatabaseSecret" - } \ No newline at end of file +**To delete the resource-based policy attached to a secret** + +The following ``delete-resource-policy`` example deletes the resource-based policy attached to a secret. :: + + aws secretsmanager delete-resource-policy \ + --secret-id MyTestSecret + +Output:: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-a1b2c3", + "Name": "MyTestSecret" + } + +For more information, see `Authentication and access control `__ in the *Secrets Manager User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/secretsmanager/delete-secret.rst awscli-1.22.34/awscli/examples/secretsmanager/delete-secret.rst --- awscli-1.21.9/awscli/examples/secretsmanager/delete-secret.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/secretsmanager/delete-secret.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,14 +1,35 @@ -**To delete a secret** - -The following example shows how to delete a secret. The secret stays in your account in a deprecated and inaccessible state until the recovery window ends. After the date and time in the ``DeletionDate`` response field has passed, you can no longer recover this secret with restore-secret. :: - - aws secretsmanager delete-secret --secret-id MyTestDatabaseSecret1 \ - --recovery-window-in-days 7 - -The output shows the following: :: - - { - "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", - "Name": "MyTestDatabaseSecret", - "DeletionDate": 1524085349.095 - } \ No newline at end of file +**Example 1: To delete a secret** + +The following ``delete-secret`` example deletes a secret. You can recover the secret with ``restore-secret`` until the date and time in the ``DeletionDate`` response field. To delete a secret that is replicated to other regions, first remove its replicas with ``remove-regions-from-replication``, and then call ``delete-secret``. :: + + aws secretsmanager delete-secret \ + --secret-id MyTestSecret \ + --recovery-window-in-days 7 + +Output:: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-a1b2c3", + "Name": "MyTestSecret", + "DeletionDate": 1524085349.095 + } + +For more information, see `Delete a secret `__ in the *Secrets Manager User Guide*. + +**Example 2: To delete a secret without a recovery window** + +The following ``delete-secret`` example deletes a secret without a recovery window. Yuo can't recover this secret. :: + + aws secretsmanager delete-secret \ + --secret-id MyTestSecret \ + ----force-delete-without-recovery + +Output:: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-a1b2c3", + "Name": "MyTestSecret", + "DeletionDate": 1508750180.309 + } + +For more information, see `Delete a secret `__ in the *Secrets Manager User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/secretsmanager/describe-secret.rst awscli-1.22.34/awscli/examples/secretsmanager/describe-secret.rst --- awscli-1.21.9/awscli/examples/secretsmanager/describe-secret.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/secretsmanager/describe-secret.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,38 +1,56 @@ -**To retrieve the details of a secret** - -The following example shows how to get the details about a secret. :: - - aws secretsmanager describe-secret --secret-id MyTestDatabaseSecret - -The output shows the following: :: - - { - "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-Ca8JGt", - "Name": "MyTestDatabaseSecret", - "Description": "My test database secret", - "LastChangedDate": 1523477145.729, - "RotationEnabled": true - "RotationLambdaARN": "arn:aws:lambda:us-west-2:123456789012:function:MyTestRotationLambda", - "RotationRules": { - "AutomaticallyAfterDays": 30 - }, - "LastRotatedDate": 1525747253.72 - "Tags": [ - { - "Key": "SecondTag", - "Value": "AnotherValue" - }, - { - "Key": "FirstTag", - "Value": "SomeValue" - } - ], - "VersionIdsToStages": { - "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE": [ - "AWSPREVIOUS" - ], - "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE": [ - "AWSCURRENT" - ] - } - } \ No newline at end of file +**To retrieve the details of a secret** + +The following ``describe-secret`` example shows the details of a secret. :: + + aws secretsmanager describe-secret \ + --secret-id MyTestSecret + +Output:: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-Ca8JGt", + "Name": "MyTestSecret", + "Description": "My test secret", + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE", + "RotationEnabled": true, + "RotationLambdaARN": "arn:aws:lambda:us-west-2:123456789012:function:MyTestRotationLambda", + "RotationRules": { + "AutomaticallyAfterDays": 30 + }, + "LastRotatedDate": 1525747253.72, + "LastChangedDate": 1523477145.729, + "LastAccessedDate": 1524572133.25, + "Tags": [ + { + "Key": "SecondTag", + "Value": "AnotherValue" + }, + { + "Key": "FirstTag", + "Value": "SomeValue" + } + ], + "VersionIdsToStages": { + "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111": [ + "AWSPREVIOUS" + ], + "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222": [ + "AWSCURRENT" + ], + "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333": [ + "AWSPENDING" + ] + }, + "CreatedDate": 1521534252.66, + "PrimaryRegion": "us-west-2", + "ReplicationStatus": [ + { + "Region": "eu-west-3", + "KmsKeyId": "alias/aws/secretsmanager", + "Status": "InSync", + "StatusMessage": "Replication succeeded" + } + ] + } + +For more information, see `Secret `__ in the *Secrets Manager User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/secretsmanager/get-random-password.rst awscli-1.22.34/awscli/examples/secretsmanager/get-random-password.rst --- awscli-1.21.9/awscli/examples/secretsmanager/get-random-password.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/secretsmanager/get-random-password.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,11 +1,15 @@ -**To generate a random password** - -The following example shows how to request a randomly generated password. This example includes the optional flags to require spaces and at least one character of each included type. It specifies a length of 20 characters. :: - - aws secretsmanager get-random-password --include-space --password-length 20 --require-each-included-type - -The output shows the following: :: - - { - "RandomPassword": "N+Z43a,>vx7j O8^*<8i3" - } +**To generate a random password** + +The following ``get-random-password`` example generates a random password 20 characters long that includes at least one uppercase letter, lowercase letter, number, and punctuation. :: + + aws secretsmanager get-random-password \ + --require-each-included-type \ + --password-length 20 + +Output:: + + { + "RandomPassword": "N+Z43a,>vx7j.O8^*<8i3" + } + +For more information, see `Create and manage secrets `__ in the *Secrets Manager User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/secretsmanager/get-resource-policy.rst awscli-1.22.34/awscli/examples/secretsmanager/get-resource-policy.rst --- awscli-1.21.9/awscli/examples/secretsmanager/get-resource-policy.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/secretsmanager/get-resource-policy.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,16 +1,18 @@ -**To retrieve the resource-based policy attached to a secret** - -The following example shows how to retrieve the resource-based policy that is attached to a secret. For more information, see `Resource-based Policies` in the *Secrets Manager User Guide*. -.. _`Resource-based Policies`: http://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_overview.html#auth-and-access_resource-policies :: - - aws secretsmanager get-resource-policy --secret-id MyTestDatabaseSecret - -The output shows the following. It is shown here word-wrapped and with extra white-space removed for clarity. :: - - { - "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", - "Name": "MyTestDatabaseSecret", - "ResourcePolicy": "{\n\"Version\":\"2012-10-17\",\n\"Statement\":[{\n\"Effect\":\"Allow\",\n - \"Principal\":{\n\"AWS\":\"arn:aws:iam::123456789012:root\"\n},\n\"Action\": - \"secretsmanager:GetSecretValue\",\n\"Resource\":\"*\"\n}]\n}" - } \ No newline at end of file +**To retrieve the resource-based policy attached to a secret** + +The following ``get-resource-policy`` example retrieves the resource-based policy attached to a secret. :: + + aws secretsmanager get-resource-policy \ + --secret-id MyTestSecret + +Output:: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-a1b2c3", + "Name": "MyTestSecret", + "ResourcePolicy": "{\n\"Version\":\"2012-10-17\",\n\"Statement\":[{\n\"Effect\":\"Allow\",\n + \"Principal\":{\n\"AWS\":\"arn:aws:iam::123456789012:root\"\n},\n\"Action\": + \"secretsmanager:GetSecretValue\",\n\"Resource\":\"*\"\n}]\n}" + } + +For more information, see `Authentication and access control `__ in the *Secrets Manager User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/secretsmanager/get-secret-value.rst awscli-1.22.34/awscli/examples/secretsmanager/get-secret-value.rst --- awscli-1.21.9/awscli/examples/secretsmanager/get-secret-value.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/secretsmanager/get-secret-value.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,18 +1,21 @@ -**To retrieve the encrypted secret value of a secret** - -The following example shows how to retrieve the secret string value from the version of the secret that has the ``AWSPREVIOUS`` staging label attached. If you want to retrieve the ``AWSCURRENT`` version of the secret, then you can omit the ``--version-stage` parameter because it defaults to ``AWSCURRENT``. :: - - aws secretsmanager get-secret-value --secret-id MyTestDatabaseSecret --version-stage AWSPREVIOUS - -The output shows the following: :: - - { - "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", - "Name": "MyTestDatabaseSecret", - "VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE", - "SecretString": "{\n \"username\":\"david\",\n \"password\":\"BnQw&XDWgaEeT9XGTT29\"\n}\n", - "VersionStages": [ - "AWSPREVIOUS" - ], - "CreatedDate": 1523477145.713 - } +**To retrieve the encrypted secret value of a secret** + +The following ``get-secret-value`` example gets the current secret value. To get the previous secret value, include ``--version-stage AWSPREVIOUS``. :: + + aws secretsmanager get-secret-value \ + --secret-id MyTestSecret + +Output:: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-a1b2c3", + "Name": "MyTestSecret", + "VersionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "SecretString": "{\"user\":\"diegor\",\"password\":\"i29wwX!%9wFV\"}", + "VersionStages": [ + "AWSCURRENT" + ], + "CreatedDate": 1523477145.713 + } + +For more information, see `Retrieve a secret `__ in the *Secrets Manager User Guide*. diff -Nru awscli-1.21.9/awscli/examples/secretsmanager/list-secrets.rst awscli-1.22.34/awscli/examples/secretsmanager/list-secrets.rst --- awscli-1.21.9/awscli/examples/secretsmanager/list-secrets.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/secretsmanager/list-secrets.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,34 +1,60 @@ -**To list the secrets in your account** - -The following example shows how to list all of the secrets in your account. :: - - aws secretsmanager list-secrets - -The output shows the following: :: - - { - "SecretList": [ - { - "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", - "Name": "MyTestDatabaseSecret", - "Description": "My test database secret", - "LastChangedDate": 1523477145.729, - "SecretVersionsToStages": { - "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE": [ - "AWSCURRENT" - ] - } - }, - { - "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret1-d4e5f6", - "Name": "MyTestDatabaseSecret1", - "Description": "Another secret created for a different database", - "LastChangedDate": 1523482025.685, - "SecretVersionsToStages": { - "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE": [ - "AWSCURRENT" - ] - } - } - ] - } \ No newline at end of file +**Example 1: To list the secrets in your account** + +The following ``list-secrets`` example gets a list of the secrets in your account. :: + + aws secretsmanager list-secrets + +Output:: + + { + "SecretList": [ + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-a1b2c3", + "Name": "MyTestSecret", + "LastChangedDate": 1523477145.729, + "SecretVersionsToStages": { + "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111": [ + "AWSCURRENT" + ] + } + }, + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:AnotherSecret-d4e5f6", + "Name": "AnotherSecret", + "LastChangedDate": 1523482025.685, + "SecretVersionsToStages": { + "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222": [ + "AWSCURRENT" + ] + } + } + ] + } + +For more information, see `Find a secret `__ in the *Secrets Manager User Guide*. + +**Example 2: To filter the list of secrets in your account** + +The following ``list-secrets`` example gets a list of the secrets in your account that have ``Test`` in the name. Filtering by name is case sensitive. :: + + aws secretsmanager list-secrets \ + --filter Key="name",Values="Test" + +Output:: + + { + "SecretList": [ + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-a1b2c3", + "Name": "MyTestSecret", + "LastChangedDate": 1523477145.729, + "SecretVersionsToStages": { + "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111": [ + "AWSCURRENT" + ] + } + } + ] + } + +For more information, see `Find a secret `__ in the *Secrets Manager User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/secretsmanager/list-secret-version-ids.rst awscli-1.22.34/awscli/examples/secretsmanager/list-secret-version-ids.rst --- awscli-1.21.9/awscli/examples/secretsmanager/list-secret-version-ids.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/secretsmanager/list-secret-version-ids.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,33 +1,37 @@ -**To list all of the secret versions associated with a secret** - -The following example shows how to retrieve a list of all of the versions of a secret, including those without any staging labels. :: - - aws secretsmanager list-secret-version-ids --secret-id MyTestDatabaseSecret \ - --include-deprecated - -The output shows the following: :: - - { - "Versions": [ - { - "VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE", - "VersionStages": [ - "AWSPREVIOUS" - ], - "CreatedDate": 1523477145.713 - }, - { - "VersionId": "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE", - "VersionStages": [ - "AWSCURRENT" - ], - "CreatedDate": 1523486221.391 - }, - { - "CreatedDate": 1.51197446236E9, - "VersionId": "EXAMPLE3-90ab-cdef-fedc-ba987EXAMPLE;" - } - ], - "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", - "Name": "MyTestDatabaseSecret" - } \ No newline at end of file +**To list all of the secret versions associated with a secret** + +The following ``list-secret-version-ids`` example gets a list of all of the versions of a secret. :: + + aws secretsmanager list-secret-version-ids \ + --secret-id MyTestSecret + +Output:: + + { + "Versions": [ + { + "VersionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "VersionStages": [ + "AWSPREVIOUS" + ], + "LastAccessedDate": 1523477145.713, + "CreatedDate": 1523477145.713 + }, + { + "VersionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "VersionStages": [ + "AWSCURRENT" + ], + "LastAccessedDate": 1523477145.713, + "CreatedDate": 1523486221.391 + }, + { + "CreatedDate": 1.51197446236E9, + "VersionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333;" + } + ], + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-a1b2c3", + "Name": "MyTestSecret" + } + +For more information, see `Version `__ in the *Secrets Manager User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/secretsmanager/put-resource-policy.rst awscli-1.22.34/awscli/examples/secretsmanager/put-resource-policy.rst --- awscli-1.21.9/awscli/examples/secretsmanager/put-resource-policy.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/secretsmanager/put-resource-policy.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,14 +1,33 @@ -**To add a resource-based policy to a secret** - -The following example shows how to add a resource-based policy to a secret. The policy is read from a file on disk and must contain a valid JSON policy document. For more information, see `Resource-based Policies` in the *Secrets Manager User Guide*. -.. _`Resource-based Policies`: http://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_overview.html#auth-and-access_resource-policies:: - - aws secretsmanager put-resource-policy --secret-id MyTestDatabaseMasterSecret \ - --resource-policy file://mysecretpolicy.json - -The output shows the following: :: - - { - "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", - "Name": "MyTestDatabaseSecret" - } +**To add a resource-based policy to a secret** + +The following ``put-resource-policy`` example adds a permissions policy to a secret, checking first that the policy does not provide broad access to the secret. The policy is read from a file. For more information, see `Loading AWS CLI parameters from a file `__ in the *AWS CLI User Guide*. :: + + aws secretsmanager put-resource-policy \ + --secret-id MyTestSecret \ + --resource-policy file://mypolicy.json \ + --block-public-policy + +Contents of ``mypolicy.json``:: + + { + "Version": "2012-10-17", + "Statement": [ + { + "Effect": "Allow", + "Principal": { + "AWS": "arn:aws:iam::123456789012:role/MyRole" + }, + "Action": "secretsmanager:GetSecretValue", + "Resource": "*" + } + ] + } + +Output:: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-a1b2c3", + "Name": "MyTestSecret" + } + +For more information, see `Attach a permissions policy to a secret `__ in the *Secrets Manager User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/secretsmanager/put-secret-value.rst awscli-1.22.34/awscli/examples/secretsmanager/put-secret-value.rst --- awscli-1.21.9/awscli/examples/secretsmanager/put-secret-value.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/secretsmanager/put-secret-value.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,17 +1,52 @@ -**To store a secret value in a new version of a secret** - -The following example shows how to create a new version of the secret. Alternatively, you can use the ``update-secret`` command. :: - - aws secretsmanager put-secret-value --secret-id MyTestDatabaseSecret \ - --secret-string file://mycreds.json - -The output shows the following: :: - - { - "ARN": "arn:aws:secretsmanager:us-west-2:128716708097:secret:MyTestDatabaseSecret-Ca8JGt", - "Name": "MyTestDatabaseSecret", - "VersionId": "dd47d3af-7095-4da5-a267-11707c060178", - "VersionStages": [ - "AWSCURRENT" - ] - } \ No newline at end of file +**Example 1: To store a new secret value in a secret** + +The following ``put-secret-value`` example creates a new version of a secret with two key-value pairs. :: + + aws secretsmanager put-secret-value \ + --secret-id MyTestSecret \ + --secret-string "{\"user\":\"diegor\",\"password\":\"VCsdUbPX!bcu]N\"KEnm||:3Bp3$IBOS\"}" + +Output:: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-1a2b3c", + "Name": "MyTestSecret", + "VersionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "VersionStages": [ + "AWSCURRENT" + ] + } + +For more information, see `Modify a secret `__ in the *Secrets Manager User Guide*. + +**Example 2: To store a new secret value from credentials in a JSON file** + +The following ``put-secret-value`` example creates a new version of a secret from credentials in a file. For more information, see `Loading AWS CLI parameters from a file `__ in the *AWS CLI User Guide*. :: + + aws secretsmanager put-secret-value \ + --secret-id MyTestSecret \ + --secret-string file://mycreds.json + +Contents of ``mycreds.json``:: + + { + "engine": "mysql", + "username": "saanvis", + "password": "i29wwX!%9wFV", + "host": "my-database-endpoint.us-west-2.rds.amazonaws.com", + "dbname": "myDatabase", + "port": "3306" + } + +Output:: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-a1b2c3", + "Name": "MyTestSecret", + "VersionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "VersionStages": [ + "AWSCURRENT" + ] + } + +For more information, see `Modify a secret `__ in the *Secrets Manager User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/secretsmanager/remove-regions-from-replication.rst awscli-1.22.34/awscli/examples/secretsmanager/remove-regions-from-replication.rst --- awscli-1.21.9/awscli/examples/secretsmanager/remove-regions-from-replication.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/secretsmanager/remove-regions-from-replication.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,16 @@ +**To delete a replica secret** + +The following ``remove-regions-from-replication`` example deletes a replica secret in eu-west-3. To delete a primary secret that is replicated to other regions, first delete the replicas and then call ``delete-secret``. :: + + aws secretsmanager remove-regions-from-replication \ + --secret-id MyTestSecret \ + --remove-replica-regions eu-west-3 + +Output:: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-1a2b3c", + "ReplicationStatus": [] + } + +For more information, see `Delete a replica secret `__ in the *Secrets Manager User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/secretsmanager/replicate-secret-to-regions.rst awscli-1.22.34/awscli/examples/secretsmanager/replicate-secret-to-regions.rst --- awscli-1.21.9/awscli/examples/secretsmanager/replicate-secret-to-regions.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/secretsmanager/replicate-secret-to-regions.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,22 @@ +**To replicate a secret to another region** + +The following ``replicate-secret-to-regions`` example replicates a secret to eu-west-3. The replica is encrypted with the AWS managed key ``aws/secretsmanager``. :: + + aws secretsmanager replicate-secret-to-regions \ + --secret-id MyTestSecret \ + --add-replica-regions Region=eu-west-3 + +Output:: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-1a2b3c", + "ReplicationStatus": [ + { + "Region": "eu-west-3", + "KmsKeyId": "alias/aws/secretsmanager", + "Status": "InProgress" + } + ] + } + +For more information, see `Replicate a secret to another Region `__ in the *Secrets Manager User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/secretsmanager/restore-secret.rst awscli-1.22.34/awscli/examples/secretsmanager/restore-secret.rst --- awscli-1.21.9/awscli/examples/secretsmanager/restore-secret.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/secretsmanager/restore-secret.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,12 +1,15 @@ -**To restore a previously deleted secret** - -The following example shows how to restore a secret that you previously scheduled for deletion. :: - - aws secretsmanager restore-secret --secret-id MyTestDatabaseSecret - -The output shows the following: :: - - { - "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", - "Name": "MyTestDatabaseSecret" - } \ No newline at end of file +**To restore a previously deleted secret** + +The following ``restore-secret`` example restores a secret that was previously scheduled for deletion. :: + + aws secretsmanager restore-secret \ + --secret-id MyTestSecret + +Output:: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-a1b2c3", + "Name": "MyTestSecret" + } + +For more information, see `Delete a secret `__ in the *Secrets Manager User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/secretsmanager/rotate-secret.rst awscli-1.22.34/awscli/examples/secretsmanager/rotate-secret.rst --- awscli-1.21.9/awscli/examples/secretsmanager/rotate-secret.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/secretsmanager/rotate-secret.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,29 +1,35 @@ -**To configure rotation for a secret** - -The following example configures rotation for a secret by providing the ARN of a Lambda rotation function (which must already exist) and the number of days between rotation. The first rotation happens immediately upon completion of this command. The rotation function runs asynchronously in the background. :: - - aws secretsmanager rotate-secret --secret-id MyTestDatabaseSecret \ - --rotation-lambda-arn arn:aws:lambda:us-west-2:1234566789012:function:MyTestRotationLambda \ - --rotation-rules AutomaticallyAfterDays=30 - -The output shows the following, including the ``VersionId`` of the new secret version: :: - - { - "ARN": "aws:arn:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", - "Name": "MyTestDatabaseSecret", - "VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE" - } - -**To request an immediate rotation for a secret** - -The following example requests an immediate invocation of the secret's Lambda rotation function. It assumes that the specified secret already has rotation configured. The rotation function runs asynchronously in the background. :: - - aws secretsmanager rotate-secret --secret-id MyTestDatabaseSecret - -The output shows the following, including the ``VersionId`` of the new secret version: :: - - { - "ARN": "aws:arn:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", - "Name": "MyTestDatabaseSecret", - "VersionId": "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE" - } \ No newline at end of file +**Example 1: To configure and start automatic rotation for a secret** + +The following ``rotate-secret`` example configures and starts automatic rotation for a secret. Secrets Manager rotates the secret once immediately and then automatically every 10 days. The output shows the ``VersionId`` of the new secret version created by rotation. :: + + aws secretsmanager rotate-secret \ + --secret-id MyTestDatabaseSecret \ + --rotation-lambda-arn arn:aws:lambda:us-west-2:1234566789012:function:SecretsManagerTestRotationLambda \ + --rotation-rules AutomaticallyAfterDays=10 + +Output:: + + { + "ARN": "aws:arn:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret", + "VersionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" + } + +For more information, see `This is the topic title `__ in the *Secrets Manager User Guide*. + +**Example 2: To rotate a secret immediately** + +The following ``rotate-secret`` example starts an immediate rotation. The output shows the ``VersionId`` of the new secret version created by rotation. The secret must already have rotation configured. :: + + aws secretsmanager rotate-secret \ + --secret-id MyTestDatabaseSecret + +Output:: + + { + "ARN": "aws:arn:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret", + "VersionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" + } + +For more information, see `Rotate secrets `__ in the *Secrets Manager User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/secretsmanager/stop-replication-to-replica.rst awscli-1.22.34/awscli/examples/secretsmanager/stop-replication-to-replica.rst --- awscli-1.21.9/awscli/examples/secretsmanager/stop-replication-to-replica.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/secretsmanager/stop-replication-to-replica.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,14 @@ +**To promote a replica secret to a primary** + +The following ``stop-replication-to-replica`` example removes the link between a replica secret to the primary. The replica secret is promoted to a primary secret in the replica region. You must call ``stop-replication-to-replica`` from within the replica region. :: + + aws secretsmanager stop-replication-to-replica \ + --secret-id MyTestSecret + +Output:: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-a1b2c3" + } + +For more information, see `Promote a replica secret `__ in the *Secrets Manager User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/secretsmanager/tag-resource.rst awscli-1.22.34/awscli/examples/secretsmanager/tag-resource.rst --- awscli-1.21.9/awscli/examples/secretsmanager/tag-resource.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/secretsmanager/tag-resource.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,8 +1,23 @@ -**To add tags to a secret** - -The following example shows how to attach two tags each with a Key and Value to a secret. :: - - aws secretsmanager tag-resource --secret-id MyTestDatabaseSecret \ - --tags '[{"Key": "FirstTag", "Value": "SomeValue"}, {"Key": "SecondTag", "Value": "AnotherValue"}]' - -There is no output from this API. To see the result, use the describe-secret operation. +**Example 1: To add a tag to a secret** + +The following example shows how to attach a tag with shorthand syntax. :: + + aws secretsmanager tag-resource \ + --secret-id MyTestSecret \ + --tags Key=FirstTag,Value=FirstValue + +This command produces no output. + +For more information, see `Tag your secrets `__ in the *Secrets Manager User Guide*. + +**Example 2: To add multiple tags to a secret** + +The following ``tag-resource`` example attaches two key-value tags to a secret. :: + + aws secretsmanager tag-resource \ + --secret-id MyTestSecret \ + --tags '[{"Key": "FirstTag", "Value": "FirstValue"}, {"Key": "SecondTag", "Value": "SecondValue"}]' + +This command produces no output. + +For more information, see `Tag secrets `__ in the *Secrets Manager User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/secretsmanager/untag-resource.rst awscli-1.22.34/awscli/examples/secretsmanager/untag-resource.rst --- awscli-1.21.9/awscli/examples/secretsmanager/untag-resource.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/secretsmanager/untag-resource.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,8 +1,11 @@ -**To remove tags from a secret** - -The following example shows how to remove two tags from a secret's metadata. For each tag, both the key and its associated value are removed. :: - - aws secretsmanager untag-resource --secret-id MyTestDatabaseSecret \ - --tag-keys '[ "FirstTag", "SecondTag"]' - -There is no output from this API. To see the result, use the describe-secret operation. +**To remove tags from a secret** + +The following ``untag-resource`` example removes two tags from a secret. For each tag, both key and value are removed. :: + + aws secretsmanager untag-resource \ + --secret-id MyTestSecret \ + --tag-keys '[ "FirstTag", "SecondTag"]' + +This command produces no output. + +For more information, see `Tag secrets `__ in the *Secrets Manager User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/secretsmanager/update-secret.rst awscli-1.22.34/awscli/examples/secretsmanager/update-secret.rst --- awscli-1.21.9/awscli/examples/secretsmanager/update-secret.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/secretsmanager/update-secret.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,44 +1,33 @@ -The following examples show how to modify individual components of the secret. Alternatively, you can combine all of the parameters into a single command to do them all in one operation. - -**To update the description of a secret** - -The following example shows how to modify the description of a secret. :: - - aws secretsmanager update-secret --secret-id MyTestDatabaseSecret \ - --description "This is a new description for the secret." - -The output shows the following: :: - - { - "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", - "Name": "MyTestDatabaseSecret" - } - -**To update the KMS key associated with a secret** - -This example shows how to update the KMS customer managed key (CMK) used to encrypt the secret value. The KMS CMK must be in the same region as the secret. :: - - aws secretsmanager update-secret --secret-id MyTestDatabaseSecret \ - --kms-key-id arn:aws:kms:us-west-2:123456789012:key/EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE - -The output shows the following: :: - - { - "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", - "Name": "MyTestDatabaseSecret" - } - -**To create a new version of the encrypted secret value** - -The following example shows how to create a new version of the secret by updating the --secret-string field. The secret string is read from the contents of the specified file. Alternatively, you can use the put-secret-value operation. :: - - aws secretsmanager update-secret --secret-id MyTestDatabaseSecret \ - --secret-string file://mycreds.json - -The output shows the following, including the ``VersionId`` of the new secret version: :: - - { - "ARN": "aws:arn:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", - "Name": "MyTestDatabaseSecret", - "VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE" - } \ No newline at end of file +**Example 1: To update the description of a secret** + +The following ``update-secret`` example updates the description of a secret. :: + + aws secretsmanager update-secret \ + --secret-id MyTestSecret \ + --description "This is a new description for the secret." + +Output:: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-a1b2c3", + "Name": "MyTestSecret" + } + +For more information, see `Modify a secret `__ in the *Secrets Manager User Guide*. + +**Example 2: To update the encryption key associated with a secret** + +The following ``update-secret`` example updates the KMS key used to encrypt the secret value. The KMS key must be in the same region as the secret. :: + + aws secretsmanager update-secret \ + --secret-id MyTestSecret \ + --kms-key-id arn:aws:kms:us-west-2:123456789012:key/EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE + +Output:: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-a1b2c3", + "Name": "MyTestSecret" + } + +For more information, see `Modify a secret `__ in the *Secrets Manager User Guide*. diff -Nru awscli-1.21.9/awscli/examples/secretsmanager/update-secret-version-stage.rst awscli-1.22.34/awscli/examples/secretsmanager/update-secret-version-stage.rst --- awscli-1.21.9/awscli/examples/secretsmanager/update-secret-version-stage.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/secretsmanager/update-secret-version-stage.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,45 +1,54 @@ -**To add a staging label attached to a version of a secret** - -The following example shows you how to add a staging label to a version of a secret. You can review the results by running the command list-secret-version-ids and viewing the VersionStages response field for the affected version. :: - - aws secretsmanager update-secret-version-stage --secret-id MyTestDatabaseSecret \ - --version-stage STAGINGLABEL1 \ - --move-to-version-id EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE - -The output shows the following: :: - - { - "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", - "Name": "MyTestDatabaseSecret" - } - -**To delete a staging label attached to a version of a secret** - -The following example shows you how to delete a staging label that is attached to a version of a secret. You can review the results by running the command list-secret-version-ids and viewing the VersionStages response field for the affected version. :: - - aws secretsmanager update-secret-version-stage --secret-id MyTestDatabaseSecret \ - --version-stage STAGINGLABEL1 \ - --remove-from-version-id EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE - -The output shows the following: :: - - { - "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", - "Name": "MyTestDatabaseSecret" - } - -**To move a staging label from one version of a secret to another** - -The following example shows you how to move a staging label that is attached to one version of a secret to a different version. You can review the results by running the command list-secret-version-ids and viewing the VersionStages response field for the affected version. :: - - aws secretsmanager update-secret-version-stage --secret-id MyTestDatabaseSecret \ - --version-stage AWSCURRENT \ - --move-to-version-id EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE \ - --remove-from-version-id EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE - -The output shows the following: :: - - { - "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", - "Name": "MyTestDatabaseSecret" - } \ No newline at end of file +**Example 1: To revert a secret to the previous version** + +The following ``update-secret-version-stage`` example moves the AWSCURRENT staging label to the previous version of a secret, which reverts the secret to the previous version. To find the ID for the previous version, use ``list-secret-version-ids``. For this example, the version with the AWSCURRENT label is a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 and the version with the AWSPREVIOUS label is a1b2c3d4-5678-90ab-cdef-EXAMPLE22222. In this example, you move the AWSCURRENT label from version 11111 to 22222. Because the AWSCURRENT label is removed from a version, ``update-secret-version-stage`` automatically moves the AWSPREVIOUS label to that version (11111). The effect is that the AWSCURRENT and AWSPREVIOUS versions are swapped. :: + + aws secretsmanager update-secret-version-stage \ + --secret-id MyTestSecret \ + --version-stage AWSCURRENT \ + --move-to-version-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ + --remove-from-version-id a1b2c3d4-5678-90ab-cdef-EXAMPLE22222 + +Output:: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-a1b2c3", + "Name": "MyTestSecret" + } + +For more information, see `Version `__ in the *Secrets Manager User Guide*. + +**Example 2: To add a staging label attached to a version of a secret** + +The following ``update-secret-version-stage`` example adds a staging label to a version of a secret. You can review the results by running ``list-secret-version-ids`` and viewing the ``VersionStages`` response field for the affected version. :: + + aws secretsmanager update-secret-version-stage \ + --secret-id MyTestSecret \ + --version-stage STAGINGLABEL1 \ + --move-to-version-id EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE + +Output:: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-a1b2c3", + "Name": "MyTestSecret" + } + +For more information, see `Version `__ in the *Secrets Manager User Guide*. + +**Example 3: To delete a staging label attached to a version of a secret** + +The following ``update-secret-version-stage`` example deletes a staging label that is attached to a version of a secret. You can review the results by running ``list-secret-version-ids`` and viewing the ``VersionStages`` response field for the affected version. :: + + aws secretsmanager update-secret-version-stage \ + --secret-id MyTestSecret \ + --version-stage STAGINGLABEL1 \ + --remove-from-version-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 + +Output:: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-a1b2c3", + "Name": "MyTestSecret" + } + +For more information, see `Version `__ in the *Secrets Manager User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/secretsmanager/validate-resource-policy.rst awscli-1.22.34/awscli/examples/secretsmanager/validate-resource-policy.rst --- awscli-1.21.9/awscli/examples/secretsmanager/validate-resource-policy.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/secretsmanager/validate-resource-policy.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,31 @@ +**To validate a resource policy** + +The following ``validate-resource-policy`` example checks that a resource policy doesn't grant broad access to a secret. The policy is read from a file on disk. For more information, see `Loading AWS CLI parameters from a file `__ in the *AWS CLI User Guide*. :: + + aws secretsmanager validate-resource-policy \ + --resource-policy file://mypolicy.json + +Contents of ``mypolicy.json``:: + + { + "Version": "2012-10-17", + "Statement": [ + { + "Effect": "Allow", + "Principal": { + "AWS": "arn:aws:iam::123456789012:role/MyRole" + }, + "Action": "secretsmanager:GetSecretValue", + "Resource": "*" + } + ] + } + +Output:: + + { + "PolicyValidationPassed": true, + "ValidationErrors": [] + } + +For more information, see `Permissions reference for Secrets Manager `__ in the *Secrets Manager User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/securityhub/create-finding-aggregator.rst awscli-1.22.34/awscli/examples/securityhub/create-finding-aggregator.rst --- awscli-1.21.9/awscli/examples/securityhub/create-finding-aggregator.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/securityhub/create-finding-aggregator.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,19 @@ +**To enable finding aggregation** + +The following ``create-finding-aggregator`` example configures finding aggregation. It is run from US East (Virginia), which designates US East (Virginia) as the aggregation Region. It indicates to only link specified Regions, and to not automatically link new Regions. It selects US West (N. California) and US West (Oregon) as the linked Regions. :: + + aws securityhub create-finding-aggregator \ + --region us-east-1 \ + --region-linking-mode SPECIFIED_REGIONS \ + --regions us-west-1,us-west-2 + +Output:: + + { + "FindingAggregatorArn": "arn:aws:securityhub:us-east-1:222222222222:finding-aggregator/123e4567-e89b-12d3-a456-426652340000", + "FindingAggregationRegion": "us-east-1", + "RegionLinkingMode": "SPECIFIED_REGIONS", + "Regions": "us-west-1,us-west-2" + } + +For more information, see `Enabling finding aggregation `__ in the *AWS Security Hub User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/securityhub/delete-finding-aggregator.rst awscli-1.22.34/awscli/examples/securityhub/delete-finding-aggregator.rst --- awscli-1.21.9/awscli/examples/securityhub/delete-finding-aggregator.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/securityhub/delete-finding-aggregator.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,11 @@ +**To stop finding aggregation** + +The following ``delete-finding-aggregator`` example stops finding aggregation. It is run from US East (Virginia), which is the aggregation Region. :: + + aws securityhub delete-finding-aggregator \ + --region us-east-1 \ + --finding-aggregator-arn arn:aws:securityhub:us-east-1:222222222222:finding-aggregator/123e4567-e89b-12d3-a456-426652340000 + +This command produces no output. + +For more information, see `Stopping finding aggregation `__ in the *AWS Security Hub User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/securityhub/get-finding-aggregator.rst awscli-1.22.34/awscli/examples/securityhub/get-finding-aggregator.rst --- awscli-1.21.9/awscli/examples/securityhub/get-finding-aggregator.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/securityhub/get-finding-aggregator.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,17 @@ +**To retrieve the current finding aggregation configuration** + +The following ``get-finding-aggregator`` example retrieves the current finding aggregation configuration. :: + + aws securityhub get-finding-aggregator \ + --finding-aggregator-arn arn:aws:securityhub:us-east-1:222222222222:finding-aggregator/123e4567-e89b-12d3-a456-426652340000 + +Output:: + + { + "FindingAggregatorArn": "arn:aws:securityhub:us-east-1:222222222222:finding-aggregator/123e4567-e89b-12d3-a456-426652340000", + "FindingAggregationRegion": "us-east-1", + "RegionLinkingMode": "SPECIFIED_REGIONS", + "Regions": "us-west-1,us-west-2" + } + +For more information, see `Viewing the current finding aggregation configuration `__ in the *AWS Security Hub User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/securityhub/list-finding-aggregators.rst awscli-1.22.34/awscli/examples/securityhub/list-finding-aggregators.rst --- awscli-1.21.9/awscli/examples/securityhub/list-finding-aggregators.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/securityhub/list-finding-aggregators.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,13 @@ +**To list the available widgets** + +The following ``list-finding-aggregators`` example returns the ARN of the finding aggregation configuration. :: + + aws securityhub list-finding-aggregators + +Output:: + + { + "FindingAggregatorArn": "arn:aws:securityhub:us-east-1:222222222222:finding-aggregator/123e4567-e89b-12d3-a456-426652340000" + } + +For more information, see `Viewing the current finding aggregation configuration `__ in the *AWS Security Hub User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/securityhub/update-finding-aggregator.rst awscli-1.22.34/awscli/examples/securityhub/update-finding-aggregator.rst --- awscli-1.21.9/awscli/examples/securityhub/update-finding-aggregator.rst 1970-01-01 00:00:00.000000000 +0000 +++ awscli-1.22.34/awscli/examples/securityhub/update-finding-aggregator.rst 2022-01-12 19:04:32.000000000 +0000 @@ -0,0 +1,13 @@ +**To update the current finding aggregation configuration** + +The following ``update-finding-aggregator`` example changes the finding aggregation configuration to link from selected Regions. It is run from US East (Virginia), which is the aggregation Region. It selects US West (N. California) and US West (Oregon) as the linked Regions. :: + + aws securityhub update-finding-aggregator \ + --region us-east-1 \ + --finding-aggregator-arn arn:aws:securityhub:us-east-1:222222222222:finding-aggregator/123e4567-e89b-12d3-a456-426652340000 \ + --region-linking-mode SPECIFIED_REGIONS \ + --regions us-west-1,us-west-2 + +This command produces no output. + +For more information, see `Updating the finding aggregation configuration `__ in the *AWS Security Hub User Guide*. \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/ssm/list-resource-data-sync.rst awscli-1.22.34/awscli/examples/ssm/list-resource-data-sync.rst --- awscli-1.21.9/awscli/examples/ssm/list-resource-data-sync.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/ssm/list-resource-data-sync.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,27 +1,26 @@ **To list your resource data sync configurations** -This example retrieves information about your resource data sync configurations. +This example retrieves information about your resource data sync configurations. :: -Command:: - - aws ssm list-resource-data-sync --sync-name "ssm-resource-data-sync" + aws ssm list-resource-data-sync Output:: - { - "ResourceDataSyncItems": [ - { - "SyncName": "ssm-resource-data-sync", - "S3Destination": { - "BucketName": "ssm-resource-data-sync", - "SyncFormat": "JsonSerDe", - "Region": "us-east-1" - }, - "LastSyncTime": 1550261472.003, - "LastSuccessfulSyncTime": 1550261472.003, - "LastStatus": "Successful", - "SyncCreatedTime": 1543235736.72, - "LastSyncStatusMessage": "The sync was successfully completed" - } - ] - } + { + "ResourceDataSyncItems": [ + { + "SyncName": "MyResourceDataSync", + "S3Destination": { + "BucketName": "ssm-resource-data-sync", + "SyncFormat": "JsonSerDe", + "Region": "us-east-1" + }, + "LastSyncTime": 1550261472.003, + "LastSuccessfulSyncTime": 1550261472.003, + "LastStatus": "Successful", + "SyncCreatedTime": 1543235736.72, + "LastSyncStatusMessage": "The sync was successfully completed" + } + ] + } + diff -Nru awscli-1.21.9/awscli/examples/textract/analyze-document.rst awscli-1.22.34/awscli/examples/textract/analyze-document.rst --- awscli-1.21.9/awscli/examples/textract/analyze-document.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/textract/analyze-document.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,59 +1,70 @@ -**To analyze text in a document** - -The following ``analyze-document`` example shows how to analyze text in a document. :: - - aws textract analyze-document --document '{"S3Object":{"Bucket":"bucket","Name":"document"}}' --feature-types '["TABLES","FORMS"]' - -Output :: - - { - "Blocks": [ - { - "Geometry": { - "BoundingBox": { - "Width": 1.0, - "Top": 0.0, - "Left": 0.0, - "Height": 1.0 - }, - "Polygon": [ - { - "Y": 0.0, - "X": 0.0 - }, - { - "Y": 0.0, - "X": 1.0 - }, - { - "Y": 1.0, - "X": 1.0 - }, - { - "Y": 1.0, - "X": 0.0 - } - ] - }, - "Relationships": [ - { - "Type": "CHILD", - "Ids": [ - "87586964-d50d-43e2-ace5-8a890657b9a0", - "a1e72126-21d9-44f4-a8d6-5c385f9002ba", - "e889d012-8a6b-4d2e-b7cd-7a8b327d876a" - ] - } - ], - "BlockType": "PAGE", - "Id": "c2227f12-b25d-4e1f-baea-1ee180d926b2" - } - ], - "DocumentMetadata": { - "Pages": 1 - } - } - -For more information, see `Analyzing Document Text with Amazon Textract`_ in the *Amazon Textract Developers Guide* - +**To analyze text in a document** + +The following ``analyze-document`` example shows how to analyze text in a document. + +Linux/macOS:: + + aws textract analyze-document \ + --document '{"S3Object":{"Bucket":"bucket","Name":"document"}}' \ + --feature-types '["TABLES","FORMS"]' + +Windows:: + + aws textract analyze-document \ + --document "{\"S3Object\":{\"Bucket\":\"bucket\",\"Name\":\"document\"}}" \ + --feature-types "[\"TABLES\",\"FORMS\"]" \ + --region region-name + +Output:: + + { + "Blocks": [ + { + "Geometry": { + "BoundingBox": { + "Width": 1.0, + "Top": 0.0, + "Left": 0.0, + "Height": 1.0 + }, + "Polygon": [ + { + "Y": 0.0, + "X": 0.0 + }, + { + "Y": 0.0, + "X": 1.0 + }, + { + "Y": 1.0, + "X": 1.0 + }, + { + "Y": 1.0, + "X": 0.0 + } + ] + }, + "Relationships": [ + { + "Type": "CHILD", + "Ids": [ + "87586964-d50d-43e2-ace5-8a890657b9a0", + "a1e72126-21d9-44f4-a8d6-5c385f9002ba", + "e889d012-8a6b-4d2e-b7cd-7a8b327d876a" + ] + } + ], + "BlockType": "PAGE", + "Id": "c2227f12-b25d-4e1f-baea-1ee180d926b2" + } + ], + "DocumentMetadata": { + "Pages": 1 + } + } + +For more information, see `Analyzing Document Text with Amazon Textract`_ in the *Amazon Textract Developers Guide* + .. _`Analyzing Document Text with Amazon Textract`: https://docs.aws.amazon.com/textract/latest/dg/analyzing-document-text.html \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/textract/detect-document-text.rst awscli-1.22.34/awscli/examples/textract/detect-document-text.rst --- awscli-1.21.9/awscli/examples/textract/detect-document-text.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/textract/detect-document-text.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,140 +1,149 @@ -**To detect text in a document** - -The following ``detect-document-text`` The following example shows how to detect text in a document. :: - - aws textract detect-document-text --document '{"S3Object":{"Bucket":"bucket","Name":"document"}}' - -Output :: - - { - "Blocks": [ - { - "Geometry": { - "BoundingBox": { - "Width": 1.0, - "Top": 0.0, - "Left": 0.0, - "Height": 1.0 - }, - "Polygon": [ - { - "Y": 0.0, - "X": 0.0 - }, - { - "Y": 0.0, - "X": 1.0 - }, - { - "Y": 1.0, - "X": 1.0 - }, - { - "Y": 1.0, - "X": 0.0 - } - ] - }, - "Relationships": [ - { - "Type": "CHILD", - "Ids": [ - "896a9f10-9e70-4412-81ce-49ead73ed881", - "0da18623-dc4c-463d-a3d1-9ac050e9e720", - "167338d7-d38c-4760-91f1-79a8ec457bb2" - ] - } - ], - "BlockType": "PAGE", - "Id": "21f0535e-60d5-4bc7-adf2-c05dd851fa25" - }, - { - "Relationships": [ - { - "Type": "CHILD", - "Ids": [ - "62490c26-37ea-49fa-8034-7a9ff9369c9c", - "1e4f3f21-05bd-4da9-ba10-15d01e66604c" - ] - } - ], - "Confidence": 89.11581420898438, - "Geometry": { - "BoundingBox": { - "Width": 0.33642634749412537, - "Top": 0.17169663310050964, - "Left": 0.13885067403316498, - "Height": 0.49159330129623413 - }, - "Polygon": [ - { - "Y": 0.17169663310050964, - "X": 0.13885067403316498 - }, - { - "Y": 0.17169663310050964, - "X": 0.47527703642845154 - }, - { - "Y": 0.6632899641990662, - "X": 0.47527703642845154 - }, - { - "Y": 0.6632899641990662, - "X": 0.13885067403316498 - } - ] - }, - "Text": "He llo,", - "BlockType": "LINE", - "Id": "896a9f10-9e70-4412-81ce-49ead73ed881" - }, - { - "Relationships": [ - { - "Type": "CHILD", - "Ids": [ - "19b28058-9516-4352-b929-64d7cef29daf" - ] - } - ], - "Confidence": 85.5694351196289, - "Geometry": { - "BoundingBox": { - "Width": 0.33182239532470703, - "Top": 0.23131252825260162, - "Left": 0.5091826915740967, - "Height": 0.3766750991344452 - }, - "Polygon": [ - { - "Y": 0.23131252825260162, - "X": 0.5091826915740967 - }, - { - "Y": 0.23131252825260162, - "X": 0.8410050868988037 - }, - { - "Y": 0.607987642288208, - "X": 0.8410050868988037 - }, - { - "Y": 0.607987642288208, - "X": 0.5091826915740967 - } - ] - }, - "Text": "worlc", - "BlockType": "LINE", - "Id": "0da18623-dc4c-463d-a3d1-9ac050e9e720" - } - ], - "DocumentMetadata": { - "Pages": 1 - } - } - -For more information, see `Detecting Document Text with Amazon Textract`_ in the *Amazon Textract Developers Guide* - +**To detect text in a document** + +The following ``detect-document-text`` The following example shows how to detect text in a document. + +Linux/macOS:: + + aws textract detect-document-text \ + --document '{"S3Object":{"Bucket":"bucket","Name":"document"}}' + +Windows:: + + aws textract detect-document-text \ + --document "{\"S3Object\":{\"Bucket\":\"bucket\",\"Name\":\"document\"}}" \ + --region region-name + +Output:: + + { + "Blocks": [ + { + "Geometry": { + "BoundingBox": { + "Width": 1.0, + "Top": 0.0, + "Left": 0.0, + "Height": 1.0 + }, + "Polygon": [ + { + "Y": 0.0, + "X": 0.0 + }, + { + "Y": 0.0, + "X": 1.0 + }, + { + "Y": 1.0, + "X": 1.0 + }, + { + "Y": 1.0, + "X": 0.0 + } + ] + }, + "Relationships": [ + { + "Type": "CHILD", + "Ids": [ + "896a9f10-9e70-4412-81ce-49ead73ed881", + "0da18623-dc4c-463d-a3d1-9ac050e9e720", + "167338d7-d38c-4760-91f1-79a8ec457bb2" + ] + } + ], + "BlockType": "PAGE", + "Id": "21f0535e-60d5-4bc7-adf2-c05dd851fa25" + }, + { + "Relationships": [ + { + "Type": "CHILD", + "Ids": [ + "62490c26-37ea-49fa-8034-7a9ff9369c9c", + "1e4f3f21-05bd-4da9-ba10-15d01e66604c" + ] + } + ], + "Confidence": 89.11581420898438, + "Geometry": { + "BoundingBox": { + "Width": 0.33642634749412537, + "Top": 0.17169663310050964, + "Left": 0.13885067403316498, + "Height": 0.49159330129623413 + }, + "Polygon": [ + { + "Y": 0.17169663310050964, + "X": 0.13885067403316498 + }, + { + "Y": 0.17169663310050964, + "X": 0.47527703642845154 + }, + { + "Y": 0.6632899641990662, + "X": 0.47527703642845154 + }, + { + "Y": 0.6632899641990662, + "X": 0.13885067403316498 + } + ] + }, + "Text": "He llo,", + "BlockType": "LINE", + "Id": "896a9f10-9e70-4412-81ce-49ead73ed881" + }, + { + "Relationships": [ + { + "Type": "CHILD", + "Ids": [ + "19b28058-9516-4352-b929-64d7cef29daf" + ] + } + ], + "Confidence": 85.5694351196289, + "Geometry": { + "BoundingBox": { + "Width": 0.33182239532470703, + "Top": 0.23131252825260162, + "Left": 0.5091826915740967, + "Height": 0.3766750991344452 + }, + "Polygon": [ + { + "Y": 0.23131252825260162, + "X": 0.5091826915740967 + }, + { + "Y": 0.23131252825260162, + "X": 0.8410050868988037 + }, + { + "Y": 0.607987642288208, + "X": 0.8410050868988037 + }, + { + "Y": 0.607987642288208, + "X": 0.5091826915740967 + } + ] + }, + "Text": "worlc", + "BlockType": "LINE", + "Id": "0da18623-dc4c-463d-a3d1-9ac050e9e720" + } + ], + "DocumentMetadata": { + "Pages": 1 + } + } + +For more information, see `Detecting Document Text with Amazon Textract`_ in the *Amazon Textract Developers Guide* + .. _`Detecting Document Text with Amazon Textract`: https://docs.aws.amazon.com/textract/latest/dg/detecting-document-text.html \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/textract/get-document-analysis.rst awscli-1.22.34/awscli/examples/textract/get-document-analysis.rst --- awscli-1.21.9/awscli/examples/textract/get-document-analysis.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/textract/get-document-analysis.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,62 +1,64 @@ -**To get the results of asynchronous text analysis of a multi-page document** - -The following ``get-document-analysis`` example shows how to get the results of asynchronous text analysis of a multi-page document. :: - - aws textract get-document-analysis --job-id df7cf32ebbd2a5de113535fcf4d921926a701b09b4e7d089f3aebadb41e0712b --max-results 1000 - -Output :: - - { - "Blocks": [ - { - "Geometry": { - "BoundingBox": { - "Width": 1.0, - "Top": 0.0, - "Left": 0.0, - "Height": 1.0 - }, - "Polygon": [ - { - "Y": 0.0, - "X": 0.0 - }, - { - "Y": 0.0, - "X": 1.0 - }, - { - "Y": 1.0, - "X": 1.0 - }, - { - "Y": 1.0, - "X": 0.0 - } - ] - }, - "Relationships": [ - { - "Type": "CHILD", - "Ids": [ - "75966e64-81c2-4540-9649-d66ec341cd8f", - "bb099c24-8282-464c-a179-8a9fa0a057f0", - "5ebf522d-f9e4-4dc7-bfae-a288dc094595" - ] - } - ], - "BlockType": "PAGE", - "Id": "247c28ee-b63d-4aeb-9af0-5f7ea8ba109e", - "Page": 1 - } - ], - "NextToken": "cY1W3eTFvoB0cH7YrKVudI4Gb0H8J0xAYLo8xI/JunCIPWCthaKQ+07n/ElyutsSy0+1VOImoTRmP1zw4P0RFtaeV9Bzhnfedpx1YqwB4xaGDA==", - "DocumentMetadata": { - "Pages": 1 - }, - "JobStatus": "SUCCEEDED" - } - -For more information, see `Detecting and Analyzing Text in Multi-Page Documents`_ in the *Amazon Textract Developers Guide* - -.. _`Detecting and Analyzing Text in Multi-Page Documents`: https://docs.aws.amazon.com/textract/latest/dg/async.html +**To get the results of asynchronous text analysis of a multi-page document** + +The following ``get-document-analysis`` example shows how to get the results of asynchronous text analysis of a multi-page document. :: + + aws textract get-document-analysis \ + --job-id df7cf32ebbd2a5de113535fcf4d921926a701b09b4e7d089f3aebadb41e0712b \ + --max-results 1000 + +Output:: + + { + "Blocks": [ + { + "Geometry": { + "BoundingBox": { + "Width": 1.0, + "Top": 0.0, + "Left": 0.0, + "Height": 1.0 + }, + "Polygon": [ + { + "Y": 0.0, + "X": 0.0 + }, + { + "Y": 0.0, + "X": 1.0 + }, + { + "Y": 1.0, + "X": 1.0 + }, + { + "Y": 1.0, + "X": 0.0 + } + ] + }, + "Relationships": [ + { + "Type": "CHILD", + "Ids": [ + "75966e64-81c2-4540-9649-d66ec341cd8f", + "bb099c24-8282-464c-a179-8a9fa0a057f0", + "5ebf522d-f9e4-4dc7-bfae-a288dc094595" + ] + } + ], + "BlockType": "PAGE", + "Id": "247c28ee-b63d-4aeb-9af0-5f7ea8ba109e", + "Page": 1 + } + ], + "NextToken": "cY1W3eTFvoB0cH7YrKVudI4Gb0H8J0xAYLo8xI/JunCIPWCthaKQ+07n/ElyutsSy0+1VOImoTRmP1zw4P0RFtaeV9Bzhnfedpx1YqwB4xaGDA==", + "DocumentMetadata": { + "Pages": 1 + }, + "JobStatus": "SUCCEEDED" + } + +For more information, see `Detecting and Analyzing Text in Multi-Page Documents`_ in the *Amazon Textract Developers Guide* + +.. _`Detecting and Analyzing Text in Multi-Page Documents`: https://docs.aws.amazon.com/textract/latest/dg/async.html \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/textract/get-document-text-detection.rst awscli-1.22.34/awscli/examples/textract/get-document-text-detection.rst --- awscli-1.21.9/awscli/examples/textract/get-document-text-detection.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/textract/get-document-text-detection.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,62 +1,64 @@ -**To get the results of asynchronous text detection in a multi-page document** - -The following ``get-document-text-detection`` example shows how to get the results of asynchronous text detection in a multi-page document. :: - - aws textract get-document-text-detection --job-id 57849a3dc627d4df74123dca269d69f7b89329c870c65bb16c9fd63409d200b9 --max-results 1000 - -Output :: - - { - "Blocks": [ - { - "Geometry": { - "BoundingBox": { - "Width": 1.0, - "Top": 0.0, - "Left": 0.0, - "Height": 1.0 - }, - "Polygon": [ - { - "Y": 0.0, - "X": 0.0 - }, - { - "Y": 0.0, - "X": 1.0 - }, - { - "Y": 1.0, - "X": 1.0 - }, - { - "Y": 1.0, - "X": 0.0 - } - ] - }, - "Relationships": [ - { - "Type": "CHILD", - "Ids": [ - "1b926a34-0357-407b-ac8f-ec473160c6a9", - "0c35dc17-3605-4c9d-af1a-d9451059df51", - "dea3db8a-52c2-41c0-b50c-81f66f4aa758" - ] - } - ], - "BlockType": "PAGE", - "Id": "84671a5e-8c99-43be-a9d1-6838965da33e", - "Page": 1 - } - ], - "NextToken": "GcqyoAJuZwujOT35EN4LCI3EUzMtiLq3nKyFFHvU5q1SaIdEBcSty+njNgoWwuMP/muqc96S4o5NzDqehhXvhkodMyVO5OJGyms5lsrCxibWJw==", - "DocumentMetadata": { - "Pages": 1 - }, - "JobStatus": "SUCCEEDED" - } - -For more information, see `Detecting and Analyzing Text in Multi-Page Documents`_ in the *Amazon Textract Developers Guide* - +**To get the results of asynchronous text detection in a multi-page document** + +The following ``get-document-text-detection`` example shows how to get the results of asynchronous text detection in a multi-page document. :: + + aws textract get-document-text-detection \ + --job-id 57849a3dc627d4df74123dca269d69f7b89329c870c65bb16c9fd63409d200b9 \ + --max-results 1000 + +Output :: + + { + "Blocks": [ + { + "Geometry": { + "BoundingBox": { + "Width": 1.0, + "Top": 0.0, + "Left": 0.0, + "Height": 1.0 + }, + "Polygon": [ + { + "Y": 0.0, + "X": 0.0 + }, + { + "Y": 0.0, + "X": 1.0 + }, + { + "Y": 1.0, + "X": 1.0 + }, + { + "Y": 1.0, + "X": 0.0 + } + ] + }, + "Relationships": [ + { + "Type": "CHILD", + "Ids": [ + "1b926a34-0357-407b-ac8f-ec473160c6a9", + "0c35dc17-3605-4c9d-af1a-d9451059df51", + "dea3db8a-52c2-41c0-b50c-81f66f4aa758" + ] + } + ], + "BlockType": "PAGE", + "Id": "84671a5e-8c99-43be-a9d1-6838965da33e", + "Page": 1 + } + ], + "NextToken": "GcqyoAJuZwujOT35EN4LCI3EUzMtiLq3nKyFFHvU5q1SaIdEBcSty+njNgoWwuMP/muqc96S4o5NzDqehhXvhkodMyVO5OJGyms5lsrCxibWJw==", + "DocumentMetadata": { + "Pages": 1 + }, + "JobStatus": "SUCCEEDED" + } + +For more information, see `Detecting and Analyzing Text in Multi-Page Documents`_ in the *Amazon Textract Developers Guide* + .. _`Detecting and Analyzing Text in Multi-Page Documents`: https://docs.aws.amazon.com/textract/latest/dg/async.html \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/textract/start-document-analysis.rst awscli-1.22.34/awscli/examples/textract/start-document-analysis.rst --- awscli-1.21.9/awscli/examples/textract/start-document-analysis.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/textract/start-document-analysis.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,15 +1,28 @@ -**To start analyzing text in a multi-page document** - -The following ``start-document-analysis`` example shows how to start asynchronous analysis of text in a multi-page document. :: - - aws textract start-document-analysis --document-location '{"S3Object":{"Bucket":"reescheastv","Name":"doctest.png"}}' --feature-types '["TABLES","FORMS"]' --notification-channel "SNSTopicArn=arn:snsTopic,RoleArn=roleArn" - -Output :: - - { - "JobId": "df7cf32ebbd2a5de113535fcf4d921926a701b09b4e7d089f3aebadb41e0712b" - } - -For more information, see `Detecting and Analyzing Text in Multi-Page Documents`_ in the *Amazon Textract Developers Guide* - -.. _`Detecting and Analyzing Text in Multi-Page Documents`: https://docs.aws.amazon.com/textract/latest/dg/async.html +**To start analyzing text in a multi-page document** + +The following ``start-document-analysis`` example shows how to start asynchronous analysis of text in a multi-page document. + +Linux/macOS:: + + aws textract start-document-analysis \ + --document-location '{"S3Object":{"Bucket":"bucket","Name":"document"}}' \ + --feature-types '["TABLES","FORMS"]' \ + --notification-channel "SNSTopicArn=arn:snsTopic,RoleArn=roleArn" + +Windows:: + + aws textract start-document-analysis \ + --document-location "{\"S3Object\":{\"Bucket\":\"bucket\",\"Name\":\"document\"}}" \ + --feature-types "[\"TABLES\", \"FORMS\"]" \ + --region region-name \ + --notification-channel "SNSTopicArn=arn:snsTopic,RoleArn=roleArn" + +Output:: + + { + "JobId": "df7cf32ebbd2a5de113535fcf4d921926a701b09b4e7d089f3aebadb41e0712b" + } + +For more information, see `Detecting and Analyzing Text in Multi-Page Documents`_ in the *Amazon Textract Developers Guide* + +.. _`Detecting and Analyzing Text in Multi-Page Documents`: https://docs.aws.amazon.com/textract/latest/dg/async.html \ No newline at end of file diff -Nru awscli-1.21.9/awscli/examples/textract/start-document-text-detection.rst awscli-1.22.34/awscli/examples/textract/start-document-text-detection.rst --- awscli-1.21.9/awscli/examples/textract/start-document-text-detection.rst 2021-11-02 18:19:34.000000000 +0000 +++ awscli-1.22.34/awscli/examples/textract/start-document-text-detection.rst 2022-01-12 19:04:32.000000000 +0000 @@ -1,15 +1,26 @@ -**To start detecting text in a multi-page document** - -The following ``start-document-text-detection`` example shows how to start asynchronous detection of text in a multi-page document. :: - - aws textract start-document-text-detection --document-location '{"S3Object":{"Bucket":"reescheastv","Name":"doctest.png"}}' --notification-channel "SNSTopicArn=topicARN,RoleArn=roleARN" - -The command returns output similar to the following. :: - - { - "JobId": "57849a3dc627d4df74123dca269d69f7b89329c870c65bb16c9fd63409d200b9" - } - -For more information, see `Detecting and Analyzing Text in Multi-Page Documents`_ in the *Amazon Textract Developers Guide* - +**To start detecting text in a multi-page document** + +The following ``start-document-text-detection`` example shows how to start asynchronous detection of text in a multi-page document. + +Linux/macOS:: + + aws textract start-document-text-detection \ + --document-location '{"S3Object":{"Bucket":"bucket","Name":"document"}}' \ + --notification-channel "SNSTopicArn=arn:snsTopic,RoleArn=roleARN" + +Windows:: + + aws textract start-document-text-detection \ + --document-location "{\"S3Object\":{\"Bucket\":\"bucket\",\"Name\":\"document\"}}" \ + --region region-name \ + --notification-channel "SNSTopicArn=arn:snsTopic,RoleArn=roleArn" + +Output:: + + { + "JobId": "57849a3dc627d4df74123dca269d69f7b89329c870c65bb16c9fd63409d200b9" + } + +For more information, see `Detecting and Analyzing Text in Multi-Page Documents`_ in the *Amazon Textract Developers Guide* + .. _`Detecting and Analyzing Text in Multi-Page Documents`: https://docs.aws.amazon.com/textract/latest/dg/async.html \ No newline at end of file diff -Nru awscli-1.21.9/awscli/__init__.py awscli-1.22.34/awscli/__init__.py --- awscli-1.21.9/awscli/__init__.py 2021-11-02 18:22:25.000000000 +0000 +++ awscli-1.22.34/awscli/__init__.py 2022-01-12 19:07:35.000000000 +0000 @@ -17,7 +17,7 @@ """ import os -__version__ = '1.21.9' +__version__ = '1.22.34' # # Get our data path to be added to botocore's search path diff -Nru awscli-1.21.9/awscli/shorthand.py awscli-1.22.34/awscli/shorthand.py --- awscli-1.21.9/awscli/shorthand.py 2021-11-02 18:19:46.000000000 +0000 +++ awscli-1.22.34/awscli/shorthand.py 2022-01-12 19:04:32.000000000 +0000 @@ -109,7 +109,7 @@ def _construct_msg(self): msg = ( "Second instance of key \"%s\" encountered for input:\n%s\n" - "This is often because there is a preceeding \",\" instead of a " + "This is often because there is a preceding \",\" instead of a " "space." ) % (self.key, self._error_location()) return msg @@ -162,7 +162,7 @@ parser.parse('a=b') # {'a': 'b'} parser.parse('a=b,c') # {'a': ['b', 'c']} - :tpye value: str + :type value: str :param value: Any value that needs to be parsed. :return: Parsed value, which will be a dictionary. diff -Nru awscli-1.21.9/awscli/topictags.py awscli-1.22.34/awscli/topictags.py --- awscli-1.21.9/awscli/topictags.py 2021-11-02 18:19:46.000000000 +0000 +++ awscli-1.22.34/awscli/topictags.py 2022-01-12 19:04:32.000000000 +0000 @@ -281,7 +281,7 @@ :param topic_name: The name of the topic :param tag: The name of the tag to retrieve - :raises VauleError: Raised if there is not exactly one value + :raises ValueError: Raised if there is not exactly one value in the list value. """ value = self.get_tag_value(topic_name, tag) diff -Nru awscli-1.21.9/awscli.egg-info/PKG-INFO awscli-1.22.34/awscli.egg-info/PKG-INFO --- awscli-1.21.9/awscli.egg-info/PKG-INFO 2021-11-02 18:22:25.000000000 +0000 +++ awscli-1.22.34/awscli.egg-info/PKG-INFO 2022-01-12 19:07:35.000000000 +0000 @@ -1,10 +1,13 @@ Metadata-Version: 2.1 Name: awscli -Version: 1.21.9 +Version: 1.22.34 Summary: Universal Command Line Environment for AWS. Home-page: http://aws.amazon.com/cli/ Author: Amazon Web Services License: Apache License 2.0 +Project-URL: Source, https://github.com/aws/aws-cli +Project-URL: Reference, https://docs.aws.amazon.com/cli/latest/reference/ +Project-URL: Changelog, https://github.com/aws/aws-cli/blob/develop/CHANGELOG.rst Platform: UNKNOWN Classifier: Development Status :: 5 - Production/Stable Classifier: Intended Audience :: Developers @@ -55,12 +58,15 @@ - 3.9.x and greater - 3.10.x and greater -On 01/15/2021 deprecation for Python 2.7 was announced and support was dropped +Notices +~~~~~~~ + +On 01/15/2021, deprecation for Python 2.7 was announced and support was dropped on 07/15/2021. To avoid disruption, customers using the AWS CLI on Python 2.7 may need to upgrade their version of Python or pin the version of the AWS CLI. For more information, see this `blog post `__. -On 10/29/2020 support for Python 3.4 and Python 3.5 was deprecated and +On 10/29/2020, support for Python 3.4 and Python 3.5 was deprecated and support was dropped on 02/01/2021. Customers using the AWS CLI on Python 3.4 or 3.5 will need to upgrade their version of Python to continue receiving feature and security updates. For more information, @@ -111,7 +117,7 @@ $ python -m pip install --user awscli If you have the aws-cli package installed and want to upgrade to the -latest version you can run: +latest version, you can run: :: diff -Nru awscli-1.21.9/awscli.egg-info/requires.txt awscli-1.22.34/awscli.egg-info/requires.txt --- awscli-1.21.9/awscli.egg-info/requires.txt 2021-11-02 18:22:25.000000000 +0000 +++ awscli-1.22.34/awscli.egg-info/requires.txt 2022-01-12 19:07:35.000000000 +0000 @@ -1,4 +1,4 @@ -botocore==1.22.9 +botocore==1.23.34 docutils<0.16,>=0.10 s3transfer<0.6.0,>=0.5.0 PyYAML<5.5,>=3.10 diff -Nru awscli-1.21.9/awscli.egg-info/SOURCES.txt awscli-1.22.34/awscli.egg-info/SOURCES.txt --- awscli-1.21.9/awscli.egg-info/SOURCES.txt 2021-11-02 18:22:26.000000000 +0000 +++ awscli-1.22.34/awscli.egg-info/SOURCES.txt 2022-01-12 19:07:35.000000000 +0000 @@ -399,10 +399,38 @@ awscli/examples/apigatewayv2/update-route.rst awscli/examples/apigatewayv2/update-stage.rst awscli/examples/apigatewayv2/update-vpc-link.rst +awscli/examples/appconfig/create-application.rst +awscli/examples/appconfig/create-configuration-profile.rst +awscli/examples/appconfig/create-environment.rst +awscli/examples/appconfig/create-hosted-configuration-version.rst +awscli/examples/appconfig/delete-application.rst +awscli/examples/appconfig/delete-configuration-profile.rst +awscli/examples/appconfig/delete-deployment-strategy.rst +awscli/examples/appconfig/delete-environment.rst +awscli/examples/appconfig/delete-hosted-configuration-version.rst +awscli/examples/appconfig/get-application.rst +awscli/examples/appconfig/get-configuration-profile.rst awscli/examples/appconfig/get-configuration.rst +awscli/examples/appconfig/get-deployment-strategy.rst +awscli/examples/appconfig/get-deployment.rst +awscli/examples/appconfig/get-environment.rst +awscli/examples/appconfig/get-hosted-configuration-version.rst awscli/examples/appconfig/list-applications.rst awscli/examples/appconfig/list-configuration-profiles.rst +awscli/examples/appconfig/list-deployment-strategies.rst +awscli/examples/appconfig/list-deployments.rst awscli/examples/appconfig/list-environments.rst +awscli/examples/appconfig/list-hosted-configuration-versions.rst +awscli/examples/appconfig/list-tags-for-resource.rst +awscli/examples/appconfig/start-deployment.rst +awscli/examples/appconfig/stop-deployment.rst +awscli/examples/appconfig/tag-resource.rst +awscli/examples/appconfig/untag-resource.rst +awscli/examples/appconfig/update-application.rst +awscli/examples/appconfig/update-configuration-profile.rst +awscli/examples/appconfig/update-deployment-strategy.rst +awscli/examples/appconfig/update-environment.rst +awscli/examples/appconfig/validate-configuration.rst awscli/examples/application-autoscaling/delete-scaling-policy.rst awscli/examples/application-autoscaling/delete-scheduled-action.rst awscli/examples/application-autoscaling/deregister-scalable-target.rst @@ -441,6 +469,28 @@ awscli/examples/appmesh/update-virtual-node.rst awscli/examples/appmesh/update-virtual-router.rst awscli/examples/appmesh/update-virtual-service.rst +awscli/examples/apprunner/associate-custom-domain.rst +awscli/examples/apprunner/create-auto-scaling-configuration.rst +awscli/examples/apprunner/create-connection.rst +awscli/examples/apprunner/create-service.rst +awscli/examples/apprunner/delete-auto-scaling-configuration.rst +awscli/examples/apprunner/delete-connection.rst +awscli/examples/apprunner/delete-service.rst +awscli/examples/apprunner/describe-auto-scaling-configuration.rst +awscli/examples/apprunner/describe-custom-domains.rst +awscli/examples/apprunner/describe-service.rst +awscli/examples/apprunner/disassociate-custom-domain.rst +awscli/examples/apprunner/list-auto-scaling-configurations.rst +awscli/examples/apprunner/list-connections.rst +awscli/examples/apprunner/list-operations.rst +awscli/examples/apprunner/list-services.rst +awscli/examples/apprunner/list-tags-for-resource.rst +awscli/examples/apprunner/pause-service.rst +awscli/examples/apprunner/resume-service.rst +awscli/examples/apprunner/start-deployment.rst +awscli/examples/apprunner/tag-resource.rst +awscli/examples/apprunner/untag-resource.rst +awscli/examples/apprunner/update-service.rst awscli/examples/athena/batch-get-named-query.rst awscli/examples/athena/batch-get-query-execution.rst awscli/examples/athena/create-data-catalog.rst @@ -673,14 +723,24 @@ awscli/examples/cloud9/list-environments.rst awscli/examples/cloud9/update-environment-membership.rst awscli/examples/cloud9/update-environment.rst +awscli/examples/cloudcontrol/create-resource.rst +awscli/examples/cloudcontrol/delete-resource.rst +awscli/examples/cloudcontrol/get-resource-request-status.rst +awscli/examples/cloudcontrol/get-resource.rst +awscli/examples/cloudcontrol/list-resource-requests.rst +awscli/examples/cloudcontrol/list-resources.rst +awscli/examples/cloudcontrol/update-resource.rst awscli/examples/cloudformation/_deploy_description.rst awscli/examples/cloudformation/_package_description.rst +awscli/examples/cloudformation/activate-type.rst +awscli/examples/cloudformation/batch-describe-type-configurations.rst awscli/examples/cloudformation/cancel-update-stack.rst awscli/examples/cloudformation/continue-update-rollback.rst awscli/examples/cloudformation/create-change-set.rst awscli/examples/cloudformation/create-stack-instances.rst awscli/examples/cloudformation/create-stack-set.rst awscli/examples/cloudformation/create-stack.rst +awscli/examples/cloudformation/deactivate-type.rst awscli/examples/cloudformation/delete-change-set.rst awscli/examples/cloudformation/delete-stack-instances.rst awscli/examples/cloudformation/delete-stack-set.rst @@ -689,6 +749,7 @@ awscli/examples/cloudformation/deregister-type.rst awscli/examples/cloudformation/describe-account-limits.rst awscli/examples/cloudformation/describe-change-set.rst +awscli/examples/cloudformation/describe-publisher.rst awscli/examples/cloudformation/describe-stack-drift-detection-status.rst awscli/examples/cloudformation/describe-stack-events.rst awscli/examples/cloudformation/describe-stack-instance.rst @@ -721,11 +782,15 @@ awscli/examples/cloudformation/list-type-versions.rst awscli/examples/cloudformation/list-types.rst awscli/examples/cloudformation/package.rst +awscli/examples/cloudformation/publish-type.rst +awscli/examples/cloudformation/register-publisher.rst awscli/examples/cloudformation/register-type.rst awscli/examples/cloudformation/set-stack-policy.rst +awscli/examples/cloudformation/set-type-configuration.rst awscli/examples/cloudformation/set-type-default-version.rst awscli/examples/cloudformation/signal-resource.rst awscli/examples/cloudformation/stop-stack-set-operation.rst +awscli/examples/cloudformation/test-type.rst awscli/examples/cloudformation/update-stack-instances.rst awscli/examples/cloudformation/update-stack-set.rst awscli/examples/cloudformation/update-stack.rst @@ -1487,6 +1552,7 @@ awscli/examples/ec2/advertise-byoip-cidr.rst awscli/examples/ec2/allocate-address.rst awscli/examples/ec2/allocate-hosts.rst +awscli/examples/ec2/allocate-ipam-pool-cidr.rst awscli/examples/ec2/apply-security-groups-to-client-vpn-target-network.rst awscli/examples/ec2/assign-ipv6-addresses.rst awscli/examples/ec2/assign-private-ip-addresses.rst @@ -1534,6 +1600,9 @@ awscli/examples/ec2/create-image.rst awscli/examples/ec2/create-instance-export-task.rst awscli/examples/ec2/create-internet-gateway.rst +awscli/examples/ec2/create-ipam-pool.rst +awscli/examples/ec2/create-ipam-scope.rst +awscli/examples/ec2/create-ipam.rst awscli/examples/ec2/create-key-pair.rst awscli/examples/ec2/create-launch-template-version.rst awscli/examples/ec2/create-launch-template.rst @@ -1564,7 +1633,9 @@ awscli/examples/ec2/create-traffic-mirror-filter.rst awscli/examples/ec2/create-traffic-mirror-session.rst awscli/examples/ec2/create-traffic-mirror-target.rst +awscli/examples/ec2/create-transit-gateway-connect-peer.rst awscli/examples/ec2/create-transit-gateway-connect.rst +awscli/examples/ec2/create-transit-gateway-multicast-domain.rst awscli/examples/ec2/create-transit-gateway-peering-attachment.rst awscli/examples/ec2/create-transit-gateway-prefix-list-reference.rst awscli/examples/ec2/create-transit-gateway-route-table.rst @@ -1590,6 +1661,8 @@ awscli/examples/ec2/delete-flow-logs.rst awscli/examples/ec2/delete-fpga-image.rst awscli/examples/ec2/delete-internet-gateway.rst +awscli/examples/ec2/delete-ipam-scope.rst +awscli/examples/ec2/delete-ipam.rst awscli/examples/ec2/delete-key-pair.rst awscli/examples/ec2/delete-launch-template-versions.rst awscli/examples/ec2/delete-launch-template.rst @@ -1616,6 +1689,8 @@ awscli/examples/ec2/delete-traffic-mirror-filter.rst awscli/examples/ec2/delete-traffic-mirror-session.rst awscli/examples/ec2/delete-traffic-mirror-target.rst +awscli/examples/ec2/delete-transit-gateway-connect-peer.rst +awscli/examples/ec2/delete-transit-gateway-connect.rst awscli/examples/ec2/delete-transit-gateway-multicast-domain.rst awscli/examples/ec2/delete-transit-gateway-peering-attachment.rst awscli/examples/ec2/delete-transit-gateway-prefix-list-reference.rst @@ -1633,6 +1708,7 @@ awscli/examples/ec2/delete-vpn-connection.rst awscli/examples/ec2/delete-vpn-gateway.rst awscli/examples/ec2/deprovision-byoip-cidr.rst +awscli/examples/ec2/deprovision-ipam-pool-cidr.rst awscli/examples/ec2/deregister-image.rst awscli/examples/ec2/deregister-instance-event-notification-attributes.rst awscli/examples/ec2/deregister-transit-gateway-multicast-group-members.rst @@ -1685,6 +1761,9 @@ awscli/examples/ec2/describe-instance-types.rst awscli/examples/ec2/describe-instances.rst awscli/examples/ec2/describe-internet-gateways.rst +awscli/examples/ec2/describe-ipam-pools.rst +awscli/examples/ec2/describe-ipam-scopes.rst +awscli/examples/ec2/describe-ipams.rst awscli/examples/ec2/describe-ipv6-pools.rst awscli/examples/ec2/describe-key-pairs.rst awscli/examples/ec2/describe-launch-template-versions.rst @@ -1735,6 +1814,7 @@ awscli/examples/ec2/describe-traffic-mirror-sessions.rst awscli/examples/ec2/describe-traffic-mirror-targets.rst awscli/examples/ec2/describe-transit-gateway-attachments.rst +awscli/examples/ec2/describe-transit-gateway-connect-peers.rst awscli/examples/ec2/describe-transit-gateway-connects.rst awscli/examples/ec2/describe-transit-gateway-multicast-domains.rst awscli/examples/ec2/describe-transit-gateway-peering-attachments.rst @@ -1780,6 +1860,7 @@ awscli/examples/ec2/disassociate-vpc-cidr-block.rst awscli/examples/ec2/enable-ebs-encryption-by-default.rst awscli/examples/ec2/enable-fast-snapshot-restores.rst +awscli/examples/ec2/enable-ipam-organization-admin-account.rst awscli/examples/ec2/enable-serial-console-access.rst awscli/examples/ec2/enable-transit-gateway-route-table-propagation.rst awscli/examples/ec2/enable-vgw-route-propagation.rst @@ -1800,6 +1881,10 @@ awscli/examples/ec2/get-flow-logs-integration-template.rst awscli/examples/ec2/get-groups-for-capacity-reservation.rst awscli/examples/ec2/get-host-reservation-purchase-preview.rst +awscli/examples/ec2/get-ipam-address-history.rst +awscli/examples/ec2/get-ipam-pool-allocations.rst +awscli/examples/ec2/get-ipam-pool-cidrs.rst +awscli/examples/ec2/get-ipam-resource-cidrs.rst awscli/examples/ec2/get-launch-template-data.rst awscli/examples/ec2/get-managed-prefix-list-associations.rst awscli/examples/ec2/get-managed-prefix-list-entries.rst @@ -1834,6 +1919,9 @@ awscli/examples/ec2/modify-instance-event-start-time.rst awscli/examples/ec2/modify-instance-metadata-options.rst awscli/examples/ec2/modify-instance-placement.rst +awscli/examples/ec2/modify-ipam-pool.rst +awscli/examples/ec2/modify-ipam-resource-cidr.rst +awscli/examples/ec2/modify-ipam.rst awscli/examples/ec2/modify-launch-template.rst awscli/examples/ec2/modify-managed-prefix-list.rst awscli/examples/ec2/modify-network-interface-attribute.rst @@ -1862,7 +1950,9 @@ awscli/examples/ec2/modify-vpn-tunnel-options.rst awscli/examples/ec2/monitor-instances.rst awscli/examples/ec2/move-address-to-vpc.rst +awscli/examples/ec2/move-byoip-cidr-to-ipam.rst awscli/examples/ec2/provision-byoip-cidr.rst +awscli/examples/ec2/provision-ipam-pool-cidr.rst awscli/examples/ec2/purchase-host-reservation.rst awscli/examples/ec2/purchase-reserved-instances-offering.rst awscli/examples/ec2/purchase-scheduled-instances.rst @@ -1871,6 +1961,7 @@ awscli/examples/ec2/register-instance-event-notification-attributes.rst awscli/examples/ec2/register-transit-gateway-multicase-group-sources.rst awscli/examples/ec2/register-transit-gateway-multicast-group-members.rst +awscli/examples/ec2/register-transit-gateway-multicast-group-sources.rst awscli/examples/ec2/reject-transit-gateway-peering-attachment.rst awscli/examples/ec2/reject-transit-gateway-vpc-attachments.rst awscli/examples/ec2/reject-vpc-endpoint-connections.rst @@ -3820,17 +3911,25 @@ awscli/examples/qldb/update-ledger-permissions-mode.rst awscli/examples/qldb/update-ledger.rst awscli/examples/ram/accept-resource-share-invitation.rst +awscli/examples/ram/associate-resource-share-permission.rst awscli/examples/ram/associate-resource-share.rst awscli/examples/ram/create-resource-share.rst awscli/examples/ram/delete-resource-share.rst +awscli/examples/ram/disassociate-resource-share-permission.rst awscli/examples/ram/disassociate-resource-share.rst awscli/examples/ram/enable-sharing-with-aws-organization.rst +awscli/examples/ram/get-permission.rst awscli/examples/ram/get-resource-policies.rst awscli/examples/ram/get-resource-share-associations.rst awscli/examples/ram/get-resource-share-invitations.rst awscli/examples/ram/get-resource-shares.rst +awscli/examples/ram/list-pending-invitation-resources.rst +awscli/examples/ram/list-permissions.rst awscli/examples/ram/list-principals.rst +awscli/examples/ram/list-resource-share-permissions.rst +awscli/examples/ram/list-resource-types.rst awscli/examples/ram/list-resources.rst +awscli/examples/ram/promote-resource-share-created-from-policy.rst awscli/examples/ram/reject-resource-share-invitation.rst awscli/examples/ram/tag-resource.rst awscli/examples/ram/untag-resource.rst @@ -4354,12 +4453,16 @@ awscli/examples/secretsmanager/list-secrets.rst awscli/examples/secretsmanager/put-resource-policy.rst awscli/examples/secretsmanager/put-secret-value.rst +awscli/examples/secretsmanager/remove-regions-from-replication.rst +awscli/examples/secretsmanager/replicate-secret-to-regions.rst awscli/examples/secretsmanager/restore-secret.rst awscli/examples/secretsmanager/rotate-secret.rst +awscli/examples/secretsmanager/stop-replication-to-replica.rst awscli/examples/secretsmanager/tag-resource.rst awscli/examples/secretsmanager/untag-resource.rst awscli/examples/secretsmanager/update-secret-version-stage.rst awscli/examples/secretsmanager/update-secret.rst +awscli/examples/secretsmanager/validate-resource-policy.rst awscli/examples/securityhub/accept-administrator-invitation.rst awscli/examples/securityhub/accept-invitation.rst awscli/examples/securityhub/batch-disable-standards.rst @@ -4367,10 +4470,12 @@ awscli/examples/securityhub/batch-import-findings.rst awscli/examples/securityhub/batch-update-findings.rst awscli/examples/securityhub/create-action-target.rst +awscli/examples/securityhub/create-finding-aggregator.rst awscli/examples/securityhub/create-insight.rst awscli/examples/securityhub/create-members.rst awscli/examples/securityhub/decline-invitations.rst awscli/examples/securityhub/delete-action-target.rst +awscli/examples/securityhub/delete-finding-aggregator.rst awscli/examples/securityhub/delete-insight.rst awscli/examples/securityhub/delete-invitations.rst awscli/examples/securityhub/delete-members.rst @@ -4391,6 +4496,7 @@ awscli/examples/securityhub/enable-security-hub.rst awscli/examples/securityhub/get-administrator-account.rst awscli/examples/securityhub/get-enabled-standards.rst +awscli/examples/securityhub/get-finding-aggregator.rst awscli/examples/securityhub/get-findings.rst awscli/examples/securityhub/get-insight-results.rst awscli/examples/securityhub/get-insights.rst @@ -4399,6 +4505,7 @@ awscli/examples/securityhub/get-members.rst awscli/examples/securityhub/invite-members.rst awscli/examples/securityhub/list-enabled-products-for-import.rst +awscli/examples/securityhub/list-finding-aggregators.rst awscli/examples/securityhub/list-invitations.rst awscli/examples/securityhub/list-members.rst awscli/examples/securityhub/list-organization-admin-accounts.rst @@ -4406,6 +4513,7 @@ awscli/examples/securityhub/tag-resource.rst awscli/examples/securityhub/untag-resource.rst awscli/examples/securityhub/update-action-target.rst +awscli/examples/securityhub/update-finding-aggregator.rst awscli/examples/securityhub/update-insight.rst awscli/examples/securityhub/update-organization-configuration.rst awscli/examples/securityhub/update-security-hub-configuration.rst diff -Nru awscli-1.21.9/debian/changelog awscli-1.22.34/debian/changelog --- awscli-1.21.9/debian/changelog 2021-11-03 17:34:09.000000000 +0000 +++ awscli-1.22.34/debian/changelog 2022-01-13 00:36:08.000000000 +0000 @@ -1,3 +1,9 @@ +awscli (1.22.34-1) unstable; urgency=medium + + * New upstream version 1.22.34 + + -- Noah Meyerhans Wed, 12 Jan 2022 16:36:08 -0800 + awscli (1.21.9-1) unstable; urgency=medium * New upstream version 1.21.9 diff -Nru awscli-1.21.9/PKG-INFO awscli-1.22.34/PKG-INFO --- awscli-1.21.9/PKG-INFO 2021-11-02 18:22:26.828759000 +0000 +++ awscli-1.22.34/PKG-INFO 2022-01-12 19:07:36.489273500 +0000 @@ -1,10 +1,13 @@ Metadata-Version: 2.1 Name: awscli -Version: 1.21.9 +Version: 1.22.34 Summary: Universal Command Line Environment for AWS. Home-page: http://aws.amazon.com/cli/ Author: Amazon Web Services License: Apache License 2.0 +Project-URL: Source, https://github.com/aws/aws-cli +Project-URL: Reference, https://docs.aws.amazon.com/cli/latest/reference/ +Project-URL: Changelog, https://github.com/aws/aws-cli/blob/develop/CHANGELOG.rst Platform: UNKNOWN Classifier: Development Status :: 5 - Production/Stable Classifier: Intended Audience :: Developers @@ -55,12 +58,15 @@ - 3.9.x and greater - 3.10.x and greater -On 01/15/2021 deprecation for Python 2.7 was announced and support was dropped +Notices +~~~~~~~ + +On 01/15/2021, deprecation for Python 2.7 was announced and support was dropped on 07/15/2021. To avoid disruption, customers using the AWS CLI on Python 2.7 may need to upgrade their version of Python or pin the version of the AWS CLI. For more information, see this `blog post `__. -On 10/29/2020 support for Python 3.4 and Python 3.5 was deprecated and +On 10/29/2020, support for Python 3.4 and Python 3.5 was deprecated and support was dropped on 02/01/2021. Customers using the AWS CLI on Python 3.4 or 3.5 will need to upgrade their version of Python to continue receiving feature and security updates. For more information, @@ -111,7 +117,7 @@ $ python -m pip install --user awscli If you have the aws-cli package installed and want to upgrade to the -latest version you can run: +latest version, you can run: :: diff -Nru awscli-1.21.9/README.rst awscli-1.22.34/README.rst --- awscli-1.21.9/README.rst 2021-11-02 18:19:46.000000000 +0000 +++ awscli-1.22.34/README.rst 2022-01-12 19:04:32.000000000 +0000 @@ -32,12 +32,15 @@ - 3.9.x and greater - 3.10.x and greater -On 01/15/2021 deprecation for Python 2.7 was announced and support was dropped +Notices +~~~~~~~ + +On 01/15/2021, deprecation for Python 2.7 was announced and support was dropped on 07/15/2021. To avoid disruption, customers using the AWS CLI on Python 2.7 may need to upgrade their version of Python or pin the version of the AWS CLI. For more information, see this `blog post `__. -On 10/29/2020 support for Python 3.4 and Python 3.5 was deprecated and +On 10/29/2020, support for Python 3.4 and Python 3.5 was deprecated and support was dropped on 02/01/2021. Customers using the AWS CLI on Python 3.4 or 3.5 will need to upgrade their version of Python to continue receiving feature and security updates. For more information, @@ -88,7 +91,7 @@ $ python -m pip install --user awscli If you have the aws-cli package installed and want to upgrade to the -latest version you can run: +latest version, you can run: :: diff -Nru awscli-1.21.9/requirements.txt awscli-1.22.34/requirements.txt --- awscli-1.21.9/requirements.txt 2021-11-02 18:19:46.000000000 +0000 +++ awscli-1.22.34/requirements.txt 2022-01-12 19:04:18.000000000 +0000 @@ -1,5 +1,5 @@ # botocore and the awscli packages are typically developed # in tandem, so we're requiring the latest develop # branch of botocore and s3transfer when working on the awscli. --e git://github.com/boto/botocore.git@develop#egg=botocore --e git://github.com/boto/s3transfer.git@develop#egg=s3transfer +-e git+https://github.com/boto/botocore.git@develop#egg=botocore +-e git+https://github.com/boto/s3transfer.git@develop#egg=s3transfer diff -Nru awscli-1.21.9/setup.cfg awscli-1.22.34/setup.cfg --- awscli-1.21.9/setup.cfg 2021-11-02 18:22:26.828759000 +0000 +++ awscli-1.22.34/setup.cfg 2022-01-12 19:07:36.489273500 +0000 @@ -3,7 +3,7 @@ [metadata] requires_dist = - botocore==1.22.9 + botocore==1.23.34 docutils>=0.10,<0.16 s3transfer>=0.5.0,<0.6.0 PyYAML>=3.10,<5.5 diff -Nru awscli-1.21.9/setup.py awscli-1.22.34/setup.py --- awscli-1.21.9/setup.py 2021-11-02 18:22:25.000000000 +0000 +++ awscli-1.22.34/setup.py 2022-01-12 19:07:35.000000000 +0000 @@ -24,7 +24,7 @@ install_requires = [ - 'botocore==1.22.9', + 'botocore==1.23.34', 'docutils>=0.10,<0.16', 's3transfer>=0.5.0,<0.6.0', 'PyYAML>=3.10,<5.5', @@ -66,6 +66,11 @@ 'Programming Language :: Python :: 3.9', 'Programming Language :: Python :: 3.10', ], + project_urls={ + 'Source': 'https://github.com/aws/aws-cli', + 'Reference': 'https://docs.aws.amazon.com/cli/latest/reference/', + 'Changelog': 'https://github.com/aws/aws-cli/blob/develop/CHANGELOG.rst', + }, )