{-# 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.RedshiftData.DescribeTable
-- 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 detailed information about a table from metadata in the
-- cluster. The information includes its columns. A token is returned to
-- page through the column list. Depending on the authorization method, use
-- one of the following combinations of request parameters:
--
-- -   Secrets Manager - when connecting to a cluster, specify the Amazon
--     Resource Name (ARN) of the secret, the database name, and the
--     cluster identifier that matches the cluster in the secret. When
--     connecting to a serverless workgroup, specify the Amazon Resource
--     Name (ARN) of the secret and the database name.
--
-- -   Temporary credentials - when connecting to a cluster, specify the
--     cluster identifier, the database name, and the database user name.
--     Also, permission to call the @redshift:GetClusterCredentials@
--     operation is required. When connecting to a serverless workgroup,
--     specify the workgroup name and database name. Also, permission to
--     call the @redshift-serverless:GetCredentials@ operation is required.
--
-- For more information about the Amazon Redshift Data API and CLI usage
-- examples, see
-- <https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html Using the Amazon Redshift Data API>
-- in the /Amazon Redshift Management Guide/.
--
-- This operation returns paginated results.
module Amazonka.RedshiftData.DescribeTable
  ( -- * Creating a Request
    DescribeTable (..),
    newDescribeTable,

    -- * Request Lenses
    describeTable_clusterIdentifier,
    describeTable_connectedDatabase,
    describeTable_dbUser,
    describeTable_maxResults,
    describeTable_nextToken,
    describeTable_schema,
    describeTable_secretArn,
    describeTable_table,
    describeTable_workgroupName,
    describeTable_database,

    -- * Destructuring the Response
    DescribeTableResponse (..),
    newDescribeTableResponse,

    -- * Response Lenses
    describeTableResponse_columnList,
    describeTableResponse_nextToken,
    describeTableResponse_tableName,
    describeTableResponse_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 Amazonka.RedshiftData.Types
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | /See:/ 'newDescribeTable' smart constructor.
data DescribeTable = DescribeTable'
  { -- | The cluster identifier. This parameter is required when connecting to a
    -- cluster and authenticating using either Secrets Manager or temporary
    -- credentials.
    DescribeTable -> Maybe Text
clusterIdentifier :: Prelude.Maybe Prelude.Text,
    -- | A database name. The connected database is specified when you connect
    -- with your authentication credentials.
    DescribeTable -> Maybe Text
connectedDatabase :: Prelude.Maybe Prelude.Text,
    -- | The database user name. This parameter is required when connecting to a
    -- cluster and authenticating using temporary credentials.
    DescribeTable -> Maybe Text
dbUser :: Prelude.Maybe Prelude.Text,
    -- | The maximum number of tables to return in the response. If more tables
    -- exist than fit in one response, then @NextToken@ is returned to page
    -- through the results.
    DescribeTable -> Maybe Natural
maxResults :: Prelude.Maybe Prelude.Natural,
    -- | A value that indicates the starting point for the next set of response
    -- records in a subsequent request. If a value is returned in a response,
    -- you can retrieve the next set of records by providing this returned
    -- NextToken value in the next NextToken parameter and retrying the
    -- command. If the NextToken field is empty, all response records have been
    -- retrieved for the request.
    DescribeTable -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The schema that contains the table. If no schema is specified, then
    -- matching tables for all schemas are returned.
    DescribeTable -> Maybe Text
schema :: Prelude.Maybe Prelude.Text,
    -- | The name or ARN of the secret that enables access to the database. This
    -- parameter is required when authenticating using Secrets Manager.
    DescribeTable -> Maybe Text
secretArn :: Prelude.Maybe Prelude.Text,
    -- | The table name. If no table is specified, then all tables for all
    -- matching schemas are returned. If no table and no schema is specified,
    -- then all tables for all schemas in the database are returned
    DescribeTable -> Maybe Text
table :: Prelude.Maybe Prelude.Text,
    -- | The serverless workgroup name. This parameter is required when
    -- connecting to a serverless workgroup and authenticating using either
    -- Secrets Manager or temporary credentials.
    DescribeTable -> Maybe Text
workgroupName :: Prelude.Maybe Prelude.Text,
    -- | The name of the database that contains the tables to be described. If
    -- @ConnectedDatabase@ is not specified, this is also the database to
    -- connect to with your authentication credentials.
    DescribeTable -> Text
database :: Prelude.Text
  }
  deriving (DescribeTable -> DescribeTable -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeTable -> DescribeTable -> Bool
$c/= :: DescribeTable -> DescribeTable -> Bool
== :: DescribeTable -> DescribeTable -> Bool
$c== :: DescribeTable -> DescribeTable -> Bool
Prelude.Eq, ReadPrec [DescribeTable]
ReadPrec DescribeTable
Int -> ReadS DescribeTable
ReadS [DescribeTable]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeTable]
$creadListPrec :: ReadPrec [DescribeTable]
readPrec :: ReadPrec DescribeTable
$creadPrec :: ReadPrec DescribeTable
readList :: ReadS [DescribeTable]
$creadList :: ReadS [DescribeTable]
readsPrec :: Int -> ReadS DescribeTable
$creadsPrec :: Int -> ReadS DescribeTable
Prelude.Read, Int -> DescribeTable -> ShowS
[DescribeTable] -> ShowS
DescribeTable -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeTable] -> ShowS
$cshowList :: [DescribeTable] -> ShowS
show :: DescribeTable -> String
$cshow :: DescribeTable -> String
showsPrec :: Int -> DescribeTable -> ShowS
$cshowsPrec :: Int -> DescribeTable -> ShowS
Prelude.Show, forall x. Rep DescribeTable x -> DescribeTable
forall x. DescribeTable -> Rep DescribeTable x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeTable x -> DescribeTable
$cfrom :: forall x. DescribeTable -> Rep DescribeTable x
Prelude.Generic)

