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

Copyright(c) 2013-2015 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.Types

Contents

Description

 

Synopsis

Service Configuration

cognitoSync :: Service Source

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

Errors

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

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

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

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

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

Indicates an internal service error.

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

Prism for InvalidConfigurationException' errors.

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

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

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

AWS Lambda throttled your account, please contact AWS Support

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

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

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

The AWS Lambda function returned invalid output or an exception.

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

Thrown if the request is throttled.

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

Thrown if there are parallel requests to modify a resource.

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

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

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

Thrown if the resource doesn't exist.

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

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

BulkPublishStatus

data BulkPublishStatus Source

Constructors

Failed 
InProgress 
NotStarted 
Succeeded 

Instances

Operation

data Operation Source

Constructors

Remove 
Replace 

Instances

Platform

data Platform Source

Constructors

ADM 
APNS 
APNSSandbox 
GCM 

Instances

StreamingStatus

data StreamingStatus Source

Constructors

Disabled 
Enabled 

Instances

CognitoStreams

data CognitoStreams Source

Configuration options for configure Cognito streams.

See: cognitoStreams smart constructor.

Instances

cognitoStreams :: CognitoStreams Source

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 :: Lens' CognitoStreams (Maybe StreamingStatus) Source

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) Source

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) Source

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 Source

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

dataset :: Dataset Source

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 :: Lens' Dataset (Maybe UTCTime) Source

Date when the dataset was last modified.

dNumRecords :: Lens' Dataset (Maybe Integer) Source

Number of records in this dataset.

dDataStorage :: Lens' Dataset (Maybe Integer) Source

Total size in bytes of the records in this dataset.

dDatasetName :: Lens' Dataset (Maybe Text) Source

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) Source

Date on which the dataset was created.

dLastModifiedBy :: Lens' Dataset (Maybe Text) Source

The device that made the last change to this dataset.

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

IdentityPoolUsage

data IdentityPoolUsage Source

Usage information for the identity pool.

See: identityPoolUsage smart constructor.

Instances

identityPoolUsage :: IdentityPoolUsage Source

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 :: Lens' IdentityPoolUsage (Maybe UTCTime) Source

Date on which the identity pool was last modified.

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

ipuDataStorage :: Lens' IdentityPoolUsage (Maybe Integer) Source

Data storage information for the identity pool.

ipuSyncSessionsCount :: Lens' IdentityPoolUsage (Maybe Integer) Source

Number of sync sessions for the identity pool.

IdentityUsage

data IdentityUsage Source

Usage information for the identity.

See: identityUsage smart constructor.

Instances

identityUsage :: IdentityUsage Source

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 :: Lens' IdentityUsage (Maybe UTCTime) Source

Date on which the identity was last modified.

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

iuDatasetCount :: Lens' IdentityUsage (Maybe Int) Source

Number of datasets for the identity.

iuDataStorage :: Lens' IdentityUsage (Maybe Integer) Source

Total data storage for this identity.

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

PushSync

data PushSync Source

Configuration options to be applied to the identity pool.

See: pushSync smart constructor.

Instances

pushSync :: PushSync Source

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 :: Lens' PushSync [Text] Source

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

psRoleARN :: Lens' PushSync (Maybe Text) Source

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

Record

data Record Source

The basic data structure of a dataset.

See: record smart constructor.

Instances

record :: Record Source

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) Source

The server sync count for this record.

rDeviceLastModifiedDate :: Lens' Record (Maybe UTCTime) Source

The last modified date of the client device.

rLastModifiedDate :: Lens' Record (Maybe UTCTime) Source

The date on which the record was last modified.

rValue :: Lens' Record (Maybe Text) Source

The value for the record.

rKey :: Lens' Record (Maybe Text) Source

The key for the record.

rLastModifiedBy :: Lens' Record (Maybe Text) Source

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

RecordPatch

data RecordPatch Source

An update operation for a record.

See: recordPatch smart constructor.

Instances

recordPatch Source

Arguments

:: Operation

rpOp

-> Text

rpKey

-> Integer

rpSyncCount

-> 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 :: Lens' RecordPatch (Maybe UTCTime) Source

The last modified date of the client device.

rpValue :: Lens' RecordPatch (Maybe Text) Source

The value associated with the record patch.

rpOp :: Lens' RecordPatch Operation Source

An operation, either replace or remove.

rpKey :: Lens' RecordPatch Text Source

The key associated with the record patch.

rpSyncCount :: Lens' RecordPatch Integer Source

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