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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:username]

Instance Attribute Summary collapse

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) 


1474
1475
1476
1477
1478
1479
1480
1481
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 1474

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

#next_token ⇒ String

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

Returns:

  • (String) 


1474
1475
1476
1477
1478
1479
1480
1481
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 1474

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

#user_pool_id ⇒ String

The Id of the user pool that contains the user profile with the logged events.

Returns:

  • (String) 


1474
1475
1476
1477
1478
1479
1480
1481
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 1474

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

#username ⇒ String

The name 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) 


1474
1475
1476
1477
1478
1479
1480
1481
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 1474

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