{-# 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.LexModels.GetIntents
-- 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 intent information as follows:
--
-- -   If you specify the @nameContains@ field, returns the @$LATEST@
--     version of all intents that contain the specified string.
--
-- -   If you don\'t specify the @nameContains@ field, returns information
--     about the @$LATEST@ version of all intents.
--
-- The operation requires permission for the @lex:GetIntents@ action.
--
-- This operation returns paginated results.
module Amazonka.LexModels.GetIntents
  ( -- * Creating a Request
    GetIntents (..),
    newGetIntents,

    -- * Request Lenses
    getIntents_maxResults,
    getIntents_nameContains,
    getIntents_nextToken,

    -- * Destructuring the Response
    GetIntentsResponse (..),
    newGetIntentsResponse,

    -- * Response Lenses
    getIntentsResponse_intents,
    getIntentsResponse_nextToken,
    getIntentsResponse_httpStatus,
  )
where

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

-- | /See:/ 'newGetIntents' smart constructor.
data GetIntents = GetIntents'
  { -- | The maximum number of intents to return in the response. The default is
    -- 10.
    GetIntents -> Maybe Natural
maxResults :: Prelude.Maybe Prelude.Natural,
    -- | Substring to match in intent names. An intent will be returned if any
    -- part of its name matches the substring. For example, \"xyz\" matches
    -- both \"xyzabc\" and \"abcxyz.\"
    GetIntents -> Maybe Text
nameContains :: Prelude.Maybe Prelude.Text,
    -- | A pagination token that fetches the next page of intents. If the
    -- response to this API call is truncated, Amazon Lex returns a pagination
    -- token in the response. To fetch the next page of intents, specify the
    -- pagination token in the next request.
    GetIntents -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text
  }
  deriving (GetIntents -> GetIntents -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetIntents -> GetIntents -> Bool
$c/= :: GetIntents -> GetIntents -> Bool
== :: GetIntents -> GetIntents -> Bool
$c== :: GetIntents -> GetIntents -> Bool
Prelude.Eq, ReadPrec [GetIntents]
ReadPrec GetIntents
Int -> ReadS GetIntents
ReadS [GetIntents]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GetIntents]
$creadListPrec :: ReadPrec [GetIntents]
readPrec :: ReadPrec GetIntents
$creadPrec :: ReadPrec GetIntents
readList :: ReadS [GetIntents]
$creadList :: ReadS [GetIntents]
readsPrec :: Int -> ReadS GetIntents
$creadsPrec :: Int -> ReadS GetIntents
Prelude.Read, Int -> GetIntents -> ShowS
[GetIntents] -> ShowS
GetIntents -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetIntents] -> ShowS
$cshowList :: [GetIntents] -> ShowS
show :: GetIntents -> String
$cshow :: GetIntents -> String
showsPrec :: Int -> GetIntents -> ShowS
$cshowsPrec :: Int -> GetIntents -> ShowS
Prelude.Show, forall x. Rep GetIntents x -> GetIntents
forall x. GetIntents -> Rep GetIntents x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep GetIntents x -> GetIntents
$cfrom :: forall x. GetIntents -> Rep GetIntents x
Prelude.Generic)

-- |
-- Create a value of 'GetIntents' 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', 'getIntents_maxResults' - The maximum number of intents to return in the response. The default is
-- 10.
--
-- 'nameContains', 'getIntents_nameContains' - Substring to match in intent names. An intent will be returned if any
-- part of its name matches the substring. For example, \"xyz\" matches
-- both \"xyzabc\" and \"abcxyz.\"
--
-- 'nextToken', 'getIntents_nextToken' - A pagination token that fetches the next page of intents. If the
-- response to this API call is truncated, Amazon Lex returns a pagination
-- token in the response. To fetch the next page of intents, specify the
-- pagination token in the next request.
newGetIntents ::
  GetIntents
newGetIntents :: GetIntents
newGetIntents =
  GetIntents'
    { $sel:maxResults:GetIntents' :: Maybe Natural
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nameContains:GetIntents' :: Maybe Text
nameContains = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:GetIntents' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing
    }

