{-# 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.QuickSight.ListAnalyses -- 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 Amazon QuickSight analyses that exist in the specified Amazon Web -- Services account. -- -- This operation returns paginated results. module Amazonka.QuickSight.ListAnalyses ( -- * Creating a Request ListAnalyses (..), newListAnalyses, -- * Request Lenses listAnalyses_maxResults, listAnalyses_nextToken, listAnalyses_awsAccountId, -- * Destructuring the Response ListAnalysesResponse (..), newListAnalysesResponse, -- * Response Lenses listAnalysesResponse_analysisSummaryList, listAnalysesResponse_nextToken, listAnalysesResponse_requestId, listAnalysesResponse_status, ) 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 Amazonka.QuickSight.Types import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response -- | /See:/ 'newListAnalyses' smart constructor. data ListAnalyses = ListAnalyses' { -- | The maximum number of results to return. maxResults :: Prelude.Maybe Prelude.Natural, -- | A pagination token that can be used in a subsequent request. nextToken :: Prelude.Maybe Prelude.Text, -- | The ID of the Amazon Web Services account that contains the analyses. awsAccountId :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'ListAnalyses' 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', 'listAnalyses_maxResults' - The maximum number of results to return. -- -- 'nextToken', 'listAnalyses_nextToken' - A pagination token that can be used in a subsequent request. -- -- 'awsAccountId', 'listAnalyses_awsAccountId' - The ID of the Amazon Web Services account that contains the analyses. newListAnalyses :: -- | 'awsAccountId' Prelude.Text -> ListAnalyses newListAnalyses pAwsAccountId_ = ListAnalyses' { maxResults = Prelude.Nothing, nextToken = Prelude.Nothing, awsAccountId = pAwsAccountId_ } -- | The maximum number of results to return. listAnalyses_maxResults :: Lens.Lens' ListAnalyses (Prelude.Maybe Prelude.Natural) listAnalyses_maxResults = Lens.lens (\ListAnalyses' {maxResults} -> maxResults) (\s@ListAnalyses' {} a -> s {maxResults = a} :: ListAnalyses) -- | A pagination token that can be used in a subsequent request. listAnalyses_nextToken :: Lens.Lens' ListAnalyses (Prelude.Maybe Prelude.Text) listAnalyses_nextToken = Lens.lens (\ListAnalyses' {nextToken} -> nextToken) (\s@ListAnalyses' {} a -> s {nextToken = a} :: ListAnalyses) -- | The ID of the Amazon Web Services account that contains the analyses. listAnalyses_awsAccountId :: Lens.Lens' ListAnalyses Prelude.Text listAnalyses_awsAccountId = Lens.lens (\ListAnalyses' {awsAccountId} -> awsAccountId) (\s@ListAnalyses' {} a -> s {awsAccountId = a} :: ListAnalyses) instance Core.AWSPager ListAnalyses where page rq rs | Core.stop ( rs Lens.^? listAnalysesResponse_nextToken Prelude.. Lens._Just ) = Prelude.Nothing | Core.stop ( rs Lens.^? listAnalysesResponse_analysisSummaryList Prelude.. Lens._Just ) = Prelude.Nothing | Prelude.otherwise = Prelude.Just Prelude.$ rq Prelude.& listAnalyses_nextToken Lens..~ rs Lens.^? listAnalysesResponse_nextToken Prelude.. Lens._Just instance Core.AWSRequest ListAnalyses where type AWSResponse ListAnalyses = ListAnalysesResponse request overrides = Request.get (overrides defaultService) response = Response.receiveJSON ( \s h x -> ListAnalysesResponse' Prelude.<$> ( x Data..?> "AnalysisSummaryList" Core..!@ Prelude.mempty ) Prelude.<*> (x Data..?> "NextToken") Prelude.<*> (x Data..?> "RequestId") Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable ListAnalyses where hashWithSalt _salt ListAnalyses' {..} = _salt `Prelude.hashWithSalt` maxResults `Prelude.hashWithSalt` nextToken `Prelude.hashWithSalt` awsAccountId instance Prelude.NFData ListAnalyses where rnf ListAnalyses' {..} = Prelude.rnf maxResults `Prelude.seq` Prelude.rnf nextToken `Prelude.seq` Prelude.rnf awsAccountId instance Data.ToHeaders ListAnalyses where toHeaders = Prelude.const ( Prelude.mconcat [ "Content-Type" Data.=# ( "application/x-amz-json-1.0" :: Prelude.ByteString ) ] ) instance Data.ToPath ListAnalyses where toPath ListAnalyses' {..} = Prelude.mconcat ["/accounts/", Data.toBS awsAccountId, "/analyses"] instance Data.ToQuery ListAnalyses where toQuery ListAnalyses' {..} = Prelude.mconcat [ "max-results" Data.=: maxResults, "next-token" Data.=: nextToken ] -- | /See:/ 'newListAnalysesResponse' smart constructor. data ListAnalysesResponse = ListAnalysesResponse' { -- | Metadata describing each of the analyses that are listed. analysisSummaryList :: Prelude.Maybe [AnalysisSummary], -- | A pagination token that can be used in a subsequent request. nextToken :: Prelude.Maybe Prelude.Text, -- | The Amazon Web Services request ID for this operation. requestId :: Prelude.Maybe Prelude.Text, -- | The HTTP status of the request. status :: Prelude.Int } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'ListAnalysesResponse' 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: -- -- 'analysisSummaryList', 'listAnalysesResponse_analysisSummaryList' - Metadata describing each of the analyses that are listed. -- -- 'nextToken', 'listAnalysesResponse_nextToken' - A pagination token that can be used in a subsequent request. -- -- 'requestId', 'listAnalysesResponse_requestId' - The Amazon Web Services request ID for this operation. -- -- 'status', 'listAnalysesResponse_status' - The HTTP status of the request. newListAnalysesResponse :: -- | 'status' Prelude.Int -> ListAnalysesResponse newListAnalysesResponse pStatus_ = ListAnalysesResponse' { analysisSummaryList = Prelude.Nothing, nextToken = Prelude.Nothing, requestId = Prelude.Nothing, status = pStatus_ } -- | Metadata describing each of the analyses that are listed. listAnalysesResponse_analysisSummaryList :: Lens.Lens' ListAnalysesResponse (Prelude.Maybe [AnalysisSummary]) listAnalysesResponse_analysisSummaryList = Lens.lens (\ListAnalysesResponse' {analysisSummaryList} -> analysisSummaryList) (\s@ListAnalysesResponse' {} a -> s {analysisSummaryList = a} :: ListAnalysesResponse) Prelude.. Lens.mapping Lens.coerced -- | A pagination token that can be used in a subsequent request. listAnalysesResponse_nextToken :: Lens.Lens' ListAnalysesResponse (Prelude.Maybe Prelude.Text) listAnalysesResponse_nextToken = Lens.lens (\ListAnalysesResponse' {nextToken} -> nextToken) (\s@ListAnalysesResponse' {} a -> s {nextToken = a} :: ListAnalysesResponse) -- | The Amazon Web Services request ID for this operation. listAnalysesResponse_requestId :: Lens.Lens' ListAnalysesResponse (Prelude.Maybe Prelude.Text) listAnalysesResponse_requestId = Lens.lens (\ListAnalysesResponse' {requestId} -> requestId) (\s@ListAnalysesResponse' {} a -> s {requestId = a} :: ListAnalysesResponse) -- | The HTTP status of the request. listAnalysesResponse_status :: Lens.Lens' ListAnalysesResponse Prelude.Int listAnalysesResponse_status = Lens.lens (\ListAnalysesResponse' {status} -> status) (\s@ListAnalysesResponse' {} a -> s {status = a} :: ListAnalysesResponse) instance Prelude.NFData ListAnalysesResponse where rnf ListAnalysesResponse' {..} = Prelude.rnf analysisSummaryList `Prelude.seq` Prelude.rnf nextToken `Prelude.seq` Prelude.rnf requestId `Prelude.seq` Prelude.rnf status