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

Contents

Description

Amazon Cognito Sync

Amazon Cognito Sync provides an AWS service and client library that enable cross-device syncing of application-related user data. High-level client libraries are available for both iOS and Android. You can use these libraries to persist data locally so that it's available even if the device is offline. Developer credentials don't need to be stored on the mobile device to access the service. You can use Amazon Cognito to obtain a normalized user ID and credentials. User data is persisted in a dataset that can store up to 1 MB of key-value pairs, and you can have up to 20 datasets per user identity.

With Amazon Cognito Sync, the data stored for each identity is accessible only to credentials assigned to that identity. In order to use the Cognito Sync service, you need to make API calls using credentials retrieved with Amazon Cognito Identity service .

If you want to use Cognito Sync in an Android or iOS application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the Developer Guide for Android and the Developer Guide for iOS .

Synopsis

Service Configuration

cognitoSync :: Service #

API version 2014-06-30 of the Amazon Cognito Sync SDK configuration.

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by CognitoSync.

InvalidParameterException

_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError #

Thrown when a request parameter does not comply with the associated constraints.

NotAuthorizedException

_NotAuthorizedException :: AsError a => Getting (First ServiceError) a ServiceError #

Thrown when a user is not authorized to access the requested resource.

InternalErrorException

_InternalErrorException :: AsError a => Getting (First ServiceError) a ServiceError #

Indicates an internal service error.

InvalidConfigurationException

_InvalidConfigurationException :: AsError a => Getting (First ServiceError) a ServiceError #

Prism for InvalidConfigurationException' errors.

DuplicateRequestException

_DuplicateRequestException :: AsError a => Getting (First ServiceError) a ServiceError #

An exception thrown when there is an IN_PROGRESS bulk publish operation for the given identity pool.

LambdaThrottledException

_LambdaThrottledException :: AsError a => Getting (First ServiceError) a ServiceError #

AWS Lambda throttled your account, please contact AWS Support

AlreadyStreamedException

_AlreadyStreamedException :: AsError a => Getting (First ServiceError) a ServiceError #

An exception thrown when a bulk publish operation is requested less than 24 hours after a previous bulk publish operation completed successfully.

InvalidLambdaFunctionOutputException

_InvalidLambdaFunctionOutputException :: AsError a => Getting (First ServiceError) a ServiceError #

The AWS Lambda function returned invalid output or an exception.

TooManyRequestsException

_TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError #

Thrown if the request is throttled.

ConcurrentModificationException

_ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError #

Thrown if there are parallel requests to modify a resource.

ResourceConflictException

_ResourceConflictException :: AsError a => Getting (First ServiceError) a ServiceError #

Thrown if an update can't be applied because the resource was changed by another call and this would result in a conflict.

ResourceNotFoundException

_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError #

Thrown if the resource doesn't exist.

LimitExceededException

_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError #

Thrown when the limit on the number of objects or operations has been exceeded.

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

DescribeDataset

SetCognitoEvents

DescribeIdentityPoolUsage

GetBulkPublishDetails

ListIdentityPoolUsage

SetIdentityPoolConfiguration

DeleteDataset

GetCognitoEvents

DescribeIdentityUsage

RegisterDevice

SubscribeToDataset

GetIdentityPoolConfiguration

ListRecords

UnsubscribeFromDataset

UpdateRecords

ListDatasets

BulkPublish

Types

BulkPublishStatus

data BulkPublishStatus #

Instances

Bounded BulkPublishStatus # 
Enum BulkPublishStatus # 
Eq BulkPublishStatus # 
Data BulkPublishStatus # 

Methods

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

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

toConstr :: BulkPublishStatus -> Constr #

dataTypeOf :: BulkPublishStatus -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c BulkPublishStatus) #

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

gmapT :: (forall b. Data b => b -> b) -> BulkPublishStatus -> BulkPublishStatus #

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

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

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

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

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

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

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

Ord BulkPublishStatus # 
Read BulkPublishStatus # 
Show BulkPublishStatus # 
Generic BulkPublishStatus # 
Hashable BulkPublishStatus # 
FromJSON BulkPublishStatus # 
NFData BulkPublishStatus # 

