awscli 1.38.8__py3-none-any.whl → 1.38.9__py3-none-any.whl

awscli/__init__.py

@@ -18,7 +18,7 @@ A Universal Command Line Environment for Amazon Web Services.
 
 import os
 
-__version__ = '1.38.8'
+__version__ = '1.38.9'
 
 #
 # Get our data path to be added to botocore's search path

awscli/examples/codecommit/get-merge-commit.rst

@@ -1,11 +1,10 @@
 **To get detailed information about a merge commit**
 
-The following ``get-merge-commit`` example displays details about a merge commit for the source branch named ``bugfix-bug1234`` with a destination branch named ``main`` using the THREE_WAY_MERGE strategy in a repository named ``MyDemoRepo``. ::
+The following ``get-merge-commit`` example displays details about a merge commit for the source branch named ``bugfix-bug1234`` with a destination branch named ``main`` in a repository named ``MyDemoRepo``. ::
 
     aws codecommit get-merge-commit \
         --source-commit-specifier bugfix-bug1234 \
         --destination-commit-specifier main \
-        --merge-option THREE_WAY_MERGE \
         --repository-name MyDemoRepo
 
 Output::

awscli/examples/cognito-idp/get-identity-provider-by-identifier.rst

@@ -0,0 +1,35 @@
+**To get the configuration of an identity provider from the IdP identifier**
+
+The following ``get-identity-provider-by-identifier`` example returns the configuration of the identity provider with the identifier ``mysso``. ::
+
+    aws cognito-idp get-identity-provider-by-identifier \
+        --user-pool-id us-west-2_EXAMPLE \
+        --idp-identifier mysso
+
+Output::
+
+    {
+        "IdentityProvider": {
+            "UserPoolId": "us-west-2_EXAMPLE",
+            "ProviderName": "MYSAML",
+            "ProviderType": "SAML",
+            "ProviderDetails": {
+                "ActiveEncryptionCertificate": "[Certificate contents]",
+                "IDPSignout": "false",
+                "MetadataURL": "https://auth.example.com/saml/metadata/",
+                "SLORedirectBindingURI": "https://auth.example.com/saml/logout/",
+                "SSORedirectBindingURI": "https://auth.example.com/saml/assertion/"
+            },
+            "AttributeMapping": {
+                "email": "email"
+            },
+            "IdpIdentifiers": [
+                "mysso",
+                "mysamlsso"
+            ],
+            "LastModifiedDate": 1705616729.188,
+            "CreationDate": 1643734622.919
+        }
+    }
+
+For more information, see `Third-party IdP sign-in <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html>`__ in the *Amazon Cognito Developer Guide*.

awscli/examples/cognito-idp/get-log-delivery-configuration.rst

@@ -0,0 +1,32 @@
+**To display the log delivery configuration**
+
+The following ``get-log-delivery-configuration`` example displays the log export settings of the requested user pool. ::
+
+    aws cognito-idp get-log-delivery-configuration \
+        --user-pool-id us-west-2_EXAMPLE
+
+Output::
+
+    {
+        "LogDeliveryConfiguration": {
+            "UserPoolId": "us-west-2_EXAMPLE",
+            "LogConfigurations": [
+                {
+                    "LogLevel": "INFO",
+                    "EventSource": "userAuthEvents",
+                    "FirehoseConfiguration": {
+                        "StreamArn": "arn:aws:firehose:us-west-2:123456789012:deliverystream/my-test-deliverystream"
+                    }
+                },
+                {
+                    "LogLevel": "ERROR",
+                    "EventSource": "userNotification",
+                    "CloudWatchLogsConfiguration": {
+                        "LogGroupArn": "arn:aws:logs:us-west-2:123456789012:log-group:my-message-delivery-logs"
+                    }
+                }
+            ]
+        }
+    }
+
+For more information, see `Exporting user pool logs <https://docs.aws.amazon.com/cognito/latest/developerguide/exporting-quotas-and-usage.html>`__ in the *Amazon Cognito Developer Guide*.

