DeleteGroupMembershipCommand

Suggest an Edit

Removes a user from a group so that the user is no longer a member of the group.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { QuickSightClient, DeleteGroupMembershipCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
// const { QuickSightClient, DeleteGroupMembershipCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
const client = new QuickSightClient(config);
const input = { // DeleteGroupMembershipRequest
  MemberName: "STRING_VALUE", // required
  GroupName: "STRING_VALUE", // required
  AwsAccountId: "STRING_VALUE", // required
  Namespace: "STRING_VALUE", // required
};
const command = new DeleteGroupMembershipCommand(input);
const response = await client.send(command);
// { // DeleteGroupMembershipResponse
//   RequestId: "STRING_VALUE",
//   Status: Number("int"),
// };

DeleteGroupMembershipCommand Input

See DeleteGroupMembershipCommandInput for more details

Parameter
Type
Description
AwsAccountId
Required
string | undefined

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

GroupName
Required
string | undefined

The name of the group that you want to delete the user from.

MemberName
Required
string | undefined

The name of the user that you want to delete from the group membership.

Namespace
Required
string | undefined

The namespace of the group that you want to remove a user from.

DeleteGroupMembershipCommand Output

See DeleteGroupMembershipCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
RequestId
string | undefined

The Amazon Web Services request ID for this operation.

Status
number | undefined

The HTTP status of the request.

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.

InternalFailureException
server

An internal failure occurred.

InvalidParameterValueException
client

One or more parameters has a value that isn't valid.

PreconditionNotMetException
client

One or more preconditions aren't met.

ResourceNotFoundException
client

One or more resources can't be found.

ResourceUnavailableException
server

This resource is currently unavailable.

ThrottlingException
client

Access is throttled.

QuickSightServiceException
Base exception class for all service exceptions from QuickSight service.