Methods

rnf :: BulkPublishStatus -> () #

ToQuery BulkPublishStatus # 
ToHeader BulkPublishStatus # 
ToByteString BulkPublishStatus # 
FromText BulkPublishStatus # 
ToText BulkPublishStatus # 
type Rep BulkPublishStatus # 
type Rep BulkPublishStatus = D1 (MetaData "BulkPublishStatus" "Network.AWS.CognitoSync.Types.Sum" "amazonka-cognito-sync-1.4.5-6kgm8A380gaABwgTunDxt8" False) ((:+:) ((:+:) (C1 (MetaCons "Failed" PrefixI False) U1) (C1 (MetaCons "InProgress" PrefixI False) U1)) ((:+:) (C1 (MetaCons "NotStarted" PrefixI False) U1) (C1 (MetaCons "Succeeded" PrefixI False) U1)))

Operation

data Operation #

Constructors

Remove 
Replace 

Instances

Bounded Operation # 
Enum Operation # 
Eq Operation # 
Data Operation # 

Methods

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

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

toConstr :: Operation -> Constr #

dataTypeOf :: Operation -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Operation) #

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

gmapT :: (forall b. Data b => b -> b) -> Operation -> Operation #

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

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

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

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

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

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

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

Ord Operation # 
Read Operation # 
Show Operation # 
Generic Operation # 

Associated Types

type Rep Operation :: * -> * #

Hashable Operation # 
ToJSON Operation # 
NFData Operation # 

Methods

rnf :: Operation -> () #

ToQuery Operation # 
ToHeader Operation # 
ToByteString Operation # 

Methods

toBS :: Operation -> ByteString #

FromText Operation # 
ToText Operation # 

Methods

toText :: Operation -> Text #

type Rep Operation # 
type Rep Operation = D1 (MetaData "Operation" "Network.AWS.CognitoSync.Types.Sum" "amazonka-cognito-sync-1.4.5-6kgm8A380gaABwgTunDxt8" False) ((:+:) (C1 (MetaCons "Remove" PrefixI False) U1) (C1 (MetaCons "Replace" PrefixI False) U1))

Platform

data Platform #

Constructors

ADM 
APNS 
APNSSandbox 
GCM 

Instances

Bounded Platform # 
Enum Platform # 
Eq Platform # 
Data Platform # 

Methods

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

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

toConstr :: Platform -> Constr #

dataTypeOf :: Platform -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Platform) #

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

gmapT :: (forall b. Data b => b -> b) -> Platform -> Platform #

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

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

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

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

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

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

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

Ord Platform # 
Read Platform # 
Show Platform # 
Generic Platform # 

Associated Types

type Rep Platform :: * -> * #

Methods

from :: Platform -> Rep Platform x #

to :: Rep Platform x -> Platform #

Hashable Platform # 

Methods

hashWithSalt :: Int -> Platform -> Int #

hash :: Platform -> Int #

ToJSON Platform # 
NFData Platform # 

Methods

rnf :: Platform -> () #

ToQuery Platform # 
ToHeader Platform # 

Methods

toHeader :: HeaderName -> Platform -> [Header] #

ToByteString Platform # 

Methods

toBS :: Platform -> ByteString #

FromText Platform # 
ToText Platform # 

Methods

toText :: Platform -> Text #

type Rep Platform # 
type Rep Platform = D1 (MetaData "Platform" "Network.AWS.CognitoSync.Types.Sum" "amazonka-cognito-sync-1.4.5-6kgm8A380gaABwgTunDxt8" False) ((:+:) ((:+:) (C1 (MetaCons "ADM" PrefixI False) U1) (C1 (MetaCons "APNS" PrefixI False) U1)) ((:+:) (C1 (MetaCons "APNSSandbox" PrefixI False) U1) (C1 (MetaCons "GCM" PrefixI False) U1)))

StreamingStatus

data StreamingStatus #

Constructors

Disabled 
Enabled 

Instances

Bounded StreamingStatus # 
Enum StreamingStatus # 
Eq StreamingStatus # 
Data StreamingStatus # 

