{-# 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.PinpointSmsVoiceV2.DescribeKeywords
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Describes the specified keywords or all keywords on your origination
-- phone number or pool.
--
-- A keyword is a word that you can search for on a particular phone number
-- or pool. It is also a specific word or phrase that an end user can send
-- to your number to elicit a response, such as an informational message or
-- a special offer. When your number receives a message that begins with a
-- keyword, Amazon Pinpoint responds with a customizable message.
--
-- If you specify a keyword that isn\'t valid, an Error is returned.
--
-- This operation returns paginated results.
module Amazonka.PinpointSmsVoiceV2.DescribeKeywords
  ( -- * Creating a Request
    DescribeKeywords (..),
    newDescribeKeywords,

    -- * Request Lenses
    describeKeywords_filters,
    describeKeywords_keywords,
    describeKeywords_maxResults,
    describeKeywords_nextToken,
    describeKeywords_originationIdentity,

    -- * Destructuring the Response
    DescribeKeywordsResponse (..),
    newDescribeKeywordsResponse,

    -- * Response Lenses
    describeKeywordsResponse_keywords,
    describeKeywordsResponse_nextToken,
    describeKeywordsResponse_originationIdentity,
    describeKeywordsResponse_originationIdentityArn,
    describeKeywordsResponse_httpStatus,
  )
where

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

-- | /See:/ 'newDescribeKeywords' smart constructor.
data DescribeKeywords = DescribeKeywords'
  { -- | An array of keyword filters to filter the results.
    DescribeKeywords -> Maybe [KeywordFilter]
filters :: Prelude.Maybe [KeywordFilter],
    -- | An array of keywords to search for.
    DescribeKeywords -> Maybe [Text]
keywords :: Prelude.Maybe [Prelude.Text],
    -- | The maximum number of results to return per each request.
    DescribeKeywords -> Maybe Natural
maxResults :: Prelude.Maybe Prelude.Natural,
    -- | The token to be used for the next set of paginated results. You don\'t
    -- need to supply a value for this field in the initial request.
    DescribeKeywords -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The origination identity to use such as a PhoneNumberId, PhoneNumberArn,
    -- SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the
    -- values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can
    -- be used to get the values for SenderId and SenderIdArn.
    DescribeKeywords -> Text
originationIdentity :: Prelude.Text
  }
  deriving (DescribeKeywords -> DescribeKeywords -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeKeywords -> DescribeKeywords -> Bool
$c/= :: DescribeKeywords -> DescribeKeywords -> Bool
== :: DescribeKeywords -> DescribeKeywords -> Bool
$c== :: DescribeKeywords -> DescribeKeywords -> Bool
Prelude.Eq, ReadPrec [DescribeKeywords]
ReadPrec DescribeKeywords
Int -> ReadS DescribeKeywords
ReadS [DescribeKeywords]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeKeywords]
$creadListPrec :: ReadPrec [DescribeKeywords]
readPrec :: ReadPrec DescribeKeywords
$creadPrec :: ReadPrec DescribeKeywords
readList :: ReadS [DescribeKeywords]
$creadList :: ReadS [DescribeKeywords]
readsPrec :: Int -> ReadS DescribeKeywords
$creadsPrec :: Int -> ReadS DescribeKeywords
Prelude.Read, Int -> DescribeKeywords -> ShowS
[DescribeKeywords] -> ShowS
DescribeKeywords -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeKeywords] -> ShowS
$cshowList :: [DescribeKeywords] -> ShowS
show :: DescribeKeywords -> String
$cshow :: DescribeKeywords -> String
showsPrec :: Int -> DescribeKeywords -> ShowS
$cshowsPrec :: Int -> DescribeKeywords -> ShowS
Prelude.Show, forall x. Rep DescribeKeywords x -> DescribeKeywords
forall x. DescribeKeywords -> Rep DescribeKeywords x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeKeywords x -> DescribeKeywords
$cfrom :: forall x. DescribeKeywords -> Rep DescribeKeywords x
Prelude.Generic)

