Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . servicecatalog ]

search-products

Description

Gets information about the products to which the caller has access.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  search-products
[--accept-language <value>]
[--filters <value>]
[--page-size <value>]
[--sort-by <value>]
[--sort-order <value>]
[--page-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--accept-language (string)

The language code.

  • en - English (default)
  • jp - Japanese
  • zh - Chinese

--filters (map)

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

Shorthand Syntax:

  KeyName1=string,string,KeyName2=string,string

Where valid key names are:
  FullTextSearch
  Owner
  ProductType
  SourceProductId

JSON Syntax:

{"FullTextSearch"|"Owner"|"ProductType"|"SourceProductId": ["string", ...]
  ...}

--page-size (integer)

The maximum number of items to return with this call.

--sort-by (string)

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

Possible values:

  • Title
  • VersionCount
  • CreationDate

--sort-order (string)

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

Possible values:

  • ASCENDING
  • DESCENDING

--page-token (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

ProductViewSummaries -> (list)

Information about the product views.

(structure)

Summary information about a product view.

Id -> (string)

The product view identifier.

ProductId -> (string)

The product identifier.

Name -> (string)

The name of the product.

Owner -> (string)

The owner of the product. Contact the product administrator for the significance of this value.

ShortDescription -> (string)

Short description of the product.

Type -> (string)

The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE , the product was created by AWS Marketplace.

Distributor -> (string)

The distributor of the product. Contact the product administrator for the significance of this value.

HasDefaultPath -> (boolean)

Indicates whether the product has a default path. If the product does not have a default path, call list-launch-paths to disambiguate between paths. Otherwise, list-launch-paths is not required, and the output of ProductViewSummary can be used directly with describe-provisioning-parameters .

SupportEmail -> (string)

The email contact information to obtain support for this Product.

SupportDescription -> (string)

The description of the support for this Product.

SupportUrl -> (string)

The URL information to obtain support for this Product.

ProductViewAggregations -> (map)

The product view aggregations.

key -> (string)

value -> (list)

(structure)

A single product view aggregation value/count pair, containing metadata about each product to which the calling user has access.

Value -> (string)

The value of the product view aggregation.

ApproximateCount -> (integer)

An approximate count of the products that match the value.

NextPageToken -> (string)

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.