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.

Synopsis¶

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

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

Constraints:

min: 1

max: 10

(structure)

A filter used to narrow purchase option results by product, seller, type, visibility, or availability.

filterType -> (string) [required]

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

Possible values:

PRODUCT_ID

SELLER_OF_RECORD_PROFILE_ID

PURCHASE_OPTION_TYPE

VISIBILITY_SCOPE

AVAILABILITY_STATUS

filterValues -> (list) [required]

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

Constraints:

min: 1

max: 10

(string)

Constraints:

min: 1

max: 255

pattern: [\w\-]+

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

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.

Constraints:

min: 0

max: 100

(structure)

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

purchaseOptionId -> (string) [required]

The unique identifier of the purchase option.

Constraints:

min: 1

max: 1024

pattern: .*\S.*

catalog -> (string) [required]

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

Constraints:

min: 1

max: 255

pattern: [\w\-]+

purchaseOptionType -> (string) [required]

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

Possible values:

OFFER

OFFERSET

purchaseOptionName -> (string)

The display name of the purchase option.

Constraints:

min: 1

max: 1024

pattern: .*\S.*

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

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

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

badges -> (list)

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

Constraints:

min: 0

max: 20

(structure)

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

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:

PRIVATE_PRICING

FUTURE_DATED

REPLACEMENT_OFFER

associatedEntities -> (list) [required]

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

Constraints:

min: 0

max: 100

(structure)

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

product -> (structure) [required]

Information about the product associated with the purchase option.

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

offer -> (structure) [required]

Information about the offer associated with the purchase option.

offerId -> (string) [required]

The unique identifier of the offer.

Constraints:

min: 1

max: 255

pattern: [\w\-]+

offerName -> (string)

The display name of the offer.

Constraints:

min: 0

max: 255

sellerOfRecord -> (structure) [required]

The entity responsible for selling the product under this offer.

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

offerSet -> (structure)

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

offerSetId -> (string) [required]

The unique identifier of the offer set.

Constraints:

min: 1

max: 255

pattern: [\w\-]+

sellerOfRecord -> (structure) [required]

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

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