Methods

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

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

toConstr :: StreamingStatus -> Constr #

dataTypeOf :: StreamingStatus -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c StreamingStatus) #

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

gmapT :: (forall b. Data b => b -> b) -> StreamingStatus -> StreamingStatus #

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

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

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

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

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

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

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

Ord StreamingStatus # 
Read StreamingStatus # 
Show StreamingStatus # 
Generic StreamingStatus # 
Hashable StreamingStatus # 
ToJSON StreamingStatus # 
FromJSON StreamingStatus # 
NFData StreamingStatus # 

Methods

rnf :: StreamingStatus -> () #

ToQuery StreamingStatus # 
ToHeader StreamingStatus # 
ToByteString StreamingStatus # 
FromText StreamingStatus # 
ToText StreamingStatus # 
type Rep StreamingStatus # 
type Rep StreamingStatus = D1 (MetaData "StreamingStatus" "Network.AWS.CognitoSync.Types.Sum" "amazonka-cognito-sync-1.4.5-6kgm8A380gaABwgTunDxt8" False) ((:+:) (C1 (MetaCons "Disabled" PrefixI False) U1) (C1 (MetaCons "Enabled" PrefixI False) U1))

CognitoStreams

data CognitoStreams #

Configuration options for configure Cognito streams.

See: cognitoStreams smart constructor.

Instances

Eq CognitoStreams # 
Data CognitoStreams # 

Methods

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

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

toConstr :: CognitoStreams -> Constr #

dataTypeOf :: CognitoStreams -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CognitoStreams) #

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

gmapT :: (forall b. Data b => b -> b) -> CognitoStreams -> CognitoStreams #

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

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

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

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

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

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

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

Read CognitoStreams # 
Show CognitoStreams # 
Generic CognitoStreams # 

Associated Types

type Rep CognitoStreams :: * -> * #

Hashable CognitoStreams # 
ToJSON CognitoStreams # 
FromJSON CognitoStreams # 
NFData CognitoStreams # 

Methods

rnf :: CognitoStreams -> () #

type Rep CognitoStreams # 
type Rep CognitoStreams = D1 (MetaData "CognitoStreams" "Network.AWS.CognitoSync.Types.Product" "amazonka-cognito-sync-1.4.5-6kgm8A380gaABwgTunDxt8" False) (C1 (MetaCons "CognitoStreams'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_csStreamingStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe StreamingStatus))) ((:*:) (S1 (MetaSel (Just Symbol "_csStreamName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_csRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

cognitoStreams :: CognitoStreams #

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

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

  • csStreamingStatus - Status of the Cognito streams. Valid values are: ENABLED - Streaming of updates to identity pool is enabled. DISABLED - Streaming of updates to identity pool is disabled. Bulk publish will also fail if StreamingStatus is DISABLED.
  • csStreamName - The name of the Cognito stream to receive updates. This stream must be in the developers account and in the same region as the identity pool.
  • csRoleARN - The ARN of the role Amazon Cognito can assume in order to publish to the stream. This role must grant access to Amazon Cognito (cognito-sync) to invoke PutRecord on your Cognito stream.

csStreamingStatus :: Lens' CognitoStreams (Maybe StreamingStatus) #

Status of the Cognito streams. Valid values are: ENABLED - Streaming of updates to identity pool is enabled. DISABLED - Streaming of updates to identity pool is disabled. Bulk publish will also fail if StreamingStatus is DISABLED.

csStreamName :: Lens' CognitoStreams (Maybe Text) #

The name of the Cognito stream to receive updates. This stream must be in the developers account and in the same region as the identity pool.

csRoleARN :: Lens' CognitoStreams (Maybe Text) #

The ARN of the role Amazon Cognito can assume in order to publish to the stream. This role must grant access to Amazon Cognito (cognito-sync) to invoke PutRecord on your Cognito stream.

Dataset

data Dataset #

A collection of data for an identity pool. An identity pool can have multiple datasets. A dataset is per identity and can be general or associated with a particular entity in an application (like a saved game). Datasets are automatically created if they don't exist. Data is synced by dataset, and a dataset can hold up to 1MB of key-value pairs.

See: dataset smart constructor.

Instances

Eq Dataset # 

Methods

(==) :: Dataset -> Dataset -> Bool #

(/=) :: Dataset -> Dataset -> Bool #

Data Dataset # 

Methods

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

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

toConstr :: Dataset -> Constr #

dataTypeOf :: Dataset -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Dataset) #

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

gmapT :: (forall b. Data b => b -> b) -> Dataset -> Dataset #

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

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

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

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

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

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

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

Read Dataset # 
Show Dataset # 
Generic Dataset # 

Associated Types

type Rep Dataset :: * -> * #

Methods

from :: Dataset -> Rep Dataset x #

to :: Rep Dataset x -> Dataset #

Hashable Dataset # 

Methods

hashWithSalt :: Int -> Dataset -> Int #

hash :: Dataset -> Int #

FromJSON Dataset # 
NFData Dataset # 

Methods

rnf :: Dataset -> () #

type Rep Dataset # 

dataset :: Dataset #

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

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

  • dLastModifiedDate - Date when the dataset was last modified.
  • dNumRecords - Number of records in this dataset.
  • dDataStorage - Total size in bytes of the records in this dataset.
  • dDatasetName - A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), - (dash), and . (dot).
  • dCreationDate - Date on which the dataset was created.
  • dLastModifiedBy - The device that made the last change to this dataset.
  • dIdentityId - 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.

