libZSservicesZSamazonka-cognito-syncZSamazonka-cognito-sync
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CognitoSync.ListRecords

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.

Synopsis

Creating a Request

data ListRecords Source #

A request for a list of records.

See: newListRecords smart constructor.

Constructors

ListRecords' 

Fields

  • lastSyncCount :: Maybe Integer

    The last server sync count for this record.

  • nextToken :: Maybe Text

    A pagination token for obtaining the next page of results.

  • syncSessionToken :: Maybe Text

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

  • maxResults :: Maybe Int

    The maximum number of results to be returned.

  • identityPoolId :: Text

    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.

  • identityId :: Text

    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.

  • datasetName :: Text

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

Instances

Instances details
Eq ListRecords Source # 
Instance details

Defined in Amazonka.CognitoSync.ListRecords

Read ListRecords Source # 
Instance details

Defined in Amazonka.CognitoSync.ListRecords

Show ListRecords Source # 
Instance details

Defined in Amazonka.CognitoSync.ListRecords

Generic ListRecords Source # 
Instance details

Defined in Amazonka.CognitoSync.ListRecords

Associated Types

type Rep ListRecords :: Type -> Type #

NFData ListRecords Source # 
Instance details

Defined in Amazonka.CognitoSync.ListRecords

Methods

rnf :: ListRecords -> () #

Hashable ListRecords Source # 
Instance details

Defined in Amazonka.CognitoSync.ListRecords

AWSRequest ListRecords Source # 
Instance details

Defined in Amazonka.CognitoSync.ListRecords

Associated Types

type AWSResponse ListRecords #

ToHeaders ListRecords Source # 
Instance details

Defined in Amazonka.CognitoSync.ListRecords

Methods

toHeaders :: ListRecords -> [Header] #

ToPath ListRecords Source # 
Instance details

Defined in Amazonka.CognitoSync.ListRecords

ToQuery ListRecords Source # 
Instance details

Defined in Amazonka.CognitoSync.ListRecords

type Rep ListRecords Source # 
Instance details

Defined in Amazonka.CognitoSync.ListRecords

type Rep ListRecords = D1 ('MetaData "ListRecords" "Amazonka.CognitoSync.ListRecords" "libZSservicesZSamazonka-cognito-syncZSamazonka-cognito-sync" 'False) (C1 ('MetaCons "ListRecords'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "lastSyncCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "syncSessionToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "identityPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "identityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "datasetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse ListRecords Source # 
Instance details

Defined in Amazonka.CognitoSync.ListRecords

newListRecords Source #

Create a value of ListRecords with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:lastSyncCount:ListRecords', listRecords_lastSyncCount - The last server sync count for this record.

$sel:nextToken:ListRecords', listRecords_nextToken - A pagination token for obtaining the next page of results.

$sel:syncSessionToken:ListRecords', listRecords_syncSessionToken - A token containing a session ID, identity ID, and expiration.

$sel:maxResults:ListRecords', listRecords_maxResults - The maximum number of results to be returned.

$sel:identityPoolId:ListRecords', listRecords_identityPoolId - 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.

$sel:identityId:ListRecords', listRecords_identityId - 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.

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

Request Lenses

listRecords_lastSyncCount :: Lens' ListRecords (Maybe Integer) Source #

The last server sync count for this record.

listRecords_nextToken :: Lens' ListRecords (Maybe Text) Source #

A pagination token for obtaining the next page of results.

listRecords_syncSessionToken :: Lens' ListRecords (Maybe Text) Source #

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

listRecords_maxResults :: Lens' ListRecords (Maybe Int) Source #

The maximum number of results to be returned.

listRecords_identityPoolId :: Lens' ListRecords Text Source #

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.

listRecords_identityId :: Lens' ListRecords Text Source #

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.

listRecords_datasetName :: Lens' ListRecords Text Source #

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

Destructuring the Response

data ListRecordsResponse Source #

Returned for a successful ListRecordsRequest.

See: newListRecordsResponse smart constructor.

Constructors

ListRecordsResponse' 

Fields

Instances

Instances details
Eq ListRecordsResponse Source # 
Instance details

Defined in Amazonka.CognitoSync.ListRecords

Read ListRecordsResponse Source # 
Instance details

Defined in Amazonka.CognitoSync.ListRecords

Show ListRecordsResponse Source # 
Instance details

Defined in Amazonka.CognitoSync.ListRecords

Generic ListRecordsResponse Source # 
Instance details

Defined in Amazonka.CognitoSync.ListRecords

Associated Types

type Rep ListRecordsResponse :: Type -> Type #

NFData ListRecordsResponse Source # 
Instance details

Defined in Amazonka.CognitoSync.ListRecords

Methods

rnf :: ListRecordsResponse -> () #

type Rep ListRecordsResponse Source # 
Instance details

Defined in Amazonka.CognitoSync.ListRecords

type Rep ListRecordsResponse = D1 ('MetaData "ListRecordsResponse" "Amazonka.CognitoSync.ListRecords" "libZSservicesZSamazonka-cognito-syncZSamazonka-cognito-sync" 'False) (C1 ('MetaCons "ListRecordsResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "datasetDeletedAfterRequestedSyncCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "datasetExists") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "count") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "records") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Record])) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "mergedDatasetNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "syncSessionToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "lastModifiedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "datasetSyncCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newListRecordsResponse Source #

Create a value of ListRecordsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:datasetDeletedAfterRequestedSyncCount:ListRecordsResponse', listRecordsResponse_datasetDeletedAfterRequestedSyncCount - A boolean value specifying whether to delete the dataset locally.

$sel:datasetExists:ListRecordsResponse', listRecordsResponse_datasetExists - Indicates whether the dataset exists.

$sel:count:ListRecordsResponse', listRecordsResponse_count - Total number of records.

$sel:records:ListRecordsResponse', listRecordsResponse_records - A list of all records.

$sel:nextToken:ListRecords', listRecordsResponse_nextToken - A pagination token for obtaining the next page of results.

$sel:mergedDatasetNames:ListRecordsResponse', listRecordsResponse_mergedDatasetNames - Names of merged datasets.

$sel:syncSessionToken:ListRecords', listRecordsResponse_syncSessionToken - A token containing a session ID, identity ID, and expiration.

$sel:lastModifiedBy:ListRecordsResponse', listRecordsResponse_lastModifiedBy - The user/device that made the last change to this record.

$sel:datasetSyncCount:ListRecordsResponse', listRecordsResponse_datasetSyncCount - Server sync count for this dataset.

$sel:httpStatus:ListRecordsResponse', listRecordsResponse_httpStatus - The response's http status code.

Response Lenses

listRecordsResponse_datasetDeletedAfterRequestedSyncCount :: Lens' ListRecordsResponse (Maybe Bool) Source #

A boolean value specifying whether to delete the dataset locally.

listRecordsResponse_nextToken :: Lens' ListRecordsResponse (Maybe Text) Source #

A pagination token for obtaining the next page of results.

listRecordsResponse_syncSessionToken :: Lens' ListRecordsResponse (Maybe Text) Source #

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

listRecordsResponse_lastModifiedBy :: Lens' ListRecordsResponse (Maybe Text) Source #

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