Skip to content

Secrets Manager  >  Operations  >  list_secret_version_ids

list_secret_version_ids

Operation

list_secret_version_ids async 

list_secret_version_ids(input: ListSecretVersionIdsInput, plugins: list[Plugin] | None = None) -> 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.

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
input ListSecretVersionIdsInput

An instance of ListSecretVersionIdsInput.

 required
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

Returns:

Type Description
ListSecretVersionIdsOutput

An instance of ListSecretVersionIdsOutput.

Input

ListSecretVersionIdsInput dataclass

Dataclass for ListSecretVersionIdsInput structure.

Attributes

include_deprecated class-attribute instance-attribute 
include_deprecated: bool | None = 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 = 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 = 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 = 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

Dataclass for ListSecretVersionIdsOutput structure.

Attributes

arn class-attribute instance-attribute 
arn: str | None = None

The ARN of the secret.

name class-attribute instance-attribute 
name: str | None = None

The name of the secret.

next_token class-attribute instance-attribute 
next_token: str | None = 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.

versions class-attribute instance-attribute 
versions: list[SecretVersionsListEntry] | None = None

A list of the versions of the secret.