{-# 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.SageMaker.Search
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Finds Amazon SageMaker resources that match a search query. Matching
-- resources are returned as a list of @SearchRecord@ objects in the
-- response. You can sort the search results by any resource property in a
-- ascending or descending order.
--
-- You can query against the following value types: numeric, text, Boolean,
-- and timestamp.
--
-- This operation returns paginated results.
module Amazonka.SageMaker.Search
  ( -- * Creating a Request
    Search (..),
    newSearch,

    -- * Request Lenses
    search_maxResults,
    search_nextToken,
    search_searchExpression,
    search_sortBy,
    search_sortOrder,
    search_resource,

    -- * Destructuring the Response
    SearchResponse (..),
    newSearchResponse,

    -- * Response Lenses
    searchResponse_nextToken,
    searchResponse_results,
    searchResponse_httpStatus,
  )
where

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

-- | /See:/ 'newSearch' smart constructor.
data Search = Search'
  { -- | The maximum number of results to return.
    Search -> Maybe Natural
maxResults :: Prelude.Maybe Prelude.Natural,
    -- | If more than @MaxResults@ resources match the specified
    -- @SearchExpression@, the response includes a @NextToken@. The @NextToken@
    -- can be passed to the next @SearchRequest@ to continue retrieving
    -- results.
    Search -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | A Boolean conditional statement. Resources must satisfy this condition
    -- to be included in search results. You must provide at least one
    -- subexpression, filter, or nested filter. The maximum number of recursive
    -- @SubExpressions@, @NestedFilters@, and @Filters@ that can be included in
    -- a @SearchExpression@ object is 50.
    Search -> Maybe SearchExpression
searchExpression :: Prelude.Maybe SearchExpression,
    -- | The name of the resource property used to sort the @SearchResults@. The
    -- default is @LastModifiedTime@.
    Search -> Maybe Text
sortBy :: Prelude.Maybe Prelude.Text,
    -- | How @SearchResults@ are ordered. Valid values are @Ascending@ or
    -- @Descending@. The default is @Descending@.
    Search -> Maybe SearchSortOrder
sortOrder :: Prelude.Maybe SearchSortOrder,
    -- | The name of the Amazon SageMaker resource to search for.
    Search -> ResourceType
resource :: ResourceType
  }
  deriving (Search -> Search -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: Search -> Search -> Bool
$c/= :: Search -> Search -> Bool
== :: Search -> Search -> Bool
$c== :: Search -> Search -> Bool
Prelude.Eq, ReadPrec [Search]
ReadPrec Search
Int -> ReadS Search
ReadS [Search]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [Search]
$creadListPrec :: ReadPrec [Search]
readPrec :: ReadPrec Search
$creadPrec :: ReadPrec Search
readList :: ReadS [Search]
$creadList :: ReadS [Search]
readsPrec :: Int -> ReadS Search
$creadsPrec :: Int -> ReadS Search
Prelude.Read, Int -> Search -> ShowS
[Search] -> ShowS
Search -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [Search] -> ShowS
$cshowList :: [Search] -> ShowS
show :: Search -> String
$cshow :: Search -> String
showsPrec :: Int -> Search -> ShowS
$cshowsPrec :: Int -> Search -> ShowS
Prelude.Show, forall x. Rep Search x -> Search
forall x. Search -> Rep Search x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep Search x -> Search
$cfrom :: forall x. Search -> Rep Search x
Prelude.Generic)

-- |
-- Create a value of 'Search' 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', 'search_maxResults' - The maximum number of results to return.
--
-- 'nextToken', 'search_nextToken' - If more than @MaxResults@ resources match the specified
-- @SearchExpression@, the response includes a @NextToken@. The @NextToken@
-- can be passed to the next @SearchRequest@ to continue retrieving
-- results.
--
-- 'searchExpression', 'search_searchExpression' - A Boolean conditional statement. Resources must satisfy this condition
-- to be included in search results. You must provide at least one
-- subexpression, filter, or nested filter. The maximum number of recursive
-- @SubExpressions@, @NestedFilters@, and @Filters@ that can be included in
-- a @SearchExpression@ object is 50.
--
-- 'sortBy', 'search_sortBy' - The name of the resource property used to sort the @SearchResults@. The
-- default is @LastModifiedTime@.
--
-- 'sortOrder', 'search_sortOrder' - How @SearchResults@ are ordered. Valid values are @Ascending@ or
-- @Descending@. The default is @Descending@.
--
-- 'resource', 'search_resource' - The name of the Amazon SageMaker resource to search for.
newSearch ::
  -- | 'resource'
  ResourceType ->
  Search
newSearch :: ResourceType -> Search
newSearch ResourceType
pResource_ =
  Search'
    { $sel:maxResults:Search' :: Maybe Natural
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:Search' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:searchExpression:Search' :: Maybe SearchExpression
searchExpression = forall a. Maybe a
Prelude.Nothing,
      $sel:sortBy:Search' :: Maybe Text
sortBy = forall a. Maybe a
Prelude.Nothing,
      $sel:sortOrder:Search' :: Maybe SearchSortOrder
sortOrder = forall a. Maybe a
Prelude.Nothing,
      $sel:resource:Search' :: ResourceType
resource = ResourceType
pResource_
    }

-- | The maximum number of results to return.
search_maxResults :: Lens.Lens' Search (Prelude.Maybe Prelude.Natural)
search_maxResults :: Lens' Search (Maybe Natural)
search_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Search' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:Search' :: Search -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: Search
s@Search' {} Maybe Natural
a -> Search
s {$sel:maxResults:Search' :: Maybe Natural
maxResults = Maybe Natural
a} :: Search)