-- |
-- Create a value of 'DescribeTable' 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:
--
-- 'clusterIdentifier', 'describeTable_clusterIdentifier' - The cluster identifier. This parameter is required when connecting to a
-- cluster and authenticating using either Secrets Manager or temporary
-- credentials.
--
-- 'connectedDatabase', 'describeTable_connectedDatabase' - A database name. The connected database is specified when you connect
-- with your authentication credentials.
--
-- 'dbUser', 'describeTable_dbUser' - The database user name. This parameter is required when connecting to a
-- cluster and authenticating using temporary credentials.
--
-- 'maxResults', 'describeTable_maxResults' - The maximum number of tables to return in the response. If more tables
-- exist than fit in one response, then @NextToken@ is returned to page
-- through the results.
--
-- 'nextToken', 'describeTable_nextToken' - A value that indicates the starting point for the next set of response
-- records in a subsequent request. If a value is returned in a response,
-- you can retrieve the next set of records by providing this returned
-- NextToken value in the next NextToken parameter and retrying the
-- command. If the NextToken field is empty, all response records have been
-- retrieved for the request.
--
-- 'schema', 'describeTable_schema' - The schema that contains the table. If no schema is specified, then
-- matching tables for all schemas are returned.
--
-- 'secretArn', 'describeTable_secretArn' - The name or ARN of the secret that enables access to the database. This
-- parameter is required when authenticating using Secrets Manager.
--
-- 'table', 'describeTable_table' - The table name. If no table is specified, then all tables for all
-- matching schemas are returned. If no table and no schema is specified,
-- then all tables for all schemas in the database are returned
--
-- 'workgroupName', 'describeTable_workgroupName' - The serverless workgroup name. This parameter is required when
-- connecting to a serverless workgroup and authenticating using either
-- Secrets Manager or temporary credentials.
--
-- 'database', 'describeTable_database' - The name of the database that contains the tables to be described. If
-- @ConnectedDatabase@ is not specified, this is also the database to
-- connect to with your authentication credentials.
newDescribeTable ::
  -- | 'database'
  Prelude.Text ->
  DescribeTable
