Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Registers a device to receive push sync notifications.
This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.
See: AWS API Reference for RegisterDevice.
- registerDevice :: Text -> Text -> Platform -> Text -> RegisterDevice
- data RegisterDevice
- rdIdentityPoolId :: Lens' RegisterDevice Text
- rdIdentityId :: Lens' RegisterDevice Text
- rdPlatform :: Lens' RegisterDevice Platform
- rdToken :: Lens' RegisterDevice Text
- registerDeviceResponse :: Int -> RegisterDeviceResponse
- data RegisterDeviceResponse
- rdrsDeviceId :: Lens' RegisterDeviceResponse (Maybe Text)
- rdrsResponseStatus :: Lens' RegisterDeviceResponse Int
Creating a Request
Creates a value of RegisterDevice
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data RegisterDevice Source
A request to RegisterDevice.
See: registerDevice
smart constructor.
Request Lenses
rdIdentityPoolId :: 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.
rdIdentityId :: Lens' RegisterDevice Text Source
The unique ID for this identity.
rdPlatform :: Lens' RegisterDevice Platform Source
The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX).
rdToken :: Lens' RegisterDevice Text Source
The push token.
Destructuring the Response
Creates a value of RegisterDeviceResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data RegisterDeviceResponse Source
Response to a RegisterDevice request.
See: registerDeviceResponse
smart constructor.
Response Lenses
rdrsDeviceId :: Lens' RegisterDeviceResponse (Maybe Text) Source
The unique ID generated for this device by Cognito.
rdrsResponseStatus :: Lens' RegisterDeviceResponse Int Source
The response status code.