{-# 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.ListWorkflows
-- 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 all of your workflows.
--
-- This operation returns paginated results.
module Amazonka.Transfer.ListWorkflows
  ( -- * Creating a Request
    ListWorkflows (..),
    newListWorkflows,

    -- * Request Lenses
    listWorkflows_maxResults,
    listWorkflows_nextToken,

    -- * Destructuring the Response
    ListWorkflowsResponse (..),
    newListWorkflowsResponse,

    -- * Response Lenses
    listWorkflowsResponse_nextToken,
    listWorkflowsResponse_httpStatus,
    listWorkflowsResponse_workflows,
  )
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:/ 'newListWorkflows' smart constructor.
data ListWorkflows = ListWorkflows'
  { -- | Specifies the maximum number of workflows to return.
    ListWorkflows -> Maybe Natural
maxResults :: Prelude.Maybe Prelude.Natural,
    -- | @ListWorkflows@ returns the @NextToken@ parameter in the output. You can
    -- then pass the @NextToken@ parameter in a subsequent command to continue
    -- listing additional workflows.
    ListWorkflows -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text
  }
  deriving (ListWorkflows -> ListWorkflows -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListWorkflows -> ListWorkflows -> Bool
$c/= :: ListWorkflows -> ListWorkflows -> Bool
== :: ListWorkflows -> ListWorkflows -> Bool
$c== :: ListWorkflows -> ListWorkflows -> Bool
Prelude.Eq, ReadPrec [ListWorkflows]
ReadPrec ListWorkflows
Int -> ReadS ListWorkflows
ReadS [ListWorkflows]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListWorkflows]
$creadListPrec :: ReadPrec [ListWorkflows]
readPrec :: ReadPrec ListWorkflows
$creadPrec :: ReadPrec ListWorkflows
readList :: ReadS [ListWorkflows]
$creadList :: ReadS [ListWorkflows]
readsPrec :: Int -> ReadS ListWorkflows
$creadsPrec :: Int -> ReadS ListWorkflows
Prelude.Read, Int -> ListWorkflows -> ShowS
[ListWorkflows] -> ShowS
ListWorkflows -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListWorkflows] -> ShowS
$cshowList :: [ListWorkflows] -> ShowS
show :: ListWorkflows -> String
$cshow :: ListWorkflows -> String
showsPrec :: Int -> ListWorkflows -> ShowS
$cshowsPrec :: Int -> ListWorkflows -> ShowS
Prelude.Show, forall x. Rep ListWorkflows x -> ListWorkflows
forall x. ListWorkflows -> Rep ListWorkflows x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListWorkflows x -> ListWorkflows
$cfrom :: forall x. ListWorkflows -> Rep ListWorkflows x
Prelude.Generic)

-- |
-- Create a value of 'ListWorkflows' 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', 'listWorkflows_maxResults' - Specifies the maximum number of workflows to return.
--
-- 'nextToken', 'listWorkflows_nextToken' - @ListWorkflows@ returns the @NextToken@ parameter in the output. You can
-- then pass the @NextToken@ parameter in a subsequent command to continue
-- listing additional workflows.
newListWorkflows ::
  ListWorkflows
newListWorkflows :: ListWorkflows
newListWorkflows =
  ListWorkflows'
    { $sel:maxResults:ListWorkflows' :: Maybe Natural
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListWorkflows' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing
    }

-- | Specifies the maximum number of workflows to return.
listWorkflows_maxResults :: Lens.Lens' ListWorkflows (Prelude.Maybe Prelude.Natural)
listWorkflows_maxResults :: Lens' ListWorkflows (Maybe Natural)
listWorkflows_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListWorkflows' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:ListWorkflows' :: ListWorkflows -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: ListWorkflows
s@ListWorkflows' {} Maybe Natural
a -> ListWorkflows
s {$sel:maxResults:ListWorkflows' :: Maybe Natural
maxResults = Maybe Natural
a} :: ListWorkflows)

-- | @ListWorkflows@ returns the @NextToken@ parameter in the output. You can
-- then pass the @NextToken@ parameter in a subsequent command to continue
-- listing additional workflows.
listWorkflows_nextToken :: Lens.Lens' ListWorkflows (Prelude.Maybe Prelude.Text)
listWorkflows_nextToken :: Lens' ListWorkflows (Maybe Text)
listWorkflows_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListWorkflows' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListWorkflows' :: ListWorkflows -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListWorkflows
s@ListWorkflows' {} Maybe Text
a -> ListWorkflows
s {$sel:nextToken:ListWorkflows' :: Maybe Text
nextToken = Maybe Text
a} :: ListWorkflows)

