Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SNS.SetPlatformApplicationAttributes

Contents

Creating a Request
Request Lenses
Destructuring the Response

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.

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 ADM, PlatformCredentialis client secret.
  - For Apple Services using certificate credentials, PlatformCredential is private key.
  - For Apple Services using token credentials, PlatformCredential is signing key.
  - For GCM (Firebase Cloud Messaging), PlatformCredential is API key.
- PlatformPrincipal – The principal received from the notification service.
  - For ADM, PlatformPrincipalis client id.
  - For Apple Services using certificate credentials, PlatformPrincipal is SSL certificate.
  - For Apple Services using token credentials, PlatformPrincipal is signing key ID.
  - For GCM (Firebase Cloud Messaging), there is no PlatformPrincipal.
- 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.
The following attributes only apply to APNs token-based authentication:
- ApplePlatformTeamID – The identifier that's assigned to your Apple developer account team.
- ApplePlatformBundleID – The bundle identifier that's assigned to your iOS app.

Instances

Instances details

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 #
AWSRequest SetPlatformApplicationAttributes Source #
Instance details Defined in Amazonka.SNS.SetPlatformApplicationAttributes Associated Types type AWSResponse SetPlatformApplicationAttributes # Methods request :: (Service -> Service) -> SetPlatformApplicationAttributes -> Request SetPlatformApplicationAttributes # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SetPlatformApplicationAttributes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SetPlatformApplicationAttributes))) #
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 #
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 #
NFData SetPlatformApplicationAttributes Source #
Instance details Defined in Amazonka.SNS.SetPlatformApplicationAttributes Methods rnf :: SetPlatformApplicationAttributes -> () #
Eq SetPlatformApplicationAttributes Source #
Instance details Defined in Amazonka.SNS.SetPlatformApplicationAttributes Methods (==) :: SetPlatformApplicationAttributes -> SetPlatformApplicationAttributes -> Bool # (/=) :: SetPlatformApplicationAttributes -> SetPlatformApplicationAttributes -> Bool #
Hashable SetPlatformApplicationAttributes Source #
Instance details Defined in Amazonka.SNS.SetPlatformApplicationAttributes Methods hashWithSalt :: Int -> SetPlatformApplicationAttributes -> Int # hash :: SetPlatformApplicationAttributes -> Int #
type AWSResponse SetPlatformApplicationAttributes Source #
Instance details Defined in Amazonka.SNS.SetPlatformApplicationAttributes type AWSResponse SetPlatformApplicationAttributes = SetPlatformApplicationAttributesResponse
type Rep SetPlatformApplicationAttributes Source #
Instance details Defined in Amazonka.SNS.SetPlatformApplicationAttributes type Rep SetPlatformApplicationAttributes = D1 ('MetaData "SetPlatformApplicationAttributes" "Amazonka.SNS.SetPlatformApplicationAttributes" "amazonka-sns-2.0-4k7AiJI7DyqhOUy5o4qb9" '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))))

newSetPlatformApplicationAttributes Source #

Arguments

:: Text	`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:

SetPlatformApplicationAttributes, setPlatformApplicationAttributes_platformApplicationArn - PlatformApplicationArn for SetPlatformApplicationAttributes action.

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 ADM, PlatformCredentialis client secret.
- For Apple Services using certificate credentials, PlatformCredential is private key.
- For Apple Services using token credentials, PlatformCredential is signing key.
- For GCM (Firebase Cloud Messaging), PlatformCredential is API key.
PlatformPrincipal – The principal received from the notification service.
- For ADM, PlatformPrincipalis client id.
- For Apple Services using certificate credentials, PlatformPrincipal is SSL certificate.
- For Apple Services using token credentials, PlatformPrincipal is signing key ID.
- For GCM (Firebase Cloud Messaging), there is no PlatformPrincipal.
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.

The following attributes only apply to APNs token-based authentication:

ApplePlatformTeamID – The identifier that's assigned to your Apple developer account team.
ApplePlatformBundleID – The bundle identifier that's assigned to your iOS app.

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 ADM, PlatformCredentialis client secret.
- For Apple Services using certificate credentials, PlatformCredential is private key.
- For Apple Services using token credentials, PlatformCredential is signing key.
- For GCM (Firebase Cloud Messaging), PlatformCredential is API key.
PlatformPrincipal – The principal received from the notification service.
- For ADM, PlatformPrincipalis client id.
- For Apple Services using certificate credentials, PlatformPrincipal is SSL certificate.
- For Apple Services using token credentials, PlatformPrincipal is signing key ID.
- For GCM (Firebase Cloud Messaging), there is no PlatformPrincipal.
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.

The following attributes only apply to APNs token-based authentication:

ApplePlatformTeamID – The identifier that's assigned to your Apple developer account team.
ApplePlatformBundleID – The bundle identifier that's assigned to your iOS app.

Destructuring the Response

data SetPlatformApplicationAttributesResponse Source #

See: newSetPlatformApplicationAttributesResponse smart constructor.

Constructors

SetPlatformApplicationAttributesResponse'

Instances

Instances details

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 #
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 #
NFData SetPlatformApplicationAttributesResponse Source #
Instance details Defined in Amazonka.SNS.SetPlatformApplicationAttributes Methods rnf :: SetPlatformApplicationAttributesResponse -> () #
Eq SetPlatformApplicationAttributesResponse Source #
Instance details Defined in Amazonka.SNS.SetPlatformApplicationAttributes Methods (==) :: SetPlatformApplicationAttributesResponse -> SetPlatformApplicationAttributesResponse -> Bool # (/=) :: SetPlatformApplicationAttributesResponse -> SetPlatformApplicationAttributesResponse -> Bool #
type Rep SetPlatformApplicationAttributesResponse Source #
Instance details Defined in Amazonka.SNS.SetPlatformApplicationAttributes type Rep SetPlatformApplicationAttributesResponse = D1 ('MetaData "SetPlatformApplicationAttributesResponse" "Amazonka.SNS.SetPlatformApplicationAttributes" "amazonka-sns-2.0-4k7AiJI7DyqhOUy5o4qb9" '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.