{-# 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.DynamoDB.ListExports
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Lists completed exports within the past 90 days.
module Amazonka.DynamoDB.ListExports
  ( -- * Creating a Request
    ListExports (..),
    newListExports,

    -- * Request Lenses
    listExports_maxResults,
    listExports_nextToken,
    listExports_tableArn,

    -- * Destructuring the Response
    ListExportsResponse (..),
    newListExportsResponse,

    -- * Response Lenses
    listExportsResponse_exportSummaries,
    listExportsResponse_nextToken,
    listExportsResponse_httpStatus,
  )
where

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

-- | /See:/ 'newListExports' smart constructor.
data ListExports = ListExports'
  { -- | Maximum number of results to return per page.
    ListExports -> Maybe Natural
maxResults :: Prelude.Maybe Prelude.Natural,
    -- | An optional string that, if supplied, must be copied from the output of
    -- a previous call to @ListExports@. When provided in this manner, the API
    -- fetches the next page of results.
    ListExports -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The Amazon Resource Name (ARN) associated with the exported table.
    ListExports -> Maybe Text
tableArn :: Prelude.Maybe Prelude.Text
  }
  deriving (ListExports -> ListExports -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListExports -> ListExports -> Bool
$c/= :: ListExports -> ListExports -> Bool
== :: ListExports -> ListExports -> Bool
$c== :: ListExports -> ListExports -> Bool
Prelude.Eq, ReadPrec [ListExports]
ReadPrec ListExports
Int -> ReadS ListExports
ReadS [ListExports]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListExports]
$creadListPrec :: ReadPrec [ListExports]
readPrec :: ReadPrec ListExports
$creadPrec :: ReadPrec ListExports
readList :: ReadS [ListExports]
$creadList :: ReadS [ListExports]
readsPrec :: Int -> ReadS ListExports
$creadsPrec :: Int -> ReadS ListExports
Prelude.Read, Int -> ListExports -> ShowS
[ListExports] -> ShowS
ListExports -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListExports] -> ShowS
$cshowList :: [ListExports] -> ShowS
show :: ListExports -> String
$cshow :: ListExports -> String
showsPrec :: Int -> ListExports -> ShowS
$cshowsPrec :: Int -> ListExports -> ShowS
Prelude.Show, forall x. Rep ListExports x -> ListExports
forall x. ListExports -> Rep ListExports x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListExports x -> ListExports
$cfrom :: forall x. ListExports -> Rep ListExports x
Prelude.Generic)

-- |
-- Create a value of 'ListExports' 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', 'listExports_maxResults' - Maximum number of results to return per page.
--
-- 'nextToken', 'listExports_nextToken' - An optional string that, if supplied, must be copied from the output of
-- a previous call to @ListExports@. When provided in this manner, the API
-- fetches the next page of results.
--
-- 'tableArn', 'listExports_tableArn' - The Amazon Resource Name (ARN) associated with the exported table.
newListExports ::
  ListExports
newListExports :: ListExports
newListExports =
  ListExports'
    { $sel:maxResults:ListExports' :: Maybe Natural
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListExports' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:tableArn:ListExports' :: Maybe Text
tableArn = forall a. Maybe a
Prelude.Nothing
    }

-- | Maximum number of results to return per page.
listExports_maxResults :: Lens.Lens' ListExports (Prelude.Maybe Prelude.Natural)
listExports_maxResults :: Lens' ListExports (Maybe Natural)
listExports_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListExports' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:ListExports' :: ListExports -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: ListExports
s@ListExports' {} Maybe Natural
a -> ListExports
s {$sel:maxResults:ListExports' :: Maybe Natural
maxResults = Maybe Natural
a} :: ListExports)

-- | An optional string that, if supplied, must be copied from the output of
-- a previous call to @ListExports@. When provided in this manner, the API
-- fetches the next page of results.
listExports_nextToken :: Lens.Lens' ListExports (Prelude.Maybe Prelude.Text)
listExports_nextToken :: Lens' ListExports (Maybe Text)
listExports_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListExports' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListExports' :: ListExports -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListExports
s@ListExports' {} Maybe Text
a -> ListExports
s {$sel:nextToken:ListExports' :: Maybe Text
nextToken = Maybe Text
a} :: ListExports)

-- | The Amazon Resource Name (ARN) associated with the exported table.
listExports_tableArn :: Lens.Lens' ListExports (Prelude.Maybe Prelude.Text)
listExports_tableArn :: Lens' ListExports (Maybe Text)
listExports_tableArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListExports' {Maybe Text
tableArn :: Maybe Text
$sel:tableArn:ListExports' :: ListExports -> Maybe Text
tableArn} -> Maybe Text
tableArn) (\s :: ListExports
s@ListExports' {} Maybe Text
a -> ListExports
s {$sel:tableArn:ListExports' :: Maybe Text
tableArn = Maybe Text
a} :: ListExports)

instance Core.AWSRequest ListExports where
  type AWSResponse ListExports = ListExportsResponse
  request :: (Service -> Service) -> ListExports -> Request ListExports
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 ListExports
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse ListExports)))
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 [ExportSummary] -> Maybe Text -> Int -> ListExportsResponse
ListExportsResponse'
            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
"ExportSummaries"
                            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 ListExports where
  hashWithSalt :: Int -> ListExports -> Int
hashWithSalt Int
_salt ListExports' {Maybe Natural
Maybe Text
tableArn :: Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:tableArn:ListExports' :: ListExports -> Maybe Text
$sel:nextToken:ListExports' :: ListExports -> Maybe Text
$sel:maxResults:ListExports' :: ListExports -> 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 Text
tableArn

