libZSservicesZSamazonka-cognito-syncZSamazonka-cognito-sync
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CognitoSync.Lens

Description

 
Synopsis

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.

SetCognitoEvents

setCognitoEvents_identityPoolId :: Lens' SetCognitoEvents Text Source #

The Cognito Identity Pool to use when configuring Cognito Events

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.

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.

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_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.

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_pushSync :: Lens' SetIdentityPoolConfigurationResponse (Maybe PushSync) Source #

Options to apply to this identity pool for push synchronization.

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.

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

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.

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

registerDeviceResponse_deviceId :: Lens' RegisterDeviceResponse (Maybe Text) Source #

The unique ID generated for this device by Cognito.

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_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.

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_pushSync :: Lens' GetIdentityPoolConfigurationResponse (Maybe PushSync) Source #

Options to apply to this identity pool for push synchronization.

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_nextToken :: Lens' ListRecordsResponse (Maybe Text) Source #

A pagination token for obtaining the next page of results.

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.

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_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.

UpdateRecords

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.

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_nextToken :: Lens' ListDatasetsResponse (Maybe Text) Source #

A pagination token for obtaining the next page of results.

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.

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

Number of records in this dataset.

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_syncCount :: Lens' Record (Maybe Integer) Source #

The server sync count for 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_value :: Lens' Record (Maybe Text) Source #

The value for the record.

record_key :: Lens' Record (Maybe Text) Source #

The key for the record.

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.