Skip to content

DescribeGroupRequest

Source code in docs_src/capo_directory_service_data/types/describe_group_request.py 
16
17
18
19
20
21
22
23
24
25
26
class DescribeGroupRequest(TypedDict, closed=True):
    directory_id: "capo_directory_service_data.types.directory_id.DirectoryId"
    """<p>The Identifier (ID) of the directory associated with the group.</p>"""
    realm: NotRequired["capo_directory_service_data.types.realm.Realm"]
    """<p> The domain name that's associated with the group. </p> <note> <p> This parameter is optional, so you can return groups outside of your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD groups are returned. </p> <p> This value is case insensitive. </p> </note>"""
    sam_account_name: "capo_directory_service_data.types.group_name.GroupName"
    """<p> The name of the group. </p>"""
    other_attributes: NotRequired[
        "capo_directory_service_data.types.ldap_display_name_list.LdapDisplayNameList"
    ]
    """<p> One or more attributes to be returned for the group. For a list of supported attributes, see <a href="https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ad_data_attributes.html">Directory Service Data Attributes</a>. </p>"""

directory_id instance-attribute 

directory_id: DirectoryId

The Identifier (ID) of the directory associated with the group.

other_attributes instance-attribute 

other_attributes: NotRequired[LdapDisplayNameList]

One or more attributes to be returned for the group. For a list of supported attributes, see Directory Service Data Attributes.

realm instance-attribute 

realm: NotRequired[Realm]

The domain name that's associated with the group.

This parameter is optional, so you can return groups outside of your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD groups are returned.

This value is case insensitive.

sam_account_name instance-attribute 

sam_account_name: GroupName

The name of the group.