awscli/examples/cognito-idp/get-signing-certificate.rst

@@ -1,13 +1,14 @@
-**To get a signing certificate**
-
-This example gets a signing certificate for a user pool.
-
-Command::
-
-  aws cognito-idp get-signing-certificate --user-pool-id us-west-2_aaaaaaaaa 
-
-Output::
-
-  {
-    "Certificate": "CERTIFICATE_DATA"
-  }
+**To display the SAML signing certificate**
+
+The following ``get-signing-certificate`` example displays the SAML 2.0 signing certificate for the request user pool. ::
+
+    aws cognito-idp get-signing-certificate \
+        --user-pool-id us-west-2_EXAMPLE
+
+Output::
+
+    {
+        "Certificate": "[Certificate content]"
+    }
+
+For more information, see `SAML signing and encryption <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-SAML-signing-encryption.html>`__ in the *Amazon Cognito Developer Guide*.

awscli/examples/cognito-idp/get-ui-customization.rst

@@ -1,19 +1,22 @@
-**To get UI customization information**
-
-This example gets UI customization information for a user pool.
-
-Command::
-
-  aws cognito-idp get-ui-customization --user-pool-id us-west-2_aaaaaaaaa 
-
-Output::
-
-  {
-    "UICustomization": {
-        "UserPoolId": "us-west-2_aaaaaaaaa",
-        "ClientId": "ALL",
-        "ImageUrl": "https://aaaaaaaaaaaaa.cloudfront.net/us-west-2_aaaaaaaaa/ALL/20190128231240/assets/images/image.jpg",
-        "CSS": ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 10px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 300;\n}\n.textDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.idpDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.legalText-customizable {\n\tcolor: #747474;\n\tfont-size: 11px;\n}\n.submitButton-customizable {\n\tfont-size: 14px;\n\tfont-weight: bold;\n\tmargin: 20px 0px 10px 0px;\n\theight: 40px;\n\twidth: 100%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\n}\n.submitButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #286090;\n}\n.errorMessage-customizable {\n\tpadding: 5px;\n\tfont-size: 14px;\n\twidth: 100%;\n\tbackground: #F5F5F5;\n\tborder: 2px solid #D64958;\n\tcolor: #D64958;\n}\n.inputField-customizable {\n\twidth: 100%;\n\theight: 34px;\n\tcolor: #555;\n\tbackground-color: #fff;\n\tborder: 1px solid #ccc;\n}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\n\twidth: 100%;\n\ttext-align: center;\n\tmargin-bottom: 15px;\n\tcolor: #fff;\n\tbackground-color: #5bc0de;\n\tborder-color: #46b8da;\n}\n.idpButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #31b0d5;\n}\n.socialButton-customizable {\n\theight: 40px;\n\ttext-align: left;\n\twidth: 100%;\n\tmargin-bottom: 15px;\n}\n.redirect-customizable {\n\ttext-align: center;\n}\n.passwordCheck-notValid-customizable {\n\tcolor: #DF3312;\n}\n.passwordCheck-valid-customizable {\n\tcolor: #19BF00;\n}\n.background-customizable {\n\tbackground-color: #faf;\n}\n",
-        "CSSVersion": "20190128231240"
-    }
-  }
+**To display the classic hosted UI customization settings for an app client**
+
+The following ``get-ui-customization`` example displays the classic hosted UI customization settings for an app client that doesn't inherit settings from the user pool. ::
+
+    aws cognito-idp get-ui-customization \
+        --user-pool-id us-west-2_EXAMPLE \
+        --client-id 1example23456789
+
+
+Output::
+
+    {
+        "UICustomization": {
+            "UserPoolId": "us-west-2_EXAMPLE",
+            "ClientId": "1example23456789",
+            "ImageUrl": "https://example.cloudfront.net/us-west-2_EXAMPLE/1example23456789/20250115191928/assets/images/image.jpg",
+            "CSS": "\n.logo-customizable {\n  max-width: 80%;\n  max-height: 30%;\n}\n\n.banner-customizable {\n  padding: 25px 0px 25px 0px;\n  background-color: lightgray;\n}\n\n.label-customizable {\n  font-weight: 400;\n}\n\n.textDescription-customizable {\n  padding-top: 100px;\n  padding-bottom: 10px;\n  display: block;\n  font-size: 12px;\n}\n\n.idpDescription-customizable {\n  padding-top: 10px;\n  padding-bottom: 10px;\n  display: block;\n  font-size: 16px;\n}\n\n.legalText-customizable {\n  color: #747474;\n  font-size: 11px;\n}\n\n.submitButton-customizable {\n  font-size: 14px;\n  font-weight: bold;\n  margin: 20px 0px 10px 0px;\n  height: 50px;\n  width: 100%;\n  color: #fff;\n  background-color: #337ab7;\n}\n\n.submitButton-customizable:hover {\n  color: #fff;\n  background-color: #286090;\n}\n\n.errorMessage-customizable {\n  padding: 5px;\n  font-size: 12px;\n  width: 100%;\n  background: #F5F5F5;\n  border: 2px solid #D64958;\n  color: #D64958;\n}\n\n.inputField-customizable {\n  width: 100%;\n  height: 34px;\n  color: #555;\n  background-color: #fff;\n  border: 1px solid #ccc;\n}\n\n.inputField-customizable:focus {\n  border-color: #66afe9;\n  outline: 0;\n}\n\n.idpButton-customizable {\n  height: 40px;\n  width: 100%;\n  width: 100%;\n  text-align: center;\n  margin-bottom: 15px;\n  color: #fff;\n  background-color: #5bc0de;\n  border-color: #46b8da;\n}\n\n.idpButton-customizable:hover {\n  color: #fff;\n  background-color: #31b0d5;\n}\n\n.socialButton-customizable {\n  border-radius: 2px;\n  height: 60px;\n  margin-bottom: 15px;\n  padding: 1px;\n  text-align: left;\n  width: 100%;\n}\n\n.redirect-customizable {\n  text-align: center;\n}\n\n.passwordCheck-notValid-customizable {\n  color: #DF3312;\n}\n\n.passwordCheck-valid-customizable {\n  color: #19BF00;\n}\n\n.background-customizable {\n  background-color: #fff;\n}\n",
+            "CSSVersion": "20250115191928"
+        }
+    }
+
+For more information, see `Hosted UI (classic) branding <https://docs.aws.amazon.com/cognito/latest/developerguide/hosted-ui-classic-branding.html>`__ in the *Amazon Cognito Developer Guide*.

