WorkMail / Client / create_group

create_group#

WorkMail.Client.create_group(**kwargs)#

Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.

See also: AWS API Documentation

Request Syntax

response = client.create_group(
    OrganizationId='string',
    Name='string',
    HiddenFromGlobalAddressList=True|False
)
Parameters:

  • OrganizationId (string) –

    [REQUIRED]

    The organization under which the group is to be created.

  • Name (string) –

    [REQUIRED]

    The name of the group.

  • HiddenFromGlobalAddressList (boolean) – If this parameter is enabled, the group will be hidden from the address book.

Return type:

dict

Returns:

Response Syntax

{
    'GroupId': 'string'
}

Response Structure

  • (dict) –

    • GroupId (string) –

      The identifier of the group.

Exceptions