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.

Constant Summary collapse

SENSITIVE =
[:access_token]

Instance Attribute Summary collapse

Instance Attribute Details

#access_tokenString

A valid access token that Amazon Cognito issued to the user whose list of devices you want to view.

Returns:

  • (String)


5958
5959
5960
5961
5962
5963
5964
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5958

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

#limitInteger

The limit of the device request.

Returns:

  • (Integer)


5958
5959
5960
5961
5962
5963
5964
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5958

class ListDevicesRequest < Struct.new(
  :access_token,
  :limit,
  :pagination_token)
  SENSITIVE = [:access_token]
  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)


5958
5959
5960
5961
5962
5963
5964
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5958

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