-- |
-- Create a value of 'DescribeKeywords' 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:
--
-- 'filters', 'describeKeywords_filters' - An array of keyword filters to filter the results.
--
-- 'keywords', 'describeKeywords_keywords' - An array of keywords to search for.
--
-- 'maxResults', 'describeKeywords_maxResults' - The maximum number of results to return per each request.
--
-- 'nextToken', 'describeKeywords_nextToken' - The token to be used for the next set of paginated results. You don\'t
-- need to supply a value for this field in the initial request.
--
-- 'originationIdentity', 'describeKeywords_originationIdentity' - The origination identity to use such as a PhoneNumberId, PhoneNumberArn,
-- SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the
-- values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can
-- be used to get the values for SenderId and SenderIdArn.
newDescribeKeywords ::
  -- | 'originationIdentity'
  Prelude.Text ->
  DescribeKeywords
newDescribeKeywords :: Text -> DescribeKeywords
newDescribeKeywords Text
pOriginationIdentity_ =
  DescribeKeywords'
    { $sel:filters:DescribeKeywords' :: Maybe [KeywordFilter]
filters = forall a. Maybe a
Prelude.Nothing,
      $sel:keywords:DescribeKeywords' :: Maybe [Text]
keywords = forall a. Maybe a
Prelude.Nothing,
      $sel:maxResults:DescribeKeywords' :: Maybe Natural
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:DescribeKeywords' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:originationIdentity:DescribeKeywords' :: Text
originationIdentity = Text
pOriginationIdentity_
    }

-- | An array of keyword filters to filter the results.
describeKeywords_filters :: Lens.Lens' DescribeKeywords (Prelude.Maybe [KeywordFilter])
describeKeywords_filters :: Lens' DescribeKeywords (Maybe [KeywordFilter])
describeKeywords_filters = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeKeywords' {Maybe [KeywordFilter]
filters :: Maybe [KeywordFilter]
$sel:filters:DescribeKeywords' :: DescribeKeywords -> Maybe [KeywordFilter]
filters} -> Maybe [KeywordFilter]
filters) (\s :: DescribeKeywords
s@DescribeKeywords' {} Maybe [KeywordFilter]
a -> DescribeKeywords
s {$sel:filters:DescribeKeywords' :: Maybe [KeywordFilter]
filters = Maybe [KeywordFilter]
a} :: DescribeKeywords) 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

-- | An array of keywords to search for.
describeKeywords_keywords :: Lens.Lens' DescribeKeywords (Prelude.Maybe [Prelude.Text])
describeKeywords_keywords :: Lens' DescribeKeywords (Maybe [Text])
describeKeywords_keywords = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeKeywords' {Maybe [Text]
keywords :: Maybe [Text]
$sel:keywords:DescribeKeywords' :: DescribeKeywords -> Maybe [Text]
keywords} -> Maybe [Text]
keywords) (\s :: DescribeKeywords
s@DescribeKeywords' {} Maybe [Text]
a -> DescribeKeywords
s {$sel:keywords:DescribeKeywords' :: Maybe [Text]
keywords = Maybe [Text]
a} :: DescribeKeywords) 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 maximum number of results to return per each request.
describeKeywords_maxResults :: Lens.Lens' DescribeKeywords (Prelude.Maybe Prelude.Natural)
describeKeywords_maxResults :: Lens' DescribeKeywords (Maybe Natural)
describeKeywords_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeKeywords' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:DescribeKeywords' :: DescribeKeywords -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: DescribeKeywords
s@DescribeKeywords' {} Maybe Natural
a -> DescribeKeywords
s {$sel:maxResults:DescribeKeywords' :: Maybe Natural
maxResults = Maybe Natural
a} :: DescribeKeywords)

-- | The token to be used for the next set of paginated results. You don\'t
-- need to supply a value for this field in the initial request.
describeKeywords_nextToken :: Lens.Lens' DescribeKeywords (Prelude.Maybe Prelude.Text)
describeKeywords_nextToken :: Lens' DescribeKeywords (Maybe Text)
describeKeywords_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeKeywords' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:DescribeKeywords' :: DescribeKeywords -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: DescribeKeywords
s@DescribeKeywords' {} Maybe Text
a -> DescribeKeywords
s {$sel:nextToken:DescribeKeywords' :: Maybe Text
nextToken = Maybe Text
a} :: DescribeKeywords)

-- | The origination identity to use such as a PhoneNumberId, PhoneNumberArn,
-- SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the
-- values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can
-- be used to get the values for SenderId and SenderIdArn.
describeKeywords_originationIdentity :: Lens.Lens' DescribeKeywords Prelude.Text
describeKeywords_originationIdentity :: Lens' DescribeKeywords Text
describeKeywords_originationIdentity = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeKeywords' {Text
originationIdentity :: Text
$sel:originationIdentity:DescribeKeywords' :: DescribeKeywords -> Text
originationIdentity} -> Text
originationIdentity) (\s :: DescribeKeywords
s@DescribeKeywords' {} Text
a -> DescribeKeywords
s {$sel:originationIdentity:DescribeKeywords' :: Text
originationIdentity = Text
a} :: DescribeKeywords)

instance Core.AWSPager DescribeKeywords where
  page :: DescribeKeywords
-> AWSResponse DescribeKeywords -> Maybe DescribeKeywords
page DescribeKeywords
rq AWSResponse DescribeKeywords
rs
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse DescribeKeywords
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' DescribeKeywordsResponse (Maybe Text)
describeKeywordsResponse_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 DescribeKeywords
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' DescribeKeywordsResponse (Maybe [KeywordInformation])
describeKeywordsResponse_keywords
            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.$ DescribeKeywords
rq
          forall a b. a -> (a -> b) -> b
Prelude.& Lens' DescribeKeywords (Maybe Text)
describeKeywords_nextToken
          forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse DescribeKeywords
rs
          forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' DescribeKeywordsResponse (Maybe Text)
describeKeywordsResponse_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 DescribeKeywords where
  type
    AWSResponse DescribeKeywords =
      DescribeKeywordsResponse
  request :: (Service -> Service)
-> DescribeKeywords -> Request DescribeKeywords
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 DescribeKeywords
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse DescribeKeywords)))
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 [KeywordInformation]
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Int
-> DescribeKeywordsResponse
DescribeKeywordsResponse'
            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
"Keywords" 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.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"OriginationIdentity")
            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
"OriginationIdentityArn")
            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 DescribeKeywords where
  hashWithSalt :: Int -> DescribeKeywords -> Int
hashWithSalt Int
_salt DescribeKeywords' {Maybe Natural
Maybe [Text]
Maybe [KeywordFilter]
Maybe Text
Text
originationIdentity :: Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
keywords :: Maybe [Text]
filters :: Maybe [KeywordFilter]
$sel:originationIdentity:DescribeKeywords' :: DescribeKeywords -> Text
$sel:nextToken:DescribeKeywords' :: DescribeKeywords -> Maybe Text
$sel:maxResults:DescribeKeywords' :: DescribeKeywords -> Maybe Natural
$sel:keywords:DescribeKeywords' :: DescribeKeywords -> Maybe [Text]
$sel:filters:DescribeKeywords' :: DescribeKeywords -> Maybe [KeywordFilter]
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [KeywordFilter]
filters
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Text]
keywords
      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
originationIdentity

instance Prelude.NFData DescribeKeywords where
  rnf :: DescribeKeywords -> ()
rnf DescribeKeywords' {Maybe Natural
Maybe [Text]
Maybe [KeywordFilter]
Maybe Text
Text
originationIdentity :: Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
keywords :: Maybe [Text]
filters :: Maybe [KeywordFilter]
$sel:originationIdentity:DescribeKeywords' :: DescribeKeywords -> Text
$sel:nextToken:DescribeKeywords' :: DescribeKeywords -> Maybe Text
$sel:maxResults:DescribeKeywords' :: DescribeKeywords -> Maybe Natural
$sel:keywords:DescribeKeywords' :: DescribeKeywords -> Maybe [Text]
$sel:filters:DescribeKeywords' :: DescribeKeywords -> Maybe [KeywordFilter]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [KeywordFilter]
filters
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Text]
keywords
      seq :: forall a b. a -> b -> b
`Prelude.seq` 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
originationIdentity

instance Data.ToHeaders DescribeKeywords where
  toHeaders :: DescribeKeywords -> 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
"PinpointSMSVoiceV2.DescribeKeywords" ::
                          Prelude.ByteString
                      ),
            HeaderName
"Content-Type"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"application/x-amz-json-1.0" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToJSON DescribeKeywords where
  toJSON :: DescribeKeywords -> Value
