Skip to content

List Secret Version Ids

secretsmanager_list_secret_version_ids R Documentation

Lists the versions of a secret

Description

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 list_secrets.

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.

Usage

secretsmanager_list_secret_version_ids(SecretId, MaxResults, NextToken,
  IncludeDeprecated)

Arguments

SecretId

[required] 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.

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 list_secret_version_ids again with the value from NextToken.

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 list_secret_version_ids again with this value.

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. By default, versions without staging labels aren't included.

Value

A list with the following syntax: 

list(
  Versions = list(
    list(
      VersionId = "string",
      VersionStages = list(
        "string"
      ),
      LastAccessedDate = as.POSIXct(
        "2015-01-01"
      ),
      CreatedDate = as.POSIXct(
        "2015-01-01"
      ),
      KmsKeyIds = list(
        "string"
      )
    )
  ),
  NextToken = "string",
  ARN = "string",
  Name = "string"
)

Request syntax

svc$list_secret_version_ids(
  SecretId = "string",
  MaxResults = 123,
  NextToken = "string",
  IncludeDeprecated = TRUE|FALSE
)

Examples

## Not run: 
# The following example shows how to retrieve a list of all of the
# versions of a secret, including those without any staging labels.
svc$list_secret_version_ids(
  IncludeDeprecated = TRUE,
  SecretId = "MyTestDatabaseSecret"
)

## End(Not run)