[−][src]Struct rusoto_sns::SubscribeInput
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.
endpoint: Option<String>
The endpoint that you want to receive notifications. Endpoints vary by protocol:
-
For the
http
protocol, the endpoint is an URL beginning withhttp://
-
For the
https
protocol, the 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 Amazon Lambda function.
protocol: String
The protocol 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 Amazon Lambda function.
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 have the subscription ARN returned, the response includes the ARN in all cases, even if the subscription is not yet confirmed.
-
If you don't have the subscription ARN returned, 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 theConfirmSubscription
action with a confirmation token.
If you set this parameter to true
, .
The default value is false
.
topic_arn: String
The ARN of the topic you want to subscribe to.
Trait Implementations
impl Clone for SubscribeInput
[src]
fn clone(&self) -> SubscribeInput
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for SubscribeInput
[src]
impl Default for SubscribeInput
[src]
fn default() -> SubscribeInput
[src]
impl PartialEq<SubscribeInput> for SubscribeInput
[src]
fn eq(&self, other: &SubscribeInput) -> bool
[src]
fn ne(&self, other: &SubscribeInput) -> bool
[src]
impl StructuralPartialEq for SubscribeInput
[src]
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 T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,