dLastModifiedDate :: Lens' Dataset (Maybe UTCTime) #

Date when the dataset was last modified.

dNumRecords :: Lens' Dataset (Maybe Integer) #

Number of records in this dataset.

dDataStorage :: Lens' Dataset (Maybe Integer) #

Total size in bytes of the records in this dataset.

dDatasetName :: Lens' Dataset (Maybe Text) #

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

dCreationDate :: Lens' Dataset (Maybe UTCTime) #

Date on which the dataset was created.

dLastModifiedBy :: Lens' Dataset (Maybe Text) #

The device that made the last change to this dataset.

dIdentityId :: Lens' Dataset (Maybe 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.

IdentityPoolUsage

data IdentityPoolUsage #

Usage information for the identity pool.

See: identityPoolUsage smart constructor.

Instances

Eq IdentityPoolUsage # 
Data IdentityPoolUsage # 

Methods

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

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

toConstr :: IdentityPoolUsage -> Constr #

dataTypeOf :: IdentityPoolUsage -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c IdentityPoolUsage) #

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

gmapT :: (forall b. Data b => b -> b) -> IdentityPoolUsage -> IdentityPoolUsage #

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

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

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

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

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

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

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

Read IdentityPoolUsage # 
Show IdentityPoolUsage # 
Generic IdentityPoolUsage # 
Hashable IdentityPoolUsage # 
FromJSON IdentityPoolUsage # 
NFData IdentityPoolUsage # 

Methods

rnf :: IdentityPoolUsage -> () #

