ListTestGridProjects.hs

{-# 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.ListTestGridProjects
-- 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 a list of all Selenium testing projects in your account.
module Amazonka.DeviceFarm.ListTestGridProjects
  ( -- * Creating a Request
    ListTestGridProjects (..),
    newListTestGridProjects,

    -- * Request Lenses
    listTestGridProjects_maxResult,
    listTestGridProjects_nextToken,

    -- * Destructuring the Response
    ListTestGridProjectsResponse (..),
    newListTestGridProjectsResponse,

    -- * Response Lenses
    listTestGridProjectsResponse_nextToken,
    listTestGridProjectsResponse_testGridProjects,
    listTestGridProjectsResponse_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

-- | /See:/ 'newListTestGridProjects' smart constructor.
data ListTestGridProjects = ListTestGridProjects'
  { -- | Return no more than this number of results.
    maxResult :: Prelude.Maybe Prelude.Natural,
    -- | From a response, used to continue a paginated listing.
    nextToken :: Prelude.Maybe Prelude.Text
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'ListTestGridProjects' 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:
--
-- 'maxResult', 'listTestGridProjects_maxResult' - Return no more than this number of results.
--
-- 'nextToken', 'listTestGridProjects_nextToken' - From a response, used to continue a paginated listing.
newListTestGridProjects ::
  ListTestGridProjects
newListTestGridProjects =
  ListTestGridProjects'
    { maxResult = Prelude.Nothing,
      nextToken = Prelude.Nothing
    }

-- | Return no more than this number of results.
listTestGridProjects_maxResult :: Lens.Lens' ListTestGridProjects (Prelude.Maybe Prelude.Natural)
listTestGridProjects_maxResult = Lens.lens (\ListTestGridProjects' {maxResult} -> maxResult) (\s@ListTestGridProjects' {} a -> s {maxResult = a} :: ListTestGridProjects)

-- | From a response, used to continue a paginated listing.
listTestGridProjects_nextToken :: Lens.Lens' ListTestGridProjects (Prelude.Maybe Prelude.Text)
listTestGridProjects_nextToken = Lens.lens (\ListTestGridProjects' {nextToken} -> nextToken) (\s@ListTestGridProjects' {} a -> s {nextToken = a} :: ListTestGridProjects)

instance Core.AWSRequest ListTestGridProjects where
  type
    AWSResponse ListTestGridProjects =
      ListTestGridProjectsResponse
  request overrides =
    Request.postJSON (overrides defaultService)
  response =
    Response.receiveJSON
      ( \s h x ->
          ListTestGridProjectsResponse'
            Prelude.<$> (x Data..?> "nextToken")
            Prelude.<*> ( x
                            Data..?> "testGridProjects"
                            Core..!@ Prelude.mempty
                        )
            Prelude.<*> (Prelude.pure (Prelude.fromEnum s))
      )

instance Prelude.Hashable ListTestGridProjects where
  hashWithSalt _salt ListTestGridProjects' {..} =
    _salt
      `Prelude.hashWithSalt` maxResult
      `Prelude.hashWithSalt` nextToken

instance Prelude.NFData ListTestGridProjects where
  rnf ListTestGridProjects' {..} =
    Prelude.rnf maxResult
      `Prelude.seq` Prelude.rnf nextToken

instance Data.ToHeaders ListTestGridProjects where
  toHeaders =
    Prelude.const
      ( Prelude.mconcat
          [ "X-Amz-Target"
              Data.=# ( "DeviceFarm_20150623.ListTestGridProjects" ::
                          Prelude.ByteString
                      ),
            "Content-Type"
              Data.=# ( "application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToJSON ListTestGridProjects where
  toJSON ListTestGridProjects' {..} =
    Data.object
      ( Prelude.catMaybes
          [ ("maxResult" Data..=) Prelude.<$> maxResult,
            ("nextToken" Data..=) Prelude.<$> nextToken
          ]
      )

instance Data.ToPath ListTestGridProjects where
  toPath = Prelude.const "/"

instance Data.ToQuery ListTestGridProjects where
  toQuery = Prelude.const Prelude.mempty

-- | /See:/ 'newListTestGridProjectsResponse' smart constructor.
data ListTestGridProjectsResponse = ListTestGridProjectsResponse'
  { -- | Used for pagination. Pass into ListTestGridProjects to get more results
    -- in a paginated request.
    nextToken :: Prelude.Maybe Prelude.Text,
    -- | The list of TestGridProjects, based on a ListTestGridProjectsRequest.
    testGridProjects :: Prelude.Maybe [TestGridProject],
    -- | The response's http status code.
    httpStatus :: Prelude.Int
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'ListTestGridProjectsResponse' 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', 'listTestGridProjectsResponse_nextToken' - Used for pagination. Pass into ListTestGridProjects to get more results
-- in a paginated request.
--
-- 'testGridProjects', 'listTestGridProjectsResponse_testGridProjects' - The list of TestGridProjects, based on a ListTestGridProjectsRequest.
--
-- 'httpStatus', 'listTestGridProjectsResponse_httpStatus' - The response's http status code.
newListTestGridProjectsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListTestGridProjectsResponse
newListTestGridProjectsResponse pHttpStatus_ =
  ListTestGridProjectsResponse'
    { nextToken =
        Prelude.Nothing,
      testGridProjects = Prelude.Nothing,
      httpStatus = pHttpStatus_
    }

-- | Used for pagination. Pass into ListTestGridProjects to get more results
-- in a paginated request.
listTestGridProjectsResponse_nextToken :: Lens.Lens' ListTestGridProjectsResponse (Prelude.Maybe Prelude.Text)
listTestGridProjectsResponse_nextToken = Lens.lens (\ListTestGridProjectsResponse' {nextToken} -> nextToken) (\s@ListTestGridProjectsResponse' {} a -> s {nextToken = a} :: ListTestGridProjectsResponse)

-- | The list of TestGridProjects, based on a ListTestGridProjectsRequest.
listTestGridProjectsResponse_testGridProjects :: Lens.Lens' ListTestGridProjectsResponse (Prelude.Maybe [TestGridProject])
listTestGridProjectsResponse_testGridProjects = Lens.lens (\ListTestGridProjectsResponse' {testGridProjects} -> testGridProjects) (\s@ListTestGridProjectsResponse' {} a -> s {testGridProjects = a} :: ListTestGridProjectsResponse) Prelude.. Lens.mapping Lens.coerced

-- | The response's http status code.
listTestGridProjectsResponse_httpStatus :: Lens.Lens' ListTestGridProjectsResponse Prelude.Int
listTestGridProjectsResponse_httpStatus = Lens.lens (\ListTestGridProjectsResponse' {httpStatus} -> httpStatus) (\s@ListTestGridProjectsResponse' {} a -> s {httpStatus = a} :: ListTestGridProjectsResponse)

instance Prelude.NFData ListTestGridProjectsResponse where
  rnf ListTestGridProjectsResponse' {..} =
    Prelude.rnf nextToken
      `Prelude.seq` Prelude.rnf testGridProjects
      `Prelude.seq` Prelude.rnf httpStatus