newDescribeTable :: Text -> DescribeTable
newDescribeTable Text
pDatabase_ =
  DescribeTable'
    { $sel:clusterIdentifier:DescribeTable' :: Maybe Text
clusterIdentifier = forall a. Maybe a
Prelude.Nothing,
      $sel:connectedDatabase:DescribeTable' :: Maybe Text
connectedDatabase = forall a. Maybe a
Prelude.Nothing,
      $sel:dbUser:DescribeTable' :: Maybe Text
dbUser = forall a. Maybe a
Prelude.Nothing,
      $sel:maxResults:DescribeTable' :: Maybe Natural
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:DescribeTable' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:schema:DescribeTable' :: Maybe Text
schema = forall a. Maybe a
Prelude.Nothing,
      $sel:secretArn:DescribeTable' :: Maybe Text
secretArn = forall a. Maybe a
Prelude.Nothing,
      $sel:table:DescribeTable' :: Maybe Text
table = forall a. Maybe a
Prelude.Nothing,
      $sel:workgroupName:DescribeTable' :: Maybe Text
workgroupName = forall a. Maybe a
Prelude.Nothing,
      $sel:database:DescribeTable' :: Text
database = Text
pDatabase_
    }

-- | The cluster identifier. This parameter is required when connecting to a
-- cluster and authenticating using either Secrets Manager or temporary
-- credentials.
describeTable_clusterIdentifier :: Lens.Lens' DescribeTable (Prelude.Maybe Prelude.Text)
describeTable_clusterIdentifier :: Lens' DescribeTable (Maybe Text)
describeTable_clusterIdentifier = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeTable' {Maybe Text
clusterIdentifier :: Maybe Text
$sel:clusterIdentifier:DescribeTable' :: DescribeTable -> Maybe Text
clusterIdentifier} -> Maybe Text
clusterIdentifier) (\s :: DescribeTable
s@DescribeTable' {} Maybe Text
a -> DescribeTable
s {$sel:clusterIdentifier:DescribeTable' :: Maybe Text
clusterIdentifier = Maybe Text
a} :: DescribeTable)

-- | A database name. The connected database is specified when you connect
-- with your authentication credentials.
describeTable_connectedDatabase :: Lens.Lens' DescribeTable (Prelude.Maybe Prelude.Text)
describeTable_connectedDatabase :: Lens' DescribeTable (Maybe Text)
describeTable_connectedDatabase = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeTable' {Maybe Text
connectedDatabase :: Maybe Text
$sel:connectedDatabase:DescribeTable' :: DescribeTable -> Maybe Text
connectedDatabase} -> Maybe Text
connectedDatabase) (\s :: DescribeTable
s@DescribeTable' {} Maybe Text
a -> DescribeTable
s {$sel:connectedDatabase:DescribeTable' :: Maybe Text
connectedDatabase = Maybe Text
a} :: DescribeTable)

-- | The database user name. This parameter is required when connecting to a
-- cluster and authenticating using temporary credentials.
describeTable_dbUser :: Lens.Lens' DescribeTable (Prelude.Maybe Prelude.Text)
describeTable_dbUser :: Lens' DescribeTable (Maybe Text)
describeTable_dbUser = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeTable' {Maybe Text
dbUser :: Maybe Text
$sel:dbUser:DescribeTable' :: DescribeTable -> Maybe Text
dbUser} -> Maybe Text
dbUser) (\s :: DescribeTable
s@DescribeTable' {} Maybe Text
a -> DescribeTable
s {$sel:dbUser:DescribeTable' :: Maybe Text
dbUser = Maybe Text
a} :: DescribeTable)

-- | The maximum number of tables to return in the response. If more tables
-- exist than fit in one response, then @NextToken@ is returned to page
-- through the results.
describeTable_maxResults :: Lens.Lens' DescribeTable (Prelude.Maybe Prelude.Natural)
describeTable_maxResults :: Lens' DescribeTable (Maybe Natural)
describeTable_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeTable' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:DescribeTable' :: DescribeTable -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: DescribeTable
s@DescribeTable' {} Maybe Natural
a -> DescribeTable
s {$sel:maxResults:DescribeTable' :: Maybe Natural
maxResults = Maybe Natural
a} :: DescribeTable)

