Struct aws_sdk_sns::Client

source · [−]
pub struct Client { /* private fields */ }
Expand description

Client for Amazon Simple Notification Service

Client for invoking operations on Amazon Simple Notification Service. Each operation on Amazon Simple Notification Service is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_sns::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_sns::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_sns::Client::from_conf(config);

Implementations

Creates a client with the given service configuration.

Returns the client’s configuration.

Constructs a fluent builder for the AddPermission operation.

Constructs a fluent builder for the CheckIfPhoneNumberIsOptedOut operation.

Constructs a fluent builder for the ConfirmSubscription operation.

Constructs a fluent builder for the CreatePlatformApplication operation.

Constructs a fluent builder for the CreatePlatformEndpoint operation.

Constructs a fluent builder for the CreateSMSSandboxPhoneNumber operation.

Constructs a fluent builder for the CreateTopic operation.

  • The fluent builder is configurable:
    • name(impl Into<String>) / set_name(Option<String>):

      The name of the topic you want to create.

      Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.

      For a FIFO (first-in-first-out) topic, the name must end with the .fifo suffix.

    • attributes(HashMap<String, String>) / set_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 CreateTopic action uses:

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

      • DisplayName – The display name to use for a topic with SMS subscriptions.

      • FifoTopic – Set to true to create a FIFO topic.

      • Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.

      The following attribute applies only to server-side encryption:

      • KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.

      The following attributes apply only to FIFO topics:

      • FifoTopic – When this is set to true, a FIFO topic is created.

      • ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.

        • By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.

        • When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

          (Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.

    • tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

      The list of tags to add to a new topic.

      To be able to tag a topic on creation, you must have the sns:CreateTopic and sns:TagResource permissions.

  • On success, responds with CreateTopicOutput with field(s):
  • On failure, responds with SdkError<CreateTopicError>

Constructs a fluent builder for the DeleteEndpoint operation.

Constructs a fluent builder for the DeletePlatformApplication operation.

Constructs a fluent builder for the DeleteSMSSandboxPhoneNumber operation.

Constructs a fluent builder for the DeleteTopic operation.

Constructs a fluent builder for the GetEndpointAttributes operation.

  • The fluent builder is configurable:
  • On success, responds with GetEndpointAttributesOutput with field(s):
    • attributes(Option<HashMap<String, String>>):

      Attributes 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.

        The device token for the iOS platform is returned in lowercase.
  • On failure, responds with SdkError<GetEndpointAttributesError>

Constructs a fluent builder for the GetPlatformApplicationAttributes operation.

  • The fluent builder is configurable:
  • On success, responds with GetPlatformApplicationAttributesOutput with field(s):
    • attributes(Option<HashMap<String, String>>):

      Attributes include the following:

      • AppleCertificateExpiryDate – The expiry date of the SSL certificate used to configure certificate-based authentication.

      • ApplePlatformTeamID – The Apple developer account ID used to configure token-based authentication.

      • ApplePlatformBundleID – The app identifier used to configure token-based authentication.

      • EventEndpointCreated – Topic ARN to which EndpointCreated event notifications should be sent.

      • EventEndpointDeleted – Topic ARN to which EndpointDeleted event notifications should be sent.

      • EventEndpointUpdated – Topic ARN to which EndpointUpdate event notifications should be sent.

      • EventDeliveryFailure – Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application’s endpoints.

  • On failure, responds with SdkError<GetPlatformApplicationAttributesError>

Constructs a fluent builder for the GetSMSAttributes operation.

Constructs a fluent builder for the GetSMSSandboxAccountStatus operation.

Constructs a fluent builder for the GetSubscriptionAttributes operation.

  • The fluent builder is configurable:
  • On success, responds with GetSubscriptionAttributesOutput with field(s):
    • attributes(Option<HashMap<String, String>>):

      A map of the subscription’s attributes. Attributes in this map include the following:

      • ConfirmationWasAuthenticated – true if the subscription confirmation request was authenticated.

      • DeliveryPolicy – The JSON serialization of the subscription’s delivery policy.

      • EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.

      • FilterPolicy – The filter policy JSON that is assigned to the subscription. For more information, see Amazon SNS Message Filtering in the Amazon SNS Developer Guide.

      • Owner – The Amazon Web Services account ID of the subscription’s owner.

      • PendingConfirmation – true if the subscription hasn’t been confirmed. To confirm a pending subscription, call the ConfirmSubscription action with a confirmation token.

      • RawMessageDelivery – true if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.

      • 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.

      • SubscriptionArn – The subscription’s ARN.

      • TopicArn – The topic ARN that the subscription is associated with.

      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.

  • On failure, responds with SdkError<GetSubscriptionAttributesError>

Constructs a fluent builder for the GetTopicAttributes operation.

  • The fluent builder is configurable:
  • On success, responds with GetTopicAttributesOutput with field(s):
    • attributes(Option<HashMap<String, String>>):

      A map of the topic’s attributes. Attributes in this map include the following:

      • DeliveryPolicy – The JSON serialization of the topic’s delivery policy.

      • DisplayName – The human-readable name used in the From field for notifications to email and email-json endpoints.

      • Owner – The Amazon Web Services account ID of the topic’s owner.

      • Policy – The JSON serialization of the topic’s access control policy.

      • SubscriptionsConfirmed – The number of confirmed subscriptions for the topic.

      • SubscriptionsDeleted – The number of deleted subscriptions for the topic.

      • SubscriptionsPending – The number of subscriptions pending confirmation for the topic.

      • TopicArn – The topic’s ARN.

      • EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy, taking system defaults into account.

      The following attribute applies only to server-side-encryption:

      • KmsMasterKeyId - The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.

      The following attributes apply only to FIFO topics:

      • FifoTopic – When this is set to true, a FIFO topic is created.

      • ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.

        • By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.

        • When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

          (Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.

  • On failure, responds with SdkError<GetTopicAttributesError>

Constructs a fluent builder for the ListEndpointsByPlatformApplication operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListOriginationNumbers operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListPhoneNumbersOptedOut operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListPlatformApplications operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListSMSSandboxPhoneNumbers operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListSubscriptions operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListSubscriptionsByTopic operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListTagsForResource operation.

Constructs a fluent builder for the ListTopics operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the OptInPhoneNumber operation.

Constructs a fluent builder for the Publish operation.

  • The fluent builder is configurable:
    • topic_arn(impl Into<String>) / set_topic_arn(Option<String>):

      The topic you want to publish to.

      If you don’t specify a value for the TopicArn parameter, you must specify a value for the PhoneNumber or TargetArn parameters.

    • target_arn(impl Into<String>) / set_target_arn(Option<String>):

      If you don’t specify a value for the TargetArn parameter, you must specify a value for the PhoneNumber or TopicArn parameters.

    • phone_number(impl Into<String>) / set_phone_number(Option<String>):

      The phone number to which you want to deliver an SMS message. Use E.164 format.

      If you don’t specify a value for the PhoneNumber parameter, you must specify a value for the TargetArn or TopicArn parameters.

    • message(impl Into<String>) / set_message(Option<String>):

      The message you want to send.

      If you are publishing to a topic and you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the MessageStructure parameter to json and use a JSON object for the Message parameter.

      Constraints:

      • With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).

      • For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters.

        If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren’t truncated mid-word but are cut off at whole-word boundaries.

        The total size limit for a single SMS Publish action is 1,600 characters.

      JSON-specific constraints:

      • Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.

      • The values will be parsed (unescaped) before they are used in outgoing messages.

      • Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).

      • Values have a minimum length of 0 (the empty string, “”, is allowed).

      • Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).

      • Non-string values will cause the key to be ignored.

      • Keys that do not correspond to supported transport protocols are ignored.

      • Duplicate keys are not allowed.

      • Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).

    • subject(impl Into<String>) / set_subject(Option<String>):

      Optional parameter to be used as the “Subject” line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.

      Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.

    • message_structure(impl Into<String>) / set_message_structure(Option<String>):

      Set MessageStructure to json if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set MessageStructure to json, the value of the Message parameter must:

      • be a syntactically valid JSON object; and

      • contain at least a top-level JSON key of “default” with a value that is a string.

      You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., “http”).

      Valid value: json

    • message_attributes(HashMap<String, MessageAttributeValue>) / set_message_attributes(Option<HashMap<String, MessageAttributeValue>>):

      Message attributes for Publish action.

    • message_deduplication_id(impl Into<String>) / set_message_deduplication_id(Option<String>):

      This parameter applies only to FIFO (first-in-first-out) topics. The MessageDeduplicationId can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!“#$%&’()*+,-./:;<=>?@[]^_`{|}~).

      Every message must have a unique MessageDeduplicationId, which is a token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any message sent with the same MessageDeduplicationId during the 5-minute deduplication interval is treated as a duplicate.

      If the topic has ContentBasedDeduplication set, the system generates a MessageDeduplicationId based on the contents of the message. Your MessageDeduplicationId overrides the generated one.

    • message_group_id(impl Into<String>) / set_message_group_id(Option<String>):

      This parameter applies only to FIFO (first-in-first-out) topics. The MessageGroupId can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!“#$%&’()*+,-./:;<=>?@[]^_`{|}~).

      The MessageGroupId is a tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). Every message must include a MessageGroupId.

  • On success, responds with PublishOutput with field(s):
    • message_id(Option<String>):

      Unique identifier assigned to the published message.

      Length Constraint: Maximum 100 characters

    • sequence_number(Option<String>):

      This response element applies only to FIFO (first-in-first-out) topics.

      The sequence number is a large, non-consecutive number that Amazon SNS assigns to each message. The length of SequenceNumber is 128 bits. SequenceNumber continues to increase for each MessageGroupId.

  • On failure, responds with SdkError<PublishError>

