AmazonSecretsManagerClient.ListSecretVersionIds Method (ListSecretVersionIdsRequest)

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to ListSecretVersionIdsAsync.

Namespace: Amazon.SecretsManager
Assembly: AWSSDK.SecretsManager.dll
Version: 3.x.y.z

Syntax

public virtual ListSecretVersionIdsResponse ListSecretVersionIds(
         ListSecretVersionIdsRequest request
)

Parameters

request: Type: Amazon.SecretsManager.Model.ListSecretVersionIdsRequest

Container for the necessary parameters to execute the ListSecretVersionIds service method.

Return Value

Type: ListSecretVersionIdsResponse

The response from the ListSecretVersionIds service method, as returned by SecretsManager.

Exceptions

Exception	Condition
InternalServiceErrorException	An error occurred on the server side.
InvalidNextTokenException	The NextToken value is invalid.
InvalidParameterException	The parameter name or value is invalid.
ResourceNotFoundException	Secrets Manager can't find the resource that you asked for.

Examples

The following example shows how to retrieve a list of all of the versions of a secret, including those without any staging labels.

To list all of the secret versions associated with a secret


var client = new AmazonSecretsManagerClient();
var response = client.ListSecretVersionIds(new ListSecretVersionIdsRequest 
{
    IncludeDeprecated = true,
    SecretId = "MyTestDatabaseSecret"
});

string arn = response.ARN;
string name = response.Name;
List<SecretVersionsListEntry> versions = response.Versions;

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

AmazonSecretsManagerClient.ListSecretVersionIds (ListSecretVersionIdsRequest)

Method