Class: Aws::CognitoIdentityProvider::Types::ListDevicesRequest

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

Overview

Represents the request to list the devices.

See Also:

Constant Summary collapse

SENSITIVE = 
[:access_token]

Instance Attribute Summary collapse

Instance Attribute Details

#access_token ⇒ String

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for aws.cognito.signin.user.admin.

Returns:

  • (String) 


7469
7470
7471
7472
7473
7474
7475
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7469

class ListDevicesRequest < Struct.new(
  :access_token,
  :limit,
  :pagination_token)
  SENSITIVE = [:access_token]
  include Aws::Structure
end

#limit ⇒ Integer

The maximum number of devices that you want Amazon Cognito to return in the response.

Returns:

  • (Integer) 


7469
7470
7471
7472
7473
7474
7475
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7469

class ListDevicesRequest < Struct.new(
  :access_token,
  :limit,
  :pagination_token)
  SENSITIVE = [:access_token]
  include Aws::Structure
end

#pagination_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) 


7469
7470
7471
7472
7473
7474
7475
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7469

class ListDevicesRequest < Struct.new(
  :access_token,
  :limit,
  :pagination_token)
  SENSITIVE = [:access_token]
  include Aws::Structure
end