Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.WorkMail.GetMailDomain

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

data GetMailDomain = GetMailDomain' {
- organizationId :: Text
- domainName :: Text
}
newGetMailDomain :: Text -> Text -> GetMailDomain
getMailDomain_organizationId :: Lens' GetMailDomain Text
getMailDomain_domainName :: Lens' GetMailDomain Text
data GetMailDomainResponse = GetMailDomainResponse' {
- dkimVerificationStatus :: Maybe DnsRecordVerificationStatus
- isDefault :: Maybe Bool
- isTestDomain :: Maybe Bool
- ownershipVerificationStatus :: Maybe DnsRecordVerificationStatus
- records :: Maybe [DnsRecord]
- httpStatus :: Int
}
newGetMailDomainResponse :: Int -> GetMailDomainResponse
getMailDomainResponse_dkimVerificationStatus :: Lens' GetMailDomainResponse (Maybe DnsRecordVerificationStatus)
getMailDomainResponse_isDefault :: Lens' GetMailDomainResponse (Maybe Bool)
getMailDomainResponse_isTestDomain :: Lens' GetMailDomainResponse (Maybe Bool)
getMailDomainResponse_ownershipVerificationStatus :: Lens' GetMailDomainResponse (Maybe DnsRecordVerificationStatus)
getMailDomainResponse_records :: Lens' GetMailDomainResponse (Maybe [DnsRecord])
getMailDomainResponse_httpStatus :: Lens' GetMailDomainResponse Int

Creating a Request

data GetMailDomain Source #

See: newGetMailDomain smart constructor.

Constructors

GetMailDomain'
Fields organizationId :: Text The WorkMail organization for which the domain is retrieved. domainName :: Text The domain from which you want to retrieve details.

Instances

Instances details