-- | If more than @MaxResults@ resources match the specified
-- @SearchExpression@, the response includes a @NextToken@. The @NextToken@
-- can be passed to the next @SearchRequest@ to continue retrieving
-- results.
search_nextToken :: Lens.Lens' Search (Prelude.Maybe Prelude.Text)
search_nextToken :: Lens' Search (Maybe Text)
search_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Search' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:Search' :: Search -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: Search
s@Search' {} Maybe Text
a -> Search
s {$sel:nextToken:Search' :: Maybe Text
nextToken = Maybe Text
a} :: Search)

-- | A Boolean conditional statement. Resources must satisfy this condition
-- to be included in search results. You must provide at least one
-- subexpression, filter, or nested filter. The maximum number of recursive
-- @SubExpressions@, @NestedFilters@, and @Filters@ that can be included in
-- a @SearchExpression@ object is 50.
search_searchExpression :: Lens.Lens' Search (Prelude.Maybe SearchExpression)
search_searchExpression :: Lens' Search (Maybe SearchExpression)
search_searchExpression = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Search' {Maybe SearchExpression
searchExpression :: Maybe SearchExpression
$sel:searchExpression:Search' :: Search -> Maybe SearchExpression
searchExpression} -> Maybe SearchExpression
searchExpression) (\s :: Search
s@Search' {} Maybe SearchExpression
a -> Search
s {$sel:searchExpression:Search' :: Maybe SearchExpression
searchExpression = Maybe SearchExpression
a} :: Search)

-- | The name of the resource property used to sort the @SearchResults@. The
-- default is @LastModifiedTime@.
search_sortBy :: Lens.Lens' Search (Prelude.Maybe Prelude.Text)
search_sortBy :: Lens' Search (Maybe Text)
search_sortBy = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Search' {Maybe Text
sortBy :: Maybe Text
$sel:sortBy:Search' :: Search -> Maybe Text
sortBy} -> Maybe Text
sortBy) (\s :: Search
s@Search' {} Maybe Text
a -> Search
s {$sel:sortBy:Search' :: Maybe Text
sortBy = Maybe Text
a} :: Search)

-- | How @SearchResults@ are ordered. Valid values are @Ascending@ or
-- @Descending@. The default is @Descending@.
search_sortOrder :: Lens.Lens' Search (Prelude.Maybe SearchSortOrder)
search_sortOrder :: Lens' Search (Maybe SearchSortOrder)
search_sortOrder = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Search' {Maybe SearchSortOrder
sortOrder :: Maybe SearchSortOrder
$sel:sortOrder:Search' :: Search -> Maybe SearchSortOrder
sortOrder} -> Maybe SearchSortOrder
sortOrder) (\s :: Search
s@Search' {} Maybe SearchSortOrder
a -> Search
s {$sel:sortOrder:Search' :: Maybe SearchSortOrder
sortOrder = Maybe SearchSortOrder
a} :: Search)

