{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.WorkMail.ListMailDomains
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Lists the mail domains in a given WorkMail organization.
module Amazonka.WorkMail.ListMailDomains
  ( -- * Creating a Request
    ListMailDomains (..),
    newListMailDomains,

    -- * Request Lenses
    listMailDomains_maxResults,
    listMailDomains_nextToken,
    listMailDomains_organizationId,

    -- * Destructuring the Response
    ListMailDomainsResponse (..),
    newListMailDomainsResponse,

    -- * Response Lenses
    listMailDomainsResponse_mailDomains,
    listMailDomainsResponse_nextToken,
    listMailDomainsResponse_httpStatus,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response
import Amazonka.WorkMail.Types

-- | /See:/ 'newListMailDomains' smart constructor.
data ListMailDomains = ListMailDomains'
  { -- | The maximum number of results to return in a single call.
    ListMailDomains -> Maybe Natural
maxResults :: Prelude.Maybe Prelude.Natural,
    -- | The token to use to retrieve the next page of results. The first call
    -- does not require a token.
    ListMailDomains -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The WorkMail organization for which to list domains.
    ListMailDomains -> Text
organizationId :: Prelude.Text
  }
  deriving (ListMailDomains -> ListMailDomains -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListMailDomains -> ListMailDomains -> Bool
$c/= :: ListMailDomains -> ListMailDomains -> Bool
== :: ListMailDomains -> ListMailDomains -> Bool
$c== :: ListMailDomains -> ListMailDomains -> Bool
Prelude.Eq, ReadPrec [ListMailDomains]
ReadPrec ListMailDomains
Int -> ReadS ListMailDomains
ReadS [ListMailDomains]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListMailDomains]
$creadListPrec :: ReadPrec [ListMailDomains]
readPrec :: ReadPrec ListMailDomains
$creadPrec :: ReadPrec ListMailDomains
readList :: ReadS [ListMailDomains]
$creadList :: ReadS [ListMailDomains]
readsPrec :: Int -> ReadS ListMailDomains
$creadsPrec :: Int -> ReadS ListMailDomains
Prelude.Read, Int -> ListMailDomains -> ShowS
[ListMailDomains] -> ShowS
ListMailDomains -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListMailDomains] -> ShowS
$cshowList :: [ListMailDomains] -> ShowS
show :: ListMailDomains -> String
$cshow :: ListMailDomains -> String
showsPrec :: Int -> ListMailDomains -> ShowS
$cshowsPrec :: Int -> ListMailDomains -> ShowS
Prelude.Show, forall x. Rep ListMailDomains x -> ListMailDomains
forall x. ListMailDomains -> Rep ListMailDomains x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListMailDomains x -> ListMailDomains
$cfrom :: forall x. ListMailDomains -> Rep ListMailDomains x
Prelude.Generic)

-- |
-- Create a value of 'ListMailDomains' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'maxResults', 'listMailDomains_maxResults' - The maximum number of results to return in a single call.
--
-- 'nextToken', 'listMailDomains_nextToken' - The token to use to retrieve the next page of results. The first call
-- does not require a token.
--
-- 'organizationId', 'listMailDomains_organizationId' - The WorkMail organization for which to list domains.
newListMailDomains ::
  -- | 'organizationId'
  Prelude.Text ->
  ListMailDomains
newListMailDomains :: Text -> ListMailDomains
newListMailDomains Text
pOrganizationId_ =
  ListMailDomains'
    { $sel:maxResults:ListMailDomains' :: Maybe Natural
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListMailDomains' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:organizationId:ListMailDomains' :: Text
organizationId = Text
pOrganizationId_
    }

-- | The maximum number of results to return in a single call.
listMailDomains_maxResults :: Lens.Lens' ListMailDomains (Prelude.Maybe Prelude.Natural)
listMailDomains_maxResults :: Lens' ListMailDomains (Maybe Natural)
listMailDomains_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListMailDomains' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:ListMailDomains' :: ListMailDomains -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: ListMailDomains
s@ListMailDomains' {} Maybe Natural
a -> ListMailDomains
s {$sel:maxResults:ListMailDomains' :: Maybe Natural
maxResults = Maybe Natural
a} :: ListMailDomains)

-- | The token to use to retrieve the next page of results. The first call
-- does not require a token.
listMailDomains_nextToken :: Lens.Lens' ListMailDomains (Prelude.Maybe Prelude.Text)
listMailDomains_nextToken :: Lens' ListMailDomains (Maybe Text)
listMailDomains_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListMailDomains' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListMailDomains' :: ListMailDomains -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListMailDomains
s@ListMailDomains' {} Maybe Text
a -> ListMailDomains
s {$sel:nextToken:ListMailDomains' :: Maybe Text
nextToken = Maybe Text
a} :: ListMailDomains)

