aws_sdk_sns/client/
get_endpoint_attributes.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`GetEndpointAttributes`](crate::operation::get_endpoint_attributes::builders::GetEndpointAttributesFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`endpoint_arn(impl Into<String>)`](crate::operation::get_endpoint_attributes::builders::GetEndpointAttributesFluentBuilder::endpoint_arn) / [`set_endpoint_arn(Option<String>)`](crate::operation::get_endpoint_attributes::builders::GetEndpointAttributesFluentBuilder::set_endpoint_arn):<br>required: **true**<br><p><code>EndpointArn</code> for <code>GetEndpointAttributes</code> input.</p><br>
7    /// - On success, responds with [`GetEndpointAttributesOutput`](crate::operation::get_endpoint_attributes::GetEndpointAttributesOutput) with field(s):
8    ///   - [`attributes(Option<HashMap::<String, String>>)`](crate::operation::get_endpoint_attributes::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>
9    /// - On failure, responds with [`SdkError<GetEndpointAttributesError>`](crate::operation::get_endpoint_attributes::GetEndpointAttributesError)
10    pub fn get_endpoint_attributes(&self) -> crate::operation::get_endpoint_attributes::builders::GetEndpointAttributesFluentBuilder {
11        crate::operation::get_endpoint_attributes::builders::GetEndpointAttributesFluentBuilder::new(self.handle.clone())
12    }
13}