Struct aws_sdk_sns::operation::subscribe::SubscribeInput

source ·

#[non_exhaustive]pub struct SubscribeInput {
    pub topic_arn: Option<String>,
    pub protocol: Option<String>,
    pub endpoint: Option<String>,
    pub attributes: Option<HashMap<String, String>>,
    pub return_subscription_arn: Option<bool>,
}

Expand description

Input for Subscribe action.

Fields (Non-exhaustive)§

This struct is marked as 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.

§topic_arn: Option<String>

The ARN of the topic you want to subscribe to.

§protocol: Option<String>

The protocol that you want to use. Supported protocols include:

http – delivery of JSON-encoded message via HTTP POST
https – delivery of JSON-encoded message via HTTPS POST
email – delivery of message via SMTP
email-json – delivery of JSON-encoded message via SMTP
sms – delivery of message via SMS
sqs – delivery of JSON-encoded message to an Amazon SQS queue
application – delivery of JSON-encoded message to an EndpointArn for a mobile app and device
lambda – delivery of JSON-encoded message to an Lambda function
firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.

§endpoint: Option<String>

The endpoint that you want to receive notifications. Endpoints vary by protocol:

For the http protocol, the (public) endpoint is a URL beginning with http://.
For the https protocol, the (public) endpoint is a URL beginning with https://.
For the email protocol, the endpoint is an email address.
For the email-json protocol, the endpoint is an email address.
For the sms protocol, the endpoint is a phone number of an SMS-enabled device.
For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue.
For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
For the lambda protocol, the endpoint is the ARN of an Lambda function.
For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.

§attributes: Option<HashMap<String, String>>

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the Subscribe 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.
FilterPolicyScope – This attribute lets you choose the filtering scope by using one of the following string value types:
- MessageAttributes (default) – The filter is applied on the message attributes.
- MessageBody – The filter is applied on the message body.
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.

The following attributes apply only to FIFO topics:

ReplayPolicy – Adds or updates an inline policy document for a subscription to replay messages stored in the specified Amazon SNS topic.
ReplayStatus – Retrieves the status of the subscription message replay, which can be one of the following:
- Completed – The replay has successfully redelivered all messages, and is now delivering newly published messages. If an ending point was specified in the ReplayPolicy then the subscription will no longer receive newly published messages.
- In progress – The replay is currently replaying the selected messages.
- Failed – The replay was unable to complete.
- Pending – The default state while the replay initiates.

§return_subscription_arn: Option<bool>

Sets whether the response from the Subscribe request includes the subscription ARN, even if the subscription is not yet confirmed.

If you set this parameter to true, the response includes the ARN in all cases, even if the subscription is not yet confirmed. In addition to the ARN for confirmed subscriptions, the response also includes the pending subscription ARN value for subscriptions that aren't yet confirmed. A subscription becomes confirmed when the subscriber calls the ConfirmSubscription action with a confirmation token.

The default value is false.

Struct aws_sdk_sns::operation::subscribe::SubscribeInput

Fields (Non-exhaustive)§

Implementations§

impl SubscribeInput

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

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

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

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

pub fn return_subscription_arn(&self) -> Option<bool>

impl SubscribeInput

pub fn builder() -> SubscribeInputBuilder

Trait Implementations§

impl Clone for SubscribeInput

fn clone(&self) -> SubscribeInput

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

impl Debug for SubscribeInput

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

impl PartialEq for SubscribeInput

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

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

impl StructuralPartialEq for SubscribeInput

Auto Trait Implementations§

impl RefUnwindSafe for SubscribeInput

impl Send for SubscribeInput

impl Sync for SubscribeInput

impl Unpin for SubscribeInput

impl UnwindSafe for SubscribeInput

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<Unshared, Shared> IntoShared<Shared> for Unsharedwhere Shared: FromUnshared<Unshared>,

fn into_shared(self) -> Shared

impl<T> Same for T

type Output = T

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T, U> Into<U> for T
where U: From<T>,

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

impl<T> ToOwned for T
where T: Clone,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,