Struct aws_sdk_sns::input::SetSubscriptionAttributesInput

#[non_exhaustive]
pub struct SetSubscriptionAttributesInput {
    pub subscription_arn: Option<String>,
    pub attribute_name: Option<String>,
    pub attribute_value: Option<String>,
}

Input for SetSubscriptionAttributes 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.

subscription_arn: Option<String>

The ARN of the subscription to modify.

attribute_name: Option<String>

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that this action uses:

• DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

• FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.

• RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.

• RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

• SubscriptionRoleArn – The ARN of the IAM role that has the following:

  • Permission to write to the Kinesis Data Firehose delivery stream

  • Amazon SNS listed as a trusted entity

  Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.

attribute_value: Option<String>

The new value for the attribute in JSON format.

Implementations

impl SetSubscriptionAttributesInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<SetSubscriptionAttributes, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<SetSubscriptionAttributes>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture SetSubscriptionAttributesInput

impl SetSubscriptionAttributesInput

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

The ARN of the subscription to modify.

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

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that this action uses:

• DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

• FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.

• RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.

• RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

• SubscriptionRoleArn – The ARN of the IAM role that has the following:

  • Permission to write to the Kinesis Data Firehose delivery stream

  • Amazon SNS listed as a trusted entity

  Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.

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

The new value for the attribute in JSON format.

Trait Implementations

impl Clone for SetSubscriptionAttributesInput

fn clone(&self) -> SetSubscriptionAttributesInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SetSubscriptionAttributesInput

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

Formats the value using the given formatter.

impl PartialEq<SetSubscriptionAttributesInput> for SetSubscriptionAttributesInput

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

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

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

This method tests for !=.

impl StructuralPartialEq for SetSubscriptionAttributesInput