Class: Aws::CognitoSync::Types::ListRecordsRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cognitosync/types.rb

Overview

A request for a list of records.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dataset_name ⇒ String

A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).

Returns:

  • (String) 

766
767
768
769
770
771
772
773
774
775
776
 
# File 'lib/aws-sdk-cognitosync/types.rb', line 766

class ListRecordsRequest < Struct.new(
  :identity_pool_id,
  :identity_id,
  :dataset_name,
  :last_sync_count,
  :next_token,
  :max_results,
  :sync_session_token)
  SENSITIVE = []
  include Aws::Structure
end

#identity_id ⇒ String

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

Returns:

  • (String) 

766
767
768
769
770
771
772
773
774
775
776
 
# File 'lib/aws-sdk-cognitosync/types.rb', line 766

class ListRecordsRequest < Struct.new(
  :identity_pool_id,
  :identity_id,
  :dataset_name,
  :last_sync_count,
  :next_token,
  :max_results,
  :sync_session_token)
  SENSITIVE = []
  include Aws::Structure
end

#identity_pool_id ⇒ String

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

Returns:

  • (String) 

766
767
768
769
770
771
772
773
774
775
776
 
# File 'lib/aws-sdk-cognitosync/types.rb', line 766

class ListRecordsRequest < Struct.new(
  :identity_pool_id,
  :identity_id,
  :dataset_name,
  :last_sync_count,
  :next_token,
  :max_results,
  :sync_session_token)
  SENSITIVE = []
  include Aws::Structure
end

#last_sync_count ⇒ Integer

The last server sync count for this record.

Returns:

  • (Integer) 

766
767
768
769
770
771
772
773
774
775
776
 
# File 'lib/aws-sdk-cognitosync/types.rb', line 766

class ListRecordsRequest < Struct.new(
  :identity_pool_id,
  :identity_id,
  :dataset_name,
  :last_sync_count,
  :next_token,
  :max_results,
  :sync_session_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to be returned.

Returns:

  • (Integer) 

766
767
768
769
770
771
772
773
774
775
776
 
# File 'lib/aws-sdk-cognitosync/types.rb', line 766

class ListRecordsRequest < Struct.new(
  :identity_pool_id,
  :identity_id,
  :dataset_name,
  :last_sync_count,
  :next_token,
  :max_results,
  :sync_session_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

A pagination token for obtaining the next page of results.

Returns:

  • (String) 

766
767
768
769
770
771
772
773
774
775
776
 
# File 'lib/aws-sdk-cognitosync/types.rb', line 766

class ListRecordsRequest < Struct.new(
  :identity_pool_id,
  :identity_id,
  :dataset_name,
  :last_sync_count,
  :next_token,
  :max_results,
  :sync_session_token)
  SENSITIVE = []
  include Aws::Structure
end

#sync_session_token ⇒ String

A token containing a session ID, identity ID, and expiration.

Returns:

  • (String) 

766
767
768
769
770
771
772
773
774
775
776
 
# File 'lib/aws-sdk-cognitosync/types.rb', line 766

class ListRecordsRequest < Struct.new(
  :identity_pool_id,
  :identity_id,
  :dataset_name,
  :last_sync_count,
  :next_token,
  :max_results,
  :sync_session_token)
  SENSITIVE = []
  include Aws::Structure
end