AWS Marketplace Discovery

2026/11/20 - AWS Marketplace Discovery - 1 new 6 updated api methods

Changes  AWS Marketplace Discovery adds ListListingAttributes, an API for trust center, case study, and specialization details. SearchListings adds summaries, seller engagements and filters. GetListing and GetProduct return purchase indicators when products cannot be subscribed to or require no subscription.

ListListingAttributes (new) Link ¶

Retrieves the requested attributes for a listing, including case studies and trust center information. The operation returns results in pages. Use nextToken to retrieve the next page.

See also: AWS API Documentation

Request Syntax

client.list_listing_attributes(
    locale='string',
    listingId='string',
    attributeTypes=[
        'CASE_STUDY'|'SPECIALIZATION_DETAIL'|'TRUST_CENTER_SOURCE'|'TRUST_CENTER_CERTIFICATION'|'TRUST_CENTER_DOCUMENT'|'TRUST_CENTER_CONTROL'|'TRUST_CENTER_FAQ'|'TRUST_CENTER_UPDATE',
    ],
    maxResults=123,
    nextToken='string'
)
type locale:

string

param locale:

The preferred locale for response content, as a Best Current Practice 47 (BCP 47) language tag or a comma-separated priority list of language tags. See Locale for supported values, constraints, fallback behavior, and the default locale. If you omit this field, the service returns content in the default locale.

type listingId:

string

param listingId:

[REQUIRED]

The unique identifier of the listing whose attributes are requested.

type attributeTypes:

list

param attributeTypes:

[REQUIRED]

The attribute types to retrieve. Specify one or more of the following values:

CASE_STUDY

Case studies associated with the listing.

SPECIALIZATION_DETAIL

Specializations earned for the listing.

TRUST_CENTER_CERTIFICATION

Trust center certifications associated with the listing.

TRUST_CENTER_CONTROL

Trust center controls associated with the listing.

TRUST_CENTER_DOCUMENT

Trust center documents associated with the listing.

TRUST_CENTER_FAQ

The trust center FAQ associated with the listing.

TRUST_CENTER_SOURCE

Trust center sources associated with the listing.

TRUST_CENTER_UPDATE

Trust center updates associated with the listing.

  • (string) --

    The type of a listing attribute. This field has one of the following values:

    CASE_STUDY

    Case studies associated with the listing.

    SPECIALIZATION_DETAIL

    Specializations earned for the listing.

    TRUST_CENTER_CERTIFICATION

    Trust center certifications associated with the listing.

    TRUST_CENTER_CONTROL

    Trust center controls associated with the listing.

    TRUST_CENTER_DOCUMENT

    Trust center documents associated with the listing.

    TRUST_CENTER_FAQ

    The trust center FAQ associated with the listing.

    TRUST_CENTER_SOURCE

    Trust center sources associated with the listing.

    TRUST_CENTER_UPDATE

    Trust center updates associated with the listing.

type maxResults:

integer

param maxResults:

The maximum number of attributes to return in each call. If you omit this field, the default is 25. Use nextToken to retrieve the next page.

type nextToken:

string

param nextToken:

If the service returns nextToken, more results are available. The value of nextToken is a unique pagination token for each page. Make the call again with the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. An expired pagination token returns a ValidationException.

rtype:

dict

returns:

Response Syntax

