Skip to content

SearchPrincipalsInput

Source code in docs_src/capo_cloudwatchomni/types/search_principals_input.py
class SearchPrincipalsInput(TypedDict, closed=True):
    domain_id: "capo_cloudwatchomni.types.domain_id.DomainId"
    """The ID of the domain to search within."""
    search_query: "str"
    """A search term to match against user names, display names, and IDs. Pass * to list all principals. Maximum 128 characters."""
    max_results: NotRequired["int"]
    """The maximum number of results to return. Defaults to 10. Valid only when searchQuery is *; other searches reject this parameter and return at most 10 results."""
    next_token: NotRequired[
        "capo_cloudwatchomni.types.search_principals_next_token.SearchPrincipalsNextToken"
    ]
    """A token to retrieve the next page of results. Valid only when searchQuery is *; other searches do not paginate and reject this parameter. Tokens expire after 24 hours."""

domain_id instance-attribute

domain_id: DomainId

The ID of the domain to search within.

max_results instance-attribute

max_results: NotRequired[int]

The maximum number of results to return. Defaults to 10. Valid only when searchQuery is *; other searches reject this parameter and return at most 10 results.

next_token instance-attribute

next_token: NotRequired[SearchPrincipalsNextToken]

A token to retrieve the next page of results. Valid only when searchQuery is *; other searches do not paginate and reject this parameter. Tokens expire after 24 hours.

search_query instance-attribute

search_query: str

A search term to match against user names, display names, and IDs. Pass * to list all principals. Maximum 128 characters.