amazonka-cognito-sync-1.4.5: Amazon Cognito Sync SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.CognitoSync.ListRecords

Contents

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

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 # 
Data 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 # 
Show ListRecords # 
Generic ListRecords # 

Associated Types

type Rep ListRecords :: * -> * #

Hashable ListRecords # 
NFData ListRecords # 

Methods

rnf :: ListRecords -> () #

AWSRequest ListRecords # 
ToQuery ListRecords # 
ToPath ListRecords # 
ToHeaders ListRecords # 

Methods

toHeaders :: ListRecords -> [Header] #

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

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 #

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:

data ListRecordsResponse #

Returned for a successful ListRecordsRequest.

See: listRecordsResponse smart constructor.

Instances

Eq ListRecordsResponse # 
Data ListRecordsResponse # 

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 # 
Show ListRecordsResponse # 
Generic ListRecordsResponse # 
NFData ListRecordsResponse # 

Methods

rnf :: ListRecordsResponse -> () #

type Rep ListRecordsResponse # 
type Rep ListRecordsResponse = D1 (MetaData "ListRecordsResponse" "Network.AWS.CognitoSync.ListRecords" "amazonka-cognito-sync-1.4.5-6kgm8A380gaABwgTunDxt8" False) (C1 (MetaCons "ListRecordsResponse'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lrrsDatasetDeletedAfterRequestedSyncCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_lrrsDatasetExists") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) ((:*:) (S1 (MetaSel (Just Symbol "_lrrsCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) ((:*:) (S1 (MetaSel (Just Symbol "_lrrsRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Record]))) (S1 (MetaSel (Just Symbol "_lrrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lrrsMergedDatasetNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_lrrsSyncSessionToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_lrrsLastModifiedBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lrrsDatasetSyncCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer))) (S1 (MetaSel (Just Symbol "_lrrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (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.