You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Note:

When making an API call, you may pass AdminListUserAuthEventsRequest data as a hash:

{
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  max_results: 1,
  next_token: "PaginationKey",
}

Instance Attribute Summary collapse

Instance Attribute Details

#max_resultsInteger

The maximum number of authentication events to return.

Returns:

  • (Integer)


1230
1231
1232
1233
1234
1235
1236
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1230

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

#next_tokenString

A pagination token.

Returns:

  • (String)


1230
1231
1232
1233
1234
1235
1236
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1230

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

#user_pool_idString

The user pool ID.

Returns:

  • (String)


1230
1231
1232
1233
1234
1235
1236
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1230

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

#usernameString

The user pool username or an alias.

Returns:

  • (String)


1230
1231
1232
1233
1234
1235
1236
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1230

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