MarketplaceDiscovery / Client / get_listing

get_listing¶

MarketplaceDiscovery.Client.get_listing(**kwargs)¶

Provides details about a listing, such as descriptions, badges, categories, pricing model summaries, reviews, and associated products and offers.

Request Syntax

response = client.get_listing(
    listingId='string'
)

Parameters:

listingId (string) –

[REQUIRED]

The unique identifier of the listing to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'associatedEntities': [
        {
            'product': {
                'productId': 'string',
                'productName': 'string',
                'manufacturer': {
                    'sellerProfileId': 'string',
                    'displayName': 'string'
                }
            },
            'offer': {
                'offerId': 'string',
                'offerName': 'string',
                'sellerOfRecord': {
                    'sellerProfileId': 'string',
                    'displayName': 'string'
                }
            }
        },
    ],
    'badges': [
        {
            'displayName': 'string',
            'badgeType': 'AWS_FREE_TIER'|'FREE_TRIAL'|'DEPLOYED_ON_AWS'|'QUICK_LAUNCH'|'MULTI_PRODUCT'
        },
    ],
    'catalog': 'string',
    'categories': [
        {
            'categoryId': 'string',
            'displayName': 'string'
        },
    ],
    'fulfillmentOptionSummaries': [
        {
            'fulfillmentOptionType': 'AMAZON_MACHINE_IMAGE'|'API'|'CLOUDFORMATION_TEMPLATE'|'CONTAINER'|'HELM'|'EKS_ADD_ON'|'EC2_IMAGE_BUILDER_COMPONENT'|'DATA_EXCHANGE'|'PROFESSIONAL_SERVICES'|'SAAS'|'SAGEMAKER_ALGORITHM'|'SAGEMAKER_MODEL',
            'displayName': 'string'
        },
    ],
    'highlights': [
        'string',
    ],
    'integrationGuide': 'string',
    'listingId': 'string',
    'listingName': 'string',
    'logoThumbnailUrl': 'string',
    'longDescription': 'string',
    'pricingModels': [
        {
            'pricingModelType': 'USAGE'|'CONTRACT'|'BYOL'|'FREE',
            'displayName': 'string'
        },
    ],
    'pricingUnits': [
        {
            'pricingUnitType': 'USERS'|'HOSTS'|'BANDWIDTH'|'DATA'|'TIERS'|'REQUESTS'|'UNITS',
            'displayName': 'string'
        },
    ],
    'promotionalMedia': [
        {
            'embeddedImage': {
                'title': 'string',
                'url': 'string',
                'description': 'string'
            },
            'embeddedVideo': {
                'title': 'string',
                'url': 'string',
                'preview': 'string',
                'thumbnail': 'string',
                'description': 'string'
            }
        },
    ],
    'publisher': {
        'sellerProfileId': 'string',
        'displayName': 'string'
    },
    'resources': [
        {
            'resourceType': 'MANUFACTURER_SUPPORT'|'MANUFACTURER_INSTRUCTIONS',
            'contentType': 'EMAIL'|'PHONE_NUMBER'|'LINK'|'OTHER',
            'value': 'string',
            'displayName': 'string'
        },
    ],
    'reviewSummary': {
        'reviewSourceSummaries': [
            {
                'sourceName': 'string',
                'sourceId': 'AWS_MARKETPLACE',
                'sourceUrl': 'string',
                'averageRating': 'string',
                'totalReviews': 123
            },
        ]
    },
    'sellerEngagements': [
        {
            'engagementType': 'REQUEST_FOR_PRIVATE_OFFER'|'REQUEST_FOR_DEMO',
            'contentType': 'LINK',
            'value': 'string'
        },
    ],
    'shortDescription': 'string',
    'useCases': [
        {
            'useCase': {
                'description': 'string',
                'displayName': 'string',
                'value': 'string'
            }
        },
    ]
}

Response Structure

(dict) –
- associatedEntities (list) –
  
  The products and offers associated with this listing. Each entity contains product and offer information.
  - (dict) –
    
    A product and offer associated with a listing.
    - product (dict) –
      
      Information about the product associated with the listing.
      - productId (string) –
        
        The unique identifier of the product.
      - productName (string) –
        
        The human-readable display name of the product.
      - manufacturer (dict) –
        
        The entity who manufactured the product.
        
        sellerProfileId (string) –
        
        The unique identifier of the seller profile.
        
        displayName (string) –
        
        The human-readable name of the seller.
    - offer (dict) –
      
      Information about the default offer associated with the listing.
      - offerId (string) –
        
        The unique identifier of the offer.
      - offerName (string) –
        
        The display name of the offer.
      - sellerOfRecord (dict) –
        
        The entity responsible for selling the product under this offer.
        
        sellerProfileId (string) –
        
        The unique identifier of the seller profile.
        
        displayName (string) –
        
        The human-readable name of the seller.
- badges (list) –
  
  Badges indicating special attributes of the listing, such as free tier eligibility, free trial availability, or Quick Launch support.
  - (dict) –
    
    A badge indicating a special attribute of a listing, such as free tier eligibility or Quick Launch support.
    - displayName (string) –
      
      The human-readable name of the badge.
    - badgeType (string) –
      
      The machine-readable type of the badge.
- catalog (string) –
  
  The name of the catalog that the listing belongs to.
- categories (list) –
  
  The categories used to classify this listing into logical groups.
  - (dict) –
    
    A category used to classify a listing or product into a logical group.
    - categoryId (string) –
      
      The machine-readable identifier of the category.
    - displayName (string) –
      
      The human-readable name of the category.
