| 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
Contents
- Service Configuration
- Errors
- InvalidParameterException
- NotAuthorizedException
- InternalErrorException
- InvalidConfigurationException
- DuplicateRequestException
- LambdaThrottledException
- AlreadyStreamedException
- InvalidLambdaFunctionOutputException
- TooManyRequestsException
- ConcurrentModificationException
- ResourceConflictException
- ResourceNotFoundException
- LimitExceededException
- Waiters
- Operations
- DescribeDataset
- SetCognitoEvents
- DescribeIdentityPoolUsage
- GetBulkPublishDetails
- ListIdentityPoolUsage
- SetIdentityPoolConfiguration
- DeleteDataset
- GetCognitoEvents
- DescribeIdentityUsage
- RegisterDevice
- SubscribeToDataset
- GetIdentityPoolConfiguration
- ListRecords
- UnsubscribeFromDataset
- UpdateRecords
- ListDatasets
- BulkPublish
- Types
Description
Derived from API version 2014-06-30 of the AWS service descriptions, licensed under Apache 2.0.
Amazon Cognito Sync
Amazon Cognito Sync provides an AWS service and client library that enable cross-device syncing of application-related user data. High-level client libraries are available for both iOS and Android. You can use these libraries to persist data locally so that it's available even if the device is offline. Developer credentials don't need to be stored on the mobile device to access the service. You can use Amazon Cognito to obtain a normalized user ID and credentials. User data is persisted in a dataset that can store up to 1 MB of key-value pairs, and you can have up to 20 datasets per user identity.
With Amazon Cognito Sync, the data stored for each identity is accessible only to credentials assigned to that identity. In order to use the Cognito Sync service, you need to make API calls using credentials retrieved with Amazon Cognito Identity service.
If you want to use Cognito Sync in an Android or iOS application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the Developer Guide for Android and the Developer Guide for iOS.
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
- data DescribeDataset = DescribeDataset' Text Text Text
- newDescribeDataset :: Text -> Text -> Text -> DescribeDataset
- data DescribeDatasetResponse = DescribeDatasetResponse' (Maybe Dataset) Int
- newDescribeDatasetResponse :: Int -> DescribeDatasetResponse
- data SetCognitoEvents = SetCognitoEvents' Text (HashMap Text Text)
- newSetCognitoEvents :: Text -> SetCognitoEvents
- data SetCognitoEventsResponse = SetCognitoEventsResponse' {
- newSetCognitoEventsResponse :: SetCognitoEventsResponse
- data DescribeIdentityPoolUsage = DescribeIdentityPoolUsage' Text
- newDescribeIdentityPoolUsage :: Text -> DescribeIdentityPoolUsage
- data DescribeIdentityPoolUsageResponse = DescribeIdentityPoolUsageResponse' (Maybe IdentityPoolUsage) Int
- newDescribeIdentityPoolUsageResponse :: Int -> DescribeIdentityPoolUsageResponse
- data GetBulkPublishDetails = GetBulkPublishDetails' Text
- newGetBulkPublishDetails :: Text -> GetBulkPublishDetails
- data GetBulkPublishDetailsResponse = GetBulkPublishDetailsResponse' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe BulkPublishStatus) Int
- newGetBulkPublishDetailsResponse :: Int -> GetBulkPublishDetailsResponse
- data ListIdentityPoolUsage = ListIdentityPoolUsage' (Maybe Text) (Maybe Int)
- newListIdentityPoolUsage :: ListIdentityPoolUsage
- data ListIdentityPoolUsageResponse = ListIdentityPoolUsageResponse' (Maybe [IdentityPoolUsage]) (Maybe Int) (Maybe Text) (Maybe Int) Int
- newListIdentityPoolUsageResponse :: Int -> ListIdentityPoolUsageResponse
- data SetIdentityPoolConfiguration = SetIdentityPoolConfiguration' (Maybe CognitoStreams) (Maybe PushSync) Text
- newSetIdentityPoolConfiguration :: Text -> SetIdentityPoolConfiguration
- data SetIdentityPoolConfigurationResponse = SetIdentityPoolConfigurationResponse' (Maybe Text) (Maybe CognitoStreams) (Maybe PushSync) Int
- newSetIdentityPoolConfigurationResponse :: Int -> SetIdentityPoolConfigurationResponse
- data DeleteDataset = DeleteDataset' Text Text Text
- newDeleteDataset :: Text -> Text -> Text -> DeleteDataset
- data DeleteDatasetResponse = DeleteDatasetResponse' (Maybe Dataset) Int
- newDeleteDatasetResponse :: Int -> DeleteDatasetResponse
- data GetCognitoEvents = GetCognitoEvents' Text
- newGetCognitoEvents :: Text -> GetCognitoEvents
- data GetCognitoEventsResponse = GetCognitoEventsResponse' (Maybe (HashMap Text Text)) Int
- newGetCognitoEventsResponse :: Int -> GetCognitoEventsResponse
- data DescribeIdentityUsage = DescribeIdentityUsage' Text Text
- newDescribeIdentityUsage :: Text -> Text -> DescribeIdentityUsage
- data DescribeIdentityUsageResponse = DescribeIdentityUsageResponse' (Maybe IdentityUsage) Int
- newDescribeIdentityUsageResponse :: Int -> DescribeIdentityUsageResponse
- data RegisterDevice = RegisterDevice' Text Text Platform Text
- newRegisterDevice :: Text -> Text -> Platform -> Text -> RegisterDevice
- data RegisterDeviceResponse = RegisterDeviceResponse' (Maybe Text) Int
- newRegisterDeviceResponse :: Int -> RegisterDeviceResponse
- data SubscribeToDataset = SubscribeToDataset' Text Text Text Text
- newSubscribeToDataset :: Text -> Text -> Text -> Text -> SubscribeToDataset
- data SubscribeToDatasetResponse = SubscribeToDatasetResponse' Int
- newSubscribeToDatasetResponse :: Int -> SubscribeToDatasetResponse
- data GetIdentityPoolConfiguration = GetIdentityPoolConfiguration' Text
- newGetIdentityPoolConfiguration :: Text -> GetIdentityPoolConfiguration
- data GetIdentityPoolConfigurationResponse = GetIdentityPoolConfigurationResponse' (Maybe Text) (Maybe CognitoStreams) (Maybe PushSync) Int
- newGetIdentityPoolConfigurationResponse :: Int -> GetIdentityPoolConfigurationResponse
- data ListRecords = ListRecords' (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Int) Text Text Text
- newListRecords :: Text -> Text -> Text -> ListRecords
- data ListRecordsResponse = ListRecordsResponse' (Maybe Bool) (Maybe Bool) (Maybe Int) (Maybe [Record]) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Integer) Int
- newListRecordsResponse :: Int -> ListRecordsResponse
- data UnsubscribeFromDataset = UnsubscribeFromDataset' Text Text Text Text
- newUnsubscribeFromDataset :: Text -> Text -> Text -> Text -> UnsubscribeFromDataset
- data UnsubscribeFromDatasetResponse = UnsubscribeFromDatasetResponse' Int
- newUnsubscribeFromDatasetResponse :: Int -> UnsubscribeFromDatasetResponse
- data UpdateRecords = UpdateRecords' (Maybe [RecordPatch]) (Maybe Text) (Maybe Text) Text Text Text Text
- newUpdateRecords :: Text -> Text -> Text -> Text -> UpdateRecords
- data UpdateRecordsResponse = UpdateRecordsResponse' (Maybe [Record]) Int
- newUpdateRecordsResponse :: Int -> UpdateRecordsResponse
- data ListDatasets = ListDatasets' (Maybe Text) (Maybe Int) Text Text
- newListDatasets :: Text -> Text -> ListDatasets
- data ListDatasetsResponse = ListDatasetsResponse' (Maybe Int) (Maybe Text) (Maybe [Dataset]) Int
- newListDatasetsResponse :: Int -> ListDatasetsResponse
- data BulkPublish = BulkPublish' Text
- newBulkPublish :: Text -> BulkPublish
- data BulkPublishResponse = BulkPublishResponse' (Maybe Text) Int
- newBulkPublishResponse :: Int -> BulkPublishResponse
- 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' (Maybe StreamingStatus) (Maybe Text) (Maybe Text)
- newCognitoStreams :: CognitoStreams
- data Dataset = Dataset' (Maybe POSIX) (Maybe Integer) (Maybe Integer) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text)
- newDataset :: Dataset
- data IdentityPoolUsage = IdentityPoolUsage' (Maybe POSIX) (Maybe Text) (Maybe Integer) (Maybe Integer)
- newIdentityPoolUsage :: IdentityPoolUsage
- data IdentityUsage = IdentityUsage' (Maybe POSIX) (Maybe Text) (Maybe Int) (Maybe Integer) (Maybe Text)
- newIdentityUsage :: IdentityUsage
- data PushSync = PushSync' (Maybe [Text]) (Maybe Text)
- newPushSync :: PushSync
- data Record = Record' (Maybe Integer) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text)
- newRecord :: Record
- data RecordPatch = RecordPatch' (Maybe POSIX) (Maybe Text) Operation Text Integer
- newRecordPatch :: Operation -> Text -> Integer -> RecordPatch
Service Configuration
defaultService :: Service Source #
API version 2014-06-30 of the Amazon Cognito Sync SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by CognitoSync.
InvalidParameterException
_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Thrown when a request parameter does not comply with the associated constraints.
NotAuthorizedException
_NotAuthorizedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Thrown when a user is not authorized to access the requested resource.
InternalErrorException
_InternalErrorException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates an internal service error.
InvalidConfigurationException
_InvalidConfigurationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Prism for InvalidConfigurationException' errors.
DuplicateRequestException
_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
_LambdaThrottledException :: AsError a => Getting (First ServiceError) a ServiceError Source #
AWS Lambda throttled your account, please contact AWS Support
AlreadyStreamedException
_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
_InvalidLambdaFunctionOutputException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The AWS Lambda function returned invalid output or an exception.
TooManyRequestsException
_TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Thrown if the request is throttled.
ConcurrentModificationException
_ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Thrown if there are parallel requests to modify a resource.
ResourceConflictException
_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
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Thrown if the resource doesn't exist.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Thrown when the limit on the number of objects or operations has been exceeded.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
DescribeDataset
data DescribeDataset Source #
A request for meta data about a dataset (creation date, number of records, size) by owner and dataset name.
See: newDescribeDataset smart constructor.
Constructors
| DescribeDataset' Text Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> DescribeDataset |
Create a value of DescribeDataset 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:identityPoolId:DescribeDataset', describeDataset_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:identityId:DescribeDataset', describeDataset_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.
$sel:datasetName:DescribeDataset', describeDataset_datasetName - A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9,
'_' (underscore), '-' (dash), and '.' (dot).
data DescribeDatasetResponse Source #
Response to a successful DescribeDataset request.
See: newDescribeDatasetResponse smart constructor.
Constructors
| DescribeDatasetResponse' (Maybe Dataset) Int |
Instances
newDescribeDatasetResponse Source #
Create a value of DescribeDatasetResponse 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:dataset:DescribeDatasetResponse', describeDatasetResponse_dataset - 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.
$sel:httpStatus:DescribeDatasetResponse', describeDatasetResponse_httpStatus - The response's http status code.
SetCognitoEvents
data SetCognitoEvents Source #
Constructors
| SetCognitoEvents' Text (HashMap Text Text) |
Instances
Arguments
| :: Text | |
| -> SetCognitoEvents |
Create a value of SetCognitoEvents 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:identityPoolId:SetCognitoEvents', setCognitoEvents_identityPoolId - The Cognito Identity Pool to use when configuring Cognito Events
$sel:events:SetCognitoEvents', setCognitoEvents_events - The events to configure
data SetCognitoEventsResponse Source #
See: newSetCognitoEventsResponse smart constructor.
Constructors
| SetCognitoEventsResponse' | |
Instances
newSetCognitoEventsResponse :: SetCognitoEventsResponse Source #
Create a value of SetCognitoEventsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeIdentityPoolUsage
data DescribeIdentityPoolUsage Source #
A request for usage information about the identity pool.
See: newDescribeIdentityPoolUsage smart constructor.
Constructors
| DescribeIdentityPoolUsage' Text |
Instances
newDescribeIdentityPoolUsage Source #
Create a value of DescribeIdentityPoolUsage 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:identityPoolId:DescribeIdentityPoolUsage', describeIdentityPoolUsage_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.
data DescribeIdentityPoolUsageResponse Source #
Response to a successful DescribeIdentityPoolUsage request.
See: newDescribeIdentityPoolUsageResponse smart constructor.
Constructors
| DescribeIdentityPoolUsageResponse' (Maybe IdentityPoolUsage) Int |
Instances
newDescribeIdentityPoolUsageResponse Source #
Arguments
| :: Int | |
| -> DescribeIdentityPoolUsageResponse |
Create a value of DescribeIdentityPoolUsageResponse 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:identityPoolUsage:DescribeIdentityPoolUsageResponse', describeIdentityPoolUsageResponse_identityPoolUsage - Information about the usage of the identity pool.
$sel:httpStatus:DescribeIdentityPoolUsageResponse', describeIdentityPoolUsageResponse_httpStatus - The response's http status code.
GetBulkPublishDetails
data GetBulkPublishDetails Source #
The input for the GetBulkPublishDetails operation.
See: newGetBulkPublishDetails smart constructor.
Constructors
| GetBulkPublishDetails' Text |
Instances
newGetBulkPublishDetails Source #
Create a value of GetBulkPublishDetails 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:identityPoolId:GetBulkPublishDetails', getBulkPublishDetails_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.
data GetBulkPublishDetailsResponse Source #
The output for the GetBulkPublishDetails operation.
See: newGetBulkPublishDetailsResponse smart constructor.
Constructors
| GetBulkPublishDetailsResponse' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe BulkPublishStatus) Int |
Instances
newGetBulkPublishDetailsResponse Source #
Create a value of GetBulkPublishDetailsResponse 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:bulkPublishStartTime:GetBulkPublishDetailsResponse', getBulkPublishDetailsResponse_bulkPublishStartTime - The date/time at which the last bulk publish was initiated.
$sel:identityPoolId:GetBulkPublishDetails', getBulkPublishDetailsResponse_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:bulkPublishCompleteTime:GetBulkPublishDetailsResponse', getBulkPublishDetailsResponse_bulkPublishCompleteTime - If BulkPublishStatus is SUCCEEDED, the time the last bulk publish
operation completed.
$sel:failureMessage:GetBulkPublishDetailsResponse', getBulkPublishDetailsResponse_failureMessage - If BulkPublishStatus is FAILED this field will contain the error message
that caused the bulk publish to fail.
$sel:bulkPublishStatus:GetBulkPublishDetailsResponse', getBulkPublishDetailsResponse_bulkPublishStatus - 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.
$sel:httpStatus:GetBulkPublishDetailsResponse', getBulkPublishDetailsResponse_httpStatus - The response's http status code.
ListIdentityPoolUsage
data ListIdentityPoolUsage Source #
A request for usage information on an identity pool.
See: newListIdentityPoolUsage smart constructor.
Constructors
| ListIdentityPoolUsage' (Maybe Text) (Maybe Int) |
Instances
newListIdentityPoolUsage :: ListIdentityPoolUsage Source #
Create a value of ListIdentityPoolUsage 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:nextToken:ListIdentityPoolUsage', listIdentityPoolUsage_nextToken - A pagination token for obtaining the next page of results.
$sel:maxResults:ListIdentityPoolUsage', listIdentityPoolUsage_maxResults - The maximum number of results to be returned.
data ListIdentityPoolUsageResponse Source #
Returned for a successful ListIdentityPoolUsage request.
See: newListIdentityPoolUsageResponse smart constructor.
Constructors
| ListIdentityPoolUsageResponse' (Maybe [IdentityPoolUsage]) (Maybe Int) (Maybe Text) (Maybe Int) Int |
Instances
newListIdentityPoolUsageResponse Source #
Create a value of ListIdentityPoolUsageResponse 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:identityPoolUsages:ListIdentityPoolUsageResponse', listIdentityPoolUsageResponse_identityPoolUsages - Usage information for the identity pools.
$sel:count:ListIdentityPoolUsageResponse', listIdentityPoolUsageResponse_count - Total number of identities for the identity pool.
$sel:nextToken:ListIdentityPoolUsage', listIdentityPoolUsageResponse_nextToken - A pagination token for obtaining the next page of results.
$sel:maxResults:ListIdentityPoolUsage', listIdentityPoolUsageResponse_maxResults - The maximum number of results to be returned.
$sel:httpStatus:ListIdentityPoolUsageResponse', listIdentityPoolUsageResponse_httpStatus - The response's http status code.
SetIdentityPoolConfiguration
data SetIdentityPoolConfiguration Source #
The input for the SetIdentityPoolConfiguration operation.
See: newSetIdentityPoolConfiguration smart constructor.
Constructors
| SetIdentityPoolConfiguration' (Maybe CognitoStreams) (Maybe PushSync) Text |
Instances
newSetIdentityPoolConfiguration Source #
Create a value of SetIdentityPoolConfiguration 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:cognitoStreams:SetIdentityPoolConfiguration', setIdentityPoolConfiguration_cognitoStreams - Options to apply to this identity pool for Amazon Cognito streams.
$sel:pushSync:SetIdentityPoolConfiguration', setIdentityPoolConfiguration_pushSync - Options to apply to this identity pool for push synchronization.
$sel:identityPoolId:SetIdentityPoolConfiguration', setIdentityPoolConfiguration_identityPoolId - 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.
data SetIdentityPoolConfigurationResponse Source #
The output for the SetIdentityPoolConfiguration operation
See: newSetIdentityPoolConfigurationResponse smart constructor.
Constructors
| SetIdentityPoolConfigurationResponse' (Maybe Text) (Maybe CognitoStreams) (Maybe PushSync) Int |
Instances
newSetIdentityPoolConfigurationResponse Source #
Arguments
| :: Int | |
| -> SetIdentityPoolConfigurationResponse |
Create a value of SetIdentityPoolConfigurationResponse 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:identityPoolId:SetIdentityPoolConfiguration', setIdentityPoolConfigurationResponse_identityPoolId - A name-spaced GUID (for example,
us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
Cognito.
$sel:cognitoStreams:SetIdentityPoolConfiguration', setIdentityPoolConfigurationResponse_cognitoStreams - Options to apply to this identity pool for Amazon Cognito streams.
$sel:pushSync:SetIdentityPoolConfiguration', setIdentityPoolConfigurationResponse_pushSync - Options to apply to this identity pool for push synchronization.
$sel:httpStatus:SetIdentityPoolConfigurationResponse', setIdentityPoolConfigurationResponse_httpStatus - The response's http status code.
DeleteDataset
data DeleteDataset Source #
A request to delete the specific dataset.
See: newDeleteDataset smart constructor.
Constructors
| DeleteDataset' Text Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> DeleteDataset |
Create a value of DeleteDataset 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:identityPoolId:DeleteDataset', deleteDataset_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:identityId:DeleteDataset', deleteDataset_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.
$sel:datasetName:DeleteDataset', deleteDataset_datasetName - A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9,
'_' (underscore), '-' (dash), and '.' (dot).
data DeleteDatasetResponse Source #
Response to a successful DeleteDataset request.
See: newDeleteDatasetResponse smart constructor.
Constructors
| DeleteDatasetResponse' (Maybe Dataset) Int |
Instances
newDeleteDatasetResponse Source #
Create a value of DeleteDatasetResponse 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:dataset:DeleteDatasetResponse', deleteDatasetResponse_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.
$sel:httpStatus:DeleteDatasetResponse', deleteDatasetResponse_httpStatus - The response's http status code.
GetCognitoEvents
data GetCognitoEvents Source #
A request for a list of the configured Cognito Events
See: newGetCognitoEvents smart constructor.
Constructors
| GetCognitoEvents' Text |
Instances
Arguments
| :: Text | |
| -> GetCognitoEvents |
Create a value of GetCognitoEvents 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:identityPoolId:GetCognitoEvents', getCognitoEvents_identityPoolId - The Cognito Identity Pool ID for the request
data GetCognitoEventsResponse Source #
The response from the GetCognitoEvents request
See: newGetCognitoEventsResponse smart constructor.
Instances
newGetCognitoEventsResponse Source #
Create a value of GetCognitoEventsResponse 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:events:GetCognitoEventsResponse', getCognitoEventsResponse_events - The Cognito Events returned from the GetCognitoEvents request
$sel:httpStatus:GetCognitoEventsResponse', getCognitoEventsResponse_httpStatus - The response's http status code.
DescribeIdentityUsage
data DescribeIdentityUsage Source #
A request for information about the usage of an identity pool.
See: newDescribeIdentityUsage smart constructor.
Constructors
| DescribeIdentityUsage' Text Text |
Instances
newDescribeIdentityUsage Source #
Arguments
| :: Text | |
| -> Text | |
| -> DescribeIdentityUsage |
Create a value of DescribeIdentityUsage 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:identityPoolId:DescribeIdentityUsage', describeIdentityUsage_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:identityId:DescribeIdentityUsage', describeIdentityUsage_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.
data DescribeIdentityUsageResponse Source #
The response to a successful DescribeIdentityUsage request.
See: newDescribeIdentityUsageResponse smart constructor.
Constructors
| DescribeIdentityUsageResponse' (Maybe IdentityUsage) Int |
Instances
newDescribeIdentityUsageResponse Source #
Create a value of DescribeIdentityUsageResponse 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:identityUsage:DescribeIdentityUsageResponse', describeIdentityUsageResponse_identityUsage - Usage information for the identity.
$sel:httpStatus:DescribeIdentityUsageResponse', describeIdentityUsageResponse_httpStatus - The response's http status code.
RegisterDevice
data RegisterDevice Source #
A request to RegisterDevice.
See: newRegisterDevice smart constructor.
Constructors
| RegisterDevice' Text Text Platform Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Platform | |
| -> Text | |
| -> RegisterDevice |
Create a value of RegisterDevice 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:identityPoolId:RegisterDevice', registerDevice_identityPoolId - 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.
$sel:identityId:RegisterDevice', registerDevice_identityId - The unique ID for this identity.
$sel:platform:RegisterDevice', registerDevice_platform - The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX).
$sel:token:RegisterDevice', registerDevice_token - The push token.
data RegisterDeviceResponse Source #
Response to a RegisterDevice request.
See: newRegisterDeviceResponse smart constructor.
Constructors
| RegisterDeviceResponse' (Maybe Text) Int |
Instances
newRegisterDeviceResponse Source #
Create a value of RegisterDeviceResponse 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:deviceId:RegisterDeviceResponse', registerDeviceResponse_deviceId - The unique ID generated for this device by Cognito.
$sel:httpStatus:RegisterDeviceResponse', registerDeviceResponse_httpStatus - The response's http status code.
SubscribeToDataset
data SubscribeToDataset Source #
A request to SubscribeToDatasetRequest.
See: newSubscribeToDataset smart constructor.
Constructors
| SubscribeToDataset' Text Text Text Text |
Instances
newSubscribeToDataset Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> SubscribeToDataset |
Create a value of SubscribeToDataset 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:identityPoolId:SubscribeToDataset', subscribeToDataset_identityPoolId - 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.
$sel:identityId:SubscribeToDataset', subscribeToDataset_identityId - Unique ID for this identity.
$sel:datasetName:SubscribeToDataset', subscribeToDataset_datasetName - The name of the dataset to subcribe to.
$sel:deviceId:SubscribeToDataset', subscribeToDataset_deviceId - The unique ID generated for this device by Cognito.
data SubscribeToDatasetResponse Source #
Response to a SubscribeToDataset request.
See: newSubscribeToDatasetResponse smart constructor.
Constructors
| SubscribeToDatasetResponse' Int |
Instances
newSubscribeToDatasetResponse Source #
Create a value of SubscribeToDatasetResponse 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:httpStatus:SubscribeToDatasetResponse', subscribeToDatasetResponse_httpStatus - The response's http status code.
GetIdentityPoolConfiguration
data GetIdentityPoolConfiguration Source #
The input for the GetIdentityPoolConfiguration operation.
See: newGetIdentityPoolConfiguration smart constructor.
Constructors
| GetIdentityPoolConfiguration' Text |
Instances
newGetIdentityPoolConfiguration Source #
Create a value of GetIdentityPoolConfiguration 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:identityPoolId:GetIdentityPoolConfiguration', getIdentityPoolConfiguration_identityPoolId - 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.
data GetIdentityPoolConfigurationResponse Source #
The output for the GetIdentityPoolConfiguration operation.
See: newGetIdentityPoolConfigurationResponse smart constructor.
Constructors
| GetIdentityPoolConfigurationResponse' (Maybe Text) (Maybe CognitoStreams) (Maybe PushSync) Int |
Instances
newGetIdentityPoolConfigurationResponse Source #
Arguments
| :: Int | |
| -> GetIdentityPoolConfigurationResponse |
Create a value of GetIdentityPoolConfigurationResponse 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:identityPoolId:GetIdentityPoolConfiguration', getIdentityPoolConfigurationResponse_identityPoolId - A name-spaced GUID (for example,
us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
Cognito.
$sel:cognitoStreams:GetIdentityPoolConfigurationResponse', getIdentityPoolConfigurationResponse_cognitoStreams - Options to apply to this identity pool for Amazon Cognito streams.
$sel:pushSync:GetIdentityPoolConfigurationResponse', getIdentityPoolConfigurationResponse_pushSync - Options to apply to this identity pool for push synchronization.
$sel:httpStatus:GetIdentityPoolConfigurationResponse', getIdentityPoolConfigurationResponse_httpStatus - The response's http status code.
ListRecords
data ListRecords Source #
A request for a list of records.
See: newListRecords smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> ListRecords |
Create a value of ListRecords 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:lastSyncCount:ListRecords', listRecords_lastSyncCount - The last server sync count for this record.
$sel:nextToken:ListRecords', listRecords_nextToken - A pagination token for obtaining the next page of results.
$sel:syncSessionToken:ListRecords', listRecords_syncSessionToken - A token containing a session ID, identity ID, and expiration.
$sel:maxResults:ListRecords', listRecords_maxResults - The maximum number of results to be returned.
$sel:identityPoolId:ListRecords', listRecords_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:identityId:ListRecords', listRecords_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.
$sel:datasetName:ListRecords', listRecords_datasetName - A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9,
'_' (underscore), '-' (dash), and '.' (dot).
data ListRecordsResponse Source #
Returned for a successful ListRecordsRequest.
See: newListRecordsResponse smart constructor.
Constructors
| ListRecordsResponse' (Maybe Bool) (Maybe Bool) (Maybe Int) (Maybe [Record]) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Integer) Int |
Instances
newListRecordsResponse Source #
Arguments
| :: Int | |
| -> ListRecordsResponse |
Create a value of ListRecordsResponse 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:datasetDeletedAfterRequestedSyncCount:ListRecordsResponse', listRecordsResponse_datasetDeletedAfterRequestedSyncCount - A boolean value specifying whether to delete the dataset locally.
$sel:datasetExists:ListRecordsResponse', listRecordsResponse_datasetExists - Indicates whether the dataset exists.
$sel:count:ListRecordsResponse', listRecordsResponse_count - Total number of records.
$sel:records:ListRecordsResponse', listRecordsResponse_records - A list of all records.
$sel:nextToken:ListRecords', listRecordsResponse_nextToken - A pagination token for obtaining the next page of results.
$sel:mergedDatasetNames:ListRecordsResponse', listRecordsResponse_mergedDatasetNames - Names of merged datasets.
$sel:syncSessionToken:ListRecords', listRecordsResponse_syncSessionToken - A token containing a session ID, identity ID, and expiration.
$sel:lastModifiedBy:ListRecordsResponse', listRecordsResponse_lastModifiedBy - The user/device that made the last change to this record.
$sel:datasetSyncCount:ListRecordsResponse', listRecordsResponse_datasetSyncCount - Server sync count for this dataset.
$sel:httpStatus:ListRecordsResponse', listRecordsResponse_httpStatus - The response's http status code.
UnsubscribeFromDataset
data UnsubscribeFromDataset Source #
A request to UnsubscribeFromDataset.
See: newUnsubscribeFromDataset smart constructor.
Constructors
| UnsubscribeFromDataset' Text Text Text Text |
Instances
newUnsubscribeFromDataset Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> UnsubscribeFromDataset |
Create a value of UnsubscribeFromDataset 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:identityPoolId:UnsubscribeFromDataset', unsubscribeFromDataset_identityPoolId - 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.
$sel:identityId:UnsubscribeFromDataset', unsubscribeFromDataset_identityId - Unique ID for this identity.
$sel:datasetName:UnsubscribeFromDataset', unsubscribeFromDataset_datasetName - The name of the dataset from which to unsubcribe.
$sel:deviceId:UnsubscribeFromDataset', unsubscribeFromDataset_deviceId - The unique ID generated for this device by Cognito.
data UnsubscribeFromDatasetResponse Source #
Response to an UnsubscribeFromDataset request.
See: newUnsubscribeFromDatasetResponse smart constructor.
Constructors
| UnsubscribeFromDatasetResponse' Int |
Instances
newUnsubscribeFromDatasetResponse Source #
Create a value of UnsubscribeFromDatasetResponse 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:httpStatus:UnsubscribeFromDatasetResponse', unsubscribeFromDatasetResponse_httpStatus - The response's http status code.
UpdateRecords
data UpdateRecords Source #
A request to post updates to records or add and delete records for a dataset and user.
See: newUpdateRecords smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> UpdateRecords |
Create a value of UpdateRecords 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:recordPatches:UpdateRecords', updateRecords_recordPatches - A list of patch operations.
$sel:deviceId:UpdateRecords', updateRecords_deviceId - The unique ID generated for this device by Cognito.
$sel:clientContext:UpdateRecords', updateRecords_clientContext - Intended to supply a device ID that will populate the lastModifiedBy
field referenced in other methods. The ClientContext field is not yet
implemented.
$sel:identityPoolId:UpdateRecords', updateRecords_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:identityId:UpdateRecords', updateRecords_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.
$sel:datasetName:UpdateRecords', updateRecords_datasetName - A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9,
'_' (underscore), '-' (dash), and '.' (dot).
$sel:syncSessionToken:UpdateRecords', updateRecords_syncSessionToken - The SyncSessionToken returned by a previous call to ListRecords for this
dataset and identity.
data UpdateRecordsResponse Source #
Returned for a successful UpdateRecordsRequest.
See: newUpdateRecordsResponse smart constructor.
Constructors
| UpdateRecordsResponse' (Maybe [Record]) Int |
Instances
newUpdateRecordsResponse Source #
Create a value of UpdateRecordsResponse 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:records:UpdateRecordsResponse', updateRecordsResponse_records - A list of records that have been updated.
$sel:httpStatus:UpdateRecordsResponse', updateRecordsResponse_httpStatus - The response's http status code.
ListDatasets
data ListDatasets Source #
Request for a list of datasets for an identity.
See: newListDatasets smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ListDatasets |
Create a value of ListDatasets 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:nextToken:ListDatasets', listDatasets_nextToken - A pagination token for obtaining the next page of results.
$sel:maxResults:ListDatasets', listDatasets_maxResults - The maximum number of results to be returned.
$sel:identityId:ListDatasets', listDatasets_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.
$sel:identityPoolId:ListDatasets', listDatasets_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.
data ListDatasetsResponse Source #
Returned for a successful ListDatasets request.
See: newListDatasetsResponse smart constructor.
Instances
newListDatasetsResponse Source #
Arguments
| :: Int | |
| -> ListDatasetsResponse |
Create a value of ListDatasetsResponse 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:count:ListDatasetsResponse', listDatasetsResponse_count - Number of datasets returned.
$sel:nextToken:ListDatasets', listDatasetsResponse_nextToken - A pagination token for obtaining the next page of results.
$sel:datasets:ListDatasetsResponse', listDatasetsResponse_datasets - A set of datasets.
$sel:httpStatus:ListDatasetsResponse', listDatasetsResponse_httpStatus - The response's http status code.
BulkPublish
data BulkPublish Source #
The input for the BulkPublish operation.
See: newBulkPublish smart constructor.
Constructors
| BulkPublish' Text |
Instances
Arguments
| :: Text | |
| -> BulkPublish |
Create a value of BulkPublish 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:identityPoolId:BulkPublish', bulkPublish_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.
data BulkPublishResponse Source #
The output for the BulkPublish operation.
See: newBulkPublishResponse smart constructor.
Constructors
| BulkPublishResponse' (Maybe Text) Int |
Instances
newBulkPublishResponse Source #
Arguments
| :: Int | |
| -> BulkPublishResponse |
Create a value of BulkPublishResponse 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:identityPoolId:BulkPublish', bulkPublishResponse_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:httpStatus:BulkPublishResponse', bulkPublishResponse_httpStatus - The response's http status code.
Types
BulkPublishStatus
newtype BulkPublishStatus Source #
Constructors
| BulkPublishStatus' | |
Fields | |
Bundled Patterns
| pattern BulkPublishStatus_FAILED :: BulkPublishStatus | |
| pattern BulkPublishStatus_IN_PROGRESS :: BulkPublishStatus | |
| pattern BulkPublishStatus_NOT_STARTED :: BulkPublishStatus | |
| pattern BulkPublishStatus_SUCCEEDED :: BulkPublishStatus |
Instances
Operation
Constructors
| Operation' | |
Fields | |
Bundled Patterns
| pattern Operation_Remove :: Operation | |
| pattern Operation_Replace :: Operation |
Instances
Platform
Constructors
| Platform' | |
Fields
| |
Bundled Patterns
| pattern Platform_ADM :: Platform | |
| pattern Platform_APNS :: Platform | |
| pattern Platform_APNS_SANDBOX :: Platform | |
| pattern Platform_GCM :: Platform |
Instances
StreamingStatus
newtype StreamingStatus Source #
Constructors
| StreamingStatus' | |
Fields | |
Bundled Patterns
| pattern StreamingStatus_DISABLED :: StreamingStatus | |
| pattern StreamingStatus_ENABLED :: StreamingStatus |
Instances
CognitoStreams
data CognitoStreams Source #
Configuration options for configure Cognito streams.
See: newCognitoStreams smart constructor.
Constructors
| CognitoStreams' (Maybe StreamingStatus) (Maybe Text) (Maybe Text) |
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.
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.
Constructors
| Dataset' (Maybe POSIX) (Maybe Integer) (Maybe Integer) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) |
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.
IdentityPoolUsage
data IdentityPoolUsage Source #
Usage information for the identity pool.
See: newIdentityPoolUsage smart constructor.
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.
IdentityUsage
data IdentityUsage Source #
Usage information for the identity.
See: newIdentityUsage smart constructor.
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.
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.
Record
The basic data structure of a dataset.
See: newRecord smart constructor.
Constructors
| Record' (Maybe Integer) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) |
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.
RecordPatch
data RecordPatch Source #
An update operation for a record.
See: newRecordPatch smart constructor.
Instances
Arguments
| :: 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.