{-# 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. 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. nextToken :: Prelude.Maybe Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'ListProjects' with all optional fields omitted. -- -- Use or 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' { arn = Prelude.Nothing, nextToken = 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.lens (\ListProjects' {arn} -> arn) (\s@ListProjects' {} a -> s {arn = 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.lens (\ListProjects' {nextToken} -> nextToken) (\s@ListProjects' {} a -> s {nextToken = a} :: ListProjects) instance Core.AWSPager ListProjects where page rq rs | Core.stop ( rs Lens.^? listProjectsResponse_nextToken Prelude.. Lens._Just ) = Prelude.Nothing | Core.stop ( rs Lens.^? listProjectsResponse_projects Prelude.. Lens._Just ) = Prelude.Nothing | Prelude.otherwise = Prelude.Just Prelude.$ rq Prelude.& listProjects_nextToken Lens..~ rs Lens.^? listProjectsResponse_nextToken Prelude.. Lens._Just instance Core.AWSRequest ListProjects where type AWSResponse ListProjects = ListProjectsResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveJSON ( \s h x -> ListProjectsResponse' Prelude.<$> (x Data..?> "nextToken") Prelude.<*> (x Data..?> "projects" Core..!@ Prelude.mempty) Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable ListProjects where hashWithSalt _salt ListProjects' {..} = _salt `Prelude.hashWithSalt` arn `Prelude.hashWithSalt` nextToken instance Prelude.NFData ListProjects where rnf ListProjects' {..} = Prelude.rnf arn `Prelude.seq` Prelude.rnf nextToken instance Data.ToHeaders ListProjects where toHeaders = Prelude.const ( Prelude.mconcat [ "X-Amz-Target" Data.=# ( "DeviceFarm_20150623.ListProjects" :: Prelude.ByteString ), "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON ListProjects where toJSON ListProjects' {..} = Data.object ( Prelude.catMaybes [ ("arn" Data..=) Prelude.<$> arn, ("nextToken" Data..=) Prelude.<$> nextToken ] ) instance Data.ToPath ListProjects where toPath = Prelude.const "/" instance Data.ToQuery ListProjects where toQuery = Prelude.const 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. nextToken :: Prelude.Maybe Prelude.Text, -- | Information about the projects. projects :: Prelude.Maybe [Project], -- | The response's http status code. httpStatus :: Prelude.Int } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'ListProjectsResponse' with all optional fields omitted. -- -- Use or 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 pHttpStatus_ = ListProjectsResponse' { nextToken = Prelude.Nothing, projects = Prelude.Nothing, httpStatus = 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.lens (\ListProjectsResponse' {nextToken} -> nextToken) (\s@ListProjectsResponse' {} a -> s {nextToken = a} :: ListProjectsResponse) -- | Information about the projects. listProjectsResponse_projects :: Lens.Lens' ListProjectsResponse (Prelude.Maybe [Project]) listProjectsResponse_projects = Lens.lens (\ListProjectsResponse' {projects} -> projects) (\s@ListProjectsResponse' {} a -> s {projects = a} :: ListProjectsResponse) Prelude.. Lens.mapping Lens.coerced -- | The response's http status code. listProjectsResponse_httpStatus :: Lens.Lens' ListProjectsResponse Prelude.Int listProjectsResponse_httpStatus = Lens.lens (\ListProjectsResponse' {httpStatus} -> httpStatus) (\s@ListProjectsResponse' {} a -> s {httpStatus = a} :: ListProjectsResponse) instance Prelude.NFData ListProjectsResponse where rnf ListProjectsResponse' {..} = Prelude.rnf nextToken `Prelude.seq` Prelude.rnf projects `Prelude.seq` Prelude.rnf httpStatus