UpdateGroupCommand

Suggest an Edit

For the specified group in the specified identity store, updates the group metadata and attributes.

Example Syntax

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

import { IdentitystoreClient, UpdateGroupCommand } from "@aws-sdk/client-identitystore"; // ES Modules import
// const { IdentitystoreClient, UpdateGroupCommand } = require("@aws-sdk/client-identitystore"); // CommonJS import
const client = new IdentitystoreClient(config);
const input = { // UpdateGroupRequest
  IdentityStoreId: "STRING_VALUE", // required
  GroupId: "STRING_VALUE", // required
  Operations: [ // AttributeOperations // required
    { // AttributeOperation
      AttributePath: "STRING_VALUE", // required
      AttributeValue: "DOCUMENT_VALUE",
    },
  ],
};
const command = new UpdateGroupCommand(input);
const response = await client.send(command);
// {};

UpdateGroupCommand Input

See UpdateGroupCommandInput for more details

Parameter
Type
Description
GroupId
Required
string | undefined

The identifier for a group in the identity store.

IdentityStoreId
Required
string | undefined

The globally unique identifier for the identity store.

Operations
Required
AttributeOperation[] | undefined

A list of AttributeOperation objects to apply to the requested group. These operations might add, replace, or remove an attribute.

UpdateGroupCommand Output

See UpdateGroupCommandOutput 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.

ServiceQuotaExceededException
client

The request would cause the number of users or groups in the identity store to exceed the maximum allowed.

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.