{-# 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.Personalize.ListDatasets -- 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 the list of datasets contained in the given dataset group. The -- response provides the properties for each dataset, including the Amazon -- Resource Name (ARN). For more information on datasets, see -- . -- -- This operation returns paginated results. module Amazonka.Personalize.ListDatasets ( -- * Creating a Request ListDatasets (..), newListDatasets, -- * Request Lenses listDatasets_datasetGroupArn, listDatasets_maxResults, listDatasets_nextToken, -- * Destructuring the Response ListDatasetsResponse (..), newListDatasetsResponse, -- * Response Lenses listDatasetsResponse_datasets, listDatasetsResponse_nextToken, listDatasetsResponse_httpStatus, ) where import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import Amazonka.Personalize.Types import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response -- | /See:/ 'newListDatasets' smart constructor. data ListDatasets = ListDatasets' { -- | The Amazon Resource Name (ARN) of the dataset group that contains the -- datasets to list. datasetGroupArn :: Prelude.Maybe Prelude.Text, -- | The maximum number of datasets to return. maxResults :: Prelude.Maybe Prelude.Natural, -- | A token returned from the previous call to @ListDatasetImportJobs@ for -- getting the next set of dataset import jobs (if they exist). nextToken :: Prelude.Maybe Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'ListDatasets' 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: -- -- 'datasetGroupArn', 'listDatasets_datasetGroupArn' - The Amazon Resource Name (ARN) of the dataset group that contains the -- datasets to list. -- -- 'maxResults', 'listDatasets_maxResults' - The maximum number of datasets to return. -- -- 'nextToken', 'listDatasets_nextToken' - A token returned from the previous call to @ListDatasetImportJobs@ for -- getting the next set of dataset import jobs (if they exist). newListDatasets :: ListDatasets newListDatasets = ListDatasets' { datasetGroupArn = Prelude.Nothing, maxResults = Prelude.Nothing, nextToken = Prelude.Nothing } -- | The Amazon Resource Name (ARN) of the dataset group that contains the -- datasets to list. listDatasets_datasetGroupArn :: Lens.Lens' ListDatasets (Prelude.Maybe Prelude.Text) listDatasets_datasetGroupArn = Lens.lens (\ListDatasets' {datasetGroupArn} -> datasetGroupArn) (\s@ListDatasets' {} a -> s {datasetGroupArn = a} :: ListDatasets) -- | The maximum number of datasets to return. listDatasets_maxResults :: Lens.Lens' ListDatasets (Prelude.Maybe Prelude.Natural) listDatasets_maxResults = Lens.lens (\ListDatasets' {maxResults} -> maxResults) (\s@ListDatasets' {} a -> s {maxResults = a} :: ListDatasets) -- | A token returned from the previous call to @ListDatasetImportJobs@ for -- getting the next set of dataset import jobs (if they exist). listDatasets_nextToken :: Lens.Lens' ListDatasets (Prelude.Maybe Prelude.Text) listDatasets_nextToken = Lens.lens (\ListDatasets' {nextToken} -> nextToken) (\s@ListDatasets' {} a -> s {nextToken = a} :: ListDatasets) instance Core.AWSPager ListDatasets where page rq rs | Core.stop ( rs Lens.^? listDatasetsResponse_nextToken Prelude.. Lens._Just ) = Prelude.Nothing | Core.stop ( rs Lens.^? listDatasetsResponse_datasets Prelude.. Lens._Just ) = Prelude.Nothing | Prelude.otherwise = Prelude.Just Prelude.$ rq Prelude.& listDatasets_nextToken Lens..~ rs Lens.^? listDatasetsResponse_nextToken Prelude.. Lens._Just instance Core.AWSRequest ListDatasets where type AWSResponse ListDatasets = ListDatasetsResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveJSON ( \s h x -> ListDatasetsResponse' Prelude.<$> (x Data..?> "datasets" Core..!@ Prelude.mempty) Prelude.<*> (x Data..?> "nextToken") Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable ListDatasets where hashWithSalt _salt ListDatasets' {..} = _salt `Prelude.hashWithSalt` datasetGroupArn `Prelude.hashWithSalt` maxResults `Prelude.hashWithSalt` nextToken instance Prelude.NFData ListDatasets where rnf ListDatasets' {..} = Prelude.rnf datasetGroupArn `Prelude.seq` Prelude.rnf maxResults `Prelude.seq` Prelude.rnf nextToken instance Data.ToHeaders ListDatasets where toHeaders = Prelude.const ( Prelude.mconcat [ "X-Amz-Target" Data.=# ( "AmazonPersonalize.ListDatasets" :: Prelude.ByteString ), "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON ListDatasets where toJSON ListDatasets' {..} = Data.object ( Prelude.catMaybes [ ("datasetGroupArn" Data..=) Prelude.<$> datasetGroupArn, ("maxResults" Data..=) Prelude.<$> maxResults, ("nextToken" Data..=) Prelude.<$> nextToken ] ) instance Data.ToPath ListDatasets where toPath = Prelude.const "/" instance Data.ToQuery ListDatasets where toQuery = Prelude.const Prelude.mempty -- | /See:/ 'newListDatasetsResponse' smart constructor. data ListDatasetsResponse = ListDatasetsResponse' { -- | An array of @Dataset@ objects. Each object provides metadata -- information. datasets :: Prelude.Maybe [DatasetSummary], -- | A token for getting the next set of datasets (if they exist). 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 'ListDatasetsResponse' 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: -- -- 'datasets', 'listDatasetsResponse_datasets' - An array of @Dataset@ objects. Each object provides metadata -- information. -- -- 'nextToken', 'listDatasetsResponse_nextToken' - A token for getting the next set of datasets (if they exist). -- -- 'httpStatus', 'listDatasetsResponse_httpStatus' - The response's http status code. newListDatasetsResponse :: -- | 'httpStatus' Prelude.Int -> ListDatasetsResponse newListDatasetsResponse pHttpStatus_ = ListDatasetsResponse' { datasets = Prelude.Nothing, nextToken = Prelude.Nothing, httpStatus = pHttpStatus_ } -- | An array of @Dataset@ objects. Each object provides metadata -- information. listDatasetsResponse_datasets :: Lens.Lens' ListDatasetsResponse (Prelude.Maybe [DatasetSummary]) listDatasetsResponse_datasets = Lens.lens (\ListDatasetsResponse' {datasets} -> datasets) (\s@ListDatasetsResponse' {} a -> s {datasets = a} :: ListDatasetsResponse) Prelude.. Lens.mapping Lens.coerced -- | A token for getting the next set of datasets (if they exist). listDatasetsResponse_nextToken :: Lens.Lens' ListDatasetsResponse (Prelude.Maybe Prelude.Text) listDatasetsResponse_nextToken = Lens.lens (\ListDatasetsResponse' {nextToken} -> nextToken) (\s@ListDatasetsResponse' {} a -> s {nextToken = a} :: ListDatasetsResponse) -- | The response's http status code. listDatasetsResponse_httpStatus :: Lens.Lens' ListDatasetsResponse Prelude.Int listDatasetsResponse_httpStatus = Lens.lens (\ListDatasetsResponse' {httpStatus} -> httpStatus) (\s@ListDatasetsResponse' {} a -> s {httpStatus = a} :: ListDatasetsResponse) instance Prelude.NFData ListDatasetsResponse where rnf ListDatasetsResponse' {..} = Prelude.rnf datasets `Prelude.seq` Prelude.rnf nextToken `Prelude.seq` Prelude.rnf httpStatus