-- | The WorkMail organization for which to list domains.
listMailDomains_organizationId :: Lens.Lens' ListMailDomains Prelude.Text
listMailDomains_organizationId :: Lens' ListMailDomains Text
listMailDomains_organizationId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListMailDomains' {Text
organizationId :: Text
$sel:organizationId:ListMailDomains' :: ListMailDomains -> Text
organizationId} -> Text
organizationId) (\s :: ListMailDomains
s@ListMailDomains' {} Text
a -> ListMailDomains
s {$sel:organizationId:ListMailDomains' :: Text
organizationId = Text
a} :: ListMailDomains)

instance Core.AWSRequest ListMailDomains where
  type
    AWSResponse ListMailDomains =
      ListMailDomainsResponse
  request :: (Service -> Service) -> ListMailDomains -> Request ListMailDomains
request Service -> Service
overrides =
    forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy ListMailDomains
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse ListMailDomains)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe [MailDomainSummary]
-> Maybe Text -> Int -> ListMailDomainsResponse
ListMailDomainsResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"MailDomains" forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty)
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"NextToken")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable ListMailDomains where
  hashWithSalt :: Int -> ListMailDomains -> Int
hashWithSalt Int
_salt ListMailDomains' {Maybe Natural
Maybe Text
Text
organizationId :: Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:organizationId:ListMailDomains' :: ListMailDomains -> Text
$sel:nextToken:ListMailDomains' :: ListMailDomains -> Maybe Text
$sel:maxResults:ListMailDomains' :: ListMailDomains -> Maybe Natural
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
maxResults
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
nextToken
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
organizationId

instance Prelude.NFData ListMailDomains where
  rnf :: ListMailDomains -> ()
rnf ListMailDomains' {Maybe Natural
Maybe Text
Text
organizationId :: Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:organizationId:ListMailDomains' :: ListMailDomains -> Text
$sel:nextToken:ListMailDomains' :: ListMailDomains -> Maybe Text
$sel:maxResults:ListMailDomains' :: ListMailDomains -> Maybe Natural
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
maxResults
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
nextToken
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
organizationId

instance Data.ToHeaders ListMailDomains where
  toHeaders :: ListMailDomains -> ResponseHeaders
toHeaders =
    forall a b. a -> b -> a
Prelude.const
      ( forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"X-Amz-Target"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"WorkMailService.ListMailDomains" ::
                          Prelude.ByteString
                      ),
            HeaderName
"Content-Type"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToJSON ListMailDomains where
  toJSON :: ListMailDomains -> Value
toJSON ListMailDomains' {Maybe Natural
Maybe Text
Text
organizationId :: Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:organizationId:ListMailDomains' :: ListMailDomains -> Text
$sel:nextToken:ListMailDomains' :: ListMailDomains -> Maybe Text
$sel:maxResults:ListMailDomains' :: ListMailDomains -> Maybe Natural
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"MaxResults" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Natural
maxResults,
            (Key
"NextToken" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
nextToken,
            forall a. a -> Maybe a
Prelude.Just
              (Key
"OrganizationId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
organizationId)
          ]
      )

instance Data.ToPath ListMailDomains where
  toPath :: ListMailDomains -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/"

instance Data.ToQuery ListMailDomains where
  toQuery :: ListMailDomains -> QueryString
toQuery = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

-- | /See:/ 'newListMailDomainsResponse' smart constructor.
data ListMailDomainsResponse = ListMailDomainsResponse'
  { -- | 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 -> Maybe [MailDomainSummary]
mailDomains :: Prelude.Maybe [MailDomainSummary],
    -- | The token to use to retrieve the next page of results. The value becomes
    -- @null@ when there are no more results to return.
    ListMailDomainsResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    ListMailDomainsResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (ListMailDomainsResponse -> ListMailDomainsResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListMailDomainsResponse -> ListMailDomainsResponse -> Bool
$c/= :: ListMailDomainsResponse -> ListMailDomainsResponse -> Bool
== :: ListMailDomainsResponse -> ListMailDomainsResponse -> Bool
$c== :: ListMailDomainsResponse -> ListMailDomainsResponse -> Bool
Prelude.Eq, ReadPrec [ListMailDomainsResponse]
ReadPrec ListMailDomainsResponse
Int -> ReadS ListMailDomainsResponse
ReadS [ListMailDomainsResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListMailDomainsResponse]
$creadListPrec :: ReadPrec [ListMailDomainsResponse]
readPrec :: ReadPrec ListMailDomainsResponse
$creadPrec :: ReadPrec ListMailDomainsResponse
readList :: ReadS [ListMailDomainsResponse]
$creadList :: ReadS [ListMailDomainsResponse]
readsPrec :: Int -> ReadS ListMailDomainsResponse
$creadsPrec :: Int -> ReadS ListMailDomainsResponse
Prelude.Read, Int -> ListMailDomainsResponse -> ShowS
[ListMailDomainsResponse] -> ShowS
ListMailDomainsResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListMailDomainsResponse] -> ShowS
$cshowList :: [ListMailDomainsResponse] -> ShowS
show :: ListMailDomainsResponse -> String
$cshow :: ListMailDomainsResponse -> String
showsPrec :: Int -> ListMailDomainsResponse -> ShowS
$cshowsPrec :: Int -> ListMailDomainsResponse -> ShowS
Prelude.Show, forall x. Rep ListMailDomainsResponse x -> ListMailDomainsResponse
forall x. ListMailDomainsResponse -> Rep ListMailDomainsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListMailDomainsResponse x -> ListMailDomainsResponse
$cfrom :: forall x. ListMailDomainsResponse -> Rep ListMailDomainsResponse x
Prelude.Generic)

