IdentityStore / Client / create_group

create_group#

IdentityStore.Client.create_group(**kwargs)#

Creates a group within the specified identity store.

See also: AWS API Documentation

Request Syntax

response = client.create_group(
    IdentityStoreId='string',
    DisplayName='string',
    Description='string'
)
Parameters:

  • IdentityStoreId (string) –

    [REQUIRED]

    The globally unique identifier for the identity store.

  • DisplayName (string) – 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.

  • Description (string) – A string containing the description of the group.

Return type:

dict

Returns:

Response Syntax

{
    'GroupId': 'string',
    'IdentityStoreId': 'string'
}

Response Structure

  • (dict) –

    • GroupId (string) –

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

    • IdentityStoreId (string) –

      The globally unique identifier for the identity store.

Exceptions

  • IdentityStore.Client.exceptions.ResourceNotFoundException

  • IdentityStore.Client.exceptions.ThrottlingException

  • IdentityStore.Client.exceptions.AccessDeniedException

  • IdentityStore.Client.exceptions.ConflictException

  • IdentityStore.Client.exceptions.InternalServerException

  • IdentityStore.Client.exceptions.ValidationException

  • IdentityStore.Client.exceptions.ServiceQuotaExceededException