awscli/examples/cognito-idp/get-user-attribute-verification-code.rst

@@ -0,0 +1,19 @@
+**To send an attribute verification code to the current user**
+
+The following ``get-user-attribute-verification-code`` example sends an attribute verification code to the currently signed-in user's email address. ::
+
+    aws cognito-idp get-user-attribute-verification-code \
+        --access-token eyJra456defEXAMPLE \
+        --attribute-name email
+
+Output::
+
+    {
+        "CodeDeliveryDetails": {
+            "Destination": "a***@e***",
+            "DeliveryMedium": "EMAIL",
+            "AttributeName": "email"
+        }
+    }
+
+For more information, see `Signing up and confirming user accounts <https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html>`__ in the *Amazon Cognito Developer Guide*.

awscli/examples/cognito-idp/get-user-auth-factors.rst

@@ -0,0 +1,20 @@
+**To list the authentication factors available to the current user**
+
+The following ``get-user-auth-factors`` example lists the available authentication factors for the currently signed-in user. ::
+
+    aws cognito-idp get-user-auth-factors \
+        --access-token eyJra456defEXAMPLE
+
+Output::
+
+    {
+        "Username": "testuser",
+        "ConfiguredUserAuthFactors": [
+            "PASSWORD",
+            "EMAIL_OTP",
+            "SMS_OTP",
+            "WEB_AUTHN"
+        ]
+    }
+
+For more information, see `Authentication <https://docs.aws.amazon.com/cognito/latest/developerguide/authentication.html>`__ in the *Amazon Cognito Developer Guide*.

