Class: Aws::ServiceCatalog::Types::SearchProductsInput

Inherits:

Struct

• Object
• Struct
• Aws::ServiceCatalog::Types::SearchProductsInput

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-servicecatalog/types.rb

Overview

Note:

When making an API call, you may pass SearchProductsInput data as a hash:

{
  accept_language: "AcceptLanguage",
  filters: {
    "FullTextSearch" => ["ProductViewFilterValue"],
  },
  page_size: 1,
  sort_by: "Title", # accepts Title, VersionCount, CreationDate
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  page_token: "PageToken",
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #accept_language ⇒ String

  The language code.

• #filters ⇒ Hash<String,Array<String>>

  The search filters.

• #page_size ⇒ Integer

  The maximum number of items to return with this call.

• #page_token ⇒ String

  The page token for the next set of results.

• #sort_by ⇒ String

  The sort field.

• #sort_order ⇒ String

  The sort order.

Instance Attribute Details

#accept_language ⇒ String

The language code.

• ‘en` - English (default)

• ‘jp` - Japanese

• ‘zh` - Chinese

Returns:

• (String)

# File 'lib/aws-sdk-servicecatalog/types.rb', line 5330

class SearchProductsInput < Struct.new(
  :accept_language,
  :filters,
  :page_size,
  :sort_by,
  :sort_order,
  :page_token)
  include Aws::Structure
end

#filters ⇒ Hash<String,Array<String>>

The search filters. If no search filters are specified, the output includes all products to which the caller has access.

Returns:

• (Hash<String,Array<String>>)

# File 'lib/aws-sdk-servicecatalog/types.rb', line 5330

class SearchProductsInput < Struct.new(
  :accept_language,
  :filters,
  :page_size,
  :sort_by,
  :sort_order,
  :page_token)
  include Aws::Structure
end

#page_size ⇒ Integer

The maximum number of items to return with this call.

Returns:

• (Integer)

# File 'lib/aws-sdk-servicecatalog/types.rb', line 5330

class SearchProductsInput < Struct.new(
  :accept_language,
  :filters,
  :page_size,
  :sort_by,
  :sort_order,
  :page_token)
  include Aws::Structure
end

#page_token ⇒ String

The page token for the next set of results. To retrieve the first set of results, use null.

Returns:

• (String)

# File 'lib/aws-sdk-servicecatalog/types.rb', line 5330

class SearchProductsInput < Struct.new(
  :accept_language,
  :filters,
  :page_size,
  :sort_by,
  :sort_order,
  :page_token)
  include Aws::Structure
end

#sort_by ⇒ String

The sort field. If no value is specified, the results are not sorted.

Returns:

• (String)

# File 'lib/aws-sdk-servicecatalog/types.rb', line 5330

class SearchProductsInput < Struct.new(
  :accept_language,
  :filters,
  :page_size,
  :sort_by,
  :sort_order,
  :page_token)
  include Aws::Structure
end

#sort_order ⇒ String

The sort order. If no value is specified, the results are not sorted.

Returns:

• (String)

# File 'lib/aws-sdk-servicecatalog/types.rb', line 5330

class SearchProductsInput < Struct.new(
  :accept_language,
  :filters,
  :page_size,
  :sort_by,
  :sort_order,
  :page_token)
  include Aws::Structure
end