{
    'locale': 'string',
    'listingAttributes': [
        {
            'caseStudy': {
                'caseStudyId': 'string',
                'caseStudyName': 'string',
                'shortDescription': 'string',
                'engagementDates': {
                    'startDate': datetime(2015, 1, 1),
                    'completionDate': datetime(2015, 1, 1)
                },
                'challenge': 'string',
                'resolution': 'string',
                'implementationApproach': 'string',
                'outcome': 'string',
                'resources': [
                    {
                        'contentType': 'EMAIL'|'PHONE_NUMBER'|'LINK'|'OTHER',
                        'value': 'string',
                        'displayName': 'string',
                        'resourceType': 'CASE_STUDY_WEBSITE'
                    },
                ]
            },
            'specializationDetail': {
                'specialization': {
                    'specializationId': 'string',
                    'specializationName': 'string',
                    'description': 'string',
                    'specializationTypes': [
                        {
                            'specializationType': 'USE_CASE'|'INDUSTRY'|'SERVICES',
                            'displayName': 'string'
                        },
                    ],
                    'caseStudyIds': [
                        'string',
                    ]
                },
                'specializationCategory': {
                    'specializationCategoryId': 'string',
                    'specializationCategoryName': 'string',
                    'parentSpecializationId': 'string'
                }
            },
            'trustCenterSource': {
                'contentType': 'EMAIL'|'PHONE_NUMBER'|'LINK'|'OTHER',
                'value': 'string',
                'displayName': 'string',
                'provider': 'DRATA'|'VANTA'|'OTHER'
            },
            'trustCenterCertification': {
                'certificationType': 'string',
                'displayName': 'string',
                'logoUrl': 'string'
            },
            'trustCenterDocument': {
                'contentType': 'EMAIL'|'PHONE_NUMBER'|'LINK'|'OTHER',
                'value': 'string',
                'displayName': 'string',
                'subjectArea': 'string',
                'accessType': 'DOWNLOAD'|'VIEW'|'REQUEST_ACCESS'
            },
            'trustCenterControl': {
                'name': 'string',
                'description': 'string',
                'domains': [
                    'SECURITY'|'AI_GOVERNANCE'|'RESILIENCE',
                ]
            },
            'trustCenterFaq': {
                'question': 'string',
                'answer': 'string',
                'subjectArea': 'string'
            },
            'trustCenterUpdate': {
                'title': 'string',
                'description': 'string',
                'publishedTime': datetime(2015, 1, 1)
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    Contains the requested listing attributes and pagination information.

    • locale (string) --

      The locale of the returned content. See Locale for details.

    • listingAttributes (list) --

      The requested attributes. Each entry contains one attribute type.

      • (dict) --

        An attribute associated with a listing. Each entry contains one attribute type.

        • caseStudy (dict) --

          A case study associated with the listing.

          • caseStudyId (string) --

            The unique identifier of the case study.

          • caseStudyName (string) --

            The case study name displayed to you.

          • shortDescription (string) --

            A brief value proposition for the case study.

          • engagementDates (dict) --

            The key implementation dates for the engagement.

            • startDate (datetime) --

              The implementation start date.

            • completionDate (datetime) --

              The implementation completion date. The service omits this field for an engagement in progress.

          • challenge (string) --

            The business challenge that the engagement addresses.

          • resolution (string) --

            How the partner resolved the challenge.

          • implementationApproach (string) --

            The implementation approach used for the engagement.

          • outcome (string) --

            The results and outcomes achieved by the engagement.

          • resources (list) --

            Resources related to the case study.

            • (dict) --

              A resource that a case study cites, such as supporting documentation or a web page.

              • contentType (string) --

                The format of the resource value.

              • value (string) --

                The resource value, such as a URL.

              • displayName (string) --

                The resource name displayed to you.

              • resourceType (string) --

                The type of case study resource.

        • specializationDetail (dict) --

          A specialization earned for the listing. Each result is either a specialization or a category under a specialization.

          • specialization (dict) --

            A specialization earned for the listing.

            • specializationId (string) --

              The unique identifier of the specialization.

            • specializationName (string) --

              The name of the specialization displayed to you.

            • description (string) --

              A description of the specialization displayed to you.

            • specializationTypes (list) --

              The types that categorize this specialization.

              • (dict) --

                Describes a specialization type with its display information.

                • specializationType (string) --

                  The specialization type.

                • displayName (string) --

                  The name of the specialization type displayed to you.

            • caseStudyIds (list) --

              The identifiers of the case studies that this specialization cites. Retrieve the case studies with the CASE_STUDY attribute type.

              • (string) --

          • specializationCategory (dict) --

            A category under a specialization that the listing earned.

            • specializationCategoryId (string) --

              The unique identifier of the category.

            • specializationCategoryName (string) --

              The name of the category displayed to you.

            • parentSpecializationId (string) --

              The identifier of the parent specialization.

        • trustCenterSource (dict) --

          A trust center source associated with the listing.

          • contentType (string) --

            The format of the trust center source value.

          • value (string) --

            The URL of the trust center.

          • displayName (string) --

            The trust center provider name displayed to you.

          • provider (string) --

            The provider hosting the trust center.

        • trustCenterCertification (dict) --

          A trust center certification associated with the listing.

          • certificationType (string) --

            The certification type. The set of values is open and can include provider-defined certifications.

          • displayName (string) --

            The authoritative certification name displayed to you.

          • logoUrl (string) --

            The URL of the certification logo.

        • trustCenterDocument (dict) --

          A trust center document associated with the listing.

          • contentType (string) --

            The format of the document resource value.

          • value (string) --

            The URL used to download, view, or request access to the document.

          • displayName (string) --

            The document name displayed to you.

          • subjectArea (string) --

            The subject area of the document.

          • accessType (string) --

            How the document can be accessed.

        • trustCenterControl (dict) --

          A trust center control associated with the listing.

          • name (string) --

            The name of the control.

          • description (string) --

            A description of the control.

          • domains (list) --

            The trust center domains to which the control applies.

            • (string) --

              A broad classification of trust center controls.

        • trustCenterFaq (dict) --

          A trust center frequently asked question associated with the listing.

          • question (string) --

            The question.

          • answer (string) --

            The answer.

          • subjectArea (string) --

            The subject area of the question.

        • trustCenterUpdate (dict) --

          A trust center update associated with the listing.

          • title (string) --

            The update title.

          • description (string) --

            The update description.

          • publishedTime (datetime) --

            The time when the update was published.

    • nextToken (string) --

      If the service returns nextToken, more results are available. The value of nextToken is a unique pagination token for each page. Make the call again with the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. An expired pagination token returns a ValidationException.

GetListing (updated) Link ¶
Changes (response)
{'purchaseIndicators': [{'indicatorType': 'NOT_AVAILABLE_FOR_SUBSCRIPTION | '
                                          'AVAILABLE_FOR_USE_WITHOUT_SUBSCRIPTION'}],
 'sellerEngagements': {'engagementType': {'BUY_NOW',
                                          'EXPRESS_PRIVATE_OFFER',
                                          'TRY_FOR_FREE'}}}

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'
)
type locale:

string

param locale:

The preferred locale for response content, as a Best Current Practice 47 (BCP 47) language tag or a comma-separated priority list of language tags. See Locale for supported values, constraints, fallback behavior, and the default locale. If you omit this field, the service returns content in the default locale.

type listingId:

string

param listingId:

[REQUIRED]

The unique identifier of the listing to retrieve.

rtype:

dict

returns:

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'|'G2'|'PEERSPOT',
                'sourceUrl': 'string',
                'averageRating': 'string',
                'totalReviews': 123
            },
        ]
    },
    'sellerEngagements': [
        {
            'engagementType': 'REQUEST_FOR_PRIVATE_OFFER'|'REQUEST_FOR_DEMO'|'EXPRESS_PRIVATE_OFFER'|'BUY_NOW'|'TRY_FOR_FREE',
            'contentType': 'LINK',
            'value': 'string'
        },
    ],
    'shortDescription': 'string',
    'useCases': [
        {
            'useCase': {
                'description': 'string',
                'displayName': 'string',
                'value': 'string'
            }
        },
    ],
    'purchaseIndicators': [
        {
            'indicatorType': 'NOT_AVAILABLE_FOR_SUBSCRIPTION'|'AVAILABLE_FOR_USE_WITHOUT_SUBSCRIPTION'
        },
    ]
}

