Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CognitoSync.ListRecords

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

data ListRecords = ListRecords' {
- lastSyncCount :: Maybe Integer
- maxResults :: Maybe Int
- nextToken :: Maybe Text
- syncSessionToken :: Maybe Text
- identityPoolId :: Text
- identityId :: Text
- datasetName :: Text
}
newListRecords :: Text -> Text -> Text -> ListRecords
listRecords_lastSyncCount :: Lens' ListRecords (Maybe Integer)
listRecords_maxResults :: Lens' ListRecords (Maybe Int)
listRecords_nextToken :: Lens' ListRecords (Maybe Text)
listRecords_syncSessionToken :: Lens' ListRecords (Maybe Text)
listRecords_identityPoolId :: Lens' ListRecords Text
listRecords_identityId :: Lens' ListRecords Text
listRecords_datasetName :: Lens' ListRecords Text
data ListRecordsResponse = ListRecordsResponse' {
- count :: Maybe Int
- datasetDeletedAfterRequestedSyncCount :: Maybe Bool
- datasetExists :: Maybe Bool
- datasetSyncCount :: Maybe Integer
- lastModifiedBy :: Maybe Text
- mergedDatasetNames :: Maybe [Text]
- nextToken :: Maybe Text
- records :: Maybe [Record]
- syncSessionToken :: Maybe Text
- httpStatus :: Int
}
newListRecordsResponse :: Int -> ListRecordsResponse
listRecordsResponse_count :: Lens' ListRecordsResponse (Maybe Int)
listRecordsResponse_datasetDeletedAfterRequestedSyncCount :: Lens' ListRecordsResponse (Maybe Bool)
listRecordsResponse_datasetExists :: Lens' ListRecordsResponse (Maybe Bool)
listRecordsResponse_datasetSyncCount :: Lens' ListRecordsResponse (Maybe Integer)
listRecordsResponse_lastModifiedBy :: Lens' ListRecordsResponse (Maybe Text)
listRecordsResponse_mergedDatasetNames :: Lens' ListRecordsResponse (Maybe [Text])
listRecordsResponse_nextToken :: Lens' ListRecordsResponse (Maybe Text)
listRecordsResponse_records :: Lens' ListRecordsResponse (Maybe [Record])
listRecordsResponse_syncSessionToken :: Lens' ListRecordsResponse (Maybe Text)
listRecordsResponse_httpStatus :: Lens' ListRecordsResponse Int

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.
maxResults :: Maybe Int
The maximum number of results to be returned.
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.
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

ToHeaders ListRecords Source #
Instance details Defined in Amazonka.CognitoSync.ListRecords Methods toHeaders :: ListRecords -> [Header] #
ToPath ListRecords Source #
Instance details Defined in Amazonka.CognitoSync.ListRecords Methods toPath :: ListRecords -> ByteString #
ToQuery ListRecords Source #
Instance details Defined in Amazonka.CognitoSync.ListRecords Methods toQuery :: ListRecords -> QueryString #
AWSRequest ListRecords Source #
Instance details Defined in Amazonka.CognitoSync.ListRecords Associated Types type AWSResponse ListRecords # Methods request :: (Service -> Service) -> ListRecords -> Request ListRecords # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListRecords -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListRecords))) #
Generic ListRecords Source #
Instance details Defined in Amazonka.CognitoSync.ListRecords Associated Types type Rep ListRecords :: Type -> Type # Methods from :: ListRecords -> Rep ListRecords x # to :: Rep ListRecords x -> ListRecords #
Read ListRecords Source #
Instance details Defined in Amazonka.CognitoSync.ListRecords Methods readsPrec :: Int -> ReadS ListRecords # readList :: ReadS [ListRecords] # readPrec :: ReadPrec ListRecords # readListPrec :: ReadPrec [ListRecords] #
Show ListRecords Source #
Instance details Defined in Amazonka.CognitoSync.ListRecords Methods showsPrec :: Int -> ListRecords -> ShowS # show :: ListRecords -> String # showList :: [ListRecords] -> ShowS #
NFData ListRecords Source #
Instance details Defined in Amazonka.CognitoSync.ListRecords Methods rnf :: ListRecords -> () #
Eq ListRecords Source #
Instance details Defined in Amazonka.CognitoSync.ListRecords Methods (==) :: ListRecords -> ListRecords -> Bool # (/=) :: ListRecords -> ListRecords -> Bool #
Hashable ListRecords Source #
Instance details Defined in Amazonka.CognitoSync.ListRecords Methods hashWithSalt :: Int -> ListRecords -> Int # hash :: ListRecords -> Int #
type AWSResponse ListRecords Source #
Instance details Defined in Amazonka.CognitoSync.ListRecords type AWSResponse ListRecords = ListRecordsResponse
type Rep ListRecords Source #
Instance details Defined in Amazonka.CognitoSync.ListRecords type Rep ListRecords = D1 ('MetaData "ListRecords" "Amazonka.CognitoSync.ListRecords" "amazonka-cognito-sync-2.0-4eAo0O3jWiUGlkSwv2vKaB" 'False) (C1 ('MetaCons "ListRecords'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "lastSyncCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "syncSessionToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: 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)))))