awscli/examples/cognito-idp/get-user-pool-mfa-config.rst

@@ -0,0 +1,33 @@
+**To display the multi-factor authentication and WebAuthn settings of a user pool**
+
+The following ``get-user-pool-mfa-config`` example displays the MFA and WebAuthn configuration of the requested user pool. ::
+
+    aws cognito-idp get-user-pool-mfa-config \
+        --user-pool-id us-west-2_EXAMPLE
+
+Output::
+
+    {
+        "SmsMfaConfiguration": {
+            "SmsAuthenticationMessage": "Your OTP for MFA or sign-in: use {####}.",
+            "SmsConfiguration": {
+                "SnsCallerArn": "arn:aws:iam::123456789012:role/service-role/my-SMS-Role",
+                "ExternalId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
+                "SnsRegion": "us-west-2"
+            }
+        },
+        "SoftwareTokenMfaConfiguration": {
+            "Enabled": true
+        },
+        "EmailMfaConfiguration": {
+            "Message": "Your OTP for MFA or sign-in: use {####}",
+            "Subject": "OTP test"
+        },
+        "MfaConfiguration": "OPTIONAL",
+        "WebAuthnConfiguration": {
+            "RelyingPartyId": "auth.example.com",
+            "UserVerification": "preferred"
+        }
+    }
+
+For more information, see `Adding MFA <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html>`__ in the *Amazon Cognito Developer Guide*.

awscli/examples/cognito-idp/get-user.rst

@@ -0,0 +1,56 @@
+**To get the details of the current user**
+
+The following ``get-user`` example displays the profile of the currently signed-in user. ::
+
+    aws cognito-idp get-user \
+        --access-token eyJra456defEXAMPLE
+
+Output::
+
+    {
+        "Username": "johndoe",
+        "UserAttributes": [
+            {
+                "Name": "sub",
+                "Value": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
+            },
+            {
+                "Name": "identities",
+                "Value": "[{\"userId\":\"a1b2c3d4-5678-90ab-cdef-EXAMPLE22222\",\"providerName\":\"SignInWithApple\",\"providerType\":\"SignInWithApple\",\"issuer\":null,\"primary\":false,\"dateCreated\":1701125599632}]"
+            },
+            {
+                "Name": "email_verified",
+                "Value": "true"
+            },
+            {
+                "Name": "custom:state",
+                "Value": "Maine"
+            },
+            {
+                "Name": "name",
+                "Value": "John Doe"
+            },
+            {
+                "Name": "phone_number_verified",
+                "Value": "true"
+            },
+            {
+                "Name": "phone_number",
+                "Value": "+12065551212"
+            },
+            {
+                "Name": "preferred_username",
+                "Value": "jamesdoe"
+            },
+            {
+                "Name": "locale",
+                "Value": "EMEA"
+            },
+            {
+                "Name": "email",
+                "Value": "jamesdoe@example.com"
+            }
+        ]
+    }
+
+For more information, see `Managing users <https://docs.aws.amazon.com/cognito/latest/developerguide/managing-users.html>`__ in the *Amazon Cognito Developer Guide*.

awscli/examples/cognito-idp/global-sign-out.rst

@@ -0,0 +1,10 @@
+**To sign out the current user**
+
+The following ``global-sign-out`` example signs out the current user. ::
+
+    aws cognito-idp global-sign-out \
+        --access-token eyJra456defEXAMPLE
+
+This command produces no output.
+
+For more information, see `Managing users <https://docs.aws.amazon.com/cognito/latest/developerguide/managing-users.html>`__ in the *Amazon Cognito Developer Guide*.

awscli/examples/cognito-idp/initiate-auth.rst

