aws_sdk_connect/client/
describe_email_address.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 [`DescribeEmailAddress`](crate::operation::describe_email_address::builders::DescribeEmailAddressFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`instance_id(impl Into<String>)`](crate::operation::describe_email_address::builders::DescribeEmailAddressFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::describe_email_address::builders::DescribeEmailAddressFluentBuilder::set_instance_id):<br>required: **true**<br><p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p><br>
7    ///   - [`email_address_id(impl Into<String>)`](crate::operation::describe_email_address::builders::DescribeEmailAddressFluentBuilder::email_address_id) / [`set_email_address_id(Option<String>)`](crate::operation::describe_email_address::builders::DescribeEmailAddressFluentBuilder::set_email_address_id):<br>required: **true**<br><p>The identifier of the email address.</p><br>
8    /// - On success, responds with [`DescribeEmailAddressOutput`](crate::operation::describe_email_address::DescribeEmailAddressOutput) with field(s):
9    ///   - [`email_address_id(Option<String>)`](crate::operation::describe_email_address::DescribeEmailAddressOutput::email_address_id): <p>The identifier of the email address.</p>
10    ///   - [`email_address_arn(Option<String>)`](crate::operation::describe_email_address::DescribeEmailAddressOutput::email_address_arn): <p>The Amazon Resource Name (ARN) of the email address.</p>
11    ///   - [`email_address(Option<String>)`](crate::operation::describe_email_address::DescribeEmailAddressOutput::email_address): <p>The email address, including the domain.</p>
12    ///   - [`display_name(Option<String>)`](crate::operation::describe_email_address::DescribeEmailAddressOutput::display_name): <p>The display name of email address</p>
13    ///   - [`description(Option<String>)`](crate::operation::describe_email_address::DescribeEmailAddressOutput::description): <p>The description of the email address.</p>
14    ///   - [`create_timestamp(Option<String>)`](crate::operation::describe_email_address::DescribeEmailAddressOutput::create_timestamp): <p>The email address creation timestamp in ISO 8601 Datetime.</p>
15    ///   - [`modified_timestamp(Option<String>)`](crate::operation::describe_email_address::DescribeEmailAddressOutput::modified_timestamp): <p>The email address last modification timestamp in ISO 8601 Datetime.</p>
16    ///   - [`alias_configurations(Option<Vec::<AliasConfiguration>>)`](crate::operation::describe_email_address::DescribeEmailAddressOutput::alias_configurations): <p>A list of alias configurations associated with this email address. Contains details about email addresses that forward to this primary email address. The list can contain at most one alias configuration per email address.</p>
17    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::describe_email_address::DescribeEmailAddressOutput::tags): <p>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</p>
18    /// - On failure, responds with [`SdkError<DescribeEmailAddressError>`](crate::operation::describe_email_address::DescribeEmailAddressError)
19    pub fn describe_email_address(&self) -> crate::operation::describe_email_address::builders::DescribeEmailAddressFluentBuilder {
20        crate::operation::describe_email_address::builders::DescribeEmailAddressFluentBuilder::new(self.handle.clone())
21    }
22}