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

Description

Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications. For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status.

Synopsis

Creating a Request

data SetPlatformApplicationAttributes Source #

Input for SetPlatformApplicationAttributes action.

See: newSetPlatformApplicationAttributes smart constructor.

Constructors

SetPlatformApplicationAttributes' 

Fields

  • platformApplicationArn :: Text

    PlatformApplicationArn for SetPlatformApplicationAttributes action.

  • attributes :: HashMap Text Text

    A map of the platform application attributes. Attributes in this map include the following:

    • PlatformCredential – The credential received from the notification service. For APNS and APNS_SANDBOX, PlatformCredential is private key. For GCM (Firebase Cloud Messaging), PlatformCredential is API key. For ADM, PlatformCredential is client secret.
    • PlatformPrincipal – The principal received from the notification service. For APNS and APNS_SANDBOX, PlatformPrincipal is SSL certificate. For GCM (Firebase Cloud Messaging), there is no PlatformPrincipal. For ADM, PlatformPrincipal is client id.
    • EventEndpointCreated – Topic ARN to which EndpointCreated event notifications are sent.
    • EventEndpointDeleted – Topic ARN to which EndpointDeleted event notifications are sent.
    • EventEndpointUpdated – Topic ARN to which EndpointUpdate event notifications are sent.
    • EventDeliveryFailure – Topic ARN to which DeliveryFailure event notifications are sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.
    • SuccessFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.
    • FailureFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.
    • SuccessFeedbackSampleRate – Sample rate percentage (0-100) of successfully delivered messages.

Instances

Instances details
Eq SetPlatformApplicationAttributes Source # 
Instance details

Defined in Amazonka.SNS.SetPlatformApplicationAttributes

Methods

(==) :: SetPlatformApplicationAttributes -> SetPlatformApplicationAttributes -> Bool #

(/=) :: SetPlatformApplicationAttributes -> SetPlatformApplicationAttributes -> Bool #

Read SetPlatformApplicationAttributes Source # 
Instance details

Defined in Amazonka.SNS.SetPlatformApplicationAttributes

Methods

readsPrec :: Int -> ReadS SetPlatformApplicationAttributes #

readList :: ReadS [SetPlatformApplicationAttributes] #

readPrec :: ReadPrec SetPlatformApplicationAttributes #

readListPrec :: ReadPrec [SetPlatformApplicationAttributes] #

Show SetPlatformApplicationAttributes Source # 
Instance details

Defined in Amazonka.SNS.SetPlatformApplicationAttributes

Methods

showsPrec :: Int -> SetPlatformApplicationAttributes -> ShowS #

show :: SetPlatformApplicationAttributes -> String #

showList :: [SetPlatformApplicationAttributes] -> ShowS #

Generic SetPlatformApplicationAttributes Source # 
Instance details

Defined in Amazonka.SNS.SetPlatformApplicationAttributes

Associated Types

type Rep SetPlatformApplicationAttributes :: Type -> Type #

Methods

from :: SetPlatformApplicationAttributes -> Rep SetPlatformApplicationAttributes x #

to :: Rep SetPlatformApplicationAttributes x -> SetPlatformApplicationAttributes #

NFData SetPlatformApplicationAttributes Source # 
Instance details

Defined in Amazonka.SNS.SetPlatformApplicationAttributes

Methods

rnf :: SetPlatformApplicationAttributes -> () #

Hashable SetPlatformApplicationAttributes Source # 
Instance details

Defined in Amazonka.SNS.SetPlatformApplicationAttributes

Methods

hashWithSalt :: Int -> SetPlatformApplicationAttributes -> Int #

hash :: SetPlatformApplicationAttributes -> Int #

AWSRequest SetPlatformApplicationAttributes Source # 
Instance details

Defined in Amazonka.SNS.SetPlatformApplicationAttributes

Associated Types

type AWSResponse SetPlatformApplicationAttributes #

Methods

request :: SetPlatformApplicationAttributes -> Request SetPlatformApplicationAttributes #

response :: MonadResource m => Logger -> Service -> Proxy SetPlatformApplicationAttributes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SetPlatformApplicationAttributes))) #

ToHeaders SetPlatformApplicationAttributes Source # 
Instance details

Defined in Amazonka.SNS.SetPlatformApplicationAttributes

Methods

toHeaders :: SetPlatformApplicationAttributes -> [Header] #

ToPath SetPlatformApplicationAttributes Source # 
Instance details

Defined in Amazonka.SNS.SetPlatformApplicationAttributes

Methods

toPath :: SetPlatformApplicationAttributes -> ByteString #

ToQuery SetPlatformApplicationAttributes Source # 
Instance details

Defined in Amazonka.SNS.SetPlatformApplicationAttributes

Methods

toQuery :: SetPlatformApplicationAttributes -> QueryString #

type Rep SetPlatformApplicationAttributes Source # 
Instance details

Defined in Amazonka.SNS.SetPlatformApplicationAttributes

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

Defined in Amazonka.SNS.SetPlatformApplicationAttributes

type AWSResponse SetPlatformApplicationAttributes = SetPlatformApplicationAttributesResponse

newSetPlatformApplicationAttributes Source #

Arguments

:: Text

$sel:platformApplicationArn:SetPlatformApplicationAttributes'

-> SetPlatformApplicationAttributes 

Create a value of SetPlatformApplicationAttributes 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:platformApplicationArn:SetPlatformApplicationAttributes', setPlatformApplicationAttributes_platformApplicationArn - PlatformApplicationArn for SetPlatformApplicationAttributes action.

