Class: Aws::SSM::Types::ListDocumentsRequest

Inherits:

Struct

• Object
• Struct
• Aws::SSM::Types::ListDocumentsRequest

Defined in:

gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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.

Returns:

• (Array<Types::DocumentFilter>)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 11659

class ListDocumentsRequest < Struct.new(
  :document_filter_list,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#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.

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

Returns:

• (Array<Types::DocumentKeyValuesFilter>)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 11659

class ListDocumentsRequest < Struct.new(
  :document_filter_list,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

• (Integer)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 11659

class ListDocumentsRequest < Struct.new(
  :document_filter_list,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 11659

class ListDocumentsRequest < Struct.new(
  :document_filter_list,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end