{-# 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.Transfer.ListCertificates
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Returns a list of the current certificates that have been imported into
-- Transfer Family. If you want to limit the results to a certain number,
-- supply a value for the @MaxResults@ parameter. If you ran the command
-- previously and received a value for the @NextToken@ parameter, you can
-- supply that value to continue listing certificates from where you left
-- off.
--
-- This operation returns paginated results.
module Amazonka.Transfer.ListCertificates
  ( -- * Creating a Request
    ListCertificates (..),
    newListCertificates,

    -- * Request Lenses
    listCertificates_maxResults,
    listCertificates_nextToken,

    -- * Destructuring the Response
    ListCertificatesResponse (..),
    newListCertificatesResponse,

    -- * Response Lenses
    listCertificatesResponse_nextToken,
    listCertificatesResponse_httpStatus,
    listCertificatesResponse_certificates,
  )
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.Transfer.Types

-- | /See:/ 'newListCertificates' smart constructor.
data ListCertificates = ListCertificates'
  { -- | The maximum number of certificates to return.
    ListCertificates -> Maybe Natural
maxResults :: Prelude.Maybe Prelude.Natural,
    -- | When you can get additional results from the @ListCertificates@ call, a
    -- @NextToken@ parameter is returned in the output. You can then pass in a
    -- subsequent command to the @NextToken@ parameter to continue listing
    -- additional certificates.
    ListCertificates -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text
  }
  deriving (ListCertificates -> ListCertificates -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListCertificates -> ListCertificates -> Bool
$c/= :: ListCertificates -> ListCertificates -> Bool
== :: ListCertificates -> ListCertificates -> Bool
$c== :: ListCertificates -> ListCertificates -> Bool
Prelude.Eq, ReadPrec [ListCertificates]
ReadPrec ListCertificates
Int -> ReadS ListCertificates
ReadS [ListCertificates]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListCertificates]
$creadListPrec :: ReadPrec [ListCertificates]
readPrec :: ReadPrec ListCertificates
$creadPrec :: ReadPrec ListCertificates
readList :: ReadS [ListCertificates]
$creadList :: ReadS [ListCertificates]
readsPrec :: Int -> ReadS ListCertificates
$creadsPrec :: Int -> ReadS ListCertificates
Prelude.Read, Int -> ListCertificates -> ShowS
[ListCertificates] -> ShowS
ListCertificates -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListCertificates] -> ShowS
$cshowList :: [ListCertificates] -> ShowS
show :: ListCertificates -> String
$cshow :: ListCertificates -> String
showsPrec :: Int -> ListCertificates -> ShowS
$cshowsPrec :: Int -> ListCertificates -> ShowS
Prelude.Show, forall x. Rep ListCertificates x -> ListCertificates
forall x. ListCertificates -> Rep ListCertificates x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListCertificates x -> ListCertificates
$cfrom :: forall x. ListCertificates -> Rep ListCertificates x
Prelude.Generic)

-- |
-- Create a value of 'ListCertificates' 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', 'listCertificates_maxResults' - The maximum number of certificates to return.
--
-- 'nextToken', 'listCertificates_nextToken' - When you can get additional results from the @ListCertificates@ call, a
-- @NextToken@ parameter is returned in the output. You can then pass in a
-- subsequent command to the @NextToken@ parameter to continue listing
-- additional certificates.
newListCertificates ::
  ListCertificates
newListCertificates :: ListCertificates
newListCertificates =
  ListCertificates'
    { $sel:maxResults:ListCertificates' :: Maybe Natural
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListCertificates' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing
    }

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

-- | When you can get additional results from the @ListCertificates@ call, a
-- @NextToken@ parameter is returned in the output. You can then pass in a
-- subsequent command to the @NextToken@ parameter to continue listing
-- additional certificates.
listCertificates_nextToken :: Lens.Lens' ListCertificates (Prelude.Maybe Prelude.Text)
listCertificates_nextToken :: Lens' ListCertificates (Maybe Text)
listCertificates_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListCertificates' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListCertificates' :: ListCertificates -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListCertificates
s@ListCertificates' {} Maybe Text
a -> ListCertificates
s {$sel:nextToken:ListCertificates' :: Maybe Text
nextToken = Maybe Text
a} :: ListCertificates)

instance Core.AWSPager ListCertificates where
  page :: ListCertificates
-> AWSResponse ListCertificates -> Maybe ListCertificates
page ListCertificates
rq AWSResponse ListCertificates
rs
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse ListCertificates
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListCertificatesResponse (Maybe Text)
listCertificatesResponse_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 ListCertificates
rs forall s a. s -> Getting a s a -> a
Lens.^. Lens' ListCertificatesResponse [ListedCertificate]
listCertificatesResponse_certificates) =
        forall a. Maybe a
Prelude.Nothing
    | Bool
Prelude.otherwise =
        forall a. a -> Maybe a
Prelude.Just
          forall a b. (a -> b) -> a -> b
Prelude.$ ListCertificates
rq
          forall a b. a -> (a -> b) -> b
Prelude.& Lens' ListCertificates (Maybe Text)
listCertificates_nextToken
          forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse ListCertificates
rs
          forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListCertificatesResponse (Maybe Text)
listCertificatesResponse_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 ListCertificates where
  type
    AWSResponse ListCertificates =
      ListCertificatesResponse
  request :: (Service -> Service)
