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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-ssm/types.rb

Overview

Note:

When making an API call, you may pass ListDocumentsRequest data as a 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",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#document_filter_listArray<Types::DocumentFilter>

This data type is deprecated. Instead, use `Filters`.

Returns:


12455
12456
12457
12458
12459
12460
12461
12462
# File 'lib/aws-sdk-ssm/types.rb', line 12455

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

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

<note markdown=“1”> 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`

</note>

Returns:


12455
12456
12457
12458
12459
12460
12461
12462
# File 'lib/aws-sdk-ssm/types.rb', line 12455

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

#max_resultsInteger

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)

12455
12456
12457
12458
12459
12460
12461
12462
# File 'lib/aws-sdk-ssm/types.rb', line 12455

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

#next_tokenString

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

Returns:

  • (String)

12455
12456
12457
12458
12459
12460
12461
12462
# File 'lib/aws-sdk-ssm/types.rb', line 12455

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