-- | A value that indicates the starting point for the next set of response
-- records in a subsequent request. If a value is returned in a response,
-- you can retrieve the next set of records by providing this returned
-- NextToken value in the next NextToken parameter and retrying the
-- command. If the NextToken field is empty, all response records have been
-- retrieved for the request.
describeTable_nextToken :: Lens.Lens' DescribeTable (Prelude.Maybe Prelude.Text)
describeTable_nextToken :: Lens' DescribeTable (Maybe Text)
describeTable_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeTable' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:DescribeTable' :: DescribeTable -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: DescribeTable
s@DescribeTable' {} Maybe Text
a -> DescribeTable
s {$sel:nextToken:DescribeTable' :: Maybe Text
nextToken = Maybe Text
a} :: DescribeTable)

-- | The schema that contains the table. If no schema is specified, then
-- matching tables for all schemas are returned.
describeTable_schema :: Lens.Lens' DescribeTable (Prelude.Maybe Prelude.Text)
describeTable_schema :: Lens' DescribeTable (Maybe Text)
describeTable_schema = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeTable' {Maybe Text
schema :: Maybe Text
$sel:schema:DescribeTable' :: DescribeTable -> Maybe Text
schema} -> Maybe Text
schema) (\s :: DescribeTable
s@DescribeTable' {} Maybe Text
a -> DescribeTable
s {$sel:schema:DescribeTable' :: Maybe Text
schema = Maybe Text
a} :: DescribeTable)

-- | The name or ARN of the secret that enables access to the database. This
-- parameter is required when authenticating using Secrets Manager.
describeTable_secretArn :: Lens.Lens' DescribeTable (Prelude.Maybe Prelude.Text)
describeTable_secretArn :: Lens' DescribeTable (Maybe Text)
describeTable_secretArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeTable' {Maybe Text
secretArn :: Maybe Text
$sel:secretArn:DescribeTable' :: DescribeTable -> Maybe Text
secretArn} -> Maybe Text
secretArn) (\s :: DescribeTable
s@DescribeTable' {} Maybe Text
a -> DescribeTable
s {$sel:secretArn:DescribeTable' :: Maybe Text
secretArn = Maybe Text
a} :: DescribeTable)

-- | The table name. If no table is specified, then all tables for all
-- matching schemas are returned. If no table and no schema is specified,
-- then all tables for all schemas in the database are returned
describeTable_table :: Lens.Lens' DescribeTable (Prelude.Maybe Prelude.Text)
describeTable_table :: Lens' DescribeTable (Maybe Text)
describeTable_table = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeTable' {Maybe Text
table :: Maybe Text
$sel:table:DescribeTable' :: DescribeTable -> Maybe Text
table} -> Maybe Text
table) (\s :: DescribeTable
s@DescribeTable' {} Maybe Text
a -> DescribeTable
s {$sel:table:DescribeTable' :: Maybe Text
table = Maybe Text
a} :: DescribeTable)

-- | The serverless workgroup name. This parameter is required when
-- connecting to a serverless workgroup and authenticating using either
-- Secrets Manager or temporary credentials.
describeTable_workgroupName :: Lens.Lens' DescribeTable (Prelude.Maybe Prelude.Text)
describeTable_workgroupName :: Lens' DescribeTable (Maybe Text)
describeTable_workgroupName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeTable' {Maybe Text
workgroupName :: Maybe Text
$sel:workgroupName:DescribeTable' :: DescribeTable -> Maybe Text
workgroupName} -> Maybe Text
workgroupName) (\s :: DescribeTable
s@DescribeTable' {} Maybe Text
a -> DescribeTable
s {$sel:workgroupName:DescribeTable' :: Maybe Text
workgroupName = Maybe Text
a} :: DescribeTable)