-> ListCertificates -> Request ListCertificates
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 ListCertificates
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse ListCertificates)))
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
-> Int -> [ListedCertificate] -> ListCertificatesResponse
ListCertificatesResponse'
            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.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
            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
"Certificates" forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty)
      )

instance Prelude.Hashable ListCertificates where
  hashWithSalt :: Int -> ListCertificates -> Int
hashWithSalt Int
_salt ListCertificates' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:nextToken:ListCertificates' :: ListCertificates -> Maybe Text
$sel:maxResults:ListCertificates' :: ListCertificates -> 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

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

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

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

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

-- | /See:/ 'newListCertificatesResponse' smart constructor.
data ListCertificatesResponse = ListCertificatesResponse'
  { -- | Returns the next token, which you can use to list the next certificate.
    ListCertificatesResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    ListCertificatesResponse -> Int
httpStatus :: Prelude.Int,
    -- | Returns an array of the certificates that are specified in the
    -- @ListCertificates@ call.
    ListCertificatesResponse -> [ListedCertificate]
certificates :: [ListedCertificate]
  }
  deriving (ListCertificatesResponse -> ListCertificatesResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListCertificatesResponse -> ListCertificatesResponse -> Bool
$c/= :: ListCertificatesResponse -> ListCertificatesResponse -> Bool
== :: ListCertificatesResponse -> ListCertificatesResponse -> Bool
$c== :: ListCertificatesResponse -> ListCertificatesResponse -> Bool
Prelude.Eq, ReadPrec [ListCertificatesResponse]
ReadPrec ListCertificatesResponse
Int -> ReadS ListCertificatesResponse
ReadS [ListCertificatesResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListCertificatesResponse]
$creadListPrec :: ReadPrec [ListCertificatesResponse]
readPrec :: ReadPrec ListCertificatesResponse
$creadPrec :: ReadPrec ListCertificatesResponse
readList :: ReadS [ListCertificatesResponse]
$creadList :: ReadS [ListCertificatesResponse]
readsPrec :: Int -> ReadS ListCertificatesResponse
$creadsPrec :: Int -> ReadS ListCertificatesResponse
Prelude.Read, Int -> ListCertificatesResponse -> ShowS
[ListCertificatesResponse] -> ShowS
ListCertificatesResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListCertificatesResponse] -> ShowS
$cshowList :: [ListCertificatesResponse] -> ShowS
show :: ListCertificatesResponse -> String
$cshow :: ListCertificatesResponse -> String
showsPrec :: Int -> ListCertificatesResponse -> ShowS
$cshowsPrec :: Int -> ListCertificatesResponse -> ShowS
Prelude.Show, forall x.
Rep ListCertificatesResponse x -> ListCertificatesResponse
forall x.
ListCertificatesResponse -> Rep ListCertificatesResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep ListCertificatesResponse x -> ListCertificatesResponse
$cfrom :: forall x.
ListCertificatesResponse -> Rep ListCertificatesResponse x
Prelude.Generic)

-- |
-- Create a value of 'ListCertificatesResponse' 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', 'listCertificatesResponse_nextToken' - Returns the next token, which you can use to list the next certificate.
--
-- 'httpStatus', 'listCertificatesResponse_httpStatus' - The response's http status code.
--
-- 'certificates', 'listCertificatesResponse_certificates' - Returns an array of the certificates that are specified in the
-- @ListCertificates@ call.
newListCertificatesResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListCertificatesResponse
newListCertificatesResponse :: Int -> ListCertificatesResponse
newListCertificatesResponse Int
pHttpStatus_ =
  ListCertificatesResponse'
    { $sel:nextToken:ListCertificatesResponse' :: Maybe Text
nextToken =
        forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:ListCertificatesResponse' :: Int
httpStatus = Int
pHttpStatus_,
      $sel:certificates:ListCertificatesResponse' :: [ListedCertificate]
certificates = forall a. Monoid a => a
Prelude.mempty
    }

-- | Returns the next token, which you can use to list the next certificate.
listCertificatesResponse_nextToken :: Lens.Lens' ListCertificatesResponse (Prelude.Maybe Prelude.Text)
listCertificatesResponse_nextToken :: Lens' ListCertificatesResponse (Maybe Text)
listCertificatesResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListCertificatesResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListCertificatesResponse' :: ListCertificatesResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListCertificatesResponse
s@ListCertificatesResponse' {} Maybe Text
a -> ListCertificatesResponse
s {$sel:nextToken:ListCertificatesResponse' :: Maybe Text
nextToken = Maybe Text
a} :: ListCertificatesResponse)

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

-- | Returns an array of the certificates that are specified in the
-- @ListCertificates@ call.
listCertificatesResponse_certificates :: Lens.Lens' ListCertificatesResponse [ListedCertificate]
listCertificatesResponse_certificates :: Lens' ListCertificatesResponse [ListedCertificate]
listCertificatesResponse_certificates = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListCertificatesResponse' {[ListedCertificate]
certificates :: [ListedCertificate]
$sel:certificates:ListCertificatesResponse' :: ListCertificatesResponse -> [ListedCertificate]
certificates} -> [ListedCertificate]
certificates) (\s :: ListCertificatesResponse
s@ListCertificatesResponse' {} [ListedCertificate]
a -> ListCertificatesResponse
s {$sel:certificates:ListCertificatesResponse' :: [ListedCertificate]
certificates = [ListedCertificate]
a} :: ListCertificatesResponse) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

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