-- |
-- Create a value of 'ListMailDomainsResponse' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'mailDomains', '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.
--
-- 'nextToken', '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.
--
-- 'httpStatus', 'listMailDomainsResponse_httpStatus' - The response's http status code.
newListMailDomainsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListMailDomainsResponse
newListMailDomainsResponse :: Int -> ListMailDomainsResponse
newListMailDomainsResponse Int
pHttpStatus_ =
  ListMailDomainsResponse'
    { $sel:mailDomains:ListMailDomainsResponse' :: Maybe [MailDomainSummary]
mailDomains =
        forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListMailDomainsResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:ListMailDomainsResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | 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_mailDomains :: Lens.Lens' ListMailDomainsResponse (Prelude.Maybe [MailDomainSummary])
listMailDomainsResponse_mailDomains :: Lens' ListMailDomainsResponse (Maybe [MailDomainSummary])
listMailDomainsResponse_mailDomains = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListMailDomainsResponse' {Maybe [MailDomainSummary]
mailDomains :: Maybe [MailDomainSummary]
$sel:mailDomains:ListMailDomainsResponse' :: ListMailDomainsResponse -> Maybe [MailDomainSummary]
mailDomains} -> Maybe [MailDomainSummary]
mailDomains) (\s :: ListMailDomainsResponse
s@ListMailDomainsResponse' {} Maybe [MailDomainSummary]
a -> ListMailDomainsResponse
s {$sel:mailDomains:ListMailDomainsResponse' :: Maybe [MailDomainSummary]
mailDomains = Maybe [MailDomainSummary]
a} :: ListMailDomainsResponse) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The token to use to retrieve the next page of results. The value becomes
-- @null@ when there are no more results to return.
listMailDomainsResponse_nextToken :: Lens.Lens' ListMailDomainsResponse (Prelude.Maybe Prelude.Text)
listMailDomainsResponse_nextToken :: Lens' ListMailDomainsResponse (Maybe Text)
listMailDomainsResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListMailDomainsResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListMailDomainsResponse' :: ListMailDomainsResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListMailDomainsResponse
s@ListMailDomainsResponse' {} Maybe Text
a -> ListMailDomainsResponse
s {$sel:nextToken:ListMailDomainsResponse' :: Maybe Text
nextToken = Maybe Text
a} :: ListMailDomainsResponse)

-- | The response's http status code.
listMailDomainsResponse_httpStatus :: Lens.Lens' ListMailDomainsResponse Prelude.Int
listMailDomainsResponse_httpStatus :: Lens' ListMailDomainsResponse Int
listMailDomainsResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListMailDomainsResponse' {Int
httpStatus :: Int
$sel:httpStatus:ListMailDomainsResponse' :: ListMailDomainsResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: ListMailDomainsResponse
s@ListMailDomainsResponse' {} Int
a -> ListMailDomainsResponse
s {$sel:httpStatus:ListMailDomainsResponse' :: Int
httpStatus = Int
a} :: ListMailDomainsResponse)

instance Prelude.NFData ListMailDomainsResponse where
  rnf :: ListMailDomainsResponse -> ()
rnf ListMailDomainsResponse' {Int
Maybe [MailDomainSummary]
Maybe Text
httpStatus :: Int
nextToken :: Maybe Text
mailDomains :: Maybe [MailDomainSummary]
$sel:httpStatus:ListMailDomainsResponse' :: ListMailDomainsResponse -> Int
$sel:nextToken:ListMailDomainsResponse' :: ListMailDomainsResponse -> Maybe Text
$sel:mailDomains:ListMailDomainsResponse' :: ListMailDomainsResponse -> Maybe [MailDomainSummary]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [MailDomainSummary]
mailDomains
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
nextToken
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus