Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetProduct

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

Request Syntax


POST /2026-02-05/getProduct HTTP/1.1
Content-type: application/json

{
   "productId": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

productId

The unique identifier of the product to retrieve.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\w\-]+

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "catalog": "string",
   "categories": [ 
      { 
         "categoryId": "string",
         "displayName": "string"
      }
   ],
   "deployedOnAws": "string",
   "fulfillmentOptionSummaries": [ 
      { 
         "displayName": "string",
         "fulfillmentOptionType": "string"
      }
   ],
   "highlights": [ "string" ],
   "logoThumbnailUrl": "string",
   "longDescription": "string",
   "manufacturer": { 
      "displayName": "string",
      "sellerProfileId": "string"
   },
   "productId": "string",
   "productName": "string",
   "promotionalMedia": [ 
      { ... }
   ],
   "resources": [ 
      { 
         "contentType": "string",
         "displayName": "string",
         "resourceType": "string",
         "value": "string"
      }
   ],
   "sellerEngagements": [ 
      { 
         "contentType": "string",
         "engagementType": "string",
         "value": "string"
      }
   ],
   "shortDescription": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

catalog

The name of the catalog that the product belongs to.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\w\-]+

categories

The categories used to classify this product into logical groups.

Type: Array of Category objects

Array Members: Minimum number of 0 items. Maximum number of 30 items.

deployedOnAws

Indicates whether the product is deployed on AWS infrastructure.

Type: String

Valid Values: DEPLOYED | NOT_DEPLOYED | NOT_APPLICABLE

fulfillmentOptionSummaries

A summary of fulfillment options available for deploying or accessing the product, such as AMI, SaaS, or Container.

Type: Array of FulfillmentOptionSummary objects

Array Members: Minimum number of 0 items. Maximum number of 20 items.

highlights

A list of key features that the product offers to customers.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .*\S.*

logoThumbnailUrl

The URL of the logo thumbnail image for the product.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: https?://.*

longDescription

A detailed description of what the product does, in paragraph format.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 32768.

Pattern: .*\S.*

manufacturer

The entity who manufactured the product.

Type: SellerInformation object

productId

The unique identifier of the product.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\w\-]+

productName

The human-readable display name of the product.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .*\S.*

promotionalMedia

Embedded promotional media provided by the creator of the product, such as images and videos.

Type: Array of PromotionalMedia objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

resources

Resources that provide further information about using the product or requesting support, such as documentation links, support contacts, and usage instructions.

Type: Array of Resource objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

sellerEngagements

Engagement options available to potential buyers, such as requesting a private offer or requesting a demo.

Type: Array of SellerEngagement objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

shortDescription

A 1–3 sentence summary describing the key aspects of the product.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .*\S.*

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You don't have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

Unexpected error during processing of the request.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource doesn't exist.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by the service.

reason: The reason that the input fails to satisfy the constraints specified by the service.

HTTP Status Code: 400