{-# 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.DeviceFarm.ListProjects
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Gets information about projects.
--
-- This operation returns paginated results.
module Amazonka.DeviceFarm.ListProjects
  ( -- * Creating a Request
    ListProjects (..),
    newListProjects,

    -- * Request Lenses
    listProjects_arn,
    listProjects_nextToken,

    -- * Destructuring the Response
    ListProjectsResponse (..),
    newListProjectsResponse,

    -- * Response Lenses
    listProjectsResponse_nextToken,
    listProjectsResponse_projects,
    listProjectsResponse_httpStatus,
  )
where

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

-- | Represents a request to the list projects operation.
--
-- /See:/ 'newListProjects' smart constructor.
data ListProjects = ListProjects'
  { -- | Optional. If no Amazon Resource Name (ARN) is specified, then AWS Device
    -- Farm returns a list of all projects for the AWS account. You can also
    -- specify a project ARN.
    ListProjects -> Maybe Text
arn :: Prelude.Maybe Prelude.Text,
    -- | An identifier that was returned from the previous call to this
    -- operation, which can be used to return the next set of items in the
    -- list.
    ListProjects -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text
  }
  deriving (ListProjects -> ListProjects -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListProjects -> ListProjects -> Bool
$c/= :: ListProjects -> ListProjects -> Bool
== :: ListProjects -> ListProjects -> Bool
$c== :: ListProjects -> ListProjects -> Bool
Prelude.Eq, ReadPrec [ListProjects]
ReadPrec ListProjects
Int -> ReadS ListProjects
ReadS [ListProjects]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListProjects]
$creadListPrec :: ReadPrec [ListProjects]
readPrec :: ReadPrec ListProjects
$creadPrec :: ReadPrec ListProjects
readList :: ReadS [ListProjects]
$creadList :: ReadS [ListProjects]
readsPrec :: Int -> ReadS ListProjects
$creadsPrec :: Int -> ReadS ListProjects
Prelude.Read, Int -> ListProjects -> ShowS
[ListProjects] -> ShowS
ListProjects -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListProjects] -> ShowS
$cshowList :: [ListProjects] -> ShowS
show :: ListProjects -> String
$cshow :: ListProjects -> String
showsPrec :: Int -> ListProjects -> ShowS
$cshowsPrec :: Int -> ListProjects -> ShowS
Prelude.Show, forall x. Rep ListProjects x -> ListProjects
forall x. ListProjects -> Rep ListProjects x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListProjects x -> ListProjects
$cfrom :: forall x. ListProjects -> Rep ListProjects x
Prelude.Generic)

-- |
-- Create a value of 'ListProjects' 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:
--
-- 'arn', 'listProjects_arn' - Optional. If no Amazon Resource Name (ARN) is specified, then AWS Device
-- Farm returns a list of all projects for the AWS account. You can also
-- specify a project ARN.
--
-- 'nextToken', 'listProjects_nextToken' - An identifier that was returned from the previous call to this
-- operation, which can be used to return the next set of items in the
-- list.
newListProjects ::
  ListProjects
newListProjects :: ListProjects
newListProjects =
  ListProjects'
    { $sel:arn:ListProjects' :: Maybe Text
arn = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListProjects' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing
    }

-- | Optional. If no Amazon Resource Name (ARN) is specified, then AWS Device
-- Farm returns a list of all projects for the AWS account. You can also
-- specify a project ARN.
listProjects_arn :: Lens.Lens' ListProjects (Prelude.Maybe Prelude.Text)
listProjects_arn :: Lens' ListProjects (Maybe Text)
listProjects_arn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListProjects' {Maybe Text
arn :: Maybe Text
$sel:arn:ListProjects' :: ListProjects -> Maybe Text
arn} -> Maybe Text
arn) (\s :: ListProjects
s@ListProjects' {} Maybe Text
a -> ListProjects
s {$sel:arn:ListProjects' :: Maybe Text
arn = Maybe Text
a} :: ListProjects)

