Struct rusoto_sns::SubscribeInput
source · [−]pub struct SubscribeInput {
pub attributes: Option<HashMap<String, String>>,
pub endpoint: Option<String>,
pub protocol: String,
pub return_subscription_arn: Option<bool>,
pub topic_arn: String,
}
Expand description
Input for Subscribe action.
Fields
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 SetTopicAttributes
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 totrue
, 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.
-
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 withhttp://
. -
For the
https
protocol, the (public) endpoint is a URL beginning withhttps://
. -
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 AWS Lambda function. -
For the
firehose
protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.
protocol: 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 AWS Lambda function -
firehose
– delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.
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
.
topic_arn: String
The ARN of the topic you want to subscribe to.
Trait Implementations
sourceimpl Clone for SubscribeInput
impl Clone for SubscribeInput
sourcefn clone(&self) -> SubscribeInput
fn clone(&self) -> SubscribeInput
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for SubscribeInput
impl Debug for SubscribeInput
sourceimpl Default for SubscribeInput
impl Default for SubscribeInput
sourcefn default() -> SubscribeInput
fn default() -> SubscribeInput
Returns the “default value” for a type. Read more
sourceimpl PartialEq<SubscribeInput> for SubscribeInput
impl PartialEq<SubscribeInput> for SubscribeInput
sourcefn eq(&self, other: &SubscribeInput) -> bool
fn eq(&self, other: &SubscribeInput) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &SubscribeInput) -> bool
fn ne(&self, other: &SubscribeInput) -> bool
This method tests for !=
.
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more