Skip to content

PrincipalSearchResult

Source code in docs_src/capo_cloudwatchomni/types/principal_search_result.py
class PrincipalSearchResult(TypedDict, closed=True):
    principal_id: "capo_cloudwatchomni.types.principal_id.PrincipalId"
    """The unique ID of the principal."""
    principal_type: "capo_cloudwatchomni.types.principal_type.PrincipalType"
    """Whether the principal is a user or a group."""
    display_name: "str"
    """The display name of the principal."""
    user_name: NotRequired["str"]
    """The user name of the principal. Present for users only."""
    description: NotRequired["str"]
    """An optional description of the principal."""

description instance-attribute

description: NotRequired[str]

An optional description of the principal.

display_name instance-attribute

display_name: str

The display name of the principal.

principal_id instance-attribute

principal_id: PrincipalId

The unique ID of the principal.

principal_type instance-attribute

principal_type: PrincipalType

Whether the principal is a user or a group.

user_name instance-attribute

user_name: NotRequired[str]

The user name of the principal. Present for users only.