You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/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",
}

Instance Attribute Summary collapse

Instance Attribute Details

#document_filter_listArray<Types::DocumentFilter>

One or more filters. Use a filter to return a more specific list of results.

Returns:



6749
6750
6751
6752
6753
6754
6755
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6749

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

#filtersArray<Types::DocumentKeyValuesFilter>

One or more filters. Use a filter to return a more specific list of results.

Returns:



6749
6750
6751
6752
6753
6754
6755
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6749

class ListDocumentsRequest < Struct.new(
  :document_filter_list,
  :filters,
  :max_results,
  :next_token)
  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)


6749
6750
6751
6752
6753
6754
6755
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6749

class ListDocumentsRequest < Struct.new(
  :document_filter_list,
  :filters,
  :max_results,
  :next_token)
  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)


6749
6750
6751
6752
6753
6754
6755
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6749

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