Table of Contents

Class ListSecretVersionIdsRequest

Namespace
Amazon.SecretsManager.Model
Assembly
AWSSDK.SecretsManager.dll

Container for the parameters to the ListSecretVersionIds operation. Lists all of the versions attached to the specified secret. The output does not include the 

SecretString
or 
SecretBinary
fields. By default, the list includes only versions that have at least one staging label in 
VersionStage
attached.
note

Always check the 

NextToken
response parameter when calling any of the 
List*
operations. These operations can occasionally return an empty or shorter than expected list of results even when there more results become available. When this happens, the 
NextToken
response parameter contains a value to pass to the next call to the same API to request the next part of the list.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:ListSecretVersionIds

Related operations

public class ListSecretVersionIdsRequest : AmazonSecretsManagerRequest
Inheritance
ListSecretVersionIdsRequest

Constructors

ListSecretVersionIdsRequest() 

public ListSecretVersionIdsRequest()

Properties

IncludeDeprecated

Gets and sets the property IncludeDeprecated.

(Optional) Specifies that you want the results to include versions that do not have any staging labels attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed. 

public bool IncludeDeprecated { get; set; }

Property Value

bool

MaxResults

Gets and sets the property MaxResults.

(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the 

NextToken
response element is present and has a value (isn't null). Include that value as the 
NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check 
NextToken
after every operation to ensure that you receive all of the results. 
public int MaxResults { get; set; }

Property Value

int

NextToken

Gets and sets the property NextToken.

(Optional) Use this parameter in a request if you receive a 

NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call 
NextToken
response to indicate where the output should continue from. 
public string NextToken { get; set; }

Property Value

string

SecretId

Gets and sets the property SecretId.

The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

note

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions. 

public string SecretId { get; set; }

Property Value

string