amazonka-sns-1.6.1: Amazon Simple Notification Service SDK.

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

Network.AWS.SNS.CreatePlatformApplication

Contents

Description

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 WNS, PlatformPrincipal is "Package Security Identifier". For MPNS, PlatformPrincipal is "TLS certificate". For Baidu, PlatformPrincipal is "API key".

For APNSAPNS_SANDBOX, PlatformCredential is "private key". For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret". For WNS, PlatformCredential is "secret key". For MPNS, PlatformCredential is "private key". For Baidu, PlatformCredential is "secret key". The PlatformApplicationArn that is returned when using CreatePlatformApplication is then used as an attribute for the CreatePlatformEndpoint action. For more information, see <http:docs.aws.amazon.comsnslatestdgSNSMobilePush.html Using Amazon SNS Mobile Push Notifications> . For more information about obtaining the PlatformPrincipal and PlatformCredential for each of the supported push notification services, see <http:docs.aws.amazon.comsnslatestdgmobile-push-apns.html Getting Started with Apple Push Notification Service> , <http:docs.aws.amazon.comsnslatestdgmobile-push-adm.html Getting Started with Amazon Device Messaging> , <http:docs.aws.amazon.comsnslatestdgmobile-push-baidu.html Getting Started with Baidu Cloud Push> , <http:docs.aws.amazon.comsnslatestdgmobile-push-gcm.html Getting Started with Google Cloud Messaging for Android> , <http:docs.aws.amazon.comsnslatestdgmobile-push-mpns.html Getting Started with MPNS> , or <http:docs.aws.amazon.comsnslatestdg/mobile-push-wns.html Getting Started with WNS> .

Synopsis

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:

  • cpaName - 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 - The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Google Cloud Messaging).
  • cpaAttributes - For a list of attributes, see SetPlatformApplicationAttributes

data CreatePlatformApplication Source #

Input for CreatePlatformApplication action.

See: createPlatformApplication smart constructor.

Instances
Eq CreatePlatformApplication Source # 
Instance details

Defined in Network.AWS.SNS.CreatePlatformApplication

Data CreatePlatformApplication Source # 
Instance details

Defined in Network.AWS.SNS.CreatePlatformApplication

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreatePlatformApplication -> c CreatePlatformApplication #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreatePlatformApplication #

toConstr :: CreatePlatformApplication -> Constr #

dataTypeOf :: CreatePlatformApplication -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreatePlatformApplication) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreatePlatformApplication) #

gmapT :: (forall b. Data b => b -> b) -> CreatePlatformApplication -> CreatePlatformApplication #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreatePlatformApplication -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreatePlatformApplication -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreatePlatformApplication -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreatePlatformApplication -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreatePlatformApplication -> m CreatePlatformApplication #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreatePlatformApplication -> m CreatePlatformApplication #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreatePlatformApplication -> m CreatePlatformApplication #

Read CreatePlatformApplication Source # 
Instance details

Defined in Network.AWS.SNS.CreatePlatformApplication

Show CreatePlatformApplication Source # 
Instance details

Defined in Network.AWS.SNS.CreatePlatformApplication

Generic CreatePlatformApplication Source # 
Instance details

Defined in Network.AWS.SNS.CreatePlatformApplication

Associated Types

type Rep CreatePlatformApplication :: Type -> Type #

Hashable CreatePlatformApplication Source # 
Instance details

Defined in Network.AWS.SNS.CreatePlatformApplication

AWSRequest CreatePlatformApplication Source # 
Instance details

Defined in Network.AWS.SNS.CreatePlatformApplication

Associated Types

type Rs CreatePlatformApplication :: Type #

ToHeaders CreatePlatformApplication Source # 
Instance details

Defined in Network.AWS.SNS.CreatePlatformApplication

ToPath CreatePlatformApplication Source # 
Instance details

Defined in Network.AWS.SNS.CreatePlatformApplication

ToQuery CreatePlatformApplication Source # 
Instance details

Defined in Network.AWS.SNS.CreatePlatformApplication

NFData CreatePlatformApplication Source # 
Instance details

Defined in Network.AWS.SNS.CreatePlatformApplication

type Rep CreatePlatformApplication Source # 
Instance details

Defined in Network.AWS.SNS.CreatePlatformApplication

type Rep CreatePlatformApplication = D1 (MetaData "CreatePlatformApplication" "Network.AWS.SNS.CreatePlatformApplication" "amazonka-sns-1.6.1-7GBYpIO1P7AJWNWtL33amk" False) (C1 (MetaCons "CreatePlatformApplication'" PrefixI True) (S1 (MetaSel (Just "_cpaName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_cpaPlatform") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_cpaAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Map Text Text)))))
type Rs CreatePlatformApplication Source # 
Instance details

Defined in Network.AWS.SNS.CreatePlatformApplication

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

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.

Instances
Eq CreatePlatformApplicationResponse Source # 
Instance details

Defined in Network.AWS.SNS.CreatePlatformApplication

Data CreatePlatformApplicationResponse Source # 
Instance details

Defined in Network.AWS.SNS.CreatePlatformApplication

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreatePlatformApplicationResponse -> c CreatePlatformApplicationResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreatePlatformApplicationResponse #

toConstr :: CreatePlatformApplicationResponse -> Constr #

dataTypeOf :: CreatePlatformApplicationResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreatePlatformApplicationResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreatePlatformApplicationResponse) #

gmapT :: (forall b. Data b => b -> b) -> CreatePlatformApplicationResponse -> CreatePlatformApplicationResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreatePlatformApplicationResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreatePlatformApplicationResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreatePlatformApplicationResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreatePlatformApplicationResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreatePlatformApplicationResponse -> m CreatePlatformApplicationResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreatePlatformApplicationResponse -> m CreatePlatformApplicationResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreatePlatformApplicationResponse -> m CreatePlatformApplicationResponse #

Read CreatePlatformApplicationResponse Source # 
Instance details

Defined in Network.AWS.SNS.CreatePlatformApplication

Show CreatePlatformApplicationResponse Source # 
Instance details

Defined in Network.AWS.SNS.CreatePlatformApplication

Generic CreatePlatformApplicationResponse Source # 
Instance details

Defined in Network.AWS.SNS.CreatePlatformApplication

Associated Types

type Rep CreatePlatformApplicationResponse :: Type -> Type #

NFData CreatePlatformApplicationResponse Source # 
Instance details

Defined in Network.AWS.SNS.CreatePlatformApplication

type Rep CreatePlatformApplicationResponse Source # 
Instance details

Defined in Network.AWS.SNS.CreatePlatformApplication

type Rep CreatePlatformApplicationResponse = D1 (MetaData "CreatePlatformApplicationResponse" "Network.AWS.SNS.CreatePlatformApplication" "amazonka-sns-1.6.1-7GBYpIO1P7AJWNWtL33amk" False) (C1 (MetaCons "CreatePlatformApplicationResponse'" PrefixI True) (S1 (MetaSel (Just "_cparsPlatformApplicationARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cparsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses