Class: Aws::CognitoIdentityProvider::Types::AdminListUserAuthEventsRequest

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::AdminListUserAuthEventsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:username]

Instance Attribute Summary

• #max_results ⇒ Integer

  The maximum number of authentication events to return.

• #next_token ⇒ String

  A pagination token.

• #user_pool_id ⇒ String

  The user pool ID.

• #username ⇒ String

  The username of the user that you want to query or modify.

Instance Attribute Details

#max_results ⇒ Integer

The maximum number of authentication events to return. Returns 60 events if you set ‘MaxResults` to 0, or if you don’t include a ‘MaxResults` parameter.

Returns:

• (Integer)

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

class AdminListUserAuthEventsRequest < Struct.new(
  :user_pool_id,
  :username,
  :max_results,
  :next_token)
  SENSITIVE = [:username]
  include Aws::Structure
end

#next_token ⇒ String

A pagination token.

Returns:

• (String)

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

class AdminListUserAuthEventsRequest < Struct.new(
  :user_pool_id,
  :username,
  :max_results,
  :next_token)
  SENSITIVE = [:username]
  include Aws::Structure
end

#user_pool_id ⇒ String

The user pool ID.

Returns:

• (String)

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

class AdminListUserAuthEventsRequest < Struct.new(
  :user_pool_id,
  :username,
  :max_results,
  :next_token)
  SENSITIVE = [:username]
  include Aws::Structure
end

#username ⇒ String

The username of the user that you want to query or modify. The value of this parameter is typically your user’s username, but it can be any of their alias attributes. If ‘username` isn’t an alias attribute in your user pool, this value must be the ‘sub` of a local user or the username of a user from a third-party IdP.

Returns:

• (String)

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

class AdminListUserAuthEventsRequest < Struct.new(
  :user_pool_id,
  :username,
  :max_results,
  :next_token)
  SENSITIVE = [:username]
  include Aws::Structure
end