-- | The name of the Amazon SageMaker resource to search for.
search_resource :: Lens.Lens' Search ResourceType
search_resource :: Lens' Search ResourceType
search_resource = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Search' {ResourceType
resource :: ResourceType
$sel:resource:Search' :: Search -> ResourceType
resource} -> ResourceType
resource) (\s :: Search
s@Search' {} ResourceType
a -> Search
s {$sel:resource:Search' :: ResourceType
resource = ResourceType
a} :: Search)

instance Core.AWSPager Search where
  page :: Search -> AWSResponse Search -> Maybe Search
page Search
rq AWSResponse Search
rs
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse Search
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' SearchResponse (Maybe Text)
searchResponse_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 Search
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' SearchResponse (Maybe [SearchRecord])
searchResponse_results
            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.$ Search
rq
          forall a b. a -> (a -> b) -> b
Prelude.& Lens' Search (Maybe Text)
search_nextToken
          forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse Search
rs
          forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' SearchResponse (Maybe Text)
searchResponse_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 Search where
  type AWSResponse Search = SearchResponse
  request :: (Service -> Service) -> Search -> Request Search
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 Search
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse Search)))
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 [SearchRecord] -> Int -> SearchResponse
SearchResponse'
            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
"Results" 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 Search where
  hashWithSalt :: Int -> Search -> Int
