DeleteUserPoolClientSecret

Deletes a specific client secret from a user pool app client. You cannot delete the last remaining secret for an app client.

Request Syntax


{
   "ClientId": "string",
   "ClientSecretId": "string",
   "UserPoolId": "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 ID of the app client from which you want to delete the secret.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w+]+

Required: Yes

The unique identifier of the client secret you want to delete.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes

The ID of the user pool that contains the app client.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 55.

Pattern: [\w-]+_[0-9a-zA-Z]+

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.

InternalServerException

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

HTTP Status Code: 500

InvalidParameterException

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

message: The message returned when the Amazon Cognito service throws an invalid parameter exception.
reasonCode: The reason code of the exception.

HTTP Status Code: 400

LimitExceededException

This exception is thrown when a user exceeds the limit for a requested AWS resource.

message: The message returned when Amazon Cognito throws a limit exceeded exception.

HTTP Status Code: 400

ResourceNotFoundException

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

message: The message returned when the Amazon Cognito service returns a resource not found exception.

HTTP Status Code: 400

TooManyRequestsException

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

message: The message returned when the Amazon Cognito service returns a too many requests exception.

HTTP Status Code: 400