Copyright	(c) 2013-2018 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
Language	Haskell2010

Network.AWS.SNS.CreatePlatformEndpoint

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication . The EndpointArn that is returned when using CreatePlatformEndpoint can then be used by the Publish action to send a message to a mobile app or by the Subscribe action for subscription to a topic. The CreatePlatformEndpoint action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see Using Amazon SNS Mobile Push Notifications .

When using CreatePlatformEndpoint with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see Creating an Amazon SNS Endpoint for Baidu .

Creating a Request

createPlatformEndpoint Source #

Arguments

:: Text	`cpePlatformApplicationARN`
-> Text	`cpeToken`
-> CreatePlatformEndpoint

Creates a value of CreatePlatformEndpoint with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cpeCustomUserData - Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.
cpeAttributes - For a list of attributes, see SetEndpointAttributes .
cpePlatformApplicationARN - PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
cpeToken - Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.

data CreatePlatformEndpoint Source #

Input for CreatePlatformEndpoint action.

See: createPlatformEndpoint smart constructor.

Instances

Eq CreatePlatformEndpoint Source #
Instance details Defined in Network.AWS.SNS.CreatePlatformEndpoint Methods (==) :: CreatePlatformEndpoint -> CreatePlatformEndpoint -> Bool # (/=) :: CreatePlatformEndpoint -> CreatePlatformEndpoint -> Bool #
Data CreatePlatformEndpoint Source #
Instance details Defined in Network.AWS.SNS.CreatePlatformEndpoint Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreatePlatformEndpoint -> c CreatePlatformEndpoint # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreatePlatformEndpoint # toConstr :: CreatePlatformEndpoint -> Constr # dataTypeOf :: CreatePlatformEndpoint -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreatePlatformEndpoint) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreatePlatformEndpoint) # gmapT :: (forall b. Data b => b -> b) -> CreatePlatformEndpoint -> CreatePlatformEndpoint # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreatePlatformEndpoint -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreatePlatformEndpoint -> r # gmapQ :: (forall d. Data d => d -> u) -> CreatePlatformEndpoint -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CreatePlatformEndpoint -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreatePlatformEndpoint -> m CreatePlatformEndpoint # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreatePlatformEndpoint -> m CreatePlatformEndpoint # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreatePlatformEndpoint -> m CreatePlatformEndpoint #
Read CreatePlatformEndpoint Source #
Instance details Defined in Network.AWS.SNS.CreatePlatformEndpoint Methods readsPrec :: Int -> ReadS CreatePlatformEndpoint # readList :: ReadS [CreatePlatformEndpoint] # readPrec :: ReadPrec CreatePlatformEndpoint # readListPrec :: ReadPrec [CreatePlatformEndpoint] #
Show CreatePlatformEndpoint Source #
Instance details Defined in Network.AWS.SNS.CreatePlatformEndpoint Methods showsPrec :: Int -> CreatePlatformEndpoint -> ShowS # show :: CreatePlatformEndpoint -> String # showList :: [CreatePlatformEndpoint] -> ShowS #
Generic CreatePlatformEndpoint Source #
Instance details Defined in Network.AWS.SNS.CreatePlatformEndpoint Associated Types type Rep CreatePlatformEndpoint :: Type -> Type # Methods from :: CreatePlatformEndpoint -> Rep CreatePlatformEndpoint x # to :: Rep CreatePlatformEndpoint x -> CreatePlatformEndpoint #
Hashable CreatePlatformEndpoint Source #
Instance details Defined in Network.AWS.SNS.CreatePlatformEndpoint Methods hashWithSalt :: Int -> CreatePlatformEndpoint -> Int # hash :: CreatePlatformEndpoint -> Int #
AWSRequest CreatePlatformEndpoint Source #
Instance details Defined in Network.AWS.SNS.CreatePlatformEndpoint Associated Types type Rs CreatePlatformEndpoint :: Type # Methods request :: CreatePlatformEndpoint -> Request CreatePlatformEndpoint # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy CreatePlatformEndpoint -> ClientResponse -> m (Response CreatePlatformEndpoint) #
ToHeaders CreatePlatformEndpoint Source #
Instance details Defined in Network.AWS.SNS.CreatePlatformEndpoint Methods toHeaders :: CreatePlatformEndpoint -> [Header] #
ToPath CreatePlatformEndpoint Source #
Instance details Defined in Network.AWS.SNS.CreatePlatformEndpoint Methods toPath :: CreatePlatformEndpoint -> ByteString #
ToQuery CreatePlatformEndpoint Source #
Instance details Defined in Network.AWS.SNS.CreatePlatformEndpoint Methods toQuery :: CreatePlatformEndpoint -> QueryString #
NFData CreatePlatformEndpoint Source #
Instance details Defined in Network.AWS.SNS.CreatePlatformEndpoint Methods rnf :: CreatePlatformEndpoint -> () #
type Rep CreatePlatformEndpoint Source #
Instance details Defined in Network.AWS.SNS.CreatePlatformEndpoint type Rep CreatePlatformEndpoint = D1 (MetaData "CreatePlatformEndpoint" "Network.AWS.SNS.CreatePlatformEndpoint" "amazonka-sns-1.6.1-7GBYpIO1P7AJWNWtL33amk" False) (C1 (MetaCons "CreatePlatformEndpoint'" PrefixI True) ((S1 (MetaSel (Just "_cpeCustomUserData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_cpeAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) :: (S1 (MetaSel (Just "_cpePlatformApplicationARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_cpeToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs CreatePlatformEndpoint Source #
Instance details Defined in Network.AWS.SNS.CreatePlatformEndpoint type Rs CreatePlatformEndpoint = CreatePlatformEndpointResponse

Request Lenses

cpeCustomUserData :: Lens' CreatePlatformEndpoint (Maybe Text) Source #

Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

cpeAttributes :: Lens' CreatePlatformEndpoint (HashMap Text Text) Source #

For a list of attributes, see SetEndpointAttributes .

cpePlatformApplicationARN :: Lens' CreatePlatformEndpoint Text Source #

PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.

cpeToken :: Lens' CreatePlatformEndpoint Text Source #

Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.

Destructuring the Response

createPlatformEndpointResponse Source #

Arguments

:: Int	`cpersResponseStatus`
-> CreatePlatformEndpointResponse

Creates a value of CreatePlatformEndpointResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cpersEndpointARN - EndpointArn returned from CreateEndpoint action.
cpersResponseStatus - -- | The response status code.

data CreatePlatformEndpointResponse Source #

Response from CreateEndpoint action.

See: createPlatformEndpointResponse smart constructor.

Instances

Eq CreatePlatformEndpointResponse Source #
Instance details Defined in Network.AWS.SNS.CreatePlatformEndpoint Methods (==) :: CreatePlatformEndpointResponse -> CreatePlatformEndpointResponse -> Bool # (/=) :: CreatePlatformEndpointResponse -> CreatePlatformEndpointResponse -> Bool #
Data CreatePlatformEndpointResponse Source #
Instance details Defined in Network.AWS.SNS.CreatePlatformEndpoint Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreatePlatformEndpointResponse -> c CreatePlatformEndpointResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreatePlatformEndpointResponse # toConstr :: CreatePlatformEndpointResponse -> Constr # dataTypeOf :: CreatePlatformEndpointResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreatePlatformEndpointResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreatePlatformEndpointResponse) # gmapT :: (forall b. Data b => b -> b) -> CreatePlatformEndpointResponse -> CreatePlatformEndpointResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreatePlatformEndpointResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreatePlatformEndpointResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> CreatePlatformEndpointResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CreatePlatformEndpointResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreatePlatformEndpointResponse -> m CreatePlatformEndpointResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreatePlatformEndpointResponse -> m CreatePlatformEndpointResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreatePlatformEndpointResponse -> m CreatePlatformEndpointResponse #
Read CreatePlatformEndpointResponse Source #
Instance details Defined in Network.AWS.SNS.CreatePlatformEndpoint Methods readsPrec :: Int -> ReadS CreatePlatformEndpointResponse # readList :: ReadS [CreatePlatformEndpointResponse] # readPrec :: ReadPrec CreatePlatformEndpointResponse # readListPrec :: ReadPrec [CreatePlatformEndpointResponse] #
Show CreatePlatformEndpointResponse Source #
Instance details Defined in Network.AWS.SNS.CreatePlatformEndpoint Methods showsPrec :: Int -> CreatePlatformEndpointResponse -> ShowS # show :: CreatePlatformEndpointResponse -> String # showList :: [CreatePlatformEndpointResponse] -> ShowS #
Generic CreatePlatformEndpointResponse Source #
Instance details Defined in Network.AWS.SNS.CreatePlatformEndpoint Associated Types type Rep CreatePlatformEndpointResponse :: Type -> Type # Methods from :: CreatePlatformEndpointResponse -> Rep CreatePlatformEndpointResponse x # to :: Rep CreatePlatformEndpointResponse x -> CreatePlatformEndpointResponse #
NFData CreatePlatformEndpointResponse Source #
Instance details Defined in Network.AWS.SNS.CreatePlatformEndpoint Methods rnf :: CreatePlatformEndpointResponse -> () #
type Rep CreatePlatformEndpointResponse Source #
Instance details Defined in Network.AWS.SNS.CreatePlatformEndpoint type Rep CreatePlatformEndpointResponse = D1 (MetaData "CreatePlatformEndpointResponse" "Network.AWS.SNS.CreatePlatformEndpoint" "amazonka-sns-1.6.1-7GBYpIO1P7AJWNWtL33amk" False) (C1 (MetaCons "CreatePlatformEndpointResponse'" PrefixI True) (S1 (MetaSel (Just "_cpersEndpointARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cpersResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

cpersEndpointARN :: Lens' CreatePlatformEndpointResponse (Maybe Text) Source #

EndpointArn returned from CreateEndpoint action.

cpersResponseStatus :: Lens' CreatePlatformEndpointResponse Int Source #

- | The response status code.