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 ListDocuments operation. Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results of this request by using a filter.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementRequest
      Amazon.SimpleSystemsManagement.Model.ListDocumentsRequest

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

Syntax

C# 
public class ListDocumentsRequest : AmazonSimpleSystemsManagementRequest
         IAmazonWebServiceRequest

The ListDocumentsRequest type exposes the following members

Constructors

NameDescription
Public Method ListDocumentsRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Public Method ListDocumentsRequest(List<DocumentFilter>)

Instantiates ListDocumentsRequest with the parameterized properties

Properties

NameTypeDescription
Public Property DocumentFilterList System.Collections.Generic.List<Amazon.SimpleSystemsManagement.Model.DocumentFilter>

Gets and sets the property DocumentFilterList.

This data type is deprecated. Instead, use Filters.

Public Property Filters System.Collections.Generic.List<Amazon.SimpleSystemsManagement.Model.DocumentKeyValuesFilter>

Gets and sets the property Filters.

One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.

This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: Key=tag:tagName,Values=valueName1,valueName2

Public Property MaxResults System.Int32

Gets and sets the property MaxResults.

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Public Property NextToken System.String

Gets and sets the property NextToken.

The token for the next set of items to return. (You received this token from a previous call.)

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