-- | The maximum number of intents to return in the response. The default is
-- 10.
getIntents_maxResults :: Lens.Lens' GetIntents (Prelude.Maybe Prelude.Natural)
getIntents_maxResults :: Lens' GetIntents (Maybe Natural)
getIntents_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetIntents' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:GetIntents' :: GetIntents -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: GetIntents
s@GetIntents' {} Maybe Natural
a -> GetIntents
s {$sel:maxResults:GetIntents' :: Maybe Natural
maxResults = Maybe Natural
a} :: GetIntents)

-- | Substring to match in intent names. An intent will be returned if any
-- part of its name matches the substring. For example, \"xyz\" matches
-- both \"xyzabc\" and \"abcxyz.\"
getIntents_nameContains :: Lens.Lens' GetIntents (Prelude.Maybe Prelude.Text)
getIntents_nameContains :: Lens' GetIntents (Maybe Text)
getIntents_nameContains = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetIntents' {Maybe Text
nameContains :: Maybe Text
$sel:nameContains:GetIntents' :: GetIntents -> Maybe Text
nameContains} -> Maybe Text
nameContains) (\s :: GetIntents
s@GetIntents' {} Maybe Text
a -> GetIntents
s {$sel:nameContains:GetIntents' :: Maybe Text
nameContains = Maybe Text
a} :: GetIntents)

-- | A pagination token that fetches the next page of intents. If the
-- response to this API call is truncated, Amazon Lex returns a pagination
-- token in the response. To fetch the next page of intents, specify the
-- pagination token in the next request.
getIntents_nextToken :: Lens.Lens' GetIntents (Prelude.Maybe Prelude.Text)
getIntents_nextToken :: Lens' GetIntents (Maybe Text)
getIntents_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetIntents' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:GetIntents' :: GetIntents -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: GetIntents
s@GetIntents' {} Maybe Text
a -> GetIntents
s {$sel:nextToken:GetIntents' :: Maybe Text
nextToken = Maybe Text
a} :: GetIntents)

instance Core.AWSPager GetIntents where
  page :: GetIntents -> AWSResponse GetIntents -> Maybe GetIntents
page GetIntents
rq AWSResponse GetIntents
rs
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse GetIntents
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' GetIntentsResponse (Maybe Text)
getIntentsResponse_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 GetIntents
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' GetIntentsResponse (Maybe [IntentMetadata])
getIntentsResponse_intents
            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.$ GetIntents
rq
          forall a b. a -> (a -> b) -> b
Prelude.& Lens' GetIntents (Maybe Text)
getIntents_nextToken
          forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse GetIntents
rs
          forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' GetIntentsResponse (Maybe Text)
getIntentsResponse_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 GetIntents where
  type AWSResponse GetIntents = GetIntentsResponse
  request :: (Service -> Service) -> GetIntents -> Request GetIntents
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 GetIntents
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse GetIntents)))
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 [IntentMetadata] -> Maybe Text -> Int -> GetIntentsResponse
GetIntentsResponse'
            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
"intents" 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 GetIntents where
  hashWithSalt :: Int -> GetIntents -> Int
hashWithSalt Int
_salt GetIntents' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
nameContains :: Maybe Text
maxResults :: Maybe Natural
$sel:nextToken:GetIntents' :: GetIntents -> Maybe Text
$sel:nameContains:GetIntents' :: GetIntents -> Maybe Text
$sel:maxResults:GetIntents' :: GetIntents -> 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
nameContains
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
nextToken

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

instance Data.ToHeaders GetIntents where
  toHeaders :: GetIntents -> 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 GetIntents where
  toPath :: GetIntents -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/intents/"

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