toJSON DescribeKeywords' {Maybe Natural
Maybe [Text]
Maybe [KeywordFilter]
Maybe Text
Text
originationIdentity :: Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
keywords :: Maybe [Text]
filters :: Maybe [KeywordFilter]
$sel:originationIdentity:DescribeKeywords' :: DescribeKeywords -> Text
$sel:nextToken:DescribeKeywords' :: DescribeKeywords -> Maybe Text
$sel:maxResults:DescribeKeywords' :: DescribeKeywords -> Maybe Natural
$sel:keywords:DescribeKeywords' :: DescribeKeywords -> Maybe [Text]
$sel:filters:DescribeKeywords' :: DescribeKeywords -> Maybe [KeywordFilter]
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"Filters" 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 [KeywordFilter]
filters,
            (Key
"Keywords" 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]
keywords,
            (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
"OriginationIdentity" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
originationIdentity)
          ]
      )

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

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

-- | /See:/ 'newDescribeKeywordsResponse' smart constructor.
data DescribeKeywordsResponse = DescribeKeywordsResponse'
  { -- | An array of KeywordInformation objects that contain the results.
    DescribeKeywordsResponse -> Maybe [KeywordInformation]
keywords :: Prelude.Maybe [KeywordInformation],
    -- | The token to be used for the next set of paginated results. If this
    -- field is empty then there are no more results.
    DescribeKeywordsResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The PhoneNumberId or PoolId that is associated with the
    -- OriginationIdentity.
    DescribeKeywordsResponse -> Maybe Text
originationIdentity :: Prelude.Maybe Prelude.Text,
    -- | The PhoneNumberArn or PoolArn that is associated with the
    -- OriginationIdentity.
    DescribeKeywordsResponse -> Maybe Text
originationIdentityArn :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    DescribeKeywordsResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (DescribeKeywordsResponse -> DescribeKeywordsResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeKeywordsResponse -> DescribeKeywordsResponse -> Bool
$c/= :: DescribeKeywordsResponse -> DescribeKeywordsResponse -> Bool
== :: DescribeKeywordsResponse -> DescribeKeywordsResponse -> Bool
$c== :: DescribeKeywordsResponse -> DescribeKeywordsResponse -> Bool
Prelude.Eq, ReadPrec [DescribeKeywordsResponse]
ReadPrec DescribeKeywordsResponse
Int -> ReadS DescribeKeywordsResponse
ReadS [DescribeKeywordsResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeKeywordsResponse]
$creadListPrec :: ReadPrec [DescribeKeywordsResponse]
readPrec :: ReadPrec DescribeKeywordsResponse
$creadPrec :: ReadPrec DescribeKeywordsResponse
readList :: ReadS [DescribeKeywordsResponse]
$creadList :: ReadS [DescribeKeywordsResponse]
readsPrec :: Int -> ReadS DescribeKeywordsResponse
$creadsPrec :: Int -> ReadS DescribeKeywordsResponse
Prelude.Read, Int -> DescribeKeywordsResponse -> ShowS
[DescribeKeywordsResponse] -> ShowS
DescribeKeywordsResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeKeywordsResponse] -> ShowS
$cshowList :: [DescribeKeywordsResponse] -> ShowS
show :: DescribeKeywordsResponse -> String
$cshow :: DescribeKeywordsResponse -> String
showsPrec :: Int -> DescribeKeywordsResponse -> ShowS
$cshowsPrec :: Int -> DescribeKeywordsResponse -> ShowS
Prelude.Show, forall x.
Rep DescribeKeywordsResponse x -> DescribeKeywordsResponse
forall x.
DescribeKeywordsResponse -> Rep DescribeKeywordsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep DescribeKeywordsResponse x -> DescribeKeywordsResponse
$cfrom :: forall x.
DescribeKeywordsResponse -> Rep DescribeKeywordsResponse x
Prelude.Generic)

