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.

Synopsis¶

  search-listings
[--search-text <value>]
[--filters <value>]
[--sort-by <value>]
[--sort-order <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--search-text (string)

The search query text to find relevant listings.

Constraints:

min: 1

max: 512

pattern: .*[^ ]*.*

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

Constraints:

min: 1

max: 30

(structure)

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

filterType -> (string) [required]

The type of filter to apply.

Possible values:

MIN_AVERAGE_CUSTOMER_RATING

MAX_AVERAGE_CUSTOMER_RATING

CATEGORY

PUBLISHER

FULFILLMENT_OPTION_TYPE

PRICING_MODEL

PRICING_UNIT

DEPLOYED_ON_AWS

NUMBER_OF_PRODUCTS

filterValues -> (list) [required]

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.

Constraints:

min: 1

max: 30

(string)

Constraints:

min: 1

max: 128

pattern: [\w\-\.]+

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 | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
yaml
yaml-stream
off

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

totalResults -> (long)

The total number of listings matching the search criteria.

Constraints:

min: 0

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) [required]

The unique identifier of the listing.

Constraints:

min: 1

max: 255

pattern: [\w\-]+

listingName -> (string) [required]

The human-readable display name of the listing.

Constraints:

min: 1

max: 1024

pattern: .*\S.*

publisher -> (structure) [required]

The entity who created and published the listing.

sellerProfileId -> (string) [required]

The unique identifier of the seller profile.

Constraints:

min: 1

max: 255

pattern: [\w\-]+

displayName -> (string) [required]

The human-readable name of the seller.

Constraints:

min: 1

max: 1024

pattern: .*\S.*

catalog -> (string) [required]

The name of the catalog that the listing belongs to.

Constraints:

min: 1

max: 255

pattern: [\w\-]+

shortDescription -> (string) [required]

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

Constraints:

min: 1

max: 1024

pattern: .*\S.*

logoThumbnailUrl -> (string) [required]

The URL of the logo thumbnail image for the listing.

Constraints:

min: 1

max: 2048

pattern: https?://.*

categories -> (list) [required]

The categories used to classify this listing into logical groups.

Constraints:

min: 0

max: 30

(structure)

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

categoryId -> (string) [required]

The machine-readable identifier of the category.

Constraints:

min: 1

max: 1024

pattern: .*\S.*

displayName -> (string) [required]

The human-readable name of the category.

Constraints:

min: 1

max: 1024

pattern: .*\S.*

fulfillmentOptionSummaries -> (list) [required]

A summary of fulfillment options available for the listing.

Constraints:

min: 0

max: 20

(structure)

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

fulfillmentOptionType -> (string) [required]

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

Possible values:

AMAZON_MACHINE_IMAGE

API

CLOUDFORMATION_TEMPLATE

CONTAINER

HELM

EKS_ADD_ON

EC2_IMAGE_BUILDER_COMPONENT

DATA_EXCHANGE

PROFESSIONAL_SERVICES

SAAS

SAGEMAKER_ALGORITHM

SAGEMAKER_MODEL

displayName -> (string) [required]

The human-readable name of the fulfillment option type.

Constraints:

min: 1

max: 1024

pattern: .*\S.*

badges -> (list) [required]

Badges indicating special attributes of the listing.

Constraints:

min: 0

max: 20

(structure)

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

displayName -> (string) [required]

The human-readable name of the badge.

Constraints:

min: 1

max: 1024

pattern: .*\S.*

badgeType -> (string) [required]

The machine-readable type of the badge.

Possible values:

AWS_FREE_TIER

FREE_TRIAL

DEPLOYED_ON_AWS

QUICK_LAUNCH

MULTI_PRODUCT

reviewSummary -> (structure) [required]

A summary of customer reviews for the listing.

reviewSourceSummaries -> (list) [required]

Review summaries from different sources, such as AWS Marketplace.

Constraints:

min: 0

max: 10

(structure)

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

sourceName -> (string) [required]

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

Constraints:

min: 1

max: 1024

pattern: .*\S.*

sourceId -> (string) [required]

The machine-readable identifier of the review source.

Possible values:

AWS_MARKETPLACE

sourceUrl -> (string)

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

Constraints:

min: 1

max: 2048

pattern: https?://.*

averageRating -> (string) [required]

The average rating across all reviews from this source.

Constraints:

min: 1

max: 1024

pattern: .*\S.*

totalReviews -> (long) [required]

The total number of reviews available from this source.

Constraints:

min: 0

pricingModels -> (list) [required]

The pricing models for offers associated with this listing.

Constraints:

min: 0

max: 20

(structure)

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

pricingModelType -> (string) [required]

The machine-readable type of the pricing model.

Possible values:

USAGE

CONTRACT

BYOL

FREE

displayName -> (string) [required]

The human-readable name of the pricing model.

Constraints:

min: 1

max: 1024

pattern: .*\S.*

pricingUnits -> (list) [required]

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

Constraints:

min: 0

max: 20

(structure)

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

pricingUnitType -> (string) [required]

The machine-readable type of the pricing unit.

Possible values:

USERS

HOSTS

BANDWIDTH

DATA

TIERS

REQUESTS

UNITS

displayName -> (string) [required]

The human-readable name of the pricing unit.

Constraints:

min: 1

max: 1024

pattern: .*\S.*

associatedEntities -> (list) [required]

The products associated with this listing.

Constraints:

min: 0

max: 50

(structure)

A product associated with a listing summary.

product -> (structure)

Information about the associated product.

productId -> (string) [required]

The unique identifier of the product.

Constraints:

min: 1

max: 255

pattern: [\w\-]+

productName -> (string) [required]

The human-readable display name of the product.

Constraints:

min: 1

max: 1024

pattern: .*\S.*

manufacturer -> (structure) [required]

The entity who manufactured the product.

sellerProfileId -> (string) [required]

The unique identifier of the seller profile.

Constraints:

min: 1

max: 255

pattern: [\w\-]+

displayName -> (string) [required]

The human-readable name of the seller.

Constraints:

min: 1

max: 1024

pattern: .*\S.*

nextToken -> (string)

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

Constraints:

min: 0

max: 8192

pattern: [a-zA-Z0-9+/=]+

Table of Contents

Feedback

User Guide