-- | The name of the database that contains the tables to be described. If
-- @ConnectedDatabase@ is not specified, this is also the database to
-- connect to with your authentication credentials.
describeTable_database :: Lens.Lens' DescribeTable Prelude.Text
describeTable_database :: Lens' DescribeTable Text
describeTable_database = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeTable' {Text
database :: Text
$sel:database:DescribeTable' :: DescribeTable -> Text
database} -> Text
database) (\s :: DescribeTable
s@DescribeTable' {} Text
a -> DescribeTable
s {$sel:database:DescribeTable' :: Text
database = Text
a} :: DescribeTable)

instance Core.AWSPager DescribeTable where
  page :: DescribeTable -> AWSResponse DescribeTable -> Maybe DescribeTable
page DescribeTable
rq AWSResponse DescribeTable
rs
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse DescribeTable
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' DescribeTableResponse (Maybe Text)
describeTableResponse_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 DescribeTable
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' DescribeTableResponse (Maybe [ColumnMetadata])
describeTableResponse_columnList
            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.$ DescribeTable
rq
          forall a b. a -> (a -> b) -> b
Prelude.& Lens' DescribeTable (Maybe Text)
describeTable_nextToken
          forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse DescribeTable
rs
          forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' DescribeTableResponse (Maybe Text)
describeTableResponse_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 DescribeTable where
  type
    AWSResponse DescribeTable =
      DescribeTableResponse
  request :: (Service -> Service) -> DescribeTable -> Request DescribeTable
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 DescribeTable
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse DescribeTable)))
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 [ColumnMetadata]
-> Maybe Text -> Maybe Text -> Int -> DescribeTableResponse
DescribeTableResponse'
            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
"ColumnList" 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
"TableName")
            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 DescribeTable where
  hashWithSalt :: Int -> DescribeTable -> Int
hashWithSalt Int
_salt DescribeTable' {Maybe Natural
Maybe Text
Text
database :: Text
workgroupName :: Maybe Text
table :: Maybe Text
secretArn :: Maybe Text
schema :: Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
dbUser :: Maybe Text
connectedDatabase :: Maybe Text
clusterIdentifier :: Maybe Text
$sel:database:DescribeTable' :: DescribeTable -> Text
$sel:workgroupName:DescribeTable' :: DescribeTable -> Maybe Text
$sel:table:DescribeTable' :: DescribeTable -> Maybe Text
$sel:secretArn:DescribeTable' :: DescribeTable -> Maybe Text
$sel:schema:DescribeTable' :: DescribeTable -> Maybe Text
$sel:nextToken:DescribeTable' :: DescribeTable -> Maybe Text
$sel:maxResults:DescribeTable' :: DescribeTable -> Maybe Natural
$sel:dbUser:DescribeTable' :: DescribeTable -> Maybe Text
$sel:connectedDatabase:DescribeTable' :: DescribeTable -> Maybe Text
$sel:clusterIdentifier:DescribeTable' :: DescribeTable -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
clusterIdentifier
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
connectedDatabase
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
dbUser
      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 Text
schema
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
secretArn
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
table
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
workgroupName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
database

instance Prelude.NFData DescribeTable where
  rnf :: DescribeTable -> ()
rnf DescribeTable' {Maybe Natural
Maybe Text
Text
database :: Text
workgroupName :: Maybe Text
table :: Maybe Text
secretArn :: Maybe Text
schema :: Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
dbUser :: Maybe Text
connectedDatabase :: Maybe Text
clusterIdentifier :: Maybe Text
$sel:database:DescribeTable' :: DescribeTable -> Text
$sel:workgroupName:DescribeTable' :: DescribeTable -> Maybe Text
$sel:table:DescribeTable' :: DescribeTable -> Maybe Text
$sel:secretArn:DescribeTable' :: DescribeTable -> Maybe Text
$sel:schema:DescribeTable' :: DescribeTable -> Maybe Text
$sel:nextToken:DescribeTable' :: DescribeTable -> Maybe Text
$sel:maxResults:DescribeTable' :: DescribeTable -> Maybe Natural
$sel:dbUser:DescribeTable' :: DescribeTable -> Maybe Text
$sel:connectedDatabase:DescribeTable' :: DescribeTable -> Maybe Text
$sel:clusterIdentifier:DescribeTable' :: DescribeTable -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
clusterIdentifier
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
connectedDatabase
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
dbUser
      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 Maybe Text
