Struct aws_sdk_sns::operation::set_platform_application_attributes::SetPlatformApplicationAttributesInput

#[non_exhaustive]
pub struct SetPlatformApplicationAttributesInput {
    pub platform_application_arn: Option<String>,
    pub attributes: Option<HashMap<String, String>>,
}

Input for SetPlatformApplicationAttributes action.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

platform_application_arn: Option<String>

PlatformApplicationArn for SetPlatformApplicationAttributes action.

attributes: Option<HashMap<String, String>>

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) using key credentials, there is no PlatformPrincipal. The PlatformCredential is API key.

  • For GCM (Firebase Cloud Messaging) using token credentials, there is no PlatformPrincipal. The PlatformCredential is a JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command: SERVICE_JSON=`jq @json <<< cat service.json`.

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

Implementations

impl SetPlatformApplicationAttributesInput

pub fn platform_application_arn(&self) -> Option<&str>

PlatformApplicationArn for SetPlatformApplicationAttributes action.

pub fn attributes(&self) -> Option<&HashMap<String, String>>

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) using key credentials, there is no PlatformPrincipal. The PlatformCredential is API key.

  • For GCM (Firebase Cloud Messaging) using token credentials, there is no PlatformPrincipal. The PlatformCredential is a JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command: SERVICE_JSON=`jq @json <<< cat service.json`.

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

impl SetPlatformApplicationAttributesInput

pub fn builder() -> SetPlatformApplicationAttributesInputBuilder

Creates a new builder-style object to manufacture SetPlatformApplicationAttributesInput.

Trait Implementations

impl Clone for SetPlatformApplicationAttributesInput

fn clone(&self) -> SetPlatformApplicationAttributesInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SetPlatformApplicationAttributesInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for SetPlatformApplicationAttributesInput

fn eq(&self, other: &SetPlatformApplicationAttributesInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SetPlatformApplicationAttributesInput