Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Synopsis
- defaultService :: 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
- newtype BulkPublishStatus where
- BulkPublishStatus' { }
- pattern BulkPublishStatus_FAILED :: BulkPublishStatus
- pattern BulkPublishStatus_IN_PROGRESS :: BulkPublishStatus
- pattern BulkPublishStatus_NOT_STARTED :: BulkPublishStatus
- pattern BulkPublishStatus_SUCCEEDED :: BulkPublishStatus
- newtype Operation where
- Operation' { }
- pattern Operation_Remove :: Operation
- pattern Operation_Replace :: Operation
- newtype Platform where
- Platform' {
- fromPlatform :: Text
- pattern Platform_ADM :: Platform
- pattern Platform_APNS :: Platform
- pattern Platform_APNS_SANDBOX :: Platform
- pattern Platform_GCM :: Platform
- Platform' {
- newtype StreamingStatus where
- StreamingStatus' { }
- pattern StreamingStatus_DISABLED :: StreamingStatus
- pattern StreamingStatus_ENABLED :: StreamingStatus
- data CognitoStreams = CognitoStreams' {}
- newCognitoStreams :: CognitoStreams
- cognitoStreams_streamingStatus :: Lens' CognitoStreams (Maybe StreamingStatus)
- cognitoStreams_streamName :: Lens' CognitoStreams (Maybe Text)
- cognitoStreams_roleArn :: Lens' CognitoStreams (Maybe Text)
- data Dataset = Dataset' {}
- newDataset :: Dataset
- dataset_lastModifiedDate :: Lens' Dataset (Maybe UTCTime)
- dataset_numRecords :: Lens' Dataset (Maybe Integer)
- dataset_dataStorage :: Lens' Dataset (Maybe Integer)
- dataset_datasetName :: Lens' Dataset (Maybe Text)
- dataset_creationDate :: Lens' Dataset (Maybe UTCTime)
- dataset_lastModifiedBy :: Lens' Dataset (Maybe Text)
- dataset_identityId :: Lens' Dataset (Maybe Text)
- data IdentityPoolUsage = IdentityPoolUsage' {}
- newIdentityPoolUsage :: IdentityPoolUsage
- identityPoolUsage_lastModifiedDate :: Lens' IdentityPoolUsage (Maybe UTCTime)
- identityPoolUsage_identityPoolId :: Lens' IdentityPoolUsage (Maybe Text)
- identityPoolUsage_dataStorage :: Lens' IdentityPoolUsage (Maybe Integer)
- identityPoolUsage_syncSessionsCount :: Lens' IdentityPoolUsage (Maybe Integer)
- data IdentityUsage = IdentityUsage' {}
- newIdentityUsage :: IdentityUsage
- identityUsage_lastModifiedDate :: Lens' IdentityUsage (Maybe UTCTime)
- identityUsage_identityPoolId :: Lens' IdentityUsage (Maybe Text)
- identityUsage_datasetCount :: Lens' IdentityUsage (Maybe Int)
- identityUsage_dataStorage :: Lens' IdentityUsage (Maybe Integer)
- identityUsage_identityId :: Lens' IdentityUsage (Maybe Text)
- data PushSync = PushSync' {}
- newPushSync :: PushSync
- pushSync_applicationArns :: Lens' PushSync (Maybe [Text])
- pushSync_roleArn :: Lens' PushSync (Maybe Text)
- data Record = Record' {}
- newRecord :: Record
- record_syncCount :: Lens' Record (Maybe Integer)
- record_deviceLastModifiedDate :: Lens' Record (Maybe UTCTime)
- record_lastModifiedDate :: Lens' Record (Maybe UTCTime)
- record_value :: Lens' Record (Maybe Text)
- record_key :: Lens' Record (Maybe Text)
- record_lastModifiedBy :: Lens' Record (Maybe Text)
- data RecordPatch = RecordPatch' {}
- newRecordPatch :: Operation -> Text -> Integer -> RecordPatch
- recordPatch_deviceLastModifiedDate :: Lens' RecordPatch (Maybe UTCTime)
- recordPatch_value :: Lens' RecordPatch (Maybe Text)
- recordPatch_op :: Lens' RecordPatch Operation
- recordPatch_key :: Lens' RecordPatch Text
- recordPatch_syncCount :: Lens' RecordPatch Integer
Service Configuration
defaultService :: 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
newtype BulkPublishStatus Source #
pattern BulkPublishStatus_FAILED :: BulkPublishStatus | |
pattern BulkPublishStatus_IN_PROGRESS :: BulkPublishStatus | |
pattern BulkPublishStatus_NOT_STARTED :: BulkPublishStatus | |
pattern BulkPublishStatus_SUCCEEDED :: BulkPublishStatus |
Instances
Operation
pattern Operation_Remove :: Operation | |
pattern Operation_Replace :: Operation |
Instances
Platform
pattern Platform_ADM :: Platform | |
pattern Platform_APNS :: Platform | |
pattern Platform_APNS_SANDBOX :: Platform | |
pattern Platform_GCM :: Platform |
Instances
StreamingStatus
newtype StreamingStatus Source #
pattern StreamingStatus_DISABLED :: StreamingStatus | |
pattern StreamingStatus_ENABLED :: StreamingStatus |
Instances
CognitoStreams
data CognitoStreams Source #
Configuration options for configure Cognito streams.
See: newCognitoStreams
smart constructor.
CognitoStreams' | |
|
Instances
newCognitoStreams :: CognitoStreams Source #
Create a value of CognitoStreams
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:streamingStatus:CognitoStreams'
, cognitoStreams_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.
$sel:streamName:CognitoStreams'
, cognitoStreams_streamName
- 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.
$sel:roleArn:CognitoStreams'
, cognitoStreams_roleArn
- 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.
cognitoStreams_streamingStatus :: 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.
cognitoStreams_streamName :: 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.
cognitoStreams_roleArn :: 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: newDataset
smart constructor.
Dataset' | |
|
Instances
newDataset :: Dataset Source #
Create a value of Dataset
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastModifiedDate:Dataset'
, dataset_lastModifiedDate
- Date when the dataset was last modified.
$sel:numRecords:Dataset'
, dataset_numRecords
- Number of records in this dataset.
$sel:dataStorage:Dataset'
, dataset_dataStorage
- Total size in bytes of the records in this dataset.
$sel:datasetName:Dataset'
, dataset_datasetName
- A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9,
'_' (underscore), '-' (dash), and '.' (dot).
$sel:creationDate:Dataset'
, dataset_creationDate
- Date on which the dataset was created.
$sel:lastModifiedBy:Dataset'
, dataset_lastModifiedBy
- The device that made the last change to this dataset.
$sel:identityId:Dataset'
, dataset_identityId
- 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.
dataset_lastModifiedDate :: Lens' Dataset (Maybe UTCTime) Source #
Date when the dataset was last modified.
dataset_dataStorage :: Lens' Dataset (Maybe Integer) Source #
Total size in bytes of the records in this dataset.
dataset_datasetName :: 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).
dataset_creationDate :: Lens' Dataset (Maybe UTCTime) Source #
Date on which the dataset was created.
dataset_lastModifiedBy :: Lens' Dataset (Maybe Text) Source #
The device that made the last change to this dataset.
dataset_identityId :: 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: newIdentityPoolUsage
smart constructor.
IdentityPoolUsage' | |
|
Instances
newIdentityPoolUsage :: IdentityPoolUsage Source #
Create a value of IdentityPoolUsage
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastModifiedDate:IdentityPoolUsage'
, identityPoolUsage_lastModifiedDate
- Date on which the identity pool was last modified.
$sel:identityPoolId:IdentityPoolUsage'
, identityPoolUsage_identityPoolId
- 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.
$sel:dataStorage:IdentityPoolUsage'
, identityPoolUsage_dataStorage
- Data storage information for the identity pool.
$sel:syncSessionsCount:IdentityPoolUsage'
, identityPoolUsage_syncSessionsCount
- Number of sync sessions for the identity pool.
identityPoolUsage_lastModifiedDate :: Lens' IdentityPoolUsage (Maybe UTCTime) Source #
Date on which the identity pool was last modified.
identityPoolUsage_identityPoolId :: 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.
identityPoolUsage_dataStorage :: Lens' IdentityPoolUsage (Maybe Integer) Source #
Data storage information for the identity pool.
identityPoolUsage_syncSessionsCount :: Lens' IdentityPoolUsage (Maybe Integer) Source #
Number of sync sessions for the identity pool.
IdentityUsage
data IdentityUsage Source #
Usage information for the identity.
See: newIdentityUsage
smart constructor.
IdentityUsage' | |
|
Instances
newIdentityUsage :: IdentityUsage Source #
Create a value of IdentityUsage
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastModifiedDate:IdentityUsage'
, identityUsage_lastModifiedDate
- Date on which the identity was last modified.
$sel:identityPoolId:IdentityUsage'
, identityUsage_identityPoolId
- 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.
$sel:datasetCount:IdentityUsage'
, identityUsage_datasetCount
- Number of datasets for the identity.
$sel:dataStorage:IdentityUsage'
, identityUsage_dataStorage
- Total data storage for this identity.
$sel:identityId:IdentityUsage'
, identityUsage_identityId
- 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.
identityUsage_lastModifiedDate :: Lens' IdentityUsage (Maybe UTCTime) Source #
Date on which the identity was last modified.
identityUsage_identityPoolId :: 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.
identityUsage_datasetCount :: Lens' IdentityUsage (Maybe Int) Source #
Number of datasets for the identity.
identityUsage_dataStorage :: Lens' IdentityUsage (Maybe Integer) Source #
Total data storage for this identity.
identityUsage_identityId :: 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: newPushSync
smart constructor.
Instances
Eq PushSync Source # | |
Read PushSync Source # | |
Show PushSync Source # | |
Generic PushSync Source # | |
NFData PushSync Source # | |
Defined in Amazonka.CognitoSync.Types.PushSync | |
Hashable PushSync Source # | |
Defined in Amazonka.CognitoSync.Types.PushSync | |
ToJSON PushSync Source # | |
Defined in Amazonka.CognitoSync.Types.PushSync | |
FromJSON PushSync Source # | |
type Rep PushSync Source # | |
Defined in Amazonka.CognitoSync.Types.PushSync type Rep PushSync = D1 ('MetaData "PushSync" "Amazonka.CognitoSync.Types.PushSync" "libZSservicesZSamazonka-cognito-syncZSamazonka-cognito-sync" 'False) (C1 ('MetaCons "PushSync'" 'PrefixI 'True) (S1 ('MetaSel ('Just "applicationArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
newPushSync :: PushSync Source #
Create a value of PushSync
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationArns:PushSync'
, pushSync_applicationArns
- List of SNS platform application ARNs that could be used by clients.
$sel:roleArn:PushSync'
, pushSync_roleArn
- A role configured to allow Cognito to call SNS on behalf of the
developer.
pushSync_applicationArns :: Lens' PushSync (Maybe [Text]) Source #
List of SNS platform application ARNs that could be used by clients.
pushSync_roleArn :: 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: newRecord
smart constructor.
Record' | |
|
Instances
Create a value of Record
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:syncCount:Record'
, record_syncCount
- The server sync count for this record.
$sel:deviceLastModifiedDate:Record'
, record_deviceLastModifiedDate
- The last modified date of the client device.
$sel:lastModifiedDate:Record'
, record_lastModifiedDate
- The date on which the record was last modified.
$sel:value:Record'
, record_value
- The value for the record.
$sel:key:Record'
, record_key
- The key for the record.
$sel:lastModifiedBy:Record'
, record_lastModifiedBy
- The user/device that made the last change to this record.
record_deviceLastModifiedDate :: Lens' Record (Maybe UTCTime) Source #
The last modified date of the client device.
record_lastModifiedDate :: Lens' Record (Maybe UTCTime) Source #
The date on which the record was last modified.
record_lastModifiedBy :: 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: newRecordPatch
smart constructor.
RecordPatch' | |
|
Instances
:: Operation | |
-> Text | |
-> Integer | |
-> RecordPatch |
Create a value of RecordPatch
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deviceLastModifiedDate:RecordPatch'
, recordPatch_deviceLastModifiedDate
- The last modified date of the client device.
$sel:value:RecordPatch'
, recordPatch_value
- The value associated with the record patch.
$sel:op:RecordPatch'
, recordPatch_op
- An operation, either replace or remove.
$sel:key:RecordPatch'
, recordPatch_key
- The key associated with the record patch.
$sel:syncCount:RecordPatch'
, recordPatch_syncCount
- Last known server sync count for this record. Set to 0 if unknown.
recordPatch_deviceLastModifiedDate :: Lens' RecordPatch (Maybe UTCTime) Source #
The last modified date of the client device.
recordPatch_value :: Lens' RecordPatch (Maybe Text) Source #
The value associated with the record patch.
recordPatch_op :: Lens' RecordPatch Operation Source #
An operation, either replace or remove.
recordPatch_key :: Lens' RecordPatch Text Source #
The key associated with the record patch.
recordPatch_syncCount :: Lens' RecordPatch Integer Source #
Last known server sync count for this record. Set to 0 if unknown.