{-# 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.FraudDetector.GetLabels
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Gets all labels or a specific label if name is provided. This is a
-- paginated API. If you provide a null @maxResults@, this action retrieves
-- a maximum of 50 records per page. If you provide a @maxResults@, the
-- value must be between 10 and 50. To get the next page results, provide
-- the pagination token from the @GetGetLabelsResponse@ as part of your
-- request. A null pagination token fetches the records from the beginning.
module Amazonka.FraudDetector.GetLabels
  ( -- * Creating a Request
    GetLabels (..),
    newGetLabels,

    -- * Request Lenses
    getLabels_maxResults,
    getLabels_name,
    getLabels_nextToken,

    -- * Destructuring the Response
    GetLabelsResponse (..),
    newGetLabelsResponse,

    -- * Response Lenses
    getLabelsResponse_labels,
    getLabelsResponse_nextToken,
    getLabelsResponse_httpStatus,
  )
where

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

-- | /See:/ 'newGetLabels' smart constructor.
data GetLabels = GetLabels'
  { -- | The maximum number of objects to return for the request.
    GetLabels -> Maybe Natural
maxResults :: Prelude.Maybe Prelude.Natural,
    -- | The name of the label or labels to get.
    GetLabels -> Maybe Text
name :: Prelude.Maybe Prelude.Text,
    -- | The next token for the subsequent request.
    GetLabels -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text
  }
  deriving (GetLabels -> GetLabels -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetLabels -> GetLabels -> Bool
$c/= :: GetLabels -> GetLabels -> Bool
== :: GetLabels -> GetLabels -> Bool
$c== :: GetLabels -> GetLabels -> Bool
Prelude.Eq, ReadPrec [GetLabels]
ReadPrec GetLabels
Int -> ReadS GetLabels
ReadS [GetLabels]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GetLabels]
$creadListPrec :: ReadPrec [GetLabels]
readPrec :: ReadPrec GetLabels
$creadPrec :: ReadPrec GetLabels
readList :: ReadS [GetLabels]
$creadList :: ReadS [GetLabels]
readsPrec :: Int -> ReadS GetLabels
$creadsPrec :: Int -> ReadS GetLabels
Prelude.Read, Int -> GetLabels -> ShowS
[GetLabels] -> ShowS
GetLabels -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetLabels] -> ShowS
$cshowList :: [GetLabels] -> ShowS
show :: GetLabels -> String
$cshow :: GetLabels -> String
showsPrec :: Int -> GetLabels -> ShowS
$cshowsPrec :: Int -> GetLabels -> ShowS
Prelude.Show, forall x. Rep GetLabels x -> GetLabels
forall x. GetLabels -> Rep GetLabels x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep GetLabels x -> GetLabels
$cfrom :: forall x. GetLabels -> Rep GetLabels x
Prelude.Generic)

-- |
-- Create a value of 'GetLabels' 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', 'getLabels_maxResults' - The maximum number of objects to return for the request.
--
-- 'name', 'getLabels_name' - The name of the label or labels to get.
--
-- 'nextToken', 'getLabels_nextToken' - The next token for the subsequent request.
newGetLabels ::
  GetLabels
newGetLabels :: GetLabels
newGetLabels =
  GetLabels'
    { $sel:maxResults:GetLabels' :: Maybe Natural
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:name:GetLabels' :: Maybe Text
name = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:GetLabels' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing
    }

-- | The maximum number of objects to return for the request.
getLabels_maxResults :: Lens.Lens' GetLabels (Prelude.Maybe Prelude.Natural)
getLabels_maxResults :: Lens' GetLabels (Maybe Natural)
getLabels_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetLabels' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:GetLabels' :: GetLabels -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: GetLabels
s@GetLabels' {} Maybe Natural
a -> GetLabels
s {$sel:maxResults:GetLabels' :: Maybe Natural
maxResults = Maybe Natural
a} :: GetLabels)

-- | The name of the label or labels to get.
getLabels_name :: Lens.Lens' GetLabels (Prelude.Maybe Prelude.Text)
getLabels_name :: Lens' GetLabels (Maybe Text)
getLabels_name = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetLabels' {Maybe Text
name :: Maybe Text
$sel:name:GetLabels' :: GetLabels -> Maybe Text
name} -> Maybe Text
name) (\s :: GetLabels
s@GetLabels' {} Maybe Text
a -> GetLabels
s {$sel:name:GetLabels' :: Maybe Text
name = Maybe Text
a} :: GetLabels)

-- | The next token for the subsequent request.
getLabels_nextToken :: Lens.Lens' GetLabels (Prelude.Maybe Prelude.Text)
getLabels_nextToken :: Lens' GetLabels (Maybe Text)
getLabels_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetLabels' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:GetLabels' :: GetLabels -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: GetLabels
s@GetLabels' {} Maybe Text
a -> GetLabels
s {$sel:nextToken:GetLabels' :: Maybe Text
nextToken = Maybe Text
a} :: GetLabels)

instance Core.AWSRequest GetLabels where
  type AWSResponse GetLabels = GetLabelsResponse
  request :: (Service -> Service) -> GetLabels -> Request GetLabels
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 GetLabels
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse GetLabels)))
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 [Label] -> Maybe Text -> Int -> GetLabelsResponse
GetLabelsResponse'
            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
"labels" 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 GetLabels where
  hashWithSalt :: Int -> GetLabels -> Int
hashWithSalt Int
_salt GetLabels' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
name :: Maybe Text
maxResults :: Maybe Natural
$sel:nextToken:GetLabels' :: GetLabels -> Maybe Text
$sel:name:GetLabels' :: GetLabels -> Maybe Text
$sel:maxResults:GetLabels' :: GetLabels -> 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
name
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
nextToken

