Class: Aws::CognitoIdentityProvider::Types::AuthEventType

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::AuthEventType

Includes:

Structure

Defined in:

lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

One authentication event that Amazon Cognito logged in a user pool with advanced security features active. Contains user and device metadata and a risk assessment from your user pool.

This data type is a request parameter of [AdminListUserAuthEvents].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminListUserAuthEvents.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #challenge_responses ⇒ Array<Types::ChallengeResponseType>

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

• #creation_date ⇒ Time

  The date and time when the item was created.

• #event_context_data ⇒ Types::EventContextDataType

  The user context data captured at the time of an event request.

• #event_feedback ⇒ Types::EventFeedbackType

  The [UpdateAuthEventFeedback] or [AdminUpdateAuthEventFeedback] feedback that you or your user provided in response to the event.

• #event_id ⇒ String

  The event ID.

• #event_response ⇒ String

  The event response.

• #event_risk ⇒ Types::EventRiskType

  The threat evaluation from your user pool about an event.

• #event_type ⇒ String

  The type of authentication event.

Instance Attribute Details

#challenge_responses ⇒ Array<Types::ChallengeResponseType>

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

Returns:

• (Array<Types::ChallengeResponseType>)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 2530

class AuthEventType < Struct.new(
  :event_id,
  :event_type,
  :creation_date,
  :event_response,
  :event_risk,
  :challenge_responses,
  :event_context_data,
  :event_feedback)
  SENSITIVE = []
  include Aws::Structure
end

#creation_date ⇒ Time

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:

• (Time)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 2530

class AuthEventType < Struct.new(
  :event_id,
  :event_type,
  :creation_date,
  :event_response,
  :event_risk,
  :challenge_responses,
  :event_context_data,
  :event_feedback)
  SENSITIVE = []
  include Aws::Structure
end

#event_context_data ⇒ Types::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.

Returns:

• (Types::EventContextDataType)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 2530

class AuthEventType < Struct.new(
  :event_id,
  :event_type,
  :creation_date,
  :event_response,
  :event_risk,
  :challenge_responses,
  :event_context_data,
  :event_feedback)
  SENSITIVE = []
  include Aws::Structure
end

#event_feedback ⇒ Types::EventFeedbackType

The [UpdateAuthEventFeedback] or

AdminUpdateAuthEventFeedback][2

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.

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateAuthEventFeedback.html [2]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateAuthEventFeedback.html

Returns:

• (Types::EventFeedbackType)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 2530

class AuthEventType < Struct.new(
  :event_id,
  :event_type,
  :creation_date,
  :event_response,
  :event_risk,
  :challenge_responses,
  :event_context_data,
  :event_feedback)
  SENSITIVE = []
  include Aws::Structure
end

#event_id ⇒ String

The event ID.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 2530

class AuthEventType < Struct.new(
  :event_id,
  :event_type,
  :creation_date,
  :event_response,
  :event_risk,
  :challenge_responses,
  :event_context_data,
  :event_feedback)
  SENSITIVE = []
  include Aws::Structure
end

#event_response ⇒ String

The event response.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 2530

class AuthEventType < Struct.new(
  :event_id,
  :event_type,
  :creation_date,
  :event_response,
  :event_risk,
  :challenge_responses,
  :event_context_data,
  :event_feedback)
  SENSITIVE = []
  include Aws::Structure
end

#event_risk ⇒ Types::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.

Returns:

• (Types::EventRiskType)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 2530

class AuthEventType < Struct.new(
  :event_id,
  :event_type,
  :creation_date,
  :event_response,
  :event_risk,
  :challenge_responses,
  :event_context_data,
  :event_feedback)
  SENSITIVE = []
  include Aws::Structure
end

#event_type ⇒ String

The type of authentication event.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 2530

class AuthEventType < Struct.new(
  :event_id,
  :event_type,
  :creation_date,
  :event_response,
  :event_risk,
  :challenge_responses,
  :event_context_data,
  :event_feedback)
  SENSITIVE = []
  include Aws::Structure
end