aws_sdk_mailmanager/client/
get_relay.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 [`GetRelay`](crate::operation::get_relay::builders::GetRelayFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`relay_id(impl Into<String>)`](crate::operation::get_relay::builders::GetRelayFluentBuilder::relay_id) / [`set_relay_id(Option<String>)`](crate::operation::get_relay::builders::GetRelayFluentBuilder::set_relay_id):<br>required: **true**<br><p>A unique relay identifier.</p><br>
7    /// - On success, responds with [`GetRelayOutput`](crate::operation::get_relay::GetRelayOutput) with field(s):
8    ///   - [`relay_id(String)`](crate::operation::get_relay::GetRelayOutput::relay_id): <p>The unique relay identifier.</p>
9    ///   - [`relay_arn(Option<String>)`](crate::operation::get_relay::GetRelayOutput::relay_arn): <p>The Amazon Resource Name (ARN) of the relay.</p>
10    ///   - [`relay_name(Option<String>)`](crate::operation::get_relay::GetRelayOutput::relay_name): <p>The unique name of the relay.</p>
11    ///   - [`server_name(Option<String>)`](crate::operation::get_relay::GetRelayOutput::server_name): <p>The destination relay server address.</p>
12    ///   - [`server_port(Option<i32>)`](crate::operation::get_relay::GetRelayOutput::server_port): <p>The destination relay server port.</p>
13    ///   - [`authentication(Option<RelayAuthentication>)`](crate::operation::get_relay::GetRelayOutput::authentication): <p>The authentication attribute—contains the secret ARN where the customer relay server credentials are stored.</p>
14    ///   - [`created_timestamp(Option<DateTime>)`](crate::operation::get_relay::GetRelayOutput::created_timestamp): <p>The timestamp of when the relay was created.</p>
15    ///   - [`last_modified_timestamp(Option<DateTime>)`](crate::operation::get_relay::GetRelayOutput::last_modified_timestamp): <p>The timestamp of when relay was last updated.</p>
16    /// - On failure, responds with [`SdkError<GetRelayError>`](crate::operation::get_relay::GetRelayError)
17    pub fn get_relay(&self) -> crate::operation::get_relay::builders::GetRelayFluentBuilder {
18        crate::operation::get_relay::builders::GetRelayFluentBuilder::new(self.handle.clone())
19    }
20}