| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.SecretsManager.ListSecrets
Description
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 Find secrets in Secrets Manager.
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 Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:ListSecrets. For more
information, see
IAM policy actions for Secrets Manager
and
Authentication and access control in Secrets Manager.
This operation returns paginated results.
Synopsis
- data ListSecrets = ListSecrets' {}
- newListSecrets :: ListSecrets
- listSecrets_filters :: Lens' ListSecrets (Maybe [Filter])
- listSecrets_includePlannedDeletion :: Lens' ListSecrets (Maybe Bool)
- listSecrets_maxResults :: Lens' ListSecrets (Maybe Natural)
- listSecrets_nextToken :: Lens' ListSecrets (Maybe Text)
- listSecrets_sortOrder :: Lens' ListSecrets (Maybe SortOrderType)
- data ListSecretsResponse = ListSecretsResponse' {
- nextToken :: Maybe Text
- secretList :: Maybe [SecretListEntry]
- httpStatus :: Int
- newListSecretsResponse :: Int -> ListSecretsResponse
- listSecretsResponse_nextToken :: Lens' ListSecretsResponse (Maybe Text)
- listSecretsResponse_secretList :: Lens' ListSecretsResponse (Maybe [SecretListEntry])
- listSecretsResponse_httpStatus :: Lens' ListSecretsResponse Int
Creating a Request
data ListSecrets Source #
See: newListSecrets smart constructor.
Constructors
| ListSecrets' | |
Fields
| |
Instances
newListSecrets :: ListSecrets Source #
Create a value of ListSecrets with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListSecrets', listSecrets_filters - The filters to apply to the list of secrets.
$sel:includePlannedDeletion:ListSecrets', listSecrets_includePlannedDeletion - Undocumented member.
$sel:maxResults:ListSecrets', 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.
ListSecrets, 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.
$sel:sortOrder:ListSecrets', listSecrets_sortOrder - Secrets are listed by CreatedDate.
Request Lenses
listSecrets_filters :: Lens' ListSecrets (Maybe [Filter]) Source #
The filters to apply to the list of secrets.
listSecrets_includePlannedDeletion :: Lens' ListSecrets (Maybe Bool) Source #
Undocumented member.
listSecrets_maxResults :: Lens' ListSecrets (Maybe Natural) Source #
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_nextToken :: Lens' ListSecrets (Maybe Text) Source #
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_sortOrder :: Lens' ListSecrets (Maybe SortOrderType) Source #
Secrets are listed by CreatedDate.
Destructuring the Response
data ListSecretsResponse Source #
See: newListSecretsResponse smart constructor.
Constructors
| ListSecretsResponse' | |
Fields
| |
Instances
newListSecretsResponse Source #
Arguments
| :: Int | |
| -> ListSecretsResponse |
Create a value of ListSecretsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListSecrets, 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.
$sel:secretList:ListSecretsResponse', listSecretsResponse_secretList - A list of the secrets in the account.
$sel:httpStatus:ListSecretsResponse', listSecretsResponse_httpStatus - The response's http status code.
Response Lenses
listSecretsResponse_nextToken :: Lens' ListSecretsResponse (Maybe Text) Source #
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_secretList :: Lens' ListSecretsResponse (Maybe [SecretListEntry]) Source #
A list of the secrets in the account.
listSecretsResponse_httpStatus :: Lens' ListSecretsResponse Int Source #
The response's http status code.