aws_sdk_workmail/client/
get_mail_domain.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetMailDomain`](crate::operation::get_mail_domain::builders::GetMailDomainFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`organization_id(impl Into<String>)`](crate::operation::get_mail_domain::builders::GetMailDomainFluentBuilder::organization_id) / [`set_organization_id(Option<String>)`](crate::operation::get_mail_domain::builders::GetMailDomainFluentBuilder::set_organization_id):<br>required: **true**<br><p>The WorkMail organization for which the domain is retrieved.</p><br>
    ///   - [`domain_name(impl Into<String>)`](crate::operation::get_mail_domain::builders::GetMailDomainFluentBuilder::domain_name) / [`set_domain_name(Option<String>)`](crate::operation::get_mail_domain::builders::GetMailDomainFluentBuilder::set_domain_name):<br>required: **true**<br><p>The domain from which you want to retrieve details.</p><br>
    /// - On success, responds with [`GetMailDomainOutput`](crate::operation::get_mail_domain::GetMailDomainOutput) with field(s):
    ///   - [`records(Option<Vec::<DnsRecord>>)`](crate::operation::get_mail_domain::GetMailDomainOutput::records): <p>A list of the DNS records that WorkMail recommends adding in your DNS provider for the best user experience. The records configure your domain with DMARC, SPF, DKIM, and direct incoming email traffic to SES. See admin guide for more details.</p>
    ///   - [`is_test_domain(bool)`](crate::operation::get_mail_domain::GetMailDomainOutput::is_test_domain): <p>Specifies whether the domain is a test domain provided by WorkMail, or a custom domain.</p>
    ///   - [`is_default(bool)`](crate::operation::get_mail_domain::GetMailDomainOutput::is_default): <p>Specifies whether the domain is the default domain for your organization.</p>
    ///   - [`ownership_verification_status(Option<DnsRecordVerificationStatus>)`](crate::operation::get_mail_domain::GetMailDomainOutput::ownership_verification_status): <p>Indicates the status of the domain ownership verification.</p>
    ///   - [`dkim_verification_status(Option<DnsRecordVerificationStatus>)`](crate::operation::get_mail_domain::GetMailDomainOutput::dkim_verification_status): <p>Indicates the status of a DKIM verification.</p>
    /// - On failure, responds with [`SdkError<GetMailDomainError>`](crate::operation::get_mail_domain::GetMailDomainError)
    pub fn get_mail_domain(&self) -> crate::operation::get_mail_domain::builders::GetMailDomainFluentBuilder {
        crate::operation::get_mail_domain::builders::GetMailDomainFluentBuilder::new(self.handle.clone())
    }
}