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

Inherits:

Struct

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

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",
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #document_filter_list ⇒ Array<Types::DocumentFilter>

  One or more filters.

• #filters ⇒ Array<Types::DocumentKeyValuesFilter>

  One or more filters.

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

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

Returns:

• (Array<Types::DocumentFilter>)

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

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

#filters ⇒ Array<Types::DocumentKeyValuesFilter>

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

Returns:

• (Array<Types::DocumentKeyValuesFilter>)

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

class ListDocumentsRequest < Struct.new(
  :document_filter_list,
  :filters,
  :max_results,
  :next_token)
  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 'lib/aws-sdk-ssm/types.rb', line 10246

class ListDocumentsRequest < Struct.new(
  :document_filter_list,
  :filters,
  :max_results,
  :next_token)
  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 'lib/aws-sdk-ssm/types.rb', line 10246

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