Skip to content

List Secrets

secretsmanager_list_secrets R Documentation

Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets that are marked for deletion

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.

All Secrets Manager operations are eventually consistent. ListSecrets might not reflect changes from the last five minutes. You can get more recent information for a specific secret by calling describe_secret.

To list the versions of a secret, use list_secret_version_ids.

To retrieve the values for the secrets, call batch_get_secret_value or get_secret_value.

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.

Usage

secretsmanager_list_secrets(IncludePlannedDeletion, MaxResults,
  NextToken, Filters, SortOrder)

Arguments

IncludePlannedDeletion

Specifies whether to include secrets scheduled for deletion. By default, secrets scheduled for deletion aren't included.

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

Filters

The filters to apply to the list of secrets.

SortOrder

Secrets are listed by CreatedDate.

Value

A list with the following syntax: 

list(
  SecretList = list(
    list(
      ARN = "string",
      Name = "string",
      Description = "string",
      KmsKeyId = "string",
      RotationEnabled = TRUE|FALSE,
      RotationLambdaARN = "string",
      RotationRules = list(
        AutomaticallyAfterDays = 123,
        Duration = "string",
        ScheduleExpression = "string"
      ),
      LastRotatedDate = as.POSIXct(
        "2015-01-01"
      ),
      LastChangedDate = as.POSIXct(
        "2015-01-01"
      ),
      LastAccessedDate = as.POSIXct(
        "2015-01-01"
      ),
      DeletedDate = as.POSIXct(
        "2015-01-01"
      ),
      NextRotationDate = as.POSIXct(
        "2015-01-01"
      ),
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      SecretVersionsToStages = list(
        list(
          "string"
        )
      ),
      OwningService = "string",
      CreatedDate = as.POSIXct(
        "2015-01-01"
      ),
      PrimaryRegion = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_secrets(
  IncludePlannedDeletion = TRUE|FALSE,
  MaxResults = 123,
  NextToken = "string",
  Filters = list(
    list(
      Key = "description"|"name"|"tag-key"|"tag-value"|"primary-region"|"owning-service"|"all",
      Values = list(
        "string"
      )
    )
  ),
  SortOrder = "asc"|"desc"
)

Examples

## Not run: 
# The following example shows how to list all of the secrets in your
# account.
svc$list_secrets()

## End(Not run)