list_secret_version_ids¶
Operation¶
list_secret_version_ids
¶
list_secret_version_ids(request: ListSecretVersionIdsInput | ListSecretVersionIdsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListSecretVersionIdsInputDict]) -> ListSecretVersionIdsOutput
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.
Note
ListSecretVersionIds only returns versions that contain a secret
value. To see all version IDs that have staging labels attached,
including ones without a secret value, call DescribeSecret and check
VersionIdsToStages.
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListSecretVersionIdsInput | ListSecretVersionIdsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[ListSecretVersionIdsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListSecretVersionIdsOutput
|
An instance of |
list_secret_version_ids
async
¶
list_secret_version_ids(request: ListSecretVersionIdsInput | ListSecretVersionIdsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListSecretVersionIdsInputDict]) -> ListSecretVersionIdsOutput
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.
Note
ListSecretVersionIds only returns versions that contain a secret
value. To see all version IDs that have staging labels attached,
including ones without a secret value, call DescribeSecret and check
VersionIdsToStages.
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListSecretVersionIdsInput | ListSecretVersionIdsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[ListSecretVersionIdsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListSecretVersionIdsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ListSecretVersionIdsInputDict
¶
Bases: TypedDict
Dictionary form of ListSecretVersionIdsInput.
Attributes¶
include_deprecated
instance-attribute
¶
include_deprecated: bool | None
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. By default, versions without staging labels aren't included.
max_results
instance-attribute
¶
max_results: int | None
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.
next_token
instance-attribute
¶
next_token: str | None
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.
secret_id
instance-attribute
¶
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.
ListSecretVersionIdsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListSecretVersionIdsInput structure.
Attributes¶
include_deprecated
class-attribute
instance-attribute
¶
include_deprecated: bool | None = ...
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. By default, versions without staging labels aren't included.
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
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.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
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.
secret_id
class-attribute
instance-attribute
¶
secret_id: str | None = ...
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.
Output¶
ListSecretVersionIdsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListSecretVersionIdsOutput structure.
Attributes¶
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
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.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
versions
class-attribute
instance-attribute
¶
versions: list[SecretVersionsListEntry] | None = ...
A list of the versions of the secret.