Skip to content

AuthEventType

Source code in docs_src/capo_cognito_identity_provider/types/auth_event_type.py
class AuthEventType(TypedDict, closed=True):
    event_id: NotRequired["capo_cognito_identity_provider.types.string_type.StringType"]
    """<p>The event ID.</p>"""
    event_type: NotRequired["capo_cognito_identity_provider.types.event_type.EventType"]
    """<p>The type of authentication event.</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>"""
    event_response: NotRequired[
        "capo_cognito_identity_provider.types.event_response_type.EventResponseType"
    ]
    """<p>The event response.</p>"""
    event_risk: NotRequired[
        "capo_cognito_identity_provider.types.event_risk_type.EventRiskType"
    ]
    """<p>The threat evaluation from your user pool about an event. Contains information about whether your user pool detected compromised credentials, whether the event triggered an automated response, and the level of risk.</p>"""
    challenge_responses: NotRequired[
        "capo_cognito_identity_provider.types.challenge_response_list_type.ChallengeResponseListType"
    ]
    """<p>A list of the challenges that the user was requested to answer, for example <code>Password</code>, and the result, for example <code>Success</code>.</p>"""
    event_context_data: NotRequired[
        "capo_cognito_identity_provider.types.event_context_data_type.EventContextDataType"
    ]
    """<p>The user context data captured at the time of an event request. This value provides additional information about the client from which event the request is received.</p>"""
    event_feedback: NotRequired[
        "capo_cognito_identity_provider.types.event_feedback_type.EventFeedbackType"
    ]
    """<p>The <code>UpdateAuthEventFeedback</code> or <code>AdminUpdateAuthEventFeedback</code> feedback that you or your user provided in response to the event. A value of <code>Valid</code> indicates that you disagreed with the level of risk that your user pool assigned, and evaluated a session to be valid, or likely safe. A value of <code>Invalid</code> indicates that you agreed with the user pool risk level and evaluated a session to be invalid, or likely malicious.</p>"""

challenge_responses instance-attribute

challenge_responses: NotRequired[ChallengeResponseListType]

A list of the challenges that the user was requested to answer, for example Password, and the result, for example Success.

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.

event_context_data instance-attribute

event_context_data: NotRequired[EventContextDataType]

The user context data captured at the time of an event request. This value provides additional information about the client from which event the request is received.

event_feedback instance-attribute

event_feedback: NotRequired[EventFeedbackType]

The UpdateAuthEventFeedback or AdminUpdateAuthEventFeedback feedback that you or your user provided in response to the event. A value of Valid indicates that you disagreed with the level of risk that your user pool assigned, and evaluated a session to be valid, or likely safe. A value of Invalid indicates that you agreed with the user pool risk level and evaluated a session to be invalid, or likely malicious.

event_id instance-attribute

event_id: NotRequired[StringType]

The event ID.

event_response instance-attribute

event_response: NotRequired[EventResponseType]

The event response.

event_risk instance-attribute

event_risk: NotRequired[EventRiskType]

The threat evaluation from your user pool about an event. Contains information about whether your user pool detected compromised credentials, whether the event triggered an automated response, and the level of risk.

event_type instance-attribute

event_type: NotRequired[EventType]

The type of authentication event.