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

Amazonka.SNS.CreatePlatformEndpoint

Description

Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. You can use the returned EndpointArn 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

data CreatePlatformEndpoint Source #

Input for CreatePlatformEndpoint action.

See: newCreatePlatformEndpoint smart constructor.

Constructors

CreatePlatformEndpoint' 

Fields

  • customUserData :: Maybe Text

    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.

  • attributes :: Maybe (HashMap Text Text)

    For a list of attributes, see SetEndpointAttributes.

  • platformApplicationArn :: Text

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

  • token :: Text

    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 (Firebase Cloud Messaging) or ADM, the device token equivalent is called the registration ID.

Instances

Instances details
Eq CreatePlatformEndpoint Source # 
Instance details

Defined in Amazonka.SNS.CreatePlatformEndpoint

Read CreatePlatformEndpoint Source # 
Instance details

Defined in Amazonka.SNS.CreatePlatformEndpoint

Show CreatePlatformEndpoint Source # 
Instance details

Defined in Amazonka.SNS.CreatePlatformEndpoint

Generic CreatePlatformEndpoint Source # 
Instance details

Defined in Amazonka.SNS.CreatePlatformEndpoint

Associated Types

type Rep CreatePlatformEndpoint :: Type -> Type #

NFData CreatePlatformEndpoint Source # 
Instance details

Defined in Amazonka.SNS.CreatePlatformEndpoint

Methods

rnf :: CreatePlatformEndpoint -> () #

Hashable CreatePlatformEndpoint Source # 
Instance details

Defined in Amazonka.SNS.CreatePlatformEndpoint

AWSRequest CreatePlatformEndpoint Source # 
Instance details

Defined in Amazonka.SNS.CreatePlatformEndpoint

Associated Types

type AWSResponse CreatePlatformEndpoint #

ToHeaders CreatePlatformEndpoint Source # 
Instance details

Defined in Amazonka.SNS.CreatePlatformEndpoint

ToPath CreatePlatformEndpoint Source # 
Instance details

Defined in Amazonka.SNS.CreatePlatformEndpoint

ToQuery CreatePlatformEndpoint Source # 
Instance details

Defined in Amazonka.SNS.CreatePlatformEndpoint

type Rep CreatePlatformEndpoint Source # 
Instance details

Defined in Amazonka.SNS.CreatePlatformEndpoint

type Rep CreatePlatformEndpoint = D1 ('MetaData "CreatePlatformEndpoint" "Amazonka.SNS.CreatePlatformEndpoint" "libZSservicesZSamazonka-snsZSamazonka-sns" 'False) (C1 ('MetaCons "CreatePlatformEndpoint'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "customUserData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "platformApplicationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse CreatePlatformEndpoint Source # 
Instance details

Defined in Amazonka.SNS.CreatePlatformEndpoint

newCreatePlatformEndpoint Source #

Create a value of CreatePlatformEndpoint with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:customUserData:CreatePlatformEndpoint', createPlatformEndpoint_customUserData - 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.

$sel:attributes:CreatePlatformEndpoint', createPlatformEndpoint_attributes - For a list of attributes, see SetEndpointAttributes.

$sel:platformApplicationArn:CreatePlatformEndpoint', createPlatformEndpoint_platformApplicationArn - PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.

$sel:token:CreatePlatformEndpoint', createPlatformEndpoint_token - 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 (Firebase Cloud Messaging) or ADM, the device token equivalent is called the registration ID.

Request Lenses

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

createPlatformEndpoint_platformApplicationArn :: Lens' CreatePlatformEndpoint Text Source #

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

createPlatformEndpoint_token :: 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 (Firebase Cloud Messaging) or ADM, the device token equivalent is called the registration ID.

Destructuring the Response

data CreatePlatformEndpointResponse Source #

Response from CreateEndpoint action.

See: newCreatePlatformEndpointResponse smart constructor.

Constructors

CreatePlatformEndpointResponse' 

Fields

Instances

Instances details
Eq CreatePlatformEndpointResponse Source # 
Instance details

Defined in Amazonka.SNS.CreatePlatformEndpoint

Read CreatePlatformEndpointResponse Source # 
Instance details

Defined in Amazonka.SNS.CreatePlatformEndpoint

Show CreatePlatformEndpointResponse Source # 
Instance details

Defined in Amazonka.SNS.CreatePlatformEndpoint

Generic CreatePlatformEndpointResponse Source # 
Instance details

Defined in Amazonka.SNS.CreatePlatformEndpoint

Associated Types

type Rep CreatePlatformEndpointResponse :: Type -> Type #

NFData CreatePlatformEndpointResponse Source # 
Instance details

Defined in Amazonka.SNS.CreatePlatformEndpoint

type Rep CreatePlatformEndpointResponse Source # 
Instance details

Defined in Amazonka.SNS.CreatePlatformEndpoint

type Rep CreatePlatformEndpointResponse = D1 ('MetaData "CreatePlatformEndpointResponse" "Amazonka.SNS.CreatePlatformEndpoint" "libZSservicesZSamazonka-snsZSamazonka-sns" 'False) (C1 ('MetaCons "CreatePlatformEndpointResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endpointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreatePlatformEndpointResponse Source #

Create a value of CreatePlatformEndpointResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:endpointArn:CreatePlatformEndpointResponse', createPlatformEndpointResponse_endpointArn - EndpointArn returned from CreateEndpoint action.

$sel:httpStatus:CreatePlatformEndpointResponse', createPlatformEndpointResponse_httpStatus - The response's http status code.

Response Lenses