$sel:attributes:SetPlatformApplicationAttributes', setPlatformApplicationAttributes_attributes - A map of the platform application attributes. Attributes in this map include the following:

  • PlatformCredential – The credential received from the notification service. For APNS and APNS_SANDBOX, PlatformCredential is private key. For GCM (Firebase Cloud Messaging), PlatformCredential is API key. For ADM, PlatformCredential is client secret.
  • PlatformPrincipal – The principal received from the notification service. For APNS and APNS_SANDBOX, PlatformPrincipal is SSL certificate. For GCM (Firebase Cloud Messaging), there is no PlatformPrincipal. For ADM, PlatformPrincipal is client id.
  • EventEndpointCreated – Topic ARN to which EndpointCreated event notifications are sent.
  • EventEndpointDeleted – Topic ARN to which EndpointDeleted event notifications are sent.
  • EventEndpointUpdated – Topic ARN to which EndpointUpdate event notifications are sent.
  • EventDeliveryFailure – Topic ARN to which DeliveryFailure event notifications are sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.
  • SuccessFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.
  • FailureFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.
  • SuccessFeedbackSampleRate – Sample rate percentage (0-100) of successfully delivered messages.

Request Lenses

setPlatformApplicationAttributes_platformApplicationArn :: Lens' SetPlatformApplicationAttributes Text Source #

PlatformApplicationArn for SetPlatformApplicationAttributes action.

setPlatformApplicationAttributes_attributes :: Lens' SetPlatformApplicationAttributes (HashMap Text Text) Source #

A map of the platform application attributes. Attributes in this map include the following:

  • PlatformCredential – The credential received from the notification service. For APNS and APNS_SANDBOX, PlatformCredential is private key. For GCM (Firebase Cloud Messaging), PlatformCredential is API key. For ADM, PlatformCredential is client secret.
  • PlatformPrincipal – The principal received from the notification service. For APNS and APNS_SANDBOX, PlatformPrincipal is SSL certificate. For GCM (Firebase Cloud Messaging), there is no PlatformPrincipal. For ADM, PlatformPrincipal is client id.
  • EventEndpointCreated – Topic ARN to which EndpointCreated event notifications are sent.
  • EventEndpointDeleted – Topic ARN to which EndpointDeleted event notifications are sent.
  • EventEndpointUpdated – Topic ARN to which EndpointUpdate event notifications are sent.
  • EventDeliveryFailure – Topic ARN to which DeliveryFailure event notifications are sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.
  • SuccessFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.
  • FailureFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.
  • SuccessFeedbackSampleRate – Sample rate percentage (0-100) of successfully delivered messages.

Destructuring the Response

data SetPlatformApplicationAttributesResponse Source #

See: newSetPlatformApplicationAttributesResponse smart constructor.

Constructors

SetPlatformApplicationAttributesResponse' 

Instances

Instances details
Eq SetPlatformApplicationAttributesResponse Source # 
Instance details

Defined in Amazonka.SNS.SetPlatformApplicationAttributes

Methods

(==) :: SetPlatformApplicationAttributesResponse -> SetPlatformApplicationAttributesResponse -> Bool #

(/=) :: SetPlatformApplicationAttributesResponse -> SetPlatformApplicationAttributesResponse -> Bool #

Read SetPlatformApplicationAttributesResponse Source # 
Instance details

Defined in Amazonka.SNS.SetPlatformApplicationAttributes

Methods

readsPrec :: Int -> ReadS SetPlatformApplicationAttributesResponse #

readList :: ReadS [SetPlatformApplicationAttributesResponse] #

readPrec :: ReadPrec SetPlatformApplicationAttributesResponse #

readListPrec :: ReadPrec [SetPlatformApplicationAttributesResponse] #

Show SetPlatformApplicationAttributesResponse Source # 
Instance details

Defined in Amazonka.SNS.SetPlatformApplicationAttributes

Methods

showsPrec :: Int -> SetPlatformApplicationAttributesResponse -> ShowS #

show :: SetPlatformApplicationAttributesResponse -> String #

showList :: [SetPlatformApplicationAttributesResponse] -> ShowS #

Generic SetPlatformApplicationAttributesResponse Source # 
Instance details

Defined in Amazonka.SNS.SetPlatformApplicationAttributes

Associated Types

type Rep SetPlatformApplicationAttributesResponse :: Type -> Type #

Methods

from :: SetPlatformApplicationAttributesResponse -> Rep SetPlatformApplicationAttributesResponse x #

to :: Rep SetPlatformApplicationAttributesResponse x -> SetPlatformApplicationAttributesResponse #

NFData SetPlatformApplicationAttributesResponse Source # 
Instance details

Defined in Amazonka.SNS.SetPlatformApplicationAttributes

Methods

rnf :: SetPlatformApplicationAttributesResponse -> () #

type Rep SetPlatformApplicationAttributesResponse Source # 
Instance details

Defined in Amazonka.SNS.SetPlatformApplicationAttributes

type Rep SetPlatformApplicationAttributesResponse = D1 ('MetaData "SetPlatformApplicationAttributesResponse" "Amazonka.SNS.SetPlatformApplicationAttributes" "libZSservicesZSamazonka-snsZSamazonka-sns" 'False) (C1 ('MetaCons "SetPlatformApplicationAttributesResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newSetPlatformApplicationAttributesResponse :: SetPlatformApplicationAttributesResponse Source #

Create a value of SetPlatformApplicationAttributesResponse with all optional fields omitted.

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