Container for the parameters to the ListSecretVersionIds operation. 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.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.SecretsManager.AmazonSecretsManagerRequest
Amazon.SecretsManager.Model.ListSecretVersionIdsRequest
Namespace: Amazon.SecretsManager.Model
Assembly: AWSSDK.SecretsManager.dll
Version: 3.x.y.z
Syntax
public class ListSecretVersionIdsRequest : AmazonSecretsManagerRequest IAmazonWebServiceRequest
The ListSecretVersionIdsRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
ListSecretVersionIdsRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
IncludeDeprecated | System.Boolean |
Gets and sets the property 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. |
|
|
MaxResults | System.Int32 |
Gets and sets the property MaxResults. The number of results to include in the response.
If there are more results available, in the response, Secrets Manager includes |
|
|
NextToken | System.String |
Gets and sets the property 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 |
|
|
SecretId | System.String |
Gets and sets the property SecretId. 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. |
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 Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5