- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
AdminRemoveUserFromGroupCommand
Given a username and a group name. removes them from the group. User pool groups are identifiers that you can reference from the contents of ID and access tokens, and set preferred IAM roles for identity-pool authentication. For more information, see Adding groups to a user pool .
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { CognitoIdentityProviderClient, AdminRemoveUserFromGroupCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
// const { CognitoIdentityProviderClient, AdminRemoveUserFromGroupCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
const client = new CognitoIdentityProviderClient(config);
const input = { // AdminRemoveUserFromGroupRequest
UserPoolId: "STRING_VALUE", // required
Username: "STRING_VALUE", // required
GroupName: "STRING_VALUE", // required
};
const command = new AdminRemoveUserFromGroupCommand(input);
const response = await client.send(command);
// {};
AdminRemoveUserFromGroupCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
GroupName Required | string | undefined | The name of the group that you want to remove the user from, for example |
UserPoolId Required | string | undefined | The ID of the user pool that contains the group and the user that you want to remove. |
Username Required | string | undefined | The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If |
AdminRemoveUserFromGroupCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
InternalErrorException | server | This exception is thrown when Amazon Cognito encounters an internal error. |
InvalidParameterException | client | This exception is thrown when the Amazon Cognito service encounters an invalid parameter. |
NotAuthorizedException | client | This exception is thrown when a user isn't authorized. |
ResourceNotFoundException | client | This exception is thrown when the Amazon Cognito service can't find the requested resource. |
TooManyRequestsException | client | This exception is thrown when the user has made too many requests for a given operation. |
UserNotFoundException | client | This exception is thrown when a user isn't found. |
CognitoIdentityProviderServiceException | Base exception class for all service exceptions from CognitoIdentityProvider service. |