{-# 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.DocDbElastic.ListClusters -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Returns information about provisioned Elastic DocumentDB clusters. -- -- This operation returns paginated results. module Amazonka.DocDbElastic.ListClusters ( -- * Creating a Request ListClusters (..), newListClusters, -- * Request Lenses listClusters_maxResults, listClusters_nextToken, -- * Destructuring the Response ListClustersResponse (..), newListClustersResponse, -- * Response Lenses listClustersResponse_clusters, listClustersResponse_nextToken, listClustersResponse_httpStatus, ) where import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import Amazonka.DocDbElastic.Types import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response -- | /See:/ 'newListClusters' smart constructor. data ListClusters = ListClusters' { -- | The maximum number of entries to recieve in the response. maxResults :: Prelude.Maybe Prelude.Natural, -- | The nextToken which is used the get the next page of data. nextToken :: Prelude.Maybe Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'ListClusters' 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', 'listClusters_maxResults' - The maximum number of entries to recieve in the response. -- -- 'nextToken', 'listClusters_nextToken' - The nextToken which is used the get the next page of data. newListClusters :: ListClusters newListClusters = ListClusters' { maxResults = Prelude.Nothing, nextToken = Prelude.Nothing } -- | The maximum number of entries to recieve in the response. listClusters_maxResults :: Lens.Lens' ListClusters (Prelude.Maybe Prelude.Natural) listClusters_maxResults = Lens.lens (\ListClusters' {maxResults} -> maxResults) (\s@ListClusters' {} a -> s {maxResults = a} :: ListClusters) -- | The nextToken which is used the get the next page of data. listClusters_nextToken :: Lens.Lens' ListClusters (Prelude.Maybe Prelude.Text) listClusters_nextToken = Lens.lens (\ListClusters' {nextToken} -> nextToken) (\s@ListClusters' {} a -> s {nextToken = a} :: ListClusters) instance Core.AWSPager ListClusters where page rq rs | Core.stop ( rs Lens.^? listClustersResponse_nextToken Prelude.. Lens._Just ) = Prelude.Nothing | Core.stop ( rs Lens.^? listClustersResponse_clusters Prelude.. Lens._Just ) = Prelude.Nothing | Prelude.otherwise = Prelude.Just Prelude.$ rq Prelude.& listClusters_nextToken Lens..~ rs Lens.^? listClustersResponse_nextToken Prelude.. Lens._Just instance Core.AWSRequest ListClusters where type AWSResponse ListClusters = ListClustersResponse request overrides = Request.get (overrides defaultService) response = Response.receiveJSON ( \s h x -> ListClustersResponse' Prelude.<$> (x Data..?> "clusters" Core..!@ Prelude.mempty) Prelude.<*> (x Data..?> "nextToken") Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable ListClusters where hashWithSalt _salt ListClusters' {..} = _salt `Prelude.hashWithSalt` maxResults `Prelude.hashWithSalt` nextToken instance Prelude.NFData ListClusters where rnf ListClusters' {..} = Prelude.rnf maxResults `Prelude.seq` Prelude.rnf nextToken instance Data.ToHeaders ListClusters where toHeaders = Prelude.const ( Prelude.mconcat [ "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToPath ListClusters where toPath = Prelude.const "/clusters" instance Data.ToQuery ListClusters where toQuery ListClusters' {..} = Prelude.mconcat [ "maxResults" Data.=: maxResults, "nextToken" Data.=: nextToken ] -- | /See:/ 'newListClustersResponse' smart constructor. data ListClustersResponse = ListClustersResponse' { -- | A list of Elastic DocumentDB cluster. clusters :: Prelude.Maybe [ClusterInList], -- | The response will provide a nextToken if there is more data beyond the -- maxResults. -- -- If there is no more data in the responce, the nextToken will not be -- returned. nextToken :: Prelude.Maybe Prelude.Text, -- | The response's http status code. httpStatus :: Prelude.Int } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'ListClustersResponse' 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: -- -- 'clusters', 'listClustersResponse_clusters' - A list of Elastic DocumentDB cluster. -- -- 'nextToken', 'listClustersResponse_nextToken' - The response will provide a nextToken if there is more data beyond the -- maxResults. -- -- If there is no more data in the responce, the nextToken will not be -- returned. -- -- 'httpStatus', 'listClustersResponse_httpStatus' - The response's http status code. newListClustersResponse :: -- | 'httpStatus' Prelude.Int -> ListClustersResponse newListClustersResponse pHttpStatus_ = ListClustersResponse' { clusters = Prelude.Nothing, nextToken = Prelude.Nothing, httpStatus = pHttpStatus_ } -- | A list of Elastic DocumentDB cluster. listClustersResponse_clusters :: Lens.Lens' ListClustersResponse (Prelude.Maybe [ClusterInList]) listClustersResponse_clusters = Lens.lens (\ListClustersResponse' {clusters} -> clusters) (\s@ListClustersResponse' {} a -> s {clusters = a} :: ListClustersResponse) Prelude.. Lens.mapping Lens.coerced -- | The response will provide a nextToken if there is more data beyond the -- maxResults. -- -- If there is no more data in the responce, the nextToken will not be -- returned. listClustersResponse_nextToken :: Lens.Lens' ListClustersResponse (Prelude.Maybe Prelude.Text) listClustersResponse_nextToken = Lens.lens (\ListClustersResponse' {nextToken} -> nextToken) (\s@ListClustersResponse' {} a -> s {nextToken = a} :: ListClustersResponse) -- | The response's http status code. listClustersResponse_httpStatus :: Lens.Lens' ListClustersResponse Prelude.Int listClustersResponse_httpStatus = Lens.lens (\ListClustersResponse' {httpStatus} -> httpStatus) (\s@ListClustersResponse' {} a -> s {httpStatus = a} :: ListClustersResponse) instance Prelude.NFData ListClustersResponse where rnf ListClustersResponse' {..} = Prelude.rnf clusters `Prelude.seq` Prelude.rnf nextToken `Prelude.seq` Prelude.rnf httpStatus