type Rep IdentityPoolUsage # 
type Rep IdentityPoolUsage = D1 (MetaData "IdentityPoolUsage" "Network.AWS.CognitoSync.Types.Product" "amazonka-cognito-sync-1.4.5-6kgm8A380gaABwgTunDxt8" False) (C1 (MetaCons "IdentityPoolUsage'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ipuLastModifiedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) (S1 (MetaSel (Just Symbol "_ipuIdentityPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_ipuDataStorage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer))) (S1 (MetaSel (Just Symbol "_ipuSyncSessionsCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer))))))

identityPoolUsage :: IdentityPoolUsage #

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

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

  • ipuLastModifiedDate - Date on which the identity pool was last modified.
  • ipuIdentityPoolId - 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.
  • ipuDataStorage - Data storage information for the identity pool.
  • ipuSyncSessionsCount - Number of sync sessions for the identity pool.

ipuLastModifiedDate :: Lens' IdentityPoolUsage (Maybe UTCTime) #

Date on which the identity pool was last modified.

ipuIdentityPoolId :: Lens' IdentityPoolUsage (Maybe 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.

ipuDataStorage :: Lens' IdentityPoolUsage (Maybe Integer) #

Data storage information for the identity pool.

ipuSyncSessionsCount :: Lens' IdentityPoolUsage (Maybe Integer) #

Number of sync sessions for the identity pool.

IdentityUsage

data IdentityUsage #

Usage information for the identity.

See: identityUsage smart constructor.

Instances

Eq IdentityUsage # 
Data IdentityUsage # 

Methods

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

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

toConstr :: IdentityUsage -> Constr #

dataTypeOf :: IdentityUsage -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c IdentityUsage) #

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

gmapT :: (forall b. Data b => b -> b) -> IdentityUsage -> IdentityUsage #

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

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

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

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

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

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

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

Read IdentityUsage # 
Show IdentityUsage # 
Generic IdentityUsage # 

Associated Types

type Rep IdentityUsage :: * -> * #

Hashable IdentityUsage # 
FromJSON IdentityUsage # 
NFData IdentityUsage # 

Methods

rnf :: IdentityUsage -> () #

type Rep IdentityUsage # 
type Rep IdentityUsage = D1 (MetaData "IdentityUsage" "Network.AWS.CognitoSync.Types.Product" "amazonka-cognito-sync-1.4.5-6kgm8A380gaABwgTunDxt8" False) (C1 (MetaCons "IdentityUsage'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_iuLastModifiedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) (S1 (MetaSel (Just Symbol "_iuIdentityPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_iuDatasetCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) ((:*:) (S1 (MetaSel (Just Symbol "_iuDataStorage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer))) (S1 (MetaSel (Just Symbol "_iuIdentityId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

identityUsage :: IdentityUsage #

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

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

  • iuLastModifiedDate - Date on which the identity was last modified.
  • iuIdentityPoolId - 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.
  • iuDatasetCount - Number of datasets for the identity.
  • iuDataStorage - Total data storage for this identity.
  • iuIdentityId - 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.

iuLastModifiedDate :: Lens' IdentityUsage (Maybe UTCTime) #

Date on which the identity was last modified.

iuIdentityPoolId :: Lens' IdentityUsage (Maybe 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.

iuDatasetCount :: Lens' IdentityUsage (Maybe Int) #

Number of datasets for the identity.

iuDataStorage :: Lens' IdentityUsage (Maybe Integer) #

Total data storage for this identity.

iuIdentityId :: Lens' IdentityUsage (Maybe 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.

PushSync

data PushSync #

Configuration options to be applied to the identity pool.

See: pushSync smart constructor.

Instances

Eq PushSync # 
Data PushSync # 

Methods

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

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

toConstr :: PushSync -> Constr #

dataTypeOf :: PushSync -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c PushSync) #

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

gmapT :: (forall b. Data b => b -> b) -> PushSync -> PushSync #

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

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

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

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

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

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

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

Read PushSync # 
Show PushSync # 
Generic PushSync # 

Associated Types

type Rep PushSync :: * -> * #

Methods

from :: PushSync -> Rep PushSync x #

to :: Rep PushSync x -> PushSync #

Hashable PushSync # 

Methods

hashWithSalt :: Int -> PushSync -> Int #

hash :: PushSync -> Int #

ToJSON PushSync # 
FromJSON PushSync # 
NFData PushSync # 

Methods

rnf :: PushSync -> () #

type Rep PushSync # 
type Rep PushSync = D1 (MetaData "PushSync" "Network.AWS.CognitoSync.Types.Product" "amazonka-cognito-sync-1.4.5-6kgm8A380gaABwgTunDxt8" False) (C1 (MetaCons "PushSync'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_psApplicationARNs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_psRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))

pushSync :: PushSync #

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

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

  • psApplicationARNs - List of SNS platform application ARNs that could be used by clients.
  • psRoleARN - A role configured to allow Cognito to call SNS on behalf of the developer.

psApplicationARNs :: Lens' PushSync [Text] #

List of SNS platform application ARNs that could be used by clients.

psRoleARN :: Lens' PushSync (Maybe Text) #

A role configured to allow Cognito to call SNS on behalf of the developer.

Record

data Record #

The basic data structure of a dataset.

See: record smart constructor.

Instances

Eq Record # 

Methods

(==) :: Record -> Record -> Bool #

(/=) :: Record -> Record -> Bool #

Data Record # 

Methods

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

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

toConstr :: Record -> Constr #

dataTypeOf :: Record -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Record) #

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

gmapT :: (forall b. Data b => b -> b) -> Record -> Record #

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

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

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

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

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

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

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

Read Record # 
Show Record # 
Generic Record # 

Associated Types

type Rep Record :: * -> * #

Methods

from :: Record -> Rep Record x #

to :: Rep Record x -> Record #

Hashable Record # 

Methods

hashWithSalt :: Int -> Record -> Int #

hash :: Record -> Int #

FromJSON Record # 
NFData Record # 

Methods

rnf :: Record -> () #

type Rep Record # 
type Rep Record = D1 (MetaData "Record" "Network.AWS.CognitoSync.Types.Product" "amazonka-cognito-sync-1.4.5-6kgm8A380gaABwgTunDxt8" False) (C1 (MetaCons "Record'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_rSyncCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer))) ((:*:) (S1 (MetaSel (Just Symbol "_rDeviceLastModifiedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) (S1 (MetaSel (Just Symbol "_rLastModifiedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))))) ((:*:) (S1 (MetaSel (Just Symbol "_rValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_rKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_rLastModifiedBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

record :: Record #

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

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

rSyncCount :: Lens' Record (Maybe Integer) #

The server sync count for this record.

rDeviceLastModifiedDate :: Lens' Record (Maybe UTCTime) #

The last modified date of the client device.

rLastModifiedDate :: Lens' Record (Maybe UTCTime) #

The date on which the record was last modified.

rValue :: Lens' Record (Maybe Text) #

The value for the record.

rKey :: Lens' Record (Maybe Text) #

The key for the record.

rLastModifiedBy :: Lens' Record (Maybe Text) #

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

RecordPatch

data RecordPatch #

An update operation for a record.

See: recordPatch smart constructor.

Instances

Eq RecordPatch # 
Data RecordPatch # 

Methods

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

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

toConstr :: RecordPatch -> Constr #

dataTypeOf :: RecordPatch -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RecordPatch) #

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

gmapT :: (forall b. Data b => b -> b) -> RecordPatch -> RecordPatch #

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

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

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

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

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

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

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

Read RecordPatch # 
Show RecordPatch # 
Generic RecordPatch # 

Associated Types

type Rep RecordPatch :: * -> * #

Hashable RecordPatch # 
ToJSON RecordPatch # 
NFData RecordPatch # 

Methods

rnf :: RecordPatch -> () #

type Rep RecordPatch # 
type Rep RecordPatch = D1 (MetaData "RecordPatch" "Network.AWS.CognitoSync.Types.Product" "amazonka-cognito-sync-1.4.5-6kgm8A380gaABwgTunDxt8" False) (C1 (MetaCons "RecordPatch'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_rpDeviceLastModifiedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) (S1 (MetaSel (Just Symbol "_rpValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_rpOp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Operation)) ((:*:) (S1 (MetaSel (Just Symbol "_rpKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_rpSyncCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Integer))))))

recordPatch #

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

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

  • rpDeviceLastModifiedDate - The last modified date of the client device.
  • rpValue - The value associated with the record patch.
  • rpOp - An operation, either replace or remove.
  • rpKey - The key associated with the record patch.
  • rpSyncCount - Last known server sync count for this record. Set to 0 if unknown.

rpDeviceLastModifiedDate :: Lens' RecordPatch (Maybe UTCTime) #

The last modified date of the client device.

rpValue :: Lens' RecordPatch (Maybe Text) #

The value associated with the record patch.

rpOp :: Lens' RecordPatch Operation #

An operation, either replace or remove.

rpKey :: Lens' RecordPatch Text #

The key associated with the record patch.

rpSyncCount :: Lens' RecordPatch Integer #

Last known server sync count for this record. Set to 0 if unknown.