-- | An identifier that was returned from the previous call to this
-- operation, which can be used to return the next set of items in the
-- list.
listProjects_nextToken :: Lens.Lens' ListProjects (Prelude.Maybe Prelude.Text)
listProjects_nextToken :: Lens' ListProjects (Maybe Text)
listProjects_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListProjects' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListProjects' :: ListProjects -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListProjects
s@ListProjects' {} Maybe Text
a -> ListProjects
s {$sel:nextToken:ListProjects' :: Maybe Text
nextToken = Maybe Text
a} :: ListProjects)

instance Core.AWSPager ListProjects where
  page :: ListProjects -> AWSResponse ListProjects -> Maybe ListProjects
page ListProjects
rq AWSResponse ListProjects
rs
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse ListProjects
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListProjectsResponse (Maybe Text)
listProjectsResponse_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 ListProjects
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListProjectsResponse (Maybe [Project])
listProjectsResponse_projects
            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.$ ListProjects
rq
          forall a b. a -> (a -> b) -> b
Prelude.& Lens' ListProjects (Maybe Text)
listProjects_nextToken
          forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse ListProjects
rs
          forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListProjectsResponse (Maybe Text)
listProjectsResponse_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 ListProjects where
  type AWSResponse ListProjects = ListProjectsResponse
  request :: (Service -> Service) -> ListProjects -> Request ListProjects
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 ListProjects
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse ListProjects)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe Text -> Maybe [Project] -> Int -> ListProjectsResponse
ListProjectsResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"nextToken")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"projects" forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty)
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable ListProjects where
  hashWithSalt :: Int -> ListProjects -> Int
hashWithSalt Int
_salt ListProjects' {Maybe Text
nextToken :: Maybe Text
arn :: Maybe Text
$sel:nextToken:ListProjects' :: ListProjects -> Maybe Text
$sel:arn:ListProjects' :: ListProjects -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
arn
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
nextToken

instance Prelude.NFData ListProjects where
  rnf :: ListProjects -> ()
rnf ListProjects' {Maybe Text
nextToken :: Maybe Text
arn :: Maybe Text
$sel:nextToken:ListProjects' :: ListProjects -> Maybe Text
$sel:arn:ListProjects' :: ListProjects -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
arn seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
nextToken

instance Data.ToHeaders ListProjects where
  toHeaders :: ListProjects -> 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
"DeviceFarm_20150623.ListProjects" ::
                          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 ListProjects where
  toJSON :: ListProjects -> Value
