Network.AWS.CognitoSync.ListRecords

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.

Creating a Request

listRecords

Arguments

:: Text

lrIdentityPoolId

-> Text

lrIdentityId

-> Text

lrDatasetName

-> ListRecords

Creates a value of ListRecords with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lrLastSyncCount - The last server sync count for this record.
• lrNextToken - A pagination token for obtaining the next page of results.
• lrSyncSessionToken - A token containing a session ID, identity ID, and expiration.
• lrMaxResults - The maximum number of results to be returned.
• lrIdentityPoolId - 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.
• lrIdentityId - 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.
• lrDatasetName - A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), - (dash), and . (dot).

data ListRecords

A request for a list of records.

See: listRecords smart constructor.

Instances

Eq ListRecords

Defined in Network.AWS.CognitoSync.ListRecords

Methods

(==) :: ListRecords -> ListRecords -> Bool

(/=) :: ListRecords -> ListRecords -> Bool

Data ListRecords

Defined in Network.AWS.CognitoSync.ListRecords

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListRecords -> c ListRecords

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListRecords

toConstr :: ListRecords -> Constr

dataTypeOf :: ListRecords -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListRecords)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListRecords)

gmapT :: (forall b. Data b => b -> b) -> ListRecords -> ListRecords

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListRecords -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListRecords -> r

gmapQ :: (forall d. Data d => d -> u) -> ListRecords -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListRecords -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListRecords -> m ListRecords

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListRecords -> m ListRecords

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListRecords -> m ListRecords

Read ListRecords

Defined in Network.AWS.CognitoSync.ListRecords

Methods

readsPrec :: Int -> ReadS ListRecords

readList :: ReadS [ListRecords]

readPrec :: ReadPrec ListRecords

readListPrec :: ReadPrec [ListRecords]

Show ListRecords

Defined in Network.AWS.CognitoSync.ListRecords

Methods

showsPrec :: Int -> ListRecords -> ShowS

show :: ListRecords -> String

showList :: [ListRecords] -> ShowS

Generic ListRecords

Defined in Network.AWS.CognitoSync.ListRecords

Associated Types

type Rep ListRecords :: Type -> Type

Methods

from :: ListRecords -> Rep ListRecords x

to :: Rep ListRecords x -> ListRecords

Hashable ListRecords

Defined in Network.AWS.CognitoSync.ListRecords

Methods

hashWithSalt :: Int -> ListRecords -> Int

hash :: ListRecords -> Int

AWSRequest ListRecords

Defined in Network.AWS.CognitoSync.ListRecords

Associated Types

type Rs ListRecords :: Type

Methods

request :: ListRecords -> Request ListRecords

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy ListRecords -> ClientResponse -> m (Response ListRecords)

ToHeaders ListRecords

Defined in Network.AWS.CognitoSync.ListRecords

Methods

toHeaders :: ListRecords -> [Header]

ToPath ListRecords

Defined in Network.AWS.CognitoSync.ListRecords

Methods

toPath :: ListRecords -> ByteString

ToQuery ListRecords

Defined in Network.AWS.CognitoSync.ListRecords

Methods

toQuery :: ListRecords -> QueryString

NFData ListRecords

Defined in Network.AWS.CognitoSync.ListRecords

Methods

rnf :: ListRecords -> ()

type Rep ListRecords

Defined in Network.AWS.CognitoSync.ListRecords