@@ -0,0 +1,27 @@
+**To sign in a user**
+
+The following ``initiate-auth`` example signs in a user with the basic username-password flow and no additional challenges. ::
+
+    aws cognito-idp initiate-auth \
+        --auth-flow USER_PASSWORD_AUTH \
+        --client-id 1example23456789 \
+        --analytics-metadata AnalyticsEndpointId=d70b2ba36a8c4dc5a04a0451aEXAMPLE \
+        --auth-parameters USERNAME=testuser,PASSWORD=[Password] --user-context-data EncodedData=mycontextdata --client-metadata MyTestKey=MyTestValue
+
+Output::
+
+    {
+        "AuthenticationResult": {
+            "AccessToken": "eyJra456defEXAMPLE",
+            "ExpiresIn": 3600,
+            "TokenType": "Bearer",
+            "RefreshToken": "eyJra123abcEXAMPLE",
+            "IdToken": "eyJra789ghiEXAMPLE",
+            "NewDeviceMetadata": {
+                "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
+                "DeviceGroupKey": "-v7w9UcY6"
+            }
+        }
+    }
+
+For more information, see `Authentication <https://docs.aws.amazon.com/cognito/latest/developerguide/authentication.html>`__ in the *Amazon Cognito Developer Guide*.

awscli/examples/cognito-idp/list-devices.rst

@@ -1,18 +1,15 @@
-**To list devices for a user**
+**To list a user's devices**
 
-The following ``list-devices`` example lists devices for the currently sign-in user. ::
+The following ``list-devices`` example lists the devices that the current user has registered. ::
 
-    aws cognito-idp admin-list-devices \
-        --user-pool-id us-west-2_EXAMPLE \
-        --access-token eyJra456defEXAMPLE \
-        --limit 1
+    aws cognito-idp list-devices \
+        --access-token eyJra456defEXAMPLE
 
 Output::
 
     {
         "Devices": [
             {
-                "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
                 "DeviceAttributes": [
                     {
                         "Name": "device_status",
@@ -20,34 +17,35 @@ Output::
                     },
                     {
                         "Name": "device_name",
-                        "Value": "MyDevice"
-                    },
-                    {
-                        "Name": "dev:device_arn",
-                        "Value": "arn:aws:cognito-idp:us-west-2:123456789012:owner/diego.us-west-2_EXAMPLE/device/us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
-                    },
-                    {
-                        "Name": "dev:device_owner",
-                        "Value": "diego.us-west-2_EXAMPLE"
+                        "Value": "Dart-device"
                     },
                     {
                         "Name": "last_ip_used",
                         "Value": "192.0.2.1"
-                    },
+                    }
+                ],
+                "DeviceCreateDate": 1715100742.022,
+                "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
+                "DeviceLastAuthenticatedDate": 1715100742.0,
+                "DeviceLastModifiedDate": 1723233651.167
+            },
+            {
+                "DeviceAttributes": [
                     {
-                        "Name": "dev:device_remembered_status",
-                        "Value": "remembered"
+                        "Name": "device_status",
+                        "Value": "valid"
                     },
                     {
-                        "Name": "dev:device_sdk",
-                        "Value": "aws-sdk"
+                        "Name": "last_ip_used",
+                        "Value": "192.0.2.2"
                     }
                 ],
-                "DeviceCreateDate": 1715100742.022,
-                "DeviceLastModifiedDate": 1723233651.167,
-                "DeviceLastAuthenticatedDate": 1715100742.0
+                "DeviceCreateDate": 1726856147.993,
+                "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
+                "DeviceLastAuthenticatedDate": 1726856147.0,
+                "DeviceLastModifiedDate": 1726856147.993
             }
         ]
     }
 
-For more information, see `Working with user devices in your user pool <https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html>`__ in the *Amazon Cognito Developer Guide*.
+For more information, see `Working with devices <https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html>`__ in the *Amazon Cognito Developer Guide*.

awscli/examples/cognito-idp/list-groups.rst

