Network.AWS.SNS.CreatePlatformApplication

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

Creating a Request

createPlatformApplication

Arguments

:: Text

cpaName

-> Text

cpaPlatform

-> CreatePlatformApplication

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

Input for CreatePlatformApplication action.

See: createPlatformApplication smart constructor.

Instances

Eq CreatePlatformApplication

Methods

(==) :: CreatePlatformApplication -> CreatePlatformApplication -> Bool

(/=) :: CreatePlatformApplication -> CreatePlatformApplication -> Bool

Data 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

Methods

readsPrec :: Int -> ReadS CreatePlatformApplication

readList :: ReadS [CreatePlatformApplication]

readPrec :: ReadPrec CreatePlatformApplication

readListPrec :: ReadPrec [CreatePlatformApplication]

Show CreatePlatformApplication

Methods

showsPrec :: Int -> CreatePlatformApplication -> ShowS

show :: CreatePlatformApplication -> String

showList :: [CreatePlatformApplication] -> ShowS

Generic CreatePlatformApplication

Associated Types

type Rep CreatePlatformApplication :: * -> *

Methods

from :: CreatePlatformApplication -> Rep CreatePlatformApplication x

to :: Rep CreatePlatformApplication x -> CreatePlatformApplication

Hashable CreatePlatformApplication

Methods

hashWithSalt :: Int -> CreatePlatformApplication -> Int

hash :: CreatePlatformApplication -> Int

NFData CreatePlatformApplication

Methods

rnf :: CreatePlatformApplication -> ()

AWSRequest CreatePlatformApplication

Associated Types

type Rs CreatePlatformApplication :: *

Methods

request :: CreatePlatformApplication -> Request CreatePlatformApplication

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * CreatePlatformApplication -> ClientResponse -> m (Response CreatePlatformApplication)

ToHeaders CreatePlatformApplication

Methods

toHeaders :: CreatePlatformApplication -> [Header]

ToPath CreatePlatformApplication

Methods

toPath :: CreatePlatformApplication -> ByteString

ToQuery CreatePlatformApplication

Methods

toQuery :: CreatePlatformApplication -> QueryString

type Rep CreatePlatformApplication

type Rep CreatePlatformApplication = D1 * (MetaData "CreatePlatformApplication" "Network.AWS.SNS.CreatePlatformApplication" "amazonka-sns-1.6.0-9aFI2fxVFLPtYIjs5ltfP" False) (C1 * (MetaCons "CreatePlatformApplication'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_cpaName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) ((:*:) * (S1 * (MetaSel (Just Symbol "_cpaPlatform") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_cpaAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Map Text Text))))))

type Rs CreatePlatformApplication

type Rs CreatePlatformApplication = CreatePlatformApplicationResponse

Request Lenses

cpaName :: Lens' CreatePlatformApplication Text

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

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)

For a list of attributes, see SetPlatformApplicationAttributes

Destructuring the Response

createPlatformApplicationResponse

Arguments

:: Int

cparsResponseStatus

-> CreatePlatformApplicationResponse

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:

• cparsPlatformApplicationARN - PlatformApplicationArn is returned.
• cparsResponseStatus - -- | The response status code.

data CreatePlatformApplicationResponse

Response from CreatePlatformApplication action.

See: createPlatformApplicationResponse smart constructor.

Instances

Eq CreatePlatformApplicationResponse

Methods

(==) :: CreatePlatformApplicationResponse -> CreatePlatformApplicationResponse -> Bool

(/=) :: CreatePlatformApplicationResponse -> CreatePlatformApplicationResponse -> Bool

Data CreatePlatformApplicationResponse

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

Methods

readsPrec :: Int -> ReadS CreatePlatformApplicationResponse

readList :: ReadS [CreatePlatformApplicationResponse]

readPrec :: ReadPrec CreatePlatformApplicationResponse

readListPrec :: ReadPrec [CreatePlatformApplicationResponse]

Show CreatePlatformApplicationResponse

Methods

showsPrec :: Int -> CreatePlatformApplicationResponse -> ShowS

show :: CreatePlatformApplicationResponse -> String

showList :: [CreatePlatformApplicationResponse] -> ShowS

Generic CreatePlatformApplicationResponse

Associated Types

type Rep CreatePlatformApplicationResponse :: * -> *

Methods

from :: CreatePlatformApplicationResponse -> Rep CreatePlatformApplicationResponse x

to :: Rep CreatePlatformApplicationResponse x -> CreatePlatformApplicationResponse

NFData CreatePlatformApplicationResponse

Methods

rnf :: CreatePlatformApplicationResponse -> ()

type Rep CreatePlatformApplicationResponse

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

Response Lenses

cparsPlatformApplicationARN :: Lens' CreatePlatformApplicationResponse (Maybe Text)

PlatformApplicationArn is returned.

cparsResponseStatus :: Lens' CreatePlatformApplicationResponse Int

• - | The response status code.