Skip to content

SearchUsersRequest

Source code in docs_src/capo_directory_service_data/types/search_users_request.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class SearchUsersRequest(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>"""
    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 of 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>"""
    search_string: "capo_directory_service_data.types.search_string.SearchString"
    """<p> The attribute value that you want to search for. </p> <note> <p> Wildcard <code>(*)</code> searches aren't supported. 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> </note>"""
    search_attributes: (
        "capo_directory_service_data.types.ldap_display_name_list.LdapDisplayNameList"
    )
    """<p> One or more data attributes that are used to search for a user. 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>"""
    next_token: NotRequired["capo_directory_service_data.types.next_token.NextToken"]
    """<p> An encoded paging token for paginated calls that can be passed back to retrieve the next page. </p>"""
    max_results: NotRequired["capo_directory_service_data.types.max_results.MaxResults"]
    """<p> The maximum number of results to be returned per request. </p>"""

directory_id instance-attribute 

directory_id: DirectoryId

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

max_results instance-attribute 

max_results: NotRequired[MaxResults]

The maximum number of results to be returned per request.

next_token instance-attribute 

next_token: NotRequired[NextToken]

An encoded paging token for paginated calls that can be passed back to retrieve the next page.

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 of your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD users are returned.

This value is case insensitive.

search_attributes instance-attribute 

search_attributes: LdapDisplayNameList

One or more data attributes that are used to search for a user. For a list of supported attributes, see Directory Service Data Attributes.

search_string instance-attribute 

search_string: SearchString

The attribute value that you want to search for.

Wildcard (*) searches aren't supported. For a list of supported attributes, see Directory Service Data Attributes.