Skip to content

UserPoolDescriptionType

Source code in docs_src/capo_cognito_identity_provider/types/user_pool_description_type.py
class UserPoolDescriptionType(TypedDict, closed=True):
    id: NotRequired[
        "capo_cognito_identity_provider.types.user_pool_id_type.UserPoolIdType"
    ]
    """<p>The user pool ID.</p>"""
    name: NotRequired[
        "capo_cognito_identity_provider.types.user_pool_name_type.UserPoolNameType"
    ]
    """<p>The user pool name.</p>"""
    lambda_config: NotRequired[
        "capo_cognito_identity_provider.types.lambda_config_type.LambdaConfigType"
    ]
    """<p>A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible stages of user pool operations. Triggers can modify the outcome of the operations that invoked them.</p>"""
    status: NotRequired["capo_cognito_identity_provider.types.status_type.StatusType"]
    """<p>The user pool status.</p>"""
    last_modified_date: NotRequired[
        "capo_cognito_identity_provider.types.date_type.DateType"
    ]
    """<p>The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>"""
    creation_date: NotRequired[
        "capo_cognito_identity_provider.types.date_type.DateType"
    ]
    """<p>The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>"""
    replica_regions: NotRequired[
        "capo_cognito_identity_provider.types.replica_regions_type.ReplicaRegionsType"
    ]
    """<p>A list of Amazon Web Services Regions where replicas of this user pool exist.</p>"""

creation_date instance-attribute

creation_date: NotRequired[DateType]

The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

id instance-attribute

id: NotRequired[UserPoolIdType]

The user pool ID.

lambda_config instance-attribute

lambda_config: NotRequired[LambdaConfigType]

A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible stages of user pool operations. Triggers can modify the outcome of the operations that invoked them.

last_modified_date instance-attribute

last_modified_date: NotRequired[DateType]

The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

name instance-attribute

name: NotRequired[UserPoolNameType]

The user pool name.

replica_regions instance-attribute

replica_regions: NotRequired[ReplicaRegionsType]

A list of Amazon Web Services Regions where replicas of this user pool exist.

status instance-attribute

status: NotRequired[StatusType]

The user pool status.