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

Class: Aws::ServiceCatalog::Types::SearchProductsAsAdminInput

Inherits:

Struct

• Object
• Struct
• Aws::ServiceCatalog::Types::SearchProductsAsAdminInput

Defined in:

gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb

Overview

Note:

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

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

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.

• #portfolio_id ⇒ String

  The portfolio identifier.

• #product_source ⇒ String

  Access level of the source of the product.

• #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 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 4092

class SearchProductsAsAdminInput < Struct.new(
  :accept_language,
  :portfolio_id,
  :filters,
  :sort_by,
  :sort_order,
  :page_token,
  :page_size,
  :product_source)
  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 administrator has access.

Returns:

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

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

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

#page_size ⇒ Integer

The maximum number of items to return with this call.

Returns:

• (Integer)

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

class SearchProductsAsAdminInput < Struct.new(
  :accept_language,
  :portfolio_id,
  :filters,
  :sort_by,
  :sort_order,
  :page_token,
  :page_size,
  :product_source)
  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 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 4092

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

#portfolio_id ⇒ String

The portfolio identifier.

Returns:

• (String)

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

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

#product_source ⇒ String

Access level of the source of the product.

Returns:

• (String)

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

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

#sort_by ⇒ String

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

Returns:

• (String)

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

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

#sort_order ⇒ String

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

Returns:

• (String)

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

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