type Rep ListRecords = D1 (MetaData "ListRecords" "Network.AWS.CognitoSync.ListRecords" "amazonka-cognito-sync-1.6.1-ha9SVGJqZqDpQMx6bgfWw" False) (C1 (MetaCons "ListRecords'" PrefixI True) ((S1 (MetaSel (Just "_lrLastSyncCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 (MetaSel (Just "_lrNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lrSyncSessionToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_lrMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)) :*: S1 (MetaSel (Just "_lrIdentityPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :*: (S1 (MetaSel (Just "_lrIdentityId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_lrDatasetName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs ListRecords

Defined in Network.AWS.CognitoSync.ListRecords

type Rs ListRecords = ListRecordsResponse

Request Lenses

lrLastSyncCount :: Lens' ListRecords (Maybe Integer)

The last server sync count for this record.

lrNextToken :: Lens' ListRecords (Maybe Text)

A pagination token for obtaining the next page of results.

lrSyncSessionToken :: Lens' ListRecords (Maybe Text)

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

lrMaxResults :: Lens' ListRecords (Maybe Int)

The maximum number of results to be returned.

lrIdentityPoolId :: Lens' ListRecords 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.

lrIdentityId :: Lens' ListRecords 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.

lrDatasetName :: Lens' ListRecords Text

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

Destructuring the Response

listRecordsResponse

Arguments

:: Int

lrrsResponseStatus

-> ListRecordsResponse

Creates a value of ListRecordsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lrrsDatasetDeletedAfterRequestedSyncCount - A boolean value specifying whether to delete the dataset locally.
• lrrsDatasetExists - Indicates whether the dataset exists.
• lrrsCount - Total number of records.
• lrrsRecords - A list of all records.
• lrrsNextToken - A pagination token for obtaining the next page of results.
• lrrsMergedDatasetNames - Names of merged datasets.
• lrrsSyncSessionToken - A token containing a session ID, identity ID, and expiration.
• lrrsLastModifiedBy - The user/device that made the last change to this record.
• lrrsDatasetSyncCount - Server sync count for this dataset.
• lrrsResponseStatus - -- | The response status code.

data ListRecordsResponse

Returned for a successful ListRecordsRequest.

See: listRecordsResponse smart constructor.

Instances

Eq ListRecordsResponse

Defined in Network.AWS.CognitoSync.ListRecords

Methods

(==) :: ListRecordsResponse -> ListRecordsResponse -> Bool

(/=) :: ListRecordsResponse -> ListRecordsResponse -> Bool

Data ListRecordsResponse

Defined in Network.AWS.CognitoSync.ListRecords

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListRecordsResponse -> c ListRecordsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListRecordsResponse

toConstr :: ListRecordsResponse -> Constr

dataTypeOf :: ListRecordsResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListRecordsResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListRecordsResponse)

gmapT :: (forall b. Data b => b -> b) -> ListRecordsResponse -> ListRecordsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListRecordsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListRecordsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> ListRecordsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListRecordsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListRecordsResponse -> m ListRecordsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListRecordsResponse -> m ListRecordsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListRecordsResponse -> m ListRecordsResponse

Read ListRecordsResponse

Defined in Network.AWS.CognitoSync.ListRecords

Methods

readsPrec :: Int -> ReadS ListRecordsResponse

readList :: ReadS [ListRecordsResponse]

readPrec :: ReadPrec ListRecordsResponse

readListPrec :: ReadPrec [ListRecordsResponse]

Show ListRecordsResponse

Defined in Network.AWS.CognitoSync.ListRecords

Methods

showsPrec :: Int -> ListRecordsResponse -> ShowS

show :: ListRecordsResponse -> String

showList :: [ListRecordsResponse] -> ShowS

Generic ListRecordsResponse

Defined in Network.AWS.CognitoSync.ListRecords

Associated Types

type Rep ListRecordsResponse :: Type -> Type

Methods

from :: ListRecordsResponse -> Rep ListRecordsResponse x

to :: Rep ListRecordsResponse x -> ListRecordsResponse

NFData ListRecordsResponse

Defined in Network.AWS.CognitoSync.ListRecords

Methods

rnf :: ListRecordsResponse -> ()

type Rep ListRecordsResponse

Defined in Network.AWS.CognitoSync.ListRecords

type Rep ListRecordsResponse = D1 (MetaData "ListRecordsResponse" "Network.AWS.CognitoSync.ListRecords" "amazonka-cognito-sync-1.6.1-ha9SVGJqZqDpQMx6bgfWw" False) (C1 (MetaCons "ListRecordsResponse'" PrefixI True) (((S1 (MetaSel (Just "_lrrsDatasetDeletedAfterRequestedSyncCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_lrrsDatasetExists") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 (MetaSel (Just "_lrrsCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 (MetaSel (Just "_lrrsRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Record])) :*: S1 (MetaSel (Just "_lrrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 (MetaSel (Just "_lrrsMergedDatasetNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_lrrsSyncSessionToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_lrrsLastModifiedBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_lrrsDatasetSyncCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 (MetaSel (Just "_lrrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))))

Response Lenses

lrrsDatasetDeletedAfterRequestedSyncCount :: Lens' ListRecordsResponse (Maybe Bool)

A boolean value specifying whether to delete the dataset locally.

lrrsDatasetExists :: Lens' ListRecordsResponse (Maybe Bool)

Indicates whether the dataset exists.

lrrsCount :: Lens' ListRecordsResponse (Maybe Int)

Total number of records.

lrrsRecords :: Lens' ListRecordsResponse [Record]

A list of all records.

lrrsNextToken :: Lens' ListRecordsResponse (Maybe Text)

A pagination token for obtaining the next page of results.

lrrsMergedDatasetNames :: Lens' ListRecordsResponse [Text]

Names of merged datasets.

lrrsSyncSessionToken :: Lens' ListRecordsResponse (Maybe Text)

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

lrrsLastModifiedBy :: Lens' ListRecordsResponse (Maybe Text)

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

lrrsDatasetSyncCount :: Lens' ListRecordsResponse (Maybe Integer)

Server sync count for this dataset.

lrrsResponseStatus :: Lens' ListRecordsResponse Int

• - | The response status code.