1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::create_platform_endpoint::_create_platform_endpoint_output::CreatePlatformEndpointOutputBuilder;
pub use crate::operation::create_platform_endpoint::_create_platform_endpoint_input::CreatePlatformEndpointInputBuilder;
/// 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 CreatePlatformEndpointFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::create_platform_endpoint::builders::CreatePlatformEndpointInputBuilder,
}
impl CreatePlatformEndpointFluentBuilder {
/// Creates a new `CreatePlatformEndpoint`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
}
}
// This function will go away in the near future. Do not rely on it.
#[doc(hidden)]
pub async fn customize_middleware(
self,
) -> ::std::result::Result<
crate::client::customize::CustomizableOperation<
crate::operation::create_platform_endpoint::CreatePlatformEndpoint,
::aws_http::retry::AwsResponseRetryClassifier,
>,
::aws_smithy_http::result::SdkError<
crate::operation::create_platform_endpoint::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)?;
::std::result::Result::Ok(crate::client::customize::CustomizableOperation {
handle,
operation,
})
}
// This function will go away in the near future. Do not rely on it.
#[doc(hidden)]
pub async fn send_middleware(
self,
) -> ::std::result::Result<
crate::operation::create_platform_endpoint::CreatePlatformEndpointOutput,
::aws_smithy_http::result::SdkError<
crate::operation::create_platform_endpoint::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
}
/// 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::operation::create_platform_endpoint::CreatePlatformEndpointOutput,
::aws_smithy_http::result::SdkError<
crate::operation::create_platform_endpoint::CreatePlatformEndpointError,
>,
> {
self.send_middleware().await
}
/// Consumes 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::client::customize::CustomizableOperation<
crate::operation::create_platform_endpoint::CreatePlatformEndpoint,
::aws_http::retry::AwsResponseRetryClassifier,
>,
::aws_smithy_http::result::SdkError<
crate::operation::create_platform_endpoint::CreatePlatformEndpointError,
>,
> {
self.customize_middleware().await
}
/// <p>PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.</p>
pub fn platform_application_arn(
mut self,
input: impl ::std::convert::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 ::std::convert::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 ::std::convert::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 ::std::convert::Into<::std::string::String>,
v: impl ::std::convert::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
}
}