class Amazonite::Ssm::ListDocumentsRequest

Included Modules

Defined in:

ssm/list_documents_request.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(document_filter_list : Array(DocumentFilter) | Nil = nil, filters : Array(DocumentKeyValuesFilter) | Nil = nil, max_results : Int32 | Nil = nil, next_token : String | Nil = nil) #

[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def document_filter_list : Array(DocumentFilter) | Nil #

This data type is deprecated. Instead, use Filters.


[View source]
def document_filter_list=(document_filter_list : Array(DocumentFilter) | Nil) #

This data type is deprecated. Instead, use Filters.


[View source]
def filters : Array(DocumentKeyValuesFilter) | Nil #

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


[View source]
def filters=(filters : Array(DocumentKeyValuesFilter) | Nil) #

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


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def max_results : Int32 | Nil #

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.


[View source]
def max_results=(max_results : Int32 | Nil) #

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.


[View source]
def next_token : String | Nil #

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


[View source]
def next_token=(next_token : String | Nil) #

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


[View source]
def validate! : Nil #

[View source]