{-# 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.Evidently.ListSegments
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Returns a list of audience segments that you have created in your
-- account in this Region.
--
-- This operation returns paginated results.
module Amazonka.Evidently.ListSegments
  ( -- * Creating a Request
    ListSegments (..),
    newListSegments,

    -- * Request Lenses
    listSegments_maxResults,
    listSegments_nextToken,

    -- * Destructuring the Response
    ListSegmentsResponse (..),
    newListSegmentsResponse,

    -- * Response Lenses
    listSegmentsResponse_nextToken,
    listSegmentsResponse_segments,
    listSegmentsResponse_httpStatus,
  )
where

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

-- | /See:/ 'newListSegments' smart constructor.
data ListSegments = ListSegments'
  { -- | The maximum number of results to include in the response. If you omit
    -- this, the default of 50 is used.
    ListSegments -> Maybe Natural
maxResults :: Prelude.Maybe Prelude.Natural,
    -- | The token to use when requesting the next set of results. You received
    -- this token from a previous @ListSegments@ operation.
    ListSegments -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text
  }
  deriving (ListSegments -> ListSegments -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListSegments -> ListSegments -> Bool
$c/= :: ListSegments -> ListSegments -> Bool
== :: ListSegments -> ListSegments -> Bool
$c== :: ListSegments -> ListSegments -> Bool
Prelude.Eq, ReadPrec [ListSegments]
ReadPrec ListSegments
Int -> ReadS ListSegments
ReadS [ListSegments]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListSegments]
$creadListPrec :: ReadPrec [ListSegments]
readPrec :: ReadPrec ListSegments
$creadPrec :: ReadPrec ListSegments
readList :: ReadS [ListSegments]
$creadList :: ReadS [ListSegments]
readsPrec :: Int -> ReadS ListSegments
$creadsPrec :: Int -> ReadS ListSegments
Prelude.Read, Int -> ListSegments -> ShowS
[ListSegments] -> ShowS
ListSegments -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListSegments] -> ShowS
$cshowList :: [ListSegments] -> ShowS
show :: ListSegments -> String
$cshow :: ListSegments -> String
showsPrec :: Int -> ListSegments -> ShowS
$cshowsPrec :: Int -> ListSegments -> ShowS
Prelude.Show, forall x. Rep ListSegments x -> ListSegments
forall x. ListSegments -> Rep ListSegments x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListSegments x -> ListSegments
$cfrom :: forall x. ListSegments -> Rep ListSegments x
Prelude.Generic)

-- |
-- Create a value of 'ListSegments' 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', 'listSegments_maxResults' - The maximum number of results to include in the response. If you omit
-- this, the default of 50 is used.
--
-- 'nextToken', 'listSegments_nextToken' - The token to use when requesting the next set of results. You received
-- this token from a previous @ListSegments@ operation.
newListSegments ::
  ListSegments
newListSegments :: ListSegments
newListSegments =
  ListSegments'
    { $sel:maxResults:ListSegments' :: Maybe Natural
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListSegments' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing
    }

-- | The maximum number of results to include in the response. If you omit
-- this, the default of 50 is used.
listSegments_maxResults :: Lens.Lens' ListSegments (Prelude.Maybe Prelude.Natural)
listSegments_maxResults :: Lens' ListSegments (Maybe Natural)
listSegments_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListSegments' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:ListSegments' :: ListSegments -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: ListSegments
s@ListSegments' {} Maybe Natural
a -> ListSegments
s {$sel:maxResults:ListSegments' :: Maybe Natural
maxResults = Maybe Natural
a} :: ListSegments)

-- | The token to use when requesting the next set of results. You received
-- this token from a previous @ListSegments@ operation.
listSegments_nextToken :: Lens.Lens' ListSegments (Prelude.Maybe Prelude.Text)
listSegments_nextToken :: Lens' ListSegments (Maybe Text)
listSegments_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListSegments' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListSegments' :: ListSegments -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListSegments
s@ListSegments' {} Maybe Text
a -> ListSegments
s {$sel:nextToken:ListSegments' :: Maybe Text
nextToken = Maybe Text
a} :: ListSegments)

