Skip to content

DescribeGroupResponse

Source code in docs_src/capo_workmail/types/describe_group_response.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class DescribeGroupResponse(TypedDict, closed=True):
    group_id: NotRequired["capo_workmail.types.work_mail_identifier.WorkMailIdentifier"]
    """<p>The identifier of the described group.</p>"""
    name: NotRequired["capo_workmail.types.group_name.GroupName"]
    """<p>The name of the described group.</p>"""
    email: NotRequired["capo_workmail.types.email_address.EmailAddress"]
    """<p>The email of the described group.</p>"""
    state: NotRequired["capo_workmail.types.entity_state.EntityState"]
    """<p>The state of the user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).</p>"""
    enabled_date: NotRequired["capo_workmail.types.timestamp.Timestamp"]
    """<p>The date and time when a user was registered to WorkMail, in UNIX epoch time format.</p>"""
    disabled_date: NotRequired["capo_workmail.types.timestamp.Timestamp"]
    """<p>The date and time when a user was deregistered from WorkMail, in UNIX epoch time format.</p>"""
    hidden_from_global_address_list: "capo_workmail.types.boolean.Boolean"
    """<p>If the value is set to <i>true</i>, the group is hidden from the address book.</p>"""

disabled_date instance-attribute 

disabled_date: NotRequired[Timestamp]

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

email instance-attribute 

email: NotRequired[EmailAddress]

The email of the described group.

enabled_date instance-attribute 

enabled_date: NotRequired[Timestamp]

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

group_id instance-attribute 

group_id: NotRequired[WorkMailIdentifier]

The identifier of the described group.

hidden_from_global_address_list instance-attribute 

hidden_from_global_address_list: Boolean

If the value is set to true, the group is hidden from the address book.

name instance-attribute 

name: NotRequired[GroupName]

The name of the described group.

state instance-attribute 

state: NotRequired[EntityState]

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