{-# 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.SWF.ListDomains
-- 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)
--
-- Returns the list of domains registered in the account. The results may
-- be split into multiple pages. To retrieve subsequent pages, make the
-- call again using the nextPageToken returned by the initial call.
--
-- This operation is eventually consistent. The results are best effort and
-- may not exactly reflect recent updates and changes.
--
-- __Access Control__
--
-- You can use IAM policies to control this action\'s access to Amazon SWF
-- resources as follows:
--
-- -   Use a @Resource@ element with the domain name to limit the action to
--     only specified domains. The element must be set to
--     @arn:aws:swf::AccountID:domain\/*@, where /AccountID/ is the account
--     ID, with no dashes.
--
-- -   Use an @Action@ element to allow or deny permission to call this
--     action.
--
-- -   You cannot use an IAM policy to constrain this action\'s parameters.
--
-- If the caller doesn\'t have sufficient permissions to invoke the action,
-- or the parameter values fall outside the specified constraints, the
-- action fails. The associated event attribute\'s @cause@ parameter is set
-- to @OPERATION_NOT_PERMITTED@. For details and example IAM policies, see
-- <https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html Using IAM to Manage Access to Amazon SWF Workflows>
-- in the /Amazon SWF Developer Guide/.
--
-- This operation returns paginated results.
module Amazonka.SWF.ListDomains
  ( -- * Creating a Request
    ListDomains (..),
    newListDomains,

    -- * Request Lenses
    listDomains_nextPageToken,
    listDomains_reverseOrder,
    listDomains_maximumPageSize,
    listDomains_registrationStatus,

    -- * Destructuring the Response
    ListDomainsResponse (..),
    newListDomainsResponse,

    -- * Response Lenses
    listDomainsResponse_nextPageToken,
    listDomainsResponse_httpStatus,
    listDomainsResponse_domainInfos,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response
import Amazonka.SWF.Types

-- | /See:/ 'newListDomains' smart constructor.
data ListDomains = ListDomains'
  { -- | If @NextPageToken@ is returned there are more results available. The
    -- value of @NextPageToken@ is a unique pagination token for each page.
    -- Make the call again using the returned token to retrieve the next page.
    -- Keep all other arguments unchanged. Each pagination token expires after
    -- 60 seconds. Using an expired pagination token will return a @400@ error:
    -- \"@Specified token has exceeded its maximum lifetime@\".
    --
    -- The configured @maximumPageSize@ determines how many results can be
    -- returned in a single call.
    ListDomains -> Maybe Text
nextPageToken :: Prelude.Maybe Prelude.Text,
    -- | When set to @true@, returns the results in reverse order. By default,
    -- the results are returned in ascending alphabetical order by @name@ of
    -- the domains.
    ListDomains -> Maybe Bool
reverseOrder :: Prelude.Maybe Prelude.Bool,
    -- | The maximum number of results that are returned per call. Use
    -- @nextPageToken@ to obtain further pages of results.
    ListDomains -> Maybe Natural
maximumPageSize :: Prelude.Maybe Prelude.Natural,
    -- | Specifies the registration status of the domains to list.
    ListDomains -> RegistrationStatus
registrationStatus :: RegistrationStatus
  }
  deriving (ListDomains -> ListDomains -> Bool
(ListDomains -> ListDomains -> Bool)
-> (ListDomains -> ListDomains -> Bool) -> Eq ListDomains
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListDomains -> ListDomains -> Bool
$c/= :: ListDomains -> ListDomains -> Bool
== :: ListDomains -> ListDomains -> Bool
$c== :: ListDomains -> ListDomains -> Bool
Prelude.Eq, ReadPrec [ListDomains]
ReadPrec ListDomains
Int -> ReadS ListDomains
ReadS [ListDomains]
(Int -> ReadS ListDomains)
-> ReadS [ListDomains]
-> ReadPrec ListDomains
-> ReadPrec [ListDomains]
-> Read ListDomains
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListDomains]
$creadListPrec :: ReadPrec [ListDomains]
readPrec :: ReadPrec ListDomains
$creadPrec :: ReadPrec ListDomains
readList :: ReadS [ListDomains]
$creadList :: ReadS [ListDomains]
readsPrec :: Int -> ReadS ListDomains
$creadsPrec :: Int -> ReadS ListDomains
Prelude.Read, Int -> ListDomains -> ShowS
[ListDomains] -> ShowS
ListDomains -> String
(Int -> ListDomains -> ShowS)
-> (ListDomains -> String)
-> ([ListDomains] -> ShowS)
-> Show ListDomains
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListDomains] -> ShowS
$cshowList :: [ListDomains] -> ShowS
show :: ListDomains -> String
$cshow :: ListDomains -> String
showsPrec :: Int -> ListDomains -> ShowS
$cshowsPrec :: Int -> ListDomains -> ShowS
Prelude.Show, (forall x. ListDomains -> Rep ListDomains x)
-> (forall x. Rep ListDomains x -> ListDomains)
-> Generic ListDomains
forall x. Rep ListDomains x -> ListDomains
forall x. ListDomains -> Rep ListDomains x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListDomains x -> ListDomains
$cfrom :: forall x. ListDomains -> Rep ListDomains x
Prelude.Generic)

-- |
-- Create a value of 'ListDomains' 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:
--
-- 'nextPageToken', 'listDomains_nextPageToken' - If @NextPageToken@ is returned there are more results available. The
-- value of @NextPageToken@ is a unique pagination token for each page.
-- Make the call again using the returned token to retrieve the next page.
-- Keep all other arguments unchanged. Each pagination token expires after
-- 60 seconds. Using an expired pagination token will return a @400@ error:
-- \"@Specified token has exceeded its maximum lifetime@\".
--
-- The configured @maximumPageSize@ determines how many results can be
-- returned in a single call.
--
-- 'reverseOrder', 'listDomains_reverseOrder' - When set to @true@, returns the results in reverse order. By default,
-- the results are returned in ascending alphabetical order by @name@ of
-- the domains.
--
-- 'maximumPageSize', 'listDomains_maximumPageSize' - The maximum number of results that are returned per call. Use
-- @nextPageToken@ to obtain further pages of results.
--
-- 'registrationStatus', 'listDomains_registrationStatus' - Specifies the registration status of the domains to list.
newListDomains ::
  -- | 'registrationStatus'
  RegistrationStatus ->
  ListDomains
newListDomains :: RegistrationStatus -> ListDomains
newListDomains RegistrationStatus
pRegistrationStatus_ =
  ListDomains' :: Maybe Text
-> Maybe Bool -> Maybe Natural -> RegistrationStatus -> ListDomains
ListDomains'
    { $sel:nextPageToken:ListDomains' :: Maybe Text
nextPageToken = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:reverseOrder:ListDomains' :: Maybe Bool
reverseOrder = Maybe Bool
forall a. Maybe a
Prelude.Nothing,
      $sel:maximumPageSize:ListDomains' :: Maybe Natural
maximumPageSize = Maybe Natural
forall a. Maybe a
Prelude.Nothing,
      $sel:registrationStatus:ListDomains' :: RegistrationStatus
registrationStatus = RegistrationStatus
pRegistrationStatus_
    }

-- | If @NextPageToken@ is returned there are more results available. The
-- value of @NextPageToken@ is a unique pagination token for each page.
-- Make the call again using the returned token to retrieve the next page.
-- Keep all other arguments unchanged. Each pagination token expires after
-- 60 seconds. Using an expired pagination token will return a @400@ error:
-- \"@Specified token has exceeded its maximum lifetime@\".
--
-- The configured @maximumPageSize@ determines how many results can be
-- returned in a single call.
listDomains_nextPageToken :: Lens.Lens' ListDomains (Prelude.Maybe Prelude.Text)
listDomains_nextPageToken :: (Maybe Text -> f (Maybe Text)) -> ListDomains -> f ListDomains
listDomains_nextPageToken = (ListDomains -> Maybe Text)
-> (ListDomains -> Maybe Text -> ListDomains)
-> Lens ListDomains ListDomains (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListDomains' {Maybe Text
nextPageToken :: Maybe Text
$sel:nextPageToken:ListDomains' :: ListDomains -> Maybe Text
nextPageToken} -> Maybe Text
nextPageToken) (\s :: ListDomains
s@ListDomains' {} Maybe Text
a -> ListDomains
s {$sel:nextPageToken:ListDomains' :: Maybe Text
nextPageToken = Maybe Text
a} :: ListDomains)

-- | When set to @true@, returns the results in reverse order. By default,
-- the results are returned in ascending alphabetical order by @name@ of
-- the domains.
listDomains_reverseOrder :: Lens.Lens' ListDomains (Prelude.Maybe Prelude.Bool)
listDomains_reverseOrder :: (Maybe Bool -> f (Maybe Bool)) -> ListDomains -> f ListDomains
listDomains_reverseOrder = (ListDomains -> Maybe Bool)
-> (ListDomains -> Maybe Bool -> ListDomains)
-> Lens ListDomains ListDomains (Maybe Bool) (Maybe Bool)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListDomains' {Maybe Bool
reverseOrder :: Maybe Bool
$sel:reverseOrder:ListDomains' :: ListDomains -> Maybe Bool
reverseOrder} -> Maybe Bool
reverseOrder) (\s :: ListDomains
s@ListDomains' {} Maybe Bool
a -> ListDomains
s {$sel:reverseOrder:ListDomains' :: Maybe Bool
reverseOrder = Maybe Bool
a} :: ListDomains)

-- | The maximum number of results that are returned per call. Use
-- @nextPageToken@ to obtain further pages of results.
listDomains_maximumPageSize :: Lens.Lens' ListDomains (Prelude.Maybe Prelude.Natural)
listDomains_maximumPageSize :: (Maybe Natural -> f (Maybe Natural))
-> ListDomains -> f ListDomains
listDomains_maximumPageSize = (ListDomains -> Maybe Natural)
-> (ListDomains -> Maybe Natural -> ListDomains)
-> Lens ListDomains ListDomains (Maybe Natural) (Maybe Natural)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListDomains' {Maybe Natural
maximumPageSize :: Maybe Natural
$sel:maximumPageSize:ListDomains' :: ListDomains -> Maybe Natural
maximumPageSize} -> Maybe Natural
maximumPageSize) (\s :: ListDomains
s@ListDomains' {} Maybe Natural
a -> ListDomains
s {$sel:maximumPageSize:ListDomains' :: Maybe Natural
maximumPageSize = Maybe Natural
a} :: ListDomains)

-- | Specifies the registration status of the domains to list.
listDomains_registrationStatus :: Lens.Lens' ListDomains RegistrationStatus
listDomains_registrationStatus :: (RegistrationStatus -> f RegistrationStatus)
-> ListDomains -> f ListDomains
listDomains_registrationStatus = (ListDomains -> RegistrationStatus)
-> (ListDomains -> RegistrationStatus -> ListDomains)
-> Lens
     ListDomains ListDomains RegistrationStatus RegistrationStatus
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListDomains' {RegistrationStatus
registrationStatus :: RegistrationStatus
$sel:registrationStatus:ListDomains' :: ListDomains -> RegistrationStatus
registrationStatus} -> RegistrationStatus
registrationStatus) (\s :: ListDomains
s@ListDomains' {} RegistrationStatus
a -> ListDomains
s {$sel:registrationStatus:ListDomains' :: RegistrationStatus
registrationStatus = RegistrationStatus
a} :: ListDomains)

instance Core.AWSPager ListDomains where
  page :: ListDomains -> AWSResponse ListDomains -> Maybe ListDomains
page ListDomains
rq AWSResponse ListDomains
rs
    | Maybe Text -> Bool
forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse ListDomains
ListDomainsResponse
rs
            ListDomainsResponse
-> Getting (First Text) ListDomainsResponse Text -> Maybe Text
forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? (Maybe Text -> Const (First Text) (Maybe Text))
-> ListDomainsResponse -> Const (First Text) ListDomainsResponse
Lens' ListDomainsResponse (Maybe Text)
listDomainsResponse_nextPageToken
              ((Maybe Text -> Const (First Text) (Maybe Text))
 -> ListDomainsResponse -> Const (First Text) ListDomainsResponse)
-> ((Text -> Const (First Text) Text)
    -> Maybe Text -> Const (First Text) (Maybe Text))
-> Getting (First Text) ListDomainsResponse Text
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. (Text -> Const (First Text) Text)
-> Maybe Text -> Const (First Text) (Maybe Text)
forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just
        ) =
      Maybe ListDomains
forall a. Maybe a
Prelude.Nothing
    | [DomainInfo] -> Bool
forall a. AWSTruncated a => a -> Bool
Core.stop
        (AWSResponse ListDomains
ListDomainsResponse
rs ListDomainsResponse
-> Getting [DomainInfo] ListDomainsResponse [DomainInfo]
-> [DomainInfo]
forall s a. s -> Getting a s a -> a
Lens.^. Getting [DomainInfo] ListDomainsResponse [DomainInfo]
Lens' ListDomainsResponse [DomainInfo]
listDomainsResponse_domainInfos) =
      Maybe ListDomains
forall a. Maybe a
Prelude.Nothing
    | Bool
Prelude.otherwise =
      ListDomains -> Maybe ListDomains
forall a. a -> Maybe a
Prelude.Just (ListDomains -> Maybe ListDomains)
-> ListDomains -> Maybe ListDomains
forall a b. (a -> b) -> a -> b
Prelude.$
        ListDomains
rq
          ListDomains -> (ListDomains -> ListDomains) -> ListDomains
forall a b. a -> (a -> b) -> b
Prelude.& (Maybe Text -> Identity (Maybe Text))
-> ListDomains -> Identity ListDomains
Lens ListDomains ListDomains (Maybe Text) (Maybe Text)
listDomains_nextPageToken
          ((Maybe Text -> Identity (Maybe Text))
 -> ListDomains -> Identity ListDomains)
-> Maybe Text -> ListDomains -> ListDomains
forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse ListDomains
ListDomainsResponse
rs
          ListDomainsResponse
-> Getting (First Text) ListDomainsResponse Text -> Maybe Text
forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? (Maybe Text -> Const (First Text) (Maybe Text))
-> ListDomainsResponse -> Const (First Text) ListDomainsResponse
Lens' ListDomainsResponse (Maybe Text)
listDomainsResponse_nextPageToken
            ((Maybe Text -> Const (First Text) (Maybe Text))
 -> ListDomainsResponse -> Const (First Text) ListDomainsResponse)
-> ((Text -> Const (First Text) Text)
    -> Maybe Text -> Const (First Text) (Maybe Text))
-> Getting (First Text) ListDomainsResponse Text
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. (Text -> Const (First Text) Text)
-> Maybe Text -> Const (First Text) (Maybe Text)
forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just

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

instance Prelude.Hashable ListDomains

instance Prelude.NFData ListDomains

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

instance Core.ToJSON ListDomains where
  toJSON :: ListDomains -> Value
toJSON ListDomains' {Maybe Bool
Maybe Natural
Maybe Text
RegistrationStatus
registrationStatus :: RegistrationStatus
maximumPageSize :: Maybe Natural
reverseOrder :: Maybe Bool
nextPageToken :: Maybe Text
$sel:registrationStatus:ListDomains' :: ListDomains -> RegistrationStatus
$sel:maximumPageSize:ListDomains' :: ListDomains -> Maybe Natural
$sel:reverseOrder:ListDomains' :: ListDomains -> Maybe Bool
$sel:nextPageToken:ListDomains' :: ListDomains -> Maybe Text
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Text
"nextPageToken" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Text -> Pair) -> Maybe Text -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
nextPageToken,
            (Text
"reverseOrder" Text -> Bool -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Bool -> Pair) -> Maybe Bool -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Bool
reverseOrder,
            (Text
"maximumPageSize" Text -> Natural -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=)
              (Natural -> Pair) -> Maybe Natural -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Natural
maximumPageSize,
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just
              (Text
"registrationStatus" Text -> RegistrationStatus -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= RegistrationStatus
registrationStatus)
          ]
      )

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

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

-- | Contains a paginated collection of DomainInfo structures.
--
-- /See:/ 'newListDomainsResponse' smart constructor.
data ListDomainsResponse = ListDomainsResponse'
  { -- | If a @NextPageToken@ was returned by a previous call, there are more
    -- results available. To retrieve the next page of results, make the call
    -- again using the returned token in @nextPageToken@. Keep all other
    -- arguments unchanged.
    --
    -- The configured @maximumPageSize@ determines how many results can be
    -- returned in a single call.
    ListDomainsResponse -> Maybe Text
nextPageToken :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    ListDomainsResponse -> Int
httpStatus :: Prelude.Int,
    -- | A list of DomainInfo structures.
    ListDomainsResponse -> [DomainInfo]
domainInfos :: [DomainInfo]
  }
  deriving (ListDomainsResponse -> ListDomainsResponse -> Bool
(ListDomainsResponse -> ListDomainsResponse -> Bool)
-> (ListDomainsResponse -> ListDomainsResponse -> Bool)
-> Eq ListDomainsResponse
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListDomainsResponse -> ListDomainsResponse -> Bool
$c/= :: ListDomainsResponse -> ListDomainsResponse -> Bool
== :: ListDomainsResponse -> ListDomainsResponse -> Bool
$c== :: ListDomainsResponse -> ListDomainsResponse -> Bool
Prelude.Eq, ReadPrec [ListDomainsResponse]
ReadPrec ListDomainsResponse
Int -> ReadS ListDomainsResponse
ReadS [ListDomainsResponse]
(Int -> ReadS ListDomainsResponse)
-> ReadS [ListDomainsResponse]
-> ReadPrec ListDomainsResponse
-> ReadPrec [ListDomainsResponse]
-> Read ListDomainsResponse
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListDomainsResponse]
$creadListPrec :: ReadPrec [ListDomainsResponse]
readPrec :: ReadPrec ListDomainsResponse
$creadPrec :: ReadPrec ListDomainsResponse
readList :: ReadS [ListDomainsResponse]
$creadList :: ReadS [ListDomainsResponse]
readsPrec :: Int -> ReadS ListDomainsResponse
$creadsPrec :: Int -> ReadS ListDomainsResponse
Prelude.Read, Int -> ListDomainsResponse -> ShowS
[ListDomainsResponse] -> ShowS
ListDomainsResponse -> String
(Int -> ListDomainsResponse -> ShowS)
-> (ListDomainsResponse -> String)
-> ([ListDomainsResponse] -> ShowS)
-> Show ListDomainsResponse
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListDomainsResponse] -> ShowS
$cshowList :: [ListDomainsResponse] -> ShowS
show :: ListDomainsResponse -> String
$cshow :: ListDomainsResponse -> String
showsPrec :: Int -> ListDomainsResponse -> ShowS
$cshowsPrec :: Int -> ListDomainsResponse -> ShowS
Prelude.Show, (forall x. ListDomainsResponse -> Rep ListDomainsResponse x)
-> (forall x. Rep ListDomainsResponse x -> ListDomainsResponse)
-> Generic ListDomainsResponse
forall x. Rep ListDomainsResponse x -> ListDomainsResponse
forall x. ListDomainsResponse -> Rep ListDomainsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListDomainsResponse x -> ListDomainsResponse
$cfrom :: forall x. ListDomainsResponse -> Rep ListDomainsResponse x
Prelude.Generic)

-- |
-- Create a value of 'ListDomainsResponse' 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:
--
-- 'nextPageToken', 'listDomainsResponse_nextPageToken' - If a @NextPageToken@ was returned by a previous call, there are more
-- results available. To retrieve the next page of results, make the call
-- again using the returned token in @nextPageToken@. Keep all other
-- arguments unchanged.
--
-- The configured @maximumPageSize@ determines how many results can be
-- returned in a single call.
--
-- 'httpStatus', 'listDomainsResponse_httpStatus' - The response's http status code.
--
-- 'domainInfos', 'listDomainsResponse_domainInfos' - A list of DomainInfo structures.
newListDomainsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListDomainsResponse
newListDomainsResponse :: Int -> ListDomainsResponse
newListDomainsResponse Int
pHttpStatus_ =
  ListDomainsResponse' :: Maybe Text -> Int -> [DomainInfo] -> ListDomainsResponse
ListDomainsResponse'
    { $sel:nextPageToken:ListDomainsResponse' :: Maybe Text
nextPageToken =
        Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:ListDomainsResponse' :: Int
httpStatus = Int
pHttpStatus_,
      $sel:domainInfos:ListDomainsResponse' :: [DomainInfo]
domainInfos = [DomainInfo]
forall a. Monoid a => a
Prelude.mempty
    }

-- | If a @NextPageToken@ was returned by a previous call, there are more
-- results available. To retrieve the next page of results, make the call
-- again using the returned token in @nextPageToken@. Keep all other
-- arguments unchanged.
--
-- The configured @maximumPageSize@ determines how many results can be
-- returned in a single call.
listDomainsResponse_nextPageToken :: Lens.Lens' ListDomainsResponse (Prelude.Maybe Prelude.Text)
listDomainsResponse_nextPageToken :: (Maybe Text -> f (Maybe Text))
-> ListDomainsResponse -> f ListDomainsResponse
listDomainsResponse_nextPageToken = (ListDomainsResponse -> Maybe Text)
-> (ListDomainsResponse -> Maybe Text -> ListDomainsResponse)
-> Lens' ListDomainsResponse (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListDomainsResponse' {Maybe Text
nextPageToken :: Maybe Text
$sel:nextPageToken:ListDomainsResponse' :: ListDomainsResponse -> Maybe Text
nextPageToken} -> Maybe Text
nextPageToken) (\s :: ListDomainsResponse
s@ListDomainsResponse' {} Maybe Text
a -> ListDomainsResponse
s {$sel:nextPageToken:ListDomainsResponse' :: Maybe Text
nextPageToken = Maybe Text
a} :: ListDomainsResponse)

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

-- | A list of DomainInfo structures.
listDomainsResponse_domainInfos :: Lens.Lens' ListDomainsResponse [DomainInfo]
listDomainsResponse_domainInfos :: ([DomainInfo] -> f [DomainInfo])
-> ListDomainsResponse -> f ListDomainsResponse
listDomainsResponse_domainInfos = (ListDomainsResponse -> [DomainInfo])
-> (ListDomainsResponse -> [DomainInfo] -> ListDomainsResponse)
-> Lens' ListDomainsResponse [DomainInfo]
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListDomainsResponse' {[DomainInfo]
domainInfos :: [DomainInfo]
$sel:domainInfos:ListDomainsResponse' :: ListDomainsResponse -> [DomainInfo]
domainInfos} -> [DomainInfo]
domainInfos) (\s :: ListDomainsResponse
s@ListDomainsResponse' {} [DomainInfo]
a -> ListDomainsResponse
s {$sel:domainInfos:ListDomainsResponse' :: [DomainInfo]
domainInfos = [DomainInfo]
a} :: ListDomainsResponse) (([DomainInfo] -> f [DomainInfo])
 -> ListDomainsResponse -> f ListDomainsResponse)
-> (([DomainInfo] -> f [DomainInfo])
    -> [DomainInfo] -> f [DomainInfo])
-> ([DomainInfo] -> f [DomainInfo])
-> ListDomainsResponse
-> f ListDomainsResponse
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. ([DomainInfo] -> f [DomainInfo]) -> [DomainInfo] -> f [DomainInfo]
forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance Prelude.NFData ListDomainsResponse