describe_group

describe_group(**kwargs)

Returns the data available for the group.

See also: AWS API Documentation

Request Syntax

response = client.describe_group(
    OrganizationId='string',
    GroupId='string'
)

Parameters

• OrganizationId (string) --

  [REQUIRED]

  The identifier for the organization under which the group exists.

• GroupId (string) --

  [REQUIRED]

  The identifier for the group to be described.

Return type

dict

Returns

Response Syntax

{
    'GroupId': 'string',
    'Name': 'string',
    'Email': 'string',
    'State': 'ENABLED'|'DISABLED'|'DELETED',
    'EnabledDate': datetime(2015, 1, 1),
    'DisabledDate': datetime(2015, 1, 1)
}

Response Structure

• (dict) --

  • GroupId (string) --

    The identifier of the described group.

  • Name (string) --

    The name of the described group.

  • Email (string) --

    The email of the described group.

  • State (string) --

    The state of the user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).

  • EnabledDate (datetime) --

    The date and time when a user was registered to WorkMail, in UNIX epoch time format.

  • DisabledDate (datetime) --

    The date and time when a user was deregistered from WorkMail, in UNIX epoch time format.

Exceptions

• WorkMail.Client.exceptions.EntityNotFoundException
• WorkMail.Client.exceptions.InvalidParameterException
• WorkMail.Client.exceptions.OrganizationNotFoundException
• WorkMail.Client.exceptions.OrganizationStateException