import { Command as $Command } from "@smithy/core/client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient"; import type { CreateGroupRequest, CreateGroupResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link CreateGroupCommand}. */ export interface CreateGroupCommandInput extends CreateGroupRequest { } /** * @public * * The output of {@link CreateGroupCommand}. */ export interface CreateGroupCommandOutput extends CreateGroupResponse, __MetadataBearer { } declare const CreateGroupCommand_base: { new (input: CreateGroupCommandInput): import("@smithy/core/client").CommandImpl; new (input: CreateGroupCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): { [x: string]: unknown; }; }; /** *

Creates a new group in the specified user pool. For more information about user pool * groups, 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 * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { CognitoIdentityProviderClient, CreateGroupCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import * // const { CognitoIdentityProviderClient, CreateGroupCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import * // import type { CognitoIdentityProviderClientConfig } from "@aws-sdk/client-cognito-identity-provider"; * const config = {}; // type is CognitoIdentityProviderClientConfig * const client = new CognitoIdentityProviderClient(config); * const input = { // CreateGroupRequest * GroupName: "STRING_VALUE", // required * UserPoolId: "STRING_VALUE", // required * Description: "STRING_VALUE", * RoleArn: "STRING_VALUE", * Precedence: Number("int"), * }; * const command = new CreateGroupCommand(input); * const response = await client.send(command); * // { // CreateGroupResponse * // Group: { // GroupType * // GroupName: "STRING_VALUE", * // UserPoolId: "STRING_VALUE", * // Description: "STRING_VALUE", * // RoleArn: "STRING_VALUE", * // Precedence: Number("int"), * // LastModifiedDate: new Date("TIMESTAMP"), * // CreationDate: new Date("TIMESTAMP"), * // }, * // }; * * ``` * * @param CreateGroupCommandInput - {@link CreateGroupCommandInput} * @returns {@link CreateGroupCommandOutput} * @see {@link CreateGroupCommandInput} for command's `input` shape. * @see {@link CreateGroupCommandOutput} for command's `response` shape. * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape. * * @throws {@link GroupExistsException} (client fault) *

This exception is thrown when Amazon Cognito encounters a group that already exists in the user * pool.

* * @throws {@link InternalErrorException} (server fault) *

This exception is thrown when Amazon Cognito encounters an internal error.

* * @throws {@link InvalidParameterException} (client fault) *

This exception is thrown when the Amazon Cognito service encounters an invalid * parameter.

* * @throws {@link LimitExceededException} (client fault) *

This exception is thrown when a user exceeds the limit for a requested Amazon Web Services * resource.

* * @throws {@link NotAuthorizedException} (client fault) *

This exception is thrown when a user isn't authorized.

* * @throws {@link OperationNotEnabledException} (client fault) *

This exception is thrown when an operation is not available in the current region or for the current user pool configuration. This can occur when attempting to perform operations that are not supported in secondary replica regions.

* * @throws {@link ResourceNotFoundException} (client fault) *

This exception is thrown when the Amazon Cognito service can't find the requested * resource.

* * @throws {@link TooManyRequestsException} (client fault) *

This exception is thrown when the user has made too many requests for a given * operation.

* * @throws {@link CognitoIdentityProviderServiceException} *

Base exception class for all service exceptions from CognitoIdentityProvider service.

* * * @public */ export declare class CreateGroupCommand extends CreateGroupCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: CreateGroupRequest; output: CreateGroupResponse; }; sdk: { input: CreateGroupCommandInput; output: CreateGroupCommandOutput; }; }; }