2026/09/24 - AWS Marketplace Discovery - 9 updated api methods
Changes AWS Marketplace Discovery API now supports localized responses and SigV4a request signing. It returns new fulfillment details, including AMI architecture, EBS volume and security group information, SaaS quick-launch status, and SageMaker input and output MIME types.
{'locale': 'string'}
Provides details about a listing, such as descriptions, badges, categories, pricing model summaries, reviews, and associated products and offers.
See also: AWS API Documentation
Request Syntax
client.get_listing(
locale='string',
listingId='string'
)
string
A BCP 47 language tag or comma-separated priority list specifying the preferred locale for response content. See Locale for supported values, constraints, fallback behavior, and the default locale. If omitted, the service returns content in the default locale.
string
[REQUIRED]
The unique identifier of the listing to retrieve.
dict
Response Syntax
{
'locale': 'string',
'associatedEntities': [
{
'product': {
'productId': 'string',
'productName': 'string',
'manufacturer': {
'sellerProfileId': 'string',
'displayName': 'string'
}
},
'offer': {
'offerId': 'string',
'offerName': 'string',
'sellerOfRecord': {
'sellerProfileId': 'string',
'displayName': 'string'
}
}
},
],
'badges': [
{
'displayName': 'string',
'badgeType': 'AWS_FREE_TIER'|'FREE_TRIAL'|'DEPLOYED_ON_AWS'|'QUICK_LAUNCH'|'MULTI_PRODUCT'
},
],
'catalog': 'string',
'categories': [
{
'categoryId': 'string',
'displayName': 'string'
},
],
'fulfillmentOptionSummaries': [
{
'fulfillmentOptionType': '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'
},
],
'highlights': [
'string',
],
'integrationGuide': 'string',
'listingId': 'string',
'listingName': 'string',
'logoThumbnailUrl': 'string',
'longDescription': 'string',
'pricingModels': [
{
'pricingModelType': 'USAGE'|'CONTRACT'|'BYOL'|'FREE',
'displayName': 'string'
},
],
'pricingUnits': [
{
'pricingUnitType': 'USERS'|'HOSTS'|'BANDWIDTH'|'DATA'|'TIERS'|'REQUESTS'|'UNITS',
'displayName': 'string'
},
],
'promotionalMedia': [
{
'embeddedImage': {
'title': 'string',
'url': 'string',
'description': 'string'
},
'embeddedVideo': {
'title': 'string',
'url': 'string',
'preview': 'string',
'thumbnail': 'string',
'description': 'string'
}
},
],
'publisher': {
'sellerProfileId': 'string',
'displayName': 'string'
},
'resources': [
{
'resourceType': 'MANUFACTURER_SUPPORT'|'MANUFACTURER_INSTRUCTIONS',
'contentType': 'EMAIL'|'PHONE_NUMBER'|'LINK'|'OTHER',
'value': 'string',
'displayName': 'string'
},
],
'reviewSummary': {
'reviewSourceSummaries': [
{
'sourceName': 'string',
'sourceId': 'AWS_MARKETPLACE',
'sourceUrl': 'string',
'averageRating': 'string',
'totalReviews': 123
},
]
},
'sellerEngagements': [
{
'engagementType': 'REQUEST_FOR_PRIVATE_OFFER'|'REQUEST_FOR_DEMO',
'contentType': 'LINK',
'value': 'string'
},
],
'shortDescription': 'string',
'useCases': [
{
'useCase': {
'description': 'string',
'displayName': 'string',
'value': 'string'
}
},
]
}
Response Structure
(dict) --
locale (string) --
The locale of the returned content. Indicates whether the response contains content in the requested locale, or fell back to the default locale. See Locale for details.
associatedEntities (list) --
The products and offers associated with this listing. Each entity contains product and offer information.
(dict) --
A product and offer associated with a listing.
product (dict) --
Information about the product associated with the listing.
productId (string) --
The unique identifier of the product.
productName (string) --
The human-readable display name of the product.
manufacturer (dict) --
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 (dict) --
Information about the default offer associated with the listing.
offerId (string) --
The unique identifier of the offer.
offerName (string) --
The display name of the offer.
sellerOfRecord (dict) --
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.
badges (list) --
Badges indicating special attributes of the listing, such as free tier eligibility, free trial availability, or Quick Launch support.
(dict) --
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.
catalog (string) --
The name of the catalog that the listing belongs to.
categories (list) --
The categories used to classify this listing into logical groups.
(dict) --
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 deploying or accessing the listing, such as AMI, SaaS, or Container.
(dict) --
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.
highlights (list) --
A list of key features that the listing offers to customers.
(string) --
integrationGuide (string) --
Optional guidance explaining how to use data in this listing. Primarily defines how to integrate with a multi-product listing.
listingId (string) --
The unique identifier of the listing.
listingName (string) --
The human-readable display name of the listing.
logoThumbnailUrl (string) --
The URL of the logo thumbnail image for the listing.
longDescription (string) --
A detailed description of what the listing offers, in paragraph format.
pricingModels (list) --
The pricing models for offers associated with this listing, such as usage-based, contract, BYOL, or free.
(dict) --
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, such as users, hosts, or data.
(dict) --
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.
promotionalMedia (list) --
Embedded promotional media provided by the creator of the product, such as images and videos.
(dict) --
Embedded promotional media for a product, such as images or videos. Each element contains exactly one media type.
embeddedImage (dict) --
An embedded promotional image for a product.
title (string) --
The title displayed when hovering over the image.
url (string) --
The URL of the image file.
description (string) --
An optional description of the image.
embeddedVideo (dict) --
An embedded promotional video for a product.
title (string) --
The title displayed when hovering over the video.
url (string) --
The URL of the video file.
preview (string) --
The URL of the high-resolution preview image for the video.
thumbnail (string) --
The URL of the thumbnail image for the video.
description (string) --
An optional description of the video.
publisher (dict) --
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.
resources (list) --
Resources that provide further information about using the product or requesting support, such as documentation links, support contacts, and usage instructions.
(dict) --
A resource that provides supplementary information about a product, such as documentation links, support contacts, or usage instructions.
resourceType (string) --
The category of the resource, such as manufacturer support or usage instructions.
contentType (string) --
The format of the resource content, such as a URL, email address, or text.
value (string) --
The resource content. Interpretation depends on the content type.
displayName (string) --
An optional human-readable label for the resource.
reviewSummary (dict) --
A summary of customer reviews available for the listing, including average rating and total review count by source.
reviewSourceSummaries (list) --
Review summaries from different sources, such as AWS Marketplace.
(dict) --
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 (integer) --
The total number of reviews available from this source.
sellerEngagements (list) --
Engagement options available to potential buyers, such as requesting a private offer or requesting a demo.
(dict) --
An engagement option available to potential buyers of a product, such as requesting a private offer or a demo.
engagementType (string) --
The type of engagement, such as REQUEST_FOR_PRIVATE_OFFER or REQUEST_FOR_DEMO.
contentType (string) --
The format of the engagement value, such as a URL.
value (string) --
The engagement value, such as a URL to the engagement form.
shortDescription (string) --
A 1–3 sentence summary describing the key aspects of the listing.
useCases (list) --
Use cases associated with the listing, describing scenarios where the product can be applied.
(dict) --
An entry in the list of use cases for a listing.
useCase (dict) --
The use case details.
description (string) --
A description of the use case.
displayName (string) --
The human-readable name of the use case.
value (string) --
The machine-readable identifier of the use case.
{'locale': 'string'}
Provides details about an offer, such as the pricing model, seller of record, availability dates, badges, and associated products.
See also: AWS API Documentation
Request Syntax
client.get_offer(
locale='string',
offerId='string'
)
string
A BCP 47 language tag or comma-separated priority list specifying the preferred locale for response content. See Locale for supported values, constraints, fallback behavior, and the default locale. If omitted, the service returns content in the default locale.
string
[REQUIRED]
The unique identifier of the offer to retrieve.
dict
Response Syntax
{
'locale': 'string',
'offerId': 'string',
'catalog': 'string',
'offerName': 'string',
'expirationTime': datetime(2015, 1, 1),
'availableFromTime': datetime(2015, 1, 1),
'sellerOfRecord': {
'sellerProfileId': 'string',
'displayName': 'string'
},
'associatedEntities': [
{
'product': {
'productId': 'string',
'productName': 'string',
'manufacturer': {
'sellerProfileId': 'string',
'displayName': 'string'
}
},
'offerSet': {
'offerSetId': 'string',
'sellerOfRecord': {
'sellerProfileId': 'string',
'displayName': 'string'
}
}
},
],
'agreementProposalId': 'string',
'replacementAgreementId': 'string',
'pricingModel': {
'pricingModelType': 'USAGE'|'CONTRACT'|'BYOL'|'FREE',
'displayName': 'string'
},
'badges': [
{
'displayName': 'string',
'badgeType': 'PRIVATE_PRICING'|'FUTURE_DATED'|'REPLACEMENT_OFFER'|'AUTO_RENEW'
},
]
}
Response Structure
(dict) --
locale (string) --
The locale of the returned content. Indicates whether the response contains content in the requested locale, or fell back to the default locale. See Locale for details.
offerId (string) --
The unique identifier of the offer.
catalog (string) --
The name of the catalog that the offer belongs to.
offerName (string) --
The display name of the offer. This is free-form text provided by the seller.
expirationTime (datetime) --
The date and time until when the offer can be procured. This value is null for offers that never expire.
availableFromTime (datetime) --
The date and time when the offer became available to the buyer.
sellerOfRecord (dict) --
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.
associatedEntities (list) --
The products and offer sets associated with this offer.
(dict) --
A product and optional offer set associated with an offer.
product (dict) --
Information about the product associated with the offer.
productId (string) --
The unique identifier of the product.
productName (string) --
The human-readable display name of the product.
manufacturer (dict) --
The entity who manufactured the product.
sellerProfileId (string) --
The unique identifier of the seller profile.
displayName (string) --
The human-readable name of the seller.
offerSet (dict) --
Information about the offer set, if the offer is part of a bundled offer set.
offerSetId (string) --
The unique identifier of the offer set.
sellerOfRecord (dict) --
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.
agreementProposalId (string) --
An encoded string to be passed by the acceptor of the terms when creating an agreement.
replacementAgreementId (string) --
The identifier of the existing agreement that this offer would replace. Enables agreement-based offer functionality.
pricingModel (dict) --
The pricing model that determines how buyers are charged, 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.
badges (list) --
Badges indicating special attributes of the offer, such as private pricing, future dated, or replacement offer.
(dict) --
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.
{'locale': 'string'}
Provides details about an offer set, which is a bundle of offers across multiple products. Includes the seller, availability dates, buyer notes, and associated product-offer pairs.
See also: AWS API Documentation
Request Syntax
client.get_offer_set(
locale='string',
offerSetId='string'
)
string
A BCP 47 language tag or comma-separated priority list specifying the preferred locale for response content. See Locale for supported values, constraints, fallback behavior, and the default locale. If omitted, the service returns content in the default locale.
string
[REQUIRED]
The unique identifier of the offer set to retrieve.
dict
Response Syntax
{
'locale': 'string',
'offerSetId': 'string',
'catalog': 'string',
'offerSetName': 'string',
'availableFromTime': datetime(2015, 1, 1),
'expirationTime': datetime(2015, 1, 1),
'buyerNotes': 'string',
'sellerOfRecord': {
'sellerProfileId': 'string',
'displayName': 'string'
},
'badges': [
{
'displayName': 'string',
'badgeType': 'PRIVATE_PRICING'|'FUTURE_DATED'|'REPLACEMENT_OFFER'|'AUTO_RENEW'
},
],
'associatedEntities': [
{
'product': {
'productId': 'string',
'productName': 'string',
'manufacturer': {
'sellerProfileId': 'string',
'displayName': 'string'
}
},
'offer': {
'offerId': 'string',
'offerName': 'string',
'sellerOfRecord': {
'sellerProfileId': 'string',
'displayName': 'string'
}
}
},
]
}
Response Structure
(dict) --
locale (string) --
The locale of the returned content. Indicates whether the response contains content in the requested locale, or fell back to the default locale. See Locale for details.
offerSetId (string) --
The unique identifier of the offer set.
catalog (string) --
The name of the catalog that the offer set belongs to.
offerSetName (string) --
The display name of the offer set.
availableFromTime (datetime) --
The date and time when the offer set became available to the buyer.
expirationTime (datetime) --
The date and time when the offer set expires and is no longer available for procurement.
buyerNotes (string) --
Detailed information about the offer set that helps buyers understand its purpose and contents.
sellerOfRecord (dict) --
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.
badges (list) --
Badges indicating special attributes of the offer set, such as private pricing or future dated.
(dict) --
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 and offers included in this offer set.
(dict) --
A product and offer associated with an offer set.
product (dict) --
Information about the product associated with the offer set.
productId (string) --
The unique identifier of the product.
productName (string) --
The human-readable display name of the product.
manufacturer (dict) --
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 (dict) --
Information about the offer associated with the offer set.
offerId (string) --
The unique identifier of the offer.
offerName (string) --
The display name of the offer.
sellerOfRecord (dict) --
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.
{'locale': 'string'}
Returns the terms attached to an offer, such as pricing terms (usage-based, contract, BYOL, free trial), legal terms, payment schedules, validity terms, support terms, and renewal terms.
See also: AWS API Documentation
Request Syntax
client.get_offer_terms(
locale='string',
offerId='string',
maxResults=123,
nextToken='string'
)
string
A BCP 47 language tag or comma-separated priority list specifying the preferred locale for response content. See Locale for supported values, constraints, fallback behavior, and the default locale. If omitted, the service returns content in the default locale.
string
[REQUIRED]
The unique identifier of the offer whose terms to retrieve.
integer
The maximum number of results that are returned per call. You can use nextToken to get more results.
string
If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.
dict
Response Syntax
{
'locale': 'string',
'offerTerms': [
{
'byolPricingTerm': {
'id': 'string',
'type': 'ByolPricingTerm'|'ConfigurableUpfrontPricingTerm'|'FixedUpfrontPricingTerm'|'UsageBasedPricingTerm'|'FreeTrialPricingTerm'|'LegalTerm'|'PaymentScheduleTerm'|'RecurringPaymentTerm'|'RenewalTerm'|'SupportTerm'|'ValidityTerm'|'VariablePaymentTerm'|'NetPaymentTerm'
},
'configurableUpfrontPricingTerm': {
'id': 'string',
'type': 'ByolPricingTerm'|'ConfigurableUpfrontPricingTerm'|'FixedUpfrontPricingTerm'|'UsageBasedPricingTerm'|'FreeTrialPricingTerm'|'LegalTerm'|'PaymentScheduleTerm'|'RecurringPaymentTerm'|'RenewalTerm'|'SupportTerm'|'ValidityTerm'|'VariablePaymentTerm'|'NetPaymentTerm',
'currencyCode': 'string',
'rateCards': [
{
'selector': {
'type': 'Duration',
'value': 'string'
},
'constraints': {
'multipleDimensionSelection': 'Allowed'|'Disallowed',
'quantityConfiguration': 'Allowed'|'Disallowed'
},
'rateCard': [
{
'dimensionKey': 'string',
'displayName': 'string',
'description': 'string',
'dimensionLabels': [
{
'labelType': 'Region'|'SagemakerOption',
'labelValue': 'string',
'displayName': 'string'
},
],
'unit': 'string',
'price': 'string'
},
]
},
]
},
'fixedUpfrontPricingTerm': {
'id': 'string',
'type': 'ByolPricingTerm'|'ConfigurableUpfrontPricingTerm'|'FixedUpfrontPricingTerm'|'UsageBasedPricingTerm'|'FreeTrialPricingTerm'|'LegalTerm'|'PaymentScheduleTerm'|'RecurringPaymentTerm'|'RenewalTerm'|'SupportTerm'|'ValidityTerm'|'VariablePaymentTerm'|'NetPaymentTerm',
'currencyCode': 'string',
'duration': 'string',
'price': 'string',
'grants': [
{
'dimensionKey': 'string',
'displayName': 'string',
'description': 'string',
'dimensionLabels': [
{
'labelType': 'Region'|'SagemakerOption',
'labelValue': 'string',
'displayName': 'string'
},
],
'unit': 'string',
'maxQuantity': 123
},
]
},
'freeTrialPricingTerm': {
'id': 'string',
'type': 'ByolPricingTerm'|'ConfigurableUpfrontPricingTerm'|'FixedUpfrontPricingTerm'|'UsageBasedPricingTerm'|'FreeTrialPricingTerm'|'LegalTerm'|'PaymentScheduleTerm'|'RecurringPaymentTerm'|'RenewalTerm'|'SupportTerm'|'ValidityTerm'|'VariablePaymentTerm'|'NetPaymentTerm',
'duration': 'string',
'grants': [
{
'dimensionKey': 'string',
'displayName': 'string',
'description': 'string',
'dimensionLabels': [
{
'labelType': 'Region'|'SagemakerOption',
'labelValue': 'string',
'displayName': 'string'
},
],
'unit': 'string',
'maxQuantity': 123
},
]
},
'legalTerm': {
'id': 'string',
'type': 'ByolPricingTerm'|'ConfigurableUpfrontPricingTerm'|'FixedUpfrontPricingTerm'|'UsageBasedPricingTerm'|'FreeTrialPricingTerm'|'LegalTerm'|'PaymentScheduleTerm'|'RecurringPaymentTerm'|'RenewalTerm'|'SupportTerm'|'ValidityTerm'|'VariablePaymentTerm'|'NetPaymentTerm',
'documents': [
{
'type': 'CustomEula'|'CustomDsa'|'EnterpriseEula'|'StandardEula'|'StandardDsa',
'url': 'string',
'version': 'string'
},
]
},
'paymentScheduleTerm': {
'id': 'string',
'type': 'ByolPricingTerm'|'ConfigurableUpfrontPricingTerm'|'FixedUpfrontPricingTerm'|'UsageBasedPricingTerm'|'FreeTrialPricingTerm'|'LegalTerm'|'PaymentScheduleTerm'|'RecurringPaymentTerm'|'RenewalTerm'|'SupportTerm'|'ValidityTerm'|'VariablePaymentTerm'|'NetPaymentTerm',
'currencyCode': 'string',
'schedule': [
{
'chargeDate': datetime(2015, 1, 1),
'chargeAmount': 'string'
},
]
},
'recurringPaymentTerm': {
'id': 'string',
'type': 'ByolPricingTerm'|'ConfigurableUpfrontPricingTerm'|'FixedUpfrontPricingTerm'|'UsageBasedPricingTerm'|'FreeTrialPricingTerm'|'LegalTerm'|'PaymentScheduleTerm'|'RecurringPaymentTerm'|'RenewalTerm'|'SupportTerm'|'ValidityTerm'|'VariablePaymentTerm'|'NetPaymentTerm',
'currencyCode': 'string',
'billingPeriod': 'Monthly',
'price': 'string'
},
'renewalTerm': {
'id': 'string',
'type': 'ByolPricingTerm'|'ConfigurableUpfrontPricingTerm'|'FixedUpfrontPricingTerm'|'UsageBasedPricingTerm'|'FreeTrialPricingTerm'|'LegalTerm'|'PaymentScheduleTerm'|'RecurringPaymentTerm'|'RenewalTerm'|'SupportTerm'|'ValidityTerm'|'VariablePaymentTerm'|'NetPaymentTerm',
'maxRenewals': 123,
'lockoutPeriod': 'string',
'adjustmentDeadline': 'string',
'priceIncrease': {
'fixedPercentage': {
'percentageValue': 'string'
},
'percentageRange': {
'minimumValue': 'string',
'maximumValue': 'string',
'defaultValue': 'string'
}
},
'termTemplates': [
{
'paymentScheduleTermTemplate': {
'schedule': [
{
'chargeDateOffset': 'string',
'chargePercentage': 'string',
'dayOfMonth': 123
},
]
}
},
]
},
'supportTerm': {
'id': 'string',
'type': 'ByolPricingTerm'|'ConfigurableUpfrontPricingTerm'|'FixedUpfrontPricingTerm'|'UsageBasedPricingTerm'|'FreeTrialPricingTerm'|'LegalTerm'|'PaymentScheduleTerm'|'RecurringPaymentTerm'|'RenewalTerm'|'SupportTerm'|'ValidityTerm'|'VariablePaymentTerm'|'NetPaymentTerm',
'refundPolicy': 'string'
},
'usageBasedPricingTerm': {
'id': 'string',
'type': 'ByolPricingTerm'|'ConfigurableUpfrontPricingTerm'|'FixedUpfrontPricingTerm'|'UsageBasedPricingTerm'|'FreeTrialPricingTerm'|'LegalTerm'|'PaymentScheduleTerm'|'RecurringPaymentTerm'|'RenewalTerm'|'SupportTerm'|'ValidityTerm'|'VariablePaymentTerm'|'NetPaymentTerm',
'currencyCode': 'string',
'rateCards': [
{
'rateCard': [
{
'dimensionKey': 'string',
'displayName': 'string',
'description': 'string',
'dimensionLabels': [
{
'labelType': 'Region'|'SagemakerOption',
'labelValue': 'string',
'displayName': 'string'
},
],
'unit': 'string',
'price': 'string'
},
]
},
]
},
'validityTerm': {
'id': 'string',
'type': 'ByolPricingTerm'|'ConfigurableUpfrontPricingTerm'|'FixedUpfrontPricingTerm'|'UsageBasedPricingTerm'|'FreeTrialPricingTerm'|'LegalTerm'|'PaymentScheduleTerm'|'RecurringPaymentTerm'|'RenewalTerm'|'SupportTerm'|'ValidityTerm'|'VariablePaymentTerm'|'NetPaymentTerm',
'agreementDuration': 'string',
'agreementEndDate': datetime(2015, 1, 1),
'agreementStartDate': datetime(2015, 1, 1)
},
'variablePaymentTerm': {
'id': 'string',
'type': 'ByolPricingTerm'|'ConfigurableUpfrontPricingTerm'|'FixedUpfrontPricingTerm'|'UsageBasedPricingTerm'|'FreeTrialPricingTerm'|'LegalTerm'|'PaymentScheduleTerm'|'RecurringPaymentTerm'|'RenewalTerm'|'SupportTerm'|'ValidityTerm'|'VariablePaymentTerm'|'NetPaymentTerm',
'currencyCode': 'string',
'maxTotalChargeAmount': 'string'
},
'netPaymentTerm': {
'id': 'string',
'type': 'ByolPricingTerm'|'ConfigurableUpfrontPricingTerm'|'FixedUpfrontPricingTerm'|'UsageBasedPricingTerm'|'FreeTrialPricingTerm'|'LegalTerm'|'PaymentScheduleTerm'|'RecurringPaymentTerm'|'RenewalTerm'|'SupportTerm'|'ValidityTerm'|'VariablePaymentTerm'|'NetPaymentTerm',
'paymentDuePeriod': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
locale (string) --
The locale of the returned content. Indicates whether the response contains content in the requested locale, or fell back to the default locale. See Locale for details.
offerTerms (list) --
The terms attached to the offer. Each element contains exactly one term type.
(dict) --
A term attached to an offer. Each element contains exactly one term type, such as a pricing term, legal term, or payment schedule term.
byolPricingTerm (dict) --
Defines a Bring Your Own License (BYOL) pricing term, where buyers use their existing license for the product.
id (string) --
The unique identifier of the term.
type (string) --
The category of the term.
configurableUpfrontPricingTerm (dict) --
Defines a configurable upfront pricing term with selectable rate cards, where buyers choose from predefined pricing configurations.
id (string) --
The unique identifier of the term.
type (string) --
The category of the term.
currencyCode (string) --
Defines the currency for the prices in this term.
rateCards (list) --
The rate cards available for selection, each with a selector, constraints, and per-unit rates.
(dict) --
A rate card item within a configurable upfront pricing term, including a selector for choosing the configuration and per-unit rates.
selector (dict) --
The selector criteria for this rate card, such as duration.
type (string) --
The category of the selector, such as Duration.
value (string) --
The value of the selector.
constraints (dict) --
Constraints on how the buyer can configure this rate card, such as whether multiple dimensions can be selected.
multipleDimensionSelection (string) --
Whether the buyer can select multiple dimensions. Values are Allowed or Disallowed.
quantityConfiguration (string) --
Whether the buyer can configure quantities. Values are Allowed or Disallowed.
rateCard (list) --
The per-unit rates for this configuration.
(dict) --
A per-unit rate within a rate card, defining the price for a specific dimension.
dimensionKey (string) --
The machine-readable key identifying the dimension being priced.
displayName (string) --
The human-readable name of the dimension.
description (string) --
A description of the dimension being priced.
dimensionLabels (list) --
Labels used to categorize this dimension, such as by region.
(dict) --
A label used to group or categorize pricing dimensions, such as by region or SageMaker option.
labelType (string) --
The type of the dimension label, such as Region or SagemakerOption.
labelValue (string) --
The value used to group dimensions together.
displayName (string) --
The human-readable display name of the label.
unit (string) --
The unit of measurement for the dimension.
price (string) --
The price per unit for the dimension.
fixedUpfrontPricingTerm (dict) --
Defines a fixed upfront pricing term with a pre-paid amount and granted entitlements.
id (string) --
The unique identifier of the term.
type (string) --
The category of the term.
currencyCode (string) --
Defines the currency for the prices in this term.
duration (string) --
The duration of the fixed pricing term, in ISO 8601 format.
price (string) --
The price charged upfront for this term.
grants (list) --
The entitlements granted to the buyer as part of this term.
(dict) --
An entitlement granted to the buyer as part of a pricing term.
dimensionKey (string) --
The machine-readable key identifying the entitlement dimension.
displayName (string) --
The human-readable name of the entitlement dimension.
description (string) --
A description of the entitlement.
dimensionLabels (list) --
Labels used to categorize this entitlement, such as by region.
(dict) --
A label used to group or categorize pricing dimensions, such as by region or SageMaker option.
labelType (string) --
The type of the dimension label, such as Region or SagemakerOption.
labelValue (string) --
The value used to group dimensions together.
displayName (string) --
The human-readable display name of the label.
unit (string) --
The unit of measurement for the entitlement.
maxQuantity (integer) --
The maximum quantity of the entitlement that can be granted.
freeTrialPricingTerm (dict) --
Defines a free trial pricing term that enables customers to try the product before purchasing.
id (string) --
The unique identifier of the term.
type (string) --
The category of the term.
duration (string) --
The duration of the free trial period.
grants (list) --
The entitlements granted to the buyer during the free trial.
(dict) --
An entitlement granted to the buyer as part of a pricing term.
dimensionKey (string) --
The machine-readable key identifying the entitlement dimension.
displayName (string) --
The human-readable name of the entitlement dimension.
description (string) --
A description of the entitlement.
dimensionLabels (list) --
Labels used to categorize this entitlement, such as by region.
(dict) --
A label used to group or categorize pricing dimensions, such as by region or SageMaker option.
labelType (string) --
The type of the dimension label, such as Region or SagemakerOption.
labelValue (string) --
The value used to group dimensions together.
displayName (string) --
The human-readable display name of the label.
unit (string) --
The unit of measurement for the entitlement.
maxQuantity (integer) --
The maximum quantity of the entitlement that can be granted.
legalTerm (dict) --
Defines a legal term containing documents proposed to buyers, such as EULAs and data subscription agreements.
id (string) --
The unique identifier of the term.
type (string) --
The category of the term.
documents (list) --
The legal documents proposed to the buyer as part of this term.
(dict) --
A legal document associated with a legal term, such as a EULA or data subscription agreement.
type (string) --
The category of the legal document, such as StandardEula or CustomEula.
url (string) --
The URL where the legal document can be accessed.
version (string) --
The version of the standard contract, if applicable.
paymentScheduleTerm (dict) --
Defines a payment schedule term with installment payments at specified dates.
id (string) --
The unique identifier of the term.
type (string) --
The category of the term.
currencyCode (string) --
Defines the currency for the prices in this term.
schedule (list) --
The payment schedule installments, each with a charge date and amount.
(dict) --
A payment installment within a payment schedule term.
chargeDate (datetime) --
The date when the payment is due.
chargeAmount (string) --
The amount to be charged on the charge date.
recurringPaymentTerm (dict) --
Defines a recurring payment term with fixed charges at regular billing intervals.
id (string) --
The unique identifier of the term.
type (string) --
The category of the term.
currencyCode (string) --
Defines the currency for the prices in this term.
billingPeriod (string) --
The billing period frequency, such as Monthly.
price (string) --
The amount charged each billing period.
renewalTerm (dict) --
Defines a renewal term that enables automatic agreement renewal.
id (string) --
The unique identifier of the term.
type (string) --
The category of the term.
maxRenewals (integer) --
The maximum number of renewals allowed on this offer. Absent means unlimited renewals.
lockoutPeriod (string) --
The duration before the agreement end date when the lockout window begins, in ISO 8601 format (for example, P30D). Absent means no lockout.
adjustmentDeadline (string) --
The duration before the agreement end date by which the renewal price is finalized, represented in ISO 8601 format (for example, P30D). Only applicable with PercentageRange.
priceIncrease (dict) --
The price increase applied at each renewal cycle. Absent means identical pricing on renewal.
fixedPercentage (dict) --
A single fixed percentage applied uniformly at every renewal cycle.
percentageValue (string) --
The percentage value applied at each renewal cycle.
percentageRange (dict) --
A percentage band with minimum, maximum, and default values that bound the price increase at each renewal cycle.
minimumValue (string) --
The minimum percentage by which the price can increase at each renewal cycle.
maximumValue (string) --
The maximum percentage by which the price can increase at each renewal cycle.
defaultValue (string) --
The percentage increase applied by default when no other value is finalized before the adjustment deadline. Falls between minimumValue and maximumValue.
termTemplates (list) --
Structural templates defining how specific terms are reshaped on each renewal cycle. Absent for upfront-only offers.
(dict) --
A structural template defining how a specific term type is reshaped on each renewal cycle. Exactly one variant is present.
paymentScheduleTermTemplate (dict) --
The installment schedule used to structure payments on the renewal offer.
schedule (list) --
An ordered list of installment entries for the renewal payment schedule.
(dict) --
A single installment entry in the renewal payment schedule.
chargeDateOffset (string) --
The relative offset from the renewal agreement start date when this installment is due, represented in ISO 8601 duration format (for example, P1M or P30D).
chargePercentage (string) --
The percentage of the increased Total Contract Value (TCV) to charge in this installment. All entries in a schedule sum to 100.00.
dayOfMonth (integer) --
The optional calendar day of month on which the charge occurs. When absent, the charge day is derived from chargeDateOffset. For months with fewer days than the specified day, the charge occurs on the last day of the month. For example, if dayOfMonth is 31, the charge in April occurs on April 30.
supportTerm (dict) --
Defines a support term that includes the refund policy for the offer.
id (string) --
The unique identifier of the term.
type (string) --
The category of the term.
refundPolicy (string) --
The refund policy description for the offer.
usageBasedPricingTerm (dict) --
Defines a usage-based pricing term (typically pay-as-you-go), where buyers are charged based on product usage.
id (string) --
The unique identifier of the term.
type (string) --
The category of the term.
currencyCode (string) --
Defines the currency for the prices in this term.
rateCards (list) --
The rate cards containing per-unit rates for usage-based pricing.
(dict) --
A rate card within a usage-based pricing term, containing per-unit rates.
rateCard (list) --
The per-unit rates for this usage-based rate card.
(dict) --
A per-unit rate within a rate card, defining the price for a specific dimension.
dimensionKey (string) --
The machine-readable key identifying the dimension being priced.
displayName (string) --
The human-readable name of the dimension.
description (string) --
A description of the dimension being priced.
dimensionLabels (list) --
Labels used to categorize this dimension, such as by region.
(dict) --
A label used to group or categorize pricing dimensions, such as by region or SageMaker option.
labelType (string) --
The type of the dimension label, such as Region or SagemakerOption.
labelValue (string) --
The value used to group dimensions together.
displayName (string) --
The human-readable display name of the label.
unit (string) --
The unit of measurement for the dimension.
price (string) --
The price per unit for the dimension.
validityTerm (dict) --
Defines a validity term that specifies the duration or date range of an agreement.
id (string) --
The unique identifier of the term.
type (string) --
The category of the term.
agreementDuration (string) --
The duration of the agreement, in ISO 8601 format.
agreementEndDate (datetime) --
The date when the agreement ends.
agreementStartDate (datetime) --
The date when the agreement starts.
variablePaymentTerm (dict) --
Defines a variable payment term with a maximum total charge amount.
id (string) --
The unique identifier of the term.
type (string) --
The category of the term.
currencyCode (string) --
Defines the currency for the prices in this term.
maxTotalChargeAmount (string) --
The maximum total amount that can be charged under this term.
netPaymentTerm (dict) --
A net payment term.
id (string) --
The unique identifier of the term.
type (string) --
The category of the term.
paymentDuePeriod (string) --
The duration after invoice date by which payment is due.
nextToken (string) --
If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.
{'locale': 'string'}
Response {'listingId': 'string', 'locale': 'string'}
Provides details about a product, such as descriptions, highlights, categories, fulfillment option summaries, promotional media, and seller engagement options.
See also: AWS API Documentation
Request Syntax
client.get_product(
locale='string',
productId='string'
)
string
A BCP 47 language tag or comma-separated priority list specifying the preferred locale for response content. See Locale for supported values, constraints, fallback behavior, and the default locale. If omitted, the service returns content in the default locale.
string
[REQUIRED]
The unique identifier of the product to retrieve.
dict
Response Syntax
{
'locale': 'string',
'productId': 'string',
'catalog': 'string',
'productName': 'string',
'manufacturer': {
'sellerProfileId': 'string',
'displayName': 'string'
},
'deployedOnAws': 'DEPLOYED'|'NOT_DEPLOYED'|'NOT_APPLICABLE',
'shortDescription': 'string',
'longDescription': 'string',
'logoThumbnailUrl': 'string',
'fulfillmentOptionSummaries': [
{
'fulfillmentOptionType': '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'
},
],
'categories': [
{
'categoryId': 'string',
'displayName': 'string'
},
],
'highlights': [
'string',
],
'promotionalMedia': [
{
'embeddedImage': {
'title': 'string',
'url': 'string',
'description': 'string'
},
'embeddedVideo': {
'title': 'string',
'url': 'string',
'preview': 'string',
'thumbnail': 'string',
'description': 'string'
}
},
],
'resources': [
{
'resourceType': 'MANUFACTURER_SUPPORT'|'MANUFACTURER_INSTRUCTIONS',
'contentType': 'EMAIL'|'PHONE_NUMBER'|'LINK'|'OTHER',
'value': 'string',
'displayName': 'string'
},
],
'sellerEngagements': [
{
'engagementType': 'REQUEST_FOR_PRIVATE_OFFER'|'REQUEST_FOR_DEMO',
'contentType': 'LINK',
'value': 'string'
},
],
'listingId': 'string'
}
Response Structure
(dict) --
locale (string) --
The locale of the returned content. Indicates whether the response contains content in the requested locale, or fell back to the default locale. See Locale for details.
productId (string) --
The unique identifier of the product.
catalog (string) --
The name of the catalog that the product belongs to.
productName (string) --
The human-readable display name of the product.
manufacturer (dict) --
The entity who manufactured the product.
sellerProfileId (string) --
The unique identifier of the seller profile.
displayName (string) --
The human-readable name of the seller.
deployedOnAws (string) --
Indicates whether the product is deployed on AWS infrastructure.
shortDescription (string) --
A 1–3 sentence summary describing the key aspects of the product.
longDescription (string) --
A detailed description of what the product does, in paragraph format.
logoThumbnailUrl (string) --
The URL of the logo thumbnail image for the product.
fulfillmentOptionSummaries (list) --
A summary of fulfillment options available for deploying or accessing the product, such as AMI, SaaS, or Container.
(dict) --
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.
categories (list) --
The categories used to classify this product into logical groups.
(dict) --
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.
highlights (list) --
A list of key features that the product offers to customers.
(string) --
promotionalMedia (list) --
Embedded promotional media provided by the creator of the product, such as images and videos.
(dict) --
Embedded promotional media for a product, such as images or videos. Each element contains exactly one media type.
embeddedImage (dict) --
An embedded promotional image for a product.
title (string) --
The title displayed when hovering over the image.
url (string) --
The URL of the image file.
description (string) --
An optional description of the image.
embeddedVideo (dict) --
An embedded promotional video for a product.
title (string) --
The title displayed when hovering over the video.
url (string) --
The URL of the video file.
preview (string) --
The URL of the high-resolution preview image for the video.
thumbnail (string) --
The URL of the thumbnail image for the video.
description (string) --
An optional description of the video.
resources (list) --
Resources that provide further information about using the product or requesting support, such as documentation links, support contacts, and usage instructions.
(dict) --
A resource that provides supplementary information about a product, such as documentation links, support contacts, or usage instructions.
resourceType (string) --
The category of the resource, such as manufacturer support or usage instructions.
contentType (string) --
The format of the resource content, such as a URL, email address, or text.
value (string) --
The resource content. Interpretation depends on the content type.
displayName (string) --
An optional human-readable label for the resource.
sellerEngagements (list) --
Engagement options available to potential buyers, such as requesting a private offer or requesting a demo.
(dict) --
An engagement option available to potential buyers of a product, such as requesting a private offer or a demo.
engagementType (string) --
The type of engagement, such as REQUEST_FOR_PRIVATE_OFFER or REQUEST_FOR_DEMO.
contentType (string) --
The format of the engagement value, such as a URL.
value (string) --
The engagement value, such as a URL to the engagement form.
listingId (string) --
The default listing identifier associated with the product.
{'locale': 'string'}
Response {'fulfillmentOptions': {'amazonMachineImageFulfillmentOption': {'accessUrlTemplate': 'string',
'amiAlias': 'string',
'architecture': 'string',
'availableFromTime': 'timestamp',
'ebsVolume': {'iops': 'integer',
'volumeTypes': ['string']},
'recommendation': {'securityGroups': [{'cidrIpAddresses': ['string'],
'fromPort': 'integer',
'protocol': 'string',
'toPort': 'integer'}]},
'shortDescription': 'string'},
'cloudFormationFulfillmentOption': {'availableFromTime': 'timestamp',
'longDescription': 'string',
'shortDescription': 'string'},
'saasFulfillmentOption': {'availableFromTime': 'timestamp',
'launchUrl': 'string',
'quickLaunch': 'ENABLED | '
'DISABLED'},
'sageMakerModelFulfillmentOption': {'supportedContentTypes': ['string'],
'supportedResponseMimeTypes': ['string']}},
'locale': 'string'}
Returns the fulfillment options available for a product, including deployment details such as version information, operating systems, usage instructions, and release notes.
See also: AWS API Documentation
Request Syntax
client.list_fulfillment_options(
locale='string',
productId='string',
maxResults=123,
nextToken='string'
)
string
A BCP 47 language tag or comma-separated priority list specifying the preferred locale for response content. See Locale for supported values, constraints, fallback behavior, and the default locale. If omitted, the service returns content in the default locale.
string
[REQUIRED]
The unique identifier of the product for which to list fulfillment options.
integer
The maximum number of results that are returned per call. You can use nextToken to get more results.
string
If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.
dict
Response Syntax
{
'locale': 'string',
'fulfillmentOptions': [
{
'amazonMachineImageFulfillmentOption': {
'fulfillmentOptionId': 'string',
'fulfillmentOptionName': 'string',
'fulfillmentOptionVersion': 'string',
'fulfillmentOptionType': 'AMAZON_MACHINE_IMAGE'|'API'|'CLOUDFORMATION_TEMPLATE'|'CONTAINER'|'HELM'|'EKS_ADD_ON'|'EC2_IMAGE_BUILDER_COMPONENT'|'DATA_EXCHANGE'|'PROFESSIONAL_SERVICES'|'SAAS'|'SAGEMAKER_ALGORITHM'|'SAGEMAKER_MODEL',
'fulfillmentOptionDisplayName': 'string',
'operatingSystems': [
{
'operatingSystemFamilyName': 'string',
'operatingSystemName': 'string',
'operatingSystemVersion': 'string'
},
],
'recommendation': {
'instanceType': 'string',
'securityGroups': [
{
'protocol': 'string',
'fromPort': 123,
'toPort': 123,
'cidrIpAddresses': [
'string',
]
},
]
},
'releaseNotes': 'string',
'usageInstructions': 'string',
'availableFromTime': datetime(2015, 1, 1),
'accessUrlTemplate': 'string',
'architecture': 'string',
'amiAlias': 'string',
'ebsVolume': {
'volumeTypes': [
'string',
],
'iops': 123
},
'shortDescription': 'string'
},
'apiFulfillmentOption': {
'fulfillmentOptionId': 'string',
'fulfillmentOptionType': 'AMAZON_MACHINE_IMAGE'|'API'|'CLOUDFORMATION_TEMPLATE'|'CONTAINER'|'HELM'|'EKS_ADD_ON'|'EC2_IMAGE_BUILDER_COMPONENT'|'DATA_EXCHANGE'|'PROFESSIONAL_SERVICES'|'SAAS'|'SAGEMAKER_ALGORITHM'|'SAGEMAKER_MODEL',
'fulfillmentOptionDisplayName': 'string',
'usageInstructions': 'string',
'awsSupportedServices': [
{
'supportedServiceType': 'string',
'displayName': 'string',
'description': 'string'
},
]
},
'cloudFormationFulfillmentOption': {
'fulfillmentOptionId': 'string',
'fulfillmentOptionName': 'string',
'fulfillmentOptionType': 'AMAZON_MACHINE_IMAGE'|'API'|'CLOUDFORMATION_TEMPLATE'|'CONTAINER'|'HELM'|'EKS_ADD_ON'|'EC2_IMAGE_BUILDER_COMPONENT'|'DATA_EXCHANGE'|'PROFESSIONAL_SERVICES'|'SAAS'|'SAGEMAKER_ALGORITHM'|'SAGEMAKER_MODEL',
'fulfillmentOptionDisplayName': 'string',
'fulfillmentOptionVersion': 'string',
'releaseNotes': 'string',
'usageInstructions': 'string',
'availableFromTime': datetime(2015, 1, 1),
'shortDescription': 'string',
'longDescription': 'string'
},
'containerFulfillmentOption': {
'fulfillmentOptionId': 'string',
'fulfillmentOptionName': 'string',
'fulfillmentOptionType': 'AMAZON_MACHINE_IMAGE'|'API'|'CLOUDFORMATION_TEMPLATE'|'CONTAINER'|'HELM'|'EKS_ADD_ON'|'EC2_IMAGE_BUILDER_COMPONENT'|'DATA_EXCHANGE'|'PROFESSIONAL_SERVICES'|'SAAS'|'SAGEMAKER_ALGORITHM'|'SAGEMAKER_MODEL',
'fulfillmentOptionDisplayName': 'string',
'fulfillmentOptionVersion': 'string',
'operatingSystems': [
{
'operatingSystemFamilyName': 'string',
'operatingSystemName': 'string'
},
],
'awsSupportedServices': [
{
'supportedServiceType': 'string',
'displayName': 'string',
'description': 'string'
},
],
'releaseNotes': 'string',
'usageInstructions': 'string'
},
'helmFulfillmentOption': {
'fulfillmentOptionId': 'string',
'fulfillmentOptionName': 'string',
'fulfillmentOptionType': 'AMAZON_MACHINE_IMAGE'|'API'|'CLOUDFORMATION_TEMPLATE'|'CONTAINER'|'HELM'|'EKS_ADD_ON'|'EC2_IMAGE_BUILDER_COMPONENT'|'DATA_EXCHANGE'|'PROFESSIONAL_SERVICES'|'SAAS'|'SAGEMAKER_ALGORITHM'|'SAGEMAKER_MODEL',
'fulfillmentOptionDisplayName': 'string',
'fulfillmentOptionVersion': 'string',
'operatingSystems': [
{
'operatingSystemFamilyName': 'string',
'operatingSystemName': 'string'
},
],
'releaseNotes': 'string',
'awsSupportedServices': [
{
'supportedServiceType': 'string',
'displayName': 'string',
'description': 'string'
},
],
'usageInstructions': 'string'
},
'eksAddOnFulfillmentOption': {
'fulfillmentOptionId': 'string',
'fulfillmentOptionName': 'string',
'fulfillmentOptionType': 'AMAZON_MACHINE_IMAGE'|'API'|'CLOUDFORMATION_TEMPLATE'|'CONTAINER'|'HELM'|'EKS_ADD_ON'|'EC2_IMAGE_BUILDER_COMPONENT'|'DATA_EXCHANGE'|'PROFESSIONAL_SERVICES'|'SAAS'|'SAGEMAKER_ALGORITHM'|'SAGEMAKER_MODEL',
'fulfillmentOptionDisplayName': 'string',
'fulfillmentOptionVersion': 'string',
'operatingSystems': [
{
'operatingSystemFamilyName': 'string',
'operatingSystemName': 'string'
},
],
'releaseNotes': 'string',
'usageInstructions': 'string',
'awsSupportedServices': [
{
'supportedServiceType': 'string',
'displayName': 'string',
'description': 'string'
},
]
},
'ec2ImageBuilderComponentFulfillmentOption': {
'fulfillmentOptionId': 'string',
'fulfillmentOptionName': 'string',
'fulfillmentOptionType': 'AMAZON_MACHINE_IMAGE'|'API'|'CLOUDFORMATION_TEMPLATE'|'CONTAINER'|'HELM'|'EKS_ADD_ON'|'EC2_IMAGE_BUILDER_COMPONENT'|'DATA_EXCHANGE'|'PROFESSIONAL_SERVICES'|'SAAS'|'SAGEMAKER_ALGORITHM'|'SAGEMAKER_MODEL',
'fulfillmentOptionDisplayName': 'string',
'fulfillmentOptionVersion': 'string',
'operatingSystems': [
{
'operatingSystemFamilyName': 'string',
'operatingSystemName': 'string'
},
],
'awsSupportedServices': [
{
'supportedServiceType': 'string',
'displayName': 'string',
'description': 'string'
},
],
'releaseNotes': 'string',
'usageInstructions': 'string'
},
'dataExchangeFulfillmentOption': {
'fulfillmentOptionId': 'string',
'fulfillmentOptionType': 'AMAZON_MACHINE_IMAGE'|'API'|'CLOUDFORMATION_TEMPLATE'|'CONTAINER'|'HELM'|'EKS_ADD_ON'|'EC2_IMAGE_BUILDER_COMPONENT'|'DATA_EXCHANGE'|'PROFESSIONAL_SERVICES'|'SAAS'|'SAGEMAKER_ALGORITHM'|'SAGEMAKER_MODEL',
'fulfillmentOptionDisplayName': 'string',
'dataArtifacts': [
{
'description': 'string',
'resourceArn': 'string',
'resourceType': 'string',
'dataClassification': 'string'
},
]
},
'professionalServicesFulfillmentOption': {
'fulfillmentOptionId': 'string',
'fulfillmentOptionType': 'AMAZON_MACHINE_IMAGE'|'API'|'CLOUDFORMATION_TEMPLATE'|'CONTAINER'|'HELM'|'EKS_ADD_ON'|'EC2_IMAGE_BUILDER_COMPONENT'|'DATA_EXCHANGE'|'PROFESSIONAL_SERVICES'|'SAAS'|'SAGEMAKER_ALGORITHM'|'SAGEMAKER_MODEL',
'fulfillmentOptionDisplayName': 'string'
},
'saasFulfillmentOption': {
'fulfillmentOptionId': 'string',
'fulfillmentOptionType': 'AMAZON_MACHINE_IMAGE'|'API'|'CLOUDFORMATION_TEMPLATE'|'CONTAINER'|'HELM'|'EKS_ADD_ON'|'EC2_IMAGE_BUILDER_COMPONENT'|'DATA_EXCHANGE'|'PROFESSIONAL_SERVICES'|'SAAS'|'SAGEMAKER_ALGORITHM'|'SAGEMAKER_MODEL',
'fulfillmentOptionDisplayName': 'string',
'fulfillmentUrl': 'string',
'usageInstructions': 'string',
'availableFromTime': datetime(2015, 1, 1),
'launchUrl': 'string',
'quickLaunch': 'ENABLED'|'DISABLED'
},
'sageMakerAlgorithmFulfillmentOption': {
'fulfillmentOptionId': 'string',
'fulfillmentOptionType': 'AMAZON_MACHINE_IMAGE'|'API'|'CLOUDFORMATION_TEMPLATE'|'CONTAINER'|'HELM'|'EKS_ADD_ON'|'EC2_IMAGE_BUILDER_COMPONENT'|'DATA_EXCHANGE'|'PROFESSIONAL_SERVICES'|'SAAS'|'SAGEMAKER_ALGORITHM'|'SAGEMAKER_MODEL',
'fulfillmentOptionDisplayName': 'string',
'fulfillmentOptionVersion': 'string',
'releaseNotes': 'string',
'usageInstructions': 'string',
'recommendation': {
'recommendedBatchTransformInstanceType': 'string',
'recommendedRealtimeInferenceInstanceType': 'string',
'recommendedTrainingInstanceType': 'string'
}
},
'sageMakerModelFulfillmentOption': {
'fulfillmentOptionId': 'string',
'fulfillmentOptionType': 'AMAZON_MACHINE_IMAGE'|'API'|'CLOUDFORMATION_TEMPLATE'|'CONTAINER'|'HELM'|'EKS_ADD_ON'|'EC2_IMAGE_BUILDER_COMPONENT'|'DATA_EXCHANGE'|'PROFESSIONAL_SERVICES'|'SAAS'|'SAGEMAKER_ALGORITHM'|'SAGEMAKER_MODEL',
'fulfillmentOptionDisplayName': 'string',
'fulfillmentOptionVersion': 'string',
'releaseNotes': 'string',
'usageInstructions': 'string',
'recommendation': {
'recommendedBatchTransformInstanceType': 'string',
'recommendedRealtimeInferenceInstanceType': 'string'
},
'supportedContentTypes': [
'string',
],
'supportedResponseMimeTypes': [
'string',
]
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
locale (string) --
A BCP 47 language tag or comma-separated priority list of language tags that specifies the preferred locale for response content. The field accepts a maximum of two language tags.
The service resolves a locale string to the nearest supported locale. If no supported locale matches, the service applies the fallback behavior described below.
Preferred locale (first tag) – The locale you want the service to return content in.
Fallback locale (optional, second tag) – The service default locale ( en-US or en). The service returns content in this locale when translated content for the preferred locale is unavailable.
The field is optional. If omitted or null, the service returns content in the default locale ( en-US).
Supported locales:
en-US – English (service default, also resolves from en)
fr – French
es – Spanish
ko – Korean
ja – Japanese
Fallback behavior:
If translated content for the preferred locale is unavailable, the service returns content in the default locale.
If the preferred locale is not supported and no fallback is provided, the service returns a ValidationException.
If you provide an unsupported locale with the default locale as fallback (for example, xx, en-US), the service returns content in the default locale.
Response locale field (Get APIs): The locale field in Get API responses indicates the locale of the returned content. You can use this field to determine whether the response contains content in the requested locale or the default locale.
Examples:
fr – Request French content. If unavailable, falls back to en-US.
fr, en-US – Request French content with explicit fallback to English.
en-US – Request content in the default locale.
fulfillmentOptions (list) --
The fulfillment options available for the product. Each option describes how the buyer can deploy or access the product.
(dict) --
Describes a fulfillment option for a product. Each element contains exactly one fulfillment option type.
amazonMachineImageFulfillmentOption (dict) --
An Amazon Machine Image (AMI) fulfillment option for EC2 deployment.
fulfillmentOptionId (string) --
The unique identifier of the fulfillment option.
fulfillmentOptionName (string) --
The display name of the fulfillment option version.
fulfillmentOptionVersion (string) --
The version identifier of the fulfillment option.
fulfillmentOptionType (string) --
The category of the fulfillment option.
fulfillmentOptionDisplayName (string) --
A human-readable name for the fulfillment option type.
operatingSystems (list) --
The operating systems supported by this AMI.
(dict) --
Describes an operating system supported by an AMI fulfillment option.
operatingSystemFamilyName (string) --
The operating system family, such as Linux or Windows.
operatingSystemName (string) --
The specific operating system name, such as Amazon Linux 2 or Windows Server 2022.
operatingSystemVersion (string) --
The version of the operating system.
recommendation (dict) --
Recommended instance types for running this AMI.
instanceType (string) --
The recommended EC2 instance type for this AMI.
securityGroups (list) --
The recommended security group configurations for this AMI.
(dict) --
Contains a recommended security group configuration for an AMI fulfillment option.
protocol (string) --
The IP protocol name, such as tcp.
fromPort (integer) --
The start of the port range.
toPort (integer) --
The end of the port range.
cidrIpAddresses (list) --
The IP address ranges in CIDR format.
(string) --
releaseNotes (string) --
Release notes describing changes in this version of the fulfillment option.
usageInstructions (string) --
Instructions on how to deploy and use this fulfillment option.
availableFromTime (datetime) --
The date and time when the AMI became available for fulfillment.
accessUrlTemplate (string) --
The URL pattern for accessing the product when an instance is running.
architecture (string) --
The architecture of the AMI, such as x86_64.
amiAlias (string) --
The alias of the AMI associated with this fulfillment option.
ebsVolume (dict) --
The supported Amazon EBS volume configuration for the AMI.
volumeTypes (list) --
The supported Amazon EBS volume types.
(string) --
iops (integer) --
The total number of provisioned IOPS supported.
shortDescription (string) --
A short description of the fulfillment option.
apiFulfillmentOption (dict) --
An API-based fulfillment option for programmatic integration.
fulfillmentOptionId (string) --
The unique identifier of the fulfillment option.
fulfillmentOptionType (string) --
The category of the fulfillment option.
fulfillmentOptionDisplayName (string) --
A human-readable name for the fulfillment option type.
usageInstructions (string) --
Instructions on how to integrate with and use this API.
awsSupportedServices (list) --
The AWS services supported by this API integration.
(dict) --
Describes an AWS service supported by a fulfillment option.
supportedServiceType (string) --
The machine-readable identifier of the supported service.
displayName (string) --
The human-readable name of the supported service.
description (string) --
A description of the supported service.
cloudFormationFulfillmentOption (dict) --
An AWS CloudFormation template fulfillment option for infrastructure deployment.
fulfillmentOptionId (string) --
The unique identifier of the fulfillment option.
fulfillmentOptionName (string) --
The display name of the fulfillment option version.
fulfillmentOptionType (string) --
The category of the fulfillment option.
fulfillmentOptionDisplayName (string) --
A human-readable name for the fulfillment option type.
fulfillmentOptionVersion (string) --
The version identifier of the fulfillment option.
releaseNotes (string) --
Release notes describing changes in this version of the fulfillment option.
usageInstructions (string) --
Instructions on how to deploy and use this CloudFormation template.
availableFromTime (datetime) --
The date and time when the CloudFormation fulfillment option became available for fulfillment.
shortDescription (string) --
A short description of the fulfillment option.
longDescription (string) --
A detailed description of the fulfillment option.
containerFulfillmentOption (dict) --
A container image fulfillment option for container-based deployment.
fulfillmentOptionId (string) --
The unique identifier of the fulfillment option.
fulfillmentOptionName (string) --
The display name of the fulfillment option version.
fulfillmentOptionType (string) --
The category of the fulfillment option.
fulfillmentOptionDisplayName (string) --
A human-readable name for the fulfillment option type.
fulfillmentOptionVersion (string) --
The version identifier of the fulfillment option.
operatingSystems (list) --
The operating systems supported by this container image.
(dict) --
Describes an operating system supported by a container fulfillment option.
operatingSystemFamilyName (string) --
The operating system family, such as Linux.
operatingSystemName (string) --
The specific operating system name.
awsSupportedServices (list) --
The AWS services supported by this container deployment.
(dict) --
Describes an AWS service supported by a fulfillment option.
supportedServiceType (string) --
The machine-readable identifier of the supported service.
displayName (string) --
The human-readable name of the supported service.
description (string) --
A description of the supported service.
releaseNotes (string) --
Release notes describing changes in this version of the fulfillment option.
usageInstructions (string) --
Instructions on how to deploy and use this container image.
helmFulfillmentOption (dict) --
A Helm chart fulfillment option for Kubernetes deployment.
fulfillmentOptionId (string) --
The unique identifier of the fulfillment option.
fulfillmentOptionName (string) --
The display name of the fulfillment option version.
fulfillmentOptionType (string) --
The category of the fulfillment option.
fulfillmentOptionDisplayName (string) --
A human-readable name for the fulfillment option type.
fulfillmentOptionVersion (string) --
The version identifier of the fulfillment option.
operatingSystems (list) --
The operating systems supported by this Helm chart.
(dict) --
Describes an operating system supported by a Helm chart fulfillment option.
operatingSystemFamilyName (string) --
The operating system family, such as Linux.
operatingSystemName (string) --
The specific operating system name.
releaseNotes (string) --
Release notes describing changes in this version of the fulfillment option.
awsSupportedServices (list) --
The AWS services supported by this Helm chart deployment.
(dict) --
Describes an AWS service supported by a fulfillment option.
supportedServiceType (string) --
The machine-readable identifier of the supported service.
displayName (string) --
The human-readable name of the supported service.
description (string) --
A description of the supported service.
usageInstructions (string) --
Instructions on how to deploy and use this Helm chart.
eksAddOnFulfillmentOption (dict) --
An Amazon EKS add-on fulfillment option.
fulfillmentOptionId (string) --
The unique identifier of the fulfillment option.
fulfillmentOptionName (string) --
The display name of the fulfillment option version.
fulfillmentOptionType (string) --
The category of the fulfillment option.
fulfillmentOptionDisplayName (string) --
A human-readable name for the fulfillment option type.
fulfillmentOptionVersion (string) --
The version identifier of the fulfillment option.
operatingSystems (list) --
The operating systems supported by this EKS add-on.
(dict) --
Describes an operating system supported by an EKS add-on fulfillment option.
operatingSystemFamilyName (string) --
The operating system family, such as Linux.
operatingSystemName (string) --
The specific operating system name.
releaseNotes (string) --
Release notes describing changes in this version of the fulfillment option.
usageInstructions (string) --
Instructions on how to deploy and use this EKS add-on.
awsSupportedServices (list) --
The AWS services supported by this EKS add-on.
(dict) --
Describes an AWS service supported by a fulfillment option.
supportedServiceType (string) --
The machine-readable identifier of the supported service.
displayName (string) --
The human-readable name of the supported service.
description (string) --
A description of the supported service.
ec2ImageBuilderComponentFulfillmentOption (dict) --
An EC2 Image Builder component fulfillment option.
fulfillmentOptionId (string) --
The unique identifier of the fulfillment option.
fulfillmentOptionName (string) --
The display name of the fulfillment option version.
fulfillmentOptionType (string) --
The category of the fulfillment option.
fulfillmentOptionDisplayName (string) --
A human-readable name for the fulfillment option type.
fulfillmentOptionVersion (string) --
The version identifier of the fulfillment option.
operatingSystems (list) --
The operating systems supported by this EC2 Image Builder component.
(dict) --
Describes an operating system supported by a container fulfillment option.
operatingSystemFamilyName (string) --
The operating system family, such as Linux.
operatingSystemName (string) --
The specific operating system name.
awsSupportedServices (list) --
The AWS services supported by this EC2 Image Builder component.
(dict) --
Describes an AWS service supported by a fulfillment option.
supportedServiceType (string) --
The machine-readable identifier of the supported service.
displayName (string) --
The human-readable name of the supported service.
description (string) --
A description of the supported service.
releaseNotes (string) --
Release notes describing changes in this version of the fulfillment option.
usageInstructions (string) --
Instructions on how to deploy and use this EC2 Image Builder component.
dataExchangeFulfillmentOption (dict) --
An AWS Data Exchange fulfillment option for data set delivery.
fulfillmentOptionId (string) --
The unique identifier of the fulfillment option.
fulfillmentOptionType (string) --
The category of the fulfillment option.
fulfillmentOptionDisplayName (string) --
A human-readable name for the fulfillment option type.
dataArtifacts (list) --
The data artifacts included in this Data Exchange fulfillment option.
(dict) --
Describes a data artifact within a Data Exchange fulfillment option.
description (string) --
A description of the data artifact.
resourceArn (string) --
The Amazon Resource Name (ARN) of the data artifact.
resourceType (string) --
The type of the data artifact resource.
dataClassification (string) --
The classification of sensitive data contained in the dataset.
professionalServicesFulfillmentOption (dict) --
A professional services fulfillment option.
fulfillmentOptionId (string) --
The unique identifier of the fulfillment option.
fulfillmentOptionType (string) --
The category of the fulfillment option.
fulfillmentOptionDisplayName (string) --
A human-readable name for the fulfillment option type.
saasFulfillmentOption (dict) --
A Software as a Service (SaaS) fulfillment option.
fulfillmentOptionId (string) --
The unique identifier of the fulfillment option.
fulfillmentOptionType (string) --
The category of the fulfillment option.
fulfillmentOptionDisplayName (string) --
A human-readable name for the fulfillment option type.
fulfillmentUrl (string) --
The URL of the seller's software registration landing page.
usageInstructions (string) --
Instructions on how to access and use this SaaS product.
availableFromTime (datetime) --
The date and time when the SaaS product became available for fulfillment.
launchUrl (string) --
The URL that a buyer uses to launch the seller's SaaS product. This URL is distinct from fulfillmentUrl, which is the seller's software registration landing page.
quickLaunch (string) --
Specifies whether the SaaS product supports quick-launch deployment.
sageMakerAlgorithmFulfillmentOption (dict) --
An Amazon SageMaker algorithm fulfillment option.
fulfillmentOptionId (string) --
The unique identifier of the fulfillment option.
fulfillmentOptionType (string) --
The category of the fulfillment option.
fulfillmentOptionDisplayName (string) --
A human-readable name for the fulfillment option type.
fulfillmentOptionVersion (string) --
The version identifier of the fulfillment option.
releaseNotes (string) --
Release notes describing changes in this version of the fulfillment option.
usageInstructions (string) --
Instructions on how to use this SageMaker algorithm.
recommendation (dict) --
Recommended instance types for training and inference with this algorithm.
recommendedBatchTransformInstanceType (string) --
The recommended instance type for batch inference.
recommendedRealtimeInferenceInstanceType (string) --
The recommended instance type for real-time inference.
recommendedTrainingInstanceType (string) --
The recommended instance type for training.
sageMakerModelFulfillmentOption (dict) --
An Amazon SageMaker model fulfillment option.
fulfillmentOptionId (string) --
The unique identifier of the fulfillment option.
fulfillmentOptionType (string) --
The category of the fulfillment option.
fulfillmentOptionDisplayName (string) --
A human-readable name for the fulfillment option type.
fulfillmentOptionVersion (string) --
The version identifier of the fulfillment option.
releaseNotes (string) --
Release notes describing changes in this version of the fulfillment option.
usageInstructions (string) --
Instructions on how to use this SageMaker model.
recommendation (dict) --
Recommended instance types for inference with this model.
recommendedBatchTransformInstanceType (string) --
The recommended instance type for batch inference.
recommendedRealtimeInferenceInstanceType (string) --
The recommended instance type for real-time inference.
supportedContentTypes (list) --
The MIME types that this model accepts as input.
(string) --
supportedResponseMimeTypes (list) --
The MIME types that this model returns as output.
(string) --
nextToken (string) --
If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.
{'locale': 'string'}
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.
See also: AWS API Documentation
Request Syntax
client.list_purchase_options(
locale='string',
filters=[
{
'filterType': 'PRODUCT_ID'|'SELLER_OF_RECORD_PROFILE_ID'|'PURCHASE_OPTION_TYPE'|'VISIBILITY_SCOPE'|'AVAILABILITY_STATUS',
'filterValues': [
'string',
]
},
],
maxResults=123,
nextToken='string'
)
string
A BCP 47 language tag or comma-separated priority list specifying the preferred locale for response content. See Locale for supported values, constraints, fallback behavior, and the default locale. If omitted, the service returns content in the default locale.
list
Filters to narrow the results. Multiple filters are combined with AND logic. Multiple values within the same filter are combined with OR logic.
(dict) --
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.
filterValues (list) -- [REQUIRED]
The values to filter by. Supported values depend on filterType:
PRODUCT_ID – One or more product identifiers to filter by.
SELLER_OF_RECORD_PROFILE_ID – One or more seller profile identifiers to filter by.
PURCHASE_OPTION_TYPE – One or more purchase option types to filter by: OFFER or OFFERSET.
VISIBILITY_SCOPE – The visibility scope to filter by: PRIVATE.
AVAILABILITY_STATUS – One or more availability statuses to filter by: AVAILABLE or EXPIRED.
To retrieve private offers and offer sets visible to you, use VISIBILITY_SCOPE with PRIVATE. OR logic combines multiple values within the same filter.
(string) --
integer
The maximum number of results that are returned per call. You can use nextToken to get more results.
string
If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.
dict
Response Syntax
{
'purchaseOptions': [
{
'purchaseOptionId': 'string',
'catalog': 'string',
'purchaseOptionType': 'OFFER'|'OFFERSET',
'purchaseOptionName': 'string',
'availableFromTime': datetime(2015, 1, 1),
'expirationTime': datetime(2015, 1, 1),
'sellerOfRecord': {
'sellerProfileId': 'string',
'displayName': 'string'
},
'badges': [
{
'displayName': 'string',
'badgeType': 'PRIVATE_PRICING'|'FUTURE_DATED'|'REPLACEMENT_OFFER'|'AUTO_RENEW'
},
],
'associatedEntities': [
{
'product': {
'productId': 'string',
'productName': 'string',
'manufacturer': {
'sellerProfileId': 'string',
'displayName': 'string'
}
},
'offer': {
'offerId': 'string',
'offerName': 'string',
'sellerOfRecord': {
'sellerProfileId': 'string',
'displayName': 'string'
}
},
'offerSet': {
'offerSetId': 'string',
'sellerOfRecord': {
'sellerProfileId': 'string',
'displayName': 'string'
}
}
},
]
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
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.
(dict) --
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 (datetime) --
The date and time when the purchase option became available to the buyer.
expirationTime (datetime) --
The date and time when the purchase option expires and is no longer available for procurement.
sellerOfRecord (dict) --
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.
(dict) --
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.
(dict) --
A product, offer, and optional offer set associated with a purchase option.
product (dict) --
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 (dict) --
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 (dict) --
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 (dict) --
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 (dict) --
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 (dict) --
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.
{'locale': 'string'}
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
Request Syntax
client.search_facets(
locale='string',
searchText='string',
filters=[
{
'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',
]
},
],
facetTypes=[
'AVERAGE_CUSTOMER_RATING'|'CATEGORY'|'PUBLISHER'|'FULFILLMENT_OPTION_TYPE'|'PRICING_MODEL'|'PRICING_UNIT'|'DEPLOYED_ON_AWS'|'NUMBER_OF_PRODUCTS',
],
nextToken='string'
)
string
A BCP 47 language tag or comma-separated priority list specifying the preferred locale for response content. See Locale for supported values, constraints, fallback behavior, and the default locale. If omitted, the service returns content in the default locale.
string
The search query text to filter listings before retrieving facets.
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.
(dict) --
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.
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.
(string) --
list
A list of specific facet types to retrieve. If empty or null, all available facets are returned.
(string) --
string
If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.
dict
Response Syntax
{
'totalResults': 123,
'listingFacets': {
'string': [
{
'value': 'string',
'displayName': 'string',
'parent': 'string',
'count': 123
},
]
},
'nextToken': 'string'
}
Response Structure
(dict) --
totalResults (integer) --
The total number of listings matching the search criteria.
listingFacets (dict) --
A map of facet types to their corresponding facet values. Each facet value includes a display name, internal value, and count of matching listings.
(string) --
(list) --
(dict) --
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 (integer) --
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.
{'locale': 'string'}
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
Request Syntax
client.search_listings(
locale='string',
searchText='string',
filters=[
{
'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',
]
},
],
maxResults=123,
sortBy='RELEVANCE'|'AVERAGE_CUSTOMER_RATING',
sortOrder='DESCENDING'|'ASCENDING',
nextToken='string'
)
string
A BCP 47 language tag or comma-separated priority list specifying the preferred locale for response content. See Locale for supported values, constraints, fallback behavior, and the default locale. If omitted, the service returns content in the default locale.
string
The search query text to find relevant listings.
list
Filters to narrow search results. Multiple filters are combined with AND logic. Multiple values within the same filter are combined with OR logic.
(dict) --
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.
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.
(string) --
integer
The maximum number of results that are returned per call. You can use nextToken to get more results.
string
The field to sort results by. Valid values are RELEVANCE and AVERAGE_CUSTOMER_RATING.
string
The sort direction. Valid values are DESCENDING and ASCENDING.
string
If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.
dict
Response Syntax
{
'totalResults': 123,
'listingSummaries': [
{
'listingId': 'string',
'listingName': 'string',
'publisher': {
'sellerProfileId': 'string',
'displayName': 'string'
},
'fulfillmentOptionSummaries': [
{
'fulfillmentOptionType': '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'
},
],
'catalog': 'string',
'shortDescription': 'string',
'logoThumbnailUrl': 'string',
'categories': [
{
'categoryId': 'string',
'displayName': 'string'
},
],
'badges': [
{
'displayName': 'string',
'badgeType': 'AWS_FREE_TIER'|'FREE_TRIAL'|'DEPLOYED_ON_AWS'|'QUICK_LAUNCH'|'MULTI_PRODUCT'
},
],
'reviewSummary': {
'reviewSourceSummaries': [
{
'sourceName': 'string',
'sourceId': 'AWS_MARKETPLACE',
'sourceUrl': 'string',
'averageRating': 'string',
'totalReviews': 123
},
]
},
'pricingModels': [
{
'pricingModelType': 'USAGE'|'CONTRACT'|'BYOL'|'FREE',
'displayName': 'string'
},
],
'pricingUnits': [
{
'pricingUnitType': 'USERS'|'HOSTS'|'BANDWIDTH'|'DATA'|'TIERS'|'REQUESTS'|'UNITS',
'displayName': 'string'
},
],
'associatedEntities': [
{
'product': {
'productId': 'string',
'productName': 'string',
'manufacturer': {
'sellerProfileId': 'string',
'displayName': 'string'
}
}
},
]
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
totalResults (integer) --
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.
(dict) --
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 (dict) --
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.
fulfillmentOptionSummaries (list) --
A summary of fulfillment options available for the listing.
(dict) --
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.
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.
(dict) --
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.
badges (list) --
Badges indicating special attributes of the listing.
(dict) --
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 (dict) --
A summary of customer reviews for the listing.
reviewSourceSummaries (list) --
Review summaries from different sources, such as AWS Marketplace.
(dict) --
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 (integer) --
The total number of reviews available from this source.
pricingModels (list) --
The pricing models for offers associated with this listing.
(dict) --
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.
(dict) --
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.
(dict) --
A product associated with a listing summary.
product (dict) --
Information about the associated product.
productId (string) --
The unique identifier of the product.
productName (string) --
The human-readable display name of the product.
manufacturer (dict) --
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.