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.

    You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.

  • 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

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

Response Structure

  • (dict) –

    • IdentityStoreId (string) –

      The globally unique identifier for the identity store.

    • GroupId (string) –

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

    • GroupArn (string) –

      The Amazon Resource Name (ARN) of the newly created group in the identity store. For example, arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.

    • Revision (string) –

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

Exceptions