UntagResource

Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account.

Request Syntax


{
   "ResourceArn": "string",
   "TagKeys": [ "string" ]
}

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

The keys of the tags 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.

For information about the errors that are common to all actions, see Common Errors.

InternalErrorException

This exception is thrown when Amazon Cognito encounters an internal error.

HTTP Status Code: 500

InvalidParameterException

This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

HTTP Status Code: 400

NotAuthorizedException

This exception is thrown when a user isn't authorized.

HTTP Status Code: 400

ResourceNotFoundException

This exception is thrown when the Amazon Cognito service can't find the requested resource.

HTTP Status Code: 400

TooManyRequestsException

This exception is thrown when the user has made too many requests for a given operation.

HTTP Status Code: 400