# CreateGroup Creates a group within the specified identity store. ## Request Syntax ``` { "Description": "string", "DisplayName": "string", "IdentityStoreId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Description](#API_CreateGroup_RequestSyntax) ** A string containing the description of the group. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r  　]+` Required: No ** [DisplayName](#API_CreateGroup_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r  ]+` Required: No ** [IdentityStoreId](#API_CreateGroup_RequestSyntax) ** The globally unique identifier for the identity store. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: `d-[0-9a-f]{10}$|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Response Syntax ``` { "GroupId": "string", "IdentityStoreId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [GroupId](#API_CreateGroup_ResponseSyntax) ** The identifier of the newly created group in the identity store. Type: String Length Constraints: Minimum length of 1. Maximum length of 47. Pattern: `([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}` ** [IdentityStoreId](#API_CreateGroup_ResponseSyntax) ** The globally unique identifier for the identity store. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: `d-[0-9a-f]{10}$|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. ** Reason ** Indicates the reason for an access denial when returned by KMS while accessing a Customer Managed KMS key. For non-KMS access-denied errors, this field is not included. ** RequestId ** The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails. HTTP Status Code: 400 ** ConflictException ** 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. ** Reason ** Indicates the reason for a conflict error when the service is unable to access a Customer Managed KMS key. For non-KMS permission errors, this field is not included. ** RequestId ** The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails. HTTP Status Code: 400 ** InternalServerException ** The request processing has failed because of an unknown error, exception or failure with an internal server. ** RequestId ** The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails. ** RetryAfterSeconds ** The number of seconds to wait before retrying the next request. HTTP Status Code: 500 ** ResourceNotFoundException ** Indicates that a requested resource is not found. ** Reason ** Indicates the reason for a resource not found error when the service is unable to access a Customer Managed KMS key. For non-KMS permission errors, this field is not included. ** RequestId ** The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails. ** ResourceId ** The identifier for a resource in the identity store that can be used as `UserId` or `GroupId`. The format for `ResourceId` is either `UUID` or `1234567890-UUID`, where `UUID` is a randomly generated value for each resource when it is created and `1234567890` represents the ` IdentityStoreId` string value. In the case that the identity store is migrated from a legacy SSO identity store, the `ResourceId` for that identity store will be in the format of `UUID`. Otherwise, it will be in the `1234567890-UUID` format. ** ResourceType ** An enum object indicating the type of resource in the identity store service. Valid values include USER, GROUP, and IDENTITY\$1STORE. HTTP Status Code: 400 ** ServiceQuotaExceededException ** The request would cause the number of users or groups in the identity store to exceed the maximum allowed. ** RequestId ** The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails. HTTP Status Code: 400 ** ThrottlingException ** Indicates that the principal has crossed the throttling limits of the API operations. ** Reason ** Indicates the reason for the throttling error when the service is unable to access a Customer Managed KMS key. For non-KMS permission errors, this field is not included. ** RequestId ** The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails. ** RetryAfterSeconds ** The number of seconds to wait before retrying the next request. HTTP Status Code: 400 ** ValidationException ** The request failed because it contains a syntax error. ** Reason ** Indicates the reason for the validation error when the service is unable to access a Customer Managed KMS key. For non-KMS permission errors, this field is not included. ** RequestId ** The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails. HTTP Status Code: 400 ## Examples ### Example This example creates a new group called Developers in the specified identity store. #### Sample Request ``` { "IdentityStoreId": "d-1234567890", "DisplayName": "Developers", "Description": "Group that contains all developers" } ``` #### Sample Response ``` { "GroupId": "1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p", "IdentityStoreId": "d-1234567890" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/identitystore-2020-06-15/CreateGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/identitystore-2020-06-15/CreateGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/identitystore-2020-06-15/CreateGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/identitystore-2020-06-15/CreateGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/identitystore-2020-06-15/CreateGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/identitystore-2020-06-15/CreateGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/identitystore-2020-06-15/CreateGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/identitystore-2020-06-15/CreateGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/identitystore-2020-06-15/CreateGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/identitystore-2020-06-15/CreateGroup)