instance Core.AWSPager ListSegments where
  page :: ListSegments -> AWSResponse ListSegments -> Maybe ListSegments
page ListSegments
rq AWSResponse ListSegments
rs
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse ListSegments
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListSegmentsResponse (Maybe Text)
listSegmentsResponse_nextToken
            forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just
        ) =
        forall a. Maybe a
Prelude.Nothing
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse ListSegments
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListSegmentsResponse (Maybe [Segment])
listSegmentsResponse_segments
            forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just
        ) =
        forall a. Maybe a
Prelude.Nothing
    | Bool
Prelude.otherwise =
        forall a. a -> Maybe a
Prelude.Just
          forall a b. (a -> b) -> a -> b
Prelude.$ ListSegments
rq
          forall a b. a -> (a -> b) -> b
Prelude.& Lens' ListSegments (Maybe Text)
listSegments_nextToken
          forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse ListSegments
rs
          forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListSegmentsResponse (Maybe Text)
listSegmentsResponse_nextToken
          forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just

instance Core.AWSRequest ListSegments where
  type AWSResponse ListSegments = ListSegmentsResponse
  request :: (Service -> Service) -> ListSegments -> Request ListSegments
request Service -> Service
overrides =
    forall a. ToRequest a => Service -> a -> Request a
Request.get (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy ListSegments
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse ListSegments)))
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 Text -> Maybe [Segment] -> Int -> ListSegmentsResponse
ListSegmentsResponse'
            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
"nextToken")
            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
"segments" 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.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable ListSegments where
  hashWithSalt :: Int -> ListSegments -> Int
hashWithSalt Int
_salt ListSegments' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:nextToken:ListSegments' :: ListSegments -> Maybe Text
$sel:maxResults:ListSegments' :: ListSegments -> 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

instance Prelude.NFData ListSegments where
  rnf :: ListSegments -> ()
rnf ListSegments' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:nextToken:ListSegments' :: ListSegments -> Maybe Text
$sel:maxResults:ListSegments' :: ListSegments -> 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

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

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

instance Data.ToQuery ListSegments where
  toQuery :: ListSegments -> QueryString
toQuery ListSegments' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:nextToken:ListSegments' :: ListSegments -> Maybe Text
$sel:maxResults:ListSegments' :: ListSegments -> Maybe Natural
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"maxResults" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Natural
maxResults,
        ByteString
"nextToken" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
nextToken
      ]

-- | /See:/ 'newListSegmentsResponse' smart constructor.
data ListSegmentsResponse = ListSegmentsResponse'
  { -- | The token to use in a subsequent @ListSegments@ operation to return the
    -- next set of results.
    ListSegmentsResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | An array of structures that contain information about the segments in
    -- this Region.
    ListSegmentsResponse -> Maybe [Segment]
segments :: Prelude.Maybe [Segment],
    -- | The response's http status code.
    ListSegmentsResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (ListSegmentsResponse -> ListSegmentsResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListSegmentsResponse -> ListSegmentsResponse -> Bool
$c/= :: ListSegmentsResponse -> ListSegmentsResponse -> Bool
== :: ListSegmentsResponse -> ListSegmentsResponse -> Bool
$c== :: ListSegmentsResponse -> ListSegmentsResponse -> Bool
Prelude.Eq, ReadPrec [ListSegmentsResponse]
ReadPrec ListSegmentsResponse
Int -> ReadS ListSegmentsResponse
ReadS [ListSegmentsResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListSegmentsResponse]
$creadListPrec :: ReadPrec [ListSegmentsResponse]
readPrec :: ReadPrec ListSegmentsResponse
$creadPrec :: ReadPrec ListSegmentsResponse
readList :: ReadS [ListSegmentsResponse]
$creadList :: ReadS [ListSegmentsResponse]
readsPrec :: Int -> ReadS ListSegmentsResponse
$creadsPrec :: Int -> ReadS ListSegmentsResponse
Prelude.Read, Int -> ListSegmentsResponse -> ShowS
[ListSegmentsResponse] -> ShowS
ListSegmentsResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListSegmentsResponse] -> ShowS
$cshowList :: [ListSegmentsResponse] -> ShowS
show :: ListSegmentsResponse -> String
$cshow :: ListSegmentsResponse -> String
showsPrec :: Int -> ListSegmentsResponse -> ShowS
$cshowsPrec :: Int -> ListSegmentsResponse -> ShowS
Prelude.Show, forall x. Rep ListSegmentsResponse x -> ListSegmentsResponse
forall x. ListSegmentsResponse -> Rep ListSegmentsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListSegmentsResponse x -> ListSegmentsResponse
$cfrom :: forall x. ListSegmentsResponse -> Rep ListSegmentsResponse x
Prelude.Generic)

