aws_sdk_iot/client/
describe_endpoint.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 [`DescribeEndpoint`](crate::operation::describe_endpoint::builders::DescribeEndpointFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`endpoint_type(impl Into<String>)`](crate::operation::describe_endpoint::builders::DescribeEndpointFluentBuilder::endpoint_type) / [`set_endpoint_type(Option<String>)`](crate::operation::describe_endpoint::builders::DescribeEndpointFluentBuilder::set_endpoint_type):<br>required: **false**<br><p>The endpoint type. Valid endpoint types include:</p> <ul>  <li>   <p><code>iot:Data</code> - Returns a VeriSign signed data endpoint.</p></li> </ul> <ul>  <li>   <p><code>iot:Data-ATS</code> - Returns an ATS signed data endpoint.</p></li> </ul> <ul>  <li>   <p><code>iot:CredentialProvider</code> - Returns an IoT credentials provider API endpoint.</p></li> </ul> <ul>  <li>   <p><code>iot:Jobs</code> - Returns an IoT device management Jobs API endpoint.</p></li> </ul> <p>We strongly recommend that customers use the newer <code>iot:Data-ATS</code> endpoint type to avoid issues related to the widespread distrust of Symantec certificate authorities. ATS Signed Certificates are more secure and are trusted by most popular browsers.</p><br>
7    /// - On success, responds with [`DescribeEndpointOutput`](crate::operation::describe_endpoint::DescribeEndpointOutput) with field(s):
8    ///   - [`endpoint_address(Option<String>)`](crate::operation::describe_endpoint::DescribeEndpointOutput::endpoint_address): <p>The endpoint. The format of the endpoint is as follows: <i>identifier</i>.iot.<i>region</i>.amazonaws.com.</p>
9    /// - On failure, responds with [`SdkError<DescribeEndpointError>`](crate::operation::describe_endpoint::DescribeEndpointError)
10    pub fn describe_endpoint(&self) -> crate::operation::describe_endpoint::builders::DescribeEndpointFluentBuilder {
11        crate::operation::describe_endpoint::builders::DescribeEndpointFluentBuilder::new(self.handle.clone())
12    }
13}