hashWithSalt Int
_salt Search' {Maybe Natural
Maybe Text
Maybe SearchExpression
Maybe SearchSortOrder
ResourceType
resource :: ResourceType
sortOrder :: Maybe SearchSortOrder
sortBy :: Maybe Text
searchExpression :: Maybe SearchExpression
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:resource:Search' :: Search -> ResourceType
$sel:sortOrder:Search' :: Search -> Maybe SearchSortOrder
$sel:sortBy:Search' :: Search -> Maybe Text
$sel:searchExpression:Search' :: Search -> Maybe SearchExpression
$sel:nextToken:Search' :: Search -> Maybe Text
$sel:maxResults:Search' :: Search -> 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
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe SearchExpression
searchExpression
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
sortBy
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe SearchSortOrder
sortOrder
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` ResourceType
resource

instance Prelude.NFData Search where
  rnf :: Search -> ()
rnf Search' {Maybe Natural
Maybe Text
Maybe SearchExpression
Maybe SearchSortOrder
ResourceType
resource :: ResourceType
sortOrder :: Maybe SearchSortOrder
sortBy :: Maybe Text
searchExpression :: Maybe SearchExpression
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:resource:Search' :: Search -> ResourceType
$sel:sortOrder:Search' :: Search -> Maybe SearchSortOrder
$sel:sortBy:Search' :: Search -> Maybe Text
$sel:searchExpression:Search' :: Search -> Maybe SearchExpression
$sel:nextToken:Search' :: Search -> Maybe Text
$sel:maxResults:Search' :: Search -> 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
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe SearchExpression
searchExpression
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
sortBy
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe SearchSortOrder
sortOrder
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf ResourceType
resource

instance Data.ToHeaders Search where
  toHeaders :: Search -> 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
"SageMaker.Search" :: 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 Search where
  toJSON :: Search -> Value
toJSON Search' {Maybe Natural
Maybe Text
Maybe SearchExpression
Maybe SearchSortOrder
ResourceType
resource :: ResourceType
sortOrder :: Maybe SearchSortOrder
sortBy :: Maybe Text
searchExpression :: Maybe SearchExpression
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:resource:Search' :: Search -> ResourceType
$sel:sortOrder:Search' :: Search -> Maybe SearchSortOrder
$sel:sortBy:Search' :: Search -> Maybe Text
$sel:searchExpression:Search' :: Search -> Maybe SearchExpression
$sel:nextToken:Search' :: Search -> Maybe Text
$sel:maxResults:Search' :: Search -> 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
"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,
            (Key
"SearchExpression" 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 SearchExpression
searchExpression,
            (Key
"SortBy" 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
sortBy,
            (Key
"SortOrder" 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 SearchSortOrder
sortOrder,
            forall a. a -> Maybe a
Prelude.Just (Key
"Resource" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= ResourceType
resource)
          ]
      )

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

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

-- | /See:/ 'newSearchResponse' smart constructor.
data SearchResponse = SearchResponse'
  { -- | If the result of the previous @Search@ request was truncated, the
    -- response includes a NextToken. To retrieve the next set of results, use
    -- the token in the next request.
    SearchResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | A list of @SearchRecord@ objects.
    SearchResponse -> Maybe [SearchRecord]
results :: Prelude.Maybe [SearchRecord],
    -- | The response's http status code.
    SearchResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (SearchResponse -> SearchResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: SearchResponse -> SearchResponse -> Bool
$c/= :: SearchResponse -> SearchResponse -> Bool
== :: SearchResponse -> SearchResponse -> Bool
$c== :: SearchResponse -> SearchResponse -> Bool
Prelude.Eq, Int -> SearchResponse -> ShowS
[SearchResponse] -> ShowS
SearchResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [SearchResponse] -> ShowS
$cshowList :: [SearchResponse] -> ShowS
show :: SearchResponse -> String
$cshow :: SearchResponse -> String
showsPrec :: Int -> SearchResponse -> ShowS
$cshowsPrec :: Int -> SearchResponse -> ShowS
Prelude.Show, forall x. Rep SearchResponse x -> SearchResponse
forall x. SearchResponse -> Rep SearchResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep SearchResponse x -> SearchResponse
$cfrom :: forall x. SearchResponse -> Rep SearchResponse x
Prelude.Generic)

-- |
-- Create a value of 'SearchResponse' 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', 'searchResponse_nextToken' - If the result of the previous @Search@ request was truncated, the
-- response includes a NextToken. To retrieve the next set of results, use
-- the token in the next request.
--
-- 'results', 'searchResponse_results' - A list of @SearchRecord@ objects.
--
-- 'httpStatus', 'searchResponse_httpStatus' - The response's http status code.
newSearchResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  SearchResponse
newSearchResponse :: Int -> SearchResponse
newSearchResponse Int
pHttpStatus_ =
  SearchResponse'
    { $sel:nextToken:SearchResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:results:SearchResponse' :: Maybe [SearchRecord]
results = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:SearchResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | If the result of the previous @Search@ request was truncated, the
-- response includes a NextToken. To retrieve the next set of results, use
-- the token in the next request.
searchResponse_nextToken :: Lens.Lens' SearchResponse (Prelude.Maybe Prelude.Text)
searchResponse_nextToken :: Lens' SearchResponse (Maybe Text)
searchResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SearchResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:SearchResponse' :: SearchResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: SearchResponse
s@SearchResponse' {} Maybe Text
a -> SearchResponse
s {$sel:nextToken:SearchResponse' :: Maybe Text
nextToken = Maybe Text
a} :: SearchResponse)

-- | A list of @SearchRecord@ objects.
searchResponse_results :: Lens.Lens' SearchResponse (Prelude.Maybe [SearchRecord])
searchResponse_results :: Lens' SearchResponse (Maybe [SearchRecord])
searchResponse_results = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SearchResponse' {Maybe [SearchRecord]
results :: Maybe [SearchRecord]
$sel:results:SearchResponse' :: SearchResponse -> Maybe [SearchRecord]
results} -> Maybe [SearchRecord]
results) (\s :: SearchResponse
s@SearchResponse' {} Maybe [SearchRecord]
a -> SearchResponse
s {$sel:results:SearchResponse' :: Maybe [SearchRecord]
results = Maybe [SearchRecord]
a} :: SearchResponse) 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.
searchResponse_httpStatus :: Lens.Lens' SearchResponse Prelude.Int
searchResponse_httpStatus :: Lens' SearchResponse Int
searchResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SearchResponse' {Int
httpStatus :: Int
$sel:httpStatus:SearchResponse' :: SearchResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: SearchResponse
s@SearchResponse' {} Int
a -> SearchResponse
s {$sel:httpStatus:SearchResponse' :: Int
httpStatus = Int
a} :: SearchResponse)

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