MarketplaceDiscovery / Client / get_product

get_product¶

MarketplaceDiscovery.Client.get_product(**kwargs)¶

Provides details about a product, such as descriptions, highlights, categories, fulfillment option summaries, promotional media, and seller engagement options.

Request Syntax

response = client.get_product(
    locale='string',
    productId='string'
)

Parameters:

locale (string) – A BCP 47 language tag or comma-separated priority list specifying the preferred locale for response content. See Locale for supported values, constraints, fallback behavior, and the default locale. If omitted, the service returns content in the default locale.
productId (string) –
[REQUIRED]

The unique identifier of the product to retrieve.

Return type:

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',
            'contentType': 'LINK',
            'value': 'string'
        },
    ],
    'listingId': 'string'
}

Response Structure

(dict) –
- locale (string) –
  
  The locale of the returned content. Indicates whether the response contains content in the requested locale, or fell back to the default locale. See Locale for details.
- productId (string) –
  
  The unique identifier of the product.
- catalog (string) –
  
  The name of the catalog that the product belongs to.
- productName (string) –
  
  The human-readable display name of the product.
- manufacturer (dict) –
  
  The entity who manufactured the product.
  - sellerProfileId (string) –
    
    The unique identifier of the seller profile.
  - displayName (string) –
    
    The human-readable name of the seller.
- deployedOnAws (string) –
  
  Indicates whether the product is deployed on AWS infrastructure.
- shortDescription (string) –
  
  A 1–3 sentence summary describing the key aspects of the product.
- longDescription (string) –
  
  A detailed description of what the product does, in paragraph format.
- logoThumbnailUrl (string) –
  
  The URL of the logo thumbnail image for the product.
- fulfillmentOptionSummaries (list) –
  
  A summary of fulfillment options available for deploying or accessing the product, such as AMI, SaaS, or Container.
  - (dict) –
    
    A summary of a fulfillment option available for deploying or accessing a listing or product.
    - fulfillmentOptionType (string) –
      
      The machine-readable type of the fulfillment option, such as SAAS or AMAZON_MACHINE_IMAGE.
    - displayName (string) –
      
      The human-readable name of the fulfillment option type.
- categories (list) –
  
  The categories used to classify this product into logical groups.
  - (dict) –
    
    A category used to classify a listing or product into a logical group.
    - categoryId (string) –
      
      The machine-readable identifier of the category.
    - displayName (string) –
      
      The human-readable name of the category.
- highlights (list) –
  
  A list of key features that the product offers to customers.
  - (string) –
- promotionalMedia (list) –
  
  Embedded promotional media provided by the creator of the product, such as images and videos.
  - (dict) –
    
    Embedded promotional media for a product, such as images or videos. Each element contains exactly one media type.
    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.
- resources (list) –
  
  Resources that provide further information about using the product or requesting support, such as documentation links, support contacts, and usage instructions.
  - (dict) –
    
    A resource that provides supplementary information about a product, such as documentation links, support contacts, or usage instructions.
    - resourceType (string) –
      
      The category of the resource, such as manufacturer support or usage instructions.
    - contentType (string) –
      
      The format of the resource content, such as a URL, email address, or text.
    - value (string) –
      
      The resource content. Interpretation depends on the content type.
    - displayName (string) –
      
      An optional human-readable label for the resource.
- sellerEngagements (list) –
  
  Engagement options available to potential buyers, such as requesting a private offer or requesting a demo.
  - (dict) –
    
    An engagement option available to potential buyers of a product, such as requesting a private offer or a demo.
    - engagementType (string) –
      
      The type of engagement, such as REQUEST_FOR_PRIVATE_OFFER or REQUEST_FOR_DEMO.
    - contentType (string) –
      
      The format of the engagement value, such as a URL.
    - value (string) –
      
      The engagement value, such as a URL to the engagement form.
- listingId (string) –
  
  The default listing identifier associated with the product.

Exceptions

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