Constructs a fluent builder for the PublishBatch operation.

Constructs a fluent builder for the RemovePermission operation.

Constructs a fluent builder for the SetEndpointAttributes operation.

  • The fluent builder is configurable:
    • endpoint_arn(impl Into<String>) / set_endpoint_arn(Option<String>):

      EndpointArn used for SetEndpointAttributes action.

    • attributes(HashMap<String, String>) / set_attributes(Option<HashMap<String, String>>):

      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.

  • On success, responds with SetEndpointAttributesOutput
  • On failure, responds with SdkError<SetEndpointAttributesError>

Constructs a fluent builder for the SetPlatformApplicationAttributes operation.

  • The fluent builder is configurable:
    • platform_application_arn(impl Into<String>) / set_platform_application_arn(Option<String>):

      PlatformApplicationArn for SetPlatformApplicationAttributes action.

    • attributes(HashMap<String, String>) / set_attributes(Option<HashMap<String, String>>):

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

      • PlatformCredential – The credential received from the notification service.

        • For ADM, PlatformCredentialis client secret.

        • For Apple Services using certificate credentials, PlatformCredential is private key.

        • For Apple Services using token credentials, PlatformCredential is signing key.

        • For GCM (Firebase Cloud Messaging), PlatformCredential is API key.

      • PlatformPrincipal – The principal received from the notification service.

        • For ADM, PlatformPrincipalis client id.

        • For Apple Services using certificate credentials, PlatformPrincipal is SSL certificate.

        • For Apple Services using token credentials, PlatformPrincipal is signing key ID.

        • For GCM (Firebase Cloud Messaging), there is no PlatformPrincipal.

      • EventEndpointCreated – Topic ARN to which EndpointCreated event notifications are sent.

      • EventEndpointDeleted – Topic ARN to which EndpointDeleted event notifications are sent.

      • EventEndpointUpdated – Topic ARN to which EndpointUpdate event notifications are sent.

      • EventDeliveryFailure – Topic ARN to which DeliveryFailure event notifications are sent upon Direct Publish delivery failure (permanent) to one of the application’s endpoints.

      • SuccessFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.

      • FailureFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.

      • SuccessFeedbackSampleRate – Sample rate percentage (0-100) of successfully delivered messages.

      The following attributes only apply to APNs token-based authentication:

      • ApplePlatformTeamID – The identifier that’s assigned to your Apple developer account team.

      • ApplePlatformBundleID – The bundle identifier that’s assigned to your iOS app.

  • On success, responds with SetPlatformApplicationAttributesOutput
  • On failure, responds with SdkError<SetPlatformApplicationAttributesError>