Response Structure

  • (dict) --

    • locale (string) --

      The locale of the returned content. This value 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. See ListingBadgeType for the values.

    • catalog (string) --

      The name of the catalog that the listing belongs to.

    • categories (list) --

      The categories that classify this listing into logical groups.

      • (dict) --

        A category that classifies 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 Amazon Machine Image (AMI), Software as a Service (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, Bring Your Own License (BYOL), or free.

      • (dict) --

        A pricing model that determines how you are charged for a listing, such as usage-based, contract, Bring Your Own License (BYOL), or free.

        • pricingModelType (string) --

          The machine-readable type of the pricing model. See PricingModelType for the values.

        • 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. This field has one of the following values:

          MANUFACTURER_INSTRUCTIONS

          Usage instructions from the seller.

          MANUFACTURER_SUPPORT

          Support information from the seller.

        • contentType (string) --

          The format of the resource content, such as a URL, email address, or text. This field has one of the following values:

          EMAIL

          An email address.

          LINK

          A URL.

          OTHER

          Text in another format.

          PHONE_NUMBER

          A phone number.

        • 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, G2, and PeerSpot.

        • (dict) --

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

          • sourceName (string) --

            The name of the review source. This field has one of the following values:

            • AWS Marketplace

            • G2

            • PeerSpot

          • sourceId (string) --

            The machine-readable identifier of the review source. This field has one of the following values:

            AWS_MARKETPLACE

            The reviews come from AWS Marketplace.

            G2

            The reviews come from G2.

            PEERSPOT

            The reviews come from PeerSpot.

          • sourceUrl (string) --

            The URL where you can read the reviews at their 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) --

      The engagement options available to you, such as buying now, requesting a private offer, or requesting a demo.

      • (dict) --

        A way you can engage with the seller of a product, such as requesting a private offer or a demo.

        • engagementType (string) --

          The type of engagement. This field has one of the following values:

          BUY_NOW

          The product is available for immediate purchase.

          EXPRESS_PRIVATE_OFFER

          You can request an express private offer and accept it immediately.

          REQUEST_FOR_DEMO

          You can request a demo from the seller.

          REQUEST_FOR_PRIVATE_OFFER

          You can request a private offer from the seller.

          TRY_FOR_FREE

          The product offers a free trial.

        • 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 you can apply the product.

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

    • purchaseIndicators (list) --

      Indicators describing purchase characteristics of this listing, such as whether you can subscribe to it or use it without a subscription. The list is empty when no special purchase conditions apply.

      • (dict) --

        An indicator describing a purchase characteristic, such as availability for use without a subscription.

        • indicatorType (string) --

          The type of purchase indicator.

GetOfferTerms (updated) Link ¶
Changes (response)
{'offerTerms': {'configurableUpfrontPricingTerm': {'rateCards': {'rateCard': {'regionalPrices': [{'displayName': 'string',
                                                                                                  'price': 'string',
                                                                                                  'region': 'string'}]}}},
                'usageBasedPricingTerm': {'rateCards': {'rateCard': {'regionalPrices': [{'displayName': 'string',
                                                                                         'price': 'string',
                                                                                         'region': 'string'}]}}}}}

Retrieves the terms attached to an offer, such as pricing terms (usage-based, contract, Bring Your Own License (BYOL), free trial), legal terms, payment schedules, validity terms, support terms, and renewal terms. The operation returns results in pages. Use nextToken to retrieve the next page.

See also: AWS API Documentation

Request Syntax

client.get_offer_terms(
    locale='string',
    offerId='string',
    maxResults=123,
    nextToken='string'
)
type locale:

string

param locale:

The preferred locale for response content, as a Best Current Practice 47 (BCP 47) language tag or a comma-separated priority list of language tags. See Locale for supported values, constraints, fallback behavior, and the default locale. If you omit this field, the service returns content in the default locale.

type offerId:

string

param offerId:

[REQUIRED]

The unique identifier of the offer whose terms to retrieve.

type maxResults:

integer

param maxResults:

The maximum number of terms to return in each call. If you omit this field, the default is 10. Use nextToken to retrieve the next page.

type nextToken:

string

param nextToken:

If the service returns nextToken, more results are available. The value of nextToken is a unique pagination token for each page. Make the call again with the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. An expired pagination token returns a ValidationException.

rtype:

dict

