{-# 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.SecretsManager.ListSecrets -- 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 secrets that are stored by Secrets Manager in the Amazon Web -- Services account, not including secrets that are marked for deletion. To -- see secrets marked for deletion, use the Secrets Manager console. -- -- ListSecrets is eventually consistent, however it might not reflect -- changes from the last five minutes. To get the latest information for a -- specific secret, use DescribeSecret. -- -- To list the versions of a secret, use ListSecretVersionIds. -- -- To get the secret value from @SecretString@ or @SecretBinary@, call -- GetSecretValue. -- -- For information about finding secrets in the console, see -- . -- -- Secrets Manager generates a CloudTrail log entry when you call this -- action. Do not include sensitive information in request parameters -- because it might be logged. For more information, see -- . -- -- __Required permissions:__ @secretsmanager:ListSecrets@. For more -- information, see -- -- and -- . -- -- This operation returns paginated results. module Amazonka.SecretsManager.ListSecrets ( -- * Creating a Request ListSecrets (..), newListSecrets, -- * Request Lenses listSecrets_filters, listSecrets_includePlannedDeletion, listSecrets_maxResults, listSecrets_nextToken, listSecrets_sortOrder, -- * Destructuring the Response ListSecretsResponse (..), newListSecretsResponse, -- * Response Lenses listSecretsResponse_nextToken, listSecretsResponse_secretList, listSecretsResponse_httpStatus, ) 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 qualified Amazonka.Request as Request import qualified Amazonka.Response as Response import Amazonka.SecretsManager.Types -- | /See:/ 'newListSecrets' smart constructor. data ListSecrets = ListSecrets' { -- | The filters to apply to the list of secrets. filters :: Prelude.Maybe [Filter], includePlannedDeletion :: Prelude.Maybe Prelude.Bool, -- | The number of results to include in the response. -- -- If there are more results available, in the response, Secrets Manager -- includes @NextToken@. To get the next results, call @ListSecrets@ again -- with the value from @NextToken@. maxResults :: Prelude.Maybe Prelude.Natural, -- | A token that indicates where the output should continue from, if a -- previous call did not show all results. To get the next results, call -- @ListSecrets@ again with this value. nextToken :: Prelude.Maybe Prelude.Text, -- | Secrets are listed by @CreatedDate@. sortOrder :: Prelude.Maybe SortOrderType } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'ListSecrets' 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: -- -- 'filters', 'listSecrets_filters' - The filters to apply to the list of secrets. -- -- 'includePlannedDeletion', 'listSecrets_includePlannedDeletion' - Undocumented member. -- -- 'maxResults', 'listSecrets_maxResults' - The number of results to include in the response. -- -- If there are more results available, in the response, Secrets Manager -- includes @NextToken@. To get the next results, call @ListSecrets@ again -- with the value from @NextToken@. -- -- 'nextToken', 'listSecrets_nextToken' - A token that indicates where the output should continue from, if a -- previous call did not show all results. To get the next results, call -- @ListSecrets@ again with this value. -- -- 'sortOrder', 'listSecrets_sortOrder' - Secrets are listed by @CreatedDate@. newListSecrets :: ListSecrets newListSecrets = ListSecrets' { filters = Prelude.Nothing, includePlannedDeletion = Prelude.Nothing, maxResults = Prelude.Nothing, nextToken = Prelude.Nothing, sortOrder = Prelude.Nothing } -- | The filters to apply to the list of secrets. listSecrets_filters :: Lens.Lens' ListSecrets (Prelude.Maybe [Filter]) listSecrets_filters = Lens.lens (\ListSecrets' {filters} -> filters) (\s@ListSecrets' {} a -> s {filters = a} :: ListSecrets) Prelude.. Lens.mapping Lens.coerced -- | Undocumented member. listSecrets_includePlannedDeletion :: Lens.Lens' ListSecrets (Prelude.Maybe Prelude.Bool) listSecrets_includePlannedDeletion = Lens.lens (\ListSecrets' {includePlannedDeletion} -> includePlannedDeletion) (\s@ListSecrets' {} a -> s {includePlannedDeletion = a} :: ListSecrets) -- | The number of results to include in the response. -- -- If there are more results available, in the response, Secrets Manager -- includes @NextToken@. To get the next results, call @ListSecrets@ again -- with the value from @NextToken@. listSecrets_maxResults :: Lens.Lens' ListSecrets (Prelude.Maybe Prelude.Natural) listSecrets_maxResults = Lens.lens (\ListSecrets' {maxResults} -> maxResults) (\s@ListSecrets' {} a -> s {maxResults = a} :: ListSecrets) -- | A token that indicates where the output should continue from, if a -- previous call did not show all results. To get the next results, call -- @ListSecrets@ again with this value. listSecrets_nextToken :: Lens.Lens' ListSecrets (Prelude.Maybe Prelude.Text) listSecrets_nextToken = Lens.lens (\ListSecrets' {nextToken} -> nextToken) (\s@ListSecrets' {} a -> s {nextToken = a} :: ListSecrets) -- | Secrets are listed by @CreatedDate@. listSecrets_sortOrder :: Lens.Lens' ListSecrets (Prelude.Maybe SortOrderType) listSecrets_sortOrder = Lens.lens (\ListSecrets' {sortOrder} -> sortOrder) (\s@ListSecrets' {} a -> s {sortOrder = a} :: ListSecrets) instance Core.AWSPager ListSecrets where page rq rs | Core.stop ( rs Lens.^? listSecretsResponse_nextToken Prelude.. Lens._Just ) = Prelude.Nothing | Core.stop ( rs Lens.^? listSecretsResponse_secretList Prelude.. Lens._Just ) = Prelude.Nothing | Prelude.otherwise = Prelude.Just Prelude.$ rq Prelude.& listSecrets_nextToken Lens..~ rs Lens.^? listSecretsResponse_nextToken Prelude.. Lens._Just instance Core.AWSRequest ListSecrets where type AWSResponse ListSecrets = ListSecretsResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveJSON ( \s h x -> ListSecretsResponse' Prelude.<$> (x Data..?> "NextToken") Prelude.<*> (x Data..?> "SecretList" Core..!@ Prelude.mempty) Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable ListSecrets where hashWithSalt _salt ListSecrets' {..} = _salt `Prelude.hashWithSalt` filters `Prelude.hashWithSalt` includePlannedDeletion `Prelude.hashWithSalt` maxResults `Prelude.hashWithSalt` nextToken `Prelude.hashWithSalt` sortOrder instance Prelude.NFData ListSecrets where rnf ListSecrets' {..} = Prelude.rnf filters `Prelude.seq` Prelude.rnf includePlannedDeletion `Prelude.seq` Prelude.rnf maxResults `Prelude.seq` Prelude.rnf nextToken `Prelude.seq` Prelude.rnf sortOrder instance Data.ToHeaders ListSecrets where toHeaders = Prelude.const ( Prelude.mconcat [ "X-Amz-Target" Data.=# ("secretsmanager.ListSecrets" :: Prelude.ByteString), "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON ListSecrets where toJSON ListSecrets' {..} = Data.object ( Prelude.catMaybes [ ("Filters" Data..=) Prelude.<$> filters, ("IncludePlannedDeletion" Data..=) Prelude.<$> includePlannedDeletion, ("MaxResults" Data..=) Prelude.<$> maxResults, ("NextToken" Data..=) Prelude.<$> nextToken, ("SortOrder" Data..=) Prelude.<$> sortOrder ] ) instance Data.ToPath ListSecrets where toPath = Prelude.const "/" instance Data.ToQuery ListSecrets where toQuery = Prelude.const Prelude.mempty -- | /See:/ 'newListSecretsResponse' smart constructor. data ListSecretsResponse = ListSecretsResponse' { -- | Secrets Manager includes this value if there\'s more output available -- than what is included in the current response. This can occur even when -- the response includes no values at all, such as when you ask for a -- filtered view of a long list. To get the next results, call -- @ListSecrets@ again with this value. nextToken :: Prelude.Maybe Prelude.Text, -- | A list of the secrets in the account. secretList :: Prelude.Maybe [SecretListEntry], -- | The response's http status code. httpStatus :: Prelude.Int } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'ListSecretsResponse' 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', 'listSecretsResponse_nextToken' - Secrets Manager includes this value if there\'s more output available -- than what is included in the current response. This can occur even when -- the response includes no values at all, such as when you ask for a -- filtered view of a long list. To get the next results, call -- @ListSecrets@ again with this value. -- -- 'secretList', 'listSecretsResponse_secretList' - A list of the secrets in the account. -- -- 'httpStatus', 'listSecretsResponse_httpStatus' - The response's http status code. newListSecretsResponse :: -- | 'httpStatus' Prelude.Int -> ListSecretsResponse newListSecretsResponse pHttpStatus_ = ListSecretsResponse' { nextToken = Prelude.Nothing, secretList = Prelude.Nothing, httpStatus = pHttpStatus_ } -- | Secrets Manager includes this value if there\'s more output available -- than what is included in the current response. This can occur even when -- the response includes no values at all, such as when you ask for a -- filtered view of a long list. To get the next results, call -- @ListSecrets@ again with this value. listSecretsResponse_nextToken :: Lens.Lens' ListSecretsResponse (Prelude.Maybe Prelude.Text) listSecretsResponse_nextToken = Lens.lens (\ListSecretsResponse' {nextToken} -> nextToken) (\s@ListSecretsResponse' {} a -> s {nextToken = a} :: ListSecretsResponse) -- | A list of the secrets in the account. listSecretsResponse_secretList :: Lens.Lens' ListSecretsResponse (Prelude.Maybe [SecretListEntry]) listSecretsResponse_secretList = Lens.lens (\ListSecretsResponse' {secretList} -> secretList) (\s@ListSecretsResponse' {} a -> s {secretList = a} :: ListSecretsResponse) Prelude.. Lens.mapping Lens.coerced -- | The response's http status code. listSecretsResponse_httpStatus :: Lens.Lens' ListSecretsResponse Prelude.Int listSecretsResponse_httpStatus = Lens.lens (\ListSecretsResponse' {httpStatus} -> httpStatus) (\s@ListSecretsResponse' {} a -> s {httpStatus = a} :: ListSecretsResponse) instance Prelude.NFData ListSecretsResponse where rnf ListSecretsResponse' {..} = Prelude.rnf nextToken `Prelude.seq` Prelude.rnf secretList `Prelude.seq` Prelude.rnf httpStatus