schema
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
secretArn
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
table
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
workgroupName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
database

instance Data.ToHeaders DescribeTable where
  toHeaders :: DescribeTable -> 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
"RedshiftData.DescribeTable" :: 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 DescribeTable where
  toJSON :: DescribeTable -> Value
toJSON DescribeTable' {Maybe Natural
Maybe Text
Text
database :: Text
workgroupName :: Maybe Text
table :: Maybe Text
secretArn :: Maybe Text
schema :: Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
dbUser :: Maybe Text
connectedDatabase :: Maybe Text
clusterIdentifier :: Maybe Text
$sel:database:DescribeTable' :: DescribeTable -> Text
$sel:workgroupName:DescribeTable' :: DescribeTable -> Maybe Text
$sel:table:DescribeTable' :: DescribeTable -> Maybe Text
$sel:secretArn:DescribeTable' :: DescribeTable -> Maybe Text
$sel:schema:DescribeTable' :: DescribeTable -> Maybe Text
$sel:nextToken:DescribeTable' :: DescribeTable -> Maybe Text
$sel:maxResults:DescribeTable' :: DescribeTable -> Maybe Natural
$sel:dbUser:DescribeTable' :: DescribeTable -> Maybe Text
$sel:connectedDatabase:DescribeTable' :: DescribeTable -> Maybe Text
$sel:clusterIdentifier:DescribeTable' :: DescribeTable -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"ClusterIdentifier" 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
clusterIdentifier,
            (Key
"ConnectedDatabase" 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
connectedDatabase,
            (Key
"DbUser" 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
dbUser,
            (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
"Schema" 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
schema,
            (Key
"SecretArn" 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
secretArn,
            (Key
"Table" 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
table,
            (Key
"WorkgroupName" 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
workgroupName,
            forall a. a -> Maybe a
Prelude.Just (Key
"Database" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
database)
          ]
      )

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

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

-- | /See:/ 'newDescribeTableResponse' smart constructor.
data DescribeTableResponse = DescribeTableResponse'
  { -- | A list of columns in the table.
    DescribeTableResponse -> Maybe [ColumnMetadata]
columnList :: Prelude.Maybe [ColumnMetadata],
    -- | A value that indicates the starting point for the next set of response
    -- records in a subsequent request. If a value is returned in a response,
    -- you can retrieve the next set of records by providing this returned
    -- NextToken value in the next NextToken parameter and retrying the
    -- command. If the NextToken field is empty, all response records have been
    -- retrieved for the request.
    DescribeTableResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The table name.
    DescribeTableResponse -> Maybe Text
tableName :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    DescribeTableResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (DescribeTableResponse -> DescribeTableResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeTableResponse -> DescribeTableResponse -> Bool
$c/= :: DescribeTableResponse -> DescribeTableResponse -> Bool
== :: DescribeTableResponse -> DescribeTableResponse -> Bool
$c== :: DescribeTableResponse -> DescribeTableResponse -> Bool
Prelude.Eq, ReadPrec [DescribeTableResponse]
ReadPrec DescribeTableResponse
Int -> ReadS DescribeTableResponse
ReadS [DescribeTableResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeTableResponse]
$creadListPrec :: ReadPrec [DescribeTableResponse]
readPrec :: ReadPrec DescribeTableResponse
$creadPrec :: ReadPrec DescribeTableResponse
readList :: ReadS [DescribeTableResponse]
$creadList :: ReadS [DescribeTableResponse]
readsPrec :: Int -> ReadS DescribeTableResponse
$creadsPrec :: Int -> ReadS DescribeTableResponse
Prelude.Read, Int -> DescribeTableResponse -> ShowS
[DescribeTableResponse] -> ShowS
DescribeTableResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeTableResponse] -> ShowS
$cshowList :: [DescribeTableResponse] -> ShowS
show :: DescribeTableResponse -> String
$cshow :: DescribeTableResponse -> String
showsPrec :: Int -> DescribeTableResponse -> ShowS
$cshowsPrec :: Int -> DescribeTableResponse -> ShowS
Prelude.Show, forall x. Rep DescribeTableResponse x -> DescribeTableResponse
forall x. DescribeTableResponse -> Rep DescribeTableResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeTableResponse x -> DescribeTableResponse
$cfrom :: forall x. DescribeTableResponse -> Rep DescribeTableResponse x
Prelude.Generic)

-- |
-- Create a value of 'DescribeTableResponse' 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:
--
-- 'columnList', 'describeTableResponse_columnList' - A list of columns in the table.
--
-- 'nextToken', 'describeTableResponse_nextToken' - A value that indicates the starting point for the next set of response
-- records in a subsequent request. If a value is returned in a response,
-- you can retrieve the next set of records by providing this returned
-- NextToken value in the next NextToken parameter and retrying the
-- command. If the NextToken field is empty, all response records have been
-- retrieved for the request.
--
-- 'tableName', 'describeTableResponse_tableName' - The table name.
--
-- 'httpStatus', 'describeTableResponse_httpStatus' - The response's http status code.
newDescribeTableResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DescribeTableResponse
newDescribeTableResponse :: Int -> DescribeTableResponse
newDescribeTableResponse Int
pHttpStatus_ =
  DescribeTableResponse'
    { $sel:columnList:DescribeTableResponse' :: Maybe [ColumnMetadata]
columnList =
        forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:DescribeTableResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:tableName:DescribeTableResponse' :: Maybe Text
tableName = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:DescribeTableResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | A list of columns in the table.
describeTableResponse_columnList :: Lens.Lens' DescribeTableResponse (Prelude.Maybe [ColumnMetadata])
describeTableResponse_columnList :: Lens' DescribeTableResponse (Maybe [ColumnMetadata])
describeTableResponse_columnList = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeTableResponse' {Maybe [ColumnMetadata]
columnList :: Maybe [ColumnMetadata]
$sel:columnList:DescribeTableResponse' :: DescribeTableResponse -> Maybe [ColumnMetadata]
columnList} -> Maybe [ColumnMetadata]
columnList) (\s :: DescribeTableResponse
s@DescribeTableResponse' {} Maybe [ColumnMetadata]
a -> DescribeTableResponse
s {$sel:columnList:DescribeTableResponse' :: Maybe [ColumnMetadata]
columnList = Maybe [ColumnMetadata]
a} :: DescribeTableResponse) 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

-- | A value that indicates the starting point for the next set of response
-- records in a subsequent request. If a value is returned in a response,
-- you can retrieve the next set of records by providing this returned
-- NextToken value in the next NextToken parameter and retrying the
-- command. If the NextToken field is empty, all response records have been
-- retrieved for the request.
describeTableResponse_nextToken :: Lens.Lens' DescribeTableResponse (Prelude.Maybe Prelude.Text)
describeTableResponse_nextToken :: Lens' DescribeTableResponse (Maybe Text)
describeTableResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeTableResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:DescribeTableResponse' :: DescribeTableResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: DescribeTableResponse
s@DescribeTableResponse' {} Maybe Text
a -> DescribeTableResponse
s {$sel:nextToken:DescribeTableResponse' :: Maybe Text
nextToken = Maybe Text
a} :: DescribeTableResponse)

-- | The table name.
describeTableResponse_tableName :: Lens.Lens' DescribeTableResponse (Prelude.Maybe Prelude.Text)
describeTableResponse_tableName :: Lens' DescribeTableResponse (Maybe Text)
describeTableResponse_tableName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeTableResponse' {Maybe Text
tableName :: Maybe Text
$sel:tableName:DescribeTableResponse' :: DescribeTableResponse -> Maybe Text
tableName} -> Maybe Text
tableName) (\s :: DescribeTableResponse
s@DescribeTableResponse' {} Maybe Text
a -> DescribeTableResponse
s {$sel:tableName:DescribeTableResponse' :: Maybe Text
tableName = Maybe Text
a} :: DescribeTableResponse)

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

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