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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListRecordsRequest as input to an Aws::Client method, you can use a vanilla 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.

See Also:

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) —

    A string of up to 128 characters.

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

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

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

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

#last_sync_count ⇒ Integer

The last server sync count for this record.

Returns:

  • (Integer) —

    The last server sync count for this record.

#max_results ⇒ Integer

The maximum number of results to be returned.

Returns:

  • (Integer) —

    The maximum number of results to be returned.

#next_token ⇒ String

A pagination token for obtaining the next page of results.

Returns:

  • (String) —

    A pagination token for obtaining the next page of results.

#sync_session_token ⇒ String

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

Returns:

  • (String) —

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