Constructs a fluent builder for the SetSMSAttributes operation.

  • The fluent builder is configurable:
    • attributes(HashMap<String, String>) / set_attributes(Option<HashMap<String, String>>):

      The default settings for sending SMS messages from your Amazon Web Services account. You can set values for the following attribute names:

      MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.

      Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.

      By default, the spend limit is set to the maximum allowed by Amazon SNS. If you want to raise the limit, submit an SNS Limit Increase case. For New limit value, enter your desired monthly spend limit. In the Use Case Description field, explain that you are requesting an SMS monthly spend limit increase.

      DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.

      DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10.

      DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.

      DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:

      • Promotional – (Default) Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.

      • Transactional – Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.

      UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your Amazon Web Services account:

      • Time that the message was published (in UTC)

      • Message ID

      • Destination phone number

      • Message type

      • Delivery status

      • Message price (in USD)

      • Part number (a message is split into multiple parts if it is too long for a single message)

      • Total number of parts

      To receive the report, the bucket must have a policy that allows the Amazon SNS service principal to perform the s3:PutObject and s3:GetBucketLocation actions.

      For an example bucket policy and usage report, see Monitoring SMS Activity in the Amazon SNS Developer Guide.

  • On success, responds with SetSmsAttributesOutput
  • On failure, responds with SdkError<SetSMSAttributesError>

