amazonka-workmail-2.0: Amazon WorkMail SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.WorkMail.RegisterMailDomain

Description

Registers a new domain in WorkMail and SES, and configures it for use by WorkMail. Emails received by SES for this domain are routed to the specified WorkMail organization, and WorkMail has permanent permission to use the specified domain for sending your users' emails.

Synopsis

Creating a Request

data RegisterMailDomain Source #

See: newRegisterMailDomain smart constructor.

Constructors

RegisterMailDomain' 

Fields

Instances

Instances details
ToJSON RegisterMailDomain Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterMailDomain

Methods

toJSON :: RegisterMailDomain -> Value #

toEncoding :: RegisterMailDomain -> Encoding #

toJSONList :: [RegisterMailDomain] -> Value #

toEncodingList :: [RegisterMailDomain] -> Encoding #

ToHeaders RegisterMailDomain Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterMailDomain

Methods

toHeaders :: RegisterMailDomain -> [Header] #

ToPath RegisterMailDomain Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterMailDomain

Methods

toPath :: RegisterMailDomain -> ByteString #

ToQuery RegisterMailDomain Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterMailDomain

Methods

toQuery :: RegisterMailDomain -> QueryString #

AWSRequest RegisterMailDomain Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterMailDomain

Associated Types

type AWSResponse RegisterMailDomain #

Methods

request :: (Service -> Service) -> RegisterMailDomain -> Request RegisterMailDomain #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy RegisterMailDomain -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RegisterMailDomain))) #

Generic RegisterMailDomain Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterMailDomain

Associated Types

type Rep RegisterMailDomain :: Type -> Type #

Methods

from :: RegisterMailDomain -> Rep RegisterMailDomain x #

to :: Rep RegisterMailDomain x -> RegisterMailDomain #

Read RegisterMailDomain Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterMailDomain

Methods

readsPrec :: Int -> ReadS RegisterMailDomain #

readList :: ReadS [RegisterMailDomain] #

readPrec :: ReadPrec RegisterMailDomain #

readListPrec :: ReadPrec [RegisterMailDomain] #

Show RegisterMailDomain Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterMailDomain

Methods

showsPrec :: Int -> RegisterMailDomain -> ShowS #

show :: RegisterMailDomain -> String #

showList :: [RegisterMailDomain] -> ShowS #

NFData RegisterMailDomain Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterMailDomain

Methods

rnf :: RegisterMailDomain -> () #

Eq RegisterMailDomain Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterMailDomain

Methods

(==) :: RegisterMailDomain -> RegisterMailDomain -> Bool #

(/=) :: RegisterMailDomain -> RegisterMailDomain -> Bool #

Hashable RegisterMailDomain Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterMailDomain

Methods

hashWithSalt :: Int -> RegisterMailDomain -> Int #

hash :: RegisterMailDomain -> Int #

type AWSResponse RegisterMailDomain Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterMailDomain

type AWSResponse RegisterMailDomain = RegisterMailDomainResponse
type Rep RegisterMailDomain Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterMailDomain

type Rep RegisterMailDomain = D1 ('MetaData "RegisterMailDomain" "Amazonka.WorkMail.RegisterMailDomain" "amazonka-workmail-2.0-6w5uOhF45UX4mlfLHLnG5b" 'False) (C1 ('MetaCons "RegisterMailDomain'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "organizationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newRegisterMailDomain Source #

Arguments

:: Text

RegisterMailDomain

-> Text

RegisterMailDomain

-> RegisterMailDomain 

Create a value of RegisterMailDomain 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:clientToken:RegisterMailDomain', registerMailDomain_clientToken - Idempotency token used when retrying requests.

RegisterMailDomain, registerMailDomain_organizationId - The WorkMail organization under which you're creating the domain.

RegisterMailDomain, registerMailDomain_domainName - The name of the mail domain to create in WorkMail and SES.

Request Lenses

registerMailDomain_clientToken :: Lens' RegisterMailDomain (Maybe Text) Source #

Idempotency token used when retrying requests.

registerMailDomain_organizationId :: Lens' RegisterMailDomain Text Source #

The WorkMail organization under which you're creating the domain.

registerMailDomain_domainName :: Lens' RegisterMailDomain Text Source #

The name of the mail domain to create in WorkMail and SES.

Destructuring the Response

data RegisterMailDomainResponse Source #

See: newRegisterMailDomainResponse smart constructor.

Constructors

RegisterMailDomainResponse' 

Fields

Instances

Instances details
Generic RegisterMailDomainResponse Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterMailDomain

Associated Types

type Rep RegisterMailDomainResponse :: Type -> Type #

Methods

from :: RegisterMailDomainResponse -> Rep RegisterMailDomainResponse x #

to :: Rep RegisterMailDomainResponse x -> RegisterMailDomainResponse #

Read RegisterMailDomainResponse Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterMailDomain

Methods

readsPrec :: Int -> ReadS RegisterMailDomainResponse #

readList :: ReadS [RegisterMailDomainResponse] #

readPrec :: ReadPrec RegisterMailDomainResponse #

readListPrec :: ReadPrec [RegisterMailDomainResponse] #

Show RegisterMailDomainResponse Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterMailDomain

Methods

showsPrec :: Int -> RegisterMailDomainResponse -> ShowS #

show :: RegisterMailDomainResponse -> String #

showList :: [RegisterMailDomainResponse] -> ShowS #

NFData RegisterMailDomainResponse Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterMailDomain

Methods

rnf :: RegisterMailDomainResponse -> () #

Eq RegisterMailDomainResponse Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterMailDomain

Methods

(==) :: RegisterMailDomainResponse -> RegisterMailDomainResponse -> Bool #

(/=) :: RegisterMailDomainResponse -> RegisterMailDomainResponse -> Bool #

type Rep RegisterMailDomainResponse Source # 
Instance details

Defined in Amazonka.WorkMail.RegisterMailDomain

type Rep RegisterMailDomainResponse = D1 ('MetaData "RegisterMailDomainResponse" "Amazonka.WorkMail.RegisterMailDomain" "amazonka-workmail-2.0-6w5uOhF45UX4mlfLHLnG5b" 'False) (C1 ('MetaCons "RegisterMailDomainResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newRegisterMailDomainResponse Source #

Arguments

:: Int

$sel:httpStatus:RegisterMailDomainResponse'

-> RegisterMailDomainResponse 

Create a value of RegisterMailDomainResponse 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:httpStatus:RegisterMailDomainResponse', registerMailDomainResponse_httpStatus - The response's http status code.

Response Lenses

registerMailDomainResponse_httpStatus :: Lens' RegisterMailDomainResponse Int Source #

The response's http status code.