- fulfillmentOptionSummaries (list) –
  
  A summary of fulfillment options available for deploying or accessing the listing, such as AMI, SaaS, or Container.
  - (dict) –
    
    A summary of a fulfillment option available for deploying or accessing a listing or product.
    - fulfillmentOptionType (string) –
      
      The machine-readable type of the fulfillment option, such as SAAS or AMAZON_MACHINE_IMAGE.
    - displayName (string) –
      
      The human-readable name of the fulfillment option type.
- highlights (list) –
  
  A list of key features that the listing offers to customers.
  - (string) –
- integrationGuide (string) –
  
  Optional guidance explaining how to use data in this listing. Primarily defines how to integrate with a multi-product listing.
- listingId (string) –
  
  The unique identifier of the listing.
- listingName (string) –
  
  The human-readable display name of the listing.
- logoThumbnailUrl (string) –
  
  The URL of the logo thumbnail image for the listing.
- longDescription (string) –
  
  A detailed description of what the listing offers, in paragraph format.
- pricingModels (list) –
  
  The pricing models for offers associated with this listing, such as usage-based, contract, BYOL, or free.
  - (dict) –
    
    A pricing model that determines how buyers are charged for a listing, such as usage-based, contract, BYOL, or free.
    - pricingModelType (string) –
      
      The machine-readable type of the pricing model.
    - displayName (string) –
      
      The human-readable name of the pricing model.
- pricingUnits (list) –
  
  The pricing units that define the billing dimensions for offers associated with this listing, such as users, hosts, or data.
  - (dict) –
    
    A pricing unit that defines the billing dimension for a listing, such as users, hosts, bandwidth, or data.
    - pricingUnitType (string) –
      
      The machine-readable type of the pricing unit.
    - displayName (string) –
      
      The human-readable name of the pricing unit.
- promotionalMedia (list) –
  
  Embedded promotional media provided by the creator of the product, such as images and videos.
  - (dict) –
    
    Embedded promotional media for a product, such as images or videos. Each element contains exactly one media type.
    Note
    This is a Tagged Union structure. Only one of the following top level keys will be set: embeddedImage, embeddedVideo. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
    - embeddedImage (dict) –
      
      An embedded promotional image for a product.
      - title (string) –
        
        The title displayed when hovering over the image.
      - url (string) –
        
        The URL of the image file.
      - description (string) –
        
        An optional description of the image.
    - embeddedVideo (dict) –
      
      An embedded promotional video for a product.
      - title (string) –
        
        The title displayed when hovering over the video.
      - url (string) –
        
        The URL of the video file.
      - preview (string) –
        
        The URL of the high-resolution preview image for the video.
      - thumbnail (string) –
        
        The URL of the thumbnail image for the video.
      - description (string) –
        
        An optional description of the video.
- publisher (dict) –
  
  The entity who created and published the listing.
  - sellerProfileId (string) –
    
    The unique identifier of the seller profile.
  - displayName (string) –
    
    The human-readable name of the seller.
- resources (list) –
  
  Resources that provide further information about using the product or requesting support, such as documentation links, support contacts, and usage instructions.
  - (dict) –
    
    A resource that provides supplementary information about a product, such as documentation links, support contacts, or usage instructions.
    - resourceType (string) –
      
      The category of the resource, such as manufacturer support or usage instructions.
    - contentType (string) –
      
      The format of the resource content, such as a URL, email address, or text.
    - value (string) –
      
      The resource content. Interpretation depends on the content type.
    - displayName (string) –
      
      An optional human-readable label for the resource.
- reviewSummary (dict) –
  
  A summary of customer reviews available for the listing, including average rating and total review count by source.
  - reviewSourceSummaries (list) –
    
    Review summaries from different sources, such as AWS Marketplace.
    - (dict) –
      
      A review summary from a specific source, including the average rating and total review count.
      - sourceName (string) –
        
        The name of the review source, such as AWS Marketplace.
      - sourceId (string) –
        
        The machine-readable identifier of the review source.
      - sourceUrl (string) –
        
        The URL where the reviews can be accessed at the source.
      - averageRating (string) –
        
        The average rating across all reviews from this source.
      - totalReviews (integer) –
        
        The total number of reviews available from this source.
- sellerEngagements (list) –
  
  Engagement options available to potential buyers, such as requesting a private offer or requesting a demo.
  - (dict) –
    
    An engagement option available to potential buyers of a product, such as requesting a private offer or a demo.
    - engagementType (string) –
      
      The type of engagement, such as REQUEST_FOR_PRIVATE_OFFER or REQUEST_FOR_DEMO.
    - contentType (string) –
      
      The format of the engagement value, such as a URL.
    - value (string) –
      
      The engagement value, such as a URL to the engagement form.
- shortDescription (string) –
  
  A 1–3 sentence summary describing the key aspects of the listing.
- useCases (list) –
  
  Use cases associated with the listing, describing scenarios where the product can be applied.
  - (dict) –
    
    An entry in the list of use cases for a listing.
    - useCase (dict) –
      
      The use case details.
      - description (string) –
        
        A description of the use case.
      - displayName (string) –
        
        The human-readable name of the use case.
      - value (string) –
        
        The machine-readable identifier of the use case.

Exceptions

MarketplaceDiscovery.Client.exceptions.ThrottlingException
MarketplaceDiscovery.Client.exceptions.AccessDeniedException
MarketplaceDiscovery.Client.exceptions.ValidationException
MarketplaceDiscovery.Client.exceptions.ResourceNotFoundException
MarketplaceDiscovery.Client.exceptions.InternalServerException