Skip to content
AWS for Query.Farm

aws.cognito_sync.list_records

Example SQL Queries

SELECT * FROM
aws.cognito_sync.list_records
WHERE
"identity_pool_id" = 'VALUE'
AND "identity_id" = 'VALUE'
AND "dataset_name" = 'VALUE';

Description

Gets paginated records, optionally changed after a particular sync count for a dataset and identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.

ListRecords can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.

Table Definition

Column NameColumn Data Type
dataset_name Required Input Column

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

VARCHAR
identity_id Required Input Column

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.

VARCHAR
identity_pool_id Required Input Column

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.

VARCHAR
last_sync_count Input Column

The last server sync count for this record.

BIGINT
max_results Input Column

The maximum number of results to be returned.

BIGINT
next_token Input Column

A pagination token for obtaining the next page of results.

VARCHAR
sync_session_token Input Column

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

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
count

Total number of records.

BIGINT
dataset_deleted_after_requested_sync_count

A boolean value specifying whether to delete the dataset locally.

BOOLEAN
dataset_exists

Indicates whether the dataset exists.

BOOLEAN
dataset_sync_count

Server sync count for this dataset.

BIGINT
last_modified_by

The user/device that made the last change to this record.

VARCHAR
merged_dataset_names

Names of merged datasets.

VARCHAR[]
Show child fields
merged_dataset_names[]
records

A list of all records.

STRUCT(
    "key" VARCHAR,
    "value" VARCHAR,
    "sync_count" BIGINT,
    "last_modified_date" TIMESTAMP_S,
    "last_modified_by" VARCHAR,
    "device_last_modified_date" TIMESTAMP_S
)[]
Show child fields
records[]
Show child fields
records[].device_last_modified_date

The last modified date of the client device.

records[].key

The key for the record.

records[].last_modified_by

The user/device that made the last change to this record.

records[].last_modified_date

The date on which the record was last modified.

records[].sync_count

The server sync count for this record.

records[].value

The value for the record.