{-# 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.LookoutVision.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) -- -- Lists the Amazon Lookout for Vision projects in your AWS account that -- are in the AWS Region in which you call @ListProjects@. -- -- The @ListProjects@ operation is eventually consistent. Recent calls to -- @CreateProject@ and @DeleteProject@ might take a while to appear in the -- response from @ListProjects@. -- -- This operation requires permissions to perform the -- @lookoutvision:ListProjects@ operation. -- -- This operation returns paginated results. module Amazonka.LookoutVision.ListProjects ( -- * Creating a Request ListProjects (..), newListProjects, -- * Request Lenses listProjects_maxResults, 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.LookoutVision.Types import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response -- | /See:/ 'newListProjects' smart constructor. data ListProjects = ListProjects' { -- | The maximum number of results to return per paginated call. The largest -- value you can specify is 100. If you specify a value greater than 100, a -- ValidationException error occurs. The default value is 100. maxResults :: Prelude.Maybe Prelude.Natural, -- | If the previous response was incomplete (because there is more data to -- retrieve), Amazon Lookout for Vision returns a pagination token in the -- response. You can use this pagination token to retrieve the next set of -- projects. 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: -- -- 'maxResults', 'listProjects_maxResults' - The maximum number of results to return per paginated call. The largest -- value you can specify is 100. If you specify a value greater than 100, a -- ValidationException error occurs. The default value is 100. -- -- 'nextToken', 'listProjects_nextToken' - If the previous response was incomplete (because there is more data to -- retrieve), Amazon Lookout for Vision returns a pagination token in the -- response. You can use this pagination token to retrieve the next set of -- projects. newListProjects :: ListProjects newListProjects = ListProjects' { maxResults = Prelude.Nothing, nextToken = Prelude.Nothing } -- | The maximum number of results to return per paginated call. The largest -- value you can specify is 100. If you specify a value greater than 100, a -- ValidationException error occurs. The default value is 100. listProjects_maxResults :: Lens.Lens' ListProjects (Prelude.Maybe Prelude.Natural) listProjects_maxResults = Lens.lens (\ListProjects' {maxResults} -> maxResults) (\s@ListProjects' {} a -> s {maxResults = a} :: ListProjects) -- | If the previous response was incomplete (because there is more data to -- retrieve), Amazon Lookout for Vision returns a pagination token in the -- response. You can use this pagination token to retrieve the next set of -- projects. 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.get (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` maxResults `Prelude.hashWithSalt` nextToken instance Prelude.NFData ListProjects where rnf ListProjects' {..} = Prelude.rnf maxResults `Prelude.seq` Prelude.rnf nextToken instance Data.ToHeaders ListProjects where toHeaders = Prelude.const ( Prelude.mconcat [ "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToPath ListProjects where toPath = Prelude.const "/2020-11-20/projects" instance Data.ToQuery ListProjects where toQuery ListProjects' {..} = Prelude.mconcat [ "maxResults" Data.=: maxResults, "nextToken" Data.=: nextToken ] -- | /See:/ 'newListProjectsResponse' smart constructor. data ListProjectsResponse = ListProjectsResponse' { -- | If the response is truncated, Amazon Lookout for Vision returns this -- token that you can use in the subsequent request to retrieve the next -- set of projects. nextToken :: Prelude.Maybe Prelude.Text, -- | A list of projects in your AWS account. projects :: Prelude.Maybe [ProjectMetadata], -- | 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 response is truncated, Amazon Lookout for Vision returns this -- token that you can use in the subsequent request to retrieve the next -- set of projects. -- -- 'projects', 'listProjectsResponse_projects' - A list of projects in your AWS account. -- -- '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 response is truncated, Amazon Lookout for Vision returns this -- token that you can use in the subsequent request to retrieve the next -- set of projects. listProjectsResponse_nextToken :: Lens.Lens' ListProjectsResponse (Prelude.Maybe Prelude.Text) listProjectsResponse_nextToken = Lens.lens (\ListProjectsResponse' {nextToken} -> nextToken) (\s@ListProjectsResponse' {} a -> s {nextToken = a} :: ListProjectsResponse) -- | A list of projects in your AWS account. listProjectsResponse_projects :: Lens.Lens' ListProjectsResponse (Prelude.Maybe [ProjectMetadata]) 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