You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::SSM::Types::ListDocumentsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::SSM::Types::ListDocumentsRequest
- Defined in:
- (unknown)
Overview
When passing ListDocumentsRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
document_filter_list: [
{
key: "Name", # required, accepts Name, Owner, PlatformTypes, DocumentType
value: "DocumentFilterValue", # required
},
],
filters: [
{
key: "DocumentKeyValuesFilterKey",
values: ["DocumentKeyValuesFilterValue"],
},
],
max_results: 1,
next_token: "NextToken",
}
Instance Attribute Summary collapse
-
#document_filter_list ⇒ Array<Types::DocumentFilter>
This data type is deprecated.
-
#filters ⇒ Array<Types::DocumentKeyValuesFilter>
One or more DocumentKeyValuesFilter objects.
-
#max_results ⇒ Integer
The maximum number of items to return for this call.
-
#next_token ⇒ String
The token for the next set of items to return.
Instance Attribute Details
#document_filter_list ⇒ Array<Types::DocumentFilter>
This data type is deprecated. Instead, use Filters
.
#filters ⇒ Array<Types::DocumentKeyValuesFilter>
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
.
#max_results ⇒ Integer
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.
#next_token ⇒ String
The token for the next set of items to return. (You received this token from a previous call.)