libZSservicesZSamazonka-workmailZSamazonka-workmail
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.WorkMail.GetMailDomain

Description

Gets details for a mail domain, including domain records required to configure your domain with recommended security.

Synopsis

Creating a Request

data GetMailDomain Source #

See: newGetMailDomain smart constructor.

Constructors

GetMailDomain' 

Fields

Instances

Instances details
Eq GetMailDomain Source # 
Instance details

Defined in Amazonka.WorkMail.GetMailDomain

Read GetMailDomain Source # 
Instance details

Defined in Amazonka.WorkMail.GetMailDomain

Show GetMailDomain Source # 
Instance details

Defined in Amazonka.WorkMail.GetMailDomain

Generic GetMailDomain Source # 
Instance details

Defined in Amazonka.WorkMail.GetMailDomain

Associated Types

type Rep GetMailDomain :: Type -> Type #

NFData GetMailDomain Source # 
Instance details

Defined in Amazonka.WorkMail.GetMailDomain

Methods

rnf :: GetMailDomain -> () #

Hashable GetMailDomain Source # 
Instance details

Defined in Amazonka.WorkMail.GetMailDomain

ToJSON GetMailDomain Source # 
Instance details

Defined in Amazonka.WorkMail.GetMailDomain

AWSRequest GetMailDomain Source # 
Instance details

Defined in Amazonka.WorkMail.GetMailDomain

Associated Types

type AWSResponse GetMailDomain #

ToHeaders GetMailDomain Source # 
Instance details

Defined in Amazonka.WorkMail.GetMailDomain

ToPath GetMailDomain Source # 
Instance details

Defined in Amazonka.WorkMail.GetMailDomain

ToQuery GetMailDomain Source # 
Instance details

Defined in Amazonka.WorkMail.GetMailDomain

type Rep GetMailDomain Source # 
Instance details

Defined in Amazonka.WorkMail.GetMailDomain

type Rep GetMailDomain = D1 ('MetaData "GetMailDomain" "Amazonka.WorkMail.GetMailDomain" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "GetMailDomain'" 'PrefixI 'True) (S1 ('MetaSel ('Just "organizationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetMailDomain Source # 
Instance details

Defined in Amazonka.WorkMail.GetMailDomain

newGetMailDomain Source #

Create a value of GetMailDomain with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:organizationId:GetMailDomain', getMailDomain_organizationId - The Amazon WorkMail organization for which the domain is retrieved.

$sel:domainName:GetMailDomain', getMailDomain_domainName - The domain from which you want to retrieve details.

Request Lenses

getMailDomain_organizationId :: Lens' GetMailDomain Text Source #

The Amazon WorkMail organization for which the domain is retrieved.

getMailDomain_domainName :: Lens' GetMailDomain Text Source #

The domain from which you want to retrieve details.

Destructuring the Response

data GetMailDomainResponse Source #

See: newGetMailDomainResponse smart constructor.

Constructors

GetMailDomainResponse' 

Fields

Instances

Instances details
Eq GetMailDomainResponse Source # 
Instance details

Defined in Amazonka.WorkMail.GetMailDomain

Read GetMailDomainResponse Source # 
Instance details

Defined in Amazonka.WorkMail.GetMailDomain

Show GetMailDomainResponse Source # 
Instance details

Defined in Amazonka.WorkMail.GetMailDomain

Generic GetMailDomainResponse Source # 
Instance details

Defined in Amazonka.WorkMail.GetMailDomain

Associated Types

type Rep GetMailDomainResponse :: Type -> Type #

NFData GetMailDomainResponse Source # 
Instance details

Defined in Amazonka.WorkMail.GetMailDomain

Methods

rnf :: GetMailDomainResponse -> () #

type Rep GetMailDomainResponse Source # 
Instance details

Defined in Amazonka.WorkMail.GetMailDomain

type Rep GetMailDomainResponse = D1 ('MetaData "GetMailDomainResponse" "Amazonka.WorkMail.GetMailDomain" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "GetMailDomainResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "isTestDomain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "records") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DnsRecord])) :*: S1 ('MetaSel ('Just "ownershipVerificationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DnsRecordVerificationStatus)))) :*: (S1 ('MetaSel ('Just "dkimVerificationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DnsRecordVerificationStatus)) :*: (S1 ('MetaSel ('Just "isDefault") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetMailDomainResponse Source #

Create a value of GetMailDomainResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:isTestDomain:GetMailDomainResponse', getMailDomainResponse_isTestDomain - Specifies whether the domain is a test domain provided by WorkMail, or a custom domain.

$sel:records:GetMailDomainResponse', getMailDomainResponse_records - A list of the DNS records that Amazon 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.

$sel:ownershipVerificationStatus:GetMailDomainResponse', getMailDomainResponse_ownershipVerificationStatus - Indicates the status of the domain ownership verification.

$sel:dkimVerificationStatus:GetMailDomainResponse', getMailDomainResponse_dkimVerificationStatus - Indicates the status of a DKIM verification.

$sel:isDefault:GetMailDomainResponse', getMailDomainResponse_isDefault - Specifies whether the domain is the default domain for your organization.

$sel:httpStatus:GetMailDomainResponse', getMailDomainResponse_httpStatus - The response's http status code.

Response Lenses

getMailDomainResponse_isTestDomain :: Lens' GetMailDomainResponse (Maybe Bool) Source #

Specifies whether the domain is a test domain provided by WorkMail, or a custom domain.

getMailDomainResponse_records :: Lens' GetMailDomainResponse (Maybe [DnsRecord]) Source #

A list of the DNS records that Amazon 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.

getMailDomainResponse_isDefault :: Lens' GetMailDomainResponse (Maybe Bool) Source #

Specifies whether the domain is the default domain for your organization.