AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . marketplace-discovery ]

search-facets

Description

Returns available facet values for filtering listings, such as categories, pricing models, fulfillment option types, publishers, and customer ratings. Each facet value includes a count of matching listings.

See also: AWS API Documentation

search-facets is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: listingFacets

Synopsis

  search-facets
[--search-text <value>]
[--filters <value>]
[--facet-types <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--search-text (string)

The search query text to filter listings before retrieving facets.

--filters (list)

Filters to apply before retrieving facets. Multiple filters are combined with AND logic. Multiple values within the same filter are combined with OR logic.

(structure)

A filter used to narrow search results by attribute, such as category, pricing model, or fulfillment type.

filterType -> (string)

The type of filter to apply.

filterValues -> (list)

The values to filter by. Term filters accept multiple values (OR logic). Range filters (MIN/MAX_AVERAGE_CUSTOMER_RATING) accept a single value between 0.0 and 5.0.

(string)

Shorthand Syntax:

filterType=string,filterValues=string,string ...

JSON Syntax:

[
  {
    "filterType": "MIN_AVERAGE_CUSTOMER_RATING"|"MAX_AVERAGE_CUSTOMER_RATING"|"CATEGORY"|"PUBLISHER"|"FULFILLMENT_OPTION_TYPE"|"PRICING_MODEL"|"PRICING_UNIT"|"DEPLOYED_ON_AWS"|"NUMBER_OF_PRODUCTS",
    "filterValues": ["string", ...]
  }
  ...
]

--facet-types (list)

A list of specific facet types to retrieve. If empty or null, all available facets are returned.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  AVERAGE_CUSTOMER_RATING
  CATEGORY
  PUBLISHER
  FULFILLMENT_OPTION_TYPE
  PRICING_MODEL
  PRICING_UNIT
  DEPLOYED_ON_AWS
  NUMBER_OF_PRODUCTS

--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. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

totalResults -> (long)

The total number of listings matching the search criteria.

listingFacets -> (map)

A map of facet types to their corresponding facet values. Each facet value includes a display name, internal value, and count of matching listings.

key -> (string)

value -> (list)

(structure)

A facet value with display information and a count of matching listings. Used to build filter and browse experiences.

value -> (string)

The internal value used for filtering when passed back in a search filter.

displayName -> (string)

The human-readable name of the facet value, suitable for display in a user interface.

parent -> (string)

The parent facet value for hierarchical facets, such as subcategories.

count -> (long)

The number of listings matching this facet value.

nextToken -> (string)

If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.