instance Prelude.NFData GetLabels where
  rnf :: GetLabels -> ()
rnf GetLabels' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
name :: Maybe Text
maxResults :: Maybe Natural
$sel:nextToken:GetLabels' :: GetLabels -> Maybe Text
$sel:name:GetLabels' :: GetLabels -> Maybe Text
$sel:maxResults:GetLabels' :: GetLabels -> 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
name
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
nextToken

instance Data.ToHeaders GetLabels where
  toHeaders :: GetLabels -> 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
"AWSHawksNestServiceFacade.GetLabels" ::
                          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 GetLabels where
  toJSON :: GetLabels -> Value
toJSON GetLabels' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
name :: Maybe Text
maxResults :: Maybe Natural
$sel:nextToken:GetLabels' :: GetLabels -> Maybe Text
$sel:name:GetLabels' :: GetLabels -> Maybe Text
$sel:maxResults:GetLabels' :: GetLabels -> 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
"name" 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
name,
            (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
          ]
      )

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

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

-- | /See:/ 'newGetLabelsResponse' smart constructor.
data GetLabelsResponse = GetLabelsResponse'
  { -- | An array of labels.
    GetLabelsResponse -> Maybe [Label]
labels :: Prelude.Maybe [Label],
    -- | The next page token.
    GetLabelsResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    GetLabelsResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (GetLabelsResponse -> GetLabelsResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetLabelsResponse -> GetLabelsResponse -> Bool
$c/= :: GetLabelsResponse -> GetLabelsResponse -> Bool
== :: GetLabelsResponse -> GetLabelsResponse -> Bool
$c== :: GetLabelsResponse -> GetLabelsResponse -> Bool
Prelude.Eq, ReadPrec [GetLabelsResponse]
ReadPrec GetLabelsResponse
Int -> ReadS GetLabelsResponse
ReadS [GetLabelsResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GetLabelsResponse]
$creadListPrec :: ReadPrec [GetLabelsResponse]
readPrec :: ReadPrec GetLabelsResponse
$creadPrec :: ReadPrec GetLabelsResponse
readList :: ReadS [GetLabelsResponse]
$creadList :: ReadS [GetLabelsResponse]
readsPrec :: Int -> ReadS GetLabelsResponse
$creadsPrec :: Int -> ReadS GetLabelsResponse
Prelude.Read, Int -> GetLabelsResponse -> ShowS
[GetLabelsResponse] -> ShowS
GetLabelsResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetLabelsResponse] -> ShowS
$cshowList :: [GetLabelsResponse] -> ShowS
show :: GetLabelsResponse -> String
$cshow :: GetLabelsResponse -> String
showsPrec :: Int -> GetLabelsResponse -> ShowS
$cshowsPrec :: Int -> GetLabelsResponse -> ShowS
Prelude.Show, forall x. Rep GetLabelsResponse x -> GetLabelsResponse
forall x. GetLabelsResponse -> Rep GetLabelsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep GetLabelsResponse x -> GetLabelsResponse
$cfrom :: forall x. GetLabelsResponse -> Rep GetLabelsResponse x
Prelude.Generic)

-- |
-- Create a value of 'GetLabelsResponse' 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:
--
-- 'labels', 'getLabelsResponse_labels' - An array of labels.
--
-- 'nextToken', 'getLabelsResponse_nextToken' - The next page token.
--
-- 'httpStatus', 'getLabelsResponse_httpStatus' - The response's http status code.
newGetLabelsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  GetLabelsResponse
newGetLabelsResponse :: Int -> GetLabelsResponse
newGetLabelsResponse Int
pHttpStatus_ =
  GetLabelsResponse'
    { $sel:labels:GetLabelsResponse' :: Maybe [Label]
labels = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:GetLabelsResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:GetLabelsResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | An array of labels.
getLabelsResponse_labels :: Lens.Lens' GetLabelsResponse (Prelude.Maybe [Label])
getLabelsResponse_labels :: Lens' GetLabelsResponse (Maybe [Label])
getLabelsResponse_labels = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetLabelsResponse' {Maybe [Label]
labels :: Maybe [Label]
$sel:labels:GetLabelsResponse' :: GetLabelsResponse -> Maybe [Label]
labels} -> Maybe [Label]
labels) (\s :: GetLabelsResponse
s@GetLabelsResponse' {} Maybe [Label]
a -> GetLabelsResponse
s {$sel:labels:GetLabelsResponse' :: Maybe [Label]
labels = Maybe [Label]
a} :: GetLabelsResponse) 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 next page token.
getLabelsResponse_nextToken :: Lens.Lens' GetLabelsResponse (Prelude.Maybe Prelude.Text)
getLabelsResponse_nextToken :: Lens' GetLabelsResponse (Maybe Text)
getLabelsResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetLabelsResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:GetLabelsResponse' :: GetLabelsResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: GetLabelsResponse
s@GetLabelsResponse' {} Maybe Text
a -> GetLabelsResponse
s {$sel:nextToken:GetLabelsResponse' :: Maybe Text
nextToken = Maybe Text
a} :: GetLabelsResponse)

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

instance Prelude.NFData GetLabelsResponse where
  rnf :: GetLabelsResponse -> ()
rnf GetLabelsResponse' {Int
Maybe [Label]
Maybe Text
httpStatus :: Int
nextToken :: Maybe Text
labels :: Maybe [Label]
$sel:httpStatus:GetLabelsResponse' :: GetLabelsResponse -> Int
$sel:nextToken:GetLabelsResponse' :: GetLabelsResponse -> Maybe Text
$sel:labels:GetLabelsResponse' :: GetLabelsResponse -> Maybe [Label]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [Label]
labels
      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