AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the ListSecrets operation. 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 DescribeSecret.

To list the versions of a secret, use ListSecretVersionIds.

To retrieve the values for the secrets, call BatchGetSecretValue or GetSecretValue.

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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SecretsManager.AmazonSecretsManagerRequest
      Amazon.SecretsManager.Model.ListSecretsRequest

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

Syntax

C#
public class ListSecretsRequest : AmazonSecretsManagerRequest
         IAmazonWebServiceRequest

The ListSecretsRequest type exposes the following members

Constructors

NameDescription
Public Method ListSecretsRequest()

Properties

NameTypeDescription
Public Property Filters System.Collections.Generic.List<Amazon.SecretsManager.Model.Filter>

Gets and sets the property Filters.

The filters to apply to the list of secrets.

Public Property IncludePlannedDeletion System.Boolean

Gets and sets the property IncludePlannedDeletion.

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

Public Property 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. To get the next results, call ListSecrets again with the value from NextToken.

Public Property 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 ListSecrets again with this value.

Public Property SortOrder Amazon.SecretsManager.SortOrderType

Gets and sets the property SortOrder.

Secrets are listed by CreatedDate.

Examples

The following example shows how to list all of the secrets in your account.

To list the secrets in your account


var client = new AmazonSecretsManagerClient();
var response = client.ListSecrets(new ListSecretsRequest 
{
});

List<SecretListEntry> secretList = response.SecretList;

            

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