| 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.SubscribeToDataset
Description
Subscribes to receive notifications when a dataset is modified by another device.
This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.
Synopsis
- data SubscribeToDataset = SubscribeToDataset' {
- identityPoolId :: Text
- identityId :: Text
- datasetName :: Text
- deviceId :: Text
- newSubscribeToDataset :: Text -> Text -> Text -> Text -> SubscribeToDataset
- subscribeToDataset_identityPoolId :: Lens' SubscribeToDataset Text
- subscribeToDataset_identityId :: Lens' SubscribeToDataset Text
- subscribeToDataset_datasetName :: Lens' SubscribeToDataset Text
- subscribeToDataset_deviceId :: Lens' SubscribeToDataset Text
- data SubscribeToDatasetResponse = SubscribeToDatasetResponse' {
- httpStatus :: Int
- newSubscribeToDatasetResponse :: Int -> SubscribeToDatasetResponse
- subscribeToDatasetResponse_httpStatus :: Lens' SubscribeToDatasetResponse Int
Creating a Request
data SubscribeToDataset Source #
A request to SubscribeToDatasetRequest.
See: newSubscribeToDataset smart constructor.
Constructors
| SubscribeToDataset' | |
Fields
| |
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.
Request Lenses
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.
Destructuring the Response
data SubscribeToDatasetResponse Source #
Response to a SubscribeToDataset request.
See: newSubscribeToDatasetResponse smart constructor.
Constructors
| SubscribeToDatasetResponse' | |
Fields
| |
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.
Response Lenses
subscribeToDatasetResponse_httpStatus :: Lens' SubscribeToDatasetResponse Int Source #
The response's http status code.