CreateGroupCommand

Suggest an Edit

Creates a group within the specified identity store.

Example Syntax

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

import { IdentitystoreClient, CreateGroupCommand } from "@aws-sdk/client-identitystore"; // ES Modules import
// const { IdentitystoreClient, CreateGroupCommand } = require("@aws-sdk/client-identitystore"); // CommonJS import
const client = new IdentitystoreClient(config);
const input = { // CreateGroupRequest
  IdentityStoreId: "STRING_VALUE", // required
  DisplayName: "STRING_VALUE",
  Description: "STRING_VALUE",
};
const command = new CreateGroupCommand(input);
const response = await client.send(command);
// { // CreateGroupResponse
//   GroupId: "STRING_VALUE", // required
//   IdentityStoreId: "STRING_VALUE", // required
// };

CreateGroupCommand Input

See CreateGroupCommandInput for more details

Parameter
Type
Description
IdentityStoreId
Required
string | undefined

The globally unique identifier for the identity store.

Description
string | undefined

A string containing the description of the group.

DisplayName
string | undefined

A string containing the name of the group. This value is commonly displayed when the group is referenced. Administrator and AWSAdministrators are reserved names and can't be used for users or groups.

CreateGroupCommand Output

See CreateGroupCommandOutput for details

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

The identifier of the newly created group in the identity store.

IdentityStoreId
Required
string | undefined

The globally unique identifier for the identity store.

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.