ToJSON GetMailDomain Source #
Instance details Defined in Amazonka.WorkMail.GetMailDomain Methods toJSON :: GetMailDomain -> Value # toEncoding :: GetMailDomain -> Encoding # toJSONList :: [GetMailDomain] -> Value # toEncodingList :: [GetMailDomain] -> Encoding #
ToHeaders GetMailDomain Source #
Instance details Defined in Amazonka.WorkMail.GetMailDomain Methods toHeaders :: GetMailDomain -> [Header] #
ToPath GetMailDomain Source #
Instance details Defined in Amazonka.WorkMail.GetMailDomain Methods toPath :: GetMailDomain -> ByteString #
ToQuery GetMailDomain Source #
Instance details Defined in Amazonka.WorkMail.GetMailDomain Methods toQuery :: GetMailDomain -> QueryString #
AWSRequest GetMailDomain Source #
Instance details Defined in Amazonka.WorkMail.GetMailDomain Associated Types type AWSResponse GetMailDomain # Methods request :: (Service -> Service) -> GetMailDomain -> Request GetMailDomain # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetMailDomain -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetMailDomain))) #
Generic GetMailDomain Source #
Instance details Defined in Amazonka.WorkMail.GetMailDomain Associated Types type Rep GetMailDomain :: Type -> Type # Methods from :: GetMailDomain -> Rep GetMailDomain x # to :: Rep GetMailDomain x -> GetMailDomain #
Read GetMailDomain Source #
Instance details Defined in Amazonka.WorkMail.GetMailDomain Methods readsPrec :: Int -> ReadS GetMailDomain # readList :: ReadS [GetMailDomain] # readPrec :: ReadPrec GetMailDomain # readListPrec :: ReadPrec [GetMailDomain] #
Show GetMailDomain Source #
Instance details Defined in Amazonka.WorkMail.GetMailDomain Methods showsPrec :: Int -> GetMailDomain -> ShowS # show :: GetMailDomain -> String # showList :: [GetMailDomain] -> ShowS #
NFData GetMailDomain Source #
Instance details Defined in Amazonka.WorkMail.GetMailDomain Methods rnf :: GetMailDomain -> () #
Eq GetMailDomain Source #
Instance details Defined in Amazonka.WorkMail.GetMailDomain Methods (==) :: GetMailDomain -> GetMailDomain -> Bool # (/=) :: GetMailDomain -> GetMailDomain -> Bool #
Hashable GetMailDomain Source #
Instance details Defined in Amazonka.WorkMail.GetMailDomain Methods hashWithSalt :: Int -> GetMailDomain -> Int # hash :: GetMailDomain -> Int #
type AWSResponse GetMailDomain Source #
Instance details Defined in Amazonka.WorkMail.GetMailDomain type AWSResponse GetMailDomain = GetMailDomainResponse
type Rep GetMailDomain Source #
Instance details Defined in Amazonka.WorkMail.GetMailDomain type Rep GetMailDomain = D1 ('MetaData "GetMailDomain" "Amazonka.WorkMail.GetMailDomain" "amazonka-workmail-2.0-6w5uOhF45UX4mlfLHLnG5b" 'False) (C1 ('MetaCons "GetMailDomain'" 'PrefixI 'True) (S1 ('MetaSel ('Just "organizationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetMailDomain Source #

Arguments

:: Text	`GetMailDomain`
-> Text	`GetMailDomain`
-> GetMailDomain

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:

GetMailDomain, getMailDomain_organizationId - The WorkMail organization for which the domain is retrieved.

GetMailDomain, getMailDomain_domainName - The domain from which you want to retrieve details.

Request Lenses

getMailDomain_organizationId :: Lens' GetMailDomain Text Source #

The 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

dkimVerificationStatus :: Maybe DnsRecordVerificationStatus
Indicates the status of a DKIM verification.
isDefault :: Maybe Bool
Specifies whether the domain is the default domain for your organization.
isTestDomain :: Maybe Bool
Specifies whether the domain is a test domain provided by WorkMail, or a custom domain.
ownershipVerificationStatus :: Maybe DnsRecordVerificationStatus
Indicates the status of the domain ownership verification.
records :: Maybe [DnsRecord]
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetMailDomainResponse Source #
Instance details Defined in Amazonka.WorkMail.GetMailDomain Associated Types type Rep GetMailDomainResponse :: Type -> Type # Methods from :: GetMailDomainResponse -> Rep GetMailDomainResponse x # to :: Rep GetMailDomainResponse x -> GetMailDomainResponse #
Read GetMailDomainResponse Source #
Instance details Defined in Amazonka.WorkMail.GetMailDomain Methods readsPrec :: Int -> ReadS GetMailDomainResponse # readList :: ReadS [GetMailDomainResponse] # readPrec :: ReadPrec GetMailDomainResponse # readListPrec :: ReadPrec [GetMailDomainResponse] #
Show GetMailDomainResponse Source #
Instance details Defined in Amazonka.WorkMail.GetMailDomain Methods showsPrec :: Int -> GetMailDomainResponse -> ShowS # show :: GetMailDomainResponse -> String # showList :: [GetMailDomainResponse] -> ShowS #
NFData GetMailDomainResponse Source #
Instance details Defined in Amazonka.WorkMail.GetMailDomain Methods rnf :: GetMailDomainResponse -> () #
Eq GetMailDomainResponse Source #
Instance details Defined in Amazonka.WorkMail.GetMailDomain Methods (==) :: GetMailDomainResponse -> GetMailDomainResponse -> Bool # (/=) :: GetMailDomainResponse -> GetMailDomainResponse -> Bool #
type Rep GetMailDomainResponse Source #
Instance details Defined in Amazonka.WorkMail.GetMailDomain type Rep GetMailDomainResponse = D1 ('MetaData "GetMailDomainResponse" "Amazonka.WorkMail.GetMailDomain" "amazonka-workmail-2.0-6w5uOhF45UX4mlfLHLnG5b" 'False) (C1 ('MetaCons "GetMailDomainResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dkimVerificationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DnsRecordVerificationStatus)) :: (S1 ('MetaSel ('Just "isDefault") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "isTestDomain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: (S1 ('MetaSel ('Just "ownershipVerificationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DnsRecordVerificationStatus)) :: (S1 ('MetaSel ('Just "records") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DnsRecord])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetMailDomainResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetMailDomainResponse'`
-> GetMailDomainResponse

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: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:isTestDomain:GetMailDomainResponse', getMailDomainResponse_isTestDomain - Specifies whether the domain is a test domain provided by WorkMail, or a custom domain.

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

$sel:records:GetMailDomainResponse', getMailDomainResponse_records - 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.

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

Response Lenses

getMailDomainResponse_dkimVerificationStatus :: Lens' GetMailDomainResponse (Maybe DnsRecordVerificationStatus) Source #

Indicates the status of a DKIM verification.

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

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

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

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

getMailDomainResponse_ownershipVerificationStatus :: Lens' GetMailDomainResponse (Maybe DnsRecordVerificationStatus) Source #

Indicates the status of the domain ownership verification.

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

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.

getMailDomainResponse_httpStatus :: Lens' GetMailDomainResponse Int Source #

The response's http status code.