-- |
-- Create a value of 'ListSegmentsResponse' 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:
--
-- 'nextToken', 'listSegmentsResponse_nextToken' - The token to use in a subsequent @ListSegments@ operation to return the
-- next set of results.
--
-- 'segments', 'listSegmentsResponse_segments' - An array of structures that contain information about the segments in
-- this Region.
--
-- 'httpStatus', 'listSegmentsResponse_httpStatus' - The response's http status code.
newListSegmentsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListSegmentsResponse
newListSegmentsResponse :: Int -> ListSegmentsResponse
newListSegmentsResponse Int
pHttpStatus_ =
  ListSegmentsResponse'
    { $sel:nextToken:ListSegmentsResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:segments:ListSegmentsResponse' :: Maybe [Segment]
segments = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:ListSegmentsResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The token to use in a subsequent @ListSegments@ operation to return the
-- next set of results.
listSegmentsResponse_nextToken :: Lens.Lens' ListSegmentsResponse (Prelude.Maybe Prelude.Text)
listSegmentsResponse_nextToken :: Lens' ListSegmentsResponse (Maybe Text)
listSegmentsResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListSegmentsResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListSegmentsResponse' :: ListSegmentsResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListSegmentsResponse
s@ListSegmentsResponse' {} Maybe Text
a -> ListSegmentsResponse
s {$sel:nextToken:ListSegmentsResponse' :: Maybe Text
nextToken = Maybe Text
a} :: ListSegmentsResponse)

-- | An array of structures that contain information about the segments in
-- this Region.
listSegmentsResponse_segments :: Lens.Lens' ListSegmentsResponse (Prelude.Maybe [Segment])
listSegmentsResponse_segments :: Lens' ListSegmentsResponse (Maybe [Segment])
listSegmentsResponse_segments = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListSegmentsResponse' {Maybe [Segment]
segments :: Maybe [Segment]
$sel:segments:ListSegmentsResponse' :: ListSegmentsResponse -> Maybe [Segment]
segments} -> Maybe [Segment]
segments) (\s :: ListSegmentsResponse
s@ListSegmentsResponse' {} Maybe [Segment]
a -> ListSegmentsResponse
s {$sel:segments:ListSegmentsResponse' :: Maybe [Segment]
segments = Maybe [Segment]
a} :: ListSegmentsResponse) 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 response's http status code.
listSegmentsResponse_httpStatus :: Lens.Lens' ListSegmentsResponse Prelude.Int
listSegmentsResponse_httpStatus :: Lens' ListSegmentsResponse Int
listSegmentsResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListSegmentsResponse' {Int
httpStatus :: Int
$sel:httpStatus:ListSegmentsResponse' :: ListSegmentsResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: ListSegmentsResponse
s@ListSegmentsResponse' {} Int
a -> ListSegmentsResponse
s {$sel:httpStatus:ListSegmentsResponse' :: Int
httpStatus = Int
a} :: ListSegmentsResponse)

instance Prelude.NFData ListSegmentsResponse where
  rnf :: ListSegmentsResponse -> ()
rnf ListSegmentsResponse' {Int
Maybe [Segment]
Maybe Text
httpStatus :: Int
segments :: Maybe [Segment]
nextToken :: Maybe Text
$sel:httpStatus:ListSegmentsResponse' :: ListSegmentsResponse -> Int
$sel:segments:ListSegmentsResponse' :: ListSegmentsResponse -> Maybe [Segment]
$sel:nextToken:ListSegmentsResponse' :: ListSegmentsResponse -> Maybe Text
..} =
    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 Maybe [Segment]
segments
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus