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

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

Overview

Represents the request to list devices, as an administrator.

Constant Summary collapse

SENSITIVE =
[:username]

Instance Attribute Summary collapse

Instance Attribute Details

#limitInteger

The limit of the devices request.

Returns:

  • (Integer)


1171
1172
1173
1174
1175
1176
1177
1178
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1171

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

#pagination_tokenString

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)


1171
1172
1173
1174
1175
1176
1177
1178
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1171

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

#user_pool_idString

The user pool ID.

Returns:

  • (String)


1171
1172
1173
1174
1175
1176
1177
1178
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1171

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

#usernameString

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)


1171
1172
1173
1174
1175
1176
1177
1178
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1171

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