| 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 |
Amazonka.CognitoSync.Lens
Contents
- Operations
- DescribeDataset
- SetCognitoEvents
- DescribeIdentityPoolUsage
- GetBulkPublishDetails
- ListIdentityPoolUsage
- SetIdentityPoolConfiguration
- DeleteDataset
- GetCognitoEvents
- DescribeIdentityUsage
- RegisterDevice
- SubscribeToDataset
- GetIdentityPoolConfiguration
- ListRecords
- UnsubscribeFromDataset
- UpdateRecords
- ListDatasets
- BulkPublish
- Types
Description
Synopsis
- describeDataset_identityPoolId :: Lens' DescribeDataset Text
- describeDataset_identityId :: Lens' DescribeDataset Text
- describeDataset_datasetName :: Lens' DescribeDataset Text
- describeDatasetResponse_dataset :: Lens' DescribeDatasetResponse (Maybe Dataset)
- describeDatasetResponse_httpStatus :: Lens' DescribeDatasetResponse Int
- setCognitoEvents_identityPoolId :: Lens' SetCognitoEvents Text
- setCognitoEvents_events :: Lens' SetCognitoEvents (HashMap Text Text)
- describeIdentityPoolUsage_identityPoolId :: Lens' DescribeIdentityPoolUsage Text
- describeIdentityPoolUsageResponse_identityPoolUsage :: Lens' DescribeIdentityPoolUsageResponse (Maybe IdentityPoolUsage)
- describeIdentityPoolUsageResponse_httpStatus :: Lens' DescribeIdentityPoolUsageResponse Int
- getBulkPublishDetails_identityPoolId :: Lens' GetBulkPublishDetails Text
- getBulkPublishDetailsResponse_bulkPublishStartTime :: Lens' GetBulkPublishDetailsResponse (Maybe UTCTime)
- getBulkPublishDetailsResponse_identityPoolId :: Lens' GetBulkPublishDetailsResponse (Maybe Text)
- getBulkPublishDetailsResponse_bulkPublishCompleteTime :: Lens' GetBulkPublishDetailsResponse (Maybe UTCTime)
- getBulkPublishDetailsResponse_failureMessage :: Lens' GetBulkPublishDetailsResponse (Maybe Text)
- getBulkPublishDetailsResponse_bulkPublishStatus :: Lens' GetBulkPublishDetailsResponse (Maybe BulkPublishStatus)
- getBulkPublishDetailsResponse_httpStatus :: Lens' GetBulkPublishDetailsResponse Int
- listIdentityPoolUsage_nextToken :: Lens' ListIdentityPoolUsage (Maybe Text)
- listIdentityPoolUsage_maxResults :: Lens' ListIdentityPoolUsage (Maybe Int)
- listIdentityPoolUsageResponse_identityPoolUsages :: Lens' ListIdentityPoolUsageResponse (Maybe [IdentityPoolUsage])
- listIdentityPoolUsageResponse_count :: Lens' ListIdentityPoolUsageResponse (Maybe Int)
- listIdentityPoolUsageResponse_nextToken :: Lens' ListIdentityPoolUsageResponse (Maybe Text)
- listIdentityPoolUsageResponse_maxResults :: Lens' ListIdentityPoolUsageResponse (Maybe Int)
- listIdentityPoolUsageResponse_httpStatus :: Lens' ListIdentityPoolUsageResponse Int
- setIdentityPoolConfiguration_cognitoStreams :: Lens' SetIdentityPoolConfiguration (Maybe CognitoStreams)
- setIdentityPoolConfiguration_pushSync :: Lens' SetIdentityPoolConfiguration (Maybe PushSync)
- setIdentityPoolConfiguration_identityPoolId :: Lens' SetIdentityPoolConfiguration Text
- setIdentityPoolConfigurationResponse_identityPoolId :: Lens' SetIdentityPoolConfigurationResponse (Maybe Text)
- setIdentityPoolConfigurationResponse_cognitoStreams :: Lens' SetIdentityPoolConfigurationResponse (Maybe CognitoStreams)
- setIdentityPoolConfigurationResponse_pushSync :: Lens' SetIdentityPoolConfigurationResponse (Maybe PushSync)
- setIdentityPoolConfigurationResponse_httpStatus :: Lens' SetIdentityPoolConfigurationResponse Int
- deleteDataset_identityPoolId :: Lens' DeleteDataset Text
- deleteDataset_identityId :: Lens' DeleteDataset Text
- deleteDataset_datasetName :: Lens' DeleteDataset Text
- deleteDatasetResponse_dataset :: Lens' DeleteDatasetResponse (Maybe Dataset)
- deleteDatasetResponse_httpStatus :: Lens' DeleteDatasetResponse Int
- getCognitoEvents_identityPoolId :: Lens' GetCognitoEvents Text
- getCognitoEventsResponse_events :: Lens' GetCognitoEventsResponse (Maybe (HashMap Text Text))
- getCognitoEventsResponse_httpStatus :: Lens' GetCognitoEventsResponse Int
- describeIdentityUsage_identityPoolId :: Lens' DescribeIdentityUsage Text
- describeIdentityUsage_identityId :: Lens' DescribeIdentityUsage Text
- describeIdentityUsageResponse_identityUsage :: Lens' DescribeIdentityUsageResponse (Maybe IdentityUsage)
- describeIdentityUsageResponse_httpStatus :: Lens' DescribeIdentityUsageResponse Int
- registerDevice_identityPoolId :: Lens' RegisterDevice Text
- registerDevice_identityId :: Lens' RegisterDevice Text
- registerDevice_platform :: Lens' RegisterDevice Platform
- registerDevice_token :: Lens' RegisterDevice Text
- registerDeviceResponse_deviceId :: Lens' RegisterDeviceResponse (Maybe Text)
- registerDeviceResponse_httpStatus :: Lens' RegisterDeviceResponse Int
- subscribeToDataset_identityPoolId :: Lens' SubscribeToDataset Text
- subscribeToDataset_identityId :: Lens' SubscribeToDataset Text
- subscribeToDataset_datasetName :: Lens' SubscribeToDataset Text
- subscribeToDataset_deviceId :: Lens' SubscribeToDataset Text
- subscribeToDatasetResponse_httpStatus :: Lens' SubscribeToDatasetResponse Int
- getIdentityPoolConfiguration_identityPoolId :: Lens' GetIdentityPoolConfiguration Text
- getIdentityPoolConfigurationResponse_identityPoolId :: Lens' GetIdentityPoolConfigurationResponse (Maybe Text)
- getIdentityPoolConfigurationResponse_cognitoStreams :: Lens' GetIdentityPoolConfigurationResponse (Maybe CognitoStreams)
- getIdentityPoolConfigurationResponse_pushSync :: Lens' GetIdentityPoolConfigurationResponse (Maybe PushSync)
- getIdentityPoolConfigurationResponse_httpStatus :: Lens' GetIdentityPoolConfigurationResponse Int
- listRecords_lastSyncCount :: Lens' ListRecords (Maybe Integer)
- listRecords_nextToken :: Lens' ListRecords (Maybe Text)
- listRecords_syncSessionToken :: Lens' ListRecords (Maybe Text)
- listRecords_maxResults :: Lens' ListRecords (Maybe Int)
- listRecords_identityPoolId :: Lens' ListRecords Text
- listRecords_identityId :: Lens' ListRecords Text
- listRecords_datasetName :: Lens' ListRecords Text
- listRecordsResponse_datasetDeletedAfterRequestedSyncCount :: Lens' ListRecordsResponse (Maybe Bool)
- listRecordsResponse_datasetExists :: Lens' ListRecordsResponse (Maybe Bool)
- listRecordsResponse_count :: Lens' ListRecordsResponse (Maybe Int)
- listRecordsResponse_records :: Lens' ListRecordsResponse (Maybe [Record])
- listRecordsResponse_nextToken :: Lens' ListRecordsResponse (Maybe Text)
- listRecordsResponse_mergedDatasetNames :: Lens' ListRecordsResponse (Maybe [Text])
- listRecordsResponse_syncSessionToken :: Lens' ListRecordsResponse (Maybe Text)
- listRecordsResponse_lastModifiedBy :: Lens' ListRecordsResponse (Maybe Text)
- listRecordsResponse_datasetSyncCount :: Lens' ListRecordsResponse (Maybe Integer)
- listRecordsResponse_httpStatus :: Lens' ListRecordsResponse Int
- unsubscribeFromDataset_identityPoolId :: Lens' UnsubscribeFromDataset Text
- unsubscribeFromDataset_identityId :: Lens' UnsubscribeFromDataset Text
- unsubscribeFromDataset_datasetName :: Lens' UnsubscribeFromDataset Text
- unsubscribeFromDataset_deviceId :: Lens' UnsubscribeFromDataset Text
- unsubscribeFromDatasetResponse_httpStatus :: Lens' UnsubscribeFromDatasetResponse Int
- updateRecords_recordPatches :: Lens' UpdateRecords (Maybe [RecordPatch])
- updateRecords_deviceId :: Lens' UpdateRecords (Maybe Text)
- updateRecords_clientContext :: Lens' UpdateRecords (Maybe Text)
- updateRecords_identityPoolId :: Lens' UpdateRecords Text
- updateRecords_identityId :: Lens' UpdateRecords Text
- updateRecords_datasetName :: Lens' UpdateRecords Text
- updateRecords_syncSessionToken :: Lens' UpdateRecords Text
- updateRecordsResponse_records :: Lens' UpdateRecordsResponse (Maybe [Record])
- updateRecordsResponse_httpStatus :: Lens' UpdateRecordsResponse Int
- listDatasets_nextToken :: Lens' ListDatasets (Maybe Text)
- listDatasets_maxResults :: Lens' ListDatasets (Maybe Int)
- listDatasets_identityId :: Lens' ListDatasets Text
- listDatasets_identityPoolId :: Lens' ListDatasets Text
- listDatasetsResponse_count :: Lens' ListDatasetsResponse (Maybe Int)
- listDatasetsResponse_nextToken :: Lens' ListDatasetsResponse (Maybe Text)
- listDatasetsResponse_datasets :: Lens' ListDatasetsResponse (Maybe [Dataset])
- listDatasetsResponse_httpStatus :: Lens' ListDatasetsResponse Int
- bulkPublish_identityPoolId :: Lens' BulkPublish Text
- bulkPublishResponse_identityPoolId :: Lens' BulkPublishResponse (Maybe Text)
- bulkPublishResponse_httpStatus :: Lens' BulkPublishResponse Int
- cognitoStreams_streamingStatus :: Lens' CognitoStreams (Maybe StreamingStatus)
- cognitoStreams_streamName :: Lens' CognitoStreams (Maybe Text)
- cognitoStreams_roleArn :: Lens' CognitoStreams (Maybe Text)
- 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)
- identityPoolUsage_lastModifiedDate :: Lens' IdentityPoolUsage (Maybe UTCTime)
- identityPoolUsage_identityPoolId :: Lens' IdentityPoolUsage (Maybe Text)
- identityPoolUsage_dataStorage :: Lens' IdentityPoolUsage (Maybe Integer)
- identityPoolUsage_syncSessionsCount :: Lens' IdentityPoolUsage (Maybe Integer)
- 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)
- pushSync_applicationArns :: Lens' PushSync (Maybe [Text])
- pushSync_roleArn :: Lens' PushSync (Maybe Text)
- 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)
- 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
Operations
DescribeDataset
describeDataset_identityPoolId :: Lens' DescribeDataset 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.
describeDataset_identityId :: Lens' DescribeDataset 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.
describeDataset_datasetName :: Lens' DescribeDataset Text Source #
A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).
describeDatasetResponse_dataset :: Lens' DescribeDatasetResponse (Maybe Dataset) Source #
Meta data for a collection of data for an identity. An identity can have multiple datasets. A dataset 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.
describeDatasetResponse_httpStatus :: Lens' DescribeDatasetResponse Int Source #
The response's http status code.
SetCognitoEvents
setCognitoEvents_identityPoolId :: Lens' SetCognitoEvents Text Source #
The Cognito Identity Pool to use when configuring Cognito Events
setCognitoEvents_events :: Lens' SetCognitoEvents (HashMap Text Text) Source #
The events to configure
DescribeIdentityPoolUsage
describeIdentityPoolUsage_identityPoolId :: Lens' DescribeIdentityPoolUsage 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.
describeIdentityPoolUsageResponse_identityPoolUsage :: Lens' DescribeIdentityPoolUsageResponse (Maybe IdentityPoolUsage) Source #
Information about the usage of the identity pool.
describeIdentityPoolUsageResponse_httpStatus :: Lens' DescribeIdentityPoolUsageResponse Int Source #
The response's http status code.
GetBulkPublishDetails
getBulkPublishDetails_identityPoolId :: Lens' GetBulkPublishDetails 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.
getBulkPublishDetailsResponse_bulkPublishStartTime :: Lens' GetBulkPublishDetailsResponse (Maybe UTCTime) Source #
The date/time at which the last bulk publish was initiated.
getBulkPublishDetailsResponse_identityPoolId :: Lens' GetBulkPublishDetailsResponse (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.
getBulkPublishDetailsResponse_bulkPublishCompleteTime :: Lens' GetBulkPublishDetailsResponse (Maybe UTCTime) Source #
If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed.
getBulkPublishDetailsResponse_failureMessage :: Lens' GetBulkPublishDetailsResponse (Maybe Text) Source #
If BulkPublishStatus is FAILED this field will contain the error message that caused the bulk publish to fail.
getBulkPublishDetailsResponse_bulkPublishStatus :: Lens' GetBulkPublishDetailsResponse (Maybe BulkPublishStatus) Source #
Status of the last bulk publish operation, valid values are:
NOT_STARTED - No bulk publish has been requested for this identity pool
IN_PROGRESS - Data is being published to the configured stream
SUCCEEDED - All data for the identity pool has been published to the configured stream
FAILED - Some portion of the data has failed to publish, check FailureMessage for the cause.
getBulkPublishDetailsResponse_httpStatus :: Lens' GetBulkPublishDetailsResponse Int Source #
The response's http status code.
ListIdentityPoolUsage
listIdentityPoolUsage_nextToken :: Lens' ListIdentityPoolUsage (Maybe Text) Source #
A pagination token for obtaining the next page of results.
listIdentityPoolUsage_maxResults :: Lens' ListIdentityPoolUsage (Maybe Int) Source #
The maximum number of results to be returned.
listIdentityPoolUsageResponse_identityPoolUsages :: Lens' ListIdentityPoolUsageResponse (Maybe [IdentityPoolUsage]) Source #
Usage information for the identity pools.
listIdentityPoolUsageResponse_count :: Lens' ListIdentityPoolUsageResponse (Maybe Int) Source #
Total number of identities for the identity pool.
listIdentityPoolUsageResponse_nextToken :: Lens' ListIdentityPoolUsageResponse (Maybe Text) Source #
A pagination token for obtaining the next page of results.
listIdentityPoolUsageResponse_maxResults :: Lens' ListIdentityPoolUsageResponse (Maybe Int) Source #
The maximum number of results to be returned.
listIdentityPoolUsageResponse_httpStatus :: Lens' ListIdentityPoolUsageResponse Int Source #
The response's http status code.
SetIdentityPoolConfiguration
setIdentityPoolConfiguration_cognitoStreams :: Lens' SetIdentityPoolConfiguration (Maybe CognitoStreams) Source #
Options to apply to this identity pool for Amazon Cognito streams.
setIdentityPoolConfiguration_pushSync :: Lens' SetIdentityPoolConfiguration (Maybe PushSync) Source #
Options to apply to this identity pool for push synchronization.
setIdentityPoolConfiguration_identityPoolId :: Lens' SetIdentityPoolConfiguration Text Source #
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool to modify.
setIdentityPoolConfigurationResponse_identityPoolId :: Lens' SetIdentityPoolConfigurationResponse (Maybe Text) Source #
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
setIdentityPoolConfigurationResponse_cognitoStreams :: Lens' SetIdentityPoolConfigurationResponse (Maybe CognitoStreams) Source #
Options to apply to this identity pool for Amazon Cognito streams.
setIdentityPoolConfigurationResponse_pushSync :: Lens' SetIdentityPoolConfigurationResponse (Maybe PushSync) Source #
Options to apply to this identity pool for push synchronization.
setIdentityPoolConfigurationResponse_httpStatus :: Lens' SetIdentityPoolConfigurationResponse Int Source #
The response's http status code.
DeleteDataset
deleteDataset_identityPoolId :: Lens' DeleteDataset 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.
deleteDataset_identityId :: Lens' DeleteDataset 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.
deleteDataset_datasetName :: Lens' DeleteDataset Text Source #
A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).
deleteDatasetResponse_dataset :: Lens' DeleteDatasetResponse (Maybe 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.
deleteDatasetResponse_httpStatus :: Lens' DeleteDatasetResponse Int Source #
The response's http status code.
GetCognitoEvents
getCognitoEvents_identityPoolId :: Lens' GetCognitoEvents Text Source #
The Cognito Identity Pool ID for the request
getCognitoEventsResponse_events :: Lens' GetCognitoEventsResponse (Maybe (HashMap Text Text)) Source #
The Cognito Events returned from the GetCognitoEvents request
getCognitoEventsResponse_httpStatus :: Lens' GetCognitoEventsResponse Int Source #
The response's http status code.
DescribeIdentityUsage
describeIdentityUsage_identityPoolId :: Lens' DescribeIdentityUsage 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.
describeIdentityUsage_identityId :: Lens' DescribeIdentityUsage 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.
describeIdentityUsageResponse_identityUsage :: Lens' DescribeIdentityUsageResponse (Maybe IdentityUsage) Source #
Usage information for the identity.
describeIdentityUsageResponse_httpStatus :: Lens' DescribeIdentityUsageResponse Int Source #
The response's http status code.
RegisterDevice
registerDevice_identityPoolId :: Lens' RegisterDevice Text Source #
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. Here, the ID of the pool that the identity belongs to.
registerDevice_identityId :: Lens' RegisterDevice Text Source #
The unique ID for this identity.
registerDevice_platform :: Lens' RegisterDevice Platform Source #
The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX).
registerDevice_token :: Lens' RegisterDevice Text Source #
The push token.
registerDeviceResponse_deviceId :: Lens' RegisterDeviceResponse (Maybe Text) Source #
The unique ID generated for this device by Cognito.
registerDeviceResponse_httpStatus :: Lens' RegisterDeviceResponse Int Source #
The response's http status code.
SubscribeToDataset
subscribeToDataset_identityPoolId :: Lens' SubscribeToDataset Text Source #
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The ID of the pool to which the identity belongs.
subscribeToDataset_identityId :: Lens' SubscribeToDataset Text Source #
Unique ID for this identity.
subscribeToDataset_datasetName :: Lens' SubscribeToDataset Text Source #
The name of the dataset to subcribe to.
subscribeToDataset_deviceId :: Lens' SubscribeToDataset Text Source #
The unique ID generated for this device by Cognito.
subscribeToDatasetResponse_httpStatus :: Lens' SubscribeToDatasetResponse Int Source #
The response's http status code.
GetIdentityPoolConfiguration
getIdentityPoolConfiguration_identityPoolId :: Lens' GetIdentityPoolConfiguration Text Source #
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool for which to return a configuration.
getIdentityPoolConfigurationResponse_identityPoolId :: Lens' GetIdentityPoolConfigurationResponse (Maybe Text) Source #
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
getIdentityPoolConfigurationResponse_cognitoStreams :: Lens' GetIdentityPoolConfigurationResponse (Maybe CognitoStreams) Source #
Options to apply to this identity pool for Amazon Cognito streams.
getIdentityPoolConfigurationResponse_pushSync :: Lens' GetIdentityPoolConfigurationResponse (Maybe PushSync) Source #
Options to apply to this identity pool for push synchronization.
getIdentityPoolConfigurationResponse_httpStatus :: Lens' GetIdentityPoolConfigurationResponse Int Source #
The response's http status code.
ListRecords
listRecords_lastSyncCount :: Lens' ListRecords (Maybe Integer) Source #
The last server sync count for this record.
listRecords_nextToken :: Lens' ListRecords (Maybe Text) Source #
A pagination token for obtaining the next page of results.
listRecords_syncSessionToken :: Lens' ListRecords (Maybe Text) Source #
A token containing a session ID, identity ID, and expiration.
listRecords_maxResults :: Lens' ListRecords (Maybe Int) Source #
The maximum number of results to be returned.
listRecords_identityPoolId :: Lens' ListRecords 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.
listRecords_identityId :: Lens' ListRecords 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.
listRecords_datasetName :: Lens' ListRecords Text Source #
A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).
listRecordsResponse_datasetDeletedAfterRequestedSyncCount :: Lens' ListRecordsResponse (Maybe Bool) Source #
A boolean value specifying whether to delete the dataset locally.
listRecordsResponse_datasetExists :: Lens' ListRecordsResponse (Maybe Bool) Source #
Indicates whether the dataset exists.
listRecordsResponse_count :: Lens' ListRecordsResponse (Maybe Int) Source #
Total number of records.
listRecordsResponse_records :: Lens' ListRecordsResponse (Maybe [Record]) Source #
A list of all records.
listRecordsResponse_nextToken :: Lens' ListRecordsResponse (Maybe Text) Source #
A pagination token for obtaining the next page of results.
listRecordsResponse_mergedDatasetNames :: Lens' ListRecordsResponse (Maybe [Text]) Source #
Names of merged datasets.
listRecordsResponse_syncSessionToken :: Lens' ListRecordsResponse (Maybe Text) Source #
A token containing a session ID, identity ID, and expiration.
listRecordsResponse_lastModifiedBy :: Lens' ListRecordsResponse (Maybe Text) Source #
The user/device that made the last change to this record.
listRecordsResponse_datasetSyncCount :: Lens' ListRecordsResponse (Maybe Integer) Source #
Server sync count for this dataset.
listRecordsResponse_httpStatus :: Lens' ListRecordsResponse Int Source #
The response's http status code.
UnsubscribeFromDataset
unsubscribeFromDataset_identityPoolId :: Lens' UnsubscribeFromDataset Text Source #
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The ID of the pool to which this identity belongs.
unsubscribeFromDataset_identityId :: Lens' UnsubscribeFromDataset Text Source #
Unique ID for this identity.
unsubscribeFromDataset_datasetName :: Lens' UnsubscribeFromDataset Text Source #
The name of the dataset from which to unsubcribe.
unsubscribeFromDataset_deviceId :: Lens' UnsubscribeFromDataset Text Source #
The unique ID generated for this device by Cognito.
unsubscribeFromDatasetResponse_httpStatus :: Lens' UnsubscribeFromDatasetResponse Int Source #
The response's http status code.
UpdateRecords
updateRecords_recordPatches :: Lens' UpdateRecords (Maybe [RecordPatch]) Source #
A list of patch operations.
updateRecords_deviceId :: Lens' UpdateRecords (Maybe Text) Source #
The unique ID generated for this device by Cognito.
updateRecords_clientContext :: Lens' UpdateRecords (Maybe Text) Source #
Intended to supply a device ID that will populate the lastModifiedBy field referenced in other methods. The ClientContext field is not yet implemented.
updateRecords_identityPoolId :: Lens' UpdateRecords 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.
updateRecords_identityId :: Lens' UpdateRecords 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.
updateRecords_datasetName :: Lens' UpdateRecords Text Source #
A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).
updateRecords_syncSessionToken :: Lens' UpdateRecords Text Source #
The SyncSessionToken returned by a previous call to ListRecords for this dataset and identity.
updateRecordsResponse_records :: Lens' UpdateRecordsResponse (Maybe [Record]) Source #
A list of records that have been updated.
updateRecordsResponse_httpStatus :: Lens' UpdateRecordsResponse Int Source #
The response's http status code.
ListDatasets
listDatasets_nextToken :: Lens' ListDatasets (Maybe Text) Source #
A pagination token for obtaining the next page of results.
listDatasets_maxResults :: Lens' ListDatasets (Maybe Int) Source #
The maximum number of results to be returned.
listDatasets_identityId :: Lens' ListDatasets 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.
listDatasets_identityPoolId :: Lens' ListDatasets 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.
listDatasetsResponse_count :: Lens' ListDatasetsResponse (Maybe Int) Source #
Number of datasets returned.
listDatasetsResponse_nextToken :: Lens' ListDatasetsResponse (Maybe Text) Source #
A pagination token for obtaining the next page of results.
listDatasetsResponse_datasets :: Lens' ListDatasetsResponse (Maybe [Dataset]) Source #
A set of datasets.
listDatasetsResponse_httpStatus :: Lens' ListDatasetsResponse Int Source #
The response's http status code.
BulkPublish
bulkPublish_identityPoolId :: Lens' BulkPublish 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.
bulkPublishResponse_identityPoolId :: Lens' BulkPublishResponse (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.
bulkPublishResponse_httpStatus :: Lens' BulkPublishResponse Int Source #
The response's http status code.
Types
CognitoStreams
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
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
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
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
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
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
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.