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 ]

list-purchase-options

Description

Returns the purchase options (offers and offer sets) available to the buyer. You can filter results by product, seller, purchase option type, visibility scope, and availability status.

Note

You must include at least one of the following filters in the request: a PRODUCT_ID filter to specify the product for which to retrieve purchase options, or a VISIBILITY_SCOPE filter to retrieve purchase options by visibility.

See also: AWS API Documentation

list-purchase-options 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: purchaseOptions

Synopsis

  list-purchase-options
[--filters <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

--filters (list)

Filters to narrow the 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 purchase option results by product, seller, type, visibility, or availability.

filterType -> (string)

The type of filter to apply, such as PRODUCT_ID , VISIBILITY_SCOPE , or PURCHASE_OPTION_TYPE .

filterValues -> (list)

The values to filter by. Multiple values within the same filter are combined with OR logic.

(string)

Shorthand Syntax:

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

JSON Syntax:

[
  {
    "filterType": "PRODUCT_ID"|"SELLER_OF_RECORD_PROFILE_ID"|"PURCHASE_OPTION_TYPE"|"VISIBILITY_SCOPE"|"AVAILABILITY_STATUS",
    "filterValues": ["string", ...]
  }
  ...
]

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

purchaseOptions -> (list)

The purchase options available to the buyer. Each option is either an offer for a single product or an offer set spanning multiple products.

(structure)

Summary information about a purchase option (offer or offer set) available to the buyer, including the seller, badges, and associated products.

purchaseOptionId -> (string)

The unique identifier of the purchase option.

catalog -> (string)

The name of the catalog that the purchase option belongs to.

purchaseOptionType -> (string)

The type of purchase option. Values are OFFER for a single-product offer or OFFERSET for a bundled offer set.

purchaseOptionName -> (string)

The display name of the purchase option.

availableFromTime -> (timestamp)

The date and time when the purchase option became available to the buyer.

expirationTime -> (timestamp)

The date and time when the purchase option expires and is no longer available for procurement.

sellerOfRecord -> (structure)

The entity responsible for selling the product under this purchase option.

sellerProfileId -> (string)

The unique identifier of the seller profile.

displayName -> (string)

The human-readable name of the seller.

badges -> (list)

Badges indicating special attributes of the purchase option, such as private pricing or future dated.

(structure)

A badge indicating a special attribute of a purchase option, such as private pricing or future dated.

displayName -> (string)

The human-readable name of the badge.

badgeType -> (string)

The machine-readable type of the badge.

associatedEntities -> (list)

The products, offers, and offer sets associated with this purchase option.

(structure)

A product, offer, and optional offer set associated with a purchase option.

product -> (structure)

Information about the product associated with the purchase option.

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.

offer -> (structure)

Information about the offer associated with the purchase option.

offerId -> (string)

The unique identifier of the offer.

offerName -> (string)

The display name of the offer.

sellerOfRecord -> (structure)

The entity responsible for selling the product under this offer.

sellerProfileId -> (string)

The unique identifier of the seller profile.

displayName -> (string)

The human-readable name of the seller.

offerSet -> (structure)

Information about the offer set, if the purchase option is part of a bundled offer set.

offerSetId -> (string)

The unique identifier of the offer set.

sellerOfRecord -> (structure)

The entity responsible for selling the products under this offer set.

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.