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 |
Lists the versions of a secret. Secrets Manager uses staging labels to indicate the different versions of a secret. For more information, see Secrets Manager concepts: Versions.
To list the secrets in the account, use ListSecrets.
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:ListSecretVersionIds
. 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 ListSecretVersionIds = ListSecretVersionIds' {}
- newListSecretVersionIds :: Text -> ListSecretVersionIds
- listSecretVersionIds_includeDeprecated :: Lens' ListSecretVersionIds (Maybe Bool)
- listSecretVersionIds_maxResults :: Lens' ListSecretVersionIds (Maybe Natural)
- listSecretVersionIds_nextToken :: Lens' ListSecretVersionIds (Maybe Text)
- listSecretVersionIds_secretId :: Lens' ListSecretVersionIds Text
- data ListSecretVersionIdsResponse = ListSecretVersionIdsResponse' {}
- newListSecretVersionIdsResponse :: Int -> ListSecretVersionIdsResponse
- listSecretVersionIdsResponse_arn :: Lens' ListSecretVersionIdsResponse (Maybe Text)
- listSecretVersionIdsResponse_name :: Lens' ListSecretVersionIdsResponse (Maybe Text)
- listSecretVersionIdsResponse_nextToken :: Lens' ListSecretVersionIdsResponse (Maybe Text)
- listSecretVersionIdsResponse_versions :: Lens' ListSecretVersionIdsResponse (Maybe [SecretVersionsListEntry])
- listSecretVersionIdsResponse_httpStatus :: Lens' ListSecretVersionIdsResponse Int
Creating a Request
data ListSecretVersionIds Source #
See: newListSecretVersionIds
smart constructor.
ListSecretVersionIds' | |
|
Instances
newListSecretVersionIds Source #
Create a value of ListSecretVersionIds
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:includeDeprecated:ListSecretVersionIds'
, listSecretVersionIds_includeDeprecated
- Specifies whether to include versions of secrets that don't have any
staging labels attached to them. Versions without staging labels are
considered deprecated and are subject to deletion by Secrets Manager.
$sel:maxResults:ListSecretVersionIds'
, listSecretVersionIds_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
ListSecretVersionIds
again with the value from NextToken
.
ListSecretVersionIds
, listSecretVersionIds_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
ListSecretVersionIds
again with this value.
$sel:secretId:ListSecretVersionIds'
, listSecretVersionIds_secretId
- The ARN or name of the secret whose versions you want to list.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
Request Lenses
listSecretVersionIds_includeDeprecated :: Lens' ListSecretVersionIds (Maybe Bool) Source #
Specifies whether to include versions of secrets that don't have any staging labels attached to them. Versions without staging labels are considered deprecated and are subject to deletion by Secrets Manager.
listSecretVersionIds_maxResults :: Lens' ListSecretVersionIds (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
ListSecretVersionIds
again with the value from NextToken
.
listSecretVersionIds_nextToken :: Lens' ListSecretVersionIds (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
ListSecretVersionIds
again with this value.
listSecretVersionIds_secretId :: Lens' ListSecretVersionIds Text Source #
The ARN or name of the secret whose versions you want to list.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
Destructuring the Response
data ListSecretVersionIdsResponse Source #
See: newListSecretVersionIdsResponse
smart constructor.
ListSecretVersionIdsResponse' | |
|
Instances
newListSecretVersionIdsResponse Source #
Create a value of ListSecretVersionIdsResponse
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:
ListSecretVersionIdsResponse
, listSecretVersionIdsResponse_arn
- The ARN of the secret.
ListSecretVersionIdsResponse
, listSecretVersionIdsResponse_name
- The name of the secret.
ListSecretVersionIds
, listSecretVersionIdsResponse_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
ListSecretVersionIds
again with this value.
$sel:versions:ListSecretVersionIdsResponse'
, listSecretVersionIdsResponse_versions
- A list of the versions of the secret.
$sel:httpStatus:ListSecretVersionIdsResponse'
, listSecretVersionIdsResponse_httpStatus
- The response's http status code.
Response Lenses
listSecretVersionIdsResponse_arn :: Lens' ListSecretVersionIdsResponse (Maybe Text) Source #
The ARN of the secret.
listSecretVersionIdsResponse_name :: Lens' ListSecretVersionIdsResponse (Maybe Text) Source #
The name of the secret.
listSecretVersionIdsResponse_nextToken :: Lens' ListSecretVersionIdsResponse (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
ListSecretVersionIds
again with this value.
listSecretVersionIdsResponse_versions :: Lens' ListSecretVersionIdsResponse (Maybe [SecretVersionsListEntry]) Source #
A list of the versions of the secret.
listSecretVersionIdsResponse_httpStatus :: Lens' ListSecretVersionIdsResponse Int Source #
The response's http status code.