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

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

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

Overview

Note:

When making an API call, you may pass ListRecordsRequest data as a hash:

{
  identity_pool_id: "IdentityPoolId", # required
  identity_id: "IdentityId", # required
  dataset_name: "DatasetName", # required
  last_sync_count: 1,
  next_token: "String",
  max_results: 1,
  sync_session_token: "SyncSessionToken",
}

A request for a list of records.

Instance Attribute Summary collapse

Instance Attribute Details

#dataset_nameString

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

Returns:

  • (String)


711
712
713
714
715
716
717
718
719
720
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 711

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

#identity_idString

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)


711
712
713
714
715
716
717
718
719
720
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 711

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

#identity_pool_idString

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)


711
712
713
714
715
716
717
718
719
720
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 711

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

#last_sync_countInteger

The last server sync count for this record.

Returns:

  • (Integer)


711
712
713
714
715
716
717
718
719
720
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 711

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

#max_resultsInteger

The maximum number of results to be returned.

Returns:

  • (Integer)


711
712
713
714
715
716
717
718
719
720
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 711

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

#next_tokenString

A pagination token for obtaining the next page of results.

Returns:

  • (String)


711
712
713
714
715
716
717
718
719
720
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 711

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

#sync_session_tokenString

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

Returns:

  • (String)


711
712
713
714
715
716
717
718
719
720
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 711

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