instance Core.AWSPager ListWorkflows where
  page :: ListWorkflows -> AWSResponse ListWorkflows -> Maybe ListWorkflows
page ListWorkflows
rq AWSResponse ListWorkflows
rs
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse ListWorkflows
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListWorkflowsResponse (Maybe Text)
listWorkflowsResponse_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 ListWorkflows
rs forall s a. s -> Getting a s a -> a
Lens.^. Lens' ListWorkflowsResponse [ListedWorkflow]
listWorkflowsResponse_workflows) =
        forall a. Maybe a
Prelude.Nothing
    | Bool
Prelude.otherwise =
        forall a. a -> Maybe a
Prelude.Just
          forall a b. (a -> b) -> a -> b
Prelude.$ ListWorkflows
rq
          forall a b. a -> (a -> b) -> b
Prelude.& Lens' ListWorkflows (Maybe Text)
listWorkflows_nextToken
          forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse ListWorkflows
rs
          forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListWorkflowsResponse (Maybe Text)
listWorkflowsResponse_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 ListWorkflows where
  type
    AWSResponse ListWorkflows =
      ListWorkflowsResponse
  request :: (Service -> Service) -> ListWorkflows -> Request ListWorkflows
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 ListWorkflows
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse ListWorkflows)))
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 -> [ListedWorkflow] -> ListWorkflowsResponse
ListWorkflowsResponse'
            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
"Workflows" forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty)
      )

instance Prelude.Hashable ListWorkflows where
  hashWithSalt :: Int -> ListWorkflows -> Int
hashWithSalt Int
_salt ListWorkflows' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:nextToken:ListWorkflows' :: ListWorkflows -> Maybe Text
$sel:maxResults:ListWorkflows' :: ListWorkflows -> 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 ListWorkflows where
  rnf :: ListWorkflows -> ()
rnf ListWorkflows' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:nextToken:ListWorkflows' :: ListWorkflows -> Maybe Text
$sel:maxResults:ListWorkflows' :: ListWorkflows -> 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 ListWorkflows where
  toHeaders :: ListWorkflows -> 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.ListWorkflows" ::
                          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 ListWorkflows where
  toJSON :: ListWorkflows -> Value
toJSON ListWorkflows' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:nextToken:ListWorkflows' :: ListWorkflows -> Maybe Text
$sel:maxResults:ListWorkflows' :: ListWorkflows -> 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 ListWorkflows where
  toPath :: ListWorkflows -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/"

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

-- | /See:/ 'newListWorkflowsResponse' smart constructor.
data ListWorkflowsResponse = ListWorkflowsResponse'
  { -- | @ListWorkflows@ returns the @NextToken@ parameter in the output. You can
    -- then pass the @NextToken@ parameter in a subsequent command to continue
    -- listing additional workflows.
    ListWorkflowsResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    ListWorkflowsResponse -> Int
httpStatus :: Prelude.Int,
    -- | Returns the @Arn@, @WorkflowId@, and @Description@ for each workflow.
    ListWorkflowsResponse -> [ListedWorkflow]
workflows :: [ListedWorkflow]
  }
  deriving (ListWorkflowsResponse -> ListWorkflowsResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListWorkflowsResponse -> ListWorkflowsResponse -> Bool
$c/= :: ListWorkflowsResponse -> ListWorkflowsResponse -> Bool
== :: ListWorkflowsResponse -> ListWorkflowsResponse -> Bool
$c== :: ListWorkflowsResponse -> ListWorkflowsResponse -> Bool
Prelude.Eq, ReadPrec [ListWorkflowsResponse]
ReadPrec ListWorkflowsResponse
Int -> ReadS ListWorkflowsResponse
ReadS [ListWorkflowsResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListWorkflowsResponse]
$creadListPrec :: ReadPrec [ListWorkflowsResponse]
readPrec :: ReadPrec ListWorkflowsResponse
$creadPrec :: ReadPrec ListWorkflowsResponse
readList :: ReadS [ListWorkflowsResponse]
$creadList :: ReadS [ListWorkflowsResponse]
readsPrec :: Int -> ReadS ListWorkflowsResponse
$creadsPrec :: Int -> ReadS ListWorkflowsResponse
Prelude.Read, Int -> ListWorkflowsResponse -> ShowS
[ListWorkflowsResponse] -> ShowS
ListWorkflowsResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListWorkflowsResponse] -> ShowS
$cshowList :: [ListWorkflowsResponse] -> ShowS
show :: ListWorkflowsResponse -> String
$cshow :: ListWorkflowsResponse -> String
showsPrec :: Int -> ListWorkflowsResponse -> ShowS
$cshowsPrec :: Int -> ListWorkflowsResponse -> ShowS
Prelude.Show, forall x. Rep ListWorkflowsResponse x -> ListWorkflowsResponse
forall x. ListWorkflowsResponse -> Rep ListWorkflowsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListWorkflowsResponse x -> ListWorkflowsResponse
$cfrom :: forall x. ListWorkflowsResponse -> Rep ListWorkflowsResponse x
Prelude.Generic)

