Class: Aws::CognitoIdentityProvider::Types::AdminListDevicesRequest

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 AdminListDevicesRequest data as a hash:

{
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  limit: 1,
  pagination_token: "SearchPaginationTokenType",
}

Represents the request to list devices, as an administrator.

Instance Attribute Summary collapse

Instance Attribute Details

#limitInteger

The limit of the devices request.

Returns:

  • (Integer)


1321
1322
1323
1324
1325
1326
1327
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1321

class AdminListDevicesRequest < Struct.new(
  :user_pool_id,
  :username,
  :limit,
  :pagination_token)
  include Aws::Structure
end

#pagination_tokenString

The pagination token.

Returns:

  • (String)


1321
1322
1323
1324
1325
1326
1327
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1321

class AdminListDevicesRequest < Struct.new(
  :user_pool_id,
  :username,
  :limit,
  :pagination_token)
  include Aws::Structure
end

#user_pool_idString

The user pool ID.

Returns:

  • (String)


1321
1322
1323
1324
1325
1326
1327
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1321

class AdminListDevicesRequest < Struct.new(
  :user_pool_id,
  :username,
  :limit,
  :pagination_token)
  include Aws::Structure
end

#usernameString

The user name.

Returns:

  • (String)


1321
1322
1323
1324
1325
1326
1327
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1321

class AdminListDevicesRequest < Struct.new(
  :user_pool_id,
  :username,
  :limit,
  :pagination_token)
  include Aws::Structure
end