Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- cognitoSync :: Service
- _InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError
- _NotAuthorizedException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalErrorException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidConfigurationException :: AsError a => Getting (First ServiceError) a ServiceError
- _DuplicateRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _LambdaThrottledException :: AsError a => Getting (First ServiceError) a ServiceError
- _AlreadyStreamedException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidLambdaFunctionOutputException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceConflictException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- data BulkPublishStatus
- data Operation
- data Platform
- = ADM
- | APNS
- | APNSSandbox
- | GCM
- data StreamingStatus
- data CognitoStreams
- cognitoStreams :: CognitoStreams
- csStreamingStatus :: Lens' CognitoStreams (Maybe StreamingStatus)
- csStreamName :: Lens' CognitoStreams (Maybe Text)
- csRoleARN :: Lens' CognitoStreams (Maybe Text)
- data Dataset
- dataset :: Dataset
- dLastModifiedDate :: Lens' Dataset (Maybe UTCTime)
- dNumRecords :: Lens' Dataset (Maybe Integer)
- dDataStorage :: Lens' Dataset (Maybe Integer)
- dDatasetName :: Lens' Dataset (Maybe Text)
- dCreationDate :: Lens' Dataset (Maybe UTCTime)
- dLastModifiedBy :: Lens' Dataset (Maybe Text)
- dIdentityId :: Lens' Dataset (Maybe Text)
- data IdentityPoolUsage
- identityPoolUsage :: IdentityPoolUsage
- ipuLastModifiedDate :: Lens' IdentityPoolUsage (Maybe UTCTime)
- ipuIdentityPoolId :: Lens' IdentityPoolUsage (Maybe Text)
- ipuDataStorage :: Lens' IdentityPoolUsage (Maybe Integer)
- ipuSyncSessionsCount :: Lens' IdentityPoolUsage (Maybe Integer)
- data IdentityUsage
- identityUsage :: IdentityUsage
- iuLastModifiedDate :: Lens' IdentityUsage (Maybe UTCTime)
- iuIdentityPoolId :: Lens' IdentityUsage (Maybe Text)
- iuDatasetCount :: Lens' IdentityUsage (Maybe Int)
- iuDataStorage :: Lens' IdentityUsage (Maybe Integer)
- iuIdentityId :: Lens' IdentityUsage (Maybe Text)
- data PushSync
- pushSync :: PushSync
- psApplicationARNs :: Lens' PushSync [Text]
- psRoleARN :: Lens' PushSync (Maybe Text)
- data Record
- record :: Record
- rSyncCount :: Lens' Record (Maybe Integer)
- rDeviceLastModifiedDate :: Lens' Record (Maybe UTCTime)
- rLastModifiedDate :: Lens' Record (Maybe UTCTime)
- rValue :: Lens' Record (Maybe Text)
- rKey :: Lens' Record (Maybe Text)
- rLastModifiedBy :: Lens' Record (Maybe Text)
- data RecordPatch
- recordPatch :: Operation -> Text -> Integer -> RecordPatch
- rpDeviceLastModifiedDate :: Lens' RecordPatch (Maybe UTCTime)
- rpValue :: Lens' RecordPatch (Maybe Text)
- rpOp :: Lens' RecordPatch Operation
- rpKey :: Lens' RecordPatch Text
- rpSyncCount :: Lens' RecordPatch Integer
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 #
Operation
Platform
StreamingStatus
data StreamingStatus Source #
CognitoStreams
data CognitoStreams Source #
Configuration options for configure Cognito streams.
See: cognitoStreams
smart constructor.
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
- 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) 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
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.
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.
dDataStorage :: Lens' Dataset (Maybe Integer) Source #
Total size in bytes of the records in this dataset.
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.
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
- 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) 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.
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
- 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) 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
Configuration options to be applied to the identity pool.
See: pushSync
smart constructor.
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] 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
The basic data structure of a dataset.
See: record
smart constructor.
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
- The server sync count for this record.rDeviceLastModifiedDate
- The last modified date of the client device.rLastModifiedDate
- The date on which the record was last modified.rValue
- The value for the record.rKey
- The key for the record.rLastModifiedBy
- The user/device that made the last change to 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.
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.
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) Source #
The last modified date of the client device.
rpSyncCount :: Lens' RecordPatch Integer Source #
Last known server sync count for this record. Set to 0 if unknown.