@@ -0,0 +1,32 @@
+**To list the groups in a user pool**
+
+The following ``list-groups`` example lists the first two groups in the requested user pool. ::
+
+    aws cognito-idp list-groups \
+        --user-pool-id us-west-2_EXAMPLE \
+        --max-items 2
+
+Output::
+
+    {
+        "Groups": [
+            {
+                "CreationDate": 1681760899.633,
+                "Description": "My test group",
+                "GroupName": "testgroup",
+                "LastModifiedDate": 1681760899.633,
+                "Precedence": 1,
+                "UserPoolId": "us-west-2_EXAMPLE"
+            },
+            {
+                "CreationDate": 1642632749.051,
+                "Description": "Autogenerated group for users who sign in using Facebook",
+                "GroupName": "us-west-2_EXAMPLE_Facebook",
+                "LastModifiedDate": 1642632749.051,
+                "UserPoolId": "us-west-2_EXAMPLE"
+            }
+        ],
+        "NextToken": "[Pagination token]"
+    }
+
+For more information, see `Adding groups to a user pool <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-user-groups.html>`__ in the *Amazon Cognito Developer Guide*.

awscli/examples/cognito-idp/list-identity-providers.rst

@@ -0,0 +1,29 @@
+**To list identity providers**
+
+The following ``list-identity-providers`` example lists the first two identity providers in the requested user pool. ::
+
+    aws cognito-idp list-identity-providers \
+        --user-pool-id us-west-2_EXAMPLE \
+        --max-items 2
+
+Output::
+
+    {
+        "Providers": [
+            {
+                "CreationDate": 1619477386.504,
+                "LastModifiedDate": 1703798328.142,
+                "ProviderName": "Azure",
+                "ProviderType": "SAML"
+            },
+            {
+                "CreationDate": 1642698776.175,
+                "LastModifiedDate": 1642699086.453,
+                "ProviderName": "LoginWithAmazon",
+                "ProviderType": "LoginWithAmazon"
+            }
+        ],
+        "NextToken": "[Pagination token]"
+    }
+
+For more information, see `Third-party IdP sign-in <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html>`__ in the *Amazon Cognito Developer Guide*.

awscli/examples/cognito-idp/list-resource-servers.rst

@@ -0,0 +1,43 @@
+**To list resource servers**
+
+The following ``list-resource-servers`` example lists the first two resource servers in the requested user pool. ::
+
+    aws cognito-idp list-resource-servers \
+        --user-pool-id us-west-2_EXAMPLE \
+        --max-results 2
+
+Output::
+
+    {
+        "ResourceServers": [
+            {
+                "Identifier": "myapi.example.com",
+                "Name": "Example API with custom access control scopes",
+                "Scopes": [
+                    {
+                        "ScopeDescription": "International customers",
+                        "ScopeName": "international.read"
+                    },
+                    {
+                        "ScopeDescription": "Domestic customers",
+                        "ScopeName": "domestic.read"
+                    }
+                ],
+                "UserPoolId": "us-west-2_EXAMPLE"
+            },
+            {
+                "Identifier": "myapi2.example.com",
+                "Name": "Another example API for access control",
+                "Scopes": [
+                    {
+                        "ScopeDescription": "B2B customers",
+                        "ScopeName": "b2b.read"
+                    }
+                ],
+                "UserPoolId": "us-west-2_EXAMPLE"
+            }
+        ],
+        "NextToken": "[Pagination token]"
+    }
+
+For more information, see `Access control with resource servers <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-define-resource-servers.html>`__ in the *Amazon Cognito Developer Guide*.

awscli/examples/cognito-idp/list-tags-for-resource.rst

@@ -0,0 +1,17 @@
+**To list user pool tags**
+
+The following ``list-tags-for-resource`` example lists the tags assigned to the user pool with the requested ARN. ::
+
+    aws cognito-idp list-tags-for-resource \
+        --resource-arn arn:aws:cognito-idp:us-west-2:123456789012:userpool/us-west-2_EXAMPLE
+
+Output::
+
+    {
+        "Tags": {
+            "administrator": "Jie",
+            "tenant": "ExampleCorp"
+        }
+    }
+
+For more information, see `Tagging Amazon Cognito resources <https://docs.aws.amazon.com/cognito/latest/developerguide/tagging.html>`__ in the *Amazon Cognito Developer Guide*.