Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.WorkMail.ListMailDomains

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the mail domains in a given Amazon WorkMail organization.

Creating a Request

data ListMailDomains Source #

See: newListMailDomains smart constructor.

Constructors

ListMailDomains'
Fields nextToken :: Maybe Text The token to use to retrieve the next page of results. The first call does not require a token. maxResults :: Maybe Natural The maximum number of results to return in a single call. organizationId :: Text The Amazon WorkMail organization for which to list domains.

Instances

Instances details

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

newListMailDomains Source #

Arguments

:: Text	`$sel:organizationId:ListMailDomains'`
-> ListMailDomains

Create a value of ListMailDomains 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:nextToken:ListMailDomains', listMailDomains_nextToken - The token to use to retrieve the next page of results. The first call does not require a token.

$sel:maxResults:ListMailDomains', listMailDomains_maxResults - The maximum number of results to return in a single call.

$sel:organizationId:ListMailDomains', listMailDomains_organizationId - The Amazon WorkMail organization for which to list domains.

Request Lenses

listMailDomains_nextToken :: Lens' ListMailDomains (Maybe Text) Source #

The token to use to retrieve the next page of results. The first call does not require a token.

listMailDomains_maxResults :: Lens' ListMailDomains (Maybe Natural) Source #

The maximum number of results to return in a single call.

listMailDomains_organizationId :: Lens' ListMailDomains Text Source #

The Amazon WorkMail organization for which to list domains.

Destructuring the Response

data ListMailDomainsResponse Source #

See: newListMailDomainsResponse smart constructor.

Constructors

ListMailDomainsResponse'

Fields

nextToken :: Maybe Text
The token to use to retrieve the next page of results. The value becomes null when there are no more results to return.
mailDomains :: Maybe [MailDomainSummary]
The list of mail domain summaries, specifying domains that exist in the specified Amazon WorkMail organization, along with the information about whether the domain is or isn't the default.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq ListMailDomainsResponse Source #
Instance details Defined in Amazonka.WorkMail.ListMailDomains Methods (==) :: ListMailDomainsResponse -> ListMailDomainsResponse -> Bool # (/=) :: ListMailDomainsResponse -> ListMailDomainsResponse -> Bool #
Read ListMailDomainsResponse Source #
Instance details Defined in Amazonka.WorkMail.ListMailDomains Methods readsPrec :: Int -> ReadS ListMailDomainsResponse # readList :: ReadS [ListMailDomainsResponse] # readPrec :: ReadPrec ListMailDomainsResponse # readListPrec :: ReadPrec [ListMailDomainsResponse] #
Show ListMailDomainsResponse Source #
Instance details Defined in Amazonka.WorkMail.ListMailDomains Methods showsPrec :: Int -> ListMailDomainsResponse -> ShowS # show :: ListMailDomainsResponse -> String # showList :: [ListMailDomainsResponse] -> ShowS #
Generic ListMailDomainsResponse Source #
Instance details Defined in Amazonka.WorkMail.ListMailDomains Associated Types type Rep ListMailDomainsResponse :: Type -> Type # Methods from :: ListMailDomainsResponse -> Rep ListMailDomainsResponse x # to :: Rep ListMailDomainsResponse x -> ListMailDomainsResponse #
NFData ListMailDomainsResponse Source #
Instance details Defined in Amazonka.WorkMail.ListMailDomains Methods rnf :: ListMailDomainsResponse -> () #
type Rep ListMailDomainsResponse Source #
Instance details Defined in Amazonka.WorkMail.ListMailDomains type Rep ListMailDomainsResponse = D1 ('MetaData "ListMailDomainsResponse" "Amazonka.WorkMail.ListMailDomains" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "ListMailDomainsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "mailDomains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MailDomainSummary])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListMailDomainsResponse Source #

Arguments

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

Create a value of ListMailDomainsResponse 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:nextToken:ListMailDomains', listMailDomainsResponse_nextToken - The token to use to retrieve the next page of results. The value becomes null when there are no more results to return.

$sel:mailDomains:ListMailDomainsResponse', listMailDomainsResponse_mailDomains - The list of mail domain summaries, specifying domains that exist in the specified Amazon WorkMail organization, along with the information about whether the domain is or isn't the default.

$sel:httpStatus:ListMailDomainsResponse', listMailDomainsResponse_httpStatus - The response's http status code.

Response Lenses

listMailDomainsResponse_nextToken :: Lens' ListMailDomainsResponse (Maybe Text) Source #

The token to use to retrieve the next page of results. The value becomes null when there are no more results to return.

listMailDomainsResponse_mailDomains :: Lens' ListMailDomainsResponse (Maybe [MailDomainSummary]) Source #

The list of mail domain summaries, specifying domains that exist in the specified Amazon WorkMail organization, along with the information about whether the domain is or isn't the default.

listMailDomainsResponse_httpStatus :: Lens' ListMailDomainsResponse Int Source #

The response's http status code.