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

Description

Returns a list of product listings based on search criteria and filters. You can search by keyword, filter by category, pricing model, fulfillment type, and other attributes, and sort results by relevance or customer rating.

See also: AWS API Documentation

search-listings 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: listingSummaries

Synopsis

  search-listings
[--search-text <value>]
[--filters <value>]
[--sort-by <value>]
[--sort-order <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <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 find relevant listings.

--filters (list)

Filters to narrow search results. 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", ...]
  }
  ...
]

--sort-by (string)

The field to sort results by. Valid values are RELEVANCE and AVERAGE_CUSTOMER_RATING .

Possible values:

  • RELEVANCE
  • AVERAGE_CUSTOMER_RATING

--sort-order (string)

The sort direction. Valid values are DESCENDING and ASCENDING .

Possible values:

  • DESCENDING
  • ASCENDING

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

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

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.

listingSummaries -> (list)

The listing summaries matching the search criteria. Each summary includes the listing name, description, badges, categories, pricing models, reviews, and associated products.

(structure)

Summary information about a listing returned by search operations, including the listing name, description, badges, categories, pricing models, reviews, and associated products.

listingId -> (string)

The unique identifier of the listing.

listingName -> (string)

The human-readable display name of the listing.

publisher -> (structure)

The entity who created and published the listing.

sellerProfileId -> (string)

The unique identifier of the seller profile.

displayName -> (string)

The human-readable name of the seller.

catalog -> (string)

The name of the catalog that the listing belongs to.

shortDescription -> (string)

A 1–3 sentence summary describing the key aspects of the listing.

logoThumbnailUrl -> (string)

The URL of the logo thumbnail image for the listing.

categories -> (list)

The categories used to classify this listing into logical groups.

(structure)

A category used to classify a listing or product into a logical group.

categoryId -> (string)

The machine-readable identifier of the category.

displayName -> (string)

The human-readable name of the category.

fulfillmentOptionSummaries -> (list)

A summary of fulfillment options available for the listing.

(structure)

A summary of a fulfillment option available for deploying or accessing a listing or product.

fulfillmentOptionType -> (string)

The machine-readable type of the fulfillment option, such as SAAS or AMAZON_MACHINE_IMAGE .

displayName -> (string)

The human-readable name of the fulfillment option type.

badges -> (list)

Badges indicating special attributes of the listing.

(structure)

A badge indicating a special attribute of a listing, such as free tier eligibility or Quick Launch support.

displayName -> (string)

The human-readable name of the badge.

badgeType -> (string)

The machine-readable type of the badge.

reviewSummary -> (structure)

A summary of customer reviews for the listing.

reviewSourceSummaries -> (list)

Review summaries from different sources, such as AWS Marketplace.

(structure)

A review summary from a specific source, including the average rating and total review count.

sourceName -> (string)

The name of the review source, such as AWS Marketplace.

sourceId -> (string)

The machine-readable identifier of the review source.

sourceUrl -> (string)

The URL where the reviews can be accessed at the source.

averageRating -> (string)

The average rating across all reviews from this source.

totalReviews -> (long)

The total number of reviews available from this source.

pricingModels -> (list)

The pricing models for offers associated with this listing.

(structure)

A pricing model that determines how buyers are charged for a listing, such as usage-based, contract, BYOL, or free.

pricingModelType -> (string)

The machine-readable type of the pricing model.

displayName -> (string)

The human-readable name of the pricing model.

pricingUnits -> (list)

The pricing units that define the billing dimensions for offers associated with this listing.

(structure)

A pricing unit that defines the billing dimension for a listing, such as users, hosts, bandwidth, or data.

pricingUnitType -> (string)

The machine-readable type of the pricing unit.

displayName -> (string)

The human-readable name of the pricing unit.

associatedEntities -> (list)

The products associated with this listing.

(structure)

A product associated with a listing summary.

product -> (structure)

Information about the associated product.

productId -> (string)

The unique identifier of the product.

productName -> (string)

The human-readable display name of the product.

manufacturer -> (structure)

The entity who manufactured the product.

sellerProfileId -> (string)

The unique identifier of the seller profile.

displayName -> (string)

The human-readable name of the seller.

nextToken -> (string)

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