newListRecords Source #

Arguments

:: Text	`ListRecords`
-> Text	`ListRecords`
-> Text	`ListRecords`
-> ListRecords

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:maxResults:ListRecords', listRecords_maxResults - The maximum number of results to be returned.

ListRecords, listRecords_nextToken - A pagination token for obtaining the next page of results.

ListRecords, listRecords_syncSessionToken - A token containing a session ID, identity ID, and expiration.

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.

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.

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_maxResults :: Lens' ListRecords (Maybe Int) Source #

The maximum number of results to be returned.

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_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

count :: Maybe Int
Total number of records.
datasetDeletedAfterRequestedSyncCount :: Maybe Bool
A boolean value specifying whether to delete the dataset locally.
datasetExists :: Maybe Bool
Indicates whether the dataset exists.
datasetSyncCount :: Maybe Integer
Server sync count for this dataset.
lastModifiedBy :: Maybe Text
The user/device that made the last change to this record.
mergedDatasetNames :: Maybe [Text]
Names of merged datasets.
nextToken :: Maybe Text
A pagination token for obtaining the next page of results.
records :: Maybe [Record]
A list of all records.
syncSessionToken :: Maybe Text
A token containing a session ID, identity ID, and expiration.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ListRecordsResponse Source #
Instance details Defined in Amazonka.CognitoSync.ListRecords Associated Types type Rep ListRecordsResponse :: Type -> Type # Methods from :: ListRecordsResponse -> Rep ListRecordsResponse x # to :: Rep ListRecordsResponse x -> ListRecordsResponse #
Read ListRecordsResponse Source #
Instance details Defined in Amazonka.CognitoSync.ListRecords Methods readsPrec :: Int -> ReadS ListRecordsResponse # readList :: ReadS [ListRecordsResponse] # readPrec :: ReadPrec ListRecordsResponse # readListPrec :: ReadPrec [ListRecordsResponse] #
Show ListRecordsResponse Source #
Instance details Defined in Amazonka.CognitoSync.ListRecords Methods showsPrec :: Int -> ListRecordsResponse -> ShowS # show :: ListRecordsResponse -> String # showList :: [ListRecordsResponse] -> ShowS #
NFData ListRecordsResponse Source #
Instance details Defined in Amazonka.CognitoSync.ListRecords Methods rnf :: ListRecordsResponse -> () #
Eq ListRecordsResponse Source #
Instance details Defined in Amazonka.CognitoSync.ListRecords Methods (==) :: ListRecordsResponse -> ListRecordsResponse -> Bool # (/=) :: ListRecordsResponse -> ListRecordsResponse -> Bool #
type Rep ListRecordsResponse Source #
Instance details Defined in Amazonka.CognitoSync.ListRecords type Rep ListRecordsResponse = D1 ('MetaData "ListRecordsResponse" "Amazonka.CognitoSync.ListRecords" "amazonka-cognito-sync-2.0-4eAo0O3jWiUGlkSwv2vKaB" 'False) (C1 ('MetaCons "ListRecordsResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "count") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "datasetDeletedAfterRequestedSyncCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "datasetExists") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "datasetSyncCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "lastModifiedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "mergedDatasetNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "records") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Record])) :: (S1 ('MetaSel ('Just "syncSessionToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))