View a markdown version of this page

ListingSummary - AWS Marketplace

ListingSummary

Summary information about a listing returned by search operations, including the listing name, description, badges, categories, pricing models, reviews, and associated products.

Contents

Note

In the following list, the required parameters are described first.

associatedEntities

The products associated with this listing.

Type: Array of ListingSummaryAssociatedEntity objects

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

Required: Yes

badges

Badges indicating special attributes of the listing.

Type: Array of ListingBadge objects

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

Required: Yes

catalog

The name of the catalog that the listing belongs to.

Type: String

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

Pattern: [\w\-]+

Required: Yes

categories

The categories used to classify this listing into logical groups.

Type: Array of Category objects

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

Required: Yes

fulfillmentOptionSummaries

A summary of fulfillment options available for the listing.

Type: Array of FulfillmentOptionSummary objects

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

Required: Yes

listingId

The unique identifier of the listing.

Type: String

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

Pattern: [\w\-]+

Required: Yes

listingName

The human-readable display name of the listing.

Type: String

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

Pattern: .*\S.*

Required: Yes

logoThumbnailUrl

The URL of the logo thumbnail image for the listing.

Type: String

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

Pattern: https?://.*

Required: Yes

pricingModels

The pricing models for offers associated with this listing.

Type: Array of PricingModel objects

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

Required: Yes

pricingUnits

The pricing units that define the billing dimensions for offers associated with this listing.

Type: Array of PricingUnit objects

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

Required: Yes

publisher

The entity who created and published the listing.

Type: SellerInformation object

Required: Yes

reviewSummary

A summary of customer reviews for the listing.

Type: ReviewSummary object

Required: Yes

shortDescription

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

Type: String

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

Pattern: .*\S.*

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: