| 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.ListMailDomains
Description
Lists the mail domains in a given WorkMail organization.
Synopsis
- data ListMailDomains = ListMailDomains' {}
- newListMailDomains :: Text -> ListMailDomains
- listMailDomains_maxResults :: Lens' ListMailDomains (Maybe Natural)
- listMailDomains_nextToken :: Lens' ListMailDomains (Maybe Text)
- listMailDomains_organizationId :: Lens' ListMailDomains Text
- data ListMailDomainsResponse = ListMailDomainsResponse' {
- mailDomains :: Maybe [MailDomainSummary]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListMailDomainsResponse :: Int -> ListMailDomainsResponse
- listMailDomainsResponse_mailDomains :: Lens' ListMailDomainsResponse (Maybe [MailDomainSummary])
- listMailDomainsResponse_nextToken :: Lens' ListMailDomainsResponse (Maybe Text)
- listMailDomainsResponse_httpStatus :: Lens' ListMailDomainsResponse Int
Creating a Request
data ListMailDomains Source #
See: newListMailDomains smart constructor.
Constructors
| ListMailDomains' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> 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:maxResults:ListMailDomains', listMailDomains_maxResults - The maximum number of results to return in a single call.
ListMailDomains, listMailDomains_nextToken - The token to use to retrieve the next page of results. The first call
does not require a token.
ListMailDomains, listMailDomains_organizationId - The WorkMail organization for which to list domains.
Request Lenses
listMailDomains_maxResults :: Lens' ListMailDomains (Maybe Natural) Source #
The maximum number of results to return in a single call.
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_organizationId :: Lens' ListMailDomains Text Source #
The WorkMail organization for which to list domains.
Destructuring the Response
data ListMailDomainsResponse Source #
See: newListMailDomainsResponse smart constructor.
Constructors
| ListMailDomainsResponse' | |
Fields
| |
Instances
newListMailDomainsResponse Source #
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:mailDomains:ListMailDomainsResponse', listMailDomainsResponse_mailDomains - The list of mail domain summaries, specifying domains that exist in the
specified WorkMail organization, along with the information about
whether the domain is or isn't the default.
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:httpStatus:ListMailDomainsResponse', listMailDomainsResponse_httpStatus - The response's http status code.
Response Lenses
listMailDomainsResponse_mailDomains :: Lens' ListMailDomainsResponse (Maybe [MailDomainSummary]) Source #
The list of mail domain summaries, specifying domains that exist in the specified WorkMail organization, along with the information about whether the domain is or isn't the default.
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_httpStatus :: Lens' ListMailDomainsResponse Int Source #
The response's http status code.