-- |
-- Create a value of 'ListWorkflowsResponse' 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', 'listWorkflowsResponse_nextToken' - @ListWorkflows@ returns the @NextToken@ parameter in the output. You can
-- then pass the @NextToken@ parameter in a subsequent command to continue
-- listing additional workflows.
--
-- 'httpStatus', 'listWorkflowsResponse_httpStatus' - The response's http status code.
--
-- 'workflows', 'listWorkflowsResponse_workflows' - Returns the @Arn@, @WorkflowId@, and @Description@ for each workflow.
newListWorkflowsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListWorkflowsResponse
newListWorkflowsResponse :: Int -> ListWorkflowsResponse
newListWorkflowsResponse Int
pHttpStatus_ =
  ListWorkflowsResponse'
    { $sel:nextToken:ListWorkflowsResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:ListWorkflowsResponse' :: Int
httpStatus = Int
pHttpStatus_,
      $sel:workflows:ListWorkflowsResponse' :: [ListedWorkflow]
workflows = forall a. Monoid a => a
Prelude.mempty
    }

-- | @ListWorkflows@ returns the @NextToken@ parameter in the output. You can
-- then pass the @NextToken@ parameter in a subsequent command to continue
-- listing additional workflows.
listWorkflowsResponse_nextToken :: Lens.Lens' ListWorkflowsResponse (Prelude.Maybe Prelude.Text)
listWorkflowsResponse_nextToken :: Lens' ListWorkflowsResponse (Maybe Text)
listWorkflowsResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListWorkflowsResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListWorkflowsResponse' :: ListWorkflowsResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListWorkflowsResponse
s@ListWorkflowsResponse' {} Maybe Text
a -> ListWorkflowsResponse
s {$sel:nextToken:ListWorkflowsResponse' :: Maybe Text
nextToken = Maybe Text
a} :: ListWorkflowsResponse)

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

-- | Returns the @Arn@, @WorkflowId@, and @Description@ for each workflow.
listWorkflowsResponse_workflows :: Lens.Lens' ListWorkflowsResponse [ListedWorkflow]
listWorkflowsResponse_workflows :: Lens' ListWorkflowsResponse [ListedWorkflow]
listWorkflowsResponse_workflows = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListWorkflowsResponse' {[ListedWorkflow]
workflows :: [ListedWorkflow]
$sel:workflows:ListWorkflowsResponse' :: ListWorkflowsResponse -> [ListedWorkflow]
workflows} -> [ListedWorkflow]
workflows) (\s :: ListWorkflowsResponse
s@ListWorkflowsResponse' {} [ListedWorkflow]
a -> ListWorkflowsResponse
s {$sel:workflows:ListWorkflowsResponse' :: [ListedWorkflow]
workflows = [ListedWorkflow]
a} :: ListWorkflowsResponse) 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 ListWorkflowsResponse where
  rnf :: ListWorkflowsResponse -> ()
rnf ListWorkflowsResponse' {Int
[ListedWorkflow]
Maybe Text
workflows :: [ListedWorkflow]
httpStatus :: Int
nextToken :: Maybe Text
$sel:workflows:ListWorkflowsResponse' :: ListWorkflowsResponse -> [ListedWorkflow]
$sel:httpStatus:ListWorkflowsResponse' :: ListWorkflowsResponse -> Int
$sel:nextToken:ListWorkflowsResponse' :: ListWorkflowsResponse -> 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 [ListedWorkflow]
workflows