-- |
-- Create a value of 'DescribeKeywordsResponse' 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:
--
-- 'keywords', 'describeKeywordsResponse_keywords' - An array of KeywordInformation objects that contain the results.
--
-- 'nextToken', 'describeKeywordsResponse_nextToken' - The token to be used for the next set of paginated results. If this
-- field is empty then there are no more results.
--
-- 'originationIdentity', 'describeKeywordsResponse_originationIdentity' - The PhoneNumberId or PoolId that is associated with the
-- OriginationIdentity.
--
-- 'originationIdentityArn', 'describeKeywordsResponse_originationIdentityArn' - The PhoneNumberArn or PoolArn that is associated with the
-- OriginationIdentity.
--
-- 'httpStatus', 'describeKeywordsResponse_httpStatus' - The response's http status code.
newDescribeKeywordsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DescribeKeywordsResponse
newDescribeKeywordsResponse :: Int -> DescribeKeywordsResponse
newDescribeKeywordsResponse Int
pHttpStatus_ =
  DescribeKeywordsResponse'
    { $sel:keywords:DescribeKeywordsResponse' :: Maybe [KeywordInformation]
keywords =
        forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:DescribeKeywordsResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:originationIdentity:DescribeKeywordsResponse' :: Maybe Text
originationIdentity = forall a. Maybe a
Prelude.Nothing,
      $sel:originationIdentityArn:DescribeKeywordsResponse' :: Maybe Text
originationIdentityArn = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:DescribeKeywordsResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | An array of KeywordInformation objects that contain the results.
describeKeywordsResponse_keywords :: Lens.Lens' DescribeKeywordsResponse (Prelude.Maybe [KeywordInformation])
describeKeywordsResponse_keywords :: Lens' DescribeKeywordsResponse (Maybe [KeywordInformation])
describeKeywordsResponse_keywords = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeKeywordsResponse' {Maybe [KeywordInformation]
keywords :: Maybe [KeywordInformation]
$sel:keywords:DescribeKeywordsResponse' :: DescribeKeywordsResponse -> Maybe [KeywordInformation]
keywords} -> Maybe [KeywordInformation]
keywords) (\s :: DescribeKeywordsResponse
s@DescribeKeywordsResponse' {} Maybe [KeywordInformation]
a -> DescribeKeywordsResponse
s {$sel:keywords:DescribeKeywordsResponse' :: Maybe [KeywordInformation]
keywords = Maybe [KeywordInformation]
a} :: DescribeKeywordsResponse) 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 be used for the next set of paginated results. If this
-- field is empty then there are no more results.
describeKeywordsResponse_nextToken :: Lens.Lens' DescribeKeywordsResponse (Prelude.Maybe Prelude.Text)
describeKeywordsResponse_nextToken :: Lens' DescribeKeywordsResponse (Maybe Text)
describeKeywordsResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeKeywordsResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:DescribeKeywordsResponse' :: DescribeKeywordsResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: DescribeKeywordsResponse
s@DescribeKeywordsResponse' {} Maybe Text
a -> DescribeKeywordsResponse
s {$sel:nextToken:DescribeKeywordsResponse' :: Maybe Text
nextToken = Maybe Text
a} :: DescribeKeywordsResponse)

-- | The PhoneNumberId or PoolId that is associated with the
-- OriginationIdentity.
describeKeywordsResponse_originationIdentity :: Lens.Lens' DescribeKeywordsResponse (Prelude.Maybe Prelude.Text)
describeKeywordsResponse_originationIdentity :: Lens' DescribeKeywordsResponse (Maybe Text)
describeKeywordsResponse_originationIdentity = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeKeywordsResponse' {Maybe Text
originationIdentity :: Maybe Text
$sel:originationIdentity:DescribeKeywordsResponse' :: DescribeKeywordsResponse -> Maybe Text
originationIdentity} -> Maybe Text
originationIdentity) (\s :: DescribeKeywordsResponse
s@DescribeKeywordsResponse' {} Maybe Text
a -> DescribeKeywordsResponse
s {$sel:originationIdentity:DescribeKeywordsResponse' :: Maybe Text
originationIdentity = Maybe Text
a} :: DescribeKeywordsResponse)

-- | The PhoneNumberArn or PoolArn that is associated with the
-- OriginationIdentity.
describeKeywordsResponse_originationIdentityArn :: Lens.Lens' DescribeKeywordsResponse (Prelude.Maybe Prelude.Text)
describeKeywordsResponse_originationIdentityArn :: Lens' DescribeKeywordsResponse (Maybe Text)
describeKeywordsResponse_originationIdentityArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeKeywordsResponse' {Maybe Text
originationIdentityArn :: Maybe Text
$sel:originationIdentityArn:DescribeKeywordsResponse' :: DescribeKeywordsResponse -> Maybe Text
originationIdentityArn} -> Maybe Text
originationIdentityArn) (\s :: DescribeKeywordsResponse
s@DescribeKeywordsResponse' {} Maybe Text
a -> DescribeKeywordsResponse
s {$sel:originationIdentityArn:DescribeKeywordsResponse' :: Maybe Text
originationIdentityArn = Maybe Text
a} :: DescribeKeywordsResponse)

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

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