Struct aws_sdk_sns::client::fluent_builders::SetEndpointAttributes

pub struct SetEndpointAttributes { /* private fields */ }

Fluent builder constructing a request to SetEndpointAttributes.

Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.

Implementations

impl SetEndpointAttributes

pub async fn customize(
    self
) -> Result<CustomizableOperation<SetEndpointAttributes, AwsResponseRetryClassifier>, SdkError<SetEndpointAttributesError>>

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<SetEndpointAttributesOutput, SdkError<SetEndpointAttributesError>>

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 endpoint_arn(self, input: impl Into<String>) -> Self

EndpointArn used for SetEndpointAttributes action.

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

EndpointArn used for SetEndpointAttributes 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 endpoint attributes. Attributes in this map include the following:

• CustomUserData – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

• Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.

• Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

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

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

• CustomUserData – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

• Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.

• Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

Trait Implementations

impl Clone for SetEndpointAttributes

fn clone(&self) -> SetEndpointAttributes

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SetEndpointAttributes

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

Formats the value using the given formatter.