Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class AuthEventType

    • Method Detail

      • eventId

        public final String eventId()

        The event ID.

        Returns:
        The event ID.

      • eventType

        public final EventType eventType()

        The type of authentication event.

        If the service returns an enum value that is not available in the current SDK version, eventType will return EventType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventTypeAsString().

        Returns:
        The type of authentication event.
        See Also:
        EventType

      • eventTypeAsString

        public final String eventTypeAsString()

        The type of authentication event.

        If the service returns an enum value that is not available in the current SDK version, eventType will return EventType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventTypeAsString().

        Returns:
        The type of authentication event.
        See Also:
        EventType

      • creationDate

        public final Instant creationDate()

        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.

        Returns:
        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.

      • eventRisk

        public final EventRiskType eventRisk()

        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.

        Returns:
        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.

      • hasChallengeResponses

        public final boolean hasChallengeResponses()
        For responses, this returns true if the service returned a value for the ChallengeResponses property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • challengeResponses

        public final List<ChallengeResponseType> challengeResponses()

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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasChallengeResponses() method.

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

      • eventContextData

        public final EventContextDataType eventContextData()

        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.

        Returns:
        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.

      • eventFeedback

        public final EventFeedbackType eventFeedback()

        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.

        Returns:
        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.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object

      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                              Class<T> clazz)