// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[derive(Debug)]
pub(crate) struct Handle {
pub(crate) client: aws_smithy_client::Client<
aws_smithy_client::erase::DynConnector,
aws_smithy_client::erase::DynMiddleware<aws_smithy_client::erase::DynConnector>,
>,
pub(crate) conf: crate::Config,
}
/// 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**
/// ```rust,no_run
/// # async fn docs() {
/// // 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**
/// ```rust,no_run
/// use aws_config::retry::RetryConfig;
/// # async fn docs() {
/// 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);
/// # }
#[derive(std::fmt::Debug)]
pub struct Client {
handle: std::sync::Arc<Handle>,
}
impl std::clone::Clone for Client {
fn clone(&self) -> Self {
Self {
handle: self.handle.clone(),
}
}
}
#[doc(inline)]
pub use aws_smithy_client::Builder;
impl
From<
aws_smithy_client::Client<
aws_smithy_client::erase::DynConnector,
aws_smithy_client::erase::DynMiddleware<aws_smithy_client::erase::DynConnector>,
>,
> for Client
{
fn from(
client: aws_smithy_client::Client<
aws_smithy_client::erase::DynConnector,
aws_smithy_client::erase::DynMiddleware<aws_smithy_client::erase::DynConnector>,
>,
) -> Self {
Self::with_config(client, crate::Config::builder().build())
}
}
impl Client {
/// Creates a client with the given service configuration.
pub fn with_config(
client: aws_smithy_client::Client<
aws_smithy_client::erase::DynConnector,
aws_smithy_client::erase::DynMiddleware<aws_smithy_client::erase::DynConnector>,
>,
conf: crate::Config,
) -> Self {
Self {
handle: std::sync::Arc::new(Handle { client, conf }),
}
}
/// Returns the client's configuration.
pub fn conf(&self) -> &crate::Config {
&self.handle.conf
}
}
impl Client {
/// Constructs a fluent builder for the [`AddPermission`](crate::client::fluent_builders::AddPermission) operation.
///
/// - The fluent builder is configurable:
/// - [`topic_arn(impl Into<String>)`](crate::client::fluent_builders::AddPermission::topic_arn) / [`set_topic_arn(Option<String>)`](crate::client::fluent_builders::AddPermission::set_topic_arn): <p>The ARN of the topic whose access control policy you wish to modify.</p>
/// - [`label(impl Into<String>)`](crate::client::fluent_builders::AddPermission::label) / [`set_label(Option<String>)`](crate::client::fluent_builders::AddPermission::set_label): <p>A unique identifier for the new policy statement.</p>
/// - [`aws_account_id(Vec<String>)`](crate::client::fluent_builders::AddPermission::aws_account_id) / [`set_aws_account_id(Option<Vec<String>>)`](crate::client::fluent_builders::AddPermission::set_aws_account_id): <p>The Amazon Web Services account IDs of the users (principals) who will be given access to the specified actions. The users must have Amazon Web Services account, but do not need to be signed up for this service.</p>
/// - [`action_name(Vec<String>)`](crate::client::fluent_builders::AddPermission::action_name) / [`set_action_name(Option<Vec<String>>)`](crate::client::fluent_builders::AddPermission::set_action_name): <p>The action you want to allow for the specified principal(s).</p> <p>Valid values: Any Amazon SNS action name, for example <code>Publish</code>.</p>
/// - On success, responds with [`AddPermissionOutput`](crate::output::AddPermissionOutput)
/// - On failure, responds with [`SdkError<AddPermissionError>`](crate::error::AddPermissionError)
pub fn add_permission(&self) -> fluent_builders::AddPermission {
fluent_builders::AddPermission::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`CheckIfPhoneNumberIsOptedOut`](crate::client::fluent_builders::CheckIfPhoneNumberIsOptedOut) operation.
///
/// - The fluent builder is configurable:
/// - [`phone_number(impl Into<String>)`](crate::client::fluent_builders::CheckIfPhoneNumberIsOptedOut::phone_number) / [`set_phone_number(Option<String>)`](crate::client::fluent_builders::CheckIfPhoneNumberIsOptedOut::set_phone_number): <p>The phone number for which you want to check the opt out status.</p>
/// - On success, responds with [`CheckIfPhoneNumberIsOptedOutOutput`](crate::output::CheckIfPhoneNumberIsOptedOutOutput) with field(s):
/// - [`is_opted_out(bool)`](crate::output::CheckIfPhoneNumberIsOptedOutOutput::is_opted_out): <p>Indicates whether the phone number is opted out:</p> <ul> <li> <p> <code>true</code> – The phone number is opted out, meaning you cannot publish SMS messages to it.</p> </li> <li> <p> <code>false</code> – The phone number is opted in, meaning you can publish SMS messages to it.</p> </li> </ul>
/// - On failure, responds with [`SdkError<CheckIfPhoneNumberIsOptedOutError>`](crate::error::CheckIfPhoneNumberIsOptedOutError)
pub fn check_if_phone_number_is_opted_out(
&self,
) -> fluent_builders::CheckIfPhoneNumberIsOptedOut {
fluent_builders::CheckIfPhoneNumberIsOptedOut::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ConfirmSubscription`](crate::client::fluent_builders::ConfirmSubscription) operation.
///
/// - The fluent builder is configurable:
/// - [`topic_arn(impl Into<String>)`](crate::client::fluent_builders::ConfirmSubscription::topic_arn) / [`set_topic_arn(Option<String>)`](crate::client::fluent_builders::ConfirmSubscription::set_topic_arn): <p>The ARN of the topic for which you wish to confirm a subscription.</p>
/// - [`token(impl Into<String>)`](crate::client::fluent_builders::ConfirmSubscription::token) / [`set_token(Option<String>)`](crate::client::fluent_builders::ConfirmSubscription::set_token): <p>Short-lived token sent to an endpoint during the <code>Subscribe</code> action.</p>
/// - [`authenticate_on_unsubscribe(impl Into<String>)`](crate::client::fluent_builders::ConfirmSubscription::authenticate_on_unsubscribe) / [`set_authenticate_on_unsubscribe(Option<String>)`](crate::client::fluent_builders::ConfirmSubscription::set_authenticate_on_unsubscribe): <p>Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is <code>true</code> and the request has an Amazon Web Services signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires Amazon Web Services authentication. </p>
/// - On success, responds with [`ConfirmSubscriptionOutput`](crate::output::ConfirmSubscriptionOutput) with field(s):
/// - [`subscription_arn(Option<String>)`](crate::output::ConfirmSubscriptionOutput::subscription_arn): <p>The ARN of the created subscription.</p>
/// - On failure, responds with [`SdkError<ConfirmSubscriptionError>`](crate::error::ConfirmSubscriptionError)
pub fn confirm_subscription(&self) -> fluent_builders::ConfirmSubscription {
fluent_builders::ConfirmSubscription::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`CreatePlatformApplication`](crate::client::fluent_builders::CreatePlatformApplication) operation.
///
/// - The fluent builder is configurable:
/// - [`name(impl Into<String>)`](crate::client::fluent_builders::CreatePlatformApplication::name) / [`set_name(Option<String>)`](crate::client::fluent_builders::CreatePlatformApplication::set_name): <p>Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.</p>
/// - [`platform(impl Into<String>)`](crate::client::fluent_builders::CreatePlatformApplication::platform) / [`set_platform(Option<String>)`](crate::client::fluent_builders::CreatePlatformApplication::set_platform): <p>The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging).</p>
/// - [`attributes(HashMap<String, String>)`](crate::client::fluent_builders::CreatePlatformApplication::attributes) / [`set_attributes(Option<HashMap<String, String>>)`](crate::client::fluent_builders::CreatePlatformApplication::set_attributes): <p>For a list of attributes, see <a href="https://docs.aws.amazon.com/sns/latest/api/API_SetPlatformApplicationAttributes.html">SetPlatformApplicationAttributes</a>.</p>
/// - On success, responds with [`CreatePlatformApplicationOutput`](crate::output::CreatePlatformApplicationOutput) with field(s):
/// - [`platform_application_arn(Option<String>)`](crate::output::CreatePlatformApplicationOutput::platform_application_arn): <p>PlatformApplicationArn is returned.</p>
/// - On failure, responds with [`SdkError<CreatePlatformApplicationError>`](crate::error::CreatePlatformApplicationError)
pub fn create_platform_application(&self) -> fluent_builders::CreatePlatformApplication {
fluent_builders::CreatePlatformApplication::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`CreatePlatformEndpoint`](crate::client::fluent_builders::CreatePlatformEndpoint) operation.
///
/// - The fluent builder is configurable:
/// - [`platform_application_arn(impl Into<String>)`](crate::client::fluent_builders::CreatePlatformEndpoint::platform_application_arn) / [`set_platform_application_arn(Option<String>)`](crate::client::fluent_builders::CreatePlatformEndpoint::set_platform_application_arn): <p>PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.</p>
/// - [`token(impl Into<String>)`](crate::client::fluent_builders::CreatePlatformEndpoint::token) / [`set_token(Option<String>)`](crate::client::fluent_builders::CreatePlatformEndpoint::set_token): <p>Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM (Firebase Cloud Messaging) or ADM, the device token equivalent is called the registration ID.</p>
/// - [`custom_user_data(impl Into<String>)`](crate::client::fluent_builders::CreatePlatformEndpoint::custom_user_data) / [`set_custom_user_data(Option<String>)`](crate::client::fluent_builders::CreatePlatformEndpoint::set_custom_user_data): <p>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.</p>
/// - [`attributes(HashMap<String, String>)`](crate::client::fluent_builders::CreatePlatformEndpoint::attributes) / [`set_attributes(Option<HashMap<String, String>>)`](crate::client::fluent_builders::CreatePlatformEndpoint::set_attributes): <p>For a list of attributes, see <a href="https://docs.aws.amazon.com/sns/latest/api/API_SetEndpointAttributes.html">SetEndpointAttributes</a>.</p>
/// - On success, responds with [`CreatePlatformEndpointOutput`](crate::output::CreatePlatformEndpointOutput) with field(s):
/// - [`endpoint_arn(Option<String>)`](crate::output::CreatePlatformEndpointOutput::endpoint_arn): <p>EndpointArn returned from CreateEndpoint action.</p>
/// - On failure, responds with [`SdkError<CreatePlatformEndpointError>`](crate::error::CreatePlatformEndpointError)
pub fn create_platform_endpoint(&self) -> fluent_builders::CreatePlatformEndpoint {
fluent_builders::CreatePlatformEndpoint::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`CreateSMSSandboxPhoneNumber`](crate::client::fluent_builders::CreateSMSSandboxPhoneNumber) operation.
///
/// - The fluent builder is configurable:
/// - [`phone_number(impl Into<String>)`](crate::client::fluent_builders::CreateSMSSandboxPhoneNumber::phone_number) / [`set_phone_number(Option<String>)`](crate::client::fluent_builders::CreateSMSSandboxPhoneNumber::set_phone_number): <p>The destination phone number to verify. On verification, Amazon SNS adds this phone number to the list of verified phone numbers that you can send SMS messages to.</p>
/// - [`language_code(LanguageCodeString)`](crate::client::fluent_builders::CreateSMSSandboxPhoneNumber::language_code) / [`set_language_code(Option<LanguageCodeString>)`](crate::client::fluent_builders::CreateSMSSandboxPhoneNumber::set_language_code): <p>The language to use for sending the OTP. The default value is <code>en-US</code>.</p>
/// - On success, responds with [`CreateSmsSandboxPhoneNumberOutput`](crate::output::CreateSmsSandboxPhoneNumberOutput)
/// - On failure, responds with [`SdkError<CreateSMSSandboxPhoneNumberError>`](crate::error::CreateSMSSandboxPhoneNumberError)
pub fn create_sms_sandbox_phone_number(&self) -> fluent_builders::CreateSMSSandboxPhoneNumber {
fluent_builders::CreateSMSSandboxPhoneNumber::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`CreateTopic`](crate::client::fluent_builders::CreateTopic) operation.
///
/// - The fluent builder is configurable:
/// - [`name(impl Into<String>)`](crate::client::fluent_builders::CreateTopic::name) / [`set_name(Option<String>)`](crate::client::fluent_builders::CreateTopic::set_name): <p>The name of the topic you want to create.</p> <p>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.</p> <p>For a FIFO (first-in-first-out) topic, the name must end with the <code>.fifo</code> suffix. </p>
/// - [`attributes(HashMap<String, String>)`](crate::client::fluent_builders::CreateTopic::attributes) / [`set_attributes(Option<HashMap<String, String>>)`](crate::client::fluent_builders::CreateTopic::set_attributes): <p>A map of attributes with their corresponding values.</p> <p>The following lists the names, descriptions, and values of the special request parameters that the <code>CreateTopic</code> action uses:</p> <ul> <li> <p> <code>DeliveryPolicy</code> – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.</p> </li> <li> <p> <code>DisplayName</code> – The display name to use for a topic with SMS subscriptions.</p> </li> <li> <p> <code>FifoTopic</code> – Set to true to create a FIFO topic.</p> </li> <li> <p> <code>Policy</code> – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.</p> </li> <li> <p> <code>SignatureVersion</code> – The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, <code>SignatureVersion</code> is set to 1.</p> </li> <li> <p> <code>TracingConfig</code> – Tracing mode of an Amazon SNS topic. By default <code>TracingConfig</code> is set to <code>PassThrough</code>, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.</p> </li> </ul> <p>The following attribute applies only to <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html">server-side encryption</a>:</p> <ul> <li> <p> <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms">Key Terms</a>. For more examples, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">KeyId</a> in the <i>Key Management Service API Reference</i>. </p> </li> </ul> <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html">FIFO topics</a>:</p> <ul> <li> <p> <code>FifoTopic</code> – When this is set to <code>true</code>, a FIFO topic is created.</p> </li> <li> <p> <code>ContentBasedDeduplication</code> – Enables content-based deduplication for FIFO topics.</p> <ul> <li> <p>By default, <code>ContentBasedDeduplication</code> is set to <code>false</code>. If you create a FIFO topic and this attribute is <code>false</code>, you must specify a value for the <code>MessageDeduplicationId</code> parameter for the <a href="https://docs.aws.amazon.com/sns/latest/api/API_Publish.html">Publish</a> action. </p> </li> <li> <p>When you set <code>ContentBasedDeduplication</code> to <code>true</code>, Amazon SNS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using the body of the message (but not the attributes of the message).</p> <p>(Optional) To override the generated value, you can specify a value for the <code>MessageDeduplicationId</code> parameter for the <code>Publish</code> action.</p> </li> </ul> </li> </ul>
/// - [`tags(Vec<Tag>)`](crate::client::fluent_builders::CreateTopic::tags) / [`set_tags(Option<Vec<Tag>>)`](crate::client::fluent_builders::CreateTopic::set_tags): <p>The list of tags to add to a new topic.</p> <note> <p>To be able to tag a topic on creation, you must have the <code>sns:CreateTopic</code> and <code>sns:TagResource</code> permissions.</p> </note>
/// - [`data_protection_policy(impl Into<String>)`](crate::client::fluent_builders::CreateTopic::data_protection_policy) / [`set_data_protection_policy(Option<String>)`](crate::client::fluent_builders::CreateTopic::set_data_protection_policy): <p>The body of the policy document you want to use for this topic.</p> <p>You can only add one policy per topic.</p> <p>The policy must be in JSON string format.</p> <p>Length Constraints: Maximum length of 30,720.</p>
/// - On success, responds with [`CreateTopicOutput`](crate::output::CreateTopicOutput) with field(s):
/// - [`topic_arn(Option<String>)`](crate::output::CreateTopicOutput::topic_arn): <p>The Amazon Resource Name (ARN) assigned to the created topic.</p>
/// - On failure, responds with [`SdkError<CreateTopicError>`](crate::error::CreateTopicError)
pub fn create_topic(&self) -> fluent_builders::CreateTopic {
fluent_builders::CreateTopic::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DeleteEndpoint`](crate::client::fluent_builders::DeleteEndpoint) operation.
///
/// - The fluent builder is configurable:
/// - [`endpoint_arn(impl Into<String>)`](crate::client::fluent_builders::DeleteEndpoint::endpoint_arn) / [`set_endpoint_arn(Option<String>)`](crate::client::fluent_builders::DeleteEndpoint::set_endpoint_arn): <p>EndpointArn of endpoint to delete.</p>
/// - On success, responds with [`DeleteEndpointOutput`](crate::output::DeleteEndpointOutput)
/// - On failure, responds with [`SdkError<DeleteEndpointError>`](crate::error::DeleteEndpointError)
pub fn delete_endpoint(&self) -> fluent_builders::DeleteEndpoint {
fluent_builders::DeleteEndpoint::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DeletePlatformApplication`](crate::client::fluent_builders::DeletePlatformApplication) operation.
///
/// - The fluent builder is configurable:
/// - [`platform_application_arn(impl Into<String>)`](crate::client::fluent_builders::DeletePlatformApplication::platform_application_arn) / [`set_platform_application_arn(Option<String>)`](crate::client::fluent_builders::DeletePlatformApplication::set_platform_application_arn): <p>PlatformApplicationArn of platform application object to delete.</p>
/// - On success, responds with [`DeletePlatformApplicationOutput`](crate::output::DeletePlatformApplicationOutput)
/// - On failure, responds with [`SdkError<DeletePlatformApplicationError>`](crate::error::DeletePlatformApplicationError)
pub fn delete_platform_application(&self) -> fluent_builders::DeletePlatformApplication {
fluent_builders::DeletePlatformApplication::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DeleteSMSSandboxPhoneNumber`](crate::client::fluent_builders::DeleteSMSSandboxPhoneNumber) operation.
///
/// - The fluent builder is configurable:
/// - [`phone_number(impl Into<String>)`](crate::client::fluent_builders::DeleteSMSSandboxPhoneNumber::phone_number) / [`set_phone_number(Option<String>)`](crate::client::fluent_builders::DeleteSMSSandboxPhoneNumber::set_phone_number): <p>The destination phone number to delete.</p>
/// - On success, responds with [`DeleteSmsSandboxPhoneNumberOutput`](crate::output::DeleteSmsSandboxPhoneNumberOutput)
/// - On failure, responds with [`SdkError<DeleteSMSSandboxPhoneNumberError>`](crate::error::DeleteSMSSandboxPhoneNumberError)
pub fn delete_sms_sandbox_phone_number(&self) -> fluent_builders::DeleteSMSSandboxPhoneNumber {
fluent_builders::DeleteSMSSandboxPhoneNumber::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DeleteTopic`](crate::client::fluent_builders::DeleteTopic) operation.
///
/// - The fluent builder is configurable:
/// - [`topic_arn(impl Into<String>)`](crate::client::fluent_builders::DeleteTopic::topic_arn) / [`set_topic_arn(Option<String>)`](crate::client::fluent_builders::DeleteTopic::set_topic_arn): <p>The ARN of the topic you want to delete.</p>
/// - On success, responds with [`DeleteTopicOutput`](crate::output::DeleteTopicOutput)
/// - On failure, responds with [`SdkError<DeleteTopicError>`](crate::error::DeleteTopicError)
pub fn delete_topic(&self) -> fluent_builders::DeleteTopic {
fluent_builders::DeleteTopic::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`GetDataProtectionPolicy`](crate::client::fluent_builders::GetDataProtectionPolicy) operation.
///
/// - The fluent builder is configurable:
/// - [`resource_arn(impl Into<String>)`](crate::client::fluent_builders::GetDataProtectionPolicy::resource_arn) / [`set_resource_arn(Option<String>)`](crate::client::fluent_builders::GetDataProtectionPolicy::set_resource_arn): <p>The ARN of the topic whose <code>DataProtectionPolicy</code> you want to get.</p> <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the Amazon Web Services General Reference.</p>
/// - On success, responds with [`GetDataProtectionPolicyOutput`](crate::output::GetDataProtectionPolicyOutput) with field(s):
/// - [`data_protection_policy(Option<String>)`](crate::output::GetDataProtectionPolicyOutput::data_protection_policy): <p>Retrieves the <code>DataProtectionPolicy</code> in JSON string format.</p>
/// - On failure, responds with [`SdkError<GetDataProtectionPolicyError>`](crate::error::GetDataProtectionPolicyError)
pub fn get_data_protection_policy(&self) -> fluent_builders::GetDataProtectionPolicy {
fluent_builders::GetDataProtectionPolicy::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`GetEndpointAttributes`](crate::client::fluent_builders::GetEndpointAttributes) operation.
///
/// - The fluent builder is configurable:
/// - [`endpoint_arn(impl Into<String>)`](crate::client::fluent_builders::GetEndpointAttributes::endpoint_arn) / [`set_endpoint_arn(Option<String>)`](crate::client::fluent_builders::GetEndpointAttributes::set_endpoint_arn): <p>EndpointArn for GetEndpointAttributes input.</p>
/// - On success, responds with [`GetEndpointAttributesOutput`](crate::output::GetEndpointAttributesOutput) with field(s):
/// - [`attributes(Option<HashMap<String, String>>)`](crate::output::GetEndpointAttributesOutput::attributes): <p>Attributes include the following:</p> <ul> <li> <p> <code>CustomUserData</code> – 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.</p> </li> <li> <p> <code>Enabled</code> – 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.</p> </li> <li> <p> <code>Token</code> – 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.</p> <note> <p>The device token for the iOS platform is returned in lowercase.</p> </note> </li> </ul>
/// - On failure, responds with [`SdkError<GetEndpointAttributesError>`](crate::error::GetEndpointAttributesError)
pub fn get_endpoint_attributes(&self) -> fluent_builders::GetEndpointAttributes {
fluent_builders::GetEndpointAttributes::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`GetPlatformApplicationAttributes`](crate::client::fluent_builders::GetPlatformApplicationAttributes) operation.
///
/// - The fluent builder is configurable:
/// - [`platform_application_arn(impl Into<String>)`](crate::client::fluent_builders::GetPlatformApplicationAttributes::platform_application_arn) / [`set_platform_application_arn(Option<String>)`](crate::client::fluent_builders::GetPlatformApplicationAttributes::set_platform_application_arn): <p>PlatformApplicationArn for GetPlatformApplicationAttributesInput.</p>
/// - On success, responds with [`GetPlatformApplicationAttributesOutput`](crate::output::GetPlatformApplicationAttributesOutput) with field(s):
/// - [`attributes(Option<HashMap<String, String>>)`](crate::output::GetPlatformApplicationAttributesOutput::attributes): <p>Attributes include the following:</p> <ul> <li> <p> <code>AppleCertificateExpiryDate</code> – The expiry date of the SSL certificate used to configure certificate-based authentication.</p> </li> <li> <p> <code>ApplePlatformTeamID</code> – The Apple developer account ID used to configure token-based authentication.</p> </li> <li> <p> <code>ApplePlatformBundleID</code> – The app identifier used to configure token-based authentication.</p> </li> <li> <p> <code>EventEndpointCreated</code> – Topic ARN to which EndpointCreated event notifications should be sent.</p> </li> <li> <p> <code>EventEndpointDeleted</code> – Topic ARN to which EndpointDeleted event notifications should be sent.</p> </li> <li> <p> <code>EventEndpointUpdated</code> – Topic ARN to which EndpointUpdate event notifications should be sent.</p> </li> <li> <p> <code>EventDeliveryFailure</code> – Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.</p> </li> </ul>
/// - On failure, responds with [`SdkError<GetPlatformApplicationAttributesError>`](crate::error::GetPlatformApplicationAttributesError)
pub fn get_platform_application_attributes(
&self,
) -> fluent_builders::GetPlatformApplicationAttributes {
fluent_builders::GetPlatformApplicationAttributes::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`GetSMSAttributes`](crate::client::fluent_builders::GetSMSAttributes) operation.
///
/// - The fluent builder is configurable:
/// - [`attributes(Vec<String>)`](crate::client::fluent_builders::GetSMSAttributes::attributes) / [`set_attributes(Option<Vec<String>>)`](crate::client::fluent_builders::GetSMSAttributes::set_attributes): <p>A list of the individual attribute names, such as <code>MonthlySpendLimit</code>, for which you want values.</p> <p>For all attribute names, see <a href="https://docs.aws.amazon.com/sns/latest/api/API_SetSMSAttributes.html">SetSMSAttributes</a>.</p> <p>If you don't use this parameter, Amazon SNS returns all SMS attributes.</p>
/// - On success, responds with [`GetSmsAttributesOutput`](crate::output::GetSmsAttributesOutput) with field(s):
/// - [`attributes(Option<HashMap<String, String>>)`](crate::output::GetSmsAttributesOutput::attributes): <p>The SMS attribute names and their values.</p>
/// - On failure, responds with [`SdkError<GetSMSAttributesError>`](crate::error::GetSMSAttributesError)
pub fn get_sms_attributes(&self) -> fluent_builders::GetSMSAttributes {
fluent_builders::GetSMSAttributes::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`GetSMSSandboxAccountStatus`](crate::client::fluent_builders::GetSMSSandboxAccountStatus) operation.
///
/// - The fluent builder takes no input, just [`send`](crate::client::fluent_builders::GetSMSSandboxAccountStatus::send) it.
/// - On success, responds with [`GetSmsSandboxAccountStatusOutput`](crate::output::GetSmsSandboxAccountStatusOutput) with field(s):
/// - [`is_in_sandbox(bool)`](crate::output::GetSmsSandboxAccountStatusOutput::is_in_sandbox): <p>Indicates whether the calling Amazon Web Services account is in the SMS sandbox.</p>
/// - On failure, responds with [`SdkError<GetSMSSandboxAccountStatusError>`](crate::error::GetSMSSandboxAccountStatusError)
pub fn get_sms_sandbox_account_status(&self) -> fluent_builders::GetSMSSandboxAccountStatus {
fluent_builders::GetSMSSandboxAccountStatus::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`GetSubscriptionAttributes`](crate::client::fluent_builders::GetSubscriptionAttributes) operation.
///
/// - The fluent builder is configurable:
/// - [`subscription_arn(impl Into<String>)`](crate::client::fluent_builders::GetSubscriptionAttributes::subscription_arn) / [`set_subscription_arn(Option<String>)`](crate::client::fluent_builders::GetSubscriptionAttributes::set_subscription_arn): <p>The ARN of the subscription whose properties you want to get.</p>
/// - On success, responds with [`GetSubscriptionAttributesOutput`](crate::output::GetSubscriptionAttributesOutput) with field(s):
/// - [`attributes(Option<HashMap<String, String>>)`](crate::output::GetSubscriptionAttributesOutput::attributes): <p>A map of the subscription's attributes. Attributes in this map include the following:</p> <ul> <li> <p> <code>ConfirmationWasAuthenticated</code> – <code>true</code> if the subscription confirmation request was authenticated.</p> </li> <li> <p> <code>DeliveryPolicy</code> – The JSON serialization of the subscription's delivery policy.</p> </li> <li> <p> <code>EffectiveDeliveryPolicy</code> – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.</p> </li> <li> <p> <code>FilterPolicy</code> – The filter policy JSON that is assigned to the subscription. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-message-filtering.html">Amazon SNS Message Filtering</a> in the <i>Amazon SNS Developer Guide</i>.</p> </li> <li> <p> <code>FilterPolicyScope</code> – This attribute lets you choose the filtering scope by using one of the following string value types:</p> <ul> <li> <p> <code>MessageAttributes</code> (default) – The filter is applied on the message attributes.</p> </li> <li> <p> <code>MessageBody</code> – The filter is applied on the message body.</p> </li> </ul> </li> <li> <p> <code>Owner</code> – The Amazon Web Services account ID of the subscription's owner.</p> </li> <li> <p> <code>PendingConfirmation</code> – <code>true</code> if the subscription hasn't been confirmed. To confirm a pending subscription, call the <code>ConfirmSubscription</code> action with a confirmation token.</p> </li> <li> <p> <code>RawMessageDelivery</code> – <code>true</code> 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.</p> </li> <li> <p> <code>RedrivePolicy</code> – 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.</p> </li> <li> <p> <code>SubscriptionArn</code> – The subscription's ARN.</p> </li> <li> <p> <code>TopicArn</code> – The topic ARN that the subscription is associated with.</p> </li> </ul> <p>The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:</p> <ul> <li> <p> <code>SubscriptionRoleArn</code> – The ARN of the IAM role that has the following:</p> <ul> <li> <p>Permission to write to the Kinesis Data Firehose delivery stream</p> </li> <li> <p>Amazon SNS listed as a trusted entity</p> </li> </ul> <p>Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html">Fanout to Kinesis Data Firehose delivery streams</a> in the <i>Amazon SNS Developer Guide</i>.</p> </li> </ul>
/// - On failure, responds with [`SdkError<GetSubscriptionAttributesError>`](crate::error::GetSubscriptionAttributesError)
pub fn get_subscription_attributes(&self) -> fluent_builders::GetSubscriptionAttributes {
fluent_builders::GetSubscriptionAttributes::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`GetTopicAttributes`](crate::client::fluent_builders::GetTopicAttributes) operation.
///
/// - The fluent builder is configurable:
/// - [`topic_arn(impl Into<String>)`](crate::client::fluent_builders::GetTopicAttributes::topic_arn) / [`set_topic_arn(Option<String>)`](crate::client::fluent_builders::GetTopicAttributes::set_topic_arn): <p>The ARN of the topic whose properties you want to get.</p>
/// - On success, responds with [`GetTopicAttributesOutput`](crate::output::GetTopicAttributesOutput) with field(s):
/// - [`attributes(Option<HashMap<String, String>>)`](crate::output::GetTopicAttributesOutput::attributes): <p>A map of the topic's attributes. Attributes in this map include the following:</p> <ul> <li> <p> <code>DeliveryPolicy</code> – The JSON serialization of the topic's delivery policy.</p> </li> <li> <p> <code>DisplayName</code> – The human-readable name used in the <code>From</code> field for notifications to <code>email</code> and <code>email-json</code> endpoints.</p> </li> <li> <p> <code>EffectiveDeliveryPolicy</code> – The JSON serialization of the effective delivery policy, taking system defaults into account.</p> </li> <li> <p> <code>Owner</code> – The Amazon Web Services account ID of the topic's owner.</p> </li> <li> <p> <code>Policy</code> – The JSON serialization of the topic's access control policy.</p> </li> <li> <p> <code>SignatureVersion</code> – The version of the Amazon SNS signature used for the topic.</p> <ul> <li> <p>By default, <code>SignatureVersion</code> is set to <b>1</b>. The signature is a Base64-encoded <b>SHA1withRSA</b> signature.</p> </li> <li> <p>When you set <code>SignatureVersion</code> to <b>2</b>. Amazon SNS uses a Base64-encoded <b>SHA256withRSA</b> signature. </p> <note> <p>If the API response does not include the <code>SignatureVersion</code> attribute, it means that the <code>SignatureVersion</code> for the topic has value <b>1</b>.</p> </note> </li> </ul> </li> <li> <p> <code>SubscriptionsConfirmed</code> – The number of confirmed subscriptions for the topic.</p> </li> <li> <p> <code>SubscriptionsDeleted</code> – The number of deleted subscriptions for the topic.</p> </li> <li> <p> <code>SubscriptionsPending</code> – The number of subscriptions pending confirmation for the topic.</p> </li> <li> <p> <code>TopicArn</code> – The topic's ARN.</p> </li> <li> <p> <code>TracingConfig</code> – Tracing mode of an Amazon SNS topic. By default <code>TracingConfig</code> is set to <code>PassThrough</code>, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.</p> </li> </ul> <p>The following attribute applies only to <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html">server-side-encryption</a>:</p> <ul> <li> <p> <code>KmsMasterKeyId</code> - The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms">Key Terms</a>. For more examples, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">KeyId</a> in the <i>Key Management Service API Reference</i>.</p> </li> </ul> <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html">FIFO topics</a>:</p> <ul> <li> <p> <code>FifoTopic</code> – When this is set to <code>true</code>, a FIFO topic is created.</p> </li> <li> <p> <code>ContentBasedDeduplication</code> – Enables content-based deduplication for FIFO topics.</p> <ul> <li> <p>By default, <code>ContentBasedDeduplication</code> is set to <code>false</code>. If you create a FIFO topic and this attribute is <code>false</code>, you must specify a value for the <code>MessageDeduplicationId</code> parameter for the <a href="https://docs.aws.amazon.com/sns/latest/api/API_Publish.html">Publish</a> action. </p> </li> <li> <p>When you set <code>ContentBasedDeduplication</code> to <code>true</code>, Amazon SNS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using the body of the message (but not the attributes of the message).</p> <p>(Optional) To override the generated value, you can specify a value for the <code>MessageDeduplicationId</code> parameter for the <code>Publish</code> action.</p> </li> </ul> </li> </ul>
/// - On failure, responds with [`SdkError<GetTopicAttributesError>`](crate::error::GetTopicAttributesError)
pub fn get_topic_attributes(&self) -> fluent_builders::GetTopicAttributes {
fluent_builders::GetTopicAttributes::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ListEndpointsByPlatformApplication`](crate::client::fluent_builders::ListEndpointsByPlatformApplication) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::ListEndpointsByPlatformApplication::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`platform_application_arn(impl Into<String>)`](crate::client::fluent_builders::ListEndpointsByPlatformApplication::platform_application_arn) / [`set_platform_application_arn(Option<String>)`](crate::client::fluent_builders::ListEndpointsByPlatformApplication::set_platform_application_arn): <p>PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.</p>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::ListEndpointsByPlatformApplication::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::ListEndpointsByPlatformApplication::set_next_token): <p>NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results.</p>
/// - On success, responds with [`ListEndpointsByPlatformApplicationOutput`](crate::output::ListEndpointsByPlatformApplicationOutput) with field(s):
/// - [`endpoints(Option<Vec<Endpoint>>)`](crate::output::ListEndpointsByPlatformApplicationOutput::endpoints): <p>Endpoints returned for ListEndpointsByPlatformApplication action.</p>
/// - [`next_token(Option<String>)`](crate::output::ListEndpointsByPlatformApplicationOutput::next_token): <p>NextToken string is returned when calling ListEndpointsByPlatformApplication action if additional records are available after the first page results.</p>
/// - On failure, responds with [`SdkError<ListEndpointsByPlatformApplicationError>`](crate::error::ListEndpointsByPlatformApplicationError)
pub fn list_endpoints_by_platform_application(
&self,
) -> fluent_builders::ListEndpointsByPlatformApplication {
fluent_builders::ListEndpointsByPlatformApplication::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ListOriginationNumbers`](crate::client::fluent_builders::ListOriginationNumbers) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::ListOriginationNumbers::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::ListOriginationNumbers::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::ListOriginationNumbers::set_next_token): <p>Token that the previous <code>ListOriginationNumbers</code> request returns.</p>
/// - [`max_results(i32)`](crate::client::fluent_builders::ListOriginationNumbers::max_results) / [`set_max_results(Option<i32>)`](crate::client::fluent_builders::ListOriginationNumbers::set_max_results): <p>The maximum number of origination numbers to return.</p>
/// - On success, responds with [`ListOriginationNumbersOutput`](crate::output::ListOriginationNumbersOutput) with field(s):
/// - [`next_token(Option<String>)`](crate::output::ListOriginationNumbersOutput::next_token): <p>A <code>NextToken</code> string is returned when you call the <code>ListOriginationNumbers</code> operation if additional pages of records are available.</p>
/// - [`phone_numbers(Option<Vec<PhoneNumberInformation>>)`](crate::output::ListOriginationNumbersOutput::phone_numbers): <p>A list of the calling account's verified and pending origination numbers.</p>
/// - On failure, responds with [`SdkError<ListOriginationNumbersError>`](crate::error::ListOriginationNumbersError)
pub fn list_origination_numbers(&self) -> fluent_builders::ListOriginationNumbers {
fluent_builders::ListOriginationNumbers::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ListPhoneNumbersOptedOut`](crate::client::fluent_builders::ListPhoneNumbersOptedOut) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::ListPhoneNumbersOptedOut::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::ListPhoneNumbersOptedOut::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::ListPhoneNumbersOptedOut::set_next_token): <p>A <code>NextToken</code> string is used when you call the <code>ListPhoneNumbersOptedOut</code> action to retrieve additional records that are available after the first page of results.</p>
/// - On success, responds with [`ListPhoneNumbersOptedOutOutput`](crate::output::ListPhoneNumbersOptedOutOutput) with field(s):
/// - [`phone_numbers(Option<Vec<String>>)`](crate::output::ListPhoneNumbersOptedOutOutput::phone_numbers): <p>A list of phone numbers that are opted out of receiving SMS messages. The list is paginated, and each page can contain up to 100 phone numbers.</p>
/// - [`next_token(Option<String>)`](crate::output::ListPhoneNumbersOptedOutOutput::next_token): <p>A <code>NextToken</code> string is returned when you call the <code>ListPhoneNumbersOptedOut</code> action if additional records are available after the first page of results.</p>
/// - On failure, responds with [`SdkError<ListPhoneNumbersOptedOutError>`](crate::error::ListPhoneNumbersOptedOutError)
pub fn list_phone_numbers_opted_out(&self) -> fluent_builders::ListPhoneNumbersOptedOut {
fluent_builders::ListPhoneNumbersOptedOut::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ListPlatformApplications`](crate::client::fluent_builders::ListPlatformApplications) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::ListPlatformApplications::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::ListPlatformApplications::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::ListPlatformApplications::set_next_token): <p>NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results.</p>
/// - On success, responds with [`ListPlatformApplicationsOutput`](crate::output::ListPlatformApplicationsOutput) with field(s):
/// - [`platform_applications(Option<Vec<PlatformApplication>>)`](crate::output::ListPlatformApplicationsOutput::platform_applications): <p>Platform applications returned when calling ListPlatformApplications action.</p>
/// - [`next_token(Option<String>)`](crate::output::ListPlatformApplicationsOutput::next_token): <p>NextToken string is returned when calling ListPlatformApplications action if additional records are available after the first page results.</p>
/// - On failure, responds with [`SdkError<ListPlatformApplicationsError>`](crate::error::ListPlatformApplicationsError)
pub fn list_platform_applications(&self) -> fluent_builders::ListPlatformApplications {
fluent_builders::ListPlatformApplications::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ListSMSSandboxPhoneNumbers`](crate::client::fluent_builders::ListSMSSandboxPhoneNumbers) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::ListSMSSandboxPhoneNumbers::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::ListSMSSandboxPhoneNumbers::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::ListSMSSandboxPhoneNumbers::set_next_token): <p>Token that the previous <code>ListSMSSandboxPhoneNumbersInput</code> request returns.</p>
/// - [`max_results(i32)`](crate::client::fluent_builders::ListSMSSandboxPhoneNumbers::max_results) / [`set_max_results(Option<i32>)`](crate::client::fluent_builders::ListSMSSandboxPhoneNumbers::set_max_results): <p>The maximum number of phone numbers to return.</p>
/// - On success, responds with [`ListSmsSandboxPhoneNumbersOutput`](crate::output::ListSmsSandboxPhoneNumbersOutput) with field(s):
/// - [`phone_numbers(Option<Vec<SmsSandboxPhoneNumber>>)`](crate::output::ListSmsSandboxPhoneNumbersOutput::phone_numbers): <p>A list of the calling account's pending and verified phone numbers.</p>
/// - [`next_token(Option<String>)`](crate::output::ListSmsSandboxPhoneNumbersOutput::next_token): <p>A <code>NextToken</code> string is returned when you call the <code>ListSMSSandboxPhoneNumbersInput</code> operation if additional pages of records are available.</p>
/// - On failure, responds with [`SdkError<ListSMSSandboxPhoneNumbersError>`](crate::error::ListSMSSandboxPhoneNumbersError)
pub fn list_sms_sandbox_phone_numbers(&self) -> fluent_builders::ListSMSSandboxPhoneNumbers {
fluent_builders::ListSMSSandboxPhoneNumbers::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ListSubscriptions`](crate::client::fluent_builders::ListSubscriptions) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::ListSubscriptions::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::ListSubscriptions::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::ListSubscriptions::set_next_token): <p>Token returned by the previous <code>ListSubscriptions</code> request.</p>
/// - On success, responds with [`ListSubscriptionsOutput`](crate::output::ListSubscriptionsOutput) with field(s):
/// - [`subscriptions(Option<Vec<Subscription>>)`](crate::output::ListSubscriptionsOutput::subscriptions): <p>A list of subscriptions.</p>
/// - [`next_token(Option<String>)`](crate::output::ListSubscriptionsOutput::next_token): <p>Token to pass along to the next <code>ListSubscriptions</code> request. This element is returned if there are more subscriptions to retrieve.</p>
/// - On failure, responds with [`SdkError<ListSubscriptionsError>`](crate::error::ListSubscriptionsError)
pub fn list_subscriptions(&self) -> fluent_builders::ListSubscriptions {
fluent_builders::ListSubscriptions::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ListSubscriptionsByTopic`](crate::client::fluent_builders::ListSubscriptionsByTopic) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::ListSubscriptionsByTopic::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`topic_arn(impl Into<String>)`](crate::client::fluent_builders::ListSubscriptionsByTopic::topic_arn) / [`set_topic_arn(Option<String>)`](crate::client::fluent_builders::ListSubscriptionsByTopic::set_topic_arn): <p>The ARN of the topic for which you wish to find subscriptions.</p>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::ListSubscriptionsByTopic::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::ListSubscriptionsByTopic::set_next_token): <p>Token returned by the previous <code>ListSubscriptionsByTopic</code> request.</p>
/// - On success, responds with [`ListSubscriptionsByTopicOutput`](crate::output::ListSubscriptionsByTopicOutput) with field(s):
/// - [`subscriptions(Option<Vec<Subscription>>)`](crate::output::ListSubscriptionsByTopicOutput::subscriptions): <p>A list of subscriptions.</p>
/// - [`next_token(Option<String>)`](crate::output::ListSubscriptionsByTopicOutput::next_token): <p>Token to pass along to the next <code>ListSubscriptionsByTopic</code> request. This element is returned if there are more subscriptions to retrieve.</p>
/// - On failure, responds with [`SdkError<ListSubscriptionsByTopicError>`](crate::error::ListSubscriptionsByTopicError)
pub fn list_subscriptions_by_topic(&self) -> fluent_builders::ListSubscriptionsByTopic {
fluent_builders::ListSubscriptionsByTopic::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ListTagsForResource`](crate::client::fluent_builders::ListTagsForResource) operation.
///
/// - The fluent builder is configurable:
/// - [`resource_arn(impl Into<String>)`](crate::client::fluent_builders::ListTagsForResource::resource_arn) / [`set_resource_arn(Option<String>)`](crate::client::fluent_builders::ListTagsForResource::set_resource_arn): <p>The ARN of the topic for which to list tags.</p>
/// - On success, responds with [`ListTagsForResourceOutput`](crate::output::ListTagsForResourceOutput) with field(s):
/// - [`tags(Option<Vec<Tag>>)`](crate::output::ListTagsForResourceOutput::tags): <p>The tags associated with the specified topic.</p>
/// - On failure, responds with [`SdkError<ListTagsForResourceError>`](crate::error::ListTagsForResourceError)
pub fn list_tags_for_resource(&self) -> fluent_builders::ListTagsForResource {
fluent_builders::ListTagsForResource::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ListTopics`](crate::client::fluent_builders::ListTopics) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::ListTopics::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::ListTopics::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::ListTopics::set_next_token): <p>Token returned by the previous <code>ListTopics</code> request.</p>
/// - On success, responds with [`ListTopicsOutput`](crate::output::ListTopicsOutput) with field(s):
/// - [`topics(Option<Vec<Topic>>)`](crate::output::ListTopicsOutput::topics): <p>A list of topic ARNs.</p>
/// - [`next_token(Option<String>)`](crate::output::ListTopicsOutput::next_token): <p>Token to pass along to the next <code>ListTopics</code> request. This element is returned if there are additional topics to retrieve.</p>
/// - On failure, responds with [`SdkError<ListTopicsError>`](crate::error::ListTopicsError)
pub fn list_topics(&self) -> fluent_builders::ListTopics {
fluent_builders::ListTopics::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`OptInPhoneNumber`](crate::client::fluent_builders::OptInPhoneNumber) operation.
///
/// - The fluent builder is configurable:
/// - [`phone_number(impl Into<String>)`](crate::client::fluent_builders::OptInPhoneNumber::phone_number) / [`set_phone_number(Option<String>)`](crate::client::fluent_builders::OptInPhoneNumber::set_phone_number): <p>The phone number to opt in. Use E.164 format.</p>
/// - On success, responds with [`OptInPhoneNumberOutput`](crate::output::OptInPhoneNumberOutput)
/// - On failure, responds with [`SdkError<OptInPhoneNumberError>`](crate::error::OptInPhoneNumberError)
pub fn opt_in_phone_number(&self) -> fluent_builders::OptInPhoneNumber {
fluent_builders::OptInPhoneNumber::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`Publish`](crate::client::fluent_builders::Publish) operation.
///
/// - The fluent builder is configurable:
/// - [`topic_arn(impl Into<String>)`](crate::client::fluent_builders::Publish::topic_arn) / [`set_topic_arn(Option<String>)`](crate::client::fluent_builders::Publish::set_topic_arn): <p>The topic you want to publish to.</p> <p>If you don't specify a value for the <code>TopicArn</code> parameter, you must specify a value for the <code>PhoneNumber</code> or <code>TargetArn</code> parameters.</p>
/// - [`target_arn(impl Into<String>)`](crate::client::fluent_builders::Publish::target_arn) / [`set_target_arn(Option<String>)`](crate::client::fluent_builders::Publish::set_target_arn): <p>If you don't specify a value for the <code>TargetArn</code> parameter, you must specify a value for the <code>PhoneNumber</code> or <code>TopicArn</code> parameters.</p>
/// - [`phone_number(impl Into<String>)`](crate::client::fluent_builders::Publish::phone_number) / [`set_phone_number(Option<String>)`](crate::client::fluent_builders::Publish::set_phone_number): <p>The phone number to which you want to deliver an SMS message. Use E.164 format.</p> <p>If you don't specify a value for the <code>PhoneNumber</code> parameter, you must specify a value for the <code>TargetArn</code> or <code>TopicArn</code> parameters.</p>
/// - [`message(impl Into<String>)`](crate::client::fluent_builders::Publish::message) / [`set_message(Option<String>)`](crate::client::fluent_builders::Publish::set_message): <p>The message you want to send.</p> <p>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 <code>MessageStructure</code> parameter to <code>json</code> and use a JSON object for the <code>Message</code> parameter. </p> <p></p> <p>Constraints:</p> <ul> <li> <p>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).</p> </li> <li> <p>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.</p> <p>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.</p> <p>The total size limit for a single SMS <code>Publish</code> action is 1,600 characters.</p> </li> </ul> <p>JSON-specific constraints:</p> <ul> <li> <p>Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.</p> </li> <li> <p>The values will be parsed (unescaped) before they are used in outgoing messages.</p> </li> <li> <p>Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).</p> </li> <li> <p>Values have a minimum length of 0 (the empty string, "", is allowed).</p> </li> <li> <p>Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).</p> </li> <li> <p>Non-string values will cause the key to be ignored.</p> </li> <li> <p>Keys that do not correspond to supported transport protocols are ignored.</p> </li> <li> <p>Duplicate keys are not allowed.</p> </li> <li> <p>Failure to parse or validate any key or value in the message will cause the <code>Publish</code> call to return an error (no partial delivery).</p> </li> </ul>
/// - [`subject(impl Into<String>)`](crate::client::fluent_builders::Publish::subject) / [`set_subject(Option<String>)`](crate::client::fluent_builders::Publish::set_subject): <p>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.</p> <p>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.</p>
/// - [`message_structure(impl Into<String>)`](crate::client::fluent_builders::Publish::message_structure) / [`set_message_structure(Option<String>)`](crate::client::fluent_builders::Publish::set_message_structure): <p>Set <code>MessageStructure</code> to <code>json</code> 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 <code>MessageStructure</code> to <code>json</code>, the value of the <code>Message</code> parameter must: </p> <ul> <li> <p>be a syntactically valid JSON object; and</p> </li> <li> <p>contain at least a top-level JSON key of "default" with a value that is a string.</p> </li> </ul> <p>You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http").</p> <p>Valid value: <code>json</code> </p>
/// - [`message_attributes(HashMap<String, MessageAttributeValue>)`](crate::client::fluent_builders::Publish::message_attributes) / [`set_message_attributes(Option<HashMap<String, MessageAttributeValue>>)`](crate::client::fluent_builders::Publish::set_message_attributes): <p>Message attributes for Publish action.</p>
/// - [`message_deduplication_id(impl Into<String>)`](crate::client::fluent_builders::Publish::message_deduplication_id) / [`set_message_deduplication_id(Option<String>)`](crate::client::fluent_builders::Publish::set_message_deduplication_id): <p>This parameter applies only to FIFO (first-in-first-out) topics. The <code>MessageDeduplicationId</code> can contain up to 128 alphanumeric characters <code>(a-z, A-Z, 0-9)</code> and punctuation <code>(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)</code>.</p> <p>Every message must have a unique <code>MessageDeduplicationId</code>, which is a token used for deduplication of sent messages. If a message with a particular <code>MessageDeduplicationId</code> is sent successfully, any message sent with the same <code>MessageDeduplicationId</code> during the 5-minute deduplication interval is treated as a duplicate. </p> <p>If the topic has <code>ContentBasedDeduplication</code> set, the system generates a <code>MessageDeduplicationId</code> based on the contents of the message. Your <code>MessageDeduplicationId</code> overrides the generated one.</p>
/// - [`message_group_id(impl Into<String>)`](crate::client::fluent_builders::Publish::message_group_id) / [`set_message_group_id(Option<String>)`](crate::client::fluent_builders::Publish::set_message_group_id): <p>This parameter applies only to FIFO (first-in-first-out) topics. The <code>MessageGroupId</code> can contain up to 128 alphanumeric characters <code>(a-z, A-Z, 0-9)</code> and punctuation <code>(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)</code>.</p> <p>The <code>MessageGroupId</code> 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 <code>MessageGroupId</code>.</p>
/// - On success, responds with [`PublishOutput`](crate::output::PublishOutput) with field(s):
/// - [`message_id(Option<String>)`](crate::output::PublishOutput::message_id): <p>Unique identifier assigned to the published message.</p> <p>Length Constraint: Maximum 100 characters</p>
/// - [`sequence_number(Option<String>)`](crate::output::PublishOutput::sequence_number): <p>This response element applies only to FIFO (first-in-first-out) topics. </p> <p>The sequence number is a large, non-consecutive number that Amazon SNS assigns to each message. The length of <code>SequenceNumber</code> is 128 bits. <code>SequenceNumber</code> continues to increase for each <code>MessageGroupId</code>.</p>
/// - On failure, responds with [`SdkError<PublishError>`](crate::error::PublishError)
pub fn publish(&self) -> fluent_builders::Publish {
fluent_builders::Publish::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`PublishBatch`](crate::client::fluent_builders::PublishBatch) operation.
///
/// - The fluent builder is configurable:
/// - [`topic_arn(impl Into<String>)`](crate::client::fluent_builders::PublishBatch::topic_arn) / [`set_topic_arn(Option<String>)`](crate::client::fluent_builders::PublishBatch::set_topic_arn): <p>The Amazon resource name (ARN) of the topic you want to batch publish to.</p>
/// - [`publish_batch_request_entries(Vec<PublishBatchRequestEntry>)`](crate::client::fluent_builders::PublishBatch::publish_batch_request_entries) / [`set_publish_batch_request_entries(Option<Vec<PublishBatchRequestEntry>>)`](crate::client::fluent_builders::PublishBatch::set_publish_batch_request_entries): <p>A list of <code>PublishBatch</code> request entries to be sent to the SNS topic.</p>
/// - On success, responds with [`PublishBatchOutput`](crate::output::PublishBatchOutput) with field(s):
/// - [`successful(Option<Vec<PublishBatchResultEntry>>)`](crate::output::PublishBatchOutput::successful): <p>A list of successful <code>PublishBatch</code> responses.</p>
/// - [`failed(Option<Vec<BatchResultErrorEntry>>)`](crate::output::PublishBatchOutput::failed): <p>A list of failed <code>PublishBatch</code> responses. </p>
/// - On failure, responds with [`SdkError<PublishBatchError>`](crate::error::PublishBatchError)
pub fn publish_batch(&self) -> fluent_builders::PublishBatch {
fluent_builders::PublishBatch::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`PutDataProtectionPolicy`](crate::client::fluent_builders::PutDataProtectionPolicy) operation.
///
/// - The fluent builder is configurable:
/// - [`resource_arn(impl Into<String>)`](crate::client::fluent_builders::PutDataProtectionPolicy::resource_arn) / [`set_resource_arn(Option<String>)`](crate::client::fluent_builders::PutDataProtectionPolicy::set_resource_arn): <p>The ARN of the topic whose <code>DataProtectionPolicy</code> you want to add or update.</p> <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the Amazon Web Services General Reference.</p>
/// - [`data_protection_policy(impl Into<String>)`](crate::client::fluent_builders::PutDataProtectionPolicy::data_protection_policy) / [`set_data_protection_policy(Option<String>)`](crate::client::fluent_builders::PutDataProtectionPolicy::set_data_protection_policy): <p>The JSON serialization of the topic's <code>DataProtectionPolicy</code>.</p> <p>The <code>DataProtectionPolicy</code> must be in JSON string format.</p> <p>Length Constraints: Maximum length of 30,720.</p>
/// - On success, responds with [`PutDataProtectionPolicyOutput`](crate::output::PutDataProtectionPolicyOutput)
/// - On failure, responds with [`SdkError<PutDataProtectionPolicyError>`](crate::error::PutDataProtectionPolicyError)
pub fn put_data_protection_policy(&self) -> fluent_builders::PutDataProtectionPolicy {
fluent_builders::PutDataProtectionPolicy::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`RemovePermission`](crate::client::fluent_builders::RemovePermission) operation.
///
/// - The fluent builder is configurable:
/// - [`topic_arn(impl Into<String>)`](crate::client::fluent_builders::RemovePermission::topic_arn) / [`set_topic_arn(Option<String>)`](crate::client::fluent_builders::RemovePermission::set_topic_arn): <p>The ARN of the topic whose access control policy you wish to modify.</p>
/// - [`label(impl Into<String>)`](crate::client::fluent_builders::RemovePermission::label) / [`set_label(Option<String>)`](crate::client::fluent_builders::RemovePermission::set_label): <p>The unique label of the statement you want to remove.</p>
/// - On success, responds with [`RemovePermissionOutput`](crate::output::RemovePermissionOutput)
/// - On failure, responds with [`SdkError<RemovePermissionError>`](crate::error::RemovePermissionError)
pub fn remove_permission(&self) -> fluent_builders::RemovePermission {
fluent_builders::RemovePermission::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`SetEndpointAttributes`](crate::client::fluent_builders::SetEndpointAttributes) operation.
///
/// - The fluent builder is configurable:
/// - [`endpoint_arn(impl Into<String>)`](crate::client::fluent_builders::SetEndpointAttributes::endpoint_arn) / [`set_endpoint_arn(Option<String>)`](crate::client::fluent_builders::SetEndpointAttributes::set_endpoint_arn): <p>EndpointArn used for SetEndpointAttributes action.</p>
/// - [`attributes(HashMap<String, String>)`](crate::client::fluent_builders::SetEndpointAttributes::attributes) / [`set_attributes(Option<HashMap<String, String>>)`](crate::client::fluent_builders::SetEndpointAttributes::set_attributes): <p>A map of the endpoint attributes. Attributes in this map include the following:</p> <ul> <li> <p> <code>CustomUserData</code> – 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.</p> </li> <li> <p> <code>Enabled</code> – 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.</p> </li> <li> <p> <code>Token</code> – 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.</p> </li> </ul>
/// - On success, responds with [`SetEndpointAttributesOutput`](crate::output::SetEndpointAttributesOutput)
/// - On failure, responds with [`SdkError<SetEndpointAttributesError>`](crate::error::SetEndpointAttributesError)
pub fn set_endpoint_attributes(&self) -> fluent_builders::SetEndpointAttributes {
fluent_builders::SetEndpointAttributes::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`SetPlatformApplicationAttributes`](crate::client::fluent_builders::SetPlatformApplicationAttributes) operation.
///
/// - The fluent builder is configurable:
/// - [`platform_application_arn(impl Into<String>)`](crate::client::fluent_builders::SetPlatformApplicationAttributes::platform_application_arn) / [`set_platform_application_arn(Option<String>)`](crate::client::fluent_builders::SetPlatformApplicationAttributes::set_platform_application_arn): <p>PlatformApplicationArn for SetPlatformApplicationAttributes action.</p>
/// - [`attributes(HashMap<String, String>)`](crate::client::fluent_builders::SetPlatformApplicationAttributes::attributes) / [`set_attributes(Option<HashMap<String, String>>)`](crate::client::fluent_builders::SetPlatformApplicationAttributes::set_attributes): <p>A map of the platform application attributes. Attributes in this map include the following:</p> <ul> <li> <p> <code>PlatformCredential</code> – The credential received from the notification service.</p> <ul> <li> <p>For ADM, <code>PlatformCredential</code>is client secret.</p> </li> <li> <p>For Apple Services using certificate credentials, <code>PlatformCredential</code> is private key.</p> </li> <li> <p>For Apple Services using token credentials, <code>PlatformCredential</code> is signing key.</p> </li> <li> <p>For GCM (Firebase Cloud Messaging), <code>PlatformCredential</code> is API key. </p> </li> </ul> </li> </ul> <ul> <li> <p> <code>PlatformPrincipal</code> – The principal received from the notification service.</p> <ul> <li> <p>For ADM, <code>PlatformPrincipal</code>is client id.</p> </li> <li> <p>For Apple Services using certificate credentials, <code>PlatformPrincipal</code> is SSL certificate.</p> </li> <li> <p>For Apple Services using token credentials, <code>PlatformPrincipal</code> is signing key ID.</p> </li> <li> <p>For GCM (Firebase Cloud Messaging), there is no <code>PlatformPrincipal</code>. </p> </li> </ul> </li> </ul> <ul> <li> <p> <code>EventEndpointCreated</code> – Topic ARN to which <code>EndpointCreated</code> event notifications are sent.</p> </li> <li> <p> <code>EventEndpointDeleted</code> – Topic ARN to which <code>EndpointDeleted</code> event notifications are sent.</p> </li> <li> <p> <code>EventEndpointUpdated</code> – Topic ARN to which <code>EndpointUpdate</code> event notifications are sent.</p> </li> <li> <p> <code>EventDeliveryFailure</code> – Topic ARN to which <code>DeliveryFailure</code> event notifications are sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.</p> </li> <li> <p> <code>SuccessFeedbackRoleArn</code> – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.</p> </li> <li> <p> <code>FailureFeedbackRoleArn</code> – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.</p> </li> <li> <p> <code>SuccessFeedbackSampleRate</code> – Sample rate percentage (0-100) of successfully delivered messages.</p> </li> </ul> <p>The following attributes only apply to <code>APNs</code> token-based authentication:</p> <ul> <li> <p> <code>ApplePlatformTeamID</code> – The identifier that's assigned to your Apple developer account team.</p> </li> <li> <p> <code>ApplePlatformBundleID</code> – The bundle identifier that's assigned to your iOS app.</p> </li> </ul>
/// - On success, responds with [`SetPlatformApplicationAttributesOutput`](crate::output::SetPlatformApplicationAttributesOutput)
/// - On failure, responds with [`SdkError<SetPlatformApplicationAttributesError>`](crate::error::SetPlatformApplicationAttributesError)
pub fn set_platform_application_attributes(
&self,
) -> fluent_builders::SetPlatformApplicationAttributes {
fluent_builders::SetPlatformApplicationAttributes::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`SetSMSAttributes`](crate::client::fluent_builders::SetSMSAttributes) operation.
///
/// - The fluent builder is configurable:
/// - [`attributes(HashMap<String, String>)`](crate::client::fluent_builders::SetSMSAttributes::attributes) / [`set_attributes(Option<HashMap<String, String>>)`](crate::client::fluent_builders::SetSMSAttributes::set_attributes): <p>The default settings for sending SMS messages from your Amazon Web Services account. You can set values for the following attribute names:</p> <p> <code>MonthlySpendLimit</code> – 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.</p> <important> <p>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.</p> </important> <p>By default, the spend limit is set to the maximum allowed by Amazon SNS. If you want to raise the limit, submit an <a href="https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-sns">SNS Limit Increase case</a>. For <b>New limit value</b>, enter your desired monthly spend limit. In the <b>Use Case Description</b> field, explain that you are requesting an SMS monthly spend limit increase.</p> <p> <code>DeliveryStatusIAMRole</code> – 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.</p> <p> <code>DeliveryStatusSuccessSamplingRate</code> – 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 <code>0</code>. To write logs for 10% of your successful deliveries, set it to <code>10</code>.</p> <p> <code>DefaultSenderID</code> – 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.</p> <p> <code>DefaultSMSType</code> – The type of SMS message that you will send by default. You can assign the following values:</p> <ul> <li> <p> <code>Promotional</code> – (Default) Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.</p> </li> <li> <p> <code>Transactional</code> – 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.</p> </li> </ul> <p> <code>UsageReportS3Bucket</code> – 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:</p> <ul> <li> <p>Time that the message was published (in UTC)</p> </li> <li> <p>Message ID</p> </li> <li> <p>Destination phone number</p> </li> <li> <p>Message type</p> </li> <li> <p>Delivery status</p> </li> <li> <p>Message price (in USD)</p> </li> <li> <p>Part number (a message is split into multiple parts if it is too long for a single message)</p> </li> <li> <p>Total number of parts</p> </li> </ul> <p>To receive the report, the bucket must have a policy that allows the Amazon SNS service principal to perform the <code>s3:PutObject</code> and <code>s3:GetBucketLocation</code> actions.</p> <p>For an example bucket policy and usage report, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sms_stats.html">Monitoring SMS Activity</a> in the <i>Amazon SNS Developer Guide</i>.</p>
/// - On success, responds with [`SetSmsAttributesOutput`](crate::output::SetSmsAttributesOutput)
/// - On failure, responds with [`SdkError<SetSMSAttributesError>`](crate::error::SetSMSAttributesError)
pub fn set_sms_attributes(&self) -> fluent_builders::SetSMSAttributes {
fluent_builders::SetSMSAttributes::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`SetSubscriptionAttributes`](crate::client::fluent_builders::SetSubscriptionAttributes) operation.
///
/// - The fluent builder is configurable:
/// - [`subscription_arn(impl Into<String>)`](crate::client::fluent_builders::SetSubscriptionAttributes::subscription_arn) / [`set_subscription_arn(Option<String>)`](crate::client::fluent_builders::SetSubscriptionAttributes::set_subscription_arn): <p>The ARN of the subscription to modify.</p>
/// - [`attribute_name(impl Into<String>)`](crate::client::fluent_builders::SetSubscriptionAttributes::attribute_name) / [`set_attribute_name(Option<String>)`](crate::client::fluent_builders::SetSubscriptionAttributes::set_attribute_name): <p>A map of attributes with their corresponding values.</p> <p>The following lists the names, descriptions, and values of the special request parameters that this action uses:</p> <ul> <li> <p> <code>DeliveryPolicy</code> – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.</p> </li> <li> <p> <code>FilterPolicy</code> – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.</p> </li> <li> <p> <code>FilterPolicyScope</code> – This attribute lets you choose the filtering scope by using one of the following string value types:</p> <ul> <li> <p> <code>MessageAttributes</code> (default) – The filter is applied on the message attributes.</p> </li> <li> <p> <code>MessageBody</code> – The filter is applied on the message body.</p> </li> </ul> </li> <li> <p> <code>RawMessageDelivery</code> – When set to <code>true</code>, 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.</p> </li> <li> <p> <code>RedrivePolicy</code> – 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.</p> </li> </ul> <p>The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:</p> <ul> <li> <p> <code>SubscriptionRoleArn</code> – The ARN of the IAM role that has the following:</p> <ul> <li> <p>Permission to write to the Kinesis Data Firehose delivery stream</p> </li> <li> <p>Amazon SNS listed as a trusted entity</p> </li> </ul> <p>Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html">Fanout to Kinesis Data Firehose delivery streams</a> in the <i>Amazon SNS Developer Guide</i>.</p> </li> </ul>
/// - [`attribute_value(impl Into<String>)`](crate::client::fluent_builders::SetSubscriptionAttributes::attribute_value) / [`set_attribute_value(Option<String>)`](crate::client::fluent_builders::SetSubscriptionAttributes::set_attribute_value): <p>The new value for the attribute in JSON format.</p>
/// - On success, responds with [`SetSubscriptionAttributesOutput`](crate::output::SetSubscriptionAttributesOutput)
/// - On failure, responds with [`SdkError<SetSubscriptionAttributesError>`](crate::error::SetSubscriptionAttributesError)
pub fn set_subscription_attributes(&self) -> fluent_builders::SetSubscriptionAttributes {
fluent_builders::SetSubscriptionAttributes::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`SetTopicAttributes`](crate::client::fluent_builders::SetTopicAttributes) operation.
///
/// - The fluent builder is configurable:
/// - [`topic_arn(impl Into<String>)`](crate::client::fluent_builders::SetTopicAttributes::topic_arn) / [`set_topic_arn(Option<String>)`](crate::client::fluent_builders::SetTopicAttributes::set_topic_arn): <p>The ARN of the topic to modify.</p>
/// - [`attribute_name(impl Into<String>)`](crate::client::fluent_builders::SetTopicAttributes::attribute_name) / [`set_attribute_name(Option<String>)`](crate::client::fluent_builders::SetTopicAttributes::set_attribute_name): <p>A map of attributes with their corresponding values.</p> <p>The following lists the names, descriptions, and values of the special request parameters that the <code>SetTopicAttributes</code> action uses:</p> <ul> <li> <p> <code>DeliveryPolicy</code> – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.</p> </li> <li> <p> <code>DisplayName</code> – The display name to use for a topic with SMS subscriptions.</p> </li> <li> <p> <code>Policy</code> – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.</p> </li> <li> <p> <code>TracingConfig</code> – Tracing mode of an Amazon SNS topic. By default <code>TracingConfig</code> is set to <code>PassThrough</code>, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.</p> </li> </ul> <p>The following attribute applies only to <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html">server-side-encryption</a>:</p> <ul> <li> <p> <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms">Key Terms</a>. For more examples, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">KeyId</a> in the <i>Key Management Service API Reference</i>. </p> </li> <li> <p> <code>SignatureVersion</code> – The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS.</p> </li> </ul> <p>The following attribute applies only to <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html">FIFO topics</a>:</p> <ul> <li> <p> <code>ContentBasedDeduplication</code> – Enables content-based deduplication for FIFO topics.</p> <ul> <li> <p>By default, <code>ContentBasedDeduplication</code> is set to <code>false</code>. If you create a FIFO topic and this attribute is <code>false</code>, you must specify a value for the <code>MessageDeduplicationId</code> parameter for the <a href="https://docs.aws.amazon.com/sns/latest/api/API_Publish.html">Publish</a> action. </p> </li> <li> <p>When you set <code>ContentBasedDeduplication</code> to <code>true</code>, Amazon SNS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using the body of the message (but not the attributes of the message).</p> <p>(Optional) To override the generated value, you can specify a value for the <code>MessageDeduplicationId</code> parameter for the <code>Publish</code> action.</p> </li> </ul> </li> </ul>
/// - [`attribute_value(impl Into<String>)`](crate::client::fluent_builders::SetTopicAttributes::attribute_value) / [`set_attribute_value(Option<String>)`](crate::client::fluent_builders::SetTopicAttributes::set_attribute_value): <p>The new value for the attribute.</p>
/// - On success, responds with [`SetTopicAttributesOutput`](crate::output::SetTopicAttributesOutput)
/// - On failure, responds with [`SdkError<SetTopicAttributesError>`](crate::error::SetTopicAttributesError)
pub fn set_topic_attributes(&self) -> fluent_builders::SetTopicAttributes {
fluent_builders::SetTopicAttributes::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`Subscribe`](crate::client::fluent_builders::Subscribe) operation.
///
/// - The fluent builder is configurable:
/// - [`topic_arn(impl Into<String>)`](crate::client::fluent_builders::Subscribe::topic_arn) / [`set_topic_arn(Option<String>)`](crate::client::fluent_builders::Subscribe::set_topic_arn): <p>The ARN of the topic you want to subscribe to.</p>
/// - [`protocol(impl Into<String>)`](crate::client::fluent_builders::Subscribe::protocol) / [`set_protocol(Option<String>)`](crate::client::fluent_builders::Subscribe::set_protocol): <p>The protocol that you want to use. Supported protocols include:</p> <ul> <li> <p> <code>http</code> – delivery of JSON-encoded message via HTTP POST</p> </li> <li> <p> <code>https</code> – delivery of JSON-encoded message via HTTPS POST</p> </li> <li> <p> <code>email</code> – delivery of message via SMTP</p> </li> <li> <p> <code>email-json</code> – delivery of JSON-encoded message via SMTP</p> </li> <li> <p> <code>sms</code> – delivery of message via SMS</p> </li> <li> <p> <code>sqs</code> – delivery of JSON-encoded message to an Amazon SQS queue</p> </li> <li> <p> <code>application</code> – delivery of JSON-encoded message to an EndpointArn for a mobile app and device</p> </li> <li> <p> <code>lambda</code> – delivery of JSON-encoded message to an Lambda function</p> </li> <li> <p> <code>firehose</code> – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.</p> </li> </ul>
/// - [`endpoint(impl Into<String>)`](crate::client::fluent_builders::Subscribe::endpoint) / [`set_endpoint(Option<String>)`](crate::client::fluent_builders::Subscribe::set_endpoint): <p>The endpoint that you want to receive notifications. Endpoints vary by protocol:</p> <ul> <li> <p>For the <code>http</code> protocol, the (public) endpoint is a URL beginning with <code>http://</code>.</p> </li> <li> <p>For the <code>https</code> protocol, the (public) endpoint is a URL beginning with <code>https://</code>.</p> </li> <li> <p>For the <code>email</code> protocol, the endpoint is an email address.</p> </li> <li> <p>For the <code>email-json</code> protocol, the endpoint is an email address.</p> </li> <li> <p>For the <code>sms</code> protocol, the endpoint is a phone number of an SMS-enabled device.</p> </li> <li> <p>For the <code>sqs</code> protocol, the endpoint is the ARN of an Amazon SQS queue.</p> </li> <li> <p>For the <code>application</code> protocol, the endpoint is the EndpointArn of a mobile app and device.</p> </li> <li> <p>For the <code>lambda</code> protocol, the endpoint is the ARN of an Lambda function.</p> </li> <li> <p>For the <code>firehose</code> protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.</p> </li> </ul>
/// - [`attributes(HashMap<String, String>)`](crate::client::fluent_builders::Subscribe::attributes) / [`set_attributes(Option<HashMap<String, String>>)`](crate::client::fluent_builders::Subscribe::set_attributes): <p>A map of attributes with their corresponding values.</p> <p>The following lists the names, descriptions, and values of the special request parameters that the <code>Subscribe</code> action uses:</p> <ul> <li> <p> <code>DeliveryPolicy</code> – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.</p> </li> <li> <p> <code>FilterPolicy</code> – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.</p> </li> <li> <p> <code>FilterPolicyScope</code> – This attribute lets you choose the filtering scope by using one of the following string value types:</p> <ul> <li> <p> <code>MessageAttributes</code> (default) – The filter is applied on the message attributes.</p> </li> <li> <p> <code>MessageBody</code> – The filter is applied on the message body.</p> </li> </ul> </li> <li> <p> <code>RawMessageDelivery</code> – When set to <code>true</code>, 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.</p> </li> <li> <p> <code>RedrivePolicy</code> – 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.</p> </li> </ul> <p>The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:</p> <ul> <li> <p> <code>SubscriptionRoleArn</code> – The ARN of the IAM role that has the following:</p> <ul> <li> <p>Permission to write to the Kinesis Data Firehose delivery stream</p> </li> <li> <p>Amazon SNS listed as a trusted entity</p> </li> </ul> <p>Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html">Fanout to Kinesis Data Firehose delivery streams</a> in the <i>Amazon SNS Developer Guide</i>.</p> </li> </ul>
/// - [`return_subscription_arn(bool)`](crate::client::fluent_builders::Subscribe::return_subscription_arn) / [`set_return_subscription_arn(bool)`](crate::client::fluent_builders::Subscribe::set_return_subscription_arn): <p>Sets whether the response from the <code>Subscribe</code> request includes the subscription ARN, even if the subscription is not yet confirmed.</p> <p>If you set this parameter to <code>true</code>, 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 <code>pending subscription</code> ARN value for subscriptions that aren't yet confirmed. A subscription becomes confirmed when the subscriber calls the <code>ConfirmSubscription</code> action with a confirmation token.</p> <p></p> <p>The default value is <code>false</code>.</p>
/// - On success, responds with [`SubscribeOutput`](crate::output::SubscribeOutput) with field(s):
/// - [`subscription_arn(Option<String>)`](crate::output::SubscribeOutput::subscription_arn): <p>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 <code>ReturnSubscriptionArn</code> is true, then the value is always the subscription ARN, even if the subscription requires confirmation.</p>
/// - On failure, responds with [`SdkError<SubscribeError>`](crate::error::SubscribeError)
pub fn subscribe(&self) -> fluent_builders::Subscribe {
fluent_builders::Subscribe::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`TagResource`](crate::client::fluent_builders::TagResource) operation.
///
/// - The fluent builder is configurable:
/// - [`resource_arn(impl Into<String>)`](crate::client::fluent_builders::TagResource::resource_arn) / [`set_resource_arn(Option<String>)`](crate::client::fluent_builders::TagResource::set_resource_arn): <p>The ARN of the topic to which to add tags.</p>
/// - [`tags(Vec<Tag>)`](crate::client::fluent_builders::TagResource::tags) / [`set_tags(Option<Vec<Tag>>)`](crate::client::fluent_builders::TagResource::set_tags): <p>The tags to be added to the specified topic. A tag consists of a required key and an optional value.</p>
/// - On success, responds with [`TagResourceOutput`](crate::output::TagResourceOutput)
/// - On failure, responds with [`SdkError<TagResourceError>`](crate::error::TagResourceError)
pub fn tag_resource(&self) -> fluent_builders::TagResource {
fluent_builders::TagResource::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`Unsubscribe`](crate::client::fluent_builders::Unsubscribe) operation.
///
/// - The fluent builder is configurable:
/// - [`subscription_arn(impl Into<String>)`](crate::client::fluent_builders::Unsubscribe::subscription_arn) / [`set_subscription_arn(Option<String>)`](crate::client::fluent_builders::Unsubscribe::set_subscription_arn): <p>The ARN of the subscription to be deleted.</p>
/// - On success, responds with [`UnsubscribeOutput`](crate::output::UnsubscribeOutput)
/// - On failure, responds with [`SdkError<UnsubscribeError>`](crate::error::UnsubscribeError)
pub fn unsubscribe(&self) -> fluent_builders::Unsubscribe {
fluent_builders::Unsubscribe::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`UntagResource`](crate::client::fluent_builders::UntagResource) operation.
///
/// - The fluent builder is configurable:
/// - [`resource_arn(impl Into<String>)`](crate::client::fluent_builders::UntagResource::resource_arn) / [`set_resource_arn(Option<String>)`](crate::client::fluent_builders::UntagResource::set_resource_arn): <p>The ARN of the topic from which to remove tags.</p>
/// - [`tag_keys(Vec<String>)`](crate::client::fluent_builders::UntagResource::tag_keys) / [`set_tag_keys(Option<Vec<String>>)`](crate::client::fluent_builders::UntagResource::set_tag_keys): <p>The list of tag keys to remove from the specified topic.</p>
/// - On success, responds with [`UntagResourceOutput`](crate::output::UntagResourceOutput)
/// - On failure, responds with [`SdkError<UntagResourceError>`](crate::error::UntagResourceError)
pub fn untag_resource(&self) -> fluent_builders::UntagResource {
fluent_builders::UntagResource::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`VerifySMSSandboxPhoneNumber`](crate::client::fluent_builders::VerifySMSSandboxPhoneNumber) operation.
///
/// - The fluent builder is configurable:
/// - [`phone_number(impl Into<String>)`](crate::client::fluent_builders::VerifySMSSandboxPhoneNumber::phone_number) / [`set_phone_number(Option<String>)`](crate::client::fluent_builders::VerifySMSSandboxPhoneNumber::set_phone_number): <p>The destination phone number to verify.</p>
/// - [`one_time_password(impl Into<String>)`](crate::client::fluent_builders::VerifySMSSandboxPhoneNumber::one_time_password) / [`set_one_time_password(Option<String>)`](crate::client::fluent_builders::VerifySMSSandboxPhoneNumber::set_one_time_password): <p>The OTP sent to the destination number from the <code>CreateSMSSandBoxPhoneNumber</code> call.</p>
/// - On success, responds with [`VerifySmsSandboxPhoneNumberOutput`](crate::output::VerifySmsSandboxPhoneNumberOutput)
/// - On failure, responds with [`SdkError<VerifySMSSandboxPhoneNumberError>`](crate::error::VerifySMSSandboxPhoneNumberError)
pub fn verify_sms_sandbox_phone_number(&self) -> fluent_builders::VerifySMSSandboxPhoneNumber {
fluent_builders::VerifySMSSandboxPhoneNumber::new(self.handle.clone())
}
}
pub mod fluent_builders {
//! Utilities to ergonomically construct a request to the service.
//!
//! Fluent builders are created through the [`Client`](crate::client::Client) by calling
//! one if its operation methods. After parameters are set using the builder methods,
//! the `send` method can be called to initiate the request.
/// Fluent builder constructing a request to `AddPermission`.
///
/// <p>Adds a statement to a topic's access control policy, granting access for the specified Amazon Web Services accounts to the specified actions.</p> <note>
/// <p>To remove the ability to change topic permissions, you must deny permissions to the <code>AddPermission</code>, <code>RemovePermission</code>, and <code>SetTopicAttributes</code> actions in your IAM policy.</p>
/// </note>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct AddPermission {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::add_permission_input::Builder,
}
impl AddPermission {
/// Creates a new `AddPermission`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::AddPermission,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::AddPermissionError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::AddPermissionOutput,
aws_smithy_http::result::SdkError<crate::error::AddPermissionError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The ARN of the topic whose access control policy you wish to modify.</p>
pub fn topic_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.topic_arn(input.into());
self
}
/// <p>The ARN of the topic whose access control policy you wish to modify.</p>
pub fn set_topic_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_topic_arn(input);
self
}
/// <p>A unique identifier for the new policy statement.</p>
pub fn label(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.label(input.into());
self
}
/// <p>A unique identifier for the new policy statement.</p>
pub fn set_label(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_label(input);
self
}
/// Appends an item to `AWSAccountId`.
///
/// To override the contents of this collection use [`set_aws_account_id`](Self::set_aws_account_id).
///
/// <p>The Amazon Web Services account IDs of the users (principals) who will be given access to the specified actions. The users must have Amazon Web Services account, but do not need to be signed up for this service.</p>
pub fn aws_account_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.aws_account_id(input.into());
self
}
/// <p>The Amazon Web Services account IDs of the users (principals) who will be given access to the specified actions. The users must have Amazon Web Services account, but do not need to be signed up for this service.</p>
pub fn set_aws_account_id(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_aws_account_id(input);
self
}
/// Appends an item to `ActionName`.
///
/// To override the contents of this collection use [`set_action_name`](Self::set_action_name).
///
/// <p>The action you want to allow for the specified principal(s).</p>
/// <p>Valid values: Any Amazon SNS action name, for example <code>Publish</code>.</p>
pub fn action_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.action_name(input.into());
self
}
/// <p>The action you want to allow for the specified principal(s).</p>
/// <p>Valid values: Any Amazon SNS action name, for example <code>Publish</code>.</p>
pub fn set_action_name(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_action_name(input);
self
}
}
/// Fluent builder constructing a request to `CheckIfPhoneNumberIsOptedOut`.
///
/// <p>Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your Amazon Web Services account. You cannot send SMS messages to a number that is opted out.</p>
/// <p>To resume sending messages, you can opt in the number by using the <code>OptInPhoneNumber</code> action.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct CheckIfPhoneNumberIsOptedOut {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::check_if_phone_number_is_opted_out_input::Builder,
}
impl CheckIfPhoneNumberIsOptedOut {
/// Creates a new `CheckIfPhoneNumberIsOptedOut`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::CheckIfPhoneNumberIsOptedOut,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::CheckIfPhoneNumberIsOptedOutError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::CheckIfPhoneNumberIsOptedOutOutput,
aws_smithy_http::result::SdkError<crate::error::CheckIfPhoneNumberIsOptedOutError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The phone number for which you want to check the opt out status.</p>
pub fn phone_number(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.phone_number(input.into());
self
}
/// <p>The phone number for which you want to check the opt out status.</p>
pub fn set_phone_number(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_phone_number(input);
self
}
}
/// Fluent builder constructing a request to `ConfirmSubscription`.
///
/// <p>Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier <code>Subscribe</code> action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the <code>AuthenticateOnUnsubscribe</code> flag is set to "true".</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ConfirmSubscription {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::confirm_subscription_input::Builder,
}
impl ConfirmSubscription {
/// Creates a new `ConfirmSubscription`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ConfirmSubscription,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ConfirmSubscriptionError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ConfirmSubscriptionOutput,
aws_smithy_http::result::SdkError<crate::error::ConfirmSubscriptionError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The ARN of the topic for which you wish to confirm a subscription.</p>
pub fn topic_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.topic_arn(input.into());
self
}
/// <p>The ARN of the topic for which you wish to confirm a subscription.</p>
pub fn set_topic_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_topic_arn(input);
self
}
/// <p>Short-lived token sent to an endpoint during the <code>Subscribe</code> action.</p>
pub fn token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.token(input.into());
self
}
/// <p>Short-lived token sent to an endpoint during the <code>Subscribe</code> action.</p>
pub fn set_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_token(input);
self
}
/// <p>Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is <code>true</code> and the request has an Amazon Web Services signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires Amazon Web Services authentication. </p>
pub fn authenticate_on_unsubscribe(
mut self,
input: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.authenticate_on_unsubscribe(input.into());
self
}
/// <p>Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is <code>true</code> and the request has an Amazon Web Services signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires Amazon Web Services authentication. </p>
pub fn set_authenticate_on_unsubscribe(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_authenticate_on_unsubscribe(input);
self
}
}
/// Fluent builder constructing a request to `CreatePlatformApplication`.
///
/// <p>Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register. You must specify <code>PlatformPrincipal</code> and <code>PlatformCredential</code> attributes when using the <code>CreatePlatformApplication</code> action.</p>
/// <p> <code>PlatformPrincipal</code> and <code>PlatformCredential</code> are received from the notification service.</p>
/// <ul>
/// <li> <p>For <code>ADM</code>, <code>PlatformPrincipal</code> is <code>client id</code> and <code>PlatformCredential</code> is <code>client secret</code>.</p> </li>
/// <li> <p>For <code>Baidu</code>, <code>PlatformPrincipal</code> is <code>API key</code> and <code>PlatformCredential</code> is <code>secret key</code>.</p> </li>
/// <li> <p>For <code>APNS</code> and <code>APNS_SANDBOX</code> using certificate credentials, <code>PlatformPrincipal</code> is <code>SSL certificate</code> and <code>PlatformCredential</code> is <code>private key</code>.</p> </li>
/// <li> <p>For <code>APNS</code> and <code>APNS_SANDBOX</code> using token credentials, <code>PlatformPrincipal</code> is <code>signing key ID</code> and <code>PlatformCredential</code> is <code>signing key</code>.</p> </li>
/// <li> <p>For <code>GCM</code> (Firebase Cloud Messaging), there is no <code>PlatformPrincipal</code> and the <code>PlatformCredential</code> is <code>API key</code>.</p> </li>
/// <li> <p>For <code>MPNS</code>, <code>PlatformPrincipal</code> is <code>TLS certificate</code> and <code>PlatformCredential</code> is <code>private key</code>.</p> </li>
/// <li> <p>For <code>WNS</code>, <code>PlatformPrincipal</code> is <code>Package Security Identifier</code> and <code>PlatformCredential</code> is <code>secret key</code>.</p> </li>
/// </ul>
/// <p>You can use the returned <code>PlatformApplicationArn</code> as an attribute for the <code>CreatePlatformEndpoint</code> action.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct CreatePlatformApplication {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::create_platform_application_input::Builder,
}
impl CreatePlatformApplication {
/// Creates a new `CreatePlatformApplication`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::CreatePlatformApplication,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::CreatePlatformApplicationError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::CreatePlatformApplicationOutput,
aws_smithy_http::result::SdkError<crate::error::CreatePlatformApplicationError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.</p>
pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.name(input.into());
self
}
/// <p>Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.</p>
pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_name(input);
self
}
/// <p>The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging).</p>
pub fn platform(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.platform(input.into());
self
}
/// <p>The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging).</p>
pub fn set_platform(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_platform(input);
self
}
/// Adds a key-value pair to `Attributes`.
///
/// To override the contents of this collection use [`set_attributes`](Self::set_attributes).
///
/// <p>For a list of attributes, see <a href="https://docs.aws.amazon.com/sns/latest/api/API_SetPlatformApplicationAttributes.html">SetPlatformApplicationAttributes</a>.</p>
pub fn attributes(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.attributes(k.into(), v.into());
self
}
/// <p>For a list of attributes, see <a href="https://docs.aws.amazon.com/sns/latest/api/API_SetPlatformApplicationAttributes.html">SetPlatformApplicationAttributes</a>.</p>
pub fn set_attributes(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_attributes(input);
self
}
}
/// Fluent builder constructing a request to `CreatePlatformEndpoint`.
///
/// <p>Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. <code>CreatePlatformEndpoint</code> requires the <code>PlatformApplicationArn</code> that is returned from <code>CreatePlatformApplication</code>. You can use the returned <code>EndpointArn</code> to send a message to a mobile app or by the <code>Subscribe</code> action for subscription to a topic. The <code>CreatePlatformEndpoint</code> action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </p>
/// <p>When using <code>CreatePlatformEndpoint</code> with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePushBaiduEndpoint.html">Creating an Amazon SNS Endpoint for Baidu</a>. </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct CreatePlatformEndpoint {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::create_platform_endpoint_input::Builder,
}
impl CreatePlatformEndpoint {
/// Creates a new `CreatePlatformEndpoint`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::CreatePlatformEndpoint,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::CreatePlatformEndpointError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::CreatePlatformEndpointOutput,
aws_smithy_http::result::SdkError<crate::error::CreatePlatformEndpointError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.</p>
pub fn platform_application_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.platform_application_arn(input.into());
self
}
/// <p>PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.</p>
pub fn set_platform_application_arn(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_platform_application_arn(input);
self
}
/// <p>Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM (Firebase Cloud Messaging) or ADM, the device token equivalent is called the registration ID.</p>
pub fn token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.token(input.into());
self
}
/// <p>Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM (Firebase Cloud Messaging) or ADM, the device token equivalent is called the registration ID.</p>
pub fn set_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_token(input);
self
}
/// <p>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.</p>
pub fn custom_user_data(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.custom_user_data(input.into());
self
}
/// <p>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.</p>
pub fn set_custom_user_data(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_custom_user_data(input);
self
}
/// Adds a key-value pair to `Attributes`.
///
/// To override the contents of this collection use [`set_attributes`](Self::set_attributes).
///
/// <p>For a list of attributes, see <a href="https://docs.aws.amazon.com/sns/latest/api/API_SetEndpointAttributes.html">SetEndpointAttributes</a>.</p>
pub fn attributes(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.attributes(k.into(), v.into());
self
}
/// <p>For a list of attributes, see <a href="https://docs.aws.amazon.com/sns/latest/api/API_SetEndpointAttributes.html">SetEndpointAttributes</a>.</p>
pub fn set_attributes(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_attributes(input);
self
}
}
/// Fluent builder constructing a request to `CreateSMSSandboxPhoneNumber`.
///
/// <p>Adds a destination phone number to an Amazon Web Services account in the SMS sandbox and sends a one-time password (OTP) to that phone number.</p>
/// <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the <i>SMS sandbox</i>. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">SMS sandbox</a> in the <i>Amazon SNS Developer Guide</i>.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct CreateSMSSandboxPhoneNumber {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::create_sms_sandbox_phone_number_input::Builder,
}
impl CreateSMSSandboxPhoneNumber {
/// Creates a new `CreateSMSSandboxPhoneNumber`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::CreateSMSSandboxPhoneNumber,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::CreateSMSSandboxPhoneNumberError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::CreateSmsSandboxPhoneNumberOutput,
aws_smithy_http::result::SdkError<crate::error::CreateSMSSandboxPhoneNumberError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The destination phone number to verify. On verification, Amazon SNS adds this phone number to the list of verified phone numbers that you can send SMS messages to.</p>
pub fn phone_number(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.phone_number(input.into());
self
}
/// <p>The destination phone number to verify. On verification, Amazon SNS adds this phone number to the list of verified phone numbers that you can send SMS messages to.</p>
pub fn set_phone_number(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_phone_number(input);
self
}
/// <p>The language to use for sending the OTP. The default value is <code>en-US</code>.</p>
pub fn language_code(mut self, input: crate::model::LanguageCodeString) -> Self {
self.inner = self.inner.language_code(input);
self
}
/// <p>The language to use for sending the OTP. The default value is <code>en-US</code>.</p>
pub fn set_language_code(
mut self,
input: std::option::Option<crate::model::LanguageCodeString>,
) -> Self {
self.inner = self.inner.set_language_code(input);
self
}
}
/// Fluent builder constructing a request to `CreateTopic`.
///
/// <p>Creates a topic to which notifications can be published. Users can create at most 100,000 standard topics (at most 1,000 FIFO topics). For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-create-topic.html">Creating an Amazon SNS topic</a> in the <i>Amazon SNS Developer Guide</i>. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct CreateTopic {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::create_topic_input::Builder,
}
impl CreateTopic {
/// Creates a new `CreateTopic`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::CreateTopic,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::CreateTopicError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::CreateTopicOutput,
aws_smithy_http::result::SdkError<crate::error::CreateTopicError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The name of the topic you want to create.</p>
/// <p>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.</p>
/// <p>For a FIFO (first-in-first-out) topic, the name must end with the <code>.fifo</code> suffix. </p>
pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.name(input.into());
self
}
/// <p>The name of the topic you want to create.</p>
/// <p>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.</p>
/// <p>For a FIFO (first-in-first-out) topic, the name must end with the <code>.fifo</code> suffix. </p>
pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_name(input);
self
}
/// Adds a key-value pair to `Attributes`.
///
/// To override the contents of this collection use [`set_attributes`](Self::set_attributes).
///
/// <p>A map of attributes with their corresponding values.</p>
/// <p>The following lists the names, descriptions, and values of the special request parameters that the <code>CreateTopic</code> action uses:</p>
/// <ul>
/// <li> <p> <code>DeliveryPolicy</code> – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.</p> </li>
/// <li> <p> <code>DisplayName</code> – The display name to use for a topic with SMS subscriptions.</p> </li>
/// <li> <p> <code>FifoTopic</code> – Set to true to create a FIFO topic.</p> </li>
/// <li> <p> <code>Policy</code> – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.</p> </li>
/// <li> <p> <code>SignatureVersion</code> – The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, <code>SignatureVersion</code> is set to 1.</p> </li>
/// <li> <p> <code>TracingConfig</code> – Tracing mode of an Amazon SNS topic. By default <code>TracingConfig</code> is set to <code>PassThrough</code>, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.</p> </li>
/// </ul>
/// <p>The following attribute applies only to <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html">server-side encryption</a>:</p>
/// <ul>
/// <li> <p> <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms">Key Terms</a>. For more examples, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">KeyId</a> in the <i>Key Management Service API Reference</i>. </p> </li>
/// </ul>
/// <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html">FIFO topics</a>:</p>
/// <ul>
/// <li> <p> <code>FifoTopic</code> – When this is set to <code>true</code>, a FIFO topic is created.</p> </li>
/// <li> <p> <code>ContentBasedDeduplication</code> – Enables content-based deduplication for FIFO topics.</p>
/// <ul>
/// <li> <p>By default, <code>ContentBasedDeduplication</code> is set to <code>false</code>. If you create a FIFO topic and this attribute is <code>false</code>, you must specify a value for the <code>MessageDeduplicationId</code> parameter for the <a href="https://docs.aws.amazon.com/sns/latest/api/API_Publish.html">Publish</a> action. </p> </li>
/// <li> <p>When you set <code>ContentBasedDeduplication</code> to <code>true</code>, Amazon SNS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using the body of the message (but not the attributes of the message).</p> <p>(Optional) To override the generated value, you can specify a value for the <code>MessageDeduplicationId</code> parameter for the <code>Publish</code> action.</p> </li>
/// </ul> </li>
/// </ul>
pub fn attributes(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.attributes(k.into(), v.into());
self
}
/// <p>A map of attributes with their corresponding values.</p>
/// <p>The following lists the names, descriptions, and values of the special request parameters that the <code>CreateTopic</code> action uses:</p>
/// <ul>
/// <li> <p> <code>DeliveryPolicy</code> – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.</p> </li>
/// <li> <p> <code>DisplayName</code> – The display name to use for a topic with SMS subscriptions.</p> </li>
/// <li> <p> <code>FifoTopic</code> – Set to true to create a FIFO topic.</p> </li>
/// <li> <p> <code>Policy</code> – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.</p> </li>
/// <li> <p> <code>SignatureVersion</code> – The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, <code>SignatureVersion</code> is set to 1.</p> </li>
/// <li> <p> <code>TracingConfig</code> – Tracing mode of an Amazon SNS topic. By default <code>TracingConfig</code> is set to <code>PassThrough</code>, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.</p> </li>
/// </ul>
/// <p>The following attribute applies only to <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html">server-side encryption</a>:</p>
/// <ul>
/// <li> <p> <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms">Key Terms</a>. For more examples, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">KeyId</a> in the <i>Key Management Service API Reference</i>. </p> </li>
/// </ul>
/// <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html">FIFO topics</a>:</p>
/// <ul>
/// <li> <p> <code>FifoTopic</code> – When this is set to <code>true</code>, a FIFO topic is created.</p> </li>
/// <li> <p> <code>ContentBasedDeduplication</code> – Enables content-based deduplication for FIFO topics.</p>
/// <ul>
/// <li> <p>By default, <code>ContentBasedDeduplication</code> is set to <code>false</code>. If you create a FIFO topic and this attribute is <code>false</code>, you must specify a value for the <code>MessageDeduplicationId</code> parameter for the <a href="https://docs.aws.amazon.com/sns/latest/api/API_Publish.html">Publish</a> action. </p> </li>
/// <li> <p>When you set <code>ContentBasedDeduplication</code> to <code>true</code>, Amazon SNS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using the body of the message (but not the attributes of the message).</p> <p>(Optional) To override the generated value, you can specify a value for the <code>MessageDeduplicationId</code> parameter for the <code>Publish</code> action.</p> </li>
/// </ul> </li>
/// </ul>
pub fn set_attributes(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_attributes(input);
self
}
/// Appends an item to `Tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>The list of tags to add to a new topic.</p> <note>
/// <p>To be able to tag a topic on creation, you must have the <code>sns:CreateTopic</code> and <code>sns:TagResource</code> permissions.</p>
/// </note>
pub fn tags(mut self, input: crate::model::Tag) -> Self {
self.inner = self.inner.tags(input);
self
}
/// <p>The list of tags to add to a new topic.</p> <note>
/// <p>To be able to tag a topic on creation, you must have the <code>sns:CreateTopic</code> and <code>sns:TagResource</code> permissions.</p>
/// </note>
pub fn set_tags(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::Tag>>,
) -> Self {
self.inner = self.inner.set_tags(input);
self
}
/// <p>The body of the policy document you want to use for this topic.</p>
/// <p>You can only add one policy per topic.</p>
/// <p>The policy must be in JSON string format.</p>
/// <p>Length Constraints: Maximum length of 30,720.</p>
pub fn data_protection_policy(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.data_protection_policy(input.into());
self
}
/// <p>The body of the policy document you want to use for this topic.</p>
/// <p>You can only add one policy per topic.</p>
/// <p>The policy must be in JSON string format.</p>
/// <p>Length Constraints: Maximum length of 30,720.</p>
pub fn set_data_protection_policy(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_data_protection_policy(input);
self
}
}
/// Fluent builder constructing a request to `DeleteEndpoint`.
///
/// <p>Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </p>
/// <p>When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DeleteEndpoint {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::delete_endpoint_input::Builder,
}
impl DeleteEndpoint {
/// Creates a new `DeleteEndpoint`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DeleteEndpoint,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DeleteEndpointError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DeleteEndpointOutput,
aws_smithy_http::result::SdkError<crate::error::DeleteEndpointError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>EndpointArn of endpoint to delete.</p>
pub fn endpoint_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.endpoint_arn(input.into());
self
}
/// <p>EndpointArn of endpoint to delete.</p>
pub fn set_endpoint_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_endpoint_arn(input);
self
}
}
/// Fluent builder constructing a request to `DeletePlatformApplication`.
///
/// <p>Deletes a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DeletePlatformApplication {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::delete_platform_application_input::Builder,
}
impl DeletePlatformApplication {
/// Creates a new `DeletePlatformApplication`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DeletePlatformApplication,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DeletePlatformApplicationError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DeletePlatformApplicationOutput,
aws_smithy_http::result::SdkError<crate::error::DeletePlatformApplicationError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>PlatformApplicationArn of platform application object to delete.</p>
pub fn platform_application_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.platform_application_arn(input.into());
self
}
/// <p>PlatformApplicationArn of platform application object to delete.</p>
pub fn set_platform_application_arn(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_platform_application_arn(input);
self
}
}
/// Fluent builder constructing a request to `DeleteSMSSandboxPhoneNumber`.
///
/// <p>Deletes an Amazon Web Services account's verified or pending phone number from the SMS sandbox.</p>
/// <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the <i>SMS sandbox</i>. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">SMS sandbox</a> in the <i>Amazon SNS Developer Guide</i>.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DeleteSMSSandboxPhoneNumber {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::delete_sms_sandbox_phone_number_input::Builder,
}
impl DeleteSMSSandboxPhoneNumber {
/// Creates a new `DeleteSMSSandboxPhoneNumber`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DeleteSMSSandboxPhoneNumber,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DeleteSMSSandboxPhoneNumberError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DeleteSmsSandboxPhoneNumberOutput,
aws_smithy_http::result::SdkError<crate::error::DeleteSMSSandboxPhoneNumberError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The destination phone number to delete.</p>
pub fn phone_number(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.phone_number(input.into());
self
}
/// <p>The destination phone number to delete.</p>
pub fn set_phone_number(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_phone_number(input);
self
}
}
/// Fluent builder constructing a request to `DeleteTopic`.
///
/// <p>Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DeleteTopic {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::delete_topic_input::Builder,
}
impl DeleteTopic {
/// Creates a new `DeleteTopic`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DeleteTopic,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DeleteTopicError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DeleteTopicOutput,
aws_smithy_http::result::SdkError<crate::error::DeleteTopicError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The ARN of the topic you want to delete.</p>
pub fn topic_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.topic_arn(input.into());
self
}
/// <p>The ARN of the topic you want to delete.</p>
pub fn set_topic_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_topic_arn(input);
self
}
}
/// Fluent builder constructing a request to `GetDataProtectionPolicy`.
///
/// <p>Retrieves the specified inline <code>DataProtectionPolicy</code> document that is stored in the specified Amazon SNS topic. </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct GetDataProtectionPolicy {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::get_data_protection_policy_input::Builder,
}
impl GetDataProtectionPolicy {
/// Creates a new `GetDataProtectionPolicy`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::GetDataProtectionPolicy,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::GetDataProtectionPolicyError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::GetDataProtectionPolicyOutput,
aws_smithy_http::result::SdkError<crate::error::GetDataProtectionPolicyError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The ARN of the topic whose <code>DataProtectionPolicy</code> you want to get.</p>
/// <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the Amazon Web Services General Reference.</p>
pub fn resource_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.resource_arn(input.into());
self
}
/// <p>The ARN of the topic whose <code>DataProtectionPolicy</code> you want to get.</p>
/// <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the Amazon Web Services General Reference.</p>
pub fn set_resource_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_resource_arn(input);
self
}
}
/// Fluent builder constructing a request to `GetEndpointAttributes`.
///
/// <p>Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct GetEndpointAttributes {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::get_endpoint_attributes_input::Builder,
}
impl GetEndpointAttributes {
/// Creates a new `GetEndpointAttributes`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::GetEndpointAttributes,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::GetEndpointAttributesError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::GetEndpointAttributesOutput,
aws_smithy_http::result::SdkError<crate::error::GetEndpointAttributesError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>EndpointArn for GetEndpointAttributes input.</p>
pub fn endpoint_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.endpoint_arn(input.into());
self
}
/// <p>EndpointArn for GetEndpointAttributes input.</p>
pub fn set_endpoint_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_endpoint_arn(input);
self
}
}
/// Fluent builder constructing a request to `GetPlatformApplicationAttributes`.
///
/// <p>Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct GetPlatformApplicationAttributes {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::get_platform_application_attributes_input::Builder,
}
impl GetPlatformApplicationAttributes {
/// Creates a new `GetPlatformApplicationAttributes`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::GetPlatformApplicationAttributes,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::GetPlatformApplicationAttributesError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::GetPlatformApplicationAttributesOutput,
aws_smithy_http::result::SdkError<crate::error::GetPlatformApplicationAttributesError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>PlatformApplicationArn for GetPlatformApplicationAttributesInput.</p>
pub fn platform_application_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.platform_application_arn(input.into());
self
}
/// <p>PlatformApplicationArn for GetPlatformApplicationAttributesInput.</p>
pub fn set_platform_application_arn(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_platform_application_arn(input);
self
}
}
/// Fluent builder constructing a request to `GetSMSAttributes`.
///
/// <p>Returns the settings for sending SMS messages from your Amazon Web Services account.</p>
/// <p>These settings are set with the <code>SetSMSAttributes</code> action.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct GetSMSAttributes {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::get_sms_attributes_input::Builder,
}
impl GetSMSAttributes {
/// Creates a new `GetSMSAttributes`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::GetSMSAttributes,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::GetSMSAttributesError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::GetSmsAttributesOutput,
aws_smithy_http::result::SdkError<crate::error::GetSMSAttributesError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Appends an item to `attributes`.
///
/// To override the contents of this collection use [`set_attributes`](Self::set_attributes).
///
/// <p>A list of the individual attribute names, such as <code>MonthlySpendLimit</code>, for which you want values.</p>
/// <p>For all attribute names, see <a href="https://docs.aws.amazon.com/sns/latest/api/API_SetSMSAttributes.html">SetSMSAttributes</a>.</p>
/// <p>If you don't use this parameter, Amazon SNS returns all SMS attributes.</p>
pub fn attributes(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.attributes(input.into());
self
}
/// <p>A list of the individual attribute names, such as <code>MonthlySpendLimit</code>, for which you want values.</p>
/// <p>For all attribute names, see <a href="https://docs.aws.amazon.com/sns/latest/api/API_SetSMSAttributes.html">SetSMSAttributes</a>.</p>
/// <p>If you don't use this parameter, Amazon SNS returns all SMS attributes.</p>
pub fn set_attributes(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_attributes(input);
self
}
}
/// Fluent builder constructing a request to `GetSMSSandboxAccountStatus`.
///
/// <p>Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target Amazon Web Services Region.</p>
/// <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the <i>SMS sandbox</i>. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">SMS sandbox</a> in the <i>Amazon SNS Developer Guide</i>.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct GetSMSSandboxAccountStatus {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::get_sms_sandbox_account_status_input::Builder,
}
impl GetSMSSandboxAccountStatus {
/// Creates a new `GetSMSSandboxAccountStatus`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::GetSMSSandboxAccountStatus,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::GetSMSSandboxAccountStatusError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::GetSmsSandboxAccountStatusOutput,
aws_smithy_http::result::SdkError<crate::error::GetSMSSandboxAccountStatusError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
}
/// Fluent builder constructing a request to `GetSubscriptionAttributes`.
///
/// <p>Returns all of the properties of a subscription.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct GetSubscriptionAttributes {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::get_subscription_attributes_input::Builder,
}
impl GetSubscriptionAttributes {
/// Creates a new `GetSubscriptionAttributes`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::GetSubscriptionAttributes,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::GetSubscriptionAttributesError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::GetSubscriptionAttributesOutput,
aws_smithy_http::result::SdkError<crate::error::GetSubscriptionAttributesError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The ARN of the subscription whose properties you want to get.</p>
pub fn subscription_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.subscription_arn(input.into());
self
}
/// <p>The ARN of the subscription whose properties you want to get.</p>
pub fn set_subscription_arn(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_subscription_arn(input);
self
}
}
/// Fluent builder constructing a request to `GetTopicAttributes`.
///
/// <p>Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct GetTopicAttributes {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::get_topic_attributes_input::Builder,
}
impl GetTopicAttributes {
/// Creates a new `GetTopicAttributes`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::GetTopicAttributes,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::GetTopicAttributesError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::GetTopicAttributesOutput,
aws_smithy_http::result::SdkError<crate::error::GetTopicAttributesError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The ARN of the topic whose properties you want to get.</p>
pub fn topic_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.topic_arn(input.into());
self
}
/// <p>The ARN of the topic whose properties you want to get.</p>
pub fn set_topic_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_topic_arn(input);
self
}
}
/// Fluent builder constructing a request to `ListEndpointsByPlatformApplication`.
///
/// <p>Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM (Firebase Cloud Messaging) and APNS. The results for <code>ListEndpointsByPlatformApplication</code> are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call <code>ListEndpointsByPlatformApplication</code> again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </p>
/// <p>This action is throttled at 30 transactions per second (TPS).</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ListEndpointsByPlatformApplication {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::list_endpoints_by_platform_application_input::Builder,
}
impl ListEndpointsByPlatformApplication {
/// Creates a new `ListEndpointsByPlatformApplication`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ListEndpointsByPlatformApplication,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<
crate::error::ListEndpointsByPlatformApplicationError,
>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ListEndpointsByPlatformApplicationOutput,
aws_smithy_http::result::SdkError<
crate::error::ListEndpointsByPlatformApplicationError,
>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::ListEndpointsByPlatformApplicationPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(
self,
) -> crate::paginator::ListEndpointsByPlatformApplicationPaginator {
crate::paginator::ListEndpointsByPlatformApplicationPaginator::new(
self.handle,
self.inner,
)
}
/// <p>PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.</p>
pub fn platform_application_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.platform_application_arn(input.into());
self
}
/// <p>PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.</p>
pub fn set_platform_application_arn(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_platform_application_arn(input);
self
}
/// <p>NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results.</p>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <p>NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results.</p>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
/// Fluent builder constructing a request to `ListOriginationNumbers`.
///
/// <p>Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata. For more information about origination numbers, see <a href="https://docs.aws.amazon.com/sns/latest/dg/channels-sms-originating-identities-origination-numbers.html">Origination numbers</a> in the <i>Amazon SNS Developer Guide</i>.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ListOriginationNumbers {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::list_origination_numbers_input::Builder,
}
impl ListOriginationNumbers {
/// Creates a new `ListOriginationNumbers`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ListOriginationNumbers,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ListOriginationNumbersError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ListOriginationNumbersOutput,
aws_smithy_http::result::SdkError<crate::error::ListOriginationNumbersError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::ListOriginationNumbersPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::ListOriginationNumbersPaginator {
crate::paginator::ListOriginationNumbersPaginator::new(self.handle, self.inner)
}
/// <p>Token that the previous <code>ListOriginationNumbers</code> request returns.</p>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <p>Token that the previous <code>ListOriginationNumbers</code> request returns.</p>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
/// <p>The maximum number of origination numbers to return.</p>
pub fn max_results(mut self, input: i32) -> Self {
self.inner = self.inner.max_results(input);
self
}
/// <p>The maximum number of origination numbers to return.</p>
pub fn set_max_results(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_max_results(input);
self
}
}
/// Fluent builder constructing a request to `ListPhoneNumbersOptedOut`.
///
/// <p>Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.</p>
/// <p>The results for <code>ListPhoneNumbersOptedOut</code> are paginated, and each page returns up to 100 phone numbers. If additional phone numbers are available after the first page of results, then a <code>NextToken</code> string will be returned. To receive the next page, you call <code>ListPhoneNumbersOptedOut</code> again using the <code>NextToken</code> string received from the previous call. When there are no more records to return, <code>NextToken</code> will be null.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ListPhoneNumbersOptedOut {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::list_phone_numbers_opted_out_input::Builder,
}
impl ListPhoneNumbersOptedOut {
/// Creates a new `ListPhoneNumbersOptedOut`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ListPhoneNumbersOptedOut,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ListPhoneNumbersOptedOutError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ListPhoneNumbersOptedOutOutput,
aws_smithy_http::result::SdkError<crate::error::ListPhoneNumbersOptedOutError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::ListPhoneNumbersOptedOutPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::ListPhoneNumbersOptedOutPaginator {
crate::paginator::ListPhoneNumbersOptedOutPaginator::new(self.handle, self.inner)
}
/// <p>A <code>NextToken</code> string is used when you call the <code>ListPhoneNumbersOptedOut</code> action to retrieve additional records that are available after the first page of results.</p>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <p>A <code>NextToken</code> string is used when you call the <code>ListPhoneNumbersOptedOut</code> action to retrieve additional records that are available after the first page of results.</p>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
/// Fluent builder constructing a request to `ListPlatformApplications`.
///
/// <p>Lists the platform application objects for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). The results for <code>ListPlatformApplications</code> are paginated and return a limited list of applications, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call <code>ListPlatformApplications</code> using the NextToken string received from the previous call. When there are no more records to return, <code>NextToken</code> will be null. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </p>
/// <p>This action is throttled at 15 transactions per second (TPS).</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ListPlatformApplications {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::list_platform_applications_input::Builder,
}
impl ListPlatformApplications {
/// Creates a new `ListPlatformApplications`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ListPlatformApplications,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ListPlatformApplicationsError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ListPlatformApplicationsOutput,
aws_smithy_http::result::SdkError<crate::error::ListPlatformApplicationsError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::ListPlatformApplicationsPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::ListPlatformApplicationsPaginator {
crate::paginator::ListPlatformApplicationsPaginator::new(self.handle, self.inner)
}
/// <p>NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results.</p>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <p>NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results.</p>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
/// Fluent builder constructing a request to `ListSMSSandboxPhoneNumbers`.
///
/// <p>Lists the calling Amazon Web Services account's current verified and pending destination phone numbers in the SMS sandbox.</p>
/// <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the <i>SMS sandbox</i>. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">SMS sandbox</a> in the <i>Amazon SNS Developer Guide</i>.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ListSMSSandboxPhoneNumbers {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::list_sms_sandbox_phone_numbers_input::Builder,
}
impl ListSMSSandboxPhoneNumbers {
/// Creates a new `ListSMSSandboxPhoneNumbers`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ListSMSSandboxPhoneNumbers,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ListSMSSandboxPhoneNumbersError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ListSmsSandboxPhoneNumbersOutput,
aws_smithy_http::result::SdkError<crate::error::ListSMSSandboxPhoneNumbersError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::ListSmsSandboxPhoneNumbersPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::ListSmsSandboxPhoneNumbersPaginator {
crate::paginator::ListSmsSandboxPhoneNumbersPaginator::new(self.handle, self.inner)
}
/// <p>Token that the previous <code>ListSMSSandboxPhoneNumbersInput</code> request returns.</p>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <p>Token that the previous <code>ListSMSSandboxPhoneNumbersInput</code> request returns.</p>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
/// <p>The maximum number of phone numbers to return.</p>
pub fn max_results(mut self, input: i32) -> Self {
self.inner = self.inner.max_results(input);
self
}
/// <p>The maximum number of phone numbers to return.</p>
pub fn set_max_results(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_max_results(input);
self
}
}
/// Fluent builder constructing a request to `ListSubscriptions`.
///
/// <p>Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in a new <code>ListSubscriptions</code> call to get further results.</p>
/// <p>This action is throttled at 30 transactions per second (TPS).</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ListSubscriptions {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::list_subscriptions_input::Builder,
}
impl ListSubscriptions {
/// Creates a new `ListSubscriptions`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ListSubscriptions,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ListSubscriptionsError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ListSubscriptionsOutput,
aws_smithy_http::result::SdkError<crate::error::ListSubscriptionsError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::ListSubscriptionsPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::ListSubscriptionsPaginator {
crate::paginator::ListSubscriptionsPaginator::new(self.handle, self.inner)
}
/// <p>Token returned by the previous <code>ListSubscriptions</code> request.</p>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <p>Token returned by the previous <code>ListSubscriptions</code> request.</p>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
/// Fluent builder constructing a request to `ListSubscriptionsByTopic`.
///
/// <p>Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in a new <code>ListSubscriptionsByTopic</code> call to get further results.</p>
/// <p>This action is throttled at 30 transactions per second (TPS).</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ListSubscriptionsByTopic {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::list_subscriptions_by_topic_input::Builder,
}
impl ListSubscriptionsByTopic {
/// Creates a new `ListSubscriptionsByTopic`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ListSubscriptionsByTopic,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ListSubscriptionsByTopicError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ListSubscriptionsByTopicOutput,
aws_smithy_http::result::SdkError<crate::error::ListSubscriptionsByTopicError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::ListSubscriptionsByTopicPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::ListSubscriptionsByTopicPaginator {
crate::paginator::ListSubscriptionsByTopicPaginator::new(self.handle, self.inner)
}
/// <p>The ARN of the topic for which you wish to find subscriptions.</p>
pub fn topic_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.topic_arn(input.into());
self
}
/// <p>The ARN of the topic for which you wish to find subscriptions.</p>
pub fn set_topic_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_topic_arn(input);
self
}
/// <p>Token returned by the previous <code>ListSubscriptionsByTopic</code> request.</p>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <p>Token returned by the previous <code>ListSubscriptionsByTopic</code> request.</p>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
/// Fluent builder constructing a request to `ListTagsForResource`.
///
/// <p>List all tags added to the specified Amazon SNS topic. For an overview, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-tags.html">Amazon SNS Tags</a> in the <i>Amazon Simple Notification Service Developer Guide</i>.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ListTagsForResource {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::list_tags_for_resource_input::Builder,
}
impl ListTagsForResource {
/// Creates a new `ListTagsForResource`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ListTagsForResource,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ListTagsForResourceError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ListTagsForResourceOutput,
aws_smithy_http::result::SdkError<crate::error::ListTagsForResourceError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The ARN of the topic for which to list tags.</p>
pub fn resource_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.resource_arn(input.into());
self
}
/// <p>The ARN of the topic for which to list tags.</p>
pub fn set_resource_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_resource_arn(input);
self
}
}
/// Fluent builder constructing a request to `ListTopics`.
///
/// <p>Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in a new <code>ListTopics</code> call to get further results.</p>
/// <p>This action is throttled at 30 transactions per second (TPS).</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ListTopics {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::list_topics_input::Builder,
}
impl ListTopics {
/// Creates a new `ListTopics`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ListTopics,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ListTopicsError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ListTopicsOutput,
aws_smithy_http::result::SdkError<crate::error::ListTopicsError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::ListTopicsPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::ListTopicsPaginator {
crate::paginator::ListTopicsPaginator::new(self.handle, self.inner)
}
/// <p>Token returned by the previous <code>ListTopics</code> request.</p>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <p>Token returned by the previous <code>ListTopics</code> request.</p>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
/// Fluent builder constructing a request to `OptInPhoneNumber`.
///
/// <p>Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number.</p>
/// <p>You can opt in a phone number only once every 30 days.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct OptInPhoneNumber {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::opt_in_phone_number_input::Builder,
}
impl OptInPhoneNumber {
/// Creates a new `OptInPhoneNumber`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::OptInPhoneNumber,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::OptInPhoneNumberError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::OptInPhoneNumberOutput,
aws_smithy_http::result::SdkError<crate::error::OptInPhoneNumberError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The phone number to opt in. Use E.164 format.</p>
pub fn phone_number(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.phone_number(input.into());
self
}
/// <p>The phone number to opt in. Use E.164 format.</p>
pub fn set_phone_number(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_phone_number(input);
self
}
}
/// Fluent builder constructing a request to `Publish`.
///
/// <p>Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone number, or a message to a mobile platform endpoint (when you specify the <code>TargetArn</code>).</p>
/// <p>If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint.</p>
/// <p>When a <code>messageId</code> is returned, the message is saved and Amazon SNS immediately delivers it to subscribers.</p>
/// <p>To use the <code>Publish</code> action for publishing a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned when making a call with the <code>CreatePlatformEndpoint</code> action. </p>
/// <p>For more information about formatting messages, see <a href="https://docs.aws.amazon.com/sns/latest/dg/mobile-push-send-custommessage.html">Send Custom Platform-Specific Payloads in Messages to Mobile Devices</a>. </p> <important>
/// <p>You can publish messages only to topics and endpoints in the same Amazon Web Services Region.</p>
/// </important>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct Publish {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::publish_input::Builder,
}
impl Publish {
/// Creates a new `Publish`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::Publish,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::PublishError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::PublishOutput,
aws_smithy_http::result::SdkError<crate::error::PublishError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The topic you want to publish to.</p>
/// <p>If you don't specify a value for the <code>TopicArn</code> parameter, you must specify a value for the <code>PhoneNumber</code> or <code>TargetArn</code> parameters.</p>
pub fn topic_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.topic_arn(input.into());
self
}
/// <p>The topic you want to publish to.</p>
/// <p>If you don't specify a value for the <code>TopicArn</code> parameter, you must specify a value for the <code>PhoneNumber</code> or <code>TargetArn</code> parameters.</p>
pub fn set_topic_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_topic_arn(input);
self
}
/// <p>If you don't specify a value for the <code>TargetArn</code> parameter, you must specify a value for the <code>PhoneNumber</code> or <code>TopicArn</code> parameters.</p>
pub fn target_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.target_arn(input.into());
self
}
/// <p>If you don't specify a value for the <code>TargetArn</code> parameter, you must specify a value for the <code>PhoneNumber</code> or <code>TopicArn</code> parameters.</p>
pub fn set_target_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_target_arn(input);
self
}
/// <p>The phone number to which you want to deliver an SMS message. Use E.164 format.</p>
/// <p>If you don't specify a value for the <code>PhoneNumber</code> parameter, you must specify a value for the <code>TargetArn</code> or <code>TopicArn</code> parameters.</p>
pub fn phone_number(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.phone_number(input.into());
self
}
/// <p>The phone number to which you want to deliver an SMS message. Use E.164 format.</p>
/// <p>If you don't specify a value for the <code>PhoneNumber</code> parameter, you must specify a value for the <code>TargetArn</code> or <code>TopicArn</code> parameters.</p>
pub fn set_phone_number(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_phone_number(input);
self
}
/// <p>The message you want to send.</p>
/// <p>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 <code>MessageStructure</code> parameter to <code>json</code> and use a JSON object for the <code>Message</code> parameter. </p>
/// <p></p>
/// <p>Constraints:</p>
/// <ul>
/// <li> <p>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).</p> </li>
/// <li> <p>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.</p> <p>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.</p> <p>The total size limit for a single SMS <code>Publish</code> action is 1,600 characters.</p> </li>
/// </ul>
/// <p>JSON-specific constraints:</p>
/// <ul>
/// <li> <p>Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.</p> </li>
/// <li> <p>The values will be parsed (unescaped) before they are used in outgoing messages.</p> </li>
/// <li> <p>Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).</p> </li>
/// <li> <p>Values have a minimum length of 0 (the empty string, "", is allowed).</p> </li>
/// <li> <p>Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).</p> </li>
/// <li> <p>Non-string values will cause the key to be ignored.</p> </li>
/// <li> <p>Keys that do not correspond to supported transport protocols are ignored.</p> </li>
/// <li> <p>Duplicate keys are not allowed.</p> </li>
/// <li> <p>Failure to parse or validate any key or value in the message will cause the <code>Publish</code> call to return an error (no partial delivery).</p> </li>
/// </ul>
pub fn message(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.message(input.into());
self
}
/// <p>The message you want to send.</p>
/// <p>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 <code>MessageStructure</code> parameter to <code>json</code> and use a JSON object for the <code>Message</code> parameter. </p>
/// <p></p>
/// <p>Constraints:</p>
/// <ul>
/// <li> <p>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).</p> </li>
/// <li> <p>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.</p> <p>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.</p> <p>The total size limit for a single SMS <code>Publish</code> action is 1,600 characters.</p> </li>
/// </ul>
/// <p>JSON-specific constraints:</p>
/// <ul>
/// <li> <p>Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.</p> </li>
/// <li> <p>The values will be parsed (unescaped) before they are used in outgoing messages.</p> </li>
/// <li> <p>Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).</p> </li>
/// <li> <p>Values have a minimum length of 0 (the empty string, "", is allowed).</p> </li>
/// <li> <p>Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).</p> </li>
/// <li> <p>Non-string values will cause the key to be ignored.</p> </li>
/// <li> <p>Keys that do not correspond to supported transport protocols are ignored.</p> </li>
/// <li> <p>Duplicate keys are not allowed.</p> </li>
/// <li> <p>Failure to parse or validate any key or value in the message will cause the <code>Publish</code> call to return an error (no partial delivery).</p> </li>
/// </ul>
pub fn set_message(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_message(input);
self
}
/// <p>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.</p>
/// <p>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.</p>
pub fn subject(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.subject(input.into());
self
}
/// <p>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.</p>
/// <p>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.</p>
pub fn set_subject(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_subject(input);
self
}
/// <p>Set <code>MessageStructure</code> to <code>json</code> 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 <code>MessageStructure</code> to <code>json</code>, the value of the <code>Message</code> parameter must: </p>
/// <ul>
/// <li> <p>be a syntactically valid JSON object; and</p> </li>
/// <li> <p>contain at least a top-level JSON key of "default" with a value that is a string.</p> </li>
/// </ul>
/// <p>You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http").</p>
/// <p>Valid value: <code>json</code> </p>
pub fn message_structure(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.message_structure(input.into());
self
}
/// <p>Set <code>MessageStructure</code> to <code>json</code> 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 <code>MessageStructure</code> to <code>json</code>, the value of the <code>Message</code> parameter must: </p>
/// <ul>
/// <li> <p>be a syntactically valid JSON object; and</p> </li>
/// <li> <p>contain at least a top-level JSON key of "default" with a value that is a string.</p> </li>
/// </ul>
/// <p>You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http").</p>
/// <p>Valid value: <code>json</code> </p>
pub fn set_message_structure(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_message_structure(input);
self
}
/// Adds a key-value pair to `MessageAttributes`.
///
/// To override the contents of this collection use [`set_message_attributes`](Self::set_message_attributes).
///
/// <p>Message attributes for Publish action.</p>
pub fn message_attributes(
mut self,
k: impl Into<std::string::String>,
v: crate::model::MessageAttributeValue,
) -> Self {
self.inner = self.inner.message_attributes(k.into(), v);
self
}
/// <p>Message attributes for Publish action.</p>
pub fn set_message_attributes(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, crate::model::MessageAttributeValue>,
>,
) -> Self {
self.inner = self.inner.set_message_attributes(input);
self
}
/// <p>This parameter applies only to FIFO (first-in-first-out) topics. The <code>MessageDeduplicationId</code> can contain up to 128 alphanumeric characters <code>(a-z, A-Z, 0-9)</code> and punctuation <code>(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)</code>.</p>
/// <p>Every message must have a unique <code>MessageDeduplicationId</code>, which is a token used for deduplication of sent messages. If a message with a particular <code>MessageDeduplicationId</code> is sent successfully, any message sent with the same <code>MessageDeduplicationId</code> during the 5-minute deduplication interval is treated as a duplicate. </p>
/// <p>If the topic has <code>ContentBasedDeduplication</code> set, the system generates a <code>MessageDeduplicationId</code> based on the contents of the message. Your <code>MessageDeduplicationId</code> overrides the generated one.</p>
pub fn message_deduplication_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.message_deduplication_id(input.into());
self
}
/// <p>This parameter applies only to FIFO (first-in-first-out) topics. The <code>MessageDeduplicationId</code> can contain up to 128 alphanumeric characters <code>(a-z, A-Z, 0-9)</code> and punctuation <code>(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)</code>.</p>
/// <p>Every message must have a unique <code>MessageDeduplicationId</code>, which is a token used for deduplication of sent messages. If a message with a particular <code>MessageDeduplicationId</code> is sent successfully, any message sent with the same <code>MessageDeduplicationId</code> during the 5-minute deduplication interval is treated as a duplicate. </p>
/// <p>If the topic has <code>ContentBasedDeduplication</code> set, the system generates a <code>MessageDeduplicationId</code> based on the contents of the message. Your <code>MessageDeduplicationId</code> overrides the generated one.</p>
pub fn set_message_deduplication_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_message_deduplication_id(input);
self
}
/// <p>This parameter applies only to FIFO (first-in-first-out) topics. The <code>MessageGroupId</code> can contain up to 128 alphanumeric characters <code>(a-z, A-Z, 0-9)</code> and punctuation <code>(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)</code>.</p>
/// <p>The <code>MessageGroupId</code> 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 <code>MessageGroupId</code>.</p>
pub fn message_group_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.message_group_id(input.into());
self
}
/// <p>This parameter applies only to FIFO (first-in-first-out) topics. The <code>MessageGroupId</code> can contain up to 128 alphanumeric characters <code>(a-z, A-Z, 0-9)</code> and punctuation <code>(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)</code>.</p>
/// <p>The <code>MessageGroupId</code> 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 <code>MessageGroupId</code>.</p>
pub fn set_message_group_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_message_group_id(input);
self
}
}
/// Fluent builder constructing a request to `PublishBatch`.
///
/// <p>Publishes up to ten messages to the specified topic. This is a batch version of <code>Publish</code>. For FIFO topics, multiple messages within a single batch are published in the order they are sent, and messages are deduplicated within the batch and across batches for 5 minutes.</p>
/// <p>The result of publishing each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of <code>200</code>.</p>
/// <p>The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes). </p>
/// <p>Some actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: </p>
/// <p>&AttributeName.1=first</p>
/// <p>&AttributeName.2=second</p>
/// <p>If you send a batch message to a topic, Amazon SNS publishes the batch message to each endpoint that is subscribed to the topic. The format of the batch message depends on the notification protocol for each subscribed endpoint.</p>
/// <p>When a <code>messageId</code> is returned, the batch message is saved and Amazon SNS immediately delivers the message to subscribers.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct PublishBatch {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::publish_batch_input::Builder,
}
impl PublishBatch {
/// Creates a new `PublishBatch`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::PublishBatch,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::PublishBatchError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::PublishBatchOutput,
aws_smithy_http::result::SdkError<crate::error::PublishBatchError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The Amazon resource name (ARN) of the topic you want to batch publish to.</p>
pub fn topic_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.topic_arn(input.into());
self
}
/// <p>The Amazon resource name (ARN) of the topic you want to batch publish to.</p>
pub fn set_topic_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_topic_arn(input);
self
}
/// Appends an item to `PublishBatchRequestEntries`.
///
/// To override the contents of this collection use [`set_publish_batch_request_entries`](Self::set_publish_batch_request_entries).
///
/// <p>A list of <code>PublishBatch</code> request entries to be sent to the SNS topic.</p>
pub fn publish_batch_request_entries(
mut self,
input: crate::model::PublishBatchRequestEntry,
) -> Self {
self.inner = self.inner.publish_batch_request_entries(input);
self
}
/// <p>A list of <code>PublishBatch</code> request entries to be sent to the SNS topic.</p>
pub fn set_publish_batch_request_entries(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::PublishBatchRequestEntry>>,
) -> Self {
self.inner = self.inner.set_publish_batch_request_entries(input);
self
}
}
/// Fluent builder constructing a request to `PutDataProtectionPolicy`.
///
/// <p>Adds or updates an inline policy document that is stored in the specified Amazon SNS topic.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct PutDataProtectionPolicy {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::put_data_protection_policy_input::Builder,
}
impl PutDataProtectionPolicy {
/// Creates a new `PutDataProtectionPolicy`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::PutDataProtectionPolicy,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::PutDataProtectionPolicyError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::PutDataProtectionPolicyOutput,
aws_smithy_http::result::SdkError<crate::error::PutDataProtectionPolicyError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The ARN of the topic whose <code>DataProtectionPolicy</code> you want to add or update.</p>
/// <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the Amazon Web Services General Reference.</p>
pub fn resource_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.resource_arn(input.into());
self
}
/// <p>The ARN of the topic whose <code>DataProtectionPolicy</code> you want to add or update.</p>
/// <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the Amazon Web Services General Reference.</p>
pub fn set_resource_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_resource_arn(input);
self
}
/// <p>The JSON serialization of the topic's <code>DataProtectionPolicy</code>.</p>
/// <p>The <code>DataProtectionPolicy</code> must be in JSON string format.</p>
/// <p>Length Constraints: Maximum length of 30,720.</p>
pub fn data_protection_policy(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.data_protection_policy(input.into());
self
}
/// <p>The JSON serialization of the topic's <code>DataProtectionPolicy</code>.</p>
/// <p>The <code>DataProtectionPolicy</code> must be in JSON string format.</p>
/// <p>Length Constraints: Maximum length of 30,720.</p>
pub fn set_data_protection_policy(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_data_protection_policy(input);
self
}
}
/// Fluent builder constructing a request to `RemovePermission`.
///
/// <p>Removes a statement from a topic's access control policy.</p> <note>
/// <p>To remove the ability to change topic permissions, you must deny permissions to the <code>AddPermission</code>, <code>RemovePermission</code>, and <code>SetTopicAttributes</code> actions in your IAM policy.</p>
/// </note>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct RemovePermission {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::remove_permission_input::Builder,
}
impl RemovePermission {
/// Creates a new `RemovePermission`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::RemovePermission,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::RemovePermissionError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::RemovePermissionOutput,
aws_smithy_http::result::SdkError<crate::error::RemovePermissionError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The ARN of the topic whose access control policy you wish to modify.</p>
pub fn topic_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.topic_arn(input.into());
self
}
/// <p>The ARN of the topic whose access control policy you wish to modify.</p>
pub fn set_topic_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_topic_arn(input);
self
}
/// <p>The unique label of the statement you want to remove.</p>
pub fn label(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.label(input.into());
self
}
/// <p>The unique label of the statement you want to remove.</p>
pub fn set_label(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_label(input);
self
}
}
/// Fluent builder constructing a request to `SetEndpointAttributes`.
///
/// <p>Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct SetEndpointAttributes {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::set_endpoint_attributes_input::Builder,
}
impl SetEndpointAttributes {
/// Creates a new `SetEndpointAttributes`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::SetEndpointAttributes,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::SetEndpointAttributesError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::SetEndpointAttributesOutput,
aws_smithy_http::result::SdkError<crate::error::SetEndpointAttributesError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>EndpointArn used for SetEndpointAttributes action.</p>
pub fn endpoint_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.endpoint_arn(input.into());
self
}
/// <p>EndpointArn used for SetEndpointAttributes action.</p>
pub fn set_endpoint_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_endpoint_arn(input);
self
}
/// Adds a key-value pair to `Attributes`.
///
/// To override the contents of this collection use [`set_attributes`](Self::set_attributes).
///
/// <p>A map of the endpoint attributes. Attributes in this map include the following:</p>
/// <ul>
/// <li> <p> <code>CustomUserData</code> – 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.</p> </li>
/// <li> <p> <code>Enabled</code> – 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.</p> </li>
/// <li> <p> <code>Token</code> – 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.</p> </li>
/// </ul>
pub fn attributes(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.attributes(k.into(), v.into());
self
}
/// <p>A map of the endpoint attributes. Attributes in this map include the following:</p>
/// <ul>
/// <li> <p> <code>CustomUserData</code> – 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.</p> </li>
/// <li> <p> <code>Enabled</code> – 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.</p> </li>
/// <li> <p> <code>Token</code> – 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.</p> </li>
/// </ul>
pub fn set_attributes(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_attributes(input);
self
}
}
/// Fluent builder constructing a request to `SetPlatformApplicationAttributes`.
///
/// <p>Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. For information on configuring attributes for message delivery status, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-msg-status.html">Using Amazon SNS Application Attributes for Message Delivery Status</a>. </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct SetPlatformApplicationAttributes {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::set_platform_application_attributes_input::Builder,
}
impl SetPlatformApplicationAttributes {
/// Creates a new `SetPlatformApplicationAttributes`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::SetPlatformApplicationAttributes,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::SetPlatformApplicationAttributesError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::SetPlatformApplicationAttributesOutput,
aws_smithy_http::result::SdkError<crate::error::SetPlatformApplicationAttributesError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>PlatformApplicationArn for SetPlatformApplicationAttributes action.</p>
pub fn platform_application_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.platform_application_arn(input.into());
self
}
/// <p>PlatformApplicationArn for SetPlatformApplicationAttributes action.</p>
pub fn set_platform_application_arn(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_platform_application_arn(input);
self
}
/// Adds a key-value pair to `Attributes`.
///
/// To override the contents of this collection use [`set_attributes`](Self::set_attributes).
///
/// <p>A map of the platform application attributes. Attributes in this map include the following:</p>
/// <ul>
/// <li> <p> <code>PlatformCredential</code> – The credential received from the notification service.</p>
/// <ul>
/// <li> <p>For ADM, <code>PlatformCredential</code>is client secret.</p> </li>
/// <li> <p>For Apple Services using certificate credentials, <code>PlatformCredential</code> is private key.</p> </li>
/// <li> <p>For Apple Services using token credentials, <code>PlatformCredential</code> is signing key.</p> </li>
/// <li> <p>For GCM (Firebase Cloud Messaging), <code>PlatformCredential</code> is API key. </p> </li>
/// </ul> </li>
/// </ul>
/// <ul>
/// <li> <p> <code>PlatformPrincipal</code> – The principal received from the notification service.</p>
/// <ul>
/// <li> <p>For ADM, <code>PlatformPrincipal</code>is client id.</p> </li>
/// <li> <p>For Apple Services using certificate credentials, <code>PlatformPrincipal</code> is SSL certificate.</p> </li>
/// <li> <p>For Apple Services using token credentials, <code>PlatformPrincipal</code> is signing key ID.</p> </li>
/// <li> <p>For GCM (Firebase Cloud Messaging), there is no <code>PlatformPrincipal</code>. </p> </li>
/// </ul> </li>
/// </ul>
/// <ul>
/// <li> <p> <code>EventEndpointCreated</code> – Topic ARN to which <code>EndpointCreated</code> event notifications are sent.</p> </li>
/// <li> <p> <code>EventEndpointDeleted</code> – Topic ARN to which <code>EndpointDeleted</code> event notifications are sent.</p> </li>
/// <li> <p> <code>EventEndpointUpdated</code> – Topic ARN to which <code>EndpointUpdate</code> event notifications are sent.</p> </li>
/// <li> <p> <code>EventDeliveryFailure</code> – Topic ARN to which <code>DeliveryFailure</code> event notifications are sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.</p> </li>
/// <li> <p> <code>SuccessFeedbackRoleArn</code> – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.</p> </li>
/// <li> <p> <code>FailureFeedbackRoleArn</code> – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.</p> </li>
/// <li> <p> <code>SuccessFeedbackSampleRate</code> – Sample rate percentage (0-100) of successfully delivered messages.</p> </li>
/// </ul>
/// <p>The following attributes only apply to <code>APNs</code> token-based authentication:</p>
/// <ul>
/// <li> <p> <code>ApplePlatformTeamID</code> – The identifier that's assigned to your Apple developer account team.</p> </li>
/// <li> <p> <code>ApplePlatformBundleID</code> – The bundle identifier that's assigned to your iOS app.</p> </li>
/// </ul>
pub fn attributes(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.attributes(k.into(), v.into());
self
}
/// <p>A map of the platform application attributes. Attributes in this map include the following:</p>
/// <ul>
/// <li> <p> <code>PlatformCredential</code> – The credential received from the notification service.</p>
/// <ul>
/// <li> <p>For ADM, <code>PlatformCredential</code>is client secret.</p> </li>
/// <li> <p>For Apple Services using certificate credentials, <code>PlatformCredential</code> is private key.</p> </li>
/// <li> <p>For Apple Services using token credentials, <code>PlatformCredential</code> is signing key.</p> </li>
/// <li> <p>For GCM (Firebase Cloud Messaging), <code>PlatformCredential</code> is API key. </p> </li>
/// </ul> </li>
/// </ul>
/// <ul>
/// <li> <p> <code>PlatformPrincipal</code> – The principal received from the notification service.</p>
/// <ul>
/// <li> <p>For ADM, <code>PlatformPrincipal</code>is client id.</p> </li>
/// <li> <p>For Apple Services using certificate credentials, <code>PlatformPrincipal</code> is SSL certificate.</p> </li>
/// <li> <p>For Apple Services using token credentials, <code>PlatformPrincipal</code> is signing key ID.</p> </li>
/// <li> <p>For GCM (Firebase Cloud Messaging), there is no <code>PlatformPrincipal</code>. </p> </li>
/// </ul> </li>
/// </ul>
/// <ul>
/// <li> <p> <code>EventEndpointCreated</code> – Topic ARN to which <code>EndpointCreated</code> event notifications are sent.</p> </li>
/// <li> <p> <code>EventEndpointDeleted</code> – Topic ARN to which <code>EndpointDeleted</code> event notifications are sent.</p> </li>
/// <li> <p> <code>EventEndpointUpdated</code> – Topic ARN to which <code>EndpointUpdate</code> event notifications are sent.</p> </li>
/// <li> <p> <code>EventDeliveryFailure</code> – Topic ARN to which <code>DeliveryFailure</code> event notifications are sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.</p> </li>
/// <li> <p> <code>SuccessFeedbackRoleArn</code> – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.</p> </li>
/// <li> <p> <code>FailureFeedbackRoleArn</code> – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.</p> </li>
/// <li> <p> <code>SuccessFeedbackSampleRate</code> – Sample rate percentage (0-100) of successfully delivered messages.</p> </li>
/// </ul>
/// <p>The following attributes only apply to <code>APNs</code> token-based authentication:</p>
/// <ul>
/// <li> <p> <code>ApplePlatformTeamID</code> – The identifier that's assigned to your Apple developer account team.</p> </li>
/// <li> <p> <code>ApplePlatformBundleID</code> – The bundle identifier that's assigned to your iOS app.</p> </li>
/// </ul>
pub fn set_attributes(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_attributes(input);
self
}
}
/// Fluent builder constructing a request to `SetSMSAttributes`.
///
/// <p>Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.</p>
/// <p>You can override some of these settings for a single message when you use the <code>Publish</code> action with the <code>MessageAttributes.entry.N</code> parameter. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html">Publishing to a mobile phone</a> in the <i>Amazon SNS Developer Guide</i>.</p> <note>
/// <p>To use this operation, you must grant the Amazon SNS service principal (<code>sns.amazonaws.com</code>) permission to perform the <code>s3:ListBucket</code> action. </p>
/// </note>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct SetSMSAttributes {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::set_sms_attributes_input::Builder,
}
impl SetSMSAttributes {
/// Creates a new `SetSMSAttributes`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::SetSMSAttributes,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::SetSMSAttributesError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::SetSmsAttributesOutput,
aws_smithy_http::result::SdkError<crate::error::SetSMSAttributesError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Adds a key-value pair to `attributes`.
///
/// To override the contents of this collection use [`set_attributes`](Self::set_attributes).
///
/// <p>The default settings for sending SMS messages from your Amazon Web Services account. You can set values for the following attribute names:</p>
/// <p> <code>MonthlySpendLimit</code> – 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.</p> <important>
/// <p>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.</p>
/// </important>
/// <p>By default, the spend limit is set to the maximum allowed by Amazon SNS. If you want to raise the limit, submit an <a href="https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-sns">SNS Limit Increase case</a>. For <b>New limit value</b>, enter your desired monthly spend limit. In the <b>Use Case Description</b> field, explain that you are requesting an SMS monthly spend limit increase.</p>
/// <p> <code>DeliveryStatusIAMRole</code> – 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.</p>
/// <p> <code>DeliveryStatusSuccessSamplingRate</code> – 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 <code>0</code>. To write logs for 10% of your successful deliveries, set it to <code>10</code>.</p>
/// <p> <code>DefaultSenderID</code> – 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.</p>
/// <p> <code>DefaultSMSType</code> – The type of SMS message that you will send by default. You can assign the following values:</p>
/// <ul>
/// <li> <p> <code>Promotional</code> – (Default) Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.</p> </li>
/// <li> <p> <code>Transactional</code> – 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.</p> </li>
/// </ul>
/// <p> <code>UsageReportS3Bucket</code> – 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:</p>
/// <ul>
/// <li> <p>Time that the message was published (in UTC)</p> </li>
/// <li> <p>Message ID</p> </li>
/// <li> <p>Destination phone number</p> </li>
/// <li> <p>Message type</p> </li>
/// <li> <p>Delivery status</p> </li>
/// <li> <p>Message price (in USD)</p> </li>
/// <li> <p>Part number (a message is split into multiple parts if it is too long for a single message)</p> </li>
/// <li> <p>Total number of parts</p> </li>
/// </ul>
/// <p>To receive the report, the bucket must have a policy that allows the Amazon SNS service principal to perform the <code>s3:PutObject</code> and <code>s3:GetBucketLocation</code> actions.</p>
/// <p>For an example bucket policy and usage report, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sms_stats.html">Monitoring SMS Activity</a> in the <i>Amazon SNS Developer Guide</i>.</p>
pub fn attributes(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.attributes(k.into(), v.into());
self
}
/// <p>The default settings for sending SMS messages from your Amazon Web Services account. You can set values for the following attribute names:</p>
/// <p> <code>MonthlySpendLimit</code> – 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.</p> <important>
/// <p>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.</p>
/// </important>
/// <p>By default, the spend limit is set to the maximum allowed by Amazon SNS. If you want to raise the limit, submit an <a href="https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-sns">SNS Limit Increase case</a>. For <b>New limit value</b>, enter your desired monthly spend limit. In the <b>Use Case Description</b> field, explain that you are requesting an SMS monthly spend limit increase.</p>
/// <p> <code>DeliveryStatusIAMRole</code> – 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.</p>
/// <p> <code>DeliveryStatusSuccessSamplingRate</code> – 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 <code>0</code>. To write logs for 10% of your successful deliveries, set it to <code>10</code>.</p>
/// <p> <code>DefaultSenderID</code> – 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.</p>
/// <p> <code>DefaultSMSType</code> – The type of SMS message that you will send by default. You can assign the following values:</p>
/// <ul>
/// <li> <p> <code>Promotional</code> – (Default) Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.</p> </li>
/// <li> <p> <code>Transactional</code> – 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.</p> </li>
/// </ul>
/// <p> <code>UsageReportS3Bucket</code> – 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:</p>
/// <ul>
/// <li> <p>Time that the message was published (in UTC)</p> </li>
/// <li> <p>Message ID</p> </li>
/// <li> <p>Destination phone number</p> </li>
/// <li> <p>Message type</p> </li>
/// <li> <p>Delivery status</p> </li>
/// <li> <p>Message price (in USD)</p> </li>
/// <li> <p>Part number (a message is split into multiple parts if it is too long for a single message)</p> </li>
/// <li> <p>Total number of parts</p> </li>
/// </ul>
/// <p>To receive the report, the bucket must have a policy that allows the Amazon SNS service principal to perform the <code>s3:PutObject</code> and <code>s3:GetBucketLocation</code> actions.</p>
/// <p>For an example bucket policy and usage report, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sms_stats.html">Monitoring SMS Activity</a> in the <i>Amazon SNS Developer Guide</i>.</p>
pub fn set_attributes(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_attributes(input);
self
}
}
/// Fluent builder constructing a request to `SetSubscriptionAttributes`.
///
/// <p>Allows a subscription owner to set an attribute of the subscription to a new value.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct SetSubscriptionAttributes {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::set_subscription_attributes_input::Builder,
}
impl SetSubscriptionAttributes {
/// Creates a new `SetSubscriptionAttributes`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::SetSubscriptionAttributes,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::SetSubscriptionAttributesError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::SetSubscriptionAttributesOutput,
aws_smithy_http::result::SdkError<crate::error::SetSubscriptionAttributesError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The ARN of the subscription to modify.</p>
pub fn subscription_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.subscription_arn(input.into());
self
}
/// <p>The ARN of the subscription to modify.</p>
pub fn set_subscription_arn(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_subscription_arn(input);
self
}
/// <p>A map of attributes with their corresponding values.</p>
/// <p>The following lists the names, descriptions, and values of the special request parameters that this action uses:</p>
/// <ul>
/// <li> <p> <code>DeliveryPolicy</code> – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.</p> </li>
/// <li> <p> <code>FilterPolicy</code> – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.</p> </li>
/// <li> <p> <code>FilterPolicyScope</code> – This attribute lets you choose the filtering scope by using one of the following string value types:</p>
/// <ul>
/// <li> <p> <code>MessageAttributes</code> (default) – The filter is applied on the message attributes.</p> </li>
/// <li> <p> <code>MessageBody</code> – The filter is applied on the message body.</p> </li>
/// </ul> </li>
/// <li> <p> <code>RawMessageDelivery</code> – When set to <code>true</code>, 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.</p> </li>
/// <li> <p> <code>RedrivePolicy</code> – 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.</p> </li>
/// </ul>
/// <p>The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:</p>
/// <ul>
/// <li> <p> <code>SubscriptionRoleArn</code> – The ARN of the IAM role that has the following:</p>
/// <ul>
/// <li> <p>Permission to write to the Kinesis Data Firehose delivery stream</p> </li>
/// <li> <p>Amazon SNS listed as a trusted entity</p> </li>
/// </ul> <p>Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html">Fanout to Kinesis Data Firehose delivery streams</a> in the <i>Amazon SNS Developer Guide</i>.</p> </li>
/// </ul>
pub fn attribute_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.attribute_name(input.into());
self
}
/// <p>A map of attributes with their corresponding values.</p>
/// <p>The following lists the names, descriptions, and values of the special request parameters that this action uses:</p>
/// <ul>
/// <li> <p> <code>DeliveryPolicy</code> – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.</p> </li>
/// <li> <p> <code>FilterPolicy</code> – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.</p> </li>
/// <li> <p> <code>FilterPolicyScope</code> – This attribute lets you choose the filtering scope by using one of the following string value types:</p>
/// <ul>
/// <li> <p> <code>MessageAttributes</code> (default) – The filter is applied on the message attributes.</p> </li>
/// <li> <p> <code>MessageBody</code> – The filter is applied on the message body.</p> </li>
/// </ul> </li>
/// <li> <p> <code>RawMessageDelivery</code> – When set to <code>true</code>, 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.</p> </li>
/// <li> <p> <code>RedrivePolicy</code> – 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.</p> </li>
/// </ul>
/// <p>The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:</p>
/// <ul>
/// <li> <p> <code>SubscriptionRoleArn</code> – The ARN of the IAM role that has the following:</p>
/// <ul>
/// <li> <p>Permission to write to the Kinesis Data Firehose delivery stream</p> </li>
/// <li> <p>Amazon SNS listed as a trusted entity</p> </li>
/// </ul> <p>Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html">Fanout to Kinesis Data Firehose delivery streams</a> in the <i>Amazon SNS Developer Guide</i>.</p> </li>
/// </ul>
pub fn set_attribute_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_attribute_name(input);
self
}
/// <p>The new value for the attribute in JSON format.</p>
pub fn attribute_value(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.attribute_value(input.into());
self
}
/// <p>The new value for the attribute in JSON format.</p>
pub fn set_attribute_value(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_attribute_value(input);
self
}
}
/// Fluent builder constructing a request to `SetTopicAttributes`.
///
/// <p>Allows a topic owner to set an attribute of the topic to a new value.</p> <note>
/// <p>To remove the ability to change topic permissions, you must deny permissions to the <code>AddPermission</code>, <code>RemovePermission</code>, and <code>SetTopicAttributes</code> actions in your IAM policy.</p>
/// </note>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct SetTopicAttributes {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::set_topic_attributes_input::Builder,
}
impl SetTopicAttributes {
/// Creates a new `SetTopicAttributes`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::SetTopicAttributes,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::SetTopicAttributesError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::SetTopicAttributesOutput,
aws_smithy_http::result::SdkError<crate::error::SetTopicAttributesError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The ARN of the topic to modify.</p>
pub fn topic_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.topic_arn(input.into());
self
}
/// <p>The ARN of the topic to modify.</p>
pub fn set_topic_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_topic_arn(input);
self
}
/// <p>A map of attributes with their corresponding values.</p>
/// <p>The following lists the names, descriptions, and values of the special request parameters that the <code>SetTopicAttributes</code> action uses:</p>
/// <ul>
/// <li> <p> <code>DeliveryPolicy</code> – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.</p> </li>
/// <li> <p> <code>DisplayName</code> – The display name to use for a topic with SMS subscriptions.</p> </li>
/// <li> <p> <code>Policy</code> – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.</p> </li>
/// <li> <p> <code>TracingConfig</code> – Tracing mode of an Amazon SNS topic. By default <code>TracingConfig</code> is set to <code>PassThrough</code>, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.</p> </li>
/// </ul>
/// <p>The following attribute applies only to <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html">server-side-encryption</a>:</p>
/// <ul>
/// <li> <p> <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms">Key Terms</a>. For more examples, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">KeyId</a> in the <i>Key Management Service API Reference</i>. </p> </li>
/// <li> <p> <code>SignatureVersion</code> – The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS.</p> </li>
/// </ul>
/// <p>The following attribute applies only to <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html">FIFO topics</a>:</p>
/// <ul>
/// <li> <p> <code>ContentBasedDeduplication</code> – Enables content-based deduplication for FIFO topics.</p>
/// <ul>
/// <li> <p>By default, <code>ContentBasedDeduplication</code> is set to <code>false</code>. If you create a FIFO topic and this attribute is <code>false</code>, you must specify a value for the <code>MessageDeduplicationId</code> parameter for the <a href="https://docs.aws.amazon.com/sns/latest/api/API_Publish.html">Publish</a> action. </p> </li>
/// <li> <p>When you set <code>ContentBasedDeduplication</code> to <code>true</code>, Amazon SNS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using the body of the message (but not the attributes of the message).</p> <p>(Optional) To override the generated value, you can specify a value for the <code>MessageDeduplicationId</code> parameter for the <code>Publish</code> action.</p> </li>
/// </ul> </li>
/// </ul>
pub fn attribute_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.attribute_name(input.into());
self
}
/// <p>A map of attributes with their corresponding values.</p>
/// <p>The following lists the names, descriptions, and values of the special request parameters that the <code>SetTopicAttributes</code> action uses:</p>
/// <ul>
/// <li> <p> <code>DeliveryPolicy</code> – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.</p> </li>
/// <li> <p> <code>DisplayName</code> – The display name to use for a topic with SMS subscriptions.</p> </li>
/// <li> <p> <code>Policy</code> – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.</p> </li>
/// <li> <p> <code>TracingConfig</code> – Tracing mode of an Amazon SNS topic. By default <code>TracingConfig</code> is set to <code>PassThrough</code>, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.</p> </li>
/// </ul>
/// <p>The following attribute applies only to <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html">server-side-encryption</a>:</p>
/// <ul>
/// <li> <p> <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms">Key Terms</a>. For more examples, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">KeyId</a> in the <i>Key Management Service API Reference</i>. </p> </li>
/// <li> <p> <code>SignatureVersion</code> – The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS.</p> </li>
/// </ul>
/// <p>The following attribute applies only to <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html">FIFO topics</a>:</p>
/// <ul>
/// <li> <p> <code>ContentBasedDeduplication</code> – Enables content-based deduplication for FIFO topics.</p>
/// <ul>
/// <li> <p>By default, <code>ContentBasedDeduplication</code> is set to <code>false</code>. If you create a FIFO topic and this attribute is <code>false</code>, you must specify a value for the <code>MessageDeduplicationId</code> parameter for the <a href="https://docs.aws.amazon.com/sns/latest/api/API_Publish.html">Publish</a> action. </p> </li>
/// <li> <p>When you set <code>ContentBasedDeduplication</code> to <code>true</code>, Amazon SNS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using the body of the message (but not the attributes of the message).</p> <p>(Optional) To override the generated value, you can specify a value for the <code>MessageDeduplicationId</code> parameter for the <code>Publish</code> action.</p> </li>
/// </ul> </li>
/// </ul>
pub fn set_attribute_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_attribute_name(input);
self
}
/// <p>The new value for the attribute.</p>
pub fn attribute_value(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.attribute_value(input.into());
self
}
/// <p>The new value for the attribute.</p>
pub fn set_attribute_value(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_attribute_value(input);
self
}
}
/// Fluent builder constructing a request to `Subscribe`.
///
/// <p>Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or email, or if the endpoint and the topic are not in the same Amazon Web Services account, the endpoint owner must run the <code>ConfirmSubscription</code> action to confirm the subscription.</p>
/// <p>You call the <code>ConfirmSubscription</code> action with the token from the subscription response. Confirmation tokens are valid for three days.</p>
/// <p>This action is throttled at 100 transactions per second (TPS).</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct Subscribe {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::subscribe_input::Builder,
}
impl Subscribe {
/// Creates a new `Subscribe`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::Subscribe,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::SubscribeError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::SubscribeOutput,
aws_smithy_http::result::SdkError<crate::error::SubscribeError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The ARN of the topic you want to subscribe to.</p>
pub fn topic_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.topic_arn(input.into());
self
}
/// <p>The ARN of the topic you want to subscribe to.</p>
pub fn set_topic_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_topic_arn(input);
self
}
/// <p>The protocol that you want to use. Supported protocols include:</p>
/// <ul>
/// <li> <p> <code>http</code> – delivery of JSON-encoded message via HTTP POST</p> </li>
/// <li> <p> <code>https</code> – delivery of JSON-encoded message via HTTPS POST</p> </li>
/// <li> <p> <code>email</code> – delivery of message via SMTP</p> </li>
/// <li> <p> <code>email-json</code> – delivery of JSON-encoded message via SMTP</p> </li>
/// <li> <p> <code>sms</code> – delivery of message via SMS</p> </li>
/// <li> <p> <code>sqs</code> – delivery of JSON-encoded message to an Amazon SQS queue</p> </li>
/// <li> <p> <code>application</code> – delivery of JSON-encoded message to an EndpointArn for a mobile app and device</p> </li>
/// <li> <p> <code>lambda</code> – delivery of JSON-encoded message to an Lambda function</p> </li>
/// <li> <p> <code>firehose</code> – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.</p> </li>
/// </ul>
pub fn protocol(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.protocol(input.into());
self
}
/// <p>The protocol that you want to use. Supported protocols include:</p>
/// <ul>
/// <li> <p> <code>http</code> – delivery of JSON-encoded message via HTTP POST</p> </li>
/// <li> <p> <code>https</code> – delivery of JSON-encoded message via HTTPS POST</p> </li>
/// <li> <p> <code>email</code> – delivery of message via SMTP</p> </li>
/// <li> <p> <code>email-json</code> – delivery of JSON-encoded message via SMTP</p> </li>
/// <li> <p> <code>sms</code> – delivery of message via SMS</p> </li>
/// <li> <p> <code>sqs</code> – delivery of JSON-encoded message to an Amazon SQS queue</p> </li>
/// <li> <p> <code>application</code> – delivery of JSON-encoded message to an EndpointArn for a mobile app and device</p> </li>
/// <li> <p> <code>lambda</code> – delivery of JSON-encoded message to an Lambda function</p> </li>
/// <li> <p> <code>firehose</code> – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.</p> </li>
/// </ul>
pub fn set_protocol(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_protocol(input);
self
}
/// <p>The endpoint that you want to receive notifications. Endpoints vary by protocol:</p>
/// <ul>
/// <li> <p>For the <code>http</code> protocol, the (public) endpoint is a URL beginning with <code>http://</code>.</p> </li>
/// <li> <p>For the <code>https</code> protocol, the (public) endpoint is a URL beginning with <code>https://</code>.</p> </li>
/// <li> <p>For the <code>email</code> protocol, the endpoint is an email address.</p> </li>
/// <li> <p>For the <code>email-json</code> protocol, the endpoint is an email address.</p> </li>
/// <li> <p>For the <code>sms</code> protocol, the endpoint is a phone number of an SMS-enabled device.</p> </li>
/// <li> <p>For the <code>sqs</code> protocol, the endpoint is the ARN of an Amazon SQS queue.</p> </li>
/// <li> <p>For the <code>application</code> protocol, the endpoint is the EndpointArn of a mobile app and device.</p> </li>
/// <li> <p>For the <code>lambda</code> protocol, the endpoint is the ARN of an Lambda function.</p> </li>
/// <li> <p>For the <code>firehose</code> protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.</p> </li>
/// </ul>
pub fn endpoint(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.endpoint(input.into());
self
}
/// <p>The endpoint that you want to receive notifications. Endpoints vary by protocol:</p>
/// <ul>
/// <li> <p>For the <code>http</code> protocol, the (public) endpoint is a URL beginning with <code>http://</code>.</p> </li>
/// <li> <p>For the <code>https</code> protocol, the (public) endpoint is a URL beginning with <code>https://</code>.</p> </li>
/// <li> <p>For the <code>email</code> protocol, the endpoint is an email address.</p> </li>
/// <li> <p>For the <code>email-json</code> protocol, the endpoint is an email address.</p> </li>
/// <li> <p>For the <code>sms</code> protocol, the endpoint is a phone number of an SMS-enabled device.</p> </li>
/// <li> <p>For the <code>sqs</code> protocol, the endpoint is the ARN of an Amazon SQS queue.</p> </li>
/// <li> <p>For the <code>application</code> protocol, the endpoint is the EndpointArn of a mobile app and device.</p> </li>
/// <li> <p>For the <code>lambda</code> protocol, the endpoint is the ARN of an Lambda function.</p> </li>
/// <li> <p>For the <code>firehose</code> protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.</p> </li>
/// </ul>
pub fn set_endpoint(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_endpoint(input);
self
}
/// Adds a key-value pair to `Attributes`.
///
/// To override the contents of this collection use [`set_attributes`](Self::set_attributes).
///
/// <p>A map of attributes with their corresponding values.</p>
/// <p>The following lists the names, descriptions, and values of the special request parameters that the <code>Subscribe</code> action uses:</p>
/// <ul>
/// <li> <p> <code>DeliveryPolicy</code> – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.</p> </li>
/// <li> <p> <code>FilterPolicy</code> – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.</p> </li>
/// <li> <p> <code>FilterPolicyScope</code> – This attribute lets you choose the filtering scope by using one of the following string value types:</p>
/// <ul>
/// <li> <p> <code>MessageAttributes</code> (default) – The filter is applied on the message attributes.</p> </li>
/// <li> <p> <code>MessageBody</code> – The filter is applied on the message body.</p> </li>
/// </ul> </li>
/// <li> <p> <code>RawMessageDelivery</code> – When set to <code>true</code>, 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.</p> </li>
/// <li> <p> <code>RedrivePolicy</code> – 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.</p> </li>
/// </ul>
/// <p>The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:</p>
/// <ul>
/// <li> <p> <code>SubscriptionRoleArn</code> – The ARN of the IAM role that has the following:</p>
/// <ul>
/// <li> <p>Permission to write to the Kinesis Data Firehose delivery stream</p> </li>
/// <li> <p>Amazon SNS listed as a trusted entity</p> </li>
/// </ul> <p>Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html">Fanout to Kinesis Data Firehose delivery streams</a> in the <i>Amazon SNS Developer Guide</i>.</p> </li>
/// </ul>
pub fn attributes(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.attributes(k.into(), v.into());
self
}
/// <p>A map of attributes with their corresponding values.</p>
/// <p>The following lists the names, descriptions, and values of the special request parameters that the <code>Subscribe</code> action uses:</p>
/// <ul>
/// <li> <p> <code>DeliveryPolicy</code> – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.</p> </li>
/// <li> <p> <code>FilterPolicy</code> – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.</p> </li>
/// <li> <p> <code>FilterPolicyScope</code> – This attribute lets you choose the filtering scope by using one of the following string value types:</p>
/// <ul>
/// <li> <p> <code>MessageAttributes</code> (default) – The filter is applied on the message attributes.</p> </li>
/// <li> <p> <code>MessageBody</code> – The filter is applied on the message body.</p> </li>
/// </ul> </li>
/// <li> <p> <code>RawMessageDelivery</code> – When set to <code>true</code>, 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.</p> </li>
/// <li> <p> <code>RedrivePolicy</code> – 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.</p> </li>
/// </ul>
/// <p>The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:</p>
/// <ul>
/// <li> <p> <code>SubscriptionRoleArn</code> – The ARN of the IAM role that has the following:</p>
/// <ul>
/// <li> <p>Permission to write to the Kinesis Data Firehose delivery stream</p> </li>
/// <li> <p>Amazon SNS listed as a trusted entity</p> </li>
/// </ul> <p>Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html">Fanout to Kinesis Data Firehose delivery streams</a> in the <i>Amazon SNS Developer Guide</i>.</p> </li>
/// </ul>
pub fn set_attributes(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_attributes(input);
self
}
/// <p>Sets whether the response from the <code>Subscribe</code> request includes the subscription ARN, even if the subscription is not yet confirmed.</p>
/// <p>If you set this parameter to <code>true</code>, 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 <code>pending subscription</code> ARN value for subscriptions that aren't yet confirmed. A subscription becomes confirmed when the subscriber calls the <code>ConfirmSubscription</code> action with a confirmation token.</p>
/// <p></p>
/// <p>The default value is <code>false</code>.</p>
pub fn return_subscription_arn(mut self, input: bool) -> Self {
self.inner = self.inner.return_subscription_arn(input);
self
}
/// <p>Sets whether the response from the <code>Subscribe</code> request includes the subscription ARN, even if the subscription is not yet confirmed.</p>
/// <p>If you set this parameter to <code>true</code>, 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 <code>pending subscription</code> ARN value for subscriptions that aren't yet confirmed. A subscription becomes confirmed when the subscriber calls the <code>ConfirmSubscription</code> action with a confirmation token.</p>
/// <p></p>
/// <p>The default value is <code>false</code>.</p>
pub fn set_return_subscription_arn(mut self, input: std::option::Option<bool>) -> Self {
self.inner = self.inner.set_return_subscription_arn(input);
self
}
}
/// Fluent builder constructing a request to `TagResource`.
///
/// <p>Add tags to the specified Amazon SNS topic. For an overview, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-tags.html">Amazon SNS Tags</a> in the <i>Amazon SNS Developer Guide</i>.</p>
/// <p>When you use topic tags, keep the following guidelines in mind:</p>
/// <ul>
/// <li> <p>Adding more than 50 tags to a topic isn't recommended.</p> </li>
/// <li> <p>Tags don't have any semantic meaning. Amazon SNS interprets tags as character strings.</p> </li>
/// <li> <p>Tags are case-sensitive.</p> </li>
/// <li> <p>A new tag with a key identical to that of an existing tag overwrites the existing tag.</p> </li>
/// <li> <p>Tagging actions are limited to 10 TPS per Amazon Web Services account, per Amazon Web Services Region. If your application requires a higher throughput, file a <a href="https://console.aws.amazon.com/support/home#/case/create?issueType=technical">technical support request</a>.</p> </li>
/// </ul>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct TagResource {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::tag_resource_input::Builder,
}
impl TagResource {
/// Creates a new `TagResource`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::TagResource,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::TagResourceError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::TagResourceOutput,
aws_smithy_http::result::SdkError<crate::error::TagResourceError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The ARN of the topic to which to add tags.</p>
pub fn resource_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.resource_arn(input.into());
self
}
/// <p>The ARN of the topic to which to add tags.</p>
pub fn set_resource_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_resource_arn(input);
self
}
/// Appends an item to `Tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>The tags to be added to the specified topic. A tag consists of a required key and an optional value.</p>
pub fn tags(mut self, input: crate::model::Tag) -> Self {
self.inner = self.inner.tags(input);
self
}
/// <p>The tags to be added to the specified topic. A tag consists of a required key and an optional value.</p>
pub fn set_tags(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::Tag>>,
) -> Self {
self.inner = self.inner.set_tags(input);
self
}
}
/// Fluent builder constructing a request to `Unsubscribe`.
///
/// <p>Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an Amazon Web Services signature is required. If the <code>Unsubscribe</code> call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the <code>Unsubscribe</code> request was unintended.</p> <note>
/// <p>Amazon SQS queue subscriptions require authentication for deletion. Only the owner of the subscription, or the owner of the topic can unsubscribe using the required Amazon Web Services signature.</p>
/// </note>
/// <p>This action is throttled at 100 transactions per second (TPS).</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct Unsubscribe {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::unsubscribe_input::Builder,
}
impl Unsubscribe {
/// Creates a new `Unsubscribe`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::Unsubscribe,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::UnsubscribeError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::UnsubscribeOutput,
aws_smithy_http::result::SdkError<crate::error::UnsubscribeError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The ARN of the subscription to be deleted.</p>
pub fn subscription_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.subscription_arn(input.into());
self
}
/// <p>The ARN of the subscription to be deleted.</p>
pub fn set_subscription_arn(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_subscription_arn(input);
self
}
}
/// Fluent builder constructing a request to `UntagResource`.
///
/// <p>Remove tags from the specified Amazon SNS topic. For an overview, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-tags.html">Amazon SNS Tags</a> in the <i>Amazon SNS Developer Guide</i>.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct UntagResource {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::untag_resource_input::Builder,
}
impl UntagResource {
/// Creates a new `UntagResource`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::UntagResource,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::UntagResourceError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::UntagResourceOutput,
aws_smithy_http::result::SdkError<crate::error::UntagResourceError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The ARN of the topic from which to remove tags.</p>
pub fn resource_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.resource_arn(input.into());
self
}
/// <p>The ARN of the topic from which to remove tags.</p>
pub fn set_resource_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_resource_arn(input);
self
}
/// Appends an item to `TagKeys`.
///
/// To override the contents of this collection use [`set_tag_keys`](Self::set_tag_keys).
///
/// <p>The list of tag keys to remove from the specified topic.</p>
pub fn tag_keys(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.tag_keys(input.into());
self
}
/// <p>The list of tag keys to remove from the specified topic.</p>
pub fn set_tag_keys(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_tag_keys(input);
self
}
}
/// Fluent builder constructing a request to `VerifySMSSandboxPhoneNumber`.
///
/// <p>Verifies a destination phone number with a one-time password (OTP) for the calling Amazon Web Services account.</p>
/// <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the <i>SMS sandbox</i>. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">SMS sandbox</a> in the <i>Amazon SNS Developer Guide</i>.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct VerifySMSSandboxPhoneNumber {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::verify_sms_sandbox_phone_number_input::Builder,
}
impl VerifySMSSandboxPhoneNumber {
/// Creates a new `VerifySMSSandboxPhoneNumber`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::VerifySMSSandboxPhoneNumber,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::VerifySMSSandboxPhoneNumberError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::VerifySmsSandboxPhoneNumberOutput,
aws_smithy_http::result::SdkError<crate::error::VerifySMSSandboxPhoneNumberError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The destination phone number to verify.</p>
pub fn phone_number(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.phone_number(input.into());
self
}
/// <p>The destination phone number to verify.</p>
pub fn set_phone_number(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_phone_number(input);
self
}
/// <p>The OTP sent to the destination number from the <code>CreateSMSSandBoxPhoneNumber</code> call.</p>
pub fn one_time_password(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.one_time_password(input.into());
self
}
/// <p>The OTP sent to the destination number from the <code>CreateSMSSandBoxPhoneNumber</code> call.</p>
pub fn set_one_time_password(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_one_time_password(input);
self
}
}
}
impl Client {
/// Creates a new client from an [SDK Config](aws_types::sdk_config::SdkConfig).
///
/// # Panics
///
/// - This method will panic if the `sdk_config` is missing an async sleep implementation. If you experience this panic, set
/// the `sleep_impl` on the Config passed into this function to fix it.
/// - This method will panic if the `sdk_config` is missing an HTTP connector. If you experience this panic, set the
/// `http_connector` on the Config passed into this function to fix it.
pub fn new(sdk_config: &aws_types::sdk_config::SdkConfig) -> Self {
Self::from_conf(sdk_config.into())
}
/// Creates a new client from the service [`Config`](crate::Config).
///
/// # Panics
///
/// - This method will panic if the `conf` is missing an async sleep implementation. If you experience this panic, set
/// the `sleep_impl` on the Config passed into this function to fix it.
/// - This method will panic if the `conf` is missing an HTTP connector. If you experience this panic, set the
/// `http_connector` on the Config passed into this function to fix it.
pub fn from_conf(conf: crate::Config) -> Self {
let retry_config = conf
.retry_config()
.cloned()
.unwrap_or_else(aws_smithy_types::retry::RetryConfig::disabled);
let timeout_config = conf
.timeout_config()
.cloned()
.unwrap_or_else(aws_smithy_types::timeout::TimeoutConfig::disabled);
let sleep_impl = conf.sleep_impl();
if (retry_config.has_retry() || timeout_config.has_timeouts()) && sleep_impl.is_none() {
panic!("An async sleep implementation is required for retries or timeouts to work. \
Set the `sleep_impl` on the Config passed into this function to fix this panic.");
}
let connector = conf.http_connector().and_then(|c| {
let timeout_config = conf
.timeout_config()
.cloned()
.unwrap_or_else(aws_smithy_types::timeout::TimeoutConfig::disabled);
let connector_settings =
aws_smithy_client::http_connector::ConnectorSettings::from_timeout_config(
&timeout_config,
);
c.connector(&connector_settings, conf.sleep_impl())
});
let builder = aws_smithy_client::Builder::new();
let builder = match connector {
// Use provided connector
Some(c) => builder.connector(c),
None => {
#[cfg(any(feature = "rustls", feature = "native-tls"))]
{
// Use default connector based on enabled features
builder.dyn_https_connector(
aws_smithy_client::http_connector::ConnectorSettings::from_timeout_config(
&timeout_config,
),
)
}
#[cfg(not(any(feature = "rustls", feature = "native-tls")))]
{
panic!("No HTTP connector was available. Enable the `rustls` or `native-tls` crate feature or set a connector to fix this.");
}
}
};
let mut builder = builder
.middleware(aws_smithy_client::erase::DynMiddleware::new(
crate::middleware::DefaultMiddleware::new(),
))
.retry_config(retry_config.into())
.operation_timeout_config(timeout_config.into());
builder.set_sleep_impl(sleep_impl);
let client = builder.build();
Self {
handle: std::sync::Arc::new(Handle { client, conf }),
}
}
}