DeleteGroupMembershipCommand

Suggest an Edit

Delete a membership within a group given MembershipId.

Example Syntax

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

import { IdentitystoreClient, DeleteGroupMembershipCommand } from "@aws-sdk/client-identitystore"; // ES Modules import
// const { IdentitystoreClient, DeleteGroupMembershipCommand } = require("@aws-sdk/client-identitystore"); // CommonJS import
const client = new IdentitystoreClient(config);
const input = { // DeleteGroupMembershipRequest
  IdentityStoreId: "STRING_VALUE", // required
  MembershipId: "STRING_VALUE", // required
};
const command = new DeleteGroupMembershipCommand(input);
const response = await client.send(command);
// {};

DeleteGroupMembershipCommand Input

See DeleteGroupMembershipCommandInput for more details

Parameter
Type
Description
IdentityStoreId
Required
string | undefined

The globally unique identifier for the identity store.

MembershipId
Required
string | undefined

The identifier for a GroupMembership in an identity store.

DeleteGroupMembershipCommand Output

See DeleteGroupMembershipCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
ConflictException
client

This request cannot be completed for one of the following reasons:

  • Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.

  • The requested resource was being concurrently modified by another request.

ResourceNotFoundException
client

Indicates that a requested resource is not found.

ValidationException
client

The request failed because it contains a syntax error.

AccessDeniedException
client

You do not have sufficient access to perform this action.

InternalServerException
server

The request processing has failed because of an unknown error, exception or failure with an internal server.

ThrottlingException
client

Indicates that the principal has crossed the throttling limits of the API operations.

IdentitystoreServiceException
Base exception class for all service exceptions from Identitystore service.