returns:

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',
                                'regionalPrices': [
                                    {
                                        'region': 'string',
                                        'displayName': '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',
                                'regionalPrices': [
                                    {
                                        'region': 'string',
                                        'displayName': '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. This value 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) --

          Describes a Bring Your Own License (BYOL) pricing term. With this term, you use your existing license for the product.

          • id (string) --

            The unique identifier of the term.

          • type (string) --

            The category of the term.

        • configurableUpfrontPricingTerm (dict) --

          Describes a configurable upfront pricing term with selectable rate cards. You 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 you can configure this rate card, such as whether you can select multiple dimensions.

                • multipleDimensionSelection (string) --

                  Specifies whether you can select multiple dimensions. This field has one of the following values:

                  Allowed

                  You can select more than one dimension.

                  Disallowed

                  You can select only one dimension.

                • quantityConfiguration (string) --

                  Specifies whether you can configure quantities. This field has one of the following values:

                  Allowed

                  You can set the quantity of each dimension.

                  Disallowed

                  You cannot change the quantity.

              • 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 that categorize this dimension, such as by region.

                    • (dict) --

                      A label that groups or categorizes pricing dimensions, such as by region or SageMaker option.

                      • labelType (string) --

                        The type of the dimension label. This field has one of the following values:

                        Region

                        The label groups dimensions by AWS Region.

                        SagemakerOption

                        The label groups dimensions by Amazon SageMaker option.

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

                  • regionalPrices (list) --

                    The price overrides for the dimension in individual AWS Regions. When a Regional price is present for an AWS Region, it replaces the default price.

                    • (dict) --

                      A price override for a pricing dimension in one AWS Region.

                      • region (string) --

                        The AWS Region the override applies to.

                      • displayName (string) --

                        The human-readable display name of the Region.

                      • price (string) --

                        The per-unit price for the dimension in this Region.

        • fixedUpfrontPricingTerm (dict) --

          Describes 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 that you receive as part of this term.

            • (dict) --

              An entitlement that you receive 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 that categorize this entitlement, such as by region.

                • (dict) --

                  A label that groups or categorizes pricing dimensions, such as by region or SageMaker option.

                  • labelType (string) --

                    The type of the dimension label. This field has one of the following values:

                    Region

                    The label groups dimensions by AWS Region.

                    SagemakerOption

                    The label groups dimensions by Amazon SageMaker option.

                  • 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 you can receive.

        • freeTrialPricingTerm (dict) --

          Describes a free trial pricing term. With this term, you can try the product before you purchase it.

          • 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 that you receive during the free trial.

            • (dict) --

              An entitlement that you receive 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 that categorize this entitlement, such as by region.

                • (dict) --

                  A label that groups or categorizes pricing dimensions, such as by region or SageMaker option.

                  • labelType (string) --

                    The type of the dimension label. This field has one of the following values:

                    Region

                    The label groups dimensions by AWS Region.

                    SagemakerOption

                    The label groups dimensions by Amazon SageMaker option.

                  • 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 you can receive.

        • legalTerm (dict) --

          Describes a legal term containing documents proposed to you, such as End User License Agreements (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 you as part of this term.

            • (dict) --

              A legal document associated with a legal term, such as an End User License Agreement (EULA) or a 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) --

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

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

          Describes a renewal term that renews the agreement automatically.

          • 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). This field applies only 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) --

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

          Describes a usage-based pricing term, typically pay-as-you-go. You are charged based on your use of the product.

          • 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 that categorize this dimension, such as by region.

                    • (dict) --

                      A label that groups or categorizes pricing dimensions, such as by region or SageMaker option.

                      • labelType (string) --

                        The type of the dimension label. This field has one of the following values:

                        Region

                        The label groups dimensions by AWS Region.

                        SagemakerOption

                        The label groups dimensions by Amazon SageMaker option.

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

                  • regionalPrices (list) --

                    The price overrides for the dimension in individual AWS Regions. When a Regional price is present for an AWS Region, it replaces the default price.

                    • (dict) --

                      A price override for a pricing dimension in one AWS Region.

                      • region (string) --

                        The AWS Region the override applies to.

                      • displayName (string) --

                        The human-readable display name of the Region.

                      • price (string) --

                        The per-unit price for the dimension in this Region.

        • validityTerm (dict) --

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

          Describes 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 the service returns nextToken, more results are available. The value of nextToken is a unique pagination token for each page. Make the call again with the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. An expired pagination token returns a ValidationException.

GetProduct (updated) Link ¶
Changes (response)
{'purchaseIndicators': [{'indicatorType': 'NOT_AVAILABLE_FOR_SUBSCRIPTION | '
                                          'AVAILABLE_FOR_USE_WITHOUT_SUBSCRIPTION'}],
 'sellerEngagements': {'engagementType': {'BUY_NOW',
                                          'EXPRESS_PRIVATE_OFFER',
                                          'TRY_FOR_FREE'}}}

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'
)
type locale:

string

param locale:

The preferred locale for response content, as a Best Current Practice 47 (BCP 47) language tag or a comma-separated priority list of language tags. See Locale for supported values, constraints, fallback behavior, and the default locale. If you omit this field, the service returns content in the default locale.

type productId:

string

param productId:

[REQUIRED]

The unique identifier of the product to retrieve.

rtype:

dict

returns:

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'|'EXPRESS_PRIVATE_OFFER'|'BUY_NOW'|'TRY_FOR_FREE',
            'contentType': 'LINK',
            'value': 'string'
        },
    ],
    'listingId': 'string',
    'purchaseIndicators': [
        {
            'indicatorType': 'NOT_AVAILABLE_FOR_SUBSCRIPTION'|'AVAILABLE_FOR_USE_WITHOUT_SUBSCRIPTION'
        },
    ]
}

