Skip to content

DescribeUserRequest

Source code in docs_src/capo_directory_service_data/types/describe_user_request.py 
16
17
18
19
20
21
22
23
24
25
26
class DescribeUserRequest(TypedDict, closed=True):
    directory_id: "capo_directory_service_data.types.directory_id.DirectoryId"
    """<p> The identifier (ID) of the directory that's associated with the user. </p>"""
    sam_account_name: "capo_directory_service_data.types.user_name.UserName"
    """<p> The name of the user. </p>"""
    other_attributes: NotRequired[
        "capo_directory_service_data.types.ldap_display_name_list.LdapDisplayNameList"
    ]
    """<p> One or more attribute names to be returned for the user. A key is an attribute name, and the value is a list of maps. 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>"""
    realm: NotRequired["capo_directory_service_data.types.realm.Realm"]
    """<p> The domain name that's associated with the user. </p> <note> <p> This parameter is optional, so you can return users outside your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD users are returned. </p> <p> This value is case insensitive. </p> </note>"""

directory_id instance-attribute 

directory_id: DirectoryId

The identifier (ID) of the directory that's associated with the user.

other_attributes instance-attribute 

other_attributes: NotRequired[LdapDisplayNameList]

One or more attribute names to be returned for the user. A key is an attribute name, and the value is a list of maps. 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 user.

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

This value is case insensitive.

sam_account_name instance-attribute 

sam_account_name: UserName

The name of the user.