diff --git a/awscli/examples/appconfig/create-application.rst b/awscli/examples/appconfig/create-application.rst new file mode 100644 index 000000000000..1b5ba40f6c4e --- /dev/null +++ b/awscli/examples/appconfig/create-application.rst @@ -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 --git a/awscli/examples/appconfig/create-configuration-profile.rst b/awscli/examples/appconfig/create-configuration-profile.rst new file mode 100644 index 000000000000..5a467677ea4e --- /dev/null +++ b/awscli/examples/appconfig/create-configuration-profile.rst @@ -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 --git a/awscli/examples/appconfig/create-environment.rst b/awscli/examples/appconfig/create-environment.rst new file mode 100644 index 000000000000..fa2c774fb49a --- /dev/null +++ b/awscli/examples/appconfig/create-environment.rst @@ -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 --git a/awscli/examples/appconfig/create-hosted-configuration-version.rst b/awscli/examples/appconfig/create-hosted-configuration-version.rst new file mode 100644 index 000000000000..a05909a526a7 --- /dev/null +++ b/awscli/examples/appconfig/create-hosted-configuration-version.rst @@ -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 --git a/awscli/examples/appconfig/delete-application.rst b/awscli/examples/appconfig/delete-application.rst new file mode 100644 index 000000000000..2573e5574f96 --- /dev/null +++ b/awscli/examples/appconfig/delete-application.rst @@ -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 --git a/awscli/examples/appconfig/delete-configuration-profile.rst b/awscli/examples/appconfig/delete-configuration-profile.rst new file mode 100644 index 000000000000..9d602bf19c50 --- /dev/null +++ b/awscli/examples/appconfig/delete-configuration-profile.rst @@ -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 --git a/awscli/examples/appconfig/delete-deployment-strategy.rst b/awscli/examples/appconfig/delete-deployment-strategy.rst new file mode 100644 index 000000000000..8f3ca7947359 --- /dev/null +++ b/awscli/examples/appconfig/delete-deployment-strategy.rst @@ -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 --git a/awscli/examples/appconfig/delete-environment.rst b/awscli/examples/appconfig/delete-environment.rst new file mode 100644 index 000000000000..fd8f36680c03 --- /dev/null +++ b/awscli/examples/appconfig/delete-environment.rst @@ -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 --git a/awscli/examples/appconfig/delete-hosted-configuration-version.rst b/awscli/examples/appconfig/delete-hosted-configuration-version.rst new file mode 100644 index 000000000000..cc465ba726fc --- /dev/null +++ b/awscli/examples/appconfig/delete-hosted-configuration-version.rst @@ -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 --git a/awscli/examples/appconfig/get-application.rst b/awscli/examples/appconfig/get-application.rst new file mode 100644 index 000000000000..6bab15ecc4bd --- /dev/null +++ b/awscli/examples/appconfig/get-application.rst @@ -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 --git a/awscli/examples/appconfig/get-configuration-profile.rst b/awscli/examples/appconfig/get-configuration-profile.rst new file mode 100644 index 000000000000..29eb432bf147 --- /dev/null +++ b/awscli/examples/appconfig/get-configuration-profile.rst @@ -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 --git a/awscli/examples/appconfig/get-configuration.rst b/awscli/examples/appconfig/get-configuration.rst index 3413d8037e01..242469727fb5 100644 --- a/awscli/examples/appconfig/get-configuration.rst +++ b/awscli/examples/appconfig/get-configuration.rst @@ -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 --git a/awscli/examples/appconfig/get-deployment-strategy.rst b/awscli/examples/appconfig/get-deployment-strategy.rst new file mode 100644 index 000000000000..16184864f88a --- /dev/null +++ b/awscli/examples/appconfig/get-deployment-strategy.rst @@ -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 --git a/awscli/examples/appconfig/get-deployment.rst b/awscli/examples/appconfig/get-deployment.rst new file mode 100644 index 000000000000..6399274ce0e8 --- /dev/null +++ b/awscli/examples/appconfig/get-deployment.rst @@ -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 --git a/awscli/examples/appconfig/get-environment.rst b/awscli/examples/appconfig/get-environment.rst new file mode 100644 index 000000000000..13a81bb4f260 --- /dev/null +++ b/awscli/examples/appconfig/get-environment.rst @@ -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 --git a/awscli/examples/appconfig/get-hosted-configuration-version.rst b/awscli/examples/appconfig/get-hosted-configuration-version.rst new file mode 100644 index 000000000000..2200b1245d03 --- /dev/null +++ b/awscli/examples/appconfig/get-hosted-configuration-version.rst @@ -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 --git a/awscli/examples/appconfig/list-applications.rst b/awscli/examples/appconfig/list-applications.rst index af8d868dd140..beaff130233b 100755 --- a/awscli/examples/appconfig/list-applications.rst +++ b/awscli/examples/appconfig/list-applications.rst @@ -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 --git a/awscli/examples/appconfig/list-configuration-profiles.rst b/awscli/examples/appconfig/list-configuration-profiles.rst index 622a48ea5a05..486aa0c1b1a7 100755 --- a/awscli/examples/appconfig/list-configuration-profiles.rst +++ b/awscli/examples/appconfig/list-configuration-profiles.rst @@ -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 --git a/awscli/examples/appconfig/list-deployment-strategies.rst b/awscli/examples/appconfig/list-deployment-strategies.rst new file mode 100644 index 000000000000..042666fa307c --- /dev/null +++ b/awscli/examples/appconfig/list-deployment-strategies.rst @@ -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 --git a/awscli/examples/appconfig/list-deployments.rst b/awscli/examples/appconfig/list-deployments.rst new file mode 100644 index 000000000000..0e7590026d4a --- /dev/null +++ b/awscli/examples/appconfig/list-deployments.rst @@ -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 --git a/awscli/examples/appconfig/list-environments.rst b/awscli/examples/appconfig/list-environments.rst index 9f6990c74d6c..6e45b7a22ed9 100755 --- a/awscli/examples/appconfig/list-environments.rst +++ b/awscli/examples/appconfig/list-environments.rst @@ -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 --git a/awscli/examples/appconfig/list-hosted-configuration-versions.rst b/awscli/examples/appconfig/list-hosted-configuration-versions.rst new file mode 100644 index 000000000000..46f6ef888875 --- /dev/null +++ b/awscli/examples/appconfig/list-hosted-configuration-versions.rst @@ -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 --git a/awscli/examples/appconfig/list-tags-for-resource.rst b/awscli/examples/appconfig/list-tags-for-resource.rst new file mode 100644 index 000000000000..0904218b31a7 --- /dev/null +++ b/awscli/examples/appconfig/list-tags-for-resource.rst @@ -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 --git a/awscli/examples/appconfig/start-deployment.rst b/awscli/examples/appconfig/start-deployment.rst new file mode 100644 index 000000000000..cb26673a7425 --- /dev/null +++ b/awscli/examples/appconfig/start-deployment.rst @@ -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 --git a/awscli/examples/appconfig/stop-deployment.rst b/awscli/examples/appconfig/stop-deployment.rst new file mode 100644 index 000000000000..e7dc33711071 --- /dev/null +++ b/awscli/examples/appconfig/stop-deployment.rst @@ -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 --git a/awscli/examples/appconfig/tag-resource.rst b/awscli/examples/appconfig/tag-resource.rst new file mode 100644 index 000000000000..db8cccc8b70c --- /dev/null +++ b/awscli/examples/appconfig/tag-resource.rst @@ -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 --git a/awscli/examples/appconfig/untag-resource.rst b/awscli/examples/appconfig/untag-resource.rst new file mode 100644 index 000000000000..3816a543a007 --- /dev/null +++ b/awscli/examples/appconfig/untag-resource.rst @@ -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 --git a/awscli/examples/appconfig/update-application.rst b/awscli/examples/appconfig/update-application.rst new file mode 100644 index 000000000000..b55da5ed9775 --- /dev/null +++ b/awscli/examples/appconfig/update-application.rst @@ -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 --git a/awscli/examples/appconfig/update-configuration-profile.rst b/awscli/examples/appconfig/update-configuration-profile.rst new file mode 100644 index 000000000000..2f257228e273 --- /dev/null +++ b/awscli/examples/appconfig/update-configuration-profile.rst @@ -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 --git a/awscli/examples/appconfig/update-deployment-strategy.rst b/awscli/examples/appconfig/update-deployment-strategy.rst new file mode 100644 index 000000000000..2df642af937d --- /dev/null +++ b/awscli/examples/appconfig/update-deployment-strategy.rst @@ -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 --git a/awscli/examples/appconfig/update-environment.rst b/awscli/examples/appconfig/update-environment.rst new file mode 100644 index 000000000000..3377ff2bc430 --- /dev/null +++ b/awscli/examples/appconfig/update-environment.rst @@ -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 --git a/awscli/examples/appconfig/validate-configuration.rst b/awscli/examples/appconfig/validate-configuration.rst new file mode 100644 index 000000000000..f9cf1696b452 --- /dev/null +++ b/awscli/examples/appconfig/validate-configuration.rst @@ -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 --git a/awscli/examples/cloudcontrol/create-resource.rst b/awscli/examples/cloudcontrol/create-resource.rst new file mode 100644 index 000000000000..10f9697aa2d3 --- /dev/null +++ b/awscli/examples/cloudcontrol/create-resource.rst @@ -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 --git a/awscli/examples/cloudcontrol/delete-resource.rst b/awscli/examples/cloudcontrol/delete-resource.rst new file mode 100644 index 000000000000..81d3a4f0abb5 --- /dev/null +++ b/awscli/examples/cloudcontrol/delete-resource.rst @@ -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 --git a/awscli/examples/cloudcontrol/get-resource-request-status.rst b/awscli/examples/cloudcontrol/get-resource-request-status.rst new file mode 100644 index 000000000000..17f0e929b341 --- /dev/null +++ b/awscli/examples/cloudcontrol/get-resource-request-status.rst @@ -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 --git a/awscli/examples/cloudcontrol/get-resource.rst b/awscli/examples/cloudcontrol/get-resource.rst new file mode 100644 index 000000000000..693888b0b18f --- /dev/null +++ b/awscli/examples/cloudcontrol/get-resource.rst @@ -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 --git a/awscli/examples/cloudcontrol/list-resource-requests.rst b/awscli/examples/cloudcontrol/list-resource-requests.rst new file mode 100644 index 000000000000..17edec7cf82f --- /dev/null +++ b/awscli/examples/cloudcontrol/list-resource-requests.rst @@ -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 --git a/awscli/examples/cloudcontrol/list-resources.rst b/awscli/examples/cloudcontrol/list-resources.rst new file mode 100644 index 000000000000..09ef323a3ff8 --- /dev/null +++ b/awscli/examples/cloudcontrol/list-resources.rst @@ -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 --git a/awscli/examples/cloudcontrol/update-resource.rst b/awscli/examples/cloudcontrol/update-resource.rst new file mode 100644 index 000000000000..79a4e77ab778 --- /dev/null +++ b/awscli/examples/cloudcontrol/update-resource.rst @@ -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 --git a/awscli/examples/cloudformation/activate-type.rst b/awscli/examples/cloudformation/activate-type.rst new file mode 100644 index 000000000000..964b4b09733c --- /dev/null +++ b/awscli/examples/cloudformation/activate-type.rst @@ -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 --git a/awscli/examples/cloudformation/batch-describe-type-configurations.rst b/awscli/examples/cloudformation/batch-describe-type-configurations.rst new file mode 100644 index 000000000000..88a5ed83a795 --- /dev/null +++ b/awscli/examples/cloudformation/batch-describe-type-configurations.rst @@ -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 --git a/awscli/examples/cloudformation/deactivate-type.rst b/awscli/examples/cloudformation/deactivate-type.rst new file mode 100644 index 000000000000..6c4fcee20c87 --- /dev/null +++ b/awscli/examples/cloudformation/deactivate-type.rst @@ -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 --git a/awscli/examples/cloudformation/describe-publisher.rst b/awscli/examples/cloudformation/describe-publisher.rst new file mode 100644 index 000000000000..214f12fd835f --- /dev/null +++ b/awscli/examples/cloudformation/describe-publisher.rst @@ -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 --git a/awscli/examples/cloudformation/list-type-versions.rst b/awscli/examples/cloudformation/list-type-versions.rst index 0cb228f28af7..0acd8a4df27a 100644 --- a/awscli/examples/cloudformation/list-type-versions.rst +++ b/awscli/examples/cloudformation/list-type-versions.rst @@ -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 --git a/awscli/examples/cloudformation/publish-type.rst b/awscli/examples/cloudformation/publish-type.rst new file mode 100644 index 000000000000..35798cd82976 --- /dev/null +++ b/awscli/examples/cloudformation/publish-type.rst @@ -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 --git a/awscli/examples/cloudformation/register-publisher.rst b/awscli/examples/cloudformation/register-publisher.rst new file mode 100644 index 000000000000..f0d6eb59c20b --- /dev/null +++ b/awscli/examples/cloudformation/register-publisher.rst @@ -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 --git a/awscli/examples/cloudformation/set-type-configuration.rst b/awscli/examples/cloudformation/set-type-configuration.rst new file mode 100644 index 000000000000..7cbc7c9ce8be --- /dev/null +++ b/awscli/examples/cloudformation/set-type-configuration.rst @@ -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 --git a/awscli/examples/cloudformation/test-type.rst b/awscli/examples/cloudformation/test-type.rst new file mode 100644 index 000000000000..b4ca3983f47e --- /dev/null +++ b/awscli/examples/cloudformation/test-type.rst @@ -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 --git a/awscli/examples/ec2/associate-transit-gateway-multicast-domain.rst b/awscli/examples/ec2/associate-transit-gateway-multicast-domain.rst index a0bda8feaba0..1deeb815c1fd 100755 --- a/awscli/examples/ec2/associate-transit-gateway-multicast-domain.rst +++ b/awscli/examples/ec2/associate-transit-gateway-multicast-domain.rst @@ -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-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 `Managing multicast domains `__ in the *Transit Gateways Guide*. \ No newline at end of file diff --git a/awscli/examples/ec2/create-transit-gateway-connect-peer.rst b/awscli/examples/ec2/create-transit-gateway-connect-peer.rst new file mode 100644 index 000000000000..3842fcb168bb --- /dev/null +++ b/awscli/examples/ec2/create-transit-gateway-connect-peer.rst @@ -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 --git a/awscli/examples/ec2/create-transit-gateway-connect.rst b/awscli/examples/ec2/create-transit-gateway-connect.rst index 5c5babd1c2f2..195898d3f182 100644 --- a/awscli/examples/ec2/create-transit-gateway-connect.rst +++ b/awscli/examples/ec2/create-transit-gateway-connect.rst @@ -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 --git a/awscli/examples/ec2/create-transit-gateway-multicast-domain.rst b/awscli/examples/ec2/create-transit-gateway-multicast-domain.rst new file mode 100644 index 000000000000..a4efff723aba --- /dev/null +++ b/awscli/examples/ec2/create-transit-gateway-multicast-domain.rst @@ -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 --git a/awscli/examples/ec2/create-transit-gateway-route-table.rst b/awscli/examples/ec2/create-transit-gateway-route-table.rst index 7a8f4cf620b6..fcd84e785ccb 100644 --- a/awscli/examples/ec2/create-transit-gateway-route-table.rst +++ b/awscli/examples/ec2/create-transit-gateway-route-table.rst @@ -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 --git a/awscli/examples/ec2/create-transit-gateway-route.rst b/awscli/examples/ec2/create-transit-gateway-route.rst index a7c519e73a08..f606f7830b54 100755 --- a/awscli/examples/ec2/create-transit-gateway-route.rst +++ b/awscli/examples/ec2/create-transit-gateway-route.rst @@ -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 --git a/awscli/examples/ec2/create-transit-gateway-vpc-attachment.rst b/awscli/examples/ec2/create-transit-gateway-vpc-attachment.rst index 73eb604720b7..4331097096da 100755 --- a/awscli/examples/ec2/create-transit-gateway-vpc-attachment.rst +++ b/awscli/examples/ec2/create-transit-gateway-vpc-attachment.rst @@ -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 --git a/awscli/examples/ec2/create-transit-gateway.rst b/awscli/examples/ec2/create-transit-gateway.rst index b9f2583c9bea..8ea7832f8e74 100644 --- a/awscli/examples/ec2/create-transit-gateway.rst +++ b/awscli/examples/ec2/create-transit-gateway.rst @@ -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 --git a/awscli/examples/ec2/delete-transit-gateway-connect-peer.rst b/awscli/examples/ec2/delete-transit-gateway-connect-peer.rst new file mode 100644 index 000000000000..7ce1911536c3 --- /dev/null +++ b/awscli/examples/ec2/delete-transit-gateway-connect-peer.rst @@ -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 --git a/awscli/examples/ec2/delete-transit-gateway-connect.rst b/awscli/examples/ec2/delete-transit-gateway-connect.rst new file mode 100644 index 000000000000..beadd5f54e22 --- /dev/null +++ b/awscli/examples/ec2/delete-transit-gateway-connect.rst @@ -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 --git a/awscli/examples/ec2/delete-transit-gateway-multicast-domain.rst b/awscli/examples/ec2/delete-transit-gateway-multicast-domain.rst index 2bd5202bd869..d22f4449360b 100755 --- a/awscli/examples/ec2/delete-transit-gateway-multicast-domain.rst +++ b/awscli/examples/ec2/delete-transit-gateway-multicast-domain.rst @@ -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 --git a/awscli/examples/ec2/delete-transit-gateway-route-table.rst b/awscli/examples/ec2/delete-transit-gateway-route-table.rst index 69b934cea728..93cfe12cca6e 100755 --- a/awscli/examples/ec2/delete-transit-gateway-route-table.rst +++ b/awscli/examples/ec2/delete-transit-gateway-route-table.rst @@ -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 --git a/awscli/examples/ec2/delete-transit-gateway-route.rst b/awscli/examples/ec2/delete-transit-gateway-route.rst index 04ee8593cde0..3b89410b950e 100755 --- a/awscli/examples/ec2/delete-transit-gateway-route.rst +++ b/awscli/examples/ec2/delete-transit-gateway-route.rst @@ -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 --git a/awscli/examples/ec2/delete-transit-gateway-vpc-attachment.rst b/awscli/examples/ec2/delete-transit-gateway-vpc-attachment.rst index 0963dffc234f..10f6307241d9 100644 --- a/awscli/examples/ec2/delete-transit-gateway-vpc-attachment.rst +++ b/awscli/examples/ec2/delete-transit-gateway-vpc-attachment.rst @@ -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 --git a/awscli/examples/ec2/delete-transit-gateway.rst b/awscli/examples/ec2/delete-transit-gateway.rst index 35d706ff1e42..bd787dcf6b9c 100755 --- a/awscli/examples/ec2/delete-transit-gateway.rst +++ b/awscli/examples/ec2/delete-transit-gateway.rst @@ -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 --git a/awscli/examples/ec2/describe-transit-gateway-attachments.rst b/awscli/examples/ec2/describe-transit-gateway-attachments.rst index 151cd20456a4..61b377506f43 100755 --- a/awscli/examples/ec2/describe-transit-gateway-attachments.rst +++ b/awscli/examples/ec2/describe-transit-gateway-attachments.rst @@ -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 --git a/awscli/examples/ec2/describe-transit-gateway-connect-peers.rst b/awscli/examples/ec2/describe-transit-gateway-connect-peers.rst new file mode 100644 index 000000000000..11e4a3011b20 --- /dev/null +++ b/awscli/examples/ec2/describe-transit-gateway-connect-peers.rst @@ -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 --git a/awscli/examples/ec2/describe-transit-gateway-connects.rst b/awscli/examples/ec2/describe-transit-gateway-connects.rst index f3bfd1c2094c..1ab15cedd905 100644 --- a/awscli/examples/ec2/describe-transit-gateway-connects.rst +++ b/awscli/examples/ec2/describe-transit-gateway-connects.rst @@ -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 --git a/awscli/examples/ec2/describe-transit-gateway-route-tables.rst b/awscli/examples/ec2/describe-transit-gateway-route-tables.rst index 93affc3c45b5..c2a2e88572b3 100755 --- a/awscli/examples/ec2/describe-transit-gateway-route-tables.rst +++ b/awscli/examples/ec2/describe-transit-gateway-route-tables.rst @@ -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 --git a/awscli/examples/ec2/describe-transit-gateway-vpc-attachments.rst b/awscli/examples/ec2/describe-transit-gateway-vpc-attachments.rst index 4ba20f8c475f..7620c444131a 100644 --- a/awscli/examples/ec2/describe-transit-gateway-vpc-attachments.rst +++ b/awscli/examples/ec2/describe-transit-gateway-vpc-attachments.rst @@ -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 --git a/awscli/examples/ec2/disable-transit-gateway-route-table-propagation.rst b/awscli/examples/ec2/disable-transit-gateway-route-table-propagation.rst index 12fd6b3e644f..ef1bfb5e5355 100644 --- a/awscli/examples/ec2/disable-transit-gateway-route-table-propagation.rst +++ b/awscli/examples/ec2/disable-transit-gateway-route-table-propagation.rst @@ -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 --git a/awscli/examples/ec2/disassociate-transit-gateway-multicast-domain.rst b/awscli/examples/ec2/disassociate-transit-gateway-multicast-domain.rst index 29c857815fc0..f8283f72e225 100755 --- a/awscli/examples/ec2/disassociate-transit-gateway-multicast-domain.rst +++ b/awscli/examples/ec2/disassociate-transit-gateway-multicast-domain.rst @@ -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 --git a/awscli/examples/ec2/disassociate-transit-gateway-route-table.rst b/awscli/examples/ec2/disassociate-transit-gateway-route-table.rst index bcdda018412b..909ac0c70620 100755 --- a/awscli/examples/ec2/disassociate-transit-gateway-route-table.rst +++ b/awscli/examples/ec2/disassociate-transit-gateway-route-table.rst @@ -18,4 +18,4 @@ Output:: } } -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 --git a/awscli/examples/ec2/enable-transit-gateway-route-table-propagation.rst b/awscli/examples/ec2/enable-transit-gateway-route-table-propagation.rst index 0db10242d9f6..295c859627af 100644 --- a/awscli/examples/ec2/enable-transit-gateway-route-table-propagation.rst +++ b/awscli/examples/ec2/enable-transit-gateway-route-table-propagation.rst @@ -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 --git a/awscli/examples/ec2/get-transit-gateway-attachment-propagations.rst b/awscli/examples/ec2/get-transit-gateway-attachment-propagations.rst index 550b6565d5fe..8760d663464f 100755 --- a/awscli/examples/ec2/get-transit-gateway-attachment-propagations.rst +++ b/awscli/examples/ec2/get-transit-gateway-attachment-propagations.rst @@ -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 --git a/awscli/examples/ec2/get-transit-gateway-multicast-domain-associations.rst b/awscli/examples/ec2/get-transit-gateway-multicast-domain-associations.rst index ffe3e16054bb..08e3c8ab8def 100755 --- a/awscli/examples/ec2/get-transit-gateway-multicast-domain-associations.rst +++ b/awscli/examples/ec2/get-transit-gateway-multicast-domain-associations.rst @@ -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 --git a/awscli/examples/ec2/get-transit-gateway-route-table-associations.rst b/awscli/examples/ec2/get-transit-gateway-route-table-associations.rst index ec04604ea2c5..a9bf2d203f75 100644 --- a/awscli/examples/ec2/get-transit-gateway-route-table-associations.rst +++ b/awscli/examples/ec2/get-transit-gateway-route-table-associations.rst @@ -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 --git a/awscli/examples/ec2/get-transit-gateway-route-table-propagations.rst b/awscli/examples/ec2/get-transit-gateway-route-table-propagations.rst index e63fb72fc7c5..a86c59c5f42b 100755 --- a/awscli/examples/ec2/get-transit-gateway-route-table-propagations.rst +++ b/awscli/examples/ec2/get-transit-gateway-route-table-propagations.rst @@ -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 --git a/awscli/examples/ec2/modify-transit-gateway-vpc-attachment.rst b/awscli/examples/ec2/modify-transit-gateway-vpc-attachment.rst index 1a5f20a8018d..51013ed75a22 100644 --- a/awscli/examples/ec2/modify-transit-gateway-vpc-attachment.rst +++ b/awscli/examples/ec2/modify-transit-gateway-vpc-attachment.rst @@ -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 --git a/awscli/examples/ec2/register-transit-gateway-multicast-group-members.rst b/awscli/examples/ec2/register-transit-gateway-multicast-group-members.rst index 9bd9f10dfec8..46ddf85f5cf6 100755 --- a/awscli/examples/ec2/register-transit-gateway-multicast-group-members.rst +++ b/awscli/examples/ec2/register-transit-gateway-multicast-group-members.rst @@ -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 --git a/awscli/examples/ec2/register-transit-gateway-multicast-group-sources.rst b/awscli/examples/ec2/register-transit-gateway-multicast-group-sources.rst new file mode 100644 index 000000000000..c8b67bfe69ff --- /dev/null +++ b/awscli/examples/ec2/register-transit-gateway-multicast-group-sources.rst @@ -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 --git a/awscli/examples/ec2/reject-transit-gateway-vpc-attachments.rst b/awscli/examples/ec2/reject-transit-gateway-vpc-attachments.rst index d09774d0cc29..5df209f8278a 100755 --- a/awscli/examples/ec2/reject-transit-gateway-vpc-attachments.rst +++ b/awscli/examples/ec2/reject-transit-gateway-vpc-attachments.rst @@ -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 --git a/awscli/examples/ec2/replace-transit-gateway-route.rst b/awscli/examples/ec2/replace-transit-gateway-route.rst index 5576d7dcbba2..6a1a9783e133 100644 --- a/awscli/examples/ec2/replace-transit-gateway-route.rst +++ b/awscli/examples/ec2/replace-transit-gateway-route.rst @@ -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 --git a/awscli/examples/ec2/search-transit-gateway-multicast-groups.rst b/awscli/examples/ec2/search-transit-gateway-multicast-groups.rst index e7707fe704aa..0f801b40a60c 100755 --- a/awscli/examples/ec2/search-transit-gateway-multicast-groups.rst +++ b/awscli/examples/ec2/search-transit-gateway-multicast-groups.rst @@ -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 --git a/awscli/examples/ec2/search-transit-gateway-routes.rst b/awscli/examples/ec2/search-transit-gateway-routes.rst index 6a3921cd1dc0..e7716cdd8153 100644 --- a/awscli/examples/ec2/search-transit-gateway-routes.rst +++ b/awscli/examples/ec2/search-transit-gateway-routes.rst @@ -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 --git a/awscli/examples/iot/delete-domain-configuration.rst b/awscli/examples/iot/delete-domain-configuration.rst index dd7a2c69e499..5dc991c5c72d 100755 --- a/awscli/examples/iot/delete-domain-configuration.rst +++ b/awscli/examples/iot/delete-domain-configuration.rst @@ -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 --git a/awscli/examples/ram/accept-resource-share-invitation.rst b/awscli/examples/ram/accept-resource-share-invitation.rst index bc85aa255247..dd021d8c8deb 100644 --- a/awscli/examples/ram/accept-resource-share-invitation.rst +++ b/awscli/examples/ram/accept-resource-share-invitation.rst @@ -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 --git a/awscli/examples/ram/associate-resource-share-permission.rst b/awscli/examples/ram/associate-resource-share-permission.rst new file mode 100644 index 000000000000..f1b2c81d632d --- /dev/null +++ b/awscli/examples/ram/associate-resource-share-permission.rst @@ -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 --git a/awscli/examples/ram/associate-resource-share.rst b/awscli/examples/ram/associate-resource-share.rst index ecbf8d93e6b5..7b064a4a13f7 100644 --- a/awscli/examples/ram/associate-resource-share.rst +++ b/awscli/examples/ram/associate-resource-share.rst @@ -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 --git a/awscli/examples/ram/create-resource-share.rst b/awscli/examples/ram/create-resource-share.rst index 10a17ac36372..086cce5c9778 100644 --- a/awscli/examples/ram/create-resource-share.rst +++ b/awscli/examples/ram/create-resource-share.rst @@ -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 --git a/awscli/examples/ram/disassociate-resource-share-permission.rst b/awscli/examples/ram/disassociate-resource-share-permission.rst new file mode 100644 index 000000000000..7f8d1c189461 --- /dev/null +++ b/awscli/examples/ram/disassociate-resource-share-permission.rst @@ -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 --git a/awscli/examples/ram/disassociate-resource-share.rst b/awscli/examples/ram/disassociate-resource-share.rst index 2456e964c3e1..7cb095e8afb3 100644 --- a/awscli/examples/ram/disassociate-resource-share.rst +++ b/awscli/examples/ram/disassociate-resource-share.rst @@ -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 @@ 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", + "associatedEntity": "arn:aws:ec2:us-west-2:123456789012:subnet/subnet-0250c25a1fEXAMPLE", "associationType": "RESOURCE", "status": "DISASSOCIATING", "external": false diff --git a/awscli/examples/ram/enable-sharing-with-aws-organization.rst b/awscli/examples/ram/enable-sharing-with-aws-organization.rst index eba4f99ac560..211934cc05b1 100644 --- a/awscli/examples/ram/enable-sharing-with-aws-organization.rst +++ b/awscli/examples/ram/enable-sharing-with-aws-organization.rst @@ -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 @@ The following output indicates success. :: { "returnValue": true - } + } \ No newline at end of file diff --git a/awscli/examples/ram/get-permission.rst b/awscli/examples/ram/get-permission.rst new file mode 100644 index 000000000000..bb3f7407b1f8 --- /dev/null +++ b/awscli/examples/ram/get-permission.rst @@ -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 --git a/awscli/examples/ram/get-resource-policies.rst b/awscli/examples/ram/get-resource-policies.rst index db7f60ea7eae..e3eec289b2b8 100644 --- a/awscli/examples/ram/get-resource-policies.rst +++ b/awscli/examples/ram/get-resource-policies.rst @@ -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 --git a/awscli/examples/ram/get-resource-share-associations.rst b/awscli/examples/ram/get-resource-share-associations.rst index 4cf2dbffbf70..692ae44711c6 100644 --- a/awscli/examples/ram/get-resource-share-associations.rst +++ b/awscli/examples/ram/get-resource-share-associations.rst @@ -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 @@ 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", + "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 --git a/awscli/examples/ram/get-resource-share-invitations.rst b/awscli/examples/ram/get-resource-share-invitations.rst index 95dfe6fe605b..4f12b12e20d3 100644 --- a/awscli/examples/ram/get-resource-share-invitations.rst +++ b/awscli/examples/ram/get-resource-share-invitations.rst @@ -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 @@ 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": 1565312166.258, "status": "PENDING" } diff --git a/awscli/examples/ram/get-resource-shares.rst b/awscli/examples/ram/get-resource-shares.rst index 2aa053cb08ab..0f06487e2b7a 100644 --- a/awscli/examples/ram/get-resource-shares.rst +++ b/awscli/examples/ram/get-resource-shares.rst @@ -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 @@ Output:: } ] } + +**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 --git a/awscli/examples/ram/list-pending-invitation-resources.rst b/awscli/examples/ram/list-pending-invitation-resources.rst new file mode 100644 index 000000000000..50a4e1ba5fab --- /dev/null +++ b/awscli/examples/ram/list-pending-invitation-resources.rst @@ -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 --git a/awscli/examples/ram/list-permissions.rst b/awscli/examples/ram/list-permissions.rst new file mode 100644 index 000000000000..66a204f1c71d --- /dev/null +++ b/awscli/examples/ram/list-permissions.rst @@ -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 --git a/awscli/examples/ram/list-principals.rst b/awscli/examples/ram/list-principals.rst index de7ae2a5d865..6eaaaf8ca105 100644 --- a/awscli/examples/ram/list-principals.rst +++ b/awscli/examples/ram/list-principals.rst @@ -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 --git a/awscli/examples/ram/list-resource-share-permissions.rst b/awscli/examples/ram/list-resource-share-permissions.rst new file mode 100644 index 000000000000..db59b452dd9e --- /dev/null +++ b/awscli/examples/ram/list-resource-share-permissions.rst @@ -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 --git a/awscli/examples/ram/list-resource-types.rst b/awscli/examples/ram/list-resource-types.rst new file mode 100644 index 000000000000..053708ba713b --- /dev/null +++ b/awscli/examples/ram/list-resource-types.rst @@ -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 --git a/awscli/examples/ram/list-resources.rst b/awscli/examples/ram/list-resources.rst index 8985e21f5b9b..d1e3f1d55907 100644 --- a/awscli/examples/ram/list-resources.rst +++ b/awscli/examples/ram/list-resources.rst @@ -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 --git a/awscli/examples/ram/promote-resource-share-created-from-policy.rst b/awscli/examples/ram/promote-resource-share-created-from-policy.rst new file mode 100644 index 000000000000..453210704bdf --- /dev/null +++ b/awscli/examples/ram/promote-resource-share-created-from-policy.rst @@ -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 --git a/awscli/examples/ram/reject-resource-share-invitation.rst b/awscli/examples/ram/reject-resource-share-invitation.rst index bd0c08f7cdaa..43388a084141 100644 --- a/awscli/examples/ram/reject-resource-share-invitation.rst +++ b/awscli/examples/ram/reject-resource-share-invitation.rst @@ -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 --git a/awscli/examples/ram/tag-resource.rst b/awscli/examples/ram/tag-resource.rst index 34983f5a883d..52a66a0a8c66 100644 --- a/awscli/examples/ram/tag-resource.rst +++ b/awscli/examples/ram/tag-resource.rst @@ -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 --git a/awscli/examples/ram/untag-resource.rst b/awscli/examples/ram/untag-resource.rst index 0bf08a1b164b..ede7ed4d2eb2 100644 --- a/awscli/examples/ram/untag-resource.rst +++ b/awscli/examples/ram/untag-resource.rst @@ -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 --git a/awscli/examples/ram/update-resource-share.rst b/awscli/examples/ram/update-resource-share.rst index dd9300881928..36d6b4293277 100644 --- a/awscli/examples/ram/update-resource-share.rst +++ b/awscli/examples/ram/update-resource-share.rst @@ -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 --git a/awscli/examples/ssm/list-resource-data-sync.rst b/awscli/examples/ssm/list-resource-data-sync.rst index 2b871df68d75..98f2fada3446 100644 --- a/awscli/examples/ssm/list-resource-data-sync.rst +++ b/awscli/examples/ssm/list-resource-data-sync.rst @@ -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" + } + ] + } +