WorkMail / Client / delete_group

delete_group#

WorkMail.Client.delete_group(**kwargs)#

Deletes a group from WorkMail.

See also: AWS API Documentation

Request Syntax

response = client.delete_group(
    OrganizationId='string',
    GroupId='string'
)
Parameters:
  • OrganizationId (string) –

    [REQUIRED]

    The organization that contains the group.

  • GroupId (string) –

    [REQUIRED]

    The identifier of the group to be deleted.

    The identifier can be the GroupId, or Groupname. The following identity formats are available:

    • Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

    • Group name: group

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • WorkMail.Client.exceptions.DirectoryServiceAuthenticationFailedException

  • WorkMail.Client.exceptions.DirectoryUnavailableException

  • WorkMail.Client.exceptions.EntityStateException

  • WorkMail.Client.exceptions.InvalidParameterException

  • WorkMail.Client.exceptions.OrganizationNotFoundException

  • WorkMail.Client.exceptions.OrganizationStateException

  • WorkMail.Client.exceptions.UnsupportedOperationException