Copyright | (c) 2013-2016 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 |
Creates a platform application object for one of the supported push
notification services, such as APNS and GCM, to which devices and mobile
apps may register. You must specify PlatformPrincipal and
PlatformCredential attributes when using the CreatePlatformApplication
action. The PlatformPrincipal is received from the notification service.
For APNS/APNS_SANDBOX, PlatformPrincipal is "SSL certificate". For
GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is
"client id". The PlatformCredential is also received from the
notification service. For APNS/APNS_SANDBOX, PlatformCredential is
"private key". For GCM, PlatformCredential is "API key". For ADM,
PlatformCredential is "client secret". The PlatformApplicationArn that
is returned when using CreatePlatformApplication
is then used as an
attribute for the CreatePlatformEndpoint
action. For more information,
see
Using Amazon SNS Mobile Push Notifications.
- createPlatformApplication :: Text -> Text -> CreatePlatformApplication
- data CreatePlatformApplication
- cpaName :: Lens' CreatePlatformApplication Text
- cpaPlatform :: Lens' CreatePlatformApplication Text
- cpaAttributes :: Lens' CreatePlatformApplication (HashMap Text Text)
- createPlatformApplicationResponse :: Int -> CreatePlatformApplicationResponse
- data CreatePlatformApplicationResponse
- cparsPlatformApplicationARN :: Lens' CreatePlatformApplicationResponse (Maybe Text)
- cparsResponseStatus :: Lens' CreatePlatformApplicationResponse Int
Creating a Request
createPlatformApplication Source
Creates a value of CreatePlatformApplication
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CreatePlatformApplication Source
Input for CreatePlatformApplication action.
See: createPlatformApplication
smart constructor.
Request Lenses
cpaName :: Lens' CreatePlatformApplication Text Source
Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.
cpaPlatform :: Lens' CreatePlatformApplication Text Source
The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Google Cloud Messaging).
cpaAttributes :: Lens' CreatePlatformApplication (HashMap Text Text) Source
For a list of attributes, see SetPlatformApplicationAttributes
Destructuring the Response
createPlatformApplicationResponse Source
Creates a value of CreatePlatformApplicationResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CreatePlatformApplicationResponse Source
Response from CreatePlatformApplication action.
See: createPlatformApplicationResponse
smart constructor.
Response Lenses
cparsPlatformApplicationARN :: Lens' CreatePlatformApplicationResponse (Maybe Text) Source
PlatformApplicationArn is returned.
cparsResponseStatus :: Lens' CreatePlatformApplicationResponse Int Source
The response status code.