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 |
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
- data SetPlatformApplicationAttributes = SetPlatformApplicationAttributes' {}
- newSetPlatformApplicationAttributes :: Text -> SetPlatformApplicationAttributes
- setPlatformApplicationAttributes_platformApplicationArn :: Lens' SetPlatformApplicationAttributes Text
- setPlatformApplicationAttributes_attributes :: Lens' SetPlatformApplicationAttributes (HashMap Text Text)
- data SetPlatformApplicationAttributesResponse = SetPlatformApplicationAttributesResponse' {
- newSetPlatformApplicationAttributesResponse :: SetPlatformApplicationAttributesResponse
Creating a Request
data SetPlatformApplicationAttributes Source #
Input for SetPlatformApplicationAttributes action.
See: newSetPlatformApplicationAttributes
smart constructor.
SetPlatformApplicationAttributes' | |
|
Instances
newSetPlatformApplicationAttributes Source #
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,
PlatformCredential
is 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.
- For ADM,
PlatformPrincipal
– The principal received from the notification service.- For ADM,
PlatformPrincipal
is 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
.
- For ADM,
EventEndpointCreated
– Topic ARN to whichEndpointCreated
event notifications are sent.EventEndpointDeleted
– Topic ARN to whichEndpointDeleted
event notifications are sent.EventEndpointUpdated
– Topic ARN to whichEndpointUpdate
event notifications are sent.EventDeliveryFailure
– Topic ARN to whichDeliveryFailure
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,
PlatformCredential
is 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.
- For ADM,
PlatformPrincipal
– The principal received from the notification service.- For ADM,
PlatformPrincipal
is 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
.
- For ADM,
EventEndpointCreated
– Topic ARN to whichEndpointCreated
event notifications are sent.EventEndpointDeleted
– Topic ARN to whichEndpointDeleted
event notifications are sent.EventEndpointUpdated
– Topic ARN to whichEndpointUpdate
event notifications are sent.EventDeliveryFailure
– Topic ARN to whichDeliveryFailure
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.
Instances
Generic SetPlatformApplicationAttributesResponse Source # | |
Defined in Amazonka.SNS.SetPlatformApplicationAttributes type Rep SetPlatformApplicationAttributesResponse :: Type -> Type # | |
Read SetPlatformApplicationAttributesResponse Source # | |
Show SetPlatformApplicationAttributesResponse Source # | |
NFData SetPlatformApplicationAttributesResponse Source # | |
Defined in Amazonka.SNS.SetPlatformApplicationAttributes rnf :: SetPlatformApplicationAttributesResponse -> () # | |
Eq SetPlatformApplicationAttributesResponse Source # | |
type Rep SetPlatformApplicationAttributesResponse Source # | |
Defined in Amazonka.SNS.SetPlatformApplicationAttributes type Rep SetPlatformApplicationAttributesResponse = D1 ('MetaData "SetPlatformApplicationAttributesResponse" "Amazonka.SNS.SetPlatformApplicationAttributes" "amazonka-sns-2.0-Jy408UFhFBG6svSKp3jUxJ" '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.