amazonka-sns-1.6.0: 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.CreatePlatformEndpoint

Contents

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 .

Synopsis

Creating a Request

createPlatformEndpoint Source #

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 # 
Data CreatePlatformEndpoint Source # 

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 # 
Show CreatePlatformEndpoint Source # 
Generic CreatePlatformEndpoint Source # 
Hashable CreatePlatformEndpoint Source # 
NFData CreatePlatformEndpoint Source # 

Methods

rnf :: CreatePlatformEndpoint -> () #

AWSRequest CreatePlatformEndpoint Source # 
ToHeaders CreatePlatformEndpoint Source # 
ToPath CreatePlatformEndpoint Source # 
ToQuery CreatePlatformEndpoint Source # 
type Rep CreatePlatformEndpoint Source # 
type Rep CreatePlatformEndpoint = D1 * (MetaData "CreatePlatformEndpoint" "Network.AWS.SNS.CreatePlatformEndpoint" "amazonka-sns-1.6.0-9aFI2fxVFLPtYIjs5ltfP" False) (C1 * (MetaCons "CreatePlatformEndpoint'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cpeCustomUserData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cpeAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cpePlatformApplicationARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_cpeToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))
type Rs CreatePlatformEndpoint Source # 

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.

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 #

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:

data CreatePlatformEndpointResponse Source #

Response from CreateEndpoint action.

See: createPlatformEndpointResponse smart constructor.

Instances

Eq CreatePlatformEndpointResponse Source # 
Data CreatePlatformEndpointResponse Source # 

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 # 
Show CreatePlatformEndpointResponse Source # 
Generic CreatePlatformEndpointResponse Source # 
NFData CreatePlatformEndpointResponse Source # 
type Rep CreatePlatformEndpointResponse Source # 
type Rep CreatePlatformEndpointResponse = D1 * (MetaData "CreatePlatformEndpointResponse" "Network.AWS.SNS.CreatePlatformEndpoint" "amazonka-sns-1.6.0-9aFI2fxVFLPtYIjs5ltfP" False) (C1 * (MetaCons "CreatePlatformEndpointResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_cpersEndpointARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cpersResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

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

EndpointArn returned from CreateEndpoint action.