Given tag IDs that you previously assigned to a user pool, removes them.
Request Syntax{
"ResourceArn": "string
",
"TagKeys": [ "string
" ]
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
Required: Yes
An array of tag keys that you want to remove from the user pool.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors.
This exception is thrown when Amazon Cognito encounters an internal error.
HTTP Status Code: 500
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
HTTP Status Code: 400
This exception is thrown when a user isn't authorized.
HTTP Status Code: 400
This exception is thrown when the Amazon Cognito service can't find the requested resource.
HTTP Status Code: 400
This exception is thrown when the user has made too many requests for a given operation.
HTTP Status Code: 400
The following example request removes the administrator
and tenant
tags from the requested user pool.
POST HTTP/1.1
Host: cognito-idp.us-west-2.amazonaws.com
X-Amz-Date: 20230613T200059Z
Accept-Encoding: gzip, deflate, br
X-Amz-Target: AWSCognitoIdentityProviderService.UntagResource
User-Agent: <UserAgentString>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature>
Content-Length: <PayloadSizeBytes>
{
"ResourceArn": "arn:aws:cognito-idp:us-west-2:123456789012:userpool/us-west-2_EXAMPLE",
"TagKeys": [
"administrator",
"tenant"
]
}
Sample Response
HTTP/1.1 200 OK
Date: Tue, 13 Jun 2023 20:00:59 GMT
Content-Type: application/x-amz-json-1.0
Content-Length: <PayloadSizeBytes>
x-amzn-requestid: a1b2c3d4-e5f6-a1b2-c3d4-EXAMPLE11111
Connection: keep-alive
{}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4