instance Prelude.NFData ListExports where
  rnf :: ListExports -> ()
rnf ListExports' {Maybe Natural
Maybe Text
tableArn :: Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:tableArn:ListExports' :: ListExports -> Maybe Text
$sel:nextToken:ListExports' :: ListExports -> Maybe Text
$sel:maxResults:ListExports' :: ListExports -> 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 Text
tableArn

instance Data.ToHeaders ListExports where
  toHeaders :: ListExports -> 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
"DynamoDB_20120810.ListExports" ::
                          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 ListExports where
  toJSON :: ListExports -> Value
toJSON ListExports' {Maybe Natural
Maybe Text
tableArn :: Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:tableArn:ListExports' :: ListExports -> Maybe Text
$sel:nextToken:ListExports' :: ListExports -> Maybe Text
$sel:maxResults:ListExports' :: ListExports -> 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
"TableArn" 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
tableArn
          ]
      )

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

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

-- | /See:/ 'newListExportsResponse' smart constructor.
data ListExportsResponse = ListExportsResponse'
  { -- | A list of @ExportSummary@ objects.
    ListExportsResponse -> Maybe [ExportSummary]
exportSummaries :: Prelude.Maybe [ExportSummary],
    -- | If this value is returned, there are additional results to be displayed.
    -- To retrieve them, call @ListExports@ again, with @NextToken@ set to this
    -- value.
    ListExportsResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    ListExportsResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (ListExportsResponse -> ListExportsResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListExportsResponse -> ListExportsResponse -> Bool
$c/= :: ListExportsResponse -> ListExportsResponse -> Bool
== :: ListExportsResponse -> ListExportsResponse -> Bool
$c== :: ListExportsResponse -> ListExportsResponse -> Bool
Prelude.Eq, ReadPrec [ListExportsResponse]
ReadPrec ListExportsResponse
Int -> ReadS ListExportsResponse
ReadS [ListExportsResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListExportsResponse]
$creadListPrec :: ReadPrec [ListExportsResponse]
readPrec :: ReadPrec ListExportsResponse
$creadPrec :: ReadPrec ListExportsResponse
readList :: ReadS [ListExportsResponse]
$creadList :: ReadS [ListExportsResponse]
readsPrec :: Int -> ReadS ListExportsResponse
$creadsPrec :: Int -> ReadS ListExportsResponse
Prelude.Read, Int -> ListExportsResponse -> ShowS
[ListExportsResponse] -> ShowS
ListExportsResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListExportsResponse] -> ShowS
$cshowList :: [ListExportsResponse] -> ShowS
show :: ListExportsResponse -> String
$cshow :: ListExportsResponse -> String
showsPrec :: Int -> ListExportsResponse -> ShowS
$cshowsPrec :: Int -> ListExportsResponse -> ShowS
Prelude.Show, forall x. Rep ListExportsResponse x -> ListExportsResponse
forall x. ListExportsResponse -> Rep ListExportsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListExportsResponse x -> ListExportsResponse
$cfrom :: forall x. ListExportsResponse -> Rep ListExportsResponse x
Prelude.Generic)

-- |
-- Create a value of 'ListExportsResponse' 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:
--
-- 'exportSummaries', 'listExportsResponse_exportSummaries' - A list of @ExportSummary@ objects.
--
-- 'nextToken', 'listExportsResponse_nextToken' - If this value is returned, there are additional results to be displayed.
-- To retrieve them, call @ListExports@ again, with @NextToken@ set to this
-- value.
--
-- 'httpStatus', 'listExportsResponse_httpStatus' - The response's http status code.
newListExportsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListExportsResponse
newListExportsResponse :: Int -> ListExportsResponse
newListExportsResponse Int
pHttpStatus_ =
  ListExportsResponse'
    { $sel:exportSummaries:ListExportsResponse' :: Maybe [ExportSummary]
exportSummaries =
        forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListExportsResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:ListExportsResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | A list of @ExportSummary@ objects.
listExportsResponse_exportSummaries :: Lens.Lens' ListExportsResponse (Prelude.Maybe [ExportSummary])
listExportsResponse_exportSummaries :: Lens' ListExportsResponse (Maybe [ExportSummary])
listExportsResponse_exportSummaries = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListExportsResponse' {Maybe [ExportSummary]
exportSummaries :: Maybe [ExportSummary]
$sel:exportSummaries:ListExportsResponse' :: ListExportsResponse -> Maybe [ExportSummary]
exportSummaries} -> Maybe [ExportSummary]
exportSummaries) (\s :: ListExportsResponse
s@ListExportsResponse' {} Maybe [ExportSummary]
a -> ListExportsResponse
s {$sel:exportSummaries:ListExportsResponse' :: Maybe [ExportSummary]
exportSummaries = Maybe [ExportSummary]
a} :: ListExportsResponse) 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 this value is returned, there are additional results to be displayed.
-- To retrieve them, call @ListExports@ again, with @NextToken@ set to this
-- value.
listExportsResponse_nextToken :: Lens.Lens' ListExportsResponse (Prelude.Maybe Prelude.Text)
listExportsResponse_nextToken :: Lens' ListExportsResponse (Maybe Text)
listExportsResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListExportsResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListExportsResponse' :: ListExportsResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListExportsResponse
s@ListExportsResponse' {} Maybe Text
a -> ListExportsResponse
s {$sel:nextToken:ListExportsResponse' :: Maybe Text
nextToken = Maybe Text
a} :: ListExportsResponse)

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

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