{-# 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.TimeStreamWrite.ListTables
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- A list of tables, along with the name, status and retention properties
-- of each table. See
-- <https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-table.html code sample>
-- for details.
module Amazonka.TimeStreamWrite.ListTables
  ( -- * Creating a Request
    ListTables (..),
    newListTables,

    -- * Request Lenses
    listTables_databaseName,
    listTables_maxResults,
    listTables_nextToken,

    -- * Destructuring the Response
    ListTablesResponse (..),
    newListTablesResponse,

    -- * Response Lenses
    listTablesResponse_nextToken,
    listTablesResponse_tables,
    listTablesResponse_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.TimeStreamWrite.Types

-- | /See:/ 'newListTables' smart constructor.
data ListTables = ListTables'
  { -- | The name of the Timestream database.
    ListTables -> Maybe Text
databaseName :: Prelude.Maybe Prelude.Text,
    -- | The total number of items to return in the output. If the total number
    -- of items available is more than the value specified, a NextToken is
    -- provided in the output. To resume pagination, provide the NextToken
    -- value as argument of a subsequent API invocation.
    ListTables -> Maybe Natural
maxResults :: Prelude.Maybe Prelude.Natural,
    -- | The pagination token. To resume pagination, provide the NextToken value
    -- as argument of a subsequent API invocation.
    ListTables -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text
  }
  deriving (ListTables -> ListTables -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListTables -> ListTables -> Bool
$c/= :: ListTables -> ListTables -> Bool
== :: ListTables -> ListTables -> Bool
$c== :: ListTables -> ListTables -> Bool
Prelude.Eq, ReadPrec [ListTables]
ReadPrec ListTables
Int -> ReadS ListTables
ReadS [ListTables]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListTables]
$creadListPrec :: ReadPrec [ListTables]
readPrec :: ReadPrec ListTables
$creadPrec :: ReadPrec ListTables
readList :: ReadS [ListTables]
$creadList :: ReadS [ListTables]
readsPrec :: Int -> ReadS ListTables
$creadsPrec :: Int -> ReadS ListTables
Prelude.Read, Int -> ListTables -> ShowS
[ListTables] -> ShowS
ListTables -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListTables] -> ShowS
$cshowList :: [ListTables] -> ShowS
show :: ListTables -> String
$cshow :: ListTables -> String
showsPrec :: Int -> ListTables -> ShowS
$cshowsPrec :: Int -> ListTables -> ShowS
Prelude.Show, forall x. Rep ListTables x -> ListTables
forall x. ListTables -> Rep ListTables x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListTables x -> ListTables
$cfrom :: forall x. ListTables -> Rep ListTables x
Prelude.Generic)

-- |
-- Create a value of 'ListTables' 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:
--
-- 'databaseName', 'listTables_databaseName' - The name of the Timestream database.
--
-- 'maxResults', 'listTables_maxResults' - The total number of items to return in the output. If the total number
-- of items available is more than the value specified, a NextToken is
-- provided in the output. To resume pagination, provide the NextToken
-- value as argument of a subsequent API invocation.
--
-- 'nextToken', 'listTables_nextToken' - The pagination token. To resume pagination, provide the NextToken value
-- as argument of a subsequent API invocation.
newListTables ::
  ListTables
newListTables :: ListTables
newListTables =
  ListTables'
    { $sel:databaseName:ListTables' :: Maybe Text
databaseName = forall a. Maybe a
Prelude.Nothing,
      $sel:maxResults:ListTables' :: Maybe Natural
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListTables' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing
    }

-- | The name of the Timestream database.
listTables_databaseName :: Lens.Lens' ListTables (Prelude.Maybe Prelude.Text)
listTables_databaseName :: Lens' ListTables (Maybe Text)
listTables_databaseName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListTables' {Maybe Text
databaseName :: Maybe Text
$sel:databaseName:ListTables' :: ListTables -> Maybe Text
databaseName} -> Maybe Text
databaseName) (\s :: ListTables
s@ListTables' {} Maybe Text
a -> ListTables
s {$sel:databaseName:ListTables' :: Maybe Text
databaseName = Maybe Text
a} :: ListTables)

-- | The total number of items to return in the output. If the total number
-- of items available is more than the value specified, a NextToken is
-- provided in the output. To resume pagination, provide the NextToken
-- value as argument of a subsequent API invocation.
listTables_maxResults :: Lens.Lens' ListTables (Prelude.Maybe Prelude.Natural)
listTables_maxResults :: Lens' ListTables (Maybe Natural)
listTables_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListTables' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:ListTables' :: ListTables -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: ListTables
s@ListTables' {} Maybe Natural
a -> ListTables
s {$sel:maxResults:ListTables' :: Maybe Natural
maxResults = Maybe Natural
a} :: ListTables)

-- | The pagination token. To resume pagination, provide the NextToken value
-- as argument of a subsequent API invocation.
listTables_nextToken :: Lens.Lens' ListTables (Prelude.Maybe Prelude.Text)
listTables_nextToken :: Lens' ListTables (Maybe Text)
listTables_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListTables' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListTables' :: ListTables -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListTables
s@ListTables' {} Maybe Text
a -> ListTables
s {$sel:nextToken:ListTables' :: Maybe Text
nextToken = Maybe Text
a} :: ListTables)

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

instance Prelude.NFData ListTables where
  rnf :: ListTables -> ()
