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

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)


1112
1113
1114
1115
1116
1117
1118
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1112

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

#pagination_tokenString

The pagination token.

Returns:

  • (String)


1112
1113
1114
1115
1116
1117
1118
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1112

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

#user_pool_idString

The user pool ID.

Returns:

  • (String)


1112
1113
1114
1115
1116
1117
1118
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1112

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

#usernameString

The user name.

Returns:

  • (String)


1112
1113
1114
1115
1116
1117
1118
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1112

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