Class: Aws::OpenSearchServerless::Types::ListCollectionsRequest

Inherits:

Struct

• Object
• Struct
• Aws::OpenSearchServerless::Types::ListCollectionsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-opensearchserverless/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #collection_filters ⇒ Types::CollectionFilters

  A list of filter names and values that you can use for requests.

• #max_results ⇒ Integer

  The maximum number of results to return.

• #next_token ⇒ String

  If your initial ‘ListCollections` operation returns a `nextToken`, you can include the returned `nextToken` in subsequent `ListCollections` operations, which returns results in the next page.

Instance Attribute Details

#collection_filters ⇒ Types::CollectionFilters

A list of filter names and values that you can use for requests.

Returns:

• (Types::CollectionFilters)

# File 'lib/aws-sdk-opensearchserverless/types.rb', line 1640

class ListCollectionsRequest < Struct.new(
  :collection_filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to return. Default is 20. You can use ‘nextToken` to get the next page of results.

Returns:

• (Integer)

# File 'lib/aws-sdk-opensearchserverless/types.rb', line 1640

class ListCollectionsRequest < Struct.new(
  :collection_filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

If your initial ‘ListCollections` operation returns a `nextToken`, you can include the returned `nextToken` in subsequent `ListCollections` operations, which returns results in the next page.

Returns:

• (String)

# File 'lib/aws-sdk-opensearchserverless/types.rb', line 1640

class ListCollectionsRequest < Struct.new(
  :collection_filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end