toJSON ListProjects' {Maybe Text
nextToken :: Maybe Text
arn :: Maybe Text
$sel:nextToken:ListProjects' :: ListProjects -> Maybe Text
$sel:arn:ListProjects' :: ListProjects -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"arn" 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
arn,
            (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 ListProjects where
  toPath :: ListProjects -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/"

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

-- | Represents the result of a list projects request.
--
-- /See:/ 'newListProjectsResponse' smart constructor.
data ListProjectsResponse = ListProjectsResponse'
  { -- | If the number of items that are returned is significantly large, this is
    -- an identifier that is also returned. It can be used in a subsequent call
    -- to this operation to return the next set of items in the list.
    ListProjectsResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | Information about the projects.
    ListProjectsResponse -> Maybe [Project]
projects :: Prelude.Maybe [Project],
    -- | The response's http status code.
    ListProjectsResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (ListProjectsResponse -> ListProjectsResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListProjectsResponse -> ListProjectsResponse -> Bool
$c/= :: ListProjectsResponse -> ListProjectsResponse -> Bool
== :: ListProjectsResponse -> ListProjectsResponse -> Bool
$c== :: ListProjectsResponse -> ListProjectsResponse -> Bool
Prelude.Eq, ReadPrec [ListProjectsResponse]
ReadPrec ListProjectsResponse
Int -> ReadS ListProjectsResponse
ReadS [ListProjectsResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListProjectsResponse]
$creadListPrec :: ReadPrec [ListProjectsResponse]
readPrec :: ReadPrec ListProjectsResponse
$creadPrec :: ReadPrec ListProjectsResponse
readList :: ReadS [ListProjectsResponse]
$creadList :: ReadS [ListProjectsResponse]
readsPrec :: Int -> ReadS ListProjectsResponse
$creadsPrec :: Int -> ReadS ListProjectsResponse
Prelude.Read, Int -> ListProjectsResponse -> ShowS
[ListProjectsResponse] -> ShowS
ListProjectsResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListProjectsResponse] -> ShowS
$cshowList :: [ListProjectsResponse] -> ShowS
show :: ListProjectsResponse -> String
$cshow :: ListProjectsResponse -> String
showsPrec :: Int -> ListProjectsResponse -> ShowS
$cshowsPrec :: Int -> ListProjectsResponse -> ShowS
Prelude.Show, forall x. Rep ListProjectsResponse x -> ListProjectsResponse
forall x. ListProjectsResponse -> Rep ListProjectsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListProjectsResponse x -> ListProjectsResponse
$cfrom :: forall x. ListProjectsResponse -> Rep ListProjectsResponse x
Prelude.Generic)

-- |
-- Create a value of 'ListProjectsResponse' 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', 'listProjectsResponse_nextToken' - If the number of items that are returned is significantly large, this is
-- an identifier that is also returned. It can be used in a subsequent call
-- to this operation to return the next set of items in the list.
--
-- 'projects', 'listProjectsResponse_projects' - Information about the projects.
--
-- 'httpStatus', 'listProjectsResponse_httpStatus' - The response's http status code.
newListProjectsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListProjectsResponse
newListProjectsResponse :: Int -> ListProjectsResponse
newListProjectsResponse Int
pHttpStatus_ =
  ListProjectsResponse'
    { $sel:nextToken:ListProjectsResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:projects:ListProjectsResponse' :: Maybe [Project]
projects = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:ListProjectsResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | If the number of items that are returned is significantly large, this is
-- an identifier that is also returned. It can be used in a subsequent call
-- to this operation to return the next set of items in the list.
listProjectsResponse_nextToken :: Lens.Lens' ListProjectsResponse (Prelude.Maybe Prelude.Text)
listProjectsResponse_nextToken :: Lens' ListProjectsResponse (Maybe Text)
listProjectsResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListProjectsResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListProjectsResponse' :: ListProjectsResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListProjectsResponse
s@ListProjectsResponse' {} Maybe Text
a -> ListProjectsResponse
s {$sel:nextToken:ListProjectsResponse' :: Maybe Text
nextToken = Maybe Text
a} :: ListProjectsResponse)

-- | Information about the projects.
listProjectsResponse_projects :: Lens.Lens' ListProjectsResponse (Prelude.Maybe [Project])
listProjectsResponse_projects :: Lens' ListProjectsResponse (Maybe [Project])
listProjectsResponse_projects = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListProjectsResponse' {Maybe [Project]
projects :: Maybe [Project]
$sel:projects:ListProjectsResponse' :: ListProjectsResponse -> Maybe [Project]
projects} -> Maybe [Project]
projects) (\s :: ListProjectsResponse
s@ListProjectsResponse' {} Maybe [Project]
a -> ListProjectsResponse
s {$sel:projects:ListProjectsResponse' :: Maybe [Project]
projects = Maybe [Project]
a} :: ListProjectsResponse) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

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

instance Prelude.NFData ListProjectsResponse where
  rnf :: ListProjectsResponse -> ()
rnf ListProjectsResponse' {Int
Maybe [Project]
Maybe Text
httpStatus :: Int
projects :: Maybe [Project]
nextToken :: Maybe Text
$sel:httpStatus:ListProjectsResponse' :: ListProjectsResponse -> Int
$sel:projects:ListProjectsResponse' :: ListProjectsResponse -> Maybe [Project]
$sel:nextToken:ListProjectsResponse' :: ListProjectsResponse -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
nextToken
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Project]
projects
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus