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
show all
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
}

Instance Attribute Summary collapse

Instance Attribute Details

#accept_languageString

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

Returns:

  • (String)


3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 3319

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

#filtersHash<String,Array<String>>

The list of filters with which to limit search results. If no search filters are specified, the output is all the products to which the administrator has access.

Returns:

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


3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 3319

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

#page_sizeInteger

The maximum number of items to return in the results. If more results exist than fit in the specified PageSize, the value of NextPageToken in the response is non-null.

Returns:

  • (Integer)


3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 3319

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

#page_tokenString

The page token of the first page retrieved. If null, this retrieves the first page of size PageSize.

Returns:

  • (String)


3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 3319

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

#portfolio_idString

The portfolio identifier.

Returns:

  • (String)


3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 3319

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

#product_sourceString

Access level of the source of the product.

Returns:

  • (String)


3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 3319

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

#sort_byString

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

Returns:

  • (String)


3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 3319

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

#sort_orderString

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

Returns:

  • (String)


3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 3319

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