Struct aws_sdk_sns::client::fluent_builders::SetPlatformApplicationAttributes

pub struct SetPlatformApplicationAttributes { /* private fields */ }

Fluent builder constructing a request to SetPlatformApplicationAttributes.

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.

Implementations

impl SetPlatformApplicationAttributes

pub async fn customize(
    self
) -> Result<CustomizableOperation<SetPlatformApplicationAttributes, AwsResponseRetryClassifier>, SdkError<SetPlatformApplicationAttributesError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<SetPlatformApplicationAttributesOutput, SdkError<SetPlatformApplicationAttributesError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn platform_application_arn(self, input: impl Into<String>) -> Self

PlatformApplicationArn for SetPlatformApplicationAttributes action.

pub fn set_platform_application_arn(self, input: Option<String>) -> Self

PlatformApplicationArn for SetPlatformApplicationAttributes action.

pub fn attributes(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to Attributes.

To override the contents of this collection use set_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.

pub fn set_attributes(self, input: Option<HashMap<String, String>>) -> Self

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.

Trait Implementations

impl Clone for SetPlatformApplicationAttributes

fn clone(&self) -> SetPlatformApplicationAttributes

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SetPlatformApplicationAttributes

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

Formats the value using the given formatter.