Constructs a fluent builder for the SetSubscriptionAttributes operation.

  • The fluent builder is configurable:
    • subscription_arn(impl Into<String>) / set_subscription_arn(Option<String>):

      The ARN of the subscription to modify.

    • attribute_name(impl Into<String>) / set_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(impl Into<String>) / set_attribute_value(Option<String>):

      The new value for the attribute in JSON format.

  • On success, responds with SetSubscriptionAttributesOutput
  • On failure, responds with SdkError<SetSubscriptionAttributesError>

Constructs a fluent builder for the SetTopicAttributes operation.

  • The fluent builder is configurable:
    • topic_arn(impl Into<String>) / set_topic_arn(Option<String>):

      The ARN of the topic to modify.

    • attribute_name(impl Into<String>) / set_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 the SetTopicAttributes action uses:

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

      • DisplayName – The display name to use for a topic with SMS subscriptions.

      • Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.

      The following attribute applies only to server-side-encryption:

      • KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.

      The following attribute applies only to FIFO topics:

      • ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.

        • By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.

        • When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

          (Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.

    • attribute_value(impl Into<String>) / set_attribute_value(Option<String>):

      The new value for the attribute.

  • On success, responds with SetTopicAttributesOutput
  • On failure, responds with SdkError<SetTopicAttributesError>

Constructs a fluent builder for the Subscribe operation.

  • The fluent builder is configurable:
    • topic_arn(impl Into<String>) / set_topic_arn(Option<String>):

      The ARN of the topic you want to subscribe to.

    • protocol(impl Into<String>) / set_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(impl Into<String>) / set_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(HashMap<String, String>) / set_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.

      • 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.

    • return_subscription_arn(bool) / set_return_subscription_arn(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.

  • On success, responds with SubscribeOutput with field(s):
    • subscription_arn(Option<String>):

      The ARN of the subscription if it is confirmed, or the string “pending confirmation” if the subscription requires confirmation. However, if the API request parameter ReturnSubscriptionArn is true, then the value is always the subscription ARN, even if the subscription requires confirmation.

  • On failure, responds with SdkError<SubscribeError>

Constructs a fluent builder for the TagResource operation.

Constructs a fluent builder for the Unsubscribe operation.

Constructs a fluent builder for the UntagResource operation.

Constructs a fluent builder for the VerifySMSSandboxPhoneNumber operation.

Creates a client with the given service config and connector override.

Creates a new client from a shared config.

Creates a new client from the service Config.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Converts to this type from the input type.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more