rnf ListTables' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
databaseName :: Maybe Text
$sel:nextToken:ListTables' :: ListTables -> Maybe Text
$sel:maxResults:ListTables' :: ListTables -> Maybe Natural
$sel:databaseName:ListTables' :: ListTables -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
databaseName
      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

instance Data.ToHeaders ListTables where
  toHeaders :: ListTables -> 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
"Timestream_20181101.ListTables" ::
                          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 ListTables where
  toJSON :: ListTables -> Value
toJSON ListTables' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
databaseName :: Maybe Text
$sel:nextToken:ListTables' :: ListTables -> Maybe Text
$sel:maxResults:ListTables' :: ListTables -> Maybe Natural
$sel:databaseName:ListTables' :: ListTables -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"DatabaseName" 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
databaseName,
            (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
          ]
      )

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

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

-- | /See:/ 'newListTablesResponse' smart constructor.
data ListTablesResponse = ListTablesResponse'
  { -- | A token to specify where to start paginating. This is the NextToken from
    -- a previously truncated response.
    ListTablesResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | A list of tables.
    ListTablesResponse -> Maybe [Table]
tables :: Prelude.Maybe [Table],
    -- | The response's http status code.
    ListTablesResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (ListTablesResponse -> ListTablesResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListTablesResponse -> ListTablesResponse -> Bool
$c/= :: ListTablesResponse -> ListTablesResponse -> Bool
== :: ListTablesResponse -> ListTablesResponse -> Bool
$c== :: ListTablesResponse -> ListTablesResponse -> Bool
Prelude.Eq, ReadPrec [ListTablesResponse]
ReadPrec ListTablesResponse
Int -> ReadS ListTablesResponse
ReadS [ListTablesResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListTablesResponse]
$creadListPrec :: ReadPrec [ListTablesResponse]
readPrec :: ReadPrec ListTablesResponse
$creadPrec :: ReadPrec ListTablesResponse
readList :: ReadS [ListTablesResponse]
$creadList :: ReadS [ListTablesResponse]
readsPrec :: Int -> ReadS ListTablesResponse
$creadsPrec :: Int -> ReadS ListTablesResponse
Prelude.Read, Int -> ListTablesResponse -> ShowS
[ListTablesResponse] -> ShowS
ListTablesResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListTablesResponse] -> ShowS
$cshowList :: [ListTablesResponse] -> ShowS
show :: ListTablesResponse -> String
$cshow :: ListTablesResponse -> String
showsPrec :: Int -> ListTablesResponse -> ShowS
$cshowsPrec :: Int -> ListTablesResponse -> ShowS
Prelude.Show, forall x. Rep ListTablesResponse x -> ListTablesResponse
forall x. ListTablesResponse -> Rep ListTablesResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListTablesResponse x -> ListTablesResponse
$cfrom :: forall x. ListTablesResponse -> Rep ListTablesResponse x
Prelude.Generic)

-- |
-- Create a value of 'ListTablesResponse' 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', 'listTablesResponse_nextToken' - A token to specify where to start paginating. This is the NextToken from
-- a previously truncated response.
--
-- 'tables', 'listTablesResponse_tables' - A list of tables.
--
-- 'httpStatus', 'listTablesResponse_httpStatus' - The response's http status code.
newListTablesResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListTablesResponse
newListTablesResponse :: Int -> ListTablesResponse
newListTablesResponse Int
pHttpStatus_ =
  ListTablesResponse'
    { $sel:nextToken:ListTablesResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:tables:ListTablesResponse' :: Maybe [Table]
tables = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:ListTablesResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | A token to specify where to start paginating. This is the NextToken from
-- a previously truncated response.
listTablesResponse_nextToken :: Lens.Lens' ListTablesResponse (Prelude.Maybe Prelude.Text)
listTablesResponse_nextToken :: Lens' ListTablesResponse (Maybe Text)
listTablesResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListTablesResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListTablesResponse' :: ListTablesResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListTablesResponse
s@ListTablesResponse' {} Maybe Text
a -> ListTablesResponse
s {$sel:nextToken:ListTablesResponse' :: Maybe Text
nextToken = Maybe Text
a} :: ListTablesResponse)

-- | A list of tables.
listTablesResponse_tables :: Lens.Lens' ListTablesResponse (Prelude.Maybe [Table])
listTablesResponse_tables :: Lens' ListTablesResponse (Maybe [Table])
listTablesResponse_tables = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListTablesResponse' {Maybe [Table]
tables :: Maybe [Table]
$sel:tables:ListTablesResponse' :: ListTablesResponse -> Maybe [Table]
tables} -> Maybe [Table]
tables) (\s :: ListTablesResponse
s@ListTablesResponse' {} Maybe [Table]
a -> ListTablesResponse
s {$sel:tables:ListTablesResponse' :: Maybe [Table]
tables = Maybe [Table]
a} :: ListTablesResponse) 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.
listTablesResponse_httpStatus :: Lens.Lens' ListTablesResponse Prelude.Int
listTablesResponse_httpStatus :: Lens' ListTablesResponse Int
listTablesResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListTablesResponse' {Int
httpStatus :: Int
$sel:httpStatus:ListTablesResponse' :: ListTablesResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: ListTablesResponse
s@ListTablesResponse' {} Int
a -> ListTablesResponse
s {$sel:httpStatus:ListTablesResponse' :: Int
httpStatus = Int
a} :: ListTablesResponse)

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