-- | /See:/ 'newGetIntentsResponse' smart constructor.
data GetIntentsResponse = GetIntentsResponse'
  { -- | An array of @Intent@ objects. For more information, see PutBot.
    GetIntentsResponse -> Maybe [IntentMetadata]
intents :: Prelude.Maybe [IntentMetadata],
    -- | If the response is truncated, the response includes a pagination token
    -- that you can specify in your next request to fetch the next page of
    -- intents.
    GetIntentsResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    GetIntentsResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (GetIntentsResponse -> GetIntentsResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetIntentsResponse -> GetIntentsResponse -> Bool
$c/= :: GetIntentsResponse -> GetIntentsResponse -> Bool
== :: GetIntentsResponse -> GetIntentsResponse -> Bool
$c== :: GetIntentsResponse -> GetIntentsResponse -> Bool
Prelude.Eq, ReadPrec [GetIntentsResponse]
ReadPrec GetIntentsResponse
Int -> ReadS GetIntentsResponse
ReadS [GetIntentsResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GetIntentsResponse]
$creadListPrec :: ReadPrec [GetIntentsResponse]
readPrec :: ReadPrec GetIntentsResponse
$creadPrec :: ReadPrec GetIntentsResponse
readList :: ReadS [GetIntentsResponse]
$creadList :: ReadS [GetIntentsResponse]
readsPrec :: Int -> ReadS GetIntentsResponse
$creadsPrec :: Int -> ReadS GetIntentsResponse
Prelude.Read, Int -> GetIntentsResponse -> ShowS
[GetIntentsResponse] -> ShowS
GetIntentsResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetIntentsResponse] -> ShowS
$cshowList :: [GetIntentsResponse] -> ShowS
show :: GetIntentsResponse -> String
$cshow :: GetIntentsResponse -> String
showsPrec :: Int -> GetIntentsResponse -> ShowS
$cshowsPrec :: Int -> GetIntentsResponse -> ShowS
Prelude.Show, forall x. Rep GetIntentsResponse x -> GetIntentsResponse
forall x. GetIntentsResponse -> Rep GetIntentsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep GetIntentsResponse x -> GetIntentsResponse
$cfrom :: forall x. GetIntentsResponse -> Rep GetIntentsResponse x
Prelude.Generic)

-- |
-- Create a value of 'GetIntentsResponse' 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:
--
-- 'intents', 'getIntentsResponse_intents' - An array of @Intent@ objects. For more information, see PutBot.
--
-- 'nextToken', 'getIntentsResponse_nextToken' - If the response is truncated, the response includes a pagination token
-- that you can specify in your next request to fetch the next page of
-- intents.
--
-- 'httpStatus', 'getIntentsResponse_httpStatus' - The response's http status code.
newGetIntentsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  GetIntentsResponse
newGetIntentsResponse :: Int -> GetIntentsResponse
newGetIntentsResponse Int
pHttpStatus_ =
  GetIntentsResponse'
    { $sel:intents:GetIntentsResponse' :: Maybe [IntentMetadata]
intents = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:GetIntentsResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:GetIntentsResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | An array of @Intent@ objects. For more information, see PutBot.
getIntentsResponse_intents :: Lens.Lens' GetIntentsResponse (Prelude.Maybe [IntentMetadata])
getIntentsResponse_intents :: Lens' GetIntentsResponse (Maybe [IntentMetadata])
getIntentsResponse_intents = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetIntentsResponse' {Maybe [IntentMetadata]
intents :: Maybe [IntentMetadata]
$sel:intents:GetIntentsResponse' :: GetIntentsResponse -> Maybe [IntentMetadata]
intents} -> Maybe [IntentMetadata]
intents) (\s :: GetIntentsResponse
s@GetIntentsResponse' {} Maybe [IntentMetadata]
a -> GetIntentsResponse
s {$sel:intents:GetIntentsResponse' :: Maybe [IntentMetadata]
intents = Maybe [IntentMetadata]
a} :: GetIntentsResponse) 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

-- | If the response is truncated, the response includes a pagination token
-- that you can specify in your next request to fetch the next page of
-- intents.
getIntentsResponse_nextToken :: Lens.Lens' GetIntentsResponse (Prelude.Maybe Prelude.Text)
getIntentsResponse_nextToken :: Lens' GetIntentsResponse (Maybe Text)
getIntentsResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetIntentsResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:GetIntentsResponse' :: GetIntentsResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: GetIntentsResponse
s@GetIntentsResponse' {} Maybe Text
a -> GetIntentsResponse
s {$sel:nextToken:GetIntentsResponse' :: Maybe Text
nextToken = Maybe Text
a} :: GetIntentsResponse)

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

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