Response Structure

  • (dict) --

    • locale (string) --

      The locale of the returned content. This value 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) --

      Specifies 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 Amazon Machine Image (AMI), Software as a Service (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 that classify this product into logical groups.

      • (dict) --

        A category that classifies 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. This field has one of the following values:

          MANUFACTURER_INSTRUCTIONS

          Usage instructions from the seller.

          MANUFACTURER_SUPPORT

          Support information from the seller.

        • contentType (string) --

          The format of the resource content, such as a URL, email address, or text. This field has one of the following values:

          EMAIL

          An email address.

          LINK

          A URL.

          OTHER

          Text in another format.

          PHONE_NUMBER

          A phone number.

        • value (string) --

          The resource content. Interpretation depends on the content type.

        • displayName (string) --

          An optional human-readable label for the resource.

    • sellerEngagements (list) --

      The engagement options available to you, such as buying now, requesting a private offer, or requesting a demo.

      • (dict) --

        A way you can engage with the seller of a product, such as requesting a private offer or a demo.

        • engagementType (string) --

          The type of engagement. This field has one of the following values:

          BUY_NOW

          The product is available for immediate purchase.

          EXPRESS_PRIVATE_OFFER

          You can request an express private offer and accept it immediately.

          REQUEST_FOR_DEMO

          You can request a demo from the seller.

          REQUEST_FOR_PRIVATE_OFFER

          You can request a private offer from the seller.

          TRY_FOR_FREE

          The product offers a free trial.

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

    • purchaseIndicators (list) --

      Indicators describing purchase characteristics of this product, such as whether you can subscribe to it or use it without a subscription. The list is empty when no special purchase conditions apply.

      • (dict) --

        An indicator describing a purchase characteristic, such as availability for use without a subscription.

        • indicatorType (string) --

          The type of purchase indicator.

ListFulfillmentOptions (updated) Link ¶
Changes (response)
{'fulfillmentOptions': {'cloudFormationFulfillmentOption': {'architectureDiagramUrl': 'string',
                                                            'deploymentTemplateUrl': 'string'},
                        'saasFulfillmentOption': {'deploymentTemplates': [{'cloudFormationDeploymentTemplate': {'defaultStackName': 'string',
                                                                                                                'description': 'string',
                                                                                                                'iamPolicy': 'string',
                                                                                                                'templateName': 'string',
                                                                                                                'templateUrl': 'string'}}]}}}

Retrieves the fulfillment options available for a product, including deployment details such as version information, operating systems, usage instructions, and release notes. The operation returns results in pages. Use nextToken to retrieve the next page.

See also: AWS API Documentation

Request Syntax

client.list_fulfillment_options(
    locale='string',
    productId='string',
    maxResults=123,
    nextToken='string'
)
type locale:

string

param locale:

The preferred locale for response content, as a Best Current Practice 47 (BCP 47) language tag or a comma-separated priority list of language tags. See Locale for supported values, constraints, fallback behavior, and the default locale. If you omit this field, the service returns content in the default locale.

type productId:

string

param productId:

[REQUIRED]

The unique identifier of the product for which to list fulfillment options.

type maxResults:

integer

param maxResults:

The maximum number of fulfillment options to return in each call. If you omit this field, the default is 25. Use nextToken to retrieve the next page.

type nextToken:

string

param nextToken:

If the service returns nextToken, more results are available. The value of nextToken is a unique pagination token for each page. Make the call again with the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. An expired pagination token returns a ValidationException.

rtype:

dict

returns:

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),
                'architectureDiagramUrl': 'string',
                'deploymentTemplateUrl': 'string',
                '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',
                'deploymentTemplates': [
                    {
                        'cloudFormationDeploymentTemplate': {
                            'templateName': 'string',
                            'description': 'string',
                            'defaultStackName': 'string',
                            'templateUrl': 'string',
                            'iamPolicy': 'string'
                        }
                    },
                ]
            },
            '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 Best Current Practice 47 (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 in the following lists.

      • 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 you omit this field or set it to null, the service returns content in the default locale ( en-US).

      The service supports the following locales:

      en-US

      English (service default, also resolves from en)

      fr

      French

      es

      Spanish

      ko

      Korean

      ja

      Japanese

      The fallback behavior is as follows:

      • 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 you provide no fallback, 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.

      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.

      The following examples show how the field works:

      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 you 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 Amazon Elastic Compute Cloud (Amazon 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 that an AMI fulfillment option supports.

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

            The recommended instance types for running this AMI.

            • instanceType (string) --

              The recommended Amazon Elastic Compute Cloud (Amazon 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 Classless Inter-Domain Routing (CIDR) format.

                  • (string) --

          • releaseNotes (string) --

            Release notes that describe the 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 Elastic Block Store (Amazon EBS) volume configuration for the AMI.

            • volumeTypes (list) --

              The supported Amazon EBS volume types.

              • (string) --

            • iops (integer) --

              The total number of provisioned input/output operations per second (IOPS) that the volume supports.

          • 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 that describe the 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.

          • architectureDiagramUrl (string) --

            The URL of the architecture diagram for the CloudFormation template.

          • deploymentTemplateUrl (string) --

            The URL of the CloudFormation template.

          • 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 that a container fulfillment option supports.

              • 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 that describe the 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 that a Helm chart fulfillment option supports.

              • operatingSystemFamilyName (string) --

                The operating system family, such as Linux.

              • operatingSystemName (string) --

                The specific operating system name.

          • releaseNotes (string) --

            Release notes that describe the 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 that an Amazon EKS add-on fulfillment option supports.

              • operatingSystemFamilyName (string) --

                The operating system family, such as Linux.

              • operatingSystemName (string) --

                The specific operating system name.

          • releaseNotes (string) --

            Release notes that describe the 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 Amazon Elastic Compute Cloud (Amazon 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 that a container fulfillment option supports.

              • operatingSystemFamilyName (string) --

                The operating system family, such as Linux.

              • operatingSystemName (string) --

                The specific operating system name.

          • awsSupportedServices (list) --

            The AWS services that this EC2 Image Builder component supports.

            • (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 that describe the 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 you 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 you use 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. This field has one of the following values:

            DISABLED

            The product does not support Quick Launch.

            ENABLED

            The product supports Quick Launch.

          • deploymentTemplates (list) --

            The AWS CloudFormation deployment templates available for this SaaS product. The list is empty when no deployment templates are available.

            • (dict) --

              Contains a deployment template for a SaaS product. Exactly one member is set, indicating the deployment template type.

              • cloudFormationDeploymentTemplate (dict) --

                An AWS CloudFormation deployment template.

                • templateName (string) --

                  The display name of the deployment template.

                • description (string) --

                  A description of the deployment template.

                • defaultStackName (string) --

                  The default CloudFormation stack name used when deploying this template.

                • templateUrl (string) --

                  The URL of the CloudFormation deployment template.

                • iamPolicy (string) --

                  The AWS Identity and Access Management (IAM) policy that you need to deploy this template.

        • 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 that describe the changes in this version of the fulfillment option.

          • usageInstructions (string) --

            Instructions on how to use this SageMaker algorithm.

          • recommendation (dict) --

            The recommended instance types for training and inference with this algorithm.

            • recommendedBatchTransformInstanceType (string) --

              The instance type that the seller recommends for batch transform jobs with this algorithm.

            • recommendedRealtimeInferenceInstanceType (string) --

              The instance type that the seller recommends for real-time inference endpoints with this algorithm.

            • 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 that describe the changes in this version of the fulfillment option.

          • usageInstructions (string) --

            Instructions on how to use this SageMaker model.

          • recommendation (dict) --

            The recommended instance types for inference with this model.

            • recommendedBatchTransformInstanceType (string) --

              The instance type that the seller recommends for batch transform jobs with this model package.

            • recommendedRealtimeInferenceInstanceType (string) --

              The instance type that the seller recommends for real-time inference endpoints with this model package.

          • supportedContentTypes (list) --

            The Multipurpose Internet Mail Extensions (MIME) types that this model accepts as input.

            • (string) --

          • supportedResponseMimeTypes (list) --

            The MIME types that this model returns as output.

            • (string) --

    • nextToken (string) --

      If the service returns nextToken, more results are available. The value of nextToken is a unique pagination token for each page. Make the call again with the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. An expired pagination token returns a ValidationException.

SearchFacets (updated) Link ¶
Changes (request)
{'facetTypes': {'CERTIFICATES',
                'SELLER_ENGAGEMENT',
                'SPECIALIZATION',
                'SPECIALIZATION_CATEGORY',
                'TRUST_CENTER'},
 'filters': {'filterType': {'CERTIFICATES',
                            'PRODUCT_ID',
                            'SELLER_ENGAGEMENT',
                            'SPECIALIZATION',
                            'SPECIALIZATION_CATEGORY',
                            'TRUST_CENTER'}}}

Retrieves the 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'|'CERTIFICATES'|'PRODUCT_ID'|'SPECIALIZATION'|'SPECIALIZATION_CATEGORY'|'SELLER_ENGAGEMENT'|'TRUST_CENTER',
            'filterValues': [
                'string',
            ]
        },
    ],
    facetTypes=[
        'AVERAGE_CUSTOMER_RATING'|'CATEGORY'|'PUBLISHER'|'FULFILLMENT_OPTION_TYPE'|'PRICING_MODEL'|'PRICING_UNIT'|'DEPLOYED_ON_AWS'|'NUMBER_OF_PRODUCTS'|'CERTIFICATES'|'SPECIALIZATION'|'SPECIALIZATION_CATEGORY'|'SELLER_ENGAGEMENT'|'TRUST_CENTER',
    ],
    nextToken='string'
)
type locale:

string

param locale:

The preferred locale for response content, as a Best Current Practice 47 (BCP 47) language tag or a comma-separated priority list of language tags. See Locale for supported values, constraints, fallback behavior, and the default locale. If you omit this field, the service returns content in the default locale.

type searchText:

string

param searchText:

The search query text to filter listings before retrieving facets.

type filters:

list

param filters:

Filters to apply before retrieving facets. A result must match every filter. Within one filter, a result matches if it has any of the values.

  • (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. See filterValues for the supported types and their values.

    • filterValues (list) -- [REQUIRED]

      The values to filter by. Term filters accept multiple values, and a result matches if it has any of them. Range filters accept a single value. The supported values for each filterType are as follows:

      CATEGORY

      One or more category identifiers. Matches listings in those categories.

      CERTIFICATES

      One or more certification identifiers, such as ISO_27001 or SOC2_TYPE_2. Matches listings that hold those certifications.

      DEPLOYED_ON_AWS

      The single value DEPLOYED_ON_AWS. Matches listings whose products are deployed on AWS infrastructure.

      FULFILLMENT_OPTION_TYPE

      One or more fulfillment option types, such as SAAS, AMAZON_MACHINE_IMAGE, or CONTAINER. Matches listings that you can deploy or access in those ways.

      MAX_AVERAGE_CUSTOMER_RATING

      A single rating between 0.0 and 5.0. Matches listings whose average customer rating is at or below that value.

      MIN_AVERAGE_CUSTOMER_RATING

      A single rating between 0.0 and 5.0. Matches listings whose average customer rating is at or above that value.

      NUMBER_OF_PRODUCTS

      SINGLE_PRODUCT or MULTI_PRODUCT. Matches single-product listings or multi-product solutions.

      PRICING_MODEL

      One or more of BYOL, CONTRACT, FREE, and USAGE. Matches listings with offers that use those pricing models.

      PRICING_UNIT

      One or more pricing units, such as USERS, HOSTS, or REQUESTS. Matches listings that bill by those units.

      PRODUCT_ID

      One or more product identifiers. Matches listings that contain those products.

      PUBLISHER

      One or more publisher identifiers. Matches listings from those sellers.

      SELLER_ENGAGEMENT

      One or more SellerEngagementType values, such as BUY_NOW or REQUEST_FOR_DEMO. Matches listings that offer those ways to engage with the seller.

      SPECIALIZATION

      One or more specialization identifiers. Matches listings that earned those specializations.

      SPECIALIZATION_CATEGORY

      One or more specialization category identifiers. Matches listings that earned a category under a specialization.

      TRUST_CENTER

      The single value HAS_TRUST_CENTER. Matches listings that have a trust center.

      Use SearchFacets to retrieve the values available for CATEGORY, PUBLISHER, CERTIFICATES, SPECIALIZATION, and SPECIALIZATION_CATEGORY.

      • (string) --

type facetTypes:

list

param facetTypes:

The facet types to retrieve. If you omit this field or leave it empty, the service returns all available facets.

  • (string) --

type nextToken:

string

param nextToken:

If the service returns nextToken, more results are available. The value of nextToken is a unique pagination token for each page. Make the call again with the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. An expired pagination token returns a ValidationException.

rtype:

dict

returns:

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 the service returns nextToken, more results are available. The value of nextToken is a unique pagination token for each page. Make the call again with the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. An expired pagination token returns a ValidationException.

SearchListings (updated) Link ¶
Changes (request, response)
Request
{'filters': {'filterType': {'CERTIFICATES',
                            'PRODUCT_ID',
                            'SELLER_ENGAGEMENT',
                            'SPECIALIZATION',
                            'SPECIALIZATION_CATEGORY',
                            'TRUST_CENTER'}}}
Response
{'listingSummaries': {'caseStudiesSummary': {'caseStudyCount': 'long'},
                      'sellerEngagements': [{'contentType': 'LINK',
                                             'engagementType': 'REQUEST_FOR_PRIVATE_OFFER '
                                                               '| '
                                                               'REQUEST_FOR_DEMO '
                                                               '| '
                                                               'EXPRESS_PRIVATE_OFFER '
                                                               '| BUY_NOW | '
                                                               'TRY_FOR_FREE',
                                             'value': 'string'}],
                      'trustCenterSummary': {'certificationSummaries': [{'certificationType': 'string',
                                                                         'displayName': 'string',
                                                                         'logoUrl': 'string'}],
                                             'sourceSummaries': [{'contentType': 'EMAIL '
                                                                                 '| '
                                                                                 'PHONE_NUMBER '
                                                                                 '| '
                                                                                 'LINK '
                                                                                 '| '
                                                                                 'OTHER',
                                                                  'displayName': 'string',
                                                                  'provider': 'DRATA '
                                                                              '| '
                                                                              'VANTA '
                                                                              '| '
                                                                              'OTHER',
                                                                  'value': 'string'}],
                                             'totalCertificationCount': 'long'},
                      'useCaseSummary': {'useCases': [{'useCase': {'displayName': 'string',
                                                                   'value': 'string'}}]}}}

Searches for listings that match your 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. The operation returns results in pages. Use nextToken to retrieve the next page.

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'|'CERTIFICATES'|'PRODUCT_ID'|'SPECIALIZATION'|'SPECIALIZATION_CATEGORY'|'SELLER_ENGAGEMENT'|'TRUST_CENTER',
            'filterValues': [
                'string',
            ]
        },
    ],
    maxResults=123,
    sortBy='RELEVANCE'|'AVERAGE_CUSTOMER_RATING',
    sortOrder='DESCENDING'|'ASCENDING',
    nextToken='string'
)
type locale:

string

param locale:

The preferred locale for response content, as a Best Current Practice 47 (BCP 47) language tag or a comma-separated priority list of language tags. See Locale for supported values, constraints, fallback behavior, and the default locale. If you omit this field, the service returns content in the default locale.

type searchText:

string

param searchText:

The search query text to find relevant listings.

type filters:

list

param filters:

Filters to narrow search results. A result must match every filter. Within one filter, a result matches if it has any of the values.

  • (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. See filterValues for the supported types and their values.

    • filterValues (list) -- [REQUIRED]

      The values to filter by. Term filters accept multiple values, and a result matches if it has any of them. Range filters accept a single value. The supported values for each filterType are as follows:

      CATEGORY

      One or more category identifiers. Matches listings in those categories.

      CERTIFICATES

      One or more certification identifiers, such as ISO_27001 or SOC2_TYPE_2. Matches listings that hold those certifications.

      DEPLOYED_ON_AWS

      The single value DEPLOYED_ON_AWS. Matches listings whose products are deployed on AWS infrastructure.

      FULFILLMENT_OPTION_TYPE

      One or more fulfillment option types, such as SAAS, AMAZON_MACHINE_IMAGE, or CONTAINER. Matches listings that you can deploy or access in those ways.

      MAX_AVERAGE_CUSTOMER_RATING

      A single rating between 0.0 and 5.0. Matches listings whose average customer rating is at or below that value.

      MIN_AVERAGE_CUSTOMER_RATING

      A single rating between 0.0 and 5.0. Matches listings whose average customer rating is at or above that value.

      NUMBER_OF_PRODUCTS

      SINGLE_PRODUCT or MULTI_PRODUCT. Matches single-product listings or multi-product solutions.

      PRICING_MODEL

      One or more of BYOL, CONTRACT, FREE, and USAGE. Matches listings with offers that use those pricing models.

      PRICING_UNIT

      One or more pricing units, such as USERS, HOSTS, or REQUESTS. Matches listings that bill by those units.

      PRODUCT_ID

      One or more product identifiers. Matches listings that contain those products.

      PUBLISHER

      One or more publisher identifiers. Matches listings from those sellers.

      SELLER_ENGAGEMENT

      One or more SellerEngagementType values, such as BUY_NOW or REQUEST_FOR_DEMO. Matches listings that offer those ways to engage with the seller.

      SPECIALIZATION

      One or more specialization identifiers. Matches listings that earned those specializations.

      SPECIALIZATION_CATEGORY

      One or more specialization category identifiers. Matches listings that earned a category under a specialization.

      TRUST_CENTER

      The single value HAS_TRUST_CENTER. Matches listings that have a trust center.

      Use SearchFacets to retrieve the values available for CATEGORY, PUBLISHER, CERTIFICATES, SPECIALIZATION, and SPECIALIZATION_CATEGORY.

      • (string) --

type maxResults:

integer

param maxResults:

The maximum number of listings to return in each call. If you omit this field, the default is 25. Use nextToken to retrieve the next page.

type sortBy:

string

param sortBy:

The field to sort results by. If you do not specify a value, the service sorts by RELEVANCE. This field has one of the following values:

AVERAGE_CUSTOMER_RATING

Sorts by average customer rating.

RELEVANCE

Sorts by relevance to the search query.

type sortOrder:

string

param sortOrder:

The sort direction. If you do not specify a value, the service sorts in DESCENDING order. This field has one of the following values:

ASCENDING

Sorts from lowest to highest.

DESCENDING

Sorts from highest to lowest.

type nextToken:

string

param nextToken:

If the service returns nextToken, more results are available. The value of nextToken is a unique pagination token for each page. Make the call again with the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. An expired pagination token returns a ValidationException.

rtype:

dict

returns:

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'|'G2'|'PEERSPOT',
                        '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'
                        }
                    }
                },
            ],
            'trustCenterSummary': {
                'sourceSummaries': [
                    {
                        'contentType': 'EMAIL'|'PHONE_NUMBER'|'LINK'|'OTHER',
                        'value': 'string',
                        'displayName': 'string',
                        'provider': 'DRATA'|'VANTA'|'OTHER'
                    },
                ],
                'certificationSummaries': [
                    {
                        'certificationType': 'string',
                        'displayName': 'string',
                        'logoUrl': 'string'
                    },
                ],
                'totalCertificationCount': 123
            },
            'caseStudiesSummary': {
                'caseStudyCount': 123
            },
            'useCaseSummary': {
                'useCases': [
                    {
                        'useCase': {
                            'displayName': 'string',
                            'value': 'string'
                        }
                    },
                ]
            },
            'sellerEngagements': [
                {
                    'engagementType': 'REQUEST_FOR_PRIVATE_OFFER'|'REQUEST_FOR_DEMO'|'EXPRESS_PRIVATE_OFFER'|'BUY_NOW'|'TRY_FOR_FREE',
                    'contentType': 'LINK',
                    'value': '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 that classify this listing into logical groups.

          • (dict) --

            A category that classifies 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. See ListingBadgeType for the values.

        • reviewSummary (dict) --

          A summary of customer reviews for the listing.

          • reviewSourceSummaries (list) --

            Review summaries from different sources, such as AWS Marketplace, G2, and PeerSpot.

            • (dict) --

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

              • sourceName (string) --

                The name of the review source. This field has one of the following values:

                • AWS Marketplace

                • G2

                • PeerSpot

              • sourceId (string) --

                The machine-readable identifier of the review source. This field has one of the following values:

                AWS_MARKETPLACE

                The reviews come from AWS Marketplace.

                G2

                The reviews come from G2.

                PEERSPOT

                The reviews come from PeerSpot.

              • sourceUrl (string) --

                The URL where you can read the reviews at their 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 you are charged for a listing, such as usage-based, contract, Bring Your Own License (BYOL), or free.

            • pricingModelType (string) --

              The machine-readable type of the pricing model. See PricingModelType for the values.

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

        • trustCenterSummary (dict) --

          A summary of trust center sources and certifications associated with the listing.

          • sourceSummaries (list) --

            Trust center source summaries associated with the listing.

            • (dict) --

              Summary information for a source of trust center information.

              • contentType (string) --

                The format of the trust center source value.

              • value (string) --

                The URL of the trust center.

              • displayName (string) --

                The trust center provider name displayed to you.

              • provider (string) --

                The provider hosting the trust center.

          • certificationSummaries (list) --

            A subset of certifications associated with the listing, selected by importance.

            • (dict) --

              Summary information for a certification associated with a listing.

              • certificationType (string) --

                The certification type. The set of values is open and can include provider-defined certifications.

              • displayName (string) --

                The certification name displayed to you.

              • logoUrl (string) --

                The URL of the certification logo.

          • totalCertificationCount (integer) --

            The total number of distinct certifications associated with the listing, including certifications omitted from certificationSummaries.

        • caseStudiesSummary (dict) --

          A summary of the case studies associated with the listing. Retrieve the case studies with ListListingAttributes.

          • caseStudyCount (integer) --

            The total number of case studies associated with the listing.

        • useCaseSummary (dict) --

          A summary of the use cases the listing is written for: the name and identifier of each, without descriptions. The summary is empty when the listing has none.

          • useCases (list) --

            The use cases, in the order the seller defined them.

            • (dict) --

              A use case entry, as in GetListing without the description.

              • useCase (dict) --

                The name and identifier of the use case.

                • displayName (string) --

                  The human-readable name of the use case.

                • value (string) --

                  The machine-readable identifier of the use case.

        • sellerEngagements (list) --

          The seller engagement options available for this listing, such as buying now, requesting a private offer, or requesting a demo.

          • (dict) --

            A way you can engage with the seller of a product, such as requesting a private offer or a demo.

            • engagementType (string) --

              The type of engagement. This field has one of the following values:

              BUY_NOW

              The product is available for immediate purchase.

              EXPRESS_PRIVATE_OFFER

              You can request an express private offer and accept it immediately.

              REQUEST_FOR_DEMO

              You can request a demo from the seller.

              REQUEST_FOR_PRIVATE_OFFER

              You can request a private offer from the seller.

              TRY_FOR_FREE

              The product offers a free trial.

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

    • nextToken (string) --

      If the service returns nextToken, more results are available. The value of nextToken is a unique pagination token for each page. Make the call again with the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. An expired pagination token returns a ValidationException.